Add fallback functionality related to function key related shortcuts for shortcut resolver

Migrate to latest version of KeyCodes and InputSources

Author: zenangst

App/Sources/Core/Controllers/SnippetController.swift

@@ -68,7 +68,7 @@ final class SnippetController: @unchecked Sendable, ObservableObject {
       return
     }
 
-    let modifiers = VirtualModifierKey.fromCGEvent(keyCode, flags: event.flags, specialKeys: Array(store.specialKeys().keys))
+    let modifiers = VirtualModifierKey.modifiers(for: keyCode, flags: event.flags, specialKeys: Array(store.specialKeys().keys))
 
     // Figure out which modifier to apply to get the correct display value.
     var modifier: VirtualModifierKey?

App/Sources/Core/MachPort/MachPortRecordValidator.swift

@@ -16,7 +16,7 @@ final class MachPortRecordValidator {
       return .cancel(.empty())
     }
 
-    let virtualModifiers = VirtualModifierKey.fromCGEvent(keyCode, flags: machPortEvent.event.flags, specialKeys: Array(store.specialKeys().keys))
+    let virtualModifiers = VirtualModifierKey.modifiers(for: keyCode, flags: machPortEvent.event.flags, specialKeys: Array(store.specialKeys().keys))
     let modifiers = virtualModifiers.compactMap({ ModifierKey(rawValue: $0.rawValue) })
     let keyboardShortcut = KeyShortcut(
       id: UUID().uuidString,

App/Sources/Core/MachPort/ShortcutResolver.swift

@@ -14,12 +14,15 @@ protocol KeycodeLocating {
 }
 
 protocol LookupToken {
+  var keyCode: Int64 { get }
+  var flags: CGEventFlags { get }
   var signature: CGEventSignature { get }
 }
 
 extension KeyCodesStore: KeycodeLocating { }
 
 extension MachPortEvent: LookupToken {
+  var flags: CGEventFlags { event.flags }
   var signature: CGEventSignature { CGEventSignature.from(event) }
 }
 
@@ -36,7 +39,8 @@ final class ShortcutResolver {
   func lookup(_ token: LookupToken,
               bundleIdentifier: String,
               userModes: [UserMode] = [],
-              partialMatch: PartialMatch = .init(rawValue: ".")) -> KeyboardShortcutResult? {
+              partialMatch: PartialMatch = .init(rawValue: "."),
+              fallback: Bool = true) -> KeyboardShortcutResult? {
     let eventSignature = token.signature
     if !userModes.isEmpty {
       for userMode in userModes {
@@ -76,7 +80,20 @@ final class ShortcutResolver {
 
     if Self.debug { print("globalKey: \(globalKey)") }
 
-    return cache[globalKey]
+    if let globalKeyResult = cache[globalKey] {
+      return globalKeyResult
+    } else if fallback && SpecialKeys.functionKeys.contains(Int(token.keyCode)) {
+      var newFlags = token.flags
+      if newFlags.contains(.maskSecondaryFn) {
+        newFlags.remove(.maskSecondaryFn)
+      } else {
+        newFlags.insert(.maskSecondaryFn)
+      }
+      let fallbackToken = FallbackLookupToken(keyCode: token.keyCode, flags: newFlags)
+      return lookup(fallbackToken, bundleIdentifier: bundleIdentifier, fallback: false)
+    } else {
+      return nil
+    }
   }
 
   func allMatchingPrefix(_ prefix: String, shortcutIndexPrefix: Int) -> [Workflow] {
@@ -289,3 +306,9 @@ struct SpecialKeys {
     kVK_JIS_KeypadComma,
   ]
 }
+
+private struct FallbackLookupToken: LookupToken {
+  var keyCode: Int64
+  var signature: CGEventSignature { CGEventSignature(keyCode, flags) }
+  var flags: CGEventFlags
+}

Configurations/Release.xcconfig

@@ -4,3 +4,4 @@ ENABLE_NS_ASSERTIONS = NO
 VALIDATE_PRODUCT = YES
 MTL_ENABLE_DEBUG_INFO = NO
 SWIFT_OPTIMIZATION_LEVEL = -Owholemodule
+_EXPERIMENTAL_SWIFT_EXPLICIT_MODULES = YES

UnitTests/Sources/Controllers/MachPortRecordValidatorTests.swift

@@ -3,6 +3,7 @@ import InputSources
 @testable import MachPort
 @testable import Keyboard_Cowboy
 
+@MainActor
 final class MachPortRecordValidatorTests: XCTestCase {
   func testValidatorMapping_LeftCommand_S() {
     let validator = MachPortRecordValidator(store: KeyCodesStore(InputSourceController()))

UnitTests/Sources/Controllers/ShortcutResolverTests.swift

@@ -69,6 +69,7 @@ final class ShortcutResolverTests: XCTestCase {
   }
 
   // https://github.com/zenangst/KeyboardCowboy/issues/562
+  @MainActor
   func testFix562() throws {
     let fixture = Self.rootPath.appending(path: "Fixtures/json/example_config/bug_562.json")
     let fileManager = FileManager.default
@@ -143,6 +144,17 @@ final class ShortcutResolverTests: XCTestCase {
       }
     }
 
+    // Verify F20 (without function-key)
+    do {
+      switch shortcutResolver.lookup(
+        LookupTokenMock(keyCode: Int64(kVK_F20), flags: CGEventFlags(arrayLiteral: [.maskNonCoalesced])),
+        bundleIdentifier: "*"
+      ) {
+      case .exact(let workflow): XCTAssertEqual(workflow.name, "Paste")
+      default: XCTFail("")
+      }
+    }
+
     // Verify Home
     do {
       switch shortcutResolver.lookup(
@@ -192,6 +204,32 @@ final class ShortcutResolverTests: XCTestCase {
       }
     }
 
+    // Verify Command + Control + Shift + Option + Left Arrow without secondary function key
+    do {
+      switch shortcutResolver.lookup(
+        LookupTokenMock(
+          keyCode: Int64(kVK_LeftArrow),
+          flags: CGEventFlags(
+            arrayLiteral: [
+              .maskShift,
+              .maskLeftShift,
+              .maskControl,
+              .maskLeftControl,
+              .maskAlternate,
+              .maskLeftAlternate,
+              .maskCommand,
+              .maskLeftCommand,
+              .maskNumericPad,
+              .maskNonCoalesced]
+          )
+        ),
+        bundleIdentifier: "*"
+      ) {
+      case .exact(let workflow): XCTAssertEqual(workflow.name, "Next Tab")
+      default: XCTFail("")
+      }
+    }
+
     // Verify Command + Control + Shift + Option + Right Arrow
     do {
       switch shortcutResolver.lookup(
@@ -234,9 +272,13 @@ fileprivate class KeyCodeLoookupMock: KeycodeLocating {
 }
 
 fileprivate struct LookupTokenMock: LookupToken {
+  var keyCode: Int64
   var signature: CGEventSignature
+  var flags: CGEventFlags
 
   init(keyCode: Int64, flags: CGEventFlags) {
+    self.keyCode = keyCode
+    self.flags = flags
     self.signature = CGEventSignature(keyCode, flags)
   }
 }