339 lines
13 KiB
Swift
339 lines
13 KiB
Swift
// (c) 2022 and onwards The vChewing Project (MIT-NTL License).
|
||
// ====================
|
||
// This code is released under the MIT license (SPDX-License-Identifier: MIT)
|
||
// ... with NTL restriction stating that:
|
||
// No trademark license is granted to use the trade names, trademarks, service
|
||
// marks, or product names of Contributor, except as required to fulfill notice
|
||
// requirements defined in MIT License.
|
||
|
||
import Cocoa
|
||
import IMKUtils
|
||
|
||
// MARK: - NSEvent Extension - Reconstructors
|
||
|
||
public extension NSEvent {
|
||
func reinitiate(
|
||
with type: NSEvent.EventType? = nil,
|
||
location: NSPoint? = nil,
|
||
modifierFlags: NSEvent.ModifierFlags? = nil,
|
||
timestamp: TimeInterval? = nil,
|
||
windowNumber: Int? = nil,
|
||
characters: String? = nil,
|
||
charactersIgnoringModifiers: String? = nil,
|
||
isARepeat: Bool? = nil,
|
||
keyCode: UInt16? = nil
|
||
) -> NSEvent? {
|
||
let oldChars: String = {
|
||
if self.type == .flagsChanged { return "" }
|
||
return self.characters ?? ""
|
||
}()
|
||
return NSEvent.keyEvent(
|
||
with: type ?? self.type,
|
||
location: location ?? locationInWindow,
|
||
modifierFlags: modifierFlags ?? self.modifierFlags,
|
||
timestamp: timestamp ?? self.timestamp,
|
||
windowNumber: windowNumber ?? self.windowNumber,
|
||
context: nil,
|
||
characters: characters ?? oldChars,
|
||
charactersIgnoringModifiers: charactersIgnoringModifiers ?? characters ?? oldChars,
|
||
isARepeat: isARepeat ?? self.isARepeat,
|
||
keyCode: keyCode ?? self.keyCode
|
||
)
|
||
}
|
||
|
||
/// 自 Emacs 熱鍵的 NSEvent 翻譯回標準 NSEvent。失敗的話則會返回原始 NSEvent 自身。
|
||
/// - Parameter isVerticalTyping: 是否按照縱排來操作。
|
||
/// - Returns: 翻譯結果。失敗的話則返回翻譯原文。
|
||
func convertFromEmacsKeyEvent(isVerticalContext: Bool) -> NSEvent {
|
||
guard isEmacsKey else { return self }
|
||
let newKeyCode: UInt16 = {
|
||
switch isVerticalContext {
|
||
case false: return EmacsKey.charKeyMapHorizontal[charCode] ?? 0
|
||
case true: return EmacsKey.charKeyMapVertical[charCode] ?? 0
|
||
}
|
||
}()
|
||
guard newKeyCode != 0 else { return self }
|
||
let newCharScalar: Unicode.Scalar = {
|
||
switch charCode {
|
||
case 6:
|
||
return isVerticalContext
|
||
? NSEvent.SpecialKey.downArrow.unicodeScalar : NSEvent.SpecialKey.rightArrow.unicodeScalar
|
||
case 2:
|
||
return isVerticalContext
|
||
? NSEvent.SpecialKey.upArrow.unicodeScalar : NSEvent.SpecialKey.leftArrow.unicodeScalar
|
||
case 1: return NSEvent.SpecialKey.home.unicodeScalar
|
||
case 5: return NSEvent.SpecialKey.end.unicodeScalar
|
||
case 4: return NSEvent.SpecialKey.deleteForward.unicodeScalar // Use "deleteForward" for PC delete.
|
||
case 22: return NSEvent.SpecialKey.pageDown.unicodeScalar
|
||
default: return .init(0)
|
||
}
|
||
}()
|
||
let newChar = String(newCharScalar)
|
||
return reinitiate(modifierFlags: [], characters: newChar, charactersIgnoringModifiers: newChar, keyCode: newKeyCode)
|
||
?? self
|
||
}
|
||
}
|
||
|
||
// MARK: - NSEvent Extension - InputSignalProtocol
|
||
|
||
public extension NSEvent {
|
||
var isTypingVertical: Bool { charactersIgnoringModifiers == "Vertical" }
|
||
var text: String { characters ?? "" }
|
||
var inputTextIgnoringModifiers: String? {
|
||
guard charactersIgnoringModifiers != nil else { return nil }
|
||
return charactersIgnoringModifiers ?? characters ?? ""
|
||
}
|
||
|
||
var charCode: UInt16 {
|
||
guard type != .flagsChanged else { return 0 }
|
||
guard characters != nil else { return 0 }
|
||
// 這裡不用「count > 0」，因為該整數變數只要「!isEmpty」那就必定滿足這個條件。
|
||
guard !text.isEmpty else { return 0 }
|
||
let scalars = text.unicodeScalars
|
||
let result = scalars[scalars.startIndex].value
|
||
return result <= UInt16.max ? UInt16(result) : UInt16.max
|
||
}
|
||
|
||
var isFlagChanged: Bool { type == .flagsChanged }
|
||
|
||
var isEmacsKey: Bool {
|
||
// 這裡不能只用 isControlHold，因為這裡對修飾鍵的要求有排他性。
|
||
[6, 2, 1, 5, 4, 22].contains(charCode) && modifierFlags == .control
|
||
}
|
||
|
||
// 摁 Alt+Shift+主鍵盤區域數字鍵 的話，根據不同的 macOS 鍵盤佈局種類，會出現不同的符號結果。
|
||
// 然而呢，KeyCode 卻是一致的。於是這裡直接準備一個換算表來用。
|
||
// 這句用來返回換算結果。
|
||
var mainAreaNumKeyChar: String? { mapMainAreaNumKey[keyCode] }
|
||
|
||
// 除了 ANSI charCode 以外，其餘一律過濾掉，免得 InputHandler 被餵屎。
|
||
var isInvalid: Bool {
|
||
(0x20 ... 0xFF).contains(charCode) ? false : !(isReservedKey && !isKeyCodeBlacklisted)
|
||
}
|
||
|
||
var isKeyCodeBlacklisted: Bool {
|
||
guard let code = KeyCodeBlackListed(rawValue: keyCode) else { return false }
|
||
return code.rawValue != KeyCode.kNone.rawValue
|
||
}
|
||
|
||
var isReservedKey: Bool {
|
||
guard let code = KeyCode(rawValue: keyCode) else { return false }
|
||
return code.rawValue != KeyCode.kNone.rawValue
|
||
}
|
||
|
||
/// 單獨用 flags 來判定數字小鍵盤輸入的方法已經失效了，所以必須再增補用 KeyCode 判定的方法。
|
||
var isJISAlphanumericalKey: Bool { KeyCode(rawValue: keyCode) == KeyCode.kJISAlphanumericalKey }
|
||
var isJISKanaSwappingKey: Bool { KeyCode(rawValue: keyCode) == KeyCode.kJISKanaSwappingKey }
|
||
var isNumericPadKey: Bool { arrNumpadKeyCodes.contains(keyCode) }
|
||
var isMainAreaNumKey: Bool { arrMainAreaNumKey.contains(keyCode) }
|
||
var isShiftHold: Bool { modifierFlags.contains([.shift]) }
|
||
var isCommandHold: Bool { modifierFlags.contains([.command]) }
|
||
var isControlHold: Bool { modifierFlags.contains([.control]) }
|
||
var isControlHotKey: Bool { modifierFlags.contains([.control]) && text.first?.isLetter ?? false }
|
||
var isOptionHold: Bool { modifierFlags.contains([.option]) }
|
||
var isOptionHotKey: Bool { modifierFlags.contains([.option]) && text.first?.isLetter ?? false }
|
||
var isCapsLockOn: Bool { modifierFlags.contains([.capsLock]) }
|
||
var isFunctionKeyHold: Bool { modifierFlags.contains([.function]) }
|
||
var isNonLaptopFunctionKey: Bool { modifierFlags.contains([.numericPad]) && !isNumericPadKey }
|
||
var isEnter: Bool { [KeyCode.kCarriageReturn, KeyCode.kLineFeed].contains(KeyCode(rawValue: keyCode)) }
|
||
var isTab: Bool { KeyCode(rawValue: keyCode) == KeyCode.kTab }
|
||
var isUp: Bool { KeyCode(rawValue: keyCode) == KeyCode.kUpArrow }
|
||
var isDown: Bool { KeyCode(rawValue: keyCode) == KeyCode.kDownArrow }
|
||
var isLeft: Bool { KeyCode(rawValue: keyCode) == KeyCode.kLeftArrow }
|
||
var isRight: Bool { KeyCode(rawValue: keyCode) == KeyCode.kRightArrow }
|
||
var isPageUp: Bool { KeyCode(rawValue: keyCode) == KeyCode.kPageUp }
|
||
var isPageDown: Bool { KeyCode(rawValue: keyCode) == KeyCode.kPageDown }
|
||
var isSpace: Bool { KeyCode(rawValue: keyCode) == KeyCode.kSpace }
|
||
var isBackSpace: Bool { KeyCode(rawValue: keyCode) == KeyCode.kBackSpace }
|
||
var isEsc: Bool { KeyCode(rawValue: keyCode) == KeyCode.kEscape }
|
||
var isHome: Bool { KeyCode(rawValue: keyCode) == KeyCode.kHome }
|
||
var isEnd: Bool { KeyCode(rawValue: keyCode) == KeyCode.kEnd }
|
||
var isDelete: Bool { KeyCode(rawValue: keyCode) == KeyCode.kWindowsDelete }
|
||
|
||
var isCursorBackward: Bool {
|
||
isTypingVertical
|
||
? KeyCode(rawValue: keyCode) == .kUpArrow
|
||
: KeyCode(rawValue: keyCode) == .kLeftArrow
|
||
}
|
||
|
||
var isCursorForward: Bool {
|
||
isTypingVertical
|
||
? KeyCode(rawValue: keyCode) == .kDownArrow
|
||
: KeyCode(rawValue: keyCode) == .kRightArrow
|
||
}
|
||
|
||
var isCursorClockRight: Bool {
|
||
isTypingVertical
|
||
? KeyCode(rawValue: keyCode) == .kRightArrow
|
||
: KeyCode(rawValue: keyCode) == .kUpArrow
|
||
}
|
||
|
||
var isCursorClockLeft: Bool {
|
||
isTypingVertical
|
||
? KeyCode(rawValue: keyCode) == .kLeftArrow
|
||
: KeyCode(rawValue: keyCode) == .kDownArrow
|
||
}
|
||
|
||
var isASCII: Bool { charCode < 0x80 }
|
||
|
||
// 這裡必須加上「flags == .shift」，否則會出現某些情況下輸入法「誤判當前鍵入的非 Shift 字符為大寫」的問題
|
||
var isUpperCaseASCIILetterKey: Bool {
|
||
(65 ... 90).contains(charCode) && modifierFlags == .shift
|
||
}
|
||
|
||
// 這裡必須用 KeyCode，這樣才不會受隨 macOS 版本更動的 Apple 動態注音鍵盤排列內容的影響。
|
||
// 只是必須得與 ![input isShiftHold] 搭配使用才可以（也就是僅判定 Shift 沒被摁下的情形）。
|
||
var isSymbolMenuPhysicalKey: Bool {
|
||
[KeyCode.kSymbolMenuPhysicalKeyIntl, KeyCode.kSymbolMenuPhysicalKeyJIS].contains(KeyCode(rawValue: keyCode))
|
||
}
|
||
}
|
||
|
||
// MARK: - Enums of Constants
|
||
|
||
// Use KeyCodes as much as possible since its recognition won't be affected by macOS Base Keyboard Layouts.
|
||
// KeyCodes: https://eastmanreference.com/complete-list-of-applescript-key-codes
|
||
// Also: HIToolbox.framework/Versions/A/Headers/Events.h
|
||
public enum KeyCode: UInt16 {
|
||
case kNone = 0
|
||
case kCarriageReturn = 36 // Renamed from "kReturn" to avoid nomenclatural confusions.
|
||
case kTab = 48
|
||
case kSpace = 49
|
||
case kSymbolMenuPhysicalKeyIntl = 50 // vChewing Specific (Non-JIS)
|
||
case kBackSpace = 51 // Renamed from "kDelete" to avoid nomenclatural confusions.
|
||
case kEscape = 53
|
||
case kCommand = 55
|
||
case kShift = 56
|
||
case kCapsLock = 57
|
||
case kOption = 58
|
||
case kControl = 59
|
||
case kRightShift = 60
|
||
case kRightOption = 61
|
||
case kRightControl = 62
|
||
case kFunction = 63
|
||
case kF17 = 64
|
||
case kVolumeUp = 72
|
||
case kVolumeDown = 73
|
||
case kMute = 74
|
||
case kLineFeed = 76 // Another keyCode to identify the Enter Key, typable by Fn+Enter.
|
||
case kF18 = 79
|
||
case kF19 = 80
|
||
case kF20 = 90
|
||
case kYen = 93
|
||
case kSymbolMenuPhysicalKeyJIS = 94 // vChewing Specific (JIS)
|
||
case kJISNumPadComma = 95
|
||
case kF5 = 96
|
||
case kF6 = 97
|
||
case kF7 = 98
|
||
case kF3 = 99
|
||
case kF8 = 100
|
||
case kF9 = 101
|
||
case kJISAlphanumericalKey = 102
|
||
case kF11 = 103
|
||
case kJISKanaSwappingKey = 104
|
||
case kF13 = 105 // PrtSc
|
||
case kF16 = 106
|
||
case kF14 = 107
|
||
case kF10 = 109
|
||
case kContextMenu = 110
|
||
case kF12 = 111
|
||
case kF15 = 113
|
||
case kHelp = 114 // Insert
|
||
case kHome = 115
|
||
case kPageUp = 116
|
||
case kWindowsDelete = 117 // Renamed from "kForwardDelete" to avoid nomenclatural confusions.
|
||
case kF4 = 118
|
||
case kEnd = 119
|
||
case kF2 = 120
|
||
case kPageDown = 121
|
||
case kF1 = 122
|
||
case kLeftArrow = 123
|
||
case kRightArrow = 124
|
||
case kDownArrow = 125
|
||
case kUpArrow = 126
|
||
}
|
||
|
||
enum KeyCodeBlackListed: UInt16 {
|
||
case kF17 = 64
|
||
case kVolumeUp = 72
|
||
case kVolumeDown = 73
|
||
case kMute = 74
|
||
case kF18 = 79
|
||
case kF19 = 80
|
||
case kF20 = 90
|
||
case kF5 = 96
|
||
case kF6 = 97
|
||
case kF7 = 98
|
||
case kF3 = 99
|
||
case kF8 = 100
|
||
case kF9 = 101
|
||
case kF11 = 103
|
||
case kF13 = 105 // PrtSc
|
||
case kF16 = 106
|
||
case kF14 = 107
|
||
case kF10 = 109
|
||
case kF12 = 111
|
||
case kF15 = 113
|
||
case kHelp = 114 // Insert
|
||
case kF4 = 118
|
||
case kF2 = 120
|
||
case kF1 = 122
|
||
}
|
||
|
||
// 摁 Alt+Shift+主鍵盤區域數字鍵 的話，根據不同的 macOS 鍵盤佈局種類，會出現不同的符號結果。
|
||
// 然而呢，KeyCode 卻是一致的。於是這裡直接準備一個換算表來用。
|
||
let mapMainAreaNumKey: [UInt16: String] = [
|
||
18: "1", 19: "2", 20: "3", 21: "4", 23: "5", 22: "6", 26: "7", 28: "8", 25: "9", 29: "0",
|
||
]
|
||
|
||
/// 數字小鍵盤區域的按鍵的 KeyCode。
|
||
///
|
||
/// 注意：第 95 號 Key Code（逗號）為 JIS 佈局特有的數字小鍵盤按鍵。
|
||
let arrNumpadKeyCodes: [UInt16] = [65, 67, 69, 71, 75, 78, 81, 82, 83, 84, 85, 86, 87, 88, 89, 91, 92, 95]
|
||
|
||
/// 主鍵盤區域的數字鍵的 KeyCode。
|
||
let arrMainAreaNumKey: [UInt16] = [18, 19, 20, 21, 22, 23, 25, 26, 28, 29]
|
||
|
||
// CharCodes: https://theasciicode.com.ar/ascii-control-characters/horizontal-tab-ascii-code-9.html
|
||
enum CharCode: UInt16 {
|
||
case yajuusenpaiA = 114
|
||
case yajuusenpaiB = 514
|
||
case yajuusenpaiC = 1919
|
||
case yajuusenpaiD = 810
|
||
// CharCode is not reliable at all. KeyCode is the most appropriate choice due to its accuracy.
|
||
// KeyCode doesn't give a phuque about the character sent through macOS keyboard layouts ...
|
||
// ... but only focuses on which physical key is pressed.
|
||
}
|
||
|
||
// MARK: - Emacs CharCode-KeyCode translation tables.
|
||
|
||
public enum EmacsKey {
|
||
static let charKeyMapHorizontal: [UInt16: UInt16] = [6: 124, 2: 123, 1: 115, 5: 119, 4: 117, 22: 121]
|
||
static let charKeyMapVertical: [UInt16: UInt16] = [6: 125, 2: 126, 1: 115, 5: 119, 4: 117, 22: 121]
|
||
}
|
||
|
||
// MARK: - Apple ABC Keyboard Mapping
|
||
|
||
let arrAppleABCKeyboardMap: [UInt16: (String, String)] = [
|
||
50: ("`", "~"), 18: ("1", "!"), 19: ("2", "@"), 20: ("3", "#"), 21: ("4", "$"), 23: ("5", "%"), 22: ("6", "^"),
|
||
26: ("7", "&"), 28: ("8", "*"), 25: ("9", "("), 29: ("0", ")"), 27: ("-", "_"), 24: ("=", "+"), 12: ("q", "Q"),
|
||
13: ("w", "W"), 14: ("e", "E"), 15: ("r", "R"), 17: ("t", "T"), 16: ("y", "Y"), 32: ("u", "U"), 34: ("i", "I"),
|
||
31: ("o", "O"), 35: ("p", "P"), 33: ("[", "{"), 30: ("]", "}"), 42: ("\\", "|"), 0: ("a", "A"), 1: ("s", "S"),
|
||
2: ("d", "D"), 3: ("f", "F"), 5: ("g", "G"), 4: ("h", "H"), 38: ("j", "J"), 40: ("k", "K"), 37: ("l", "L"),
|
||
41: (";", ":"), 39: ("'", "\""), 6: ("z", "Z"), 7: ("x", "X"), 8: ("c", "C"), 9: ("v", "V"), 11: ("b", "B"),
|
||
45: ("n", "N"), 46: ("m", "M"), 43: (",", "<"), 47: (".", ">"), 44: ("/", "?"),
|
||
]
|
||
|
||
public extension NSEvent {
|
||
var inAppleABCStaticForm: NSEvent {
|
||
if type == .flagsChanged { return self }
|
||
guard modifierFlags == .shift || modifierFlags == [] else { return self }
|
||
if !arrAppleABCKeyboardMap.keys.contains(keyCode) { return self }
|
||
guard let dataTuplet = arrAppleABCKeyboardMap[keyCode] else { return self }
|
||
let result: NSEvent? = reinitiate(
|
||
characters: isShiftHold ? dataTuplet.1 : dataTuplet.0,
|
||
charactersIgnoringModifiers: dataTuplet.0
|
||
)
|
||
return result ?? self
|
||
}
|
||
}
|