fad54d7fb1
Assign retained TP identity before layout and emit pure, runtime-free surface plans with exact character and text-property equivalence. Keep live publication unchanged for the staged cutover and add focused surface, package, docs, and CI contracts.\n\nVerified: make check EMACS=/Applications/Emacs.app/Contents/MacOS/Emacs\nVerified: WERROR byte compilation for all 16 active Lisp files\nVerified: focused ebox-surface checkdoc has zero warnings
3.1 KiB
3.1 KiB
Ebox
Ebox 是一个独立的 Emacs 像素级 Box 与布局引擎。它是同级 ETAF 文本应用框架使用的底层渲染基座；也可以脱离 Component、应用状态和 ETAF 单独使用。
安装与使用
先安装 TP，再通过包管理器安装 Ebox，让声明的依赖自动解析。使用同级源码 checkout 时，把两个目录都加入 load-path：
(add-to-list 'load-path "/path/to/github/tp")
(add-to-list 'load-path "/path/to/github/ebox")
(require 'ebox)
(ebox-render-to-buffer
"*Ebox Example*"
(ebox-column
(ebox-create :content "Hello Ebox"
:padding '(1 2)
:border '((1) solid "#8A93A6")
:color "#263244"
:bgcolor "#F4F6FB")))
公共模型是一棵 Ebox 节点树。ebox-create 构造叶子或包装节点；ebox-column、ebox-row、ebox-flex 和 ebox-grid 组合节点；ebox-render 返回带属性文本；ebox-render-to-buffer 将结果发布到 buffer；ebox-commit 使用新的根树更新已有 runtime。
本包负责什么
- box 创建、padding、margin、border、颜色、face、overflow 与文本测量；
- row、column、flex 和二维 Grid 布局；
- selector、稳定节点 identity、key reconciliation、buffer 渲染与增量发布；
- 可选 Rust native reflow，以及完全等价的 Elisp fallback；
- 底层 Ebox DSL 文件与渲染器测试。
ETAF 属于同级独立包。当你需要统一 View 语法、Component、响应式状态、behavior、Context、Data Controller 或应用生命周期时，单独安装 ETAF。两个独立的示例包是 ebox-playground 与 etaf-playground。
仓库结构
| 路径 | 职责 |
|---|---|
ebox.el |
公共门面与包入口。 |
ebox-style.el、ebox-tree.el、ebox-measure.el |
样式、树和测量模型。 |
ebox-layout.el、ebox-flex.el、ebox-grid.el |
Formatting Context 与布局算法。 |
ebox-surface.el |
将 Ebox runtime/layout 纯投影为通用 TP surface plan。 |
ebox-buffer-backend.el、ebox-incremental.el |
Buffer 发布与增量更新。 |
ebox-dsl.el、ebox-selector.el |
独立 DSL 与树/runtime 查询。 |
ebox-native-reflow.el、native/ |
可选 native reflow 边界。 |
examples/、tests/ |
只属于 Ebox 的示例和回归测试。 |
docs/user/、docs/maintainer/ |
长期维护的中英文文档。 |
验证
make load EMACS=/Applications/Emacs.app/Contents/MacOS/Emacs
make compile EMACS=/Applications/Emacs.app/Contents/MacOS/Emacs
make check EMACS=/Applications/Emacs.app/Contents/MacOS/Emacs
make native-rust-tests
小范围修改先运行对应目标（例如 make grid-tests、make surface-tests、make dsl-tests 或 make visual-check-tests）；共享渲染或公共 API 修改后运行完整的 make check。默认从 ../tp 查找同级 TP checkout；若路径不同可覆盖 TP_DIR。