213 lines
8.1 KiB
Swift
213 lines
8.1 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 LangModelAssembly
|
||
import Shared
|
||
|
||
/// 用以呈現輸入法控制器（SessionCtl）的各種狀態。
|
||
///
|
||
/// 從實際角度來看，輸入法屬於有限態械（Finite State Machine）。其藉由滑鼠/鍵盤
|
||
/// 等輸入裝置接收輸入訊號，據此切換至對應的狀態，再根據狀態更新使用者介面內容，
|
||
/// 最終生成文字輸出、遞交給接收文字輸入行為的客體應用。此乃單向資訊流序，且使用
|
||
/// 者介面內容與文字輸出均無條件地遵循某一個指定的資料來源。
|
||
///
|
||
/// IMEState 型別用以呈現輸入法控制器正在做的事情，且分狀態儲存各種狀態限定的
|
||
/// 常數與變數。
|
||
///
|
||
/// 對 IMEState 型別下的諸多狀態的切換，應以生成新副本來取代舊有副本的形式來完
|
||
/// 成。唯一例外是 IMEState.ofMarking、擁有可以將自身轉變為 IMEState.ofInputting
|
||
/// 的成員函式，但也只是生成副本、來交給輸入法控制器來處理而已。每個狀態都有
|
||
/// 各自的構造器 (Constructor)。
|
||
///
|
||
/// 輸入法控制器持下述狀態：
|
||
///
|
||
/// - .Deactivated: 使用者沒在使用輸入法。
|
||
/// - .AssociatedPhrases: 逐字選字模式內的聯想詞輸入狀態。因為逐字選字模式不需要在
|
||
/// 組字區內存入任何東西，所以該狀態不受 .NotEmpty 的管轄。
|
||
/// - .Empty: 使用者剛剛切換至該輸入法、卻還沒有任何輸入行為。抑或是剛剛敲字遞交給
|
||
/// 客體應用、準備新的輸入行為。
|
||
/// - .Abortion: 與 Empty 類似，但會扔掉上一個狀態的內容、不將這些
|
||
/// 內容遞交給客體應用。該狀態在處理完畢之後會被立刻切換至 .Empty()。
|
||
/// - .Committing: 該狀態會承載要遞交出去的內容，讓輸入法控制器處理時代為遞交。
|
||
/// - .NotEmpty: 非空狀態，是一種狀態大類、用以派生且代表下述諸狀態。
|
||
/// - .Inputting: 使用者輸入了內容。此時會出現組字區（Compositor）。
|
||
/// - .Marking: 使用者在組字區內標記某段範圍，可以決定是添入新詞、還是將這個範圍的
|
||
/// 詞音組合放入語彙濾除清單。
|
||
/// - .ChoosingCandidate: 叫出選字窗、允許使用者選字。
|
||
/// - .SymbolTable: 波浪鍵符號選單專用的狀態，有自身的特殊處理。
|
||
public struct IMEState: IMEStateProtocol {
|
||
public var type: StateType = .ofEmpty
|
||
public var data: IMEStateDataProtocol = IMEStateData() as IMEStateDataProtocol
|
||
public var node: CandidateNode = .init(name: "")
|
||
public var isASCIIMode = false
|
||
public var isVerticalCandidateWindow = false
|
||
init(_ data: IMEStateDataProtocol = IMEStateData() as IMEStateDataProtocol, type: StateType = .ofEmpty) {
|
||
self.data = data
|
||
self.type = type
|
||
isVerticalTyping = SessionCtl.isVerticalTyping
|
||
}
|
||
|
||
init(
|
||
_ data: IMEStateDataProtocol = IMEStateData() as IMEStateDataProtocol, type: StateType = .ofEmpty,
|
||
node: CandidateNode
|
||
) {
|
||
self.data = data
|
||
self.type = type
|
||
self.node = node
|
||
self.data.candidates = node.members.map { ("", $0.name) }
|
||
}
|
||
}
|
||
|
||
// MARK: - 針對不同的狀態，規定不同的構造器
|
||
|
||
extension IMEState {
|
||
public static func ofDeactivated() -> IMEState { .init(type: .ofDeactivated) }
|
||
public static func ofEmpty() -> IMEState { .init(type: .ofEmpty) }
|
||
public static func ofAbortion() -> IMEState { .init(type: .ofAbortion) }
|
||
public static func ofCommitting(textToCommit: String) -> IMEState {
|
||
var result = IMEState(type: .ofCommitting)
|
||
result.textToCommit = textToCommit
|
||
ChineseConverter.ensureCurrencyNumerals(target: &result.data.textToCommit)
|
||
return result
|
||
}
|
||
|
||
public static func ofAssociates(candidates: [(String, String)]) -> IMEState {
|
||
var result = IMEState(type: .ofAssociates)
|
||
result.candidates = candidates
|
||
return result
|
||
}
|
||
|
||
public static func ofNotEmpty(displayTextSegments: [String], cursor: Int) -> IMEState {
|
||
var result = IMEState(type: .ofNotEmpty)
|
||
// 注意資料的設定順序，一定得先設定 displayTextSegments。
|
||
result.data.displayTextSegments = displayTextSegments.map {
|
||
if !SessionCtl.isVerticalTyping { return $0 }
|
||
guard PrefMgr.shared.hardenVerticalPunctuations else { return $0 }
|
||
var neta = $0
|
||
ChineseConverter.hardenVerticalPunctuations(target: &neta, convert: SessionCtl.isVerticalTyping)
|
||
return neta
|
||
}
|
||
|
||
result.data.cursor = cursor
|
||
result.data.marker = cursor
|
||
return result
|
||
}
|
||
|
||
public static func ofInputting(displayTextSegments: [String], cursor: Int) -> IMEState {
|
||
var result = Self.ofNotEmpty(displayTextSegments: displayTextSegments, cursor: cursor)
|
||
result.type = .ofInputting
|
||
return result
|
||
}
|
||
|
||
public static func ofMarking(
|
||
displayTextSegments: [String], markedReadings: [String], cursor: Int, marker: Int
|
||
)
|
||
-> IMEState
|
||
{
|
||
var result = Self.ofNotEmpty(displayTextSegments: displayTextSegments, cursor: cursor)
|
||
result.type = .ofMarking
|
||
result.data.marker = marker
|
||
result.data.markedReadings = markedReadings
|
||
result.data.updateTooltipForMarking()
|
||
return result
|
||
}
|
||
|
||
public static func ofCandidates(candidates: [(String, String)], displayTextSegments: [String], cursor: Int)
|
||
-> IMEState
|
||
{
|
||
var result = Self.ofNotEmpty(displayTextSegments: displayTextSegments, cursor: cursor)
|
||
result.type = .ofCandidates
|
||
result.data.candidates = candidates
|
||
return result
|
||
}
|
||
|
||
public static func ofSymbolTable(node: CandidateNode) -> IMEState {
|
||
var result = IMEState(type: .ofNotEmpty, node: node)
|
||
result.type = .ofSymbolTable
|
||
return result
|
||
}
|
||
}
|
||
|
||
// MARK: - 規定一個狀態該怎樣返回自己的資料值
|
||
|
||
extension IMEState {
|
||
public var isFilterable: Bool { data.isFilterable }
|
||
public var isMarkedLengthValid: Bool { data.isMarkedLengthValid }
|
||
public var displayedText: String { data.displayedText }
|
||
public var displayedTextConverted: String { data.displayedTextConverted }
|
||
public var displayTextSegments: [String] { data.displayTextSegments }
|
||
public var markedRange: Range<Int> { data.markedRange }
|
||
public var u16MarkedRange: Range<Int> { data.u16MarkedRange }
|
||
public var u16Cursor: Int { data.u16Cursor }
|
||
|
||
public var cursor: Int {
|
||
get { data.cursor }
|
||
set { data.cursor = newValue }
|
||
}
|
||
|
||
public var marker: Int {
|
||
get { data.marker }
|
||
set { data.marker = newValue }
|
||
}
|
||
|
||
public var convertedToInputting: IMEStateProtocol {
|
||
if type == .ofInputting { return self }
|
||
var result = Self.ofInputting(displayTextSegments: data.displayTextSegments, cursor: data.cursor)
|
||
result.tooltip = data.tooltipBackupForInputting
|
||
result.isVerticalTyping = isVerticalTyping
|
||
return result
|
||
}
|
||
|
||
public var candidates: [(String, String)] {
|
||
get { data.candidates }
|
||
set { data.candidates = newValue }
|
||
}
|
||
|
||
public var textToCommit: String {
|
||
get { data.textToCommit }
|
||
set { data.textToCommit = newValue }
|
||
}
|
||
|
||
public var tooltip: String {
|
||
get { data.tooltip }
|
||
set { data.tooltip = newValue }
|
||
}
|
||
|
||
public var attributedString: NSAttributedString {
|
||
switch type {
|
||
case .ofMarking: return data.attributedStringMarking
|
||
case .ofAssociates, .ofSymbolTable: return data.attributedStringPlaceholder
|
||
default: return data.attributedStringNormal
|
||
}
|
||
}
|
||
|
||
public var hasComposition: Bool {
|
||
switch type {
|
||
case .ofNotEmpty, .ofInputting, .ofMarking, .ofCandidates: return true
|
||
default: return false
|
||
}
|
||
}
|
||
|
||
public var isVerticalTyping: Bool {
|
||
get { data.isVerticalTyping }
|
||
set { data.isVerticalTyping = newValue }
|
||
}
|
||
|
||
public var isCandidateContainer: Bool {
|
||
switch type {
|
||
case .ofCandidates, .ofAssociates, .ofSymbolTable: return true
|
||
default: return false
|
||
}
|
||
}
|
||
|
||
public var tooltipBackupForInputting: String {
|
||
get { data.tooltipBackupForInputting }
|
||
set { data.tooltipBackupForInputting = newValue }
|
||
}
|
||
}
|