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