Repo // Deploy LMPlainBopomofo.

Source/Modules/LangModelRelated/LMInstantiator.swift

@@ -76,6 +76,7 @@ extension vChewing {
     )
     var lmReplacements = LMReplacments()
     var lmAssociates = LMAssociates()
+    var lmPlainBopomofo = LMPlainBopomofo()
 
     // MARK: - 工具函式
 
@@ -166,6 +167,16 @@ extension vChewing {
       }
     }
 
+    public func loadUserSCPCSequencesData(path: String) {
+      if FileManager.default.isReadableFile(atPath: path) {
+        lmPlainBopomofo.close()
+        lmPlainBopomofo.open(path)
+        IME.prtDebugIntel("lmPlainBopomofo: \(lmPlainBopomofo.count) entries of data loaded from: \(path)")
+      } else {
+        IME.prtDebugIntel("lmPlainBopomofo: File access failure: \(path)")
+      }
+    }
+
     // MARK: - 核心函式（對外）
 
     /// 威注音輸入法目前尚未具備對雙元圖的處理能力，故停用該函式。
@@ -181,6 +192,11 @@ extension vChewing {
       /// 準備不同的語言模組容器，開始逐漸往容器陣列內塞入資料。
       var rawAllUnigrams: [Megrez.Unigram] = []
 
+      // 如果有檢測到使用者自訂逐字選字語料庫內的相關資料的話，在這裡先插入。
+      if mgrPrefs.useSCPCTypingMode {
+        rawAllUnigrams += lmPlainBopomofo.valuesFor(key: key).map { Megrez.Unigram.init(value: $0, score: 0) }
+      }
+
       // 用 reversed 指令讓使用者語彙檔案內的詞條優先順序隨著行數增加而逐漸增高。
       // 這樣一來就可以在就地新增語彙時徹底複寫優先權。
       // 將兩句差分也是為了讓 rawUserUnigrams 的類型不受可能的影響。

Source/Modules/LangModelRelated/SubLMs/lmPlainBopomofo.swift

@@ -0,0 +1,83 @@
+// Copyright (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
+
+extension vChewing {
+  @frozen public struct LMPlainBopomofo {
+    var rangeMap: [String: String] = [:]
+
+    public var count: Int {
+      rangeMap.count
+    }
+
+    public init() {
+      rangeMap = [:]
+    }
+
+    public func isLoaded() -> Bool {
+      !rangeMap.isEmpty
+    }
+
+    @discardableResult public mutating func open(_ path: String) -> Bool {
+      if isLoaded() {
+        return false
+      }
+
+      do {
+        let rawData = try Data(contentsOf: URL(fileURLWithPath: path))
+        let rawPlist: [String: String] =
+          try PropertyListSerialization.propertyList(from: rawData, format: nil) as? [String: String] ?? .init()
+        rangeMap = rawPlist
+      } catch {
+        IME.prtDebugIntel("\(error)")
+        IME.prtDebugIntel("↑ Exception happened when reading data at: \(path).")
+        return false
+      }
+
+      return true
+    }
+
+    public mutating func close() {
+      if isLoaded() {
+        rangeMap.removeAll()
+      }
+    }
+
+    public func dump() {
+      // We remove this function in order to reduce out maintenance workload.
+      // This function will be implemented only if further hard-necessity comes.
+    }
+
+    public func valuesFor(key: String) -> [String] {
+      var pairs: [String] = []
+      if let arrRangeRecords: String = rangeMap[key] {
+        pairs.append(contentsOf: arrRangeRecords.map({ String($0) }))
+      }
+      var set = Set<String>()
+      return pairs.filter { set.insert($0).inserted }
+    }
+
+    public func hasValuesFor(key: String) -> Bool { rangeMap.keys.contains(key) }
+  }
+}
+
+// MARK: - StringView Ranges Extension (by Isaac Xen)
+
+extension String {
+  fileprivate func ranges(splitBy separator: Element) -> [Range<String.Index>] {
+    var startIndex = startIndex
+    return split(separator: separator).reduce(into: []) { ranges, substring in
+      _ = range(of: substring, range: startIndex..<endIndex).map { range in
+        ranges.append(range)
+        startIndex = range.upperBound
+      }
+    }
+  }
+}

vChewing.xcodeproj/project.pbxproj

@@ -117,6 +117,7 @@
 		5BF9DA2A28840E6200DBD48E /* template-replacements.txt in Resources */ = {isa = PBXBuildFile; fileRef = 5BF9DA2528840E6200DBD48E /* template-replacements.txt */; };
 		5BF9DA2B28840E6200DBD48E /* template-userphrases.txt in Resources */ = {isa = PBXBuildFile; fileRef = 5BF9DA2628840E6200DBD48E /* template-userphrases.txt */; };
 		5BF9DA2D288427E000DBD48E /* template-associatedPhrases-cht.txt in Resources */ = {isa = PBXBuildFile; fileRef = 5BF9DA2C2884247800DBD48E /* template-associatedPhrases-cht.txt */; };
+		5BF9EC1628A2BFC600333639 /* lmPlainBopomofo.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5BF9EC1528A2BFC600333639 /* lmPlainBopomofo.swift */; };
 		5BFDF011289635C100417BBC /* ctlCandidateIMK.swift in Sources */ = {isa = PBXBuildFile; fileRef = 5BFDF010289635C100417BBC /* ctlCandidateIMK.swift */; };
 		6A187E2616004C5900466B2E /* MainMenu.xib in Resources */ = {isa = PBXBuildFile; fileRef = 6A187E2816004C5900466B2E /* MainMenu.xib */; };
 		6A225A1F23679F2600F685C6 /* NotarizedArchives in Resources */ = {isa = PBXBuildFile; fileRef = 6A225A1E23679F2600F685C6 /* NotarizedArchives */; };
