use NSStatusItem to indicate im and toggle (#263)

Author: eagleoflqj

macosfrontend/macosfrontend.cpp

@@ -26,6 +26,31 @@ namespace fcitx {
 MacosFrontend::MacosFrontend(Instance *instance)
     : instance_(instance),
       focusGroup_("macos", instance->inputContextManager()) {
+    eventHandler_ = instance_->watchEvent(
+        EventType::InputContextUpdateUI, EventWatcherPhase::Default,
+        [=, this](Event &event) {
+            if (auto ic = instance->mostRecentInputContext()) {
+                auto engine = instance->inputMethodEngine(ic);
+                auto entry = instance->inputMethodEntry(ic);
+                std::string display;
+                if (engine) {
+                    auto subModeLabel = engine->subModeLabel(*entry, *ic);
+                    auto name =
+                        entry->label().empty() ? entry->name() : entry->label();
+                    if (subModeLabel.empty()) {
+                        display = std::move(name);
+                    } else {
+                        display = std::move(subModeLabel);
+                    }
+                } else {
+                    display = "🐧";
+                }
+                if (statusItemText != display) {
+                    statusItemText = std::move(display);
+                    SwiftFrontend::setStatusItemText(statusItemText);
+                }
+            }
+        });
     reloadConfig();
 }
 

macosfrontend/macosfrontend.h

@@ -91,8 +91,8 @@ class MacosFrontend : public AddonInstance {
     static const inline std::string ConfPath = "conf/macosfrontend.conf";
 
     FocusGroup focusGroup_; // ensure there is at most one active ic
-    std::vector<std::unique_ptr<HandlerTableEntry<EventHandler>>>
-        eventHandlers_;
+    std::unique_ptr<HandlerTableEntry<EventHandler>> eventHandler_;
+    std::string statusItemText;
 
     inline MacosInputContext *findIC(ICUUID);
     void useAppDefaultIM(const std::string &appId);

macosfrontend/macosfrontend.swift

@@ -14,6 +14,16 @@ public func setController(_ ctrl: Any) {
   controller = ctrl as? IMKInputController
 }
 
+private var statusItemCallback: ((String) -> Void)? = nil
+
+public func setStatusItemCallback(_ callback: @escaping (String) -> Void) {
+  statusItemCallback = callback
+}
+
+public func setStatusItemText(_ text: String) {
+  statusItemCallback?(text)
+}
+
 private func commitString(_ client: IMKTextInput, _ string: String) {
   client.insertText(string, replacementRange: NSRange(location: NSNotFound, length: NSNotFound))
 }

src/controller.swift

@@ -43,6 +43,14 @@ class FcitxInputController: IMKInputController {
     // Do not clear in deinit, otherwise it will crash with
     // "Simultaneous accesses to 0x100e05650, but modification requires exclusive access."
     setController(self)
+    setStatusItemCallback { text in
+      // No concrete evidence that this needs to be on main thread but just to be safe.
+      DispatchQueue.main.async {
+        if let button = AppDelegate.statusItem?.button {
+          button.title = text
+        }
+      }
+    }
   }
 
   deinit {
@@ -320,3 +328,7 @@ struct FcitxAction: Codable {
     return items
   }
 }
+
+func toggleInputMethod() {
+  Fcitx.toggleInputMethod()
+}

src/fcitx-public.h

@@ -29,6 +29,7 @@ void imSetGroups(const char *json) noexcept;
 
 std::string imGetCurrentIMName() noexcept;
 void imSetCurrentIM(const char *imName) noexcept;
+void toggleInputMethod() noexcept;
 
 // Returns a json array of Input Methods.
 // type InputMethod := {uniqueName:str, name:str, nativeName:str,

src/fcitx.cpp

@@ -357,6 +357,10 @@ void imSetCurrentIM(const char *imName) noexcept {
         [=](Fcitx &fcitx) { fcitx.instance()->setCurrentInputMethod(imName); });
 }
 
+void toggleInputMethod() noexcept {
+    return with_fcitx([=](Fcitx &fcitx) { return fcitx.instance()->toggle(); });
+}
+
 std::string imGetCurrentIMName() noexcept {
     return with_fcitx(
         [=](Fcitx &fcitx) { return fcitx.instance()->currentInputMethod(); });

src/server.swift

@@ -39,12 +39,20 @@ private func signalHandler(signal: Int32) {
 class AppDelegate: NSObject, NSApplicationDelegate {
   static var server = IMKServer()
   static var notificationDelegate = NotificationDelegate()
+  static var statusItem: NSStatusItem?
 
   func applicationDidFinishLaunching(_ notification: Notification) {
     redirectStderr()
 
     signal(SIGTERM, signalHandler)
 
+    AppDelegate.statusItem = NSStatusBar.system.statusItem(withLength: NSStatusItem.variableLength)
+
+    if let button = AppDelegate.statusItem?.button {
+      button.action = #selector(handleStatusItemClick)
+      button.target = self
+    }
+
     AppDelegate.server = IMKServer(
       name: Bundle.main.infoDictionary?["InputMethodConnectionName"] as? String,
       bundleIdentifier: Bundle.main.bundleIdentifier)
@@ -59,4 +67,8 @@ class AppDelegate: NSObject, NSApplicationDelegate {
   func applicationWillTerminate(_ notification: Notification) {
     stop_fcitx_thread()
   }
+
+  @objc func handleStatusItemClick() {
+    toggleInputMethod()
+  }
 }