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
37 * HCBT_SYSCOMMAND Not implemented
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
73 #include "wine/server.h"
74 #include "wine/unicode.h"
75 #include "wine/debug.h"
78 WINE_DEFAULT_DEBUG_CHANNEL(hook
);
79 WINE_DECLARE_DEBUG_CHANNEL(relay
);
81 static const char * const hook_names
[WH_MAXHOOK
- WH_MINHOOK
+ 1] =
102 /***********************************************************************
103 * get_ll_hook_timeout
106 static UINT
get_ll_hook_timeout(void)
108 /* FIXME: should retrieve LowLevelHooksTimeout in HKEY_CURRENT_USER\Control Panel\Desktop */
113 /***********************************************************************
116 * Implementation of SetWindowsHookExA and SetWindowsHookExW.
118 static HHOOK
set_windows_hook( INT id
, HOOKPROC proc
, HINSTANCE inst
, DWORD tid
, BOOL unicode
)
121 WCHAR module
[MAX_PATH
];
123 if (tid
) /* thread-local hook */
125 if (id
== WH_JOURNALRECORD
||
126 id
== WH_JOURNALPLAYBACK
||
127 id
== WH_KEYBOARD_LL
||
129 id
== WH_SYSMSGFILTER
)
131 /* these can only be global */
132 SetLastError( ERROR_INVALID_PARAMETER
);
137 else /* system-global hook */
139 if (id
== WH_KEYBOARD_LL
|| id
== WH_MOUSE_LL
) inst
= 0;
140 else if (!inst
|| !GetModuleFileNameW( inst
, module
, MAX_PATH
))
142 SetLastError( ERROR_INVALID_PARAMETER
);
147 SERVER_START_REQ( set_hook
)
151 req
->unicode
= unicode
;
152 if (inst
) /* make proc relative to the module base */
154 req
->proc
= (void *)((char *)proc
- (char *)inst
);
155 wine_server_add_data( req
, module
, strlenW(module
) * sizeof(WCHAR
) );
157 else req
->proc
= proc
;
159 if (!wine_server_call_err( req
)) handle
= reply
->handle
;
163 TRACE( "%s %p %lx -> %p\n", hook_names
[id
-WH_MINHOOK
], proc
, tid
, handle
);
168 /***********************************************************************
171 static LRESULT
call_hook_AtoW( HOOKPROC proc
, INT id
, INT code
, WPARAM wparam
, LPARAM lparam
)
174 UNICODE_STRING usBuffer
;
175 if (id
!= WH_CBT
|| code
!= HCBT_CREATEWND
) ret
= proc( code
, wparam
, lparam
);
178 CBT_CREATEWNDA
*cbtcwA
= (CBT_CREATEWNDA
*)lparam
;
179 CBT_CREATEWNDW cbtcwW
;
183 cbtcwW
.hwndInsertAfter
= cbtcwA
->hwndInsertAfter
;
184 csW
= *(CREATESTRUCTW
*)cbtcwA
->lpcs
;
186 if (HIWORD(cbtcwA
->lpcs
->lpszName
))
188 RtlCreateUnicodeStringFromAsciiz(&usBuffer
,cbtcwA
->lpcs
->lpszName
);
189 csW
.lpszName
= usBuffer
.Buffer
;
191 if (HIWORD(cbtcwA
->lpcs
->lpszClass
))
193 RtlCreateUnicodeStringFromAsciiz(&usBuffer
,cbtcwA
->lpcs
->lpszName
);
194 csW
.lpszClass
= usBuffer
.Buffer
;
196 ret
= proc( code
, wparam
, (LPARAM
)&cbtcwW
);
197 cbtcwA
->hwndInsertAfter
= cbtcwW
.hwndInsertAfter
;
198 if (HIWORD(csW
.lpszName
)) HeapFree( GetProcessHeap(), 0, (LPWSTR
)csW
.lpszName
);
199 if (HIWORD(csW
.lpszClass
)) HeapFree( GetProcessHeap(), 0, (LPWSTR
)csW
.lpszClass
);
205 /***********************************************************************
208 static LRESULT
call_hook_WtoA( HOOKPROC proc
, INT id
, INT code
, WPARAM wparam
, LPARAM lparam
)
212 if (id
!= WH_CBT
|| code
!= HCBT_CREATEWND
) ret
= proc( code
, wparam
, lparam
);
215 CBT_CREATEWNDW
*cbtcwW
= (CBT_CREATEWNDW
*)lparam
;
216 CBT_CREATEWNDA cbtcwA
;
220 cbtcwA
.hwndInsertAfter
= cbtcwW
->hwndInsertAfter
;
221 csA
= *(CREATESTRUCTA
*)cbtcwW
->lpcs
;
223 if (HIWORD(cbtcwW
->lpcs
->lpszName
))
224 csA
.lpszName
= HEAP_strdupWtoA( GetProcessHeap(), 0, cbtcwW
->lpcs
->lpszName
);
225 if (HIWORD(cbtcwW
->lpcs
->lpszClass
))
226 csA
.lpszClass
= HEAP_strdupWtoA( GetProcessHeap(), 0, cbtcwW
->lpcs
->lpszClass
);
227 ret
= proc( code
, wparam
, (LPARAM
)&cbtcwA
);
228 cbtcwW
->hwndInsertAfter
= cbtcwA
.hwndInsertAfter
;
229 if (HIWORD(csA
.lpszName
)) HeapFree( GetProcessHeap(), 0, (LPSTR
)csA
.lpszName
);
230 if (HIWORD(csA
.lpszClass
)) HeapFree( GetProcessHeap(), 0, (LPSTR
)csA
.lpszClass
);
236 /***********************************************************************
239 static LRESULT
call_hook( HOOKPROC proc
, INT id
, INT code
, WPARAM wparam
, LPARAM lparam
,
240 BOOL prev_unicode
, BOOL next_unicode
)
245 DPRINTF( "%04lx:Call hook proc %p (id=%s,code=%x,wp=%08x,lp=%08lx)\n",
246 GetCurrentThreadId(), proc
, hook_names
[id
-WH_MINHOOK
], code
, wparam
, lparam
);
248 if (!prev_unicode
== !next_unicode
) ret
= proc( code
, wparam
, lparam
);
249 else if (prev_unicode
) ret
= call_hook_WtoA( proc
, id
, code
, wparam
, lparam
);
250 else ret
= call_hook_AtoW( proc
, id
, code
, wparam
, lparam
);
253 DPRINTF( "%04lx:Ret hook proc %p (id=%s,code=%x,wp=%08x,lp=%08lx) retval=%08lx\n",
254 GetCurrentThreadId(), proc
, hook_names
[id
-WH_MINHOOK
], code
, wparam
, lparam
, ret
);
260 /***********************************************************************
263 * Retrieve the hook procedure real value for a module-relative proc
265 static HOOKPROC
get_hook_proc( HOOKPROC proc
, const WCHAR
*module
)
269 if (!(mod
= GetModuleHandleW(module
)))
271 TRACE( "loading %s\n", debugstr_w(module
) );
272 /* FIXME: the library will never be freed */
273 if (!(mod
= LoadLibraryW(module
))) return NULL
;
275 return (HOOKPROC
)((char *)mod
+ (ULONG_PTR
)proc
);
279 /***********************************************************************
282 LRESULT
HOOK_CallHooks( INT id
, INT code
, WPARAM wparam
, LPARAM lparam
, BOOL unicode
)
284 MESSAGEQUEUE
*queue
= QUEUE_Current();
285 HOOKPROC proc
= NULL
;
287 DWORD pid
= 0, tid
= 0;
288 WCHAR module
[MAX_PATH
];
289 BOOL unicode_hook
= FALSE
;
292 if (!queue
) return 0;
293 SERVER_START_REQ( start_hook_chain
)
296 wine_server_set_reply( req
, module
, sizeof(module
)-sizeof(WCHAR
) );
297 if (!wine_server_call( req
))
299 module
[wine_server_reply_size(req
) / sizeof(WCHAR
)] = 0;
300 handle
= reply
->handle
;
304 unicode_hook
= reply
->unicode
;
311 TRACE( "calling hook in thread %04lx %s code %x wp %x lp %lx\n",
312 tid
, hook_names
[id
-WH_MINHOOK
], code
, wparam
, lparam
);
317 MSG_SendInternalMessageTimeout( pid
, tid
, WM_WINE_KEYBOARD_LL_HOOK
, wparam
, lparam
,
318 SMTO_ABORTIFHUNG
, get_ll_hook_timeout(), &ret
);
321 MSG_SendInternalMessageTimeout( pid
, tid
, WM_WINE_MOUSE_LL_HOOK
, wparam
, lparam
,
322 SMTO_ABORTIFHUNG
, get_ll_hook_timeout(), &ret
);
328 TRACE( "calling hook %p %s code %x wp %x lp %lx module %s\n",
329 proc
, hook_names
[id
-WH_MINHOOK
], code
, wparam
, lparam
, debugstr_w(module
) );
331 if (!module
[0] || (proc
= get_hook_proc( proc
, module
)) != NULL
)
333 int locks
= WIN_SuspendWndsLock();
334 HHOOK prev
= queue
->hook
;
335 queue
->hook
= handle
;
336 ret
= call_hook( proc
, id
, code
, wparam
, lparam
, unicode
, unicode_hook
);
338 WIN_RestoreWndsLock( locks
);
344 SERVER_START_REQ( finish_hook_chain
)
347 wine_server_call( req
);
354 /***********************************************************************
357 BOOL
HOOK_IsHooked( INT id
)
359 return TRUE
; /* FIXME */
363 /***********************************************************************
364 * SetWindowsHookA (USER32.@)
366 HHOOK WINAPI
SetWindowsHookA( INT id
, HOOKPROC proc
)
368 return SetWindowsHookExA( id
, proc
, 0, GetCurrentThreadId() );
372 /***********************************************************************
373 * SetWindowsHookW (USER32.@)
375 HHOOK WINAPI
SetWindowsHookW( INT id
, HOOKPROC proc
)
377 return SetWindowsHookExW( id
, proc
, 0, GetCurrentThreadId() );
381 /***********************************************************************
382 * SetWindowsHookExA (USER32.@)
384 HHOOK WINAPI
SetWindowsHookExA( INT id
, HOOKPROC proc
, HINSTANCE inst
, DWORD tid
)
386 return set_windows_hook( id
, proc
, inst
, tid
, FALSE
);
389 /***********************************************************************
390 * SetWindowsHookExW (USER32.@)
392 HHOOK WINAPI
SetWindowsHookExW( INT id
, HOOKPROC proc
, HINSTANCE inst
, DWORD tid
)
394 return set_windows_hook( id
, proc
, inst
, tid
, TRUE
);
398 /***********************************************************************
399 * UnhookWindowsHook (USER32.@)
401 BOOL WINAPI
UnhookWindowsHook( INT id
, HOOKPROC proc
)
405 TRACE( "%s %p\n", hook_names
[id
-WH_MINHOOK
], proc
);
407 SERVER_START_REQ( remove_hook
)
412 ret
= !wine_server_call_err( req
);
420 /***********************************************************************
421 * UnhookWindowsHookEx (USER32.@)
423 BOOL WINAPI
UnhookWindowsHookEx( HHOOK hhook
)
427 TRACE( "%p\n", hhook
);
429 SERVER_START_REQ( remove_hook
)
432 ret
= !wine_server_call_err( req
);
439 /***********************************************************************
440 * CallNextHookEx (USER32.@)
442 LRESULT WINAPI
CallNextHookEx( HHOOK hhook
, INT code
, WPARAM wparam
, LPARAM lparam
)
444 MESSAGEQUEUE
*queue
= QUEUE_Current();
445 HOOKPROC proc
= NULL
;
446 WCHAR module
[MAX_PATH
];
448 DWORD pid
= 0, tid
= 0;
450 BOOL prev_unicode
= FALSE
, next_unicode
= FALSE
;
453 if (!queue
) return 0;
455 SERVER_START_REQ( get_next_hook
)
457 req
->handle
= queue
->hook
;
458 wine_server_set_reply( req
, module
, sizeof(module
)-sizeof(WCHAR
) );
459 if (!wine_server_call_err( req
))
461 module
[wine_server_reply_size(req
) / sizeof(WCHAR
)] = 0;
462 handle
= reply
->next
;
467 prev_unicode
= reply
->prev_unicode
;
468 next_unicode
= reply
->next_unicode
;
475 TRACE( "calling hook in thread %04lx %s code %x wp %x lp %lx\n",
476 tid
, hook_names
[id
-WH_MINHOOK
], code
, wparam
, lparam
);
481 MSG_SendInternalMessageTimeout( pid
, tid
, WM_WINE_KEYBOARD_LL_HOOK
, wparam
, lparam
,
482 SMTO_ABORTIFHUNG
, get_ll_hook_timeout(), &ret
);
485 MSG_SendInternalMessageTimeout( pid
, tid
, WM_WINE_MOUSE_LL_HOOK
, wparam
, lparam
,
486 SMTO_ABORTIFHUNG
, get_ll_hook_timeout(), &ret
);
492 TRACE( "calling hook %p %s code %x wp %x lp %lx module %s\n",
493 proc
, hook_names
[id
-WH_MINHOOK
], code
, wparam
, lparam
, debugstr_w(module
) );
495 if (!module
[0] || (proc
= get_hook_proc( proc
, module
)) != NULL
)
497 HHOOK prev
= queue
->hook
;
498 queue
->hook
= handle
;
499 ret
= call_hook( proc
, id
, code
, wparam
, lparam
, prev_unicode
, next_unicode
);
507 /***********************************************************************
508 * CallMsgFilterA (USER32.@)
510 BOOL WINAPI
CallMsgFilterA( LPMSG msg
, INT code
)
512 if (HOOK_CallHooks( WH_SYSMSGFILTER
, code
, 0, (LPARAM
)msg
, FALSE
)) return TRUE
;
513 return HOOK_CallHooks( WH_MSGFILTER
, code
, 0, (LPARAM
)msg
, FALSE
);
517 /***********************************************************************
518 * CallMsgFilterW (USER32.@)
520 BOOL WINAPI
CallMsgFilterW( LPMSG msg
, INT code
)
522 if (HOOK_CallHooks( WH_SYSMSGFILTER
, code
, 0, (LPARAM
)msg
, TRUE
)) return TRUE
;
523 return HOOK_CallHooks( WH_MSGFILTER
, code
, 0, (LPARAM
)msg
, TRUE
);
527 /***********************************************************************
528 * SetWinEventHook [USER32.@]
530 * Set up an event hook for a set of events.
533 * dwMin [I] Lowest event handled by pfnProc
534 * dwMax [I] Highest event handled by pfnProc
535 * hModule [I] DLL containing pfnProc
536 * pfnProc [I] Callback event hook function
537 * dwProcess [I] Process to get events from, or 0 for all processes
538 * dwThread [I] Thread to get events from, or 0 for all threads
539 * dwFlags [I] Flags indicating the status of pfnProc
542 * Success: A handle representing the hook.
543 * Failure: A NULL handle.
548 HWINEVENTHOOK WINAPI
SetWinEventHook(DWORD dwMin
, DWORD dwMax
, HMODULE hModule
,
549 WINEVENTPROC pfnProc
, DWORD dwProcess
,
550 DWORD dwThread
, DWORD dwFlags
)
552 FIXME("(%ld,%ld,%p,%p,%ld,%ld,0x%08lx)-stub!\n", dwMin
, dwMax
, hModule
,
553 pfnProc
, dwProcess
, dwThread
, dwFlags
);
558 /***********************************************************************
559 * UnhookWinEvent [USER32.@]
561 * Remove an event hook for a set of events.
564 * hEventHook [I] Event hook to remove
567 * Success: TRUE. The event hook has been removed.
568 * Failure: FALSE, if hEventHook is invalid.
573 BOOL WINAPI
UnhookWinEvent(HWINEVENTHOOK hEventHook
)
575 FIXME("(%p)-stub!\n", hEventHook
);
577 return (hEventHook
!= 0);
581 /***********************************************************************
582 * NotifyWinEvent [USER32.@]
584 * Inform the OS that an event has occurred.
587 * dwEvent [I] Id of the event
588 * hWnd [I] Window holding the object that created the event
589 * nId [I] Type of object that created the event
590 * nChildId [I] Child object of nId, or CHILDID_SELF.
598 void WINAPI
NotifyWinEvent(DWORD dwEvent
, HWND hWnd
, LONG nId
, LONG nChildId
)
600 FIXME("(%ld,%p,%ld,%ld)-stub!\n", dwEvent
, hWnd
, nId
, nChildId
);
604 /***********************************************************************
605 * IsWinEventHookInstalled [USER32.@]
607 * Determine if an event hook is installed for an event.
610 * dwEvent [I] Id of the event
613 * TRUE, If there are any hooks installed for the event.
619 BOOL WINAPI
IsWinEventHookInstalled(DWORD dwEvent
)
621 FIXME("(%ld)-stub!\n", dwEvent
);