!473 [201_11] 数学环境 Tab Cycling 补全项获取

* doc on test
* doc
* 数学环境 Tab Cycling 补全项获取

Author: JimZhouZZY

TeXmacs/progs/math/math-edit.scm

@@ -756,3 +756,79 @@
 	  (set-message "Only implemented for complete subtrees"
 		       "correct formula"))
       (math-manually-correct-tree (buffer-tree))))
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;; Tab cycling completion
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+(define (tabcycle-symbols comb)
+  ;; 根据按键序列获取数学符号Tab循环展示的列表
+  ;; 输入:
+  ;;     comb: 按键序列，类型为string，如"b tab"
+  ;; 处理过程:
+  ;;     1. 裁剪comb获得最基本的按键序列，例如“space b tab” -> "b"
+  ;;     2. 查找该按键序列对应的符号绑定
+  ;;     3. 如果绑定不存在，返回空列表
+  ;;     4. 如果绑定存在，继续查找所有以该按键序列为前缀的符号绑定
+  ;;     5. 返回所有找到的符号绑定列表，例如((symbol "<alpha>"))
+  ;; 输出:
+  ;;     符号列表，格式为((symbol "符号") ...)
+  (if (not (kbd-find-key-binding comb)) '()
+    (let* ((pre (string-replace (string-replace comb " tab" "") "space " ""))
+          (kbd-res (kbd-find-key-binding pre))
+          (kbd-sym (and (pair? kbd-res) (car kbd-res))))
+      (append
+        (if kbd-sym `((symbol ,kbd-sym)) '())
+        (reverse
+          (map (lambda (x) `(symbol ,(and (pair? x) (pair? (cdr x)) (cadadr x))))
+            (list-sort
+              (filter
+                (lambda (x)
+                  (and (pair? x)
+                      (string? (car x))
+                      (string-ends? (car x) "tab")
+                      (string=? (string-replace (car x) " tab" "") pre)))
+                (kbd-find-prefix pre))
+              (lambda (x y)
+                (and (pair? x) (pair? y)
+                    (string>? (car x) (car y)))))))))))
+
+(define (highlight-tabcycle-symbols lst comb)
+  ;; 高亮显示Tab循环符号列表中符合按键序列的符号
+  ;; 输入:
+  ;;     lst: 符号列表，格式为((symbol "符号") ...)
+  ;;     comb: 按键序列，类型为string，如"b tab"
+  ;; 输出:
+  ;;     符号列表，格式为((symbol "符号") (symbol* "符号") ...)，
+  ;;     其中 symbol* 表示高亮显示的符号，参见 make-menu-symbol 中的定义
+  (let ((bind (let ((res (kbd-find-key-binding comb)))
+                (and res (car res)))))
+    (if (string? bind)
+      (map (lambda (x) (if (and bind
+                                (pair? x)
+                                (eq? (car x) 'symbol)
+                                (string=? (cadr x) bind))
+                          (list 'symbol* bind) x))
+           lst)
+      lst)))
+
+(tm-define (math-tabcycle-symbols comb)
+  ;; 根据按键序列获取数学符号Tab循环展示的列表
+  ;; 输入:
+  ;;     comb: 按键序列，类型为string，如"b tab"
+  ;; 输出:
+  ;;     符号列表，格式为((symbol "符号") (symbol* "符号") ...)
+  (if (in-math?)
+    (highlight-tabcycle-symbols (tabcycle-symbols comb) comb)
+    '()))
+
+(tm-define (math-variant comb)
+  ;; 触发数学符号Tab循环的展示
+  ;; 输入:
+  ;;     comb: 按键序列，类型为string，如"b tab"
+  (if (in-math?)
+    (set-auxiliary-widget
+      (make-menu-widget
+        `((tile 99 (link (lambda () (math-tabcycle-symbols ,comb))))) 0)
+      "Math"))
+    (noop))

TeXmacs/tests/201_11.scm

@@ -2,7 +2,7 @@
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;;
 ;; MODULE      : 201_11.scm
-;; DESCRIPTION : Tests for kbd-find-prefix
+;; DESCRIPTION : Tests for tab-cycling completion
 ;; COPYRIGHT   : (C) 2025  JimZhouZZY
 ;;
 ;; This software falls under the GNU general public license version 3 or later.
@@ -39,6 +39,23 @@
                        ("e tab tab tab" ((#<lambda ()>) "<epsilon>" ""))
                        ("e tab tab tab tab" ((#<lambda ()>) "<backepsilon>" ""))))))
 
+(define (test-math-tabcycle-symbols)
+  (make 'math)
+  (kbd-insert "now we are in math mode")
+  ;; 注意 symbol* 高亮的位置也是随着 tab 的次数变化的
+  (check (math-tabcycle-symbols "a") => '((symbol* "a") (symbol "<alpha>")))
+  (check (math-tabcycle-symbols "a tab")
+    => '((symbol "a") (symbol* "<alpha>")))
+  (check (math-tabcycle-symbols "a tab tab") => '())
+  (check (math-tabcycle-symbols "= >")
+    => '((symbol* "<Rightarrow>") (symbol "<Downarrow>") (symbol "<Uparrow>") (symbol "<Rrightarrow>")))
+  (check (math-tabcycle-symbols "= > tab")
+    => '((symbol "<Rightarrow>") (symbol* "<Downarrow>") (symbol "<Uparrow>") (symbol "<Rrightarrow>")))
+  (check (math-tabcycle-symbols "= > tab tab")
+    => '((symbol "<Rightarrow>") (symbol "<Downarrow>") (symbol* "<Uparrow>") (symbol "<Rrightarrow>")))
+)
+
 (tm-define (test_201_11)
   (test-kbd-find-prefix)
+  (test-math-tabcycle-symbols)
   (check-report))

devel/201_11.md

@@ -17,6 +17,22 @@
 ```
 4. 检查：右侧辅助窗口中正常出现数学符号的按钮
 
+### 测试数学环境 Tab Cycling 补全项获取
+注：这部分也有自动测试，在`201_11.scm`
+1. 插入一个 Scheme 块
+2. run
+```
+((lambda () (make 'math) (insert "in math") (math-variant "b") (show-auxiliary-widget #t))))))
+```
+3. 检查结果
+
+## 2025/07/31 数学环境 Tab Cycling 补全项获取
+### What
+- 在`math-edit.scm`中添加了函数`math-tabcycle-symbols`用于在数学环境下获取 TabCycling 补全项
+- 在`math-edit.scm`中添加了函数`math-variant`用于展示 TabCycling 补全项
+
+目前TabCycling补全项由辅助窗口展示。将来会改成新的UI组件。
+
 ## 2025/07/29 支持转化box_widget内容为qwidget
 ### What
 修改了as_qwidget中case menu_button情况下的逻辑，在没有精确匹配到type=xpm_widget或者text_widget的时候默认包装此widget的as_qaction为一个QToolButton作为返回的qwidget。