Repo // Deprecating Zonble's KeyHandlerInput (InputSignal).
This commit is contained in:
ShikiSuen
parent
5b8be25c73
commit
29600e48e6
|
|
@ -1,168 +0,0 @@
|
||||||
// (c) 2011 and onwards The OpenVanilla Project (MIT License).
|
|
||||||
// All possible vChewing-specific modifications are of:
|
|
||||||
// (c) 2021 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
|
|
||||||
|
|
||||||
struct InputSignal: CustomStringConvertible {
|
|
||||||
private(set) var isTypingVertical: Bool
|
|
||||||
private(set) var inputText: String
|
|
||||||
private(set) var inputTextIgnoringModifiers: String?
|
|
||||||
private(set) var charCode: UInt16
|
|
||||||
private(set) var keyCode: UInt16
|
|
||||||
private var isFlagChanged: Bool
|
|
||||||
private var flags: NSEvent.ModifierFlags
|
|
||||||
private var cursorForwardKey: KeyCode = .kNone // 12 o'clock
|
|
||||||
private var cursorBackwardKey: KeyCode = .kNone // 6 o'clock
|
|
||||||
private var cursorKeyClockRight: KeyCode = .kNone // 3 o'clock
|
|
||||||
private var cursorKeyClockLeft: KeyCode = .kNone // 9 o'clock
|
|
||||||
private(set) var emacsKey: EmacsKey
|
|
||||||
public var isASCIIModeInput: Bool = false
|
|
||||||
|
|
||||||
public init(
|
|
||||||
inputText: String = "", keyCode: UInt16, charCode: UInt16, flags: NSEvent.ModifierFlags,
|
|
||||||
isVerticalTyping: Bool = false, inputTextIgnoringModifiers: String? = nil
|
|
||||||
) {
|
|
||||||
self.inputText = AppleKeyboardConverter.cnvStringApple2ABC(inputText)
|
|
||||||
self.inputTextIgnoringModifiers = AppleKeyboardConverter.cnvStringApple2ABC(
|
|
||||||
inputTextIgnoringModifiers ?? inputText)
|
|
||||||
self.flags = flags
|
|
||||||
isFlagChanged = false
|
|
||||||
isTypingVertical = isVerticalTyping
|
|
||||||
self.keyCode = keyCode
|
|
||||||
self.charCode = AppleKeyboardConverter.cnvApple2ABC(charCode)
|
|
||||||
emacsKey = EmacsKeyHelper.detect(
|
|
||||||
charCode: AppleKeyboardConverter.cnvApple2ABC(charCode), flags: flags
|
|
||||||
)
|
|
||||||
// Define Arrow Keys in the same way above.
|
|
||||||
defineArrowKeys()
|
|
||||||
}
|
|
||||||
|
|
||||||
public init(event: NSEvent, isVerticalTyping: Bool = false) {
|
|
||||||
inputText = AppleKeyboardConverter.cnvStringApple2ABC(event.characters ?? "")
|
|
||||||
inputTextIgnoringModifiers = AppleKeyboardConverter.cnvStringApple2ABC(
|
|
||||||
event.charactersIgnoringModifiers ?? inputText)
|
|
||||||
keyCode = event.keyCode
|
|
||||||
flags = event.modifierFlags
|
|
||||||
isFlagChanged = (event.type == .flagsChanged)
|
|
||||||
isTypingVertical = isVerticalTyping
|
|
||||||
let charCode: UInt16 = {
|
|
||||||
// 這裡不用「count > 0」，因為該整數變數只要「!isEmpty」那就必定滿足這個條件。
|
|
||||||
guard let inputText = event.characters, !inputText.isEmpty else {
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
let first = inputText[inputText.startIndex].utf16.first!
|
|
||||||
return first
|
|
||||||
}()
|
|
||||||
self.charCode = AppleKeyboardConverter.cnvApple2ABC(charCode)
|
|
||||||
emacsKey = EmacsKeyHelper.detect(
|
|
||||||
charCode: AppleKeyboardConverter.cnvApple2ABC(charCode), flags: flags
|
|
||||||
)
|
|
||||||
// Define Arrow Keys in the same way above.
|
|
||||||
defineArrowKeys()
|
|
||||||
}
|
|
||||||
|
|
||||||
mutating func defineArrowKeys() {
|
|
||||||
cursorForwardKey = isTypingVertical ? .kDownArrow : .kRightArrow
|
|
||||||
cursorBackwardKey = isTypingVertical ? .kUpArrow : .kLeftArrow
|
|
||||||
cursorKeyClockLeft = isTypingVertical ? .kRightArrow : .kUpArrow
|
|
||||||
cursorKeyClockRight = isTypingVertical ? .kLeftArrow : .kDownArrow
|
|
||||||
}
|
|
||||||
|
|
||||||
var description: String {
|
|
||||||
var result = "<[InputSignal] "
|
|
||||||
result += "inputText:\(String(describing: inputText)), "
|
|
||||||
result += "inputTextIgnoringModifiers:\(String(describing: inputTextIgnoringModifiers)), "
|
|
||||||
result += "charCode:\(charCode), "
|
|
||||||
result += "keyCode:\(keyCode), "
|
|
||||||
result += "flags:\(flags), "
|
|
||||||
result += "cursorForwardKey:\(cursorForwardKey), "
|
|
||||||
result += "cursorBackwardKey:\(cursorBackwardKey), "
|
|
||||||
result += "cursorKeyClockRight:\(cursorKeyClockRight), "
|
|
||||||
result += "cursorKeyClockLeft:\(cursorKeyClockLeft), "
|
|
||||||
result += "emacsKey:\(emacsKey), "
|
|
||||||
result += "isTypingVertical:\(isTypingVertical)"
|
|
||||||
result += ">"
|
|
||||||
return result
|
|
||||||
}
|
|
||||||
|
|
||||||
// 除了 ANSI charCode 以外，其餘一律過濾掉，免得純 Swift 版 KeyHandler 被餵屎。
|
|
||||||
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
|
|
||||||
}
|
|
||||||
|
|
||||||
// 摁 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",
|
|
||||||
]
|
|
||||||
|
|
||||||
var isCandidateKey: Bool {
|
|
||||||
mgrPrefs.candidateKeys.contains(inputText)
|
|
||||||
|| mgrPrefs.candidateKeys.contains(inputTextIgnoringModifiers ?? "114514")
|
|
||||||
}
|
|
||||||
|
|
||||||
/// 單獨用 flags 來判定數字小鍵盤輸入的方法已經失效了，所以必須再增補用 KeyCode 判定的方法。
|
|
||||||
var isNumericPadKey: Bool { arrNumpadKeyCodes.contains(keyCode) }
|
|
||||||
var isMainAreaNumKey: Bool { arrMainAreaNumKey.contains(keyCode) }
|
|
||||||
var isShiftHold: Bool { flags.contains([.shift]) }
|
|
||||||
var isCommandHold: Bool { flags.contains([.command]) }
|
|
||||||
var isControlHold: Bool { flags.contains([.control]) }
|
|
||||||
var isControlHotKey: Bool { flags.contains([.control]) && inputText.first?.isLetter ?? false }
|
|
||||||
var isOptionHold: Bool { flags.contains([.option]) }
|
|
||||||
var isOptionHotKey: Bool { flags.contains([.option]) && inputText.first?.isLetter ?? false }
|
|
||||||
var isCapsLockOn: Bool { flags.contains([.capsLock]) }
|
|
||||||
var isFunctionKeyHold: Bool { flags.contains([.function]) }
|
|
||||||
var isNonLaptopFunctionKey: Bool { flags.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 { KeyCode(rawValue: keyCode) == cursorBackwardKey }
|
|
||||||
var isCursorForward: Bool { KeyCode(rawValue: keyCode) == cursorForwardKey }
|
|
||||||
var isCursorClockRight: Bool { KeyCode(rawValue: keyCode) == cursorKeyClockRight }
|
|
||||||
var isCursorClockLeft: Bool { KeyCode(rawValue: keyCode) == cursorKeyClockLeft }
|
|
||||||
|
|
||||||
// 這裡必須加上「flags == .shift」，否則會出現某些情況下輸入法「誤判當前鍵入的非 Shift 字符為大寫」的問題。
|
|
||||||
var isUpperCaseASCIILetterKey: Bool { (65...90).contains(charCode) && flags == .shift }
|
|
||||||
|
|
||||||
// 這裡必須用 KeyCode，這樣才不會受隨 macOS 版本更動的 Apple 動態注音鍵盤排列內容的影響。
|
|
||||||
// 只是必須得與 ![input isShiftHold] 搭配使用才可以（也就是僅判定 Shift 沒被摁下的情形）。
|
|
||||||
var isSymbolMenuPhysicalKey: Bool {
|
|
||||||
[KeyCode.kSymbolMenuPhysicalKeyIntl, KeyCode.kSymbolMenuPhysicalKeyJIS].contains(KeyCode(rawValue: keyCode))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
enum EmacsKeyHelper {
|
|
||||||
static func detect(charCode: UniChar, flags: NSEvent.ModifierFlags) -> EmacsKey {
|
|
||||||
let charCode = AppleKeyboardConverter.cnvApple2ABC(charCode)
|
|
||||||
if flags.contains(.control) {
|
|
||||||
return EmacsKey(rawValue: charCode) ?? .none
|
|
||||||
}
|
|
||||||
return .none
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -134,7 +134,6 @@
|
||||||
6ACA41FD15FC1D9000935EF6 /* MainMenu.xib in Resources */ = {isa = PBXBuildFile; fileRef = 6ACA41F015FC1D9000935EF6 /* MainMenu.xib */; };
|
6ACA41FD15FC1D9000935EF6 /* MainMenu.xib in Resources */ = {isa = PBXBuildFile; fileRef = 6ACA41F015FC1D9000935EF6 /* MainMenu.xib */; };
|
||||||
6ACA420215FC1E5200935EF6 /* vChewing.app in Resources */ = {isa = PBXBuildFile; fileRef = 6A0D4EA215FC0D2D00ABF4B3 /* vChewing.app */; };
|
6ACA420215FC1E5200935EF6 /* vChewing.app in Resources */ = {isa = PBXBuildFile; fileRef = 6A0D4EA215FC0D2D00ABF4B3 /* vChewing.app */; };
|
||||||
D427F76C278CA2B0004A2160 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = D427F76B278CA1BA004A2160 /* AppDelegate.swift */; };
|
D427F76C278CA2B0004A2160 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = D427F76B278CA1BA004A2160 /* AppDelegate.swift */; };
|
||||||
D456576E279E4F7B00DF6BC9 /* InputSignal.swift in Sources */ = {isa = PBXBuildFile; fileRef = D456576D279E4F7B00DF6BC9 /* InputSignal.swift */; };
|
|
||||||
D461B792279DAC010070E734 /* InputState.swift in Sources */ = {isa = PBXBuildFile; fileRef = D461B791279DAC010070E734 /* InputState.swift */; };
|
D461B792279DAC010070E734 /* InputState.swift in Sources */ = {isa = PBXBuildFile; fileRef = D461B791279DAC010070E734 /* InputState.swift */; };
|
||||||
D47B92C027972AD100458394 /* main.swift in Sources */ = {isa = PBXBuildFile; fileRef = D47B92BF27972AC800458394 /* main.swift */; };
|
D47B92C027972AD100458394 /* main.swift in Sources */ = {isa = PBXBuildFile; fileRef = D47B92BF27972AC800458394 /* main.swift */; };
|
||||||
D47F7DCE278BFB57002F9DD7 /* ctlPrefWindow.swift in Sources */ = {isa = PBXBuildFile; fileRef = D47F7DCD278BFB57002F9DD7 /* ctlPrefWindow.swift */; };
|
D47F7DCE278BFB57002F9DD7 /* ctlPrefWindow.swift in Sources */ = {isa = PBXBuildFile; fileRef = D47F7DCD278BFB57002F9DD7 /* ctlPrefWindow.swift */; };
|
||||||
|
|
@ -367,7 +366,6 @@
|
||||||
6ACA41EF15FC1D9000935EF6 /* en */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = en; path = en.lproj/Localizable.strings; sourceTree = "<group>"; };
|
6ACA41EF15FC1D9000935EF6 /* en */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = en; path = en.lproj/Localizable.strings; sourceTree = "<group>"; };
|
||||||
6ACA41F215FC1D9000935EF6 /* Installer-Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = "Installer-Info.plist"; path = "Installer/Installer-Info.plist"; sourceTree = SOURCE_ROOT; };
|
6ACA41F215FC1D9000935EF6 /* Installer-Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = "Installer-Info.plist"; path = "Installer/Installer-Info.plist"; sourceTree = SOURCE_ROOT; };
|
||||||
D427F76B278CA1BA004A2160 /* AppDelegate.swift */ = {isa = PBXFileReference; explicitFileType = sourcecode.swift; fileEncoding = 4; indentWidth = 2; lineEnding = 0; path = AppDelegate.swift; sourceTree = "<group>"; tabWidth = 2; usesTabs = 0; };
|
D427F76B278CA1BA004A2160 /* AppDelegate.swift */ = {isa = PBXFileReference; explicitFileType = sourcecode.swift; fileEncoding = 4; indentWidth = 2; lineEnding = 0; path = AppDelegate.swift; sourceTree = "<group>"; tabWidth = 2; usesTabs = 0; };
|
||||||
D456576D279E4F7B00DF6BC9 /* InputSignal.swift */ = {isa = PBXFileReference; explicitFileType = sourcecode.swift; fileEncoding = 4; indentWidth = 2; lineEnding = 0; path = InputSignal.swift; sourceTree = "<group>"; tabWidth = 2; usesTabs = 0; };
|
|
||||||
D461B791279DAC010070E734 /* InputState.swift */ = {isa = PBXFileReference; explicitFileType = sourcecode.swift; fileEncoding = 4; indentWidth = 2; lineEnding = 0; path = InputState.swift; sourceTree = "<group>"; tabWidth = 2; usesTabs = 0; };
|
D461B791279DAC010070E734 /* InputState.swift */ = {isa = PBXFileReference; explicitFileType = sourcecode.swift; fileEncoding = 4; indentWidth = 2; lineEnding = 0; path = InputState.swift; sourceTree = "<group>"; tabWidth = 2; usesTabs = 0; };
|
||||||
D47B92BF27972AC800458394 /* main.swift */ = {isa = PBXFileReference; explicitFileType = sourcecode.swift; fileEncoding = 4; indentWidth = 2; lineEnding = 0; path = main.swift; sourceTree = "<group>"; tabWidth = 2; usesTabs = 0; };
|
D47B92BF27972AC800458394 /* main.swift */ = {isa = PBXFileReference; explicitFileType = sourcecode.swift; fileEncoding = 4; indentWidth = 2; lineEnding = 0; path = main.swift; sourceTree = "<group>"; tabWidth = 2; usesTabs = 0; };
|
||||||
D47F7DCD278BFB57002F9DD7 /* ctlPrefWindow.swift */ = {isa = PBXFileReference; explicitFileType = sourcecode.swift; fileEncoding = 4; indentWidth = 2; lineEnding = 0; path = ctlPrefWindow.swift; sourceTree = "<group>"; tabWidth = 2; usesTabs = 0; };
|
D47F7DCD278BFB57002F9DD7 /* ctlPrefWindow.swift */ = {isa = PBXFileReference; explicitFileType = sourcecode.swift; fileEncoding = 4; indentWidth = 2; lineEnding = 0; path = ctlPrefWindow.swift; sourceTree = "<group>"; tabWidth = 2; usesTabs = 0; };
|
||||||
|
|
@ -500,7 +498,6 @@
|
||||||
5B21176D28753B35000443A9 /* ctlInputMethod_HandleDisplay.swift */,
|
5B21176D28753B35000443A9 /* ctlInputMethod_HandleDisplay.swift */,
|
||||||
5B21176B287539BB000443A9 /* ctlInputMethod_HandleStates.swift */,
|
5B21176B287539BB000443A9 /* ctlInputMethod_HandleStates.swift */,
|
||||||
5BB802D927FABA8300CF1C19 /* ctlInputMethod_Menu.swift */,
|
5BB802D927FABA8300CF1C19 /* ctlInputMethod_Menu.swift */,
|
||||||
D456576D279E4F7B00DF6BC9 /* InputSignal.swift */,
|
|
||||||
D461B791279DAC010070E734 /* InputState.swift */,
|
D461B791279DAC010070E734 /* InputState.swift */,
|
||||||
5BD0113C2818543900609769 /* KeyHandler_Core.swift */,
|
5BD0113C2818543900609769 /* KeyHandler_Core.swift */,
|
||||||
5B782EC3280C243C007276DE /* KeyHandler_HandleCandidate.swift */,
|
5B782EC3280C243C007276DE /* KeyHandler_HandleCandidate.swift */,
|
||||||
|
|
@ -1223,7 +1220,6 @@
|
||||||
D47F7DD0278C0897002F9DD7 /* ctlNonModalAlertWindow.swift in Sources */,
|
D47F7DD0278C0897002F9DD7 /* ctlNonModalAlertWindow.swift in Sources */,
|
||||||
5B2170E5289FACAD00BE7304 /* 6_Node.swift in Sources */,
|
5B2170E5289FACAD00BE7304 /* 6_Node.swift in Sources */,
|
||||||
5B949BD92816DC5400D87B5D /* LineReader.swift in Sources */,
|
5B949BD92816DC5400D87B5D /* LineReader.swift in Sources */,
|
||||||
D456576E279E4F7B00DF6BC9 /* InputSignal.swift in Sources */,
|
|
||||||
5BA9FD1027FEDB6B002DE248 /* suiPrefPaneKeyboard.swift in Sources */,
|
5BA9FD1027FEDB6B002DE248 /* suiPrefPaneKeyboard.swift in Sources */,
|
||||||
5B3133BF280B229700A4A505 /* KeyHandler_States.swift in Sources */,
|
5B3133BF280B229700A4A505 /* KeyHandler_States.swift in Sources */,
|
||||||
5B2170E1289FACAD00BE7304 /* 0_Megrez.swift in Sources */,
|
5B2170E1289FACAD00BE7304 /* 0_Megrez.swift in Sources */,
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue