Add global hotkeys for toggling MiddleDrag and menu bar visibility (#121)

* Add global hotkeys for toggling MiddleDrag and menu bar visibility

- Implemented global hotkey ⌘⇧E to toggle MiddleDrag functionality.
- Implemented global hotkey ⌘⇧M to toggle the visibility of the menu bar icon.
- Updated MenuBarController to handle menu bar icon visibility and added corresponding menu item.

This enhances user accessibility and control over the application features.

* Implement hotkey customization and recording functionality

- Added a new HotKeyRecorderView for capturing user-defined hotkey combinations.
- Updated UserPreferences to include customizable hotkey bindings for toggling MiddleDrag and menu bar visibility.
- Enhanced MenuBarController to allow users to change hotkeys via the menu.
- Refactored hotkey registration logic in AppDelegate to support dynamic updates based on user preferences.

This improves user experience by providing flexibility in hotkey configuration.

* Add applicationShouldHandleReopen method and update menu item text

- Implemented applicationShouldHandleReopen in AppDelegate to toggle menu bar visibility when the application is reopened.
- Updated the menu item text in MenuBarController to clarify the method for restoring the menu bar icon.

These changes enhance user interaction with the application and improve clarity in the menu options.

* Implement cleanup for hotkey recording and improve alert handling

- Added a deinitializer in HotKeyRecorderView to ensure the local keyboard monitor is removed when the instance is deallocated.
- Introduced a cancelRecording method to stop any ongoing recording and clean up the keyboard monitor.
- Updated MenuBarController to call cancelRecording when an alert is dismissed, ensuring no leaked monitors occur.

These changes enhance memory safety and improve the user experience by preventing potential issues with lingering keyboard monitors.

* Refactor multitouch and hotkey handling for improved safety and functionality

- Updated MultitouchManager and related tests to ensure safe memory handling with the introduction of 'unsafe' keyword in critical areas.
- Enhanced AlertHelperTests and SystemGestureHelperTests to utilize 'unsafe' settings provider for better test isolation.
- Added new tests for GlobalHotKeyManager and HotKeyRecorderView to validate hotkey registration and recording functionality.
- Improved MenuBarController tests to ensure menu bar visibility toggling works as expected.

These changes enhance the robustness of multitouch and hotkey functionalities while ensuring better test coverage.

* Refactor menu bar visibility handling and enhance hotkey tests

- Updated AppDelegate to call showMenuBarIcon instead of toggleMenuBarVisibility for improved clarity.
- Added new tests for MenuBarController to verify the behavior of showMenuBarIcon under various conditions.
- Enhanced GlobalHotKeyManagerTests and HotKeyRecorderViewTests with additional test cases for better coverage and validation of hotkey functionality.

These changes improve the robustness of menu bar interactions and ensure comprehensive testing of hotkey features.

* Enhance MenuBarController to skip button click during tests

- Added a check to prevent the button click action in MenuBarController when running tests, avoiding modal menu loops that can stall CI processes.

This change improves test reliability and ensures smoother continuous integration workflows.

* Refactor MenuBarController hotkey handling for improved safety

- Updated hotkey binding closures in MenuBarController to use guard statements for safer self-referencing.
- This change enhances memory safety by preventing potential retain cycles and ensures smoother execution of hotkey updates.

These improvements contribute to the overall robustness of the menu bar functionality.

Author: NullPointerDepressiveDisorder

MiddleDrag.xcodeproj/project.pbxproj

@@ -70,8 +70,10 @@
 				Models/GestureModels.swift,
 				Models/TouchModels.swift,
 				UI/AlertHelper.swift,
+				UI/HotKeyRecorderView.swift,
 				UI/MenuBarController.swift,
 				Utilities/AnalyticsManager.swift,
+				Utilities/GlobalHotKeyManager.swift,
 				Utilities/LaunchAtLoginManager.swift,
 				Utilities/PreferencesManager.swift,
 				Utilities/ScreenHelper.swift,
@@ -90,6 +92,8 @@
 				MiddleDragTests/DeviceMonitorTests.swift,
 				MiddleDragTests/GestureModelsTests.swift,
 				MiddleDragTests/GestureRecognizerTests.swift,
+				MiddleDragTests/GlobalHotKeyManagerTests.swift,
+				MiddleDragTests/HotKeyRecorderViewTests.swift,
 				MiddleDragTests/LaunchAtLoginManagerTests.swift,
 				MiddleDragTests/MenuBarControllerTests.swift,
 				MiddleDragTests/Mocks/MockDeviceMonitor.swift,
@@ -109,7 +113,6 @@
 			membershipExceptions = (
 				Debug.xcconfig,
 				Release.xcconfig,
-				Secrets.xcconfig,
 			);
 			target = 1A0000011 /* MiddleDrag */;
 		};
