ETAF

ETAF 是构建在独立 Ebox 布局与渲染引擎之上的小型文本应用框架。

完整的公共模型是：

Component(props, Scope) → View → Renderer → Ebox Node → Emacs buffer

所有可见结构都使用一种形式：

(name :property value ... child ...)

子节点中唯一的计算桥接是 expr :value；属性值则是普通 Elisp 表达式。

(etaf-view
 (column
  (text :face 'bold "Hello")
  (text
   :color "#687386"
   (expr :value (if ready "Ready" "Waiting")))))

定义 Component：

(etaf-define-component status-label (&key label)
  "Render a status label."
  :view
  (text :face 'bold (expr :value label)))

(etaf-mount
 "*etaf-demo*"
 (etaf-view (status-label :label "Connected")))

etaf-view 是唯一的公共 View 构造入口。结构 form 不使用 quote；quote 仍然是普通 Elisp 数据语法，例如 'bold。普通 Elisp 返回 View 时，必须在 expr 中显式使用 (etaf-view ...) 构造它。

App 预编译

App 预编译是 ETAF core 的通用能力，不依赖 Playground。App 或宿主先注册文件清单和产物位置：

(etaf-register-app
 "my-app"
 :source "/path/to/my-app.el"
 :static "/path/to/my-app.etaf"
 :style "/path/to/my-app.ecss"
 :artifact "/path/to/build/my-app.etafc")

用户手动执行一次：

M-x etaf-compile-app

命令会选择已注册 App，并原子生成独立 .etafc 中间产物。查看状态使用：

M-x etaf-app-compile-status

状态包括 current、missing、stale 和 invalid。ETAF 会记录 companion、 .etaf 和 .ecss 的内容 hash；任一源码变化都会拒绝旧产物。宿主启动 App 时调用 etaf-app-load-artifact-or-warn：有效产物直接加载，缺失或过期则保持完整 source fallback 功能，同时明确提醒用户运行 M-x etaf-compile-app。

etaf-compiler.el 只负责 blueprint 与 .etafc 的编译/校验；App 注册、交互命令、状态和回退提醒属于独立的 etaf-app.el。Playground 只是这个通用 API 的一个可选 UI consumer。

性能记录面板

ETAF 内置了一个按需启用、与具体应用无关的性能记录器。它自动识别公共 Event、Action、mount、flush、focus、Data、Resource 和 viewport 操作；当 Ebox、TP、SQLite 等包已加载时，还会把这些包的粗粒度阶段关联到同一个 operation。

(etaf-performance-mode 1)
;; 正常操作任意已挂载的 ETAF 应用。
(etaf-performance-show)

交互采集时先执行 M-x etaf-performance-clear，复现一组操作后，在面板按 c（或执行 M-x etaf-performance-copy-report）即可把完整报告复制到剪贴板；按 w（或执行 M-x etaf-performance-export）可保存为 .eld 文件。报告包含 Emacs/显示环境、电源来源、低功耗模式、系统负载、分组 p50/p95/max、每次 operation、GC 增量和嵌套阶段；面板 header 也显示同一环境信息，避免把整机降频误判成某个包的热点。

*ETAF Performance* 面板会显示 operation ID 与父 operation、generation 变化、总耗时、GC 增量，以及嵌套阶段的 inclusive/self 耗时。记录数量由 etaf-performance-max-records 限制；关闭 mode 会移除全部记录 advice。 etaf-performance-summary 会按需计算 operation 的 p50/p95/max， etaf-performance-operation-stage-summary 则按 exclusive 耗时排列单次 operation 的包级阶段。

默认注册表刻意只记录包级粗边界，避免分析工具明显改变被测应用。任意包或应用可以临时增加更细的探针，不需要绑定某个示例：

(etaf-performance-register-stage
 'my-package-expensive-step 'application 'expensive-step)

没有内置公共边界的任意操作，可以使用 etaf-performance-call-operation 或 etaf-performance-with-operation 包裹。

可执行示例

examples/ 目录包含三个只依赖 core 的最佳实践应用：保留式状态与 Action、Data Controller 所有权，以及 Resource 错误/清理 lifecycle。make check 会编译它们，并通过已挂载的公开事件路径驱动交互。

(add-to-list 'load-path "/path/to/github/etaf/examples")
(require 'etaf-counter-example)
(etaf-counter-example-open)

文档

独立包

包	职责
`etaf-ui`	官方 Component 目录：Button、Checkbox、Label、Panel 和 DataGrid。
`etaf-sqlite`	具体 SQLite Data Source；Data Controller 仍属于 ETAF core。
`etaf-playground`	ETAF 示例；只有请求官方目录示例时才加载 UI 包。
`ebox-playground`	只使用 Ebox 的布局示例，与 ETAF 独立。

没有单独需要安装的 etaf-data：Data 是 ETAF 核心能力。也没有笼统的 etaf-adapters 包：其他数据库、服务、文件或 ORM 应使用明确名称的具体 Data Source 包实现同一契约。

加载与验证

ECSS 0.1.0 与 TP 1.0.0 是互相独立的包，安装顺序任意；两者都安装后再安装 Ebox 2.0.0，最后安装 ETAF。ETAF 只使用 Ebox 2.0 的公共渲染契约。

开发时先把同级 Ebox 检出目录加入 load-path：

(add-to-list 'load-path "/path/to/github/ebox")
(add-to-list 'load-path "/path/to/github/etaf")
(require 'etaf)

运行完整本地门禁：

make check EMACS=/Applications/Emacs.app/Contents/MacOS/Emacs

核心门禁会编译实现、运行 core/Data/Resource 测试，并检查文档和 API 边界。还应在同级 etaf-ui、etaf-sqlite、etaf-playground 和 ebox-playground 仓库分别运行 make check；它们都不会被 core facade 自动加载。

6.1 KiB Raw Blame History Unescape Escape

ETAF

App 预编译

性能记录面板

可执行示例

文档

独立包

加载与验证

6.1 KiB

Raw Blame History