Merge pull request #407 from mtgto/skkserv-completion

mtgto · web-flow · commit 08c570e60213 · 2025-11-09T16:34:16.000+09:00
SKKServに補完候補を問い合わせする設定を追加
diff --git a/macSKK/Global.swift b/macSKK/Global.swift
@@ -25,7 +25,7 @@ import Combine
     /// 1文字目を常に未確定扱いするワークアラウンドを適用するBundle Identifierの集合
     static let treatFirstCharacterAsMarkedTextBundleIdentifiers = CurrentValueSubject<[String], Never>([])
     /// ユーザー辞書だけでなくすべての辞書から補完候補を検索するか？
-    static let findCompletionFromAllDicts = CurrentValueSubject<Bool, Never>(false)
+    static var findCompletionFromAllDicts = false
     /// 現在のローマ字かな変換ルール
     static var kanaRule: Romaji!
     /// デフォルトでもってるローマ字かな変換ルール
@@ -51,6 +51,8 @@ import Combine
     static var candidateListDirection = CurrentValueSubject<CandidateListDirection, Never>(.vertical)
     /// ピリオドで補完候補の最初の要素で確定するか
     static var fixedCompletionByPeriod: Bool = true
+    /// SKKServから補完候補を検索するか
+    static var searchCompletionsSkkserv: Bool = false
     /// 現在のモードを表示するパネル
     private let inputModePanel: InputModePanel
     /// 変換候補を表示するパネル
diff --git a/macSKK/InputController.swift b/macSKK/InputController.swift
@@ -184,11 +184,12 @@ class InputController: IMKInputController {
             }
             .receive(on: DispatchQueue.global())
             .compactMap { (yomi, cursorPosition) -> (String, Completion, NSRect)? in
+                let skkservDict = Global.searchCompletionsSkkserv ? Global.skkservDict : nil
                 if Global.showCandidateForCompletion {
-                    let candidates = Global.dictionary.candidatesForCompletion(prefix: yomi)
+                    let candidates = Global.dictionary.candidatesForCompletion(prefix: yomi, skkservDict: skkservDict, findFromAllDicts: Global.findCompletionFromAllDicts)
                     return (yomi, .candidates(candidates), cursorPosition)
-                 } else {
-                    let completions = Global.dictionary.findCompletions(prefix: yomi)
+                } else {
+                    let completions = Global.dictionary.findCompletionsDicts(prefix: yomi, skkservDict: skkservDict, findFromAllDicts: Global.findCompletionFromAllDicts)
                     return (yomi, .yomi(completions, 0), cursorPosition)
                 }
             }
@@ -267,12 +268,6 @@ class InputController: IMKInputController {
                     self?.stateMachine.inlineCandidateCount = inlineCandidateCount
                 }
             }.store(in: &cancellables)
-        NotificationCenter.default.publisher(for: notificationNameFindCompletionFromAllDicts)
-            .sink { notification in
-                if let findCompletionFromAllDicts = notification.object as? Bool {
-                    Global.findCompletionFromAllDicts.send(findCompletionFromAllDicts)
-                }
-            }.store(in: &cancellables)
     }
 
     @MainActor override func handle(_ event: NSEvent!, client sender: Any!) -> Bool {
diff --git a/macSKK/SKKServDict.swift b/macSKK/SKKServDict.swift
@@ -62,6 +62,37 @@ struct SKKServDict {
         }
     }
 