@@ -131,6 +134,8 @@
 				MiddleDragTests/DeviceMonitorTests.swift,
 				MiddleDragTests/GestureModelsTests.swift,
 				MiddleDragTests/GestureRecognizerTests.swift,
+				MiddleDragTests/GlobalHotKeyManagerTests.swift,
+				MiddleDragTests/HotKeyRecorderViewTests.swift,
 				MiddleDragTests/LaunchAtLoginManagerTests.swift,
 				MiddleDragTests/MenuBarControllerTests.swift,
 				MiddleDragTests/Mocks/MockDeviceMonitor.swift,
@@ -145,8 +150,10 @@
 				Models/GestureModels.swift,
 				Models/TouchModels.swift,
 				UI/AlertHelper.swift,
+				UI/HotKeyRecorderView.swift,
 				UI/MenuBarController.swift,
 				Utilities/AnalyticsManager.swift,
+				Utilities/GlobalHotKeyManager.swift,
 				Utilities/LaunchAtLoginManager.swift,
 				Utilities/PreferencesManager.swift,
 				Utilities/ScreenHelper.swift,

MiddleDrag/AppDelegate.swift

@@ -1,4 +1,5 @@
 import Cocoa
+import Carbon.HIToolbox
 import MiddleDragCore
 
 /// Main application delegate
@@ -18,6 +19,9 @@ class AppDelegate: NSObject, NSApplicationDelegate {
     private var preferences: UserPreferences!
 
     private var accessibilityMonitor: AccessibilityMonitor?
+    
+    private var toggleHotKeyID: UInt32 = 0
+    private var menuBarHotKeyID: UInt32 = 0
 
     // MARK: - Application Lifecycle
 
@@ -111,6 +115,9 @@ class AppDelegate: NSObject, NSApplicationDelegate {
         )
         Log.info("Menu bar controller initialized", category: .app)
 
+        // Register global hotkeys
+        registerHotKeys()
+
         // Set up notification observers
         setupNotifications()
 
@@ -160,6 +167,11 @@ class AppDelegate: NSObject, NSApplicationDelegate {
         return true
     }
 
+    func applicationShouldHandleReopen(_ sender: NSApplication, hasVisibleWindows: Bool) -> Bool {
+        menuBarController?.showMenuBarIcon()
+        return false
+    }
+
     // MARK: - Setup
 
     private func setupNotifications() {
@@ -177,6 +189,32 @@ class AppDelegate: NSObject, NSApplicationDelegate {
             object: nil
         )
     }
+    
+    /// Register (or re-register) global hotkeys from current preferences
+    private func registerHotKeys() {
+        // Unregister existing
+        if toggleHotKeyID != 0 {
+            GlobalHotKeyManager.shared.unregister(id: toggleHotKeyID)
+        }
+        if menuBarHotKeyID != 0 {
+            GlobalHotKeyManager.shared.unregister(id: menuBarHotKeyID)
+        }
+
+        // Register from preferences
+        toggleHotKeyID = GlobalHotKeyManager.shared.register(
+            keyCode: preferences.toggleHotKey.keyCode,
+            modifiers: preferences.toggleHotKey.carbonModifiers
+        ) { [weak self] in
+            self?.menuBarController?.toggleEnabled()
+        }
+
+        menuBarHotKeyID = GlobalHotKeyManager.shared.register(
+            keyCode: preferences.menuBarHotKey.keyCode,
+            modifiers: preferences.menuBarHotKey.carbonModifiers
+        ) { [weak self] in
+            self?.menuBarController?.toggleMenuBarVisibility()
+        }
+    }
 
     // MARK: - Notification Handlers
 
@@ -185,6 +223,7 @@ class AppDelegate: NSObject, NSApplicationDelegate {
             preferences = newPreferences
             PreferencesManager.shared.savePreferences(preferences)
             multitouchManager.updateConfiguration(preferences.gestureConfig)
+            registerHotKeys()
             Log.info("Preferences updated", category: .app)
         }
     }

MiddleDrag/Managers/MultitouchManager.swift

