Added a close_handle method to the object operations, and use it to
[wine] / dlls / user / user_private.h
1 /*
2  * USER private definitions
3  *
4  * Copyright 1993 Alexandre Julliard
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #ifndef __WINE_USER_PRIVATE_H
22 #define __WINE_USER_PRIVATE_H
23
24 #include <stdarg.h>
25 #include "windef.h"
26 #include "winbase.h"
27 #include "wingdi.h"
28 #include "winuser.h"
29 #include "winreg.h"
30 #include "winternl.h"
31 #include "wine/windef16.h"
32 #include "wine/winbase16.h"
33
34 extern WORD USER_HeapSel;
35
36 static inline HLOCAL16 LOCAL_Alloc( HANDLE16 ds, UINT16 flags, WORD size )
37 {
38     STACK16FRAME* stack16 = MapSL((SEGPTR)NtCurrentTeb()->WOW32Reserved);
39     HANDLE16 oldDS = stack16->ds;
40     HLOCAL16 ret;
41
42     stack16->ds = ds;
43     ret = LocalAlloc16 (flags, size);
44     stack16->ds = oldDS;
45     return ret;
46 }
47
48 static inline  HLOCAL16 LOCAL_ReAlloc( HANDLE16 ds, HLOCAL16 handle, WORD size, UINT16 flags )
49 {
50     STACK16FRAME* stack16 = MapSL((SEGPTR)NtCurrentTeb()->WOW32Reserved);
51     HANDLE16 oldDS = stack16->ds;
52     HLOCAL16 ret;
53
54     stack16->ds = ds;
55     ret = LocalReAlloc16 (handle, size, flags);
56     stack16->ds = oldDS;
57     return ret;
58 }
59
60 static inline HLOCAL16 LOCAL_Free( HANDLE16 ds, HLOCAL16 handle )
61 {
62     STACK16FRAME* stack16 = MapSL((SEGPTR)NtCurrentTeb()->WOW32Reserved);
63     HANDLE16 oldDS = stack16->ds;
64     HLOCAL16 ret;
65
66     stack16->ds = ds;
67     ret = LocalFree16 (handle);
68     stack16->ds = oldDS;
69     return ret;
70 }
71
72 #define USER_HEAP_ALLOC(size) \
73             ((HANDLE)(ULONG_PTR)LOCAL_Alloc( USER_HeapSel, LMEM_FIXED, (size) ))
74 #define USER_HEAP_REALLOC(handle,size) \
75             ((HANDLE)(ULONG_PTR)LOCAL_ReAlloc( USER_HeapSel, LOWORD(handle), (size), LMEM_FIXED ))
76 #define USER_HEAP_FREE(handle) \
77             LOCAL_Free( USER_HeapSel, LOWORD(handle) )
78 #define USER_HEAP_LIN_ADDR(handle)  \
79          ((handle) ? MapSL(MAKESEGPTR(USER_HeapSel, LOWORD(handle))) : NULL)
80
81 #define GET_WORD(ptr)  (*(const WORD *)(ptr))
82 #define GET_DWORD(ptr) (*(const DWORD *)(ptr))
83
84 /* internal messages codes */
85 enum wine_internal_message
86 {
87     WM_WINE_DESTROYWINDOW = 0x80000000,
88     WM_WINE_SETWINDOWPOS,
89     WM_WINE_SHOWWINDOW,
90     WM_WINE_SETPARENT,
91     WM_WINE_SETWINDOWLONG,
92     WM_WINE_ENABLEWINDOW,
93     WM_WINE_SETACTIVEWINDOW,
94     WM_WINE_KEYBOARD_LL_HOOK,
95     WM_WINE_MOUSE_LL_HOOK,
96     WM_WINE_FIRST_DRIVER_MSG = 0x80001000,  /* range of messages reserved for the USER driver */
97     WM_WINE_LAST_DRIVER_MSG = 0x80001fff
98 };
99
100 struct tagCURSORICONINFO;
101
102 typedef struct tagUSER_DRIVER {
103     /* keyboard functions */
104     HKL    (*pActivateKeyboardLayout)(HKL, UINT);
105     void   (*pBeep)(void);
106     SHORT  (*pGetAsyncKeyState)(INT);
107     INT    (*pGetKeyNameText)(LONG, LPWSTR, INT);
108     HKL    (*pGetKeyboardLayout)(DWORD);
109     UINT   (*pGetKeyboardLayoutList)(INT, HKL *);
110     BOOL   (*pGetKeyboardLayoutName)(LPWSTR);
111     HKL    (*pLoadKeyboardLayout)(LPCWSTR, UINT);
112     UINT   (*pMapVirtualKeyEx)(UINT, UINT, HKL);
113     UINT   (*pSendInput)(UINT, LPINPUT, int);
114     INT    (*pToUnicodeEx)(UINT, UINT, LPBYTE, LPWSTR, int, UINT, HKL);
115     BOOL   (*pUnloadKeyboardLayout)(HKL);
116     SHORT  (*pVkKeyScanEx)(WCHAR, HKL);
117     /* mouse functions */
118     void   (*pSetCursor)(struct tagCURSORICONINFO *);
119     BOOL   (*pGetCursorPos)(LPPOINT);
120     BOOL   (*pSetCursorPos)(INT,INT);
121     /* screen saver functions */
122     BOOL   (*pGetScreenSaveActive)(void);
123     void   (*pSetScreenSaveActive)(BOOL);
124     /* clipboard functions */
125     void   (*pAcquireClipboard)(HWND);                     /* Acquire selection */
126     BOOL   (*pCountClipboardFormats)(void);                /* Count available clipboard formats */
127     void   (*pEmptyClipboard)(BOOL);                       /* Empty clipboard data */
128     BOOL   (*pEndClipboardUpdate)(void);                   /* End clipboard update */
129     BOOL   (*pEnumClipboardFormats)(UINT);                 /* Enumerate clipboard formats */
130     BOOL   (*pGetClipboardData)(UINT, HANDLE16*, HANDLE*); /* Get specified selection data */
131     BOOL   (*pGetClipboardFormatName)(UINT, LPWSTR, UINT); /* Get a clipboard format name */
132     BOOL   (*pIsClipboardFormatAvailable)(UINT);           /* Check if specified format is available */
133     INT    (*pRegisterClipboardFormat)(LPCWSTR);           /* Register a clipboard format */
134     void   (*pResetSelectionOwner)(HWND, BOOL);
135     BOOL   (*pSetClipboardData)(UINT, HANDLE16, HANDLE, BOOL);   /* Set specified selection data */
136     /* display modes */
137     LONG   (*pChangeDisplaySettingsExW)(LPCWSTR,LPDEVMODEW,HWND,DWORD,LPVOID);
138     BOOL   (*pEnumDisplaySettingsExW)(LPCWSTR,DWORD,LPDEVMODEW,DWORD);
139     /* windowing functions */
140     BOOL   (*pCreateWindow)(HWND,CREATESTRUCTA*,BOOL);
141     BOOL   (*pDestroyWindow)(HWND);
142     HDC    (*pGetDCEx)(HWND,HRGN,DWORD);
143     DWORD  (*pMsgWaitForMultipleObjectsEx)(DWORD,const HANDLE*,DWORD,DWORD,DWORD);
144     BOOL   (*pReleaseDC)(HWND,HDC,BOOL);
145     BOOL   (*pScrollDC)(HDC, INT, INT, const RECT *, const RECT *, HRGN, LPRECT);
146     void   (*pSetFocus)(HWND);
147     HWND   (*pSetParent)(HWND,HWND);
148     BOOL   (*pSetWindowPos)(WINDOWPOS *);
149     int    (*pSetWindowRgn)(HWND,HRGN,BOOL);
150     void   (*pSetWindowIcon)(HWND,UINT,HICON);
151     void   (*pSetWindowStyle)(HWND,DWORD);
152     BOOL   (*pSetWindowText)(HWND,LPCWSTR);
153     BOOL   (*pShowWindow)(HWND,INT);
154     void   (*pSysCommandSizeMove)(HWND,WPARAM);
155     HWND   (*pWindowFromDC)(HDC);
156     LRESULT (*pWindowMessage)(HWND,UINT,WPARAM,LPARAM);
157 } USER_DRIVER;
158
159 extern USER_DRIVER USER_Driver;
160
161 struct received_message_info;
162 struct hook16_queue_info;
163
164 /* this is the structure stored in TEB->Win32ClientInfo */
165 /* no attempt is made to keep the layout compatible with the Windows one */
166 struct user_thread_info
167 {
168     HANDLE                        server_queue;           /* 00 Handle to server-side queue */
169     DWORD                         recursion_count;        /* 04 SendMessage recursion counter */
170     HHOOK                         hook;                   /* 08 Current hook */
171     struct received_message_info *receive_info;           /* 0c Message being currently received */
172     struct hook16_queue_info     *hook16_info;            /* 10 Opaque pointer for 16-bit hook support */
173     DWORD                         GetMessageTimeVal;      /* 14 Value for GetMessageTime */
174     DWORD                         GetMessagePosVal;       /* 18 Value for GetMessagePos */
175     DWORD                         GetMessageExtraInfoVal; /* 1c Value for GetMessageExtraInfo */
176     HCURSOR                       cursor;                 /* 20 Current cursor */
177     INT                           cursor_count;           /* 24 Cursor show count */
178     UINT                          active_hooks;           /* 28 Bitmap of active hooks */
179                                                           /* 2c-7c Available for more data */
180 };
181
182 static inline struct user_thread_info *get_user_thread_info(void)
183 {
184     return (struct user_thread_info *)NtCurrentTeb()->Win32ClientInfo;
185 }
186
187 /* check if hwnd is a broadcast magic handle */
188 static inline BOOL is_broadcast( HWND hwnd )
189 {
190     return (hwnd == HWND_BROADCAST || hwnd == HWND_TOPMOST);
191 }
192
193 extern HMODULE user32_module;
194 extern DWORD USER16_AlertableWait;
195 extern HBRUSH SYSCOLOR_55AABrush;
196
197 extern BOOL CLIPBOARD_ReleaseOwner(void);
198 extern BOOL FOCUS_MouseActivate( HWND hwnd );
199 extern BOOL HOOK_IsHooked( INT id );
200 extern LRESULT MSG_SendInternalMessageTimeout( DWORD dest_pid, DWORD dest_tid,
201                                                UINT msg, WPARAM wparam, LPARAM lparam,
202                                                UINT flags, UINT timeout, PDWORD_PTR res_ptr );
203 extern HPEN SYSCOLOR_GetPen( INT index );
204 extern void SYSPARAMS_Init(void);
205 extern void USER_CheckNotLock(void);
206 extern BOOL USER_IsExitingThread( DWORD tid );
207
208 /* message spy definitions */
209
210 #define SPY_DISPATCHMESSAGE16     0x0100
211 #define SPY_DISPATCHMESSAGE       0x0101
212 #define SPY_SENDMESSAGE16         0x0102
213 #define SPY_SENDMESSAGE           0x0103
214 #define SPY_DEFWNDPROC16          0x0104
215 #define SPY_DEFWNDPROC            0x0105
216
217 #define SPY_RESULT_OK16           0x0000
218 #define SPY_RESULT_OK             0x0001
219 #define SPY_RESULT_INVALIDHWND16  0x0002
220 #define SPY_RESULT_INVALIDHWND    0x0003
221 #define SPY_RESULT_DEFWND16       0x0004
222 #define SPY_RESULT_DEFWND         0x0005
223
224 extern const char *SPY_GetMsgName( UINT msg, HWND hWnd );
225 extern const char *SPY_GetVKeyName(WPARAM wParam);
226 extern void SPY_EnterMessage( INT iFlag, HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam );
227 extern void SPY_ExitMessage( INT iFlag, HWND hwnd, UINT msg,
228                              LRESULT lReturn, WPARAM wParam, LPARAM lParam );
229 extern int SPY_Init(void);
230
231 /* HANDLE16 <-> HANDLE conversions */
232 #define HCURSOR_16(h32)    (LOWORD(h32))
233 #define HICON_16(h32)      (LOWORD(h32))
234 #define HINSTANCE_16(h32)  (LOWORD(h32))
235
236 #define HCURSOR_32(h16)    ((HCURSOR)(ULONG_PTR)(h16))
237 #define HICON_32(h16)      ((HICON)(ULONG_PTR)(h16))
238 #define HINSTANCE_32(h16)  ((HINSTANCE)(ULONG_PTR)(h16))
239 #define HMODULE_32(h16)    ((HMODULE)(ULONG_PTR)(h16))
240
241 #endif /* __WINE_USER_PRIVATE_H */