hide candidate in librime by MokOopsing · Pull Request #1115 · rime/librime

MokOopsing · 2025-12-25T06:15:00Z

Pull request

Issue tracker

Fixes will automatically close the related issue

Feature

This pull request introduces the ability to control whether the candidate list is displayed through a Rime option (_hide_candidate).

When the option _hide_candidate is enabled, Rime sets num_candidates to 0. once the frontends like squirrel and weasel detect that num_candidates is 0, they will skip populating and showing the candidate list, allowing users or schemas to dynamically hide candidates without relying on theme configuration.

Unit test

Done

Manual test

Done

Code Review

Unit and manual test pass
GitHub Action CI pass
At least one contributor reviews and votes
Can be merged clean without conflicts
PR will be merged by rebase upstream base

Additional Info

lotem · 2025-12-25T08:35:00Z

真是執着啊。

src/rime_api_impl.h

fxliang · 2025-12-27T07:17:28Z

这样还是不够环保

可能这样？将每次RimeGetContext里的高频操作改成ctx->set_option的低频操作，代价是context要多一个成员

diff --git a/src/rime/context.cc b/src/rime/context.cc
index ec840a3e..4a976e8a 100644
--- a/src/rime/context.cc
+++ b/src/rime/context.cc
@@ -284,6 +284,8 @@ void Context::set_input(const string& value) {
 }
 
 void Context::set_option(const string& name, bool value) {
+  if (name == "_hide_candidate")
+    is_hide_candidate_on_ = value;
   options_[name] = value;
   DLOG(INFO) << "Context::set_option " << name << " = " << value;
   option_update_notifier_(this, name);
diff --git a/src/rime/context.h b/src/rime/context.h
index d5261300..2820c95f 100644
--- a/src/rime/context.h
+++ b/src/rime/context.h
@@ -81,6 +81,7 @@ class RIME_DLL Context {
   // options and properties starting with '_' are local to schema;
   // others are session scoped.
   void ClearTransientOptions();
+  bool is_hide_candidate_on() const { return is_hide_candidate_on_; }
 
   Notifier& commit_notifier() { return commit_notifier_; }
   Notifier& select_notifier() { return select_notifier_; }
@@ -104,6 +105,7 @@ class RIME_DLL Context {
   CommitHistory commit_history_;
   map<string, bool> options_;
   map<string, string> properties_;
+  bool is_hide_candidate_on_ = false;
 
   Notifier commit_notifier_;
   Notifier select_notifier_;
diff --git a/src/rime_api_impl.h b/src/rime_api_impl.h
index 6e906cfe..94fce741 100644
--- a/src/rime_api_impl.h
+++ b/src/rime_api_impl.h
@@ -247,8 +247,11 @@ RIME_DEPRECATED Bool RimeGetContext(RimeSessionId session_id,
       context->menu.page_no = page_no;
       context->menu.is_last_page = Bool(page->is_last_page);
       context->menu.highlighted_candidate_index = selected_index % page_size;
+      context->menu.num_candidates =
+          ctx->is_hide_candidate_on() ? 0 : page->candidates.size();
+      if (ctx->is_hide_candidate_on())
+        return True;
       int i = 0;
-      context->menu.num_candidates = page->candidates.size();
       context->menu.candidates = new RimeCandidate[page->candidates.size()];
       for (const an<Candidate>& cand : page->candidates) {
         RimeCandidate* dest = &context->menu.candidates[i++];

jimmy54 · 2025-12-30T02:43:19Z

这个不应该是前端的能力嘛？真要放到librime里面嘛？

jimmy54 · 2025-12-30T02:44:29Z

如果真想实现是不是自己写个lua的filter呢。

lotem · 2025-12-30T02:55:42Z

这个不应该是前端的能力嘛？真要放到librime里面嘛？

確實是前端的功能。
在 librime 裏做不會浪費——就沒有必要填候選信息了。又能無需修改全面支持各種前端。
現在傾向於這個做法。
核心關注是不影響正常顯示候選，減少額外開銷。

lotem · 2025-12-30T03:03:51Z

这样还是不够环保

可能这样？将每次RimeGetContext里的高频操作改成ctx->set_option的低频操作，代价是context要多一个成员

diff --git a/src/rime/context.cc b/src/rime/context.cc
index ec840a3e..4a976e8a 100644
--- a/src/rime/context.cc
+++ b/src/rime/context.cc
@@ -284,6 +284,8 @@ void Context::set_input(const string& value) {
 }
 
 void Context::set_option(const string& name, bool value) {
+  if (name == "_hide_candidate")
+    is_hide_candidate_on_ = value;
   options_[name] = value;
   DLOG(INFO) << "Context::set_option " << name << " = " << value;
   option_update_notifier_(this, name);
diff --git a/src/rime/context.h b/src/rime/context.h
index d5261300..2820c95f 100644
--- a/src/rime/context.h
+++ b/src/rime/context.h
@@ -81,6 +81,7 @@ class RIME_DLL Context {
   // options and properties starting with '_' are local to schema;
   // others are session scoped.
   void ClearTransientOptions();
+  bool is_hide_candidate_on() const { return is_hide_candidate_on_; }
 
   Notifier& commit_notifier() { return commit_notifier_; }
   Notifier& select_notifier() { return select_notifier_; }
@@ -104,6 +105,7 @@ class RIME_DLL Context {
   CommitHistory commit_history_;
   map<string, bool> options_;
   map<string, string> properties_;
+  bool is_hide_candidate_on_ = false;
 
   Notifier commit_notifier_;
   Notifier select_notifier_;
diff --git a/src/rime_api_impl.h b/src/rime_api_impl.h
index 6e906cfe..94fce741 100644
--- a/src/rime_api_impl.h
+++ b/src/rime_api_impl.h
@@ -247,8 +247,11 @@ RIME_DEPRECATED Bool RimeGetContext(RimeSessionId session_id,
       context->menu.page_no = page_no;
       context->menu.is_last_page = Bool(page->is_last_page);
       context->menu.highlighted_candidate_index = selected_index % page_size;
+      context->menu.num_candidates =
+          ctx->is_hide_candidate_on() ? 0 : page->candidates.size();
+      if (ctx->is_hide_candidate_on())
+        return True;
       int i = 0;
-      context->menu.num_candidates = page->candidates.size();
       context->menu.candidates = new RimeCandidate[page->candidates.size()];
       for (const an<Candidate>& cand : page->candidates) {
         RimeCandidate* dest = &context->menu.candidates[i++];

不要吧，雖然優化了，但這樣寫容易亂。

我考慮呢，想再漂亮一點，就定義一個 UiOptions 結構體，把 _horizontal 之類都放進去，偵聽 option_update_notifier 更新；供 rime_api 以及 navigator 等組件訪問。

lotem

LGTM.

MokOopsing · 2025-12-30T03:06:24Z

这样还是不够环保
可能这样？将每次RimeGetContext里的高频操作改成ctx->set_option的低频操作，代价是context要多一个成员

diff --git a/src/rime/context.cc b/src/rime/context.cc
index ec840a3e..4a976e8a 100644
--- a/src/rime/context.cc
+++ b/src/rime/context.cc
@@ -284,6 +284,8 @@ void Context::set_input(const string& value) {
 }
 
 void Context::set_option(const string& name, bool value) {
+  if (name == "_hide_candidate")
+    is_hide_candidate_on_ = value;
   options_[name] = value;
   DLOG(INFO) << "Context::set_option " << name << " = " << value;
   option_update_notifier_(this, name);
diff --git a/src/rime/context.h b/src/rime/context.h
index d5261300..2820c95f 100644
--- a/src/rime/context.h
+++ b/src/rime/context.h
@@ -81,6 +81,7 @@ class RIME_DLL Context {
   // options and properties starting with '_' are local to schema;
   // others are session scoped.
   void ClearTransientOptions();
+  bool is_hide_candidate_on() const { return is_hide_candidate_on_; }
 
   Notifier& commit_notifier() { return commit_notifier_; }
   Notifier& select_notifier() { return select_notifier_; }
@@ -104,6 +105,7 @@ class RIME_DLL Context {
   CommitHistory commit_history_;
   map<string, bool> options_;
   map<string, string> properties_;
+  bool is_hide_candidate_on_ = false;
 
   Notifier commit_notifier_;
   Notifier select_notifier_;
diff --git a/src/rime_api_impl.h b/src/rime_api_impl.h
index 6e906cfe..94fce741 100644
--- a/src/rime_api_impl.h
+++ b/src/rime_api_impl.h
@@ -247,8 +247,11 @@ RIME_DEPRECATED Bool RimeGetContext(RimeSessionId session_id,
       context->menu.page_no = page_no;
       context->menu.is_last_page = Bool(page->is_last_page);
       context->menu.highlighted_candidate_index = selected_index % page_size;
+      context->menu.num_candidates =
+          ctx->is_hide_candidate_on() ? 0 : page->candidates.size();
+      if (ctx->is_hide_candidate_on())
+        return True;
       int i = 0;
-      context->menu.num_candidates = page->candidates.size();
       context->menu.candidates = new RimeCandidate[page->candidates.size()];
       for (const an<Candidate>& cand : page->candidates) {
         RimeCandidate* dest = &context->menu.candidates[i++];

不要吧，雖然優化了，但這樣寫容易亂。

我考慮呢，想再漂亮一點，就定義一個 UiOptions 結構體，把 _horizontal 之類都放進去，偵聽 option_update_notifier 更新；供 rime_api 以及 navigator 等組件訪問。

改动太多，您亲自操刀吧，加入experimental分支，我来测试

lotem requested changes Dec 25, 2025

View reviewed changes

src/rime_api_impl.h Show resolved Hide resolved

hide candidate in librime

d902833

MokOopsing force-pushed the master branch from a4c8688 to d902833 Compare December 26, 2025 01:03

MokOopsing force-pushed the master branch from 72a70f5 to d902833 Compare December 30, 2025 02:48

lotem approved these changes Dec 30, 2025

View reviewed changes

lotem merged commit 2350b77 into rime:master Jan 2, 2026
20 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

hide candidate in librime#1115

hide candidate in librime#1115
lotem merged 1 commit intorime:masterfrom
MokOopsing:master

MokOopsing commented Dec 25, 2025 •

edited

Loading

Uh oh!

lotem commented Dec 25, 2025

Uh oh!

Uh oh!

fxliang commented Dec 27, 2025 •

edited

Loading

Uh oh!

jimmy54 commented Dec 30, 2025

Uh oh!

jimmy54 commented Dec 30, 2025

Uh oh!

lotem commented Dec 30, 2025

Uh oh!

lotem commented Dec 30, 2025

Uh oh!

lotem left a comment

Uh oh!

MokOopsing commented Dec 30, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

MokOopsing commented Dec 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull request

Issue tracker

Feature

Unit test

Manual test

Code Review

Additional Info

Uh oh!

lotem commented Dec 25, 2025

Uh oh!

Uh oh!

fxliang commented Dec 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jimmy54 commented Dec 30, 2025

Uh oh!

jimmy54 commented Dec 30, 2025

Uh oh!

lotem commented Dec 30, 2025

Uh oh!

lotem commented Dec 30, 2025

Uh oh!

lotem left a comment

Choose a reason for hiding this comment

Uh oh!

MokOopsing commented Dec 30, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

MokOopsing commented Dec 25, 2025 •

edited

Loading

fxliang commented Dec 27, 2025 •

edited

Loading