@@ -870,9 +870,9 @@ extension MultitouchManager: DeviceMonitorDelegate {
 
         gestureQueue.async { [weak self] in
             if let data = touchData {
-                data.withUnsafeBytes { rawBuffer in
+                unsafe data.withUnsafeBytes { rawBuffer in
                     guard let baseAddress = rawBuffer.baseAddress else { return }
-                    let buffer = UnsafeMutableRawPointer(mutating: baseAddress)
+                    let buffer = unsafe UnsafeMutableRawPointer(mutating: baseAddress)
                     unsafe self?.gestureRecognizer.processTouches(
                         buffer, count: touchCount, timestamp: timestamp, modifierFlags: modifierFlags)
                 }

MiddleDrag/MiddleDragTests/AlertHelperTests.swift

@@ -46,15 +46,15 @@ final class AlertHelperTests: XCTestCase {
         AlertHelper.presenter = mockPresenter
 
         // Save and replace SystemGestureHelper settings provider
-        originalSettingsProvider = SystemGestureHelper.settingsProvider
+        originalSettingsProvider = unsafe SystemGestureHelper.settingsProvider
         mockSettingsProvider = MockTrackpadSettingsProvider()
-        SystemGestureHelper.settingsProvider = mockSettingsProvider
+        unsafe SystemGestureHelper.settingsProvider = mockSettingsProvider
     }
 
     override func tearDown() {
         // Restore originals
         AlertHelper.presenter = originalPresenter
-        SystemGestureHelper.settingsProvider = originalSettingsProvider
+        unsafe SystemGestureHelper.settingsProvider = originalSettingsProvider
         mockPresenter = nil
         mockSettingsProvider = nil
         super.tearDown()

MiddleDrag/MiddleDragTests/DeviceMonitorTests.swift

@@ -80,7 +80,7 @@ import XCTest
     }
 
     func testStartStopStartDoesNotCrash() throws {
-        try requireUnsafeMultitouchTestsEnabled()
+        try unsafe requireUnsafeMultitouchTestsEnabled()
         // Should be able to restart the monitor
         unsafe XCTAssertNoThrow(monitor.start())
         unsafe XCTAssertNoThrow(monitor.stop())
@@ -122,7 +122,7 @@ import XCTest
     // MARK: - Multiple Instance Tests
 
     func testMultipleInstancesDoNotCrash() throws {
-        try requireUnsafeMultitouchTestsEnabled()
+        try unsafe requireUnsafeMultitouchTestsEnabled()
         // Create multiple monitors - only first should own global reference
         let monitor2 = unsafe DeviceMonitor()
         let monitor3 = unsafe DeviceMonitor()
@@ -208,7 +208,7 @@ import XCTest
     }
 
     func testRapidStartStopCyclesDoNotCrash() throws {
-        try requireUnsafeMultitouchTestsEnabled()
+        try unsafe requireUnsafeMultitouchTestsEnabled()
         // Simulates the race condition scenario where rapid restart cycles
         // could cause the framework's internal thread to access deallocated resources.
         // The fix adds delays to prevent this, so rapid cycles should be safe.
@@ -222,7 +222,7 @@ import XCTest
     }
 
     func testStopSeparatesCallbackUnregistrationFromDeviceStop() throws {
-        try requireUnsafeMultitouchTestsEnabled()
+        try unsafe requireUnsafeMultitouchTestsEnabled()
         // This test exercises the code path where:
         // 1. Callbacks are unregistered first (MTUnregisterContactFrameCallback)
         // 2. A delay occurs (Thread.sleep)
@@ -241,7 +241,7 @@ import XCTest
     }
 
     func testConcurrentStopDoesNotCrash() throws {
-        try requireUnsafeMultitouchTestsEnabled()
+        try unsafe requireUnsafeMultitouchTestsEnabled()
         // Test that even if something tries to access the monitor during stop,
         // it doesn't crash. This simulates what happens when the framework's
         // internal thread is still processing while we stop.
@@ -287,7 +287,7 @@ import XCTest
     }
 
     func testRapidRestartCyclesWithDelayDoNotCrash() throws {
-        try requireUnsafeMultitouchTestsEnabled()
+        try unsafe requireUnsafeMultitouchTestsEnabled()
         // Simulates the exact scenario from the bug report:
         // Rapid restart cycles during connectivity changes causing
         // gDeviceMonitor to become nil while callbacks are still in-flight.
@@ -318,7 +318,7 @@ import XCTest
     }
 
     func testConcurrentStartStopDoesNotCrash() throws {
-        try requireUnsafeMultitouchTestsEnabled()
+        try unsafe requireUnsafeMultitouchTestsEnabled()
         // Test that concurrent start/stop operations on the same instance don't crash.
         // NOTE: Concurrent start/stop on the same instance may leave it in an inconsistent
         // state, but it should NOT crash due to the locking mechanism protecting global state.
@@ -353,7 +353,7 @@ import XCTest
     }
 
     func testMultipleMonitorCreationDuringCleanup() throws {
-        try requireUnsafeMultitouchTestsEnabled()
+        try unsafe requireUnsafeMultitouchTestsEnabled()
         // Test that creating new monitors while the old one is being cleaned up
         // doesn't cause a crash. This tests the gPendingCleanup mechanism.
         unsafe monitor.start()

MiddleDrag/MiddleDragTests/GestureRecognizerTests.swift

@@ -57,7 +57,7 @@ final class GestureRecognizerTests: XCTestCase {
         let count = touches.count
         guard count > 0 else {
             // Non-null placeholder; processTouches won't dereference when count == 0.
-            return (UnsafeMutableRawPointer(bitPattern: 1)!, 0, {})
+            return unsafe (UnsafeMutableRawPointer(bitPattern: 1)!, 0, {})
         }
 
         let pointer = UnsafeMutablePointer<MTTouch>.allocate(capacity: count)