support vim mode (#280)

Author: eagleoflqj

assets/po/zh_CN.po

@@ -27,31 +27,35 @@ msgstr "切换输入法"
 msgid "Menu"
 msgstr "菜单"
 
-#: macosfrontend/macosfrontend.h:45
+#: macosfrontend/macosfrontend.h:53
 msgid "Status bar"
 msgstr "状态栏"
 
-#: macosfrontend/macosfrontend.h:48
+#: macosfrontend/macosfrontend.h:56
 msgid "App default IM"
 msgstr "应用默认输入法"
 
-#: macosfrontend/macosfrontend.h:50
+#: macosfrontend/macosfrontend.h:58
+msgid "Vim mode"
+msgstr "Vim 模式"
+
+#: macosfrontend/macosfrontend.h:60
 msgid "Simulate key release"
 msgstr "模拟按键释放"
 
-#: macosfrontend/macosfrontend.h:53
+#: macosfrontend/macosfrontend.h:63
 msgid "Delay of simulated key release in milliseconds"
 msgstr "模拟按键释放延迟毫秒数"
 
-#: macosfrontend/macosfrontend.h:56
+#: macosfrontend/macosfrontend.h:66
 msgid "Monitor Pasteboard"
 msgstr "监视剪贴板"
 
-#: macosfrontend/macosfrontend.h:58
+#: macosfrontend/macosfrontend.h:68
 msgid "Remove tracking parameters"
 msgstr "清除追踪参数"
 
-#: macosfrontend/macosfrontend.h:61
+#: macosfrontend/macosfrontend.h:71
 msgid "Poll Pasteboard interval (s)"
 msgstr "轮询剪贴板的间隔（秒）"
 

macosfrontend/macosfrontend.cpp

@@ -141,6 +141,39 @@ std::string MacosFrontend::keyEvent(ICUUID uuid, const Key &key, bool isRelease,
         auto timeEventPtr = timeEvent.release();
     }
 
+    bool keepVimPreedit = false;
+    if (ic->vimMode() && !keyEvent.accepted() &&
+        imGetCurrentIMName() != "keyboard-us") {
+        if (key.check(FcitxKey_Escape) ||
+            key.check(FcitxKey_bracketleft, KeyState::Ctrl) ||
+            key.check(FcitxKey_c, KeyState::Ctrl)) {
+            // If the dummy preedit hack on Ctrl was needed, it has to be
+            // preserved here, otherwise vim won't enter normal mode. Make this
+            // explicit, as some engines (rime, mozc) will call
+            // updateUserInterface(UserInterfaceComponent::InputPanel) even if
+            // input panel was and keeps empty, which makes webpanel clear the
+            // dummy preedit.
+            keepVimPreedit = true;
+            imSetCurrentIM("keyboard-us");
+        } else if (!ic->inputPanel().transient() && ic->inputPanel().empty()) {
+            // HACK: For Terminal and iTerm, when pressing an handled ctrl, we
+            // force a dummy preedit so that the following c or [ could be
+            // processed by fcitx. It's known that Esc won't work in Terminal,
+            // but we don't want to force dummy preedit unconditionally as it
+            // breaks other keys.
+            if (!isRelease &&
+                (ic->program() == "com.apple.Terminal" ||
+                 ic->program() == "com.googlecode.iterm2") &&
+                (key.check(FcitxKey_Control_L, KeyState::Ctrl) ||
+                 key.check(FcitxKey_Control_R, KeyState::Ctrl))) {
+                keepVimPreedit = true;
+                ic->setVimPreedit(true);
+            }
+        }
+    }
+    if (!keepVimPreedit) {
+        ic->setVimPreedit(false);
+    }
     return ic->popState(keyEvent.accepted());
 }
 
@@ -198,6 +231,12 @@ void MacosFrontend::useAppDefaultIM(const std::string &appId) {
     }
 }
 
+void MacosFrontend::useVimMode(const std::string &appId,
+                               MacosInputContext *ic) {
+    const auto &vimMode = *config_.vimMode;
+    ic->setVimMode(std::ranges::find(vimMode, appId) != vimMode.end());
+}
+
 void MacosFrontend::focusIn(ICUUID uuid, bool isPassword) {
     auto *ic = findIC(uuid);
     if (!ic)
@@ -207,7 +246,10 @@ void MacosFrontend::focusIn(ICUUID uuid, bool isPassword) {
     ic->focusIn();
     auto program = ic->program();
     FCITX_INFO() << "Focus in " << program;
-    useAppDefaultIM(program);
+    if (!program.empty()) {
+        useAppDefaultIM(program);
+        useVimMode(program, ic);
+    }
 }
 
 std::string MacosFrontend::commitComposition(ICUUID uuid) {
@@ -282,7 +324,7 @@ std::string MacosInputContext::popState(bool accepted) {
     j["commit"] = state_.commit;
     j["preedit"] = state_.preedit;
     j["caretPos"] = state_.caretPos;
-    j["dummyPreedit"] = state_.dummyPreedit;
+    j["dummyPreedit"] = state_.dummyPreedit || state_.vimPreedit;
     j["accepted"] = accepted;
     resetState();
     return j.dump();

macosfrontend/macosfrontend.h

@@ -39,13 +39,23 @@ struct AppIMAnnotation {
     }
 };
 
+struct VimModeAnnotation {
+    bool skipDescription() { return false; }
+    bool skipSave() { return false; }
+    void dumpDescription(RawConfig &config) {
+        config.setValueByPath("VimMode", "True");
+    }
+};
+
 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}};
