441 lines
20 KiB
Swift
441 lines
20 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.
|
||
|
||
/// 該檔案用來處理 InputHandler.HandleInput() 當中的與組字有關的行為。
|
||
|
||
import AppKit
|
||
import Shared
|
||
import Tekkon
|
||
|
||
extension InputHandler {
|
||
/// 用來處理 InputHandler.HandleInput() 當中的與組字有關的行為。
|
||
/// - Parameter input: 輸入訊號。
|
||
/// - Returns: 告知 IMK「該按鍵是否已經被輸入法攔截處理」。
|
||
func handleComposition(input: InputSignalProtocol) -> Bool? {
|
||
guard let delegate = delegate else { return nil }
|
||
// 不處理任何包含不可列印字元的訊號。
|
||
guard !input.text.isEmpty, input.charCode.isPrintable else { return nil }
|
||
if isCodePointInputMode { return handleCodePointComposition(input: input) }
|
||
if prefs.cassetteEnabled {
|
||
// 準備處理 `%quick` 選字行為。
|
||
var handleQuickCandidate = true
|
||
if currentLM.areCassetteCandidateKeysShiftHeld { handleQuickCandidate = input.isShiftHold }
|
||
let hasQuickCandidates: Bool = delegate.state.type == .ofInputting && delegate.state.isCandidateContainer
|
||
|
||
// 處理 `%symboldef` 選字行為。
|
||
if handleCassetteSymbolTable(input: input) {
|
||
return true
|
||
} else if hasQuickCandidates, input.text != currentLM.cassetteWildcardKey,
|
||
let itim = input.inputTextIgnoringModifiers,
|
||
let newEv = (input as? NSEvent)?.reinitiate(characters: itim)
|
||
{
|
||
// 處理 `%quick` 選字行為（當且僅當與 `%symboldef` 衝突的情況下）。
|
||
guard !(handleQuickCandidate && handleCandidate(input: newEv)) else { return true }
|
||
} else {
|
||
// 處理 `%quick` 選字行為。
|
||
guard !(hasQuickCandidates && handleQuickCandidate && handleCandidate(input: input)) else { return true }
|
||
}
|
||
return handleCassetteComposition(input: input)
|
||
}
|
||
return handlePhonabetComposition(input: input)
|
||
}
|
||
|
||
// MARK: 注音按鍵輸入處理 (Handle BPMF Keys)
|
||
|
||
/// 用來處理 InputHandler.HandleInput() 當中的與注音输入有關的組字行為。
|
||
/// - Parameter input: 輸入訊號。
|
||
/// - Returns: 告知 IMK「該按鍵是否已經被輸入法攔截處理」。
|
||
private func handlePhonabetComposition(input: InputSignalProtocol) -> Bool? {
|
||
guard let delegate = delegate else { return nil }
|
||
var inputText = (input.inputTextIgnoringModifiers ?? input.text)
|
||
inputText = inputText.lowercased().applyingTransformFW2HW(reverse: false)
|
||
let existedIntonation = composer.intonation
|
||
var overrideHappened = false
|
||
|
||
// 哪怕不啟用支援對「先輸入聲調、後輸入注音」的情況的支援，對 keyConsumedByReading 的處理得保留。
|
||
// 不然的話，「敲 Space 叫出選字窗」的功能會失效。
|
||
// 究其原因，乃是因為威注音所用的鐵恨注拼引擎「有在處理陰平聲調」的緣故。
|
||
// 對於某些動態注音排列，威注音會依賴包括陰平聲調鍵在內的聲調按鍵做結算判斷。
|
||
var keyConsumedByReading = false
|
||
let skipPhoneticHandling =
|
||
input.isReservedKey || input.isNumericPadKey || input.isNonLaptopFunctionKey
|
||
|| input.isControlHold || input.isOptionHold || input.isShiftHold || input.isCommandHold
|
||
let confirmCombination = input.isSpace || input.isEnter
|
||
|
||
// 這裡 inputValidityCheck() 是讓注拼槽檢查 charCode 這個 UniChar 是否是合法的注音輸入。
|
||
// 如果是的話，就將這次傳入的這個按鍵訊號塞入注拼槽內且標記為「keyConsumedByReading」。
|
||
// 函式 composer.receiveKey() 可以既接收 String 又接收 UniChar。
|
||
if (!skipPhoneticHandling && composer.inputValidityCheck(charStr: inputText)) || confirmCombination {
|
||
// 引入 macOS 內建注音輸入法的行為，允許用除了陰平以外的聲調鍵覆寫前一個漢字的讀音。
|
||
// 但如果要覆寫的內容會導致游標身後的字音沒有對應的辭典記錄的話，那就只蜂鳴警告一下。
|
||
proc: if [0, 1].contains(prefs.specifyIntonationKeyBehavior), composer.isEmpty, !input.isSpace {
|
||
// prevReading 的內容分別是：「完整讀音」「去掉聲調的讀音」「是否有聲調」。
|
||
guard let prevReading = previousParsableReading, isIntonationKey(input) else { break proc }
|
||
var theComposer = composer
|
||
prevReading.0.map(\.description).forEach { theComposer.receiveKey(fromPhonabet: $0) }
|
||
// 發現要覆寫的聲調與覆寫對象的聲調雷同的情況的話，直接跳過處理。
|
||
let oldIntonation: Tekkon.Phonabet = theComposer.intonation
|
||
theComposer.receiveKey(fromString: inputText)
|
||
if theComposer.intonation == oldIntonation, prefs.specifyIntonationKeyBehavior == 1 { break proc }
|
||
theComposer.intonation.clear()
|
||
// 檢查新的漢字字音是否在庫。
|
||
let temporaryReadingKey = theComposer.getComposition()
|
||
if currentLM.hasUnigramsFor(keyArray: [temporaryReadingKey]) {
|
||
compositor.dropKey(direction: .rear)
|
||
walk() // 這裡必須 Walk 一次、來更新目前被 walk 的內容。
|
||
composer = theComposer
|
||
// 這裡不需要回呼 generateStateOfInputting()，因為當前輸入的聲調鍵一定是合規的、會在之後回呼 generateStateOfInputting()。
|
||
overrideHappened = true
|
||
} else {
|
||
delegate.callError("4B0DD2D4：語彙庫內無「\(temporaryReadingKey)」的匹配記錄，放棄覆寫游標身後的內容。")
|
||
return true
|
||
}
|
||
}
|
||
|
||
// 鐵恨引擎並不具備對 Enter (CR / LF) 鍵的具體判斷能力，所以在這裡單獨處理。
|
||
composer.receiveKey(fromString: confirmCombination ? " " : inputText)
|
||
keyConsumedByReading = true
|
||
|
||
// 沒有調號的話，只需要 setInlineDisplayWithCursor() 且終止處理（return true）即可。
|
||
// 有調號的話，則不需要這樣，而是轉而繼續在此之後的處理。
|
||
if !composer.hasIntonation() {
|
||
delegate.switchState(generateStateOfInputting())
|
||
return true
|
||
}
|
||
}
|
||
|
||
// 這裡不需要做排他性判斷。
|
||
var composeReading = composer.hasIntonation() && composer.inputValidityCheck(charStr: inputText)
|
||
// 如果當前的按鍵是 Enter 或 Space 的話，這時就可以取出 composer 內的注音來做檢查了。
|
||
// 來看看詞庫內到底有沒有對應的讀音索引。這裡用了類似「|=」的判斷處理方式。
|
||
composeReading = composeReading || (!composer.isEmpty && confirmCombination)
|
||
ifComposeReading: if composeReading {
|
||
if input.isControlHold, input.isCommandHold, input.isEnter,
|
||
!input.isOptionHold, !input.isShiftHold, compositor.isEmpty
|
||
{
|
||
return handleEnter(input: input, readingOnly: true)
|
||
}
|
||
// 拿取用來進行索引檢索用的注音。這裡先不急著處理「僅有注音符號輸入」的情況。
|
||
let maybeKey = composer.phonabetKeyForQuery(pronouncable: prefs.acceptLeadingIntonations)
|
||
guard let readingKey = maybeKey else { break ifComposeReading }
|
||
// 向語言模型詢問是否有對應的記錄。
|
||
if !currentLM.hasUnigramsFor(keyArray: [readingKey]) {
|
||
delegate.callError("B49C0979：語彙庫內無「\(readingKey)」的匹配記錄。")
|
||
|
||
if prefs.keepReadingUponCompositionError {
|
||
composer.intonation.clear() // 砍掉聲調。
|
||
delegate.switchState(generateStateOfInputting())
|
||
return true
|
||
}
|
||
|
||
composer.clear()
|
||
// 根據「組字器是否為空」來判定回呼哪一種狀態。
|
||
switch compositor.isEmpty {
|
||
case false: delegate.switchState(generateStateOfInputting())
|
||
case true: delegate.switchState(IMEState.ofAbortion())
|
||
}
|
||
return true // 向 IMK 報告說這個按鍵訊號已經被輸入法攔截處理了。
|
||
}
|
||
|
||
// 將該讀音插入至組字器內的軌格當中。
|
||
// 提前過濾掉一些不合規的按鍵訊號輸入，免得相關按鍵訊號被送給 Megrez 引發輸入法崩潰。
|
||
if input.isInvalid {
|
||
delegate.callError("22017F76: 不合規的按鍵輸入。")
|
||
return true
|
||
} else if !compositor.insertKey(readingKey) {
|
||
delegate.callError("3CF278C9: 得檢查對應的語言模組的 hasUnigramsFor() 是否有誤判之情形。")
|
||
return true
|
||
}
|
||
|
||
// 讓組字器反爬軌格。
|
||
walk()
|
||
|
||
// 一邊吃一邊屙（僅對位列黑名單的 App 用這招限制組字區長度）。
|
||
let textToCommit = commitOverflownComposition
|
||
|
||
// 看看半衰記憶模組是否會對目前的狀態給出自動選字建議。
|
||
retrieveUOMSuggestions(apply: true)
|
||
|
||
// 之後就是更新組字區了。先清空注拼槽的內容。
|
||
composer.clear()
|
||
|
||
// 再以回呼組字狀態的方式來執行 setInlineDisplayWithCursor()。
|
||
var inputting = generateStateOfInputting()
|
||
inputting.textToCommit = textToCommit
|
||
if overrideHappened {
|
||
inputting.tooltip = "Previous intonation has been overridden.".localized
|
||
inputting.tooltipDuration = 2
|
||
inputting.data.tooltipColorState = .normal
|
||
}
|
||
delegate.switchState(inputting)
|
||
|
||
/// 逐字選字模式的處理。
|
||
if prefs.useSCPCTypingMode {
|
||
let candidateState: IMEStateProtocol = generateStateOfCandidates()
|
||
switch candidateState.candidates.count {
|
||
case 2...: delegate.switchState(candidateState)
|
||
case 1:
|
||
let firstCandidate = candidateState.candidates.first! // 一定會有，所以強制拆包也無妨。
|
||
let reading: [String] = firstCandidate.keyArray
|
||
let text: String = firstCandidate.value
|
||
delegate.switchState(IMEState.ofCommitting(textToCommit: text))
|
||
|
||
if prefs.associatedPhrasesEnabled {
|
||
let associatedCandidates = generateArrayOfAssociates(withPairs: [.init(keyArray: reading, value: text)])
|
||
delegate.switchState(
|
||
associatedCandidates.isEmpty
|
||
? IMEState.ofEmpty()
|
||
: IMEState.ofAssociates(candidates: associatedCandidates)
|
||
)
|
||
}
|
||
default: break
|
||
}
|
||
}
|
||
// 將「這個按鍵訊號已經被輸入法攔截處理了」的結果藉由 SessionCtl 回報給 IMK。
|
||
return true
|
||
}
|
||
|
||
/// 是說此時注拼槽並非為空、卻還沒組音。這種情況下只可能是「注拼槽內只有聲調」。
|
||
/// 但這裡不處理陰平聲調。
|
||
if keyConsumedByReading {
|
||
// 此處將 strict 設為 false，以應對「僅有注音符號輸入」的情況。
|
||
if composer.phonabetKeyForQuery(pronouncable: false) == nil {
|
||
// 將被空格鍵覆蓋掉的既有聲調塞入組字器。
|
||
if !composer.isPinyinMode, input.isSpace,
|
||
compositor.insertKey(existedIntonation.value)
|
||
{
|
||
walk()
|
||
var theInputting = generateStateOfInputting()
|
||
theInputting.textToCommit = commitOverflownComposition
|
||
composer.clear()
|
||
delegate.switchState(theInputting)
|
||
return true
|
||
}
|
||
composer.clear()
|
||
return nil
|
||
}
|
||
// 以回呼組字狀態的方式來執行 setInlineDisplayWithCursor()。
|
||
var resultState = generateStateOfInputting()
|
||
resultState.tooltip = tooltipForStandaloneIntonationMark
|
||
resultState.tooltipDuration = 0
|
||
resultState.data.tooltipColorState = .prompt
|
||
delegate.switchState(resultState)
|
||
return true
|
||
}
|
||
return nil
|
||
}
|
||
}
|
||
|
||
// MARK: - 磁帶模式的組字支援。
|
||
|
||
extension InputHandler {
|
||
/// 用來處理 InputHandler.HandleInput() 當中的與磁帶模組有關的組字行為。
|
||
/// - Parameter input: 輸入訊號。
|
||
/// - Returns: 告知 IMK「該按鍵是否已經被輸入法攔截處理」。
|
||
private func handleCassetteComposition(input: InputSignalProtocol) -> Bool? {
|
||
guard let delegate = delegate else { return nil }
|
||
let state = delegate.state
|
||
var wildcardKey: String { currentLM.cassetteWildcardKey } // 花牌鍵。
|
||
let inputText = input.text
|
||
let isWildcardKeyInput: Bool = (inputText == wildcardKey && !wildcardKey.isEmpty)
|
||
|
||
let skipStrokeHandling =
|
||
input.isReservedKey || input.isNumericPadKey || input.isNonLaptopFunctionKey
|
||
|| input.isControlHold || input.isOptionHold || input.isCommandHold // || input.isShiftHold
|
||
var confirmCombination = input.isSpace
|
||
|
||
var isLongestPossibleKeyFormed: Bool {
|
||
guard !isWildcardKeyInput, prefs.autoCompositeWithLongestPossibleCassetteKey else { return false }
|
||
return !currentLM.hasCassetteWildcardResultsFor(key: calligrapher) && !calligrapher.isEmpty
|
||
}
|
||
|
||
var isStrokesFull: Bool {
|
||
calligrapher.count >= currentLM.maxCassetteKeyLength || isLongestPossibleKeyFormed
|
||
}
|
||
|
||
prehandling: if !skipStrokeHandling && currentLM.isThisCassetteKeyAllowed(key: inputText) {
|
||
if calligrapher.isEmpty, isWildcardKeyInput {
|
||
delegate.callError("3606B9C0")
|
||
if input.beganWithLetter {
|
||
var newEmptyState = compositor.isEmpty ? IMEState.ofEmpty() : generateStateOfInputting()
|
||
newEmptyState.tooltip = NSLocalizedString("Wildcard key cannot be the initial key.", comment: "")
|
||
newEmptyState.data.tooltipColorState = .redAlert
|
||
newEmptyState.tooltipDuration = 1.0
|
||
delegate.switchState(newEmptyState)
|
||
return true
|
||
}
|
||
delegate.callNotification(NSLocalizedString("Wildcard key cannot be the initial key.", comment: ""))
|
||
return nil
|
||
}
|
||
if isStrokesFull {
|
||
delegate.callError("2268DD51: calligrapher is full, clearing calligrapher.")
|
||
calligrapher.removeAll()
|
||
} else {
|
||
calligrapher.append(inputText)
|
||
}
|
||
if isWildcardKeyInput {
|
||
break prehandling
|
||
}
|
||
|
||
if !isStrokesFull {
|
||
var result = generateStateOfInputting()
|
||
if !calligrapher.isEmpty, let fetched = currentLM.cassetteQuickSetsFor(key: calligrapher)?.split(separator: "\t") {
|
||
result.candidates = fetched.enumerated().map {
|
||
(keyArray: [($0.offset + 1).description], value: $0.element.description)
|
||
}
|
||
}
|
||
delegate.switchState(result)
|
||
return true
|
||
}
|
||
}
|
||
|
||
if !(state.type == .ofInputting && state.isCandidateContainer) {
|
||
confirmCombination = confirmCombination || input.isEnter
|
||
}
|
||
|
||
var combineStrokes =
|
||
(isStrokesFull && prefs.autoCompositeWithLongestPossibleCassetteKey)
|
||
|| (isWildcardKeyInput && !calligrapher.isEmpty)
|
||
|
||
// 如果當前的按鍵是 Enter 或 Space 的話，這時就可以取出 calligrapher 內的筆畫來做檢查了。
|
||
// 來看看詞庫內到底有沒有對應的讀音索引。這裡用了類似「|=」的判斷處理方式。
|
||
combineStrokes = combineStrokes || (!calligrapher.isEmpty && confirmCombination)
|
||
ifCombineStrokes: if combineStrokes {
|
||
// 警告：calligrapher 不能為空，否則組字引擎會炸。
|
||
guard !calligrapher.isEmpty else { break ifCombineStrokes }
|
||
if input.isControlHold, input.isCommandHold, input.isEnter,
|
||
!input.isOptionHold, !input.isShiftHold, composer.isEmpty
|
||
{
|
||
return handleEnter(input: input, readingOnly: true)
|
||
}
|
||
// 向語言模型詢問是否有對應的記錄。
|
||
if !currentLM.hasUnigramsFor(keyArray: [calligrapher]) {
|
||
delegate.callError("B49C0979_Cassette：語彙庫內無「\(calligrapher)」的匹配記錄。")
|
||
calligrapher.removeAll()
|
||
// 根據「組字器是否為空」來判定回呼哪一種狀態。
|
||
switch compositor.isEmpty {
|
||
case false: delegate.switchState(generateStateOfInputting())
|
||
case true: delegate.switchState(IMEState.ofAbortion())
|
||
}
|
||
return true // 向 IMK 報告說這個按鍵訊號已經被輸入法攔截處理了。
|
||
}
|
||
|
||
// 將該讀音插入至組字器內的軌格當中。
|
||
// 提前過濾掉一些不合規的按鍵訊號輸入，免得相關按鍵訊號被送給 Megrez 引發輸入法崩潰。
|
||
if input.isInvalid {
|
||
delegate.callError("BFE387CC: 不合規的按鍵輸入。")
|
||
return true
|
||
} else if !compositor.insertKey(calligrapher) {
|
||
delegate.callError("61F6B11F: 得檢查對應的語言模組的 hasUnigramsFor() 是否有誤判之情形。")
|
||
return true
|
||
}
|
||
|
||
// 讓組字器反爬軌格。
|
||
walk()
|
||
|
||
// 一邊吃一邊屙（僅對位列黑名單的 App 用這招限制組字區長度）。
|
||
let textToCommit = commitOverflownComposition
|
||
|
||
// 看看半衰記憶模組是否會對目前的狀態給出自動選字建議。
|
||
retrieveUOMSuggestions(apply: true)
|
||
|
||
// 之後就是更新組字區了。先清空注拼槽的內容。
|
||
calligrapher.removeAll()
|
||
|
||
// 再以回呼組字狀態的方式來執行 setInlineDisplayWithCursor()。
|
||
var inputting = generateStateOfInputting()
|
||
inputting.textToCommit = textToCommit
|
||
delegate.switchState(inputting)
|
||
|
||
/// 逐字選字模式的處理。
|
||
if prefs.useSCPCTypingMode {
|
||
let candidateState: IMEStateProtocol = generateStateOfCandidates()
|
||
switch candidateState.candidates.count {
|
||
case 2...: delegate.switchState(candidateState)
|
||
case 1:
|
||
let firstCandidate = candidateState.candidates.first! // 一定會有，所以強制拆包也無妨。
|
||
let reading: [String] = firstCandidate.keyArray
|
||
let text: String = firstCandidate.value
|
||
delegate.switchState(IMEState.ofCommitting(textToCommit: text))
|
||
|
||
if prefs.associatedPhrasesEnabled {
|
||
let associatedCandidates = generateArrayOfAssociates(withPairs: [.init(keyArray: reading, value: text)])
|
||
delegate.switchState(
|
||
associatedCandidates.isEmpty
|
||
? IMEState.ofEmpty()
|
||
: IMEState.ofAssociates(candidates: associatedCandidates)
|
||
)
|
||
}
|
||
default: break
|
||
}
|
||
}
|
||
// 將「這個按鍵訊號已經被輸入法攔截處理了」的結果藉由 SessionCtl 回報給 IMK。
|
||
return true
|
||
}
|
||
|
||
return nil
|
||
}
|
||
|
||
// MARK: 內碼區位輸入處理 (Handle Code Point Input)
|
||
|
||
/// 用來處理 InputHandler.HandleInput() 當中的與內碼區位輸入有關的組字行為。
|
||
/// - Parameter input: 輸入訊號。
|
||
/// - Returns: 告知 IMK「該按鍵是否已經被輸入法攔截處理」。
|
||
private func handleCodePointComposition(input: InputSignalProtocol) -> Bool? {
|
||
guard !input.isReservedKey else { return nil }
|
||
guard let delegate = delegate, input.text.count == 1 else { return nil }
|
||
guard !input.text.compactMap(\.hexDigitValue).isEmpty else {
|
||
delegate.callError("05DD692C：輸入的字元並非 ASCII 字元。。")
|
||
return true
|
||
}
|
||
switch strCodePointBuffer.count {
|
||
case 0 ..< 4:
|
||
if strCodePointBuffer.count < 3 {
|
||
strCodePointBuffer.append(input.text)
|
||
var updatedState = generateStateOfInputting(guarded: true)
|
||
updatedState.tooltipDuration = 0
|
||
updatedState.tooltip = tooltipCodePointInputMode
|
||
delegate.switchState(updatedState)
|
||
return true
|
||
}
|
||
let encoding: CFStringEncodings? = {
|
||
switch IMEApp.currentInputMode {
|
||
case .imeModeCHS: return .GB_18030_2000
|
||
case .imeModeCHT: return .big5_HKSCS_1999
|
||
default: return nil
|
||
}
|
||
}()
|
||
guard
|
||
var char = "\(strCodePointBuffer)\(input.text)"
|
||
.parsedAsHexLiteral(encoding: encoding)?.first?.description
|
||
else {
|
||
delegate.callError("D220B880：輸入的字碼沒有對應的字元。")
|
||
var updatedState = IMEState.ofAbortion()
|
||
updatedState.tooltipDuration = 0
|
||
updatedState.tooltip = "Invalid Code Point.".localized
|
||
delegate.switchState(updatedState)
|
||
isCodePointInputMode = true
|
||
return true
|
||
}
|
||
// 某些舊版 macOS 會在這裡生成的字元後面插入垃圾字元。這裡只保留起始字元。
|
||
if char.count > 1 { char = char.map(\.description)[0] }
|
||
delegate.switchState(IMEState.ofCommitting(textToCommit: char))
|
||
var updatedState = generateStateOfInputting(guarded: true)
|
||
updatedState.tooltipDuration = 0
|
||
updatedState.tooltip = tooltipCodePointInputMode
|
||
delegate.switchState(updatedState)
|
||
isCodePointInputMode = true
|
||
return true
|
||
default:
|
||
delegate.switchState(generateStateOfInputting())
|
||
isCodePointInputMode = true
|
||
return true
|
||
}
|
||
}
|
||
}
|