ddraw: Separate IDirectDrawSurface4 vtable.
[wine] / dlls / user32 / 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, 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
32 #define GET_WORD(ptr)  (*(const WORD *)(ptr))
33 #define GET_DWORD(ptr) (*(const DWORD *)(ptr))
34
35 #define WM_SYSTIMER         0x0118
36 #define WM_POPUPSYSTEMMENU  0x0313
37
38 /* internal messages codes */
39 enum wine_internal_message
40 {
41     WM_WINE_DESTROYWINDOW = 0x80000000,
42     WM_WINE_SETWINDOWPOS,
43     WM_WINE_SHOWWINDOW,
44     WM_WINE_SETPARENT,
45     WM_WINE_SETWINDOWLONG,
46     WM_WINE_ENABLEWINDOW,
47     WM_WINE_SETACTIVEWINDOW,
48     WM_WINE_KEYBOARD_LL_HOOK,
49     WM_WINE_MOUSE_LL_HOOK,
50     WM_WINE_CLIPCURSOR,
51     WM_WINE_FIRST_DRIVER_MSG = 0x80001000,  /* range of messages reserved for the USER driver */
52     WM_WINE_LAST_DRIVER_MSG = 0x80001fff
53 };
54
55 typedef struct tagUSER_DRIVER {
56     /* keyboard functions */
57     HKL    (CDECL *pActivateKeyboardLayout)(HKL, UINT);
58     void   (CDECL *pBeep)(void);
59     SHORT  (CDECL *pGetAsyncKeyState)(INT);
60     INT    (CDECL *pGetKeyNameText)(LONG, LPWSTR, INT);
61     HKL    (CDECL *pGetKeyboardLayout)(DWORD);
62     BOOL   (CDECL *pGetKeyboardLayoutName)(LPWSTR);
63     HKL    (CDECL *pLoadKeyboardLayout)(LPCWSTR, UINT);
64     UINT   (CDECL *pMapVirtualKeyEx)(UINT, UINT, HKL);
65     INT    (CDECL *pToUnicodeEx)(UINT, UINT, const BYTE *, LPWSTR, int, UINT, HKL);
66     BOOL   (CDECL *pUnloadKeyboardLayout)(HKL);
67     SHORT  (CDECL *pVkKeyScanEx)(WCHAR, HKL);
68     /* cursor/icon functions */
69     void   (CDECL *pCreateCursorIcon)(HCURSOR);
70     void   (CDECL *pDestroyCursorIcon)(HCURSOR);
71     void   (CDECL *pSetCursor)(HCURSOR);
72     BOOL   (CDECL *pGetCursorPos)(LPPOINT);
73     BOOL   (CDECL *pSetCursorPos)(INT,INT);
74     BOOL   (CDECL *pClipCursor)(LPCRECT);
75     /* screen saver functions */
76     BOOL   (CDECL *pGetScreenSaveActive)(void);
77     void   (CDECL *pSetScreenSaveActive)(BOOL);
78     /* clipboard functions */
79     INT    (CDECL *pAcquireClipboard)(HWND);                     /* Acquire selection */
80     BOOL   (CDECL *pCountClipboardFormats)(void);                /* Count available clipboard formats */
81     void   (CDECL *pEmptyClipboard)(BOOL);                       /* Empty clipboard data */
82     void   (CDECL *pEndClipboardUpdate)(void);                   /* End clipboard update */
83     UINT   (CDECL *pEnumClipboardFormats)(UINT);                 /* Enumerate clipboard formats */
84     HANDLE (CDECL *pGetClipboardData)(UINT);                     /* Get specified selection data */
85     BOOL   (CDECL *pIsClipboardFormatAvailable)(UINT);           /* Check if specified format is available */
86     BOOL   (CDECL *pSetClipboardData)(UINT, HANDLE, BOOL);       /* Set specified selection data */
87     /* display modes */
88     LONG   (CDECL *pChangeDisplaySettingsEx)(LPCWSTR,LPDEVMODEW,HWND,DWORD,LPVOID);
89     BOOL   (CDECL *pEnumDisplayMonitors)(HDC,LPRECT,MONITORENUMPROC,LPARAM);
90     BOOL   (CDECL *pEnumDisplaySettingsEx)(LPCWSTR,DWORD,LPDEVMODEW,DWORD);
91     BOOL   (CDECL *pGetMonitorInfo)(HMONITOR,MONITORINFO*);
92     /* windowing functions */
93     BOOL   (CDECL *pCreateDesktopWindow)(HWND);
94     BOOL   (CDECL *pCreateWindow)(HWND);
95     void   (CDECL *pDestroyWindow)(HWND);
96     void   (CDECL *pGetDC)(HDC,HWND,HWND,const RECT *,const RECT *,DWORD);
97     DWORD  (CDECL *pMsgWaitForMultipleObjectsEx)(DWORD,const HANDLE*,DWORD,DWORD,DWORD);
98     void   (CDECL *pReleaseDC)(HWND,HDC);
99     BOOL   (CDECL *pScrollDC)(HDC, INT, INT, const RECT *, const RECT *, HRGN, LPRECT);
100     void   (CDECL *pSetCapture)(HWND,UINT);
101     void   (CDECL *pSetFocus)(HWND);
102     void   (CDECL *pSetLayeredWindowAttributes)(HWND,COLORREF,BYTE,DWORD);
103     void   (CDECL *pSetParent)(HWND,HWND,HWND);
104     int    (CDECL *pSetWindowRgn)(HWND,HRGN,BOOL);
105     void   (CDECL *pSetWindowIcon)(HWND,UINT,HICON);
106     void   (CDECL *pSetWindowStyle)(HWND,INT,STYLESTRUCT*);
107     void   (CDECL *pSetWindowText)(HWND,LPCWSTR);
108     UINT   (CDECL *pShowWindow)(HWND,INT,RECT*,UINT);
109     LRESULT (CDECL *pSysCommand)(HWND,WPARAM,LPARAM);
110     LRESULT (CDECL *pWindowMessage)(HWND,UINT,WPARAM,LPARAM);
111     void   (CDECL *pWindowPosChanging)(HWND,HWND,UINT,const RECT *,const RECT *,RECT *);
112     void   (CDECL *pWindowPosChanged)(HWND,HWND,UINT,const RECT *,const RECT *,const RECT *,const RECT *);
113 } USER_DRIVER;
114
115 extern const USER_DRIVER *USER_Driver DECLSPEC_HIDDEN;
116
117 extern void USER_unload_driver(void) DECLSPEC_HIDDEN;
118
119 struct received_message_info;
120
121 enum user_obj_type
122 {
123     USER_WINDOW = 1,  /* window */
124     USER_MENU,        /* menu */
125     USER_ACCEL,       /* accelerator */
126     USER_ICON,        /* icon or cursor */
127     USER_DWP          /* DeferWindowPos structure */
128 };
129
130 struct user_object
131 {
132     HANDLE             handle;
133     enum user_obj_type type;
134 };
135
136 #define OBJ_OTHER_PROCESS ((void *)1)  /* returned by get_user_handle_ptr on unknown handles */
137
138 HANDLE alloc_user_handle( struct user_object *ptr, enum user_obj_type type ) DECLSPEC_HIDDEN;
139 void *get_user_handle_ptr( HANDLE handle, enum user_obj_type type ) DECLSPEC_HIDDEN;
140 void release_user_handle_ptr( void *ptr ) DECLSPEC_HIDDEN;
141 void *free_user_handle( HANDLE handle, enum user_obj_type type ) DECLSPEC_HIDDEN;
142
143 /* type of message-sending functions that need special WM_CHAR handling */
144 enum wm_char_mapping
145 {
146     WMCHAR_MAP_POSTMESSAGE,
147     WMCHAR_MAP_SENDMESSAGE,
148     WMCHAR_MAP_SENDMESSAGETIMEOUT,
149     WMCHAR_MAP_RECVMESSAGE,
150     WMCHAR_MAP_DISPATCHMESSAGE,
151     WMCHAR_MAP_CALLWINDOWPROC,
152     WMCHAR_MAP_COUNT,
153     WMCHAR_MAP_NOMAPPING = WMCHAR_MAP_COUNT
154 };
155
156 /* data to store state for A/W mappings of WM_CHAR */
157 struct wm_char_mapping_data
158 {
159     BYTE lead_byte[WMCHAR_MAP_COUNT];
160     MSG  get_msg;
161 };
162
163 /* this is the structure stored in TEB->Win32ClientInfo */
164 /* no attempt is made to keep the layout compatible with the Windows one */
165 struct user_thread_info
166 {
167     HANDLE                        server_queue;           /* Handle to server-side queue */
168     DWORD                         recursion_count;        /* SendMessage recursion counter */
169     BOOL                          hook_unicode;           /* Is current hook unicode? */
170     HHOOK                         hook;                   /* Current hook */
171     struct received_message_info *receive_info;           /* Message being currently received */
172     struct wm_char_mapping_data  *wmchar_data;            /* Data for WM_CHAR mappings */
173     DWORD                         GetMessageTimeVal;      /* Value for GetMessageTime */
174     DWORD                         GetMessagePosVal;       /* Value for GetMessagePos */
175     ULONG_PTR                     GetMessageExtraInfoVal; /* Value for GetMessageExtraInfo */
176     UINT                          active_hooks;           /* Bitmap of active hooks */
177     HWND                          top_window;             /* Desktop window */
178     HWND                          msg_window;             /* HWND_MESSAGE parent window */
179
180     ULONG                         pad[11];                /* Available for more data */
181 };
182
183 struct hook_extra_info
184 {
185     HHOOK handle;
186     LPARAM lparam;
187 };
188
189 static inline struct user_thread_info *get_user_thread_info(void)
190 {
191     return (struct user_thread_info *)NtCurrentTeb()->Win32ClientInfo;
192 }
193
194 /* check if hwnd is a broadcast magic handle */
195 static inline BOOL is_broadcast( HWND hwnd )
196 {
197     return (hwnd == HWND_BROADCAST || hwnd == HWND_TOPMOST);
198 }
199
200 extern HMODULE user32_module DECLSPEC_HIDDEN;
201 extern HBRUSH SYSCOLOR_55AABrush DECLSPEC_HIDDEN;
202
203 struct dce;
204
205 extern BOOL CLIPBOARD_ReleaseOwner(void) DECLSPEC_HIDDEN;
206 extern BOOL FOCUS_MouseActivate( HWND hwnd ) DECLSPEC_HIDDEN;
207 extern BOOL set_capture_window( HWND hwnd, UINT gui_flags, HWND *prev_ret ) DECLSPEC_HIDDEN;
208 extern void free_dce( struct dce *dce, HWND hwnd ) DECLSPEC_HIDDEN;
209 extern void invalidate_dce( HWND hwnd, const RECT *rect ) DECLSPEC_HIDDEN;
210 extern void erase_now( HWND hwnd, UINT rdw_flags ) DECLSPEC_HIDDEN;
211 extern void *get_hook_proc( void *proc, const WCHAR *module ) DECLSPEC_HIDDEN;
212 extern LRESULT call_current_hook( HHOOK hhook, INT code, WPARAM wparam, LPARAM lparam ) DECLSPEC_HIDDEN;
213 extern BOOL map_wparam_AtoW( UINT message, WPARAM *wparam, enum wm_char_mapping mapping ) DECLSPEC_HIDDEN;
214 extern NTSTATUS send_hardware_message( HWND hwnd, const INPUT *input, UINT flags ) DECLSPEC_HIDDEN;
215 extern LRESULT MSG_SendInternalMessageTimeout( DWORD dest_pid, DWORD dest_tid,
216                                                UINT msg, WPARAM wparam, LPARAM lparam,
217                                                UINT flags, UINT timeout, PDWORD_PTR res_ptr ) DECLSPEC_HIDDEN;
218 extern HPEN SYSCOLOR_GetPen( INT index ) DECLSPEC_HIDDEN;
219 extern void SYSPARAMS_Init(void) DECLSPEC_HIDDEN;
220 extern void USER_CheckNotLock(void) DECLSPEC_HIDDEN;
221 extern BOOL USER_IsExitingThread( DWORD tid ) DECLSPEC_HIDDEN;
222
223 extern BOOL USER_SetWindowPos( WINDOWPOS * winpos ) DECLSPEC_HIDDEN;
224
225 typedef LRESULT (*winproc_callback_t)( HWND hwnd, UINT msg, WPARAM wp, LPARAM lp,
226                                        LRESULT *result, void *arg );
227
228 extern WNDPROC WINPROC_GetProc( WNDPROC proc, BOOL unicode ) DECLSPEC_HIDDEN;
229 extern WNDPROC WINPROC_AllocProc( WNDPROC func, BOOL unicode ) DECLSPEC_HIDDEN;
230 extern BOOL WINPROC_IsUnicode( WNDPROC proc, BOOL def_val ) DECLSPEC_HIDDEN;
231
232 extern LRESULT WINPROC_CallProcAtoW( winproc_callback_t callback, HWND hwnd, UINT msg,
233                                      WPARAM wParam, LPARAM lParam, LRESULT *result, void *arg,
234                                      enum wm_char_mapping mapping ) DECLSPEC_HIDDEN;
235
236 extern INT_PTR WINPROC_CallDlgProcA( DLGPROC func, HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam ) DECLSPEC_HIDDEN;
237 extern INT_PTR WINPROC_CallDlgProcW( DLGPROC func, HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam ) DECLSPEC_HIDDEN;
238 extern BOOL WINPROC_call_window( HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam,
239                                  LRESULT *result, BOOL unicode, enum wm_char_mapping mapping ) DECLSPEC_HIDDEN;
240
241 /* message spy definitions */
242
243 #define SPY_DISPATCHMESSAGE       0x0100
244 #define SPY_SENDMESSAGE           0x0101
245 #define SPY_DEFWNDPROC            0x0102
246
247 #define SPY_RESULT_OK             0x0001
248 #define SPY_RESULT_DEFWND         0x0002
249
250 extern const char *SPY_GetClassLongOffsetName( INT offset ) DECLSPEC_HIDDEN;
251 extern const char *SPY_GetMsgName( UINT msg, HWND hWnd ) DECLSPEC_HIDDEN;
252 extern const char *SPY_GetVKeyName(WPARAM wParam) DECLSPEC_HIDDEN;
253 extern void SPY_EnterMessage( INT iFlag, HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam ) DECLSPEC_HIDDEN;
254 extern void SPY_ExitMessage( INT iFlag, HWND hwnd, UINT msg,
255                              LRESULT lReturn, WPARAM wParam, LPARAM lParam ) DECLSPEC_HIDDEN;
256 extern int SPY_Init(void) DECLSPEC_HIDDEN;
257
258 #include "pshpack1.h"
259
260 typedef struct
261 {
262     BYTE   bWidth;
263     BYTE   bHeight;
264     BYTE   bColorCount;
265     BYTE   bReserved;
266 } ICONRESDIR;
267
268 typedef struct
269 {
270     WORD   wWidth;
271     WORD   wHeight;
272 } CURSORDIR;
273
274 typedef struct
275 {   union
276     { ICONRESDIR icon;
277       CURSORDIR  cursor;
278     } ResInfo;
279     WORD   wPlanes;
280     WORD   wBitCount;
281     DWORD  dwBytesInRes;
282     WORD   wResId;
283 } CURSORICONDIRENTRY;
284
285 typedef struct
286 {
287     WORD                idReserved;
288     WORD                idType;
289     WORD                idCount;
290     CURSORICONDIRENTRY  idEntries[1];
291 } CURSORICONDIR;
292
293 #include "poppack.h"
294
295 extern BOOL get_icon_size( HICON handle, SIZE *size ) DECLSPEC_HIDDEN;
296
297 /* Mingw's assert() imports MessageBoxA and gets confused by user32 exporting it */
298 #ifdef __MINGW32__
299 #undef assert
300 #define assert(expr) ((void)0)
301 #endif
302
303 #endif /* __WINE_USER_PRIVATE_H */