+    func findCompletions(prefix: String) -> [String] {
+        do {
+            let result = try service.completion(yomi: prefix, destination: destination, timeout: 1.0)
+            // 補完結果が見つかった場合は "1/ほかん/ほかんこうほ/" のように 1が先頭でスラッシュで区切られた文字列
+            // 見つからなかた場合は "4ほかん" のように4が先頭の文字列
+            guard result.hasPrefix("1/") else {
+                logger.debug("skkservから補完候補が見つからなかったレスポンスが返りました")
+                return []
+            }
+            return result.dropFirst(2).split(separator: "/").map { String($0) }
+        } catch {
+            if let error = error as? SKKServClientError {
+                switch error {
+                case .connectionRefused:
+                    logger.log("skkservが応答しません")
+                case .connectionTimeout:
+                    logger.log("skkservとの接続がタイムアウトしました")
+                case .invalidResponse:
+                    logger.warning("skkservから想定しない応答が返りました")
+                case .timeout:
+                    logger.log("skkservから応答が一定時間返りませんでした")
+                default:
+                    logger.error("skkservから不明なエラーが返りました")
+                }
+            } else {
+                logger.error("skkserv辞書の検索でエラーが発生しました: \(error, privacy: .public)")
+            }
+            return []
+        }
+    }
+
     func disconnect() {
         do {
             try service.disconnect()
diff --git a/macSKK/SKKServService.swift b/macSKK/SKKServService.swift
@@ -5,6 +5,7 @@ import Foundation
 
 protocol SKKServServiceProtocol {
     func refer(yomi: String, destination: SKKServDestination, timeout: TimeInterval) throws -> String
+    func completion(yomi: String, destination: SKKServDestination, timeout: TimeInterval) throws -> String
     func disconnect() throws
 }
 
diff --git a/macSKK/Settings/SKKServDictSetting.swift b/macSKK/Settings/SKKServDictSetting.swift
@@ -12,13 +12,16 @@ final class SKKServDictSetting: ObservableObject {
     @Published var encoding: String.Encoding
     /// 変換履歴をユーザー辞書に保存するかどうか
     @Published var saveToUserDict: Bool
+    /// 補完候補をSKKServから取得するか
+    @Published var enableCompletion: Bool
 
-    init(enabled: Bool, address: String, port: UInt16, encoding: String.Encoding, saveToUserDict: Bool) {
+    init(enabled: Bool, address: String, port: UInt16, encoding: String.Encoding, saveToUserDict: Bool, enableCompletion: Bool) {
         self.enabled = enabled
         self.address = address
         self.port = port
         self.encoding = encoding
         self.saveToUserDict = saveToUserDict
+        self.enableCompletion = enableCompletion
     }
 
     // UserDefaultsのDictionaryを受け取る
@@ -31,9 +34,12 @@ final class SKKServDictSetting: ObservableObject {
         self.port = port
         guard let encoding = dictionary["encoding"] as? UInt else { return nil }
         self.encoding = String.Encoding(rawValue: encoding)
-        // v2.2.1までは存在しなかった設定
+        // v2.2.1まで存在しなかった設定
         let saveToUserDict = dictionary["saveToUserDict"] as? Bool ?? true
         self.saveToUserDict = saveToUserDict
+        // v2.5.0まで存在しなかった設定
+        let enableCompletion = dictionary["enableCompletion"] as? Bool ?? false
+        self.enableCompletion = enableCompletion
     }
 
     // UserDefaults用にDictionaryにシリアライズ
@@ -44,6 +50,7 @@ final class SKKServDictSetting: ObservableObject {
             "port": port,
             "encoding": encoding.rawValue,
             "saveToUserDict": saveToUserDict,
+            "enableCompletion": enableCompletion,
         ]
     }
 }
diff --git a/macSKK/Settings/SKKServDictView.swift b/macSKK/Settings/SKKServDictView.swift
@@ -28,6 +28,10 @@ struct SKKServDictView: View {
                         Text("Save conversion history to User Dictionary")
                     }
                     .toggleStyle(.switch)
+                    Toggle(isOn: $settingsViewModel.skkservDictSetting.enableCompletion) {
+                        Text("Search completions")
+                    }
+                    .toggleStyle(.switch)
                 } header: {
                     Text("SKKServDictTitle")
                 }
@@ -167,7 +171,8 @@ struct SKKServDictView: View {
         address: "127.0.0.1",
         port: 1178,
         encoding: .japaneseEUC,
-        saveToUserDict: true)
+        saveToUserDict: true,
+        enableCompletion: false)
     return SKKServDictView(settingsViewModel: try! SettingsViewModel(skkservDictSetting: setting),
                     isShowSheet: .constant(true), information: "skkservが応答していません")
 }
