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
109 lines
6.3 KiB
Markdown
109 lines
6.3 KiB
Markdown
# Ebox 当前实现参考
|
||
|
||
本文是独立 Ebox 仓库的维护者入口，描述包边界、active 文件、运行时模型、不变量和验证命令。历史 `emacs-box` 是另一个旧架构源码树，不是本包依赖。ETAF 是同级高层包。
|
||
|
||
## 阅读顺序
|
||
|
||
1. 先读 `AGENTS.md` 了解仓库规则。
|
||
2. 读 `README.md` 了解安装和公共边界。
|
||
3. 读 `docs/user/ebox-user-guide.zh.md` 了解公共构造方式。
|
||
4. 读本文了解所有权和验证方式。
|
||
5. 修改发布或 patch 规划前，读 `docs/maintainer/ebox-incremental-update-contract.zh.md`。
|
||
|
||
## Active 源码清单
|
||
|
||
| 文件 | 负责内容 |
|
||
| --- | --- |
|
||
| `ebox.el` | 公共门面、构造辅助函数、渲染、buffer 入口、滚动、commit 与 byte compile。 |
|
||
| `ebox-cache.el` | 测量/渲染缓存记录、失效和缓存报告。 |
|
||
| `ebox-style.el` | 属性注册、别名、shorthand 展开、computed style、颜色、border 和 dirty effect。 |
|
||
| `ebox-tree.el` | 节点遍历、子节点访问、identity、父路径、key 和树 snapshot。 |
|
||
| `ebox-measure.el` | display 敏感的字符、face、像素测量与测量缓存。 |
|
||
| `ebox-fragment.el` | 布局 fragment、signature、snapshot、span 和 dirty kind 事实。 |
|
||
| `ebox-render-context.el` | render-local context 与发布输入。 |
|
||
| `ebox-layout.el` | box、row、column、stack、concat、spacer、换行和通用 formatting context。 |
|
||
| `ebox-flex.el` | flex 归一化、line、剩余空间分配和 flex 渲染。 |
|
||
| `ebox-grid.el` | 轨道、隐式轨道、分数、minmax/repeat、gap、placement、span 和对齐。 |
|
||
| `ebox-surface.el` | Ebox 候选 identity，以及从布局输出到通用 TP surface plan 的纯投影。 |
|
||
| `ebox-buffer-backend.el` | text property、display space/border、marker、extent、替换和 buffer 变更。 |
|
||
| `ebox-incremental.el` | runtime、snapshot、dirty 规划、owner 提升、原子发布和报告。 |
|
||
| `ebox-dsl.el` | 数据型 `.ebox` form，以及向公共节点的 lowering。 |
|
||
| `ebox-selector.el` | 对树和 runtime handle 的 CSS-like 查询。 |
|
||
| `ebox-native-reflow.el` | 可选 native 模块加载/构建、ABI 校验、受限 session 和 Elisp fallback。 |
|
||
|
||
本包有意不包含应用 Component、UI control、响应式 data 或 playground 实现；它们属于同级包。历史应用性能记录器和 native reflow 评估器也不属于独立 Ebox 的发布边界；Ebox 只保留 native 模块本身、Rust 构建输入和可重复的构建检查。
|
||
|
||
active 合同还覆盖 `Makefile`、`.github/workflows/ci.yml`、`tests/ebox-core-render-tests.el`、`tests/ebox-grid-tests.el`、`tests/ebox-commit-tests.el`、`tests/ebox-surface-tests.el`、`tests/ebox-dsl-tests.el`、`tests/ebox-flex-tests.el`、`tests/ebox-selector-tests.el`、`tests/ebox-package-tests.el`、`tests/ebox-visual-check-tests.el`、`tests/ebox-docs-contract-tests.el`、`tests/ebox-ci-contract-tests.el`、`native/Cargo.toml`、`native/Cargo.lock`、`native/build.rs`、`native/vendor/emacs-30/emacs-module.h`、`native/src/lib.rs`、`native/src/layout.rs`、`native/c/ebox_module.c`、`scripts/ebox-package-lint.el` 和 `scripts/ebox-visual-check.el`。
|
||
|
||
## 运行时模型
|
||
|
||
正常数据流是：
|
||
|
||
```text
|
||
Source Tree
|
||
-> Element Tree
|
||
-> Computed Style
|
||
-> Box/Formatting Context
|
||
-> Measurement + Render Context
|
||
-> Layout Fragment/Snapshot
|
||
-> 纯 TP Surface Plan
|
||
-> Dirty/Patch Plan
|
||
-> Emacs Buffer Backend
|
||
```
|
||
|
||
| 模型 | Owner | 不得拥有 |
|
||
| --- | --- | --- |
|
||
| Source/Element Tree | `ebox-tree.el`、`ebox-dsl.el` | 已发布 buffer 的变更。 |
|
||
| Computed Style | `ebox-style.el` | 布局 identity 或 patch 执行。 |
|
||
| Measurement | `ebox-measure.el` | 应用状态或 dirty 策略。 |
|
||
| Formatting Context | `ebox-layout.el`、`ebox-flex.el`、`ebox-grid.el` | Buffer 编辑。 |
|
||
| Fragment/Snapshot | `ebox-fragment.el`、`ebox-incremental.el` | Source parsing 或 identity 分配。 |
|
||
| Surface Projection | `ebox-surface.el` | Buffer 变更或 Ebox 布局决策。 |
|
||
| Dirty/Patch | `ebox-incremental.el` | 原始测量或直接 buffer 编辑。 |
|
||
| Buffer Backend | `ebox-buffer-backend.el` | 样式语义或应用状态。 |
|
||
|
||
## 不变量
|
||
|
||
- 公共 Ebox 节点是数据；`ebox--*` 名称是私有实现。
|
||
- `'(420)` 这样的单元素横向 list 表示像素；普通横向数字表示字符列。
|
||
- `ebox-render` 不发布到 buffer；`ebox-render-to-buffer` 负责首次发布；`ebox-commit` 负责声明式替换。
|
||
- 候选失败时必须保留之前的 buffer、runtime identity 和报告。
|
||
- Key 只在兄弟节点中有效；不能用可见字符串作为 identity。
|
||
- `owner-rerender` 范围大于 `span-patch`，`span-patch` 大于 `paint-patch`。
|
||
- Buffer 坐标属于生成它的 generation，变更后必须重新获取。
|
||
- Grid 使用普通测量与渲染流水线；native reflow 可以拒绝不适合的树并回退到 Elisp，正确性不变。
|
||
- 加载 Ebox 不会构建或安装可选 Rust 模块。
|
||
- Phase 7 projector 在布局前分配 TP candidate identity，输出不含 marker、position、buffer 或 TP runtime handle 的 plan，并与 `ebox-render` 保持逐字节、逐属性等价。公开 live 入口在下一阶段切换前仍使用现有 Ebox backend。
|
||
|
||
## Grid 合同
|
||
|
||
当前 Grid 支持固定和像素轨道、`auto`、分数轨道、`minmax`、`repeat`、隐式行列、行列 gap、auto-flow、从 1 开始的 placement、正整数 span、item/content 对齐，以及普通 buffer 渲染和更新。CSS cascade、百分比、绝对定位、z-index、圆角、阴影、完整 typography 和浏览器级 bidi 不在合同内。
|
||
|
||
## Active 示例与测试
|
||
|
||
独立 Ebox 包不再内置 playground fixture。迁移后的 `.ebox` 参考文件及其运行器位于同级 `ebox-playground` 包；本仓库直接测试 DSL 与布局原语。回归边界是 `tests/` 下由文档合同列出的 ERT 文件。本包测试不得加载历史全栈源码树或应用框架。
|
||
|
||
## 验证矩阵
|
||
|
||
```sh
|
||
make check
|
||
make core-tests
|
||
make grid-tests
|
||
make ebox-commit-tests
|
||
make surface-tests
|
||
make visual-check-tests
|
||
make package-tests
|
||
make selector-tests
|
||
make dsl-tests
|
||
make flex-tests
|
||
make docs-contract-tests
|
||
make ci-contract-tests
|
||
make visual-check
|
||
make native-rust-tests
|
||
make native-build
|
||
make package-lint
|
||
make diff-check
|
||
```
|
||
|
||
先运行聚焦测试；修改共享渲染、Grid、公共构造器或文档后运行 `make check`。修改 native 后必须运行 Rust 检查与 native 构建。
|