implement commitComposition to distinguish switch app and switch abc; fix double commit on switch abc

Author: eagleoflqj

macosfrontend/macosfrontend-public.h

@@ -15,4 +15,5 @@ ICUUID create_input_context(const char *appId, id client,
                             const char *accentColor) noexcept;
 void destroy_input_context(ICUUID uuid) noexcept;
 void focus_in(ICUUID uuid, bool isPassword) noexcept;
-std::string focus_out(ICUUID uuid) noexcept;
+std::string commit_composition(ICUUID uuid) noexcept;
+void focus_out(ICUUID uuid) noexcept;

macosfrontend/macosfrontend.cpp

@@ -141,9 +141,7 @@ std::string MacosFrontend::keyEvent(ICUUID uuid, const Key &key, bool isRelease,
         auto timeEventPtr = timeEvent.release();
     }
 
-    auto state = ic->getState(keyEvent.accepted());
-    ic->resetState();
-    return state;
+    return ic->popState(keyEvent.accepted());
 }
 
 MacosInputContext *MacosFrontend::findIC(ICUUID uuid) {
@@ -212,7 +210,7 @@ void MacosFrontend::focusIn(ICUUID uuid, bool isPassword) {
     useAppDefaultIM(program);
 }
 
-std::string MacosFrontend::focusOut(ICUUID uuid) {
+std::string MacosFrontend::commitComposition(ICUUID uuid) {
     auto *ic = findIC(uuid);
     if (!ic)
         return "{}";
@@ -230,13 +228,18 @@ std::string MacosFrontend::focusOut(ICUUID uuid) {
     // At this stage panel is still shown. If removed, a following backspace
     // will commit a BS character in VSCode.
     ic->setDummyPreedit(false);
-    auto state = ic->getState(false);
+    auto state = ic->popState(false);
     ic->isSyncEvent = false;
 
+    return state;
+}
+
+void MacosFrontend::focusOut(ICUUID uuid) {
+    auto *ic = findIC(uuid);
+    if (!ic)
+        return;
     FCITX_INFO() << "Focus out " << ic->program();
     ic->focusOut();
-
-    return state;
 }
 
 MacosInputContext::MacosInputContext(MacosFrontend *frontend,
@@ -274,13 +277,14 @@ void MacosInputContext::updatePreeditImpl() {
     state_.caretPos = preedit.cursor();
 }
 
-std::string MacosInputContext::getState(bool accepted) {
+std::string MacosInputContext::popState(bool accepted) {
     nlohmann::json j;
     j["commit"] = state_.commit;
     j["preedit"] = state_.preedit;
     j["caretPos"] = state_.caretPos;
     j["dummyPreedit"] = state_.dummyPreedit;
     j["accepted"] = accepted;
+    resetState();
     return j.dump();
 }
 
@@ -345,7 +349,12 @@ void focus_in(ICUUID uuid, bool isPassword) noexcept {
     });
 }
 
-std::string focus_out(ICUUID uuid) noexcept {
-    return with_fcitx(
-        [=](Fcitx &fcitx) { return fcitx.frontend()->focusOut(uuid); });
+std::string commit_composition(ICUUID uuid) noexcept {
+    return with_fcitx([=](Fcitx &fcitx) {
+        return fcitx.frontend()->commitComposition(uuid);
+    });
+}
+
+void focus_out(ICUUID uuid) noexcept {
+    with_fcitx([=](Fcitx &fcitx) { return fcitx.frontend()->focusOut(uuid); });
 }

macosfrontend/macosfrontend.h

@@ -83,7 +83,8 @@ class MacosFrontend : public AddonInstance {
     std::string keyEvent(ICUUID, const Key &key, bool isRelease,
                          bool isPassword);
     void focusIn(ICUUID, bool isPassword);
-    std::string focusOut(ICUUID);
+    std::string commitComposition(ICUUID uuid);
+    void focusOut(ICUUID);
 
 private:
     Instance *instance_;
@@ -138,7 +139,7 @@ class MacosInputContext : public InputContext {
     void setDummyPreedit(bool dummyPreedit) {
         state_.dummyPreedit = dummyPreedit;
     }
-    std::string getState(bool accepted);
+    std::string popState(bool accepted);
     // Shows whether we are processing a sync event (mainly key down) that needs
     // to return a bool to indicate if it's handled. In this case, commit and
     // preedit need to be set in batch synchronously before returning. Otherwise

macosfrontend/macosfrontend.swift

@@ -6,8 +6,6 @@ private var currentPreedit = ""
 
 private let zeroWidthSpace = "\u{200B}"
 
-public var hasCaret = false
-
 private var controller: IMKInputController? = nil
 
 public func setController(_ ctrl: Any) {
@@ -60,16 +58,11 @@ private func setPreedit(_ client: IMKTextInput, _ preedit: String, _ caretPosUtf
 
 public func commitAndSetPreeditSync(
   _ client: IMKTextInput, _ commit: String, _ preedit: String, _ caretPos: Int,
-  _ dummyPreedit: Bool, focusOut: Bool = false
+  _ dummyPreedit: Bool
 ) {
   if !commit.isEmpty {
     commitString(client, commit)
   }
-  // Setting preedit on focus out may cause IMK stall for seconds. High possibility
-  // to reproduce by having no caret on a Safari page and Cmd+T to open a new Tab.
-  if focusOut && !hasCaret {
-    return
-  }
   // Without client preedit, Backspace bypasses IM in Terminal, every key
   // is both processed by IM and passed to client in iTerm, so we force a
   // dummy client preedit here.
@@ -135,7 +128,6 @@ public func getCaretCoordinates(
     forCharacterIndex: followCaret ? (isEnd ? u16pos - 1 : u16pos) : 0,
     lineHeightRectangle: &rect)
   if rect.width == 0 && rect.height == 0 {
-    hasCaret = false
     return false
   }
   x.pointee = Double(NSMinX(rect))
@@ -144,6 +136,5 @@ public func getCaretCoordinates(
   if followCaret && isEnd {
     x.pointee += 10
   }
-  hasCaret = true
   return true
 }

src/controller.swift

@@ -63,15 +63,24 @@ class FcitxInputController: IMKInputController {
     uuid = create_input_context(appId, client, accentColor)
   }
 
-  func processRes(_ client: IMKTextInput, _ res: String, focusOut: Bool = false) -> Bool {
+  override func commitComposition(_ sender: Any!) {
+    guard let client = client as? IMKTextInput else {
+      return
+    }
+    let res = String(commit_composition(uuid))
+    // Maybe commit and clear preedit synchronously if user switches to ABC by Ctrl+Space.
+    // For Rime with CapsLock, the result will depend on ascii_composer/switch_key/Caps_Lock instead of fcitx5-rime config.
+    let _ = processRes(client, res)
+  }
+
+  func processRes(_ client: IMKTextInput, _ res: String) -> Bool {
     guard let data = res.data(using: .utf8),
       let response = try? JSONDecoder().decode(SyncResponse.self, from: data)
     else {
       return false
     }
     commitAndSetPreeditSync(
-      client, response.commit, response.preedit, response.caretPos, response.dummyPreedit,
-      focusOut: focusOut)
+      client, response.commit, response.preedit, response.caretPos, response.dummyPreedit)
     return response.accepted
   }
 
@@ -181,26 +190,19 @@ class FcitxInputController: IMKInputController {
     }
   }
 
+  // activateServer is called when app is in foreground but not necessarily a text field is selected.
   override func activateServer(_ client: Any!) {
     // overrideKeyboard is needed for pressing space to play in Shotcut.
     if let client = client as? IMKTextInput {
       client.overrideKeyboard(withKeyboardNamed: "com.apple.keylayout.ABC")
     }
-    // activateServer is called when app is in foreground but not necessarily a text field is selected.
-    hasCaret = false
     // Make sure status bar is updated on click password input, before first key event.
     let isPassword = getSecureInputInfo(isOnFocus: true)
     focus_in(uuid, isPassword)
   }
 
   override func deactivateServer(_ client: Any!) {
-    guard let client = client as? IMKTextInput else {
-      return
-    }
-    let res = String(focus_out(uuid))
-    // Maybe commit and clear preedit synchronously if user switches to ABC by Ctrl+Space.
-    let _ = processRes(client, res, focusOut: true)
-    hasCaret = false
+    focus_out(uuid)
   }
 
   override func menu() -> NSMenu! {