horizontal scroll and fetch candidates on demand (#49)

eagleoflqj · web-flow · commit 7e6b9a5945d5 · 2025-04-13T19:33:17.000-04:00
diff --git a/entry/src/main/cpp/napi_init.cpp b/entry/src/main/cpp/napi_init.cpp
@@ -88,6 +88,14 @@ API(setCurrentInputMethod) {
     return {};
 }
 
+API(scroll) {
+    GET_ARGS(2)
+    GET_I32(start, 0)
+    GET_I32(count, 1)
+    fcitx::scroll(start, count);
+    return {};
+}
+
 static void CallJs(napi_env env, napi_value jsCb, void *context, void *data) {
     if (env == nullptr) {
         return;
@@ -124,6 +132,7 @@ static napi_value Init(napi_env env, napi_value exports) {
         {"selectCandidate", nullptr, selectCandidate, nullptr, nullptr, nullptr, napi_default, nullptr},
         {"askCandidateActions", nullptr, askCandidateActions, nullptr, nullptr, nullptr, napi_default, nullptr},
         {"activateCandidateAction", nullptr, activateCandidateAction, nullptr, nullptr, nullptr, napi_default, nullptr},
+        {"scroll", nullptr, scroll, nullptr, nullptr, nullptr, napi_default, nullptr},
         {"setCurrentInputMethod", nullptr, setCurrentInputMethod, nullptr, nullptr, nullptr, napi_default, nullptr},
         {"activateStatusAreaAction", nullptr, activateStatusAreaAction, nullptr, nullptr, nullptr, napi_default,
          nullptr}};
diff --git a/entry/src/main/cpp/src/fcitx.cpp b/entry/src/main/cpp/src/fcitx.cpp
@@ -38,6 +38,7 @@ namespace fcitx {
 std::unique_ptr<Instance> instance;
 std::unique_ptr<fcitx::EventDispatcher> dispatcher;
 HarmonyFrontend *frontend;
+WebKeyboard *ui;
 
 static native_streambuf log_streambuf;
 static std::ostream stream(&log_streambuf);
@@ -81,6 +82,7 @@ void init(const std::string &bundle, const std::string &resfile) {
     dispatcher->attach(&instance->eventLoop());
     fcitx_thread = std::thread([] { instance->eventLoop().exec(); });
     frontend = dynamic_cast<HarmonyFrontend *>(addonMgr.addon("harmonyfrontend"));
+    ui = dynamic_cast<WebKeyboard *>(addonMgr.addon("webkeyboard"));
     setInputMethods({"keyboard-us", "keyboard-th", "pinyin"}); // XXX: for test only.
 }
 
@@ -109,6 +111,15 @@ void selectCandidate(int index) {
         const auto &list = ic->inputPanel().candidateList();
         if (!list)
             return;
+        const auto &bulk = list->toBulk();
+        if (bulk) {
+            try {
+                bulk->candidateFromAll(index).select(ic);
+            } catch (const std::invalid_argument &e) {
+                FCITX_ERROR() << "select candidate index out of range";
+            }
+            return;
+        }
         try {
             // Engine is responsible for updating UI
             list->candidate(index).select(ic);
@@ -118,6 +129,17 @@ void selectCandidate(int index) {
     });
 }
 
+static void answerCandidateAction(ActionableCandidateList *actionableList, const CandidateWord &candidate, int index) {
+    if (actionableList->hasAction(candidate)) {
+        json actions = json::array();
+        for (const auto &action : actionableList->candidateActions(candidate)) {
+            actions.push_back({{"id", action.id()}, {"text", action.text()}});
+        }
+        notify_main_async(
+            json{{"type", "CANDIDATE_ACTIONS"}, {"data", {{"index", index}, {"actions", actions}}}}.dump());
+    }
+}
+
 void askCandidateAction(int index) {
     with_fcitx([index] {
         auto ic = instance->mostRecentInputContext();
@@ -128,16 +150,19 @@ void askCandidateAction(int index) {
         if (!actionableList) {
             return;
         }
+        const auto &bulk = list->toBulk();
+        if (bulk) {
+            try {
+                auto &candidate = bulk->candidateFromAll(index);
+                answerCandidateAction(actionableList, candidate, index);
+            } catch (const std::invalid_argument &e) {
+                FCITX_ERROR() << "action candidate index out of range";
+            }
+            return;
+        }
         try {
             auto &candidate = list->candidate(index);
-            if (actionableList->hasAction(candidate)) {
-                json actions = json::array();
-                for (const auto &action : actionableList->candidateActions(candidate)) {
-                    actions.push_back({{"id", action.id()}, {"text", action.text()}});
-                }
-                notify_main_async(
-                    json{{"type", "CANDIDATE_ACTIONS"}, {"data", {{"index", index}, {"actions", actions}}}}.dump());
-            }
+            answerCandidateAction(actionableList, candidate, index);
         } catch (const std::invalid_argument &e) {
             FCITX_ERROR() << "action candidate index out of range";
         }
@@ -154,6 +179,18 @@ void activateCandidateAction(int index, int id) {
         if (!actionableList) {
             return;
         }
+        const auto &bulk = list->toBulk();
+        if (bulk) {
+            try {
+                const auto &candidate = bulk->candidateFromAll(index);
+                if (actionableList->hasAction(candidate)) {
+                    actionableList->triggerAction(candidate, id);
+                }
+            } catch (const std::invalid_argument &e) {
+                FCITX_ERROR() << "action candidate index out of range";
+            }
+            return;
+        }
         try {
             auto &candidate = list->candidate(index);
             if (actionableList->hasAction(candidate)) {
@@ -181,4 +218,8 @@ void toggle() {
 void setCurrentInputMethod(const std::string &inputMethod) {
     with_fcitx([&] { instance->setCurrentInputMethod(inputMethod); });
 }
+
+void scroll(int start, int count) {
+    with_fcitx([=] { ui->scroll(start, count); });
+}
 } // namespace fcitx
diff --git a/entry/src/main/cpp/src/fcitx.h b/entry/src/main/cpp/src/fcitx.h
@@ -26,4 +26,5 @@ void activateCandidateAction(int index, int id);
 void activateStatusAreaAction(int id);
 void toggle();
 void setCurrentInputMethod(const std::string &inputMethod);
+void scroll(int start, int count);
 } // namespace fcitx
diff --git a/entry/src/main/cpp/types/libentry/Index.d.ts b/entry/src/main/cpp/types/libentry/Index.d.ts
@@ -17,3 +17,4 @@ export const askCandidateActions: (index: number) => void
 export const activateCandidateAction: (index: number, id: number) => void
 export const activateStatusAreaAction: (id: number) => void
 export const setCurrentInputMethod: (inputMethod: string) => void
+export const scroll: (start: number, count: number) => void
diff --git a/entry/src/main/cpp/webkeyboard/webkeyboard.cpp b/entry/src/main/cpp/webkeyboard/webkeyboard.cpp
@@ -35,20 +35,24 @@ void WebKeyboard::update(UserInterfaceComponent component, InputContext *inputCo
         auto preedit = instance_->outputFilter(inputContext, inputPanel.preedit()).toString();
         notify_main_async(json{{"type", "PREEDIT"}, {"data", {{"auxUp", auxUp}, {"preedit", preedit}}}}.dump());
         if (const auto &list = inputPanel.candidateList()) {
+            const auto &bulk = list->toBulk();
+            if (bulk) {
+                return expand();
+            }
             int size = list->size();
             candidates.reserve(size);
             for (int i = 0; i < size; ++i) {
                 const auto &label = stringutils::trim(list->label(i).toString());
                 const auto &candidate = list->candidate(i);
-                candidates.push_back({label, instance_->outputFilter(inputContext, candidate.text()).toString(),
+                candidates.push_back({instance_->outputFilter(inputContext, candidate.text()).toString(), label,
                                       instance_->outputFilter(inputContext, candidate.comment()).toString()});
             }
             highlighted = list->cursorIndex();
         }
         if (auxUp.empty() && preedit.empty() && candidates.empty()) {
             notify_main_async(R"JSON({"type":"CLEAR"})JSON");
         } else {
-            setCandidatesAsync(candidates, highlighted);
+            setCandidatesAsync(candidates, highlighted, 0, false, false);
         }
         break;
     }
@@ -58,11 +62,48 @@ void WebKeyboard::update(UserInterfaceComponent component, InputContext *inputCo
     }
 }
 
-void WebKeyboard::setCandidatesAsync(const std::vector<Candidate> &candidates, int highlighted) {
-    auto j = json{{"type", "CANDIDATES"}, {"data", {{"candidates", candidates}, {"highlighted", highlighted}}}};
+void WebKeyboard::setCandidatesAsync(const std::vector<Candidate> &candidates, int highlighted, int scrollState,
+                                     bool scrollStart, bool scrollEnd) {
+    auto j = json{{"type", "CANDIDATES"},
+                  {"data",
+                   {{"candidates", candidates},
+                    {"highlighted", highlighted},
+                    {"scrollState", scrollState},
+                    {"scrollStart", scrollStart},
+                    {"scrollEnd", scrollEnd}}}};
     notify_main_async(j.dump());
 }
 
+void WebKeyboard::expand() { scroll(0, 20); }
+
+void WebKeyboard::scroll(int start, int count) {
+    auto ic = instance_->mostRecentInputContext();
+    const auto &list = ic->inputPanel().candidateList();
+    if (!list) {
+        return;
+    }
+    const auto &bulk = list->toBulk();
+    if (!bulk) {
+        return;
+    }
+    int size = bulk->totalSize();
+    int end = size < 0 ? start + count : std::min(start + count, size);
+    bool endReached = size == end;
+    std::vector<Candidate> candidates;
+    for (int i = start; i < end; ++i) {
+        try {
+            auto &candidate = bulk->candidateFromAll(i);
+            candidates.push_back({instance_->outputFilter(ic, candidate.text()).toString(), "",
+                                  instance_->outputFilter(ic, candidate.comment()).toString()});
+        } catch (const std::invalid_argument &e) {
+            // size == -1 but actual limit is reached
+            endReached = true;
+            break;
+        }
+    }
+    setCandidatesAsync(candidates, start == 0 ? 0 : -1, 2, start == 0, endReached);
+}
+
 static nlohmann::json actionToJson(Action *action, InputContext *ic) {
     nlohmann::json j;
     j["id"] = action->id();
diff --git a/entry/src/main/cpp/webkeyboard/webkeyboard.h b/entry/src/main/cpp/webkeyboard/webkeyboard.h
@@ -13,8 +13,8 @@ std::string escape_html(const std::string &content);
 namespace fcitx {
 
 struct Candidate {
-    std::string label;
     std::string text;
+    std::string label;
     std::string comment;
 
     friend void to_json(json &j, const Candidate &c) {
@@ -42,11 +42,14 @@ class WebKeyboard final : public VirtualKeyboardUserInterface {
     void showVirtualKeyboard() override;
     void hideVirtualKeyboard() override {}
     void updateStatusArea(InputContext *ic);
+    void scroll(int start, int count);
 
 private:
     Instance *instance_;
 
-    void setCandidatesAsync(const std::vector<Candidate> &candidates, int highlighted);
+    void setCandidatesAsync(const std::vector<Candidate> &candidates, int highlighted, int scrollState,
+                            bool scrollStart, bool scrollEnd);
+    void expand();
 };
 
 class WebKeyboardFactory : public AddonFactory {
diff --git a/entry/src/main/ets/InputMethodExtensionAbility/model/KeyboardController.ets b/entry/src/main/ets/InputMethodExtensionAbility/model/KeyboardController.ets
@@ -318,6 +318,8 @@ export class KeyboardController {
         return this.textInputClient?.sendExtendAction(inputMethodEngine.ExtendAction.PASTE)
       case 'REDO':
         return redo(this.textInputClient!)
+      case 'SCROLL':
+        return fcitx.scroll(event.data.start, event.data.count)
       case 'SELECT':
         this.selecting = true
         break
diff --git a/entry/src/main/fcitx5-keyboard-web b/entry/src/main/fcitx5-keyboard-web
@@ -1 +1 @@
-Subproject commit d75be3c6e8ff7dc02807f6b5125721a4150651ba
+Subproject commit 0e5325f0e9e37b119c12ae43564bed90e9e3e434
