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