SessionCtl // Revamp certain client()-related operations.

Source/Modules/SessionCtl_Core.swift

@@ -95,18 +95,26 @@ class SessionCtl: IMKInputController {
   /// 順帶更新 IME 模組及 UserPrefs 當中對於當前語言模式的記載。
   var inputMode: Shared.InputMode = IMEApp.currentInputMode {
     willSet {
-      /// 將新的簡繁輸入模式提報給 Prefs 與 IME 模組。
+      /// 將新的簡繁輸入模式提報給 Prefs 模組。IMEApp 模組會據此計算正確的資料值。
-      IMEApp.currentInputMode = newValue
+      PrefMgr.shared.mostRecentInputMode = newValue.rawValue
-      PrefMgr.shared.mostRecentInputMode = IMEApp.currentInputMode.rawValue
     }
     didSet {
-      /// 重設所有語言模組。這裡不需要做按需重設，因為對運算量沒有影響。
+      if oldValue != inputMode, inputMode != .imeModeNULL {
-      keyHandler.currentLM = LMMgr.currentLM()  // 會自動更新組字引擎內的模組。
+        UserDefaults.standard.synchronize()
-      keyHandler.currentUOM = LMMgr.currentUOM()
+        keyHandler.clear()  // 這句不要砍，因為後面 handle State.Empty() 不一定執行。
-      /// 清空注拼槽＋同步最新的注拼槽排列設定。
+        // ----------------------------
-      keyHandler.ensureKeyboardParser()
+        /// 重設所有語言模組。這裡不需要做按需重設，因為對運算量沒有影響。
-      /// 將輸入法偏好設定同步至語言模組內。
+        keyHandler.currentLM = LMMgr.currentLM()  // 會自動更新組字引擎內的模組。
-      syncBaseLMPrefs()
+        keyHandler.currentUOM = LMMgr.currentUOM()
+        /// 清空注拼槽＋同步最新的注拼槽排列設定。
+        keyHandler.ensureKeyboardParser()
+        /// 將輸入法偏好設定同步至語言模組內。
+        syncBaseLMPrefs()
+        // ----------------------------
+        Self.isVerticalTyping = isVerticalTyping
+        // 強制重設當前鍵盤佈局、使其與偏好設定同步。這裡的這一步也不能省略。
+        handle(state: IMEState.ofEmpty())
+      }
     }
   }
 
@@ -122,9 +130,6 @@ class SessionCtl: IMKInputController {
     super.init(server: server, delegate: delegate, client: inputClient)
     keyHandler.delegate = self
     syncBaseLMPrefs()
-    // 下述兩行很有必要，否則輸入法會在手動重啟之後無法立刻生效。
-    resetKeyHandler()
-    activateServer(inputClient)
   }
 }
 
@@ -134,11 +139,18 @@ extension SessionCtl {
   /// 指定鍵盤佈局。
   func setKeyLayout() {
     guard let client = client() else { return }
-    if (isASCIIMode && IMKHelper.isDynamicBasicKeyboardLayoutEnabled) || state.isCandidateContainer {
+
-      client.overrideKeyboard(withKeyboardNamed: PrefMgr.shared.alphanumericalKeyboardLayout)
+    func doSetKeyLayout() {
-      return
+      if (isASCIIMode && IMKHelper.isDynamicBasicKeyboardLayoutEnabled) || state.isCandidateContainer {
+        client.overrideKeyboard(withKeyboardNamed: PrefMgr.shared.alphanumericalKeyboardLayout)
+        return
+      }
+      client.overrideKeyboard(withKeyboardNamed: PrefMgr.shared.basicKeyboardLayout)
+    }
+
+    DispatchQueue.main.async {
+      doSetKeyLayout()
     }
-    client.overrideKeyboard(withKeyboardNamed: PrefMgr.shared.basicKeyboardLayout)
   }
 
   /// 重設按鍵調度模組，會將當前尚未遞交的內容遞交出去。
@@ -189,17 +201,9 @@ extension SessionCtl {
       }
     }
 
-    /// 必須加上下述條件，否則會在每次切換至輸入法本體的視窗（比如偏好設定視窗）時會卡死。
+    DispatchQueue.main.async {
-    /// 這是很多 macOS 副廠輸入法的常見失誤之處。
+      (NSApp.delegate as? AppDelegate)?.updateSputnik.checkForUpdate(forced: false, url: kUpdateInfoSourceURL)
-    if let client = client() {
+    }
-      Self.isVerticalTyping = isVerticalTyping
-      if client.bundleIdentifier() != Bundle.main.bundleIdentifier {
-        // 強制重設當前鍵盤佈局、使其與偏好設定同步。
-        setKeyLayout()
-        handle(state: IMEState.ofEmpty())
-      }
-    }  // 除此之外就不要動了，免得在點開輸入法自身的視窗時卡死。
-    (NSApp.delegate as? AppDelegate)?.updateSputnik.checkForUpdate(forced: false, url: kUpdateInfoSourceURL)
   }
 
   /// 停用輸入法時，會觸發該函式。
