Function AllowIt

source/hook.cpp:2022–2271

LRESULT AllowIt(const HHOOK aHook, int aCode, WPARAM wParam, LPARAM lParam, const vk_type aVK, const sc_type aSC
	, bool aKeyUp, ULONG_PTR aExtraInfo, KeyHistoryItem *pKeyHistoryCurr, WPARAM aHotkeyIDToPost)
// Always use the parameter vk rather than event.vkCode because the caller or caller's caller
// might have adjusted vk, namely to make it a left/right specific modifier key rather than a
// neutral one.
{
	WPARAM hs_wparam_to_post = HOTSTRING_INDEX_INVALID; // Set default.
	LPARAM hs_lparam_to_post; // Not initialized because the above is the sole indicator of whether its contents should even be examined.

	// Prevent toggleable keys from being toggled (if the user wanted that) by suppressing it.
	// Seems best to suppress key-up events as well as key-down, since a key-up by itself,
	// if seen by the system, doesn't make much sense and might have unwanted side-effects
	// in rare cases (e.g. if the foreground app takes note of these types of key events).
	// Don't do this for ignored keys because that could cause an endless loop of
	// numlock events due to the keybd events that SuppressThisKey sends.
	// It's a little more readable and comfortable not to rely on short-circuit
	// booleans and instead do these conditions as separate IF statements.
	if (aHook == g_MouseHook)
	{
		// Since a mouse button that is physically down is not necessarily logically down -- such as
		// when the mouse button is a suppressed hotkey -- only update the logical state (which is the
		// state the OS believes the key to be in) when this event is non-supressed (i.e. allowed to
		// go to the system):
#ifdef FUTURE_USE_MOUSE_BUTTONS_LOGICAL
		// THIS ENTIRE SECTION might never be necessary if it's true that GetAsyncKeyState() and
		// GetKeyState() can retrieve the logical mouse button state on Windows NT/2000/XP, which are
		// the only OSes that matter for this purpose because the hooks aren't supported on Win9x.
		KBDLLHOOKSTRUCT &event = *(PMSDLLHOOKSTRUCT)lParam;  // For convenience, maintainability, and possibly performance.
		switch (wParam)
		{
			case WM_LBUTTONUP: g_mouse_buttons_logical &= ~MK_LBUTTON; break;
			case WM_RBUTTONUP: g_mouse_buttons_logical &= ~MK_RBUTTON; break;
			case WM_MBUTTONUP: g_mouse_buttons_logical &= ~MK_MBUTTON; break;
			// WM_NCXBUTTONUP is a click in the non-client area of a window.  MSDN implies this message can be
			// received by the mouse hook  but it seems doubtful because its counterparts, such as WM_NCLBUTTONUP,
			// are apparently never received:
			case WM_NCXBUTTONUP:
			case WM_XBUTTONUP:
				g_mouse_buttons_logical &= ~(   (HIWORD(event.mouseData)) == XBUTTON1 ? MK_XBUTTON1 : MK_XBUTTON2   );
				break;
			case WM_LBUTTONDOWN: g_mouse_buttons_logical |= MK_LBUTTON; break;
			case WM_RBUTTONDOWN: g_mouse_buttons_logical |= MK_RBUTTON; break;
			case WM_MBUTTONDOWN: g_mouse_buttons_logical |= MK_MBUTTON; break;
			case WM_NCXBUTTONDOWN:
			case WM_XBUTTONDOWN:
				g_mouse_buttons_logical |= (HIWORD(event.mouseData) == XBUTTON1) ? MK_XBUTTON1 : MK_XBUTTON2;
				break;
		}
#endif
	}
	else // Our caller is the keyboard hook.
	{
		KBDLLHOOKSTRUCT &event = *(PKBDLLHOOKSTRUCT)lParam;

		bool is_ignored = IsIgnored(event.dwExtraInfo);
		if (!is_ignored)
		{
			if (kvk[aVK].pForceToggle) // Key is a toggleable key.