@@ -333,6 +334,7 @@
 		5BF9DA2528840E6200DBD48E /* template-replacements.txt */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; lineEnding = 0; path = "template-replacements.txt"; sourceTree = "<group>"; usesTabs = 0; };
 		5BF9DA2628840E6200DBD48E /* template-userphrases.txt */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; lineEnding = 0; path = "template-userphrases.txt"; sourceTree = "<group>"; usesTabs = 0; };
 		5BF9DA2C2884247800DBD48E /* template-associatedPhrases-cht.txt */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; lineEnding = 0; name = "template-associatedPhrases-cht.txt"; path = "../Data/components/cht/template-associatedPhrases-cht.txt"; sourceTree = "<group>"; };
+		5BF9EC1528A2BFC600333639 /* lmPlainBopomofo.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = lmPlainBopomofo.swift; sourceTree = "<group>"; };
 		5BFDF010289635C100417BBC /* ctlCandidateIMK.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ctlCandidateIMK.swift; sourceTree = "<group>"; };
 		5BFDF48C27B51867009523B6 /* zh-Hant */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = "zh-Hant"; path = "zh-Hant.lproj/Main.strings"; sourceTree = "<group>"; };
 		6A0D4EA215FC0D2D00ABF4B3 /* vChewing.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = vChewing.app; sourceTree = BUILT_PRODUCTS_DIR; };
@@ -432,6 +434,7 @@
 				5B407309281672610023DFFF /* lmAssociates.swift */,
 				5B887F2F2826AEA400B6651E /* lmCoreEX.swift */,
 				5B54E742283A7D89001ECBDC /* lmCoreNS.swift */,
+				5BF9EC1528A2BFC600333639 /* lmPlainBopomofo.swift */,
 				5B40730A281672610023DFFF /* lmReplacements.swift */,
 				5BA0DF2E2817857D009E73BB /* lmUserOverride.swift */,
 			);
@@ -1177,6 +1180,7 @@
 				5BA9FD1027FEDB6B002DE248 /* suiPrefPaneKeyboard.swift in Sources */,
 				5B3133BF280B229700A4A505 /* KeyHandler_States.swift in Sources */,
 				5B2170E1289FACAD00BE7304 /* 0_Megrez.swift in Sources */,
+				5BF9EC1628A2BFC600333639 /* lmPlainBopomofo.swift in Sources */,
 				5B3A87BC28597CDB0090E163 /* LMSymbolNode.swift in Sources */,
 				5BA9FD4327FEF3C8002DE248 /* Preferences.swift in Sources */,
 				5BA9FD4427FEF3C8002DE248 /* SegmentedControlStyleViewController.swift in Sources */,