[0707] Collab 文档禁用 Preedit (#4282)

Author: JimZhouZZY

devel/0707.md

@@ -0,0 +1,37 @@
+# [0707] Collab 文档禁用 IM 预编辑（preedit）
+
+## What & Why
+协作文档下，输入法的实时预编辑（preedit，即正在拼写的候选拼音/字符装饰）会干扰 CRDT
+协同，需要禁用。参考 `(set-preference "IM:preedit" "off")` 的效果，但**不应改用户配置**
+——不能持久写 `IM:preedit` 偏好，只在运行期、按当前文档是否处于协作会话判定。
+
+## How
+复刻既有 `in-math?` 的运行期门控模式：数学模式下同样会在不改偏好的前提下强制关 preedit。
+Scheme 谓词 `(collab-enabled?)` **已存在**（`src/Scheme/Glue/glue_editor.lua`，glue 规则
+生成 `get_current_editor()->collab_enabled()`），其实现为 `edit_modify_rep::collab_enabled()`
+→ 返回 `loro_collab_on`（`src/Edit/Modify/edit_collab.cpp`）。故无需新增 glue，只在 3 处
+预编辑入口各加一行判断：
+
+- Qt：`QTMWidget::inputMethodEvent` — `if (as_bool (call ("collab-enabled?"))) im_preedit_switch= false;`
+- ImGui/web：`mogan_ime_preedit` — `if (as_bool (call ("collab-enabled?"))) return;`
+- ImGui/macOS：`im_macos_enqueue_preedit` — 同上
+
+提交文本（commit string）路径不经过这些门控，协作文档中正常输入提交文本不受影响；只压制
+实时 preedit 装饰。亦未动 `inputMethodQuery` 的 `Qt::ImEnabled`（那会整体关掉 IME，连提交
+文本一起禁，过重）。
+
+行为：普通文档 preedit 跟随用户 `IM:preedit` 偏好（默认开）；协作文档强制关（即使偏好为 on）。
+
+## 涉及文件
+- `src/Plugins/Qt/QTMWidget.cpp`：`inputMethodEvent` 加协作门控
+- `src/Plugins/ImGui/im_tm_widget.cpp`：`mogan_ime_preedit`（web）、
+  `im_macos_enqueue_preedit`（macOS）各加协作门控
+
+## 如何测试
+需 `--loro=y` 构建后 GUI 验证（preedit 是真实 IME 行为，headless 跑不出）：
+```
+xmake f --loro=y && xmake b stem && xmake r stem
+```
+1. 普通文档：中文输入法拼写时 preedit 候选正常显示（偏好未变）。
+2. 开协作会话（CREATE/JOIN，触发 `collab_enable`）后：同一输入法拼写时不再显示 preedit
+   装饰，但提交文本（选词后上屏）仍正常。

src/Plugins/ImGui/im_tm_widget.cpp

@@ -219,6 +219,9 @@ extern "C" EMSCRIPTEN_KEEPALIVE void
 mogan_ime_preedit (const char* utf8) {
   if (utf8 == nullptr) return;
   if (as_bool (call ("in-math?"))) return;
+  // 协作文档禁用预编辑
+  editor ed= get_current_editor ();
+  if (!is_nil (ed) && ed->collab_enabled ()) return;
   g_ime_pending << ("pre-edit:" * string (utf8));
 }
 #endif // __EMSCRIPTEN__
@@ -231,6 +234,9 @@ void
 im_macos_enqueue_preedit (const char* utf8) {
   if (utf8 == nullptr) return;
   if (as_bool (call ("in-math?"))) return;
+  // 协作文档禁用预编辑
+  editor ed= get_current_editor ();
+  if (!is_nil (ed) && ed->collab_enabled ()) return;
   g_ime_pending << ("pre-edit:" * string (utf8));
 }
 

src/Plugins/Qt/QTMWidget.cpp

@@ -369,6 +369,9 @@ QTMWidget::inputMethodEvent (QInputMethodEvent* event) {
   }
   // Disable preedit in math mode to prevent crash in QQPinyin
   if (as_bool (call ("in-math?"))) im_preedit_switch= false;
+  // 协作文档禁用预编辑（与数学模式同理）
+  editor ed= get_current_editor ();
+  if (!is_nil (ed) && ed->collab_enabled ()) im_preedit_switch= false;
 
   string r= "pre-edit:";
   if (im_preedit_switch && !preedit_string.isEmpty ()) {