Add special key support

Author: magicien

JoyKeyMapper/DataModels/GameController.swift

@@ -7,6 +7,7 @@
 //
 
 import JoyConSwift
+import InputMethodKit
 
 extension JoyCon.BatteryStatus {
     static let stringMap: [JoyCon.BatteryStatus: String] = [
@@ -199,9 +200,27 @@ class GameController {
             if config.keyCode >= 0 {
                 metaKeyEvent(config: config, keyDown: true)
 
-                let event = CGEvent(keyboardEventSource: source, virtualKey: CGKeyCode(config.keyCode), keyDown: true)
-                event?.flags = CGEventFlags(rawValue: CGEventFlags.RawValue(config.modifiers))
-                event?.post(tap: .cghidEventTap)
+                if let systemKey = systemDefinedKey[Int(config.keyCode)] {
+                    let mousePos = NSEvent.mouseLocation
+                    let flags = NSEvent.ModifierFlags(rawValue: 0x0a00)
+                    let data1 = Int((systemKey << 16) | 0x0a00)
+                    
+                    let ev = NSEvent.otherEvent(
+                        with: .systemDefined,
+                        location: mousePos,
+                        modifierFlags: flags,
+                        timestamp: ProcessInfo().systemUptime,
+                        windowNumber: 0,
+                        context: nil,
+                        subtype: Int16(NX_SUBTYPE_AUX_CONTROL_BUTTONS),
+                        data1: data1,
+                        data2: -1)
+                    ev?.cgEvent?.post(tap: .cghidEventTap)
+                } else {
+                    let event = CGEvent(keyboardEventSource: source, virtualKey: CGKeyCode(config.keyCode), keyDown: true)
+                    event?.flags = CGEventFlags(rawValue: CGEventFlags.RawValue(config.modifiers))
+                    event?.post(tap: .cghidEventTap)
+                }
             }
 
             if config.mouseButton >= 0 {
@@ -237,11 +256,29 @@ class GameController {
             let source = CGEventSource(stateID: .hidSystemState)
 
             if config.keyCode >= 0 {
+                if let systemKey = systemDefinedKey[Int(config.keyCode)] {
+                    let mousePos = NSEvent.mouseLocation
+                    let flags = NSEvent.ModifierFlags(rawValue: 0x0b00)
+                    let data1 = Int((systemKey << 16) | 0x0b00)
+                    
+                    let ev = NSEvent.otherEvent(
+                        with: .systemDefined,
+                        location: mousePos,
+                        modifierFlags: flags,
+                        timestamp: ProcessInfo().systemUptime,
+                        windowNumber: 0,
+                        context: nil,
+                        subtype: Int16(NX_SUBTYPE_AUX_CONTROL_BUTTONS),
+                        data1: data1,
+                        data2: -1)
+                    ev?.cgEvent?.post(tap: .cghidEventTap)
+                } else {
                     let event = CGEvent(keyboardEventSource: source, virtualKey: CGKeyCode(config.keyCode), keyDown: false)
                     event?.flags = CGEventFlags(rawValue: CGEventFlags.RawValue(config.modifiers))
                     event?.post(tap: .cghidEventTap)
+                }
 
-                    metaKeyEvent(config: config, keyDown: false)
+                metaKeyEvent(config: config, keyDown: false)
             }
 
             if config.mouseButton >= 0 {

JoyKeyMapper/Misc/Utils.swift

@@ -81,3 +81,14 @@ func getKeyName(keyCode: UInt16) -> String {
 
     return name.uppercased()
 }
+
+/** Get the frontmost winodow ID. Currently not used. */
+func getFrontmostWinodowNumber() -> Int? {
+    let app = NSWorkspace.shared.frontmostApplication
+    guard let pidInt32 = app?.processIdentifier else { return nil }
+    let pid = Int64(pidInt32)
+    guard let windowList = CGWindowListCopyWindowInfo(.optionAll, kCGNullWindowID) as? [NSDictionary] else { return nil }
+    let window = windowList.first { ($0[kCGWindowOwnerPID] as? Int64 ?? -1) == pid }
+
+    return window?[kCGWindowNumber] as? Int
+}

JoyKeyMapper/Views/KeyConfigView/KeyConfigComboBox.swift

@@ -20,7 +20,7 @@ let keyCodeList: [Int] = [
     kVK_Space,
     kVK_Delete,
     kVK_Escape,
-    kVK_CapsLock,
+    // kVK_CapsLock,
     kVK_RightShift,
     kVK_RightOption,
     kVK_RightControl,
@@ -70,7 +70,7 @@ let keyCodeList: [Int] = [
     kVK_JIS_Underscore,
     kVK_JIS_Eisu,
     kVK_JIS_Kana,
-    kVK_Help,
+    // kVK_Help,
     kVK_Home,
     kVK_PageUp,
     kVK_PageDown,
@@ -79,7 +79,15 @@ let keyCodeList: [Int] = [
     kVK_LeftArrow,
     kVK_RightArrow,
     kVK_DownArrow,
-    kVK_UpArrow
+    kVK_UpArrow,
+    SpecialKey_BrightnessUp,
+    SpecialKey_BrightnessDown,
+    // SpecialKey_NumLock,
+    SpecialKey_Play,
+    SpecialKey_Next,
+    SpecialKey_Previous,
+    SpecialKey_Fast,
+    SpecialKey_Rewind
 ]
 
 let keyCells: [NSComboBoxCell] = {

JoyKeyMapper/Views/KeyMapList/SpecialKeyName.swift

@@ -9,6 +9,17 @@
 import Foundation
 import InputMethodKit
 
+let SpecialKey_BaseValue = 0x7000
+let SpecialKey_BrightnessUp = SpecialKey_BaseValue + Int(NX_KEYTYPE_BRIGHTNESS_UP)
+let SpecialKey_BrightnessDown = SpecialKey_BaseValue + Int(NX_KEYTYPE_BRIGHTNESS_DOWN)
+let SpecialKey_Power = SpecialKey_BaseValue + Int(NX_POWER_KEY)
+let SpecialKey_NumLock = SpecialKey_BaseValue + Int(NX_KEYTYPE_NUM_LOCK)
+let SpecialKey_Play = SpecialKey_BaseValue + Int(NX_KEYTYPE_PLAY)
+let SpecialKey_Next = SpecialKey_BaseValue + Int(NX_KEYTYPE_NEXT)
+let SpecialKey_Previous = SpecialKey_BaseValue + Int(NX_KEYTYPE_PREVIOUS)
+let SpecialKey_Fast = SpecialKey_BaseValue + Int(NX_KEYTYPE_FAST)
+let SpecialKey_Rewind = SpecialKey_BaseValue + Int(NX_KEYTYPE_REWIND)
+
 let SpecialKeyName: [Int:String] = [
     kVK_ISO_Section: "Section",
     kVK_Return: "Return",
@@ -80,9 +91,41 @@ let SpecialKeyName: [Int:String] = [
     kVK_LeftArrow: "←",
     kVK_RightArrow: "→",
     kVK_DownArrow: "↓",
-    kVK_UpArrow: "↑"
+    kVK_UpArrow: "↑",
+    SpecialKey_BrightnessUp: "BrightnessUp",
+    SpecialKey_BrightnessDown: "BrightnessDown",
+    SpecialKey_NumLock: "NumLock",
+    SpecialKey_Play: "Play",
+    SpecialKey_Next: "Next",
+    SpecialKey_Previous: "Previous",
+    SpecialKey_Fast: "Fast",
+    SpecialKey_Rewind: "Rewind"
 ]
 
 let LocalizedSpecialKeyName = SpecialKeyName.mapValues {
     NSLocalizedString($0, comment: $0)
 }
+
+let systemDefinedKey: [Int: Int32] = [
+    kVK_VolumeUp: NX_KEYTYPE_SOUND_UP,
+    kVK_VolumeDown: NX_KEYTYPE_SOUND_DOWN,
+    SpecialKey_BrightnessUp: NX_KEYTYPE_BRIGHTNESS_UP,
+    SpecialKey_BrightnessDown: NX_KEYTYPE_BRIGHTNESS_DOWN,
+    // kVK_CapsLock: NX_KEYTYPE_CAPS_LOCK,
+    // kVK_Help: NX_KEYTYPE_HELP,
+    // NX_POWER_KEY
+    kVK_Mute: NX_KEYTYPE_MUTE,
+    // NX_UP_ARROW_KEY
+    // NX_DOWN_ARROW_KEY
+    // NX_KEYTYPE_NUM_LOCK,
+    // NX_KEYTYPE_CONTRAST_UP
+    // NX_KEYTYPE_CONTRAST_DOWN
+    // NX_KEYTYPE_LAUNCH_PANEL
+    // NX_KEYTYPE_EJECT
+    // NX_KEYTYPE_VIDMIRROR
+    SpecialKey_Play: NX_KEYTYPE_PLAY,
+    SpecialKey_Next: NX_KEYTYPE_NEXT,
+    SpecialKey_Previous: NX_KEYTYPE_PREVIOUS,
+    SpecialKey_Fast: NX_KEYTYPE_FAST,
+    SpecialKey_Rewind: NX_KEYTYPE_REWIND
+]