2 * Windows hook functions
4 * Copyright 2002 Alexandre Julliard
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.
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.
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
21 * Status of the various hooks:
23 * WH_JOURNALRECORD Partially implemented
24 * WH_JOURNALPLAYBACK Partially implemented
26 * WH_GETMESSAGE OK (FIXME: A/W mapping?)
27 * WH_CALLWNDPROC OK (FIXME: A/W mapping?)
35 * HCBT_CLICKSKIPPED OK
41 * WH_HARDWARE Not supported in Win32
42 * WH_DEBUG Not implemented
44 * HSHELL_WINDOWCREATED OK
45 * HSHELL_WINDOWDESTROYED OK
46 * HSHELL_ACTIVATESHELLWINDOW Not implemented
47 * HSHELL_WINDOWACTIVATED Not implemented
48 * HSHELL_GETMINRECT Not implemented
49 * HSHELL_REDRAW Not implemented
50 * HSHELL_TASKMAN Not implemented
51 * HSHELL_LANGUAGE Not implemented
52 * HSHELL_SYSMENU Not implemented
53 * HSHELL_ENDTASK Not implemented
54 * HSHELL_ACCESSIBILITYSTATE Not implemented
55 * HSHELL_APPCOMMAND Not implemented
56 * HSHELL_WINDOWREPLACED Not implemented
57 * HSHELL_WINDOWREPLACING Not implemented
58 * WH_FOREGROUNDIDLE Not implemented
59 * WH_CALLWNDPROCRET OK (FIXME: A/W mapping?)
60 * WH_KEYBOARD_LL Implemented but should use SendMessage instead
61 * WH_MOUSE_LL Implemented but should use SendMessage instead
65 #include "wine/port.h"
75 #include "user_private.h"
76 #include "wine/server.h"
77 #include "wine/unicode.h"
78 #include "wine/debug.h"
81 WINE_DEFAULT_DEBUG_CHANNEL(hook
);
82 WINE_DECLARE_DEBUG_CHANNEL(relay
);
84 static const char * const hook_names
[WH_MAXHOOK
- WH_MINHOOK
+ 1] =
105 /***********************************************************************
106 * get_ll_hook_timeout
109 static UINT
get_ll_hook_timeout(void)
111 /* FIXME: should retrieve LowLevelHooksTimeout in HKEY_CURRENT_USER\Control Panel\Desktop */
116 /***********************************************************************
119 * Implementation of SetWindowsHookExA and SetWindowsHookExW.
121 static HHOOK
set_windows_hook( INT id
, HOOKPROC proc
, HINSTANCE inst
, DWORD tid
, BOOL unicode
)
124 WCHAR module
[MAX_PATH
];
127 if (tid
) /* thread-local hook */
129 if (id
== WH_JOURNALRECORD
||
130 id
== WH_JOURNALPLAYBACK
||
131 id
== WH_KEYBOARD_LL
||
133 id
== WH_SYSMSGFILTER
)
135 /* these can only be global */
136 SetLastError( ERROR_INVALID_PARAMETER
);
141 else /* system-global hook */
143 if (id
== WH_KEYBOARD_LL
|| id
== WH_MOUSE_LL
) inst
= 0;
144 else if (!inst
|| !(len
= GetModuleFileNameW( inst
, module
, MAX_PATH
)) || len
>= MAX_PATH
)
146 SetLastError( ERROR_INVALID_PARAMETER
);
151 SERVER_START_REQ( set_hook
)
155 req
->unicode
= unicode
;
156 if (inst
) /* make proc relative to the module base */
158 req
->proc
= (void *)((char *)proc
- (char *)inst
);
159 wine_server_add_data( req
, module
, strlenW(module
) * sizeof(WCHAR
) );
161 else req
->proc
= proc
;
163 if (!wine_server_call_err( req
)) handle
= reply
->handle
;
167 TRACE( "%s %p %lx -> %p\n", hook_names
[id
-WH_MINHOOK
], proc
, tid
, handle
);
172 /***********************************************************************
175 static LRESULT
call_hook_AtoW( HOOKPROC proc
, INT id
, INT code
, WPARAM wparam
, LPARAM lparam
)
178 UNICODE_STRING usBuffer
;
179 if (id
!= WH_CBT
|| code
!= HCBT_CREATEWND
) ret
= proc( code
, wparam
, lparam
);
182 CBT_CREATEWNDA
*cbtcwA
= (CBT_CREATEWNDA
*)lparam
;
183 CBT_CREATEWNDW cbtcwW
;
187 cbtcwW
.hwndInsertAfter
= cbtcwA
->hwndInsertAfter
;
188 csW
= *(CREATESTRUCTW
*)cbtcwA
->lpcs
;
190 if (HIWORD(cbtcwA
->lpcs
->lpszName
))
192 RtlCreateUnicodeStringFromAsciiz(&usBuffer
,cbtcwA
->lpcs
->lpszName
);
193 csW
.lpszName
= usBuffer
.Buffer
;
195 if (HIWORD(cbtcwA
->lpcs
->lpszClass
))
197 RtlCreateUnicodeStringFromAsciiz(&usBuffer
,cbtcwA
->lpcs
->lpszClass
);
198 csW
.lpszClass
= usBuffer
.Buffer
;
200 ret
= proc( code
, wparam
, (LPARAM
)&cbtcwW
);
201 cbtcwA
->hwndInsertAfter
= cbtcwW
.hwndInsertAfter
;
202 if (HIWORD(csW
.lpszName
)) HeapFree( GetProcessHeap(), 0, (LPWSTR
)csW
.lpszName
);
203 if (HIWORD(csW
.lpszClass
)) HeapFree( GetProcessHeap(), 0, (LPWSTR
)csW
.lpszClass
);
209 /***********************************************************************
212 static LRESULT
call_hook_WtoA( HOOKPROC proc
, INT id
, INT code
, WPARAM wparam
, LPARAM lparam
)
216 if (id
!= WH_CBT
|| code
!= HCBT_CREATEWND
) ret
= proc( code
, wparam
, lparam
);
219 CBT_CREATEWNDW
*cbtcwW
= (CBT_CREATEWNDW
*)lparam
;
220 CBT_CREATEWNDA cbtcwA
;
225 cbtcwA
.hwndInsertAfter
= cbtcwW
->hwndInsertAfter
;
226 csA
= *(CREATESTRUCTA
*)cbtcwW
->lpcs
;
228 if (HIWORD(cbtcwW
->lpcs
->lpszName
)) {
229 len
= WideCharToMultiByte( CP_ACP
, 0, cbtcwW
->lpcs
->lpszName
, -1, NULL
, 0, NULL
, NULL
);
230 csA
.lpszName
= HeapAlloc( GetProcessHeap(), 0, len
*sizeof(CHAR
) );
231 WideCharToMultiByte( CP_ACP
, 0, cbtcwW
->lpcs
->lpszName
, -1, (LPSTR
)csA
.lpszName
, len
, NULL
, NULL
);
234 if (HIWORD(cbtcwW
->lpcs
->lpszClass
)) {
235 len
= WideCharToMultiByte( CP_ACP
, 0, cbtcwW
->lpcs
->lpszClass
, -1, NULL
, 0, NULL
, NULL
);
236 csA
.lpszClass
= HeapAlloc( GetProcessHeap(), 0, len
*sizeof(CHAR
) );
237 WideCharToMultiByte( CP_ACP
, 0, cbtcwW
->lpcs
->lpszClass
, -1, (LPSTR
)csA
.lpszClass
, len
, NULL
, NULL
);
240 ret
= proc( code
, wparam
, (LPARAM
)&cbtcwA
);
241 cbtcwW
->hwndInsertAfter
= cbtcwA
.hwndInsertAfter
;
242 if (HIWORD(csA
.lpszName
)) HeapFree( GetProcessHeap(), 0, (LPSTR
)csA
.lpszName
);
243 if (HIWORD(csA
.lpszClass
)) HeapFree( GetProcessHeap(), 0, (LPSTR
)csA
.lpszClass
);
249 /***********************************************************************
252 static LRESULT
call_hook( HOOKPROC proc
, INT id
, INT code
, WPARAM wparam
, LPARAM lparam
,
253 BOOL prev_unicode
, BOOL next_unicode
)
258 DPRINTF( "%04lx:Call hook proc %p (id=%s,code=%x,wp=%08x,lp=%08lx)\n",
259 GetCurrentThreadId(), proc
, hook_names
[id
-WH_MINHOOK
], code
, wparam
, lparam
);
261 if (!prev_unicode
== !next_unicode
) ret
= proc( code
, wparam
, lparam
);
262 else if (prev_unicode
) ret
= call_hook_WtoA( proc
, id
, code
, wparam
, lparam
);
263 else ret
= call_hook_AtoW( proc
, id
, code
, wparam
, lparam
);
266 DPRINTF( "%04lx:Ret hook proc %p (id=%s,code=%x,wp=%08x,lp=%08lx) retval=%08lx\n",
267 GetCurrentThreadId(), proc
, hook_names
[id
-WH_MINHOOK
], code
, wparam
, lparam
, ret
);
273 /***********************************************************************
276 * Retrieve the hook procedure real value for a module-relative proc
278 static HOOKPROC
get_hook_proc( HOOKPROC proc
, const WCHAR
*module
)
282 if (!(mod
= GetModuleHandleW(module
)))
284 TRACE( "loading %s\n", debugstr_w(module
) );
285 /* FIXME: the library will never be freed */
286 if (!(mod
= LoadLibraryW(module
))) return NULL
;
288 return (HOOKPROC
)((char *)mod
+ (ULONG_PTR
)proc
);
292 /***********************************************************************
295 LRESULT
HOOK_CallHooks( INT id
, INT code
, WPARAM wparam
, LPARAM lparam
, BOOL unicode
)
297 MESSAGEQUEUE
*queue
= QUEUE_Current();
298 HOOKPROC proc
= NULL
;
300 DWORD pid
= 0, tid
= 0;
301 WCHAR module
[MAX_PATH
];
302 BOOL unicode_hook
= FALSE
;
305 if (!queue
) return 0;
306 SERVER_START_REQ( start_hook_chain
)
309 wine_server_set_reply( req
, module
, sizeof(module
)-sizeof(WCHAR
) );
310 if (!wine_server_call( req
))
312 module
[wine_server_reply_size(req
) / sizeof(WCHAR
)] = 0;
313 handle
= reply
->handle
;
317 unicode_hook
= reply
->unicode
;
324 TRACE( "calling hook in thread %04lx %s code %x wp %x lp %lx\n",
325 tid
, hook_names
[id
-WH_MINHOOK
], code
, wparam
, lparam
);
330 MSG_SendInternalMessageTimeout( pid
, tid
, WM_WINE_KEYBOARD_LL_HOOK
, wparam
, lparam
,
331 SMTO_ABORTIFHUNG
, get_ll_hook_timeout(), &ret
);
334 MSG_SendInternalMessageTimeout( pid
, tid
, WM_WINE_MOUSE_LL_HOOK
, wparam
, lparam
,
335 SMTO_ABORTIFHUNG
, get_ll_hook_timeout(), &ret
);
341 TRACE( "calling hook %p %s code %x wp %x lp %lx module %s\n",
342 proc
, hook_names
[id
-WH_MINHOOK
], code
, wparam
, lparam
, debugstr_w(module
) );
344 if (!module
[0] || (proc
= get_hook_proc( proc
, module
)) != NULL
)
346 int locks
= WIN_SuspendWndsLock();
347 HHOOK prev
= queue
->hook
;
348 queue
->hook
= handle
;
349 ret
= call_hook( proc
, id
, code
, wparam
, lparam
, unicode
, unicode_hook
);
351 WIN_RestoreWndsLock( locks
);
357 SERVER_START_REQ( finish_hook_chain
)
360 wine_server_call( req
);
367 /***********************************************************************
370 BOOL
HOOK_IsHooked( INT id
)
372 return TRUE
; /* FIXME */
376 /***********************************************************************
377 * SetWindowsHookA (USER32.@)
379 HHOOK WINAPI
SetWindowsHookA( INT id
, HOOKPROC proc
)
381 return SetWindowsHookExA( id
, proc
, 0, GetCurrentThreadId() );
385 /***********************************************************************
386 * SetWindowsHookW (USER32.@)
388 HHOOK WINAPI
SetWindowsHookW( INT id
, HOOKPROC proc
)
390 return SetWindowsHookExW( id
, proc
, 0, GetCurrentThreadId() );
394 /***********************************************************************
395 * SetWindowsHookExA (USER32.@)
397 HHOOK WINAPI
SetWindowsHookExA( INT id
, HOOKPROC proc
, HINSTANCE inst
, DWORD tid
)
399 return set_windows_hook( id
, proc
, inst
, tid
, FALSE
);
402 /***********************************************************************
403 * SetWindowsHookExW (USER32.@)
405 HHOOK WINAPI
SetWindowsHookExW( INT id
, HOOKPROC proc
, HINSTANCE inst
, DWORD tid
)
407 return set_windows_hook( id
, proc
, inst
, tid
, TRUE
);
411 /***********************************************************************
412 * UnhookWindowsHook (USER32.@)
414 BOOL WINAPI
UnhookWindowsHook( INT id
, HOOKPROC proc
)
418 TRACE( "%s %p\n", hook_names
[id
-WH_MINHOOK
], proc
);
420 SERVER_START_REQ( remove_hook
)
425 ret
= !wine_server_call_err( req
);
433 /***********************************************************************
434 * UnhookWindowsHookEx (USER32.@)
436 BOOL WINAPI
UnhookWindowsHookEx( HHOOK hhook
)
440 TRACE( "%p\n", hhook
);
442 SERVER_START_REQ( remove_hook
)
445 ret
= !wine_server_call_err( req
);
452 /***********************************************************************
453 * CallNextHookEx (USER32.@)
455 LRESULT WINAPI
CallNextHookEx( HHOOK hhook
, INT code
, WPARAM wparam
, LPARAM lparam
)
457 MESSAGEQUEUE
*queue
= QUEUE_Current();
458 HOOKPROC proc
= NULL
;
459 WCHAR module
[MAX_PATH
];
461 DWORD pid
= 0, tid
= 0;
463 BOOL prev_unicode
= FALSE
, next_unicode
= FALSE
;
466 if (!queue
) return 0;
468 SERVER_START_REQ( get_next_hook
)
470 req
->handle
= queue
->hook
;
471 wine_server_set_reply( req
, module
, sizeof(module
)-sizeof(WCHAR
) );
472 if (!wine_server_call_err( req
))
474 module
[wine_server_reply_size(req
) / sizeof(WCHAR
)] = 0;
475 handle
= reply
->next
;
480 prev_unicode
= reply
->prev_unicode
;
481 next_unicode
= reply
->next_unicode
;
488 TRACE( "calling hook in thread %04lx %s code %x wp %x lp %lx\n",
489 tid
, hook_names
[id
-WH_MINHOOK
], code
, wparam
, lparam
);
494 MSG_SendInternalMessageTimeout( pid
, tid
, WM_WINE_KEYBOARD_LL_HOOK
, wparam
, lparam
,
495 SMTO_ABORTIFHUNG
, get_ll_hook_timeout(), &ret
);
498 MSG_SendInternalMessageTimeout( pid
, tid
, WM_WINE_MOUSE_LL_HOOK
, wparam
, lparam
,
499 SMTO_ABORTIFHUNG
, get_ll_hook_timeout(), &ret
);
505 TRACE( "calling hook %p %s code %x wp %x lp %lx module %s\n",
506 proc
, hook_names
[id
-WH_MINHOOK
], code
, wparam
, lparam
, debugstr_w(module
) );
508 if (!module
[0] || (proc
= get_hook_proc( proc
, module
)) != NULL
)
510 HHOOK prev
= queue
->hook
;
511 queue
->hook
= handle
;
512 ret
= call_hook( proc
, id
, code
, wparam
, lparam
, prev_unicode
, next_unicode
);
520 /***********************************************************************
521 * CallMsgFilterA (USER32.@)
523 BOOL WINAPI
CallMsgFilterA( LPMSG msg
, INT code
)
525 if (HOOK_CallHooks( WH_SYSMSGFILTER
, code
, 0, (LPARAM
)msg
, FALSE
)) return TRUE
;
526 return HOOK_CallHooks( WH_MSGFILTER
, code
, 0, (LPARAM
)msg
, FALSE
);
530 /***********************************************************************
531 * CallMsgFilterW (USER32.@)
533 BOOL WINAPI
CallMsgFilterW( LPMSG msg
, INT code
)
535 if (HOOK_CallHooks( WH_SYSMSGFILTER
, code
, 0, (LPARAM
)msg
, TRUE
)) return TRUE
;
536 return HOOK_CallHooks( WH_MSGFILTER
, code
, 0, (LPARAM
)msg
, TRUE
);
540 /***********************************************************************
541 * SetWinEventHook [USER32.@]
543 * Set up an event hook for a set of events.
546 * dwMin [I] Lowest event handled by pfnProc
547 * dwMax [I] Highest event handled by pfnProc
548 * hModule [I] DLL containing pfnProc
549 * pfnProc [I] Callback event hook function
550 * dwProcess [I] Process to get events from, or 0 for all processes
551 * dwThread [I] Thread to get events from, or 0 for all threads
552 * dwFlags [I] Flags indicating the status of pfnProc
555 * Success: A handle representing the hook.
556 * Failure: A NULL handle.
561 HWINEVENTHOOK WINAPI
SetWinEventHook(DWORD dwMin
, DWORD dwMax
, HMODULE hModule
,
562 WINEVENTPROC pfnProc
, DWORD dwProcess
,
563 DWORD dwThread
, DWORD dwFlags
)
565 FIXME("(%ld,%ld,%p,%p,%ld,%ld,0x%08lx)-stub!\n", dwMin
, dwMax
, hModule
,
566 pfnProc
, dwProcess
, dwThread
, dwFlags
);
571 /***********************************************************************
572 * UnhookWinEvent [USER32.@]
574 * Remove an event hook for a set of events.
577 * hEventHook [I] Event hook to remove
580 * Success: TRUE. The event hook has been removed.
581 * Failure: FALSE, if hEventHook is invalid.
586 BOOL WINAPI
UnhookWinEvent(HWINEVENTHOOK hEventHook
)
588 FIXME("(%p)-stub!\n", hEventHook
);
590 return (hEventHook
!= 0);
594 /***********************************************************************
595 * NotifyWinEvent [USER32.@]
597 * Inform the OS that an event has occurred.
600 * dwEvent [I] Id of the event
601 * hWnd [I] Window holding the object that created the event
602 * nId [I] Type of object that created the event
603 * nChildId [I] Child object of nId, or CHILDID_SELF.
611 void WINAPI
NotifyWinEvent(DWORD dwEvent
, HWND hWnd
, LONG nId
, LONG nChildId
)
613 FIXME("(%ld,%p,%ld,%ld)-stub!\n", dwEvent
, hWnd
, nId
, nChildId
);
617 /***********************************************************************
618 * IsWinEventHookInstalled [USER32.@]
620 * Determine if an event hook is installed for an event.
623 * dwEvent [I] Id of the event
626 * TRUE, If there are any hooks installed for the event.
632 BOOL WINAPI
IsWinEventHookInstalled(DWORD dwEvent
)
634 FIXME("(%ld)-stub!\n", dwEvent
);