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
62 lines
3.4 KiB
Markdown
62 lines
3.4 KiB
Markdown
# Ebox
|
|
|
|
Ebox is a standalone, pixel-precise box and layout engine for Emacs. It provides the low-level rendering substrate used by the sibling [ETAF](../etaf/README.md) text-application framework. Ebox can also be used directly without Components, application state, or ETAF.
|
|
|
|
## Install and use
|
|
|
|
Install TP first, then install Ebox through a package manager so its declared dependency is resolved. For sibling source checkouts, place both directories on `load-path`:
|
|
|
|
```elisp
|
|
(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")))
|
|
```
|
|
|
|
The public model is a tree of Ebox nodes. `ebox-create` builds a leaf or wrapper node; `ebox-column`, `ebox-row`, `ebox-flex`, and `ebox-grid` compose nodes; `ebox-render` returns propertized text; `ebox-render-to-buffer` publishes it into a buffer; and `ebox-commit` updates an existing runtime from a fresh root tree.
|
|
|
|
## What belongs here
|
|
|
|
- box creation, padding, margins, borders, colors, faces, overflow, and text measurement;
|
|
- row, column, flex, and two-dimensional Grid layout;
|
|
- selectors, stable node identity, keyed reconciliation, buffer rendering, and incremental publication;
|
|
- optional Rust native reflow with an exact Elisp fallback;
|
|
- low-level Ebox DSL files and renderer-focused tests.
|
|
|
|
ETAF belongs in the sibling package. Install it separately when you need the unified View grammar, Components, reactive state, behaviors, Context, Data Controllers, or application lifecycle. The independent example packages are [ebox-playground](../ebox-playground/README.md) and [etaf-playground](../etaf-playground/README.md).
|
|
|
|
## Repository map
|
|
|
|
| Path | Responsibility |
|
|
| --- | --- |
|
|
| `ebox.el` | Public facade and package entry point. |
|
|
| `ebox-style.el`, `ebox-tree.el`, `ebox-measure.el` | Style, tree, and measurement models. |
|
|
| `ebox-layout.el`, `ebox-flex.el`, `ebox-grid.el` | Formatting contexts and layout algorithms. |
|
|
| `ebox-surface.el` | Pure Ebox runtime/layout projection into generic TP surface plans. |
|
|
| `ebox-buffer-backend.el`, `ebox-incremental.el` | Buffer publication and incremental updates. |
|
|
| `ebox-dsl.el`, `ebox-selector.el` | Standalone DSL and tree/runtime queries. |
|
|
| `ebox-native-reflow.el`, `native/` | Optional native reflow boundary. |
|
|
| `examples/`, `tests/` | Ebox-only examples and regression tests. |
|
|
| `docs/user/`, `docs/maintainer/` | Long-lived English and Chinese documentation. |
|
|
|
|
## Verification
|
|
|
|
```sh
|
|
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
|
|
```
|
|
|
|
Run the smallest focused target first (`make grid-tests`, `make surface-tests`, `make dsl-tests`, or `make visual-check-tests`), then run `make check` for shared rendering or public API changes. A sibling TP checkout is found at `../tp` by default; override `TP_DIR` when it lives elsewhere.
|
|
|
|
Read the [Ebox user guide](docs/user/ebox-user-guide.en.md) for public construction examples and the [current implementation reference](docs/maintainer/ebox-current-implementation-reference.en.md) for ownership boundaries and invariants.
|