initial uipanel (#9)

Author: eagleoflqj

.github/workflows/ci.yml

@@ -17,8 +17,8 @@ jobs:
 
       - name: Lint
         run: |
-          find src keyboard -name '*.cpp' -o -name '*.h' | xargs clang-format -Werror --dry-run
-          swift-format lint -rs src keyboard
+          find src keyboard iosfrontend uipanel -name '*.cpp' -o -name '*.h' | xargs clang-format -Werror --dry-run
+          swift-format lint -rs src keyboard iosfrontend
 
   build:
     needs: lint

CMakeLists.txt

@@ -59,6 +59,7 @@ find_host_package(Gettext)
 add_subdirectory(fcitx5)
 
 add_subdirectory(iosfrontend)
+add_subdirectory(uipanel)
 
 add_subdirectory(engines)
 

iosfrontend/iosfrontend.cpp

@@ -4,8 +4,7 @@
 namespace fcitx {
 
 IosFrontend::IosFrontend(Instance *instance)
-    : instance_(instance),
-      focusGroup_("ios", instance->inputContextManager()) {
+    : instance_(instance), focusGroup_("ios", instance->inputContextManager()) {
     createInputContext();
 }
 
@@ -28,7 +27,7 @@ void IosFrontend::focusIn(id client) {
 void IosFrontend::focusOut() { ic_->focusOut(); }
 
 IosInputContext::IosInputContext(IosFrontend *frontend,
-                                   InputContextManager &inputContextManager)
+                                 InputContextManager &inputContextManager)
     : InputContext(inputContextManager, ""), frontend_(frontend) {
     CapabilityFlags flags = CapabilityFlag::Preedit;
     setCapabilityFlags(flags);

iosfrontend/iosfrontend.h

@@ -1,12 +1,12 @@
 #pragma once
 
-#include <objc/objc.h>
 #include <fcitx-config/configuration.h>
 #include <fcitx/addonfactory.h>
 #include <fcitx/addoninstance.h>
 #include <fcitx/addonmanager.h>
 #include <fcitx/focusgroup.h>
 #include <fcitx/instance.h>
+#include <objc/objc.h>
 
 namespace fcitx {
 
@@ -43,7 +43,7 @@ class IosFrontendFactory : public AddonFactory {
 class IosInputContext : public InputContext {
   public:
     IosInputContext(IosFrontend *frontend,
-                     InputContextManager &inputContextManager);
+                    InputContextManager &inputContextManager);
     ~IosInputContext();
 
     const char *frontend() const override { return "ios"; }

keyboard/CMakeLists.txt

@@ -18,5 +18,6 @@ target_link_libraries(keyboard PRIVATE
     spell
     iosfrontend
     SwiftFrontend
+    uipanel
     "${ENGINE}"
 )

keyboard/fcitx.cpp

@@ -1,5 +1,6 @@
 #include "../fcitx5/src/modules/spell/spell.h"
 #include "../iosfrontend/iosfrontend.h"
+#include "../uipanel/uipanel.h"
 #include "nativestreambuf.h"
 #include <fcitx-utils/event.h>
 #include <fcitx-utils/eventdispatcher.h>
@@ -23,12 +24,15 @@ namespace fs = std::filesystem;
 
 fcitx::SpellModuleFactory SpellModuleFactory;
 fcitx::IosFrontendFactory IosFrontendFactory;
+fcitx::UIPanelFactory UIPanelFactory;
 
 fcitx::StaticAddonRegistry addons = {
     std::make_pair<std::string, fcitx::AddonFactory *>("spell",
                                                        &SpellModuleFactory),
     std::make_pair<std::string, fcitx::AddonFactory *>("iosfrontend",
                                                        &IosFrontendFactory),
+    std::make_pair<std::string, fcitx::AddonFactory *>("uipanel",
+                                                       &UIPanelFactory),
     std::make_pair<std::string, fcitx::AddonFactory *>(ENGINE_ADDON,
                                                        &EngineFactory),
 };

uipanel/CMakeLists.txt

@@ -0,0 +1,15 @@
+add_library(uipanel STATIC uipanel.cpp)
+target_link_libraries(uipanel Fcitx5::Core)
+
+configure_file(uipanel.conf.in.in uipanel.conf.in @ONLY)
+fcitx5_translate_desktop_file(${CMAKE_CURRENT_BINARY_DIR}/uipanel.conf.in uipanel.conf)
+
+add_custom_command(
+    TARGET uipanel
+    POST_BUILD COMMAND /bin/sh -c
+    \"
+    ${CMAKE_COMMAND} -E copy
+        ${CMAKE_CURRENT_BINARY_DIR}/uipanel.conf
+        ${PROJECT_BINARY_DIR}/keyboard/$<CONFIG>${CMAKE_XCODE_EFFECTIVE_PLATFORMS}/keyboard.appex/share/fcitx5/addon/uipanel.conf
+    \"
+)

uipanel/uipanel.conf.in.in

@@ -0,0 +1,7 @@
+[Addon]
+Name=UIPanel
+Type=StaticLibrary
+Library=libuipanel
+Category=UI
+Version=@PROJECT_VERSION@
+Configurable=True

uipanel/uipanel.cpp

@@ -0,0 +1,31 @@
+#include <fcitx/inputpanel.h>
+
+#include "uipanel.h"
+
+namespace fcitx {
+
+UIPanel::UIPanel(Instance *instance) : instance_(instance) {}
+
+void UIPanel::update(UserInterfaceComponent component,
+                     InputContext *inputContext) {
+    switch (component) {
+    case UserInterfaceComponent::InputPanel: {
+        const InputPanel &inputPanel = inputContext->inputPanel();
+        int size = 0;
+        if (const auto &list = inputPanel.candidateList()) {
+            size = list->size();
+            for (int i = 0; i < size; i++) {
+                const auto &candidate = list->candidate(i);
+                FCITX_INFO()
+                    << instance_->outputFilter(inputContext, candidate.text())
+                           .toString();
+            }
+        }
+        break;
+    }
+    case UserInterfaceComponent::StatusArea:
+        break;
+    }
+}
+
+} // namespace fcitx

uipanel/uipanel.h

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