Fix keyboard hooks

Author: 0niel

lib/src/app/bootstrap.dart

@@ -418,6 +418,7 @@ class _AppState extends State<App>
     await windowManager.setSize(size);
     await windowManager.setAlwaysOnTop(true);
     await windowManager.center();
+    await WidgetsBinding.instance.endOfFrame;
     await _showOverlayWindowInactive(widget.overlayGateway);
   }
 

pubspec.lock

@@ -29,10 +29,10 @@ packages:
     dependency: transitive
     description:
       name: characters
-      sha256: faf38497bda5ead2a8c7615f4f7939df04333478bf32e4173fcb06d428b5716b
+      sha256: f71061c654a3380576a52b451dd5532377954cf9dbd272a78fc8479606670803
       url: "https://pub.dev"
     source: hosted
-    version: "1.4.1"
+    version: "1.4.0"
   clock:
     dependency: transitive
     description:
@@ -271,18 +271,18 @@ packages:
     dependency: transitive
     description:
       name: matcher
-      sha256: dc0b7dc7651697ea4ff3e69ef44b0407ea32c487a39fff6a4004fa585e901861
+      sha256: dc58c723c3c24bf8d3e2d3ad3f2f9d7bd9cf43ec6feaa64181775e60190153f2
       url: "https://pub.dev"
     source: hosted
-    version: "0.12.19"
+    version: "0.12.17"
   material_color_utilities:
     dependency: transitive
     description:
       name: material_color_utilities
-      sha256: "9c337007e82b1889149c82ed242ed1cb24a66044e30979c44912381e9be4c48b"
+      sha256: f7142bb1154231d7ea5f96bc7bde4bda2a0945d2806bb11670e30b850d56bdec
       url: "https://pub.dev"
     source: hosted
-    version: "0.13.0"
+    version: "0.11.1"
   menu_base:
     dependency: transitive
     description:
@@ -295,10 +295,10 @@ packages:
     dependency: transitive
     description:
       name: meta
-      sha256: "1741988757a65eb6b36abe716829688cf01910bbf91c34354ff7ec1c3de2b349"
+      sha256: "23f08335362185a5ea2ad3a4e597f1375e78bce8a040df5c600c8d3552ef2394"
       url: "https://pub.dev"
     source: hosted
-    version: "1.18.0"
+    version: "1.17.0"
   nested:
     dependency: transitive
     description:
@@ -492,10 +492,10 @@ packages:
     dependency: transitive
     description:
       name: test_api
-      sha256: "949a932224383300f01be9221c39180316445ecb8e7547f70a41a35bf421fb9e"
+      sha256: ab2726c1a94d3176a45960b6234466ec367179b87dd74f1611adb1f3b5fb9d55
       url: "https://pub.dev"
     source: hosted
-    version: "0.7.11"
+    version: "0.7.7"
   tray_manager:
     dependency: "direct main"
     description:

windows/runner/flutter_window.cpp

@@ -2,6 +2,7 @@
 
 #include <flutter/standard_method_codec.h>
 
+#include <algorithm>
 #include <optional>
 
 #include "flutter/generated_plugin_registrant.h"
@@ -10,6 +11,7 @@ namespace {
 
 constexpr char kHotkeyChannel[] = "ykd/native_hotkeys";
 constexpr char kOverlayChannel[] = "ykd/overlay";
+constexpr UINT kHotkeyMessage = WM_APP + 0x101;
 constexpr UINT kOutsideClickMessage = WM_APP + 0x102;
 
 FlutterWindow* g_hotkey_window = nullptr;
@@ -24,6 +26,19 @@ int ReadInt(const flutter::EncodableMap& map, const char* key) {
   return 0;
 }
 
+bool ModifierDown(int virtual_key) {
+  return (::GetAsyncKeyState(virtual_key) & 0x8000) != 0;
+}
+
+UINT CurrentModifiers() {
+  UINT modifiers = 0;
+  if (ModifierDown(VK_MENU)) modifiers |= MOD_ALT;
+  if (ModifierDown(VK_CONTROL)) modifiers |= MOD_CONTROL;
+  if (ModifierDown(VK_SHIFT)) modifiers |= MOD_SHIFT;
+  if (ModifierDown(VK_LWIN) || ModifierDown(VK_RWIN)) modifiers |= MOD_WIN;
+  return modifiers;
+}
+
 }
 
 FlutterWindow::FlutterWindow(const flutter::DartProject& project)
