status bar: hide and menu (#266)

Author: eagleoflqj

assets/po/zh_CN.po

@@ -15,7 +15,23 @@ msgstr ""
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 
-#: macosfrontend/macosfrontend.h:47
+#: macosfrontend/macosfrontend.h:27
+msgid "Hidden"
+msgstr "隐藏"
+
+#: macosfrontend/macosfrontend.h:28
+msgid "Toggle input method"
+msgstr "切换输入法"
+
+#: macosfrontend/macosfrontend.h:28
+msgid "Menu"
+msgstr "菜单"
+
+#: macosfrontend/macosfrontend.h:44
+msgid "Status bar"
+msgstr "状态栏"
+
+#: macosfrontend/macosfrontend.h:48
 msgid "App default IM"
 msgstr "应用默认输入法"
 

assets/zh-Hans.lproj/Localizable.strings

@@ -26,34 +26,41 @@ namespace fcitx {
 MacosFrontend::MacosFrontend(Instance *instance)
     : instance_(instance),
       focusGroup_("macos", instance->inputContextManager()) {
-    eventHandler_ = instance_->watchEvent(
+    // For update when switching internal input method of rime.
+    eventHandlers_.emplace_back(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);
-                }
-            }
-        });
+        [this](Event &event) { updateStatusItemText(); }));
+    // For switching from VSCode to Terminal, otherwise the first key press
+    // triggers text update.
+    eventHandlers_.emplace_back(instance_->watchEvent(
+        EventType::InputContextInputMethodActivated, EventWatcherPhase::Default,
+        [this](Event &event) { updateStatusItemText(); }));
     reloadConfig();
 }
 
