202 lines
8.9 KiB
Swift
202 lines
8.9 KiB
Swift
// (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 CocoaExtension
|
||
import IMKUtils
|
||
import InputMethodKit
|
||
import NotifierUI
|
||
import Shared
|
||
import SwiftyCapsLockToggler
|
||
|
||
// MARK: - Facade
|
||
|
||
public extension SessionCtl {
|
||
/// 接受所有鍵鼠事件為 NSEvent，讓輸入法判斷是否要處理、該怎樣處理。
|
||
/// 然後再交給 InputHandler.handleEvent() 分診。
|
||
/// - Parameters:
|
||
/// - event: 裝置操作輸入事件，可能會是 nil。
|
||
/// - sender: 呼叫了該函式的客體（無須使用）。
|
||
/// - Returns: 回「`true`」以將該按鍵已攔截處理的訊息傳遞給 IMK；回「`false`」則放行、不作處理。
|
||
@objc(handleEvent:client:) override func handle(_ event: NSEvent?, client sender: Any?) -> Bool {
|
||
_ = sender // 防止格式整理工具毀掉與此對應的參數。
|
||
|
||
// 就這傳入的 NSEvent 都還有可能是 nil，Apple InputMethodKit 團隊到底在搞三小。
|
||
// 只針對特定類型的 client() 進行處理。
|
||
guard let event = event, sender is IMKTextInput else {
|
||
resetInputHandler(forceComposerCleanup: true)
|
||
return false
|
||
}
|
||
|
||
// 用 Shift 開關半形英數模式，僅對 macOS 10.15 及之後的 macOS 有效。
|
||
// 警告：這裡的 event 必須是原始 event 且不能被 var，否則會影響 Shift 中英模式判定。
|
||
if Self.theShiftKeyDetector.check(event) {
|
||
toggleAlphanumericalMode()
|
||
// Shift 處理完畢之後也有必要立刻返回處理結果。
|
||
return true
|
||
}
|
||
|
||
guard let newEvent = event.copyAsKBEvent else { return false }
|
||
|
||
switch newEvent.type {
|
||
case .flagsChanged: return handleKeyDown(event: newEvent)
|
||
case .keyDown:
|
||
let result = handleKeyDown(event: newEvent)
|
||
if result { previouslyHandledEvents.append(newEvent) }
|
||
return result
|
||
case .keyUp: return handleKeyUp(event: newEvent)
|
||
}
|
||
}
|
||
|
||
private func handleKeyUp(event: KBEvent) -> Bool {
|
||
guard ![.ofEmpty, .ofAbortion].contains(state.type) else { return false }
|
||
let codes = previouslyHandledEvents.map(\.keyCode)
|
||
if codes.contains(event.keyCode) {
|
||
previouslyHandledEvents = previouslyHandledEvents.filter { prevEvent in
|
||
prevEvent.keyCode != event.keyCode
|
||
}
|
||
return true
|
||
}
|
||
return false
|
||
}
|
||
|
||
private func handleKeyDown(event: KBEvent) -> Bool {
|
||
// MARK: 前置處理
|
||
|
||
// 先放過一些以 .command 觸發的熱鍵（包括剪貼簿熱鍵）。
|
||
if state.type == .ofEmpty, event.isSingleCommandBasedLetterHotKey { return false }
|
||
|
||
// 如果是 deactivated 狀態的話，強制糾正其為 empty()。
|
||
if state.type == .ofDeactivated {
|
||
state = IMEState.ofEmpty()
|
||
return handleKeyDown(event: event)
|
||
}
|
||
|
||
// Caps Lock 通知與切換處理，要求至少 macOS 12 Monterey。
|
||
if #available(macOS 12, *) {
|
||
if event.type == .flagsChanged, event.keyCode == KeyCode.kCapsLock.rawValue {
|
||
DispatchQueue.main.async { [weak self] in
|
||
let isCapsLockTurnedOn = CapsLockToggler.isOn
|
||
if PrefMgr.shared.shiftEisuToggleOffTogetherWithCapsLock, !isCapsLockTurnedOn, self?.isASCIIMode ?? false {
|
||
self?.isASCIIMode.toggle()
|
||
}
|
||
guard PrefMgr.shared.showNotificationsWhenTogglingCapsLock else { return }
|
||
guard !PrefMgr.shared.bypassNonAppleCapsLockHandling else { return }
|
||
let status = NSLocalizedString("NotificationSwitchRevolver", comment: "")
|
||
Notifier.notify(
|
||
message: isCapsLockTurnedOn
|
||
? "Caps Lock " + "Alphanumerical Input Mode".localized + "\n" + status
|
||
: "Chinese Input Mode".localized + "\n" + status
|
||
)
|
||
}
|
||
}
|
||
}
|
||
|
||
// 用 JIS 鍵盤的英數切換鍵來切換中英文模式。
|
||
if event.type == .keyDown, event.isJISAlphanumericalKey {
|
||
toggleAlphanumericalMode()
|
||
return true // Adobe Photoshop 相容：對 JIS 英數切換鍵傳入事件一律立刻返回 true。
|
||
}
|
||
|
||
// MARK: 針對客體的具體處理
|
||
|
||
/// 這裡仍舊需要判斷 flags。之前使輸入法狀態卡住無法敲漢字的問題已在 InputHandler 內修復。
|
||
/// 這裡不判斷 flags 的話，用方向鍵前後定位光標之後，再次試圖觸發組字區時、反而會在首次按鍵時失敗。
|
||
/// 同時注意：必須針對 event.type == .flagsChanged 提前返回結果，
|
||
/// 否則，每次處理這種判斷時都會因為讀取 event.characters? 而觸發 NSInternalInconsistencyException。
|
||
if event.isFlagChanged { return true }
|
||
|
||
/// 沒有文字輸入客體的話，就不要再往下處理了。
|
||
guard let inputHandler = inputHandler, client() != nil else { return false }
|
||
|
||
/// 除非核心辭典有載入，否則一律蜂鳴。
|
||
if !LMMgr.isCoreDBConnected {
|
||
if (event as InputSignalProtocol).isReservedKey { return false }
|
||
var newState: IMEStateProtocol = IMEState.ofEmpty()
|
||
newState.tooltip = NSLocalizedString("Factory dictionary not loaded yet.", comment: "")
|
||
newState.tooltipDuration = 1.85
|
||
newState.data.tooltipColorState = .redAlert
|
||
switchState(newState)
|
||
callError("CoreLM not loaded yet.")
|
||
return true
|
||
}
|
||
|
||
var eventToDeal = event
|
||
|
||
// 如果是方向鍵輸入的話，就想辦法帶上標記資訊、來說明當前是縱排還是橫排。
|
||
if event.isUp || event.isDown || event.isLeft || event.isRight {
|
||
updateVerticalTypingStatus() // 檢查當前環境是否是縱排輸入。
|
||
eventToDeal = event.reinitiate(charactersIgnoringModifiers: isVerticalTyping ? "Vertical" : "Horizontal")
|
||
}
|
||
|
||
// 使 NSEvent 自翻譯，這樣可以讓 Emacs NSEvent 變成標準 NSEvent。
|
||
// 注意不要針對 Empty 空狀態使用這個轉換，否則會使得相關組合鍵第交出垃圾字元。
|
||
if eventToDeal.isEmacsKey {
|
||
if state.type == .ofEmpty { return false }
|
||
let verticalProcessing = (state.isCandidateContainer) ? isVerticalCandidateWindow : isVerticalTyping
|
||
eventToDeal = eventToDeal.convertFromEmacsKeyEvent(isVerticalContext: verticalProcessing)
|
||
}
|
||
|
||
// 在啟用注音排列而非拼音輸入的情況下，強制將當前鍵盤佈局翻譯為美規鍵盤（或指定的其它鍵盤佈局）。
|
||
if !inputHandler.isComposerUsingPinyin || IMKHelper.isDynamicBasicKeyboardLayoutEnabled {
|
||
var defaultLayout = LatinKeyboardMappings(rawValue: PrefMgr.shared.basicKeyboardLayout) ?? .qwerty
|
||
if let parser = KeyboardParser(rawValue: PrefMgr.shared.keyboardParser) {
|
||
switch parser {
|
||
case .ofStandard, .ofIBM, .ofSeigyou, .ofFakeSeigyou, .ofDachen26: defaultLayout = .qwerty
|
||
default: break
|
||
}
|
||
}
|
||
eventToDeal = eventToDeal.layoutTranslated(to: defaultLayout)
|
||
}
|
||
|
||
// Apple 數字小鍵盤處理
|
||
if eventToDeal.isNumericPadKey,
|
||
let eventCharConverted = eventToDeal.characters?.applyingTransformFW2HW(reverse: false)
|
||
{
|
||
eventToDeal = eventToDeal.reinitiate(characters: eventCharConverted)
|
||
} else if [.ofEmpty, .ofInputting].contains(state.type), eventToDeal.isMainAreaNumKey,
|
||
!eventToDeal.isCommandHold, !eventToDeal.isControlHold, eventToDeal.isOptionHold
|
||
{
|
||
// Alt(+Shift)+主鍵盤區數字鍵 預先處理
|
||
eventToDeal = eventToDeal.reinitiate(characters: eventToDeal.mainAreaNumKeyChar)
|
||
}
|
||
|
||
// 準備修飾鍵，用來判定要新增的詞彙是否需要賦以非常低的權重。
|
||
Self.areWeNerfing = eventToDeal.commonKeyModifierFlags == [.shift, .command]
|
||
|
||
/// 直接交給 commonEventHandler 來處理。
|
||
let result = inputHandler.triageInput(event: eventToDeal)
|
||
if !result {
|
||
// 除非是 .ofMarking 狀態，否則讓某些不用去抓的按鍵起到「取消工具提示」的作用。
|
||
if [.ofEmpty].contains(state.type) { tooltipInstance.hide() }
|
||
|
||
// 將 Apple 動態鍵盤佈局的 RAW 輸出轉為 ABC 輸出，除非轉換結果與轉換前的內容一致。
|
||
if IMKHelper.isDynamicBasicKeyboardLayoutEnabled, event.text != eventToDeal.text {
|
||
switchState(IMEState.ofCommitting(textToCommit: eventToDeal.text))
|
||
return true
|
||
}
|
||
}
|
||
|
||
return result
|
||
}
|
||
|
||
/// 切換英數模式開關。
|
||
private func toggleAlphanumericalMode() {
|
||
let status = "NotificationSwitchRevolver".localized
|
||
let oldValue = isASCIIMode
|
||
let newValue = isASCIIMode.toggled()
|
||
Notifier.notify(
|
||
message: newValue
|
||
? NSLocalizedString("Alphanumerical Input Mode", comment: "") + "\n" + status
|
||
: NSLocalizedString("Chinese Input Mode", comment: "") + "\n" + status
|
||
)
|
||
if PrefMgr.shared.shiftEisuToggleOffTogetherWithCapsLock, oldValue, !newValue, CapsLockToggler.isOn {
|
||
CapsLockToggler.turnOff()
|
||
}
|
||
}
|
||
}
|