+    OptionWithAnnotation<std::vector<std::string>, VimModeAnnotation> vimMode{
+        this, "VimMode", _("Vim mode"), {"org.vim.MacVim"}};
     Option<bool> simulateKeyRelease{this, "SimulateKeyRelease",
                                     _("Simulate key release")};
     Option<int, IntConstrain> simulateKeyReleaseDelay{
@@ -105,13 +115,15 @@ class MacosFrontend : public AddonInstance {
 
     inline MacosInputContext *findIC(ICUUID);
     void useAppDefaultIM(const std::string &appId);
+    void useVimMode(const std::string &appId, MacosInputContext *ic);
 };
 
 struct InputContextState {
     std::string commit;
     std::string preedit;
     int caretPos;
     bool dummyPreedit;
+    bool vimPreedit;
 };
 
 class MacosInputContext : public InputContext {
@@ -139,6 +151,7 @@ class MacosInputContext : public InputContext {
     void setDummyPreedit(bool dummyPreedit) {
         state_.dummyPreedit = dummyPreedit;
     }
+    void setVimPreedit(bool vimPreedit) { state_.vimPreedit = vimPreedit; }
     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
@@ -148,12 +161,15 @@ class MacosInputContext : public InputContext {
     void commitAndSetPreeditAsync();
 
     void setPassword(bool isPassword);
+    void setVimMode(bool vimMode) { vimMode_ = vimMode; }
+    bool vimMode() const { return vimMode_; }
 
 private:
     MacosFrontend *frontend_;
     id client_;
     InputContextState state_;
     std::string accentColor_;
+    bool vimMode_ = false;
 };
 
 class MacosFrontendFactory : public AddonFactory {

src/config/appimoptionview.swift

@@ -8,11 +8,6 @@ private let presetApps: [String] = [
   "/System/Library/Input Methods/CharacterPalette.app",  // emoji picker
 ]
 
-private func image(_ appPath: String) -> Image {
-  let icon = NSWorkspace.shared.icon(forFile: appPath)
-  return Image(nsImage: icon)
-}
-
 struct AppIMOptionView: OptionView {
   let label: String
   let overrideLabel: String? = nil
@@ -31,7 +26,7 @@ struct AppIMOptionView: OptionView {
   var body: some View {
     HStack {
       if !model.appPath.isEmpty {
-        image(model.appPath)
+        appIconFromPath(model.appPath)
       }
       Picker("", selection: $model.appPath) {
         ForEach(selections(), id: \.self) { key in
@@ -40,15 +35,19 @@ struct AppIMOptionView: OptionView {
           } else {
             HStack {
               if model.appPath != key {
-                image(key)
+                appIconFromPath(key)
               }
               Text(appNameFromPath(key)).tag(key)
             }
           }
         }
       }
       Button {
-        openSelector()
+        selectApplication(
+          openPanel,
+          onFinish: { path in
+            model.appPath = path
+          })
       } label: {
         Image(systemName: "folder")
       }
@@ -71,19 +70,4 @@ struct AppIMOptionView: OptionView {
         }
       }
   }
-
-  private func openSelector() {
-    openPanel.allowsMultipleSelection = false
-    openPanel.canChooseDirectories = false
-    openPanel.allowedContentTypes = [.application]
-    openPanel.directoryURL = URL(fileURLWithPath: "/Applications")
-    openPanel.begin { response in
-      if response == .OK {
-        let selectedApp = openPanel.urls.first
-        if let appURL = selectedApp {
-          model.appPath = appURL.localPath()
-        }
-      }
-    }
-  }
 }

src/config/config.swift

@@ -103,6 +103,9 @@ private func jsonToOption(_ json: JSON, _ type: String) throws -> any Option {
     if let appIM = json["AppIM"].string, appIM == "True" {
       return try ListOption<AppIMOption>.decode(json: json)
     }
+    if let vim = json["VimMode"].string, vim == "True" {
+      return try ListOption<VimModeOption>.decode(json: json)
+    }
     if let plugin = json["Plugin"].string, plugin == "True" {
       return try ListOption<PluginOption>.decode(json: json)
     }

src/config/optionmodels.swift

@@ -334,17 +334,7 @@ class CssOption: StringOption {}
 
 class PluginOption: StringOption {}
 
-private func bundleIdentifier(_ appPath: String) -> String {
-  guard let bundle = Bundle(path: appPath) else {
-    return ""
-  }
-  return bundle.bundleIdentifier ?? ""
-}
-
-func appNameFromPath(_ path: String) -> String {
-  let name = URL(filePath: path).lastPathComponent
-  return name.hasSuffix(".app") ? String(name.dropLast(4)) : name
-}
+class VimModeOption: StringOption {}
 
 class AppIMOption: Option, ObservableObject, EmptyConstructible {
   typealias Storage = String

src/config/optionviews.swift

@@ -560,6 +560,8 @@ func buildViewImpl(label: String, option: any Option) -> any OptionView {
     return CssOptionView(label: label, model: option)
   } else if let option = option as? AppIMOption {
     return AppIMOptionView(label: label, model: option)
+  } else if let option = option as? VimModeOption {
+    return VimModeOptionView(label: label, model: option)
   } else if let option = option as? PluginOption {
     return PluginOptionView(label: label, model: option)
   } else if let option = option as? KeyOption {
@@ -580,6 +582,8 @@ func buildViewImpl(label: String, option: any Option) -> any OptionView {
     return ListOptionView<FontOption>(label: label, model: option)
   } else if let option = option as? ListOption<AppIMOption> {
     return ListOptionView<AppIMOption>(label: label, model: option)
+  } else if let option = option as? ListOption<VimModeOption> {
+    return ListOptionView<VimModeOption>(label: label, model: option)
   } else if let option = option as? ListOption<PluginOption> {
     return ListOptionView<PluginOption>(label: label, model: option)
   } else if let option = option as? ListOption<KeyOption> {

src/config/ui.swift

@@ -148,3 +148,23 @@ struct SelectFileButton<Label>: View where Label: View {
     }
   }
 }
+
+func selectApplication(_ openPanel: NSOpenPanel, onFinish: @escaping (String) -> Void) {
+  openPanel.allowsMultipleSelection = false
+  openPanel.canChooseDirectories = false
+  openPanel.allowedContentTypes = [.application]
+  openPanel.directoryURL = URL(fileURLWithPath: "/Applications")
+  openPanel.begin { response in
+    if response == .OK {
+      let selectedApp = openPanel.urls.first
+      if let appURL = selectedApp {
+        onFinish(appURL.localPath())
+      }
+    }
+  }
+}
+
+func appIconFromPath(_ path: String) -> Image {
+  let icon = NSWorkspace.shared.icon(forFile: path)
+  return Image(nsImage: icon)
+}

src/config/util.swift

@@ -228,3 +228,26 @@ func getNoCacheSession() -> URLSession {
   config.requestCachePolicy = .reloadIgnoringLocalCacheData
   return URLSession(configuration: config)
 }
+
+func bundleIdentifier(_ appPath: String) -> String {
+  guard let bundle = Bundle(path: appPath) else {
+    return ""
+  }
+  return bundle.bundleIdentifier ?? ""
+}
+
+func appPathFromBundleIdentifier(_ bundleID: String) -> String {
+  // Must check empty, otherwise it uses the last opened app that has no bundleID.
+  if bundleID.isEmpty {
+    return ""
+  }
+  if let url = NSWorkspace.shared.urlForApplication(withBundleIdentifier: bundleID) {
+    return url.localPath()
+  }
+  return ""
+}
+
+func appNameFromPath(_ path: String) -> String {
+  let name = URL(filePath: path).lastPathComponent
+  return name.hasSuffix(".app") ? String(name.dropLast(4)) : ""
+}

src/config/vimmodeoptionview.swift

@@ -0,0 +1,35 @@
+import SwiftUI
+
+struct VimModeOptionView: OptionView {
+  let label: String
+  let overrideLabel: String? = nil
+  let openPanel = NSOpenPanel()
+  @ObservedObject var model: VimModeOption
+
+  var body: some View {
+    HStack {
+      let appPath = appPathFromBundleIdentifier(model.value)
+      let appName = appNameFromPath(appPath)
+      if !appPath.isEmpty {
+        appIconFromPath(appPath)
+      }
+      Spacer()
+      if !appName.isEmpty {
+        Text(appName)
+      } else if model.value.isEmpty {
+        Text("Select App")
+      } else {
+        Text(model.value)
+      }
+      Button {
+        selectApplication(
+          openPanel,
+          onFinish: { path in
+            model.value = bundleIdentifier(path)
+          })
+      } label: {
+        Image(systemName: "folder")
+      }
+    }
+  }
+}