diff --git a/macSKK/Settings/SettingsViewModel.swift b/macSKK/Settings/SettingsViewModel.swift
@@ -286,7 +286,7 @@ final class SettingsViewModel: ObservableObject {
         Global.punctuation = Punctuation(comma: comma, period: period)
         Global.ignoreUserDictInPrivateMode.send(ignoreUserDictInPrivateMode)
         Global.candidateListDirection.send(candidateListDirection)
-        Global.findCompletionFromAllDicts.send(findCompletionFromAllDicts)
+        Global.findCompletionFromAllDicts = findCompletionFromAllDicts
 
         // SKK-JISYO.Lのようなファイルの読み込みが遅いのでバックグラウンドで処理
         $dictSettings.filter({ !$0.isEmpty }).receive(on: DispatchQueue.global()).sink { dictSettings in
@@ -333,6 +333,7 @@ final class SettingsViewModel: ObservableObject {
                 logger.log("skkserv辞書は無効化されています")
                 Global.skkservDict = nil
             }
+            Global.searchCompletionsSkkserv = setting.enableCompletion
             UserDefaults.app.set(setting.encode(), forKey: UserDefaultsKeys.skkservClient)
         }.store(in: &cancellables)
 
@@ -451,7 +452,7 @@ final class SettingsViewModel: ObservableObject {
 
         $findCompletionFromAllDicts.dropFirst().sink { findCompletionFromAllDicts in
             UserDefaults.app.set(findCompletionFromAllDicts, forKey: UserDefaultsKeys.findCompletionFromAllDicts)
-            NotificationCenter.default.post(name: notificationNameFindCompletionFromAllDicts, object: findCompletionFromAllDicts)
+            Global.findCompletionFromAllDicts = findCompletionFromAllDicts
             logger.log("一般の辞書を使って補完するかを\(findCompletionFromAllDicts)に変更しました")
         }.store(in: &cancellables)
 
@@ -582,7 +583,8 @@ final class SettingsViewModel: ObservableObject {
             address: "127.0.0.1",
             port: 1178,
             encoding: .japaneseEUC,
-            saveToUserDict: true)
+            saveToUserDict: true,
+            enableCompletion: false)
         selectCandidateKeys = "123456789"
         findCompletionFromAllDicts = false
         keyBindingSets = [KeyBindingSet.defaultKeyBindingSet]
diff --git a/macSKK/UserDict.swift b/macSKK/UserDict.swift
@@ -29,20 +29,17 @@ class UserDict: NSObject, DictProtocol {
     private let privateMode: CurrentValueSubject<Bool, Never>
     /// プライベートモード時に変換候補にユーザー辞書を無視するかどうか
     private let ignoreUserDictInPrivateMode: CurrentValueSubject<Bool, Never>
-    // ユーザー辞書だけでなくすべての辞書から補完候補を検索するか？
-    private let findCompletionFromAllDicts: CurrentValueSubject<Bool, Never>
     private var cancellables: Set<AnyCancellable> = []
     let saveToUserDict = true
 
     // MARK: NSFilePresenter
     let presentedItemURL: URL?
     let presentedItemOperationQueue: OperationQueue = OperationQueue()
 
-    init(dicts: [any DictProtocol], userDictEntries: [String: [Word]]? = nil, privateMode: CurrentValueSubject<Bool, Never>, ignoreUserDictInPrivateMode: CurrentValueSubject<Bool, Never>, findCompletionFromAllDicts: CurrentValueSubject<Bool, Never>, dateYomis: [DateConversion.Yomi], dateConversions: [DateConversion]) throws {
+    init(dicts: [any DictProtocol], userDictEntries: [String: [Word]]? = nil, privateMode: CurrentValueSubject<Bool, Never>, ignoreUserDictInPrivateMode: CurrentValueSubject<Bool, Never>, dateYomis: [DateConversion.Yomi], dateConversions: [DateConversion]) throws {
         self.dicts = dicts
         self.privateMode = privateMode
         self.ignoreUserDictInPrivateMode = ignoreUserDictInPrivateMode
-        self.findCompletionFromAllDicts = findCompletionFromAllDicts
         self.dateYomis = dateYomis
         self.dateConversions = dateConversions
         dictionariesDirectoryURL = try FileManager.default.url(
@@ -207,6 +204,46 @@ class UserDict: NSObject, DictProtocol {
     }
 
     /**
+     * 保持する辞書を順に引き現在入力中のprefixに続く入力候補を返す。見つからなければ空配列を返す。
+     *
+     * ## skkservについて
+     * skkservを辞書とする場合はすべてのファイル辞書の候補の末尾に付けて返す。
+     * skkserv辞書の変換候補を末尾につけるのは仮の仕様で将来は利用者が選択可能にする可能性がある。
+     *
+     * skkservからの応答が一定時間なかった場合はTCP接続を切断する。
+     * 実装を簡単にするためskkserv辞書が有効なまま再度このメソッドが呼ばれたら再接続から試みる。
+     *
+     * - Parameters:
+     *   - prefix: SKK辞書の見出しの接頭辞。複数のひらがな、もしくは複数のひらがな + ローマ字からなる文字列
+     *   - skkservDict: SKKServ辞書。nilのときはskkservを引かない
+     *   - findFromAllDicts: ユーザー辞書以外を検索するか
+     */
+    func findCompletionsDicts(prefix: String, skkservDict: SKKServDict?, findFromAllDicts: Bool) -> [String] {
+        if prefix.isEmpty {
+            return []
+        }
+        var results: [String] = findCompletions(prefix: prefix)
+        if findFromAllDicts {
+            for dict in dicts {
+                for yomi in dict.findCompletions(prefix: prefix) {
+                    if !results.contains(yomi) {
+                        results.append(yomi)
+                    }
+                }
+            }
+        }
+        if let skkservDict {
+            for yomi in skkservDict.findCompletions(prefix: prefix) {
+                if !results.contains(yomi) {
+                    results.append(yomi)
+                }
+            }
+        }
+        return results
+    }
+
+    /**
+     * ユーザー辞書のみから検索して他のSKK辞書は参照しない。すべての辞書から参照する場合は ``referDicts(_:option:skkservDict:findFromAllDicts:)`` を使用すること。
      * プライベートモードで入力したエントリは参照しない。
      */
     func refer(_ yomi: String, option: DictReferringOption? = nil) -> [Word] {
@@ -316,15 +353,6 @@ class UserDict: NSObject, DictProtocol {
                 results.append(dateYomi.yomi)
             }
         }
-        if findCompletionFromAllDicts.value {
-            for dict in dicts {
-                for yomi in dict.findCompletions(prefix: prefix) {
-                    if !results.contains(yomi) {
-                        results.append(yomi)
-                    }
-                }
-            }
-        }
         return results
     }
 
@@ -334,20 +362,20 @@ class UserDict: NSObject, DictProtocol {
      * asyncにするかも? (skkservとかで便利そう)
      * AsyncStreamにするかも?
      */
-    func candidatesForCompletion(prefix: String) -> [Candidate] {
+    func candidatesForCompletion(prefix: String, skkservDict: SKKServDict?, findFromAllDicts: Bool) -> [Candidate] {
         // 1文字のときは全探索するとめちゃくちゃ量が多いので完全一致だけ探す
         if prefix.count == 1 {
-            return referDicts(prefix, option: nil, skkservDict: nil, findFromAllDicts: findCompletionFromAllDicts.value)
+            return referDicts(prefix, option: nil, skkservDict: skkservDict, findFromAllDicts: findFromAllDicts)
                 .map { candidate in
                     candidate.withOriginal(Candidate.Original(midashi: prefix, word: candidate.word))
                 }
         }
         // あとでいろいろ拡張するけどひとまずfindCompletionsの結果を[Candidate]にするだけ
         // 別スレッドから実行したいのでひとまずskkserv以外を検索する
-        return findCompletions(prefix: prefix).flatMap { midashi in
+        return findCompletionsDicts(prefix: prefix, skkservDict: skkservDict, findFromAllDicts: findFromAllDicts).flatMap { midashi in
             // NOTE: 多すぎても役に立たないだろうと思うのでひとまず先頭100件に制限。設定項目にしてもよさそう
             // FIXME: Candidateの配列じゃなくて、(String, Candidate) のように見出し語と変換候補のタプルの配列を返すほうがよさそう
-            referDicts(midashi, option: nil, skkservDict: nil, findFromAllDicts: findCompletionFromAllDicts.value)
+            referDicts(midashi, option: nil, skkservDict: skkservDict, findFromAllDicts: findFromAllDicts)
                 .prefix(100)
                 .map { candidate in
                     candidate.withOriginal(Candidate.Original(midashi: midashi, word: candidate.word))
diff --git a/macSKK/en.lproj/Localizable.strings b/macSKK/en.lproj/Localizable.strings
@@ -93,6 +93,7 @@
 "TCP Port" = "TCP Port No.";
 "Response Encoding" = "Response Encoding";
 "Save conversion history to User Dictionary" = "Save conversion history to User Dictionary";
+"Search completions" = "Search completions";
 "Yomi" = "Yomi";
 "Find Candidates" = "Find Candidates";
 "Find Completions" = "Find Completions";
diff --git a/macSKK/ja.lproj/Localizable.strings b/macSKK/ja.lproj/Localizable.strings
@@ -93,6 +93,7 @@
 "TCP Port" = "TCPポート番号";
 "Response Encoding" = "応答エンコーディング";
 "Save conversion history to User Dictionary" = "ユーザー辞書に変換履歴を保存する";
+"Search completions" = "補完候補を検索する";
 "Yomi" = "読み";
 "Find Candidates" = "変換候補を検索";
 "Find Completions" = "補完候補を検索";
diff --git a/macSKK/macSKKApp.swift b/macSKK/macSKKApp.swift
@@ -18,8 +18,6 @@ let notificationNameToggleTreatFirstCharacterAsMarkedText = Notification.Name("t
 let notificationNameOpenSettings = Notification.Name("openSettings")
 // インラインで表示する変換候補の数を変更したときに通知される通知の名前
 let notificationNameInlineCandidateCount = Notification.Name("inlineCandidateCount")
-// 一般辞書を補完で検索するかが変更されたときに通知される通知の名前
-let notificationNameFindCompletionFromAllDicts =  Notification.Name("findCompletionFromAllDicts")
 
 func isTest() -> Bool {
     return ProcessInfo.processInfo.environment["MACSKK_IS_TEST"] == "1"
@@ -61,7 +59,6 @@ struct macSKKApp: App {
             Global.dictionary = try UserDict(dicts: [],
                                              privateMode: Global.privateMode,
                                              ignoreUserDictInPrivateMode: Global.ignoreUserDictInPrivateMode,
-                                             findCompletionFromAllDicts: Global.findCompletionFromAllDicts,
                                              dateYomis: settingsViewModel.dateYomis,
                                              dateConversions: settingsViewModel.dateConversions)
             settingsWindowController = NSWindowController(window: settingsWindow)
@@ -193,7 +190,8 @@ struct macSKKApp: App {
                 address: "127.0.0.1",
                 port: 1178,
                 encoding: .japaneseEUC,
-                saveToUserDict: true).encode(),
+                saveToUserDict: true,
+                enableCompletion: false).encode(),
             UserDefaultsKeys.findCompletionFromAllDicts: false,
             UserDefaultsKeys.keyBindingSets: [],
             UserDefaultsKeys.selectedKeyBindingSetId: KeyBindingSet.defaultKeyBindingSet.id,
diff --git a/macSKKTests/SKKServDictSettingTests.swift b/macSKKTests/SKKServDictSettingTests.swift
@@ -14,5 +14,7 @@ final class SKKServDictSettingTests: XCTestCase {
         ]))
         // v2.2.1まではsaveToUserDictは設定としてなかった。辞書にエントリがない場合はtrue
         XCTAssertTrue(skkServDictSetting.saveToUserDict)
+        // v2.5.0まではenableCompletionは設定としてなかった。辞書にエントリがない場合はfalse
+        XCTAssertFalse(skkServDictSetting.enableCompletion)
     }
 }
diff --git a/macSKKTests/SKKServDictTests.swift b/macSKKTests/SKKServDictTests.swift
diff --git a/macSKKTests/StateMachineTests.swift b/macSKKTests/StateMachineTests.swift
diff --git a/macSKKTests/UserDictTests.swift b/macSKKTests/UserDictTests.swift

Original file line number	Diff line number	Diff line change
`@@ -184,11 +184,12 @@ class InputController: IMKInputController {`
`184`	`184`	`}`
`185`	`185`	`.receive(on: DispatchQueue.global())`
`186`	`186`	`.compactMap { (yomi, cursorPosition) -> (String, Completion, NSRect)? in`
	`187`	`+ let skkservDict = Global.searchCompletionsSkkserv ? Global.skkservDict : nil`
`187`	`188`	`if Global.showCandidateForCompletion {`
`188`		`- let candidates = Global.dictionary.candidatesForCompletion(prefix: yomi)`
	`189`	`+ let candidates = Global.dictionary.candidatesForCompletion(prefix: yomi, skkservDict: skkservDict, findFromAllDicts: Global.findCompletionFromAllDicts)`
`189`	`190`	`return (yomi, .candidates(candidates), cursorPosition)`
`190`		`- } else {`
`191`		`- let completions = Global.dictionary.findCompletions(prefix: yomi)`
	`191`	`+ } else {`
	`192`	`+ let completions = Global.dictionary.findCompletionsDicts(prefix: yomi, skkservDict: skkservDict, findFromAllDicts: Global.findCompletionFromAllDicts)`
`192`	`193`	`return (yomi, .yomi(completions, 0), cursorPosition)`
`193`	`194`	`}`
`194`	`195`	`}`
`@@ -267,12 +268,6 @@ class InputController: IMKInputController {`
`267`	`268`	`self?.stateMachine.inlineCandidateCount = inlineCandidateCount`
`268`	`269`	`}`
`269`	`270`	`}.store(in: &cancellables)`
`270`		`- NotificationCenter.default.publisher(for: notificationNameFindCompletionFromAllDicts)`
`271`		`- .sink { notification in`
`272`		`- if let findCompletionFromAllDicts = notification.object as? Bool {`
`273`		`- Global.findCompletionFromAllDicts.send(findCompletionFromAllDicts)`
`274`		`- }`
`275`		`- }.store(in: &cancellables)`
`276`	`271`	`}`
`277`	`272`
`278`	`273`	`@MainActor override func handle(_ event: NSEvent!, client sender: Any!) -> Bool {`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ import Foundation`
`5`	`5`
`6`	`6`	`protocol SKKServServiceProtocol {`
`7`	`7`	`func refer(yomi: String, destination: SKKServDestination, timeout: TimeInterval) throws -> String`
	`8`	`+ func completion(yomi: String, destination: SKKServDestination, timeout: TimeInterval) throws -> String`
`8`	`9`	`func disconnect() throws`
`9`	`10`	`}`
`10`	`11`