@@ -218,28 +222,13 @@ extension SessionCtl {
   override func setValue(_ value: Any!, forTag tag: Int, client sender: Any!) {
     _ = tag  // 防止格式整理工具毀掉與此對應的參數。
     _ = sender  // 防止格式整理工具毀掉與此對應的參數。
-    var newInputMode = Shared.InputMode(rawValue: value as? String ?? "") ?? Shared.InputMode.imeModeNULL
+    let newInputMode = Shared.InputMode(rawValue: value as? String ?? "") ?? Shared.InputMode.imeModeNULL
-    switch newInputMode {
-      case .imeModeCHS:
-        newInputMode = .imeModeCHS
-      case .imeModeCHT:
-        newInputMode = .imeModeCHT
-      default:
-        newInputMode = .imeModeNULL
-    }
     if PrefMgr.shared.onlyLoadFactoryLangModelsIfNeeded { LMMgr.loadDataModel(newInputMode) }
-
+    inputMode = newInputMode
-    if inputMode != newInputMode {
+    if let rawValString = value as? String, let bundleID = Bundle.main.bundleIdentifier,
-      UserDefaults.standard.synchronize()
+      !bundleID.isEmpty, !rawValString.contains(bundleID)
-      keyHandler.clear()  // 這句不要砍，因為後面 handle State.Empty() 不一定執行。
+    {
-      inputMode = newInputMode
+      setKeyLayout()
-      /// 必須加上下述條件，否則會在每次切換至輸入法本體的視窗（比如偏好設定視窗）時會卡死。
-      /// 這是很多 macOS 副廠輸入法的常見失誤之處。
-      if let client = client(), client.bundleIdentifier() != Bundle.main.bundleIdentifier {
-        // 強制重設當前鍵盤佈局、使其與偏好設定同步。這裡的這一步也不能省略。
-        setKeyLayout()
-        handle(state: IMEState.ofEmpty())
-      }  // 除此之外就不要動了，免得在點開輸入法自身的視窗時卡死。
     }
   }
 

Source/Modules/SessionCtl_HandleStates.swift

@@ -93,9 +93,8 @@ extension SessionCtl {
 
   /// 針對受 .NotEmpty() 管轄的非空狀態，在組字區內顯示游標。
   func setInlineDisplayWithCursor() {
-    guard let client = client() else { return }
     if state.type == .ofAssociates {
-      client.setMarkedText(
+      doSetMarkedText(
         state.data.attributedStringPlaceholder, selectionRange: NSRange(location: 0, length: 0),
         replacementRange: NSRange(location: NSNotFound, length: NSNotFound)
       )
@@ -106,7 +105,7 @@ extension SessionCtl {
       /// 所謂選區「selectionRange」，就是「可見游標位置」的位置，只不過長度
       /// 是 0 且取代範圍（replacementRange）為「NSNotFound」罷了。
       /// 也就是說，內文組字區該在哪裡出現，得由客體軟體來作主。
-      client.setMarkedText(
+      doSetMarkedText(
         attributedStringSecured.0, selectionRange: attributedStringSecured.1,
         replacementRange: NSRange(location: NSNotFound, length: NSNotFound)
       )
@@ -120,8 +119,7 @@ extension SessionCtl {
   /// 在處理不受 .NotEmpty() 管轄的狀態時可能要用到的函式，會清空螢幕上顯示的內文組字區。
   /// 當 setInlineDisplayWithCursor() 在錯誤的狀態下被呼叫時，也會觸發這個函式。
   private func clearInlineDisplay() {
-    guard let theClient = client() else { return }
+    doSetMarkedText(
-    theClient.setMarkedText(
       "", selectionRange: NSRange(location: 0, length: 0),
       replacementRange: NSRange(location: NSNotFound, length: NSNotFound)
     )
@@ -135,8 +133,28 @@ extension SessionCtl {
     if buffer.isEmpty {
       return
     }
-    client.insertText(
+    if let myID = Bundle.main.bundleIdentifier, let clientID = client.bundleIdentifier(), myID == clientID {
-      buffer, replacementRange: NSRange(location: NSNotFound, length: NSNotFound)
+      DispatchQueue.main.async {
-    )
+        client.insertText(
+          buffer, replacementRange: NSRange(location: NSNotFound, length: NSNotFound)
+        )
+      }
+    } else {
+      client.insertText(
+        buffer, replacementRange: NSRange(location: NSNotFound, length: NSNotFound)
+      )
+    }
+  }
+
+  /// 把 setMarkedText 包裝一下，按需啟用 GCD。
+  func doSetMarkedText(_ string: Any!, selectionRange: NSRange, replacementRange: NSRange) {
+    guard let client = client() else { return }
+    if let myID = Bundle.main.bundleIdentifier, let clientID = client.bundleIdentifier(), myID == clientID {
+      DispatchQueue.main.async {
+        client.setMarkedText(string, selectionRange: selectionRange, replacementRange: replacementRange)
+      }
+    } else {
+      client.setMarkedText(string, selectionRange: selectionRange, replacementRange: replacementRange)
+    }
   }
 }

Source/Modules/main.swift

@@ -74,8 +74,9 @@ NSApp.run()
 public enum IMEApp {
   // MARK: - 輸入法的當前的簡繁體中文模式
 
-  public static var currentInputMode: Shared.InputMode =
+  public static var currentInputMode: Shared.InputMode {
     .init(rawValue: PrefMgr.shared.mostRecentInputMode) ?? .imeModeNULL
+  }
 
   /// Fart or Beep?
   static func buzz() {