feat: 予測入力のUI実装と、Zenzaiを利用しないPoCの追加 (#270)

* feat: 予測入力のUI実装と、Zenzaiを利用しないPoCの追加

* fix: reduce call of requestCandidate

* feat: ヒステリシスを入れて入力時のちらつきを抑制

Author: ensan-hcl

Core/Package.swift

@@ -21,7 +21,7 @@ let package = Package(
         )
     ],
     dependencies: [
-        .package(url: "https://github.com/azooKey/AzooKeyKanaKanjiConverter", revision: "ecb569963d2969340cca81a3fe6840bdb9a0afc7", traits: kanaKanjiConverterTraits)
+        .package(url: "https://github.com/azooKey/AzooKeyKanaKanjiConverter", revision: "44cfd766f3939ee4901e46b81dcee6ea48c2c7e9", traits: kanaKanjiConverterTraits)
     ],
     targets: [
         .executableTarget(

Core/Sources/Core/Configs/BoolConfigItem.swift

@@ -26,6 +26,12 @@ extension Config {
         static let `default` = false
         public static let key: String = "dev.ensan.inputmethod.azooKeyMac.preference.debug.enableDebugWindow"
     }
+    /// 予測入力のデバッグ機能を有効化する設定
+    public struct DebugPredictiveTyping: BoolConfigItem {
+        public init() {}
+        static let `default` = false
+        public static let key: String = "dev.ensan.inputmethod.azooKeyMac.preference.debug.predictiveTyping"
+    }
     /// ライブ変換を有効化する設定
     public struct LiveConversion: BoolConfigItem {
         public init() {}

Core/Sources/Core/InputUtils/Actions/ClientAction.swift

@@ -49,6 +49,7 @@ public enum ClientAction {
 
     // PredictiveSuggestion
     case requestPredictiveSuggestion
+    case acceptPredictionCandidate
 
     // ReplaceSuggestion
     case requestReplaceSuggestion

Core/Sources/Core/InputUtils/InputState.swift

@@ -139,8 +139,10 @@ public enum InputState: Sendable, Hashable {
                 case .ten:
                     return (.submitHalfWidthRomanCandidate, .transition(.none))
                 }
-            case .forget, .tab:
+            case .forget:
                 return (.consume, .fallthrough)
+            case .tab:
+                return (.acceptPredictionCandidate, .fallthrough)
             case .英数:
                 return (.selectInputLanguage(.english), .fallthrough)
             case .かな:

Core/Sources/Core/InputUtils/SegmentsManager.swift

@@ -44,6 +44,15 @@ public final class SegmentsManager {
     private var replaceSuggestions: [Candidate] = []
     private var suggestSelectionIndex: Int?
 
+    public struct PredictionCandidate: Sendable {
+        public var displayText: String
+        public var appendText: String
+    }
+
+    private func candidateReading(_ candidate: Candidate) -> String {
+        candidate.data.map(\.ruby).joined()
+    }
+
     private lazy var zenzaiPersonalizationMode: ConvertRequestOptions.ZenzaiMode.PersonalizationMode? = self.getZenzaiPersonalizationMode()
 
     private func getZenzaiPersonalizationMode() -> ConvertRequestOptions.ZenzaiMode.PersonalizationMode? {
@@ -121,10 +130,15 @@ public final class SegmentsManager {
         }
     }
 
-    private func options(leftSideContext: String? = nil, requestRichCandidates: Bool = false) -> ConvertRequestOptions {
+    private func options(
+        leftSideContext: String?,
+        requestRichCandidates: Bool,
+        requireJapanesePrediction: ConvertRequestOptions.PredictionMode,
+        requireEnglishPrediction: ConvertRequestOptions.PredictionMode
+    ) -> ConvertRequestOptions {
         .init(
-            requireJapanesePrediction: false,
-            requireEnglishPrediction: false,
+            requireJapanesePrediction: requireJapanesePrediction,
+            requireEnglishPrediction: requireEnglishPrediction,
             keyboardLanguage: .ja_JP,
             englishCandidateInRoman2KanaInput: false,
             fullWidthRomanCandidate: true,
@@ -361,7 +375,15 @@ public final class SegmentsManager {
 
         let prefixComposingText = self.composingText.prefixToCursorPosition()
         let leftSideContext = forcedLeftSideContext ?? self.getCleanLeftSideContext(maxCount: 30)
-        let result = self.kanaKanjiConverter.requestCandidates(prefixComposingText, options: options(leftSideContext: leftSideContext, requestRichCandidates: requestRichCandidates))
+        let result = self.kanaKanjiConverter.requestCandidates(
+            prefixComposingText,
+            options: options(
+                leftSideContext: leftSideContext,
+                requestRichCandidates: requestRichCandidates,
+                requireJapanesePrediction: Config.DebugPredictiveTyping().value ? .manualMix : .disabled,
+                requireEnglishPrediction: Config.DebugPredictiveTyping().value ? .manualMix : .disabled
+            )
+        )
         self.rawCandidates = result
     }
 
@@ -556,6 +578,52 @@ public final class SegmentsManager {
         suggestSelectionIndex = nil
     }
 
+    public func requestPredictionCandidates() -> [PredictionCandidate] {
+        guard Config.DebugPredictiveTyping().value else {
+            return []
+        }
+
+        let target = self.composingText.convertTarget
+        guard !target.isEmpty else {
+            return []
+        }
+
+        var matchTarget = target
+        if let last = matchTarget.last,
+           last.unicodeScalars.allSatisfy({ $0.isASCII && CharacterSet.letters.contains($0) }) {
+            matchTarget.removeLast()
+        }
+        guard matchTarget.count >= 2 else {
+            return []
+        }
+        matchTarget = matchTarget.toHiragana()
+
+        guard let rawCandidates else {
+            return []
+        }
+
+        for candidate in rawCandidates.predictionResults {
+            let reading = candidateReading(candidate)
+            guard !reading.isEmpty else {
+                continue
+            }
+            let readingHiragana = reading.toHiragana()
+            guard readingHiragana.hasPrefix(matchTarget) else {
+                continue
+            }
+            guard matchTarget.count < readingHiragana.count else {
+                continue
+            }
+            let appendText = String(readingHiragana.dropFirst(matchTarget.count))
+            guard !appendText.isEmpty else {
+                continue
+            }
+            return [.init(displayText: candidate.text, appendText: appendText)]
+        }
+
+        return []
+    }
+
     // swiftlint:disable:next cyclomatic_complexity
     public func getCurrentMarkedText(inputState: InputState) -> MarkedText {
         switch inputState {

azooKeyMac/InputController/CandidateWindow/CandidateView.swift

@@ -80,3 +80,54 @@ class CandidatesViewController: BaseCandidateViewController {
         }
     }
 }
+
+class PredictionCandidatesViewController: BaseCandidateViewController {
+    private let prefixTabStop: CGFloat = 24
+    private let prefixSymbolName = "arrow.forward.to.line.compact"
+    private let prefixFontSize: CGFloat = 12
+
+    override var numberOfVisibleRows: Int {
+        min(3, self.tableView.numberOfRows)
+    }
+
+    override internal func configureCellView(_ cell: CandidateTableCellView, forRow row: Int) {
+        let candidateText = candidates[row].text
+        let attributedString = NSMutableAttributedString()
+
+        let isSelected = currentSelectedRow == row
+        let candidateColor = isSelected ? NSColor.white : NSColor.labelColor
+
+        if let symbol = NSImage(systemSymbolName: prefixSymbolName, accessibilityDescription: nil) {
+            let config = NSImage.SymbolConfiguration(pointSize: prefixFontSize, weight: .regular)
+            let configured = symbol.withSymbolConfiguration(config) ?? symbol
+            let attachment = NSTextAttachment()
+            attachment.image = configured
+            attachment.bounds = NSRect(x: 0, y: -2, width: prefixFontSize + 2, height: prefixFontSize + 2)
+            attributedString.append(NSAttributedString(attachment: attachment))
+        }
+        attributedString.append(NSAttributedString(string: "\t"))
+        let candidateAttributed = NSAttributedString(
+            string: candidateText,
+            attributes: [
+                .font: NSFont.systemFont(ofSize: 18),
+                .foregroundColor: candidateColor
+            ]
+        )
+        attributedString.append(candidateAttributed)
+
+        let fullRange = NSRange(location: 0, length: attributedString.length)
+
+        let paragraphStyle = NSMutableParagraphStyle()
+        paragraphStyle.tabStops = [
+            NSTextTab(textAlignment: .left, location: prefixTabStop, options: [:])
+        ]
+        paragraphStyle.defaultTabInterval = prefixTabStop
+        attributedString.addAttribute(.paragraphStyle, value: paragraphStyle, range: fullRange)
+
+        cell.candidateTextField.attributedStringValue = attributedString
+    }
+
+    override func getWindowWidth(maxContentWidth: CGFloat) -> CGFloat {
+        maxContentWidth + prefixTabStop + 20
+    }
+}