add chromepanel (#67)

Author: eagleoflqj

CMakeLists.txt

@@ -82,6 +82,7 @@ add_subdirectory(wasmnotifications)
 add_subdirectory(webkeyboard)
 add_subdirectory(fcitx5-webview)
 add_subdirectory(webpanel)
+add_subdirectory(chromepanel)
 
 # Force cmake to re-link Fcitx5.js when non-cpp files are changed.
 set(DUMMY_CPP "${PROJECT_BINARY_DIR}/dummy.cpp")
@@ -90,7 +91,7 @@ file(GLOB JS_SOURCES CONFIGURE_DEPENDS "page/*")
 add_custom_command(
     OUTPUT ${DUMMY_CPP}
     COMMAND pnpm run build && ./scripts/install.sh
-    DEPENDS ${JS_SOURCES} clipboard imselector spell quickphrase unicode webpanel webkeyboard wasmfrontend notifications
+    DEPENDS ${JS_SOURCES} clipboard imselector spell quickphrase unicode webpanel webkeyboard chromepanel wasmfrontend notifications
     WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
     COMMENT "Generating the pre.js, index.js and installing shared libraries"
 )

chromepanel/CMakeLists.txt

@@ -0,0 +1,8 @@
+add_library(chromepanel STATIC chromepanel.cpp)
+target_link_libraries(chromepanel Fcitx5::Core nlohmann_json::nlohmann_json)
+
+configure_file(chromepanel.conf.in.in chromepanel.conf.in @ONLY)
+fcitx5_translate_desktop_file(${CMAKE_CURRENT_BINARY_DIR}/chromepanel.conf.in chromepanel.conf)
+install(FILES "${CMAKE_CURRENT_BINARY_DIR}/chromepanel.conf"
+    DESTINATION "${CMAKE_INSTALL_PREFIX}/share/fcitx5/addon"
+)

chromepanel/chromepanel.conf.in.in

@@ -0,0 +1,7 @@
+[Addon]
+Name=ChromePanel
+Type=StaticLibrary
+Library=libchromepanel
+Category=UI
+Version=@PROJECT_VERSION@
+Configurable=False

chromepanel/chromepanel.cpp

@@ -0,0 +1,60 @@
+#include "chromepanel.h"
+#include <emscripten.h>
+#include <fcitx/inputpanel.h>
+#include <nlohmann/json.hpp>
+
+using json = nlohmann::json;
+
+namespace fcitx {
+
+struct Candidate {
+    std::string text;
+    std::string label;
+    std::string comment;
+
+    friend void to_json(json &j, const Candidate &c) {
+        j = json{{"label", c.label}, {"text", c.text}, {"comment", c.comment}};
+    }
+};
+
+ChromePanel::ChromePanel(Instance *instance) : instance_(instance) {}
+
+void ChromePanel::update(UserInterfaceComponent component,
+                         InputContext *inputContext) {
+    switch (component) {
+    case UserInterfaceComponent::InputPanel: {
+        const InputPanel &inputPanel = inputContext->inputPanel();
+        std::vector<Candidate> candidates;
+        int highlighted = -1;
+        if (const auto &list = inputPanel.candidateList()) {
+            auto size = list->size();
+            candidates.reserve(size);
+            for (int i = 0; i < size; ++i) {
+                const auto &candidate = list->candidate(i);
+                auto label = list->label(i).toString();
+                // HACK: fcitx5's Linux UI concatenates label and text and
+                // expects engine to append a ' ' to label.
+                auto length = label.length();
+                if (length && label[length - 1] == ' ') {
+                    label = label.substr(0, length - 1);
+                }
+                candidates.push_back(
+                    {instance_->outputFilter(inputContext, candidate.text())
+                         .toString(),
+                     label,
+                     instance_->outputFilter(inputContext, candidate.comment())
+                         .toString()});
+                highlighted = list->cursorIndex();
+            }
+        }
+        auto str =
+            json{{"candidates", candidates}, {"highlighted", highlighted}}
+                .dump();
+        EM_ASM(fcitx.chrome.setCandidates(UTF8ToString($0)), str.c_str());
+        break;
+    }
+    }
+}
+} // namespace fcitx
+
+FCITX_ADDON_FACTORY_V2(chromepanel, fcitx::ChromePanelFactory);

chromepanel/chromepanel.h

@@ -0,0 +1,32 @@
+#pragma once
+
+#include <fcitx/addonfactory.h>
+#include <fcitx/addonmanager.h>
+#include <fcitx/instance.h>
+
+namespace fcitx {
+class ChromePanel final : public UserInterface {
+  public:
+    ChromePanel(Instance *);
+    virtual ~ChromePanel() = default;
+    void reloadConfig() override {}
+    void setConfig(const RawConfig &config) override {}
+    void setSubConfig(const std::string &path,
+                      const RawConfig &config) override {}
+    bool available() override { return true; }
+    void suspend() override {}
+    void resume() override {}
+    void update(UserInterfaceComponent component,
+                InputContext *inputContext) override;
+
+  private:
+    Instance *instance_;
+};
+
+class ChromePanelFactory : public AddonFactory {
+  public:
+    AddonInstance *create(AddonManager *manager) override {
+        return new ChromePanel(manager->instance());
+    }
+};
+} // namespace fcitx

scripts/format.sh

@@ -1,2 +1,2 @@
-find src wasmfrontend wasmnotifications webkeyboard webpanel -name '*.h' -o -name '*.cpp' | xargs clang-format -i
+find src wasmfrontend wasmnotifications webkeyboard webpanel chromepanel -name '*.h' -o -name '*.cpp' | xargs clang-format -i
 pnpm run lint:fix

scripts/install.sh

@@ -1,7 +1,5 @@
 export DESTDIR=build/destdir
-cmake --install build/fcitx5
-cmake --install build/wasmfrontend
-cmake --install build/wasmnotifications
-cmake --install build/webkeyboard
-cmake --install build/webpanel
+for dir in chromepanel fcitx5 wasmfrontend wasmnotifications webkeyboard webpanel; do
+  cmake --install build/$dir
+done
 touch build/dummy.cpp

src/CMakeLists.txt

@@ -29,7 +29,7 @@ set(EXE_LINK_OPTIONS
 set(INSTALL_LIB_DIR "${PROJECT_BINARY_DIR}/destdir/usr/lib")
 set(INSTALL_SHARE_DIR "${PROJECT_BINARY_DIR}/destdir/usr/share")
 
-set(STATIC_ADDONS webpanel webkeyboard wasmfrontend)
+set(STATIC_ADDONS webpanel webkeyboard chromepanel wasmfrontend)
 
 if (RIME_ONLY)
     foreach(ADDON ${STATIC_ADDONS})

src/fcitx.cpp

@@ -174,24 +174,26 @@ EMSCRIPTEN_KEEPALIVE void init(const char *locale, Runtime runtime,
 
     EventLoop::setEventLoopFactory(
         [] { return std::make_unique<JSEventLoop>(); });
+
+    char arg0[] = "fcitx5-js";
     switch (runtime) {
     case Runtime::web: {
-        instance = std::make_unique<Instance>(0, nullptr);
+        char arg1[] = "--disable=chromepanel";
+        char *argv[] = {arg0, arg1};
+        instance = std::make_unique<Instance>(FCITX_ARRAY_SIZE(argv), argv);
         if (touch) {
             instance->setInputMethodMode(InputMethodMode::OnScreenKeyboard);
         }
         break;
     }
     case Runtime::webworker: {
-        char arg0[] = "fcitx5-js";
         char arg1[] = "--disable=all";
         char arg2[] = "--enable=rime,notifications";
         char *argv[] = {arg0, arg1, arg2};
         instance = std::make_unique<Instance>(FCITX_ARRAY_SIZE(argv), argv);
         break;
     }
     case Runtime::serviceworker: {
-        char arg0[] = "fcitx5-js";
         char arg1[] = "--disable=webkeyboard,webpanel";
         char *argv[] = {arg0, arg1};
         instance = std::make_unique<Instance>(FCITX_ARRAY_SIZE(argv), argv);