[VersionUp] 3.8.5 GM Build 3850.

- The hotkey is (Shift+)Opt+FWD/BWD.

.github/workflows/continuous-integration-workflow.yml

@@ -1,4 +1,4 @@
-name: Build-with-macOS-latest
+name: debug-macOS-MainAssembly
 on:
   push:
     branches: [ "main" ]
@@ -7,16 +7,16 @@ on:
 
 jobs:
   build:
-    name: Build (latest)
-    runs-on: macOS-latest
+    name: Build
+    runs-on: macOS-13
     env:
         GIT_SSL_NO_VERIFY: true
     steps:
       - uses: maxim-lobanov/setup-xcode@v1
         with:
-          xcode-version: '^15.0'
+          xcode-version: '^15.1'
       - uses: actions/checkout@v1
       - name: Clean
-        run: make clean
+        run: make spmClean
       - name: Build
-        run: git pull --all && git submodule sync; make update; make
+        run: make spmDebug

DataCompiler/dataCompiler.swift

@@ -194,9 +194,9 @@ func prepareDatabase() -> Bool {
     PRIMARY KEY (theChar)
   ) WITHOUT ROWID;
   """
-  guard sqlite3_open(urlSQLite, &ptrSQL) == SQLITE_OK else { return false }
+  guard sqlite3_open(":memory:", &ptrSQL) == SQLITE_OK else { return false }
   guard sqlite3_exec(ptrSQL, "PRAGMA synchronous = OFF;", nil, nil, nil) == SQLITE_OK else { return false }
-  guard sqlite3_exec(ptrSQL, "PRAGMA journal_mode = MEMORY;", nil, nil, nil) == SQLITE_OK else { return false }
+  guard sqlite3_exec(ptrSQL, "PRAGMA journal_mode = OFF;", nil, nil, nil) == SQLITE_OK else { return false }
   guard sqlMakeTableMACV.runAsSQLExec(dbPointer: &ptrSQL) else { return false }
   guard "begin;".runAsSQLExec(dbPointer: &ptrSQL) else { return false }
 
@@ -231,6 +231,20 @@ func prepareDatabase() -> Bool {
   return true
 }
 
+// MARK: - Dump SQLite3 Memory Database to File.
+
+@discardableResult func dumpSQLDB() -> Bool {
+  var ptrSQLTarget: OpaquePointer?
+  defer { sqlite3_close_v2(ptrSQLTarget) }
+  guard sqlite3_open(urlSQLite, &ptrSQLTarget) == SQLITE_OK else { return false }
+  let ptrBackupObj = sqlite3_backup_init(ptrSQLTarget, "main", ptrSQL, "main")
+  if ptrBackupObj != nil {
+    sqlite3_backup_step(ptrBackupObj, -1)
+    sqlite3_backup_finish(ptrBackupObj)
+  }
+  return sqlite3_errcode(ptrSQLTarget) == SQLITE_OK
+}
+
 // MARK: - 載入詞組檔案且輸出陣列
 
 func rawDictForPhrases(isCHS: Bool) -> [Unigram] {
@@ -1044,6 +1058,19 @@ func healthCheck(_ data: [Unigram]) -> String {
   return result
 }
 
+// MARK: - 與主執行緒有關的任務 Flags
+
+struct TaskFlags: OptionSet {
+  public let rawValue: Int
+  public init(rawValue: Int) {
+    self.rawValue = rawValue
+  }
+
+  public static let common = TaskFlags(rawValue: 1 << 0)
+  public static let chs = TaskFlags(rawValue: 1 << 1)
+  public static let cht = TaskFlags(rawValue: 1 << 2)
+}
+
 // MARK: - 主執行緒
 
 var compileJSON = false
@@ -1061,62 +1088,76 @@ func main() {
     compileJSON = false
     compileSQLite = true
   }
-
-  if !prepareDatabase(), compileSQLite {
+  let prepared = prepareDatabase()
+  if compileSQLite, !prepared {
     NSLog("// SQLite 資料庫初期化失敗。")
     exit(-1)
   }
+
+  var taskFlags: TaskFlags = [.common, .chs, .cht] {
+    didSet {
+      guard taskFlags.isEmpty else { return }
+      NSLog("// 全部 TXT 辭典檔案建置完畢。")
+      if compileJSON {
+        NSLog("// 全部 JSON 辭典檔案建置完畢。")
+      }
+      if compileSQLite, prepared {
+        NSLog("// 開始整合反查資料。")
+        mapReverseLookupForCheck.forEach { key, values in
+          values.reversed().forEach { valueLiteral in
+            let value = cnvPhonabetToASCII(valueLiteral)
+            if !rangeMapReverseLookup[key, default: []].contains(value) {
+              rangeMapReverseLookup[key, default: []].insert(value, at: 0)
+            }
+          }
+        }
+        NSLog("// 反查資料整合完畢。")
+        NSLog("// 準備建置 SQL 資料庫。")
+        writeMainMapToSQL(rangeMapJSONCHS, column: "theDataCHS")
+        writeMainMapToSQL(rangeMapJSONCHT, column: "theDataCHT")
+        writeMainMapToSQL(rangeMapSymbols, column: "theDataSYMB")
+        writeMainMapToSQL(rangeMapZhuyinwen, column: "theDataCHEW")
+        writeMainMapToSQL(rangeMapCNS, column: "theDataCNS")
+        writeRevLookupMapToSQL(rangeMapReverseLookup)
+        let committed = "commit;".runAsSQLExec(dbPointer: &ptrSQL)
+        assert(committed)
+        let compressed = "VACUUM;".runAsSQLExec(dbPointer: &ptrSQL)
+        assert(compressed)
+        if !dumpSQLDB() {
+          NSLog("// SQLite 辭典傾印失敗。")
+        } else {
+          NSLog("// 全部 SQLite 辭典檔案建置完畢。")
+        }
+        sqlite3_close_v2(ptrSQL)
+      }
+    }
+  }
+
   let globalQueue = DispatchQueue.global(qos: .default)
   let group = DispatchGroup()
   group.enter()
   globalQueue.async {
     NSLog("// 準備編譯符號表情ㄅ文語料檔案。")
     commonFileOutput()
+    taskFlags.remove(.common)
     group.leave()
   }
   group.enter()
   globalQueue.async {
     NSLog("// 準備編譯繁體中文核心語料檔案。")
     fileOutput(isCHS: false)
+    taskFlags.remove(.cht)
     group.leave()
   }
   group.enter()
   globalQueue.async {
     NSLog("// 準備編譯簡體中文核心語料檔案。")
     fileOutput(isCHS: true)
+    taskFlags.remove(.chs)
     group.leave()
   }
   // 一直等待完成
   group.wait()
-  NSLog("// 全部 TXT 辭典檔案建置完畢。")
-  if compileJSON {
-    NSLog("// 全部 JSON 辭典檔案建置完畢。")
-  }
-  if compileSQLite {
-    NSLog("// 開始整合反查資料。")
-    mapReverseLookupForCheck.forEach { key, values in
-      values.reversed().forEach { valueLiteral in
-        let value = cnvPhonabetToASCII(valueLiteral)
-        if !rangeMapReverseLookup[key, default: []].contains(value) {
-          rangeMapReverseLookup[key, default: []].insert(value, at: 0)
-        }
-      }
-    }
-    NSLog("// 反查資料整合完畢。")
-    NSLog("// 準備建置 SQL 資料庫。")
-    writeMainMapToSQL(rangeMapJSONCHS, column: "theDataCHS")
-    writeMainMapToSQL(rangeMapJSONCHT, column: "theDataCHT")
-    writeMainMapToSQL(rangeMapSymbols, column: "theDataSYMB")
-    writeMainMapToSQL(rangeMapZhuyinwen, column: "theDataCHEW")
-    writeMainMapToSQL(rangeMapCNS, column: "theDataCNS")
-    writeRevLookupMapToSQL(rangeMapReverseLookup)
-    let committed = "commit;".runAsSQLExec(dbPointer: &ptrSQL)
-    assert(committed)
-    let compressed = "VACUUM;".runAsSQLExec(dbPointer: &ptrSQL)
-    assert(compressed)
-    sqlite3_close_v2(ptrSQL)
-    NSLog("// 全部 SQLite 辭典檔案建置完畢。")
-  }
 }
 
 main()

Installer/InstallerShared.swift

@@ -50,7 +50,7 @@ var allRegisteredInstancesOfThisInputMethod: [TISInputSource] {
   else {
     return []
   }
-  return tsInputModeListKey.keys.compactMap { TISInputSource.generate(from: $0) }
+  return TISInputSource.match(modeIDs: tsInputModeListKey.keys.map(\.description))
 }
 
 // MARK: - NSApp Activation Helper

Installer/MainView.swift

@@ -10,6 +10,8 @@ import AppKit
 import SwiftUI
 
 public struct MainView: View {
+  static let strCopyrightLabel = Bundle.main.localizedInfoDictionary?["NSHumanReadableCopyright"] as? String ?? "BAD_COPYRIGHT_LABEL"
+
   @State var pendingSheetPresenting = false
   @State var isShowingAlertForFailedInstallation = false
   @State var isShowingAlertForMissingPostInstall = false
@@ -53,6 +55,7 @@ public struct MainView: View {
                 Text("v\(versionString) Build \(installingVersion)").lineLimit(1)
               }.fixedSize()
               Text("i18n:installer.APP_DERIVED_FROM").font(.custom("Tahoma", size: 11))
+              Text(Self.strCopyrightLabel).font(.custom("Tahoma", size: 11))
               Text("i18n:installer.DEV_CREW").font(.custom("Tahoma", size: 11)).padding([.vertical], 2)
             }
           }

Installer/Resources/en.lproj/Localizable.strings

@@ -1,30 +1,30 @@
-"vChewing Input Method" = "vChewing Input Method";
-"i18n:installer.DO_APP_UPGRADE" = "Accept & Upgrade";
+"Abort" = "Abort";
+"Attention" = "Attention";
 "Cancel" = "Cancel";
 "Cannot activate the input method." = "Cannot activate the input method.";
 "Cannot copy the file to the destination." = "Cannot copy the file to the destination.";
+"Cannot find input source %@ after registration." = "Cannot find input source %@ after registration.";
+"Cannot register input source %@ at %@." = "Cannot register input source %@ at %@.";
+"Continue" = "Continue";
+"Fatal Error" = "Fatal Error";
+"i18n:installer.ACCEPT_INSTALLATION" = "I Accept";
+"i18n:installer.APP_DERIVED_FROM" = "Was derived from OpenVanilla McBopopmofo Project (MIT-License).";
+"i18n:installer.APP_NAME" = "vChewing for macOS";
+"i18n:installer.CANCEL_INSTALLATION" = "Cancel";
+"i18n:installer.DEV_CREW" = "vChewing macOS Development: Shiki Suen, Isaac Xen, Hiraku Wang, etc.\nvChewing Phrase Database Maintained by Shiki Suen.\nWalking algorithm by Lukhnos Liu (from Gramambular 2, MIT-License).";
+"i18n:installer.DISCLAIMER_TEXT" = "DISCLAIMER: The vChewing project, having no relationship of cooperation or affiliation with the OpenVanilla project, is not responsible for the phrase database shipped in the original McBopomofo project. Certain geopolitical and ideological contents, which are potentially harmful to the global spread of this software, are not included in vChewing official phrase database.";
+"i18n:installer.DO_APP_UPGRADE" = "Accept & Upgrade";
+"i18n:installer.EULA_PROMPT_NOTICE" = "By installing the software, you must accept the terms above.";
+"i18n:installer.INSTALLER_APP_TITLE_FULL" = "vChewing Installer";
+"i18n:installer.INSTALLER_APP_TITLE" = "vChewing Installer";
+"i18n:installer.LICENSE_TITLE" = "MIT-NTL License:";
+"i18n:installer.STOPPING_THE_OLD_VERSION" = "Stopping the old version. This may take up to one minute…";
+"Input method may not be fully enabled. Please enable it through System Preferences > Keyboard > Input Sources." = "Input method may not be fully enabled. Please enable it through System Preferences > Keyboard > Input Sources.";
 "Install Failed" = "Install Failed";
 "Installation Successful" = "Installation Successful";
 "OK" = "OK";
-"vChewing is ready to use. \n\nPlease relogin if this is the first time you install it in this user account." = "vChewing is ready to use. \n\nPlease relogin if this is the first time you install it in this user account.";
 "Stopping the old version. This may take up to one minute…" = "Stopping the old version. This may take up to one minute…";
-"Attention" = "Attention";
+"vChewing Input Method" = "vChewing Input Method";
+"vChewing is ready to use. \n\nPlease relogin if this is the first time you install it in this user account." = "vChewing is ready to use. \n\nPlease relogin if this is the first time you install it in this user account.";
 "vChewing is upgraded, but please log out or reboot for the new version to be fully functional." = "vChewing is upgraded, but please log out or reboot for the new version to be fully functional.";
-"Fatal Error" = "Fatal Error";
-"Abort" = "Abort";
-"Cannot register input source %@ at %@." = "Cannot register input source %@ at %@.";
-"Cannot find input source %@ after registration." = "Cannot find input source %@ after registration.";
 "Warning" = "Warning";
-"Input method may not be fully enabled. Please enable it through System Preferences > Keyboard > Input Sources." = "Input method may not be fully enabled. Please enable it through System Preferences > Keyboard > Input Sources.";
-"Continue" = "Continue";
-"i18n:installer.DISCLAIMER_TEXT" = "DISCLAIMER: The vChewing project, having no relationship of cooperation or affiliation with the OpenVanilla project, is not responsible for the phrase database shipped in the original McBopomofo project. Certain geopolitical and ideological contents, which are potentially harmful to the global spread of this software, are not included in vChewing official phrase database.";
-"i18n:installer.INSTALLER_APP_TITLE" = "vChewing Installer";
-"i18n:installer.INSTALLER_APP_TITLE_FULL" = "vChewing Installer";
-"i18n:installer.ACCEPT_INSTALLATION" = "I Accept";
-"i18n:installer.CANCEL_INSTALLATION" = "Cancel";
-"i18n:installer.LICENSE_TITLE" = "MIT-NTL License:";
-"i18n:installer.APP_NAME" = "vChewing for macOS";
-"i18n:installer.APP_DERIVED_FROM" = "Was derived from OpenVanilla McBopopmofo Project (MIT-License).";
-"i18n:installer.DEV_CREW" = "vChewing macOS Development: Shiki Suen, Isaac Xen, Hiraku Wang, etc.\nvChewing Phrase Database Maintained by Shiki Suen.\nWalking algorithm by Lukhnos Liu (from Gramambular 2, MIT-License).";
-"i18n:installer.EULA_PROMPT_NOTICE" = "By installing the software, you must accept the terms above.";
-"i18n:installer.STOPPING_THE_OLD_VERSION" = "Stopping the old version. This may take up to one minute…";

Installer/Resources/ja.lproj/Localizable.strings

@@ -1,30 +1,30 @@
-"vChewing Input Method" = "威注音入力アプリ";
-"i18n:installer.DO_APP_UPGRADE" = "承認と更新";
+"Abort" = "中止";
+"Attention" = "ご注意";
 "Cancel" = "取消";
 "Cannot activate the input method." = "入力アプリ、起動失敗。";
 "Cannot copy the file to the destination." = "目標へファイルのコピーできません。";
+"Cannot find input source %@ after registration." = "登録済みですが「%@」は見つけませんでした。";
+"Cannot register input source %@ at %@." = "「%2$@」で入力アプリ「\"%1$@\"」の実装は失敗しました。";
+"Continue" = "続行";
+"Fatal Error" = "致命錯乱";
+"i18n:installer.ACCEPT_INSTALLATION" = "承認する";
+"i18n:installer.APP_DERIVED_FROM" = "曾て OpenVanilla 小麦注音プロジェクト (MIT-License) から派生。";
+"i18n:installer.APP_NAME" = "vChewing for macOS";
+"i18n:installer.CANCEL_INSTALLATION" = "取消";
+"i18n:installer.DEV_CREW" = "macOS 版威注音の開発：Shiki Suen, Isaac Xen, Hiraku Wang, など。\n威注音語彙データの維持：Shiki Suen。\nウォーキング算法：Lukhnos Liu (Gramambular 2, MIT-License)。";
+"i18n:installer.DISCLAIMER_TEXT" = "免責事項：vChewing Project は、OpenVanilla と協力関係や提携関係にあるわけではなく、OpenVanilla が小麦注音プロジェクトに同梱した辞書データについて、vChewing Project は一切責任負い兼ねる。特定な地政学的・観念形態的な内容は、vChewing アプリの世界的な普及に妨害する恐れがあるため、vChewing 公式辞書データに不収録。";
+"i18n:installer.DO_APP_UPGRADE" = "承認と更新";
+"i18n:installer.EULA_PROMPT_NOTICE" = "このアプリを実装するために、上記の条約を承認すべきである。";
+"i18n:installer.INSTALLER_APP_TITLE_FULL" = "威注音入力 実装用アプリ";
+"i18n:installer.INSTALLER_APP_TITLE" = "威注音入力 実装用アプリ";
+"i18n:installer.LICENSE_TITLE" = "ＭＩＴ商標不許可ライセンス (MIT-NTL License):";
+"i18n:installer.STOPPING_THE_OLD_VERSION" = "古いバージョンを強制停止中。１分かかると恐れ入りますが……";
+"Input method may not be fully enabled. Please enable it through System Preferences > Keyboard > Input Sources." = "入力アプリの自動起動はうまく出来なかったかもしれません。ご自分で「システム環境設定→キーボード→入力ソース」で起動してください。";
 "Install Failed" = "実装失敗。";
 "Installation Successful" = "実装完了";
 "OK" = "うむ";
-"vChewing is ready to use. \n\nPlease relogin if this is the first time you install it in this user account." = "威注音入力、利用準備完了。\n\nこのシステムユーザーアカウントで初めて実装した場合、再ログインしてください。";
 "Stopping the old version. This may take up to one minute…" = "古いバージョンを強制停止中。１分かかると恐れ入りますが……";
-"Attention" = "ご注意";
+"vChewing Input Method" = "威注音入力アプリ";
+"vChewing is ready to use. \n\nPlease relogin if this is the first time you install it in this user account." = "威注音入力、利用準備完了。\n\nこのシステムユーザーアカウントで初めて実装した場合、再ログインしてください。";
 "vChewing is upgraded, but please log out or reboot for the new version to be fully functional." = "威注音入力の更新は実装完了しましたが、うまく作動できるために、このパソコンの再起動および再ログインが必要だと恐れ入ります。";
-"Fatal Error" = "致命錯乱";
-"Abort" = "中止";
-"Cannot register input source %@ at %@." = "「%2$@」で入力アプリ「\"%1$@\"」の実装は失敗しました。";
-"Cannot find input source %@ after registration." = "登録済みですが「%@」は見つけませんでした。";
 "Warning" = "お知らせ";
-"Input method may not be fully enabled. Please enable it through System Preferences > Keyboard > Input Sources." = "入力アプリの自動起動はうまく出来なかったかもしれません。ご自分で「システム環境設定→キーボード→入力ソース」で起動してください。";
-"Continue" = "続行";
-"i18n:installer.DISCLAIMER_TEXT" = "免責事項：vChewing Project は、OpenVanilla と協力関係や提携関係にあるわけではなく、OpenVanilla が小麦注音プロジェクトに同梱した辞書データについて、vChewing Project は一切責任負い兼ねる。特定な地政学的・観念形態的な内容は、vChewing アプリの世界的な普及に妨害する恐れがあるため、vChewing 公式辞書データに不収録。";
-"i18n:installer.INSTALLER_APP_TITLE" = "威注音入力 実装用アプリ";
-"i18n:installer.INSTALLER_APP_TITLE_FULL" = "威注音入力 実装用アプリ";
-"i18n:installer.ACCEPT_INSTALLATION" = "承認する";
-"i18n:installer.CANCEL_INSTALLATION" = "取消";
-"i18n:installer.LICENSE_TITLE" = "ＭＩＴ商標不許可ライセンス (MIT-NTL License):";
-"i18n:installer.APP_NAME" = "vChewing for macOS";
-"i18n:installer.APP_DERIVED_FROM" = "曾て OpenVanilla 小麦注音プロジェクト (MIT-License) から派生。";
-"i18n:installer.DEV_CREW" = "macOS 版威注音の開発：Shiki Suen, Isaac Xen, Hiraku Wang, など。\n威注音語彙データの維持：Shiki Suen。\nウォーキング算法：Lukhnos Liu (Gramambular 2, MIT-License)。";
-"i18n:installer.EULA_PROMPT_NOTICE" = "このアプリを実装するために、上記の条約を承認すべきである。";
-"i18n:installer.STOPPING_THE_OLD_VERSION" = "古いバージョンを強制停止中。１分かかると恐れ入りますが……";

Installer/Resources/zh-Hans.lproj/Localizable.strings

@@ -1,30 +1,30 @@
-"vChewing Input Method" = "威注音输入法";
-"i18n:installer.DO_APP_UPGRADE" = "接受并升级";
+"Abort" = "放弃安装";
+"Attention" = "请注意";
 "Cancel" = "取消";
 "Cannot activate the input method." = "无法启用输入法。";
 "Cannot copy the file to the destination." = "无法将输入法拷贝至目的地。";
+"Cannot find input source %@ after registration." = "在注册完输入法 \"%@\" 之后仍然无法找到该输入法。";
+"Cannot register input source %@ at %@." = "无法从档案位置 %2$@ 安装输入法 \"%1$@\"。";
+"Continue" = "继续";
+"Fatal Error" = "安装错误";
+"i18n:installer.ACCEPT_INSTALLATION" = "我接受";
+"i18n:installer.APP_DERIVED_FROM" = "该专案曾由 OpenVanilla 小麦注音专案 (MIT-License) 衍生而来。";
+"i18n:installer.APP_NAME" = "vChewing for macOS";
+"i18n:installer.CANCEL_INSTALLATION" = "取消安装";
+"i18n:installer.DEV_CREW" = "威注音 macOS 程式研发：Shiki Suen, Isaac Xen, Hiraku Wang, 等。\n威注音词库维护：Shiki Suen。\n爬轨算法：Lukhnos Liu (Gramambular 2, MIT-License)。";
+"i18n:installer.DISCLAIMER_TEXT" = "免责声明：威注音专案对小麦注音官方专案内赠的小麦注音原版词库内容不负任何责任。威注音输入法专用的威注音官方词库不包含任何「会在法理上妨碍威注音在全球传播」的「与地缘政治及政治意识形态有关的」内容。威注音专案与 OpenVanilla 专案之间无合作关系、无隶属关系。";
+"i18n:installer.DO_APP_UPGRADE" = "接受并升级";
+"i18n:installer.EULA_PROMPT_NOTICE" = "若要安装该软件，请接受上述条款。";
+"i18n:installer.INSTALLER_APP_TITLE_FULL" = "威注音输入法安装程式";
+"i18n:installer.INSTALLER_APP_TITLE" = "威注音安装程式";
+"i18n:installer.LICENSE_TITLE" = "麻理去商标授权合约 (MIT-NTL License):";
+"i18n:installer.STOPPING_THE_OLD_VERSION" = "等待旧版完全停用，大约需要一分钟…";
+"Input method may not be fully enabled. Please enable it through System Preferences > Keyboard > Input Sources." = "输入法已经安装好，但可能没有完全启用。请从「系统偏好设定」 > 「键盘」 > 「输入方式」分页加入输入法。";
 "Install Failed" = "安装失败";
 "Installation Successful" = "安装成功";
 "OK" = "确定";
-"vChewing is ready to use. \n\nPlease relogin if this is the first time you install it in this user account." = "威注音输入法安装成功。\n\n若是在當前使用者帳戶內首次安裝的話，請重新登入。";
 "Stopping the old version. This may take up to one minute…" = "正在试图结束正在运行的旧版输入法，大概需要一分钟…";
-"Attention" = "请注意";
+"vChewing Input Method" = "威注音输入法";
+"vChewing is ready to use. \n\nPlease relogin if this is the first time you install it in this user account." = "威注音输入法安装成功。\n\n若是在當前使用者帳戶內首次安裝的話，請重新登入。";
 "vChewing is upgraded, but please log out or reboot for the new version to be fully functional." = "vChewing 安装完成，但建议您登出或重新开机，以便顺利使用新版。";
-"Fatal Error" = "安装错误";
-"Abort" = "放弃安装";
-"Cannot register input source %@ at %@." = "无法从档案位置 %2$@ 安装输入法 \"%1$@\"。";
-"Cannot find input source %@ after registration." = "在注册完输入法 \"%@\" 之后仍然无法找到该输入法。";
 "Warning" = "安装不完整";
-"Input method may not be fully enabled. Please enable it through System Preferences > Keyboard > Input Sources." = "输入法已经安装好，但可能没有完全启用。请从「系统偏好设定」 > 「键盘」 > 「输入方式」分页加入输入法。";
-"Continue" = "继续";
-"i18n:installer.DISCLAIMER_TEXT" = "免责声明：威注音专案对小麦注音官方专案内赠的小麦注音原版词库内容不负任何责任。威注音输入法专用的威注音官方词库不包含任何「会在法理上妨碍威注音在全球传播」的「与地缘政治及政治意识形态有关的」内容。威注音专案与 OpenVanilla 专案之间无合作关系、无隶属关系。";
-"i18n:installer.INSTALLER_APP_TITLE" = "威注音安装程式";
-"i18n:installer.INSTALLER_APP_TITLE_FULL" = "威注音输入法安装程式";
-"i18n:installer.ACCEPT_INSTALLATION" = "我接受";
-"i18n:installer.CANCEL_INSTALLATION" = "取消安装";
-"i18n:installer.LICENSE_TITLE" = "麻理去商标授权合约 (MIT-NTL License):";
-"i18n:installer.APP_NAME" = "vChewing for macOS";
-"i18n:installer.APP_DERIVED_FROM" = "该专案曾由 OpenVanilla 小麦注音专案 (MIT-License) 衍生而来。";
-"i18n:installer.DEV_CREW" = "威注音 macOS 程式研发：Shiki Suen, Isaac Xen, Hiraku Wang, 等。\n威注音词库维护：Shiki Suen。\n爬轨算法：Lukhnos Liu (Gramambular 2, MIT-License)。";
-"i18n:installer.EULA_PROMPT_NOTICE" = "若要安装该软件，请接受上述条款。";
-"i18n:installer.STOPPING_THE_OLD_VERSION" = "等待旧版完全停用，大约需要一分钟…";

Installer/Resources/zh-Hant.lproj/Localizable.strings

@@ -1,30 +1,30 @@
-"vChewing Input Method" = "威注音輸入法";
-"i18n:installer.DO_APP_UPGRADE" = "接受並升級";
+"Abort" = "放棄安裝";
+"Attention" = "請注意";
 "Cancel" = "取消";
 "Cannot activate the input method." = "無法啟用輸入法。";
 "Cannot copy the file to the destination." = "無法將輸入法拷貝至目的地。";
+"Cannot find input source %@ after registration." = "在註冊完輸入法 \"%@\" 之後仍然無法找到該輸入法。";
+"Cannot register input source %@ at %@." = "無法從檔案位置 %2$@ 安裝輸入法 \"%1$@\"。";
+"Continue" = "繼續";
+"Fatal Error" = "安裝錯誤";
+"i18n:installer.ACCEPT_INSTALLATION" = "我接受";
+"i18n:installer.APP_DERIVED_FROM" = "該專案曾由 OpenVanilla 小麥注音專案 (MIT-License) 衍生而來。";
+"i18n:installer.APP_NAME" = "vChewing for macOS";
+"i18n:installer.CANCEL_INSTALLATION" = "取消安裝";
+"i18n:installer.DEV_CREW" = "威注音 macOS 程式研發：Shiki Suen, Isaac Xen, Hiraku Wang, 等。\n威注音詞庫維護：Shiki Suen。\n爬軌算法：Lukhnos Liu (Gramambular 2, MIT-License)。";
+"i18n:installer.DISCLAIMER_TEXT" = "免責聲明：威注音專案對小麥注音官方專案內贈的小麥注音原版詞庫內容不負任何責任。威注音輸入法專用的威注音官方詞庫不包含任何「會在法理上妨礙威注音在全球傳播」的「與地緣政治及政治意識形態有關的」內容。威註音專案與 OpenVanilla 專案之間無合作關係、無隸屬關係。";
+"i18n:installer.DO_APP_UPGRADE" = "接受並升級";
+"i18n:installer.EULA_PROMPT_NOTICE" = "若要安裝該軟體，請接受上述條款。";
+"i18n:installer.INSTALLER_APP_TITLE_FULL" = "威注音輸入法安裝程式";
+"i18n:installer.INSTALLER_APP_TITLE" = "威注音安裝程式";
+"i18n:installer.LICENSE_TITLE" = "麻理去商標授權合約 (MIT-NTL License):";
+"i18n:installer.STOPPING_THE_OLD_VERSION" = "等待舊版完全停用，大約需要一分鐘…";
+"Input method may not be fully enabled. Please enable it through System Preferences > Keyboard > Input Sources." = "輸入法已經安裝好，但可能沒有完全啟用。請從「系統偏好設定」 > 「鍵盤」 > 「輸入方式」分頁加入輸入法。";
 "Install Failed" = "安裝失敗";
 "Installation Successful" = "安裝成功";
 "OK" = "確定";
-"vChewing is ready to use. \n\nPlease relogin if this is the first time you install it in this user account." = "威注音輸入法安裝成功。\n\n若是在當前使用者帳戶內首次安裝的話，請重新登入。";
 "Stopping the old version. This may take up to one minute…" = "正在試圖結束正在運行的舊版輸入法，大概需要一分鐘…";
-"Attention" = "請注意";
+"vChewing Input Method" = "威注音輸入法";
+"vChewing is ready to use. \n\nPlease relogin if this is the first time you install it in this user account." = "威注音輸入法安裝成功。\n\n若是在當前使用者帳戶內首次安裝的話，請重新登入。";
 "vChewing is upgraded, but please log out or reboot for the new version to be fully functional." = "vChewing 安裝完成，但建議您登出或重新開機，以便順利使用新版。";
-"Fatal Error" = "安裝錯誤";
-"Abort" = "放棄安裝";
-"Cannot register input source %@ at %@." = "無法從檔案位置 %2$@ 安裝輸入法 \"%1$@\"。";
-"Cannot find input source %@ after registration." = "在註冊完輸入法 \"%@\" 之後仍然無法找到該輸入法。";
 "Warning" = "安裝不完整";
-"Input method may not be fully enabled. Please enable it through System Preferences > Keyboard > Input Sources." = "輸入法已經安裝好，但可能沒有完全啟用。請從「系統偏好設定」 > 「鍵盤」 > 「輸入方式」分頁加入輸入法。";
-"Continue" = "繼續";
-"i18n:installer.DISCLAIMER_TEXT" = "免責聲明：威注音專案對小麥注音官方專案內贈的小麥注音原版詞庫內容不負任何責任。威注音輸入法專用的威注音官方詞庫不包含任何「會在法理上妨礙威注音在全球傳播」的「與地緣政治及政治意識形態有關的」內容。威註音專案與 OpenVanilla 專案之間無合作關係、無隸屬關係。";
-"i18n:installer.INSTALLER_APP_TITLE" = "威注音安裝程式";
-"i18n:installer.INSTALLER_APP_TITLE_FULL" = "威注音輸入法安裝程式";
-"i18n:installer.ACCEPT_INSTALLATION" = "我接受";
-"i18n:installer.CANCEL_INSTALLATION" = "取消安裝";
-"i18n:installer.LICENSE_TITLE" = "麻理去商標授權合約 (MIT-NTL License):";
-"i18n:installer.APP_NAME" = "vChewing for macOS";
-"i18n:installer.APP_DERIVED_FROM" = "該專案曾由 OpenVanilla 小麥注音專案 (MIT-License) 衍生而來。";
-"i18n:installer.DEV_CREW" = "威注音 macOS 程式研發：Shiki Suen, Isaac Xen, Hiraku Wang, 等。\n威注音詞庫維護：Shiki Suen。\n爬軌算法：Lukhnos Liu (Gramambular 2, MIT-License)。";
-"i18n:installer.EULA_PROMPT_NOTICE" = "若要安裝該軟體，請接受上述條款。";
-"i18n:installer.STOPPING_THE_OLD_VERSION" = "等待舊版完全停用，大約需要一分鐘…";

Installer/pkgPostInstall.sh

@@ -19,4 +19,4 @@ OS_Version=$(sw_vers -productVersion)
 ##### fi
 
 # Finally, register the input method:
-/Users/"${login_user}"/Library/Input\ Methods/"${TARGET}".app/Contents/MacOS/"${TARGET}" install --all || true
+/Users/"${login_user}"/Library/Input\ Methods/"${TARGET}".app/Contents/MacOS/"${TARGET}" install || true

LocalizableFileSorter.swift

@@ -0,0 +1,33 @@
+#!/usr/bin/env swift
+
+// Copyright (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 Foundation
+
+let strDataPath = "./"
+
+func handleFiles(_ handler: @escaping ((url: URL, fileName: String)) -> Void) {
+  let rawURLs = FileManager.default.enumerator(at: URL(fileURLWithPath: strDataPath), includingPropertiesForKeys: nil)?.compactMap { $0 as? URL }
+  rawURLs?.forEach { url in
+    guard let fileName = url.pathComponents.last, fileName.lowercased() == "localizable.strings" else { return }
+    handler((url, fileName))
+  }
+}
+
+handleFiles { url, fileName in
+  guard let rawStr = try? String(contentsOf: url, encoding: .utf8) else { return }
+  let locale = Locale(identifier: "zh@collation=stroke")
+  do {
+    try rawStr.components(separatedBy: .newlines).filter { !$0.isEmpty }.sorted {
+      $0.compare($1, locale: locale) == .orderedAscending
+    }.joined(separator: "\n").description.appending("\n").write(to: url, atomically: false, encoding: .utf8)
+  } catch {
+    print("!! Error writing to \(fileName)")
+  }
+}

Makefile

@@ -11,6 +11,24 @@ BUILD_SETTINGS += ARCHS="$(ARCHS)"
 BUILD_SETTINGS += ONLY_ACTIVE_ARCH=NO
 endif
 
+spmDebug:
+	swift build -c debug --package-path ./Packages/vChewing_MainAssembly/
+
+spmRelease:
+	swift build -c release --package-path ./Packages/vChewing_MainAssembly/
+
+spmLintFormat:
+	make lint --file=./Packages/Makefile || true
+	make format --file=./Packages/Makefile || true
+
+spmClean:
+	@for currentDir in $$(ls ./Packages/); do \
+		if [ -d $$a ]; then \
+			echo "processing folder $$currentDir"; \
+			swift package clean --package-path ./Packages/$$currentDir || true; \
+		fi; \
+	done;
+
 release: 
 	xcodebuild -project vChewing.xcodeproj -scheme vChewingInstaller -configuration Release $(BUILD_SETTINGS) build
 
@@ -42,6 +60,7 @@ install-release: permission-check
 .PHONY: clean
 
 clean:
+	make clean --file=./Packages/Makefile || true
 	xcodebuild -scheme vChewingInstaller -configuration Debug $(BUILD_SETTINGS)  clean
 	xcodebuild -scheme vChewingInstaller -configuration Release $(BUILD_SETTINGS) clean
 	make clean --file=./Source/Data/Makefile || true

Packages/.clang-format

@@ -0,0 +1 @@
+BasedOnStyle: Microsoft

Packages/.swiftformat.json

@@ -0,0 +1,104 @@
+# SwiftFormat config compliant with Google Swift Guideline
+# https://google.github.io/swift/#control-flow-statements
+
+# Specify version used in a project
+
+--swiftversion 5.5
+
+# Rules explicitly required by the guideline
+
+--rules                           \
+blankLinesAroundMark,             \
+blankLinesAtEndOfScope,           \
+blankLinesAtStartOfScope,         \
+blankLinesBetweenScopes,          \
+braces,                           \
+consecutiveBlankLines,            \
+consecutiveSpaces,                \
+duplicateImports,                 \
+elseOnSameLine,                   \
+emptyBraces,                      \
+enumNamespaces,                   \
+extensionAccessControl,           \
+hoistPatternLet,                  \
+indent,                           \
+leadingDelimiters,                \
+linebreakAtEndOfFile,             \
+markTypes,                        \
+organizeDeclarations,             \
+redundantInit,                    \
+redundantParens,                  \
+redundantPattern,                 \
+redundantRawValues,               \
+redundantType,                    \
+redundantVoidReturnType,          \
+semicolons,                       \
+sortedImports,                    \
+sortedSwitchCases,                \
+spaceAroundBraces,                \
+spaceAroundBrackets,              \
+spaceAroundComments,              \
+spaceAroundGenerics,              \
+spaceAroundOperators,             \
+spaceAroundParens,                \
+spaceInsideBraces,                \
+spaceInsideBrackets,              \
+spaceInsideComments,              \
+spaceInsideGenerics,              \
+spaceInsideParens,                \
+todos,                            \
+trailingClosures,                 \
+trailingCommas,                   \
+trailingSpace,                    \
+typeSugar,                        \
+void,                             \
+wrap,                             \
+wrapArguments,                    \
+wrapAttributes,                   \
+#
+#
+# Additional rules not mentioned in the guideline, but helping to keep the codebase clean 
+# Quoting the guideline: 
+# Common themes among the rules in this section are: 
+# avoid redundancy, avoid ambiguity, and prefer implicitness over explicitness
+# unless being explicit improves readability and/or reduces ambiguity.
+#
+#
+andOperator,                      \
+isEmpty,                          \
+redundantBackticks,               \
+redundantBreak,                   \
+redundantExtensionACL,            \
+redundantGet,                     \
+redundantLetError,                \
+redundantNilInit,                 \
+redundantObjc,                    \
+redundantReturn,                  \
+redundantSelf,                    \
+strongifiedSelf
+
+
+# Options for basic rules
+
+--extensionacl on-declarations
+--funcattributes prev-line
+--indent 2
+--maxwidth 100
+--typeattributes prev-line
+--varattributes prev-line
+--voidtype tuple
+--wraparguments before-first
+--wrapparameters before-first
+--wrapcollections before-first
+--wrapreturntype if-multiline
+--wrapconditions after-first 
+
+# Option for additional rules
+
+--self init-only
+
+# Excluded folders
+
+--exclude Pods,**/UNTESTED_TODO,vendor,fastlane
+
+# https://github.com/NoemiRozpara/Google-SwiftFormat-Config

Packages/Fuziki_NSAttributedTextView/Package.swift

@@ -13,13 +13,13 @@ let package = Package(
     ),
   ],
   dependencies: [
-    .package(path: "../vChewing_CocoaExtension"),
+    .package(path: "../vChewing_OSFrameworkImpl"),
   ],
   targets: [
     .target(
       name: "NSAttributedTextView",
       dependencies: [
-        .product(name: "CocoaExtension", package: "vChewing_CocoaExtension"),
+        .product(name: "OSFrameworkImpl", package: "vChewing_OSFrameworkImpl"),
       ]
     ),
     .testTarget(

Packages/Fuziki_NSAttributedTextView/Sources/NSAttributedTextView/NSAttributedTextView.swift

@@ -6,7 +6,7 @@
 // Modified by The vChewing Project in order to use it with AppKit.
 
 import AppKit
-import CocoaExtension
+import OSFrameworkImpl
 import SwiftUI
 
 @available(macOS 10.15, *)

Packages/Fuziki_NSAttributedTextView/Tests/NSAttributedTextViewTests/NSAttributedTextViewTests.swift

@@ -7,9 +7,9 @@
 // requirements defined in MIT License.
 
 import AppKit
-import CocoaExtension
 import Foundation
 @testable import NSAttributedTextView
+import OSFrameworkImpl
 import Shared
 import XCTest
 

Packages/Makefile

@@ -0,0 +1,29 @@
++.PHONY: all
+
+all: debug
+
+debug:
+	swift build -c debug --package-path ./vChewing_MainAssembly/
+
+release:
+	swift build -c release --package-path ./vChewing_MainAssembly/
+
+clean:
+	@for currentDir in $$(ls ./); do \
+		if [ -d $$a ]; then \
+			echo "processing folder $$currentDir"; \
+			swift package clean --package-path ./$$currentDir || true; \
+		fi; \
+	done;
+
+.PHONY: lint format
+
+lintFormat: lint format
+
+format:
+	@swiftformat --swiftversion 5.5 --indent 2 ./
+
+lint:
+	@git ls-files --exclude-standard | grep -E '\.swift$$' | swiftlint --fix --autocorrect
+
+.PHONY: permission-check install-debug install-release

Packages/Qwertyyb_ShiftKeyUpChecker/Sources/ShiftKeyUpChecker/ShiftKeyUpChecker.swift

@@ -37,7 +37,7 @@ public struct ShiftKeyUpChecker {
 
   /// 實現邏輯基本上是相同的，只是威注音這邊的行文風格習慣可能與業火五筆有不同。
 
-  private let delayInterval = 0.3
+  private let delayInterval = 0.2
   private var previousKeyCode: UInt16?
   private var lastTime: Date = .init()
 

Packages/RMJay_LineReader/Sources/LineReader/LineReader.swift

@@ -1,7 +1,6 @@
 // (c) 2019 and onwards Robert Muckle-Jones (Apache 2.0 License).
 
 import Foundation
-import SwiftExtension
 
 public class LineReader {
   let encoding: String.Encoding

Packages/vChewing_BrailleSputnik/.gitignore

@@ -1,9 +1,8 @@
 .DS_Store
 /.build
 /Packages
-/*.xcodeproj
 xcuserdata/
 DerivedData/
-.swiftpm/config/registries.json
+.swiftpm/configuration/registries.json
 .swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
 .netrc

Packages/vChewing_BrailleSputnik/Package.swift

@@ -0,0 +1,35 @@
+// swift-tools-version: 5.7
+import PackageDescription
+
+let package = Package(
+  name: "BrailleSputnik",
+  platforms: [
+    .macOS(.v11),
+  ],
+  products: [
+    // Products define the executables and libraries a package produces, making them visible to other packages.
+    .library(
+      name: "BrailleSputnik",
+      targets: ["BrailleSputnik"]
+    ),
+  ],
+  dependencies: [
+    .package(path: "../vChewing_Shared"),
+    .package(path: "../vChewing_Tekkon"),
+  ],
+  targets: [
+    // Targets are the basic building blocks of a package, defining a module or a test suite.
+    // Targets can depend on other targets in this package and products from dependencies.
+    .target(
+      name: "BrailleSputnik",
+      dependencies: [
+        .product(name: "Shared", package: "vChewing_Shared"),
+        .product(name: "Tekkon", package: "vChewing_Tekkon"),
+      ]
+    ),
+    .testTarget(
+      name: "BrailleSputnikTests",
+      dependencies: ["BrailleSputnik"]
+    ),
+  ]
+)

Packages/vChewing_BrailleSputnik/Sources/BrailleSputnik/BrailleEnums.swift

@@ -0,0 +1,284 @@
+// (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.
+
+extension BrailleSputnik {
+  enum Braille: String {
+    case blank = "⠀" // U+2800
+    case d1 = "⠁"
+    case d2 = "⠂"
+    case d12 = "⠃"
+    case d3 = "⠄"
+    case d13 = "⠅"
+    case d23 = "⠆"
+    case d123 = "⠇"
+    case d4 = "⠈"
+    case d14 = "⠉"
+    case d24 = "⠊"
+    case d124 = "⠋"
+    case d34 = "⠌"
+    case d134 = "⠍"
+    case d234 = "⠎"
+    case d1234 = "⠏"
+    case d5 = "⠐"
+    case d15 = "⠑"
+    case d25 = "⠒"
+    case d125 = "⠓"
+    case d35 = "⠔"
+    case d135 = "⠕"
+    case d235 = "⠖"
+    case d1235 = "⠗"
+    case d45 = "⠘"
+    case d145 = "⠙"
+    case d245 = "⠚"
+    case d1245 = "⠛"
+    case d345 = "⠜"
+    case d1345 = "⠝"
+    case d2345 = "⠞"
+    case d12345 = "⠟"
+    case d6 = "⠠"
+    case d16 = "⠡"
+    case d26 = "⠢"
+    case d126 = "⠣"
+    case d36 = "⠤"
+    case d136 = "⠥"
+    case d236 = "⠦"
+    case d1236 = "⠧"
+    case d46 = "⠨"
+    case d146 = "⠩"
+    case d246 = "⠪"
+    case d1246 = "⠫"
+    case d346 = "⠬"
+    case d1346 = "⠭"
+    case d2346 = "⠮"
+    case d12346 = "⠯"
+    case d56 = "⠰"
+    case d156 = "⠱"
+    case d256 = "⠲"
+    case d1256 = "⠳"
+    case d356 = "⠴"
+    case d1356 = "⠵"
+    case d2356 = "⠶"
+    case d12356 = "⠷"
+    case d456 = "⠸"
+    case d1456 = "⠹"
+    case d2456 = "⠺"
+    case d12456 = "⠻"
+    case d3456 = "⠼"
+    case d13456 = "⠽"
+    case d23456 = "⠾"
+    case d123456 = "⠿"
+  }
+
+  public enum BrailleStandard: Int {
+    case of1947 = 1
+    case of2018 = 2
+  }
+}
+
+protocol BrailleProcessingUnit {
+  var mapConsonants: [String: String] { get }
+  var mapSemivowels: [String: String] { get }
+  var mapVowels: [String: String] { get }
+  var mapIntonations: [String: String] { get }
+  var mapIntonationSpecialCases: [String: String] { get }
+  var mapCombinedVowels: [String: String] { get }
+  var mapPunctuations: [String: String] { get }
+
+  func handleSpecialCases(target: inout String, value: String?) -> Bool
+}
+
+// MARK: - Static Data conforming to 1947 Standard.
+
+extension BrailleSputnik {
+  class BrailleProcessingUnit1947: BrailleProcessingUnit {
+    func handleSpecialCases(target _: inout String, value _: String?) -> Bool {
+      // 國語點字標準無最終例外處理步驟。
+      false
+    }
+
+    let mapConsonants: [String: String] = [
+      "ㄎ": "⠇", "ㄋ": "⠝", "ㄕ": "⠊",
+      "ㄌ": "⠉", "ㄆ": "⠏", "ㄇ": "⠍",
+      "ㄓ": "⠁", "ㄏ": "⠗", "ㄖ": "⠛",
+      "ㄅ": "⠕", "ㄑ": "⠚", "ㄘ": "⠚",
+      "ㄗ": "⠓", "ㄙ": "⠑", "ㄐ": "⠅",
+      "ㄉ": "⠙", "ㄈ": "⠟", "ㄔ": "⠃",
+      "ㄒ": "⠑", "ㄊ": "⠋", "ㄍ": "⠅",
+    ]
+
+    let mapSemivowels: [String: String] = [
+      "ㄧ": "⠡", "ㄩ": "⠳", "ㄨ": "⠌",
+    ]
+
+    let mapVowels: [String: String] = [
+      "ㄤ": "⠭", "ㄛ": "⠣", "ㄠ": "⠩",
+      "ㄞ": "⠺", "ㄜ": "⠮", "ㄡ": "⠷",
+      "ㄟ": "⠴", "ㄣ": "⠥", "ㄥ": "⠵",
+      "ㄢ": "⠧", "ㄚ": "⠜", "ㄦ": "⠱",
+    ]
+
+    let mapIntonations: [String: String] = [
+      "˙": "⠱⠁", "ˇ": "⠈", "ˊ": "⠂", " ": "⠄", "ˋ": "⠐",
+    ]
+
+    let mapIntonationSpecialCases: [String: String] = [
+      "ㄜ˙": "⠮⠁", "ㄚ˙": "⠜⠁", "ㄛ˙": "⠣⠁", "ㄣ˙": "⠥⠁",
+    ]
+
+    let mapCombinedVowels: [String: String] = [
+      "ㄧㄝ": "⠬", "ㄧㄣ": "⠹", "ㄩㄝ": "⠦",
+      "ㄨㄟ": "⠫", "ㄨㄥ": "⠯", "ㄨㄣ": "⠿",
+      "ㄨㄚ": "⠔", "ㄧㄡ": "⠎", "ㄧㄤ": "⠨",
+      "ㄧㄚ": "⠾", "ㄨㄛ": "⠒", "ㄧㄥ": "⠽",
+      "ㄨㄞ": "⠶", "ㄩㄥ": "⠖", "ㄧㄠ": "⠪",
+      "ㄧㄞ": "⠢", "ㄨㄤ": "⠸", "ㄩㄣ": "⠲",
+      "ㄧㄢ": "⠞", "ㄩㄢ": "⠘", "ㄨㄢ": "⠻",
+    ]
+
+    let mapPunctuations: [String: String] = [
+      "。": "⠤⠀", "·": "⠤⠀", "，": "⠆", "；": "⠰",
+      "、": "⠠", "？": "⠕⠀", "！": "⠇⠀", "：": "⠒⠒",
+      "╴╴": "⠰⠰", "﹏﹏": "⠠⠤", "……": "⠐⠐⠐",
+      "—": "⠐⠂", "——　——": "⠐⠂⠐⠂", "※": "⠈⠼", "◎": "⠪⠕",
+      "『": "⠦⠦", "』": "⠴⠴", "「": "⠰⠤", "」": "⠤⠆",
+      "‘": "⠦⠦", "’": "⠴⠴", "“": "⠰⠤", "”": "⠤⠆",
+      "（": "⠪", "）": "⠕", "〔": "⠯", "〕": "⠽",
+      "｛": "⠦", "｝": "⠴", "［": "⠯", "］": "⠽",
+    ]
+  }
+}
+
+// MARK: - Static Data conforming to 2018 Standard (GF0019-2018)
+
+extension BrailleSputnik {
+  class BrailleProcessingUnit2018: BrailleProcessingUnit {
+    func handleSpecialCases(target: inout String, value: String?) -> Bool {
+      guard let value = value else { return false }
+      switch value {
+      case "他": target = Braille.d2345.rawValue + Braille.d35.rawValue
+      case "它": target = Braille.d4.rawValue + Braille.d2345.rawValue + Braille.d35.rawValue
+      default: return false
+      }
+      return true
+    }
+
+    let mapConsonants: [String: String] = [
+      "ㄅ": Braille.d12.rawValue,
+      "ㄆ": Braille.d1234.rawValue,
+      "ㄇ": Braille.d134.rawValue,
+      "ㄈ": Braille.d124.rawValue,
+      "ㄉ": Braille.d145.rawValue,
+      "ㄊ": Braille.d2345.rawValue,
+      "ㄋ": Braille.d1345.rawValue,
+      "ㄌ": Braille.d123.rawValue,
+      "ㄍ": Braille.d1245.rawValue,
+      "ㄎ": Braille.d13.rawValue,
+      "ㄏ": Braille.d125.rawValue,
+      "ㄐ": Braille.d1245.rawValue,
+      "ㄑ": Braille.d13.rawValue,
+      "ㄒ": Braille.d125.rawValue,
+      "ㄓ": Braille.d34.rawValue,
+      "ㄔ": Braille.d12345.rawValue,
+      "ㄕ": Braille.d156.rawValue,
+      "ㄖ": Braille.d245.rawValue,
+      "ㄗ": Braille.d1356.rawValue,
+      "ㄘ": Braille.d14.rawValue,
+      "ㄙ": Braille.d234.rawValue,
+    ]
+
+    let mapSemivowels: [String: String] = [
+      "ㄧ": Braille.d24.rawValue,
+      "ㄨ": Braille.d136.rawValue,
+      "ㄩ": Braille.d346.rawValue,
+    ]
+
+    let mapVowels: [String: String] = [
+      "ㄚ": Braille.d35.rawValue,
+      "ㄛ": Braille.d26.rawValue,
+      "ㄜ": Braille.d26.rawValue,
+      "ㄞ": Braille.d246.rawValue,
+      "ㄟ": Braille.d2346.rawValue,
+      "ㄠ": Braille.d235.rawValue,
+      "ㄡ": Braille.d12356.rawValue,
+      "ㄢ": Braille.d1236.rawValue,
+      "ㄣ": Braille.d356.rawValue,
+      "ㄤ": Braille.d236.rawValue,
+      "ㄥ": Braille.d3456.rawValue, // 該注音符號也有合併處理規則。
+      "ㄦ": Braille.d1235.rawValue,
+    ]
+
+    let mapIntonations: [String: String] = [
+      " ": Braille.d1.rawValue,
+      "ˊ": Braille.d2.rawValue,
+      "ˇ": Braille.d3.rawValue,
+      "ˋ": Braille.d23.rawValue,
+      // "˙": nil, // 輕聲不設符號。
+    ]
+
+    let mapIntonationSpecialCases: [String: String] = [:]
+
+    let mapCombinedVowels: [String: String] = [
+      "ㄧㄚ": Braille.d1246.rawValue,
+      "ㄧㄝ": Braille.d15.rawValue,
+      "ㄧㄞ": Braille.d1246.rawValue, // 此乃特例「崖」，依陸規審音處理。
+      "ㄧㄠ": Braille.d345.rawValue,
+      "ㄧㄡ": Braille.d1256.rawValue,
+      "ㄧㄢ": Braille.d146.rawValue,
+      "ㄧㄣ": Braille.d126.rawValue,
+      "ㄧㄤ": Braille.d1346.rawValue,
+      "ㄧㄥ": Braille.d16.rawValue,
+      "ㄨㄚ": Braille.d123456.rawValue,
+      "ㄨㄛ": Braille.d135.rawValue,
+      "ㄨㄞ": Braille.d13456.rawValue,
+      "ㄨㄟ": Braille.d2456.rawValue,
+      "ㄨㄢ": Braille.d12456.rawValue,
+      "ㄨㄣ": Braille.d25.rawValue,
+      "ㄨㄤ": Braille.d2356.rawValue,
+      "ㄨㄥ": Braille.d256.rawValue,
+      "ㄩㄝ": Braille.d23456.rawValue,
+      "ㄩㄢ": Braille.d12346.rawValue,
+      "ㄩㄣ": Braille.d456.rawValue,
+      "ㄩㄥ": Braille.d1456.rawValue,
+    ]
+
+    let mapPunctuations: [String: String] = [
+      "。": Braille.d5.rawValue + Braille.d23.rawValue,
+      "·": Braille.d6.rawValue + Braille.d3.rawValue,
+      "，": Braille.d5.rawValue,
+      "；": Braille.d56.rawValue,
+      "、": Braille.d4.rawValue,
+      "？": Braille.d5.rawValue + Braille.d3.rawValue,
+      "！": Braille.d56.rawValue + Braille.d2.rawValue,
+      "：": Braille.d36.rawValue,
+      "——": Braille.d6.rawValue + Braille.d36.rawValue,
+      "……": Braille.d5.rawValue + Braille.d5.rawValue + Braille.d5.rawValue,
+      "-": Braille.d36.rawValue,
+      "‧": Braille.d5.rawValue, // 著重號。
+      "＊": Braille.d2356.rawValue + Braille.d35.rawValue,
+      "《": Braille.d5.rawValue + Braille.d36.rawValue,
+      "》": Braille.d36.rawValue + Braille.d2.rawValue,
+      "〈": Braille.d5.rawValue + Braille.d3.rawValue,
+      "〉": Braille.d6.rawValue + Braille.d2.rawValue,
+      "『": Braille.d45.rawValue + Braille.d45.rawValue,
+      "』": Braille.d45.rawValue + Braille.d45.rawValue,
+      "「": Braille.d45.rawValue,
+      "」": Braille.d45.rawValue,
+      "‘": Braille.d45.rawValue + Braille.d45.rawValue,
+      "’": Braille.d45.rawValue + Braille.d45.rawValue,
+      "“": Braille.d45.rawValue,
+      "”": Braille.d45.rawValue,
+      "（": Braille.d56.rawValue + Braille.d3.rawValue,
+      "）": Braille.d6.rawValue + Braille.d23.rawValue,
+      "〔": Braille.d56.rawValue + Braille.d23.rawValue,
+      "〕": Braille.d56.rawValue + Braille.d23.rawValue,
+      "［": Braille.d56.rawValue + Braille.d23.rawValue,
+      "］": Braille.d56.rawValue + Braille.d23.rawValue,
+      // "｛": "⠦", "｝": "⠴", // 2018 國通標準並未定義花括弧。
+    ]
+  }
+}

Packages/vChewing_BrailleSputnik/Sources/BrailleSputnik/BrailleSputnik.swift

@@ -0,0 +1,109 @@
+// (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 Tekkon
+
+public class BrailleSputnik {
+  public var standard: BrailleStandard
+  public init(standard: BrailleStandard) {
+    self.standard = standard
+  }
+
+  var staticData: BrailleProcessingUnit {
+    switch standard {
+    case .of1947: return Self.staticData1947
+    case .of2018: return Self.staticData2018
+    }
+  }
+
+  static var sharedComposer = Tekkon.Composer("", arrange: .ofDachen, correction: true)
+  private static let staticData1947: BrailleProcessingUnit = BrailleProcessingUnit1947()
+  private static let staticData2018: BrailleProcessingUnit = BrailleProcessingUnit2018()
+}
+
+public extension BrailleSputnik {
+  func convertToBraille(smashedPairs: [(key: String, value: String)], extraInsertion: (reading: String, cursor: Int)? = nil) -> String {
+    var convertedStack: [String?] = []
+    var processedKeysCount = 0
+    var extraInsertion = extraInsertion
+    smashedPairs.forEach { key, value in
+      let subKeys = key.split(separator: "\t")
+      switch subKeys.count {
+      case 0: return
+      case 1:
+        guard !key.isEmpty else { break }
+        let isPunctuation: Bool = key.first == "_" // 檢查是不是標點符號。
+        if isPunctuation {
+          convertedStack.append(convertPunctuationToBraille(value))
+        } else {
+          var key = key.description
+          fixToneOne(target: &key)
+          convertedStack.append(convertPhonabetReadingToBraille(key, value: value))
+        }
+        processedKeysCount += 1
+      default:
+        // 這種情形就是詞音配對不一致的典型情形，此時僅處理注音讀音。
+        subKeys.forEach { subKey in
+          var subKey = subKey.description
+          fixToneOne(target: &subKey)
+          convertedStack.append(convertPhonabetReadingToBraille(subKey))
+          processedKeysCount += 1
+        }
+      }
+      if let theExtraInsertion = extraInsertion, processedKeysCount == theExtraInsertion.cursor {
+        convertedStack.append(convertPhonabetReadingToBraille(theExtraInsertion.reading))
+        extraInsertion = nil
+      }
+    }
+    return convertedStack.compactMap(\.?.description).joined()
+  }
+
+  private func fixToneOne(target key: inout String) {
+    for char in key {
+      guard Tekkon.Phonabet(char.description).type != .null else { return }
+    }
+    if let lastChar = key.last?.description, Tekkon.Phonabet(lastChar).type != .intonation {
+      key += " "
+    }
+  }
+
+  func convertPunctuationToBraille(_ givenTarget: any StringProtocol) -> String? {
+    staticData.mapPunctuations[givenTarget.description]
+  }
+
+  func convertPhonabetReadingToBraille(_ rawReading: any StringProtocol, value referredValue: String? = nil) -> String? {
+    var resultStack = ""
+    // 检查特殊情形。
+    guard !staticData.handleSpecialCases(target: &resultStack, value: referredValue) else { return resultStack }
+    Self.sharedComposer.clear()
+    rawReading.forEach { char in
+      Self.sharedComposer.receiveKey(fromPhonabet: char.description)
+    }
+    let consonant = Self.sharedComposer.consonant.value
+    let semivowel = Self.sharedComposer.semivowel.value
+    let vowel = Self.sharedComposer.vowel.value
+    let intonation = Self.sharedComposer.intonation.value
+    if !consonant.isEmpty {
+      resultStack.append(staticData.mapConsonants[consonant] ?? "")
+    }
+    let combinedVowels = Self.sharedComposer.semivowel.value + Self.sharedComposer.vowel.value
+    if combinedVowels.count == 2 {
+      resultStack.append(staticData.mapCombinedVowels[combinedVowels] ?? "")
+    } else {
+      resultStack.append(staticData.mapSemivowels[semivowel] ?? "")
+      resultStack.append(staticData.mapVowels[vowel] ?? "")
+    }
+    // 聲調處理。
+    if let intonationSpecialCaseMetResult = staticData.mapIntonationSpecialCases[vowel + intonation] {
+      resultStack.append(intonationSpecialCaseMetResult.last?.description ?? "")
+    } else {
+      resultStack.append(staticData.mapIntonations[intonation] ?? "")
+    }
+    return resultStack
+  }
+}

Packages/vChewing_BrailleSputnik/Tests/BrailleSputnikTests/BrailleSputnikTests.swift

@@ -0,0 +1,28 @@
+// (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.
+
+@testable import BrailleSputnik
+import XCTest
+
+final class BrailleSputnikTests: XCTestCase {
+  func testBrailleConversion() throws {
+    // 大丘丘病了二丘丘瞧，三丘丘採藥四丘丘熬。
+    var rawReadingStr = "ㄉㄚˋ-ㄑㄧㄡ-ㄑㄧㄡ-ㄅㄧㄥˋ-ㄌㄜ˙-ㄦˋ-ㄑㄧㄡ-ㄑㄧㄡ-ㄑㄧㄠˊ-_，"
+    rawReadingStr += "-ㄙㄢ-ㄑㄧㄡ-ㄑㄧㄡ-ㄘㄞˇ-ㄧㄠˋ-ㄙˋ-ㄑㄧㄡ-ㄑㄧㄡ-ㄠˊ-_。"
+    let rawReadingArray: [(key: String, value: String)] = rawReadingStr.split(separator: "-").map {
+      let value: String = $0.first == "_" ? $0.last?.description ?? "" : ""
+      return (key: $0.description, value: value)
+    }
+    let processor = BrailleSputnik(standard: .of1947)
+    let result1947 = processor.convertToBraille(smashedPairs: rawReadingArray)
+    XCTAssertEqual(result1947, "⠙⠜⠐⠚⠎⠄⠚⠎⠄⠕⠽⠐⠉⠮⠁⠱⠐⠚⠎⠄⠚⠎⠄⠚⠪⠂⠆⠑⠧⠄⠚⠎⠄⠚⠎⠄⠚⠺⠈⠪⠐⠑⠐⠚⠎⠄⠚⠎⠄⠩⠂⠤⠀")
+    processor.standard = .of2018
+    let result2018 = processor.convertToBraille(smashedPairs: rawReadingArray)
+    XCTAssertEqual(result2018, "⠙⠔⠆⠅⠳⠁⠅⠳⠁⠃⠡⠆⠇⠢⠗⠆⠅⠳⠁⠅⠳⠁⠅⠜⠂⠐⠎⠧⠁⠅⠳⠁⠅⠳⠁⠉⠪⠄⠜⠆⠎⠆⠅⠳⠁⠅⠳⠁⠖⠂⠐⠆")
+  }
+}

Packages/vChewing_CandidateWindow/Sources/CandidateWindow/CandidateCellData_Core.swift

@@ -19,6 +19,7 @@ public class CandidateCellData: Hashable {
   public static var unifiedSize: Double = 16
   public static var unifiedCharDimension: Double { ceil(unifiedSize * 1.0125 + 7) }
   public static var unifiedTextHeight: Double { ceil(unifiedSize * 19 / 16) }
+  static var internalPrefs = PrefMgr()
   public var selectionKey: String
   public let displayedText: String
   public private(set) var textDimension: NSSize
@@ -81,7 +82,8 @@ public class CandidateCellData: Hashable {
   }
 
   public func cellLength(isMatrix: Bool = true) -> Double {
-    let minLength = ceil(Self.unifiedCharDimension * 2 + size * 1.25)
+    let factor: CGFloat = (Self.internalPrefs.minCellWidthForHorizontalMatrix == 0) ? 1.5 : 2
+    let minLength = ceil(Self.unifiedCharDimension * factor + size * 1.25)
     if displayedText.count <= 2, isMatrix { return minLength }
     return textDimension.width
   }
@@ -200,14 +202,14 @@ public class CandidateCellData: Hashable {
     return attrStrCandidate
   }
 
-  public var charDescriptions: [String] {
+  public func charDescriptions(shortened: Bool = false) -> [String] {
     var result = displayedText
     if displayedText.contains("("), displayedText.count > 2 {
       result = displayedText.replacingOccurrences(of: "(", with: "").replacingOccurrences(of: ")", with: "")
     }
     return result.flatMap(\.unicodeScalars).compactMap {
       let theName: String = $0.properties.name ?? ""
-      return String(format: "U+%02X %@", $0.value, theName)
+      return shortened ? String(format: "U+%02X", $0.value) : String(format: "U+%02X %@", $0.value, theName)
     }
   }
 

Packages/vChewing_CandidateWindow/Sources/CandidateWindow/CandidatePool_CocoaImpl.swift

@@ -301,10 +301,12 @@ extension CandidatePool {
       .font: Self.blankCell.phraseFont(size: reverseLookupTextSize),
     ]
     let result = NSMutableAttributedString(string: "", attributes: attrReverseLookupSpacer)
+    var addedCounter = 0
     for neta in reverseLookupResult {
       result.append(NSAttributedString(string: " ", attributes: attrReverseLookupSpacer))
       result.append(NSAttributedString(string: " \(neta) ", attributes: attrReverseLookup))
-      if maxLinesPerPage == 1 { break }
+      addedCounter += 1
+      if maxLinesPerPage == 1, addedCounter == 2 { break }
     }
     return result
   }

Packages/vChewing_CandidateWindow/Sources/CandidateWindow/CtlCandidate.swift

@@ -17,26 +17,24 @@ open class CtlCandidate: NSWindowController, CtlCandidateProtocol {
   open var reverseLookupResult: [String] = []
 
   open func highlightedColor() -> NSColor {
-    var result = NSColor.controlAccentColor
-    var colorBlendAmount: Double = NSApplication.isDarkMode ? 0.3 : 0.0
-    if #available(macOS 10.14, *), !NSApplication.isDarkMode, locale == "zh-Hant" {
-      colorBlendAmount = 0.15
+    var result = NSColor.clear
+    if #available(macOS 10.14, *) {
+      result = .controlAccentColor
+    } else {
+      result = .alternateSelectedControlTextColor
     }
+    let colorBlendAmount = 0.3
     // 設定當前高亮候選字的背景顏色。
     switch locale {
     case "zh-Hans":
-      result = NSColor.systemRed
+      result = NSColor.red
     case "zh-Hant":
-      result = NSColor.systemBlue
+      result = NSColor.blue
     case "ja":
-      result = NSColor.systemBrown
+      result = NSColor.brown
     default: break
     }
-    var blendingAgainstTarget: NSColor = NSApplication.isDarkMode ? NSColor.black : NSColor.white
-    if #unavailable(macOS 10.14) {
-      colorBlendAmount = 0.3
-      blendingAgainstTarget = NSColor.white
-    }
+    let blendingAgainstTarget: NSColor = NSApplication.isDarkMode ? NSColor.black : NSColor.white
     return result.blended(withFraction: colorBlendAmount, of: blendingAgainstTarget)!
   }
 

Packages/vChewing_CandidateWindow/Sources/CandidateWindow/TDKCandidates/CtlCandidateTDK.swift

@@ -7,7 +7,7 @@
 // requirements defined in MIT License.
 
 import AppKit
-import CocoaExtension
+import OSFrameworkImpl
 import Shared
 
 private extension NSUserInterfaceLayoutOrientation {
@@ -108,16 +108,34 @@ public class CtlCandidateTDK: CtlCandidate, NSWindowDelegate {
 
   override open func updateDisplay() {
     guard let window = window else { return }
-    if let currentCandidateText = Self.thePool.currentSelectedCandidateText {
-      reverseLookupResult = delegate?.reverseLookup(for: currentCandidateText) ?? []
-      Self.thePool.reverseLookupResult = reverseLookupResult
-      Self.thePool.tooltip = delegate?.candidateToolTip(shortened: !Self.thePool.isMatrix) ?? ""
-    }
-    delegate?.candidatePairHighlightChanged(at: highlightedIndex)
     DispatchQueue.main.async { [weak self] in
       guard let self = self else { return }
       self.updateNSWindowModern(window)
     }
+    // 先擦除之前的反查结果。
+    reverseLookupResult = []
+    // 再更新新的反查结果。
+    if let currentCandidate = Self.thePool.currentCandidate {
+      let displayedText = currentCandidate.displayedText
+      var lookupResult: [String?] = delegate?.reverseLookup(for: displayedText) ?? []
+      if displayedText.count == 1, delegate?.showCodePointForCurrentCandidate ?? false {
+        if lookupResult.isEmpty {
+          lookupResult.append(currentCandidate.charDescriptions(shortened: !Self.thePool.isMatrix).first)
+        } else {
+          lookupResult.insert(currentCandidate.charDescriptions(shortened: true).first, at: lookupResult.startIndex)
+        }
+        reverseLookupResult = lookupResult.compactMap { $0 }
+      } else {
+        reverseLookupResult = lookupResult.compactMap { $0 }
+        // 如果不提供 UNICODE 碼位資料顯示的話，則在非多行多列模式下僅顯示一筆反查資料。
+        if !Self.thePool.isMatrix {
+          reverseLookupResult = [reverseLookupResult.first].compactMap { $0 }
+        }
+      }
+    }
+    Self.thePool.reverseLookupResult = reverseLookupResult
+    Self.thePool.tooltip = delegate?.candidateToolTip(shortened: !Self.thePool.isMatrix) ?? ""
+    delegate?.candidatePairHighlightChanged(at: highlightedIndex)
   }
 
   func updateNSWindowModern(_ window: NSWindow) {

Packages/vChewing_CandidateWindow/Sources/CandidateWindow/TDKCandidates/VwrCandidateTDK_Appkit.swift

@@ -7,6 +7,7 @@
 // requirements defined in MIT License.
 
 import AppKit
+import OSFrameworkImpl
 import Shared
 
 /// 田所選字窗的 AppKit 简单版本，繪製效率不受 SwiftUI 的限制。
@@ -151,30 +152,17 @@ public extension VwrCandidateTDKAppKit {
 private extension VwrCandidateTDKAppKit {
   private func prepareMenu() {
     let newMenu = NSMenu()
-    let boostMenuItem = NSMenuItem(
-      title: "↑ \(clickedCell.displayedText)",
-      action: #selector(menuActionOfBoosting(_:)),
-      keyEquivalent: ""
-    )
-    boostMenuItem.target = self
-    newMenu.addItem(boostMenuItem)
-
-    let nerfMenuItem = NSMenuItem(
-      title: "↓ \(clickedCell.displayedText)",
-      action: #selector(menuActionOfNerfing(_:)),
-      keyEquivalent: ""
-    )
-    nerfMenuItem.target = self
-    newMenu.addItem(nerfMenuItem)
-
-    if thePool.isFilterable(target: clickedCell.index) {
-      let filterMenuItem = NSMenuItem(
-        title: "✖︎ \(clickedCell.displayedText)",
-        action: #selector(menuActionOfFiltering(_:)),
-        keyEquivalent: ""
-      )
-      filterMenuItem.target = self
-      newMenu.addItem(filterMenuItem)
+    newMenu.appendItems(self) {
+      NSMenu.Item(
+        verbatim: "↑ \(clickedCell.displayedText)"
+      )?.act(#selector(menuActionOfBoosting(_:)))
+      NSMenu.Item(
+        verbatim: "↓ \(clickedCell.displayedText)"
+      )?.act(#selector(menuActionOfNerfing(_:)))
+      NSMenu.Item(
+        verbatim: "✖︎ \(clickedCell.displayedText)"
+      )?.act(#selector(menuActionOfFiltering(_:)))
+        .nulled(!thePool.isFilterable(target: clickedCell.index))
     }
 
     theMenu = newMenu

Packages/vChewing_CocoaExtension/Sources/CocoaExtension/SecureEventInputSputnik.swift

@@ -1,77 +0,0 @@
-// (c) 2023 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.
-
-/// A Swift script to check whether a non-system process is abusing the SecureEventInput.
-
-import AppKit
-import IOKit
-import Quartz
-
-public enum SecureEventInputSputnik {
-  public static func getIORegListResults() -> String? {
-    var resultDictionaryCF: Unmanaged<CFMutableDictionary>?
-    /// Regarding the parameter in IORegistryGetRootEntry:
-    /// Both kIOMasterPortDefault and kIOMainPortDefault are 0.
-    /// The latter one is similar to what `git` had done: changing "Master" to "Main".
-    let statusSucceeded = IORegistryEntryCreateCFProperties(
-      IORegistryGetRootEntry(0), &resultDictionaryCF, kCFAllocatorDefault, IOOptionBits(0)
-    )
-    guard statusSucceeded == KERN_SUCCESS else { return nil }
-    let dict = resultDictionaryCF?.takeRetainedValue()
-    guard let dict: [CFString: Any] = dict as? [CFString: Any] else { return nil }
-    return (dict.description)
-  }
-
-  /// Find all non-system processes using the SecureEventInput.
-  /// - Parameter abusersOnly: List only non-frontmost processes.
-  /// - **Reason to Use**: Non-frontmost processes of such are considered abusers of SecureEventInput,
-  /// hindering 3rd-party input methods from being switched to by the user.
-  /// They are also hindering users from accessing the menu of all 3rd-party input methods.
-  /// There are Apple's internal business reasons why macOS always has lack of certain crucial input methods,
-  /// plus that some some IMEs in macOS have certain bugs / defects for decades and are unlikely to be solved,
-  /// making the sense that why there are needs of 3rd-party input methods.
-  /// - **How to Use**: For example, one can use an NSTimer to run this function
-  /// with `abusersOnly: true` every 15~60 seconds. Once the result dictionary is not empty,
-  /// you may either warn the users to restart the matched process or directly terminate it.
-  /// Note that you cannot terminate a process if your app is Sandboxed.
-  /// - Returns: Matched results as a dictionary in `[Int32: NSRunningApplication]` format. The keys are PIDs.
-  /// - Remark: The`"com.apple.SecurityAgent"` won't be included in the result since it is a system process.
-  /// Also, "com.apple.loginwindow" should be excluded as long as the system screen saver engine is running.
-  public static func getRunningSecureInputApps(abusersOnly: Bool = false) -> [Int32: NSRunningApplication] {
-    var result = [Int32: NSRunningApplication]()
-    guard let rawData = getIORegListResults() else { return result }
-    rawData.enumerateLines { currentLine, _ in
-      guard currentLine.contains("kCGSSessionSecureInputPID") else { return }
-      guard let filteredNumStr = Int32(currentLine.filter("0123456789".contains)) else { return }
-      guard let matchedApp = NSRunningApplication(processIdentifier: filteredNumStr) else { return }
-      guard matchedApp.bundleIdentifier != "com.apple.SecurityAgent" else { return }
-      guard !(matchedApp.isLoginWindowWithLockedScreenOrScreenSaver) else { return }
-      if abusersOnly {
-        guard !matchedApp.isActive else { return }
-      }
-      result[filteredNumStr] = matchedApp
-    }
-    return result
-  }
-}
-
-extension NSRunningApplication {
-  public var isLoginWindowWithLockedScreenOrScreenSaver: Bool {
-    guard bundleIdentifier == "com.apple.loginwindow" else { return false }
-    return Self.isScreenSaverEngineRunning || Self.isDesktopLocked
-  }
-
-  private static var isScreenSaverEngineRunning: Bool {
-    !NSRunningApplication.runningApplications(withBundleIdentifier: "com.apple.ScreenSaver.Engine").isEmpty
-  }
-
-  private static var isDesktopLocked: Bool {
-    guard let x = CGSessionCopyCurrentDictionary() as? [String: Any] else { return false }
-    return x.keys.contains("CGSSessionScreenIsLocked")
-  }
-}

Packages/vChewing_Hotenka/Sources/Hotenka/HotenkaChineseConverter.swift

@@ -80,6 +80,7 @@ public class HotenkaChineseConverter {
       ptrSQL = nil
       return
     }
+    sqlite3_exec(ptrSQL, "PRAGMA journal_mode = OFF;", nil, nil, nil)
   }
 
   public init(plistDir: String) {
@@ -99,9 +100,7 @@ public class HotenkaChineseConverter {
     dictFiles = .init()
     do {
       let rawData = try Data(contentsOf: URL(fileURLWithPath: jsonDir))
-      guard let rawJSON: [String: [String: String]] = try JSONSerialization.jsonObject(with: rawData) as? [String: [String: String]] else {
-        throw NSError()
-      }
+      let rawJSON = try JSONDecoder().decode([String: [String: String]].self, from: rawData)
       dict = rawJSON
     } catch {
       NSLog("// Exception happened when reading dict json at: \(jsonDir).")

Packages/vChewing_Hotenka/Tests/HotenkaTests/HotenkaTests_JSON.swift

@@ -40,7 +40,10 @@ extension HotenkaTests {
     let testInstance: HotenkaChineseConverter = .init(dictDir: testDataPath)
     NSLog("// Loading complete. Generating json dict file.")
     do {
-      try JSONSerialization.data(withJSONObject: testInstance.dict, options: .sortedKeys).write(to: URL(fileURLWithPath: testDataPath + "convdict.json"))
+      let urlOutput = URL(fileURLWithPath: testDataPath + "convdict.json")
+      let encoder = JSONEncoder()
+      encoder.outputFormatting = .sortedKeys
+      try encoder.encode(testInstance.dict).write(to: urlOutput, options: .atomic)
     } catch {
       NSLog("// Error on writing strings to file: \(error)")
     }

Packages/vChewing_Hotenka/Tests/HotenkaTests/HotenkaTests_SQLite.swift

@@ -51,6 +51,10 @@ extension HotenkaTests {
       sqlite3_exec(ptrSQL, "PRAGMA synchronous = OFF;", nil, nil, nil) == SQLITE_OK,
       "HOTENKA: SQLite synchronous OFF failed."
     )
+    XCTAssertTrue(
+      sqlite3_exec(ptrSQL, "PRAGMA journal_mode = OFF;", nil, nil, nil) == SQLITE_OK,
+      "HOTENKA: SQLite journal_mode OFF failed."
+    )
 
     let sqlMakeTableHotenka = """
     DROP TABLE IF EXISTS DATA_HOTENKA;

Packages/vChewing_IMKUtils/Sources/IMKUtils/IMKHelper.swift

@@ -15,23 +15,13 @@ public enum IMKHelper {
   /// 威注音有專門統計過，實際上會有差異的英數鍵盤佈局只有這幾種。
   /// 精簡成這種清單的話，不但節省 SwiftUI 的繪製壓力，也方便使用者做選擇。
   public static let arrWhitelistedKeyLayoutsASCII: [String] = {
-    var result = [
-      "com.apple.keylayout.ABC",
-      "com.apple.keylayout.ABC-AZERTY",
-      "com.apple.keylayout.ABC-QWERTZ",
-      "com.apple.keylayout.British",
-      "com.apple.keylayout.Colemak",
-      "com.apple.keylayout.Dvorak",
-      "com.apple.keylayout.Dvorak-Left",
-      "com.apple.keylayout.DVORAK-QWERTYCMD",
-      "com.apple.keylayout.Dvorak-Right",
-    ]
-    if #unavailable(macOS 10.13) {
-      result.append("com.apple.keylayout.US")
-      result.append("com.apple.keylayout.German")
-      result.append("com.apple.keylayout.French")
+    var results = LatinKeyboardMappings.allCases
+    if #available(macOS 10.13, *) {
+      results = results.filter {
+        ![.qwertyUS, .qwertzGerman, .azertyFrench].contains($0)
+      }
     }
-    return result
+    return results.map(\.rawValue)
   }()
 
   public static let arrDynamicBasicKeyLayouts: [String] = [
@@ -49,31 +39,29 @@ public enum IMKHelper {
     "org.unknown.keylayout.vChewingMiTAC",
   ]
 
-  public static var allowedAlphanumericalTISInputSources: [TISInputSource] {
-    arrWhitelistedKeyLayoutsASCII.compactMap { TISInputSource.generate(from: $0) }
+  public static var allowedAlphanumericalTISInputSources: [TISInputSource.KeyboardLayout] {
+    let allTISKeyboardLayouts = TISInputSource.getAllTISInputKeyboardLayoutMap()
+    return arrWhitelistedKeyLayoutsASCII.compactMap { allTISKeyboardLayouts[$0] }
   }
 
-  public static var allowedBasicLayoutsAsTISInputSources: [TISInputSource?] {
-    // 為了保證清單順序，先弄兩個容器。
-    var containerA: [TISInputSource?] = []
-    var containerB: [TISInputSource?] = []
-    var containerC: [TISInputSource?] = []
+  public static var allowedBasicLayoutsAsTISInputSources: [TISInputSource.KeyboardLayout?] {
+    let allTISKeyboardLayouts = TISInputSource.getAllTISInputKeyboardLayoutMap()
+    // 為了保證清單順序，先弄幾個容器。
+    var containerA: [TISInputSource.KeyboardLayout?] = []
+    var containerB: [TISInputSource.KeyboardLayout?] = []
+    var containerC: [TISInputSource.KeyboardLayout] = []
 
-    let rawDictionary = TISInputSource.rawTISInputSources(onlyASCII: false)
-
-    Self.arrWhitelistedKeyLayoutsASCII.forEach {
-      if let neta = rawDictionary[$0], !arrDynamicBasicKeyLayouts.contains(neta.identifier) {
-        containerC.append(neta)
-      }
+    let filterSet = Array(Set(arrWhitelistedKeyLayoutsASCII).subtracting(Set(arrDynamicBasicKeyLayouts)))
+    let matchedGroupBasic = (arrWhitelistedKeyLayoutsASCII + arrDynamicBasicKeyLayouts).compactMap {
+      allTISKeyboardLayouts[$0]
     }
-
-    Self.arrDynamicBasicKeyLayouts.forEach {
-      if let neta = rawDictionary[$0] {
-        if neta.identifier.contains("com.apple") {
-          containerA.append(neta)
-        } else {
-          containerB.append(neta)
-        }
+    matchedGroupBasic.forEach { neta in
+      if filterSet.contains(neta.id) {
+        containerC.append(neta)
+      } else if neta.id.hasPrefix("com.apple") {
+        containerA.append(neta)
+      } else {
+        containerB.append(neta)
       }
     }
 

Packages/vChewing_IMKUtils/Sources/IMKUtils/LatinKeyboardMappings.swift

@@ -8,25 +8,27 @@
 
 import Foundation
 
-public enum LatinKeyboardMappings: String {
+public enum LatinKeyboardMappings: String, CaseIterable {
   case qwerty = "com.apple.keylayout.ABC"
-  case qwertyUS = "com.apple.keylayout.US"
+  case qwertyBritish = "com.apple.keylayout.British"
+  case qwertyUS = "com.apple.keylayout.US" // 10.9 - 10.12
   case azerty = "com.apple.keylayout.ABC-AZERTY"
-  case azertyFrench = "com.apple.keylayout.French"
   case qwertz = "com.apple.keylayout.ABC-QWERTZ"
-  case qwertyGerman = "com.apple.keylayout.German"
+  case azertyFrench = "com.apple.keylayout.French" // 10.9 - 10.12
+  case qwertzGerman = "com.apple.keylayout.German" // 10.9 - 10.12
   case colemak = "com.apple.keylayout.Colemak"
   case dvorak = "com.apple.keylayout.Dvorak"
+  case dvorakQwertyCMD = "com.apple.keylayout.DVORAK-QWERTYCMD"
   case dvorakLeft = "com.apple.keylayout.Dvorak-Left"
   case dvorakRight = "com.apple.keylayout.Dvorak-Right"
 
   public var mapTable: [UInt16: (String, String)] {
     switch self {
-    case .qwerty, .qwertyUS: return Self.dictQwerty
+    case .qwerty, .qwertyUS, .qwertyBritish: return Self.dictQwerty
     case .azerty, .azertyFrench: return Self.dictAzerty
-    case .qwertz, .qwertyGerman: return Self.dictQwertz
+    case .qwertz, .qwertzGerman: return Self.dictQwertz
     case .colemak: return Self.dictColemak
-    case .dvorak: return Self.dictDvorak
+    case .dvorak, .dvorakQwertyCMD: return Self.dictDvorak
     case .dvorakLeft: return Self.dictDvorakLeft
     case .dvorakRight: return Self.dictDvorakRight
     }

Packages/vChewing_IMKUtils/Sources/IMKUtils/TISInputSourceExtension.swift

@@ -12,8 +12,13 @@ import InputMethodKit
 // MARK: - TISInputSource Extension by The vChewing Project (MIT-NTL License).
 
 public extension TISInputSource {
+  struct KeyboardLayout: Identifiable {
+    public var id: String
+    public var titleLocalized: String
+  }
+
   static var allRegisteredInstancesOfThisInputMethod: [TISInputSource] {
-    TISInputSource.modes.compactMap { TISInputSource.generate(from: $0) }
+    TISInputSource.match(modeIDs: TISInputSource.modes)
   }
 
   static var modes: [String] {
@@ -22,7 +27,7 @@ public extension TISInputSource {
     else {
       return []
     }
-    return tsInputModeListKey.keys.map { $0 }
+    return tsInputModeListKey.keys.map(\.description)
   }
 
   @discardableResult static func registerInputMethod() -> Bool {
@@ -80,10 +85,6 @@ public extension TISInputSource {
       == kCFBooleanTrue
   }
 
-  static func generate(from identifier: String) -> TISInputSource? {
-    TISInputSource.rawTISInputSources(onlyASCII: false)[identifier]
-  }
-
   var inputModeID: String {
     unsafeBitCast(TISGetInputSourceProperty(self, kTISPropertyInputModeID), to: NSString.self) as String? ?? ""
   }
@@ -120,9 +121,34 @@ public extension TISInputSource {
     return unsafeBitCast(r, to: NSString.self).integerValue as Int? ?? 0
   }
 
-  static func rawTISInputSources(onlyASCII: Bool = false) -> [String: TISInputSource] {
+  // Refactored by Shiki Suen.
+  static func match(identifiers: [String] = [], modeIDs: [String] = [], onlyASCII: Bool = false) -> [TISInputSource] {
+    let dicConditions: [CFString: Any] = !onlyASCII ? [:] : [
+      kTISPropertyInputSourceType: kTISTypeKeyboardLayout as CFString,
+      kTISPropertyInputSourceIsASCIICapable: kCFBooleanTrue as CFBoolean,
+    ]
+    let cfDict = !onlyASCII ? nil : dicConditions as CFDictionary
+    var resultStack: [TISInputSource] = []
+    let unionedIDs = NSOrderedSet(array: modeIDs + identifiers).compactMap { $0 as? String }
+    let retrieved = (TISCreateInputSourceList(cfDict, true)?.takeRetainedValue() as? [TISInputSource]) ?? []
+    retrieved.forEach { tis in
+      unionedIDs.forEach { id in
+        guard tis.identifier == id || tis.inputModeID == id else { return }
+        if onlyASCII {
+          guard tis.scriptCode == 0 else { return }
+        }
+        resultStack.append(tis)
+      }
+    }
+    // 為了保持指定排序，才在最後做這種處理。效能略有打折，但至少比起直接迭代容量破百的 retrieved 要好多了。
+    return unionedIDs.compactMap { currentIdentifier in
+      retrieved.first { $0.identifier == currentIdentifier || $0.inputModeID == currentIdentifier }
+    }
+  }
+
+  /// 備註：這是 Mzp 的原版函式，留在這裡當範本參考。上述的 .match() 函式都衍生自此。
+  static func rawTISInputSources(onlyASCII: Bool = false) -> [TISInputSource] {
     // 為了指定檢索條件，先構築 CFDictionary 辭典。
-    // 第二項代指辭典容量。
     let dicConditions: [CFString: Any] = !onlyASCII ? [:] : [
       kTISPropertyInputSourceType: kTISTypeKeyboardLayout as CFString,
       kTISPropertyInputSourceIsASCIICapable: kCFBooleanTrue as CFBoolean,
@@ -132,10 +158,21 @@ public extension TISInputSource {
     if onlyASCII {
       result = result.filter { $0.scriptCode == 0 }
     }
-    var resultDictionary: [String: TISInputSource] = [:]
+    return result
+  }
+
+  /// Derived from rawTISInputSources().
+  static func getAllTISInputKeyboardLayoutMap() -> [String: TISInputSource.KeyboardLayout] {
+    // 為了指定檢索條件，先構築 CFDictionary 辭典。
+    let dicConditions: [CFString: Any] = [kTISPropertyInputSourceType: kTISTypeKeyboardLayout as CFString]
+    // 返回鍵盤配列清單。
+    let result = TISCreateInputSourceList(dicConditions as CFDictionary, true)?.takeRetainedValue() as? [TISInputSource] ?? .init()
+    var resultDictionary: [String: TISInputSource.KeyboardLayout] = [:]
     result.forEach {
-      resultDictionary[$0.inputModeID] = $0
-      resultDictionary[$0.identifier] = $0
+      let newNeta1 = TISInputSource.KeyboardLayout(id: $0.inputModeID, titleLocalized: $0.vChewingLocalizedName)
+      let newNeta2 = TISInputSource.KeyboardLayout(id: $0.identifier, titleLocalized: $0.vChewingLocalizedName)
+      resultDictionary[$0.inputModeID] = newNeta1
+      resultDictionary[$0.identifier] = newNeta2
     }
     return resultDictionary
   }

Packages/vChewing_KimoDataReader/.clang-format

@@ -0,0 +1,212 @@
+---
+# BasedOnStyle:  Google
+AccessModifierOffset: -1
+AlignAfterOpenBracket: Align
+AlignArrayOfStructures: None
+AlignConsecutiveMacros: None
+AlignConsecutiveAssignments: None
+AlignConsecutiveBitFields: None
+AlignConsecutiveDeclarations: None
+AlignEscapedNewlines: Left
+AlignOperands: Align
+AlignTrailingComments: true
+AllowAllArgumentsOnNextLine: true
+AllowAllConstructorInitializersOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortEnumsOnASingleLine: true
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: All
+AllowShortLambdasOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: WithoutElse
+AllowShortLoopsOnASingleLine: true
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
+AlwaysBreakTemplateDeclarations: Yes
+AttributeMacros:
+  - __capability
+BinPackArguments: true
+BinPackParameters: true
+BraceWrapping:
+  AfterCaseLabel: false
+  AfterClass: false
+  AfterControlStatement: Never
+  AfterEnum: false
+  AfterFunction: false
+  AfterNamespace: false
+  AfterObjCDeclaration: false
+  AfterStruct: false
+  AfterUnion: false
+  AfterExternBlock: false
+  BeforeCatch: false
+  BeforeElse: false
+  BeforeLambdaBody: false
+  BeforeWhile: false
+  IndentBraces: false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeConceptDeclarations: true
+BreakBeforeBraces: Attach
+BreakBeforeInheritanceComma: false
+BreakInheritanceList: BeforeColon
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit: 80
+CommentPragmas: "^ IWYU pragma:"
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DeriveLineEnding: true
+DerivePointerAlignment: true
+DisableFormat: false
+EmptyLineAfterAccessModifier: Never
+EmptyLineBeforeAccessModifier: LogicalBlock
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IfMacros:
+  - KJ_IF_MAYBE
+IncludeBlocks: Regroup
+IncludeCategories:
+  - Regex: '^<ext/.*\.h>'
+    Priority: 2
+    SortPriority: 0
+    CaseSensitive: false
+  - Regex: '^<.*\.h>'
+    Priority: 1
+    SortPriority: 0
+    CaseSensitive: false
+  - Regex: "^<.*"
+    Priority: 2
+    SortPriority: 0
+    CaseSensitive: false
+  - Regex: ".*"
+    Priority: 3
+    SortPriority: 0
+    CaseSensitive: false
+IncludeIsMainRegex: "([-_](test|unittest))?$"
+IncludeIsMainSourceRegex: ""
+IndentAccessModifiers: false
+IndentCaseLabels: true
+IndentCaseBlocks: false
+IndentGotoLabels: true
+IndentPPDirectives: None
+IndentExternBlock: AfterExternBlock
+IndentRequires: false
+IndentWidth: 2
+IndentWrappedFunctionNames: false
+InsertTrailingCommas: None
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: false
+LambdaBodyIndentation: Signature
+MacroBlockBegin: ""
+MacroBlockEnd: ""
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBinPackProtocolList: Never
+ObjCBlockIndentWidth: 2
+ObjCBreakBeforeNestedBlockParam: true
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 1
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 200
+PenaltyIndentedWhitespace: 0
+PointerAlignment: Left
+PPIndentWidth: -1
+RawStringFormats:
+  - Language: Cpp
+    Delimiters:
+      - cc
+      - CC
+      - cpp
+      - Cpp
+      - CPP
+      - "c++"
+      - "C++"
+      - "cs"
+    CanonicalDelimiter: ""
+    BasedOnStyle: google
+  - Language: TextProto
+    Delimiters:
+      - pb
+      - PB
+      - proto
+      - PROTO
+    EnclosingFunctions:
+      - EqualsProto
+      - EquivToProto
+      - PARSE_PARTIAL_TEXT_PROTO
+      - PARSE_TEST_PROTO
+      - PARSE_TEXT_PROTO
+      - ParseTextOrDie
+      - ParseTextProtoOrDie
+      - ParseTestProto
+      - ParsePartialTestProto
+    CanonicalDelimiter: pb
+    BasedOnStyle: google
+ReferenceAlignment: Pointer
+ReflowComments: true
+ShortNamespaceLines: 1
+SortIncludes: CaseSensitive
+SortJavaStaticImport: Before
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: false
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceAroundPointerQualifiers: Default
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyBlock: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 2
+SpacesInAngles: Never
+SpacesInConditionalStatement: false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInLineCommentPrefix:
+  Minimum: 1
+  Maximum: -1
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+SpaceBeforeSquareBrackets: false
+BitFieldColonSpacing: Both
+Standard: Auto
+StatementAttributeLikeMacros:
+  - Q_EMIT
+StatementMacros:
+  - Q_UNUSED
+  - QT_REQUIRE_VERSION
+TabWidth: 8
+UseCRLF: false
+UseTab: Never
+WhitespaceSensitiveMacros:
+  - STRINGIZE
+  - PP_STRINGIZE
+  - BOOST_PP_STRINGIZE
+  - NS_SWIFT_NAME
+  - CF_SWIFT_NAME
+---
+

Packages/vChewing_KimoDataReader/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+/.build
+/Packages
+xcuserdata/
+DerivedData/
+.swiftpm/configuration/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc

Packages/vChewing_KimoDataReader/Package.swift

@@ -0,0 +1,31 @@
+// swift-tools-version: 5.9
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+  name: "KimoDataReader",
+  products: [
+    // Products define the executables and libraries a package produces, making them visible to other packages.
+    .library(
+      name: "KimoDataReader",
+      targets: ["KimoDataReader"]
+    ),
+  ],
+  targets: [
+    // Targets are the basic building blocks of a package, defining a module or a test suite.
+    // Targets can depend on other targets in this package and products from dependencies.
+    .target(
+      name: "ObjcKimoCommunicator",
+      publicHeadersPath: "include"
+    ),
+    .target(
+      name: "KimoDataReader",
+      dependencies: ["ObjcKimoCommunicator"]
+    ),
+    .testTarget(
+      name: "KimoDataReaderTests",
+      dependencies: ["KimoDataReader"]
+    ),
+  ]
+)

Packages/vChewing_KimoDataReader/README.MD

@@ -0,0 +1,19 @@
+# KimoCommunicator
+
+用來與奇摩輸入法進行 NSConnection 通訊的模組，便於直接從奇摩輸入法讀入使用者自訂詞資料庫的資料。
+
+> 免責聲明：
+> 與奇摩輸入法有關的原始碼是由 Yahoo 奇摩以 `SPDX Identifier: BSD-3-Clause` 釋出的，
+> 但敝模組只是藉由其 Protocol API 與該當程式進行跨執行緒通訊，所以屬於合理使用範圍。
+
+```
+// (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.
+```
+
+$ EOF.

Packages/vChewing_KimoDataReader/Sources/KimoDataReader/KimoCommunicatorImpl.swift

@@ -0,0 +1,25 @@
+// (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 Foundation
+import ObjcKimoCommunicator
+
+public class KimoCommunicator: ObjcKimoCommunicator {
+  public static let shared: KimoCommunicator = .init()
+
+  public func prepareData(handler: @escaping (_ key: String, _ value: String) -> Void) {
+    guard KimoCommunicator.shared.establishConnection() else { return }
+    assert(KimoCommunicator.shared.hasValidConnection())
+    let loopAmount = KimoCommunicator.shared.userPhraseDBTotalAmountOfRows()
+    for i in 0 ..< loopAmount {
+      let fetched = KimoCommunicator.shared.userPhraseDBDictionary(atRow: i)
+      guard let key = fetched["BPMF"], let text = fetched["Text"] else { continue }
+      handler(key, text)
+    }
+  }
+}

Packages/vChewing_KimoDataReader/Sources/ObjcKimoCommunicator/KimoCommunicator.m

@@ -0,0 +1,86 @@
+// (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.
+
+// 免責聲明：
+// 與奇摩輸入法有關的原始碼是由 Yahoo 奇摩以 `SPDX Identifier: BSD-3-Clause` 釋出的，
+// 但敝模組只是藉由其 Protocol API 與該當程式進行跨執行緒通訊，所以屬於合理使用範圍。
+
+#import "KimoCommunicator.h"
+
+#import <AppKit/AppKit.h>
+#import <Foundation/Foundation.h>
+
+#define kYahooKimoDataObjectConnectionName @"YahooKeyKeyService"
+
+@implementation ObjcKimoCommunicator {
+  id _xpcConnection;
+}
+
+/// 解構。
+- (void)dealloc {
+  [self disconnect];
+}
+
+/// 斷開連線。
+- (void)disconnect {
+  _xpcConnection = nil;
+}
+
+/// 嘗試連線。
+- (bool)establishConnection {
+  // 奇摩輸入法2012最終版在建置的時候還沒用到 NSXPCConnection，實質上並不支援
+  // NSXPCConnection。 因此，這裡使用 NSXPCConnection 的話反而會壞事。
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+  _xpcConnection = [NSConnection rootProxyForConnectionWithRegisteredName:
+                                     kYahooKimoDataObjectConnectionName
+                                                                     host:nil];
+#pragma GCC diagnostic pop
+  BOOL result = false;
+  if (_xpcConnection) {
+    result = true;
+  }
+  if (result) {
+    [_xpcConnection setProtocolForProxy:@protocol(KimoUserDataReaderService)];
+    NSLog(@"vChewingDebug: Connection successful. Available data amount: %d.\n",
+          [_xpcConnection userPhraseDBNumberOfRow]);
+  }
+  return result;
+}
+
+/// 偵測連線是否有效。
+- (bool)hasValidConnection {
+  BOOL result = false;
+  if (_xpcConnection) result = true;
+  return result;
+}
+
+- (BOOL)userPhraseDBCanProvideService {
+  return [self hasValidConnection]
+             ? [_xpcConnection userPhraseDBCanProvideService]
+             : NO;
+}
+
+- (int)userPhraseDBTotalAmountOfRows {
+  return [self hasValidConnection] ? [_xpcConnection userPhraseDBNumberOfRow]
+                                   : 0;
+}
+
+- (NSDictionary<NSString*, NSString*> *)userPhraseDBDictionaryAtRow:(int)row {
+  return [self hasValidConnection]
+             ? [_xpcConnection userPhraseDBDictionaryAtRow:row]
+             : [NSDictionary alloc];
+}
+
+- (bool)exportUserPhraseDBToFile:(NSString *)path {
+  return [self hasValidConnection]
+             ? [_xpcConnection exportUserPhraseDBToFile:path]
+             : NO;
+}
+
+@end

Packages/vChewing_KimoDataReader/Sources/ObjcKimoCommunicator/include/KimoCommunicator.h

@@ -0,0 +1,46 @@
+// (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.
+
+// 免責聲明：
+// 與奇摩輸入法有關的原始碼是由 Yahoo 奇摩以 `SPDX Identifier: BSD-3-Clause` 釋出的，
+// 但敝模組只是藉由其 Protocol API 與該當程式進行跨執行緒通訊，所以屬於合理使用範圍。
+
+#import <AppKit/AppKit.h>
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@protocol KimoUserDataReaderService
+- (BOOL)userPhraseDBCanProvideService;
+- (int)userPhraseDBNumberOfRow;
+- (NSDictionary *)userPhraseDBDictionaryAtRow:(int)row;
+- (bool)exportUserPhraseDBToFile:(NSString *)path;
+@end
+
+/// 不要理會 Xcode 對 NSDistantObject 的過期狗吠。
+/// 奇摩輸入法是用 NSConnection 寫的，
+/// 換用 NSXPCConnection 只會製造更多的問題。
+@interface ObjcKimoCommunicator : NSObject
+
+/// 嘗試連線。
+- (bool)establishConnection;
+
+/// 偵測連線是否有效。
+- (bool)hasValidConnection;
+
+/// 斷開連線。
+- (void)disconnect;
+
+// Conforming KimoUserDataReaderService protocol.
+- (BOOL)userPhraseDBCanProvideService;
+- (int)userPhraseDBTotalAmountOfRows;
+- (NSDictionary<NSString*, NSString*> *)userPhraseDBDictionaryAtRow:(int)row;
+- (bool)exportUserPhraseDBToFile:(NSString *)path;
+@end
+
+NS_ASSUME_NONNULL_END

Packages/vChewing_KimoDataReader/Tests/KimoDataReaderTests/KimoDataReaderTests.swift

@@ -0,0 +1,10 @@
+@testable import ObjcKimoCommunicator
+import XCTest
+
+final class KimoDataReaderTests: XCTestCase {
+  // 先運行奇摩輸入法，再跑這個測試。
+  func testExample() throws {
+    let shared = ObjcKimoCommunicator()
+    print(shared.establishConnection())
+  }
+}

Packages/vChewing_KimoDataReader/format.sh

@@ -0,0 +1,6 @@
+find . -regex '.*\.\(hh\)' -exec clang-format -style=file -i {} \;
+find . -regex '.*\.\(cc\)' -exec clang-format -style=file -i {} \;
+find . -regex '.*\.\(mm\)' -exec clang-format -style=file -i {} \;
+find . -regex '.*\.\(h\)' -exec clang-format -style=file -i {} \;
+find . -regex '.*\.\(c\)' -exec clang-format -style=file -i {} \;
+find . -regex '.*\.\(m\)' -exec clang-format -style=file -i {} \;

Packages/vChewing_LangModelAssembly/Package.swift

@@ -15,8 +15,7 @@ let package = Package(
   dependencies: [
     .package(path: "../RMJay_LineReader"),
     .package(path: "../vChewing_Megrez"),
-    .package(path: "../vChewing_PinyinPhonaConverter"),
-    .package(path: "../vChewing_Shared"),
+    .package(path: "../vChewing_SwiftExtension"),
   ],
   targets: [
     .target(
@@ -24,12 +23,7 @@ let package = Package(
       dependencies: [
         .product(name: "LineReader", package: "RMJay_LineReader"),
         .product(name: "Megrez", package: "vChewing_Megrez"),
-        .product(name: "Shared", package: "vChewing_Shared"),
-        .product(name: "PinyinPhonaConverter", package: "vChewing_PinyinPhonaConverter"),
-      ],
-      resources: [
-        .process("Resources/sequenceDataFromEtenDOS-chs.json"),
-        .process("Resources/sequenceDataFromEtenDOS-cht.json"),
+        .product(name: "SwiftExtension", package: "vChewing_SwiftExtension"),
       ]
     ),
     .testTarget(

Packages/vChewing_LangModelAssembly/README.md

@@ -1,17 +1,17 @@
 # LangModelAssembly
 
-威注音輸入法的語言模組總成套裝。
+威注音輸入法的語言模組總成套裝，以 LMAssembly 命名空間承載下述唯二對外物件：
 
-- vChewingLM：總命名空間，也承載一些在套裝內共用的工具函式。
 - LMConsolidator：自動格式整理模組。
-- LMInstantiator：語言模組副本化模組。另有其日期時間擴充模組可用（對 CIN 磁帶模式無效）。
+- LMInstantiator：語言模組副本化模組，亦集成一些自身功能擴展。
+
+LMAssembly 總命名空間也承載一些在套裝內共用的工具函式。
 
 以下是子模組：
 
+- LMAssociates：關聯詞語模組。
 - lmCassette：專門用來處理 CIN 磁帶檔案的模組，命名為「遠野」引擎。
-- LMAssociates：聯想詞模組。
 - LMCoreEX：可以直接讀取 TXT 格式的帶有權重資料的語彙檔案的模組。
-- LMCoreJSON：專門用來讀取原廠 JSON 檔案的模組。
 - lmPlainBopomofo：專門用來讀取使用者自訂ㄅ半候選字順序覆蓋定義檔案（plist）的模組。
 - lmReplacements：專門用來讀取使用者語彙置換模式的辭典資料的模組。
 - lmUserOverride：半衰記憶模組。

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/InputToken.swift

@@ -11,29 +11,31 @@ import Foundation
 /// 工作原理：先用 InputToken.parse 分析原始字串，給出準確的 Token。
 /// 然後再讓這個 Token 用 .translated() 自我表述出轉換結果。
 
-public enum InputToken {
-  case timeZone(shortened: Bool)
-  case timeNow(shortened: Bool)
-  case date(dayDelta: Int = 0, yearDelta: Int = 0, shortened: Bool = true, luna: Bool = false)
-  case week(dayDelta: Int = 0, shortened: Bool = true)
-  case year(yearDelta: Int = 0)
-  case yearGanzhi(yearDelta: Int = 0)
-  case yearZodiac(yearDelta: Int = 0)
+extension LMAssembly {
+  enum InputToken {
+    case timeZone(shortened: Bool)
+    case timeNow(shortened: Bool)
+    case date(dayDelta: Int = 0, yearDelta: Int = 0, shortened: Bool = true, luna: Bool = false)
+    case week(dayDelta: Int = 0, shortened: Bool = true)
+    case year(yearDelta: Int = 0)
+    case yearGanzhi(yearDelta: Int = 0)
+    case yearZodiac(yearDelta: Int = 0)
+  }
 }
 
 // MARK: - 正式對外投入使用的 API。
 
 public extension String {
   func parseAsInputToken(isCHS: Bool) -> [String] {
-    InputToken.parse(from: self).map { $0.translated(isCHS: isCHS) }.flatMap { $0 }.deduplicated
+    LMAssembly.InputToken.parse(from: self).map { $0.translated(isCHS: isCHS) }.flatMap { $0 }.deduplicated
   }
 }
 
 // MARK: - Parser parsing raw token value to construct token.
 
-public extension InputToken {
-  static func parse(from rawToken: String) -> [InputToken] {
-    var result: [InputToken] = []
+extension LMAssembly.InputToken {
+  static func parse(from rawToken: String) -> [LMAssembly.InputToken] {
+    var result: [LMAssembly.InputToken] = []
     guard rawToken.prefix(6) == "MACRO@" else { return result }
     var mapParams: [String: Int] = [:]
     let tokenComponents = rawToken.dropFirst(6).split(separator: "_").map { param in
@@ -69,7 +71,7 @@ public extension InputToken {
 
 // MARK: - Parser parsing token itself.
 
-public extension InputToken {
+extension LMAssembly.InputToken {
   func translated(isCHS: Bool) -> [String] {
     let locale = Locale(identifier: isCHS ? "zh-Hans" : "zh-Hant-TW")
     let formatter = DateFormatter()

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/LMConsolidator.swift

@@ -8,9 +8,8 @@
 
 import Foundation
 import LineReader
-import Shared
 
-public extension vChewingLM {
+public extension LMAssembly {
   enum LMConsolidator {
     public static let kPragmaHeader = "# 𝙵𝙾𝚁𝙼𝙰𝚃 𝚘𝚛𝚐.𝚊𝚝𝚎𝚕𝚒𝚎𝚛𝙸𝚗𝚖𝚞.𝚟𝚌𝚑𝚎𝚠𝚒𝚗𝚐.𝚞𝚜𝚎𝚛𝙻𝚊𝚗𝚐𝚞𝚊𝚐𝚎𝙼𝚘𝚍𝚎𝚕𝙳𝚊𝚝𝚊.𝚏𝚘𝚛𝚖𝚊𝚝𝚝𝚎𝚍"
 
@@ -26,19 +25,19 @@ public extension vChewingLM {
           let lineReader = try LineReader(file: fileHandle)
           for strLine in lineReader { // 不需要 i=0，因為第一遍迴圈就出結果。
             if strLine != kPragmaHeader {
-              vCLog("Header Mismatch, Starting In-Place Consolidation.")
+              vCLMLog("Header Mismatch, Starting In-Place Consolidation.")
               return false
             } else {
-              vCLog("Header Verification Succeeded: \(strLine).")
+              vCLMLog("Header Verification Succeeded: \(strLine).")
               return true
             }
           }
         } catch {
-          vCLog("Header Verification Failed: File Access Error.")
+          vCLMLog("Header Verification Failed: File Access Error.")
           return false
         }
       }
-      vCLog("Header Verification Failed: File Missing.")
+      vCLMLog("Header Verification Failed: File Missing.")
       return false
     }
 
@@ -51,12 +50,12 @@ public extension vChewingLM {
         let dict = try FileManager.default.attributesOfItem(atPath: path)
         if let value = dict[FileAttributeKey.size] as? UInt64 { fileSize = value }
       } catch {
-        vCLog("EOF Fix Failed: File Missing at \(path).")
+        vCLMLog("EOF Fix Failed: File Missing at \(path).")
         return false
       }
       guard let fileSize = fileSize else { return false }
       guard let writeFile = FileHandle(forUpdatingAtPath: path) else {
-        vCLog("EOF Fix Failed: File Not Writable at \(path).")
+        vCLMLog("EOF Fix Failed: File Not Writable at \(path).")
         return false
       }
       defer { writeFile.closeFile() }
@@ -64,11 +63,11 @@ public extension vChewingLM {
       /// 但這個函式執行完之後往往就會 consolidate() 整理格式，所以不會有差。
       writeFile.seek(toFileOffset: fileSize - 1)
       if writeFile.readDataToEndOfFile().first != 0x0A {
-        vCLog("EOF Missing Confirmed, Start Fixing.")
+        vCLMLog("EOF Missing Confirmed, Start Fixing.")
         var newData = Data()
         newData.append(0x0A)
         writeFile.write(newData)
-        vCLog("EOF Successfully Assured.")
+        vCLMLog("EOF Successfully Assured.")
       }
       return false
     }
@@ -142,14 +141,29 @@ public extension vChewingLM {
           // Write consolidated file contents.
           try strProcessed.write(to: urlPath, atomically: false, encoding: .utf8)
         } catch {
-          vCLog("Consolidation Failed w/ File: \(path), error: \(error)")
+          vCLMLog("Consolidation Failed w/ File: \(path), error: \(error)")
           return false
         }
-        vCLog("Either Consolidation Successful Or No-Need-To-Consolidate.")
+        vCLMLog("Either Consolidation Successful Or No-Need-To-Consolidate.")
         return true
       }
-      vCLog("Consolidation Failed: File Missing at \(path).")
+      vCLMLog("Consolidation Failed: File Missing at \(path).")
       return false
     }
   }
 }
+
+private extension String {
+  mutating func regReplace(pattern: String, replaceWith: String = "") {
+    // Ref: https://stackoverflow.com/a/40993403/4162914 && https://stackoverflow.com/a/71291137/4162914
+    do {
+      let regex = try NSRegularExpression(
+        pattern: pattern, options: [.caseInsensitive, .anchorsMatchLines]
+      )
+      let range = NSRange(startIndex..., in: self)
+      self = regex.stringByReplacingMatches(
+        in: self, options: [], range: range, withTemplate: replaceWith
+      )
+    } catch { return }
+  }
+}

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/LMInstantiator.swift

@@ -8,10 +8,8 @@
 
 import Foundation
 import Megrez
-import Shared
-import SQLite3
 
-public extension vChewingLM {
+public extension LMAssembly {
   /// 語言模組副本化模組（LMInstantiator，下稱「LMI」）自身為符合天權星組字引擎內
   /// 的 LangModelProtocol 協定的模組、統籌且整理來自其它子模組的資料（包括使
   /// 用者語彙、繪文字模組、語彙濾除表、原廠語言模組等）。
@@ -30,41 +28,49 @@ public extension vChewingLM {
   /// LMI 會根據需要分別載入原廠語言模組和其他個別的子語言模組。LMI 本身不會記錄這些
   /// 語言模組的相關資料的存放位置，僅藉由參數來讀取相關訊息。
   class LMInstantiator: LangModelProtocol {
+    public struct Config {
+      /// 如果設定為 nil 的話，則不產生任何詞頻資料。
+      /// true = 全形，false = 半形。
+      public var numPadFWHWStatus: Bool?
+      public var isCassetteEnabled = false
+      public var isPhraseReplacementEnabled = false
+      public var isCNSEnabled = false
+      public var isSymbolEnabled = false
+      public var isSCPCEnabled = false
+      public var filterNonCNSReadings = false
+      public var deltaOfCalendarYears: Int = -2000
+    }
+
+    public static var asyncLoadingUserData: Bool = true
+
     // SQLite 連線所在的記憶體位置。
     static var ptrSQL: OpaquePointer?
 
     // SQLite 連線是否已經建立。
-    public private(set) static var isSQLDBConnected: Bool = false
+    public internal(set) static var isSQLDBConnected: Bool = false
+
+    // 簡體中文模型？
+    public let isCHS: Bool
 
     // 在函式內部用以記錄狀態的開關。
-    public var isCassetteEnabled = false
-    public var isPhraseReplacementEnabled = false
-    public var isCNSEnabled = false
-    public var isSymbolEnabled = false
-    public var isSCPCEnabled = false
-    public var isCHS = false
-    public var deltaOfCalendarYears: Int = -2000
+    public private(set) var config = Config()
 
     // 這句需要留著，不然無法被 package 外界存取。
-    public init(isCHS: Bool = false) {
+    public init(
+      isCHS: Bool = false,
+      uomDataURL: URL? = nil
+    ) {
       self.isCHS = isCHS
+      lmUserOverride = .init(dataURL: uomDataURL)
     }
 
-    @discardableResult public static func connectSQLDB(dbPath: String, dropPreviousConnection: Bool = true) -> Bool {
-      if dropPreviousConnection { disconnectSQLDB() }
-      vCLog("Establishing SQLite connection to: \(dbPath)")
-      guard sqlite3_open(dbPath, &Self.ptrSQL) == SQLITE_OK else { return false }
-      guard "PRAGMA journal_mode = MEMORY;".runAsSQLExec(dbPointer: &ptrSQL) else { return false }
-      isSQLDBConnected = true
-      return true
+    @discardableResult public func setOptions(handler: (inout Config) -> Void) -> LMInstantiator {
+      handler(&config)
+      return self
     }
 
-    public static func disconnectSQLDB() {
-      if Self.ptrSQL != nil {
-        sqlite3_close_v2(Self.ptrSQL)
-        Self.ptrSQL = nil
-      }
-      isSQLDBConnected = false
+    public static func setCassetCandidateKeyValidator(_ validator: @escaping (String) -> Bool) {
+      Self.lmCassette.candidateKeysValidator = validator
     }
 
     /// 介紹一下幾個通用的語言模組型別：
@@ -73,12 +79,13 @@ public extension vChewingLM {
     /// 比較適合那種每筆記錄都有不同的權重數值的語言模組，雖然也可以強制施加權重數值就是了。
     /// LMCoreEX 的辭典陣列不承載 Unigram 本體、而是承載索引範圍，這樣可以節約記憶體。
     /// 一個 LMCoreEX 就可以滿足威注音幾乎所有語言模組副本的需求，當然也有這兩個例外：
-    /// LMReplacements 與 LMAssociates 分別擔當語彙置換表資料與使用者聯想詞的資料承載工作。
+    /// LMReplacements 與 LMAssociates 分別擔當語彙置換表資料與使用者關聯詞語的資料承載工作。
     /// 但是，LMCoreEX 對 2010-2013 年等舊 mac 機種而言，讀取速度異常緩慢。
     /// 於是 LMCoreJSON 就出場了，專門用來讀取原廠的 JSON 格式的辭典。
 
     // 磁帶資料模組。「currentCassette」對外唯讀，僅用來讀取磁帶本身的中繼資料（Metadata）。
     static var lmCassette = LMCassette()
+    static var lmPlainBopomofo = LMPlainBopomofo()
 
     // 聲明使用者語言模組。
     // 使用者語言模組使用多執行緒的話，可能會導致一些問題。有時間再仔細排查看看。
@@ -93,30 +100,46 @@ public extension vChewingLM {
     )
     var lmReplacements = LMReplacements()
     var lmAssociates = LMAssociates()
-    var lmPlainBopomofo = LMPlainBopomofo()
+
+    // 半衰记忆模组
+    var lmUserOverride: LMUserOverride
 
     // MARK: - 工具函式
 
     public func resetFactoryJSONModels() {}
 
     public func loadUserPhrasesData(path: String, filterPath: String?) {
-      DispatchQueue.main.async {
+      func loadMain() {
         if FileManager.default.isReadableFile(atPath: path) {
-          self.lmUserPhrases.clear()
-          self.lmUserPhrases.open(path)
-          vCLog("lmUserPhrases: \(self.lmUserPhrases.count) entries of data loaded from: \(path)")
+          lmUserPhrases.clear()
+          lmUserPhrases.open(path)
+          vCLMLog("lmUserPhrases: \(lmUserPhrases.count) entries of data loaded from: \(path)")
         } else {
-          vCLog("lmUserPhrases: File access failure: \(path)")
+          vCLMLog("lmUserPhrases: File access failure: \(path)")
+        }
+      }
+      if !Self.asyncLoadingUserData {
+        loadMain()
+      } else {
+        DispatchQueue.main.async {
+          loadMain()
         }
       }
       guard let filterPath = filterPath else { return }
-      DispatchQueue.main.async {
+      func loadFilter() {
         if FileManager.default.isReadableFile(atPath: filterPath) {
-          self.lmFiltered.clear()
-          self.lmFiltered.open(filterPath)
-          vCLog("lmFiltered: \(self.lmFiltered.count) entries of data loaded from: \(path)")
+          lmFiltered.clear()
+          lmFiltered.open(filterPath)
+          vCLMLog("lmFiltered: \(lmFiltered.count) entries of data loaded from: \(path)")
         } else {
-          vCLog("lmFiltered: File access failure: \(path)")
+          vCLMLog("lmFiltered: File access failure: \(path)")
+        }
+      }
+      if !Self.asyncLoadingUserData {
+        loadFilter()
+      } else {
+        DispatchQueue.main.async {
+          loadFilter()
         }
       }
     }
@@ -126,74 +149,85 @@ public extension vChewingLM {
       if FileManager.default.isReadableFile(atPath: path) {
         lmFiltered.clear()
         lmFiltered.open(path)
-        vCLog("lmFiltered: \(lmFiltered.count) entries of data loaded from: \(path)")
+        vCLMLog("lmFiltered: \(lmFiltered.count) entries of data loaded from: \(path)")
       } else {
-        vCLog("lmFiltered: File access failure: \(path)")
+        vCLMLog("lmFiltered: File access failure: \(path)")
       }
     }
 
     public func loadUserSymbolData(path: String) {
-      DispatchQueue.main.async {
+      func load() {
         if FileManager.default.isReadableFile(atPath: path) {
-          self.lmUserSymbols.clear()
-          self.lmUserSymbols.open(path)
-          vCLog("lmUserSymbol: \(self.lmUserSymbols.count) entries of data loaded from: \(path)")
+          lmUserSymbols.clear()
+          lmUserSymbols.open(path)
+          vCLMLog("lmUserSymbol: \(lmUserSymbols.count) entries of data loaded from: \(path)")
         } else {
-          vCLog("lmUserSymbol: File access failure: \(path)")
+          vCLMLog("lmUserSymbol: File access failure: \(path)")
+        }
+      }
+      if !Self.asyncLoadingUserData {
+        load()
+      } else {
+        DispatchQueue.main.async {
+          load()
         }
       }
     }
 
     public func loadUserAssociatesData(path: String) {
-      DispatchQueue.main.async {
+      func load() {
         if FileManager.default.isReadableFile(atPath: path) {
-          self.lmAssociates.clear()
-          self.lmAssociates.open(path)
-          vCLog("lmAssociates: \(self.lmAssociates.count) entries of data loaded from: \(path)")
+          lmAssociates.clear()
+          lmAssociates.open(path)
+          vCLMLog("lmAssociates: \(lmAssociates.count) entries of data loaded from: \(path)")
         } else {
-          vCLog("lmAssociates: File access failure: \(path)")
+          vCLMLog("lmAssociates: File access failure: \(path)")
+        }
+      }
+      if !Self.asyncLoadingUserData {
+        load()
+      } else {
+        DispatchQueue.main.async {
+          load()
         }
       }
     }
 
     public func loadReplacementsData(path: String) {
-      DispatchQueue.main.async {
+      func load() {
         if FileManager.default.isReadableFile(atPath: path) {
-          self.lmReplacements.clear()
-          self.lmReplacements.open(path)
-          vCLog("lmReplacements: \(self.lmReplacements.count) entries of data loaded from: \(path)")
+          lmReplacements.clear()
+          lmReplacements.open(path)
+          vCLMLog("lmReplacements: \(lmReplacements.count) entries of data loaded from: \(path)")
         } else {
-          vCLog("lmReplacements: File access failure: \(path)")
+          vCLMLog("lmReplacements: File access failure: \(path)")
         }
       }
-    }
-
-    public func loadSCPCSequencesData() {
-      let fileName = !isCHS ? "sequenceDataFromEtenDOS-cht" : "sequenceDataFromEtenDOS-chs"
-      guard let path = Bundle.module.path(forResource: fileName, ofType: "json") else {
-        vCLog("lmPlainBopomofo: File name access failure: \(fileName)")
-        return
-      }
-      DispatchQueue.main.async {
-        if FileManager.default.isReadableFile(atPath: path) {
-          self.lmPlainBopomofo.clear()
-          self.lmPlainBopomofo.open(path)
-          vCLog("lmPlainBopomofo: \(self.lmPlainBopomofo.count) entries of data loaded from: \(path)")
-        } else {
-          vCLog("lmPlainBopomofo: File access failure: \(path)")
+      if !Self.asyncLoadingUserData {
+        load()
+      } else {
+        DispatchQueue.main.async {
+          load()
         }
       }
     }
 
     public var isCassetteDataLoaded: Bool { Self.lmCassette.isLoaded }
     public static func loadCassetteData(path: String) {
-      DispatchQueue.main.async {
+      func load() {
         if FileManager.default.isReadableFile(atPath: path) {
           Self.lmCassette.clear()
           Self.lmCassette.open(path)
-          vCLog("lmCassette: \(Self.lmCassette.count) entries of data loaded from: \(path)")
+          vCLMLog("lmCassette: \(Self.lmCassette.count) entries of data loaded from: \(path)")
         } else {
-          vCLog("lmCassette: File access failure: \(path)")
+          vCLMLog("lmCassette: File access failure: \(path)")
+        }
+      }
+      if !Self.asyncLoadingUserData {
+        load()
+      } else {
+        DispatchQueue.main.async {
+          load()
         }
       }
     }
@@ -315,33 +349,57 @@ public extension vChewingLM {
       /// 準備不同的語言模組容器，開始逐漸往容器陣列內塞入資料。
       var rawAllUnigrams: [Megrez.Unigram] = []
 
-      if isCassetteEnabled { rawAllUnigrams += Self.lmCassette.unigramsFor(key: keyChain) }
+      if config.isCassetteEnabled { rawAllUnigrams += Self.lmCassette.unigramsFor(key: keyChain) }
 
       // 如果有檢測到使用者自訂逐字選字語料庫內的相關資料的話，在這裡先插入。
-      if isSCPCEnabled {
-        rawAllUnigrams += lmPlainBopomofo.valuesFor(key: keyChain).map { Megrez.Unigram(value: $0, score: 0) }
+      if config.isSCPCEnabled {
+        rawAllUnigrams += Self.lmPlainBopomofo.valuesFor(key: keyChain, isCHS: isCHS).map {
+          Megrez.Unigram(value: $0, score: 0)
+        }
+      }
+
+      if !config.isCassetteEnabled || config.isCassetteEnabled && keyChain.map(\.description)[0] == "_" {
+        // 先給出 NumPad 的結果。
+        rawAllUnigrams += supplyNumPadUnigrams(key: keyChain)
+        // LMMisc 與 LMCore 的 score 在 (-10.0, 0.0) 這個區間內。
+        rawAllUnigrams += factoryUnigramsFor(key: keyChain, column: .theDataCHEW)
+        // 原廠核心辭典內容。
+        var coreUnigramsResult: [Megrez.Unigram] = factoryCoreUnigramsFor(key: keyChain)
+        // 如果是繁體中文、且有開啟 CNS11643 全字庫讀音過濾開關的話，對原廠核心辭典內容追加過濾處理：
+        if config.filterNonCNSReadings, !isCHS {
+          coreUnigramsResult.removeAll { thisUnigram in
+            !checkCNSConformation(for: thisUnigram, keyArray: keyArray)
+          }
+        }
+        // 正式追加原廠核心辭典檢索結果。
+        rawAllUnigrams += coreUnigramsResult
+
+        if config.isCNSEnabled {
+          rawAllUnigrams += factoryUnigramsFor(key: keyChain, column: .theDataCNS)
+        }
+      }
+
+      if config.isSymbolEnabled {
+        rawAllUnigrams += lmUserSymbols.unigramsFor(key: keyChain)
+        if !config.isCassetteEnabled {
+          rawAllUnigrams += factoryUnigramsFor(key: keyChain, column: .theDataSYMB)
+        }
       }
 
       // 用 reversed 指令讓使用者語彙檔案內的詞條優先順序隨著行數增加而逐漸增高。
       // 這樣一來就可以在就地新增語彙時徹底複寫優先權。
       // 將兩句差分也是為了讓 rawUserUnigrams 的類型不受可能的影響。
-      rawAllUnigrams += lmUserPhrases.unigramsFor(key: keyChain).reversed()
-
-      if !isCassetteEnabled || isCassetteEnabled && keyChain.map(\.description)[0] == "_" {
-        // LMMisc 與 LMCore 的 score 在 (-10.0, 0.0) 這個區間內。
-        rawAllUnigrams += factoryUnigramsFor(key: keyChain, column: .theDataCHEW)
-        rawAllUnigrams += factoryCoreUnigramsFor(key: keyChain)
-        if isCNSEnabled {
-          rawAllUnigrams += factoryUnigramsFor(key: keyChain, column: .theDataCNS)
-        }
-      }
-
-      if isSymbolEnabled {
-        rawAllUnigrams += lmUserSymbols.unigramsFor(key: keyChain)
-        if !isCassetteEnabled {
-          rawAllUnigrams += factoryUnigramsFor(key: keyChain, column: .theDataSYMB)
+      var userPhraseUnigrams = Array(lmUserPhrases.unigramsFor(key: keyChain).reversed())
+      if keyArray.count == 1, let topScore = rawAllUnigrams.map(\.score).max() {
+        // 不再讓使用者自己加入的單漢字讀音權重進入爬軌體系。
+        userPhraseUnigrams = userPhraseUnigrams.map { currentUnigram in
+          Megrez.Unigram(
+            value: currentUnigram.value,
+            score: Swift.min(topScore + 0.000_114_514, currentUnigram.score)
+          )
         }
       }
+      rawAllUnigrams = userPhraseUnigrams + rawAllUnigrams
 
       // 分析且處理可能存在的 InputToken。
       rawAllUnigrams = rawAllUnigrams.map { unigram in
@@ -363,7 +421,7 @@ public extension vChewingLM {
       }
 
       // 提前處理語彙置換。
-      if isPhraseReplacementEnabled {
+      if config.isPhraseReplacementEnabled {
         for i in 0 ..< rawAllUnigrams.count {
           let newValue = lmReplacements.valuesFor(key: rawAllUnigrams[i].value)
           guard !newValue.isEmpty else { continue }

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/LMInstantiator_CassetteExtension.swift

@@ -8,9 +8,9 @@
 
 import Foundation
 import Megrez
-import Shared
+import SwiftExtension
 
-public extension vChewingLM.LMInstantiator {
+public extension LMAssembly.LMInstantiator {
   /// 磁帶模式專用：當前磁帶所規定的花牌鍵。
   var cassetteWildcardKey: String { Self.lmCassette.wildcardKey }
   /// 磁帶模式專用：當前磁帶規定的最大碼長。

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/LMInstantiator_DateTimeExtension.swift

@@ -11,7 +11,7 @@ import Megrez
 
 // MARK: - 日期時間便捷輸入功能
 
-extension vChewingLM.LMInstantiator {
+extension LMAssembly.LMInstantiator {
   func queryDateTimeUnigrams(with key: String = "") -> [Megrez.Unigram] {
     guard let tokenTrigger = TokenTrigger(rawValue: key) else { return [] }
     var results = [Megrez.Unigram]()
@@ -19,14 +19,14 @@ extension vChewingLM.LMInstantiator {
 
     func processDateWithDayDelta(_ delta: Int) {
       tokens = ["MACRO@DATE_DAYDELTA:\(delta)"]
-      if deltaOfCalendarYears != 0 { tokens.append("MACRO@DATE_DAYDELTA:\(delta)_YEARDELTA:\(deltaOfCalendarYears)") }
+      if config.deltaOfCalendarYears != 0 { tokens.append("MACRO@DATE_DAYDELTA:\(delta)_YEARDELTA:\(config.deltaOfCalendarYears)") }
       tokens.append("MACRO@DATE_DAYDELTA:\(delta)_SHORTENED")
       tokens.append("MACRO@DATE_DAYDELTA:\(delta)_LUNA")
     }
 
     func processYearWithYearDelta(_ delta: Int) {
       tokens = ["MACRO@YEAR_YEARDELTA:\(delta)"]
-      if deltaOfCalendarYears != 0 { tokens.append("MACRO@YEAR_YEARDELTA:\(delta + deltaOfCalendarYears)") }
+      if config.deltaOfCalendarYears != 0 { tokens.append("MACRO@YEAR_YEARDELTA:\(delta + config.deltaOfCalendarYears)") }
       tokens.append("MACRO@YEAR_GANZHI_YEARDELTA:\(delta)")
       tokens.append("MACRO@YEAR_ZODIAC_YEARDELTA:\(delta)")
     }

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/LMInstantiator_NumPadExtension.swift

@@ -0,0 +1,23 @@
+// (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 Foundation
+import Megrez
+
+public extension LMAssembly.LMInstantiator {
+  func supplyNumPadUnigrams(key: String) -> [Megrez.Unigram] {
+    guard let status = config.numPadFWHWStatus else { return [] }
+    let initials = "_NumPad_"
+    guard key.hasPrefix(initials) else { return [] }
+    let char = key.replacingOccurrences(of: initials, with: "")
+    guard char.count == 1 else { return [] }
+    let gram1 = Megrez.Unigram(value: char.applyingTransformFW2HW(reverse: status), score: 0)
+    let gram2 = Megrez.Unigram(value: char.applyingTransformFW2HW(reverse: !status), score: -0.1)
+    return [gram1, gram2]
+  }
+}

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/LMInstantiator_SQLExtension.swift

@@ -8,7 +8,6 @@
 
 import Foundation
 import Megrez
-import Shared
 import SQLite3
 
 /* ==============
@@ -31,30 +30,49 @@ import SQLite3
    ) WITHOUT ROWID;
  */
 
-enum CoreColumn: Int32 {
-  case theDataCHS = 1 // 簡體中文
-  case theDataCHT = 2 // 繁體中文
-  case theDataCNS = 3 // 全字庫
-  case theDataMISC = 4 // 待辦
-  case theDataSYMB = 5 // 符號圖
-  case theDataCHEW = 6 // 注音文
+extension LMAssembly.LMInstantiator {
+  enum CoreColumn: Int32 {
+    case theDataCHS = 1 // 簡體中文
+    case theDataCHT = 2 // 繁體中文
+    case theDataCNS = 3 // 全字庫
+    case theDataMISC = 4 // 待辦
+    case theDataSYMB = 5 // 符號圖
+    case theDataCHEW = 6 // 注音文
 
-  var name: String { String(describing: self) }
+    var name: String { String(describing: self) }
 
-  var id: Int32 { rawValue }
+    var id: Int32 { rawValue }
 
-  var defaultScore: Double {
-    switch self {
-    case .theDataCHEW: return -1
-    case .theDataCNS: return -11
-    case .theDataSYMB: return -13
-    case .theDataMISC: return -10
-    default: return -9.9
+    var defaultScore: Double {
+      switch self {
+      case .theDataCHEW: return -1
+      case .theDataCNS: return -11
+      case .theDataSYMB: return -13
+      case .theDataMISC: return -10
+      default: return -9.9
+      }
     }
   }
 }
 
-extension vChewingLM.LMInstantiator {
+extension LMAssembly.LMInstantiator {
+  @discardableResult public static func connectSQLDB(dbPath: String, dropPreviousConnection: Bool = true) -> Bool {
+    if dropPreviousConnection { disconnectSQLDB() }
+    vCLMLog("Establishing SQLite connection to: \(dbPath)")
+    guard sqlite3_open(dbPath, &Self.ptrSQL) == SQLITE_OK else { return false }
+    guard "PRAGMA journal_mode = OFF;".runAsSQLExec(dbPointer: &ptrSQL) else { return false }
+    isSQLDBConnected = true
+    return true
+  }
+
+  public static func disconnectSQLDB() {
+    if Self.ptrSQL != nil {
+      sqlite3_close_v2(Self.ptrSQL)
+      Self.ptrSQL = nil
+    }
+    isSQLDBConnected = false
+  }
+
   fileprivate static func querySQL(strStmt sqlQuery: String, coreColumn column: CoreColumn, handler: (String) -> Void) {
     guard Self.ptrSQL != nil else { return }
     performStatementSansResult { ptrStatement in
@@ -123,9 +141,10 @@ extension vChewingLM.LMInstantiator {
   }
 
   /// 根據給定的讀音索引鍵，來獲取原廠標準資料庫辭典內的對應資料陣列的 UTF8 資料、就地分析、生成單元圖陣列。
+  /// - Remark: 該函式會無損地返回原廠辭典的結果，不受使用者控頻與資料過濾條件的影響，不包含全字庫的資料。
   /// - parameters:
   ///   - key: 讀音索引鍵。
-  func factoryCoreUnigramsFor(key: String) -> [Megrez.Unigram] {
+  public func factoryCoreUnigramsFor(key: String) -> [Megrez.Unigram] {
     // 此處需要把 ASCII 單引號換成連續兩個單引號，否則會有 SQLite 語句查詢故障。
     factoryUnigramsFor(key: key, column: isCHS ? .theDataCHS : .theDataCHT)
   }
@@ -134,7 +153,9 @@ extension vChewingLM.LMInstantiator {
   /// - parameters:
   ///   - key: 讀音索引鍵。
   ///   - column: 資料欄位。
-  func factoryUnigramsFor(key: String, column: CoreColumn) -> [Megrez.Unigram] {
+  func factoryUnigramsFor(
+    key: String, column: LMAssembly.LMInstantiator.CoreColumn
+  ) -> [Megrez.Unigram] {
     if key == "_punctuation_list" { return [] }
     var grams: [Megrez.Unigram] = []
     var gramsHW: [Megrez.Unigram] = []
@@ -142,8 +163,10 @@ extension vChewingLM.LMInstantiator {
     let encryptedKey = Self.cnvPhonabetToASCII(key.replacingOccurrences(of: "'", with: "''"))
     let sqlQuery = "SELECT * FROM DATA_MAIN WHERE theKey='\(encryptedKey)';"
     Self.querySQL(strStmt: sqlQuery, coreColumn: column) { currentResult in
-      let arrRangeRecords = currentResult.split(separator: "\t")
-      for strNetaSet in arrRangeRecords {
+      var i: Double = 0
+      var previousScore: Double?
+      currentResult.split(separator: "\t").forEach { strNetaSet in
+        // 這裡假定原廠資料已經經過對權重的 stable sort 排序。
         let neta = Array(strNetaSet.trimmingCharacters(in: .newlines).split(separator: " ").reversed())
         let theValue: String = .init(neta[0])
         var theScore = column.defaultScore
@@ -153,8 +176,15 @@ extension vChewingLM.LMInstantiator {
         if theScore > 0 {
           theScore *= -1 // 應對可能忘記寫負號的情形
         }
+        if previousScore == theScore {
+          theScore -= i * 0.000_001
+          i += 1
+        } else {
+          previousScore = theScore
+          i = 0
+        }
         grams.append(Megrez.Unigram(value: theValue, score: theScore))
-        if !key.contains("_punctuation") { continue }
+        if !key.contains("_punctuation") { return }
         let halfValue = theValue.applyingTransformFW2HW(reverse: false)
         if halfValue != theValue {
           gramsHW.append(Megrez.Unigram(value: halfValue, score: theScore))
@@ -165,6 +195,24 @@ extension vChewingLM.LMInstantiator {
     return grams
   }
 
+  /// 根據給定的讀音索引鍵，來獲取原廠 CNS 資料庫辭典內的對應資料陣列的 UTF8 資料。
+  /// 該函式僅用來快速篩查 CNS 檢索結果
+  /// - parameters:
+  ///   - key: 讀音索引鍵。
+  ///   - column: 資料欄位。
+  private func factoryCNSFilterThreadFor(key: String) -> String? {
+    let column = CoreColumn.theDataCNS
+    if key == "_punctuation_list" { return nil }
+    var results: [String] = []
+    // 此處需要把 ASCII 單引號換成連續兩個單引號，否則會有 SQLite 語句查詢故障。
+    let encryptedKey = Self.cnvPhonabetToASCII(key.replacingOccurrences(of: "'", with: "''"))
+    let sqlQuery = "SELECT * FROM DATA_MAIN WHERE theKey='\(encryptedKey)';"
+    Self.querySQL(strStmt: sqlQuery, coreColumn: column) { currentResult in
+      results.append(currentResult)
+    }
+    return results.joined(separator: "\t")
+  }
+
   /// 根據給定的讀音索引鍵，來獲取原廠資料庫辭典內的對應資料陣列的 UTF8 資料、就地分析、生成單元圖陣列。
   /// - remark: 該函式暫時用不到，但先不用刪除。沒準今後會有用場。
   /// - parameters:
@@ -177,9 +225,22 @@ extension vChewingLM.LMInstantiator {
     let sqlQuery = "SELECT * FROM DATA_MAIN WHERE theKey='\(encryptedKey)' AND \(column.name) IS NOT NULL"
     return Self.hasSQLResult(strStmt: sqlQuery)
   }
+
+  /// 檢查該當 Unigram 結果是否完全符合台澎金馬 CNS11643 的規定讀音。
+  /// 該函式不適合拿給簡體中文模式使用。
+  func checkCNSConformation(for unigram: Megrez.Unigram, keyArray: [String]) -> Bool {
+    guard unigram.value.count == keyArray.count else { return true }
+    let chars = unigram.value.map(\.description)
+    for (i, key) in keyArray.enumerated() {
+      guard !key.hasPrefix("_") else { continue }
+      guard let matchedCNSResult = factoryCNSFilterThreadFor(key: key) else { continue }
+      guard matchedCNSResult.contains(chars[i]) else { return false }
+    }
+    return true
+  }
 }
 
-private extension vChewingLM.LMInstantiator {
+private extension LMAssembly.LMInstantiator {
   /// 內部函式，用以將注音讀音索引鍵進行加密。
   ///
   /// 使用這種加密字串作為索引鍵，可以增加對 json 資料庫的存取速度。
@@ -227,7 +288,7 @@ private extension vChewingLM.LMInstantiator {
   ]
 }
 
-public extension vChewingLM.LMInstantiator {
+public extension LMAssembly.LMInstantiator {
   @discardableResult static func connectToTestSQLDB() -> Bool {
     Self.connectSQLDB(dbPath: #":memory:"#) && sqlTestCoreLMData.runAsSQLExec(dbPointer: &ptrSQL)
   }

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/LMInstantiator_UOMRepresentable.swift

@@ -0,0 +1,60 @@
+// (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 Foundation
+import Megrez
+
+public extension LMAssembly.LMInstantiator {
+  func performUOMObservation(
+    walkedBefore: [Megrez.Node],
+    walkedAfter: [Megrez.Node],
+    cursor: Int,
+    timestamp: Double,
+    saveCallback: (() -> Void)? = nil
+  ) {
+    lmUserOverride.performObservation(
+      walkedBefore: walkedBefore,
+      walkedAfter: walkedAfter,
+      cursor: cursor,
+      timestamp: timestamp,
+      saveCallback: saveCallback
+    )
+  }
+
+  func fetchUOMSuggestion(
+    currentWalk: [Megrez.Node],
+    cursor: Int,
+    timestamp: Double
+  ) -> LMAssembly.OverrideSuggestion {
+    lmUserOverride.fetchSuggestion(
+      currentWalk: currentWalk,
+      cursor: cursor,
+      timestamp: timestamp
+    )
+  }
+
+  func loadUOMData(fromURL fileURL: URL? = nil) {
+    lmUserOverride.loadData(fromURL: fileURL)
+  }
+
+  func saveUOMData(toURL fileURL: URL? = nil) {
+    lmUserOverride.saveData(toURL: fileURL)
+  }
+
+  func clearUOMData(withURL fileURL: URL? = nil) {
+    lmUserOverride.clearData(withURL: fileURL)
+  }
+
+  func bleachSpecifiedUOMSuggestions(targets: [String], saveCallback: (() -> Void)? = nil) {
+    lmUserOverride.bleachSpecifiedSuggestions(targets: targets, saveCallback: saveCallback)
+  }
+
+  func bleachUOMUnigrams(saveCallback: (() -> Void)? = nil) {
+    lmUserOverride.bleachUnigrams(saveCallback: saveCallback)
+  }
+}

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/LMInstantiator_UserDictionarySummarized.swift

@@ -0,0 +1,33 @@
+// (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 Foundation
+
+public extension LMAssembly {
+  struct UserDictionarySummarized: Codable {
+    let isCHS: Bool
+    let userPhrases: [String: [String]]
+    let filter: [String: [String]]
+    let userSymbols: [String: [String]]
+    let replacements: [String: String]
+    let associates: [String: [String]]
+  }
+}
+
+public extension LMAssembly.LMInstantiator {
+  func summarize(all: Bool) -> LMAssembly.UserDictionarySummarized {
+    LMAssembly.UserDictionarySummarized(
+      isCHS: isCHS,
+      userPhrases: lmUserPhrases.dictRepresented,
+      filter: lmFiltered.dictRepresented,
+      userSymbols: lmUserSymbols.dictRepresented,
+      replacements: lmReplacements.dictRepresented,
+      associates: all ? lmAssociates.dictRepresented : [:]
+    )
+  }
+}

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/PinyinPhonaConverter.swift

@@ -0,0 +1,123 @@
+// (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 Foundation
+
+// 該檔案使得 LMAssembly 擺脫對 Tekkon 的依賴。
+
+private typealias LengthSortedDictionary = [Int: [String: String]]
+
+private let mapHanyuPinyinToPhonabets: LengthSortedDictionary = {
+  let parsed = try? JSONDecoder().decode(LengthSortedDictionary.self, from: jsnHanyuPinyinToMPS.data(using: .utf8) ?? Data([]))
+  return parsed ?? [:]
+}()
+
+extension String {
+  mutating func convertToPhonabets(newToneOne: String = "") {
+    if isEmpty || contains("_") || !isNotPureAlphanumerical { return }
+    let lengths = mapHanyuPinyinToPhonabets.keys.sorted().reversed()
+    lengths.forEach { length in
+      mapHanyuPinyinToPhonabets[length]?.forEach { key, value in
+        self = replacingOccurrences(of: key, with: value)
+      }
+    }
+    self = replacingOccurrences(of: " ", with: newToneOne)
+  }
+}
+
+/// 檢測字串是否包含半形英數內容
+private extension String {
+  var isNotPureAlphanumerical: Bool {
+    let regex = ".*[^A-Za-z0-9].*"
+    let testString = NSPredicate(format: "SELF MATCHES %@", regex)
+    return testString.evaluate(with: self)
+  }
+}
+
+private let jsnHanyuPinyinToMPS = #"""
+{
+"1":{"1":" ","2":"ˊ","3":"ˇ","4":"ˋ","5":"˙","a":"ㄚ","e":"ㄜ","o":"ㄛ","q":"ㄑ"},
+"2":{"ai":"ㄞ","an":"ㄢ","ao":"ㄠ","ba":"ㄅㄚ","bi":"ㄅㄧ","bo":"ㄅㄛ","bu":"ㄅㄨ",
+  "ca":"ㄘㄚ","ce":"ㄘㄜ","ci":"ㄘ","cu":"ㄘㄨ","da":"ㄉㄚ","de":"ㄉㄜ","di":"ㄉㄧ",
+  "du":"ㄉㄨ","eh":"ㄝ","ei":"ㄟ","en":"ㄣ","er":"ㄦ","fa":"ㄈㄚ","fo":"ㄈㄛ",
+  "fu":"ㄈㄨ","ga":"ㄍㄚ","ge":"ㄍㄜ","gi":"ㄍㄧ","gu":"ㄍㄨ","ha":"ㄏㄚ","he":"ㄏㄜ",
+  "hu":"ㄏㄨ","ji":"ㄐㄧ","ju":"ㄐㄩ","ka":"ㄎㄚ","ke":"ㄎㄜ","ku":"ㄎㄨ","la":"ㄌㄚ",
+  "le":"ㄌㄜ","li":"ㄌㄧ","lo":"ㄌㄛ","lu":"ㄌㄨ","lv":"ㄌㄩ","ma":"ㄇㄚ","me":"ㄇㄜ",
+  "mi":"ㄇㄧ","mo":"ㄇㄛ","mu":"ㄇㄨ","na":"ㄋㄚ","ne":"ㄋㄜ","ni":"ㄋㄧ","nu":"ㄋㄨ",
+  "nv":"ㄋㄩ","ou":"ㄡ","pa":"ㄆㄚ","pi":"ㄆㄧ","po":"ㄆㄛ","pu":"ㄆㄨ","qi":"ㄑㄧ",
+  "qu":"ㄑㄩ","re":"ㄖㄜ","ri":"ㄖ","ru":"ㄖㄨ","sa":"ㄙㄚ","se":"ㄙㄜ","si":"ㄙ",
+  "su":"ㄙㄨ","ta":"ㄊㄚ","te":"ㄊㄜ","ti":"ㄊㄧ","tu":"ㄊㄨ","wa":"ㄨㄚ","wo":"ㄨㄛ",
+  "wu":"ㄨ","xi":"ㄒㄧ","xu":"ㄒㄩ","ya":"ㄧㄚ","ye":"ㄧㄝ","yi":"ㄧ","yo":"ㄧㄛ",
+  "yu":"ㄩ","za":"ㄗㄚ","ze":"ㄗㄜ","zi":"ㄗ","zu":"ㄗㄨ"},
+"3":{"ang":"ㄤ","bai":"ㄅㄞ","ban":"ㄅㄢ","bao":"ㄅㄠ","bei":"ㄅㄟ","ben":"ㄅㄣ",
+  "bie":"ㄅㄧㄝ","bin":"ㄅㄧㄣ","cai":"ㄘㄞ","can":"ㄘㄢ","cao":"ㄘㄠ","cei":"ㄘㄟ",
+  "cen":"ㄘㄣ","cha":"ㄔㄚ","che":"ㄔㄜ","chi":"ㄔ","chu":"ㄔㄨ","cou":"ㄘㄡ",
+  "cui":"ㄘㄨㄟ","cun":"ㄘㄨㄣ","cuo":"ㄘㄨㄛ","dai":"ㄉㄞ","dan":"ㄉㄢ","dao":"ㄉㄠ",
+  "dei":"ㄉㄟ","den":"ㄉㄣ","dia":"ㄉㄧㄚ","die":"ㄉㄧㄝ","diu":"ㄉㄧㄡ","dou":"ㄉㄡ",
+  "dui":"ㄉㄨㄟ","dun":"ㄉㄨㄣ","duo":"ㄉㄨㄛ","eng":"ㄥ","fan":"ㄈㄢ","fei":"ㄈㄟ",
+  "fen":"ㄈㄣ","fou":"ㄈㄡ","gai":"ㄍㄞ","gan":"ㄍㄢ","gao":"ㄍㄠ","gei":"ㄍㄟ",
+  "gen":"ㄍㄣ","gin":"ㄍㄧㄣ","gou":"ㄍㄡ","gua":"ㄍㄨㄚ","gue":"ㄍㄨㄜ","gui":"ㄍㄨㄟ",
+  "gun":"ㄍㄨㄣ","guo":"ㄍㄨㄛ","hai":"ㄏㄞ","han":"ㄏㄢ","hao":"ㄏㄠ","hei":"ㄏㄟ",
+  "hen":"ㄏㄣ","hou":"ㄏㄡ","hua":"ㄏㄨㄚ","hui":"ㄏㄨㄟ","hun":"ㄏㄨㄣ","huo":"ㄏㄨㄛ",
+  "jia":"ㄐㄧㄚ","jie":"ㄐㄧㄝ","jin":"ㄐㄧㄣ","jiu":"ㄐㄧㄡ","jue":"ㄐㄩㄝ",
+  "jun":"ㄐㄩㄣ","kai":"ㄎㄞ","kan":"ㄎㄢ","kao":"ㄎㄠ","ken":"ㄎㄣ","kiu":"ㄎㄧㄡ",
+  "kou":"ㄎㄡ","kua":"ㄎㄨㄚ","kui":"ㄎㄨㄟ","kun":"ㄎㄨㄣ","kuo":"ㄎㄨㄛ","lai":"ㄌㄞ",
+  "lan":"ㄌㄢ","lao":"ㄌㄠ","lei":"ㄌㄟ","lia":"ㄌㄧㄚ","lie":"ㄌㄧㄝ","lin":"ㄌㄧㄣ",
+  "liu":"ㄌㄧㄡ","lou":"ㄌㄡ","lun":"ㄌㄨㄣ","luo":"ㄌㄨㄛ","lve":"ㄌㄩㄝ","mai":"ㄇㄞ",
+  "man":"ㄇㄢ","mao":"ㄇㄠ","mei":"ㄇㄟ","men":"ㄇㄣ","mie":"ㄇㄧㄝ","min":"ㄇㄧㄣ",
+  "miu":"ㄇㄧㄡ","mou":"ㄇㄡ","nai":"ㄋㄞ","nan":"ㄋㄢ","nao":"ㄋㄠ","nei":"ㄋㄟ",
+  "nen":"ㄋㄣ","nie":"ㄋㄧㄝ","nin":"ㄋㄧㄣ","niu":"ㄋㄧㄡ","nou":"ㄋㄡ","nui":"ㄋㄨㄟ",
+  "nun":"ㄋㄨㄣ","nuo":"ㄋㄨㄛ","nve":"ㄋㄩㄝ","pai":"ㄆㄞ","pan":"ㄆㄢ","pao":"ㄆㄠ",
+  "pei":"ㄆㄟ","pen":"ㄆㄣ","pia":"ㄆㄧㄚ","pie":"ㄆㄧㄝ","pin":"ㄆㄧㄣ","pou":"ㄆㄡ",
+  "qia":"ㄑㄧㄚ","qie":"ㄑㄧㄝ","qin":"ㄑㄧㄣ","qiu":"ㄑㄧㄡ","que":"ㄑㄩㄝ",
+  "qun":"ㄑㄩㄣ","ran":"ㄖㄢ","rao":"ㄖㄠ","ren":"ㄖㄣ","rou":"ㄖㄡ","rui":"ㄖㄨㄟ",
+  "run":"ㄖㄨㄣ","ruo":"ㄖㄨㄛ","sai":"ㄙㄞ","san":"ㄙㄢ","sao":"ㄙㄠ","sei":"ㄙㄟ",
+  "sen":"ㄙㄣ","sha":"ㄕㄚ","she":"ㄕㄜ","shi":"ㄕ","shu":"ㄕㄨ","sou":"ㄙㄡ",
+  "sui":"ㄙㄨㄟ","sun":"ㄙㄨㄣ","suo":"ㄙㄨㄛ","tai":"ㄊㄞ","tan":"ㄊㄢ","tao":"ㄊㄠ",
+  "tie":"ㄊㄧㄝ","tou":"ㄊㄡ","tui":"ㄊㄨㄟ","tun":"ㄊㄨㄣ","tuo":"ㄊㄨㄛ",
+  "wai":"ㄨㄞ","wan":"ㄨㄢ","wei":"ㄨㄟ","wen":"ㄨㄣ","xia":"ㄒㄧㄚ","xie":"ㄒㄧㄝ",
+  "xin":"ㄒㄧㄣ","xiu":"ㄒㄧㄡ","xue":"ㄒㄩㄝ","xun":"ㄒㄩㄣ","yai":"ㄧㄞ",
+  "yan":"ㄧㄢ","yao":"ㄧㄠ","yin":"ㄧㄣ","you":"ㄧㄡ","yue":"ㄩㄝ","yun":"ㄩㄣ",
+  "zai":"ㄗㄞ","zan":"ㄗㄢ","zao":"ㄗㄠ","zei":"ㄗㄟ","zen":"ㄗㄣ","zha":"ㄓㄚ",
+  "zhe":"ㄓㄜ","zhi":"ㄓ","zhu":"ㄓㄨ","zou":"ㄗㄡ","zui":"ㄗㄨㄟ","zun":"ㄗㄨㄣ",
+  "zuo":"ㄗㄨㄛ"},
+"4":{"bang":"ㄅㄤ","beng":"ㄅㄥ","bian":"ㄅㄧㄢ","biao":"ㄅㄧㄠ","bing":"ㄅㄧㄥ",
+  "cang":"ㄘㄤ","ceng":"ㄘㄥ","chai":"ㄔㄞ","chan":"ㄔㄢ","chao":"ㄔㄠ","chen":"ㄔㄣ",
+  "chou":"ㄔㄡ","chua":"ㄔㄨㄚ","chui":"ㄔㄨㄟ","chun":"ㄔㄨㄣ","chuo":"ㄔㄨㄛ",
+  "cong":"ㄘㄨㄥ","cuan":"ㄘㄨㄢ","dang":"ㄉㄤ","deng":"ㄉㄥ","dian":"ㄉㄧㄢ",
+  "diao":"ㄉㄧㄠ","ding":"ㄉㄧㄥ","dong":"ㄉㄨㄥ","duan":"ㄉㄨㄢ","fang":"ㄈㄤ",
+  "feng":"ㄈㄥ","fiao":"ㄈㄧㄠ","fong":"ㄈㄨㄥ","gang":"ㄍㄤ","geng":"ㄍㄥ",
+  "giao":"ㄍㄧㄠ","gong":"ㄍㄨㄥ","guai":"ㄍㄨㄞ","guan":"ㄍㄨㄢ","hang":"ㄏㄤ",
+  "heng":"ㄏㄥ","hong":"ㄏㄨㄥ","huai":"ㄏㄨㄞ","huan":"ㄏㄨㄢ","jian":"ㄐㄧㄢ",
+  "jiao":"ㄐㄧㄠ","jing":"ㄐㄧㄥ","juan":"ㄐㄩㄢ","kang":"ㄎㄤ","keng":"ㄎㄥ",
+  "kong":"ㄎㄨㄥ","kuai":"ㄎㄨㄞ","kuan":"ㄎㄨㄢ","lang":"ㄌㄤ","leng":"ㄌㄥ",
+  "lian":"ㄌㄧㄢ","liao":"ㄌㄧㄠ","ling":"ㄌㄧㄥ","long":"ㄌㄨㄥ","luan":"ㄌㄨㄢ",
+  "lvan":"ㄌㄩㄢ","mang":"ㄇㄤ","meng":"ㄇㄥ","mian":"ㄇㄧㄢ","miao":"ㄇㄧㄠ",
+  "ming":"ㄇㄧㄥ","nang":"ㄋㄤ","neng":"ㄋㄥ","nian":"ㄋㄧㄢ","niao":"ㄋㄧㄠ",
+  "ning":"ㄋㄧㄥ","nong":"ㄋㄨㄥ","nuan":"ㄋㄨㄢ","pang":"ㄆㄤ","peng":"ㄆㄥ",
+  "pian":"ㄆㄧㄢ","piao":"ㄆㄧㄠ","ping":"ㄆㄧㄥ","qian":"ㄑㄧㄢ","qiao":"ㄑㄧㄠ",
+  "qing":"ㄑㄧㄥ","quan":"ㄑㄩㄢ","rang":"ㄖㄤ","reng":"ㄖㄥ","rong":"ㄖㄨㄥ",
+  "ruan":"ㄖㄨㄢ","sang":"ㄙㄤ","seng":"ㄙㄥ","shai":"ㄕㄞ","shan":"ㄕㄢ",
+  "shao":"ㄕㄠ","shei":"ㄕㄟ","shen":"ㄕㄣ","shou":"ㄕㄡ","shua":"ㄕㄨㄚ",
+  "shui":"ㄕㄨㄟ","shun":"ㄕㄨㄣ","shuo":"ㄕㄨㄛ","song":"ㄙㄨㄥ","suan":"ㄙㄨㄢ",
+  "tang":"ㄊㄤ","teng":"ㄊㄥ","tian":"ㄊㄧㄢ","tiao":"ㄊㄧㄠ","ting":"ㄊㄧㄥ",
+  "tong":"ㄊㄨㄥ","tuan":"ㄊㄨㄢ","wang":"ㄨㄤ","weng":"ㄨㄥ","xian":"ㄒㄧㄢ",
+  "xiao":"ㄒㄧㄠ","xing":"ㄒㄧㄥ","xuan":"ㄒㄩㄢ","yang":"ㄧㄤ","ying":"ㄧㄥ",
+  "yong":"ㄩㄥ","yuan":"ㄩㄢ","zang":"ㄗㄤ","zeng":"ㄗㄥ","zhai":"ㄓㄞ",
+  "zhan":"ㄓㄢ","zhao":"ㄓㄠ","zhei":"ㄓㄟ","zhen":"ㄓㄣ","zhou":"ㄓㄡ",
+  "zhua":"ㄓㄨㄚ","zhui":"ㄓㄨㄟ","zhun":"ㄓㄨㄣ","zhuo":"ㄓㄨㄛ",
+  "zong":"ㄗㄨㄥ","zuan":"ㄗㄨㄢ"},
+"5":{"biang":"ㄅㄧㄤ","chang":"ㄔㄤ","cheng":"ㄔㄥ","chong":"ㄔㄨㄥ","chuai":"ㄔㄨㄞ",
+  "chuan":"ㄔㄨㄢ","duang":"ㄉㄨㄤ","guang":"ㄍㄨㄤ","huang":"ㄏㄨㄤ","jiang":"ㄐㄧㄤ",
+  "jiong":"ㄐㄩㄥ","kiang":"ㄎㄧㄤ","kuang":"ㄎㄨㄤ","liang":"ㄌㄧㄤ","niang":"ㄋㄧㄤ",
+  "qiang":"ㄑㄧㄤ","qiong":"ㄑㄩㄥ","shang":"ㄕㄤ","sheng":"ㄕㄥ","shuai":"ㄕㄨㄞ",
+  "shuan":"ㄕㄨㄢ","xiang":"ㄒㄧㄤ","xiong":"ㄒㄩㄥ","zhang":"ㄓㄤ","zheng":"ㄓㄥ",
+  "zhong":"ㄓㄨㄥ","zhuai":"ㄓㄨㄞ","zhuan":"ㄓㄨㄢ"},
+"6":{"chuang":"ㄔㄨㄤ","shuang":"ㄕㄨㄤ","zhuang":"ㄓㄨㄤ"}
+}
+"""#

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/SubLMs/lmAssociates.swift

@@ -7,13 +7,11 @@
 // requirements defined in MIT License.
 
 import Megrez
-import PinyinPhonaConverter
-import Shared
 
-public extension vChewingLM {
-  @frozen struct LMAssociates {
+extension LMAssembly {
+  struct LMAssociates {
     public private(set) var filePath: String?
-    var rangeMap: [String: [(Range<String.Index>, Int)]] = [:]
+    var rangeMap: [String: [(Range<String.Index>, Int)]] = [:] // Range 只可能是一整行，所以必須得有 index。
     var strData: String = ""
 
     public var count: Int { rangeMap.count }
@@ -48,8 +46,8 @@ public extension vChewingLM {
         replaceData(textData: rawStrData)
       } catch {
         filePath = oldPath
-        vCLog("\(error)")
-        vCLog("↑ Exception happened when reading data at: \(path).")
+        vCLMLog("\(error)")
+        vCLMLog("↑ Exception happened when reading data at: \(path).")
         return false
       }
 
@@ -93,28 +91,21 @@ public extension vChewingLM {
       do {
         try strData.write(toFile: filePath, atomically: true, encoding: .utf8)
       } catch {
-        vCLog("Failed to save current database to: \(filePath)")
+        vCLMLog("Failed to save current database to: \(filePath)")
       }
     }
 
     public func valuesFor(pair: Megrez.KeyValuePaired) -> [String] {
       var pairs: [String] = []
-      if let arrRangeRecords: [(Range<String.Index>, Int)] = rangeMap[pair.toNGramKey] {
-        for (netaRange, index) in arrRangeRecords {
+      let availableResults = [rangeMap[pair.toNGramKey], rangeMap[pair.value]].compactMap { $0 }
+      availableResults.forEach { arrRangeRecords in
+        arrRangeRecords.forEach { netaRange, index in
           let neta = strData[netaRange].split(separator: " ")
           let theValue: String = .init(neta[index])
           pairs.append(theValue)
         }
       }
-      if let arrRangeRecords: [(Range<String.Index>, Int)] = rangeMap[pair.value] {
-        for (netaRange, index) in arrRangeRecords {
-          let neta = strData[netaRange].split(separator: " ")
-          let theValue: String = .init(neta[index])
-          pairs.append(theValue)
-        }
-      }
-      var set = Set<String>()
-      return pairs.filter { set.insert($0).inserted }
+      return pairs.deduplicated
     }
 
     public func hasValuesFor(pair: Megrez.KeyValuePaired) -> Bool {
@@ -123,3 +114,17 @@ public extension vChewingLM {
     }
   }
 }
+
+extension LMAssembly.LMAssociates {
+  var dictRepresented: [String: [String]] {
+    var result = [String: [String]]()
+    rangeMap.forEach { key, arrRangeRecords in
+      arrRangeRecords.forEach { netaRange, index in
+        let neta = strData[netaRange].split(separator: " ")
+        let theValue: String = .init(neta[index])
+        result[key, default: []].append(theValue)
+      }
+    }
+    return result
+  }
+}

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/SubLMs/lmCassette.swift

@@ -10,11 +10,10 @@
 import Foundation
 import LineReader
 import Megrez
-import Shared
 
-public extension vChewingLM {
+extension LMAssembly {
   /// 磁帶模組，用來方便使用者自行擴充字根輸入法。
-  @frozen struct LMCassette {
+  struct LMCassette {
     public private(set) var filePath: String?
     public private(set) var nameShort: String = ""
     public private(set) var nameENG: String = ""
@@ -40,12 +39,13 @@ public extension vChewingLM {
     public private(set) var areCandidateKeysShiftHeld: Bool = false
     public private(set) var supplyQuickResults: Bool = false
     public private(set) var supplyPartiallyMatchedResults: Bool = false
+    public var candidateKeysValidator: (String) -> Bool = { _ in false }
     /// 計算頻率時要用到的東西 - NORM
     private var norm = 0.0
   }
 }
 
-public extension vChewingLM.LMCassette {
+extension LMAssembly.LMCassette {
   /// 計算頻率時要用到的東西 - fscale
   private static let fscale = 2.7
   /// 萬用花牌字符，哪怕花牌鍵仍不可用。
@@ -86,7 +86,7 @@ public extension vChewingLM.LMCassette {
     if FileManager.default.fileExists(atPath: path) {
       do {
         guard let fileHandle = FileHandle(forReadingAtPath: path) else {
-          throw vChewingLM.FileErrors.fileHandleError("")
+          throw LMAssembly.FileErrors.fileHandleError("")
         }
         let lineReader = try LineReader(file: fileHandle)
         var theMaxKeyLength = 1
@@ -193,7 +193,9 @@ public extension vChewingLM.LMCassette {
           }
         }
         // Post process.
-        if CandidateKey.validate(keys: selectionKeys) != nil { selectionKeys = "1234567890" }
+        // 備註：因為 Package 層級嵌套的現狀，此處不太方便檢查是否需要篩掉 J / K 鍵。
+        // 因此只能在其他地方做篩檢。
+        if !candidateKeysValidator(selectionKeys) { selectionKeys = "1234567890" }
         if !keysUsedInCharDef.intersection(selectionKeys.map(\.description)).isEmpty {
           areCandidateKeysShiftHeld = true
         }
@@ -202,10 +204,10 @@ public extension vChewingLM.LMCassette {
         filePath = path
         return true
       } catch {
-        vCLog("CIN Loading Failed: File Access Error.")
+        vCLMLog("CIN Loading Failed: File Access Error.")
       }
     } else {
-      vCLog("CIN Loading Failed: File Missing.")
+      vCLMLog("CIN Loading Failed: File Missing.")
     }
     filePath = oldPath
     return false

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/SubLMs/lmCoreEX.swift

@@ -7,15 +7,13 @@
 // requirements defined in MIT License.
 
 import Megrez
-import PinyinPhonaConverter
-import Shared
 
-public extension vChewingLM {
+extension LMAssembly {
   /// 與之前的 LMCore 不同，LMCoreEX 不在辭典內記錄實體，而是記錄 range 範圍。
   /// 需要資料的時候，直接拿 range 去 strData 取資料。
   /// 資料記錄原理與上游 C++ 的 ParselessLM 差不多，但用的是 Swift 原生手段。
   /// 主要時間消耗仍在 For 迴圈，但這個算法可以顯著減少記憶體佔用。
-  @frozen struct LMCoreEX {
+  struct LMCoreEX {
     public private(set) var filePath: String?
     /// 資料庫辭典。索引內容為注音字串，資料內容則為字串首尾範圍、方便自 strData 取資料。
     var rangeMap: [String: [Range<String.Index>]] = [:]
@@ -81,8 +79,8 @@ public extension vChewingLM {
         replaceData(textData: rawStrData)
       } catch {
         filePath = oldPath
-        vCLog("\(error)")
-        vCLog("↑ Exception happened when reading data at: \(path).")
+        vCLMLog("\(error)")
+        vCLMLog("↑ Exception happened when reading data at: \(path).")
         return false
       }
 
@@ -133,7 +131,7 @@ public extension vChewingLM {
         }
         try dataToWrite.write(toFile: filePath, atomically: true, encoding: .utf8)
       } catch {
-        vCLog("Failed to save current database to: \(filePath)")
+        vCLMLog("Failed to save current database to: \(filePath)")
       }
     }
 
@@ -150,7 +148,7 @@ public extension vChewingLM {
           strDump += addline
         }
       }
-      vCLog(strDump)
+      vCLMLog(strDump)
     }
 
     /// 根據給定的讀音索引鍵，來獲取資料庫辭典內的對應資料陣列的字串首尾範圍資料、據此自 strData 取得字串形式的資料、生成單元圖陣列。
@@ -186,3 +184,15 @@ public extension vChewingLM {
     }
   }
 }
+
+extension LMAssembly.LMCoreEX {
+  var dictRepresented: [String: [String]] {
+    var result = [String: [String]]()
+    rangeMap.forEach { key, arrValueRanges in
+      result[key, default: []] = arrValueRanges.map { currentRange in
+        strData[currentRange].description
+      }
+    }
+    return result
+  }
+}

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/SubLMs/lmPlainBopomofo.swift

@@ -7,67 +7,36 @@
 // requirements defined in MIT License.
 
 import Foundation
-import Shared
 
-public extension vChewingLM {
-  @frozen struct LMPlainBopomofo {
-    public private(set) var filePath: String?
-    var dataMap: [String: String] = [:]
+extension LMAssembly {
+  struct LMPlainBopomofo {
+    @usableFromInline typealias DataMap = [String: [String: String]]
+    let dataMap: DataMap
 
     public var count: Int { dataMap.count }
 
     public init() {
-      dataMap = [:]
+      do {
+        let rawData = jsnEtenDosSequence.data(using: .utf8) ?? .init([])
+        let rawJSON = try JSONDecoder().decode([String: [String: String]].self, from: rawData)
+        dataMap = rawJSON
+      } catch {
+        vCLMLog("\(error)")
+        vCLMLog("↑ Exception happened when parsing raw JSON sequence data from vChewing LMAssembly.")
+        dataMap = [:]
+      }
     }
 
     public var isLoaded: Bool { !dataMap.isEmpty }
 
-    @discardableResult public mutating func open(_ path: String) -> Bool {
-      if isLoaded { return false }
-      let oldPath = filePath
-      filePath = nil
-
-      do {
-        let rawData = try Data(contentsOf: URL(fileURLWithPath: path))
-        if let rawJSON = try? JSONSerialization.jsonObject(with: rawData) as? [String: String] {
-          dataMap = rawJSON
-        } else {
-          filePath = oldPath
-          vCLog("↑ Exception happened when reading JSON file at: \(path).")
-          return false
-        }
-      } catch {
-        filePath = oldPath
-        vCLog("\(error)")
-        vCLog("↑ Exception happened when reading JSON file at: \(path).")
-        return false
-      }
-
-      filePath = path
-      return true
-    }
-
-    public mutating func clear() {
-      filePath = nil
-      dataMap.removeAll()
-    }
-
-    public func saveData() {
-      guard let filePath = filePath, let plistURL = URL(string: filePath) else { return }
-      do {
-        let plistData = try PropertyListSerialization.data(fromPropertyList: dataMap, format: .binary, options: 0)
-        try plistData.write(to: plistURL)
-      } catch {
-        vCLog("Failed to save current database to: \(filePath)")
-      }
-    }
-
-    public func valuesFor(key: String) -> [String] {
+    public func valuesFor(key: String, isCHS: Bool) -> [String] {
       var pairs: [String] = []
-      if let arrRangeRecords: String = dataMap[key]?.trimmingCharacters(in: .newlines) {
+      let subKey = isCHS ? "S" : "T"
+      if let arrRangeRecords: String = dataMap[key]?[subKey] {
         pairs.append(contentsOf: arrRangeRecords.map(\.description))
       }
-      return pairs.deduplicated
+      // 這裡不做去重複處理，因為倚天中文系統注音排序適應者們已經形成了肌肉記憶。
+      return pairs
     }
 
     public func hasValuesFor(key: String) -> Bool { dataMap.keys.contains(key) }

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/SubLMs/lmReplacements.swift

@@ -6,10 +6,8 @@
 // marks, or product names of Contributor, except as required to fulfill notice
 // requirements defined in MIT License.
 
-import Shared
-
-public extension vChewingLM {
-  @frozen struct LMReplacements {
+extension LMAssembly {
+  struct LMReplacements {
     public private(set) var filePath: String?
     var rangeMap: [String: Range<String.Index>] = [:]
     var strData: String = ""
@@ -35,8 +33,8 @@ public extension vChewingLM {
         replaceData(textData: rawStrData)
       } catch {
         filePath = oldPath
-        vCLog("\(error)")
-        vCLog("↑ Exception happened when reading data at: \(path).")
+        vCLMLog("\(error)")
+        vCLMLog("↑ Exception happened when reading data at: \(path).")
         return false
       }
 
@@ -72,7 +70,7 @@ public extension vChewingLM {
       do {
         try strData.write(toFile: filePath, atomically: true, encoding: .utf8)
       } catch {
-        vCLog("Failed to save current database to: \(filePath)")
+        vCLMLog("Failed to save current database to: \(filePath)")
       }
     }
 
@@ -81,7 +79,7 @@ public extension vChewingLM {
       for entry in rangeMap {
         strDump += strData[entry.value] + "\n"
       }
-      vCLog(strDump)
+      vCLMLog(strDump)
     }
 
     public func valuesFor(key: String) -> String {
@@ -100,3 +98,13 @@ public extension vChewingLM {
     }
   }
 }
+
+extension LMAssembly.LMReplacements {
+  var dictRepresented: [String: String] {
+    var result = [String: String]()
+    rangeMap.forEach { key, valueRange in
+      result[key] = strData[valueRange].description
+    }
+    return result
+  }
+}

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/SubLMs/lmRevLookup.swift

@@ -1,76 +0,0 @@
-// (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 Foundation
-import Shared
-
-public extension vChewingLM {
-  @frozen struct LMRevLookup {
-    public private(set) var dataMap: [String: [String]] = [:]
-    public private(set) var filePath: String = ""
-
-    public init(data dictData: (dict: [String: [String]]?, path: String)) {
-      guard let theDict = dictData.dict else {
-        vCLog("↑ Exception happened when reading JSON file at: \(dictData.path).")
-        return
-      }
-      filePath = dictData.path
-      dataMap = theDict
-    }
-
-    public init(path: String) {
-      if path.isEmpty { return }
-      do {
-        let rawData = try Data(contentsOf: URL(fileURLWithPath: path))
-        if let rawJSON = try? JSONSerialization.jsonObject(with: rawData) as? [String: [String]] {
-          dataMap = rawJSON
-        } else {
-          vCLog("↑ Exception happened when reading JSON file at: \(path).")
-          return
-        }
-      } catch {
-        vCLog("↑ Exception happened when reading JSON file at: \(path).")
-        return
-      }
-      filePath = path
-    }
-
-    public func query(with kanji: String) -> [String]? {
-      guard let resultData = dataMap[kanji] else { return nil }
-      let resultArray = resultData.compactMap {
-        let result = restorePhonabetFromASCII($0)
-        return result.isEmpty ? nil : result
-      }
-      return resultArray.isEmpty ? nil : resultArray
-    }
-
-    /// 內部函式，用以將被加密的注音讀音索引鍵進行解密。
-    ///
-    /// 如果傳入的字串當中包含 ASCII 下畫線符號的話，則表明該字串並非注音讀音字串，會被忽略處理。
-    /// - parameters:
-    ///   - incoming: 傳入的已加密注音讀音字串。
-    func restorePhonabetFromASCII(_ incoming: String) -> String {
-      var strOutput = incoming
-      if !strOutput.contains("_") {
-        for entry in Self.dicPhonabet4ASCII {
-          strOutput = strOutput.replacingOccurrences(of: entry.key, with: entry.value)
-        }
-      }
-      return strOutput
-    }
-
-    // MARK: - Constants
-
-    static let dicPhonabet4ASCII: [String: String] = [
-      "b": "ㄅ", "p": "ㄆ", "m": "ㄇ", "f": "ㄈ", "d": "ㄉ", "t": "ㄊ", "n": "ㄋ", "l": "ㄌ", "g": "ㄍ", "k": "ㄎ", "h": "ㄏ",
-      "j": "ㄐ", "q": "ㄑ", "x": "ㄒ", "Z": "ㄓ", "C": "ㄔ", "S": "ㄕ", "r": "ㄖ", "z": "ㄗ", "c": "ㄘ", "s": "ㄙ", "i": "ㄧ",
-      "u": "ㄨ", "v": "ㄩ", "a": "ㄚ", "o": "ㄛ", "e": "ㄜ", "E": "ㄝ", "B": "ㄞ", "P": "ㄟ", "M": "ㄠ", "F": "ㄡ", "D": "ㄢ",
-      "T": "ㄣ", "N": "ㄤ", "L": "ㄥ", "R": "ㄦ", "2": "ˊ", "3": "ˇ", "4": "ˋ", "5": "˙",
-    ]
-  }
-}

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/SubLMs/lmUserOverride.swift

@@ -9,74 +9,41 @@
 
 import Foundation
 import Megrez
-import Shared
 
-public extension vChewingLM {
+// MARK: - Public Types.
+
+public extension LMAssembly {
+  struct OverrideSuggestion {
+    public var candidates = [(String, Megrez.Unigram)]()
+    public var forceHighScoreOverride = false
+    public var isEmpty: Bool { candidates.isEmpty }
+  }
+}
+
+// MARK: - LMUserOverride Class Definition.
+
+extension LMAssembly {
   class LMUserOverride {
-    // MARK: - Main
-
     var mutCapacity: Int
     var mutDecayExponent: Double
     var mutLRUList: [KeyObservationPair] = []
     var mutLRUMap: [String: KeyObservationPair] = [:]
     let kDecayThreshold: Double = 1.0 / 1_048_576.0 // 衰減二十次之後差不多就失效了。
-    var fileSaveLocationURL: URL
+    var fileSaveLocationURL: URL?
 
     public static let kObservedOverrideHalfLife: Double = 3600.0 * 6 // 6 小時半衰一次，能持續不到六天的記憶。
 
-    public init(capacity: Int = 500, decayConstant: Double = LMUserOverride.kObservedOverrideHalfLife, dataURL: URL) {
+    public init(capacity: Int = 500, decayConstant: Double = LMUserOverride.kObservedOverrideHalfLife, dataURL: URL? = nil) {
       mutCapacity = max(capacity, 1) // Ensures that this integer value is always > 0.
       mutDecayExponent = log(0.5) / decayConstant
       fileSaveLocationURL = dataURL
     }
-
-    public func performObservation(
-      walkedBefore: [Megrez.Node], walkedAfter: [Megrez.Node],
-      cursor: Int, timestamp: Double, saveCallback: @escaping () -> Void
-    ) {
-      // 參數合規性檢查。
-      guard !walkedAfter.isEmpty, !walkedBefore.isEmpty else { return }
-      guard walkedBefore.totalKeyCount == walkedAfter.totalKeyCount else { return }
-      // 先判斷用哪種覆寫方法。
-      var actualCursor = 0
-      guard let currentNode = walkedAfter.findNode(at: cursor, target: &actualCursor) else { return }
-      // 當前節點超過三個字的話，就不記憶了。在這種情形下，使用者可以考慮新增自訂語彙。
-      guard currentNode.spanLength <= 3 else { return }
-      // 前一個節點得從前一次爬軌結果當中來找。
-      guard actualCursor > 0 else { return } // 該情況應該不會出現。
-      let currentNodeIndex = actualCursor
-      actualCursor -= 1
-      var prevNodeIndex = 0
-      guard let prevNode = walkedBefore.findNode(at: actualCursor, target: &prevNodeIndex) else { return }
-
-      let forceHighScoreOverride: Bool = currentNode.spanLength > prevNode.spanLength
-      let breakingUp = currentNode.spanLength == 1 && prevNode.spanLength > 1
-
-      let targetNodeIndex = breakingUp ? currentNodeIndex : prevNodeIndex
-      let key: String = vChewingLM.LMUserOverride.formObservationKey(
-        walkedNodes: walkedAfter, headIndex: targetNodeIndex
-      )
-      guard !key.isEmpty else { return }
-      doObservation(
-        key: key, candidate: currentNode.currentUnigram.value, timestamp: timestamp,
-        forceHighScoreOverride: forceHighScoreOverride, saveCallback: { saveCallback() }
-      )
-    }
-
-    public func fetchSuggestion(
-      currentWalk: [Megrez.Node], cursor: Int, timestamp: Double
-    ) -> Suggestion {
-      var headIndex = 0
-      guard let nodeIter = currentWalk.findNode(at: cursor, target: &headIndex) else { return .init() }
-      let key = vChewingLM.LMUserOverride.formObservationKey(walkedNodes: currentWalk, headIndex: headIndex)
-      return getSuggestion(key: key, timestamp: timestamp, headReading: nodeIter.joinedKey())
-    }
   }
 }
 
 // MARK: - Private Structures
 
-extension vChewingLM.LMUserOverride {
+extension LMAssembly.LMUserOverride {
   enum OverrideUnit: CodingKey { case count, timestamp, forceHighScoreOverride }
   enum ObservationUnit: CodingKey { case count, overrides }
   enum KeyObservationPairUnit: CodingKey { case key, observation }
@@ -153,10 +120,52 @@ extension vChewingLM.LMUserOverride {
   }
 }
 
-// MARK: - Hash and Dehash the entire UOM data, etc.
+// MARK: - Internal Methods in LMAssembly.
 
-public extension vChewingLM.LMUserOverride {
-  func bleachSpecifiedSuggestions(targets: [String], saveCallback: @escaping () -> Void) {
+extension LMAssembly.LMUserOverride {
+  func performObservation(
+    walkedBefore: [Megrez.Node], walkedAfter: [Megrez.Node],
+    cursor: Int, timestamp: Double, saveCallback: (() -> Void)? = nil
+  ) {
+    // 參數合規性檢查。
+    guard !walkedAfter.isEmpty, !walkedBefore.isEmpty else { return }
+    guard walkedBefore.totalKeyCount == walkedAfter.totalKeyCount else { return }
+    // 先判斷用哪種覆寫方法。
+    var actualCursor = 0
+    guard let currentNode = walkedAfter.findNode(at: cursor, target: &actualCursor) else { return }
+    // 當前節點超過三個字的話，就不記憶了。在這種情形下，使用者可以考慮新增自訂語彙。
+    guard currentNode.spanLength <= 3 else { return }
+    // 前一個節點得從前一次爬軌結果當中來找。
+    guard actualCursor > 0 else { return } // 該情況應該不會出現。
+    let currentNodeIndex = actualCursor
+    actualCursor -= 1
+    var prevNodeIndex = 0
+    guard let prevNode = walkedBefore.findNode(at: actualCursor, target: &prevNodeIndex) else { return }
+
+    let forceHighScoreOverride: Bool = currentNode.spanLength > prevNode.spanLength
+    let breakingUp = currentNode.spanLength == 1 && prevNode.spanLength > 1
+
+    let targetNodeIndex = breakingUp ? currentNodeIndex : prevNodeIndex
+    let key: String = LMAssembly.LMUserOverride.formObservationKey(
+      walkedNodes: walkedAfter, headIndex: targetNodeIndex
+    )
+    guard !key.isEmpty else { return }
+    doObservation(
+      key: key, candidate: currentNode.currentUnigram.value, timestamp: timestamp,
+      forceHighScoreOverride: forceHighScoreOverride, saveCallback: saveCallback
+    )
+  }
+
+  func fetchSuggestion(
+    currentWalk: [Megrez.Node], cursor: Int, timestamp: Double
+  ) -> LMAssembly.OverrideSuggestion {
+    var headIndex = 0
+    guard let nodeIter = currentWalk.findNode(at: cursor, target: &headIndex) else { return .init() }
+    let key = LMAssembly.LMUserOverride.formObservationKey(walkedNodes: currentWalk, headIndex: headIndex)
+    return getSuggestion(key: key, timestamp: timestamp, headReading: nodeIter.joinedKey())
+  }
+
+  func bleachSpecifiedSuggestions(targets: [String], saveCallback: (() -> Void)? = nil) {
     if targets.isEmpty { return }
     for neta in mutLRUMap {
       for target in targets {
@@ -166,82 +175,86 @@ public extension vChewingLM.LMUserOverride {
       }
     }
     resetMRUList()
-    saveCallback()
+    saveCallback?() ?? saveData()
   }
 
   /// 自 LRU 辭典內移除所有的單元圖。
-  func bleachUnigrams(saveCallback: @escaping () -> Void) {
+  func bleachUnigrams(saveCallback: (() -> Void)? = nil) {
     for key in mutLRUMap.keys {
       if !key.contains("(),()") { continue }
       mutLRUMap.removeValue(forKey: key)
     }
     resetMRUList()
-    saveCallback()
+    saveCallback?() ?? saveData()
   }
 
-  internal func resetMRUList() {
+  func resetMRUList() {
     mutLRUList.removeAll()
     for neta in mutLRUMap.reversed() {
       mutLRUList.append(neta.value)
     }
   }
 
-  func clearData(withURL fileURL: URL) {
+  func clearData(withURL fileURL: URL? = nil) {
     mutLRUMap = .init()
     mutLRUList = .init()
     do {
       let nullData = "{}"
+      guard let fileURL = fileURL ?? fileSaveLocationURL else {
+        throw UOMError(rawValue: "given fileURL is invalid or nil.")
+      }
       try nullData.write(to: fileURL, atomically: false, encoding: .utf8)
     } catch {
-      vCLog("UOM Error: Unable to clear data. Details: \(error)")
+      vCLMLog("UOM Error: Unable to clear the data in the UOM file. Details: \(error)")
       return
     }
   }
 
   func saveData(toURL fileURL: URL? = nil) {
+    guard let fileURL: URL = fileURL ?? fileSaveLocationURL else {
+      vCLMLog("UOM saveData() failed. At least the file Save URL is not set for the current UOM.")
+      return
+    }
     // 此處不要使用 JSONSerialization，不然執行緒會炸掉。
     let encoder = JSONEncoder()
     do {
       guard let jsonData = try? encoder.encode(mutLRUMap) else { return }
-      let fileURL: URL = fileURL ?? fileSaveLocationURL
       try jsonData.write(to: fileURL, options: .atomic)
     } catch {
-      vCLog("UOM Error: Unable to save data, abort saving. Details: \(error)")
+      vCLMLog("UOM Error: Unable to save data, abort saving. Details: \(error)")
       return
     }
   }
 
-  func loadData(fromURL fileURL: URL) {
+  func loadData(fromURL fileURL: URL? = nil) {
+    guard let fileURL: URL = fileURL ?? fileSaveLocationURL else {
+      vCLMLog("UOM loadData() failed. At least the file Load URL is not set for the current UOM.")
+      return
+    }
     // 此處不要使用 JSONSerialization，不然執行緒會炸掉。
     let decoder = JSONDecoder()
     do {
       let data = try Data(contentsOf: fileURL, options: .mappedIfSafe)
       if ["", "{}"].contains(String(data: data, encoding: .utf8)) { return }
       guard let jsonResult = try? decoder.decode([String: KeyObservationPair].self, from: data) else {
-        vCLog("UOM Error: Read file content type invalid, abort loading.")
+        vCLMLog("UOM Error: Read file content type invalid, abort loading.")
         return
       }
       mutLRUMap = jsonResult
       resetMRUList()
     } catch {
-      vCLog("UOM Error: Unable to read file or parse the data, abort loading. Details: \(error)")
+      vCLMLog("UOM Error: Unable to read file or parse the data, abort loading. Details: \(error)")
       return
     }
   }
-
-  struct Suggestion {
-    public var candidates = [(String, Megrez.Unigram)]()
-    public var forceHighScoreOverride = false
-    public var isEmpty: Bool { candidates.isEmpty }
-  }
 }
 
-// MARK: - Private Methods
+// MARK: - Other Non-Public Internal Methods
 
-extension vChewingLM.LMUserOverride {
+extension LMAssembly.LMUserOverride {
   func doObservation(
     key: String, candidate: String, timestamp: Double, forceHighScoreOverride: Bool,
-    saveCallback: @escaping () -> Void
+    saveCallback: (() -> Void)?
   ) {
     guard mutLRUMap[key] != nil else {
       var observation: Observation = .init()
@@ -257,8 +270,8 @@ extension vChewingLM.LMUserOverride {
         mutLRUMap.removeValue(forKey: mutLRUList[mutLRUList.endIndex - 1].key)
         mutLRUList.removeLast()
       }
-      vCLog("UOM: Observation finished with new observation: \(key)")
-      saveCallback()
+      vCLMLog("UOM: Observation finished with new observation: \(key)")
+      saveCallback?() ?? saveData()
       return
     }
     // 這裡還是不要做 decayCallback 判定「是否不急著更新觀察」了，不然會在嘗試覆寫掉錯誤的記憶時失敗。
@@ -268,12 +281,12 @@ extension vChewingLM.LMUserOverride {
       )
       mutLRUList.insert(theNeta, at: 0)
       mutLRUMap[key] = theNeta
-      vCLog("UOM: Observation finished with existing observation: \(key)")
-      saveCallback()
+      vCLMLog("UOM: Observation finished with existing observation: \(key)")
+      saveCallback?() ?? saveData()
     }
   }
 
-  func getSuggestion(key: String, timestamp: Double, headReading: String) -> Suggestion {
+  func getSuggestion(key: String, timestamp: Double, headReading: String) -> LMAssembly.OverrideSuggestion {
     guard !key.isEmpty, let kvPair = mutLRUMap[key] else { return .init() }
     let observation: Observation = kvPair.observation
     var candidates: [(String, Megrez.Unigram)] = .init()
@@ -386,3 +399,10 @@ extension vChewingLM.LMUserOverride {
     return result
   }
 }
+
+struct UOMError: LocalizedError {
+  var rawValue: String
+  var errorDescription: String? {
+    NSLocalizedString("rawValue", comment: "")
+  }
+}

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/TestCoreLMSQLData.swift

@@ -1,9 +1,5 @@
-//
-//  File.swift
-//
-//
-//  Created by ShikiSuen on 2023/11/26.
-//
+// 下述詞頻資料取自 libTaBE 資料庫 (http://sourceforge.net/projects/libtabe/)
+// (2002 最終版). 該專案於 1999 年由 Pai-Hsiang Hsiao 發起、以 BSD 授權發行。
 
 import Foundation
 
@@ -29,6 +25,8 @@ INSERT INTO DATA_MAIN VALUES('de5','-3.516024 的\t-7.427179 得','-3.516024 的
 INSERT INTO DATA_MAIN VALUES('di2','-3.516024 的','-3.516024 的',NULL,NULL,NULL,NULL);
 INSERT INTO DATA_MAIN VALUES('di4','-3.516024 的','-3.516024 的',NULL,NULL,NULL,NULL);
 INSERT INTO DATA_MAIN VALUES('duP3','-9.544 㨃','-9.544 㨃','㨃\t䇏\t𦞙\t謉\t𠡒\t𡑈\t𥫉\t𦞱\t𧫏\t𩛔','','','');
+INSERT INTO DATA_MAIN VALUES('uP','-6.0 危','-6.0 危',NULL,NULL,NULL,NULL); /* 用來測試 CNS 過濾器的。 */
+INSERT INTO DATA_MAIN VALUES('uP2','-6.0 危','-6.0 危','-6.0 危',NULL,NULL,NULL); /* 用來測試 CNS 過濾器的。 */
 INSERT INTO DATA_MAIN VALUES('fL','-11.0 🐝','-11.0 🐝',NULL,NULL,NULL,NULL);
 INSERT INTO DATA_MAIN VALUES('gM','-7.171551 高\t-11.92872 膏\t-13.624335 篙\t-12.390804 糕','-7.171551 高\t-11.92872 膏\t-13.624335 篙\t-12.390804 糕',NULL,NULL,NULL,NULL);
 INSERT INTO DATA_MAIN VALUES('gM-ke-ji4','-9.842421 高科技','-9.842421 高科技',NULL,NULL,NULL,NULL);

Packages/vChewing_LangModelAssembly/Sources/LangModelAssembly/vChewingLMAssembly_Common.swift

@@ -7,10 +7,9 @@
 // requirements defined in MIT License.
 
 import Foundation
-import Shared
 import SQLite3
 
-public enum vChewingLM {
+public enum LMAssembly {
   enum FileErrors: Error {
     case fileHandleError(String)
   }
@@ -51,11 +50,12 @@ extension Array where Element == String {
       assert(looseEnds)
     }
 
-    var ptrStmt: OpaquePointer?
-    defer { sqlite3_finalize(ptrStmt) }
     for strStmt in self {
-      guard sqlite3_prepare_v2(ptrDB, strStmt, -1, &ptrStmt, nil) == SQLITE_OK, sqlite3_step(ptrStmt) == SQLITE_DONE else {
-        vCLog("SQL Query Error. Statement: \(strStmt)")
+      let thisResult = performStatement { ptrStmt in
+        sqlite3_prepare_v2(ptrDB, strStmt, -1, &ptrStmt, nil) == SQLITE_OK && sqlite3_step(ptrStmt) == SQLITE_DONE
+      }
+      guard thisResult else {
+        vCLMLog("SQL Query Error. Statement: \(strStmt)")
         return false
       }
     }
@@ -82,3 +82,13 @@ func performStatementSansResult(_ handler: (inout OpaquePointer?) -> Void) {
   }
   handler(&ptrStmt)
 }
+
+func vCLMLog(_ strPrint: StringLiteralType) {
+  guard let toLog = UserDefaults.standard.object(forKey: "_DebugMode") as? Bool else {
+    NSLog("vChewingDebug: %@", strPrint)
+    return
+  }
+  if toLog {
+    NSLog("vChewingDebug: %@", strPrint)
+  }
+}

Packages/vChewing_LangModelAssembly/Tests/LangModelAssemblyTests/InputTokenTests.swift

@@ -57,10 +57,12 @@ final class InputTokenTests: XCTestCase {
   }
 
   func testGeneratedResultsFromLMInstantiator() throws {
-    let instance = vChewingLM.LMInstantiator(isCHS: true)
-    XCTAssertTrue(vChewingLM.LMInstantiator.connectToTestSQLDB())
-    instance.isCNSEnabled = false
-    instance.isSymbolEnabled = false
+    let instance = LMAssembly.LMInstantiator(isCHS: true)
+    XCTAssertTrue(LMAssembly.LMInstantiator.connectToTestSQLDB())
+    instance.setOptions { config in
+      config.isCNSEnabled = false
+      config.isSymbolEnabled = false
+    }
     instance.insertTemporaryData(
       keyArray: ["ㄐㄧㄣ", "ㄊㄧㄢ", "ㄖˋ", "ㄑㄧˊ"],
       unigram: .init(value: "MACRO@DATE_YEARDELTA:-1945", score: -97.5),
@@ -68,6 +70,6 @@ final class InputTokenTests: XCTestCase {
     )
     let x = instance.unigramsFor(keyArray: ["ㄐㄧㄣ", "ㄊㄧㄢ", "ㄖˋ", "ㄑㄧˊ"]).description
     print(x)
-    vChewingLM.LMInstantiator.disconnectSQLDB()
+    LMAssembly.LMInstantiator.disconnectSQLDB()
   }
 }

Packages/vChewing_LangModelAssembly/Tests/LangModelAssemblyTests/LMCassetteTests.swift

@@ -20,7 +20,7 @@ private let testDataPath: String = packageRootPath + "/Tests/TestCINData/"
 final class LMCassetteTests: XCTestCase {
   func testCassetteLoadWubi86() throws {
     let pathCINFile = testDataPath + "wubi.cin"
-    var lmCassette = vChewingLM.LMCassette()
+    var lmCassette = LMAssembly.LMCassette()
     NSLog("LMCassette: Start loading CIN.")
     lmCassette.open(pathCINFile)
     NSLog("LMCassette: Finished loading CIN. Entries: \(lmCassette.count)")
@@ -41,7 +41,7 @@ final class LMCassetteTests: XCTestCase {
 
   func testCassetteLoadArray30() throws {
     let pathCINFile = testDataPath + "array30.cin2"
-    var lmCassette = vChewingLM.LMCassette()
+    var lmCassette = LMAssembly.LMCassette()
     NSLog("LMCassette: Start loading CIN.")
     lmCassette.open(pathCINFile)
     NSLog("LMCassette: Finished loading CIN. Entries: \(lmCassette.count)")

Packages/vChewing_LangModelAssembly/Tests/LangModelAssemblyTests/LMCoreEXTests.swift

@@ -38,7 +38,7 @@ private let sampleData: String = #"""
 
 final class LMCoreEXTests: XCTestCase {
   func testLMCoreEXAsFactoryCoreDict() throws {
-    var lmTest = vChewingLM.LMCoreEX(
+    var lmTest = LMAssembly.LMCoreEX(
       reverse: false, consolidate: false, defaultScore: 0, forceDefaultScore: false
     )
     lmTest.replaceData(textData: sampleData)

Packages/vChewing_LangModelAssembly/Tests/LangModelAssemblyTests/LMInstantiatorSQLTests.swift

@@ -22,22 +22,43 @@ private let expectedReverseLookupResults: [String] = [
 
 final class LMInstantiatorSQLTests: XCTestCase {
   func testSQL() throws {
-    let instance = vChewingLM.LMInstantiator(isCHS: true)
-    XCTAssertTrue(vChewingLM.LMInstantiator.connectToTestSQLDB())
-    instance.isCNSEnabled = false
-    instance.isSymbolEnabled = false
+    let instance = LMAssembly.LMInstantiator(isCHS: true)
+    XCTAssertTrue(LMAssembly.LMInstantiator.connectToTestSQLDB())
+    instance.setOptions { config in
+      config.isCNSEnabled = false
+      config.isSymbolEnabled = false
+    }
     XCTAssertEqual(instance.unigramsFor(keyArray: strBloatingKey).description, "[(吹牛逼,-7.375), (吹牛屄,-7.399)]")
     XCTAssertEqual(instance.unigramsFor(keyArray: strHaninSymbolMenuKey)[1].description, "(，,-9.9)")
     XCTAssertEqual(instance.unigramsFor(keyArray: strRefutationKey).description, "[(㨃,-9.544)]")
     XCTAssertEqual(instance.unigramsFor(keyArray: strBoobsKey).description, "[(ㄋㄟㄋㄟ,-1.0)]")
-    instance.isCNSEnabled = true
-    instance.isSymbolEnabled = true
+    instance.setOptions { config in
+      config.isCNSEnabled = true
+      config.isSymbolEnabled = true
+    }
     XCTAssertEqual(instance.unigramsFor(keyArray: strBloatingKey).last?.description, "(🌳🆕🐝,-13.0)")
     XCTAssertEqual(instance.unigramsFor(keyArray: strHaninSymbolMenuKey)[1].description, "(，,-9.9)")
     XCTAssertEqual(instance.unigramsFor(keyArray: strRefutationKey).count, 10)
     XCTAssertEqual(instance.unigramsFor(keyArray: strBoobsKey).last?.description, "(☉☉,-13.0)")
     // 再測試反查。
-    XCTAssertEqual(vChewingLM.LMInstantiator.getFactoryReverseLookupData(with: "和"), expectedReverseLookupResults)
-    vChewingLM.LMInstantiator.disconnectSQLDB()
+    XCTAssertEqual(LMAssembly.LMInstantiator.getFactoryReverseLookupData(with: "和"), expectedReverseLookupResults)
+    LMAssembly.LMInstantiator.disconnectSQLDB()
+  }
+
+  func testCNSMask() throws {
+    let instance = LMAssembly.LMInstantiator(isCHS: false)
+    XCTAssertTrue(LMAssembly.LMInstantiator.connectToTestSQLDB())
+    instance.setOptions { config in
+      config.isCNSEnabled = false
+      config.isSymbolEnabled = false
+      config.filterNonCNSReadings = false
+    }
+    XCTAssertEqual(instance.unigramsFor(keyArray: ["ㄨㄟ"]).description, "[(危,-6.0)]")
+    XCTAssertEqual(instance.unigramsFor(keyArray: ["ㄨㄟˊ"]).description, "[(危,-6.0)]")
+    instance.setOptions { config in
+      config.filterNonCNSReadings = true
+    }
+    XCTAssertEqual(instance.unigramsFor(keyArray: ["ㄨㄟ"]).description, "[]")
+    XCTAssertEqual(instance.unigramsFor(keyArray: ["ㄨㄟˊ"]).description, "[(危,-6.0)]")
   }
 }

Packages/vChewing_LangModelAssembly/Tests/LangModelAssemblyTests/LMPlainBPMFTests.swift

@@ -0,0 +1,36 @@
+//// (c) 2021 and onwards The vChewing Project (MIT-NTL License).
+// StringView Ranges extension by (c) 2022 and onwards Isaac Xen (MIT 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 Foundation
+import XCTest
+
+@testable import LangModelAssembly
+
+final class LMPlainBPMFTests: XCTestCase {
+  func testLMPlainBPMFDataQuery() throws {
+    let instance1 = LMAssembly.LMInstantiator(isCHS: false).setOptions { config in
+      config.isSCPCEnabled = true
+    }
+    var liu2 = instance1.unigramsFor(keyArray: ["ㄌㄧㄡˊ"]).map(\.value).prefix(3)
+    var bao3 = instance1.unigramsFor(keyArray: ["ㄅㄠˇ"]).map(\.value).prefix(3)
+    var jie2 = instance1.unigramsFor(keyArray: ["ㄐㄧㄝˊ"]).map(\.value).prefix(3)
+    XCTAssertEqual(liu2, ["劉", "流", "留"])
+    XCTAssertEqual(bao3, ["保", "寶", "飽"])
+    XCTAssertEqual(jie2, ["節", "潔", "傑"])
+    let instance2 = LMAssembly.LMInstantiator(isCHS: true).setOptions { config in
+      config.isSCPCEnabled = true
+    }
+    liu2 = instance2.unigramsFor(keyArray: ["ㄌㄧㄡˊ"]).map(\.value).prefix(3)
+    bao3 = instance2.unigramsFor(keyArray: ["ㄅㄠˇ"]).map(\.value).prefix(3)
+    jie2 = instance2.unigramsFor(keyArray: ["ㄐㄧㄝˊ"]).map(\.value).prefix(3)
+    XCTAssertEqual(liu2, ["刘", "流", "留"])
+    XCTAssertEqual(bao3, ["保", "宝", "饱"])
+    XCTAssertEqual(jie2, ["节", "洁", "杰"])
+  }
+}

Packages/vChewing_LangModelAssembly/Tests/LangModelAssemblyTests/LMUserOverrideTests.swift

@@ -17,12 +17,12 @@ private let halfLife: Double = 5400
 private let nullURL = URL(fileURLWithPath: "/dev/null")
 
 final class LMUserOverrideTests: XCTestCase {
-  private func observe(who uom: vChewingLM.LMUserOverride, key: String, candidate: String, timestamp stamp: Double) {
+  private func observe(who uom: LMAssembly.LMUserOverride, key: String, candidate: String, timestamp stamp: Double) {
     uom.doObservation(key: key, candidate: candidate, timestamp: stamp, forceHighScoreOverride: false, saveCallback: {})
   }
 
   func testUOM_1_BasicOps() throws {
-    let uom = vChewingLM.LMUserOverride(capacity: capacity, decayConstant: Double(halfLife), dataURL: nullURL)
+    let uom = LMAssembly.LMUserOverride(capacity: capacity, decayConstant: Double(halfLife), dataURL: nullURL)
     let key = "((ㄕㄣˊ-ㄌㄧˇ-ㄌㄧㄥˊ-ㄏㄨㄚˊ,神里綾華),(ㄉㄜ˙,的),ㄍㄡˇ)"
     let headReading = "ㄍㄡˇ"
     let expectedSuggestion = "狗"
@@ -45,7 +45,7 @@ final class LMUserOverrideTests: XCTestCase {
   }
 
   func testUOM_2_NewestAgainstRepeatedlyUsed() throws {
-    let uom = vChewingLM.LMUserOverride(capacity: capacity, decayConstant: Double(halfLife), dataURL: nullURL)
+    let uom = LMAssembly.LMUserOverride(capacity: capacity, decayConstant: Double(halfLife), dataURL: nullURL)
     let key = "((ㄕㄣˊ-ㄌㄧˇ-ㄌㄧㄥˊ-ㄏㄨㄚˊ,神里綾華),(ㄉㄜ˙,的),ㄍㄡˇ)"
     let headReading = "ㄍㄡˇ"
     let valRepeatedlyUsed = "狗" // 更常用
@@ -74,7 +74,7 @@ final class LMUserOverrideTests: XCTestCase {
     let b = (key: "((ㄆㄞˋ-ㄇㄥˊ,派蒙),(ㄉㄜ˙,的),ㄐㄧㄤˇ-ㄐㄧㄣ)", value: "伙食費", head: "ㄏㄨㄛˇ-ㄕˊ-ㄈㄟˋ")
     let c = (key: "((ㄍㄨㄛˊ-ㄅㄥ,國崩),(ㄉㄜ˙,的),ㄇㄠˋ-ㄗ˙)", value: "帽子", head: "ㄇㄠˋ-ㄗ˙")
     let d = (key: "((ㄌㄟˊ-ㄉㄧㄢˋ-ㄐㄧㄤ-ㄐㄩㄣ,雷電將軍),(ㄉㄜ˙,的),ㄐㄧㄠˇ-ㄔㄡˋ)", value: "腳臭", head: "ㄐㄧㄠˇ-ㄔㄡˋ")
-    let uom = vChewingLM.LMUserOverride(capacity: 2, decayConstant: Double(halfLife), dataURL: nullURL)
+    let uom = LMAssembly.LMUserOverride(capacity: 2, decayConstant: Double(halfLife), dataURL: nullURL)
     observe(who: uom, key: a.key, candidate: a.value, timestamp: nowTimeStamp)
     observe(who: uom, key: b.key, candidate: b.value, timestamp: nowTimeStamp + halfLife * 1)
     observe(who: uom, key: c.key, candidate: c.value, timestamp: nowTimeStamp + halfLife * 2)

Packages/vChewing_LangModelAssembly/Tests/LangModelAssemblyTests/NumPadDataTests.swift

@@ -0,0 +1,30 @@
+//// (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 Foundation
+import XCTest
+
+@testable import LangModelAssembly
+
+final class LMInstantiatorNumericPadTests: XCTestCase {
+  func testSQL() throws {
+    let instance = LMAssembly.LMInstantiator(isCHS: true)
+    instance.setOptions { config in
+      config.numPadFWHWStatus = nil
+    }
+    XCTAssertEqual(instance.unigramsFor(keyArray: ["_NumPad_0"]).description, "[]")
+    instance.setOptions { config in
+      config.numPadFWHWStatus = true
+    }
+    XCTAssertEqual(instance.unigramsFor(keyArray: ["_NumPad_0"]).description, "[(０,0.0), (0,-0.1)]")
+    instance.setOptions { config in
+      config.numPadFWHWStatus = false
+    }
+    XCTAssertEqual(instance.unigramsFor(keyArray: ["_NumPad_0"]).description, "[(0,0.0), (０,-0.1)]")
+  }
+}

Packages/vChewing_MainAssembly/Package.swift

@@ -17,10 +17,12 @@ let package = Package(
     .package(path: "../HangarRash_SwiftyCapsLockToggler"),
     .package(path: "../Jad_BookmarkManager"),
     .package(path: "../Qwertyyb_ShiftKeyUpChecker"),
+    .package(path: "../vChewing_BrailleSputnik"),
     .package(path: "../vChewing_CandidateWindow"),
-    .package(path: "../vChewing_CocoaExtension"),
+    .package(path: "../vChewing_OSFrameworkImpl"),
     .package(path: "../vChewing_Hotenka"),
     .package(path: "../vChewing_IMKUtils"),
+    .package(path: "../vChewing_KimoDataReader"),
     .package(path: "../vChewing_LangModelAssembly"),
     .package(path: "../vChewing_Megrez"),
     .package(path: "../vChewing_NotifierUI"),
@@ -37,12 +39,14 @@ let package = Package(
     .target(
       name: "MainAssembly",
       dependencies: [
+        .product(name: "BrailleSputnik", package: "vChewing_BrailleSputnik"),
         .product(name: "BookmarkManager", package: "Jad_BookmarkManager"),
         .product(name: "CandidateWindow", package: "vChewing_CandidateWindow"),
-        .product(name: "CocoaExtension", package: "vChewing_CocoaExtension"),
+        .product(name: "OSFrameworkImpl", package: "vChewing_OSFrameworkImpl"),
         .product(name: "FolderMonitor", package: "DanielGalasko_FolderMonitor"),
         .product(name: "Hotenka", package: "vChewing_Hotenka"),
         .product(name: "IMKUtils", package: "vChewing_IMKUtils"),
+        .product(name: "KimoDataReader", package: "vChewing_KimoDataReader"),
         .product(name: "LangModelAssembly", package: "vChewing_LangModelAssembly"),
         .product(name: "Megrez", package: "vChewing_Megrez"),
         .product(name: "NotifierUI", package: "vChewing_NotifierUI"),

Packages/vChewing_MainAssembly/Sources/MainAssembly/AboutUI/CtlAboutUI.swift

@@ -7,23 +7,41 @@
 // requirements defined in MIT License.
 
 import AppKit
+import Shared
 import SwiftUI
 
-@available(macOS 12, *)
 public class CtlAboutUI: NSWindowController, NSWindowDelegate {
   public static var shared: CtlAboutUI?
+  private var viewController: NSViewController?
+  var useLegacyView: Bool = false
+
+  public init(forceLegacy: Bool = false) {
+    useLegacyView = forceLegacy
+    let newWindow = NSWindow(
+      contentRect: CGRect(x: 401, y: 295, width: 577, height: 568),
+      styleMask: [.titled, .closable, .miniaturizable],
+      backing: .buffered, defer: true
+    )
+    super.init(window: newWindow)
+    guard #available(macOS 12, *), !useLegacyView else {
+      viewController = VwrAboutCocoa()
+      viewController?.loadView()
+      return
+    }
+  }
+
+  required init?(coder: NSCoder) {
+    super.init(coder: coder)
+  }
 
   public static func show() {
+    let forceLegacy = NSEvent.modifierFlags == .option
     if shared == nil {
-      let newWindow = NSWindow(
-        contentRect: CGRect(x: 401, y: 295, width: 577, height: 568),
-        styleMask: [.titled, .closable, .miniaturizable],
-        backing: .buffered, defer: true
-      )
-      let newInstance = CtlAboutUI(window: newWindow)
+      let newInstance = CtlAboutUI(forceLegacy: forceLegacy)
       shared = newInstance
     }
     guard let shared = shared, let sharedWindow = shared.window else { return }
+    shared.useLegacyView = forceLegacy
     sharedWindow.delegate = shared
     if !sharedWindow.isVisible {
       shared.windowDidLoad()
@@ -37,6 +55,28 @@ public class CtlAboutUI: NSWindowController, NSWindowDelegate {
 
   override public func windowDidLoad() {
     super.windowDidLoad()
+    guard let window = window else { return }
+    if #available(macOS 12, *), !useLegacyView {
+      windowDidLoadSwiftUI()
+      return
+    }
+    let theViewController = viewController ?? VwrAboutCocoa()
+    viewController = theViewController
+    window.contentViewController = viewController
+    let size = theViewController.view.fittingSize
+    window.setPosition(vertical: .top, horizontal: .left, padding: 20)
+    window.setFrame(.init(origin: window.frame.origin, size: size), display: true)
+    window.standardWindowButton(.closeButton)?.isHidden = true
+    window.standardWindowButton(.miniaturizeButton)?.isHidden = true
+    window.standardWindowButton(.zoomButton)?.isHidden = true
+    if #available(macOS 10.10, *) {
+      window.titlebarAppearsTransparent = true
+    }
+    window.title = "i18n:aboutWindow.ABOUT_APP_TITLE_FULL".localized + " (v\(IMEApp.appMainVersionLabel.joined(separator: " Build ")))"
+  }
+
+  @available(macOS 12, *)
+  private func windowDidLoadSwiftUI() {
     window?.setPosition(vertical: .top, horizontal: .left, padding: 20)
     window?.standardWindowButton(.closeButton)?.isHidden = true
     window?.standardWindowButton(.miniaturizeButton)?.isHidden = true

Packages/vChewing_MainAssembly/Sources/MainAssembly/AboutUI/VwrAboutCocoa.swift

@@ -0,0 +1,215 @@
+// (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 AppKit
+import Foundation
+import Shared
+
+public extension VwrAboutCocoa {
+  static let copyrightLabel = Bundle.main.localizedInfoDictionary?["NSHumanReadableCopyright"] as? String ?? "BAD_COPYRIGHT_LABEL"
+  static let eulaContent = Bundle.main.localizedInfoDictionary?["CFEULAContent"] as? String ?? "BAD_EULA_CONTENT"
+  static let eulaContentUpstream = Bundle.main.infoDictionary?["CFUpstreamEULAContent"] as? String ?? "BAD_EULA_UPSTREAM"
+}
+
+public class VwrAboutCocoa: NSViewController {
+  let windowWidth: CGFloat = 533
+  let contentWidth: CGFloat = 510
+  let imgWidth: CGFloat = 63
+
+  override public func loadView() {
+    view = body ?? .init()
+    (view as? NSStackView)?.alignment = .centerX
+    view.makeSimpleConstraint(.width, relation: .equal, value: windowWidth)
+  }
+
+  var appNameAndVersionString: NSAttributedString {
+    let strResult = NSMutableAttributedString(string: "i18n:aboutWindow.APP_NAME".localized)
+    strResult.addAttribute(
+      .font,
+      value: {
+        if #available(macOS 10.11, *) {
+          return NSFont.systemFont(ofSize: 12, weight: .bold)
+        }
+        return NSFont.boldSystemFont(ofSize: 12)
+      }(),
+      range: .init(location: 0, length: strResult.length)
+    )
+    let strVersion = NSMutableAttributedString(string: " \(versionString)")
+    strVersion.addAttribute(
+      .font,
+      value: NSFont.systemFont(ofSize: 11),
+      range: .init(location: 0, length: strVersion.length)
+    )
+    strResult.append(strVersion)
+    strResult.addAttribute(
+      .kern,
+      value: 0,
+      range: .init(location: 0, length: strResult.length)
+    )
+    return strResult
+  }
+
+  var body: NSView? {
+    NSStackView.buildSection(width: contentWidth - 18) {
+      NSStackView.build(.horizontal) {
+        bannerImage
+        NSStackView.build(.vertical) {
+          appNameAndVersionString.makeNSLabel(fixWidth: contentWidth - imgWidth - 10)
+          makeFormattedLabel(
+            verbatim: "i18n:aboutWindow.APP_DERIVED_FROM".localized
+              + "\n"
+              + Self.copyrightLabel,
+            size: 11,
+            isBold: false, fixWidth: contentWidth - imgWidth - 10
+          )
+          makeFormattedLabel(
+            verbatim: "i18n:aboutWindow.DEV_CREW".localized,
+            size: 11,
+            isBold: false, fixWidth: contentWidth - imgWidth - 10
+          )
+          makeFormattedLabel(
+            verbatim: "i18n:aboutWindow.LICENSE_TITLE".localized,
+            size: 11,
+            isBold: false, fixWidth: contentWidth - imgWidth - 10
+          )
+          eulaBox
+        }
+      }
+      NSStackView.build(.horizontal) {
+        NSStackView.build(.vertical) {
+          "i18n:aboutWindow.DISCLAIMER_TEXT".makeNSLabel(
+            descriptive: true, fixWidth: contentWidth - 120
+          )
+          NSView()
+        }
+        var verticalButtonStackSpacing: CGFloat? = 4
+        if #unavailable(macOS 10.10) {
+          verticalButtonStackSpacing = nil
+        }
+        NSStackView.build(.vertical, spacing: verticalButtonStackSpacing, width: 114) {
+          addKeyEquivalent(
+            NSButton(
+              "i18n:aboutWindow.OK_BUTTON",
+              target: self, action: #selector(btnOKAction(_:))
+            )
+          )
+          NSButton(
+            "i18n:aboutWindow.WEBSITE_BUTTON",
+            target: self, action: #selector(btnWebSiteAction(_:))
+          )
+          NSButton(
+            "i18n:aboutWindow.BUGREPORT_BUTTON",
+            target: self, action: #selector(btnBugReportAction(_:))
+          )
+        }
+      }
+    }?.withInsets(
+      {
+        if #available(macOS 10.10, *) {
+          return .new(all: 20, top: 0, bottom: 24)
+        } else {
+          return .new(all: 20, top: 10, bottom: 24)
+        }
+      }()
+    )
+  }
+
+  var versionString: String {
+    "v\(IMEApp.appMainVersionLabel.joined(separator: " Build ")) - \(IMEApp.appSignedDateLabel)"
+  }
+
+  var bannerImage: NSImageView {
+    let maybeImg = NSImage(named: "AboutBanner")
+    let imgIsNull = maybeImg == nil
+    let img = maybeImg ?? .init(size: .init(width: 63, height: 310))
+    let result = NSImageView()
+    result.image = img
+    result.makeSimpleConstraint(.width, relation: .equal, value: 63)
+    result.makeSimpleConstraint(.height, relation: .equal, value: 310)
+    if imgIsNull {
+      result.wantsLayer = true
+      result.layer?.backgroundColor = NSColor.black.cgColor
+    }
+    return result
+  }
+
+  func makeFormattedLabel(
+    verbatim: String,
+    size: CGFloat = 12,
+    isBold: Bool = false,
+    fixWidth: CGFloat? = nil
+  ) -> NSTextField {
+    let attrStr = NSMutableAttributedString(string: verbatim)
+    attrStr.addAttribute(
+      .kern,
+      value: 0,
+      range: .init(location: 0, length: attrStr.length)
+    )
+    attrStr.addAttribute(
+      .font,
+      value: {
+        guard isBold else { return NSFont.systemFont(ofSize: size) }
+        if #available(macOS 10.11, *) {
+          return NSFont.systemFont(ofSize: size, weight: .bold)
+        }
+        return NSFont.boldSystemFont(ofSize: size)
+      }(),
+      range: .init(location: 0, length: attrStr.length)
+    )
+    return attrStr.makeNSLabel(fixWidth: fixWidth)
+  }
+
+  var eulaBox: NSScrollView {
+    let textView = NSTextView()
+    let clipView = NSClipView()
+    let scrollView = NSScrollView()
+    textView.autoresizingMask = [.width, .height]
+    textView.isEditable = false
+    textView.isRichText = false
+    textView.isSelectable = true
+    textView.isVerticallyResizable = true
+    textView.smartInsertDeleteEnabled = true
+    textView.font = NSFont.systemFont(ofSize: NSFont.smallSystemFontSize)
+    textView.string = Self.eulaContent + "\n" + Self.eulaContentUpstream
+    clipView.documentView = textView
+    clipView.autoresizingMask = [.width, .height]
+    clipView.drawsBackground = false
+    scrollView.contentView = clipView
+    scrollView.makeSimpleConstraint(.width, relation: .equal, value: 430)
+    scrollView.hasVerticalScroller = true
+    scrollView.hasHorizontalScroller = false
+    scrollView.scrollerStyle = .legacy
+    return scrollView
+  }
+
+  @discardableResult func addKeyEquivalent(_ button: NSButton) -> NSButton {
+    button.keyEquivalent = String(NSEvent.SpecialKey.carriageReturn.unicodeScalar)
+    return button
+  }
+
+  @objc func btnOKAction(_: NSControl) {
+    CtlAboutUI.shared?.window?.close()
+  }
+
+  @objc func btnWebSiteAction(_: NSControl) {
+    if let url = URL(string: "https://vchewing.github.io/") {
+      NSWorkspace.shared.open(url)
+    }
+  }
+
+  @objc func btnBugReportAction(_: NSControl) {
+    if let url = URL(string: "https://vchewing.github.io/BUGREPORT.html") {
+      NSWorkspace.shared.open(url)
+    }
+  }
+}
+
+@available(macOS 14.0, *)
+#Preview(traits: .fixedLayout(width: 533, height: 550)) {
+  VwrAboutCocoa()
+}

Packages/vChewing_MainAssembly/Sources/MainAssembly/AboutUI/VwrAboutUI.swift

@@ -7,14 +7,18 @@
 // requirements defined in MIT License.
 
 import AppKit
+import Shared
 import SwiftUI
 
-@available(macOS 12, *)
-public struct VwrAboutUI: View {
-  public static let copyrightLabel = Bundle.main.localizedInfoDictionary?["NSHumanReadableCopyright"] as? String ?? "BAD_COPYRIGHT_LABEL"
-  public static let eulaContent = Bundle.main.localizedInfoDictionary?["CFEULAContent"] as? String ?? "BAD_EULA_CONTENT"
-  public static let eulaContentUpstream = Bundle.main.infoDictionary?["CFUpstreamEULAContent"] as? String ?? "BAD_EULA_UPSTREAM"
+public struct VwrAboutUI {
+  public static var copyrightLabel: String { VwrAboutCocoa.copyrightLabel }
+  public static var eulaContent: String { VwrAboutCocoa.eulaContent }
+  public static var eulaContentUpstream: String { VwrAboutCocoa.eulaContentUpstream }
+  let foobar = "FOO_BAR"
+}
 
+@available(macOS 12, *)
+extension VwrAboutUI: View {
   public var body: some View {
     GroupBox {
       VStack(alignment: .leading, spacing: 6) {
@@ -29,6 +33,7 @@ public struct VwrAboutUI: View {
                 Text("v\(IMEApp.appMainVersionLabel.joined(separator: " Build ")) - \(IMEApp.appSignedDateLabel)").lineLimit(1)
               }.fixedSize()
               Text("i18n:aboutWindow.APP_DERIVED_FROM").font(.custom("Tahoma", size: 11))
+              Text(Self.copyrightLabel).font(.custom("Tahoma", size: 11))
               Text("i18n:aboutWindow.DEV_CREW").font(.custom("Tahoma", size: 11)).padding([.vertical], 2)
             }
           }

Packages/vChewing_MainAssembly/Sources/MainAssembly/AppDelegate.swift

@@ -47,7 +47,6 @@ extension AppDelegate {
       // 先執行 initUserLangModels() 可以在目標辭典檔案不存在的情況下先行生成空白範本檔案。
       if PrefMgr.shared.shouldAutoReloadUserDataFiles || forced { LMMgr.initUserLangModels() }
       DispatchQueue.main.asyncAfter(deadline: DispatchTime.now() + 0.1) {
-        if #available(macOS 10.15, *) { FileObserveProject.shared.touch() }
         if PrefMgr.shared.phraseEditorAutoReloadExternalModifications {
           Broadcaster.shared.eventForReloadingPhraseEditor = .init()
         }
@@ -68,6 +67,10 @@ public extension AppDelegate {
 
     SecurityAgentHelper.shared.timer?.fire()
 
+    SpeechSputnik.shared.refreshStatus() // 根據現狀條件決定是否初期化語音引擎。
+
+    CandidateTextService.enableFinalSanityCheck()
+
     // 一旦發現與使用者半衰模組的觀察行為有關的崩潰標記被開啟：
     // 如果有開啟 Debug 模式的話，就將既有的半衰記憶資料檔案更名＋打上當時的時間戳。
     // 如果沒有開啟 Debug 模式的話，則將半衰記憶資料直接清空。
@@ -132,12 +135,9 @@ public extension AppDelegate {
     NSApp.popup()
     guard result == NSApplication.ModalResponse.alertFirstButtonReturn else { return }
     let url = URL(fileURLWithPath: LMMgr.dataFolderPath(isDefaultFolder: true))
-    guard let finderURL = NSWorkspace.shared.urlForApplication(withBundleIdentifier: "com.apple.finder") else { return }
-    let configuration = NSWorkspace.OpenConfiguration()
-    configuration.promptsUserIfNeeded = true
-    NSWorkspace.shared.open([url], withApplicationAt: finderURL, configuration: configuration)
+    FileOpenMethod.finder.open(url: url)
     Uninstaller.uninstall(
-      isSudo: false, selfKill: true, defaultDataFolderPath: LMMgr.dataFolderPath(isDefaultFolder: true)
+      selfKill: true, defaultDataFolderPath: LMMgr.dataFolderPath(isDefaultFolder: true)
     )
   }
 
@@ -147,7 +147,7 @@ public extension AppDelegate {
     guard let currentMemorySizeInBytes = NSApplication.memoryFootprint else { return 0 }
     let currentMemorySize: Double = (Double(currentMemorySizeInBytes) / 1024 / 1024).rounded(toPlaces: 1)
     switch currentMemorySize {
-    case 384...:
+    case 1024...:
       vCLog("WARNING: EXCESSIVE MEMORY FOOTPRINT (\(currentMemorySize)MB).")
       let msgPackage = UNMutableNotificationContent()
       msgPackage.title = NSLocalizedString("vChewing", comment: "")
@@ -169,4 +169,10 @@ public extension AppDelegate {
     }
     return currentMemorySize
   }
+
+  // New About Window
+  @IBAction func about(_: Any) {
+    CtlAboutUI.show()
+    NSApp.popup()
+  }
 }

Packages/vChewing_MainAssembly/Sources/MainAssembly/CandidateTextService_SelectorImpl.swift

@@ -0,0 +1,170 @@
+// (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 BrailleSputnik
+import Foundation
+import Shared
+import Tekkon
+
+public extension CandidateTextService {
+  // MARK: - Final Sanity Check Implementation.
+
+  static func enableFinalSanityCheck() {
+    finalSanityCheck = finalSanityCheckImplemented
+  }
+
+  private static func finalSanityCheckImplemented(_ target: CandidateTextService) -> Bool {
+    switch target.value {
+    case .url: return true
+    case let .selector(strSelector):
+      guard target.candidateText != "%s" else { return true } // 防止誤傷到編輯器。
+      switch strSelector {
+      case "copyUnicodeMetadata:": return true
+      case _ where strSelector.hasPrefix("copyRuby"),
+           _ where strSelector.hasPrefix("copyBraille"),
+           _ where strSelector.hasPrefix("copyInline"):
+        return !target.reading.joined().isEmpty // 以便應對 [""] 的情況。
+      default: return true
+      }
+    }
+  }
+
+  // MARK: - Selector Methods, CandidatePairServicable, and the Coordinator.
+
+  var responseFromSelector: String? {
+    switch value {
+    case .url: return nil
+    case let .selector(string):
+      let passable = CandidatePairServicable(value: candidateText, reading: reading)
+      return Coordinator().runTask(selectorName: string, candidate: passable)
+    }
+  }
+
+  @objcMembers class CandidatePairServicable: NSObject {
+    public var value: String
+    public var reading: [String]
+    public init(value: String, reading: [String] = []) {
+      self.value = value
+      self.reading = reading
+    }
+
+    public typealias SubPair = (key: String, value: String)
+
+    @nonobjc var smashed: [SubPair] {
+      var pairs = [SubPair]()
+      if value.count != reading.count {
+        pairs.append((reading.joined(separator: " "), value))
+      } else {
+        value.enumerated().forEach { i, valChar in
+          pairs.append((reading[i], valChar.description))
+        }
+      }
+      return pairs
+    }
+  }
+
+  @objc class Coordinator: NSObject {
+    private var result: String?
+
+    public func runTask(selectorName: String, candidate param: CandidatePairServicable) -> String? {
+      guard !selectorName.isEmpty, !param.value.isEmpty else { return nil }
+      guard responds(to: Selector(selectorName)) else { return nil }
+      performSelector(onMainThread: Selector(selectorName), with: param, waitUntilDone: true)
+      defer { result = nil }
+      return result
+    }
+
+    /// 生成 Unicode 統一碼碼位中繼資料。
+    /// - Parameter param: 要處理的詞音配對物件。
+    @objc func copyUnicodeMetadata(_ param: CandidatePairServicable) {
+      var resultArray = [String]()
+      param.value.forEach { char in
+        resultArray.append("\(char) \(char.description.charDescriptions.first ?? "NULL")")
+      }
+      result = resultArray.joined(separator: "\n")
+    }
+
+    /// 生成 HTML Ruby (教科書注音)。
+    /// - Parameter param: 要處理的詞音配對物件。
+    @objc func copyRubyHTMLZhuyinTextbookStyle(_ param: CandidatePairServicable) {
+      prepareTextBookZhuyinReadings(param)
+      copyRubyHTMLCommon(param)
+    }
+
+    /// 生成 HTML Ruby (教科書漢語拼音注音)。
+    /// - Parameter param: 要處理的詞音配對物件。
+    @objc func copyRubyHTMLHanyuPinyinTextbookStyle(_ param: CandidatePairServicable) {
+      prepareTextBookPinyinReadings(param)
+      copyRubyHTMLCommon(param)
+    }
+
+    /// 生成內文讀音標注 (教科書注音)。
+    /// - Parameter param: 要處理的詞音配對物件。
+    @objc func copyInlineZhuyinAnnotationTextbookStyle(_ param: CandidatePairServicable) {
+      prepareTextBookZhuyinReadings(param)
+      copyInlineAnnotationCommon(param)
+    }
+
+    /// 生成內文讀音標注 (教科書漢語拼音注音)。
+    /// - Parameter param: 要處理的詞音配對物件。
+    @objc func copyInlineHanyuPinyinAnnotationTextbookStyle(_ param: CandidatePairServicable) {
+      prepareTextBookPinyinReadings(param)
+      copyInlineAnnotationCommon(param)
+    }
+
+    @objc func copyBraille1947(_ param: CandidatePairServicable) {
+      result = BrailleSputnik(standard: .of1947).convertToBraille(smashedPairs: param.smashed)
+    }
+
+    @objc func copyBraille2018(_ param: CandidatePairServicable) {
+      result = BrailleSputnik(standard: .of2018).convertToBraille(smashedPairs: param.smashed)
+    }
+
+    // MARK: Privates
+  }
+}
+
+private extension CandidateTextService.Coordinator {
+  func copyInlineAnnotationCommon(_ param: CandidateTextService.CandidatePairServicable) {
+    var composed = ""
+    param.smashed.forEach { subPair in
+      let subKey = subPair.key
+      let subValue = subPair.value
+      composed += subKey.contains("_") ? subValue : "\(subValue)(\(subKey))"
+    }
+    result = composed
+  }
+
+  func copyRubyHTMLCommon(_ param: CandidateTextService.CandidatePairServicable) {
+    var composed = ""
+    param.smashed.forEach { subPair in
+      let subKey = subPair.key
+      let subValue = subPair.value
+      composed += subKey.contains("_") ? subValue : "<ruby>\(subValue)<rp>(</rp><rt>\(subKey)</rt><rp>)</rp></ruby>"
+    }
+    result = composed
+  }
+
+  func prepareTextBookZhuyinReadings(_ param: CandidateTextService.CandidatePairServicable) {
+    let newReadings = param.reading.map { currentReading in
+      if currentReading.contains("_") { return "_??" }
+      return Tekkon.cnvPhonaToTextbookStyle(target: currentReading)
+    }
+    param.reading = newReadings
+  }
+
+  func prepareTextBookPinyinReadings(_ param: CandidateTextService.CandidatePairServicable) {
+    let newReadings = param.reading.map { currentReading in
+      if currentReading.contains("_") { return "_??" }
+      return Tekkon.cnvHanyuPinyinToTextbookStyle(
+        targetJoined: Tekkon.cnvPhonaToHanyuPinyin(targetJoined: currentReading)
+      )
+    }
+    param.reading = newReadings
+  }
+}

Packages/vChewing_MainAssembly/Sources/MainAssembly/ChineseConverterBridge.swift

@@ -7,6 +7,7 @@
 // requirements defined in MIT License.
 
 import Hotenka
+import Shared
 
 public enum ChineseConverter {
   public static let shared = HotenkaChineseConverter(

Packages/vChewing_MainAssembly/Sources/MainAssembly/ClientListMgr/CtlClientListMgr.swift

@@ -0,0 +1,62 @@
+// (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 AppKit
+import Foundation
+
+public class CtlClientListMgr: NSWindowController {
+  let viewController = VwrClientListMgr()
+
+  public static var shared: CtlClientListMgr?
+  public init() {
+    super.init(
+      window: .init(
+        contentRect: CGRect(x: 401, y: 295, width: 770, height: 335),
+        styleMask: [.titled, .closable, .miniaturizable],
+        backing: .buffered,
+        defer: true
+      )
+    )
+    viewController.loadView()
+  }
+
+  required init?(coder: NSCoder) {
+    super.init(coder: coder)
+  }
+
+  public static func show() {
+    if shared == nil {
+      shared = CtlClientListMgr()
+    }
+    guard let shared = shared, let sharedWindow = shared.window else { return }
+    if !sharedWindow.isVisible {
+      shared.windowDidLoad()
+    }
+    sharedWindow.setPosition(vertical: .center, horizontal: .right, padding: 20)
+    sharedWindow.orderFrontRegardless() // 逼著視窗往最前方顯示
+    sharedWindow.title = "Client Manager".localized
+    sharedWindow.level = .statusBar
+    if #available(macOS 10.10, *) {
+      sharedWindow.titlebarAppearsTransparent = true
+    }
+    shared.showWindow(shared)
+    NSApp.popup()
+  }
+
+  override public func windowDidLoad() {
+    super.windowDidLoad()
+    let view = viewController.view
+    window?.contentView = view
+    if let window = window {
+      var frame = window.frame
+      frame.size = view.fittingSize
+      window.setFrame(frame, display: true)
+    }
+    window?.setPosition(vertical: .center, horizontal: .right, padding: 20)
+  }
+}

Packages/vChewing_MainAssembly/Sources/MainAssembly/ClientListMgr/VwrClientListMgr.swift

@@ -7,47 +7,121 @@
 // requirements defined in MIT License.
 
 import AppKit
-import MainAssembly
-import UniformTypeIdentifiers
+import Foundation
+import Shared
 
-class CtlClientListMgr: NSWindowController, NSTableViewDelegate, NSTableViewDataSource {
-  @IBOutlet var tblClients: NSTableView!
-  @IBOutlet var btnRemoveClient: NSButton!
-  @IBOutlet var btnAddClient: NSButton!
-  @IBOutlet var lblClientMgrWindow: NSTextField!
+public class VwrClientListMgr: NSViewController {
+  let windowWidth: CGFloat = 770
+  let contentWidth: CGFloat = 750
+  let buttonWidth: CGFloat = 150
+  let tableHeight: CGFloat = 230
 
-  public static var shared: CtlClientListMgr?
+  lazy var tblClients: NSTableView = .init()
+  lazy var btnAddClient = NSButton("Add Client", target: self, action: #selector(btnAddClientClicked(_:)))
+  lazy var btnRemoveClient = NSButton("Remove Selected", target: self, action: #selector(btnRemoveClientClicked(_:)))
+  lazy var tableColumn1Cell = NSButtonCell()
+  lazy var tableColumn1 = NSTableColumn()
+  lazy var tableColumn2Cell = NSTextFieldCell()
+  lazy var tableColumn2 = NSTableColumn()
 
-  static func show() {
-    if shared == nil { shared = CtlClientListMgr(windowNibName: "frmClientListMgr") }
-    guard let shared = shared, let sharedWindow = shared.window else { return }
-    sharedWindow.setPosition(vertical: .center, horizontal: .right, padding: 20)
-    sharedWindow.orderFrontRegardless() // 逼著視窗往最前方顯示
-    sharedWindow.level = .statusBar
-    sharedWindow.titlebarAppearsTransparent = true
-    shared.showWindow(shared)
-    NSApp.popup()
+  override public func loadView() {
+    tblClients.reloadData()
+    view = body ?? .init()
+    (view as? NSStackView)?.alignment = .centerX
+    view.makeSimpleConstraint(.width, relation: .equal, value: windowWidth)
+    btnRemoveClient.keyEquivalent = .init(NSEvent.SpecialKey.delete.unicodeScalar)
   }
 
-  override func windowDidLoad() {
-    super.windowDidLoad()
-    window?.setPosition(vertical: .center, horizontal: .right, padding: 20)
-    localize()
+  var body: NSView? {
+    NSStackView.build(.vertical, insets: .new(all: 14)) {
+      makeScrollableTable()
+        .makeSimpleConstraint(.height, relation: .equal, value: tableHeight)
+      NSStackView.build(.horizontal) {
+        let descriptionWidth = contentWidth - buttonWidth - 20
+        NSStackView.build(.vertical) {
+          let strDescription = "Please manage the list of those clients here which are: 1) IMKTextInput-incompatible; 2) suspected from abusing the contents of the inline composition buffer. A client listed here, if checked, will use popup composition buffer with maximum 20 reading counts holdable."
+          strDescription.makeNSLabel(descriptive: true, fixWidth: descriptionWidth)
+            .makeSimpleConstraint(.width, relation: .greaterThanOrEqual, value: descriptionWidth)
+          NSView()
+        }
+        NSStackView.build(.vertical, spacing: 6) {
+          btnAddClient
+            .makeSimpleConstraint(.width, relation: .equal, value: buttonWidth)
+          btnRemoveClient
+            .makeSimpleConstraint(.width, relation: .equal, value: buttonWidth)
+        }
+      }
+    }
+  }
+
+  func makeScrollableTable() -> NSScrollView {
+    let scrollContainer = NSScrollView()
+    scrollContainer.scrollerStyle = .legacy
+    scrollContainer.autohidesScrollers = true
+    scrollContainer.documentView = tblClients
+    scrollContainer.hasVerticalScroller = true
+    scrollContainer.hasHorizontalScroller = true
+    if #available(macOS 11.0, *) {
+      tblClients.style = .inset
+    }
+    tblClients.addTableColumn(tableColumn1)
+    tblClients.addTableColumn(tableColumn2)
+    tblClients.headerView = nil
     tblClients.delegate = self
-    tblClients.registerForDraggedTypes([.fileURL])
+    tblClients.allowsExpansionToolTips = true
     tblClients.allowsMultipleSelection = true
+    tblClients.autoresizingMask = [.width, .height]
+    tblClients.autosaveTableColumns = false
+    tblClients.backgroundColor = NSColor.controlBackgroundColor
+    tblClients.columnAutoresizingStyle = .lastColumnOnlyAutoresizingStyle
+    tblClients.frame = CGRect(x: 0, y: 0, width: 728, height: tableHeight)
+    tblClients.gridColor = NSColor.clear
+    tblClients.intercellSpacing = CGSize(width: 17, height: 0)
+    tblClients.rowHeight = 24
+    tblClients.setContentHuggingPriority(.defaultHigh, for: .vertical)
+    tblClients.registerForDraggedTypes([.kUTTypeFileURL])
     tblClients.dataSource = self
     tblClients.action = #selector(onItemClicked(_:))
     tblClients.target = self
-    tblClients.reloadData()
+    if #available(macOS 11.0, *) { tblClients.style = .inset }
+
+    tableColumn1.identifier = NSUserInterfaceItemIdentifier("colPCBEnabled")
+    tableColumn1.maxWidth = 20
+    tableColumn1.minWidth = 20
+    tableColumn1.resizingMask = [.autoresizingMask, .userResizingMask]
+    tableColumn1.width = 20
+    tableColumn1.dataCell = tableColumn1Cell
+
+    if #available(macOS 11.0, *) { tableColumn1Cell.controlSize = .large }
+    tableColumn1Cell.font = NSFont.systemFont(ofSize: 13)
+    tableColumn1Cell.setButtonType(.switch)
+    tableColumn1Cell.bezelStyle = .rounded
+
+    tableColumn2.identifier = NSUserInterfaceItemIdentifier("colClient")
+    tableColumn2.maxWidth = 1000
+    tableColumn2.minWidth = 40
+    tableColumn2.resizingMask = [.autoresizingMask, .userResizingMask]
+    tableColumn2.width = 546
+    tableColumn2.dataCell = tableColumn2Cell
+
+    tableColumn2Cell.backgroundColor = NSColor.controlBackgroundColor
+    tableColumn2Cell.font = NSFont.systemFont(ofSize: 20)
+    tableColumn2Cell.isEditable = true
+    tableColumn2Cell.isSelectable = true
+    tableColumn2Cell.lineBreakMode = .byTruncatingTail
+    tableColumn2Cell.stringValue = "Text Cell"
+    tableColumn2Cell.textColor = NSColor.controlTextColor
+    tableColumn2Cell.isEditable = true
+
+    return scrollContainer
   }
 }
 
-// MARK: - UserDefaults Handlers
+// MARK: - UserDefaults Handlers.
 
-extension CtlClientListMgr {
-  public static var clientsList: [String] { PrefMgr.shared.clientsIMKTextInputIncapable.keys.sorted() }
-  public static func removeClient(at index: Int) {
+public extension VwrClientListMgr {
+  static var clientsList: [String] { PrefMgr.shared.clientsIMKTextInputIncapable.keys.sorted() }
+  static func removeClient(at index: Int) {
     guard index < Self.clientsList.count else { return }
     let key = Self.clientsList[index]
     var dict = PrefMgr.shared.clientsIMKTextInputIncapable
@@ -56,15 +130,75 @@ extension CtlClientListMgr {
   }
 }
 
-// MARK: - Implementations
+// MARK: - Common Operation Methods.
 
-extension CtlClientListMgr {
-  func numberOfRows(in _: NSTableView) -> Int {
-    Self.clientsList.count
+extension VwrClientListMgr {
+  func applyNewValue(_ newValue: String, highMitigation mitigation: Bool = true) {
+    guard !newValue.isEmpty else { return }
+    var dict = PrefMgr.shared.clientsIMKTextInputIncapable
+    dict[newValue] = mitigation
+    PrefMgr.shared.clientsIMKTextInputIncapable = dict
+    tblClients.reloadData()
+    btnRemoveClient.isEnabled = (0 ..< Self.clientsList.count).contains(
+      tblClients.selectedRow)
+  }
+
+  /// 檢查傳入的 NSDraggingInfo 當中的 URL 對應的物件是否是 App Bundle。
+  /// - Parameters:
+  ///   - info: 傳入的 NSDraggingInfo 物件。
+  ///   - onError: 當不滿足判定條件時，執行給定的 lambda expression。
+  ///   - handler: 當滿足判定條件時，讓傳入的 lambda expression 處理已經整理出來的 URL 陣列。
+  private func validatePasteboardForAppBundles(
+    neta info: NSDraggingInfo, onError: @escaping () -> Void?, handler: (([URL]) -> Void)? = nil
+  ) {
+    let board = info.draggingPasteboard
+    let type = NSPasteboard.PasteboardType.kUTTypeAppBundle
+    let options: [NSPasteboard.ReadingOptionKey: Any] = [
+      .urlReadingFileURLsOnly: true,
+      .urlReadingContentsConformToTypes: [type],
+    ]
+    guard let urls = board.readObjects(forClasses: [NSURL.self], options: options) as? [URL], !urls.isEmpty else {
+      onError()
+      return
+    }
+    if let handler = handler {
+      handler(urls)
+    }
+  }
+}
+
+// MARK: - IBActions.
+
+extension VwrClientListMgr {
+  @IBAction func onItemClicked(_: Any!) {
+    guard tblClients.clickedColumn == 0 else { return }
+    PrefMgr.shared.clientsIMKTextInputIncapable[Self.clientsList[tblClients.clickedRow]]?.toggle()
+    tblClients.reloadData()
+  }
+
+  @IBAction func btnRemoveClientClicked(_: Any) {
+    guard let minIndexSelected = tblClients.selectedRowIndexes.min() else { return }
+    if minIndexSelected >= Self.clientsList.count { return }
+    if minIndexSelected < 0 { return }
+    var isLastRow = false
+    tblClients.selectedRowIndexes.sorted().reversed().forEach { index in
+      isLastRow = {
+        if Self.clientsList.count < 2 { return false }
+        return minIndexSelected == Self.clientsList.count - 1
+      }()
+      if index < Self.clientsList.count {
+        Self.removeClient(at: index)
+      }
+    }
+    if isLastRow {
+      tblClients.selectRowIndexes(.init(arrayLiteral: minIndexSelected - 1), byExtendingSelection: false)
+    }
+    tblClients.reloadData()
+    btnRemoveClient.isEnabled = (0 ..< Self.clientsList.count).contains(minIndexSelected)
   }
 
   @IBAction func btnAddClientClicked(_: Any) {
-    guard let window = window else { return }
+    guard let window = CtlClientListMgr.shared?.window else { return }
     let alert = NSAlert()
     alert.messageText = NSLocalizedString(
       "Please enter the client app bundle identifier(s) you want to register.", comment: ""
@@ -86,6 +220,7 @@ extension CtlClientListMgr {
     scrollview.verticalScroller?.scrollerStyle = .legacy
     scrollview.autoresizingMask = [.width, .height]
     let theTextView = NSTextView(frame: NSRect(x: 0, y: 0, width: contentSize.width, height: contentSize.height))
+    scrollview.documentView = theTextView
     theTextView.minSize = NSSize(width: 0.0, height: contentSize.height)
     theTextView.maxSize = NSSize(width: maxFloat, height: maxFloat)
     theTextView.isVerticallyResizable = true
@@ -93,7 +228,6 @@ extension CtlClientListMgr {
     theTextView.autoresizingMask = .width
     theTextView.textContainer?.containerSize = NSSize(width: contentSize.width, height: maxFloat)
     theTextView.textContainer?.widthTracksTextView = true
-    scrollview.documentView = theTextView
     theTextView.enclosingScrollView?.hasHorizontalScroller = true
     theTextView.isHorizontallyResizable = true
     theTextView.autoresizingMask = [.width, .height]
@@ -109,7 +243,7 @@ extension CtlClientListMgr {
     }()
 
     alert.accessoryView = scrollview
-    alert.beginSheetModal(for: window) { result in
+    alert.beginSheetModal(at: window) { result in
       resultCheck: switch result {
       case .alertFirstButtonReturn, .alertSecondButtonReturn:
         theTextView.textContainer?.textView?.string.components(separatedBy: "\n").filter { !$0.isEmpty }.forEach {
@@ -126,12 +260,16 @@ extension CtlClientListMgr {
         )
         dlgOpenPath.showsResizeIndicator = true
         dlgOpenPath.allowsMultipleSelection = true
-        dlgOpenPath.allowedContentTypes = [UTType.applicationBundle]
+        if #available(macOS 11.0, *) {
+          dlgOpenPath.allowedContentTypes = [.applicationBundle]
+        } else {
+          dlgOpenPath.allowedFileTypes = ["app"]
+        }
         dlgOpenPath.allowsOtherFileTypes = false
         dlgOpenPath.showsHiddenFiles = true
         dlgOpenPath.canChooseFiles = true
         dlgOpenPath.canChooseDirectories = false
-        dlgOpenPath.beginSheetModal(for: window) { result in
+        dlgOpenPath.beginSheetModal(at: window) { result in
           switch result {
           case .OK:
             for url in dlgOpenPath.urls {
@@ -141,11 +279,11 @@ extension CtlClientListMgr {
               )
               let text = url.path + "\n\n" + NSLocalizedString("Please try again.", comment: "")
               guard let bundle = Bundle(url: url) else {
-                self.window?.callAlert(title: title, text: text)
+                CtlClientListMgr.shared?.window.callAlert(title: title, text: text)
                 return
               }
               guard let identifier = bundle.bundleIdentifier else {
-                self.window?.callAlert(title: title, text: text)
+                CtlClientListMgr.shared?.window.callAlert(title: title, text: text)
                 return
               }
               let isIdentifierAlreadyRegistered = Self.clientsList.contains(identifier)
@@ -171,49 +309,20 @@ extension CtlClientListMgr {
       }
     }
   }
+}
 
-  private func applyNewValue(_ newValue: String, highMitigation mitigation: Bool = true) {
-    guard !newValue.isEmpty else { return }
-    var dict = PrefMgr.shared.clientsIMKTextInputIncapable
-    dict[newValue] = mitigation
-    PrefMgr.shared.clientsIMKTextInputIncapable = dict
-    tblClients.reloadData()
-    btnRemoveClient.isEnabled = (0 ..< Self.clientsList.count).contains(
-      tblClients.selectedRow)
+// MARK: - TableView Extensions.
+
+extension VwrClientListMgr: NSTableViewDelegate, NSTableViewDataSource {
+  public func numberOfRows(in _: NSTableView) -> Int {
+    Self.clientsList.count
   }
 
-  @IBAction func btnRemoveClientClicked(_: Any) {
-    guard let minIndexSelected = tblClients.selectedRowIndexes.min() else { return }
-    if minIndexSelected >= Self.clientsList.count { return }
-    if minIndexSelected < 0 { return }
-    var isLastRow = false
-    tblClients.selectedRowIndexes.sorted().reversed().forEach { index in
-      isLastRow = {
-        if Self.clientsList.count < 2 { return false }
-        return minIndexSelected == Self.clientsList.count - 1
-      }()
-      if index < Self.clientsList.count {
-        Self.removeClient(at: index)
-      }
-    }
-    if isLastRow {
-      tblClients.selectRowIndexes(.init(arrayLiteral: minIndexSelected - 1), byExtendingSelection: false)
-    }
-    tblClients.reloadData()
-    btnRemoveClient.isEnabled = (0 ..< Self.clientsList.count).contains(minIndexSelected)
-  }
-
-  @objc func onItemClicked(_: Any!) {
-    guard tblClients.clickedColumn == 0 else { return }
-    PrefMgr.shared.clientsIMKTextInputIncapable[Self.clientsList[tblClients.clickedRow]]?.toggle()
-    tblClients.reloadData()
-  }
-
-  func tableView(_: NSTableView, shouldEdit _: NSTableColumn?, row _: Int) -> Bool {
+  public func tableView(_: NSTableView, shouldEdit _: NSTableColumn?, row _: Int) -> Bool {
     false
   }
 
-  func tableView(_: NSTableView, objectValueFor column: NSTableColumn?, row: Int) -> Any? {
+  public func tableView(_: NSTableView, objectValueFor column: NSTableColumn?, row: Int) -> Any? {
     defer {
       self.btnRemoveClient.isEnabled = (0 ..< Self.clientsList.count).contains(
         self.tblClients.selectedRow)
@@ -232,30 +341,7 @@ extension CtlClientListMgr {
     return Self.clientsList[row]
   }
 
-  /// 檢查傳入的 NSDraggingInfo 當中的 URL 對應的物件是否是 App Bundle。
-  /// - Parameters:
-  ///   - info: 傳入的 NSDraggingInfo 物件。
-  ///   - onError: 當不滿足判定條件時，執行給定的 lambda expression。
-  ///   - handler: 當滿足判定條件時，讓傳入的 lambda expression 處理已經整理出來的 URL 陣列。
-  private func validatePasteboardForAppBundles(
-    neta info: NSDraggingInfo, onError: @escaping () -> Void?, handler: (([URL]) -> Void)? = nil
-  ) {
-    let board = info.draggingPasteboard
-    let type = UTType.applicationBundle
-    let options: [NSPasteboard.ReadingOptionKey: Any] = [
-      .urlReadingFileURLsOnly: true,
-      .urlReadingContentsConformToTypes: [type],
-    ]
-    guard let urls = board.readObjects(forClasses: [NSURL.self], options: options) as? [URL], !urls.isEmpty else {
-      onError()
-      return
-    }
-    if let handler = handler {
-      handler(urls)
-    }
-  }
-
-  func tableView(
+  public func tableView(
     _: NSTableView, validateDrop info: NSDraggingInfo, proposedRow _: Int,
     proposedDropOperation _: NSTableView.DropOperation
   ) -> NSDragOperation {
@@ -266,7 +352,7 @@ extension CtlClientListMgr {
     return result
   }
 
-  func tableView(
+  public func tableView(
     _: NSTableView, acceptDrop info: NSDraggingInfo,
     row _: Int, dropOperation _: NSTableView.DropOperation
   ) -> Bool {
@@ -285,15 +371,11 @@ extension CtlClientListMgr {
     defer { if result { tblClients.reloadData() } }
     return result
   }
-
-  private func localize() {
-    guard let window = window else { return }
-    window.title = NSLocalizedString("Client Manager", comment: "")
-    lblClientMgrWindow.stringValue = NSLocalizedString(
-      "Please manage the list of those clients here which are: 1) IMKTextInput-incompatible; 2) suspected from abusing the contents of the inline composition buffer. A client listed here, if checked, will use popup composition buffer with maximum 20 reading counts holdable.",
-      comment: ""
-    )
-    btnAddClient.title = NSLocalizedString("Add Client", comment: "")
-    btnRemoveClient.title = NSLocalizedString("Remove Selected", comment: "")
-  }
+}
+
+// MARK: - Preview.
+
+@available(macOS 14.0, *)
+#Preview(traits: .fixedLayout(width: 770, height: 335)) {
+  VwrClientListMgr()
 }

Packages/vChewing_MainAssembly/Sources/MainAssembly/IMEState.swift

@@ -33,7 +33,7 @@ import Shared
 /// 威注音輸入法在「組字區與組音區/組筆區同時為空」、
 /// 且客體軟體正在準備接收使用者文字輸入行為的時候，會處於空狀態。
 /// 有時，威注音會利用呼叫空狀態的方式，讓組字區內已經顯示出來的內容遞交出去。
-/// - **聯想詞狀態 .ofAssociates**: 逐字選字模式內的聯想詞輸入狀態。
+/// - **關聯詞語狀態 .ofAssociates**: 逐字選字模式內的關聯詞語輸入狀態。
 /// - **中絕狀態 .ofAbortion**: 與 .ofEmpty() 類似，但會扔掉上一個狀態的內容、
 /// 不將這些內容遞交給客體應用。該狀態在處理完畢之後會被立刻切換至 .ofEmpty()。
 /// - **遞交狀態 .ofCommitting**: 該狀態會承載要遞交出去的內容，讓輸入法控制器處理時代為遞交。
@@ -200,7 +200,8 @@ public extension IMEState {
     case .ofCandidates where cursor != marker: return data.attributedStringMarking(for: session)
     case .ofCandidates where cursor == marker: break
     case .ofAssociates: return data.attributedStringPlaceholder(for: session)
-    case .ofSymbolTable where displayedText.isEmpty: return data.attributedStringPlaceholder(for: session)
+    case .ofSymbolTable where displayedText.isEmpty || node.containsCandidateServices:
+      return data.attributedStringPlaceholder(for: session)
     case .ofSymbolTable where !displayedText.isEmpty: break
     default: break
     }

Packages/vChewing_MainAssembly/Sources/MainAssembly/IMEStateData.swift

@@ -212,7 +212,7 @@ public extension IMEStateData {
             subNeta = Tekkon.cnvPhonaToHanyuPinyin(targetJoined: subNeta)
             subNeta = Tekkon.cnvHanyuPinyinToTextbookStyle(targetJoined: subNeta)
           } else {
-            subNeta = Tekkon.cnvPhonaToTextbookReading(target: subNeta)
+            subNeta = Tekkon.cnvPhonaToTextbookStyle(target: subNeta)
           }
         }
         arrOutput.append(subNeta)

Packages/vChewing_MainAssembly/Sources/MainAssembly/InputHandler/InputHandler_Core.swift

@@ -19,10 +19,8 @@ import Tekkon
 // MARK: - InputHandler 自身協定 (Protocol).
 
 public protocol InputHandlerProtocol {
-  var currentLM: vChewingLM.LMInstantiator { get set }
-  var currentUOM: vChewingLM.LMUserOverride { get set }
+  var currentLM: LMAssembly.LMInstantiator { get set }
   var delegate: InputHandlerDelegate? { get set }
-  var composer: Tekkon.Composer { get set }
   var keySeparator: String { get }
   static var keySeparator: String { get }
   var isCompositorEmpty: Bool { get }
@@ -31,7 +29,7 @@ public protocol InputHandlerProtocol {
   func clearComposerAndCalligrapher()
   func ensureKeyboardParser()
   func triageInput(event input: InputSignalProtocol) -> Bool
-  func generateStateOfCandidates() -> IMEStateProtocol
+  func generateStateOfCandidates(dodge: Bool) -> IMEStateProtocol
   func generateStateOfInputting(sansReading: Bool, guarded: Bool) -> IMEStateProtocol
   func generateStateOfAssociates(withPair pair: Megrez.KeyValuePaired) -> IMEStateProtocol
   func consolidateNode(
@@ -46,6 +44,10 @@ extension InputHandlerProtocol {
     generateStateOfInputting(sansReading: sansReading, guarded: guarded)
   }
 
+  func generateStateOfCandidates() -> IMEStateProtocol {
+    generateStateOfCandidates(dodge: true)
+  }
+
   func consolidateNode(candidate: (keyArray: [String], value: String), respectCursorPushing: Bool, preConsolidate: Bool) {
     consolidateNode(
       candidate: candidate, respectCursorPushing: respectCursorPushing,
@@ -83,14 +85,20 @@ public class InputHandler: InputHandlerProtocol {
   public var delegate: InputHandlerDelegate?
   public var prefs: PrefMgrProtocol
 
+  /// 用來記錄「叫出選字窗前」的游標位置的變數。
+  var backupCursor: Int?
+  /// 當前的打字模式。
+  var currentTypingMethod: TypingMethod = .vChewingFactory
+
   /// 半衰模組的衰減指數
   let kEpsilon: Double = 0.000_001
 
-  public var calligrapher = "" // 磁帶專用組筆區
-  public var composer: Tekkon.Composer = .init() // 注拼槽
-  public var compositor: Megrez.Compositor // 組字器
-  public var currentUOM: vChewingLM.LMUserOverride
-  public var currentLM: vChewingLM.LMInstantiator {
+  var strCodePointBuffer = "" // 內碼輸入專用組碼區
+  var calligrapher = "" // 磁帶專用組筆區
+  var composer: Tekkon.Composer = .init() // 注拼槽
+  var compositor: Megrez.Compositor // 組字器
+
+  public var currentLM: LMAssembly.LMInstantiator {
     didSet {
       compositor.langModel = .init(withLM: currentLM)
       clear()
@@ -98,10 +106,9 @@ public class InputHandler: InputHandlerProtocol {
   }
 
   /// 初期化。
-  public init(lm: vChewingLM.LMInstantiator, uom: vChewingLM.LMUserOverride, pref: PrefMgrProtocol) {
+  public init(lm: LMAssembly.LMInstantiator, pref: PrefMgrProtocol) {
     prefs = pref
     currentLM = lm
-    currentUOM = uom
     /// 同步組字器單個詞的幅位長度上限。
     Megrez.Compositor.maxSpanLength = prefs.maxCandidateLength
     /// 組字器初期化。因為是首次初期化變數，所以這裡不能用 ensureCompositor() 代勞。
@@ -113,48 +120,56 @@ public class InputHandler: InputHandlerProtocol {
   public func clear() {
     clearComposerAndCalligrapher()
     compositor.clear()
-    isCodePointInputMode = false
-    isHaninKeyboardSymbolMode = false
+    currentTypingMethod = .vChewingFactory
+    backupCursor = nil
   }
 
   /// 警告：該參數僅代指組音區/組筆區域與組字區在目前狀態下被視為「空」。
   var isConsideredEmptyForNow: Bool {
-    compositor.isEmpty && isComposerOrCalligrapherEmpty && !isCodePointInputMode && !isHaninKeyboardSymbolMode
-  }
-
-  // MARK: - Hanin Keyboard Symbol Mode.
-
-  var isHaninKeyboardSymbolMode = false
-
-  static let tooltipHaninKeyboardSymbolMode: String = "\("Hanin Keyboard Symbol Input.".localized)"
-
-  // MARK: - Codepoint Input Buffer.
-
-  var isCodePointInputMode = false {
-    willSet {
-      strCodePointBuffer.removeAll()
-    }
-  }
-
-  var strCodePointBuffer = ""
-
-  var tooltipCodePointInputMode: String {
-    let commonTerm = NSMutableString()
-    commonTerm.insert("Code Point Input.".localized, at: 0)
-    if !(delegate?.isVerticalTyping ?? false) {
-      switch IMEApp.currentInputMode {
-      case .imeModeCHS: commonTerm.insert("[GB] ", at: 0)
-      case .imeModeCHT: commonTerm.insert("[Big5] ", at: 0)
-      default: break
-      }
-    }
-    return commonTerm.description
+    compositor.isEmpty && isComposerOrCalligrapherEmpty && currentTypingMethod == .vChewingFactory
   }
 
   // MARK: - Functions dealing with Megrez.
 
   public var isCompositorEmpty: Bool { compositor.isEmpty }
 
+  func isInvalidEdgeCursorSituation(givenCursor: Int? = nil) -> Bool {
+    let cursorToCheck = givenCursor ?? compositor.cursor
+    // prefs.useRearCursorMode 為 0 (false) 時（macOS 注音選字），最後方的游標位置不合邏輯。
+    // prefs.useRearCursorMode 為 1 (true) 時（微軟新注音選字），最前方的游標位置不合邏輯。
+    switch prefs.useRearCursorMode {
+    case false where cursorToCheck == 0: return true
+    case true where cursorToCheck == compositor.length: return true
+    default: return false
+    }
+  }
+
+  public func removeBackupCursor() {
+    backupCursor = nil
+  }
+
+  public func dodgeInvalidEdgeCursorForCandidateState() {
+    guard !prefs.useSCPCTypingMode else { return }
+    guard prefs.dodgeInvalidEdgeCandidateCursorPosition else { return }
+    guard isInvalidEdgeCursorSituation() else { return }
+    backupCursor = compositor.cursor
+    switch prefs.useRearCursorMode {
+    case false where compositor.cursor < compositor.length:
+      compositor.cursor += 1
+      if isCursorCuttingChar() { compositor.jumpCursorBySpan(to: .front) }
+    case true where compositor.cursor > 0:
+      compositor.cursor -= 1
+      if isCursorCuttingChar() { compositor.jumpCursorBySpan(to: .rear) }
+    default: break
+    }
+  }
+
+  public func restoreBackupCursor() {
+    guard let theBackupCursor = backupCursor else { return }
+    compositor.cursor = Swift.max(Swift.min(theBackupCursor, compositor.length), 0)
+    backupCursor = nil
+  }
+
   /// 獲取當前標記得範圍。這個函式只能是函式、而非只讀變數。
   /// - Returns: 當前標記範圍。
   func currentMarkedRange() -> Range<Int> {
@@ -198,18 +213,44 @@ public class InputHandler: InputHandlerProtocol {
     }
   }
 
-  /// 用以組建聯想詞陣列的函式。
-  /// - Parameter key: 給定的聯想詞的開頭字。
-  /// - Returns: 抓取到的聯想詞陣列。
+  /// 用以組建關聯詞語陣列的函式，生成的內容不包含重複的結果。
+  /// - Parameter pairs: 給定的詞音配對陣列。
+  /// - Returns: 抓取到的關聯詞語陣列。
   /// 不會是 nil，但那些負責接收結果的函式會對空白陣列結果做出正確的處理。
-  func generateArrayOfAssociates(withPair pair: Megrez.KeyValuePaired) -> [(keyArray: [String], value: String)] {
+  func generateArrayOfAssociates(withPairs pairs: [Megrez.KeyValuePaired]) -> [(keyArray: [String], value: String)] {
     var arrResult: [(keyArray: [String], value: String)] = []
-    if currentLM.hasAssociatedPhrasesFor(pair: pair) {
-      arrResult = currentLM.associatedPhrasesFor(pair: pair).map { ([""], $0) }
+    pairs.forEach { pair in
+      if currentLM.hasAssociatedPhrasesFor(pair: pair) {
+        let arrFetched: [String] = currentLM.associatedPhrasesFor(pair: pair)
+        arrFetched.forEach { thingToAdd in
+          // keyArray 對關聯詞語候選字詞而言（現階段）毫無意義。這裡只判斷 value。
+          if !arrResult.map(\.value).contains(thingToAdd) {
+            arrResult.append((keyArray: [""], value: thingToAdd))
+          }
+        }
+      }
     }
     return arrResult
   }
 
+  /// 用以組建關聯詞語陣列的函式，生成的內容不包含重複的結果。
+  /// - Parameter pair: 給定的詞音配對。
+  /// - Returns: 抓取到的關聯詞語陣列。
+  /// 不會是 nil，但那些負責接收結果的函式會對空白陣列結果做出正確的處理。
+  func generateArrayOfAssociates(withPair pair: Megrez.KeyValuePaired) -> [(keyArray: [String], value: String)] {
+    var pairs = [Megrez.KeyValuePaired]()
+    var keyArray = pair.keyArray
+    var value = pair.value
+    while !keyArray.isEmpty {
+      // 關聯詞語處理用不到組字引擎，故不需要 score。
+      if keyArray.count == value.count { pairs.append(.init(keyArray: keyArray, value: value)) }
+      pairs.append(.init(key: "", value: value)) // 保底。
+      keyArray = Array(keyArray.dropFirst())
+      value = value.dropFirst().description
+    }
+    return generateArrayOfAssociates(withPairs: pairs)
+  }
+
   /// 用來計算離當前游標最近的一個節點邊界的距離的函式。
   /// - Parameter direction: 文字輸入方向意義上的方向。
   /// - Returns: 邊界距離。
@@ -325,8 +366,8 @@ public class InputHandler: InputHandlerProtocol {
     let currentNode = currentWalk.findNode(at: actualNodeCursorPosition, target: &accumulatedCursor)
     guard let currentNode = currentNode else { return }
 
-    uom: if currentNode.currentUnigram.score > -12, prefs.fetchSuggestionsFromUserOverrideModel {
-      if skipObservation { break uom }
+    uomProcessing: if currentNode.currentUnigram.score > -12, prefs.fetchSuggestionsFromUserOverrideModel {
+      if skipObservation { break uomProcessing }
       vCLog("UOM: Start Observation.")
       // 這個過程可能會因為使用者半衰記憶模組內部資料錯亂、而導致輸入法在選字時崩潰。
       // 於是在這裡引入災後狀況察覺專用變數，且先開啟該開關。順利執行完觀察後會關閉。
@@ -334,9 +375,9 @@ public class InputHandler: InputHandlerProtocol {
       prefs.failureFlagForUOMObservation = true
       // 令半衰記憶模組觀測給定的三元圖。
       // 這個過程會讓半衰引擎根據當前上下文生成三元圖索引鍵。
-      currentUOM.performObservation(
+      currentLM.performUOMObservation(
         walkedBefore: previousWalk, walkedAfter: currentWalk, cursor: actualNodeCursorPosition,
-        timestamp: Date().timeIntervalSince1970, saveCallback: { self.currentUOM.saveData() }
+        timestamp: Date().timeIntervalSince1970
       )
       // 如果沒有出現崩框的話，那就將這個開關復位。
       prefs.failureFlagForUOMObservation = false
@@ -388,7 +429,7 @@ public class InputHandler: InputHandlerProtocol {
     /// 如果這個開關沒打開的話，直接放棄執行這個函式。
     if !prefs.fetchSuggestionsFromUserOverrideModel { return arrResult }
     /// 獲取來自半衰記憶模組的建議結果
-    let suggestion = currentUOM.fetchSuggestion(
+    let suggestion = currentLM.fetchUOMSuggestion(
       currentWalk: compositor.walkedNodes, cursor: actualNodeCursorPosition, timestamp: Date().timeIntervalSince1970
     )
     arrResult.append(contentsOf: suggestion.candidates)
@@ -559,7 +600,7 @@ public class InputHandler: InputHandlerProtocol {
     if prefs.halfWidthPunctuationEnabled { return "_half_punctuation_" }
     // 注意：這一行為 SHIFT+ALT+主鍵盤數字鍵專用，強制無視不同地區的鍵盤在這個按鍵組合下的符號輸入差異。
     // 但如果去掉「input.isMainAreaNumKey」這個限定條件的話，可能會影響其他依賴 Shift 鍵輸入的符號。
-    if input.isMainAreaNumKey, input.keyModifierFlags == [.option, .shift] { return "_shift_alt_punctuation_" }
+    if input.isMainAreaNumKey, input.commonKeyModifierFlags == [.option, .shift] { return "_shift_alt_punctuation_" }
     var result = ""
     switch (input.isControlHold, input.isOptionHold) {
     case (true, true): result.append("_alt_ctrl_punctuation_")

Packages/vChewing_MainAssembly/Sources/MainAssembly/InputHandler/InputHandler_HandleCandidate.swift

@@ -9,22 +9,68 @@
 /// 該檔案乃輸入調度模組當中「用來規定在選字窗出現時的按鍵行為」的部分。
 
 import CandidateWindow
-import CocoaExtension
 import InputMethodKit
+import Megrez
+import OSFrameworkImpl
 import Shared
 
 // MARK: - § 對選字狀態進行調度 (Handle Candidate State).
 
 extension InputHandler {
   /// 當且僅當選字窗出現時，對於經過初次篩選處理的輸入訊號的處理均藉由此函式來進行。
-  /// - Parameter input: 輸入訊號。
+  /// - Parameters:
+  ///   - input: 輸入訊號。
+  ///   - ignoringModifiers: 是否需要忽視修飾鍵。
   /// - Returns: 告知 IMK「該按鍵是否已經被輸入法攔截處理」。
-  func handleCandidate(input: InputSignalProtocol) -> Bool {
+  func handleCandidate(input: InputSignalProtocol, ignoringModifiers: Bool = false) -> Bool {
     guard let delegate = delegate else { return false }
     guard var ctlCandidate = delegate.candidateController() else { return false }
     let state = delegate.state
     guard state.isCandidateContainer else { return false } // 會自動判斷「isEmpty」。
     guard ctlCandidate.visible else { return false }
+    let inputText = ignoringModifiers ? (input.inputTextIgnoringModifiers ?? input.text) : input.text
+    let allowMovingCompositorCursor = state.type == .ofCandidates && !prefs.useSCPCTypingMode
+    let highlightedCandidate = state.candidates[ctlCandidate.highlightedIndex]
+
+    // MARK: 選字窗服務選單（Shift+?）。
+
+    var candidateTextServiceMenuRunning: Bool {
+      state.node.containsCandidateServices && state.type == .ofSymbolTable
+    }
+
+    serviceMenu: if prefs.useShiftQuestionToCallServiceMenu, input.commonKeyModifierFlags == .shift, input.text == "?" {
+      if candidateTextServiceMenuRunning { break serviceMenu }
+      let handled = handleServiceMenuInitiation(
+        candidateText: highlightedCandidate.value,
+        reading: highlightedCandidate.keyArray
+      )
+      if handled { return true }
+    }
+
+    // MARK: 波浪符號鍵（選字窗服務選單 / 輔助翻頁 / 其他功能）。
+
+    if input.isSymbolMenuPhysicalKey {
+      switch input.commonKeyModifierFlags {
+      case .shift, [],
+           .option where !candidateTextServiceMenuRunning:
+        if !candidateTextServiceMenuRunning {
+          let handled = handleServiceMenuInitiation(
+            candidateText: highlightedCandidate.value,
+            reading: highlightedCandidate.keyArray
+          )
+          if handled { return true }
+        }
+        var updated = true
+        let reverseTrigger = input.isShiftHold || input.isOptionHold
+        updated = reverseTrigger ? ctlCandidate.showPreviousLine() : ctlCandidate.showNextLine()
+        if !updated { delegate.callError("66F3477B") }
+        return true
+      case .option where state.type == .ofSymbolTable:
+        // 繞過內碼輸入模式，直接進入漢音鍵盤符號模式。
+        return revolveTypingMethod(to: .haninKeyboardSymbol)
+      default: break
+      }
+    }
 
     // MARK: 選字窗內使用熱鍵升權、降權、刪詞。
 
@@ -35,7 +81,7 @@ extension InputHandler {
       if candidates[highlightedIndex].keyArray.count < 2 || candidates[highlightedIndex].value.count < 2 {
         break manipulator
       }
-      switch input.keyModifierFlags {
+      switch input.commonKeyModifierFlags {
       case [.option, .command] where input.keyCode == 27: // 減號鍵
         ctlCandidate.delegate?.candidatePairRightClicked(at: highlightedIndex, action: .toNerf)
         return true
@@ -57,11 +103,11 @@ extension InputHandler {
 
     // MARK: 取消選字 (Cancel Candidate)
 
-    let cancelCandidateKey =
+    let dismissingCandidateWindow =
       input.isBackSpace || input.isEsc || input.isDelete
-        || ((input.isCursorBackward || input.isCursorForward) && input.isShiftHold)
+        || ((input.isCursorBackward || input.isCursorForward) && input.commonKeyModifierFlags == .shift)
 
-    if cancelCandidateKey {
+    if dismissingCandidateWindow {
       if state.type == .ofAssociates
         || prefs.useSCPCTypingMode
         || compositor.isEmpty
@@ -73,7 +119,7 @@ extension InputHandler {
         delegate.switchState(IMEState.ofAbortion())
       } else {
         delegate.switchState(generateStateOfInputting())
-        if input.isCursorBackward || input.isCursorForward, input.isShiftHold {
+        if input.isCursorBackward || input.isCursorForward, input.commonKeyModifierFlags == .shift {
           return triageInput(event: input)
         }
       }
@@ -96,7 +142,21 @@ extension InputHandler {
           delegate.switchState(IMEState.ofAbortion())
           return true
         }
+        var handleAssociates = !prefs.useSCPCTypingMode && prefs.associatedPhrasesEnabled // 關聯詞語功能專用。
+        handleAssociates = handleAssociates && compositor.cursor == compositor.length // 關聯詞語功能專用。
         confirmHighlightedCandidate()
+        // 關聯詞語。
+        associatedPhrases: if handleAssociates {
+          guard handleAssociates else { break associatedPhrases }
+          guard input.commonKeyModifierFlags == .shift else { break associatedPhrases }
+          let pair = Megrez.KeyValuePaired(
+            keyArray: highlightedCandidate.keyArray, value: highlightedCandidate.value
+          )
+          let associatedCandidates = generateArrayOfAssociates(withPair: pair)
+          guard !associatedCandidates.isEmpty else { break associatedPhrases }
+          delegate.switchState(IMEState.ofCommitting(textToCommit: state.displayedText))
+          delegate.switchState(IMEState.ofAssociates(candidates: associatedCandidates))
+        }
         return true
       case .kTab:
         let updated: Bool =
@@ -131,18 +191,55 @@ extension InputHandler {
         _ = ctlCandidate.showPreviousPage() ? {}() : delegate.callError("9569955D")
         return true
       case .kUpArrow, .kDownArrow, .kLeftArrow, .kRightArrow:
-        handleArrowKey: switch (keyCodeType, ctlCandidate.currentLayout) {
-        case (.kLeftArrow, .horizontal), (.kUpArrow, .vertical): // Previous Candidate
-          _ = ctlCandidate.highlightPreviousCandidate()
-        case (.kRightArrow, .horizontal), (.kDownArrow, .vertical): // Next Candidate
-          _ = ctlCandidate.highlightNextCandidate()
-        case (.kUpArrow, .horizontal), (.kLeftArrow, .vertical): // Previous Line
-          _ = ctlCandidate.showPreviousLine()
-        case (.kDownArrow, .horizontal), (.kRightArrow, .vertical): // Next Line
-          _ = ctlCandidate.showNextLine()
-        default: break handleArrowKey
+        switch input.commonKeyModifierFlags {
+        case [.option, .shift] where allowMovingCompositorCursor && input.isCursorForward:
+          if compositor.cursor < compositor.length {
+            compositor.cursor += 1
+            if isCursorCuttingChar() { compositor.jumpCursorBySpan(to: .front) }
+            delegate.switchState(generateStateOfCandidates())
+          } else {
+            delegate.callError("D3006C85")
+          }
+          return true
+        case [.option, .shift] where allowMovingCompositorCursor && input.isCursorBackward:
+          if compositor.cursor > 0 {
+            compositor.cursor -= 1
+            if isCursorCuttingChar() { compositor.jumpCursorBySpan(to: .rear) }
+            delegate.switchState(generateStateOfCandidates())
+          } else {
+            delegate.callError("DE9DAF0D")
+          }
+          return true
+        case .option where input.isCursorForward:
+          if compositor.cursor < compositor.length {
+            compositor.jumpCursorBySpan(to: .front)
+            delegate.switchState(generateStateOfCandidates())
+          } else {
+            delegate.callError("5D9F4819")
+          }
+          return true
+        case .option where input.isCursorBackward:
+          if compositor.cursor > 0 {
+            compositor.jumpCursorBySpan(to: .rear)
+            delegate.switchState(generateStateOfCandidates())
+          } else {
+            delegate.callError("34B6322D")
+          }
+          return true
+        default:
+          handleArrowKey: switch (keyCodeType, ctlCandidate.currentLayout) {
+          case (.kLeftArrow, .horizontal), (.kUpArrow, .vertical): // Previous Candidate
+            _ = ctlCandidate.highlightPreviousCandidate()
+          case (.kRightArrow, .horizontal), (.kDownArrow, .vertical): // Next Candidate
+            _ = ctlCandidate.highlightNextCandidate()
+          case (.kUpArrow, .horizontal), (.kLeftArrow, .vertical): // Previous Line
+            _ = ctlCandidate.showPreviousLine()
+          case (.kDownArrow, .horizontal), (.kRightArrow, .vertical): // Next Line
+            _ = ctlCandidate.showNextLine()
+          default: break handleArrowKey
+          }
+          return true
         }
-        return true
       case .kHome:
         _ =
           (ctlCandidate.highlightedIndex == 0)
@@ -158,21 +255,54 @@ extension InputHandler {
       }
     }
 
-    // MARK: 聯想詞處理 (Associated Phrases) 以及標準選字處理
+    // MARK: J / K 鍵組字區的游標移動行為處理
+
+    let allowMovingCompositorCursorByJK = allowMovingCompositorCursor && prefs.useJKtoMoveCompositorCursorInCandidateState
+
+    checkMovingCompositorCursorByJK: if allowMovingCompositorCursorByJK {
+      guard input.keyModifierFlags.isEmpty else { break checkMovingCompositorCursorByJK }
+      // keycode: 38 = J, 40 = K.
+      switch input.keyCode {
+      case 38:
+        if compositor.cursor > 0 {
+          compositor.cursor -= 1
+          if isCursorCuttingChar() { compositor.jumpCursorBySpan(to: .rear) }
+          delegate.switchState(generateStateOfCandidates())
+        } else {
+          delegate.callError("6F389AE9")
+        }
+        return true
+      case 40:
+        if compositor.cursor < compositor.length {
+          compositor.cursor += 1
+          if isCursorCuttingChar() { compositor.jumpCursorBySpan(to: .front) }
+          delegate.switchState(generateStateOfCandidates())
+        } else {
+          delegate.callError("EDBD27F2")
+        }
+        return true
+      default: break checkMovingCompositorCursorByJK
+      }
+    }
+
+    // MARK: 關聯詞語處理 (Associated Phrases) 以及標準選字處理
 
     if state.type == .ofAssociates, !input.isShiftHold { return false }
 
     var index: Int?
     var shaltShiftHold = [.ofAssociates].contains(state.type)
-    if [.ofInputting].contains(state.type) {
+    if state.type == .ofInputting {
       let cassetteShift = currentLM.areCassetteCandidateKeysShiftHeld
       shaltShiftHold = shaltShiftHold || cassetteShift
     }
-    let matched: String = shaltShiftHold ? input.inputTextIgnoringModifiers ?? "" : input.text
-    checkSelectionKey: for keyPair in delegate.selectionKeys.enumerated() {
-      guard matched.lowercased() == keyPair.element.lowercased() else { continue }
-      index = Int(keyPair.offset)
-      break checkSelectionKey
+    let matched: String = (shaltShiftHold ? input.inputTextIgnoringModifiers ?? "" : inputText).lowercased()
+    // 如果允許 J / K 鍵前後移動組字區游標的話，則不再將 J / K 鍵盤視為選字鍵。
+    if !(prefs.useJKtoMoveCompositorCursorInCandidateState && "jk".contains(matched)) {
+      checkSelectionKey: for keyPair in delegate.selectionKeys.enumerated() {
+        guard matched == keyPair.element.lowercased() else { continue }
+        index = Int(keyPair.offset)
+        break checkSelectionKey
+      }
     }
 
     // 標準選字處理
@@ -194,27 +324,27 @@ extension InputHandler {
       let punctuationNamePrefix: String = generatePunctuationNamePrefix(withKeyCondition: input)
       let parser = currentKeyboardParser
       let arrCustomPunctuations: [String] = [
-        punctuationNamePrefix, parser, input.text,
+        punctuationNamePrefix, parser, inputText,
       ]
       let customPunctuation: String = arrCustomPunctuations.joined()
 
       /// 看看這個輸入是否是不需要修飾鍵的那種標點鍵輸入。
 
       let arrPunctuations: [String] = [
-        punctuationNamePrefix, input.text,
+        punctuationNamePrefix, inputText,
       ]
       let punctuation: String = arrPunctuations.joined()
 
       let isInputValid: Bool =
         prefs.cassetteEnabled
-          ? currentLM.isThisCassetteKeyAllowed(key: input.text) : composer.inputValidityCheck(key: input.charCode)
+          ? currentLM.isThisCassetteKeyAllowed(key: inputText) : composer.inputValidityCheck(key: input.charCode)
 
       var shouldAutoSelectCandidate: Bool =
         isInputValid || currentLM.hasUnigramsFor(keyArray: [customPunctuation])
           || currentLM.hasUnigramsFor(keyArray: [punctuation])
 
       if !shouldAutoSelectCandidate, input.isUpperCaseASCIILetterKey {
-        let letter = "_letter_\(input.text)"
+        let letter = "_letter_\(inputText)"
         if currentLM.hasUnigramsFor(keyArray: [letter]) { shouldAutoSelectCandidate = true }
       }
 
@@ -225,11 +355,11 @@ extension InputHandler {
       }
     }
 
-    // MARK: - Flipping pages by using modified bracket keys (when they are not occupied).
+    // MARK: Flipping pages by using modified bracket keys (when they are not occupied).
 
     // Shift+Command+[] 被 Chrome 系瀏覽器佔用，所以改用 Ctrl。
-    let ctrlCMD: Bool = input.keyModifierFlags == [.control, .command]
-    let ctrlShiftCMD: Bool = input.keyModifierFlags == [.control, .command, .shift]
+    let ctrlCMD: Bool = input.commonKeyModifierFlags == [.control, .command]
+    let ctrlShiftCMD: Bool = input.commonKeyModifierFlags == [.control, .command, .shift]
     if ctrlShiftCMD || ctrlCMD {
       // 此處 JIS 鍵盤判定無法用於螢幕鍵盤。所以，螢幕鍵盤的場合，系統會依照 US 鍵盤的判定方案。
       switch (input.keyCode, IMEApp.isKeyboardJIS) {
@@ -243,23 +373,6 @@ extension InputHandler {
       }
     }
 
-    // MARK: - Flipping pages by using symbol menu keys (when they are not occupied).
-
-    if input.isSymbolMenuPhysicalKey {
-      switch input.keyModifierFlags {
-      case .shift, [],
-           .option where state.type != .ofSymbolTable:
-        var updated = true
-        let reverseTrigger = input.isShiftHold || input.isOptionHold
-        updated = reverseTrigger ? ctlCandidate.showPreviousLine() : ctlCandidate.showNextLine()
-        if !updated { delegate.callError("66F3477B") }
-        return true
-      case .option where state.type == .ofSymbolTable:
-        return handleHaninKeyboardSymbolModeToggle()
-      default: break
-      }
-    }
-
     if state.type == .ofInputting { return false } // `%quick`
 
     delegate.callError("172A0F81")

Packages/vChewing_MainAssembly/Sources/MainAssembly/InputHandler/InputHandler_HandleComposition.swift

@@ -17,40 +17,29 @@ extension InputHandler {
   /// - 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 }
-      }
+    let hardRequirementMet = !input.text.isEmpty && input.charCode.isPrintable
+    switch currentTypingMethod {
+    case .codePoint where hardRequirementMet:
+      return handleCodePointComposition(input: input)
+    case .haninKeyboardSymbol where [[], .shift].contains(input.keyModifierFlags):
+      return handleHaninKeyboardSymbolModeInput(input: input)
+    case .vChewingFactory where hardRequirementMet && prefs.cassetteEnabled:
       return handleCassetteComposition(input: input)
+    case .vChewingFactory where hardRequirementMet && !prefs.cassetteEnabled:
+      return handlePhonabetComposition(input: input)
+    default: return nil
     }
-    return handlePhonabetComposition(input: input)
   }
+}
 
-  // MARK: 注音按鍵輸入處理 (Handle BPMF Keys)
+// MARK: - 注音按鍵輸入處理 (Handle BPMF Keys)
 
+private extension InputHandler {
   /// 用來處理 InputHandler.HandleInput() 當中的與注音输入有關的組字行為。
   /// - Parameter input: 輸入訊號。
   /// - Returns: 告知 IMK「該按鍵是否已經被輸入法攔截處理」。
-  private func handlePhonabetComposition(input: InputSignalProtocol) -> Bool? {
+  func handlePhonabetComposition(input: InputSignalProtocol) -> Bool? {
     guard let delegate = delegate else { return nil }
     var inputText = (input.inputTextIgnoringModifiers ?? input.text)
     inputText = inputText.lowercased().applyingTransformFW2HW(reverse: false)
@@ -67,6 +56,14 @@ extension InputHandler {
         || input.isControlHold || input.isOptionHold || input.isShiftHold || input.isCommandHold
     let confirmCombination = input.isSpace || input.isEnter
 
+    func narrateTheComposer(with maybeKey: String? = nil, when condition: Bool, allowDuplicates: Bool = true) {
+      guard condition else { return }
+      let maybeKey = maybeKey ?? composer.phonabetKeyForQuery(pronounceableOnly: prefs.acceptLeadingIntonations)
+      guard var keyToNarrate = maybeKey else { return }
+      if composer.intonation == Tekkon.Phonabet(" ") { keyToNarrate.append("ˉ") }
+      SpeechSputnik.shared.narrate(keyToNarrate, allowDuplicates: allowDuplicates)
+    }
+
     // 這裡 inputValidityCheck() 是讓注拼槽檢查 charCode 這個 UniChar 是否是合法的注音輸入。
     // 如果是的話，就將這次傳入的這個按鍵訊號塞入注拼槽內且標記為「keyConsumedByReading」。
     // 函式 composer.receiveKey() 可以既接收 String 又接收 UniChar。
@@ -100,6 +97,7 @@ extension InputHandler {
       // 鐵恨引擎並不具備對 Enter (CR / LF) 鍵的具體判斷能力，所以在這裡單獨處理。
       composer.receiveKey(fromString: confirmCombination ? " " : inputText)
       keyConsumedByReading = true
+      narrateTheComposer(when: !overrideHappened && prefs.readingNarrationCoverage >= 2, allowDuplicates: false)
 
       // 沒有調號的話，只需要 setInlineDisplayWithCursor() 且終止處理（return true）即可。
       // 有調號的話，則不需要這樣，而是轉而繼續在此之後的處理。
@@ -121,7 +119,7 @@ extension InputHandler {
         return handleEnter(input: input, readingOnly: true)
       }
       // 拿取用來進行索引檢索用的注音。這裡先不急著處理「僅有注音符號輸入」的情況。
-      let maybeKey = composer.phonabetKeyForQuery(pronouncable: prefs.acceptLeadingIntonations)
+      let maybeKey = composer.phonabetKeyForQuery(pronounceableOnly: prefs.acceptLeadingIntonations)
       guard let readingKey = maybeKey else { break ifComposeReading }
       // 向語言模型詢問是否有對應的記錄。
       if !currentLM.hasUnigramsFor(keyArray: [readingKey]) {
@@ -150,6 +148,8 @@ extension InputHandler {
       } else if !compositor.insertKey(readingKey) {
         delegate.callError("3CF278C9: 得檢查對應的語言模組的 hasUnigramsFor() 是否有誤判之情形。")
         return true
+      } else {
+        narrateTheComposer(with: readingKey, when: prefs.readingNarrationCoverage == 1)
       }
 
       // 讓組字器反爬軌格。
@@ -186,8 +186,12 @@ extension InputHandler {
           delegate.switchState(IMEState.ofCommitting(textToCommit: text))
 
           if prefs.associatedPhrasesEnabled {
-            let associatedPhrases = generateStateOfAssociates(withPair: .init(keyArray: reading, value: text))
-            delegate.switchState(associatedPhrases.candidates.isEmpty ? IMEState.ofEmpty() : associatedPhrases)
+            let associatedCandidates = generateArrayOfAssociates(withPairs: [.init(keyArray: reading, value: text)])
+            delegate.switchState(
+              associatedCandidates.isEmpty
+                ? IMEState.ofEmpty()
+                : IMEState.ofAssociates(candidates: associatedCandidates)
+            )
           }
         default: break
         }
@@ -200,7 +204,7 @@ extension InputHandler {
     /// 但這裡不處理陰平聲調。
     if keyConsumedByReading {
       // 此處將 strict 設為 false，以應對「僅有注音符號輸入」的情況。
-      if composer.phonabetKeyForQuery(pronouncable: false) == nil {
+      if composer.phonabetKeyForQuery(pronounceableOnly: false) == nil {
         // 將被空格鍵覆蓋掉的既有聲調塞入組字器。
         if !composer.isPinyinMode, input.isSpace,
            compositor.insertKey(existedIntonation.value)
@@ -229,13 +233,31 @@ extension InputHandler {
 
 // MARK: - 磁帶模式的組字支援。
 
-extension InputHandler {
-  /// 用來處理 InputHandler.HandleInput() 當中的與磁帶模組有關的組字行為。
+private extension InputHandler {
+  /// 用來處理 InputHandler.HandleInput() 當中的與磁帶模組有關的組字行為。（前置處理）
   /// - Parameter input: 輸入訊號。
   /// - Returns: 告知 IMK「該按鍵是否已經被輸入法攔截處理」。
-  private func handleCassetteComposition(input: InputSignalProtocol) -> Bool? {
+  func handleCassetteComposition(input: InputSignalProtocol) -> Bool? {
     guard let delegate = delegate else { return nil }
     let state = delegate.state
+
+    // 準備處理 `%quick` 選字行為。
+    var handleQuickCandidate = true
+    if currentLM.areCassetteCandidateKeysShiftHeld { handleQuickCandidate = input.isShiftHold }
+    let hasQuickCandidates: Bool = state.type == .ofInputting && state.isCandidateContainer
+
+    // 處理 `%symboldef` 選字行為。
+    if handleCassetteSymbolTable(input: input) {
+      return true
+    } else if hasQuickCandidates, input.text != currentLM.cassetteWildcardKey {
+      // 處理 `%quick` 選字行為（當且僅當與 `%symboldef` 衝突的情況下）。
+      guard !(handleQuickCandidate && handleCandidate(input: input, ignoringModifiers: true)) else { return true }
+    } else {
+      // 處理 `%quick` 選字行為。
+      guard !(hasQuickCandidates && handleQuickCandidate && handleCandidate(input: input)) else { return true }
+    }
+
+    // 正式處理。
     var wildcardKey: String { currentLM.cassetteWildcardKey } // 花牌鍵。
     let inputText = input.text
     let isWildcardKeyInput: Bool = (inputText == wildcardKey && !wildcardKey.isEmpty)
@@ -254,7 +276,7 @@ extension InputHandler {
       calligrapher.count >= currentLM.maxCassetteKeyLength || isLongestPossibleKeyFormed
     }
 
-    prehandling: if !skipStrokeHandling && currentLM.isThisCassetteKeyAllowed(key: inputText) {
+  prehandling: if !skipStrokeHandling && currentLM.isThisCassetteKeyAllowed(key: inputText) {
       if calligrapher.isEmpty, isWildcardKeyInput {
         delegate.callError("3606B9C0")
         if input.beganWithLetter {
@@ -348,20 +370,24 @@ extension InputHandler {
       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.0.joined(separator: compositor.separator)
+          let reading: [String] = firstCandidate.keyArray
           let text: String = firstCandidate.value
           delegate.switchState(IMEState.ofCommitting(textToCommit: text))
 
           if prefs.associatedPhrasesEnabled {
-            let associatedPhrases = generateStateOfAssociates(withPair: .init(keyArray: [reading], value: text))
-            delegate.switchState(associatedPhrases.candidates.isEmpty ? IMEState.ofEmpty() : associatedPhrases)
+            let associatedCandidates = generateArrayOfAssociates(withPairs: [.init(keyArray: reading, value: text)])
+            delegate.switchState(
+              associatedCandidates.isEmpty
+                ? IMEState.ofEmpty()
+                : IMEState.ofAssociates(candidates: associatedCandidates)
+            )
           }
         default: break
         }
@@ -369,16 +395,17 @@ extension InputHandler {
       // 將「這個按鍵訊號已經被輸入法攔截處理了」的結果藉由 SessionCtl 回報給 IMK。
       return true
     }
-
     return nil
   }
+}
 
-  // MARK: 內碼區位輸入處理 (Handle Code Point Input)
+// MARK: - 內碼區位輸入處理 (Handle Code Point Input)
 
+private extension InputHandler {
   /// 用來處理 InputHandler.HandleInput() 當中的與內碼區位輸入有關的組字行為。
   /// - Parameter input: 輸入訊號。
   /// - Returns: 告知 IMK「該按鍵是否已經被輸入法攔截處理」。
-  private func handleCodePointComposition(input: InputSignalProtocol) -> Bool? {
+  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 {
@@ -391,27 +418,20 @@ extension InputHandler {
         strCodePointBuffer.append(input.text)
         var updatedState = generateStateOfInputting(guarded: true)
         updatedState.tooltipDuration = 0
-        updatedState.tooltip = tooltipCodePointInputMode
+        updatedState.tooltip = TypingMethod.codePoint.getTooltip(vertical: delegate.isVerticalTyping)
         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
+        .parsedAsHexLiteral(encoding: IMEApp.currentInputMode.nonUTFEncoding)?.first?.description
       else {
         delegate.callError("D220B880：輸入的字碼沒有對應的字元。")
         var updatedState = IMEState.ofAbortion()
         updatedState.tooltipDuration = 0
         updatedState.tooltip = "Invalid Code Point.".localized
         delegate.switchState(updatedState)
-        isCodePointInputMode = true
+        currentTypingMethod = .codePoint
         return true
       }
       // 某些舊版 macOS 會在這裡生成的字元後面插入垃圾字元。這裡只保留起始字元。
@@ -419,14 +439,46 @@ extension InputHandler {
       delegate.switchState(IMEState.ofCommitting(textToCommit: char))
       var updatedState = generateStateOfInputting(guarded: true)
       updatedState.tooltipDuration = 0
-      updatedState.tooltip = tooltipCodePointInputMode
+      updatedState.tooltip = TypingMethod.codePoint.getTooltip(vertical: delegate.isVerticalTyping)
       delegate.switchState(updatedState)
-      isCodePointInputMode = true
+      currentTypingMethod = .codePoint
       return true
     default:
       delegate.switchState(generateStateOfInputting())
-      isCodePointInputMode = true
+      currentTypingMethod = .codePoint
       return true
     }
   }
 }
+
+// MARK: - 處理漢音鍵盤符號輸入狀態（Handle Hanin Keyboard Symbol Inputs）
+
+private extension InputHandler {
+  /// 處理漢音鍵盤符號輸入。
+  /// - Parameters:
+  ///   - input: 輸入按鍵訊號。
+  /// - Returns: 將按鍵行為「是否有處理掉」藉由 SessionCtl 回報給 IMK。
+  func handleHaninKeyboardSymbolModeInput(input: InputSignalProtocol) -> Bool {
+    guard let delegate = delegate, delegate.state.type != .ofDeactivated else { return false }
+    let charText = input.text.lowercased().applyingTransformFW2HW(reverse: false)
+    guard CandidateNode.mapHaninKeyboardSymbols.keys.contains(charText) else {
+      return revolveTypingMethod(to: .vChewingFactory)
+    }
+    guard
+      charText.count == 1, let symbols = CandidateNode.queryHaninKeyboardSymbols(char: charText)
+    else {
+      delegate.callError("C1A760C7")
+      return true
+    }
+    // 得在這裡先 commit buffer，不然會導致「在摁 ESC 離開符號選單時會重複輸入上一次的組字區的內容」的不當行為。
+    let textToCommit = generateStateOfInputting(sansReading: true).displayedText
+    delegate.switchState(IMEState.ofCommitting(textToCommit: textToCommit))
+    if symbols.members.count == 1 {
+      delegate.switchState(IMEState.ofCommitting(textToCommit: symbols.members.map(\.name).joined()))
+    } else {
+      delegate.switchState(IMEState.ofSymbolTable(node: symbols))
+    }
+    currentTypingMethod = .vChewingFactory // 用完就關掉，但保持選字窗開啟，所以這裡不用呼叫 toggle 函式。
+    return true
+  }
+}

Packages/vChewing_MainAssembly/Sources/MainAssembly/InputHandler/InputHandler_HandleStates.swift

@@ -25,18 +25,20 @@ extension InputHandler {
   /// - Returns: 生成的「正在輸入」狀態。
   public func generateStateOfInputting(sansReading: Bool = false, guarded: Bool = false) -> IMEStateProtocol {
     if isConsideredEmptyForNow, !guarded { return IMEState.ofAbortion() }
+    restoreBackupCursor() // 只要叫了 Inputting 狀態，就盡可能還原游標備份。
     var segHighlightedAt: Int?
-    let cpInput = isCodePointInputMode && !sansReading
+    let handleAsCodePointInput = currentTypingMethod == .codePoint && !sansReading
     /// 「更新內文組字區 (Update the composing buffer)」是指要求客體軟體將組字緩衝區的內容
     /// 換成由此處重新生成的原始資料在 IMEStateData 當中生成的 NSAttributeString。
-    var displayTextSegments: [String] = cpInput
+    var displayTextSegments: [String] = handleAsCodePointInput
       ? [strCodePointBuffer]
       : compositor.walkedNodes.values
-    var cursor = cpInput
+    var cursor = handleAsCodePointInput
       ? displayTextSegments.joined().count
       : convertCursorForDisplay(compositor.cursor)
     let cursorSansReading = cursor
-    let reading: String = (sansReading || isCodePointInputMode) ? "" : readingForDisplay // 先提出來，減輕運算負擔。
+    // 先提出來讀音資料，減輕運算負擔。
+    let reading: String = (sansReading || currentTypingMethod == .codePoint) ? "" : readingForDisplay
     if !reading.isEmpty {
       var newDisplayTextSegments = [String]()
       var temporaryNode = ""
@@ -134,11 +136,15 @@ extension InputHandler {
 
   /// 拿著給定的候選字詞陣列資料內容，切換至選字狀態。
   /// - Returns: 回呼一個新的選詞狀態，來就給定的候選字詞陣列資料內容顯示選字窗。
-  public func generateStateOfCandidates() -> IMEStateProtocol {
+  public func generateStateOfCandidates(dodge: Bool = true) -> IMEStateProtocol {
+    guard let delegate = delegate else { return IMEState.ofAbortion() }
+    if dodge, delegate.state.type == .ofInputting {
+      dodgeInvalidEdgeCursorForCandidateState()
+    }
     var result = IMEState.ofCandidates(
       candidates: generateArrayOfCandidates(fixOrder: prefs.useFixedCandidateOrderOnSelection),
       displayTextSegments: compositor.walkedNodes.values,
-      cursor: delegate?.state.cursor ?? generateStateOfInputting().cursor
+      cursor: compositor.cursor
     )
     if !prefs.useRearCursorMode {
       let markerBackup = compositor.marker
@@ -149,23 +155,24 @@ extension InputHandler {
     return result
   }
 
-  // MARK: - 用以接收聯想詞陣列且生成狀態
+  // MARK: - 用以接收關聯詞語陣列且生成狀態
 
-  /// 拿著給定的聯想詞陣列資料內容，切換至聯想詞狀態。
+  /// 拿著給定的關聯詞語陣列資料內容，切換至關聯詞語狀態。
   ///
   /// 這次重寫時，針對「generateStateOfAssociates」這個（用以生成帶有
-  /// 聯想詞候選清單的結果的狀態回呼的）函式進行了小幅度的重構處理，使其始終
+  /// 關聯詞語候選清單的結果的狀態回呼的）函式進行了小幅度的重構處理，使其始終
   /// 可以從 Core 部分的「generateArrayOfAssociates」函式獲取到一個內容類型
-  /// 為「String」的標準 Swift 陣列。這樣一來，該聯想詞狀態回呼函式將始終能
+  /// 為「String」的標準 Swift 陣列。這樣一來，該關聯詞語狀態回呼函式將始終能
   /// 夠傳回正確的結果形態、永遠也無法傳回 nil。於是，所有在用到該函式時以
   /// 回傳結果類型判斷作為合法性判斷依據的函式，全都將依據改為檢查傳回的陣列
   /// 是否為空：如果陣列為空的話，直接回呼一個空狀態。
+  ///
+  /// 該函式僅用於 SessionCtl，因為 InputHandler 內部可以直接存取 generateArrayOfAssociates().
   /// - Parameters:
-  ///   - key: 給定的索引鍵（也就是給定的聯想詞的開頭字）。
-  /// - Returns: 回呼一個新的聯想詞狀態，來就給定的聯想詞陣列資料內容顯示選字窗。
+  ///   - key: 給定的索引鍵（也就是給定的關聯詞語的開頭字）。
+  /// - Returns: 回呼一個新的關聯詞語狀態，來就給定的關聯詞語陣列資料內容顯示選字窗。
   public func generateStateOfAssociates(withPair pair: Megrez.KeyValuePaired) -> IMEStateProtocol {
-    IMEState.ofAssociates(
-      candidates: generateArrayOfAssociates(withPair: pair))
+    IMEState.ofAssociates(candidates: generateArrayOfAssociates(withPair: pair))
   }
 
   // MARK: - 用以處理就地新增自訂語彙時的行為
@@ -342,103 +349,50 @@ extension InputHandler {
   // MARK: - Enter 鍵的處理，包括對其他修飾鍵的應對。
 
   /// Enter 鍵的處理。
-  /// - Parameter input: 輸入按鍵訊號。
+  /// - Parameters:
+  ///   - input: 輸入按鍵訊號。
+  ///   - readingOnly: 是否僅遞交讀音。
+  ///   - associatesData: 給定的關聯詞語資料陣列。
+  ///   該部分僅對 .ofInputting() 狀態有效、且不能是漢音符號模式與內碼輸入模式。
   /// - Returns: 將按鍵行為「是否有處理掉」藉由 SessionCtl 回報給 IMK。
-  @discardableResult func handleEnter(input: InputSignalProtocol, readingOnly: Bool = false) -> Bool {
+  @discardableResult func handleEnter(
+    input: InputSignalProtocol, readingOnly: Bool = false,
+    associatesData: @escaping () -> ([(keyArray: [String], value: String)]) = { [] }
+  ) -> Bool {
     guard let delegate = delegate else { return false }
     let state = delegate.state
 
-    if isHaninKeyboardSymbolMode { return handleHaninKeyboardSymbolModeToggle() }
-    if isCodePointInputMode { return handleCodePointInputToggle() }
+    guard currentTypingMethod == .vChewingFactory else {
+      return revolveTypingMethod(to: .vChewingFactory)
+    }
 
     guard state.type == .ofInputting else { return false }
 
     var displayedText = state.displayedText
 
-    if input.keyModifierFlags == [.option, .shift] {
+    if input.commonKeyModifierFlags == [.option, .shift] {
       displayedText = displayedText.map(\.description).joined(separator: " ")
     } else if readingOnly {
       displayedText = commissionByCtrlCommandEnter()
     } else if input.isCommandHold, input.isControlHold {
-      displayedText =
-        input.isOptionHold
-          ? commissionByCtrlOptionCommandEnter(isShiftPressed: input.isShiftHold)
-          : commissionByCtrlCommandEnter(isShiftPressed: input.isShiftHold)
+      displayedText = input.isOptionHold
+        ? commissionByCtrlOptionCommandEnter(isShiftPressed: input.isShiftHold)
+        : commissionByCtrlCommandEnter(isShiftPressed: input.isShiftHold)
     }
 
     delegate.switchState(IMEState.ofCommitting(textToCommit: displayedText))
+
+    associatedPhrases: if !prefs.useSCPCTypingMode, prefs.associatedPhrasesEnabled {
+      guard input.commonKeyModifierFlags == .shift else { break associatedPhrases }
+      guard isComposerOrCalligrapherEmpty else { break associatedPhrases }
+      let associatedCandidates = associatesData()
+      guard !associatedCandidates.isEmpty else { break associatedPhrases }
+      delegate.switchState(IMEState.ofAssociates(candidates: associatedCandidates))
+    }
+
     return true
   }
 
-  // MARK: - Command+Enter 鍵的處理（注音文）
-
-  /// Command+Enter 鍵的處理（注音文）。
-  /// - Parameter isShiftPressed: 有沒有同時摁著 Shift 鍵。
-  /// - Returns: 將按鍵行為「是否有處理掉」藉由 SessionCtl 回報給 IMK。
-  private func commissionByCtrlCommandEnter(isShiftPressed: Bool = false) -> String {
-    var displayedText = compositor.keys.joined(separator: "\t")
-    if compositor.isEmpty {
-      displayedText = readingForDisplay
-    }
-    if !prefs.cassetteEnabled {
-      if prefs.inlineDumpPinyinInLieuOfZhuyin {
-        if !compositor.isEmpty {
-          var arrDisplayedTextElements = [String]()
-          compositor.keys.forEach { key in
-            arrDisplayedTextElements.append(Tekkon.restoreToneOneInPhona(target: key)) // 恢復陰平標記
-          }
-          displayedText = arrDisplayedTextElements.joined(separator: "\t")
-        }
-        displayedText = Tekkon.cnvPhonaToHanyuPinyin(targetJoined: displayedText) // 注音轉拼音
-      }
-      if prefs.showHanyuPinyinInCompositionBuffer {
-        if compositor.isEmpty {
-          displayedText = displayedText.replacingOccurrences(of: "1", with: "")
-        }
-      }
-    }
-
-    displayedText = displayedText.replacingOccurrences(of: "\t", with: isShiftPressed ? "-" : " ")
-    return displayedText
-  }
-
-  // MARK: - Command+Option+Enter 鍵的處理（網頁 Ruby 注音文標記）
-
-  /// Command+Option+Enter 鍵的處理（網頁 Ruby 注音文標記）。
-  /// - Parameter isShiftPressed: 有沒有同時摁著 Shift 鍵。摁了的話則只遞交讀音字串。
-  /// - Returns: 將按鍵行為「是否有處理掉」藉由 SessionCtl 回報給 IMK。
-  private func commissionByCtrlOptionCommandEnter(isShiftPressed: Bool = false) -> String {
-    var composed = ""
-
-    compositor.walkedNodes.smashedPairs.forEach { key, value in
-      var key = key
-      if !prefs.cassetteEnabled {
-        key =
-          prefs.inlineDumpPinyinInLieuOfZhuyin
-            ? Tekkon.restoreToneOneInPhona(target: key) // 恢復陰平標記
-            : Tekkon.cnvPhonaToTextbookReading(target: key) // 恢復陰平標記
-
-        if prefs.inlineDumpPinyinInLieuOfZhuyin {
-          key = Tekkon.cnvPhonaToHanyuPinyin(targetJoined: key) // 注音轉拼音
-          key = Tekkon.cnvHanyuPinyinToTextbookStyle(targetJoined: key) // 轉教科書式標調
-        }
-      }
-
-      key = key.replacingOccurrences(of: "\t", with: " ")
-
-      if isShiftPressed {
-        if !composed.isEmpty { composed += " " }
-        composed += key.contains("_") ? "??" : key
-        return
-      }
-
-      // 不要給標點符號等特殊元素加注音
-      composed += key.contains("_") ? value : "<ruby>\(value)<rp>(</rp><rt>\(key)</rt><rp>)</rp></ruby>"
-    }
-
-    return composed
-  }
-
   // MARK: - 處理 BackSpace (macOS Delete) 按鍵行為
 
   /// 處理 BackSpace (macOS Delete) 按鍵行為。
@@ -449,62 +403,61 @@ extension InputHandler {
     guard let delegate = delegate else { return false }
     let state = delegate.state
     guard state.type == .ofInputting else {
-      isCodePointInputMode = false
+      currentTypingMethod = .vChewingFactory
       return false
     }
 
-    if isCodePointInputMode {
+    if currentTypingMethod == .codePoint {
       if !strCodePointBuffer.isEmpty {
         func refreshState() {
           var updatedState = generateStateOfInputting(guarded: true)
           updatedState.tooltipDuration = 0
-          updatedState.tooltip = tooltipCodePointInputMode
+          updatedState.tooltip = delegate.state.tooltip
           delegate.switchState(updatedState)
         }
         strCodePointBuffer = strCodePointBuffer.dropLast(1).description
-        if input.keyModifierFlags == .option {
-          strCodePointBuffer.removeAll()
-          refreshState()
-          isCodePointInputMode = true
-          return true
+        if input.commonKeyModifierFlags == .option {
+          return revolveTypingMethod(to: .codePoint)
         }
         if !strCodePointBuffer.isEmpty {
           refreshState()
           return true
         }
       }
-      return handleCodePointInputToggle()
+      return revolveTypingMethod(to: .vChewingFactory)
     }
 
     // 引入 macOS 內建注音輸入法的行為，允許用 Shift+BackSpace 解構前一個漢字的讀音。
-    shiftBksp: switch prefs.specifyShiftBackSpaceKeyBehavior {
-    case 0:
-      if prefs.cassetteEnabled {
-        guard input.isShiftHold, calligrapher.isEmpty else { break shiftBksp }
-        guard let prevReading = previousParsableCalligraph else { break shiftBksp }
-        compositor.dropKey(direction: .rear)
-        walk() // 這裡必須 Walk 一次、來更新目前被 walk 的內容。
-        calligrapher = prevReading
-      } else {
-        guard input.isShiftHold, isComposerOrCalligrapherEmpty else { break shiftBksp }
-        guard let prevReading = previousParsableReading else { break shiftBksp }
-        // prevReading 的內容分別是：「完整讀音」「去掉聲調的讀音」「是否有聲調」。
-        compositor.dropKey(direction: .rear)
-        walk() // 這裡必須 Walk 一次、來更新目前被 walk 的內容。
-        prevReading.1.map(\.description).forEach { composer.receiveKey(fromPhonabet: $0) }
+    shiftBksp: if input.commonKeyModifierFlags == .shift {
+      switch prefs.specifyShiftBackSpaceKeyBehavior {
+      case 0:
+        if prefs.cassetteEnabled {
+          guard input.isShiftHold, calligrapher.isEmpty else { break shiftBksp }
+          guard let prevReading = previousParsableCalligraph else { break shiftBksp }
+          compositor.dropKey(direction: .rear)
+          walk() // 這裡必須 Walk 一次、來更新目前被 walk 的內容。
+          calligrapher = prevReading
+        } else {
+          guard input.isShiftHold, isComposerOrCalligrapherEmpty else { break shiftBksp }
+          guard let prevReading = previousParsableReading else { break shiftBksp }
+          // prevReading 的內容分別是：「完整讀音」「去掉聲調的讀音」「是否有聲調」。
+          compositor.dropKey(direction: .rear)
+          walk() // 這裡必須 Walk 一次、來更新目前被 walk 的內容。
+          prevReading.1.map(\.description).forEach { composer.receiveKey(fromPhonabet: $0) }
+        }
+        delegate.switchState(generateStateOfInputting())
+        return true
+      case 1:
+        delegate.switchState(IMEState.ofAbortion())
+        return true
+      default: break
       }
-      delegate.switchState(generateStateOfInputting())
-      return true
-    case 1:
-      delegate.switchState(IMEState.ofAbortion())
-      return true
-    default: break
     }
 
     let steps = getStepsToNearbyNodeBorder(direction: .rear)
     var actualSteps = 1
 
-    switch input.keyModifierFlags {
+    switch input.commonKeyModifierFlags {
     case .shift:
       delegate.switchState(IMEState.ofAbortion())
       return true
@@ -523,7 +476,7 @@ extension InputHandler {
       }
       walk()
     } else {
-      _ = input.keyModifierFlags == .option
+      _ = input.commonKeyModifierFlags == .option
         ? clearComposerAndCalligrapher()
         : letComposerAndCalligrapherDoBackSpace()
     }
@@ -552,8 +505,9 @@ extension InputHandler {
     guard let delegate = delegate else { return false }
     let state = delegate.state
 
-    if isHaninKeyboardSymbolMode { return handleHaninKeyboardSymbolModeToggle() }
-    if isCodePointInputMode { return handleCodePointInputToggle() }
+    guard currentTypingMethod == .vChewingFactory else {
+      return revolveTypingMethod(to: .vChewingFactory)
+    }
 
     guard state.type == .ofInputting else { return false }
 
@@ -562,11 +516,11 @@ extension InputHandler {
 
     // macOS 認為 PC Delete 鍵訊號是必然有 .function 這個修飾鍵在起作用的。
     // 總之處理起來非常機車就是了。
-    switch input.keyModifierFlags {
-    case _ where input.isShiftHold && !input.isOptionHold && !input.isControlHold:
+    switch input.commonKeyModifierFlags {
+    case .shift:
       delegate.switchState(IMEState.ofAbortion())
       return true
-    case _ where !input.isShiftHold && input.isOptionHold && !input.isControlHold:
+    case .option:
       actualSteps = steps
     default: break
     }
@@ -661,8 +615,9 @@ extension InputHandler {
     guard let delegate = delegate else { return false }
     let state = delegate.state
 
-    if isHaninKeyboardSymbolMode { return handleHaninKeyboardSymbolModeToggle() }
-    if isCodePointInputMode { return handleCodePointInputToggle() }
+    guard currentTypingMethod == .vChewingFactory else {
+      return revolveTypingMethod(to: .vChewingFactory)
+    }
 
     guard state.type == .ofInputting else { return false }
 
@@ -897,73 +852,6 @@ extension InputHandler {
     return true
   }
 
-  // MARK: - 處理內碼區位輸入狀態的啟動過程（CodePoint Input Toggle）
-
-  @discardableResult func handleCodePointInputToggle() -> Bool {
-    guard let delegate = delegate, delegate.state.type != .ofDeactivated else { return false }
-    if isCodePointInputMode {
-      isCodePointInputMode = false
-      delegate.switchState(IMEState.ofAbortion())
-      return true
-    }
-    var updatedState = generateStateOfInputting(sansReading: true)
-    delegate.switchState(IMEState.ofCommitting(textToCommit: updatedState.displayedText))
-    updatedState = generateStateOfInputting(guarded: true)
-    updatedState.tooltipDuration = 0
-    updatedState.tooltip = tooltipCodePointInputMode
-    delegate.switchState(updatedState)
-    isCodePointInputMode = true
-    return true
-  }
-
-  // MARK: - 處理漢音鍵盤符號輸入狀態的啟動過程（Hanin Pallete）
-
-  @discardableResult func handleHaninKeyboardSymbolModeToggle() -> Bool {
-    guard let delegate = delegate, delegate.state.type != .ofDeactivated else { return false }
-    if isCodePointInputMode { isCodePointInputMode = false }
-    if isHaninKeyboardSymbolMode {
-      isHaninKeyboardSymbolMode = false
-      delegate.switchState(IMEState.ofAbortion())
-      return true
-    }
-    var updatedState = generateStateOfInputting(sansReading: true)
-    delegate.switchState(IMEState.ofCommitting(textToCommit: updatedState.displayedText))
-    updatedState = generateStateOfInputting(guarded: true)
-    updatedState.tooltipDuration = 0
-    updatedState.tooltip = Self.tooltipHaninKeyboardSymbolMode
-    delegate.switchState(updatedState)
-    isHaninKeyboardSymbolMode = true
-    return true
-  }
-
-  /// 處理漢音鍵盤符號輸入。
-  /// - Parameters:
-  ///   - input: 輸入按鍵訊號。
-  /// - Returns: 將按鍵行為「是否有處理掉」藉由 SessionCtl 回報給 IMK。
-  func handleHaninKeyboardSymbolModeInput(input: InputSignalProtocol) -> Bool {
-    guard let delegate = delegate, delegate.state.type != .ofDeactivated else { return false }
-    let charText = input.text.lowercased().applyingTransformFW2HW(reverse: false)
-    guard CandidateNode.mapHaninKeyboardSymbols.keys.contains(charText) else {
-      return handleHaninKeyboardSymbolModeToggle()
-    }
-    guard
-      charText.count == 1, let symbols = CandidateNode.queryHaninKeyboardSymbols(char: charText)
-    else {
-      delegate.callError("C1A760C7")
-      return true
-    }
-    // 得在這裡先 commit buffer，不然會導致「在摁 ESC 離開符號選單時會重複輸入上一次的組字區的內容」的不當行為。
-    let textToCommit = generateStateOfInputting(sansReading: true).displayedText
-    delegate.switchState(IMEState.ofCommitting(textToCommit: textToCommit))
-    if symbols.members.count == 1 {
-      delegate.switchState(IMEState.ofCommitting(textToCommit: symbols.members.map(\.name).joined()))
-    } else {
-      delegate.switchState(IMEState.ofSymbolTable(node: symbols))
-    }
-    isHaninKeyboardSymbolMode = false // 用完就關掉，但保持選字窗開啟，所以這裡不用呼叫 toggle 函式。
-    return true
-  }
-
   // MARK: - 處理符號選單（Symbol Menu Input）
 
   /// 處理符號選單。
@@ -983,7 +871,7 @@ extension InputHandler {
           inputting.textToCommit = textToCommit
           delegate.switchState(inputting)
           // 開始決定是否切換至選字狀態。
-          let newState = generateStateOfCandidates()
+          let newState = generateStateOfCandidates(dodge: false)
           _ = newState.candidates.isEmpty ? delegate.callError("B5127D8A") : delegate.switchState(newState)
         } else { // 不要在注音沒敲完整的情況下叫出統合符號選單。
           delegate.callError("17446655")
@@ -1010,6 +898,20 @@ extension InputHandler {
     }
   }
 
+  // MARK: - 處理選字窗服務選單 (Service Menu)
+
+  func handleServiceMenuInitiation(candidateText: String, reading: [String]) -> Bool {
+    guard let delegate = delegate, delegate.state.type != .ofDeactivated else { return false }
+    guard !candidateText.isEmpty else { return false }
+    let rootNode = CandidateTextService.getCurrentServiceMenu(candidate: candidateText, reading: reading)
+    guard let rootNode = rootNode else { return false }
+    // 得在這裡先 commit buffer，不然會導致「在摁 ESC 離開符號選單時會重複輸入上一次的組字區的內容」的不當行為。
+    let textToCommit = generateStateOfInputting(sansReading: true).displayedText
+    delegate.switchState(IMEState.ofCommitting(textToCommit: textToCommit))
+    delegate.switchState(IMEState.ofSymbolTable(node: rootNode))
+    return true
+  }
+
   // MARK: - 處理 Caps Lock 與英數輸入模式（Caps Lock and Alphanumerical mode）
 
   /// 處理 CapsLock 與英數輸入模式。
@@ -1027,11 +929,9 @@ extension InputHandler {
     delegate.switchState(IMEState.ofEmpty())
 
     // 字母鍵摁 Shift 的話，無須額外處理，因為直接就會敲出大寫字母。
-    if (input.isUpperCaseASCIILetterKey && delegate.isASCIIMode)
-      || (handleCapsLock && input.isShiftHold)
-    {
-      return false
-    }
+    var shiftCapsLockHandling = input.isUpperCaseASCIILetterKey && delegate.isASCIIMode
+    shiftCapsLockHandling = shiftCapsLockHandling || handleCapsLock && input.isShiftHold
+    guard !shiftCapsLockHandling else { return false }
 
     // 不再讓威注音處理由 Shift 切換到的英文模式的按鍵輸入。
     if delegate.isASCIIMode, !handleCapsLock { return false }
@@ -1060,7 +960,7 @@ extension InputHandler {
     // 另外，這裡不要用「!input.isFunctionKeyHold」，
     // 否則會導致對上下左右鍵與翻頁鍵的判斷失效。
     let notEmpty = state.hasComposition && !compositor.isEmpty && isComposerOrCalligrapherEmpty
-    let bannedModifiers: NSEvent.ModifierFlags = [.option, .shift, .command, .control]
+    let bannedModifiers: KBEvent.ModifierFlags = [.option, .shift, .command, .control]
     let noBannedModifiers = bannedModifiers.intersection(input.keyModifierFlags).isEmpty
     var triggered = input.isCursorClockLeft || input.isCursorClockRight
     triggered = triggered || (input.isSpace && prefs.chooseCandidateUsingSpace)
@@ -1127,6 +1027,35 @@ extension InputHandler {
     return false
   }
 
+  // MARK: - 處理數字小鍵盤的文字輸入行為（NumPad）
+
+  /// 處理數字小鍵盤的文字輸入行為。
+  /// - Parameter input: 輸入訊號。
+  /// - Returns: 告知 IMK「該按鍵是否已經被輸入法攔截處理」。
+  func handleNumPadKeyInput(input: InputSignalProtocol) -> Bool {
+    guard let delegate = delegate, input.isNumericPadKey else { return false }
+    let inputText = input.text
+    guard inputText.count == 1, input.isASCII else { return false }
+    guard KeyCode(rawValue: input.keyCode) == nil else { return false } // 排除功能鍵。
+    let behaviorValue = prefs.numPadCharInputBehavior
+    let fullWidthResult = behaviorValue % 2 != 0 // 能被二整除的都是半形。
+    triagePrefs: switch (behaviorValue, isConsideredEmptyForNow) {
+    case (2, _), (3, _), (4, false), (5, false):
+      currentLM.setOptions { config in
+        config.numPadFWHWStatus = fullWidthResult
+      }
+      if handlePunctuation("_NumPad_\(inputText)") { return true }
+    default: break triagePrefs // 包括 case 0 & 1。
+    }
+    currentLM.setOptions { config in
+      config.numPadFWHWStatus = nil
+    }
+    delegate.switchState(IMEState.ofEmpty())
+    let charToCommit = inputText.applyingTransformFW2HW(reverse: fullWidthResult)
+    delegate.switchState(IMEState.ofCommitting(textToCommit: charToCommit))
+    return true
+  }
+
   // MARK: - 處理磁帶模式的符號選單輸入
 
   func handleCassetteSymbolTable(input: InputSignalProtocol) -> Bool {

Packages/vChewing_MainAssembly/Sources/MainAssembly/InputHandler/InputHandler_MiscCommissions.swift

@@ -0,0 +1,125 @@
+// (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 BrailleSputnik
+import Shared
+import Tekkon
+
+/// 該檔案專門管理「用指定熱鍵遞交特殊的內容」的這一類函式。
+
+extension InputHandler {
+  // MARK: - (Shift+)Ctrl+Command+Enter 鍵的處理（注音文）
+
+  /// Command+Enter 鍵的處理（注音文）。
+  /// - Parameter isShiftPressed: 有沒有同時摁著 Shift 鍵。
+  /// - Returns: 將按鍵行為「是否有處理掉」藉由 SessionCtl 回報給 IMK。
+  func commissionByCtrlCommandEnter(isShiftPressed: Bool = false) -> String {
+    var displayedText = compositor.keys.joined(separator: "\t")
+    if compositor.isEmpty {
+      displayedText = readingForDisplay
+    }
+    if !prefs.cassetteEnabled {
+      if prefs.inlineDumpPinyinInLieuOfZhuyin {
+        if !compositor.isEmpty {
+          var arrDisplayedTextElements = [String]()
+          compositor.keys.forEach { key in
+            arrDisplayedTextElements.append(Tekkon.restoreToneOneInPhona(target: key)) // 恢復陰平標記
+          }
+          displayedText = arrDisplayedTextElements.joined(separator: "\t")
+        }
+        displayedText = Tekkon.cnvPhonaToHanyuPinyin(targetJoined: displayedText) // 注音轉拼音
+      }
+      if prefs.showHanyuPinyinInCompositionBuffer {
+        if compositor.isEmpty {
+          displayedText = displayedText.replacingOccurrences(of: "1", with: "")
+        }
+      }
+    }
+
+    displayedText = displayedText.replacingOccurrences(of: "\t", with: isShiftPressed ? "-" : " ")
+    return displayedText
+  }
+
+  // MARK: - (Shift+)Ctrl+Command+Option+Enter 鍵的處理（網頁 Ruby 注音文標記）
+
+  private enum CommitableMarkupType: Int {
+    case bareKeys = -1
+    case textWithBracketedAnnotations = 0
+    case textWithHTMLRubyAnnotations = 1
+    case braille1947 = 2
+    case braille2018 = 3
+
+    static func match(rawValue: Int) -> Self {
+      CommitableMarkupType(rawValue: rawValue) ?? .textWithBracketedAnnotations
+    }
+
+    var brailleStandard: BrailleSputnik.BrailleStandard? {
+      switch self {
+      case .braille1947: return .of1947
+      case .braille2018: return .of2018
+      default: return nil
+      }
+    }
+  }
+
+  /// Command+Option+Enter 鍵的處理（網頁 Ruby 注音文標記）。
+  ///
+  /// 關於 prefs.specifyCmdOptCtrlEnterBehavior 的幾個參數作用：
+  /// 1. 帶括弧的注音標記。
+  /// 2. HTML Ruby 注音標記。
+  /// 3. 國語點字 (1947)。
+  /// 4. 國通盲文 (GF0019-2018)。
+  /// - Parameter isShiftPressed: 有沒有同時摁著 Shift 鍵。摁了的話則只遞交讀音字串。
+  /// - Returns: 將按鍵行為「是否有處理掉」藉由 SessionCtl 回報給 IMK。
+  func commissionByCtrlOptionCommandEnter(isShiftPressed: Bool = false) -> String {
+    var behavior = CommitableMarkupType.match(rawValue: prefs.specifyCmdOptCtrlEnterBehavior)
+    if prefs.cassetteEnabled, behavior.brailleStandard != nil {
+      behavior = .textWithBracketedAnnotations
+    }
+    if isShiftPressed { behavior = .bareKeys }
+    guard let brailleStandard = behavior.brailleStandard else {
+      return specifyTextMarkupToCommit(behavior: behavior)
+    }
+    let brailleProcessor = BrailleSputnik(standard: brailleStandard)
+    return brailleProcessor.convertToBraille(
+      smashedPairs: compositor.walkedNodes.smashedPairs,
+      extraInsertion: (reading: composer.value, cursor: compositor.cursor)
+    )
+  }
+
+  private func specifyTextMarkupToCommit(behavior: CommitableMarkupType) -> String {
+    var composed = ""
+    compositor.walkedNodes.smashedPairs.forEach { key, value in
+      var key = key
+      if !prefs.cassetteEnabled {
+        key =
+          prefs.inlineDumpPinyinInLieuOfZhuyin
+            ? Tekkon.restoreToneOneInPhona(target: key) // 恢復陰平標記
+            : Tekkon.cnvPhonaToTextbookStyle(target: key) // 恢復陰平標記
+
+        if prefs.inlineDumpPinyinInLieuOfZhuyin {
+          key = Tekkon.cnvPhonaToHanyuPinyin(targetJoined: key) // 注音轉拼音
+          key = Tekkon.cnvHanyuPinyinToTextbookStyle(targetJoined: key) // 轉教科書式標調
+        }
+      }
+      key = key.replacingOccurrences(of: "\t", with: " ")
+      switch behavior {
+      case .bareKeys:
+        if !composed.isEmpty { composed += " " }
+        composed += key.contains("_") ? "??" : key
+      case .textWithBracketedAnnotations:
+        composed += key.contains("_") ? value : "\(value)(\(key))"
+      case .textWithHTMLRubyAnnotations:
+        composed += key.contains("_") ? value : "<ruby>\(value)<rp>(</rp><rt>\(key)</rt><rp>)</rp></ruby>"
+      case .braille1947: break // 另案處理
+      case .braille2018: break // 另案處理
+      }
+    }
+    return composed
+  }
+}

Packages/vChewing_MainAssembly/Sources/MainAssembly/InputHandler/InputHandler_TriageInput.swift

@@ -9,10 +9,11 @@
 /// 該檔案乃輸入調度模組當中「用來規定當 IMK 接受按鍵訊號時且首次交給輸入調度模組處理時、
 /// 輸入調度模組要率先處理」的部分。據此判斷是否需要將按鍵處理委派給其它成員函式。
 
-import CocoaExtension
 import IMKUtils
 import InputMethodKit
 import LangModelAssembly
+import Megrez
+import OSFrameworkImpl
 import Shared
 
 // MARK: - § 根據狀態調度按鍵輸入 (Handle Input with States) * Triage
@@ -21,7 +22,6 @@ public extension InputHandler {
   func triageInput(event input: InputSignalProtocol) -> Bool {
     guard let delegate = delegate else { return false }
     var state: IMEStateProtocol { delegate.state }
-    let inputText = input.text
 
     // MARK: - 按鍵碼分診（Triage by KeyCode）
 
@@ -45,22 +45,24 @@ public extension InputHandler {
       case .kEnd: return handleEnd()
       case .kBackSpace: return handleBackSpace(input: input)
       case .kWindowsDelete: return handleDelete(input: input)
-      case .kCarriageReturn, .kLineFeed: return handleEnter(input: input)
+      case .kCarriageReturn, .kLineFeed:
+        let frontNode = compositor.walkedNodes.last
+        return handleEnter(input: input) {
+          guard self.currentTypingMethod == .vChewingFactory else { return [] }
+          guard let frontNode = frontNode else { return [] }
+          let pair = Megrez.KeyValuePaired(keyArray: frontNode.keyArray, value: frontNode.value)
+          let associates = self.generateArrayOfAssociates(withPair: pair)
+          return associates
+        }
       case .kSymbolMenuPhysicalKeyJIS, .kSymbolMenuPhysicalKeyIntl:
         let isJIS = keyCodeType == .kSymbolMenuPhysicalKeyJIS
-        switch input.keyModifierFlags {
+        switch input.commonKeyModifierFlags {
         case []:
           return handlePunctuationList(alternative: false, isJIS: isJIS)
         case [.option, .shift]:
           return handlePunctuationList(alternative: true, isJIS: isJIS)
         case .option:
-          switch (isCodePointInputMode, isHaninKeyboardSymbolMode) {
-          case (false, false): return handleCodePointInputToggle()
-          case (true, false), (false, true):
-            return handleHaninKeyboardSymbolModeToggle()
-          default: break
-          }
-          return true
+          return revolveTypingMethod()
         default: break
         }
       case .kSpace:
@@ -77,7 +79,7 @@ public extension InputHandler {
           if input.isShiftHold, !input.isControlHold, !input.isOptionHold {
             return revolveCandidate(reverseOrder: input.isCommandHold)
           }
-          if isCodePointInputMode {
+          if currentTypingMethod == .codePoint {
             delegate.callError("FDD88EDB")
             delegate.switchState(IMEState.ofAbortion())
             return true
@@ -133,24 +135,18 @@ public extension InputHandler {
       }
 
       // 處理九宮格數字鍵盤區域。
-      if input.isNumericPadKey {
-        delegate.switchState(IMEState.ofEmpty())
-        delegate.switchState(IMEState.ofCommitting(textToCommit: inputText.lowercased()))
-        return true
-      }
+      if handleNumPadKeyInput(input: input) { return true }
 
       // 判斷是否響應傳統的漢音鍵盤符號模式熱鍵。
       haninSymbolInput: if prefs.classicHaninKeyboardSymbolModeShortcutEnabled {
         guard let x = input.inputTextIgnoringModifiers,
               "¥\\".contains(x), input.keyModifierFlags.isEmpty
         else { break haninSymbolInput }
-        return handleHaninKeyboardSymbolModeToggle()
+        return revolveTypingMethod(to: .haninKeyboardSymbol)
       }
 
-      // 注音按鍵輸入與漢音鍵盤符號輸入處理。
-      if isHaninKeyboardSymbolMode, [[], .shift].contains(input.keyModifierFlags) {
-        return handleHaninKeyboardSymbolModeInput(input: input)
-      } else if let compositionHandled = handleComposition(input: input) {
+      // 注音/磁帶按鍵輸入與漢音鍵盤符號輸入處理。
+      if let compositionHandled = handleComposition(input: input) {
         return compositionHandled
       }
 
@@ -159,8 +155,8 @@ public extension InputHandler {
 
       // Ctrl+Command+[] 輪替候選字。
       // Shift+Command+[] 被 Chrome 系瀏覽器佔用，所以改用 Ctrl。
-      let ctrlCMD: Bool = input.keyModifierFlags == [.control, .command]
-      let ctrlShiftCMD: Bool = input.keyModifierFlags == [.control, .command, .shift]
+      let ctrlCMD: Bool = input.commonKeyModifierFlags == [.control, .command]
+      let ctrlShiftCMD: Bool = input.commonKeyModifierFlags == [.control, .command, .shift]
       revolveCandidateWithBrackets: if ctrlShiftCMD || ctrlCMD {
         if state.type != .ofInputting { break revolveCandidateWithBrackets }
         // 此處 JIS 鍵盤判定無法用於螢幕鍵盤。所以，螢幕鍵盤的場合，系統會依照 US 鍵盤的判定方案。

Packages/vChewing_MainAssembly/Sources/MainAssembly/InputHandler/InputHandler_TypingMethod.swift

@@ -0,0 +1,77 @@
+// (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 Foundation
+import Shared
+import SwiftExtension
+
+// MARK: - Typing Method
+
+public extension InputHandler {
+  enum TypingMethod: Int, CaseIterable {
+    case vChewingFactory // 自動指派: 0
+    case codePoint // 自動指派: 1
+    case haninKeyboardSymbol // 自動指派: 2
+
+    mutating func revolveNext() {
+      var theInt = rawValue
+      theInt.revolveAsIndex(with: Self.allCases)
+      guard let nextMethod = TypingMethod(rawValue: theInt) else { return }
+      self = nextMethod
+    }
+
+    func getTooltip(vertical: Bool = false) -> String {
+      switch self {
+      case .vChewingFactory: return ""
+      case .codePoint:
+        let commonTerm = NSMutableString()
+        commonTerm.insert("Code Point Input.".localized, at: 0)
+        if !vertical, let initials = IMEApp.currentInputMode.nonUTFEncodingInitials {
+          commonTerm.insert("[\(initials)] ", at: 0)
+        }
+        return commonTerm.description
+      case .haninKeyboardSymbol:
+        return "\("Hanin Keyboard Symbol Input.".localized)"
+      }
+    }
+  }
+}
+
+// MARK: - Handle Rotation Toggles
+
+public extension InputHandler {
+  @discardableResult func revolveTypingMethod(to specifiedMethod: TypingMethod? = nil) -> Bool {
+    guard let delegate = delegate else { return false }
+    var newMethod = currentTypingMethod
+    if let specified = specifiedMethod {
+      newMethod = specified
+    } else {
+      newMethod.revolveNext()
+    }
+    /// 接下來這行必須這樣 defer 處理，
+    /// 因為再接下來的 switch newMethod 的過程會影響到 currentTypingMethod 參數。
+    defer {
+      currentTypingMethod = newMethod
+    }
+    switch newMethod {
+    case .vChewingFactory:
+      delegate.switchState(IMEState.ofAbortion())
+      return true
+    case .codePoint:
+      strCodePointBuffer.removeAll()
+    case .haninKeyboardSymbol: break
+    }
+    var updatedState = generateStateOfInputting(sansReading: true)
+    delegate.switchState(IMEState.ofCommitting(textToCommit: updatedState.displayedText))
+    updatedState = generateStateOfInputting(guarded: true)
+    updatedState.tooltipDuration = 0
+    updatedState.tooltip = newMethod.getTooltip(vertical: delegate.isVerticalTyping)
+    delegate.switchState(updatedState)
+    return true
+  }
+}

Packages/vChewing_MainAssembly/Sources/MainAssembly/LMMgr_Core.swift

@@ -1,273 +0,0 @@
-// (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 AppKit
-import LangModelAssembly
-import NotifierUI
-import Shared
-import SwiftExtension
-
-public class LMMgr {
-  public static var shared = LMMgr()
-  public private(set) static var lmCHS = vChewingLM.LMInstantiator(isCHS: true)
-  public private(set) static var lmCHT = vChewingLM.LMInstantiator(isCHS: false)
-  public private(set) static var uomCHS = vChewingLM.LMUserOverride(
-    dataURL: LMMgr.userOverrideModelDataURL(.imeModeCHS))
-  public private(set) static var uomCHT = vChewingLM.LMUserOverride(
-    dataURL: LMMgr.userOverrideModelDataURL(.imeModeCHT))
-
-  public static var currentLM: vChewingLM.LMInstantiator {
-    Self.getLM(mode: IMEApp.currentInputMode)
-  }
-
-  public static var currentUOM: vChewingLM.LMUserOverride {
-    Self.getUOM(mode: IMEApp.currentInputMode)
-  }
-
-  public static func getLM(mode: Shared.InputMode) -> vChewingLM.LMInstantiator {
-    switch mode {
-    case .imeModeCHS:
-      return Self.lmCHS
-    case .imeModeCHT:
-      return Self.lmCHT
-    case .imeModeNULL:
-      return .init()
-    }
-  }
-
-  public static func getUOM(mode: Shared.InputMode) -> vChewingLM.LMUserOverride {
-    switch mode {
-    case .imeModeCHS:
-      return Self.uomCHS
-    case .imeModeCHT:
-      return Self.uomCHT
-    case .imeModeNULL:
-      return .init(dataURL: Self.userOverrideModelDataURL(IMEApp.currentInputMode))
-    }
-  }
-
-  // MARK: - Functions reacting directly with language models.
-
-  public static func initUserLangModels() {
-    Self.chkUserLMFilesExist(.imeModeCHT)
-    Self.chkUserLMFilesExist(.imeModeCHS)
-    // LMMgr 的 loadUserPhrases 等函式在自動讀取 dataFolderPath 時，
-    // 如果發現自訂目錄不可用，則會自動抹去自訂目錄設定、改採預設目錄。
-    // 所以這裡不需要特別處理。
-    Self.loadUserPhrasesData()
-  }
-
-  public static var isCoreDBConnected: Bool { vChewingLM.LMInstantiator.isSQLDBConnected }
-
-  public static func connectCoreDB(dbPath: String? = nil) {
-    guard let path: String = dbPath ?? Self.getCoreDictionaryDBPath() else {
-      assertionFailure("vChewing factory SQLite data not found.")
-      return
-    }
-    let result = vChewingLM.LMInstantiator.connectSQLDB(dbPath: path)
-    assert(result, "vChewing factory SQLite connection failed.")
-    Notifier.notify(
-      message: NSLocalizedString("Core Dict loading complete.", comment: "")
-    )
-  }
-
-  /// 載入磁帶資料。
-  /// - Remark: cassettePath() 會在輸入法停用磁帶時直接返回
-  public static func loadCassetteData() {
-    vChewingLM.LMInstantiator.loadCassetteData(path: cassettePath())
-  }
-
-  public static func loadUserPhrasesData(type: vChewingLM.ReplacableUserDataType? = nil) {
-    guard let type = type else {
-      Self.lmCHT.loadUserPhrasesData(
-        path: userDictDataURL(mode: .imeModeCHT, type: .thePhrases).path,
-        filterPath: userDictDataURL(mode: .imeModeCHT, type: .theFilter).path
-      )
-      Self.lmCHS.loadUserPhrasesData(
-        path: userDictDataURL(mode: .imeModeCHS, type: .thePhrases).path,
-        filterPath: userDictDataURL(mode: .imeModeCHS, type: .theFilter).path
-      )
-      Self.lmCHT.loadUserSymbolData(path: userDictDataURL(mode: .imeModeCHT, type: .theSymbols).path)
-      Self.lmCHS.loadUserSymbolData(path: userDictDataURL(mode: .imeModeCHS, type: .theSymbols).path)
-
-      if PrefMgr.shared.associatedPhrasesEnabled { Self.loadUserAssociatesData() }
-      if PrefMgr.shared.phraseReplacementEnabled { Self.loadUserPhraseReplacement() }
-      if PrefMgr.shared.useSCPCTypingMode { Self.loadSCPCSequencesData() }
-
-      Self.uomCHT.loadData(fromURL: userOverrideModelDataURL(.imeModeCHT))
-      Self.uomCHS.loadData(fromURL: userOverrideModelDataURL(.imeModeCHS))
-
-      CandidateNode.load(url: Self.userSymbolMenuDataURL())
-      return
-    }
-    switch type {
-    case .thePhrases:
-      Self.lmCHT.loadUserPhrasesData(
-        path: userDictDataURL(mode: .imeModeCHT, type: .thePhrases).path,
-        filterPath: nil
-      )
-      Self.lmCHS.loadUserPhrasesData(
-        path: userDictDataURL(mode: .imeModeCHS, type: .thePhrases).path,
-        filterPath: nil
-      )
-    case .theFilter:
-      DispatchQueue.main.async {
-        Self.reloadUserFilterDirectly(mode: IMEApp.currentInputMode)
-      }
-      DispatchQueue.main.async {
-        Self.reloadUserFilterDirectly(mode: IMEApp.currentInputMode.reversed)
-      }
-    case .theReplacements:
-      if PrefMgr.shared.phraseReplacementEnabled { Self.loadUserPhraseReplacement() }
-    case .theAssociates:
-      if PrefMgr.shared.associatedPhrasesEnabled { Self.loadUserAssociatesData() }
-    case .theSymbols:
-      Self.lmCHT.loadUserSymbolData(
-        path: Self.userDictDataURL(mode: .imeModeCHT, type: .theSymbols).path
-      )
-      Self.lmCHS.loadUserSymbolData(
-        path: Self.userDictDataURL(mode: .imeModeCHS, type: .theSymbols).path
-      )
-    }
-  }
-
-  public static func loadUserAssociatesData() {
-    Self.lmCHT.loadUserAssociatesData(
-      path: Self.userDictDataURL(mode: .imeModeCHT, type: .theAssociates).path
-    )
-    Self.lmCHS.loadUserAssociatesData(
-      path: Self.userDictDataURL(mode: .imeModeCHS, type: .theAssociates).path
-    )
-  }
-
-  public static func loadUserPhraseReplacement() {
-    Self.lmCHT.loadReplacementsData(
-      path: Self.userDictDataURL(mode: .imeModeCHT, type: .theReplacements).path
-    )
-    Self.lmCHS.loadReplacementsData(
-      path: Self.userDictDataURL(mode: .imeModeCHS, type: .theReplacements).path
-    )
-  }
-
-  public static func loadSCPCSequencesData() {
-    Self.lmCHT.loadSCPCSequencesData()
-    Self.lmCHS.loadSCPCSequencesData()
-  }
-
-  public static func reloadUserFilterDirectly(mode: Shared.InputMode) {
-    Self.getLM(mode: mode).reloadUserFilterDirectly(path: userDictDataURL(mode: mode, type: .theFilter).path)
-  }
-
-  public static func checkIfPhrasePairExists(
-    userPhrase: String,
-    mode: Shared.InputMode,
-    keyArray: [String],
-    factoryDictionaryOnly: Bool = false
-  ) -> Bool {
-    Self.getLM(mode: mode).hasKeyValuePairFor(
-      keyArray: keyArray, value: userPhrase, factoryDictionaryOnly: factoryDictionaryOnly
-    )
-  }
-
-  public static func checkIfPhrasePairIsFiltered(
-    userPhrase: String,
-    mode: Shared.InputMode,
-    keyArray: [String]
-  ) -> Bool {
-    Self.getLM(mode: mode).isPairFiltered(pair: .init(keyArray: keyArray, value: userPhrase))
-  }
-
-  public static func countPhrasePairs(
-    keyArray: [String],
-    mode: Shared.InputMode,
-    factoryDictionaryOnly: Bool = false
-  ) -> Int {
-    Self.getLM(mode: mode).countKeyValuePairs(
-      keyArray: keyArray, factoryDictionaryOnly: factoryDictionaryOnly
-    )
-  }
-
-  public static func setPhraseReplacementEnabled(_ state: Bool) {
-    Self.lmCHT.isPhraseReplacementEnabled = state
-    Self.lmCHS.isPhraseReplacementEnabled = state
-  }
-
-  public static func setCNSEnabled(_ state: Bool) {
-    Self.lmCHT.isCNSEnabled = state
-    Self.lmCHS.isCNSEnabled = state
-  }
-
-  public static func setSymbolEnabled(_ state: Bool) {
-    Self.lmCHT.isSymbolEnabled = state
-    Self.lmCHS.isSymbolEnabled = state
-  }
-
-  public static func setSCPCEnabled(_ state: Bool) {
-    Self.lmCHT.isSCPCEnabled = state
-    Self.lmCHS.isSCPCEnabled = state
-  }
-
-  public static func setCassetteEnabled(_ state: Bool) {
-    Self.lmCHT.isCassetteEnabled = state
-    Self.lmCHS.isCassetteEnabled = state
-  }
-
-  public static func setDeltaOfCalendarYears(_ delta: Int) {
-    Self.lmCHT.deltaOfCalendarYears = delta
-    Self.lmCHS.deltaOfCalendarYears = delta
-  }
-
-  // MARK: UOM
-
-  public static func saveUserOverrideModelData() {
-    let globalQueue = DispatchQueue(label: "vChewingLM_UOM", qos: .unspecified, attributes: .concurrent)
-    let group = DispatchGroup()
-    group.enter()
-    globalQueue.async {
-      Self.uomCHT.saveData(toURL: userOverrideModelDataURL(.imeModeCHT))
-      group.leave()
-    }
-    group.enter()
-    globalQueue.async {
-      Self.uomCHS.saveData(toURL: userOverrideModelDataURL(.imeModeCHS))
-      group.leave()
-    }
-    _ = group.wait(timeout: .distantFuture)
-    group.notify(queue: DispatchQueue.main) {}
-  }
-
-  public static func bleachSpecifiedSuggestions(targets: [String], mode: Shared.InputMode) {
-    Self.getUOM(mode: mode).bleachSpecifiedSuggestions(targets: targets, saveCallback: { Self.getUOM(mode: mode).saveData() })
-  }
-
-  public static func removeUnigramsFromUserOverrideModel(_ mode: Shared.InputMode) {
-    Self.getUOM(mode: mode).bleachUnigrams(saveCallback: { Self.getUOM(mode: mode).saveData() })
-  }
-
-  public static func relocateWreckedUOMData() {
-    func dateStringTag(date givenDate: Date) -> String {
-      let dateFormatter = DateFormatter()
-      dateFormatter.dateFormat = "yyyyMMdd-HHmm"
-      dateFormatter.timeZone = .current
-      let strDate = dateFormatter.string(from: givenDate)
-      return strDate
-    }
-
-    let urls: [URL] = [userOverrideModelDataURL(.imeModeCHS), userOverrideModelDataURL(.imeModeCHT)]
-    let folderURL = URL(fileURLWithPath: dataFolderPath(isDefaultFolder: true)).deletingLastPathComponent()
-    urls.forEach { oldURL in
-      let newFileName = "[UOM-CRASH][\(dateStringTag(date: .init()))]\(oldURL.lastPathComponent)"
-      let newURL = folderURL.appendingPathComponent(newFileName)
-      try? FileManager.default.moveItem(at: oldURL, to: newURL)
-    }
-  }
-
-  public static func clearUserOverrideModelData(_ mode: Shared.InputMode = .imeModeNULL) {
-    Self.getUOM(mode: mode).clearData(withURL: userOverrideModelDataURL(mode))
-  }
-}

Packages/vChewing_MainAssembly/Sources/MainAssembly/LMMgr_KimoDataParser.swift

@@ -1,72 +0,0 @@
-// (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 Foundation
-import LineReader
-
-public extension LMMgr {
-  /// 匯入自奇摩輸入法使用者自訂詞資料庫匯出的 TXT 檔案。
-  /// - Parameter rawString: 原始 TXT 檔案內容。
-  /// - Returns: 成功匯入的資料數量。
-  @discardableResult static func importYahooKeyKeyUserDictionary(text rawString: inout String) -> Int {
-    var allPhrasesCHT = [UserPhrase]()
-    rawString.enumerateLines { currentLine, _ in
-      let cells = currentLine.split(separator: "\t")
-      guard cells.count >= 3, cells.first != "#", cells.first != "MJSR" else { return }
-      let value = cells[0].description
-      let keyArray = cells[1].split(separator: ",").map(\.description)
-      let phraseCHT = UserPhrase(keyArray: keyArray, value: value, inputMode: .imeModeCHT, isConverted: false)
-      guard phraseCHT.isValid, !phraseCHT.isDuplicated else { return }
-      guard !(phraseCHT.value.count == 1 && phraseCHT.keyArray.count == 1) else { return }
-      allPhrasesCHT.append(phraseCHT)
-    }
-    guard !allPhrasesCHT.isEmpty else { return 0 }
-    let allPhrasesCHS = allPhrasesCHT.compactMap { chtPhrase in
-      let chsPhrase = chtPhrase.crossConverted
-      return chsPhrase.isValid && !chsPhrase.isDuplicated ? chsPhrase : nil
-    }.deduplicated
-    let outputStrCHS = allPhrasesCHS.map(\.description).joined(separator: "\n")
-    let outputStrCHT = allPhrasesCHT.map(\.description).joined(separator: "\n")
-    var outputDataCHS = "\(outputStrCHS)\n".data(using: .utf8) ?? .init([])
-    var outputDataCHT = "\(outputStrCHT)\n".data(using: .utf8) ?? .init([])
-    let urlCHS = LMMgr.userDictDataURL(mode: .imeModeCHS, type: .thePhrases)
-    let urlCHT = LMMgr.userDictDataURL(mode: .imeModeCHT, type: .thePhrases)
-
-    let fileHandlerCHS = try? FileHandle(forUpdating: urlCHS)
-    let fileHandlerCHT = try? FileHandle(forUpdating: urlCHT)
-    guard let fileHandlerCHS = fileHandlerCHS, let fileHandlerCHT = fileHandlerCHT else { return 0 }
-    defer {
-      fileHandlerCHS.closeFile()
-      fileHandlerCHT.closeFile()
-    }
-
-    if let sizeCHS = fileSize(for: urlCHS), sizeCHS > 0 {
-      fileHandlerCHS.seek(toFileOffset: sizeCHS)
-      if fileHandlerCHS.readDataToEndOfFile().first != 0x0A {
-        outputDataCHS.insert(0x0A, at: 0)
-      }
-    }
-    fileHandlerCHS.seekToEndOfFile()
-    fileHandlerCHS.write(outputDataCHS)
-
-    if let sizeCHT = fileSize(for: urlCHT), sizeCHT > 0 {
-      fileHandlerCHT.seek(toFileOffset: sizeCHT)
-      if fileHandlerCHT.readDataToEndOfFile().first != 0x0A {
-        outputDataCHT.insert(0x0A, at: 0)
-      }
-    }
-    fileHandlerCHT.seekToEndOfFile()
-    fileHandlerCHT.write(outputDataCHT)
-
-    return allPhrasesCHT.count
-  }
-}
-
-private func fileSize(for theURL: URL) -> UInt64? {
-  (try? FileManager.default.attributesOfItem(atPath: theURL.path))?[FileAttributeKey.size] as? UInt64
-}

Packages/vChewing_MainAssembly/Sources/MainAssembly/LangModelManager/LMMgr_Core.swift

@@ -0,0 +1,224 @@
+// (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 AppKit
+import LangModelAssembly
+import NotifierUI
+import Shared
+import SwiftExtension
+
+// MARK: - Input Mode Extension for Language Models
+
+public extension Shared.InputMode {
+  private static let lmCHS = LMAssembly.LMInstantiator(
+    isCHS: true, uomDataURL: LMMgr.userOverrideModelDataURL(.imeModeCHS)
+  )
+  private static let lmCHT = LMAssembly.LMInstantiator(
+    isCHS: false, uomDataURL: LMMgr.userOverrideModelDataURL(.imeModeCHT)
+  )
+
+  var langModel: LMAssembly.LMInstantiator {
+    switch self {
+    case .imeModeCHS: return Self.lmCHS
+    case .imeModeCHT: return Self.lmCHT
+    case .imeModeNULL: return .init()
+    }
+  }
+}
+
+// MARK: - Language Model Manager.
+
+public class LMMgr {
+  public static var shared = LMMgr()
+
+  // MARK: - Functions reacting directly with language models.
+
+  public static func initUserLangModels() {
+    Shared.InputMode.validCases.forEach { mode in
+      Self.chkUserLMFilesExist(mode)
+    }
+    // LMMgr 的 loadUserPhrases 等函式在自動讀取 dataFolderPath 時，
+    // 如果發現自訂目錄不可用，則會自動抹去自訂目錄設定、改採預設目錄。
+    // 所以這裡不需要特別處理。
+    Self.loadUserPhrasesData()
+  }
+
+  public static var isCoreDBConnected: Bool { LMAssembly.LMInstantiator.isSQLDBConnected }
+
+  public static func connectCoreDB(dbPath: String? = nil) {
+    guard let path: String = dbPath ?? Self.getCoreDictionaryDBPath() else {
+      assertionFailure("vChewing factory SQLite data not found.")
+      return
+    }
+    let result = LMAssembly.LMInstantiator.connectSQLDB(dbPath: path)
+    assert(result, "vChewing factory SQLite connection failed.")
+    Notifier.notify(
+      message: NSLocalizedString("Core Dict loading complete.", comment: "")
+    )
+  }
+
+  /// 載入磁帶資料。
+  /// - Remark: cassettePath() 會在輸入法停用磁帶時直接返回
+  public static func loadCassetteData() {
+    func validateCassetteCandidateKey(_ target: String) -> Bool {
+      CandidateKey.validate(keys: target) == nil
+    }
+
+    LMAssembly.LMInstantiator.setCassetCandidateKeyValidator(validateCassetteCandidateKey)
+    LMAssembly.LMInstantiator.loadCassetteData(path: cassettePath())
+  }
+
+  public static func loadUserPhrasesData(type: LMAssembly.ReplacableUserDataType? = nil) {
+    guard let type = type else {
+      Shared.InputMode.validCases.forEach { mode in
+        mode.langModel.loadUserPhrasesData(
+          path: userDictDataURL(mode: mode, type: .thePhrases).path,
+          filterPath: userDictDataURL(mode: mode, type: .theFilter).path
+        )
+        mode.langModel.loadUserSymbolData(path: userDictDataURL(mode: mode, type: .theSymbols).path)
+        mode.langModel.loadUOMData()
+      }
+
+      if PrefMgr.shared.associatedPhrasesEnabled { Self.loadUserAssociatesData() }
+      if PrefMgr.shared.phraseReplacementEnabled { Self.loadUserPhraseReplacement() }
+
+      CandidateNode.load(url: Self.userSymbolMenuDataURL())
+      return
+    }
+    Shared.InputMode.validCases.forEach { mode in
+      switch type {
+      case .thePhrases:
+        mode.langModel.loadUserPhrasesData(
+          path: userDictDataURL(mode: mode, type: .thePhrases).path,
+          filterPath: nil
+        )
+      case .theFilter:
+        DispatchQueue.main.async {
+          Self.reloadUserFilterDirectly(mode: mode)
+        }
+      case .theReplacements:
+        if PrefMgr.shared.phraseReplacementEnabled { Self.loadUserPhraseReplacement() }
+      case .theAssociates:
+        if PrefMgr.shared.associatedPhrasesEnabled { Self.loadUserAssociatesData() }
+      case .theSymbols:
+        mode.langModel.loadUserSymbolData(
+          path: Self.userDictDataURL(mode: mode, type: .theSymbols).path
+        )
+      }
+    }
+  }
+
+  public static func loadUserAssociatesData() {
+    Shared.InputMode.validCases.forEach { mode in
+      mode.langModel.loadUserAssociatesData(
+        path: Self.userDictDataURL(mode: mode, type: .theAssociates).path
+      )
+    }
+  }
+
+  public static func loadUserPhraseReplacement() {
+    Shared.InputMode.validCases.forEach { mode in
+      mode.langModel.loadReplacementsData(
+        path: Self.userDictDataURL(mode: mode, type: .theReplacements).path
+      )
+    }
+  }
+
+  public static func reloadUserFilterDirectly(mode: Shared.InputMode) {
+    mode.langModel.reloadUserFilterDirectly(path: userDictDataURL(mode: mode, type: .theFilter).path)
+  }
+
+  public static func checkIfPhrasePairExists(
+    userPhrase: String,
+    mode: Shared.InputMode,
+    keyArray: [String],
+    factoryDictionaryOnly: Bool = false
+  ) -> Bool {
+    mode.langModel.hasKeyValuePairFor(
+      keyArray: keyArray, value: userPhrase, factoryDictionaryOnly: factoryDictionaryOnly
+    )
+  }
+
+  public static func checkIfPhrasePairIsFiltered(
+    userPhrase: String,
+    mode: Shared.InputMode,
+    keyArray: [String]
+  ) -> Bool {
+    mode.langModel.isPairFiltered(pair: .init(keyArray: keyArray, value: userPhrase))
+  }
+
+  public static func countPhrasePairs(
+    keyArray: [String],
+    mode: Shared.InputMode,
+    factoryDictionaryOnly: Bool = false
+  ) -> Int {
+    mode.langModel.countKeyValuePairs(
+      keyArray: keyArray, factoryDictionaryOnly: factoryDictionaryOnly
+    )
+  }
+
+  public static func syncLMPrefs() {
+    Shared.InputMode.validCases.forEach { mode in
+      mode.langModel.setOptions { config in
+        config.isPhraseReplacementEnabled = PrefMgr.shared.phraseReplacementEnabled
+        config.isCNSEnabled = PrefMgr.shared.cns11643Enabled
+        config.isSymbolEnabled = PrefMgr.shared.symbolInputEnabled
+        config.isSCPCEnabled = PrefMgr.shared.useSCPCTypingMode
+        config.isCassetteEnabled = PrefMgr.shared.cassetteEnabled
+        config.filterNonCNSReadings = PrefMgr.shared.filterNonCNSReadingsForCHTInput
+        config.deltaOfCalendarYears = PrefMgr.shared.deltaOfCalendarYears
+      }
+    }
+  }
+
+  // MARK: UOM
+
+  public static func saveUserOverrideModelData() {
+    let globalQueue = DispatchQueue(label: "LMAssembly_UOM", qos: .unspecified, attributes: .concurrent)
+    let group = DispatchGroup()
+    Shared.InputMode.validCases.forEach { mode in
+      group.enter()
+      globalQueue.async {
+        mode.langModel.saveUOMData()
+        group.leave()
+      }
+    }
+    _ = group.wait(timeout: .distantFuture)
+    group.notify(queue: DispatchQueue.main) {}
+  }
+
+  public static func bleachSpecifiedSuggestions(targets: [String], mode: Shared.InputMode) {
+    mode.langModel.bleachSpecifiedUOMSuggestions(targets: targets)
+  }
+
+  public static func removeUnigramsFromUserOverrideModel(_ mode: Shared.InputMode) {
+    mode.langModel.bleachUOMUnigrams()
+  }
+
+  public static func relocateWreckedUOMData() {
+    func dateStringTag(date givenDate: Date) -> String {
+      let dateFormatter = DateFormatter()
+      dateFormatter.dateFormat = "yyyyMMdd-HHmm"
+      dateFormatter.timeZone = .current
+      let strDate = dateFormatter.string(from: givenDate)
+      return strDate
+    }
+
+    let urls: [URL] = [userOverrideModelDataURL(.imeModeCHS), userOverrideModelDataURL(.imeModeCHT)]
+    let folderURL = URL(fileURLWithPath: dataFolderPath(isDefaultFolder: true)).deletingLastPathComponent()
+    urls.forEach { oldURL in
+      let newFileName = "[UOM-CRASH][\(dateStringTag(date: .init()))]\(oldURL.lastPathComponent)"
+      let newURL = folderURL.appendingPathComponent(newFileName)
+      try? FileManager.default.moveItem(at: oldURL, to: newURL)
+    }
+  }
+
+  public static func clearUserOverrideModelData(_ mode: Shared.InputMode = .imeModeNULL) {
+    mode.langModel.clearUOMData()
+  }
+}

Packages/vChewing_MainAssembly/Sources/MainAssembly/LangModelManager/LMMgr_KimoDataParser.swift

@@ -0,0 +1,147 @@
+// (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 AppKit
+import Foundation
+import KimoDataReader
+import LineReader
+import Shared
+
+public extension LMMgr {
+  enum KimoDataImportError: Error, LocalizedError {
+    case connectionFailure
+    case fileHandlerFailure
+
+    public var errorDescription: String? {
+      switch self {
+      case .fileHandlerFailure: return "i18n:KimoDataImportError.fileHandlerFailure.errMsg".localized
+      case .connectionFailure: return "i18n:KimoDataImportError.connectionFailure.errMsg".localized
+      }
+    }
+  }
+
+  /// 藉由 XPC 通訊的方式匯入自奇摩輸入法使用者自訂詞資料庫檔案。
+  /// - Parameter rawString: 原始 TXT 檔案內容。
+  /// - Returns: 成功匯入的資料數量。
+  @discardableResult static func importYahooKeyKeyUserDictionaryByXPC() throws -> Int {
+    let kimoBundleID = "com.yahoo.inputmethod.KeyKey"
+    if #unavailable(macOS 11) {
+      NSWorkspace.shared.launchApplication(
+        withBundleIdentifier: kimoBundleID,
+        additionalEventParamDescriptor: nil,
+        launchIdentifier: nil
+      )
+    } else {
+      guard let imeURL = NSWorkspace.shared.urlForApplication(withBundleIdentifier: kimoBundleID) else {
+        throw KimoDataImportError.connectionFailure
+      }
+      NSWorkspace.shared.openApplication(at: imeURL, configuration: .init())
+    }
+    guard KimoCommunicator.shared.establishConnection() else { throw KimoDataImportError.connectionFailure }
+    var allPhrasesCHT = [UserPhrase]()
+    var allPhrasesCHS = [UserPhrase]()
+    KimoCommunicator.shared.prepareData { key, value in
+      let phraseCHT = UserPhrase(
+        keyArray: key.components(separatedBy: ","),
+        value: value,
+        inputMode: .imeModeCHT,
+        isConverted: false
+      )
+      guard phraseCHT.isValid, !phraseCHT.isDuplicated else { return }
+      guard !(phraseCHT.value.count == 1 && phraseCHT.keyArray.count == 1) else { return }
+      allPhrasesCHT.append(phraseCHT)
+      let phraseCHS = phraseCHT.crossConverted
+      guard phraseCHS.isValid, !phraseCHS.isDuplicated else { return }
+      guard !(phraseCHS.value.count == 1 && phraseCHS.keyArray.count == 1) else { return }
+      allPhrasesCHS.append(phraseCHS)
+    }
+
+    guard Self.batchImportUserPhrasePairs(allPhrasesCHT: allPhrasesCHT, allPhrasesCHS: allPhrasesCHS) else {
+      throw KimoDataImportError.fileHandlerFailure
+    }
+
+    let result = allPhrasesCHT.count
+    if result > 0 {
+      Broadcaster.shared.eventForReloadingPhraseEditor = .init()
+    }
+    return result
+  }
+
+  /// 匯入自奇摩輸入法使用者自訂詞資料庫匯出的 TXT 檔案。
+  /// - Parameter rawString: 原始 TXT 檔案內容。
+  /// - Returns: 成功匯入的資料數量。
+  @discardableResult static func importYahooKeyKeyUserDictionary(text rawString: inout String) throws -> Int {
+    var allPhrasesCHT = [UserPhrase]()
+    var allPhrasesCHS = [UserPhrase]()
+    rawString.enumerateLines { currentLine, _ in
+      let cells = currentLine.split(separator: "\t")
+      guard cells.count >= 3, cells.first != "#", cells.first != "MJSR" else { return }
+      let value = cells[0].description
+      let keyArray = cells[1].split(separator: ",").map(\.description)
+      let phraseCHT = UserPhrase(keyArray: keyArray, value: value, inputMode: .imeModeCHT, isConverted: false)
+      guard phraseCHT.isValid, !phraseCHT.isDuplicated else { return }
+      guard !(phraseCHT.value.count == 1 && phraseCHT.keyArray.count == 1) else { return }
+      allPhrasesCHT.append(phraseCHT)
+      let phraseCHS = phraseCHT.crossConverted
+      guard phraseCHS.isValid, !phraseCHS.isDuplicated else { return }
+      guard !(phraseCHS.value.count == 1 && phraseCHS.keyArray.count == 1) else { return }
+      allPhrasesCHS.append(phraseCHS)
+    }
+    guard !allPhrasesCHT.isEmpty else { return 0 }
+
+    guard Self.batchImportUserPhrasePairs(allPhrasesCHT: allPhrasesCHT, allPhrasesCHS: allPhrasesCHS) else {
+      throw KimoDataImportError.fileHandlerFailure
+    }
+
+    let result = allPhrasesCHT.count
+    if result > 0 {
+      Broadcaster.shared.eventForReloadingPhraseEditor = .init()
+    }
+    return result
+  }
+
+  private static func batchImportUserPhrasePairs(allPhrasesCHT: [UserPhrase], allPhrasesCHS: [UserPhrase]) -> Bool {
+    let outputStrCHS = allPhrasesCHS.map(\.description).joined(separator: "\n")
+    let outputStrCHT = allPhrasesCHT.map(\.description).joined(separator: "\n")
+    var outputDataCHS = "\(outputStrCHS)\n".data(using: .utf8) ?? .init([])
+    var outputDataCHT = "\(outputStrCHT)\n".data(using: .utf8) ?? .init([])
+    let urlCHS = LMMgr.userDictDataURL(mode: .imeModeCHS, type: .thePhrases)
+    let urlCHT = LMMgr.userDictDataURL(mode: .imeModeCHT, type: .thePhrases)
+
+    let fileHandlerCHS = try? FileHandle(forUpdating: urlCHS)
+    let fileHandlerCHT = try? FileHandle(forUpdating: urlCHT)
+    guard let fileHandlerCHS = fileHandlerCHS, let fileHandlerCHT = fileHandlerCHT else { return false }
+    defer {
+      fileHandlerCHS.closeFile()
+      fileHandlerCHT.closeFile()
+    }
+
+    if let sizeCHS = fileSize(for: urlCHS), sizeCHS > 0 {
+      fileHandlerCHS.seek(toFileOffset: sizeCHS)
+      if fileHandlerCHS.readDataToEndOfFile().first != 0x0A {
+        outputDataCHS.insert(0x0A, at: 0)
+      }
+    }
+    fileHandlerCHS.seekToEndOfFile()
+    fileHandlerCHS.write(outputDataCHS)
+
+    if let sizeCHT = fileSize(for: urlCHT), sizeCHT > 0 {
+      fileHandlerCHT.seek(toFileOffset: sizeCHT)
+      if fileHandlerCHT.readDataToEndOfFile().first != 0x0A {
+        outputDataCHT.insert(0x0A, at: 0)
+      }
+    }
+    fileHandlerCHT.seekToEndOfFile()
+    fileHandlerCHT.write(outputDataCHT)
+    return true
+  }
+}
+
+private func fileSize(for theURL: URL) -> UInt64? {
+  (try? FileManager.default.attributesOfItem(atPath: theURL.path))?[FileAttributeKey.size] as? UInt64
+}

Packages/vChewing_MainAssembly/Sources/MainAssembly/LangModelManager/LMMgr_PhraseEditorDelegate.swift

@@ -17,23 +17,23 @@ import Shared
 extension LMMgr: PhraseEditorDelegate {
   public var currentInputMode: Shared.InputMode { IMEApp.currentInputMode }
 
-  public func openPhraseFile(mode: Shared.InputMode, type: vChewingLM.ReplacableUserDataType, appIdentifier: String) {
-    Self.openPhraseFile(fromURL: Self.userDictDataURL(mode: mode, type: type), appIdentifier: appIdentifier)
+  public func openPhraseFile(mode: Shared.InputMode, type: LMAssembly.ReplacableUserDataType, using app: FileOpenMethod) {
+    Self.openPhraseFile(fromURL: Self.userDictDataURL(mode: mode, type: type), using: app)
   }
 
   public func consolidate(text strProcessed: inout String, pragma shouldCheckPragma: Bool) {
-    vChewingLM.LMConsolidator.consolidate(text: &strProcessed, pragma: shouldCheckPragma)
+    LMAssembly.LMConsolidator.consolidate(text: &strProcessed, pragma: shouldCheckPragma)
   }
 
   public func checkIfPhrasePairExists(userPhrase: String, mode: Shared.InputMode, key unigramKey: String) -> Bool {
     Self.checkIfPhrasePairExists(userPhrase: userPhrase, mode: mode, keyArray: [unigramKey])
   }
 
-  public func retrieveData(mode: Shared.InputMode, type: vChewingLM.ReplacableUserDataType) -> String {
+  public func retrieveData(mode: Shared.InputMode, type: LMAssembly.ReplacableUserDataType) -> String {
     Self.retrieveData(mode: mode, type: type)
   }
 
-  public static func retrieveData(mode: Shared.InputMode, type: vChewingLM.ReplacableUserDataType) -> String {
+  public static func retrieveData(mode: Shared.InputMode, type: LMAssembly.ReplacableUserDataType) -> String {
     vCLog("Retrieving data. Mode: \(mode.localizedDescription), type: \(type.localizedDescription)")
     let theURL = Self.userDictDataURL(mode: mode, type: type)
     do {
@@ -44,12 +44,12 @@ extension LMMgr: PhraseEditorDelegate {
     }
   }
 
-  public func saveData(mode: Shared.InputMode, type: vChewingLM.ReplacableUserDataType, data: String) -> String {
+  public func saveData(mode: Shared.InputMode, type: LMAssembly.ReplacableUserDataType, data: String) -> String {
     Self.saveData(mode: mode, type: type, data: data)
   }
 
   @discardableResult public static func saveData(
-    mode: Shared.InputMode, type: vChewingLM.ReplacableUserDataType, data: String
+    mode: Shared.InputMode, type: LMAssembly.ReplacableUserDataType, data: String
   ) -> String {
     DispatchQueue.main.async {
       let theURL = Self.userDictDataURL(mode: mode, type: type)

Packages/vChewing_MainAssembly/Sources/MainAssembly/LangModelManager/LMMgr_UserPhraseStructure.swift

@@ -6,8 +6,10 @@
 // marks, or product names of Contributor, except as required to fulfill notice
 // requirements defined in MIT License.
 
+import CandidateWindow
 import Foundation
 import LangModelAssembly
+import Megrez
 import Shared
 
 // MARK: - 使用者語彙類型定義
@@ -32,6 +34,10 @@ public extension LMMgr {
       !keyArray.isEmpty && keyArray.filter(\.isEmpty).isEmpty && !value.isEmpty
     }
 
+    var isSingleCharReadingPair: Bool {
+      value.count == 1 && keyArray.count == 1 && keyArray.first?.first != "_"
+    }
+
     public var description: String {
       descriptionCells.joined(separator: " ")
     }
@@ -62,7 +68,7 @@ public extension LMMgr {
     }
 
     public var isAlreadyFiltered: Bool {
-      LMMgr.getLM(mode: inputMode).isPairFiltered(pair: .init(keyArray: keyArray, value: value))
+      inputMode.langModel.isPairFiltered(pair: .init(keyArray: keyArray, value: value))
     }
 
     public func write(toFilter: Bool) -> Bool {
@@ -88,7 +94,7 @@ public extension LMMgr {
       /// 有些使用者的語彙檔案已經過於龐大了（超過一千行），
       /// 每次寫入時都全文整理格式的話，會引發嚴重的效能問題。
       /// 所以這裡不再強制要求整理格式。
-      let theType: vChewingLM.ReplacableUserDataType = toFilter ? .theFilter : .thePhrases
+      let theType: LMAssembly.ReplacableUserDataType = toFilter ? .theFilter : .thePhrases
       let theURL = LMMgr.userDictDataURL(mode: inputMode, type: theType)
       var fileSize: UInt64?
       do {
@@ -143,7 +149,7 @@ public extension LMMgr {
         }
       }
       let theURL = LMMgr.userDictDataURL(mode: inputMode, type: .theFilter)
-      if forceConsolidate, !vChewingLM.LMConsolidator.consolidate(path: theURL.path, pragma: false) { return false }
+      if forceConsolidate, !LMAssembly.LMConsolidator.consolidate(path: theURL.path, pragma: false) { return false }
       // Get FileSize.
       var fileSize: UInt64?
       do {
@@ -190,3 +196,51 @@ public extension LMMgr {
     }
   }
 }
+
+// MARK: - Weight Suggestions.
+
+public extension LMMgr.UserPhrase {
+  mutating func updateWeight(basedOn action: CandidateContextMenuAction) {
+    weight = suggestNextFreq(for: action)
+  }
+
+  func suggestNextFreq(for action: CandidateContextMenuAction, extreme: Bool = false) -> Double? {
+    var extremeFallbackResult: Double? {
+      switch action {
+      case .toBoost: return nil // 不填寫權重的話，預設權重是 0
+      case .toNerf: return -114.514
+      case .toFilter: return nil
+      }
+    }
+    guard !extreme, isSingleCharReadingPair else { return extremeFallbackResult }
+    let fetchedUnigrams = inputMode.langModel.unigramsFor(keyArray: keyArray)
+    let currentWeight = weight ?? fetchedUnigrams.first { $0.value == value }?.score
+    guard let currentWeight = currentWeight else { return extremeFallbackResult }
+    let fetchedScores = fetchedUnigrams.map(\.score)
+    var neighborValue: Double?
+    switch action {
+    case .toBoost:
+      neighborValue = currentWeight.findNeighborValue(from: fetchedScores, greater: true)
+      if let realNeighborValue = neighborValue {
+        neighborValue = realNeighborValue + 0.000_001
+      } else if let fetchedMax = fetchedScores.min(), currentWeight <= fetchedMax {
+        neighborValue = Swift.min(0, currentWeight + 0.000_001)
+      } else {
+        // 理論上來講，這種情況不該出現。
+        neighborValue = Swift.min(0, currentWeight + 1)
+      }
+    case .toNerf:
+      neighborValue = currentWeight.findNeighborValue(from: fetchedScores, greater: false)
+      if let realNeighborValue = neighborValue {
+        neighborValue = realNeighborValue - 0.000_001
+      } else if let fetchedMax = fetchedScores.max(), currentWeight >= fetchedMax {
+        neighborValue = Swift.max(-114.514, currentWeight - 0.000_001)
+      } else {
+        // 理論上來講，這種情況不該出現。
+        neighborValue = Swift.max(-114.514, currentWeight - 1)
+      }
+    case .toFilter: return nil
+    }
+    return neighborValue ?? extremeFallbackResult
+  }
+}