@@ -70,6 +85,7 @@ bool FlutterWindow::OnCreate() {
 }
 
 void FlutterWindow::OnDestroy() {
+  ReleaseLowLevelHook();
   SetOutsideClickWatch(false);
   for (const int id : hotkey_ids_) {
     ::UnregisterHotKey(GetHandle(), id);
@@ -113,6 +129,49 @@ LRESULT CALLBACK FlutterWindow::LowLevelMouseProc(int code, WPARAM wparam,
   return ::CallNextHookEx(nullptr, code, wparam, lparam);
 }
 
+bool FlutterWindow::EnsureLowLevelHook() {
+  if (keyboard_hook_ != nullptr) return true;
+  keyboard_hook_ = ::SetWindowsHookExW(
+      WH_KEYBOARD_LL, &FlutterWindow::LowLevelKeyboardProc,
+      ::GetModuleHandleW(nullptr), 0);
+  return keyboard_hook_ != nullptr;
+}
+
+void FlutterWindow::ReleaseLowLevelHook() {
+  if (keyboard_hook_ != nullptr) {
+    ::UnhookWindowsHookEx(keyboard_hook_);
+    keyboard_hook_ = nullptr;
+  }
+  low_level_hotkeys_.clear();
+}
+
+LRESULT CALLBACK FlutterWindow::LowLevelKeyboardProc(int code, WPARAM wparam,
+                                                     LPARAM lparam) {
+  FlutterWindow* window = g_hotkey_window;
+  if (code == HC_ACTION && window != nullptr) {
+    const auto* event = reinterpret_cast<const KBDLLHOOKSTRUCT*>(lparam);
+    const bool key_down = wparam == WM_KEYDOWN || wparam == WM_SYSKEYDOWN;
+    const bool key_up = wparam == WM_KEYUP || wparam == WM_SYSKEYUP;
+    const UINT modifiers = CurrentModifiers();
+    for (auto& hotkey : window->low_level_hotkeys_) {
+      if (hotkey.key != event->vkCode) continue;
+      if (key_up) {
+        hotkey.active = false;
+        continue;
+      }
+      if (key_down && hotkey.modifiers == modifiers) {
+        if (!hotkey.active) {
+          hotkey.active = true;
+          ::PostMessageW(window->GetHandle(), kHotkeyMessage,
+                         static_cast<WPARAM>(hotkey.id), 0);
+        }
+        return 1;
+      }
+    }
+  }
+  return ::CallNextHookEx(nullptr, code, wparam, lparam);
+}
+
 void FlutterWindow::DispatchHotkey(int id) {
   if (hotkey_channel_) {
     hotkey_channel_->InvokeMethod(
@@ -138,6 +197,11 @@ void FlutterWindow::HandleHotkeyMethodCall(
       result->Success(flutter::EncodableValue(true));
       return;
     }
+    if (EnsureLowLevelHook()) {
+      low_level_hotkeys_.push_back({id, modifiers, key, false});
+      result->Success(flutter::EncodableValue(true));
+      return;
+    }
     result->Success(flutter::EncodableValue(false));
     return;
   }
@@ -149,6 +213,10 @@ void FlutterWindow::HandleHotkeyMethodCall(
     const int id = ReadInt(*arguments, "id");
     const bool unregistered = ::UnregisterHotKey(GetHandle(), id) != 0;
     hotkey_ids_.erase(id);
+    low_level_hotkeys_.erase(
+        std::remove_if(low_level_hotkeys_.begin(), low_level_hotkeys_.end(),
+                       [id](const LowLevelHotkey& h) { return h.id == id; }),
+        low_level_hotkeys_.end());
     result->Success(flutter::EncodableValue(unregistered));
     return;
   }
@@ -158,6 +226,7 @@ void FlutterWindow::HandleHotkeyMethodCall(
       all_released = (::UnregisterHotKey(GetHandle(), id) != 0) && all_released;
     }
     hotkey_ids_.clear();
+    ReleaseLowLevelHook();
     result->Success(flutter::EncodableValue(all_released));
     return;
   }
@@ -202,6 +271,9 @@ FlutterWindow::MessageHandler(HWND hwnd, UINT const message,
     case WM_HOTKEY:
       DispatchHotkey(static_cast<int>(wparam));
       return 0;
+    case kHotkeyMessage:
+      DispatchHotkey(static_cast<int>(wparam));
+      return 0;
     case kOutsideClickMessage:
       if (overlay_channel_) {
         overlay_channel_->InvokeMethod(

windows/runner/flutter_window.h

@@ -10,6 +10,7 @@
 
 #include <memory>
 #include <set>
+#include <vector>
 
 #include "win32_window.h"
 
@@ -25,15 +26,26 @@ class FlutterWindow : public Win32Window {
                          LPARAM const lparam) noexcept override;
 
  private:
+  struct LowLevelHotkey {
+    int id;
+    UINT modifiers;
+    UINT key;
+    bool active;
+  };
+
   void HandleHotkeyMethodCall(
       const flutter::MethodCall<flutter::EncodableValue>& call,
       std::unique_ptr<flutter::MethodResult<flutter::EncodableValue>> result);
   void HandleOverlayMethodCall(
       const flutter::MethodCall<flutter::EncodableValue>& call,
       std::unique_ptr<flutter::MethodResult<flutter::EncodableValue>> result);
+  bool EnsureLowLevelHook();
+  void ReleaseLowLevelHook();
   void DispatchHotkey(int id);
   void SetOutsideClickWatch(bool enabled);
 
+  static LRESULT CALLBACK LowLevelKeyboardProc(int code, WPARAM wparam,
+                                               LPARAM lparam);
   static LRESULT CALLBACK LowLevelMouseProc(int code, WPARAM wparam,
                                             LPARAM lparam);
 
@@ -48,6 +60,9 @@ class FlutterWindow : public Win32Window {
   std::unique_ptr<flutter::MethodChannel<flutter::EncodableValue>>
       overlay_channel_;
 
+  std::vector<LowLevelHotkey> low_level_hotkeys_;
+  HHOOK keyboard_hook_ = nullptr;
+
   HHOOK mouse_hook_ = nullptr;
 };