+void MacosFrontend::updateStatusItemText() {
+    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);
+        }
+    }
+}
+
 // Runs on the fcitx thread.
 void MacosFrontend::pollPasteboard() {
     monitorPasteboardEvent_ = instance_->eventLoop().addTimeEvent(
@@ -86,6 +93,7 @@ void MacosFrontend::pollPasteboard() {
 }
 
 void MacosFrontend::updateConfig() {
+    SwiftFrontend::setStatusItemMode(int(*config_.statusBar));
     simulateKeyRelease_ = config_.simulateKeyRelease.value();
     simulateKeyReleaseDelay_ =
         static_cast<long>(config_.simulateKeyReleaseDelay.value()) * 1000L;

macosfrontend/macosfrontend.cpp

@@ -23,6 +23,10 @@
 #define TERMINAL_USE_EN                                                        \
     R"JSON({"appPath": "/System/Applications/Utilities/Terminal.app", "appId": "com.apple.Terminal", "imName": "keyboard-us"})JSON"
 
+enum class StatusBar { Hidden, ToggleInputMethod, Menu };
+FCITX_CONFIG_ENUM_NAME_WITH_I18N(StatusBar, N_("Hidden"),
+                                 N_("Toggle input method"), N_("Menu"))
+
 namespace fcitx {
 
 class MacosInputContext;
@@ -37,6 +41,8 @@ struct AppIMAnnotation {
 
 FCITX_CONFIGURATION(
     MacosFrontendConfig,
+    OptionWithAnnotation<StatusBar, StatusBarI18NAnnotation> statusBar{
+        this, "StatusBar", _("Status bar"), StatusBar::Menu};
     OptionWithAnnotation<std::vector<std::string>, AppIMAnnotation>
         appDefaultIM{
             this, "AppDefaultIM", _("App default IM"), {TERMINAL_USE_EN}};
@@ -91,8 +97,10 @@ class MacosFrontend : public AddonInstance {
     static const inline std::string ConfPath = "conf/macosfrontend.conf";
 
     FocusGroup focusGroup_; // ensure there is at most one active ic
-    std::unique_ptr<HandlerTableEntry<EventHandler>> eventHandler_;
+    std::vector<std::unique_ptr<HandlerTableEntry<EventHandler>>>
+        eventHandlers_;
     std::string statusItemText;
+    void updateStatusItemText();
 
     inline MacosInputContext *findIC(ICUUID);
     void useAppDefaultIM(const std::string &appId);

macosfrontend/macosfrontend.h

@@ -14,14 +14,18 @@ public func setController(_ ctrl: Any) {
   controller = ctrl as? IMKInputController
 }
 
-private var statusItemCallback: ((String) -> Void)? = nil
+private var statusItemCallback: ((Int32?, String?) -> Void)? = nil
 
-public func setStatusItemCallback(_ callback: @escaping (String) -> Void) {
+public func setStatusItemCallback(_ callback: @escaping (Int32?, String?) -> Void) {
   statusItemCallback = callback
 }
 
 public func setStatusItemText(_ text: String) {
-  statusItemCallback?(text)
+  statusItemCallback?(nil, text)
+}
+
+public func setStatusItemMode(_ mode: Int32) {
+  statusItemCallback?(mode, nil)
 }
 
 private func commitString(_ client: IMKTextInput, _ string: String) {

macosfrontend/macosfrontend.swift

@@ -43,14 +43,6 @@ 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 {

src/controller.swift

@@ -1,6 +1,7 @@
 import Cocoa
 import Fcitx
 import InputMethodKit
+import SwiftFrontend
 import SwiftNotify
 
 class NSManualApplication: NSApplication {
@@ -40,18 +41,53 @@ class AppDelegate: NSObject, NSApplicationDelegate {
   static var server = IMKServer()
   static var notificationDelegate = NotificationDelegate()
   static var statusItem: NSStatusItem?
+  static var statusItemText: String = "🐧"
 
   func applicationDidFinishLaunching(_ notification: Notification) {
     redirectStderr()
 
     signal(SIGTERM, signalHandler)
 
-    // NSStatusItem.variableLength causes layout shift of icons on the left when switching between en and 拼.
-    AppDelegate.statusItem = NSStatusBar.system.statusItem(withLength: NSStatusItem.squareLength)
-
-    if let button = AppDelegate.statusItem?.button {
-      button.action = #selector(handleStatusItemClick)
-      button.target = self
+    setStatusItemCallback { mode, text in
+      // Main thread could call fcitx thread which then calls this, so must be async.
+      DispatchQueue.main.async { [self] in
+        if let mode = mode {
+          if mode == 0 {  // Hidden
+            AppDelegate.statusItem = nil
+          } else {
+            // NSStatusItem.variableLength causes layout shift of icons on the left when switching between en and 拼.
+            let statusItem: NSStatusItem = NSStatusBar.system.statusItem(
+              withLength: NSStatusItem.variableLength)
+            AppDelegate.statusItem = statusItem
+            if let button = statusItem.button {
+              button.title = AppDelegate.statusItemText
+              button.target = self
+              if mode == 1 {  // Toggle input method
+                button.action = #selector(toggle)
+              } else  // Menu
+              {
+                let menu = NSMenu()
+                menu.addItem(
+                  NSMenuItem(
+                    title: NSLocalizedString("Toggle input method", comment: ""),
+                    action: #selector(toggle), keyEquivalent: ""))
+                menu.addItem(NSMenuItem.separator())
+                menu.addItem(
+                  NSMenuItem(
+                    title: NSLocalizedString("Hide", comment: ""),
+                    action: #selector(hide), keyEquivalent: ""))
+                statusItem.menu = menu
+              }
+            }
+          }
+        }
+        if let text = text {
+          AppDelegate.statusItemText = text
+          if let button = AppDelegate.statusItem?.button {
+            button.title = text
+          }
+        }
+      }
     }
 
     AppDelegate.server = IMKServer(
@@ -69,7 +105,11 @@ class AppDelegate: NSObject, NSApplicationDelegate {
     stop_fcitx_thread()
   }
 
-  @objc func handleStatusItemClick() {
+  @objc func toggle() {
     toggleInputMethod()
   }
+
+  @objc func hide() {
+    Fcitx.setConfig("fcitx://config/addon/macosfrontend", "{\"StatusBar\": \"Hidden\"}")
+  }
 }