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