on master help sign in
290 files changed+40116−18620
since splitsnapshots
unifiedsplit
.gitattributes+3 .github/workflows/ci.yml+42 .github/workflows/playground.yml+65 .github/workflows/release.yml+21−10 .gitignore+2 CONTRIBUTING.md+167 Cargo.lock+71 Cargo.toml+11−1 DESIGN.md+1488−1089 README.md+196−132 crates/htmlang-core/Cargo.toml+4 crates/htmlang-core/src/ast.rs+775 crates/htmlang-core/src/codegen.rs+2479 crates/htmlang-core/src/codegen_tests.rs+121 crates/htmlang-core/src/diagnostic.rs+245 crates/htmlang-core/src/expr.rs+801 crates/htmlang-core/src/interp.rs+651 crates/htmlang-core/src/lib.rs+12 crates/htmlang-core/src/parser.rs+7651 crates/htmlang-core/src/std.hl+9 crates/htmlang-core/src/syntax.rs+2943 crates/htmlang-core/src/value.rs+406 crates/htmlang-core/src/vocab.rs+891 crates/htmlang-wasm/Cargo.toml+11 crates/htmlang-wasm/playground/index.html+113 crates/htmlang-wasm/src/lib.rs+91 editors/vscode/README.md+115 editors/vscode/package.json+33−1 editors/vscode/snippets/htmlang.json+256−192 editors/vscode/src/extension.ts+112−4 editors/vscode/syntaxes/htmlang.tmLanguage.json+346−64 examples/blog.hl+86 examples/blog.html.map+1 examples/demo.hl+299−37 examples/demo.html+800−1 examples/demo.html.map+1 examples/docs.hl+146 examples/docs.html.map+1 examples/landing.hl+136 examples/landing.html.map+1 examples/posts.json+27 src/ast.rs−163 src/bin/htmlang_lsp/analysis.rs+1419−916 src/bin/htmlang_lsp/completion.rs+1947−807 src/bin/htmlang_lsp/docs.rs+616 src/bin/htmlang_lsp/hover.rs+343−488 src/bin/htmlang_lsp/main.rs+637−238 src/bin/htmlang_lsp/navigation.rs+596−245 src/bin/htmlang_lsp/state.rs+315 src/bin/htmlang_lsp/tree.rs+222 src/cli.rs+92 src/codegen.rs−3142 src/convert.rs−1310 src/fmt.rs+499−236 src/lib.rs+7−4 src/main.rs+980−2942 src/parser.rs−5135 src/serve.rs+290−107 tests/common/mod.rs+140 tests/docs.rs+198 tests/editor.rs+157 tests/fmt.rs+55 tests/regressions.rs+2471 tests/snapshots.rs+5759−1031 tests/snapshots/accessibility.hl+5−5 tests/snapshots/accessibility.html+1 tests/snapshots/alignment.hl+1−1 tests/snapshots/alignment.html+1 tests/snapshots/anchor_positioning.html+1 tests/snapshots/animate_shorthand.hl+13−9 tests/snapshots/animate_shorthand.html+1 tests/snapshots/animations.hl+9−5 tests/snapshots/animations.html+1 tests/snapshots/arithmetic.hl+4−4 tests/snapshots/arithmetic.html+1 tests/snapshots/assert_directive.hl−10 tests/snapshots/attributes.hl+5−5 tests/snapshots/attributes.html+1 tests/snapshots/basic_elements.hl+2−2 tests/snapshots/basic_elements.html+1 tests/snapshots/breadcrumb.hl−4 tests/snapshots/chain_operator.hl+1−1 tests/snapshots/chain_operator.html+1 tests/snapshots/clamp_css.hl+1−1 tests/snapshots/clamp_css.html+1 tests/snapshots/code_samples.hl+28 tests/snapshots/code_samples.html+5 tests/snapshots/color_scheme.hl+1−1 tests/snapshots/color_scheme.html+1 tests/snapshots/colour_variants.hl+12 tests/snapshots/colour_variants.html+1 tests/snapshots/compat_test.hl+1−1 tests/snapshots/computed_let.hl+3−3 tests/snapshots/computed_let.html+1 tests/snapshots/conditionals.html+1 tests/snapshots/container_queries.hl+2−2 tests/snapshots/container_queries.html+1 tests/snapshots/convert_basic.hl+1−1 tests/snapshots/css_property.hl+6−4 tests/snapshots/css_property.html+1 tests/snapshots/css_shorthands.hl+7−10 tests/snapshots/css_shorthands.html+1 tests/snapshots/css_units.hl+3−3 tests/snapshots/css_units.html+1 tests/snapshots/css_vars.hl+5−5 tests/snapshots/css_vars.html+1 tests/snapshots/custom_properties.hl+47 tests/snapshots/custom_properties.html+1 tests/snapshots/dark_mode.hl+2−2 tests/snapshots/dark_mode.html+1 tests/snapshots/data_directive.hl+7−6 tests/snapshots/data_directive.html+1 tests/snapshots/direction_attr.html+1 tests/snapshots/each_destructuring.hl+4−3 tests/snapshots/each_destructuring.html+1 tests/snapshots/each_else.hl+2−2 tests/snapshots/each_else.html+1 tests/snapshots/each_index.html+1 tests/snapshots/each_range.html+1 tests/snapshots/each_step.hl+4−4 tests/snapshots/each_step.html+1 tests/snapshots/element_prefixes.hl+42 tests/snapshots/element_prefixes.html+3 tests/snapshots/else_if.html+1 tests/snapshots/env_directive.hl+1−1 tests/snapshots/env_directive.html+1 tests/snapshots/escapes_and_quotes.hl+19 tests/snapshots/escapes_and_quotes.html+1 tests/snapshots/extra_css.hl+3−3 tests/snapshots/extra_css.html+1 tests/snapshots/fn_defaults.hl+2−2 tests/snapshots/fn_defaults.html+1 tests/snapshots/form_elements.hl+9−9 tests/snapshots/form_elements.html+1 tests/snapshots/fragment.hl+1−1 tests/snapshots/fragment.html+1 tests/snapshots/function_calls.hl+66 tests/snapshots/function_calls.html+1 tests/snapshots/function_definitions.hl+35 tests/snapshots/function_definitions.html+1 tests/snapshots/functions.hl+5−5 tests/snapshots/functions.html+1 tests/snapshots/grid_areas.hl+1−1 tests/snapshots/grid_areas.html+1 tests/snapshots/has_pseudo.hl+2−2 tests/snapshots/has_pseudo.html+1 tests/snapshots/hidden_attr.hl+1−1 tests/snapshots/hidden_attr.html+1 tests/snapshots/html_elements.hl+42 tests/snapshots/html_elements.html+1 tests/snapshots/if_expr.hl+21−3 tests/snapshots/if_expr.html+1 tests/snapshots/implicit_el.hl−7 tests/snapshots/initial_letter.html+1 tests/snapshots/inline_text.hl+2−2 tests/snapshots/inline_text.html+1 tests/snapshots/lang_directive.hl+1−2 tests/snapshots/lang_directive.html+1 tests/snapshots/layer_wrapping.html+1 tests/snapshots/layout_direction.hl+33 tests/snapshots/layout_direction.html+1 tests/snapshots/layout_modes.hl+44 tests/snapshots/layout_modes.html+2 tests/snapshots/leading_argument.hl+50 tests/snapshots/leading_argument.html+1 tests/snapshots/list_elements.hl+11−11 tests/snapshots/list_elements.html+1 tests/snapshots/loops.html+1 tests/snapshots/manifest_directive.hl+3−8 tests/snapshots/manifest_directive.html+1 tests/snapshots/markdown_block.hl+1−1 tests/snapshots/markdown_block.html+10 tests/snapshots/match_directive.hl+9−10 tests/snapshots/match_directive.html+1 tests/snapshots/media_elements.hl+1−1 tests/snapshots/media_elements.html+1 tests/snapshots/media_extended.html+1 tests/snapshots/meta_head.hl+1−1 tests/snapshots/meta_head.html+1 tests/snapshots/mixin_spread.hl+5−5 tests/snapshots/mixin_spread.html+1 tests/snapshots/named_slots.hl+2−2 tests/snapshots/named_slots.html+1 tests/snapshots/names_and_values.hl+18 tests/snapshots/names_and_values.html+1 tests/snapshots/new_css.hl+1−1 tests/snapshots/new_css.html+1 tests/snapshots/new_css_attrs.hl+1−1 tests/snapshots/new_css_attrs.html+1 tests/snapshots/new_css_properties.hl+7−7 tests/snapshots/new_css_properties.html+1 tests/snapshots/new_css_properties_2.hl+2−2 tests/snapshots/new_css_properties_2.html+1 tests/snapshots/new_css_properties_3.hl+2−2 tests/snapshots/new_css_properties_3.html+1 tests/snapshots/new_css_properties_4.hl+1−1 tests/snapshots/new_css_properties_4.html+1 tests/snapshots/new_directives.hl+18−9 tests/snapshots/new_directives.html+8 tests/snapshots/new_elements.hl+7−7 tests/snapshots/new_elements.html+1 tests/snapshots/new_elements_2.hl+10−10 tests/snapshots/new_elements_2.html+1 tests/snapshots/new_elements_3.hl+2−2 tests/snapshots/new_elements_3.html+1 tests/snapshots/new_elements_4.hl+4−13 tests/snapshots/new_elements_4.html+1 tests/snapshots/new_elements_5.hl−19 tests/snapshots/new_elements_6.hl+3−3 tests/snapshots/new_elements_6.html+1 tests/snapshots/new_html_attrs.hl+5−5 tests/snapshots/new_html_attrs.html+1 tests/snapshots/new_pseudos.hl+2−2 tests/snapshots/new_pseudos.html+1 tests/snapshots/no_page.hl+1−1 tests/snapshots/no_page.html+1 tests/snapshots/nth_pseudo.hl+3−3 tests/snapshots/nth_pseudo.html+1 tests/snapshots/og_directive.hl+3−3 tests/snapshots/og_directive.html+1 tests/snapshots/one_css_path.hl+14 tests/snapshots/one_css_path.html+4 tests/snapshots/page_root.hl+15 tests/snapshots/page_root.html+1 tests/snapshots/pagination_each.hl−3 tests/snapshots/parameters.hl+31 tests/snapshots/parameters.html+1 tests/snapshots/popover_api.hl+2−2 tests/snapshots/popover_api.html+1 tests/snapshots/positional.html+1 tests/snapshots/prefixes_compose.hl+17 tests/snapshots/prefixes_compose.html+1 tests/snapshots/pseudo_elements.hl+1−1 tests/snapshots/pseudo_elements.html+1 tests/snapshots/pseudo_states.html+1 tests/snapshots/pseudo_states_extended.hl+5−5 tests/snapshots/pseudo_states_extended.html+1 tests/snapshots/px_rule.hl+20 tests/snapshots/px_rule.html+1 tests/snapshots/raw_html.hl+2−2 tests/snapshots/raw_html.html+1 tests/snapshots/repeat_directive.hl+2−2 tests/snapshots/repeat_directive.html+1 tests/snapshots/responsive.hl+1−1 tests/snapshots/responsive.html+1 tests/snapshots/responsive_images.hl+2−2 tests/snapshots/responsive_images.html+1 tests/snapshots/scope_css.hl+6−4 tests/snapshots/scope_css.html+1 tests/snapshots/script_element.hl+1−1 tests/snapshots/script_element.html+4 tests/snapshots/scroll_driven_animations.hl+6−4 tests/snapshots/scroll_driven_animations.html+1 tests/snapshots/selection_pseudo.hl+1−1 tests/snapshots/selection_pseudo.html+1 tests/snapshots/semantic_elements.hl+4−4 tests/snapshots/semantic_elements.html+1 tests/snapshots/sizing.hl+1−1 tests/snapshots/sizing.html+1 tests/snapshots/slots_and_children.hl+59 tests/snapshots/slots_and_children.html+1 tests/snapshots/starting_style.hl+5−3 tests/snapshots/starting_style.html+1 tests/snapshots/stress_deeply_nested.hl+184 tests/snapshots/stress_deeply_nested.html+1 tests/snapshots/stress_large.hl+396 tests/snapshots/stress_large.html+1 tests/snapshots/string_interpolation.html+1 tests/snapshots/style_block.hl+1−1 tests/snapshots/style_block.html+1 tests/snapshots/subgrid_css.html+1 tests/snapshots/table_elements.html+1 tests/snapshots/text_everywhere.hl+41 tests/snapshots/text_everywhere.html+3 tests/snapshots/translations_i18n.hl+3−8 tests/snapshots/translations_i18n.html+1 tests/snapshots/unless_directive.hl+2−2 tests/snapshots/unless_directive.html+1 tests/snapshots/values_and_scope.hl+62 tests/snapshots/values_and_scope.html+1 tests/snapshots/variable_filters.hl+8−8 tests/snapshots/variable_filters.html+1 tests/snapshots/variable_slots.hl+18 tests/snapshots/variable_slots.html+1 tests/snapshots/variables_defines.hl+3−3 tests/snapshots/variables_defines.html+1 tests/snapshots/view_transitions.hl+2−2 tests/snapshots/view_transitions.html+1 tests/snapshots/with_directive.hl+2−2 tests/snapshots/with_directive.html+1
.gitattributesnew file+3
@@ -0,0 +1,3 @@
1+# Check out text files with LF endings on every platform, so snapshot
2+# fixtures compare equal on Windows too.
3+* text=auto eol=lf
.github/workflows/ci.ymlnew file+42
@@ -0,0 +1,42 @@
1+name: CI
2+
3+on:
4+ push:
5+ branches: [master, main]
6+ pull_request:
7+ workflow_dispatch:
8+
9+env:
10+ CARGO_TERM_COLOR: always
11+ RUSTFLAGS: -D warnings
12+
13+jobs:
14+ test:
15+ name: Test ${{ matrix.os }}
16+ runs-on: ${{ matrix.os }}
17+ strategy:
18+ fail-fast: false
19+ matrix:
20+ os: [ubuntu-latest, macos-latest, windows-latest]
21+ steps:
22+ - uses: actions/checkout@v4
23+ - uses: dtolnay/rust-toolchain@stable
24+ - uses: Swatinem/rust-cache@v2
25+ - name: cargo test
26+ run: cargo test --workspace --all-targets
27+
28+ lint:
29+ name: Clippy + fmt
30+ runs-on: ubuntu-latest
31+ steps:
32+ - uses: actions/checkout@v4
33+ - uses: dtolnay/rust-toolchain@stable
34+ with:
35+ components: rustfmt, clippy
36+ - uses: Swatinem/rust-cache@v2
37+ - name: cargo fmt --check
38+ run: cargo fmt --all -- --check
39+ - name: cargo clippy
40+ # Treat warnings as errors. Tests exempted so new tests can land without
41+ # a lint gate blocking them.
42+ run: cargo clippy --workspace --lib --bins -- -D warnings
.github/workflows/playground.ymlnew file+65
@@ -0,0 +1,65 @@
1+name: Deploy Playground to GitHub Pages
2+
3+on:
4+ push:
5+ branches: [master]
6+ workflow_dispatch:
7+
8+permissions:
9+ contents: read
10+ pages: write
11+ id-token: write
12+
13+concurrency:
14+ group: pages
15+ cancel-in-progress: false
16+
17+jobs:
18+ build:
19+ name: Build playground
20+ runs-on: ubuntu-latest
21+ steps:
22+ - uses: actions/checkout@v4
23+
24+ - uses: dtolnay/rust-toolchain@stable
25+ with:
26+ targets: wasm32-unknown-unknown
27+
28+ - uses: Swatinem/rust-cache@v2
29+
30+ - name: Install wasm-bindgen-cli
31+ # Version must match the wasm-bindgen dep in crates/htmlang-wasm/Cargo.toml
32+ run: cargo install wasm-bindgen-cli --version 0.2.114 --locked
33+
34+ - name: Build htmlang-wasm
35+ run: cargo build --release --target wasm32-unknown-unknown -p htmlang-wasm
36+
37+ - name: Generate wasm bindings
38+ run: |
39+ wasm-bindgen --target no-modules --no-typescript \
40+ --out-dir target/wasm-pkg \
41+ target/wasm32-unknown-unknown/release/htmlang_wasm.wasm
42+
43+ - name: Assemble the playground
44+ run: |
45+ mkdir -p dist
46+ cp crates/htmlang-wasm/playground/index.html dist/
47+ cp target/wasm-pkg/htmlang_wasm.js target/wasm-pkg/htmlang_wasm_bg.wasm dist/
48+ cp examples/demo.hl dist/
49+
50+ - name: Upload Pages artifact
51+ uses: actions/upload-pages-artifact@v3
52+ with:
53+ path: dist
54+
55+ deploy:
56+ name: Deploy to GitHub Pages
57+ needs: build
58+ runs-on: ubuntu-latest
59+ environment:
60+ name: github-pages
61+ url: ${{ steps.deployment.outputs.page_url }}
62+ steps:
63+ - name: Deploy
64+ id: deployment
65+ uses: actions/deploy-pages@v4
.github/workflows/release.yml+21−10
@@ -6,6 +6,19 @@ on:
66 workflow_dispatch:
77
88jobs:
9+ version:
10+ name: Compute version
11+ runs-on: ubuntu-latest
12+ outputs:
13+ version: ${{ steps.version.outputs.version }}
14+ steps:
15+ - id: version
16+ run: |
17+ # Semver-compatible calver: YYYY.M.DHHMMSS (no leading zeros, always 3 parts)
18+ VERSION=$(date -u +'%Y.%-m.%-d%H%M%S')
19+ echo "version=$VERSION" >> $GITHUB_OUTPUT
20+ echo "Version: $VERSION"
21+
922 build:
1023 name: Build ${{ matrix.target }}
1124 runs-on: ${{ matrix.os }}
@@ -62,6 +75,7 @@ jobs:
6275 vscode:
6376 name: Build VS Code extension
6477 runs-on: ubuntu-latest
78+ needs: version
6579 steps:
6680 - uses: actions/checkout@v4
6781
@@ -69,6 +83,10 @@ jobs:
6983 with:
7084 node-version: 20
7185
86+ - name: Set extension version
87+ working-directory: editors/vscode
88+ run: npm version ${{ needs.version.outputs.version }} --no-git-tag-version --allow-same-version
89+
7290 - name: Build extension
7391 working-directory: editors/vscode
7492 run: |
@@ -84,7 +102,7 @@ jobs:
84102
85103 release:
86104 name: Create Release
87− needs: [build, vscode]
105+ needs: [version, build, vscode]
88106 runs-on: ubuntu-latest
89107 permissions:
90108 contents: write
@@ -96,13 +114,6 @@ jobs:
96114 with:
97115 path: artifacts
98116
99− - name: Calculate version
100− id: version
101− run: |
102− VERSION=$(date -u +'%Y.%m.%d.%H%M%S')
103− echo "version=$VERSION" >> $GITHUB_OUTPUT
104− echo "Version: $VERSION"
105−
106117 - name: Prepare release assets
107118 run: |
108119 mkdir -p release
@@ -119,8 +130,8 @@ jobs:
119130 - name: Create Release
120131 uses: softprops/action-gh-release@v1
121132 with:
122− tag_name: v${{ steps.version.outputs.version }}
123− name: Release ${{ steps.version.outputs.version }}
133+ tag_name: v${{ needs.version.outputs.version }}
134+ name: Release ${{ needs.version.outputs.version }}
124135 files: release/*
125136 draft: false
126137 prerelease: false
.gitignore+2
@@ -1,2 +1,4 @@
11/target
22*.html
3+!tests/snapshots/*.html
4+!crates/htmlang-wasm/playground/*.html
CONTRIBUTING.mdnew file+167
@@ -0,0 +1,167 @@
1+# Contributing
2+
3+Thanks for your interest in improving htmlang. This file covers the practical
4+bits: how to run the project locally, where the code lives, and what style of
5+changes land smoothly.
6+
7+## Development
8+
9+```
10+cargo build # build the CLI + LSP binaries
11+cargo test # run all tests (unit + snapshot + integration)
12+cargo run -- page.hl # compile a .hl file to page.html
13+cargo run -- serve examples # run the dev server at http://127.0.0.1:3000
14+```
15+
16+CI runs `cargo test`, `cargo fmt --check`, and `cargo clippy -- -D warnings` on
17+Linux, macOS, and Windows. Your change should pass all three.
18+
19+## Repository layout
20+
21+- `crates/htmlang-core/` — parser, AST, code generator. No I/O lives here.
22+ - `syntax.rs` — the syntax tree: every line as written, with spans. The
23+ compiler evaluates it, the formatter prints it back, and the language
24+ server takes definitions, directives and verbatim bodies from it. It
25+ also holds `ESCAPES`, the one escape table of every htmlang string,
26+ and decides where `{@...}` is an inline element: in every line of text
27+ except the text of a `literal` element.
28+ - `parser.rs` — evaluates the tree: definitions, data, loops and
29+ conditions, and the checks over code that doesn't run. Names live in
30+ `Env`, one frame per block, so a definition is visible to the end of
31+ its block and a function keeps the frames of its definition.
32+ - `diagnostic.rs` — `Diagnostic` and the stable diagnostic codes.
33+ - `codegen.rs` — writes the HTML and the CSS. A parent's `Flow` (the
34+ direction its CSS sets, with the changes under media and container
35+ prefixes) is what its children's `fill` and `shrink` compile against;
36+ the rules for a change are keyed on the parent's class in that block.
37+ A page's `<body>` is written like an `@el` whose styles are `@page`'s
38+ (the reset makes it the column), so the top level of a page is laid
39+ out like any column; a fragment's top level has no layout of its own.
40+ Every CSS property goes through one generic path (its name, its value
41+ as written, with `vocab::with_px`'s pixels); only htmlang's layout
42+ words and `line-clamp` have code of their own. Generated classes are
43+ `hl-` + 7 base-36 digits of `stable_hash` of the style
44+ (`CLASS_DIGITS`), so a style has one name in every file, and
45+ `htmlang build` checks no name stands for two styles; an element's
46+ defaults (its layout,
47+ `ElementKind::css`) go with its class, as `:where(.hl-2k9xq0m)`, never a
48+ rule on a global element selector, so `@markdown`/`@raw` HTML and a
49+ page embedding a fragment are untouched. The rules are in cascade
50+ layers (`LAYERS`): `hl-reset`, `hl-kind` (the defaults), `hl-inside`
51+ (element prefixes, `@td:`, each an `@scope` on the class, and
52+ functions' scoped `@style`, written when a function is called) and
53+ `htmlang` (the elements' own styles and `children:`), so which one
54+ wins is the layer's order, not specificity.
55+ A style's prefixes are a `Condition`: its at-rule prefixes (sorted, so
56+ `dark:md:` is `md:dark:`, and written as nested `@media`/`@container`
57+ blocks) and its selector chain (read left to right; an element prefix
58+ splits it into the scope's root and the elements it styles). Each
59+ class keeps one list of (condition, declarations), and every block and
60+ chain is written in one fixed order, never the order of the source.
61+ - `ast.rs` — the element kinds; every plain HTML element is one row in
62+ `TAGS` with its one `Layout` (column, row, grid, text, native or void,
63+ which decides its text lines, `spacing` and its children's layout
64+ words), whether its text is shown as written (`literal`: `@code`,
65+ `@textarea`, whose indented body is verbatim text, HTML-escaped), the
66+ one HTML attribute its first word fills (`arg`: `src`, `action`, ...;
67+ `ElementKind::arg` gives `@link`'s and `@image`'s too) and whether its
68+ body is foreign text written into the page as it is (`verbatim`:
69+ `@script`), and every directive one row in `DIRECTIVES` (its argument
70+ and its kind of body; a verbatim directive's line is its one-line body
71+ or file, and it takes no attributes). The list of
72+ elements is fixed; `HTML_NAMES_WRITTEN_OTHERWISE` maps HTML's `a`, `img`,
73+ `span`, `p` and `div` to htmlang's own names for the unknown-element
74+ suggestion only.
75+ - `vocab.rs` — the attribute vocabulary (htmlang attributes, CSS properties,
76+ HTML attributes, `@page`'s own `favicon`), the pixel rule
77+ (`LENGTH_PROPERTIES`, the one table of properties whose bare numbers
78+ are px, and `with_px`, the one function that applies it) and the
79+ prefixes: `PSEUDOS`, CSS's pseudo-classes and pseudo-elements under
80+ their CSS names, each marked `:`, `::` or taking an argument, in the
81+ order their rules are written; `children:`; element prefixes (`@td:`,
82+ any name; the parser checks it is an element with a tag of its own,
83+ `ElementKind::own_tag`); and the width, media and container prefixes,
84+ with the rank that orders the at-rule blocks. A new pseudo-class is one
85+ row in `PSEUDOS` and one word in DESIGN.md's list.
86+ - `expr.rs` — the expression language for conditions, computed values and
87+ `${...}`. It evaluates only what decides the result (the branch `if()`
88+ takes, the side of `and`/`or` that decides) and only reads the rest.
89+ - `value.rs` — the value types (text, number, true/false, list,
90+ record) and the rules defined once on them: truthiness, comparison,
91+ how numbers and lists print, ranges.
92+ - `interp.rs` — `$name` and `${...}`: where a name ends and how one slot
93+ of text (a text run, an attribute's value, an argument, a path) is
94+ filled in, including what quoted text inserts in CSS and in text. The
95+ one place variables are interpolated.
96+ - `std.hl` — the standard library, written in htmlang and loaded before
97+ every file.
98+- `crates/htmlang-wasm/` — thin wrapper exposing `compile` to the web playground.
99+- `src/` — CLI, dev server and formatter (`fmt.rs`, which prints the syntax
100+ tree back with its comments and blank lines).
101+- `src/bin/htmlang_lsp/` — language server binary (`htmlang-lsp`). Its
102+ completions come from the compiler's tables; hover and completion text live
103+ in `docs.rs`.
104+- `editors/vscode/` — VS Code extension.
105+- `tests/snapshots.rs` — integration / snapshot tests for the compiler.
106+ These tests, and `tests/regressions.rs`, read the output with its
107+ hashed classes numbered (`hl-a`, `hl-b`, ..., see `tests/common`), so a
108+ snapshot changes when a style does, not when a hash does.
109+- `tests/regressions.rs` — one test per fixed bug.
110+- `tests/docs.rs` — compiles every example in `DESIGN.md` and `README.md`,
111+ and every page in `examples/`: any diagnostic fails it.
112+- `tests/fmt.rs` — formats every example and snapshot input: the result is
113+ stable, compiles to the same HTML and keeps every comment.
114+- `examples/` — complete pages: a landing page, a blog, a docs page, and a
115+ tour of the whole language (`demo.hl`).
116+
117+## Adding a feature
118+
119+1. Add a test first. Most language features fit as a new `#[test]` in
120+ `tests/snapshots.rs`; prefer integration tests that exercise the full
121+ parser-to-HTML pipeline. Pure parser / codegen helpers can live as unit
122+ tests alongside the code.
123+2. Prefer the smallest mechanism: a component belongs in `std.hl`, an HTML
124+ element is a row in `TAGS` (and a line in DESIGN.md's table of layouts
125+ and a name in the VS Code grammar's element list, which tests check), and
126+ a CSS property needs no code at all. Only
127+ thread a feature through the parser and codegen when it needs to be, and
128+ describe it in the LSP's `docs.rs`.
129+3. Document it in `DESIGN.md` (the examples there are compiled by the tests).
130+ If it's user-facing, also update `README.md`, and show it in
131+ `examples/demo.hl` if the tour has a section it belongs in.
132+4. If it changes the CLI surface, update the `--help` output.
133+
134+## Style
135+
136+- Prefer enum-based ASTs and pattern matching over stringly-typed dispatch.
137+- Keep `@` prefixes and bracket-attribute syntax consistent with existing
138+ directives. A new `@foo` is a row in `ast::DIRECTIVES`; the parser, the
139+ formatter and the language server read that table, and `tests/editor.rs`
140+ fails when the VS Code grammar's word lists drift from it.
141+- Every diagnostic has a code from `diagnostic::code`; add one there when no
142+ existing code fits, and key tool behavior (quick fixes, tests) on the code
143+ rather than on the message. Put the name the diagnostic is about in
144+ `subject` and a replacement in `suggestion`.
145+- Diagnostics should include `line` and, when practical, `column` and a
146+ `source_line` excerpt. Use `Severity::Help` for suggestions, not `Warning`.
147+- Check names, not values, and never drop input silently. When something
148+ the author wrote can't go into the page, report an error; a warning means
149+ it went into the page as written. Check a CSS value only for what is
150+ wrong in any CSS (see `css_breakout` in `parser.rs`), not against a list
151+ of values the browser may know better.
152+- No unwrap() on parsed user input. Use `Result<_, ParseError>` and record a
153+ diagnostic so the compiler keeps going.
154+
155+## Reporting bugs
156+
157+Bug reports are most useful when they include:
158+
159+- The exact `.hl` input that reproduces the issue (minimized if possible).
160+- The command you ran and the output you saw.
161+- The output you expected instead.
162+- `htmlang --version` and your OS.
163+
164+## License
165+
166+By contributing, you agree that your changes will be licensed under the same
167+terms as the rest of the project.
Cargo.lock+71
@@ -36,6 +36,12 @@ version = "2.11.1"
3636source = "registry+https://github.com/rust-lang/crates.io-index"
3737checksum = "c4512299f36f043ab09a583e57bceb5a5aab7a73db1805848e8fef3c9e8c78b3"
3838
39+[[package]]
40+name = "bumpalo"
41+version = "3.20.2"
42+source = "registry+https://github.com/rust-lang/crates.io-index"
43+checksum = "5d20789868f4b01b2f2caec9f5c4e0213b41e3e5702a50157d699ae31ced2fcb"
44+
3945[[package]]
4046name = "bytes"
4147version = "1.11.1"
@@ -187,11 +193,25 @@ checksum = "e5274423e17b7c9fc20b6e7e208532f9b19825d82dfd615708b70edd83df41f1"
187193name = "htmlang"
188194version = "0.1.0"
189195dependencies = [
196+ "htmlang-core",
190197 "notify",
198+ "serde_json",
191199 "tokio",
192200 "tower-lsp",
193201]
194202
203+[[package]]
204+name = "htmlang-core"
205+version = "0.1.0"
206+
207+[[package]]
208+name = "htmlang-wasm"
209+version = "0.1.0"
210+dependencies = [
211+ "htmlang-core",
212+ "wasm-bindgen",
213+]
214+
195215[[package]]
196216name = "httparse"
197217version = "1.10.1"
@@ -556,6 +576,12 @@ dependencies = [
556576 "bitflags 2.11.1",
557577]
558578
579+[[package]]
580+name = "rustversion"
581+version = "1.0.22"
582+source = "registry+https://github.com/rust-lang/crates.io-index"
583+checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d"
584+
559585[[package]]
560586name = "same-file"
561587version = "1.0.6"
@@ -856,6 +882,51 @@ version = "0.11.1+wasi-snapshot-preview1"
856882source = "registry+https://github.com/rust-lang/crates.io-index"
857883checksum = "ccf3ec651a847eb01de73ccad15eb7d99f80485de043efb2f370cd654f4ea44b"
858884
885+[[package]]
886+name = "wasm-bindgen"
887+version = "0.2.114"
888+source = "registry+https://github.com/rust-lang/crates.io-index"
889+checksum = "6532f9a5c1ece3798cb1c2cfdba640b9b3ba884f5db45973a6f442510a87d38e"
890+dependencies = [
891+ "cfg-if",
892+ "once_cell",
893+ "rustversion",
894+ "wasm-bindgen-macro",
895+ "wasm-bindgen-shared",
896+]
897+
898+[[package]]
899+name = "wasm-bindgen-macro"
900+version = "0.2.114"
901+source = "registry+https://github.com/rust-lang/crates.io-index"
902+checksum = "18a2d50fcf105fb33bb15f00e7a77b772945a2ee45dcf454961fd843e74c18e6"
903+dependencies = [
904+ "quote",
905+ "wasm-bindgen-macro-support",
906+]
907+
908+[[package]]
909+name = "wasm-bindgen-macro-support"
910+version = "0.2.114"
911+source = "registry+https://github.com/rust-lang/crates.io-index"
912+checksum = "03ce4caeaac547cdf713d280eda22a730824dd11e6b8c3ca9e42247b25c631e3"
913+dependencies = [
914+ "bumpalo",
915+ "proc-macro2",
916+ "quote",
917+ "syn",
918+ "wasm-bindgen-shared",
919+]
920+
921+[[package]]
922+name = "wasm-bindgen-shared"
923+version = "0.2.114"
924+source = "registry+https://github.com/rust-lang/crates.io-index"
925+checksum = "75a326b8c223ee17883a4251907455a2431acc2791c98c26279376490c378c16"
926+dependencies = [
927+ "unicode-ident",
928+]
929+
859930[[package]]
860931name = "winapi-util"
861932version = "0.1.11"
Cargo.toml+11−1
@@ -1,3 +1,6 @@
1+[workspace]
2+members = [".", "crates/htmlang-core", "crates/htmlang-wasm"]
3+
14[package]
25name = "htmlang"
36version = "0.1.0"
@@ -8,6 +11,13 @@ name = "htmlang-lsp"
811path = "src/bin/htmlang_lsp/main.rs"
912
1013[dependencies]
14+htmlang-core = { path = "crates/htmlang-core" }
1115notify = "7"
12−tokio = { version = "1", features = ["io-std", "io-util", "macros", "net", "rt-multi-thread", "sync"] }
16+serde_json = "1"
17+tokio = { version = "1", features = ["io-std", "io-util", "macros", "net", "rt-multi-thread", "sync", "time"] }
1318tower-lsp = "0.20"
19+
20+[profile.release]
21+opt-level = "s"
22+lto = true
23+strip = true
DESIGN.md+1488−1089
@@ -1,1220 +1,1619 @@
1−# htmlang (.hl)
1+# htmlang language reference
22
3−A minimalist layout language inspired by elm-ui that compiles to static HTML.
3+htmlang is a small layout language that compiles to static HTML. A page is a
4+tree of elements written one per line, with indentation for nesting:
5+
6+```
7+@page Hello
8+@el [width fill, max-width 640, center-x, padding 40, spacing 16]
9+ @h1 Hello
10+ @paragraph
11+ This page was written in {@b htmlang}.
12+```
13+
14+Every example block in this file is compiled by the test suite
15+(`tests/docs.rs`), so the examples stay correct.
416
517## Principles
618
7−- `@` means structure, bare lines mean content
8−- Layout is explicit and compositional — no CSS cascade
9−- Every element declares its own layout role
10−- Output is a self-contained HTML file with embedded CSS (flexbox)
11−
12−## Elements
13−
14−| Element | Output | Purpose |
15−|--------------|------------------|--------------------------------|
16−| `@row` | flex row | Horizontal layout |
17−| `@column` | flex column | Vertical layout |
18−| `@el` | div | Generic container |
19−| `@text` | span | Styled inline text |
20−| `@paragraph` | p with spans | Flowing/wrapping inline text |
21−| `@image` | img | Image |
22−| `@link` | a | Anchor wrapping children |
23−| `@raw` | verbatim HTML | Escape hatch |
24−| `@nav` | nav | Navigation landmark |
25−| `@header` | header | Page/section header |
26−| `@footer` | footer | Page/section footer |
27−| `@main` | main | Main content area |
28−| `@section` | section | Thematic section |
29−| `@article` | article | Self-contained content |
30−| `@aside` | aside | Sidebar/tangential content |
31−| `@list` | ul/ol | List (`[ordered]` for ol) |
32−| `@item` | li | List item |
33−| `@table` | table | Table |
34−| `@thead` | thead | Table head group |
35−| `@tbody` | tbody | Table body group |
36−| `@tr` | tr | Table row |
37−| `@td` | td | Table cell |
38−| `@th` | th | Table header cell |
39−| `@video` | video | Video element |
40−| `@audio` | audio | Audio element |
41−| `@form` | form | Form container |
42−| `@details` | details | Disclosure widget |
43−| `@summary` | summary | Summary for `@details` |
44−| `@blockquote`| blockquote | Block quotation |
45−| `@cite` | cite | Citation/source reference |
46−| `@code` | code | Inline code (monospace) |
47−| `@pre` | pre | Preformatted text |
48−| `@hr` | hr | Horizontal rule (self-closing) |
49−| `@figure` | figure | Figure with optional caption |
50−| `@figcaption`| figcaption | Caption for `@figure` |
51−| `@progress` | progress | Progress bar |
52−| `@meter` | meter | Meter/gauge element |
53−| `@iframe` | iframe | Embedded external page |
54−| `@output` | output | Form calculation result |
55−| `@canvas` | canvas | Drawing surface for scripts |
56−
57−| `@script` | script | JavaScript (inline or external) |
58−| `@noscript` | noscript | Fallback when JS is disabled |
59−| `@address` | address | Contact information |
60−| `@search` | search | Search landmark (HTML5) |
61−| `@breadcrumb` | nav>ol | Semantic breadcrumb navigation |
62−
63−Bare lines (not starting with `@` or `[`) are text nodes.
19+- **`@` starts structure, and any other line is content.** An element is `@name`,
20+ and a line without `@` is text.
21+- **htmlang's own vocabulary is about layout.** It comes from elm-ui. An
22+ element is a row, a column, a grid or text (or keeps HTML's own layout),
23+ `spacing` sets the gap between its children,
24+ and each child says how it sits in its parent (`width fill`, `center-x`,
25+ `align-right`). The layout attributes are the only styling words htmlang
26+ adds.
27+- **Everything else is CSS or HTML, under its own name.** A style is any CSS
28+ property with a CSS value. An element that isn't about layout or text has
29+ its HTML name, and an HTML attribute is written `key=value`. Nothing is
30+ renamed or abbreviated.
31+- **Each thing is done one way.** `@let` defines every reusable piece, `@data`
32+ loads data, `@include` brings in a file, and `if()` makes an attribute
33+ conditional. A layout is an ordinary function.
34+- **The output is what you wrote.** Each page compiles to one self-contained
35+ HTML file. Its CSS is inside, and it has no JavaScript unless you write
36+ some. The compiler doesn't add attributes, tags or rewritten values that
37+ the source doesn't ask for, and it doesn't leave out anything you wrote:
38+ what can't go into the page is an error. The one exception is a style
39+ whose value comes out empty, such as an optional field a record doesn't
40+ have: it is simply not written.
41+- **Everything runs at compile time.** Variables, expressions, loops and
42+ conditions are resolved when the page is built. What CSS computes in the
43+ browser (`var()`, `calc()`, `color-mix()`) stays CSS, written as it is.
6444
6545## Syntax
6646
67−### Basic structure
47+### Elements
6848
6949```
70−@element [attributes]
50+@element [attributes] argument
7151 children
7252```
7353
74−Children are indented under their parent. Attributes are optional, comma-separated inside `[...]`. Attribute lists can span multiple lines:
54+Children are indented under their parent, with spaces or with tabs (a
55+tab counts as one space, so a file that mixes them is a warning).
56+Attributes go inside `[...]`,
57+separated by commas, and the list may span several lines:
7558
7659```
7760@el [
7861 padding 20,
7962 background white,
80− rounded 8,
81− shadow 0 2px 4px rgba(0,0,0,0.1)
63+ border-radius 8,
64+ box-shadow 0 2 4 rgba(0,0,0,0.1)
8265]
8366 Content
8467```
8568
86−### Full example
69+An attribute can take one of three forms:
8770
88−```
89−-- My Site
90−@page My Site
91−@let primary #3b82f6
92−@let gap 20
93−@define card [
94− padding 20,
95− background white,
96− rounded 8,
97− border 1 #e5e7eb,
98− shadow 0 2px 4px rgba(0,0,0,0.05)
99−]
100−
101−@include header.hl
71+- `key value` is a **style**: a layout attribute or a CSS property
72+ (`spacing 20`, `color red`).
73+- `key=value` is an **HTML attribute** (`id=main`, `type=email`,
74+ `aria-label=Close`).
75+- A bare word is a **flag**: a layout attribute such as `center-x`, a
76+ boolean HTML attribute such as `required`, `disabled`, `hidden` or `open`,
77+ or a `data-` or `hx-` attribute that has no value (`data-open`,
78+ `hx-preserve`).
10279
103−@column [max-width 800, center-x, padding 40, spacing $gap]
104− @row [spacing $gap]
105− @column [width fill, spacing 10]
106− @text [bold, size 32] Welcome
107− @paragraph [line-height 1.6]
108− This is a page built with {@text [bold, color $primary] htmlang}.
109− Read the {@link https://docs.example.com docs} to learn more.
110− @image [width 80, height 80, rounded 40] avatar.png
80+A comma inside `(...)`, `[...]` or `"..."` doesn't split attributes. Anywhere else,
81+`\,` keeps a comma in the value:
11182
112− -- cards
113− @row [wrap, spacing 10]
114− [$card]
115− First card
116− [$card, background #f9fafb]
117− Second card
118−
119− -- footer
120− @row [spacing 10]
121− @el [padding 16, background $primary, rounded 8] > @link https://example.com
122− @text [color white] Get Started
123− @el [width fill]
124− @text [color #888, text-align right] © 2026
125−
126− @raw """
127− <canvas id="chart"></canvas>
128− """
12983```
130−
131−## Directives
132−
133−### `@page`
134−
135−Sets the HTML `<title>` and generates boilerplate (`<!DOCTYPE>`, `<html>`, `<head>`, `<body>`).
136−
84+@el [transition opacity 0.3s\, transform 0.3s, font-family "Open Sans"\, sans-serif]
85+@el [hx-get=/news, hx-trigger=load\, every 60s]
13786```
138−@page My Site
139−```
140−
141−### `@let`
14287
143−Defines a variable. Referenced with `$name`.
88+Right after a `key=value`, a name htmlang doesn't know is most likely the
89+rest of that value, which a comma ended: `[hx-trigger=load, every 60s]` is
90+an error (`split-value`) that shows the value written with `\,`.
14491
145−```
146−@let primary #3b82f6
147−@let gap 20
92+An attribute given twice, by a bundle and after it, by a function and its
93+call, or written twice, takes the later value. An HTML attribute is
94+written once, with that value.
14895
149−@el [background $primary, spacing $gap]
150−```
96+A variable fills an attribute's value (`padding $gap`, `alt=$title`), never
97+its name or a whole attribute: attributes come from a
98+[bundle](#definitions), written `[$card]`, and a condition chooses whole
99+attributes with [`if()`](#conditional-attributes).
151100
152−Quoted values support string interpolation:
101+The attribute list belongs to the element name right before it. Anywhere
102+else, `[` is an ordinary character, so a line of text can contain one:
153103
154104```
155−@let name World
156−@let greeting "Hello $name" -- "Hello World"
157−@let base /api
158−@let url "$base/users" -- "/api/users"
105+@text Use [ to open a list
106+@paragraph Arrays look like [1, 2, 3].
159107```
160108
161−### `@include`
162−
163−Inlines another `.hl` file. The path is resolved relative to the current file. Variables defined with `@let`, attribute bundles from `@define`, and functions from `@fn` in the included file are available after the `@include` line.
164−
165−```
166−@include header.hl
167−@include components/card.hl
168−```
109+### Text
169110
170−Variables can be used in the filename:
111+A line that doesn't start with `@` is text. Text after an element's
112+attributes is the element's content: its first line of text, read like any
113+other. Inside a line of text, `{...}` holds an inline element, and
114+[escapes](#escapes) and [`$names`](#variables) work:
171115
172116```
173−@let component card
174−@include $component.hl
175−```
176−
177−Circular includes are detected and reported as errors. Nested includes are supported.
178−
179−### `@import`
180−
181−Like `@include`, but only imports definitions (`@let`, `@define`, `@fn`) without emitting DOM nodes. Use this for shared theme/component libraries.
182−
183−```
184−@import theme.hl -- imports variables, defines, functions only
185−@include header.hl -- inlines everything including DOM nodes
186−```
187−
188−### `@data`
189−
190−Loads a JSON file and makes its values available as template variables. Useful for data-driven static sites.
191−
192−```
193−@data site.json -- top-level object keys become variables
194−@data $posts data/posts.json -- load with a prefix
195−```
196−
197−For a JSON file like:
198−```json
199−{
200− "title": "My Site",
201− "tags": ["rust", "html", "css"],
202− "links": [
203− {"label": "Home", "url": "/"},
204− {"label": "About", "url": "/about"}
205− ]
206−}
207−```
208−
209−Without prefix (`@data site.json`):
210−- `$title` → `"My Site"`
211−- `$tags` → iterable with `@each`
212−- `$links` → destructurable: `@each $label, $url in $links`
213−
214−With prefix (`@data $site site.json`):
215−- `$site.title` → `"My Site"`
216−- `$site.tags` → iterable
217−- `$site.links` → destructurable
218−
219−Arrays of objects are automatically formatted for `@each` destructuring. Indexed access is also available: `$links.0.label`, `$links.1.url`, etc. The count is available as `$links._count`.
220−
221−### `@meta`
222−
223−Adds a `<meta>` tag to the document `<head>`. Requires `@page`.
224−
225−```
226−@meta description A portfolio site
227−@meta og:image https://example.com/preview.png
228−```
229−
230−### `@head`
231−
232−Adds raw content to the document `<head>`. Use for external fonts, favicons, or custom CSS/JS.
233−
234−```
235−@head
236− <link rel="icon" href="favicon.ico">
237− <link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Inter">
238−```
239−
240−### `@define`
241−
242−Creates a named attribute bundle. Referenced with `$name` inside attribute lists.
243−
244−```
245−@define card [padding 20, background white, rounded 8, border 1 #e5e7eb]
246−
247−@el [$card]
248− Content
249−@el [$card, background #f9fafb]
250− Overridden background
251−```
252−
253−Attributes listed after `$name` override those in the definition.
254−
255−### `@mixin`
256−
257−Creates a composable style group. Like `@define`, but intended for reusable style patterns. Referenced with `...$name` (spread syntax) or `$name` inside attribute lists.
258−
259−```
260−@mixin card-style [padding 20, rounded 8, background white]
261−@mixin interactive [cursor pointer, hover:background #e5e7eb, transition all 0.15s ease]
262−
263−@el [...$card-style, ...$interactive, border 1 #ccc]
264− Composed styles from two mixins
265−```
266−
267−### `@assert`
268−
269−Compile-time assertion. If the condition is false, a compile error is emitted. Useful for enforcing design system constraints.
270−
271−```
272−@let spacing 16
273−@let primary #3b82f6
274−
275−@assert $spacing == 16
276−@assert $primary != red
277−```
278−
279−### `@fn`
280−
281−Defines a pure function (reusable component). Parameters are prefixed with `$`. Default values can be specified with `=`.
282−
283−```
284−@fn card $title $variant=primary
285− @el [padding 20, background white, rounded 8, border 1 #e5e7eb]
286− @text [bold, size 18] $title
287− @children
288−```
289−
290−Call it like any element, passing parameters in `[...]`:
291−
292−```
293−@card [title Hello World]
294− This is the card body.
295− @text [italic] With styled text.
296−
297−@card [title Warning, variant danger]
298− Overridden variant.
299−```
300−
301−Parameters with defaults can be omitted in calls — the default value is used.
302−
303−### `@children`
304−
305−A slot inside a function body that expands to the caller's indented children.
306−
307−```
308−@fn layout $title
309− @column [max-width 800, center-x, padding 40]
310− @text [bold, size 32] $title
311− @children
312−
313−@layout [title My Page]
314− @row [spacing 10]
315− Content goes here
316−```
317−
318−Functions can call other functions. `@let` and `@define` variables are available inside function bodies. Function parameters shadow `@let` variables of the same name within the body.
319−
320−## Text
321−
322−### Bare text
323−
324−Any line not starting with `@` or `[` is a text node.
117+@paragraph
118+ This is {@strong important}, and this is {@link https://example.com a link}.
119+@text [font-weight bold, font-size 24, color #333] Hello world
120+@h2 Welcome to {@text [color #3b82f6] htmlang}
121+@ul
122+ @li Read {@link /docs the docs}
123+@section [padding 8] Text after the attributes is content too.
124+```
125+
126+How an element's lines combine is its [layout](#rows-columns-and-text)'s
127+business: in a row or column each line is a child; in a text element lines
128+flow. Text that `@if`, `@each`, `@fragment` or a function writes counts as
129+lines written in its place, so in a text element it flows with the rest,
130+joined with a space, and in a native element it is on lines of its own.
131+
132+The text of `@code` and `@textarea` is shown as written. On its line and
133+inline, a `{@...}` in it is text, while escapes and `$names` still work.
134+The lines indented under it are a [verbatim](#verbatim-bodies) sample:
135+nothing in them is htmlang (`@`, `$`, `{`, `\` and `--` are text), and
136+they are HTML-escaped with their line breaks and indentation kept. This
137+is how a page shows code, htmlang included. `@pre` is an ordinary element,
138+so `@pre > @code` is HTML's `<pre><code>`, and a function can wrap `@pre`
139+around a sample. A sample is text on the line or lines in the block, not
140+both.
325141
326142```
327−@column
328− Hello world
329− This is just text
143+@paragraph
144+ Write {@code {@link /docs docs}} for a link.
145+@pre [padding 16] > @code
146+ @el [padding 40]
147+ <b>shown as text</b>
148+@textarea [aria-label=Notes]
149+ First line
150+ Second line, indented
330151```
331152
332−### Styled text
153+A sample in the block has no `$names`, so a version number in it can't
154+come from a variable; a one-line sample on `@code`'s own line can
155+(`@code cargo install htmlang@$version`).
333156
334−Use `@text` when you need attributes.
157+### Escapes
335158
336−```
337−@text [bold, size 24, color #333] Hello world
338−```
159+A backslash before one of these characters stands for the character itself.
160+The table is the same in every htmlang string: text, arguments, attribute
161+values, `@let`, `@page` and `@meta`.
339162
340−### Inline elements
163+| Escape | Writes | For |
164+|---|---|---|
165+| `\@`, `\--` | `@`, `--` | a line of text that starts with `@` or `--` |
166+| `\$` | `$` | a `$` before a name, which would start a variable |
167+| `\{`, `\}` | `{`, `}` | braces that don't start or end an inline element |
168+| `\[`, `\]` | `[`, `]` | brackets that don't open or close an attribute list; a `'...'` in a value (`alert(']')`) doesn't hide one, so a list that seems to end inside one is reported (`unbalanced-quote`) |
169+| `\,` | `,` | a comma in an attribute's value |
170+| `\"` | `"` | a quote that doesn't start or end quoted text |
171+| `\\` | `\` | a backslash before one of these characters |
341172
342−Use `{...}` to embed elements inside text lines. Essential for mixed-style paragraphs.
173+A backslash before any other character is kept as written, so CSS's own
174+escapes and patterns pass through: `before:content "\201C"`,
175+`pattern=\d{3}`. A `$` that isn't followed by a letter or `_` is text
176+anyway: `$5`, `$$`.
343177
344178```
345−@paragraph
346− This is {@text [bold] important} and this is a {@link https://example.com link}.
179+\@htmlang on social media
180+@let price 5
181+@paragraph \$price is $price dollars: {@mark \{braces\}}, \[brackets\] and a comma\, too
182+@input [type=text, pattern=\d{3}-\d{4}, title=Costs \$5]
347183```
348184
349−## Comments
185+### Comments
350186
351−`--` starts a comment. The rest of the line is ignored.
187+A line whose first word is `--` is a comment: `--` followed by a space, or
188+alone on its line. A comment must be on its own line, because `--` later in
189+a line is ordinary text. A comment may sit between the lines of an attribute
190+list, and `--name` with no space is not a comment but a
191+[custom property](#custom-properties), so it can start a line of a list
192+(anywhere else, a line starting `--name` or `---` is text).
352193
353194```
354195-- this is a comment
355196@row [spacing 10]
356− -- todo: add nav items
357−```
358−
359−## Implicit `@el`
360−
361−A line starting with `[` (attributes) that has indented children is an anonymous container (implicit `@el`).
362−
363−```
364−[padding 20, background white]
365− Hello
366−
367−-- equivalent to:
368−@el [padding 20, background white]
369− Hello
197+ -- todo: more nav items
198+ @link / Home
199+@el [
200+ -- the gap, wider on larger screens
201+ --gap 12px,
202+ md:--gap 24px,
203+ spacing var(--gap)
204+]
205+ @text One
206+ @text Two
370207```
371208
372−## Single-child chaining
209+### Chains
373210
374−Use `>` to chain single-child elements on one line, reducing nesting depth.
211+`>` puts elements that have one child each on one line. The last element in
212+the chain gets the indented children. A `>` is a chain only between two
213+elements (`@name [attributes]`); in text it is just a character. A
214+function call can be a link of a chain, like any element. After an
215+element's leading argument (`@link /about`) the rest of the line is text,
216+so a link around an image is `@link [href=/] > @image logo.png` (the
217+compiler warns when `> @name` follows a leading argument).
375218
376219```
377−@el [padding 16, background blue, rounded 8] > @link https://example.com
220+@el [padding 16, background blue, border-radius 8] > @link https://example.com
378221 @text [color white] Get Started
379−
380−-- equivalent to:
381−@el [padding 16, background blue, rounded 8]
382− @link https://example.com
383− @text [color white] Get Started
384−```
385−
386−The last element in the chain takes the indented children.
387−
388−## `@raw`
389−
390−Triple-quoted block pasted verbatim into output. Use for arbitrary HTML, CSS, or JS.
391−
392−```
393−@raw """
394−<style>
395− @keyframes spin { to { transform: rotate(360deg); } }
396−</style>
397−<div class="custom-widget"></div>
398−"""
399222```
400223
401−## Units
402−
403−All numeric values default to pixels. You can use CSS units explicitly:
404−
405−```
406−@el [width 50%, height 100vh, padding 2rem, max-width 80ch, size 1.2em]
407−```
408−
409−Supported units: `%`, `rem`, `em`, `vh`, `vw`, `vmin`, `vmax`, `dvh`, `svh`, `ch`, `ex`, `cm`, `mm`, `in`, `pt`, `pc`, `fr`.
410−
411−## New elements
412−
413−### `@form`
414−
415−Form container. Argument is the `action` URL.
416−
417−```
418−@form [method post] /submit
419− @label [for email] Email
420− @input [type email, name email, required]
421− @button [type submit] Send
422−```
423−
424−### `@details` / `@summary`
425−
426−Native disclosure widget. Use `[open]` to expand by default.
427−
428−```
429−@details [open]
430− @summary FAQ Question
431− @text The answer is here.
432−```
433−
434−### `@blockquote` / `@cite`
435−
436−Semantic quotation with optional citation.
437−
438−```
439−@blockquote [padding 20, border-left 4 #ccc]
440− @text To be or not to be
441− @cite Shakespeare
442−```
443−
444−### `@code` / `@pre`
445−
446−Code and preformatted text. `@code` renders as `<code>` with monospace font. `@pre` preserves whitespace.
447−
448−```
449−@pre
450− @code console.log("hello")
451−```
224+### Verbatim bodies
225+
226+The bodies of `@raw`, `@style`, `@head`, `@markdown`, `@script`, `@code`
227+and `@textarea` are foreign text, kept exactly as written: nothing in them
228+is parsed as htmlang, and a `--` line in them is not a comment. `@raw`
229+writes its HTML into the page, `@style` its CSS and `@head` its HTML into
230+the `<head>`; `@code` and `@textarea` show theirs as text. Which lines are
231+verbatim is decided by the element or directive on the line, also at the
232+end of a chain (`@pre > @code`, `@el > @script`).
233+
234+The header's line follows one rule. For `@raw`, `@style` and `@head`, text
235+on the line is a one-line body; for `@markdown` it is the file and for
236+`@script` the `src`. Text on the line and an indented body together are an
237+error. Only `@script` takes attributes: an attribute list on `@raw`,
238+`@style`, `@head` or `@markdown` is an error, so content that starts with
239+`[` (a CSS attribute selector) goes in the indented block.
240+
241+```
242+@raw <hr class="fancy">
243+@raw
244+ <div class="custom-widget">
245+ <span>Hand-written HTML</span>
246+ </div>
247+@style .note { color: gray; }
248+```
249+
250+### Directives
251+
252+A directive is a built-in word that isn't an element. Each one takes a
253+fixed kind of argument and a fixed kind of body. `@page` is the one
254+directive that is also an element: it stands for the page's root, `<body>`,
255+whose content is the rest of the file (see [Page and head](#page-and-head)).
256+
257+| Directive | Argument | Body |
258+|---|---|---|
259+| `@page` | attributes (styles for `<body>`, `key=value` for `<html>`) and a title | none |
260+| `@let` | a name and a value or bundle, or `@name` and parameters | a function's body |
261+| `@include` | a file | none |
262+| `@data` | a variable and a source | none |
263+| `@meta` | a name and a value | none |
264+| `@if`, `@else`, `@each` | a condition or a loop | htmlang |
265+| `@raw`, `@style`, `@head` | the rest of the line: a one-line body | verbatim, instead of the line |
266+| `@markdown` | a file | verbatim Markdown, instead of the file |
267+
268+An indented line under a directive that takes no body is an error, because
269+it would otherwise silently become a sibling.
270+
271+### Diagnostics
272+
273+The compiler checks the whole file, including code that doesn't run: the
274+branch of an `@if` or an `if()` that isn't taken, the body of a function that is never
275+called and the body of a loop over an empty list. Unknown elements,
276+functions, attributes and prefixes are reported there too. In code that
277+doesn't run, a call is checked against every function in the file and the
278+files it includes; where the code runs, a name is looked up where it is
279+written, so a function's body sees only what is defined above the function
280+(a call to a function defined further down is reported when the body
281+runs, and two functions can't call each other). A `$name` is checked only
282+where the code runs, since any of them may come from data: an undefined
283+variable in a branch that isn't taken, or in a function that is never
284+called, isn't reported.
285+
286+**Names are checked, and values are CSS's.** A misspelled element, prefix,
287+parameter or slot is an error, and so is an undefined variable. A CSS
288+property htmlang doesn't know, but whose name CSS could have, is written to
289+the CSS as it is, with a warning that suggests the closest known name
290+(`text-grow`, or `colr`, which asks "did you mean `color`?"). Values go to
291+the CSS as written, so the browser decides what `z-index auto` or `color
292+rebeccapurple` means; only what is wrong in any CSS is reported (see
293+[CSS properties](#css-properties)).
294+
295+**Nothing you write is left out silently.** An error means something
296+couldn't go into the page: a flag htmlang doesn't know, an attribute
297+`@fragment` has no element for, content for a function without
298+`@children`. A warning means it went into the page as written, but may not
299+be what you meant. A warning is reported once, even from a line that runs
300+many times in a loop or a function.
301+
302+Every diagnostic has a stable code, such as `unknown-element` or
303+`unused-variable`. The command line prints it as `error[unknown-element]`,
304+`--format json` has it in a `code` field, and the editor's quick fixes are
305+keyed on it.
306+
307+## Layout
308+
309+### Rows, columns and text
310+
311+Every element has one layout, which decides what the lines written inside
312+it are. **In a row or column each line is a child; in a text element lines
313+flow.**
314+
315+| Layout | Elements | What is inside it |
316+|---|---|---|
317+| column | `@el`, and the containers: `@section`, `@nav`, `@form`, `@ul`, `@li`, ... | Each line of text is a child of its own, and the children are laid out top to bottom (side by side with `flex-direction row`) |
318+| row | `@row` | The same, side by side |
319+| grid | `@grid` | Each line of text is a cell |
320+| text | `@paragraph`, `@text`, `@link`, `@h1` … `@h6`, `@button`, `@label`, `@td`, `@strong`, `@em`, ... | The argument, the lines and the children flow as one run of text, joined with spaces |
321+| native | `@table`, `@caption`, `@select`, `@pre`, `@textarea`, `@video`, ... | HTML's own layout, which htmlang leaves alone |
322+| void | `@input`, `@hr`, `@br`, `@image`, `@source` | Nothing: it takes no content |
323+
324+The table under [HTML elements](#html-elements) gives every element's layout. The
325+page itself is a column too: `@page` is the [root element](#page-and-head),
326+`<body>`, so what is written at the top of a page stacks like the children
327+of an `@el`, `height fill` there takes the rest of the window and
328+`center-y` centres in it.
329+
330+```
331+@el [spacing 4]
332+ First line
333+ Second line
334+@button [type=button]
335+ Save
336+ changes
337+```
338+
339+The column shows two lines 4px apart; the button says "Save changes".
340+
341+These attributes are htmlang's own. They describe how an element lays out
342+its children, and how it sits in its parent:
452343
453−### `@hr`
454−
455−Horizontal rule / divider (self-closing). Alias: `@divider`.
456−
457−```
458−@hr [border-top 1 #e5e7eb]
459−```
460−
461−### `@figure` / `@figcaption`
462−
463−Figure with optional caption.
464−
465−```
466−@figure
467− @image [alt Sunset, width fill] sunset.jpg
468− @figcaption A beautiful sunset
469−```
470−
471−### `@progress` / `@meter`
472−
473−Progress bar and meter elements. Use `value`, `max`, `min` attributes.
474−
475−```
476−@progress [value 70, max 100]
477−@meter [value 6, min 0, max 10, low 3, high 8]
478−```
479−
480−## `@each` destructuring
481−
482−When `@each` has more than one variable and items contain spaces, values are destructured:
483−
484−```
485−@each $name, $url in Home /, About /about, Contact /contact
486− @link $url $name
487−```
488−
489−`var()` and `calc()` expressions are also passed through as-is.
490−
491−## `@each` with `@else`
492−
493−When the list is empty, the `@else` block is rendered as a fallback:
494−
495−```
496−@each $item in $items
497− @text $item
498−@else
499− @text [color #888] No items found.
500−```
501−
502−## `@iframe`
503−
504−Embedded external page. Argument is the `src` URL.
505−
506−```
507−@iframe [width fill, height 400, sandbox] https://example.com
508−```
509−
510−Attributes: `sandbox`, `allow`, `allowfullscreen`, `referrerpolicy`.
511−
512−## `@canvas`
513−
514−Drawing surface for JavaScript. Use with `@raw` for scripts.
515−
516−```
517−@canvas [width 400, height 300, id chart]
518−```
519−
520−## `@output`
521−
522−Form output element for displaying calculation results.
523−
524−```
525−@output [for a b] Result
526−```
527−
528−## Pseudo-elements
529−
530−Prefix any style attribute with `before:` or `after:` to apply it to the `::before` or `::after` pseudo-element. Use with `content` to set the generated content.
344+| Attribute | Effect |
345+|---|---|
346+| `spacing N` | Gap between children |
347+| `width fill` / `width shrink` / `width N` | In a row, take the remaining width or keep the content's width; in a column or anywhere else, take the full width or fit the content; or an exact size |
348+| `height fill` / `height shrink` / `height N` | In a column, take the remaining height or keep the content's height; in a row or anywhere else, take the full height or fit the content; or an exact size |
349+| `center-x`, `center-y` | Center the element in its parent (auto margins) |
350+| `align-left`, `align-right`, `align-top`, `align-bottom` | Align the element in its parent (an auto margin on the other side) |
351+| `wrap` | Let a row wrap onto more lines |
352+| `grid-cols N`, `grid-rows N` | Equal grid columns or rows (on `@grid`); any other value is a track list, as in `grid-template-columns` (`grid-cols 200 1fr`) |
353+| `col-span N`, `row-span N` | Cells a grid child spans |
354+
355+`spacing`, `wrap`, `grid-cols` and `grid-rows` lay out an element's
356+children, so they go on a row, column or grid. On a text, native or void
357+element they are an error: text has no gap between its lines. For a flex
358+layout of your own on such an element, write the CSS (`@label [display
359+flex, gap 8]`).
360+
361+A child's `fill` and `shrink` follow the direction its parent's CSS
362+actually sets: a row for `@row`, a column for `@el` and the other columns,
363+or whatever the parent's own `flex-direction` (or `flex-flow`) says. Along
364+that direction, `fill` takes the remaining space and `shrink` keeps the
365+content's size; across it, `fill` is the full size and `shrink` fits the
366+content. `center-x`, `center-y` and `align-*` are auto margins, which work
367+in either direction; a `margin` on the same element keeps its other sides
368+(`[center-x, margin 20]`). A layout word never overrides a CSS property
369+the element writes itself: `[width fill, min-width 200]` keeps its 200px,
370+and `[flex-shrink 0, width fill]` still grows but never shrinks.
371+
372+```
373+@row [spacing 8]
374+ @el [width fill, padding 12, background #f3f4f6] Fills the row
375+ @el [width 120, padding 12, background #e5e7eb] 120px
376+@el [height 200, spacing 8, background #f9fafb]
377+ @text [center-x] Centered
378+ @el [height fill, background #dbeafe] Fills the rest of the column
379+ @text [align-right] Right-aligned
380+@nav [flex-direction row, spacing 20]
381+ @link /features Features
382+ @el [width fill]
383+ @link /signup Sign up
384+@grid [grid-cols 3, spacing 8, md:grid-cols 4]
385+ @el [col-span 2, background #fef3c7] Two columns wide
386+ @el [background #fde68a] One
387+ @el [background #fcd34d] One
388+```
389+
390+A direction set under media or container prefixes (`md:flex-direction
391+row`, `print:`, `cq-md:`, or a stack of them such as `md:dark:`) switches
392+the children's `fill` and `shrink` in that same condition. As in elm-ui, whose child rules are keyed on the
393+parent's class (`.r > .wf`), each child gets a rule keyed on its parent's
394+class in the parent's `@media` or `@container` block. A width prefix holds
395+from its width up, so `sm:flex-direction column` still applies at `lg:`
396+unless `lg:` sets a direction of its own. A direction under a state prefix
397+(`hover:`, `first-child:`, `children:`, or a stack with one in it) leaves the
398+children's layout words as they are.
399+
400+```
401+@header [spacing 16, md:flex-direction row, md:align-items center]
402+ @text [font-weight 800] Launchpad
403+ @el [width fill]
404+ @nav [flex-direction row, spacing 20]
405+ @link /features Features
406+ @link /pricing Pricing
407+@section [padding 24]
408+ @el [width fill, max-width 800, center-x, spacing 16]
409+ The full width up to 800px, in the middle
410+```
411+
412+On a phone the header is a column and its `@el [width fill]` is the full
413+width; from md up it is a row and the `@el` takes the free space, pushing
414+the navigation to the right. The section's `@el` is the usual centred
415+column: the full width, at most 800px, with auto margins on both sides.
416+
417+Everything else about layout is plain CSS: `justify-content`, `align-items`,
418+`flex 1 1 240px`, `grid-template-areas`, `position`.
419+
420+### Layout inside text
421+
422+A row, column or grid written inside text, inline in a line (`{@el ...}`) or
423+as a child of a text element, is laid out inline (`display: inline-flex`, or
424+`inline-grid`), and keeps its attributes. Anywhere inside text, `@el`, `@row`
425+and `@grid` (and `@in-front` and `@behind`) are written as a `<span>` rather
426+than a `<div>`, since text can't hold a `<div>`.
531427
532428```
533−@el [before:content "→ ", before:color red, before:font-weight bold]
534− Item with arrow prefix
429+@paragraph
430+ Price: {@el [padding 2 6, background #fef3c7, border-radius 4] $9} a month.
431+@h2
432+ Plans
433+ @row [spacing 4, font-size 14] > @text New
434+```
435+
436+Any other element keeps its HTML element. One whose HTML ends a paragraph,
437+such as `@section`, `@ul` or `@h2`, is a warning inside `@paragraph`
438+(`block-in-paragraph`): the browser would move it, and what follows it, out
439+of the `<p>`.
440+
441+`@link` is text too, so a card written inside a link is an inline `<span>`
442+that shrinks to its content. A clickable card is the link itself, laid out
443+as a column with CSS:
535444
536−@el [after:content " ✓", after:color green]
537− Completed item
445+```
446+@link [href=/post, display flex, flex-direction column, gap 8, padding 16, border 1 solid #e5e7eb]
447+ @strong A post
448+ @text Its summary.
538449```
539450
540−Content values are automatically quoted unless they are CSS keywords (`none`, `normal`) or CSS functions (`attr()`, `counter()`).
541−
542−## Conditional attribute values
451+### Overlays: `@in-front` and `@behind`
543452
544−Use `if(condition, true_value, false_value)` inside attribute values for conditional styling:
453+These layers work like elm-ui's `inFront` and `behind`. Their children fill
454+the parent's bounds, and the parent becomes a positioning context
455+(`position: relative; isolation: isolate`). An explicit `position` on the
456+parent takes precedence.
457+
458+```
459+@el [width 200, height 200, background blue]
460+ @text [color white] Main content
461+ @in-front
462+ @text [color yellow, align-right, align-bottom] Painted on top
463+ @behind
464+ @el [background red, height fill]
465+```
466+
467+### Standard library
468+
469+Two definitions are written in htmlang (`std.hl`) and are available in every
470+file. A `@let` of your own with the same name replaces them. `@spacer` takes
471+up the remaining space in a row or column. The `$truncate` bundle cuts text
472+off at one line with an ellipsis. You define any other components yourself
473+with `@let`.
474+
475+```
476+@row [spacing 8, align-items center]
477+ @text Logo
478+ @spacer
479+ @text [$truncate, max-width 200] A long title that gets cut off
480+```
481+
482+## Style
483+
484+### CSS properties
485+
486+Any attribute that isn't a layout attribute is a **CSS property**, with the
487+same name and value as in CSS: `padding 20`, `font-weight bold`,
488+`border 1 solid #e5e7eb`, `border-radius 8`, `background red`,
489+`grid-template-areas "a b"`, `display none`.
490+
491+A quoted string in a value is CSS's own, so it keeps its quotes and its
492+commas: `font-family "Inter, sans-serif"` names one family called
493+"Inter, sans-serif", and the compiler warns about it. A font stack is
494+several values with commas between them, written `\,`:
495+`font-family Inter\, sans-serif`.
496+
497+Values mean what they mean in CSS, with one addition: **in a length
498+property, every bare number outside parentheses and quotes is pixels**. So
499+`padding 20` is `20px`, `border 1 solid red` is `1px solid red`,
500+`box-shadow 0 2 4 rgba(0,0,0,0.1)` is `0 2px 4px rgba(0,0,0,0.1)`, and
501+`margin 0 auto` is `0 auto` (a zero stays `0`). Numbers inside a function
502+belong to it (`rgb(255 128 0)`, `calc(100% - 20px)`), and values that have
503+a unit or are keywords pass through as written (`width 50%`, `max-width
504+min(100%, 800px)`). Every other property takes numbers as CSS does, so
505+`opacity 0.5`, `z-index 2`, `line-height 1.5`, `flex 1 1 240px`,
506+`grid-column 1 / 3`, `initial-letter 3` and `border-image-width 2` are
507+written as they are, and so are custom properties (`--cols 3`), which have
508+no type to go by.
509+
510+The length properties are these, and only these:
511+
512+| Group | Properties |
513+|---|---|
514+| Size | `width`, `height`, `min-*` and `max-*` of both, `block-size`, `inline-size` and their `min-`/`max-`, `flex-basis`, `column-width`, `contain-intrinsic-*` |
515+| Space | `margin`, `padding`, `scroll-margin`, `scroll-padding` and every side of them, `gap`, `row-gap`, `column-gap`, `border-spacing` |
516+| Position | `top`, `right`, `bottom`, `left`, `inset` and `inset-*`, `translate`, `transform-origin`, `perspective`, `perspective-origin`, `offset-position`, `offset-anchor`, `offset-distance` |
517+| Border | `border` and every `border-*` shorthand, width and radius (not `border-image-*`), `outline`, `outline-width`, `outline-offset`, `column-rule`, `column-rule-width` |
518+| Shadow | `box-shadow`, `text-shadow` |
519+| Grid | `grid-template-columns`, `grid-template-rows`, `grid-auto-columns`, `grid-auto-rows` |
520+| Background | `background-position` (and `-x`, `-y`), `background-size`, `object-position`, `mask-position`, `mask-size` |
521+| Text | `font-size`, `letter-spacing`, `word-spacing`, `text-indent`, `text-decoration-thickness`, `text-underline-offset`, `vertical-align`, `baseline-shift` |
522+| Other | `shape-margin`, `overflow-clip-margin`, `view-timeline-inset` |
523+
524+Shorthands that mix lengths with numbers of other kinds (`font`,
525+`background`, `mask`, `grid`, `grid-template`, `offset`, `flex`) are not in
526+the table, so the lengths in them are written with their unit:
527+`font 700 16px/1.5 Inter`.
528+
529+Nothing else is added to a value, and a shorthand means what it means in
530+CSS: `outline 2 solid red` is `2px solid red`, while `outline 2 red` names
531+no line style, so CSS draws no outline. `container card / inline-size`
532+and `contain content` are CSS's own shorthands too, and a bare `contain` is
533+an error, like any style without a value. `line-clamp N` alone also adds
534+the `-webkit-box` declarations that browsers still need to cut text off
535+after N lines.
536+
537+A property htmlang doesn't know is written to the CSS as it is, so new CSS
538+(`text-grow per-line`) works before htmlang lists it; the
539+compiler warns and suggests the closest known name, in case it is a typo.
540+Vendor-prefixed properties (`-webkit-tap-highlight-color`) pass without a
541+warning. The value of a property htmlang doesn't know is written exactly as
542+it is, without pixels added. A style needs a value: `[padding]` is an error.
543+
544+```
545+@el [-webkit-tap-highlight-color transparent, -webkit-text-stroke 1px black]
546+ Passed through as written
547+```
548+
549+A value is checked only for what is wrong in any CSS. A `;`, `{` or `}`
550+(outside a quoted string, and for `;` outside parentheses, as in CSS's own
551+`if()`) or an unclosed quote or parenthesis would break out of the rule, and
552+a `</style` (even quoted) would end the page's style element, so each is an
553+error, including in a value that comes from a variable or from `@data`. A hex color that doesn't have 3, 4, 6 or 8 digits is a warning. A
554+style whose value comes out empty, such as a field that a record doesn't
555+have, is left out. Since a value is CSS's, a missing comma between two
556+styles makes one value: `padding 8 color red` is `padding: 8px color red`,
557+which the browser ignores. A style written as an HTML attribute
558+(`padding=8`) is a warning that shows its style form.
559+
560+#### Custom properties
561+
562+A custom property (`--name`) is a CSS property like any other: it goes on
563+any element, under any prefix, and is written into the element's class.
564+Its name is yours, so it is never checked against a list.
565+CSS passes it down, so it holds for the element and everything inside it,
566+where `var(--name)` reads it. Its value is written exactly as it is, since
567+a custom property has no type for pixels to go by: `--hue 200` can feed
568+`hsl(var(--hue) 80% 50%)` and `--cols 3` can feed `repeat(var(--cols),
569+1fr)`. A length therefore takes its unit: `--gap 16px`, not `--gap 16`.
545570
546571```
572+@el [
573+ --gap 16px,
574+ md:--gap 24px,
575+ --hue 200,
576+ spacing var(--gap),
577+ background hsl(var(--hue) 80% 95%)
578+]
579+ @text One
580+ @text Two
581+```
582+
583+`@let --name value` declares a custom property for the whole page, on
584+`:root` (see [CSS custom properties](#css-custom-properties));
585+`[--name value]` sets it on one element and everything inside it. So a
586+design token is declared once with `@let`, and a theme redefines it where
587+it changes, once, rather than repeating a colour on every element that
588+uses it:
589+
590+```
591+@let --ink #0f172a
592+@let --surface white
593+@let --subtle #f8fafc
594+@page [color var(--ink), background var(--surface), dark:[--ink #e2e8f0, --surface #0b1220, --subtle #111a2e]] Tokens
595+@section [padding 96 24, background var(--subtle)]
596+ @article [padding 24, background var(--surface)]
597+ Both follow dark mode, from the one place that sets it.
598+```
599+
600+### Prefixes
601+
602+A prefix applies a style only in some condition:
603+
604+| Prefix | Applies |
605+|---|---|
606+| `hover:`, `focus:`, `first-child:`, `checked:`, `user-invalid:`, `open:`, ... | When that CSS pseudo-class matches (`:hover`, `:first-child`, ...) |
607+| `nth-child(odd):`, `not(.featured):`, `has(> img):`, `is(...):`, ... | When that pseudo-class, with its argument, matches |
608+| `before:`, `after:`, `marker:`, `placeholder:`, `backdrop:`, ... | To that pseudo-element (`::before`, `::marker`, ...) |
609+| `children:` | To each direct child |
610+| `@td:`, `@h2:`, `@link:`, ... | To every such element inside it, at any depth (see [Styling the elements inside](#styling-the-elements-inside)) |
611+| `sm:`, `md:`, `lg:`, `xl:`, `2xl:` | From that viewport width up (640, 768, 1024, 1280, 1536px) |
612+| `cq-sm:` … `cq-2xl:` | From that container width up (the same widths, for an ancestor with `container-type inline-size`) |
613+| `dark:`, `print:`, `motion-safe:`, `motion-reduce:`, `landscape:`, `portrait:` | Under that media condition |
614+
615+The selector prefixes are CSS's own pseudo-classes and pseudo-elements,
616+under their CSS names, without the colons: `link`, `visited`,
617+`first-child`, `last-child`, `only-child`, `first-of-type`,
618+`last-of-type`, `only-of-type`, `empty`, `target`, `open`,
619+`popover-open`, `default`, `checked`, `indeterminate`,
620+`placeholder-shown`, `autofill`, `required`, `optional`, `valid`,
621+`invalid`, `user-valid`, `user-invalid`, `read-only`, `read-write`,
622+`focus-within`, `hover`, `focus`, `focus-visible`, `active`, `enabled`
623+and `disabled`; with an argument, `nth-child()`, `nth-last-child()`,
624+`nth-of-type()`, `nth-last-of-type()`, `not()`, `is()`, `where()` and
625+`has()`; and the pseudo-elements `before`, `after`, `marker`,
626+`placeholder`, `selection`, `backdrop`, `first-line`, `first-letter` and
627+`file-selector-button`, which htmlang writes with CSS's `::`. The argument
628+is CSS, written as it is between balanced parentheses, and it may hold
629+spaces and colons: the key ends at the first space outside parentheses, so
630+`has(> img):padding 0` and `is(:hover, :focus-visible):color red` are one
631+key each. `children:` is htmlang's one combinator word, and an element's
632+name with `@` (`@td:`) picks out the elements of that kind inside. A name
633+that isn't one of these (`hvoer:`, or `first:` for `first-child:`) is an
634+unknown prefix, an error, not a selector that silently never matches.
635+
636+A prefix goes on a style or a layout flag, and prefixes stack: the key
637+is a chain of prefixes, then the property, and the style applies where
638+all of them hold. The selector prefixes (every row above the widths)
639+read left to right: `hover:children:` styles the children of a hovered
640+element, `children:hover:` a hovered child. A pseudo-element is not an
641+element with states of its own, so it comes last among them:
642+`hover:before:color` is the `::before` of a hovered element, and
643+`before:hover:color` is an error that says so. The width, media and
644+container prefixes go anywhere in the chain, in any order, and each is
645+an `@media` or `@container` rule around the ones inside it:
646+`md:dark:padding 32` and `dark:md:padding 32` are the same style, from
647+768px up in dark mode.
648+
649+A prefix written before a `[group]` applies to each style in it, and one
650+written before a `$bundle` to each style the bundle holds, so styles that
651+share a condition are written under it once. A prefix before an `if()`
652+applies to the branch it picks. The group or bundle holds styles only:
653+an HTML attribute (`md:[id=x]`) or a flag that is not a style has no
654+states, and it is an error there, as it is with a prefix of its own
655+(`md:id=x`).
656+
657+`children:` styles each direct child, as the parent sees it. They take
658+effect only where the child sets nothing itself, since what an element
659+says about itself wins over what its parent says about it. They do win
660+over the defaults of the child's kind, so `children:display list-item`
661+brings back a list's markers and `children:margin-bottom 8` spaces
662+headings. The words
663+that place an element in its parent (`width fill`, `width shrink`,
664+`center-x`, `align-*`) are errors under `children:`, because there the
665+parent they measure against is this element: they go on the children
666+themselves, or the CSS they stand for does (`children:flex 1`).
667+
668+#### Styling the elements inside
669+
670+An element prefix, `@NAME:`, styles every element of that kind inside
671+this one, at any depth. `@table [@td:padding 8]` pads every cell of the
672+table, and `@article [@h2:font-size 20]` sizes every heading in the
673+article. It is how content that has no attributes of its own is styled:
674+the HTML `@markdown` writes, and the rows a loop writes.
675+
676+```
677+@let team Ada, Grace, Linus
678+@table [border-collapse collapse, width 100%, @th:[padding 8, text-align left], @td:padding 8, @tr:border-bottom 1 solid #e5e7eb]
679+ @tr
680+ @th Name
681+ @th Team
682+ @each $name in $team
683+ @tr
684+ @td $name
685+ @td [padding 2] Platform
686+@article [spacing 12, @h2:font-size 20, @code:[padding 1 4, background #f1f5f9], @link:hover:color #2563eb]
687+ @markdown
688+ ## Notes
689+
690+ Run `htmlang check` before you [publish](/publish).
691+```
692+
693+- **The element has a tag of its own.** `@td:` is every `<td>`,
694+ `@paragraph:` every `<p>`, `@link:` every `<a>` and `@image:` every
695+ `<img>`, the ones `@markdown` and `@raw` write included. An element that
696+ shares its tag can't be picked out, so its prefix is an error: `@el`,
697+ `@row`, `@grid`, `@in-front` and `@behind` all write `<div>`, and `@text`
698+ writes the `<span>` that every line of text in a row or column is too.
699+ So is a function's name (`@card:`), since a function writes whatever its
700+ body says and has no tag of its own, and a name that isn't an element
701+ (`@a:` suggests `@link:`).
702+- **It takes CSS properties.** htmlang's layout words (`spacing`, `wrap`,
703+ `grid-cols`, `col-span`, `width fill`, `center-x`, `align-*`) compile
704+ against each element's own layout and its parent's, which the prefix
705+ doesn't know, so they are errors under it: write them on the elements,
706+ or the CSS they stand for (`@li:margin-inline auto`). HTML attributes
707+ have no states: `@td:colspan=2` is an error, like `md:colspan=2`.
708+- **It composes with the other prefixes, read left to right.** Selector
709+ prefixes after it choose among the elements:
710+ `@tr:nth-child(even):background #f8fafc` shades every other row, and
711+ `@link:hover:color red` colours a hovered link. Those before it are
712+ about the element itself: `hover:@link:color red` recolours its links
713+ while it is hovered. Width, media and container prefixes go anywhere
714+ (`md:@td:padding 12`). A `[group]` or a `$bundle` takes it like any
715+ prefix: `@th:[padding 8, text-align left]`. A style has one element
716+ prefix, and not `children:` as well: each says which elements the style
717+ is for.
718+- **What an element says about itself wins.** A cell's own `[padding 2]`
719+ wins over the table's `@td:padding 8`, and a parent's `children:` wins
720+ over it too. The prefix wins over the defaults of the element's kind, so
721+ `@main [@h2:margin-block-start 16]` spaces headings, which start with
722+ `margin: 0`. Where two elements around one both style it, the nearest
723+ wins, whatever the order they are written in: in an `@article
724+ [@td:padding 16]` around a `@table [@td:padding 8]`, the table's cells
725+ get 8.
726+- **It styles what is inside, not the element itself.** `@ul
727+ [@ul:padding-inline-start 16]` indents the lists inside the list, not
728+ the list itself.
729+
730+`children:` and an element prefix answer different questions:
731+`children:` is for the direct children, whatever they are, as the parent
732+sees them; `@td:` is for every cell inside, however deep. An element's
733+own attributes are for it alone.
734+
735+Each style under an element prefix compiles to a rule in CSS's `@scope`,
736+on the element's class, in the layer `hl-inside` (see [CSS](#css)):
737+`@scope (.hl-2k9xq0m) { :scope td { padding: 8px } }`. `@scope`'s proximity
738+rule is what makes the nearest element win. `@scope` is Baseline 2025,
739+supported by Chrome and Edge 118, Safari 17.4 and Firefox 146; an older
740+browser ignores these rules, so the elements inside keep the styles they
741+have without them.
742+
743+```
744+@let card [padding 16, border 1 solid #e5e7eb, border-radius 8]
547745@let active true
548−@let theme dark
549−
550−@el [background if($active, blue, gray)]
551− Conditionally styled
552−
553−@el [color if($theme == dark, white, black)]
554− Theme-aware text
555−```
556−
557−Supports equality (`==`), inequality (`!=`), and truthy checks.
558−
559−## Attributes reference
560−
561−### Layout (set on parent)
562−
563−| Attribute | Effect |
564−|------------------------|----------------------------------|
565−| `spacing N` | Gap between children |
566−| `gap N` | Alias for `spacing` |
567−| `gap-x N` | Horizontal gap (column-gap) |
568−| `gap-y N` | Vertical gap (row-gap) |
569−| `padding N` | Uniform padding |
570−| `padding Y X` | Vertical + horizontal padding |
571−| `padding T H B` | Top + horizontal + bottom |
572−| `padding T R B L` | Per-side padding |
573−| `padding-x N` | Horizontal padding |
574−| `padding-y N` | Vertical padding |
575−
576−### Sizing (set on child)
577−
578−| Attribute | Effect |
579−|------------------------|----------------------------------|
580−| `width fill` | Take remaining space (flex: 1) |
581−| `width N` | Exact pixels |
582−| `width shrink` | Fit to content (default) |
583−| `height fill` | Take remaining space |
584−| `height N` | Exact pixels |
585−| `height shrink` | Fit to content (default) |
586−| `min-width N` | Minimum width |
587−| `max-width N` | Maximum width |
588−| `min-height N` | Minimum height |
589−| `max-height N` | Maximum height |
590−
591−### Alignment (set on child)
592−
593−| Attribute | Effect |
594−|------------------------|----------------------------------|
595−| `center-x` | Center horizontally |
596−| `center-y` | Center vertically |
597−| `align-left` | Align to left |
598−| `align-right` | Align to right |
599−| `align-top` | Align to top |
600−| `align-bottom` | Align to bottom |
601−
602−### Style
603−
604−| Attribute | Effect |
605−|------------------------|----------------------------------|
606−| `background COLOR` | Background color |
607−| `color COLOR` | Text color |
608−| `border N COLOR` | Border width and color |
609−| `border-top N COLOR` | Top border |
610−| `border-bottom N COLOR`| Bottom border |
611−| `border-left N COLOR` | Left border |
612−| `border-right N COLOR` | Right border |
613−| `rounded N` | Border radius |
614−| `shadow VALUE` | Box shadow (CSS value) |
615−| `bold` | Bold text |
616−| `italic` | Italic text |
617−| `underline` | Underlined text |
618−| `size N` | Font size in px |
619−| `font NAME` | Font family |
620−| `text-align VALUE` | Text alignment (left/center/right/justify) |
621−| `line-height VALUE` | Line height (unitless or px) |
622−| `letter-spacing N` | Letter spacing |
623−| `text-transform VALUE` | Transform (uppercase/lowercase/capitalize) |
624−| `white-space VALUE` | White-space (nowrap/pre/normal) |
625−| `transition VALUE` | CSS transition |
626−| `cursor VALUE` | Cursor style |
627−| `opacity VALUE` | Opacity (0–1) |
628−| `overflow VALUE` | Overflow (hidden/scroll/auto/visible) |
629−| `position VALUE` | Position (relative/absolute/fixed/sticky) |
630−| `top N` | Top offset (positioned elements) |
631−| `right N` | Right offset |
632−| `bottom N` | Bottom offset |
633−| `left N` | Left offset |
634−| `z-index N` | Stack order |
635−| `display VALUE` | Display mode (none/block/flex/grid) |
636−| `visibility VALUE` | Visibility (visible/hidden) |
637−| `transform VALUE` | CSS transform (e.g., rotate(45deg)) |
638−| `backdrop-filter VALUE`| Backdrop filter (e.g., blur(10px)) |
639−
640−### Margin
641−
642−| Attribute | Effect |
643−|------------------------|----------------------------------|
644−| `margin N` | Uniform margin |
645−| `margin Y X` | Vertical + horizontal margin |
646−| `margin T R B L` | Per-side margin |
647−| `margin-x N` | Horizontal margin |
648−| `margin-y N` | Vertical margin |
649−
650−### Additional Style
651−
652−| Attribute | Effect |
653−|------------------------|----------------------------------|
654−| `filter VALUE` | CSS filter (blur, brightness) |
655−| `object-fit VALUE` | Object fit (cover/contain/fill) |
656−| `object-position VALUE`| Object position within container|
657−| `text-shadow VALUE` | Text shadow |
658−| `text-overflow VALUE` | Text overflow (ellipsis/clip) |
659−| `pointer-events VALUE` | Pointer events (none/auto) |
660−| `user-select VALUE` | User selection (none/text/all) |
661−| `justify-content VALUE`| Main axis alignment |
662−| `align-items VALUE` | Cross axis alignment |
663−| `order N` | Flex/grid item order |
664−| `background-size VALUE`| Background size |
665−| `background-position VALUE`| Background position |
666−| `background-repeat VALUE`| Background repeat |
667−| `word-break VALUE` | Word break (break-all/keep-all) |
668−| `overflow-wrap VALUE` | Overflow wrap (break-word) |
669−| `font-weight VALUE` | Font weight (100-900/bold/lighter)|
670−| `font-style VALUE` | Font style (normal/italic/oblique)|
671−| `text-wrap VALUE` | Text wrapping (balance/pretty) |
672−| `will-change VALUE` | Performance hint (transform) |
673−| `touch-action VALUE` | Touch behavior (none/pan-x) |
674−| `vertical-align VALUE` | Vertical alignment (middle/top) |
675−| `contain VALUE` | CSS containment (layout/paint) |
676−| `content-visibility VALUE` | Lazy rendering (auto) |
677−| `scroll-margin N` | Scroll margin (for anchors) |
678−| `scroll-padding N` | Scroll padding (scroll-snap) |
679−| `content VALUE` | Pseudo-element content (with before:/after:)|
680−
681−### Pseudo-states
682−
683−Prefix any style attribute with `hover:`, `active:`, or `focus:` to apply it on that state.
684−
685−```
686−@el [padding 16, background #3b82f6, hover:background #2563eb, active:background #1d4ed8, rounded 8, transition all 0.15s ease]
746+@el [padding 16, background #3b82f6, hover:background #2563eb, md:[padding 32, font-size 20], dark:[background #1e3a8a, hover:background #1e40af]]
687747 @text [color white] Click me
688−```
689−
690−All style attributes support state prefixes: `hover:color`, `active:rounded`, `focus:border`, etc.
691−
692−### Dark mode
748+@row [spacing 4, children:flex 1, hover:children:opacity 0.8]
749+ @el [nth-child(odd):background #f3f4f6] A
750+ @el [nth-child(odd):background #f3f4f6] B
751+ @el [nth-child(odd):background #f3f4f6] C
752+@el [before:content "→ ", before:color red, hover:before:color blue]
753+ Item with an arrow
754+@section [spacing 16, md:$card, hover:if($active, [background #eef2ff, color #3730a3])]
755+ A card from md up
756+```
757+
758+The styles of one element follow a fixed order, whatever the order they
759+are written in: those without a prefix, then those with selector
760+prefixes only, then each width, media and container condition in the
761+order of the table (a stack like `md:dark:` after `dark:` on its own),
762+with its selector chains inside it. So where two styles both hold, the
763+one later in the table wins (`dark:` over `md:`, `lg:` over `md:`), and a
764+stack wins over each of its prefixes on its own (`md:dark:` over `dark:`
765+and `md:`). Selector chains follow CSS's usual order: `link:` and
766+`visited:`, the position and form states, then `hover:`, `focus:`,
767+`active:`, and `enabled:` and `disabled:` last. So a hovered row wins over
768+`nth-child(odd):`, and a pressed button's `active:` over its `focus:`.
769+
770+### Conditional attributes
771+
772+`if(CONDITION, A, B)`, written as a whole attribute, is `A` when the
773+condition holds and `B` otherwise. Each branch is an attribute, a `[group]`
774+of attributes or a `$bundle`. An empty branch leaves the attribute out, and
775+`B` itself can be left out. Several attributes that depend on one condition
776+are one `if()` with a group:
693777
694−Prefix any style attribute with `dark:` to apply it when the user's system is in dark mode.
695−
696−```
697−@el [background white, dark:background #1a1a2e, color #333, dark:color #eee]
698− @text Theme-aware content
699778```
700−
701−This generates a `@media (prefers-color-scheme: dark)` rule.
702−
703−### Print styles
704−
705−Prefix any style attribute with `print:` to apply it when printing.
706−
707−```
708−@nav [print:display none]
709− @text Navigation (hidden in print)
710−```
711−
712−This generates a `@media print` rule.
713−
714−### Flow & Grid
715−
716−| Attribute | Effect |
717−|------------------------|----------------------------------|
718−| `wrap` | Enable flex-wrap (on `@row`) |
719−| `grid` | Enable CSS grid layout |
720−| `grid-cols N` | Grid template columns (N equal) |
721−| `grid-rows N` | Grid template rows (N equal) |
722−| `col-span N` | Span N columns in grid |
723−| `row-span N` | Span N rows in grid |
724−
725−### Identity
726−
727−| Attribute | Effect |
728−|------------------------|----------------------------------|
729−| `id NAME` | HTML id attribute |
730−| `class NAME` | HTML class attribute |
731−
732−### Modern CSS
733−
734−| Attribute | Effect |
735−|------------------------|----------------------------------|
736−| `color-scheme VALUE` | Color scheme (`light`, `dark`, `light dark`) |
737−| `appearance VALUE` | Form element appearance (`none`) |
738−
739−### Popover API
740−
741−Use HTML Popover API attributes for declarative popovers without JavaScript.
742−
743−```
744−@button [popovertarget info-panel] Show Info
745−@el [popover, id info-panel, padding 20, background white, rounded 8]
746− @text This is a popover
747−```
748−
749−| Attribute | Effect |
750−|-------------------------------|---------------------------------|
751−| `popover` | Make element a popover |
752−| `popovertarget ID` | Open popover with given ID |
753−| `popovertargetaction VALUE` | Action (toggle/show/hide) |
754−
755−### Input hints
756−
757−| Attribute | Effect |
758−|------------------------|----------------------------------|
759−| `inputmode VALUE` | Virtual keyboard type (numeric/email/search/tel/url) |
760−| `enterkeyhint VALUE` | Enter key label (enter/done/go/next/previous/search/send) |
761−| `fetchpriority VALUE` | Resource priority (high/low/auto) |
762−| `translate VALUE` | Whether to translate (yes/no) |
763−| `spellcheck VALUE` | Spell check (true/false) |
764−
765−## Asset inlining
766−
767−SVG images can be inlined directly into the HTML output using the `[inline]` attribute:
779+@let active true
780+@el [if($active, background blue, background gray), if($active, font-weight bold)]
781+ Conditionally styled
782+@link [if($active, [background #eef2ff, font-weight 600, aria-current=page])] /docs Docs
783+```
784+
785+A value that depends on a condition is an [expression](#expressions),
786+`${if(CONDITION, A, B)}`. Its branches are expressions, so a number or a
787+single word is written as it is, and other CSS text is quoted:
788+`padding ${if($active, 24, 0)}`, `color ${if($active, #10b981, "var(--muted)")}`.
789+An `if()` written in a value without `${...}` is CSS's own `if()`, which the
790+browser decides, and it is passed through like any CSS function:
791+`width if(media(width > 40em): 50%; else: 100%)`.
792+
793+## HTML
794+
795+### HTML elements
796+
797+The layout and text elements have elm-ui's names. Every other element has
798+its HTML name: `@strong`, `@em`, `@small`, `@br`, `@sub`, `@caption`,
799+`@tfoot`, `@optgroup`, `@hgroup` and the others in the table of layouts
800+below.
801+
802+| Element | Output | Purpose |
803+|---|---|---|
804+| `@el` | div, flex column | The container: children laid out top to bottom |
805+| `@row` | div, flex row | Children laid out side by side |
806+| `@grid` | div, grid | Grid container (with `grid-cols` or `grid-template-*`) |
807+| `@in-front` / `@behind` | div, absolute | Overlay layers that fill the parent |
808+| `@text` | span | Styled inline text |
809+| `@paragraph` | p | A paragraph of flowing text |
810+| `@link URL` | a | Link: the URL is its `href`, and the text after it is its content |
811+| `@image SRC` | img | Image: the one word after its attributes is its `src` |
812+| `@fragment` | (none) | Its children, without a wrapper element (so it takes no attributes) |
813+
814+Every element has one [layout](#rows-columns-and-text):
815+
816+| Layout | Elements |
817+|---|---|
818+| column | `@el`, `@in-front`, `@behind`, `@nav`, `@header`, `@footer`, `@main`, `@section`, `@article`, `@aside`, `@address`, `@search`, `@noscript`, `@form`, `@details`, `@dialog`, `@figure`, `@blockquote`, `@fieldset`, `@hgroup`, `@ul`, `@ol`, `@menu`, `@li`, `@dl`, `@dd` |
819+| row | `@row` |
820+| grid | `@grid` |
821+| text | `@text`, `@paragraph`, `@link`, `@h1`, `@h2`, `@h3`, `@h4`, `@h5`, `@h6`, `@button`, `@label`, `@legend`, `@summary`, `@figcaption`, `@cite`, `@dt`, `@td`, `@th`, `@code`, `@kbd`, `@mark`, `@abbr`, `@time`, `@b`, `@i`, `@strong`, `@em`, `@small`, `@s`, `@u`, `@sub`, `@sup`, `@q`, `@var`, `@samp`, `@dfn`, `@bdi`, `@bdo`, `@ins`, `@del` |
822+| native | `@table`, `@caption`, `@colgroup`, `@thead`, `@tbody`, `@tfoot`, `@tr`, `@select`, `@optgroup`, `@option`, `@datalist`, `@textarea`, `@progress`, `@meter`, `@output`, `@pre`, `@ruby`, `@rt`, `@rp`, `@picture`, `@video`, `@audio`, `@iframe`, `@object`, `@map`, `@canvas`, `@script` |
823+| void | `@image`, `@input`, `@hr`, `@br`, `@wbr`, `@col`, `@source`, `@track`, `@embed`, `@area` |
824+
825+`@fragment`, `@children` and `@slot` have no element of their own: what
826+they hold takes the layout of the element they are in. The top of a page is
827+a column, `<body>` (see [Page and head](#page-and-head)). In a native
828+element, and at the top of a fragment, lines of text are separated by a line break,
829+which HTML shows as a space except where whitespace is kept, as in `@pre`
830+and `@textarea`.
831+
832+The text-level elements (`@strong`, `@em`, `@b`, `@i`, `@small`, `@sub`,
833+`@q`, `@del`, ...) are text with the browser's own style and no CSS of
834+htmlang's, so they work inside a line like any inline element. Table parts,
835+`@optgroup` and `@ruby` keep HTML's own layout:
768836
769837```
770−@image [inline, width 24, height 24] icon.svg
838+@paragraph
839+ {@strong Note:} water is H{@sub 2}O,{@br}
840+ and {@em this} is {@small fine print}.
841+@table
842+ @caption Team
843+ @thead
844+ @tr
845+ @th Name
846+ @tbody
847+ @tr
848+ @td Ada
849+ @tfoot
850+ @tr
851+ @td One person
852+@select [aria-label=Fruit]
853+ @optgroup Citrus
854+ @option Lemon
855+```
856+
857+The list of elements is fixed: a name that isn't in it is an unknown
858+element, not a new HTML tag, since a function is called with the same `@`
859+and a misspelled one would otherwise become a tag. HTML's `<div>`, `<span>`,
860+`<p>`, `<a>` and `<img>` are htmlang's own `@el`, `@text`, `@paragraph`,
861+`@link` and `@image`, so `@a` is an unknown element whose error suggests
862+`@link`. The head's elements (`<meta>`, `<style>`, `<title>`, `<link>`) are
863+written with [directives](#page-and-head). `<data>` and `<slot>` share their
864+names with `@data` and `@slot`, and `<template>` holds content that only a
865+script uses; these, and `<svg>` and `<math>`, are written with `@raw`.
866+
867+An element without a closing tag (`@input`, `@hr`, `@br`, `@image`,
868+`@source`, ...) takes no content.
869+
870+Browser default margins on headings, paragraphs, lists and figures are reset
871+to 0 (in the element's own class, so Markdown and raw HTML keep theirs; see
872+[CSS](#css)), so `spacing` controls the gaps. Lists (`@ul`, `@ol`, `@menu`) and list
873+items are columns like other containers, so `spacing` on a list is the gap between its items, and
874+a list shows no markers. To bring them back, write
875+`[list-style disc, padding-inline-start 20, children:display list-item]` on
876+the list, and `marker:` styles the markers themselves (`::marker`).
877+
878+```
879+@ol [spacing 4]
880+ @li First
881+ @li Second
882+@ul [list-style disc, padding-inline-start 20, children:display list-item, children:marker:color #2563eb]
883+ @li [first-child:font-weight 700] Markers
884+ @li Back
885+@form [method=post, spacing 8] /subscribe
886+ @label [for=email] Email
887+ @input [type=email, name=email, id=email, required]
888+ @button [type=submit] Send
889+@details [open]
890+ @summary Question
891+ @text The answer.
892+```
893+
894+### The leading argument
895+
896+An element that points at a URL or a file takes it as the first word after
897+its attributes, its leading argument, which fills one HTML attribute:
898+
899+| Element | Leading argument |
900+|---|---|
901+| `@link`, `@area` | `href` |
902+| `@image`, `@script`, `@iframe`, `@video`, `@audio`, `@track`, `@embed` | `src` |
903+| `@source` | `srcset` directly inside `@picture`, `src` inside `@video` and `@audio` |
904+| `@form` | `action` |
905+| `@object` | `data` |
906+| `@optgroup` | `label` |
907+
908+The first word is taken before any `$name` in it is filled in, and it ends
909+at the first space that isn't inside `"..."` or `${...}`: `@link $url More`
910+and `@link /page/${$n + 1} Next` take the whole `$url` and
911+`/page/${$n + 1}`, and `@link "/my page" Open` takes `/my page`. After it,
912+the rest of the text is the element's content, read like any text; an
913+element without content (`@image`, `@source`, `@track`, `@embed`, `@area`)
914+takes nothing more, and a word after its argument is an error (write a
915+text alternative as `alt=...`). So is a word after an `@optgroup`'s label,
916+since it holds only the `@option` lines under it. A value with a space in
917+it is quoted, as such a label: `@optgroup "Citrus fruits"`. The first word is
918+always the argument, so on an element whose attribute is often left out
919+(`@form`, `@video`, `@audio`), text goes on the lines under it: `@form Sign
920+in` would make `Sign` the form's action. A first word that reads as text,
921+a capitalized word with nothing of a URL in it, is taken with a warning
922+(`text-as-url`): `@link [hx-get=/panel] Open panel` makes `Open` the link's
923+`href`. A relative URL like that one is written `./Open`.
924+
925+The attribute can be written as an attribute instead, and it means the same:
926+`@link [href=/about]` with its text on the lines under it, or
927+`@image [src=logo.svg, inline]`. Both at once, as in
928+`@link [href=/a] About`, is an error that says which word was taken as the
929+`href`.
930+
931+```
932+@nav [flex-direction row, spacing 16]
933+ @link /docs The docs
934+ @link [aria-current=page] /pricing Pricing
935+@image [alt=The team, width 320] "team photo.jpg"
936+@picture
937+ @source [type=image/avif] hero.avif
938+ @image [alt=The office] hero.jpg
939+@video [controls] intro.mp4
940+ @track [kind=captions, srclang=en] intro.vtt
941+ Your browser doesn't play this video.
942+```
943+
944+`@script` is an element like the others: its leading argument is its `src`,
945+any HTML attribute passes through (`@script [type=module, defer] app.js`),
946+and without a `src` its indented body is its JavaScript, kept exactly as
947+written. A `src` and a body together are an error, since the browser runs
948+only the file. It isn't shown, so a style on it is an error.
949+
950+```
951+@script [defer] analytics.js
952+@script
953+ document.body.dataset.ready = "yes"
771954```
772955
773−This reads the SVG file and embeds its content directly, keeping the output self-contained.
956+### HTML attributes
774957
775−## CLI
958+HTML attributes are written `key=value`: `id=main`, `class=note`,
959+`href=/about`, `type=email`, `alt=Logo`, `target=_blank`,
960+`aria-label=Close menu`, `data-id=42`, `hx-get=/items`. Any name works,
961+one with a colon in it included (`xml:lang=en`, `hx-on:click=open()`):
962+before an `=` a colon is part of the name, not a prefix. Boolean attributes
963+are written bare: `required`, `disabled`, `checked`, `hidden`, `open`,
964+`popover`, and so are `data-` and `hx-` attributes that have no value
965+(`hx-preserve`). An HTML attribute written like a style (`type email`,
966+`hx-get /items`) is an error that shows the `key=value` form. A style
967+and an HTML attribute can share a name, because the `=` tells them apart:
776968
777969```
778−htmlang init # scaffold a new project
779−htmlang init my-site # scaffold in a new directory
780−htmlang new about-us # create about-us.hl from template
781−htmlang page.hl # compile page.hl → page.html
782−htmlang site/ # compile all .hl files in directory
783−htmlang --watch page.hl # compile and watch for changes
784−htmlang -w page.hl # short form
785−htmlang --serve site/ # serve a multi-page site with hot reload
786−htmlang -s --open site/ # serve and open browser
787−htmlang check page.hl # check for errors without writing output
788−htmlang check src/ # check all .hl files in a directory
789−htmlang convert page.html # convert HTML to .hl format (stdout)
790−htmlang build src/ -o dist/ # parallel compile + copy static assets
791−htmlang --compat page.hl # compile with vendor prefixes
792−htmlang --format json page.hl # output diagnostics as JSON
793−htmlang lint --format json src/ # lint with JSON output
794−htmlang dead-code --format json src/ # dead code report as JSON
795−htmlang lint page.hl # stricter lint checks (accessibility, nesting)
796−htmlang lint src/ # lint all .hl files in a directory
797−htmlang stats page.hl # show file statistics (elements, CSS, colors)
798−htmlang repl # interactive REPL (type .hl, get HTML)
799−htmlang feed src/ # generate RSS feed from @page metadata
800−htmlang feed src/ -b https://mysite.com # with custom base URL
801−htmlang components src/ # list all @fn definitions across project
802−htmlang deps src/ # show dependency graph (@include/@import)
803−htmlang dead-code src/ # find unused @fn, @define, @let across project
804−htmlang deploy src/ # build and deploy to GitHub Pages
805−htmlang playground # generate self-contained HTML playground
806−htmlang clean src/ # remove generated .html files
807−htmlang outline page.hl # show document structure tree
970+@image [width=800, width 200, alt=A photo] photo.jpg
971+@label
972+ Size
973+ @select [size=4, font-size 18]
974+ @option One
808975```
809976
810−Watch mode recompiles automatically when the source file or any `@include`d/`@import`ed files change.
977+## Definitions
811978
812−The `build` command automatically extracts shared CSS rules across pages into a `shared.css` file when outputting to a directory.
979+`@let` defines everything reusable. What it defines depends on its form:
813980
814−## Compilation target
815−
816−Each `.hl` file compiles to a single self-contained `.html` file:
817−
818−- Elements map to `<div>`, `<span>`, `<p>`, `<a>`, `<img>` as appropriate
819−- Layout uses flexbox (`display: flex`, `flex-direction`, `gap`, etc.)
820−- Styles are scoped via generated class names in an embedded `<style>` block
821−- No external CSS, no JavaScript (unless injected via `@raw`)
822−- `@page` generates the HTML boilerplate; without it, output is an HTML fragment
823−
824−## Template inheritance (`@extends`)
825−
826−A page can inherit a base layout and fill named `@slot` blocks:
827−
828−**layout.hl:**
829−```
830−@page My Site
831−@column [max-width 800, center-x, padding 40]
832− @slot header
833− @text [bold, size 32] Default Header
834− @slot content
835− @slot footer
836− @text [color #888] Default Footer
837−```
838−
839−**about.hl:**
840−```
841−@extends layout.hl
842−@slot header
843− @text [bold, size 32] About Us
844−@slot content
845− @paragraph We are a team of...
846−```
847−
848−Slots not filled by the extending page use the default children from the layout.
849−
850−## Design tokens (`@theme`)
851−
852−Centralized design token definitions. Each token becomes both a `$variable` and a `--css-custom-property`:
853−
854−```
855−@theme
856− primary #3b82f6
857− secondary #10b981
858− spacing-sm 8
859− spacing-md 16
860− font-body system-ui, sans-serif
861−```
862−
863−Equivalent to:
864981```
982+-- A value, used as $primary
865983@let primary #3b82f6
866−@let --primary #3b82f6
867−@let secondary #10b981
868−@let --secondary #10b981
869−...
870−```
871−
872−## Deprecation (`@deprecated`)
873−
874−Mark a function as deprecated. Callers receive a compile-time warning:
984+-- A computed value: `=` makes the rest an expression
985+@let gap = 8 * 2
986+-- Quoted text, with $variables filled in (see Variables for its quotes)
987+@let greeting "Hello from $primary"
988+-- An attribute bundle, used as [$card]
989+@let card [padding 20, background white, border-radius 8]
990+-- A function: `@` before its name, its parameters in brackets, and a body
991+@let @panel [title]
992+ @el [$card, spacing $gap]
993+ @text [font-weight bold, color $primary] $title
994+ @children
875995
876−```
877−@deprecated Use @card-v2 instead
878−@fn old-card $title
879− @el [padding 20]
880− @text $title
996+@panel [title Welcome]
997+ $greeting
998+@el [$card, background #f9fafb]
999+ Attributes after a bundle override it.
1000+```
1001+
1002+The line alone says what a `@let` defines: an `@` before the name makes a
1003+function, a `[` after the name an attribute bundle, and anything else a
1004+value. A value or a bundle is named without `$` and used with it; a function
1005+is named with `@` and called with it. Only a function has a body, so an
1006+indented block under a value or a bundle is an error, and so are `@let $x`
1007+(write `@let x`) and a `@let` without a value.
1008+
1009+Values, bundles and functions share one namespace, and one rule says where
1010+a name is visible: **from the line that defines it to the end of its
1011+block**. A block is the file, the lines indented under an element, a branch
1012+of `@if`, one repetition of `@each` or a function's body. A `@let` gives its
1013+name a new meaning in its block, whatever the name meant before, and hides
1014+what the name means around the block until the block ends:
1015+
1016+```
1017+@let gap 8
1018+@el [spacing $gap]
1019+ @let gap 16
1020+ @el [padding $gap] Sixteen
1021+@el [padding $gap] Eight
1022+```
1023+
1024+Parameters, `@each` variables and `@data` names follow the same rule, and
1025+each repetition of `@each` starts afresh, so a `@let` in one doesn't carry
1026+over to the next. A function's body sees its parameters and what is
1027+visible where the function is defined: not the names at a call, and not a
1028+definition further down, so a function means the same wherever it is
1029+called. `@let t.greeting Hello` gives the record `$t` the field `greeting`
1030+(making `$t` a record when it isn't defined), and `@let items.0 first`
1031+replaces the first item of the list `$items`; a field of any other value is
1032+an error.
1033+
1034+### Variables
1035+
1036+`$name` inserts a value wherever htmlang holds text: a line of text, an
1037+attribute's value, an element's argument, a `@let` value, a file path, the
1038+title of `@page` and the value of `@meta`. Each line is read first, and then
1039+`$name` fills the one place it is written in. What it inserts is never read
1040+again as htmlang, so a value can't become an attribute, an attribute's name,
1041+a comma between attributes, an inline element or another `$name`. Attributes
1042+come from a bundle:
1043+
1044+```
1045+@let link-style [color #2563eb, text-decoration underline]
1046+@let label Docs
1047+@link [$link-style, aria-label=$label] /docs Read the $label
1048+```
1049+
1050+A name starts with a letter or `_` and goes on with letters, digits, `_`
1051+and `-`. It ends at the first other character, so after `@let lang fr`,
1052+`$lang.json` is `fr.json`. A `.field` continues the name only when the value
1053+is a record or a list (`$post.title`, `$tags.0`). `${name}` is the same name
1054+with explicit ends, for text that follows it directly, and `${EXPR}` inserts
1055+the value of an [expression](#expressions). A `$` followed by anything else
1056+is text.
1057+
1058+```
1059+@let lang fr
1060+@let size 4
1061+@data $post {"title": "Hello"}
1062+@text locales/$lang.json, ${size}px, $post.title, $5
1063+```
1064+
1065+A name that isn't defined is an error. A field that a record doesn't have
1066+is empty, and so is any field of it, so optional fields of `@data` records
1067+work: `@if $post.draft` is false, `$post.author.name` is empty when there is
1068+no `author`, and `${default($post.tag, none)}` gives `none`.
1069+
1070+### Values
1071+
1072+A value is text, a number, `true` or `false`, a list or a record, and a
1073+name holds a whole value: a `@let`, a parameter, `@each` and `@data` bind
1074+one, and binding the name again replaces it. What a `@let` holds is what it
1075+says:
1076+
1077+```
1078+-- Text, as written
1079+@let size 16px
1080+-- Commas make a list, which prints as it was written
1081+@let fruits apple, banana, cherry
1082+-- Quoted, or with `\,`, text with commas in it is one text
1083+@let tagline "Fast, simple"
1084+@let motto small\, fast
1085+-- A range of whole numbers
1086+@let steps 1..9 step 4
1087+-- One `$name` or `${...}` keeps the type of what it holds
1088+@data $posts [{"title": "Hello"}, {"title": "Again"}]
1089+@let first $posts.0
1090+@let backwards ${reverse($fruits)}
1091+@text [font-size $size] $fruits: ${length($fruits)}. $tagline: ${length($tagline)}. $motto. $steps
1092+@text $first.title, $backwards
1093+```
1094+
1095+The last lines give `apple, banana, cherry: 3. Fast, simple: 12. small,
1096+fast. 1..9 step 4` and `Hello, cherry, banana, apple`. A value that is
1097+exactly one `$name` or `${...}` keeps its type wherever it goes: a `@let`, a
1098+function's parameter or default, the list of `@each`. So a record can be
1099+passed to a function whole (`@post-card [post $p]`), and a list stays a
1100+list.
1101+
1102+- Text written without quotes reads as a number when it is one (`3`,
1103+ `0.5`), and as false when it is `false` or `0`: that is how htmlang writes
1104+ numbers and flags (`@let gap 8`, `@card [dot false]`). Quoted text is
1105+ always text.
1106+- **False** is `false`, empty text, `0` and an empty list (or record).
1107+ Everything else is true, including `no` and quoted `"0"`.
1108+- `==` and `!=` compare numbers as numbers (`1.0 == 1`), lists and records
1109+ item by item, and anything else as text, exactly (`#FFF` isn't `#fff`).
1110+ `<`, `>`, `<=` and `>=` compare numbers as numbers and text by character
1111+ order.
1112+- A computed number prints without float noise: whole numbers without
1113+ decimals, others with at most four (`${100 / 3}` is `33.3333`).
1114+- A list prints as written when the source wrote it, and otherwise as its
1115+ items joined with `, `. A record has no text of its own, so writing one
1116+ (or a list of records) where text goes is an error: write one of its
1117+ fields, or loop over the list with `@each`.
1118+- A `$list` in a comma list is one item, a list inside the list:
1119+ `@let more $items, d` has two items. htmlang has no list concatenation.
1120+
1121+**Quoted text remembers that it was quoted.** A value written `"..."` (in a
1122+`@let`, an attribute or a function's argument) keeps its quotes in a CSS
1123+value, where CSS needs them, and loses them in text, in HTML attribute
1124+values and in expressions (`${length($x)}` counts no quotes). It stays
1125+quoted when it passes through another `@let` or a parameter. Inside a quoted string of a CSS value, it inserts
1126+what it says, without its own quotes:
1127+
1128+```
1129+@let arrow "→ "
1130+@let label "Next, please"
1131+@el [before:content $arrow, after:content " ($label)", aria-label=$label] $label
1132+```
1133+
1134+This gives `content:"→ "`, `content:" (Next, please)"`,
1135+`aria-label="Next, please"` and the text `Next, please`. A value written
1136+without quotes is inserted as written everywhere.
1137+
1138+### Functions
1139+
1140+A function's parameters are listed in brackets after its name and written
1141+the way a call passes them: a name alone (`title`) is a required parameter,
1142+and a name and a value (`tone #f9fafb`) is a parameter with that default.
1143+The body uses them as `$title` and `$tone`. `@let @name` without brackets
1144+takes no parameters.
1145+
1146+A default is filled in at each call that leaves its parameter out, like a
1147+value passed for it: it may hold spaces, quotes, escapes, `${...}` and
1148+`$variables`. It sees what the body sees: the names visible where the
1149+function is defined and the parameters declared before it
1150+(`[title, heading "About $title"]`). A default that uses a parameter
1151+declared after it is an error.
1152+
1153+A function is called like an element, wherever an element can be: on a
1154+line of its own, in a [chain](#chains) (`@el > @card [title Hi]`) or
1155+inline in text (`{@key Ctrl+K}`):
1156+
1157+- Its parameters are passed by name, as attributes: `name value`, or the
1158+ name alone for `true`. A parameter with a default can be left out;
1159+ leaving out one without a default is an error that names it. `=` writes
1160+ an HTML attribute, so `title=Hi` for a parameter is an error too.
1161+- Every other attribute goes to the function's root element: a style, a
1162+ flag, or a `key=value` HTML attribute such as `id=intro`. It is checked
1163+ like an attribute written on that element, so `@panel [title Hi,
1164+ padding 40]` works the same as styling a built-in element, and
1165+ `[paddin 40]` gets the same warning. A name close to one of the
1166+ parameters (`titel Hi`) is a misspelled parameter, which is an error.
1167+ This needs the body to have a single root element: attributes on a call
1168+ whose body has several roots, or is text, are an error. A `class=` adds
1169+ to the root's own classes.
1170+- A parameter passed twice (in the call's list, or after a bundle that
1171+ passes it) takes the later value, as any attribute does.
1172+- Text after the attributes and the indented lines are the call's
1173+ content, and replace `@children` in the body. A `@slot NAME` block
1174+ directly under the call (or under an `@if`, `@else` or `@each` there)
1175+ fills the body's `@slot NAME` instead.
1176+- The lines indented under `@children` or `@slot NAME` in the body are its
1177+ fallback: they are shown when a call passes no content, or no block for
1178+ that slot.
1179+
1180+```
1181+@let @card [title, tone #f9fafb]
1182+ @article [padding 16, spacing 8, background $tone, border-radius 8]
1183+ @row [align-items center]
1184+ @h3 $title
1185+ @spacer
1186+ @slot actions
8811187 @children
1188+ @slot footer
1189+ @text [font-size 12, color gray] No footer
1190+
1191+@card [title Plain]
1192+ Just children.
1193+@card [title Full, tone #eff6ff, padding 24]
1194+ @slot actions
1195+ @link /edit Edit
1196+ The children go here.
1197+ @slot footer
1198+ @text Updated today
8821199```
8831200
884−When `@old-card` is called, the compiler emits: `warning: @old-card is deprecated: Use @card-v2 instead`
885−
886−## Color functions
887−
888−Color manipulation via variable filters:
1201+`@children` takes a fallback the same way:
8891202
8901203```
891−@let primary #3b82f6
1204+@let @notice
1205+ @el [padding 12, background #fef3c7]
1206+ @children
1207+ @text Nothing to report.
1208+
1209+@notice
1210+@notice Deploys are paused today.
1211+```
1212+
1213+Content that would go nowhere is an error, so a mistake can't drop it:
1214+
1215+- a `@slot NAME` block for a slot the function doesn't have (the message
1216+ lists the slots it has);
1217+- text or lines passed to a function whose body has no `@children`;
1218+- a `@slot NAME` block inside an element at the call, instead of directly
1219+ under the call;
1220+- `@slot` or `@children` outside a function's body, or inline in text;
1221+- `@children` or `@slot` after an element's attributes (`@td [padding 8]
1222+ @children`), where it would be text: it goes on a line of its own.
1223+
1224+A slot's name is one word of letters, digits, `-` and `_`, starting with a
1225+letter, like a function's. Inside a body, a call can pass on what the
1226+function got: `@children` under the call passes the content, and a
1227+`@slot footer` block holding `@slot footer` passes that slot.
1228+
1229+A parameter that is off unless the call names it is a flag: give it the
1230+default `false`, and name it alone to turn it on.
1231+
1232+```
1233+@let @post-card [post, featured false, label "About $post"]
1234+ @article [spacing 8, padding ${if($featured, 24, 0)}]
1235+ @if $featured
1236+ @text [font-weight bold] Featured
1237+ @h3 $label
1238+
1239+@post-card [post htmlang, featured]
1240+@post-card [post CSS]
1241+```
1242+
1243+An `@style` block at the top of a function body is **scoped** to the
1244+function. Its rules apply inside the function's root element, and `&` is the
1245+root itself. This requires the body to have a single root element. The
1246+stylesheet goes into the page once, when the function is first called, so
1247+a function that is never called adds nothing. It is in the layer
1248+`hl-inside`, with the styles of element prefixes (see [CSS](#css)): what an
1249+element says about itself wins over it, so a call's `[padding 20]` wins
1250+over the function's `& { padding: 12px; }`, as it would over the root's own
1251+defaults. Where CSS properties are all it needs, an element prefix on the
1252+root says the same without a stylesheet (`@aside [@h2:font-size 18]`).
1253+Only an `@style` at the top of the body is scoped: one under an `@if` or an
1254+element is the page's, where `&` is the whole page, so the compiler warns
1255+about a `&` there.
1256+
1257+```
1258+@let @note [kind Note]
1259+ @style
1260+ & { border-left: 4px solid #3b82f6; }
1261+ .title { font-weight: bold; }
1262+ @el [padding 12, border-radius 6, background #eff6ff]
1263+ @text [class=title] $kind
1264+ @children
8921265
893−@el [background $primary|lighten:20] -- 20% lighter
894−@el [background $primary|darken:10] -- 10% darker
895−@el [background $primary|alpha:0.5] -- 50% transparent (#3b82f67f)
896−@el [background $primary|mix:#ffffff:50] -- 50% mixed with white
1266+@note [kind Tip, padding 20] Scoped styles and forwarded attributes.
8971267```
8981268
899−Filters: `lighten:N` (0-100), `darken:N` (0-100), `alpha:N` (0-1), `mix:COLOR:N` (0-100).
900−
901−## Enhanced `@keyframes`
902−
903−Keyframes support htmlang attribute syntax:
1269+A call in text or in a chain whose body has several roots, or is text,
1270+puts them in its place, like `@fragment`. A function whose body is text
1271+holds multi-line content, and a small function works inside a sentence:
9041272
9051273```
906−@keyframes fade-in
907− from [opacity 0]
908− to [opacity 1]
1274+@let @intro
1275+ htmlang is a layout language.
1276+ It compiles to {@strong static HTML}.
1277+@let @key
1278+ @kbd [padding 1 6, border 1 solid #d1d5db, border-radius 4]
1279+ @children
9091280
910−@keyframes slide
911− 0% [transform translateX(-100%)]
912− 50% [transform translateX(0), opacity 1]
913− 100% [transform translateX(100%), opacity 0]
1281+@paragraph
1282+ @intro
1283+@paragraph
1284+ In short: {@intro} Press {@key Ctrl+K} to search.
9141285```
9151286
916−Raw CSS syntax is also supported for backwards compatibility.
917−
918−## Additional attributes
919−
920−| Attribute | Effect |
921−|-----------|--------|
922−| `autofocus` | Auto-focus element on page load (boolean) |
923−
924−## Named grid areas
925−
926−Use CSS Grid's named template areas with the `grid-template-areas` and `grid-area` attributes:
1287+A function may call itself, under a condition that stops it, so it can
1288+render nested data such as a menu. A parameter passed one `$name` that
1289+holds a record or a list gets the whole value, fields and items
1290+included. Calls nest at most 64 deep: a function that calls itself with
1291+nothing to stop it is an error. Since a body sees only what is defined
1292+above its function, two functions can't call each other.
9271293
9281294```
929−@el [grid, grid-template-areas "header header" "sidebar main" "footer footer", gap 20]
930− @el [grid-area header, padding 10, background #3b82f6]
931− Header
932− @el [grid-area sidebar, padding 10]
933− Sidebar
934− @el [grid-area main, padding 10]
935− Main content
936− @el [grid-area footer, padding 10]
937− Footer
1295+@data $menu [
1296+ {"label": "Guide", "children": [{"label": "Install"}, {"label": "Usage"}]},
1297+ {"label": "Reference"}
1298+]
1299+@let @tree [items]
1300+ @ul [padding-left 16]
1301+ @each $item in $items
1302+ @li
1303+ @text $item.label
1304+ @if $item.children
1305+ @tree [items $item.children]
1306+
1307+@tree [items $menu]
1308+```
1309+
1310+The elements a function's body writes are the call's: a problem with
1311+one of them, such as low contrast or `spacing` on an element that isn't a
1312+row, column or grid, is reported at the call, once, and names the function. A
1313+problem in the text of a body is reported on its own line, or at the call
1314+when the function comes from `std.hl` or another file.
1315+
1316+Naming a function after a built-in element or a directive is a warning:
1317+`@let @button` replaces `@button` in every call after it, and a function
1318+named `@if` could never be called. Inside its own body `@button` is the
1319+function too, so a function that wraps the element it is named after,
1320+outside an `@if`, is an error: give it another name.
1321+
1322+### CSS custom properties
1323+
1324+`@let --name value` declares the CSS custom property `--name` on `:root`,
1325+for the whole page. Its value is written as it is, with no pixels added,
1326+so a length takes its unit (`@let --radius 8px`). A token is read one way,
1327+`var(--name)`, in the browser, so an element (`[dark:--name value]`, see
1328+[Custom properties](#custom-properties)) or a stylesheet can still
1329+redefine it. It is not a variable: `$--name` is an error that says to
1330+write `var(--name)`. Since `:root` is one place for the whole page, a
1331+`@let --name` goes at the top level of the file, once: inside an element,
1332+an `@if`, a loop or a function's body it is an error (set the property on an
1333+element with `[--name value]` instead), and declaring it again warns.
1334+
1335+A colour variant of a token is CSS too, so it follows the token wherever
1336+it is redefined: `color-mix()` mixes two colours, and a relative colour
1337+(`rgb(from ...)`) keeps a colour's channels except those you write (`/ 0.5`
1338+for its alpha). `in srgb` mixes the red, green and blue channels, as most
1339+colour tools do; `in oklab` gives steps that look more even, a good choice
1340+for new tokens.
1341+
1342+| For | Write |
1343+|---|---|
1344+| A darker colour | `color-mix(in srgb, var(--brand), black 10%)` |
1345+| A lighter colour | `color-mix(in srgb, var(--brand), white 10%)` |
1346+| A transparent colour | `rgb(from var(--brand) r g b / 0.5)` |
1347+| Two colours mixed | `color-mix(in srgb, var(--brand), #f43f5e 50%)` |
1348+
1349+```
1350+@let --brand #3b82f6
1351+@let --radius 8px
1352+@page [dark:--brand #60a5fa] Themed
1353+@el [background var(--brand), border-radius var(--radius), border 1 solid color-mix(in srgb, var(--brand), black 10%)] Themed
1354+@row
1355+ @each $shade in 0, 10, 20, 30
1356+ @el [background color-mix(in srgb, var(--brand), black $shade%)] $shade%
1357+```
1358+
1359+## Expressions
1360+
1361+Conditions and computed values (`@let x = ...`) are expressions:
1362+
1363+| | |
1364+|---|---|
1365+| Values | numbers, `"strings"` (with `$var` interpolation), `$variables` (with their type: a list or a record too), `$record.field`, `true`, `false`, ranges `A..B` and `A..B step N`, and bare words (`dark`, `#fff`) as text |
1366+| Arithmetic | `+ - * / %` with the usual precedence, unary `-`, `( )` |
1367+| Comparison | `== != < > <= >=`: numbers as numbers, text exactly, lists and records item by item (see [Values](#values)) |
1368+| Logic | `and`, `or`, `not`. `false`, empty text, `0` and an empty list are false |
1369+| Choice | `if(CONDITION, A, B)`, where `B` may be left out (empty) |
1370+| Tests | `contains(s, x)` (in a text, or as an item of a list), `starts-with(s, x)`, `ends-with(s, x)` |
1371+| Text | `uppercase(s)`, `lowercase(s)`, `capitalize(s)`, `trim(s)`, `length(s)` (the items of a list, or the characters of a text), `reverse(s)` (a list's items, or a text's characters), `truncate(s, n)`, `replace(s, old, new)`, `default(s, fallback)` (the fallback when `s` is empty text or an empty list) |
1372+
1373+Colour maths is CSS's, not an expression's: see
1374+[CSS custom properties](#css-custom-properties). A CSS function such as
1375+`color-mix()` goes in an attribute's value as it is, or in a plain
1376+`@let` value (`@let hover color-mix(in srgb, var(--brand), black 8%)`),
1377+not in `@let x = ...` or `${...}`.
1378+
1379+Variables are looked up during evaluation, so a value that contains `==` or
1380+spaces is still one value. An invalid expression is a compile error, and so
1381+is an undefined variable. A text function given a list is an error too,
1382+instead of a guess: `uppercase()` of `Fast, simple` (a list, because of its
1383+comma) says so, and the text is written `"Fast, simple"` or `Fast\, simple`.
1384+A variable's name ends at `..`, so `${$from..$to}` is a range.
1385+
1386+Only what decides the result is evaluated: `if()` evaluates the branch it
1387+takes, and `and` and `or` stop at the side that decides. So
1388+`${if($n != 0, 10 / $n, 0)}` and `@if $n != 0 and 10 / $n > 1` work when
1389+`$n` is 0. The rest is still read, and its syntax and function names are
1390+checked.
1391+
1392+In text, values and file paths, `${EXPR}` inserts the value of any
1393+expression (see [Variables](#variables)):
1394+
1395+```
1396+@let name htmlang
1397+@let size 12
1398+@text [font-size ${$size + 4}] ${uppercase($name)} has ${length($name)} letters
1399+```
1400+
1401+## Control flow
1402+
1403+All control flow runs at compile time.
1404+
1405+```
1406+@let count 3
1407+@let hidden false
1408+
1409+@if $count > 2 and not $hidden
1410+ @text Many
1411+@else if $count == 0
1412+ @text None
1413+@else
1414+ @text Few
9381415```
9391416
940−## Animate shorthand
941−
942−The `animate` attribute is shorthand for the CSS `animation` property:
1417+`@each $item in LIST` repeats its body for each item. Its variables are
1418+written with `$`, like `@data $name`. LIST is a value, read like the value
1419+of a `@let`: items written with commas (a quoted item or one with `\,` is
1420+one text), a range `A..B` (which counts down when its start is greater than
1421+its end, and takes `step N`), or one `$name` or `${...}` that holds a list,
1422+such as one loaded with `@data` or `${reverse(1..5)}`. A text is one item,
1423+and empty text none. Each item is bound whole, so a record keeps its fields.
1424+An optional second variable is the index, starting from 0. `@else` gives
1425+the content to show when the list is empty.
9431426
9441427```
945−@keyframes fade-in
946− from [opacity 0]
947− to [opacity 1]
1428+@let fruits apple, banana, cherry
1429+@each $fruit, $i in $fruits
1430+ @text ${$i + 1}. $fruit
1431+@else
1432+ @text No fruit.
9481433
949−@el [animate fade-in 0.3s ease]
950− Fades in on load
1434+@row [spacing 8]
1435+ @each $n in 10..0 step 5
1436+ @text $n
9511437```
9521438
953−## View transitions
954−
955−The `view-transition-name` attribute enables the View Transitions API for smooth page transitions:
956−
957−```
958−@el [view-transition-name hero]
959− Hero content that transitions between pages
960−```
1439+## Data and files
9611440
962−## `:has()` pseudo-selector
1441+| Directive | Effect |
1442+|---|---|
1443+| `@data $name file.json` | Load a JSON file. Objects are records (`$name.key`) and arrays are lists |
1444+| `@data $name [...]` / `@data $name {...}` | Inline JSON, which may span several lines |
1445+| `@data $name dir/*.json` | A list with one record per file, in name order. `$item.file` is the file's name |
1446+| `@data $name env:NAME DEFAULT` | An environment variable, with an optional default |
1447+| `@include file.hl` | Insert another file: its content and its definitions. A file that holds only definitions outputs nothing (a [library](#page-layouts)) |
1448+| `@markdown` / `@markdown file.md` | Markdown (an indented body or a file), converted to HTML |
1449+| `@image [inline] file.svg` | Put the file inside the page: SVG as markup, other images as base64. The file is read next to the page, and one that can't be read is an error. The SVG's root gets `width` and `height` (lengths, not `fill` or `shrink`) and `color` or `fill` (as its `fill`) in its `style=`, after the file's own, where `var(--name)` works, and the HTML attributes (`class=`, `aria-label=`, ...); any other style, and `alt=`, is an error, since the markup has no generated class, and an element prefix (`@image:`) doesn't reach it. `inline` goes only on `@image`, without a prefix |
9631450
964−Style elements based on their children using the `has()` prefix:
1451+Records keep their values whole, even when a value contains spaces or
1452+commas:
9651453
9661454```
967−@el [padding 20, has(.active):background #dbeafe, has(img):padding 0]
968− Content
1455+@data $team [
1456+ {"name": "Ada", "role": "Engineering, research"},
1457+ {"name": "Grace", "role": "Design"}
1458+]
1459+@ul [spacing 4]
1460+ @each $person in $team
1461+ @li
1462+ @text [font-weight bold] $person.name
1463+ @text $person.role
1464+@text ${length($team)} people
9691465```
9701466
971−Generates CSS `:has()` selectors: `.class:has(.active) { background:#dbeafe; }`
972−
973−## Computed `@let`
1467+### Page layouts
9741468
975−Variables support arithmetic expressions. The `=` sign is optional:
1469+A layout is an ordinary function in a file of its own. It marks where content
1470+goes with `@slot NAME` (named blocks) and `@children` (everything in the call
1471+that is outside a `@slot` block), each with fallback content indented under
1472+it.
9761473
9771474```
978−@let base 16
979−@let large = $base * 2 -- 32
980−@let gap $base + 4 -- 20 (= is optional)
1475+-- layout.hl
1476+@let @layout
1477+ @page [lang=en, background #f8fafc] My Site
1478+ @el [width fill, max-width 800, center-x, spacing 24]
1479+ @header
1480+ @slot header
1481+ @text Default header
1482+ @main
1483+ @children
9811484```
9821485
983−Supported operators: `+`, `-`, `*`, `/`.
984−
985−## Named slots in `@fn`
986−
987−Functions support named `@slot` blocks for multi-region components:
988−
9891486```
990−@fn layout $title
991− @column [max-width 800, center-x, padding 40]
992− @slot header
993− @text [bold, size 32] $title
994− @slot content
995− @slot footer
996− @text [color #888] Default Footer
997−
998−@layout [title My Page]
1487+-- page.hl
1488+@include layout.hl
1489+@layout
9991490 @slot header
1000− @text [bold, size 32] Custom Header
1001− @slot content
1002− @paragraph Main content here
1003−```
1004−
1005−Slots not filled by the caller use the default children from the function definition.
1006−
1007−## New elements
1008−
1009−### `@script`
1010−
1011−Embeds JavaScript. Supports inline code and external files via `src`. Children are raw JS (not HTML-escaped).
1012−
1013−```
1014−@script [src app.js, defer]
1015−
1016−@script
1017− console.log("hello world");
1018− document.addEventListener("DOMContentLoaded", () => {
1019− init();
1020− });
1021−```
1022−
1023−Attributes: `src`, `type`, `defer`, `async`, `crossorigin`, `integrity`, `nomodule`.
1024−
1025−### `@noscript`
1026−
1027−Fallback content displayed when JavaScript is disabled.
1028−
1029−```
1030−@noscript
1031− @text This page requires JavaScript.
1032−```
1033−
1034−### `@address`
1035−
1036−Contact information, rendered as `<address>`.
1037−
1038−```
1039−@address
1040− @text [bold] John Doe
1041− @link mailto:john@example.com john@example.com
1042−```
1043−
1044−### `@search`
1045−
1046−HTML5 `<search>` landmark for search functionality.
1047−
1048−```
1049−@search
1050− @input [type search, placeholder Search...]
1051− @button [type submit] Search
1052−```
1053−
1054−### `@breadcrumb`
1055−
1056−Semantic breadcrumb navigation. Generates `<nav aria-label="breadcrumb">` with an `<ol>` list. Each child becomes an `<li>`.
1057−
1058−```
1059−@breadcrumb [spacing 10]
1060− @link / Home
1061− @link /docs Documentation
1062− @text Current Page
1063−```
1064−
1065−## New directives
1066−
1067−### `@canonical`
1068−
1069−Sets the canonical URL. Generates `<link rel="canonical">` in the document head.
1070−
1071−```
1072−@canonical https://example.com/my-page
1073−```
1074−
1075−### `@base`
1076−
1077−Sets the base URL for relative links. Generates `<base href="...">`.
1078−
1079−```
1080−@base https://example.com/
1491+ @h1 About us
1492+ @paragraph This fills @children.
1493+```
1494+
1495+The layout holds the page's `@page`, whose attributes can come from its
1496+parameters (`@page [background $bg] $title`). A page has one `@page`, so a
1497+second one is an error (`duplicate-page`): the page's own next to its
1498+layout's, or a layout called twice. The same `@meta` tag twice is written
1499+once. A file that holds only `@let`s, such as `layout.hl`, is a library
1500+(it may also read `@data` and `@include` other libraries): its definitions
1501+aren't reported unused, in it or in a page that includes it and uses only
1502+some of them, and `htmlang build`, `serve` and `watch` don't build it into
1503+a page of its own. An included file's unused definitions are never
1504+reported in the file that includes it.
1505+
1506+## Page and head
1507+
1508+`@page TITLE` makes the output a full HTML document. Without it, the output
1509+is a fragment, which has no `<head>`: `@meta` and `@head` in it are a
1510+warning. `--partial` writes a fragment of a page too, and warns that
1511+`@page`, `@meta` and `@head` are left out. The page is the root element, and `@page`'s attributes are
1512+checked like any element's:
1513+
1514+- Styles style `<body>`, prefixes included, so a page's colour, font and
1515+ dark background go on `@page` and cover the whole window.
1516+- `key=value` attributes go on `<html>`: `lang=en`, `dir=rtl`, `class=x`.
1517+- `favicon FILE` is its one word of htmlang's own: the file is put into
1518+ the page as its icon (or linked, when it can't be read).
1519+
1520+`<body>` is a column that fills the window (`display: flex;
1521+flex-direction: column; min-height: 100dvh`, from the reset), so the
1522+page's top-level elements are laid out like the children of an `@el`:
1523+they stack, even a line of text or an inline element such as `@text` or
1524+`@link`, and each takes the full width unless it says otherwise. A
1525+centred column at the top writes `width fill` like anywhere else (see
1526+[Rows, columns and text](#rows-columns-and-text)).
1527+
1528+`@meta NAME VALUE` adds a meta tag, and names that start with `og:` become
1529+Open Graph `property` tags; a `@meta viewport` replaces the usual one.
1530+`@head` holds any other raw HTML for the `<head>`, such as a font link, a
1531+canonical URL or JSON-LD, on its line or in its indented block.
1532+
1533+```
1534+@page [lang=en, favicon favicon.png, color #1f2937, dark:background #0b1220, dark:color #e5e7eb] My Site
1535+@meta description A small site
1536+@meta og:title My Site
1537+@head <link rel="canonical" href="https://example.com/">
1538+@head
1539+ <script type="application/ld+json">{"@type": "WebSite"}</script>
1540+@header [padding 16] My Site
1541+@main [height fill, padding 16]
1542+ The main part takes the rest of the window.
1543+@footer [padding 16] © 2026
10811544```
10821545
1083−### `@font-face`
1084−
1085−Declares a custom font. Generates a CSS `@font-face` rule with `font-display: swap`. Format is auto-detected from the file extension.
1546+Translations are a JSON file per locale: `@data $t locales/$lang.json`
1547+loads `locales/fr.json` when `$lang` is `fr`.
10861548
1087−```
1088−@font-face Inter fonts/inter.woff2
1089−@font-face Mono fonts/jetbrains-mono.ttf
1090−```
1091−
1092−### `@json-ld`
1549+## CSS
10931550
1094−Structured data for SEO. Generates a `<script type="application/ld+json">` block. Indented body is raw JSON.
1551+`@style` holds raw CSS, including at-rules such as `@keyframes`,
1552+`@font-face`, `@property` and `@starting-style`, in its indented block or,
1553+for a single rule, on its line:
10951554
10961555```
1097−@json-ld
1098− {
1099− "@context": "https://schema.org",
1100− "@type": "WebPage",
1101− "name": "My Site"
1556+@style
1557+ @keyframes fade-in {
1558+ from { opacity: 0; }
1559+ to { opacity: 1; }
11021560 }
1103−```
1104−
1105−## Additional pseudo-states
1106−
1107−| Prefix | CSS Selector | Purpose |
1108−|--------|--------------|---------|
1109−| `visited:` | `:visited` | Visited links |
1110−| `empty:` | `:empty` | Empty elements |
1111−| `target:` | `:target` | URL fragment target |
1112−| `valid:` | `:valid` | Valid form inputs |
1113−| `invalid:` | `:invalid` | Invalid form inputs |
1114−
1115−```
1116−@link [visited:color purple] https://example.com
1117− Already visited
1118−
1119−@input [type email, valid:border 2 green]
1120−@el [target:background yellow, id section-1]
1121− Highlighted when navigated to
1122−```
1123−
1124−## Additional CSS properties
1125−
1126−| Attribute | Effect |
1127−|-----------|--------|
1128−| `text-underline-offset N` | Offset of text underline from text |
1129−| `column-width N` | Ideal column width for multi-column layout |
1130−| `column-rule VALUE` | Rule between columns (e.g., `1px solid #ccc`) |
1131−
1132−```
1133−@text [underline, text-underline-offset 4, text-decoration-thickness 2]
1134− Styled underline
1135−
1136−@el [column-count 3, column-width 200, column-rule 1px solid #ccc]
1137− Multi-column content
1138−```
1139−
1140−## CSS `@layer` wrapping
1141−
1142−Generated styles are wrapped in `@layer htmlang { ... }` for specificity management. This allows `@style` blocks and `@raw` CSS to easily override generated styles without specificity wars.
1143−
1144−## CLI commands
1145−
1146−### `htmlang deps`
1147−
1148−Show the file dependency graph (`@include`, `@import`, `@extends` relationships):
1149−
1150−```
1151−htmlang deps src/
1152−```
1153−
1154−### `htmlang dead-code`
1155−
1156−Find unused `@fn`, `@define`, and `@let` definitions across an entire project:
1157−
1158−```
1159−htmlang dead-code src/
1160−```
1161−
1162−### `htmlang deploy`
1163−
1164−Build and deploy to GitHub Pages:
1165−
1166−```
1167−htmlang deploy src/
1168−```
1169−
1170−Compiles all `.hl` files, copies static assets, and pushes to a `gh-pages` branch.
1171−
1172−### `htmlang clean`
1173−
1174−Remove generated `.html` files from a directory (matching `.hl` source files). Also removes `sitemap.xml` if present.
1175−
1176−```
1177−htmlang clean src/
1178−htmlang clean # clean current directory
1179−```
1180−
1181−### `htmlang outline`
1182−
1183−Show the document structure tree — a quick overview of elements and nesting without compiling.
1184−
1185−```
1186−htmlang outline page.hl
1187−```
1188−
1189−### `htmlang playground`
1190−
1191−Generate a self-contained HTML playground for experimenting with htmlang:
1192−
1193−```
1194−htmlang playground # writes playground.html
1195−htmlang playground my-play.html # custom output path
1196−htmlang clean src/ # remove generated .html files
1197−htmlang outline page.hl # show document structure tree
1198−```
1199−
1200−## Editor support
1201−
1202−A VS Code extension is available in `editors/vscode/` with:
1203−
1204−- Syntax highlighting via TextMate grammar
1205−- LSP integration via `htmlang-lsp` for:
1206− - Real-time diagnostics and error checking
1207− - Completions for elements, attributes, variables, and functions
1208− - Hover documentation for all elements and attributes
1209− - Go to definition for variables, defines, and functions
1210− - Find all references for variables and functions
1211− - Rename refactoring for variables and functions
1212− - Signature help for `@fn` parameters
1213− - Document formatting (format on save)
1214− - Code actions (quick-fixes for typos, unused variables, missing attributes)
1215− - Auto-import suggestions (scans project for `@fn` definitions)
1216− - Extract selection to `@fn` refactoring
1217− - Color picker for hex colors
1218− - Code folding and document symbols
1219− - Semantic tokens for syntax highlighting
1220− - VS Code snippets for common patterns (`@fn`, `@each`, `@grid`, `@form`, etc.)
1561+ .note { color: gray; }
1562+@style .quiet { opacity: 0.6; }
1563+@el [animation fade-in 0.3s ease, class=note] Fades in
1564+```
1565+
1566+Each element with styles gets a generated class, and elements with the
1567+same styles share one. A class is named by its style: `hl-` and seven
1568+characters of a hash of what it sets (`hl-2k9xq0m`), so one style has one
1569+name in every file. A fragment put into a page (`--partial` output that a
1570+server returns, or any HTML of one file put into another's page) means
1571+the same there, and its rules restyle nothing of the page's: a class of
1572+both is the same style. Two different styles of one file never share a
1573+name (the later one takes more characters), and `htmlang build` checks
1574+the whole site: two files whose different styles hash to one name are an
1575+error (`class-collision`), which one more attribute on either style
1576+fixes. A function's scoped `@style` is named by the function and a hash
1577+of the stylesheet, `hl-fn-card-1x0a9zq`. The `hl-` prefix is htmlang's:
1578+a class of your own that starts with it gets a warning, since the generated
1579+rules would apply to it too. Every style goes into the class under its own
1580+name, with its value as written (plus pixels, see
1581+[CSS properties](#css-properties)); only the layout words, and
1582+`line-clamp`'s fallback, write more than one declaration.
1583+
1584+An element's defaults go with its own class: its layout (a column is
1585+`display: flex`), the margins browsers give headings, paragraphs, lists,
1586+figures and blockquotes are 0, lists have no markers, `@fieldset` has a
1587+thin border and padding, `@code`, `@kbd` and `@pre` are monospace, `@link`
1588+has no underline and takes its parent's text colour, and `@image` is a
1589+block. They apply only to htmlang's own elements, so HTML that comes from
1590+`@markdown` or `@raw` keeps the browser's defaults: a Markdown list keeps
1591+its bullets and a Markdown link its underline.
1592+
1593+The generated rules live in three cascade layers, after a small reset in
1594+the layer `hl-reset`, and a later layer wins over an earlier one whatever
1595+the specificity:
1596+
1597+| Layer | Holds |
1598+|---|---|
1599+| `hl-reset` | The reset |
1600+| `hl-kind` | The defaults of each element's kind, as `:where(.hl-2k9xq0m)` |
1601+| `hl-inside` | The styles an element gets from an element prefix on an element around it (`@td:padding 8`, see [Styling the elements inside](#styling-the-elements-inside)), and functions' scoped `@style` |
1602+| `htmlang` | Each element's own styles, and its parent's `children:` styles |
1603+
1604+So an element's own styles win over everything else htmlang writes for
1605+it; its parent's `children:` styles and the element prefixes of the
1606+elements around it win over its defaults.
1607+
1608+A page's reset sets `box-sizing: border-box` everywhere and makes
1609+`<body>` a column that fills the window. A fragment (a file
1610+without `@page`, or `--partial` output) goes into a page it doesn't own, so
1611+its reset touches only htmlang's own elements (those with an `hl-` class),
1612+which get `box-sizing: border-box`; no other element on the page is
1613+touched. In both, an element
1614+htmlang lays out stays hidden while it has `hidden`, while an `@dialog` is
1615+closed, and while a popover isn't showing, even though its generated
1616+`display` would otherwise beat the browser's `display: none`. A page with
1617+links, buttons or form fields also gives htmlang's ones a focus outline.
1618+CSS outside any layer takes precedence over every layer, so rules in
1619+`@style` or `@raw` override the generated ones.
README.md+196−132
@@ -1,34 +1,123 @@
11# htmlang
22
3−A minimalist layout language inspired by [elm-ui](https://package.elm-lang.org/packages/mdgriffith/elm-ui/latest/) that compiles to static HTML.
4−
5−`@` means structure. Bare lines mean content. No CSS required.
6−
7−## Example
3+A small layout language that compiles to static HTML. The layout model comes
4+from [elm-ui](https://package.elm-lang.org/packages/mdgriffith/elm-ui/latest/):
5+rows and columns, spacing between children, and elements that fill or center
6+themselves. Styling uses CSS properties under their CSS names, and every other
7+element uses its HTML name.
88
99```
10−@page My Site
11−@let primary #3b82f6
10+@page [lang=en, background #f8fafc] My Site
11+@let --brand #3b82f6
1212
13−@fn card $title
14− @el [padding 20, background white, rounded 8, border 1 #e5e7eb, hover:border 1 $primary, transition all 0.15s ease]
15− @text [bold] $title
13+@let @card [title]
14+ @article [padding 20, spacing 8, border 1 solid #e5e7eb, border-radius 8, hover:border-color var(--brand)]
15+ @h3 $title
1616 @children
1717
18−@column [max-width 800, center-x, padding 40, spacing 20]
19− @text [bold, size 32] Hello
20−
18+@el [width fill, max-width 800, center-x, padding 40, spacing 24]
19+ @h1 [font-size 32] Hello
2120 @paragraph
22− Built with {@text [bold, color $primary] htmlang}.
23−
24− @row [wrap, spacing 10]
21+ Built with {@text [font-weight bold, color var(--brand)] htmlang}.
22+ @row [spacing 16, wrap]
2523 @card [title Simple]
26− Write layouts without CSS
27− @card [title Fast]
28− Compiles to a single HTML file
29−```
30−
31−Compiles to a self-contained `.html` file with flexbox layout and generated CSS classes. No JavaScript, no external dependencies.
24+ Layout without writing a stylesheet.
25+ @card [title Static]
26+ One HTML file, with its CSS inside.
27+```
28+
29+Each page compiles to one self-contained `.html` file. It has no JavaScript
30+unless you write some, and nothing is added that you didn't ask for.
31+
32+## The language in brief
33+
34+- **`@` starts structure, and any other line is content.** Indentation nests
35+ elements. Text after an element's attributes is its content, read like
36+ any line of text, and `{...}` puts an element inside a line of text
37+ (`@h1 Hello {@text [color red] world}`). The text of `@code` and
38+ `@textarea` is shown as written, and the lines indented under them are
39+ verbatim, HTML-escaped with their line breaks kept, so `@pre > @code`
40+ over an indented block shows a code sample. `@raw`, `@style` and `@head`
41+ take the rest of their line or an indented block, kept as written
42+ (`@style .note { color: gray; }`). An element that points at a URL or a
43+ file takes it as its first word, and the rest is its content: `@link
44+ /about About us`, `@image logo.png`, `@form /subscribe`, `@script app.js`.
45+- **Layout comes from elm-ui.** Every element has one layout. `@el` and the
46+ containers (`@section`, `@nav`, `@ul`, `@li`, ...) are columns, `@row` is a
47+ row and `@grid` a grid: in them each line of text is a child, and
48+ `spacing` is the gap between the children. Text elements (`@paragraph`,
49+ `@h1`, `@button`, `@td`) let their lines flow, joined with spaces, and an
50+ `@el` inside text is laid out inline. Layout attributes (`width fill`,
51+ `center-x`, `align-right`, `wrap`) say how an element sits inside its
52+ parent, and follow the direction the parent's CSS sets: `@nav
53+ [flex-direction row]` is a row, and `md:flex-direction row` makes a
54+ column a row from that width up, children included. The page is the root
55+ element: `@page`'s styles go on `<body>`, a column that fills the window,
56+ and its `key=value` attributes on `<html>` (`@page [lang=en, background
57+ #f8fafc] Home`).
58+- **Styling is CSS.** Any other attribute is a CSS property with its CSS
59+ name and value: `padding 20`, `border 1 solid #eee`,
60+ `grid-template-columns 1fr 2fr`. In a length property, every bare
61+ number is pixels (`box-shadow 0 2 4 black` is `0 2px 4px black`); numbers
62+ in any other property (`flex 1`, `z-index 2`) and in custom properties
63+ stay numbers.
64+ A custom property is a style like any other: `@let --surface white`
65+ declares it for the whole page, and `[--gap 16px, md:--gap 24px]` sets
66+ it on an element and everything inside it, so dark mode redefines a
67+ token once (`@page [dark:--surface #0b1220]`) instead of every colour
68+ that uses it. A token is read one way, `var(--surface)`, and a colour
69+ variant is CSS's too (`color-mix(in srgb, var(--brand), black 8%)`,
70+ `rgb(from var(--brand) r g b / 0.5)`), so it follows the token.
71+ Prefixes make a style conditional: `hover:`, `md:`, `dark:`, and CSS's
72+ common pseudo-classes and pseudo-elements under their CSS names
73+ (`first-child:`, `nth-child(odd):`, `has(> img):`, `marker:`,
74+ `backdrop:`; the list is in DESIGN.md).
75+ They stack (`md:dark:background`, `hover:children:opacity`), and one
76+ prefix covers a group or a bundle (`md:[padding 32, font-size 20]`,
77+ `md:$card`).
78+ An element prefix styles every such element inside, at any depth:
79+ `@table [@td:padding 8]` pads every cell, and
80+ `@article [@h2:font-size 20, @code:background #f1f5f9]` styles what
81+ `@markdown` writes. An element's own attributes still win, and the
82+ nearest element that styles it wins over one further out.
83+ A comma separates attributes, so a comma inside a value is written `\,`
84+ (`transition opacity 0.3s\, transform 0.3s`), and quoted text keeps its
85+ quotes only in CSS (`before:content "→ "`).
86+- **Names are checked, values are CSS's.** A misspelled element, prefix,
87+ parameter or slot is an error. A CSS property htmlang doesn't know is
88+ passed through with a "did you mean" warning, and values go to the CSS as
89+ written (`outline 2 solid red` is `outline: 2px solid red`, nothing
90+ added). Nothing you write is left out of the page without an error.
91+- **The generated CSS stays on htmlang's elements.** Its classes are
92+ named by their styles (`hl-2k9xq0m`), in cascade layers (`hl-reset`,
93+ `hl-kind`, `hl-inside`, `htmlang`), so your own CSS wins. An element's
94+ defaults (no heading margins, no list markers, links in the text colour)
95+ go with its own class, so `@markdown` and `@raw` HTML, and a page that
96+ embeds `--partial` output, keep theirs. One style has one name in every
97+ file, so a fragment a server swaps into a page (with htmx, say) means
98+ the same there and restyles nothing of the page's.
99+- **HTML stays HTML.** An element that isn't about layout or text has its
100+ HTML name (`@nav`, `@ul`, `@form`, `@details`, `@strong`, `@em`, `@br`,
101+ `@caption`), from a fixed list, so a typo is an error rather than a new
102+ tag. HTML attributes are written `key=value` (`id=main`, `type=email`) or
103+ bare (`required`).
104+- **`@let` defines everything.** It defines values, computed values,
105+ attribute bundles and functions. A function's body puts a call's content
106+ where `@children` is and fills `@slot NAME` from the call's `@slot NAME`
107+ blocks, and content that would go nowhere (a misspelled slot, content for
108+ a function without `@children`) is an error. A layout is just a function
109+ with slots.
110+ `$name` fills in a value exactly where it is written (a line of text, an
111+ attribute's value, a file path), whole attributes come from a bundle or
112+ from `if()` (`if($active, [font-weight bold, aria-current=page])`), and
113+ an undefined name is an error where the code runs.
114+- **Values are typed: text, numbers, `true`/`false`, lists and records.**
115+ Commas make a list (`@let fruits apple, banana`), `1..5` is a range,
116+ `@data` loads JSON as records and lists, and a value passed as one `$name`
117+ keeps its type, so a record can go to a function (`@post-card [post $p]`).
118+ `@each` and `@if` run at compile time. A definition is visible from its
119+ line to the end of its block, and a function sees what is visible where
120+ it is defined.
32121
33122## Install
34123
@@ -39,143 +128,118 @@ cargo install --path .
39128## Usage
40129
41130```
42−htmlang init # scaffold a new project
43−htmlang page.hl # writes page.html
44−htmlang --watch page.hl # recompile on change
45−htmlang fmt page.hl # format a file
131+htmlang page.hl # compile page.hl to page.html
132+htmlang page.hl -o out.html # choose the output file
133+htmlang serve . # dev server with live reload
134+htmlang build src -o dist # compile a whole site
46135```
47136
48−## Editor support
137+| Command | Purpose |
138+|---|---|
139+| `build <dir> [-o out] [--minify] [--strict]` | Compile every `.hl` file under a directory (into `out/` by default), except libraries: files that hold only `@let`s. Two files whose different styles got one class name are an error (`class-collision`) |
140+| `serve [dir\|file] [-p PORT] [--open]` | Dev server with live reload. It serves files, so it answers GET and HEAD (other methods get 405), and reloads pages, not fragments |
141+| `watch [dir\|file] [-o out]` | Recompile on change, without a server |
142+| `check <file\|dir> [--format json]` | Report diagnostics without writing output |
143+| `lint <file\|dir> [--format json]` | Stricter checks (accessibility, nesting) |
144+| `fmt <file.hl>...` | Format files in place |
145+| `lsp` | Run the language server over stdio |
49146
50−A VS Code extension with syntax highlighting and LSP integration is available in [`editors/vscode`](editors/vscode). The language server (`htmlang-lsp`) provides diagnostics, completions, and hover documentation.
147+Compiling a file directly also takes `-w` / `--watch`, `--dev` (readable
148+output and source maps), `--strict`, `--partial` (a fragment, without the
149+document wrapper), `--format json`, `-s` / `--serve`, `-p` / `--port` and
150+`--open`.
51151
52−## Language overview
152+## A short tour
53153
54−### Elements
55−
56−| Element | Purpose |
57−|--------------|------------------------------|
58−| `@row` | Horizontal flex layout |
59−| `@column` | Vertical flex layout |
60−| `@el` | Generic container |
61−| `@text` | Styled inline text |
62−| `@paragraph` | Flowing text with inline elements |
63−| `@image` | Image |
64−| `@link` | Anchor |
65−| `@raw` | Verbatim HTML escape hatch |
66−| `@form` | Form container |
67−| `@details` | Disclosure widget |
68−| `@summary` | Summary for `@details` |
69−| `@blockquote`| Block quotation |
70−| `@cite` | Citation reference |
71−| `@code` | Inline code (monospace) |
72−| `@pre` | Preformatted text |
73−| `@hr` | Horizontal rule / divider |
74−| `@figure` | Figure with caption |
75−| `@figcaption`| Caption for `@figure` |
76−| `@progress` | Progress bar |
77−| `@meter` | Meter/gauge |
78−
79−### Layout attributes
154+Layout attributes place an element. Everything else is CSS, and `key=value`
155+is an HTML attribute:
80156
81157```
82−@row [spacing 20] -- gap between children
83−@row [gap-x 10, gap-y 20] -- separate horizontal/vertical gaps
84−@el [padding 20] -- uniform padding (also padding-x, padding-y)
85−@el [width fill] -- take remaining space (also width 200, width shrink)
86−@el [center-x] -- center horizontally (also align-left, align-right)
87−@el [overflow hidden] -- overflow behavior (hidden, scroll, auto)
158+@row [spacing 12, align-items center, padding 12 20, border-bottom 1 solid #e5e7eb, id=toolbar]
159+ @text [font-weight 700] Acme
160+ @spacer
161+ @input [type=search, placeholder=Search, aria-label=Search, width 240, padding 6 10]
162+ @button [type=submit, padding 6 14, hover:background #f3f4f6] Go
88163```
89164
90−### Style attributes
165+A prefix applies a style only in a state, from a screen width up, or under a
166+media condition. Prefixes stack, and a prefix before a `[group]` applies to
167+each style in it:
91168
92169```
93−@el [background #3b82f6, color white, rounded 8, border 1 #e5e7eb]
94−@text [bold, italic, underline, size 18, font Inter]
95−@el [opacity 0.5, cursor pointer, transition all 0.15s ease]
96−@el [shadow 0 2px 4px rgba(0,0,0,0.1)]
97−@paragraph [text-align center, line-height 1.5]
170+@el [padding 16, md:[padding 32, font-size 20], background #3b82f6, hover:background #2563eb, dark:[background #1e3a8a, hover:background #1e40af]]
171+ @text [color white] Click me
98172```
99173
100−### Positioning
174+An element prefix, `@td:`, styles every such element inside, so rows a
175+loop writes and HTML from `@markdown` need no attributes of their own:
101176
102177```
103−@el [position relative]
104− @el [position absolute, z-index 10]
105− Overlay content
178+@table [border-collapse collapse, @th:[padding 8, text-align left], @td:padding 8, @tr:nth-child(even):background #f8fafc]
179+ @tr
180+ @th Name
181+ @tr
182+ @td Ada
106183```
107184
108−### Pseudo-states and media prefixes
109−
110−Prefix any style attribute with `hover:`, `active:`, or `focus:`:
185+`@let` defines values, bundles and functions, in one namespace. A function
186+has `@` before its name and its parameters in brackets (`label`, or
187+`href #` with a default). It is called like an element, on its own line,
188+in a chain or inline in text: its parameters are attributes, `name value`
189+(a name alone is `true`), a parameter without a default must be passed,
190+and any other attributes style its root element and are checked like
191+attributes written there.
111192
112193```
113−@el [background #3b82f6, hover:background #2563eb, active:background #1d4ed8]
114−```
115−
116−Use `dark:` for dark mode and `print:` for print styles:
194+@let --primary #3b82f6
195+@let gap = 8 * 2
196+@let rounded [border-radius 8, overflow hidden]
117197
118−```
119−@el [background white, dark:background #1a1a2e, print:display none]
120−```
121−
122−### Variables and defines
198+@let @cta [label, href #]
199+ @link [$rounded, padding 10 16, background var(--primary), color white] $href
200+ $label
201+@let @key
202+ @kbd [padding 1 6, border 1 solid #d1d5db, border-radius 4]
203+ @children
123204
205+@row [spacing $gap]
206+ @cta [label Sign up]
207+ @cta [label Learn more, href /about, background #64748b]
208+@paragraph
209+ Press {@key Ctrl+K} to search.
124210```
125−@let primary #3b82f6 -- simple variable, used as $primary
126−@let greeting "Hello $name" -- quoted string interpolation
127−@define card [padding 20, rounded 8] -- attribute bundle, used as [$card]
128−```
129−
130−### Functions
131211
132−```
133−@fn button $label
134− @el [padding 12, background $primary, rounded 8]
135− @text [color white, bold] $label
136− @children -- slot for caller's children
212+Data, loops and conditions run at compile time:
137213
138−@button [label Click me]
139214```
215+@data $links [
216+ {"label": "Home", "url": "/"},
217+ {"label": "Blog", "url": "/blog"},
218+ {"label": "About us", "url": "/about"}
219+]
220+@let current /blog
140221
141−### File includes
142−
143−```
144−@include header.hl -- inline another .hl file
222+@nav
223+ @row [spacing 16]
224+ @each $link in $links
225+ @link [if($link.url == $current, [font-weight bold, aria-current=page])] $link.url $link.label
145226```
146227
147−### Multi-line attributes
228+The [`examples/`](examples) directory has complete pages (a landing page, a
229+blog, a docs page, and a tour of the whole language). [DESIGN.md](DESIGN.md)
230+is the language reference.
148231
149−Attribute lists can span multiple lines:
232+## Editor support
150233
151−```
152−@el [
153− padding 20,
154− background white,
155− rounded 8,
156− shadow 0 2px 4px rgba(0,0,0,0.1)
157−]
158− Content here
159−```
160−
161−### Other features
162−
163−- `--` comments
164−- `{@text [bold] inline}` elements in text
165−- `@el [attrs] > @link url` single-child chaining
166−- `[padding 20]` bare attributes as implicit `@el`
167−- `@raw """..."""` for embedding arbitrary HTML/CSS/JS
168−- `@image [inline] logo.svg` inlines SVG content
169−- `@each $name, $url in Home /, About /about` destructuring
170−- `@let large = $base * 2` computed variables
171−- `[grid-template-areas "header main", grid-area header]` named grid areas
172−- `[animate fade-in 0.3s ease]` animation shorthand
173−- `[view-transition-name hero]` View Transitions API
174−- `[has(.active):background blue]` `:has()` pseudo-selector
175−- `@slot header` / `@slot content` named slots in `@fn`
176−- `@theme` design tokens as runtime CSS custom properties
177−- VS Code snippets for common patterns
178−
179−## Documentation
180−
181−See [DESIGN.md](DESIGN.md) for the full language specification.
234+The VS Code extension in [`editors/vscode`](editors/vscode) provides syntax
235+highlighting, snippets, and the language server (`htmlang-lsp`). The server
236+gives diagnostics, completions, hover documentation, go to definition, rename
237+and formatting.
238+
239+The compiler, the formatter and the language server read a file with the
240+same parser, so the editor sees exactly what the compiler sees, relative
241+`@include` and `@data` paths included. Every diagnostic has a stable code
242+(`error[unknown-element]` on the command line, a `code` field in
243+`--format json`), and the whole file is checked, including branches and
244+functions that don't run (a `$name` there is checked only where the code
245+runs, since it may come from data).
crates/htmlang-core/Cargo.tomlnew file+4
@@ -0,0 +1,4 @@
1+[package]
2+name = "htmlang-core"
3+version = "0.1.0"
4+edition = "2024"
crates/htmlang-core/src/ast.rsnew file+775
@@ -0,0 +1,775 @@
1+use std::collections::HashMap;
2+
3+#[derive(Debug)]
4+#[allow(dead_code)]
5+pub struct Document {
6+ /// The page `@page` makes: without one, the output is a fragment.
7+ pub page: Option<Page>,
8+ pub meta_tags: Vec<(String, String)>,
9+ pub head_blocks: Vec<String>,
10+ pub variables: HashMap<String, String>,
11+ pub defines: HashMap<String, Vec<Attribute>>,
12+ pub css_vars: Vec<(String, String)>,
13+ pub custom_css: Vec<String>,
14+ /// The scoped `@style` of each function called, nested under its
15+ /// `.hl-fn-NAME-HASH` class, for `@layer hl-inside`.
16+ pub scoped_css: Vec<String>,
17+ pub og_tags: Vec<(String, String)>,
18+ pub nodes: Vec<Node>,
19+}
20+
21+/// What `@page` says: the page is the root element. Its styles style
22+/// `<body>`, which lays out the page's top-level elements as a column; its
23+/// HTML attributes (`lang=en`, `dir=rtl`, `class=x`) go on `<html>`.
24+#[derive(Debug, Clone, Default)]
25+pub struct Page {
26+ pub title: String,
27+ /// `key=value` attributes, and bare boolean HTML attributes, for `<html>`
28+ pub html_attrs: Vec<Attribute>,
29+ /// Styles, prefixed ones included, for `<body>`
30+ pub styles: Vec<Attribute>,
31+ /// `favicon FILE`, `@page`'s one word of htmlang's own
32+ pub favicon: Option<String>,
33+}
34+
35+#[derive(Debug, Clone)]
36+pub enum Node {
37+ Element(Element),
38+ Text(Vec<TextSegment>),
39+ Raw(String),
40+}
41+
42+#[derive(Debug, Clone)]
43+pub enum TextSegment {
44+ Plain(String),
45+ Inline(Element),
46+}
47+
48+#[derive(Debug, Clone)]
49+pub struct Element {
50+ pub kind: ElementKind,
51+ pub attrs: Vec<Attribute>,
52+ /// The value of the element's leading attribute (see
53+ /// [`ElementKind::arg`]): the first token of `@link /about About`, or
54+ /// its `href=` when it has no argument. For `@slot`, the slot's name.
55+ /// Any other text after the attributes is content, a first child.
56+ pub argument: Option<String>,
57+ pub children: Vec<Node>,
58+ /// The line it is written on; for an element a function's body wrote,
59+ /// the line of the call, since a function is an element at its call.
60+ pub line_num: usize,
61+ /// The function whose body wrote it, when it comes from a call.
62+ pub function: Option<String>,
63+}
64+
65+#[derive(Debug, Clone)]
66+pub struct Attribute {
67+ pub key: String,
68+ /// The value as it goes into the output: a style's with the quotes of
69+ /// quoted text, an HTML attribute's without them.
70+ pub value: Option<String>,
71+ /// Written `key=value`: an HTML attribute rather than a style.
72+ pub html: bool,
73+ /// When the value is quoted text (`"..."`, or a variable holding
74+ /// quoted text), both of its forms, for a parameter it binds.
75+ pub quoted: Option<Quoted>,
76+}
77+
78+/// Quoted text, which remembers that it was quoted: a CSS value writes it
79+/// with its quotes, text and HTML attribute values without them.
80+#[derive(Debug, Clone, PartialEq)]
81+pub struct Quoted {
82+ /// What it says: `a"b` for `"a\"b"`.
83+ pub text: String,
84+ /// As CSS writes it, quotes included: `"a\"b"`.
85+ pub css: String,
86+}
87+
88+#[derive(Debug, Clone, PartialEq)]
89+pub enum ElementKind {
90+ // Layout and text: the core of the language
91+ Row,
92+ El,
93+ Text,
94+ Paragraph,
95+ Link,
96+ Image,
97+ // Elements generated in a special way
98+ Fragment,
99+ // Function bodies: placeholders for the caller's content
100+ Children,
101+ Slot(String),
102+ /// Any other element, described by its row in [`TAGS`].
103+ Tag(&'static TagSpec),
104+}
105+
106+impl ElementKind {
107+ /// The element's name in htmlang source, without the `@`.
108+ pub fn name(&self) -> &str {
109+ match self {
110+ ElementKind::Row => "row",
111+ ElementKind::El => "el",
112+ ElementKind::Text => "text",
113+ ElementKind::Paragraph => "paragraph",
114+ ElementKind::Link => "link",
115+ ElementKind::Image => "image",
116+ ElementKind::Fragment => "fragment",
117+ ElementKind::Children => "children",
118+ ElementKind::Slot(_) => "slot",
119+ ElementKind::Tag(spec) => spec.name,
120+ }
121+ }
122+
123+ pub fn spec(&self) -> Option<&'static TagSpec> {
124+ match self {
125+ ElementKind::Tag(spec) => Some(spec),
126+ _ => None,
127+ }
128+ }
129+
130+ /// How the element lays out what is inside it. `@fragment`, `@children`
131+ /// and `@slot` have no element of their own: their content lands in the
132+ /// element around them and takes its layout.
133+ pub fn layout(&self) -> Layout {
134+ match self {
135+ ElementKind::Row => Layout::Row,
136+ ElementKind::El => Layout::Column,
137+ ElementKind::Text | ElementKind::Paragraph | ElementKind::Link => Layout::Text,
138+ ElementKind::Image => Layout::Void,
139+ ElementKind::Fragment | ElementKind::Children | ElementKind::Slot(_) => Layout::Native,
140+ ElementKind::Tag(spec) => spec.layout,
141+ }
142+ }
143+
144+ /// The CSS every such element starts with, besides its layout's
145+ /// `display` (browser margins reset, the list markers of a column, a
146+ /// link's colour). It goes into the element's own generated class,
147+ /// never onto a global element selector, so HTML from `@markdown` and
148+ /// `@raw` keeps the browser's defaults.
149+ pub fn css(&self) -> &'static str {
150+ match self {
151+ ElementKind::Paragraph => "margin:0;",
152+ ElementKind::Link => "text-decoration:none;color:inherit;",
153+ ElementKind::Image => "display:block;",
154+ ElementKind::Tag(spec) => spec.css,
155+ _ => "",
156+ }
157+ }
158+
159+ /// What the first token after its attributes is: `@link`'s `href`,
160+ /// `@image`'s `src`, or its row's [`TagArg`].
161+ pub fn arg(&self) -> TagArg {
162+ match self {
163+ ElementKind::Link => TagArg::Attr("href"),
164+ ElementKind::Image => TagArg::Attr("src"),
165+ ElementKind::Tag(spec) => spec.arg,
166+ _ => TagArg::Child,
167+ }
168+ }
169+
170+ /// The HTML attribute its leading argument fills, when it has one;
171+ /// `in_picture`: the element is directly inside `@picture`.
172+ pub fn leading_attribute(&self, in_picture: bool) -> Option<&'static str> {
173+ self.arg().attribute(in_picture)
174+ }
175+
176+ /// Whether its indented body is foreign text written into the page as
177+ /// it is (`@script`). (`@code` and `@textarea` also have a verbatim
178+ /// body, shown as text: see [`TagSpec::literal`].)
179+ pub fn is_verbatim(&self) -> bool {
180+ self.spec().is_some_and(|spec| spec.verbatim)
181+ }
182+
183+ /// The HTML element it writes (outside text, where htmlang's own
184+ /// `<div>`s are `<span>`s): `None` for `@fragment`, `@children` and
185+ /// `@slot`, which write none of their own.
186+ pub fn tag(&self) -> Option<&'static str> {
187+ match self {
188+ ElementKind::Row | ElementKind::El => Some("div"),
189+ ElementKind::Text => Some("span"),
190+ ElementKind::Paragraph => Some("p"),
191+ ElementKind::Link => Some("a"),
192+ ElementKind::Image => Some("img"),
193+ ElementKind::Fragment | ElementKind::Children | ElementKind::Slot(_) => None,
194+ ElementKind::Tag(spec) => Some(spec.html),
195+ }
196+ }
197+
198+ /// The HTML element only this element writes, which a selector can
199+ /// pick out: `@td` is every `<td>`, `@paragraph` every `<p>`. `None`
200+ /// for an element that shares its tag: `@el`, `@row`, `@grid`,
201+ /// `@in-front` and `@behind` are all `<div>`, and `@text` is a
202+ /// `<span>`, as is every line of text in a row or column. `@script`
203+ /// isn't shown, so there is nothing to style.
204+ pub fn own_tag(&self) -> Option<&'static str> {
205+ let tag = self.tag()?;
206+ let shared = matches!(tag, "div" | "span") || self.is_verbatim();
207+ (!shared).then_some(tag)
208+ }
209+
210+ /// Is this the table element named `name` (e.g. `"main"`)?
211+ pub fn is_tag(&self, name: &str) -> bool {
212+ self.spec().is_some_and(|spec| spec.name == name)
213+ }
214+
215+ /// Look up an element by its source name (without the `@`).
216+ pub fn from_name(name: &str) -> Option<ElementKind> {
217+ Some(match name {
218+ "row" => ElementKind::Row,
219+ "el" => ElementKind::El,
220+ "text" => ElementKind::Text,
221+ "paragraph" => ElementKind::Paragraph,
222+ "link" => ElementKind::Link,
223+ "image" => ElementKind::Image,
224+ "fragment" => ElementKind::Fragment,
225+ "children" => ElementKind::Children,
226+ "slot" => ElementKind::Slot(String::new()),
227+ _ => ElementKind::Tag(TAGS.iter().find(|spec| spec.name == name)?),
228+ })
229+ }
230+
231+ /// Every element name, for suggestions and completions.
232+ pub fn all_names() -> impl Iterator<Item = &'static str> {
233+ [
234+ "row",
235+ "el",
236+ "text",
237+ "paragraph",
238+ "link",
239+ "image",
240+ "fragment",
241+ "children",
242+ "slot",
243+ ]
244+ .into_iter()
245+ .chain(TAGS.iter().map(|spec| spec.name))
246+ }
247+}
248+
249+/// What an element does with the text after its name and attributes.
250+#[derive(Debug, Clone, Copy, PartialEq)]
251+pub enum TagArg {
252+ /// Its content: the first line of its text, parsed like any text
253+ /// (`@h1 Hello {@text [color red] world}`). The element's layout
254+ /// decides how it combines with the lines under it.
255+ Child,
256+ /// Its leading attribute: the first token fills this HTML attribute
257+ /// (`@iframe URL` sets `src`), and the rest of the text is content, or
258+ /// an error on an element without content. The token ends at a space
259+ /// outside `"..."` and `${...}`.
260+ Attr(&'static str),
261+ /// `@source`'s leading attribute, which depends on where it is:
262+ /// `srcset` directly inside `@picture`, `src` elsewhere (`@video`,
263+ /// `@audio`).
264+ Source,
265+}
266+
267+impl TagArg {
268+ /// The HTML attribute the leading argument fills; `in_picture`: the
269+ /// element is directly inside `@picture`.
270+ pub fn attribute(self, in_picture: bool) -> Option<&'static str> {
271+ match self {
272+ TagArg::Child => None,
273+ TagArg::Attr(attr) => Some(attr),
274+ TagArg::Source if in_picture => Some("srcset"),
275+ TagArg::Source => Some("src"),
276+ }
277+ }
278+
279+ /// The attributes the leading argument may fill, wherever the element
280+ /// is: one, or `src` and `srcset` for `@source`.
281+ pub fn attributes(self) -> Vec<&'static str> {
282+ let mut out: Vec<&'static str> = [self.attribute(false), self.attribute(true)]
283+ .into_iter()
284+ .flatten()
285+ .collect();
286+ out.dedup();
287+ out
288+ }
289+}
290+
291+/// How an element lays out what is inside it: one value per element,
292+/// after elm-ui's layouts. It decides what its text lines are, whether
293+/// `spacing` works on it, and how its children's `width fill`, `center-x`
294+/// and `align-*` compile.
295+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
296+pub enum Layout {
297+ /// A flex column (`@el`, `@section`, `@ul`, `@li`): each text line is a
298+ /// child of its own, and `spacing` is the gap between the children.
299+ Column,
300+ /// A flex row (`@row`): like a column, side by side.
301+ Row,
302+ /// A CSS grid (`@grid`): each text line is a cell.
303+ Grid,
304+ /// Flowing text (`@paragraph`, `@h1`, `@button`, `@td`): the argument,
305+ /// the text lines and the children are one run, joined with spaces. It
306+ /// has no gap for `spacing`, and a row, column or grid inside it is laid
307+ /// out inline (`@el` becomes an inline-flex `<span>`).
308+ Text,
309+ /// HTML's own layout, which htmlang leaves alone: tables, `@select`,
310+ /// `@picture`, media and form controls. Text lines are separated by a
311+ /// line break, which HTML shows as a space except in `@pre` and
312+ /// `@textarea`.
313+ Native,
314+ /// No content at all (`@input`, `@hr`, `@image`).
315+ Void,
316+}
317+
318+impl Layout {
319+ /// A row, column or grid: an element that lays out its children, so
320+ /// `spacing`, `wrap` and `grid-cols` work on it.
321+ pub fn is_container(self) -> bool {
322+ matches!(self, Layout::Column | Layout::Row | Layout::Grid)
323+ }
324+
325+ /// The name used in messages and the reference: `column`, `text`, ...
326+ pub fn name(self) -> &'static str {
327+ match self {
328+ Layout::Column => "column",
329+ Layout::Row => "row",
330+ Layout::Grid => "grid",
331+ Layout::Text => "text",
332+ Layout::Native => "native",
333+ Layout::Void => "void",
334+ }
335+ }
336+}
337+
338+/// How an element compiles: the data behind [`ElementKind::Tag`].
339+#[derive(Debug, PartialEq)]
340+pub struct TagSpec {
341+ /// Name in htmlang source, without the `@`.
342+ pub name: &'static str,
343+ /// HTML element emitted.
344+ pub html: &'static str,
345+ /// Default CSS besides the layout's `display` (margin reset, ...).
346+ pub css: &'static str,
347+ pub arg: TagArg,
348+ /// How it lays out its content.
349+ pub layout: Layout,
350+ /// Its text is shown as written (`@code`, `@textarea`). On its line and
351+ /// inline, a `{@...}` is text, not an inline element (escapes and
352+ /// `$names` still work). Its indented body is verbatim: nothing in it is
353+ /// parsed, and it is shown HTML-escaped, its lines and indentation kept.
354+ pub literal: bool,
355+ /// Its indented body is foreign text written into the page exactly as
356+ /// it is (`@script`'s JavaScript): nothing in it is parsed as htmlang.
357+ pub verbatim: bool,
358+}
359+
360+impl TagSpec {
361+ const DEFAULT: TagSpec = TagSpec {
362+ name: "",
363+ html: "",
364+ css: "",
365+ arg: TagArg::Child,
366+ layout: Layout::Native,
367+ literal: false,
368+ verbatim: false,
369+ };
370+}
371+
372+/// Every element besides the core ones in [`ElementKind`].
373+#[rustfmt::skip]
374+pub static TAGS: &[TagSpec] = &[
375+ TagSpec { name: "nav", html: "nav", layout: Layout::Column, ..TagSpec::DEFAULT },
376+ TagSpec { name: "header", html: "header", layout: Layout::Column, ..TagSpec::DEFAULT },
377+ TagSpec { name: "footer", html: "footer", layout: Layout::Column, ..TagSpec::DEFAULT },
378+ TagSpec { name: "main", html: "main", layout: Layout::Column, ..TagSpec::DEFAULT },
379+ TagSpec { name: "section", html: "section", layout: Layout::Column, ..TagSpec::DEFAULT },
380+ TagSpec { name: "article", html: "article", layout: Layout::Column, ..TagSpec::DEFAULT },
381+ TagSpec { name: "aside", html: "aside", layout: Layout::Column, ..TagSpec::DEFAULT },
382+ TagSpec { name: "details", html: "details", layout: Layout::Column, ..TagSpec::DEFAULT },
383+ TagSpec { name: "dialog", html: "dialog", layout: Layout::Column, ..TagSpec::DEFAULT },
384+ TagSpec { name: "search", html: "search", layout: Layout::Column, ..TagSpec::DEFAULT },
385+ TagSpec { name: "address", html: "address", layout: Layout::Column, ..TagSpec::DEFAULT },
386+ TagSpec { name: "noscript", html: "noscript", layout: Layout::Column, ..TagSpec::DEFAULT },
387+ TagSpec { name: "form", html: "form", arg: TagArg::Attr("action"), layout: Layout::Column, ..TagSpec::DEFAULT },
388+ TagSpec { name: "figure", html: "figure", css: "margin:0;", layout: Layout::Column, ..TagSpec::DEFAULT },
389+ TagSpec { name: "blockquote", html: "blockquote", css: "margin:0;", layout: Layout::Column, ..TagSpec::DEFAULT },
390+ TagSpec { name: "fieldset", html: "fieldset", css: "border:1px solid currentColor;padding:8px;margin:0;", layout: Layout::Column, ..TagSpec::DEFAULT },
391+ TagSpec { name: "datalist", html: "datalist", layout: Layout::Native, ..TagSpec::DEFAULT },
392+ TagSpec { name: "ul", html: "ul", css: "margin:0;padding-left:0;list-style:none;", layout: Layout::Column, ..TagSpec::DEFAULT },
393+ TagSpec { name: "ol", html: "ol", css: "margin:0;padding-left:0;list-style:none;", layout: Layout::Column, ..TagSpec::DEFAULT },
394+ TagSpec { name: "li", html: "li", layout: Layout::Column, ..TagSpec::DEFAULT },
395+ TagSpec { name: "dl", html: "dl", css: "margin:0;", layout: Layout::Column, ..TagSpec::DEFAULT },
396+ TagSpec { name: "dt", html: "dt", layout: Layout::Text, ..TagSpec::DEFAULT },
397+ TagSpec { name: "dd", html: "dd", css: "margin:0;", layout: Layout::Column, ..TagSpec::DEFAULT },
398+ TagSpec { name: "table", html: "table", layout: Layout::Native, ..TagSpec::DEFAULT },
399+ TagSpec { name: "thead", html: "thead", layout: Layout::Native, ..TagSpec::DEFAULT },
400+ TagSpec { name: "tbody", html: "tbody", layout: Layout::Native, ..TagSpec::DEFAULT },
401+ TagSpec { name: "tr", html: "tr", layout: Layout::Native, ..TagSpec::DEFAULT },
402+ TagSpec { name: "select", html: "select", layout: Layout::Native, ..TagSpec::DEFAULT },
403+ TagSpec { name: "picture", html: "picture", layout: Layout::Native, ..TagSpec::DEFAULT },
404+ TagSpec { name: "progress", html: "progress", layout: Layout::Native, ..TagSpec::DEFAULT },
405+ TagSpec { name: "meter", html: "meter", layout: Layout::Native, ..TagSpec::DEFAULT },
406+ TagSpec { name: "output", html: "output", layout: Layout::Native, ..TagSpec::DEFAULT },
407+ TagSpec { name: "canvas", html: "canvas", layout: Layout::Native, ..TagSpec::DEFAULT },
408+ TagSpec { name: "td", html: "td", layout: Layout::Text, ..TagSpec::DEFAULT },
409+ TagSpec { name: "th", html: "th", layout: Layout::Text, ..TagSpec::DEFAULT },
410+ TagSpec { name: "button", html: "button", layout: Layout::Text, ..TagSpec::DEFAULT },
411+ TagSpec { name: "label", html: "label", layout: Layout::Text, ..TagSpec::DEFAULT },
412+ TagSpec { name: "option", html: "option", layout: Layout::Native, ..TagSpec::DEFAULT },
413+ TagSpec { name: "textarea", html: "textarea", layout: Layout::Native, literal: true, ..TagSpec::DEFAULT },
414+ TagSpec { name: "summary", html: "summary", layout: Layout::Text, ..TagSpec::DEFAULT },
415+ TagSpec { name: "cite", html: "cite", layout: Layout::Text, ..TagSpec::DEFAULT },
416+ TagSpec { name: "figcaption", html: "figcaption", layout: Layout::Text, ..TagSpec::DEFAULT },
417+ TagSpec { name: "legend", html: "legend", layout: Layout::Text, ..TagSpec::DEFAULT },
418+ TagSpec { name: "time", html: "time", layout: Layout::Text, ..TagSpec::DEFAULT },
419+ TagSpec { name: "mark", html: "mark", layout: Layout::Text, ..TagSpec::DEFAULT },
420+ TagSpec { name: "abbr", html: "abbr", layout: Layout::Text, ..TagSpec::DEFAULT },
421+ TagSpec { name: "code", html: "code", css: "font-family:ui-monospace,monospace;", layout: Layout::Text, literal: true, ..TagSpec::DEFAULT },
422+ TagSpec { name: "kbd", html: "kbd", css: "font-family:ui-monospace,monospace;", layout: Layout::Text, ..TagSpec::DEFAULT },
423+ TagSpec { name: "pre", html: "pre", css: "margin:0;white-space:pre;font-family:ui-monospace,monospace;", layout: Layout::Native, ..TagSpec::DEFAULT },
424+ TagSpec { name: "h1", html: "h1", css: "margin:0;", layout: Layout::Text, ..TagSpec::DEFAULT },
425+ TagSpec { name: "h2", html: "h2", css: "margin:0;", layout: Layout::Text, ..TagSpec::DEFAULT },
426+ TagSpec { name: "h3", html: "h3", css: "margin:0;", layout: Layout::Text, ..TagSpec::DEFAULT },
427+ TagSpec { name: "h4", html: "h4", css: "margin:0;", layout: Layout::Text, ..TagSpec::DEFAULT },
428+ TagSpec { name: "h5", html: "h5", css: "margin:0;", layout: Layout::Text, ..TagSpec::DEFAULT },
429+ TagSpec { name: "h6", html: "h6", css: "margin:0;", layout: Layout::Text, ..TagSpec::DEFAULT },
430+ TagSpec { name: "input", html: "input", layout: Layout::Void, ..TagSpec::DEFAULT },
431+ TagSpec { name: "hr", html: "hr", layout: Layout::Void, ..TagSpec::DEFAULT },
432+ TagSpec { name: "source", html: "source", arg: TagArg::Source, layout: Layout::Void, ..TagSpec::DEFAULT },
433+ TagSpec { name: "video", html: "video", arg: TagArg::Attr("src"), layout: Layout::Native, ..TagSpec::DEFAULT },
434+ TagSpec { name: "audio", html: "audio", arg: TagArg::Attr("src"), layout: Layout::Native, ..TagSpec::DEFAULT },
435+ TagSpec { name: "iframe", html: "iframe", arg: TagArg::Attr("src"), layout: Layout::Native, ..TagSpec::DEFAULT },
436+ TagSpec { name: "script", html: "script", arg: TagArg::Attr("src"), layout: Layout::Native, verbatim: true, ..TagSpec::DEFAULT },
437+ // Flow containers
438+ TagSpec { name: "hgroup", html: "hgroup", layout: Layout::Column, ..TagSpec::DEFAULT },
439+ TagSpec { name: "menu", html: "menu", css: "margin:0;padding-left:0;list-style:none;", layout: Layout::Column, ..TagSpec::DEFAULT },
440+ // Phrasing: text with the browser's own style, and no CSS of htmlang's
441+ TagSpec { name: "b", html: "b", layout: Layout::Text, ..TagSpec::DEFAULT },
442+ TagSpec { name: "i", html: "i", layout: Layout::Text, ..TagSpec::DEFAULT },
443+ TagSpec { name: "strong", html: "strong", layout: Layout::Text, ..TagSpec::DEFAULT },
444+ TagSpec { name: "em", html: "em", layout: Layout::Text, ..TagSpec::DEFAULT },
445+ TagSpec { name: "small", html: "small", layout: Layout::Text, ..TagSpec::DEFAULT },
446+ TagSpec { name: "s", html: "s", layout: Layout::Text, ..TagSpec::DEFAULT },
447+ TagSpec { name: "u", html: "u", layout: Layout::Text, ..TagSpec::DEFAULT },
448+ TagSpec { name: "sub", html: "sub", layout: Layout::Text, ..TagSpec::DEFAULT },
449+ TagSpec { name: "sup", html: "sup", layout: Layout::Text, ..TagSpec::DEFAULT },
450+ TagSpec { name: "q", html: "q", layout: Layout::Text, ..TagSpec::DEFAULT },
451+ TagSpec { name: "var", html: "var", layout: Layout::Text, ..TagSpec::DEFAULT },
452+ TagSpec { name: "samp", html: "samp", layout: Layout::Text, ..TagSpec::DEFAULT },
453+ TagSpec { name: "dfn", html: "dfn", layout: Layout::Text, ..TagSpec::DEFAULT },
454+ TagSpec { name: "bdi", html: "bdi", layout: Layout::Text, ..TagSpec::DEFAULT },
455+ TagSpec { name: "bdo", html: "bdo", layout: Layout::Text, ..TagSpec::DEFAULT },
456+ TagSpec { name: "ins", html: "ins", layout: Layout::Text, ..TagSpec::DEFAULT },
457+ TagSpec { name: "del", html: "del", layout: Layout::Text, ..TagSpec::DEFAULT },
458+ TagSpec { name: "br", html: "br", layout: Layout::Void, ..TagSpec::DEFAULT },
459+ TagSpec { name: "wbr", html: "wbr", layout: Layout::Void, ..TagSpec::DEFAULT },
460+ // HTML's own display: table parts, option groups, ruby, embedded content
461+ TagSpec { name: "caption", html: "caption", layout: Layout::Native, ..TagSpec::DEFAULT },
462+ TagSpec { name: "colgroup", html: "colgroup", layout: Layout::Native, ..TagSpec::DEFAULT },
463+ TagSpec { name: "col", html: "col", layout: Layout::Void, ..TagSpec::DEFAULT },
464+ TagSpec { name: "tfoot", html: "tfoot", layout: Layout::Native, ..TagSpec::DEFAULT },
465+ TagSpec { name: "optgroup", html: "optgroup", arg: TagArg::Attr("label"), layout: Layout::Native, ..TagSpec::DEFAULT },
466+ TagSpec { name: "ruby", html: "ruby", layout: Layout::Native, ..TagSpec::DEFAULT },
467+ TagSpec { name: "rt", html: "rt", layout: Layout::Native, ..TagSpec::DEFAULT },
468+ TagSpec { name: "rp", html: "rp", layout: Layout::Native, ..TagSpec::DEFAULT },
469+ TagSpec { name: "track", html: "track", arg: TagArg::Attr("src"), layout: Layout::Void, ..TagSpec::DEFAULT },
470+ TagSpec { name: "embed", html: "embed", arg: TagArg::Attr("src"), layout: Layout::Void, ..TagSpec::DEFAULT },
471+ TagSpec { name: "object", html: "object", arg: TagArg::Attr("data"), layout: Layout::Native, ..TagSpec::DEFAULT },
472+ TagSpec { name: "map", html: "map", layout: Layout::Native, ..TagSpec::DEFAULT },
473+ TagSpec { name: "area", html: "area", arg: TagArg::Attr("href"), layout: Layout::Void, ..TagSpec::DEFAULT },
474+ // htmlang's own
475+ TagSpec { name: "grid", html: "div", layout: Layout::Grid, ..TagSpec::DEFAULT },
476+ TagSpec { name: "in-front", html: "div", css: "position:absolute;inset:0;", layout: Layout::Column, ..TagSpec::DEFAULT },
477+ TagSpec { name: "behind", html: "div", css: "position:absolute;inset:0;z-index:-1;", layout: Layout::Column, ..TagSpec::DEFAULT },
478+];
479+
480+/// HTML elements htmlang writes under another name. The HTML name isn't an
481+/// element: the unknown-element error for `@a` suggests `@link`. (Not a
482+/// second spelling: only the suggestion reads this.)
483+pub const HTML_NAMES_WRITTEN_OTHERWISE: &[(&str, &str)] = &[
484+ ("a", "link"),
485+ ("img", "image"),
486+ ("span", "text"),
487+ ("p", "paragraph"),
488+ ("div", "el"),
489+];
490+
491+/// Whether the element named `name` (without the `@`) shows its text as
492+/// written: `{@code {@link /x y}}` prints the braces, and its indented body
493+/// is verbatim text, HTML-escaped. The syntax tree reads this, so every
494+/// tool agrees on it.
495+pub fn has_literal_text(name: &str) -> bool {
496+ ElementKind::from_name(name)
497+ .and_then(|kind| kind.spec())
498+ .is_some_and(|spec| spec.literal)
499+}
500+
501+/// How a directive reads the rest of its line.
502+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
503+pub enum ArgGrammar {
504+ /// Free text, taken as written (`@include file.hl`, `@meta name value`).
505+ /// For a directive with a verbatim body it is the one-line form of the
506+ /// body (`@raw <hr>`, `@style .a { color: red }`) or, for `@markdown`,
507+ /// the file.
508+ Text,
509+ /// An optional `[attributes]` list, then text (`@page [lang=en] Title`).
510+ AttrsText,
511+ /// An expression (`@if $count > 2`).
512+ Expression,
513+ /// A name, then a value, `= EXPR`, `"text"`, `[attributes]` or the
514+ /// parameters of a function (`@let`).
515+ Definition,
516+ /// Nothing, or `if EXPR` (`@else`, `@else if`).
517+ Else,
518+ /// `$item in LIST` or `$item, $index in LIST` (`@each`).
519+ Loop,
520+ /// `$name SOURCE`; inline JSON may span several lines (`@data`).
521+ Data,
522+}
523+
524+/// What the lines indented under a directive or element are.
525+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
526+pub enum BodyKind {
527+ /// Nothing: indented lines are an error.
528+ None,
529+ /// htmlang: elements, text and directives.
530+ Htmlang,
531+ /// Foreign text (CSS, HTML, JavaScript, Markdown, a code sample), kept
532+ /// exactly as written: nothing in it is parsed, and `--` is not a
533+ /// comment. The text on the header's line is its one-line form (or a
534+ /// file or URL: `@markdown notes.md`, `@script app.js`); the line and a
535+ /// body together are an error. A verbatim directive takes no
536+ /// attributes.
537+ Verbatim,
538+}
539+
540+/// A directive: a `@name` that isn't an element. The syntax tree
541+/// (`syntax.rs`), the evaluator, the formatter and the editor tools all
542+/// read the directives' shapes from this table.
543+#[derive(Debug, PartialEq)]
544+pub struct DirectiveSpec {
545+ /// Name in htmlang source, without the `@`.
546+ pub name: &'static str,
547+ pub args: ArgGrammar,
548+ pub body: BodyKind,
549+}
550+
551+/// Every directive.
552+#[rustfmt::skip]
553+pub static DIRECTIVES: &[DirectiveSpec] = &[
554+ DirectiveSpec { name: "page", args: ArgGrammar::AttrsText, body: BodyKind::None },
555+ DirectiveSpec { name: "let", args: ArgGrammar::Definition, body: BodyKind::Htmlang },
556+ DirectiveSpec { name: "include", args: ArgGrammar::Text, body: BodyKind::None },
557+ DirectiveSpec { name: "data", args: ArgGrammar::Data, body: BodyKind::None },
558+ DirectiveSpec { name: "meta", args: ArgGrammar::Text, body: BodyKind::None },
559+ DirectiveSpec { name: "if", args: ArgGrammar::Expression, body: BodyKind::Htmlang },
560+ DirectiveSpec { name: "else", args: ArgGrammar::Else, body: BodyKind::Htmlang },
561+ DirectiveSpec { name: "each", args: ArgGrammar::Loop, body: BodyKind::Htmlang },
562+ DirectiveSpec { name: "style", args: ArgGrammar::Text, body: BodyKind::Verbatim },
563+ DirectiveSpec { name: "head", args: ArgGrammar::Text, body: BodyKind::Verbatim },
564+ DirectiveSpec { name: "raw", args: ArgGrammar::Text, body: BodyKind::Verbatim },
565+ DirectiveSpec { name: "markdown", args: ArgGrammar::Text, body: BodyKind::Verbatim },
566+];
567+
568+/// The directive named `name` (without the `@`).
569+pub fn directive(name: &str) -> Option<&'static DirectiveSpec> {
570+ DIRECTIVES.iter().find(|d| d.name == name)
571+}
572+
573+/// What the lines indented under `@name` are: the directive's body kind,
574+/// or an element's (verbatim for a row that says so: `@script`, and
575+/// `@code` and `@textarea`, whose text is literal; htmlang for every other
576+/// element).
577+pub fn body_kind(name: &str) -> BodyKind {
578+ let verbatim = |spec: &TagSpec| spec.verbatim || spec.literal;
579+ match directive(name) {
580+ Some(spec) => spec.body,
581+ None if ElementKind::from_name(name)
582+ .and_then(|kind| kind.spec())
583+ .is_some_and(verbatim) =>
584+ {
585+ BodyKind::Verbatim
586+ }
587+ None => BodyKind::Htmlang,
588+ }
589+}
590+
591+#[cfg(test)]
592+mod tests {
593+ use super::{ElementKind, Layout};
594+
595+ fn layout(name: &str) -> Layout {
596+ ElementKind::from_name(name).unwrap().layout()
597+ }
598+
599+ #[test]
600+ fn every_element_has_the_layout_it_is_documented_with() {
601+ let text = [
602+ "text",
603+ "paragraph",
604+ "link",
605+ "h1",
606+ "h2",
607+ "h3",
608+ "h4",
609+ "h5",
610+ "h6",
611+ "button",
612+ "td",
613+ "th",
614+ "label",
615+ "summary",
616+ "legend",
617+ "figcaption",
618+ "dt",
619+ "cite",
620+ "code",
621+ "kbd",
622+ "mark",
623+ "abbr",
624+ "time",
625+ "b",
626+ "i",
627+ "strong",
628+ "em",
629+ "small",
630+ "sub",
631+ "sup",
632+ "q",
633+ "del",
634+ ];
635+ for name in text {
636+ assert_eq!(layout(name), Layout::Text, "@{}", name);
637+ }
638+ let columns = [
639+ "el", "li", "dd", "ul", "ol", "dl", "search", "address", "noscript", "section", "form",
640+ "in-front", "behind", "hgroup", "menu",
641+ ];
642+ for name in columns {
643+ assert_eq!(layout(name), Layout::Column, "@{}", name);
644+ }
645+ assert_eq!(layout("row"), Layout::Row);
646+ assert_eq!(layout("grid"), Layout::Grid);
647+ for name in [
648+ "table", "tr", "select", "option", "picture", "video", "pre", "canvas", "caption",
649+ "colgroup", "tfoot", "optgroup", "ruby", "rt", "object",
650+ ] {
651+ assert_eq!(layout(name), Layout::Native, "@{}", name);
652+ }
653+ for name in [
654+ "image", "input", "hr", "source", "br", "wbr", "col", "track", "embed", "area",
655+ ] {
656+ assert_eq!(layout(name), Layout::Void, "@{}", name);
657+ }
658+ }
659+
660+ #[test]
661+ fn html_names_written_otherwise_are_not_elements() {
662+ for (html, htmlang) in super::HTML_NAMES_WRITTEN_OTHERWISE {
663+ assert!(ElementKind::from_name(html).is_none(), "@{}", html);
664+ let kind = ElementKind::from_name(htmlang).unwrap();
665+ let written = match kind {
666+ ElementKind::El => "div",
667+ ElementKind::Text => "span",
668+ ElementKind::Paragraph => "p",
669+ ElementKind::Link => "a",
670+ ElementKind::Image => "img",
671+ _ => panic!("@{} is not one of htmlang's own", htmlang),
672+ };
673+ assert_eq!(written, *html);
674+ }
675+ // No two rows share a name, and none is a directive's
676+ let mut names: Vec<&str> = ElementKind::all_names().collect();
677+ let count = names.len();
678+ names.sort_unstable();
679+ names.dedup();
680+ assert_eq!(names.len(), count, "an element name is listed twice");
681+ for name in names {
682+ assert!(super::directive(name).is_none(), "@{}", name);
683+ }
684+ }
685+
686+ #[test]
687+ fn each_row_names_at_most_one_leading_attribute() {
688+ let leading = |name: &str, in_picture: bool| {
689+ ElementKind::from_name(name)
690+ .unwrap()
691+ .leading_attribute(in_picture)
692+ };
693+ for (name, attr) in [
694+ ("link", "href"),
695+ ("area", "href"),
696+ ("image", "src"),
697+ ("script", "src"),
698+ ("iframe", "src"),
699+ ("video", "src"),
700+ ("audio", "src"),
701+ ("track", "src"),
702+ ("embed", "src"),
703+ ("form", "action"),
704+ ("object", "data"),
705+ ("optgroup", "label"),
706+ ] {
707+ assert_eq!(leading(name, false), Some(attr), "@{}", name);
708+ assert_eq!(leading(name, true), Some(attr), "@{}", name);
709+ }
710+ assert_eq!(leading("source", false), Some("src"));
711+ assert_eq!(leading("source", true), Some("srcset"));
712+ for name in ["el", "text", "h1", "button", "slot", "fragment", "picture"] {
713+ assert_eq!(leading(name, false), None, "@{}", name);
714+ }
715+ // @script is an ordinary row whose body is kept as written
716+ let script = ElementKind::from_name("script").unwrap();
717+ assert!(script.is_verbatim() && script.spec().is_some());
718+ assert_eq!(super::body_kind("script"), super::BodyKind::Verbatim);
719+ assert_eq!(super::body_kind("el"), super::BodyKind::Htmlang);
720+ // @code and @textarea: a verbatim body, shown as text; @pre is an
721+ // ordinary element, so `@pre > @code` and wrapper functions work
722+ for name in ["code", "textarea"] {
723+ assert_eq!(
724+ super::body_kind(name),
725+ super::BodyKind::Verbatim,
726+ "@{}",
727+ name
728+ );
729+ assert!(super::has_literal_text(name), "@{}", name);
730+ }
731+ assert_eq!(super::body_kind("pre"), super::BodyKind::Htmlang);
732+ // Every verbatim directive takes its line as its one-line body or file
733+ for spec in super::DIRECTIVES {
734+ if spec.body == super::BodyKind::Verbatim {
735+ assert_eq!(spec.args, super::ArgGrammar::Text, "@{}", spec.name);
736+ }
737+ }
738+ }
739+
740+ #[test]
741+ fn an_element_has_a_tag_of_its_own_when_no_other_element_writes_it() {
742+ let own = |name: &str| ElementKind::from_name(name).unwrap().own_tag();
743+ for shared in [
744+ "el", "row", "grid", "in-front", "behind", "text", "script", "fragment",
745+ ] {
746+ assert_eq!(own(shared), None, "@{}", shared);
747+ }
748+ assert_eq!(own("td"), Some("td"));
749+ assert_eq!(own("link"), Some("a"));
750+ assert_eq!(own("paragraph"), Some("p"));
751+ assert_eq!(own("image"), Some("img"));
752+ // Every tag of its own is written by that one element
753+ let names: Vec<&str> = ElementKind::all_names().collect();
754+ for name in &names {
755+ let Some(tag) = own(name) else { continue };
756+ let writers: Vec<&&str> = names
757+ .iter()
758+ .filter(|other| ElementKind::from_name(other).unwrap().tag() == Some(tag))
759+ .collect();
760+ assert_eq!(writers, vec![name], "<{}>", tag);
761+ }
762+ }
763+
764+ #[test]
765+ fn a_layout_s_display_is_not_repeated_in_the_row_s_css() {
766+ for spec in super::TAGS {
767+ assert!(
768+ !spec.css.contains("display"),
769+ "@{}: {}",
770+ spec.name,
771+ spec.css
772+ );
773+ }
774+ }
775+}
crates/htmlang-core/src/codegen.rsnew file+2479
@@ -0,0 +1,2479 @@
1+use std::collections::HashMap;
2+use std::hash::Hash;
3+
4+use crate::ast::*;
5+use crate::vocab::with_px;
6+
7+// ---------------------------------------------------------------------------
8+// Style collector: deduplicates CSS and assigns class names
9+// ---------------------------------------------------------------------------
10+
11+/// (min-width breakpoint, prefix)
12+const BREAKPOINTS: &[(&str, &str)] = &[
13+ ("sm", "640px"),
14+ ("md", "768px"),
15+ ("lg", "1024px"),
16+ ("xl", "1280px"),
17+ ("2xl", "1536px"),
18+];
19+
20+/// The prefix of every generated class (`hl-2k9xq0m`), which keeps them
21+/// out of the author's own class names.
22+pub const CLASS_PREFIX: &str = "hl-";
23+
24+/// How many base-36 digits a class's name has after `hl-`: 7, about 36
25+/// bits of its style's hash, so a site with 10,000 different styles has
26+/// odds of about 6 in 10,000 that two of them share a name, which
27+/// `htmlang build` reports (`class-collision`). Within one file, a style
28+/// whose name is taken takes more digits.
29+pub const CLASS_DIGITS: usize = 7;
30+
31+/// A stable hash of `text`: FNV-1a, then SplitMix64's finalizer, so every
32+/// digit of a name depends on all of the text. It is the same on every
33+/// platform and in every build, unlike `std`'s hasher.
34+pub fn stable_hash(text: &str) -> u64 {
35+ let mut hash: u64 = 0xcbf2_9ce4_8422_2325;
36+ for byte in text.bytes() {
37+ hash ^= u64::from(byte);
38+ hash = hash.wrapping_mul(0x0000_0100_0000_01b3);
39+ }
40+ hash = (hash ^ (hash >> 30)).wrapping_mul(0xbf58_476d_1ce4_e5b9);
41+ hash = (hash ^ (hash >> 27)).wrapping_mul(0x94d0_49bb_1331_11eb);
42+ hash ^ (hash >> 31)
43+}
44+
45+/// `digits` base-36 digits of `hash`: `2k9xq0m`. With 13, all of it.
46+pub fn hash_digits(hash: u64, digits: usize) -> String {
47+ const DIGITS: &[u8] = b"0123456789abcdefghijklmnopqrstuvwxyz";
48+ let mut n = hash;
49+ (0..digits)
50+ .map(|_| {
51+ let digit = DIGITS[(n % 36) as usize] as char;
52+ n /= 36;
53+ digit
54+ })
55+ .collect()
56+}
57+
58+/// A class htmlang generated: its name, and the hash of the style it
59+/// stands for. One style has one name in every file, so a fragment's
60+/// classes mean the same in any page it goes into.
61+#[derive(Clone, Debug, PartialEq, Eq)]
62+pub struct Class {
63+ pub name: String,
64+ pub style: u64,
65+}
66+
67+/// When a style applies: the at-rule prefixes it is under (their ranks,
68+/// see [`crate::vocab::at_rule_rank`], sorted, so `dark:md:` and `md:dark:`
69+/// are one condition) and its selector prefixes, left to right as the
70+/// selector reads (`hover:children:` is `.a:hover > *`).
71+#[derive(Clone, Default, PartialEq, Eq, Hash, Debug)]
72+struct Condition {
73+ at: Vec<usize>,
74+ selector: Vec<String>,
75+}
76+
77+impl Condition {
78+ /// The condition of an attribute's key, and the name after its
79+ /// prefixes.
80+ fn of(key: &str) -> (Condition, &str) {
81+ let (prefixes, name) = crate::vocab::split_prefixes(key);
82+ let mut condition = Condition::default();
83+ for prefix in prefixes {
84+ match crate::vocab::at_rule_rank(prefix) {
85+ Some(rank) => condition.at.push(rank),
86+ None => condition.selector.push(prefix.to_string()),
87+ }
88+ }
89+ condition.at.sort_unstable();
90+ condition.at.dedup();
91+ (condition, name)
92+ }
93+
94+ /// Only the at-rule part: a direction under `hover:` is the one without
95+ /// it.
96+ fn at_only(at: &[usize]) -> Condition {
97+ Condition {
98+ at: at.to_vec(),
99+ selector: Vec::new(),
100+ }
101+ }
102+
103+ /// The styles go on the element's children (`children:`).
104+ fn on_children(&self) -> bool {
105+ self.selector.iter().any(|p| p == crate::vocab::CHILDREN)
106+ }
107+
108+ /// The styles go on the elements of one kind inside the element
109+ /// (`@td:`): where the element prefix is in the selector chain.
110+ fn inside(&self) -> Option<usize> {
111+ self.selector
112+ .iter()
113+ .position(|p| crate::vocab::element_prefix(p).is_some())
114+ }
115+
116+ /// Whether this condition holds wherever `other` does: its at-rules
117+ /// are implied by `other`'s, and it has no selector or `other`'s.
118+ fn holds_at(&self, other: &Condition) -> bool {
119+ (self.selector.is_empty() || self.selector == other.selector)
120+ && self.at.iter().all(|&a| {
121+ other
122+ .at
123+ .iter()
124+ .any(|&b| crate::vocab::at_rule_implied(a, b))
125+ })
126+ }
127+
128+ /// The order the rules of each condition are written in, which the
129+ /// cascade follows: no prefix, then selectors, then each at-rule
130+ /// block (see [`at_order`]), with its selectors inside it.
131+ fn order(&self) -> (AtOrder, SelectorOrder) {
132+ (at_order(&self.at), selector_order(&self.selector))
133+ }
134+}
135+
136+/// Where a block of at-rules is written: after the rules without one; by
137+/// its last (innermost) prefix in the order of
138+/// [`crate::vocab::at_rule_prefixes`] (widths, media, container widths), so
139+/// `md:dark:` comes with `dark:`, after it; then by length.
140+type AtOrder = (bool, usize, usize, Vec<usize>);
141+
142+fn at_order(at: &[usize]) -> AtOrder {
143+ (
144+ !at.is_empty(),
145+ at.last().copied().unwrap_or(0),
146+ at.len(),
147+ at.to_vec(),
148+ )
149+}
150+
151+/// Selector chains in the order of [`crate::vocab::PSEUDOS`] (position,
152+/// then form state, then `hover:`, `focus:`, `active:`, `disabled:`), and
153+/// by their argument's text for the same pseudo-class; a chain before the
154+/// longer ones it starts. A chain through `children:` comes after the
155+/// others, ordered by what follows its last `children:` and then by what
156+/// comes before it: only that tail counts toward its specificity (see
157+/// [`selector`]), so `hover:children:` follows `children:` and wins over it
158+/// on hover.
159+type SelectorOrder = (bool, Vec<(usize, String)>, Vec<(usize, String)>);
160+
161+fn selector_order(selector: &[String]) -> SelectorOrder {
162+ let table = crate::vocab::PSEUDOS;
163+ let ranked = |chain: &[String]| -> Vec<(usize, String)> {
164+ chain
165+ .iter()
166+ .map(|p| {
167+ let name = crate::vocab::pseudo_name(p);
168+ let rank = table
169+ .iter()
170+ .position(|(q, _)| *q == name)
171+ .unwrap_or(table.len());
172+ (rank, p.clone())
173+ })
174+ .collect()
175+ };
176+ match selector.iter().rposition(|p| p == crate::vocab::CHILDREN) {
177+ None => (false, ranked(selector), Vec::new()),
178+ Some(i) => (true, ranked(&selector[i + 1..]), ranked(&selector[..i])),
179+ }
180+}
181+
182+/// The order of the chains through an element prefix (`@td:`, see
183+/// [`scoped_selector`]): by the prefixes before it, which select the root
184+/// of the scope and add nothing to the specificity, so `hover:@td:` comes
185+/// after `@td:` and wins on hover; then by the element; then by the
186+/// prefixes after it.
187+fn inside_order(chain: &[String]) -> (SelectorOrder, String, SelectorOrder) {
188+ let at = chain
189+ .iter()
190+ .position(|p| crate::vocab::element_prefix(p).is_some())
191+ .unwrap_or(chain.len());
192+ (
193+ selector_order(&chain[..at]),
194+ chain.get(at).cloned().unwrap_or_default(),
195+ selector_order(chain.get(at + 1..).unwrap_or_default()),
196+ )
197+}
198+
199+/// The selector for `class` under a chain of selector prefixes, read left
200+/// to right. Everything before the last `children:` goes in `:where()`, so
201+/// a parent's `children:` styles have no specificity, and a child's own
202+/// attributes win over them: `children:hover:` is `:where(.a)>*:hover`,
203+/// `hover:children:` is `:where(.a:hover)>*`.
204+fn selector(class: &str, chain: &[String]) -> String {
205+ let last_children = chain.iter().rposition(|p| p == crate::vocab::CHILDREN);
206+ let mut out = format!(".{}", class);
207+ for (i, prefix) in chain.iter().enumerate() {
208+ if prefix == crate::vocab::CHILDREN {
209+ if Some(i) == last_children {
210+ out = format!(":where({})>*", out);
211+ } else {
212+ out.push_str(">*");
213+ }
214+ } else if let Some(pseudo) = crate::vocab::pseudo_selector(prefix) {
215+ out.push_str(&pseudo);
216+ }
217+ }
218+ out
219+}
220+
221+/// The rule for the elements an element prefix picks out inside the
222+/// element with the class `class` (see [`Condition::inside`]): the scope's
223+/// root, from the selector prefixes before it (`hover:@td:` is inside a
224+/// hovered element), and the selector for the elements, from those after
225+/// it (`@td:hover:` is a hovered cell). `:scope td` leaves out the root
226+/// itself, so `@ul [@ul:...]` styles the lists inside, not its own. `None`
227+/// when the name has no tag of its own (the parser reports it).
228+fn scoped_selector(class: &str, chain: &[String], at: usize) -> Option<(String, String)> {
229+ let name = crate::vocab::element_prefix(&chain[at])?;
230+ let tag = ElementKind::from_name(name)?.own_tag()?;
231+ let root = selector(class, &chain[..at]);
232+ let mut target = format!(":scope {}", tag);
233+ for prefix in &chain[at + 1..] {
234+ if let Some(pseudo) = crate::vocab::pseudo_selector(prefix) {
235+ target.push_str(&pseudo);
236+ }
237+ }
238+ Some((root, target))
239+}
240+
241+/// The `@media` or `@container` rule an at-rule prefix stands for, as
242+/// written in readable and in compact output.
243+fn at_rule(rank: usize, dev: bool) -> String {
244+ let prefix = crate::vocab::at_rule_prefixes()
245+ .nth(rank)
246+ .unwrap_or_default();
247+ let name = prefix.trim_end_matches(':');
248+ let width = |name: &str| {
249+ BREAKPOINTS
250+ .iter()
251+ .find(|(n, _)| *n == name)
252+ .map_or("0", |(_, w)| *w)
253+ };
254+ let (kind, feature, value) = if let Some(size) = name.strip_prefix("cq-") {
255+ ("@container", "min-width", width(size))
256+ } else {
257+ match name {
258+ "print" => {
259+ return "@media print".to_string();
260+ }
261+ "dark" => ("@media", "prefers-color-scheme", "dark"),
262+ "motion-safe" => ("@media", "prefers-reduced-motion", "no-preference"),
263+ "motion-reduce" => ("@media", "prefers-reduced-motion", "reduce"),
264+ "landscape" | "portrait" => ("@media", "orientation", name),
265+ _ => ("@media", "min-width", width(name)),
266+ }
267+ };
268+ if dev {
269+ format!("{} ({}: {})", kind, feature, value)
270+ } else {
271+ format!("{}({}:{})", kind, feature, value)
272+ }
273+}
274+
275+/// A style as text, for its hash: the defaults of its element's kind, its
276+/// rules (the at-rules' ranks, the selector prefixes and the declarations
277+/// of each) and the rules keyed on it, each part ended by a character CSS
278+/// doesn't have.
279+fn style_text(defaults: &str, rules: &[(Condition, String)], distinct: &str) -> String {
280+ let mut text = format!("{defaults}\u{1}");
281+ for (condition, body) in rules {
282+ for rank in &condition.at {
283+ text.push_str(&format!("{rank}\u{2}"));
284+ }
285+ text.push('\u{3}');
286+ for prefix in &condition.selector {
287+ text.push_str(prefix);
288+ text.push('\u{2}');
289+ }
290+ text.push('\u{3}');
291+ text.push_str(body);
292+ text.push('\u{1}');
293+ }
294+ text.push_str(distinct);
295+ text
296+}
297+
298+struct StyleEntry {
299+ class_name: String,
300+ /// The hash of the style, which names the class
301+ style: u64,
302+ /// The defaults of the element's kind (its layout, a heading's
303+ /// `margin:0`, ...), less what its own attributes set. They are written
304+ /// as `:where(.hl-a)` in the layer `hl-kind`, so an element prefix
305+ /// around it (`@h2:`), its parent's `children:` styles and its own
306+ /// attributes, all in later layers, win over them.
307+ defaults: String,
308+ /// The element's rules: under each condition, its declarations, in the
309+ /// order they are written
310+ rules: Vec<(Condition, String)>,
311+ /// What else tells two elements with the same CSS apart: the rules
312+ /// keyed on this class (see [`StyleCollector::keyed`]). Not written.
313+ distinct: String,
314+}
315+
316+struct StyleCollector {
317+ entries: Vec<StyleEntry>,
318+ /// Maps a style's hash to its entries (more than one only when two
319+ /// styles hash alike, which the full comparison tells apart).
320+ index: HashMap<u64, Vec<usize>>,
321+ /// The names given, which a style whose name is taken doesn't get
322+ names: std::collections::HashSet<String>,
323+ /// Rules for an element's children, keyed on its class and written in
324+ /// the block of an at-rule condition: `(at-rules, selector, body)`, e.g.
325+ /// `([md], ":where(.a)>.b", "flex:1;")` (see [`Flow`]).
326+ keyed: Vec<(Vec<usize>, String, String)>,
327+ /// The keyed rules already added
328+ keyed_seen: std::collections::HashSet<(Vec<usize>, String, String)>,
329+}
330+
331+impl StyleCollector {
332+ fn new() -> Self {
333+ StyleCollector {
334+ entries: Vec::new(),
335+ index: HashMap::new(),
336+ names: std::collections::HashSet::new(),
337+ keyed: Vec::new(),
338+ keyed_seen: std::collections::HashSet::new(),
339+ }
340+ }
341+
342+ /// Add a rule for `selector` under the at-rules `at`, once.
343+ fn add_keyed(&mut self, at: Vec<usize>, selector: String, body: String) {
344+ let rule = (at, selector, body);
345+ if self.keyed_seen.insert(rule.clone()) {
346+ self.keyed.push(rule);
347+ }
348+ }
349+
350+ /// Returns a class name for this style combination, or None if all empty.
351+ fn get_class(
352+ &mut self,
353+ defaults: String,
354+ mut rules: Vec<(Condition, String)>,
355+ distinct: String,
356+ ) -> Option<String> {
357+ rules.retain(|(_, body)| !body.is_empty());
358+ if defaults.is_empty() && rules.is_empty() {
359+ return None;
360+ }
361+ rules.sort_by_cached_key(|(condition, _)| condition.order());
362+ let style = stable_hash(&style_text(&defaults, &rules, &distinct));
363+
364+ if let Some(indices) = self.index.get(&style) {
365+ for &idx in indices {
366+ let e = &self.entries[idx];
367+ if e.defaults == defaults && e.rules == rules && e.distinct == distinct {
368+ return Some(e.class_name.clone());
369+ }
370+ }
371+ }
372+ // The name is the hash's first digits, and more of them when
373+ // another style of this file has those; after all 13, the entry's
374+ // number tells the two apart
375+ let idx = self.entries.len();
376+ let name = (CLASS_DIGITS..=13)
377+ .map(|digits| format!("{}{}", CLASS_PREFIX, hash_digits(style, digits)))
378+ .find(|name| !self.names.contains(name))
379+ .unwrap_or_else(|| format!("{}{}{}", CLASS_PREFIX, hash_digits(style, 13), idx));
380+ self.names.insert(name.clone());
381+ self.entries.push(StyleEntry {
382+ class_name: name.clone(),
383+ style,
384+ defaults,
385+ rules,
386+ distinct,
387+ });
388+ self.index.entry(style).or_default().push(idx);
389+ Some(name)
390+ }
391+
392+ /// The classes given, in the order they were
393+ fn classes(&self) -> impl Iterator<Item = Class> + '_ {
394+ self.entries.iter().map(|e| Class {
395+ name: e.class_name.clone(),
396+ style: e.style,
397+ })
398+ }
399+
400+ /// All generated rules, in three layers (see [`LAYERS`]): the element
401+ /// kinds' defaults in `hl-kind` (`:where(.hl-a)`), the rules for the
402+ /// elements an element prefix picks out inside an element (`@td:`), and
403+ /// a function's scoped `@style`, in `hl-inside`, and the elements' own
404+ /// rules in `htmlang`. They are written in a fixed order, so which rule
405+ /// wins never depends on where in the page an element is: the rules
406+ /// without a prefix, then those under selector prefixes, then each block
407+ /// of at-rules (see [`at_order`]), in which the rules keyed on a parent
408+ /// come first, then the element's own, then its selectors (see
409+ /// [`selector_order`]).
410+ fn to_css_formatted(&self, dev: bool, scoped: &[String]) -> String {
411+ // The defaults: `:where(.hl-a,.hl-b){...}`
412+ let mut kind = String::new();
413+ let mut defaults: Vec<(&str, Vec<&str>)> = Vec::new();
414+ for e in self.entries.iter().filter(|e| !e.defaults.is_empty()) {
415+ match defaults.iter_mut().find(|(body, _)| *body == e.defaults) {
416+ Some((_, classes)) => classes.push(&e.class_name),
417+ None => defaults.push((&e.defaults, vec![&e.class_name])),
418+ }
419+ }
420+ for (body, classes) in defaults {
421+ let classes: Vec<String> = classes.iter().map(|c| format!(".{}", c)).collect();
422+ let selector = format!(":where({})", classes.join(","));
423+ if dev {
424+ kind.push_str(&format!(" {} {{{}}}\n", selector, body));
425+ } else {
426+ kind.push_str(&format!("{}{{{}}}", selector, body));
427+ }
428+ }
429+
430+ let mut inside = self.blocks(true, dev);
431+ // A function's scoped `@style`, nested under its class
432+ for block in scoped {
433+ if dev {
434+ inside.push_str(block);
435+ inside.push('\n');
436+ } else {
437+ inside.push_str(&compact_css(block));
438+ }
439+ }
440+
441+ let mut css = String::new();
442+ for (name, rules) in [
443+ ("hl-kind", kind),
444+ ("hl-inside", inside),
445+ ("htmlang", self.blocks(false, dev)),
446+ ] {
447+ if rules.is_empty() {
448+ continue;
449+ }
450+ if dev {
451+ css.push_str(&format!("@layer {} {{\n{}}}\n", name, rules));
452+ } else {
453+ css.push_str(&format!("@layer {}{{{}}}", name, rules));
454+ }
455+ }
456+ css
457+ }
458+
459+ /// The rules of every block of at-rules, in order: those for the
460+ /// elements inside (`inside`: rules under an element prefix, each in
461+ /// an `@scope` on its element's class), or the elements' own.
462+ fn blocks(&self, inside: bool, dev: bool) -> String {
463+ let mut css = String::new();
464+ let rules = || {
465+ self.entries.iter().flat_map(move |e| {
466+ e.rules
467+ .iter()
468+ .filter(move |(c, _)| c.inside().is_some() == inside)
469+ .map(move |(c, body)| (e, c, body))
470+ })
471+ };
472+ let mut blocks: Vec<&[usize]> = vec![&[]];
473+ let keyed = self.keyed.iter().filter(|_| !inside);
474+ let every = rules()
475+ .map(|(_, c, _)| c.at.as_slice())
476+ .chain(keyed.map(|(at, _, _)| at.as_slice()));
477+ for at in every {
478+ if !blocks.contains(&at) {
479+ blocks.push(at);
480+ }
481+ }
482+ blocks.sort_by_key(|at| at_order(at));
483+
484+ for at in blocks {
485+ let depth = at.len();
486+ // Readable output indents a rule inside `@layer` and inside
487+ // each at-rule but the first
488+ let indent = if dev {
489+ " ".repeat(depth.max(1))
490+ } else {
491+ String::new()
492+ };
493+ let mut inner = String::new();
494+ // Rules keyed on a parent's class come first: they have the
495+ // specificity of one class, like a class rule, so the child's
496+ // own rules in the block still win
497+ if !inside {
498+ let keyed: Vec<(&str, &str)> = self
499+ .keyed
500+ .iter()
501+ .filter(|(a, _, _)| a.as_slice() == at)
502+ .map(|(_, selector, body)| (selector.as_str(), body.as_str()))
503+ .collect();
504+ emit_selector_rules(&mut inner, &keyed, &indent, dev);
505+ }
506+ // The selector chains of this block, in order
507+ let mut chains: Vec<&[String]> = Vec::new();
508+ for (_, condition, _) in rules() {
509+ if condition.at == at && !chains.contains(&condition.selector.as_slice()) {
510+ chains.push(&condition.selector);
511+ }
512+ }
513+ if inside {
514+ chains.sort_by_cached_key(|chain| inside_order(chain));
515+ // One `@scope` for each root, its rules in the order of
516+ // the chains: rules for one element under two roots (`.a`
517+ // and `.a:hover`) tie on specificity and proximity, so the
518+ // later one wins
519+ let mut scopes: Vec<(String, Vec<(String, &str)>)> = Vec::new();
520+ for chain in chains {
521+ let Some(element) = chain
522+ .iter()
523+ .position(|p| crate::vocab::element_prefix(p).is_some())
524+ else {
525+ continue;
526+ };
527+ for (e, _, body) in
528+ rules().filter(|(_, c, _)| c.at == at && c.selector == chain)
529+ {
530+ let Some((root, target)) = scoped_selector(&e.class_name, chain, element)
531+ else {
532+ continue;
533+ };
534+ match scopes.iter_mut().find(|(r, _)| *r == root) {
535+ Some((_, targets)) => targets.push((target, body)),
536+ None => scopes.push((root, vec![(target, body)])),
537+ }
538+ }
539+ }
540+ let inner_indent = if dev {
541+ format!("{} ", indent)
542+ } else {
543+ String::new()
544+ };
545+ for (root, targets) in scopes {
546+ let targets: Vec<(&str, &str)> =
547+ targets.iter().map(|(t, b)| (t.as_str(), *b)).collect();
548+ inner.push_str(&indent);
549+ inner.push_str(&format!("@scope ({})", root));
550+ inner.push_str(if dev { " {\n" } else { "{" });
551+ emit_selector_rules(&mut inner, &targets, &inner_indent, dev);
552+ inner.push_str(&indent);
553+ inner.push_str(if dev { "}\n" } else { "}" });
554+ }
555+ } else {
556+ chains.sort_by_cached_key(|chain| selector_order(chain));
557+ for chain in chains {
558+ let pairs: Vec<(String, &str)> = rules()
559+ .filter(|(_, c, _)| c.at == at && c.selector == chain)
560+ .map(|(e, _, body)| (selector(&e.class_name, chain), body.as_str()))
561+ .collect();
562+ emit_grouped_rules(&mut inner, &pairs, &indent, dev);
563+ }
564+ }
565+ if inner.is_empty() {
566+ continue;
567+ }
568+ // Each at-rule wraps the next, outermost first
569+ for (level, &rank) in at.iter().enumerate().rev() {
570+ let pad = if dev {
571+ " ".repeat(level)
572+ } else {
573+ String::new()
574+ };
575+ inner = if dev {
576+ format!("{pad}{} {{\n{inner}{pad}}}\n", at_rule(rank, true))
577+ } else {
578+ format!("{}{{{inner}}}", at_rule(rank, false))
579+ };
580+ }
581+ css.push_str(&inner);
582+ }
583+ css
584+ }
585+}
586+
587+/// Emit CSS rules from `(selector, body)` pairs, merging identical bodies
588+/// into a single selector-list rule (e.g. `.a,.b{body}`). The first occurrence
589+/// of each distinct body determines ordering, so output stays deterministic
590+/// across runs. `indent` is prepended to each rule line.
591+fn emit_grouped_rules(out: &mut String, pairs: &[(String, &str)], indent: &str, dev: bool) {
592+ if pairs.is_empty() {
593+ return;
594+ }
595+ // Group in first-occurrence order.
596+ let mut order: Vec<&str> = Vec::new();
597+ let mut groups: HashMap<&str, Vec<&str>> = HashMap::new();
598+ for (selector, body) in pairs {
599+ if body.is_empty() {
600+ continue;
601+ }
602+ if !groups.contains_key(body) {
603+ order.push(body);
604+ }
605+ groups.entry(body).or_default().push(selector);
606+ }
607+ let sp = if dev { " " } else { "" };
608+ let nl = if dev { "\n" } else { "" };
609+ for body in &order {
610+ out.push_str(indent);
611+ out.push_str(&groups[body].join(","));
612+ out.push_str(sp);
613+ out.push('{');
614+ out.push_str(body);
615+ out.push('}');
616+ out.push_str(nl);
617+ }
618+}
619+
620+/// Emit `(selector, body)` rules in their order, merging a run of rules
621+/// with the same body into one rule with a selector list (the order
622+/// matters: two rules may apply to one element).
623+fn emit_selector_rules(out: &mut String, rules: &[(&str, &str)], indent: &str, dev: bool) {
624+ let mut i = 0;
625+ while i < rules.len() {
626+ let body = rules[i].1;
627+ let run = rules[i..].iter().take_while(|(_, b)| *b == body).count();
628+ if !body.is_empty() {
629+ let selectors: Vec<&str> = rules[i..i + run].iter().map(|(s, _)| *s).collect();
630+ out.push_str(indent);
631+ out.push_str(&selectors.join(","));
632+ if dev {
633+ out.push(' ');
634+ }
635+ out.push('{');
636+ out.push_str(body);
637+ out.push('}');
638+ if dev {
639+ out.push('\n');
640+ }
641+ }
642+ i += run;
643+ }
644+}
645+
646+struct GenContext {
647+ dev: bool,
648+ depth: usize,
649+ has_interactive: bool,
650+ /// Writing inside a text element, at any depth: htmlang's own `<div>`s
651+ /// are `<span>`s there, which text can hold.
652+ in_text: bool,
653+ /// How the element whose children are being written lays them out
654+ flow: Flow,
655+ /// Writing the children of a `@picture`, where `@source`'s leading
656+ /// argument is its `srcset`
657+ in_picture: bool,
658+}
659+
660+impl GenContext {
661+ fn indent(&self) -> String {
662+ if self.dev {
663+ " ".repeat(self.depth)
664+ } else {
665+ String::new()
666+ }
667+ }
668+
669+ fn nl(&self) -> &str {
670+ if self.dev { "\n" } else { "" }
671+ }
672+}
673+
674+// ---------------------------------------------------------------------------
675+// Public API
676+// ---------------------------------------------------------------------------
677+
678+#[derive(Default)]
679+pub struct CodegenOptions {
680+ pub dev: bool,
681+ pub partial: bool,
682+ pub minify: bool,
683+}
684+
685+/// Generate HTML from a parsed document using the given options.
686+pub fn generate_with(doc: &Document, opts: &CodegenOptions) -> String {
687+ generate_with_classes(doc, opts).0
688+}
689+
690+/// [`generate_with`], and the classes the document's styles were given,
691+/// for a check across files that no name stands for two styles.
692+pub fn generate_with_classes(doc: &Document, opts: &CodegenOptions) -> (String, Vec<Class>) {
693+ let mut classes = Vec::new();
694+ let mut html = if opts.partial {
695+ generate_partial_inner(doc, opts.dev, &mut classes)
696+ } else {
697+ generate_full_inner(doc, opts.dev, &mut classes)
698+ };
699+ if opts.minify {
700+ html = minify_html(&html);
701+ }
702+ (html, classes)
703+}
704+
705+pub fn generate(doc: &Document) -> String {
706+ generate_with(doc, &CodegenOptions::default())
707+}
708+
709+pub fn generate_dev(doc: &Document) -> String {
710+ generate_with(
711+ doc,
712+ &CodegenOptions {
713+ dev: true,
714+ ..Default::default()
715+ },
716+ )
717+}
718+
719+pub fn generate_partial(doc: &Document) -> String {
720+ generate_with(
721+ doc,
722+ &CodegenOptions {
723+ partial: true,
724+ ..Default::default()
725+ },
726+ )
727+}
728+
729+pub fn generate_partial_dev(doc: &Document) -> String {
730+ generate_with(
731+ doc,
732+ &CodegenOptions {
733+ dev: true,
734+ partial: true,
735+ ..Default::default()
736+ },
737+ )
738+}
739+
740+pub fn generate_minified(doc: &Document) -> String {
741+ generate_with(
742+ doc,
743+ &CodegenOptions {
744+ minify: true,
745+ ..Default::default()
746+ },
747+ )
748+}
749+
750+fn minify_html(html: &str) -> String {
751+ let mut result = String::with_capacity(html.len());
752+ let mut in_pre = false;
753+ let mut in_script = false;
754+ let mut in_style = false;
755+ let mut prev_was_space = false;
756+ let chars: Vec<char> = html.chars().collect();
757+ let mut i = 0;
758+
759+ while i < chars.len() {
760+ // Track <pre>, <script>, <style> contexts
761+ if i + 4 < chars.len() && chars[i] == '<' {
762+ let rest: String = chars[i..].iter().take(10).collect();
763+ let rest_lower = rest.to_lowercase();
764+ if rest_lower.starts_with("<pre") || rest_lower.starts_with("<textarea") {
765+ in_pre = true;
766+ } else if rest_lower.starts_with("</pre") || rest_lower.starts_with("</textarea") {
767+ in_pre = false;
768+ } else if rest_lower.starts_with("<script") {
769+ in_script = true;
770+ } else if rest_lower.starts_with("</script") {
771+ in_script = false;
772+ } else if rest_lower.starts_with("<style") {
773+ in_style = true;
774+ } else if rest_lower.starts_with("</style") {
775+ in_style = false;
776+ }
777+ }
778+
779+ // Strip HTML comments (<!-- ... -->)
780+ if !in_script
781+ && !in_style
782+ && i + 3 < chars.len()
783+ && chars[i] == '<'
784+ && chars[i + 1] == '!'
785+ && chars[i + 2] == '-'
786+ && chars[i + 3] == '-'
787+ {
788+ // Skip to -->
789+ let mut j = i + 4;
790+ while j + 2 < chars.len() {
791+ if chars[j] == '-' && chars[j + 1] == '-' && chars[j + 2] == '>' {
792+ j += 3;
793+ break;
794+ }
795+ j += 1;
796+ }
797+ i = j;
798+ continue;
799+ }
800+
801+ // In <pre>, preserve everything
802+ if in_pre || in_script || in_style {
803+ result.push(chars[i]);
804+ i += 1;
805+ continue;
806+ }
807+
808+ // Collapse whitespace runs to a single space. Spaces are never
809+ // dropped entirely: next to inline elements they are significant
810+ // ("Built with <span>" must keep its space).
811+ if chars[i].is_whitespace() {
812+ if !prev_was_space {
813+ result.push(' ');
814+ prev_was_space = true;
815+ }
816+ i += 1;
817+ continue;
818+ }
819+
820+ prev_was_space = false;
821+ result.push(chars[i]);
822+ i += 1;
823+ }
824+
825+ result
826+}
827+
828+fn generate_full_inner(doc: &Document, dev: bool, classes: &mut Vec<Class>) -> String {
829+ // Without `@page` the output is a fragment
830+ let Some(page) = &doc.page else {
831+ return generate_partial_inner(doc, dev, classes);
832+ };
833+ let mut styles = StyleCollector::new();
834+ let mut ctx = GenContext {
835+ dev,
836+ depth: 0,
837+ has_interactive: false,
838+ in_text: false,
839+ flow: Flow::default(),
840+ in_picture: false,
841+ };
842+
843+ // The page is the root element: `<body>` is a column (the reset makes
844+ // it one, filling the viewport), `@page`'s styles are its class, and
845+ // the page's top-level elements are its children
846+ let root = Element {
847+ kind: ElementKind::El,
848+ attrs: page.styles.clone(),
849+ argument: None,
850+ children: Vec::new(),
851+ line_num: 0,
852+ function: None,
853+ };
854+ let mut own = Flow::of(&root);
855+ let top = Flow::default();
856+ let site = Site {
857+ kind: &root.kind,
858+ parent: &top,
859+ has_overlay_children: holds_overlays(&doc.nodes),
860+ inline: false,
861+ root: true,
862+ };
863+ let body_class = element_class(&root, &site, &mut styles);
864+ own.class = body_class.clone();
865+ ctx.flow = own;
866+
867+ let mut body = String::new();
868+ generate_children(
869+ &doc.nodes,
870+ Some(Layout::Column),
871+ &mut body,
872+ &mut styles,
873+ &mut ctx,
874+ );
875+
876+ let element_css = build_element_css(doc, &styles, dev);
877+ let nl = if dev { "\n" } else { "" };
878+
879+ let mut meta_html = String::new();
880+ // A `@meta viewport` of the page's own replaces the usual one
881+ if !doc.meta_tags.iter().any(|(name, _)| name == "viewport") {
882+ meta_html.push_str(&format!(
883+ "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">{}",
884+ nl
885+ ));
886+ }
887+ meta_html.push_str(&format!(
888+ "<title>{}</title>{}",
889+ html_escape(&page.title),
890+ nl
891+ ));
892+ for (name, content) in &doc.meta_tags {
893+ meta_html.push_str(&format!(
894+ "<meta name=\"{}\" content=\"{}\">{}",
895+ html_escape(name),
896+ html_escape(content),
897+ nl
898+ ));
899+ }
900+ for (property, content) in &doc.og_tags {
901+ meta_html.push_str(&format!(
902+ "<meta property=\"og:{}\" content=\"{}\">{}",
903+ html_escape(property),
904+ html_escape(content),
905+ nl
906+ ));
907+ }
908+ if let Some(path) = &page.favicon {
909+ meta_html.push_str(&format!(
910+ "<link rel=\"icon\" href=\"{}\">{}",
911+ html_escape(path),
912+ nl
913+ ));
914+ }
915+ for block in &doc.head_blocks {
916+ meta_html.push_str(block);
917+ meta_html.push_str(nl);
918+ }
919+
920+ // `@page`'s HTML attributes go on `<html>`
921+ let mut root_attrs = String::new();
922+ for attr in html_attrs(&page.html_attrs) {
923+ push_html_attr(&mut root_attrs, attr);
924+ }
925+ let mut body_attrs = String::new();
926+ emit_class_attr(&mut body_attrs, body_class.as_deref(), None);
927+
928+ // Focus-visible CSS for interactive elements (accessibility)
929+ let focus_visible_css = if ctx.has_interactive {
930+ let focusable = ":where(a,button,input,select,textarea):focus-visible";
931+ if dev {
932+ format!(
933+ "{}{} {{ outline: 2px solid currentColor; outline-offset: 2px; }}\n",
934+ OWN_ELEMENTS, focusable
935+ )
936+ } else {
937+ format!(
938+ "{}{}{{outline:2px solid currentColor;outline-offset:2px}}",
939+ OWN_ELEMENTS, focusable
940+ )
941+ }
942+ } else {
943+ String::new()
944+ };
945+ let reset_css = reset_css(dev, true, &focus_visible_css);
946+ classes.extend(styles.classes());
947+
948+ format!(
949+ "<!DOCTYPE html>{nl}<html{root_attrs}>{nl}<head>{nl}<meta charset=\"utf-8\">{nl}\
950+ {meta_html}<style>{nl}{reset_css}{element_css}</style>{nl}</head>{nl}\
951+ <body{body_attrs}>{nl}{body}</body>{nl}</html>{nl}",
952+ )
953+}
954+
955+/// Assemble every CSS block the document needs (font faces, custom
956+/// properties, generated class rules, keyframes, and user CSS). Shared by
957+/// full-page and partial output so both emit the same styles.
958+fn build_element_css(doc: &Document, styles: &StyleCollector, dev: bool) -> String {
959+ let mut element_css = String::new();
960+
961+ // Collect the CSS custom properties declared with `@let --name` so they
962+ // can be emitted in a single `:root` block below.
963+ let mut root_vars: Vec<(String, String)> = Vec::new();
964+ for (name, value) in &doc.css_vars {
965+ root_vars.push((name.clone(), value.clone()));
966+ }
967+
968+ // Generated rules always go in htmlang's layers, so unlayered user CSS
969+ // (`@style`, `@raw`) overrides them regardless of specificity.
970+ let styles_css = styles.to_css_formatted(dev, &doc.scoped_css);
971+
972+ // Emit the :root block first so the cascade picks up the custom
973+ // properties before the class rules consume them.
974+ if !root_vars.is_empty() {
975+ if dev {
976+ element_css.push_str(":root {\n");
977+ for (name, value) in &root_vars {
978+ element_css.push_str(&format!(" {}: {};\n", name, value));
979+ }
980+ element_css.push_str("}\n");
981+ } else {
982+ element_css.push_str(":root{");
983+ for (name, value) in &root_vars {
984+ element_css.push_str(name);
985+ element_css.push(':');
986+ element_css.push_str(value);
987+ element_css.push(';');
988+ }
989+ element_css.push('}');
990+ }
991+ }
992+
993+ element_css.push_str(&styles_css);
994+
995+ // @style blocks (custom CSS)
996+ for block in &doc.custom_css {
997+ if dev {
998+ element_css.push_str(block);
999+ element_css.push('\n');
1000+ } else {
1001+ element_css.push_str(&compact_css(block));
1002+ }
1003+ }
1004+
1005+ element_css
1006+}
1007+
1008+/// An `@style` body on one line: each line trimmed, and the lines joined with
1009+/// a space, so a value that goes on over two lines (`margin: 0` then `auto;`)
1010+/// keeps its words apart.
1011+fn compact_css(block: &str) -> String {
1012+ block
1013+ .lines()
1014+ .map(str::trim)
1015+ .filter(|l| !l.is_empty())
1016+ .collect::<Vec<_>>()
1017+ .join(" ")
1018+}
1019+
1020+/// htmlang's own elements: those with a generated class, or the class of a
1021+/// function's scoped `@style`. The reset's rules for elements are kept to
1022+/// them, so `@raw` and `@markdown` content, and the page a fragment is put
1023+/// into, keep their own.
1024+const OWN_ELEMENTS: &str = ":where([class^=\"hl-\"],[class*=\" hl-\"])";
1025+
1026+/// htmlang's cascade layers, from the one that loses to the one that wins:
1027+/// the reset; the defaults of each element's kind (a heading's `margin:0`,
1028+/// a column's `display:flex`); the styles an element gets from an
1029+/// element prefix on an element around it (`@td:padding 8`) and from a
1030+/// function's scoped `@style`; and the element's own styles. So a
1031+/// scope's styles win over the defaults, and what an element says about
1032+/// itself wins over both. CSS outside any layer (`@style`, `@raw`) wins
1033+/// over all of them.
1034+const LAYERS: [&str; 4] = ["hl-reset", "hl-kind", "hl-inside", "htmlang"];
1035+
1036+/// Built-in reset rules, in a layer before `htmlang`: unlayered CSS beats
1037+/// every layer, so an unlayered rule here would override the generated
1038+/// ones. A page resets `box-sizing` everywhere and makes `<body>` a column
1039+/// that fills the window; a fragment, which goes into a page it doesn't
1040+/// own, touches only htmlang's own elements. In both, an element htmlang
1041+/// lays out stays hidden while it is `hidden`, a closed `<dialog>` or a
1042+/// popover that isn't showing: its generated `display` would otherwise
1043+/// beat the browser's `display: none`.
1044+fn reset_css(dev: bool, page: bool, focus_visible_css: &str) -> String {
1045+ let own = OWN_ELEMENTS;
1046+ let mut rules = Vec::new();
1047+ if page {
1048+ rules.push(if dev {
1049+ "*, *::before, *::after { box-sizing: border-box; }".to_string()
1050+ } else {
1051+ "*,*::before,*::after{box-sizing:border-box}".to_string()
1052+ });
1053+ rules.push(if dev {
1054+ "body { margin: 0; font-family: system-ui, -apple-system, sans-serif; display: flex; flex-direction: column; min-height: 100dvh; }".to_string()
1055+ } else {
1056+ "body{margin:0;font-family:system-ui,-apple-system,sans-serif;display:flex;flex-direction:column;min-height:100dvh}".to_string()
1057+ });
1058+ } else {
1059+ rules.push(if dev {
1060+ format!("{own}, {own}::before, {own}::after {{ box-sizing: border-box; }}")
1061+ } else {
1062+ format!("{own},{own}::before,{own}::after{{box-sizing:border-box}}")
1063+ });
1064+ }
1065+ let hidden = "[hidden]:not([hidden=\"until-found\"]),dialog:not([open]):not(:popover-open),\
1066+ [popover]:not(:popover-open):not(dialog[open])";
1067+ rules.push(if dev {
1068+ format!("{own}:where({hidden}) {{ display: none !important; }}")
1069+ } else {
1070+ format!("{own}:where({hidden}){{display:none!important}}")
1071+ });
1072+ let mut rules = rules.join(if dev { "\n" } else { "" });
1073+ if dev {
1074+ rules.push('\n');
1075+ }
1076+ rules.push_str(focus_visible_css);
1077+ if dev {
1078+ format!(
1079+ "@layer {};\n@layer hl-reset {{\n{}}}\n",
1080+ LAYERS.join(", "),
1081+ rules
1082+ )
1083+ } else {
1084+ format!("@layer {};@layer hl-reset{{{}}}", LAYERS.join(","), rules)
1085+ }
1086+}
1087+
1088+/// Generate an HTML fragment: body + optional <style>, no <html>/<head>/<body> wrapper.
1089+fn generate_partial_inner(doc: &Document, dev: bool, classes: &mut Vec<Class>) -> String {
1090+ let mut styles = StyleCollector::new();
1091+ let mut ctx = GenContext {
1092+ dev,
1093+ depth: 0,
1094+ has_interactive: false,
1095+ in_text: false,
1096+ flow: Flow::default(),
1097+ in_picture: false,
1098+ };
1099+ let mut body = String::new();
1100+
1101+ generate_children(&doc.nodes, None, &mut body, &mut styles, &mut ctx);
1102+
1103+ let mut element_css = build_element_css(doc, &styles, dev);
1104+ // htmlang's own elements get the reset's rules for elements (which
1105+ // also puts htmlang's layers in order)
1106+ if !styles.entries.is_empty() || !doc.scoped_css.is_empty() {
1107+ element_css.insert_str(0, &reset_css(dev, false, ""));
1108+ }
1109+ classes.extend(styles.classes());
1110+
1111+ if element_css.is_empty() {
1112+ body
1113+ } else if dev {
1114+ format!("<style>\n{}</style>\n{}", element_css, body)
1115+ } else {
1116+ format!("<style>{}</style>{}", element_css, body)
1117+ }
1118+}
1119+
1120+// ---------------------------------------------------------------------------
1121+// Node generation
1122+// ---------------------------------------------------------------------------
1123+
1124+/// Write `node`, which is inside an element with the layout `parent`
1125+/// (`None` at the top of the page).
1126+fn generate_node(
1127+ node: &Node,
1128+ parent: Option<Layout>,
1129+ out: &mut String,
1130+ styles: &mut StyleCollector,
1131+ ctx: &mut GenContext,
1132+) {
1133+ match node {
1134+ Node::Element(elem) => generate_element(elem, parent, out, styles, ctx),
1135+ Node::Text(segments) => {
1136+ // In a row, column or grid each line of text is a child
1137+ let needs_wrap = parent.is_some_and(Layout::is_container);
1138+ if needs_wrap {
1139+ out.push_str(&ctx.indent());
1140+ out.push_str("<span>");
1141+ }
1142+ generate_text_segments(segments, out, styles, ctx);
1143+ if needs_wrap {
1144+ out.push_str("</span>");
1145+ out.push_str(ctx.nl());
1146+ }
1147+ }
1148+ Node::Raw(content) => {
1149+ out.push_str(&ctx.indent());
1150+ out.push_str(content);
1151+ out.push_str(ctx.nl());
1152+ }
1153+ }
1154+}
1155+
1156+/// What goes between two things written one after the other in an element
1157+/// with this layout (`None`: the top of the page): text flows, so its lines
1158+/// and children are joined with a space; in HTML's own layout, and at the
1159+/// top of the page, two lines of text are separated by a line break (a
1160+/// space, except where whitespace is kept, as in `@pre`).
1161+fn separator(layout: Option<Layout>, previous_is_text: bool, next: &Node) -> Option<char> {
1162+ match layout {
1163+ Some(Layout::Text) => Some(' '),
1164+ Some(Layout::Native) | None if previous_is_text && matches!(next, Node::Text(_)) => {
1165+ Some('\n')
1166+ }
1167+ _ => None,
1168+ }
1169+}
1170+
1171+/// Write the children of an element (or of a `@fragment`, which has no
1172+/// element of its own) laid out as `layout` (`None`: the top of the page).
1173+/// The first line of an element's text is its first child.
1174+fn generate_children(
1175+ children: &[Node],
1176+ layout: Option<Layout>,
1177+ out: &mut String,
1178+ styles: &mut StyleCollector,
1179+ ctx: &mut GenContext,
1180+) {
1181+ generate_run(children, layout, &mut None, out, styles, ctx);
1182+}
1183+
1184+/// [`generate_children`], with `previous` saying whether what was written
1185+/// last was a line of text (`None`: nothing yet). A `@fragment`'s children
1186+/// are written as if they stood in its place, so its lines are separated
1187+/// from the lines around it like any other lines.
1188+fn generate_run(
1189+ children: &[Node],
1190+ layout: Option<Layout>,
1191+ previous: &mut Option<bool>,
1192+ out: &mut String,
1193+ styles: &mut StyleCollector,
1194+ ctx: &mut GenContext,
1195+) {
1196+ for child in children {
1197+ if let Node::Element(elem) = child
1198+ && elem.kind == ElementKind::Fragment
1199+ {
1200+ generate_run(&elem.children, layout, previous, out, styles, ctx);
1201+ continue;
1202+ }
1203+ let start = out.len();
1204+ if let Some(previous_is_text) = *previous
1205+ && let Some(sep) = separator(layout, previous_is_text, child)
1206+ {
1207+ out.push(sep);
1208+ }
1209+ let body = out.len();
1210+ generate_node(child, layout, out, styles, ctx);
1211+ // A child that writes nothing (an empty `@fragment`) takes no
1212+ // separator either, so text never gets two spaces in a row
1213+ if out.len() == body {
1214+ out.truncate(start);
1215+ continue;
1216+ }
1217+ *previous = Some(matches!(child, Node::Text(_)));
1218+ }
1219+}
1220+
1221+/// Emit the element's leading argument as its attribute (`@iframe URL` →
1222+/// `src="URL"`, `@form /submit` → `action="/submit"`, `@link /a` →
1223+/// `href="/a"`), first, before the class. `@image [inline] photo.png` puts
1224+/// the file itself into the page.
1225+fn emit_argument_attr(out: &mut String, elem: &Element, in_picture: bool) {
1226+ let (Some(attr), Some(value)) = (elem.kind.leading_attribute(in_picture), &elem.argument)
1227+ else {
1228+ return;
1229+ };
1230+ // `@image [inline]`'s file is already a `data:` URI (see the parser)
1231+ let value = html_escape(value);
1232+ out.push(' ');
1233+ out.push_str(attr);
1234+ out.push_str("=\"");
1235+ out.push_str(&value);
1236+ out.push('"');
1237+}
1238+
1239+/// A file's bytes as a `data:` URI, its type from its extension.
1240+pub(crate) fn data_uri(path: &str, data: &[u8]) -> String {
1241+ let mime = match path
1242+ .rsplit('.')
1243+ .next()
1244+ .map(str::to_ascii_lowercase)
1245+ .as_deref()
1246+ {
1247+ Some("png") => "image/png",
1248+ Some("jpg" | "jpeg") => "image/jpeg",
1249+ Some("gif") => "image/gif",
1250+ Some("webp") => "image/webp",
1251+ Some("avif") => "image/avif",
1252+ Some("svg") => "image/svg+xml",
1253+ Some("ico") => "image/x-icon",
1254+ _ => "application/octet-stream",
1255+ };
1256+ format!("data:{};base64,{}", mime, base64_encode(data))
1257+}
1258+
1259+/// Emit HTML attributes: `key=value` ones (except `id` / `class`, which
1260+/// are emitted with the generated class) and flags like `required`.
1261+fn emit_html_attrs(out: &mut String, attrs: &[Attribute]) {
1262+ for attr in html_attrs(attrs) {
1263+ let key = attr.key.as_str();
1264+ if key != "id" && key != "class" {
1265+ push_html_attr(out, attr);
1266+ }
1267+ }
1268+}
1269+
1270+/// The HTML attributes of `attrs`, `key=value` ones and flags, each name
1271+/// once: the later one wins, as a style does. (Of two attributes with one
1272+/// name, the browser keeps the first, so a bundle's attribute or a
1273+/// function's own would win over one written after it.)
1274+fn html_attrs(attrs: &[Attribute]) -> impl Iterator<Item = &Attribute> {
1275+ let is_html =
1276+ |a: &Attribute| a.html || (a.value.is_none() && crate::vocab::is_html_flag(&a.key));
1277+ attrs.iter().enumerate().filter_map(move |(i, attr)| {
1278+ let later = attrs[i + 1..]
1279+ .iter()
1280+ .any(|other| is_html(other) && other.key == attr.key);
1281+ (is_html(attr) && !later).then_some(attr)
1282+ })
1283+}
1284+
1285+/// ` key="value"`, or ` key` for a flag.
1286+fn push_html_attr(out: &mut String, attr: &Attribute) {
1287+ out.push(' ');
1288+ out.push_str(&attr.key);
1289+ if attr.html {
1290+ out.push_str("=\"");
1291+ // Quoted text has already lost its quotes (see parser.rs)
1292+ out.push_str(&html_escape(attr.value.as_deref().unwrap_or("")));
1293+ out.push('"');
1294+ }
1295+}
1296+
1297+// True if any direct child is `@in-front` or `@behind`. Such children render
1298+// as absolutely positioned overlays, so the parent automatically becomes a
1299+// positioning context (position:relative + isolation:isolate).
1300+fn has_overlay_children(elem: &Element) -> bool {
1301+ holds_overlays(&elem.children)
1302+}
1303+
1304+fn holds_overlays(children: &[Node]) -> bool {
1305+ children.iter().any(|child| {
1306+ matches!(
1307+ child,
1308+ Node::Element(e) if e.kind.is_tag("in-front") || e.kind.is_tag("behind")
1309+ )
1310+ })
1311+}
1312+
1313+fn generate_element(
1314+ elem: &Element,
1315+ parent: Option<Layout>,
1316+ out: &mut String,
1317+ styles: &mut StyleCollector,
1318+ ctx: &mut GenContext,
1319+) {
1320+ // Self-closing elements
1321+ if elem.kind.layout() == Layout::Void {
1322+ generate_self_closing(elem, parent, out, styles, ctx);
1323+ return;
1324+ }
1325+ // A verbatim element (@script) writes its body as it is, with no HTML
1326+ // escaping; it isn't shown, so it has no class (its styles are an error)
1327+ if elem.kind.is_verbatim() {
1328+ let tag = elem.kind.spec().map_or("script", |spec| spec.html);
1329+ out.push_str(&ctx.indent());
1330+ out.push('<');
1331+ out.push_str(tag);
1332+ emit_argument_attr(out, elem, false);
1333+ let (id, class) = extract_id_class(&elem.attrs);
1334+ for (key, value) in [("id", id), ("class", class)] {
1335+ if let Some(value) = value {
1336+ out.push_str(&format!(" {}=\"{}\"", key, html_escape(&value)));
1337+ }
1338+ }
1339+ emit_html_attrs(out, &elem.attrs);
1340+ out.push('>');
1341+ for child in &elem.children {
1342+ match child {
1343+ Node::Text(segments) => {
1344+ for seg in segments {
1345+ if let TextSegment::Plain(text) = seg {
1346+ out.push_str(text)
1347+ }
1348+ }
1349+ }
1350+ Node::Raw(content) => out.push_str(content),
1351+ _ => {}
1352+ }
1353+ }
1354+ out.push_str("</");
1355+ out.push_str(tag);
1356+ out.push('>');
1357+ out.push_str(ctx.nl());
1358+ return;
1359+ }
1360+ if elem.kind == ElementKind::Children {
1361+ return;
1362+ }
1363+ if matches!(elem.kind, ElementKind::Slot(_)) {
1364+ return;
1365+ }
1366+ if elem.kind == ElementKind::Fragment {
1367+ // Render children without a wrapper element, as if they were
1368+ // written where the fragment is
1369+ generate_children(&elem.children, parent, out, styles, ctx);
1370+ return;
1371+ }
1372+
1373+ let mut own = Flow::of(elem);
1374+ let tag = match &elem.kind {
1375+ ElementKind::Row | ElementKind::El => "div",
1376+ ElementKind::Text => "span",
1377+ ElementKind::Paragraph => "p",
1378+ ElementKind::Link => "a",
1379+ ElementKind::Tag(spec) => spec.html,
1380+ _ => "",
1381+ };
1382+ // Inside text, htmlang's own `<div>` is a `<span>`, which text can
1383+ // hold (directly in text, a row, column or grid is also laid out
1384+ // inline: see `Site::inline`)
1385+ let in_text = ctx.in_text || parent == Some(Layout::Text);
1386+ let tag = if in_text && tag == "div" { "span" } else { tag };
1387+ let kind_label = elem.kind.name();
1388+
1389+ // Track interactive elements for focus-visible CSS
1390+ if elem.kind == ElementKind::Link
1391+ || matches!(kind_label, "button" | "input" | "select" | "textarea")
1392+ {
1393+ ctx.has_interactive = true;
1394+ }
1395+
1396+ // Compute CSS for each state and get a class name
1397+ let gen_class = element_class(elem, &Site::new(elem, parent, &ctx.flow), styles);
1398+ own.class = gen_class.clone();
1399+ let (id, user_class) = extract_id_class(&elem.attrs);
1400+
1401+ if ctx.dev && elem.line_num > 0 {
1402+ out.push_str(&ctx.indent());
1403+ out.push_str(&format!(
1404+ "<!-- @{} line {} -->\n",
1405+ kind_label, elem.line_num
1406+ ));
1407+ }
1408+ out.push_str(&ctx.indent());
1409+ out.push('<');
1410+ out.push_str(tag);
1411+
1412+ emit_argument_attr(out, elem, ctx.in_picture);
1413+
1414+ emit_class_attr(out, gen_class.as_deref(), user_class.as_deref());
1415+
1416+ if let Some(id) = id {
1417+ out.push_str(" id=\"");
1418+ out.push_str(&html_escape(&id));
1419+ out.push('"');
1420+ }
1421+
1422+ emit_html_attrs(out, &elem.attrs);
1423+
1424+ // Source map attributes in dev mode
1425+ if ctx.dev && elem.line_num > 0 {
1426+ out.push_str(&format!(
1427+ " data-hl-line=\"{}\" data-hl-el=\"{}\"",
1428+ elem.line_num, kind_label
1429+ ));
1430+ }
1431+
1432+ out.push('>');
1433+ // In `<pre>` and `<textarea>` every space and line break shows, so
1434+ // readable (dev) output adds none there: a code sample's lines stay
1435+ // exactly as written
1436+ let outer_dev = ctx.dev;
1437+ ctx.dev &= !matches!(tag, "pre" | "textarea");
1438+ out.push_str(ctx.nl());
1439+
1440+ let layout = elem.kind.layout();
1441+ ctx.depth += 1;
1442+ let outer_in_text = ctx.in_text;
1443+ ctx.in_text = in_text || layout == Layout::Text;
1444+ let outer_flow = std::mem::replace(&mut ctx.flow, own);
1445+ let outer_picture = std::mem::replace(&mut ctx.in_picture, elem.kind.is_tag("picture"));
1446+ generate_children(&elem.children, Some(layout), out, styles, ctx);
1447+ ctx.in_picture = outer_picture;
1448+ ctx.flow = outer_flow;
1449+ ctx.in_text = outer_in_text;
1450+ ctx.depth -= 1;
1451+
1452+ out.push_str(&ctx.indent());
1453+ ctx.dev = outer_dev;
1454+ out.push_str("</");
1455+ out.push_str(tag);
1456+ out.push('>');
1457+ out.push_str(ctx.nl());
1458+}
1459+
1460+fn generate_self_closing(
1461+ elem: &Element,
1462+ parent: Option<Layout>,
1463+ out: &mut String,
1464+ styles: &mut StyleCollector,
1465+ ctx: &mut GenContext,
1466+) {
1467+ let gen_class = element_class(elem, &Site::new(elem, parent, &ctx.flow), styles);
1468+ let (id, user_class) = extract_id_class(&elem.attrs);
1469+
1470+ let (tag, kind_label) = match &elem.kind {
1471+ ElementKind::Image => ("img", "image"),
1472+ ElementKind::Tag(spec) => (spec.html, spec.name),
1473+ _ => unreachable!("not a void element: {:?}", elem.kind),
1474+ };
1475+
1476+ if ctx.dev && elem.line_num > 0 {
1477+ out.push_str(&ctx.indent());
1478+ out.push_str(&format!(
1479+ "<!-- @{} line {} -->\n",
1480+ kind_label, elem.line_num
1481+ ));
1482+ }
1483+ out.push_str(&ctx.indent());
1484+ out.push('<');
1485+ out.push_str(tag);
1486+ emit_argument_attr(out, elem, ctx.in_picture);
1487+
1488+ emit_class_attr(out, gen_class.as_deref(), user_class.as_deref());
1489+
1490+ if let Some(id) = id {
1491+ out.push_str(" id=\"");
1492+ out.push_str(&html_escape(&id));
1493+ out.push('"');
1494+ }
1495+
1496+ emit_html_attrs(out, &elem.attrs);
1497+
1498+ // Source map attributes in dev mode (self-closing)
1499+ if ctx.dev && elem.line_num > 0 {
1500+ out.push_str(&format!(
1501+ " data-hl-line=\"{}\" data-hl-el=\"{}\"",
1502+ elem.line_num, kind_label
1503+ ));
1504+ }
1505+
1506+ out.push('>');
1507+ out.push_str(ctx.nl());
1508+}
1509+
1510+fn generate_text_segments(
1511+ segments: &[TextSegment],
1512+ out: &mut String,
1513+ styles: &mut StyleCollector,
1514+ ctx: &mut GenContext,
1515+) {
1516+ for segment in segments {
1517+ match segment {
1518+ TextSegment::Plain(text) => out.push_str(&html_escape(text)),
1519+ TextSegment::Inline(elem) => {
1520+ let mut buf = String::new();
1521+ // An element inside a line of text is in text
1522+ let outer_flow = std::mem::take(&mut ctx.flow);
1523+ generate_element(elem, Some(Layout::Text), &mut buf, styles, ctx);
1524+ ctx.flow = outer_flow;
1525+ out.push_str(buf.trim_end());
1526+ }
1527+ }
1528+ }
1529+}
1530+
1531+// ---------------------------------------------------------------------------
1532+// Style helpers
1533+// ---------------------------------------------------------------------------
1534+
1535+fn compute_class(
1536+ attrs: &[Attribute],
1537+ site: &Site,
1538+ styles: &mut StyleCollector,
1539+ distinct: String,
1540+) -> Option<String> {
1541+ // Every condition an attribute is under, and none
1542+ let mut conditions = vec![Condition::default()];
1543+ for attr in attrs.iter().filter(|a| !a.html) {
1544+ let (condition, _) = Condition::of(&attr.key);
1545+ if !conditions.contains(&condition) {
1546+ conditions.push(condition);
1547+ }
1548+ }
1549+ // Dedupe: if a property is declared twice within a single rule, keep only
1550+ // the last occurrence.
1551+ let rules: Vec<(Condition, String)> = conditions
1552+ .into_iter()
1553+ .map(|condition| {
1554+ let css = dedupe_declarations(&attrs_to_css(attrs, &condition, site));
1555+ (condition, css)
1556+ })
1557+ .collect();
1558+ // The kind's defaults, less what the element sets itself (a user
1559+ // `[list-style disc]` wins over the default `list-style:none` anyway,
1560+ // so there is no need to ship both)
1561+ let own = rules
1562+ .iter()
1563+ .find(|(condition, _)| *condition == Condition::default())
1564+ .map_or("", |(_, css)| css.as_str());
1565+ let own: Vec<&str> = declarations(own).map(|(name, _)| name).collect();
1566+ let defaults: String = declarations(&dedupe_declarations(&default_css(site)))
1567+ .filter(|(name, _)| !own.contains(name))
1568+ .map(|(_, declaration)| declaration)
1569+ .collect();
1570+ styles.get_class(defaults, rules, distinct)
1571+}
1572+
1573+/// The defaults of an element's kind where it is: an overlay's positioning
1574+/// context, its layout, and its kind's own CSS (a heading's `margin:0`).
1575+fn default_css(site: &Site) -> String {
1576+ let mut css = String::new();
1577+ // Elements with @in-front / @behind children become positioning
1578+ // contexts
1579+ if site.has_overlay_children {
1580+ css.push_str("position:relative;isolation:isolate;");
1581+ }
1582+ if !site.root {
1583+ css.push_str(layout_css(site.kind.layout(), site.inline));
1584+ }
1585+ css.push_str(site.kind.css());
1586+ css
1587+}
1588+
1589+/// The declarations of a rule body, as (property, `property:value;`), for
1590+/// bodies htmlang wrote: every declaration ends in `;`, and a `;` inside
1591+/// quotes or parentheses doesn't end one.
1592+fn declarations(css: &str) -> impl Iterator<Item = (&str, &str)> {
1593+ let mut rest = css;
1594+ std::iter::from_fn(move || {
1595+ if rest.is_empty() {
1596+ return None;
1597+ }
1598+ let (mut depth, mut quote, mut escaped) = (0i32, None, false);
1599+ let mut end = rest.len();
1600+ for (i, c) in rest.char_indices() {
1601+ match c {
1602+ _ if escaped => escaped = false,
1603+ '\\' => escaped = true,
1604+ c if Some(c) == quote => quote = None,
1605+ _ if quote.is_some() => {}
1606+ '"' | '\'' => quote = Some(c),
1607+ '(' => depth += 1,
1608+ ')' => depth -= 1,
1609+ ';' if depth == 0 => {
1610+ end = i + 1;
1611+ break;
1612+ }
1613+ _ => {}
1614+ }
1615+ }
1616+ let (declaration, after) = rest.split_at(end);
1617+ rest = after;
1618+ let name = declaration.split(':').next().unwrap_or("").trim();
1619+ Some((name, declaration))
1620+ })
1621+}
1622+
1623+/// Dedupe CSS declarations within a single rule body: for any property
1624+/// declared more than once, keep only the last occurrence. Unparseable
1625+/// segments (no `:`) are preserved as-is. Semicolons inside parentheses or
1626+/// quoted strings are treated as part of a value, not as declaration
1627+/// separators.
1628+fn dedupe_declarations(css: &str) -> String {
1629+ if css.is_empty() {
1630+ return String::new();
1631+ }
1632+ // Quick path: no chance of duplicates if there's fewer than 2 declarations.
1633+ if css.matches(';').count() < 2 {
1634+ return css.to_string();
1635+ }
1636+
1637+ // Split into (property_name_opt, full_decl_with_semi) preserving whatever
1638+ // terminator the input used. We split on `;` at depth 0 (ignoring parens).
1639+ let mut decls: Vec<(Option<String>, String)> = Vec::new();
1640+ let mut current = String::new();
1641+ let mut depth: i32 = 0;
1642+ // A quoted string's `;` (`content "a;b"`) is text; a backslash escapes
1643+ // the character after it
1644+ let mut quote: Option<char> = None;
1645+ let mut escaped = false;
1646+ for ch in css.chars() {
1647+ if escaped {
1648+ escaped = false;
1649+ current.push(ch);
1650+ } else if ch == '\\' {
1651+ escaped = true;
1652+ current.push(ch);
1653+ } else if let Some(q) = quote {
1654+ if ch == q {
1655+ quote = None;
1656+ }
1657+ current.push(ch);
1658+ } else if ch == '"' || ch == '\'' {
1659+ quote = Some(ch);
1660+ current.push(ch);
1661+ } else if ch == '(' {
1662+ depth += 1;
1663+ current.push(ch);
1664+ } else if ch == ')' {
1665+ depth -= 1;
1666+ current.push(ch);
1667+ } else if ch == ';' && depth == 0 {
1668+ current.push(';');
1669+ let trimmed = current.trim();
1670+ if !trimmed.is_empty() && trimmed != ";" {
1671+ let prop = trimmed
1672+ .trim_end_matches(';')
1673+ .split_once(':')
1674+ .map(|(p, _)| p.trim().to_ascii_lowercase());
1675+ decls.push((prop, std::mem::take(&mut current)));
1676+ } else {
1677+ current.clear();
1678+ }
1679+ } else {
1680+ current.push(ch);
1681+ }
1682+ }
1683+ if !current.trim().is_empty() {
1684+ let prop = current
1685+ .split_once(':')
1686+ .map(|(p, _)| p.trim().to_ascii_lowercase());
1687+ decls.push((prop, std::mem::take(&mut current)));
1688+ }
1689+
1690+ if decls.len() < 2 {
1691+ return css.to_string();
1692+ }
1693+
1694+ // Find index of last occurrence of each property.
1695+ use std::collections::HashMap;
1696+ let mut last: HashMap<String, usize> = HashMap::new();
1697+ for (i, (prop, _)) in decls.iter().enumerate() {
1698+ if let Some(p) = prop {
1699+ last.insert(p.clone(), i);
1700+ }
1701+ }
1702+
1703+ let mut out = String::with_capacity(css.len());
1704+ for (i, (prop, raw)) in decls.iter().enumerate() {
1705+ let keep = match prop {
1706+ Some(p) => last.get(p) == Some(&i),
1707+ None => true,
1708+ };
1709+ if keep {
1710+ out.push_str(raw);
1711+ }
1712+ }
1713+ out
1714+}
1715+
1716+fn emit_class_attr(out: &mut String, gen_class: Option<&str>, user_class: Option<&str>) {
1717+ match (gen_class, user_class) {
1718+ (Some(g), Some(u)) => {
1719+ out.push_str(" class=\"");
1720+ out.push_str(g);
1721+ out.push(' ');
1722+ out.push_str(&html_escape(u));
1723+ out.push('"');
1724+ }
1725+ (Some(g), None) => {
1726+ out.push_str(" class=\"");
1727+ out.push_str(g);
1728+ out.push('"');
1729+ }
1730+ (None, Some(u)) => {
1731+ out.push_str(" class=\"");
1732+ out.push_str(&html_escape(u));
1733+ out.push('"');
1734+ }
1735+ (None, None) => {}
1736+ }
1737+}
1738+
1739+// ---------------------------------------------------------------------------
1740+// Attribute → CSS mapping
1741+// ---------------------------------------------------------------------------
1742+
1743+/// Where an element is written, which its CSS depends on.
1744+struct Site<'a> {
1745+ kind: &'a ElementKind,
1746+ /// How its parent lays out its children: its `width fill`, `height
1747+ /// fill` and `shrink` compile against it.
1748+ parent: &'a Flow,
1749+ /// It has `@in-front` / `@behind` children.
1750+ has_overlay_children: bool,
1751+ /// A row, column or grid inside text, laid out inline.
1752+ inline: bool,
1753+ /// The page's `<body>`, which the reset already makes a column.
1754+ root: bool,
1755+}
1756+
1757+impl Site<'_> {
1758+ /// Where an element in a parent with the layout `layout` and the flow
1759+ /// `parent` is.
1760+ fn new<'a>(elem: &'a Element, layout: Option<Layout>, parent: &'a Flow) -> Site<'a> {
1761+ Site {
1762+ kind: &elem.kind,
1763+ parent,
1764+ has_overlay_children: has_overlay_children(elem),
1765+ inline: layout == Some(Layout::Text) && elem.kind.layout().is_container(),
1766+ root: false,
1767+ }
1768+ }
1769+}
1770+
1771+// ---------------------------------------------------------------------------
1772+// Direction: what a child's `fill` and `shrink` compile against
1773+// ---------------------------------------------------------------------------
1774+
1775+/// The way a flex row or column lays out its children.
1776+#[derive(Clone, Copy, PartialEq, Eq, Debug)]
1777+enum Axis {
1778+ Row,
1779+ Column,
1780+}
1781+
1782+impl Axis {
1783+ /// The direction a `flex-direction` or `flex-flow` value sets, if it
1784+ /// names one (not `var(--dir)`, which only the browser knows).
1785+ fn of_value(value: &str) -> Option<Axis> {
1786+ value.split_whitespace().find_map(|word| match word {
1787+ "row" | "row-reverse" => Some(Axis::Row),
1788+ "column" | "column-reverse" => Some(Axis::Column),
1789+ _ => None,
1790+ })
1791+ }
1792+}
1793+
1794+/// How an element lays out its children, as its CSS sets it: the
1795+/// direction its children's `width`/`height` `fill` and `shrink` compile
1796+/// against. That is the direction of `@row` or of a column, or the one its
1797+/// own `flex-direction` (or `flex-flow`) sets, with or without media or
1798+/// container prefixes. Like elm-ui's `.r > .wf`, the rules for a direction
1799+/// set under a prefix are keyed on the element's class: `@media (...) {
1800+/// :where(.a)>.b {...} }`.
1801+#[derive(Clone, Default)]
1802+struct Flow {
1803+ /// Without a prefix; `None` when the element isn't a flex row or column
1804+ /// (a grid, text, HTML's own layout, the top of the page)
1805+ base: Option<Axis>,
1806+ /// The direction under each chain of at-rule prefixes that sets one, in
1807+ /// the order their blocks are written
1808+ changes: Vec<(Vec<usize>, Axis)>,
1809+ /// The element's generated class, which the rules for the changes are
1810+ /// keyed on
1811+ class: Option<String>,
1812+}
1813+
1814+impl Flow {
1815+ fn of(elem: &Element) -> Flow {
1816+ let mut base = match elem.kind.layout() {
1817+ Layout::Row => Axis::Row,
1818+ Layout::Column => Axis::Column,
1819+ _ => return Flow::default(),
1820+ };
1821+ let mut changes: Vec<(Vec<usize>, Axis)> = Vec::new();
1822+ for attr in elem.attrs.iter().filter(|a| !a.html) {
1823+ let (condition, name) = Condition::of(&attr.key);
1824+ if !matches!(name, "flex-direction" | "flex-flow") || !condition.selector.is_empty() {
1825+ continue;
1826+ }
1827+ let Some(axis) = attr.value.as_deref().and_then(Axis::of_value) else {
1828+ continue;
1829+ };
1830+ if condition.at.is_empty() {
1831+ base = axis;
1832+ } else {
1833+ // The later one wins, as in the CSS
1834+ changes.retain(|(at, _)| *at != condition.at);
1835+ changes.push((condition.at, axis));
1836+ }
1837+ }
1838+ changes.sort_by_key(|(at, _)| at_order(at));
1839+ Flow {
1840+ base: Some(base),
1841+ changes,
1842+ class: None,
1843+ }
1844+ }
1845+
1846+ /// The direction under the at-rules `at`: the latest one set among
1847+ /// the conditions that hold there (`md:` holds at `lg:`), else the one
1848+ /// without a prefix.
1849+ fn at(&self, at: &[usize]) -> Option<Axis> {
1850+ let base = self.base?;
1851+ let here = Condition::at_only(at);
1852+ let changed = self
1853+ .changes
1854+ .iter()
1855+ .rev()
1856+ .find(|(chain, _)| Condition::at_only(chain).holds_at(&here))
1857+ .map(|&(_, axis)| axis);
1858+ Some(changed.unwrap_or(base))
1859+ }
1860+}
1861+
1862+/// `width` or `height`.
1863+#[derive(Clone, Copy, PartialEq, Eq)]
1864+enum Dim {
1865+ Width,
1866+ Height,
1867+}
1868+
1869+/// What a `width` or `height` says.
1870+#[derive(Clone, Copy, PartialEq, Eq)]
1871+enum Size {
1872+ Fill,
1873+ Shrink,
1874+ /// A size of its own (`width 300`)
1875+ Set,
1876+}
1877+
1878+impl Size {
1879+ fn of(value: &str) -> Size {
1880+ match value.trim() {
1881+ "fill" => Size::Fill,
1882+ "shrink" => Size::Shrink,
1883+ _ => Size::Set,
1884+ }
1885+ }
1886+}
1887+
1888+/// The declarations `fill` and `shrink` make in a parent laid out along
1889+/// `axis` (`None`: not a flex row or column). Along the parent's direction,
1890+/// `fill` takes the remaining space and `shrink` keeps the content's size;
1891+/// across it (or outside flex), `fill` is the full size and `shrink` fits
1892+/// the content.
1893+fn sizing(dim: Dim, size: Size, axis: Option<Axis>) -> &'static [(&'static str, &'static str)] {
1894+ match (dim, size, axis) {
1895+ (_, Size::Set, _) => &[],
1896+ (Dim::Width, Size::Fill, Some(Axis::Row)) => &[("flex", "1"), ("min-width", "0")],
1897+ (Dim::Width, Size::Fill, _) => &[("width", "100%")],
1898+ (Dim::Width, Size::Shrink, Some(Axis::Row)) => &[("flex-shrink", "0")],
1899+ (Dim::Width, Size::Shrink, _) => &[("width", "fit-content")],
1900+ (Dim::Height, Size::Fill, Some(Axis::Column)) => &[("flex", "1"), ("min-height", "0")],
1901+ (Dim::Height, Size::Fill, _) => &[("height", "100%")],
1902+ (Dim::Height, Size::Shrink, Some(Axis::Column)) => &[("flex-shrink", "0")],
1903+ (Dim::Height, Size::Shrink, _) => &[("height", "fit-content")],
1904+ }
1905+}
1906+
1907+/// Every property `fill` and `shrink` of `dim` can set, with its initial
1908+/// value (`flex` covers `flex-shrink`).
1909+fn sizing_properties(dim: Dim) -> [(&'static str, &'static str); 3] {
1910+ match dim {
1911+ Dim::Width => [
1912+ ("flex", "0 1 auto"),
1913+ ("min-width", "auto"),
1914+ ("width", "auto"),
1915+ ],
1916+ Dim::Height => [
1917+ ("flex", "0 1 auto"),
1918+ ("min-height", "auto"),
1919+ ("height", "auto"),
1920+ ],
1921+ }
1922+}
1923+
1924+/// What an element's attributes under some prefixes say about its size.
1925+#[derive(Default)]
1926+struct Sizes {
1927+ /// The last `width` and `height`
1928+ width: Option<Size>,
1929+ height: Option<Size>,
1930+ /// A `fill` or `shrink` for the width / height is among them (a later
1931+ /// size may replace it)
1932+ width_word: bool,
1933+ height_word: bool,
1934+ /// It writes `flex`, one of its longhands (`flex-grow`, `flex-shrink`,
1935+ /// `flex-basis`), `min-width` or `min-height` itself
1936+ flex: bool,
1937+ flex_grow: bool,
1938+ flex_shrink: bool,
1939+ flex_basis: bool,
1940+ min_width: bool,
1941+ min_height: bool,
1942+}
1943+
1944+impl Sizes {
1945+ /// Read the attributes under the conditions that hold wherever `at`
1946+ /// does, a later condition over an earlier one.
1947+ fn of(attrs: &[Attribute], at: &Condition) -> Sizes {
1948+ let mut sizes = Sizes::default();
1949+ let mut read: Vec<(Condition, &str, &str)> = Vec::new();
1950+ for attr in attrs.iter().filter(|a| !a.html) {
1951+ let (condition, name) = Condition::of(&attr.key);
1952+ let Some(value) = attr.value.as_deref().filter(|v| !v.trim().is_empty()) else {
1953+ continue;
1954+ };
1955+ if condition.holds_at(at) {
1956+ read.push((condition, name, value));
1957+ }
1958+ }
1959+ read.sort_by_cached_key(|(condition, _, _)| condition.order());
1960+ for (_, name, value) in read {
1961+ match name {
1962+ "width" => {
1963+ let size = Size::of(value);
1964+ sizes.width = Some(size);
1965+ sizes.width_word |= size != Size::Set;
1966+ }
1967+ "height" => {
1968+ let size = Size::of(value);
1969+ sizes.height = Some(size);
1970+ sizes.height_word |= size != Size::Set;
1971+ }
1972+ "flex" => sizes.flex = true,
1973+ "flex-grow" => sizes.flex_grow = true,
1974+ "flex-shrink" => sizes.flex_shrink = true,
1975+ "flex-basis" => sizes.flex_basis = true,
1976+ "min-width" => sizes.min_width = true,
1977+ "min-height" => sizes.min_height = true,
1978+ _ => {}
1979+ }
1980+ }
1981+ sizes
1982+ }
1983+
1984+ /// The element writes `property` itself: a layout word leaves it alone.
1985+ fn writes(&self, property: &str) -> bool {
1986+ match property {
1987+ "flex" => self.flex,
1988+ "flex-grow" => self.flex || self.flex_grow,
1989+ "flex-shrink" => self.flex || self.flex_shrink,
1990+ "flex-basis" => self.flex || self.flex_basis,
1991+ "min-width" => self.min_width,
1992+ "min-height" => self.min_height,
1993+ "width" => self.width == Some(Size::Set),
1994+ "height" => self.height == Some(Size::Set),
1995+ _ => false,
1996+ }
1997+ }
1998+
1999+ /// Write a layout word's `property: value`, unless the element writes
2000+ /// the property itself. When it writes some of `flex`'s longhands, a
2001+ /// `flex` is written as the others (`flex-shrink 0, width fill` still
2002+ /// grows).
2003+ fn push(&self, css: &mut String, property: &str, value: &str) {
2004+ if property == "flex" && !self.flex {
2005+ let longhands = match value {
2006+ "1" => [
2007+ ("flex-grow", "1"),
2008+ ("flex-shrink", "1"),
2009+ ("flex-basis", "0%"),
2010+ ],
2011+ // The reset, `0 1 auto`
2012+ _ => [
2013+ ("flex-grow", "0"),
2014+ ("flex-shrink", "1"),
2015+ ("flex-basis", "auto"),
2016+ ],
2017+ };
2018+ if longhands.iter().any(|&(p, _)| self.writes(p)) {
2019+ for (longhand, value) in longhands {
2020+ if !self.writes(longhand) {
2021+ push_css(css, longhand, value);
2022+ }
2023+ }
2024+ return;
2025+ }
2026+ }
2027+ if !self.writes(property) {
2028+ push_css(css, property, value);
2029+ }
2030+ }
2031+}
2032+
2033+/// The rule that gives an element's `fill` and `shrink`, as its attributes
2034+/// under the at-rules `at` set them, their meaning in a parent laid out
2035+/// along `axis`. Every other property a layout word could have set is put
2036+/// back to its initial value, so the rule is right whichever earlier rule
2037+/// it overrides. Properties the element writes itself are left alone.
2038+fn sizing_rule(attrs: &[Attribute], at: &[usize], axis: Axis) -> String {
2039+ let sizes = Sizes::of(attrs, &Condition::at_only(at));
2040+ let mut sets: Vec<(&str, &str)> = Vec::new();
2041+ let mut resets: Vec<(&str, &str)> = Vec::new();
2042+ for (dim, size, word) in [
2043+ (Dim::Width, sizes.width, sizes.width_word),
2044+ (Dim::Height, sizes.height, sizes.height_word),
2045+ ] {
2046+ if !word {
2047+ continue;
2048+ }
2049+ if let Some(size) = size {
2050+ sets.extend_from_slice(sizing(dim, size, Some(axis)));
2051+ }
2052+ resets.extend_from_slice(&sizing_properties(dim));
2053+ }
2054+ let mut css = String::new();
2055+ let mut written: Vec<&str> = Vec::new();
2056+ for &(property, value) in &resets {
2057+ if sets.iter().any(|&(p, _)| p == property) || written.contains(&property) {
2058+ continue;
2059+ }
2060+ written.push(property);
2061+ sizes.push(&mut css, property, value);
2062+ }
2063+ for &(property, value) in &sets {
2064+ sizes.push(&mut css, property, value);
2065+ }
2066+ css
2067+}
2068+
2069+/// The rules an element's `fill` and `shrink` need under each chain of
2070+/// at-rules where the direction of `flow` (its parent's) changes: `(at,
2071+/// body)`.
2072+fn sizing_changes(attrs: &[Attribute], flow: &Flow) -> Vec<(Vec<usize>, String)> {
2073+ flow.changes
2074+ .iter()
2075+ .map(|(at, axis)| (at.clone(), sizing_rule(attrs, at, *axis)))
2076+ .filter(|(_, body)| !body.is_empty())
2077+ .collect()
2078+}
2079+
2080+/// An element's generated class, with the rules keyed on its parent's
2081+/// class that its `fill` and `shrink` need where the parent's direction
2082+/// changes under a prefix (see [`Flow`]): `:where(.a)>.b`, one class of
2083+/// specificity like any class rule.
2084+fn element_class(elem: &Element, site: &Site, styles: &mut StyleCollector) -> Option<String> {
2085+ let as_child = match site.parent.class {
2086+ Some(_) => sizing_changes(&elem.attrs, site.parent),
2087+ None => Vec::new(),
2088+ };
2089+ // Two elements with the same CSS but different rules keyed on them
2090+ // need two classes
2091+ let mut distinct = String::new();
2092+ for (at, body) in &as_child {
2093+ distinct.push_str(&format!("<{:?}{}", at, body));
2094+ }
2095+ let class = compute_class(&elem.attrs, site, styles, distinct)?;
2096+ if let Some(parent) = &site.parent.class {
2097+ for (at, body) in as_child {
2098+ styles.add_keyed(at, format!(":where(.{})>.{}", parent, class), body);
2099+ }
2100+ }
2101+ Some(class)
2102+}
2103+
2104+/// The `display` of a layout (nothing for text, native and void elements,
2105+/// which keep HTML's own).
2106+fn layout_css(layout: Layout, inline: bool) -> &'static str {
2107+ match (layout, inline) {
2108+ (Layout::Column, false) => "display:flex;flex-direction:column;",
2109+ (Layout::Column, true) => "display:inline-flex;flex-direction:column;",
2110+ (Layout::Row, false) => "display:flex;flex-direction:row;",
2111+ (Layout::Row, true) => "display:inline-flex;flex-direction:row;",
2112+ (Layout::Grid, false) => "display:grid;",
2113+ (Layout::Grid, true) => "display:inline-grid;",
2114+ _ => "",
2115+ }
2116+}
2117+
2118+/// The declarations of the attributes under `condition` (the defaults of
2119+/// the element's kind are [`default_css`]'s).
2120+fn attrs_to_css(attrs: &[Attribute], condition: &Condition, site: &Site) -> String {
2121+ let mut css = String::new();
2122+ // The auto margins of `center-x`, `align-left`, ..., written at the end
2123+ let mut aligned = String::new();
2124+ let kind = site.kind;
2125+ // Under `children:` the styles go on the children, whose parent is this
2126+ // element: htmlang's words that place an element in its parent are an
2127+ // error there (the parser reports them), and left out
2128+ let on_children = condition.on_children();
2129+ let inside = condition.inside().is_some();
2130+ // The direction `fill` and `shrink` compile against
2131+ let axis = site.parent.at(&condition.at);
2132+
2133+ // htmlang's words for laying out children (`spacing`, `wrap`,
2134+ // `grid-cols`) mean nothing on an element that doesn't lay out its
2135+ // children, which the parser reports; they are left out. Under
2136+ // `children:` they go on the children, whose layout isn't known here.
2137+ let lays_out_children = kind.layout().is_container() || on_children;
2138+ fn under<'k>(key: &'k str, condition: &Condition) -> Option<&'k str> {
2139+ let (c, name) = Condition::of(key);
2140+ (c == *condition).then_some(name)
2141+ }
2142+
2143+ for (index, attr) in attrs.iter().enumerate() {
2144+ if attr.html {
2145+ continue;
2146+ }
2147+ let Some(effective_key) = under(&attr.key, condition) else {
2148+ continue;
2149+ };
2150+ if on_children && crate::vocab::places_in_parent(effective_key, attr.value.as_deref()) {
2151+ continue;
2152+ }
2153+ // Under an element prefix (`@td:`) the styles go on elements whose
2154+ // layout and parent aren't known here: htmlang's own words are an
2155+ // error there (the parser reports them), and left out
2156+ if inside && crate::vocab::is_htmlang_word(effective_key, attr.value.as_deref()) {
2157+ continue;
2158+ }
2159+
2160+ let val = attr.value.as_deref();
2161+ // A style whose value came out empty (a field a record doesn't
2162+ // have, `${if()}` without its other branch) is left out
2163+ if val.is_some_and(|v| v.trim().is_empty()) {
2164+ continue;
2165+ }
2166+
2167+ match effective_key {
2168+ // htmlang's own words: they lay out children or place the
2169+ // element in its parent, and mean more than one CSS property
2170+ "spacing" if !lays_out_children => {}
2171+ "spacing" => {
2172+ if let Some(v) = val {
2173+ push_css(&mut css, "gap", &with_px("gap", v));
2174+ }
2175+ }
2176+
2177+ // Sizing: `fill` and `shrink` compile against the parent's
2178+ // direction. Only the last `width` (`height`) counts, as for
2179+ // any style written twice.
2180+ "width" | "height" if val.is_some_and(|v| Size::of(v) != Size::Set) => {
2181+ let later = attrs[index + 1..].iter().any(|a| {
2182+ !a.html
2183+ && under(&a.key, condition) == Some(effective_key)
2184+ && a.value.as_deref().is_some_and(|v| !v.trim().is_empty())
2185+ });
2186+ if later {
2187+ continue;
2188+ }
2189+ let dim = if effective_key == "width" {
2190+ Dim::Width
2191+ } else {
2192+ Dim::Height
2193+ };
2194+ let size = Size::of(val.unwrap_or_default());
2195+ // What the element writes itself, which a layout word
2196+ // leaves alone
2197+ let sizes = Sizes::of(attrs, condition);
2198+ for &(property, value) in sizing(dim, size, axis) {
2199+ sizes.push(&mut css, property, value);
2200+ }
2201+ }
2202+
2203+ // A size of its own under a prefix, where a `fill` or
2204+ // `shrink` that sets `flex` (along a flex parent's direction)
2205+ // holds too: the word's `flex` and minimum are put back, so the
2206+ // size is the one the element gets (`width fill, lg:width 200`
2207+ // in a row)
2208+ "width" | "height"
2209+ if *condition != Condition::default()
2210+ && attrs.iter().any(|a| {
2211+ let (c, name) = Condition::of(&a.key);
2212+ let along = match site.parent.at(&c.at) {
2213+ Some(Axis::Row) => name == "width",
2214+ Some(Axis::Column) => name == "height",
2215+ None => false,
2216+ };
2217+ !a.html
2218+ && name == effective_key
2219+ && along
2220+ && c != *condition
2221+ && c.holds_at(condition)
2222+ && a.value
2223+ .as_deref()
2224+ .is_some_and(|v| !v.trim().is_empty() && Size::of(v) != Size::Set)
2225+ }) =>
2226+ {
2227+ let dim = if effective_key == "width" {
2228+ Dim::Width
2229+ } else {
2230+ Dim::Height
2231+ };
2232+ let sizes = Sizes::of(attrs, condition);
2233+ for (property, value) in sizing_properties(dim) {
2234+ if property != effective_key {
2235+ sizes.push(&mut css, property, value);
2236+ }
2237+ }
2238+ if let Some(v) = val {
2239+ push_css(&mut css, effective_key, &with_px(effective_key, v));
2240+ }
2241+ }
2242+
2243+ // Alignment: auto margins, which work along either direction.
2244+ // They are written last, so a `margin` on the same element
2245+ // keeps its other sides (`center-x, margin 20`)
2246+ "center-x" => {
2247+ push_css(&mut aligned, "margin-left", "auto");
2248+ push_css(&mut aligned, "margin-right", "auto");
2249+ }
2250+ "center-y" => {
2251+ push_css(&mut aligned, "margin-top", "auto");
2252+ push_css(&mut aligned, "margin-bottom", "auto");
2253+ }
2254+ "align-left" => push_css(&mut aligned, "margin-right", "auto"),
2255+ "align-right" => push_css(&mut aligned, "margin-left", "auto"),
2256+ "align-top" => push_css(&mut aligned, "margin-bottom", "auto"),
2257+ "align-bottom" => push_css(&mut aligned, "margin-top", "auto"),
2258+
2259+ "wrap" if lays_out_children => push_css(&mut css, "flex-wrap", "wrap"),
2260+ "wrap" => {}
2261+
2262+ // Grid
2263+ "grid-cols" | "grid-rows" if !lays_out_children => {}
2264+ "grid-cols" | "grid-rows" => {
2265+ if let Some(v) = val {
2266+ let property = if effective_key == "grid-cols" {
2267+ "grid-template-columns"
2268+ } else {
2269+ "grid-template-rows"
2270+ };
2271+ match v.parse::<u32>() {
2272+ Ok(n) => push_css(&mut css, property, &format!("repeat({},1fr)", n)),
2273+ Err(_) => push_css(&mut css, property, &with_px(property, v)),
2274+ }
2275+ }
2276+ }
2277+ "col-span" | "row-span" => {
2278+ if let Some(v) = val {
2279+ let property = if effective_key == "col-span" {
2280+ "grid-column"
2281+ } else {
2282+ "grid-row"
2283+ };
2284+ push_css(&mut css, property, &format!("span {}", v));
2285+ }
2286+ }
2287+
2288+ // CSS's `line-clamp` has no support yet without its
2289+ // `-webkit-` fallback, which needs a box to clamp
2290+ "line-clamp" => {
2291+ if let Some(v) = val {
2292+ push_css(&mut css, "display", "-webkit-box");
2293+ push_css(&mut css, "-webkit-line-clamp", v);
2294+ push_css(&mut css, "-webkit-box-orient", "vertical");
2295+ push_css(&mut css, "overflow", "hidden");
2296+ }
2297+ }
2298+
2299+ // Every other name is a CSS property (standard, custom,
2300+ // vendor-prefixed, or one htmlang doesn't know, which the
2301+ // parser warned about), written under its own name with the
2302+ // value as written, except for `px` after a bare number where
2303+ // the property takes a length
2304+ key if crate::vocab::is_property_name(key) => {
2305+ if let Some(v) = val {
2306+ push_css(&mut css, key, &with_px(key, v));
2307+ }
2308+ }
2309+
2310+ _ => {}
2311+ }
2312+ }
2313+
2314+ css.push_str(&aligned);
2315+ css
2316+}
2317+
2318+fn push_css(css: &mut String, prop: &str, value: &str) {
2319+ css.push_str(prop);
2320+ css.push(':');
2321+ css.push_str(value);
2322+ css.push(';');
2323+}
2324+
2325+fn extract_id_class(attrs: &[Attribute]) -> (Option<String>, Option<String>) {
2326+ let mut id = None;
2327+ let mut class = None;
2328+ for attr in attrs.iter().filter(|a| a.html) {
2329+ match attr.key.as_str() {
2330+ "id" => id = attr.value.clone(),
2331+ "class" => class = attr.value.clone(),
2332+ _ => {}
2333+ }
2334+ }
2335+ (id, class)
2336+}
2337+
2338+fn html_escape(s: &str) -> String {
2339+ s.replace('&', "&amp;")
2340+ .replace('<', "&lt;")
2341+ .replace('>', "&gt;")
2342+ .replace('"', "&quot;")
2343+}
2344+
2345+fn base64_encode(data: &[u8]) -> String {
2346+ const CHARS: &[u8] = b"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
2347+ let mut result = String::new();
2348+ for chunk in data.chunks(3) {
2349+ let b0 = chunk[0] as u32;
2350+ let b1 = if chunk.len() > 1 { chunk[1] as u32 } else { 0 };
2351+ let b2 = if chunk.len() > 2 { chunk[2] as u32 } else { 0 };
2352+ let triple = (b0 << 16) | (b1 << 8) | b2;
2353+ result.push(CHARS[((triple >> 18) & 0x3F) as usize] as char);
2354+ result.push(CHARS[((triple >> 12) & 0x3F) as usize] as char);
2355+ if chunk.len() > 1 {
2356+ result.push(CHARS[((triple >> 6) & 0x3F) as usize] as char);
2357+ } else {
2358+ result.push('=');
2359+ }
2360+ if chunk.len() > 2 {
2361+ result.push(CHARS[(triple & 0x3F) as usize] as char);
2362+ } else {
2363+ result.push('=');
2364+ }
2365+ }
2366+ result
2367+}
2368+
2369+// ---------------------------------------------------------------------------
2370+// Source map generation (standard v3 format with VLQ-encoded mappings)
2371+// ---------------------------------------------------------------------------
2372+
2373+/// Generate a standard v3 source map with VLQ-encoded mappings.
2374+/// Compatible with browser devtools and source map tooling.
2375+pub fn generate_source_map(doc: &Document, source_file: &str) -> String {
2376+ source_map_for_html(&generate_dev(doc), source_file)
2377+}
2378+
2379+/// Build a source map for dev-mode HTML by reading the `data-hl-line`
2380+/// markers each element carries, so generated line numbers are exact.
2381+pub fn source_map_for_html(html: &str, source_file: &str) -> String {
2382+ let mut mappings: Vec<(usize, usize)> = Vec::new(); // (html_line, hl_line)
2383+ for (idx, line) in html.lines().enumerate() {
2384+ if let Some(pos) = line.find("data-hl-line=\"") {
2385+ let digits: String = line[pos + "data-hl-line=\"".len()..]
2386+ .chars()
2387+ .take_while(|c| c.is_ascii_digit())
2388+ .collect();
2389+ if let Ok(hl_line) = digits.parse::<usize>() {
2390+ mappings.push((idx + 1, hl_line));
2391+ }
2392+ }
2393+ }
2394+
2395+ // Build VLQ-encoded mappings string.
2396+ // Each generated line is separated by ';'. Each segment within a line is
2397+ // separated by ','. A segment has 4 fields: generated column, source index,
2398+ // source line, source column — all VLQ-encoded as deltas.
2399+ let max_gen_line = mappings.last().map(|m| m.0).unwrap_or(0);
2400+ let mut vlq = String::new();
2401+ let mut prev_source_line: i64 = 0;
2402+ let mut mapping_idx = 0;
2403+
2404+ for gen_line in 1..=max_gen_line {
2405+ if gen_line > 1 {
2406+ vlq.push(';');
2407+ }
2408+ if mapping_idx < mappings.len() && mappings[mapping_idx].0 == gen_line {
2409+ let source_line = mappings[mapping_idx].1 as i64 - 1; // 0-based
2410+ // Segment: gen_col=0, source_idx=0, source_line=delta, source_col=0
2411+ vlq_encode(0, &mut vlq); // generated column (always 0)
2412+ vlq_encode(0, &mut vlq); // source file index (always 0)
2413+ vlq_encode(source_line - prev_source_line, &mut vlq); // source line delta
2414+ vlq_encode(0, &mut vlq); // source column (always 0)
2415+ prev_source_line = source_line;
2416+ mapping_idx += 1;
2417+ }
2418+ }
2419+
2420+ let escaped_file = source_file
2421+ .replace(".hl", ".html")
2422+ .replace('\\', "\\\\")
2423+ .replace('"', "\\\"");
2424+ let escaped_source = source_file.replace('\\', "\\\\").replace('"', "\\\"");
2425+
2426+ format!(
2427+ "{{\"version\":3,\"file\":\"{}\",\"sourceRoot\":\"\",\"sources\":[\"{}\"],\"names\":[],\"mappings\":\"{}\"}}",
2428+ escaped_file, escaped_source, vlq
2429+ )
2430+}
2431+
2432+/// Encode a single signed integer as a VLQ base64 string, appending to `out`.
2433+fn vlq_encode(value: i64, out: &mut String) {
2434+ const B64: &[u8] = b"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
2435+ let mut v = if value < 0 {
2436+ ((-value) << 1) | 1
2437+ } else {
2438+ value << 1
2439+ } as u64;
2440+ loop {
2441+ let mut digit = (v & 0x1F) as u8; // 5-bit chunk
2442+ v >>= 5;
2443+ if v > 0 {
2444+ digit |= 0x20; // continuation bit
2445+ }
2446+ out.push(B64[digit as usize] as char);
2447+ if v == 0 {
2448+ break;
2449+ }
2450+ }
2451+}
2452+
2453+#[cfg(test)]
2454+mod tests {
2455+ use super::*;
2456+
2457+ #[test]
2458+ fn a_name_is_a_stable_hash_of_the_style() {
2459+ // The same in every build and on every platform
2460+ assert_eq!(stable_hash(""), 0xf52a_15e9_a9b5_e89b);
2461+ assert_eq!(hash_digits(35, 3), "z00");
2462+ assert_eq!(hash_digits(u64::MAX, 13), "fsgs46211e5w3");
2463+ }
2464+
2465+ #[test]
2466+ fn a_name_taken_in_the_file_takes_more_digits() {
2467+ // These two styles' hashes end in the same 7 digits
2468+ let mut styles = StyleCollector::new();
2469+ let first = styles.get_class("width:129555px;".into(), Vec::new(), String::new());
2470+ let second = styles.get_class("width:170577px;".into(), Vec::new(), String::new());
2471+ let (first, second) = (first.unwrap(), second.unwrap());
2472+ assert_eq!(first.len(), 3 + CLASS_DIGITS, "{first}");
2473+ assert_eq!(second.len(), 3 + CLASS_DIGITS + 1, "{second}");
2474+ assert!(second.starts_with(&first), "{first} {second}");
2475+ // The same style gets the name it got before
2476+ let again = styles.get_class("width:170577px;".into(), Vec::new(), String::new());
2477+ assert_eq!(again.as_deref(), Some(second.as_str()));
2478+ }
2479+}
crates/htmlang-core/src/codegen_tests.rsnew file+121
@@ -0,0 +1,121 @@
1+#[cfg(test)]
2+mod tests {
3+ use crate::codegen::{
4+ CodegenOptions, generate, generate_dev, generate_partial, generate_with_classes,
5+ };
6+ use crate::parser::parse;
7+
8+ fn compile(src: &str) -> String {
9+ let r = parse(src);
10+ assert!(
11+ r.diagnostics
12+ .iter()
13+ .all(|d| d.severity != crate::parser::Severity::Error),
14+ "unexpected parser error for src {src:?}: {:?}",
15+ r.diagnostics
16+ );
17+ generate(&r.document)
18+ }
19+
20+ #[test]
21+ fn non_empty_document_emits_doctype() {
22+ let out = compile("@page Hello\n@text hello\n");
23+ assert!(
24+ out.to_lowercase().contains("<!doctype html>"),
25+ "missing doctype: {out}"
26+ );
27+ }
28+
29+ #[test]
30+ fn text_content_is_html_escaped() {
31+ let out = compile("@text <script>alert(1)</script>\n");
32+ assert!(
33+ !out.contains("<script>alert(1)</script>"),
34+ "raw script should be escaped: {out}"
35+ );
36+ assert!(
37+ out.contains("&lt;script&gt;"),
38+ "escaped entities missing: {out}"
39+ );
40+ }
41+
42+ #[test]
43+ fn partial_output_omits_doctype_and_html_wrapper() {
44+ let r = parse("@text hi\n");
45+ let out = generate_partial(&r.document);
46+ assert!(!out.to_lowercase().contains("<!doctype html>"));
47+ assert!(!out.to_lowercase().contains("<html"));
48+ }
49+
50+ #[test]
51+ fn dev_mode_is_deterministic_across_runs() {
52+ let src =
53+ "@row [spacing 10]\n @text [font-weight bold] a\n @text [font-style italic] b\n";
54+ let r1 = parse(src);
55+ let r2 = parse(src);
56+ assert_eq!(generate_dev(&r1.document), generate_dev(&r2.document));
57+ }
58+
59+ /// The classes of `src`, compiled as a fragment
60+ fn classes(src: &str) -> Vec<crate::codegen::Class> {
61+ let options = CodegenOptions {
62+ partial: true,
63+ ..Default::default()
64+ };
65+ generate_with_classes(&parse(src).document, &options).1
66+ }
67+
68+ #[test]
69+ fn a_style_has_one_name_in_every_file() {
70+ // A fragment's classes mean in a page what they mean in the
71+ // fragment, whatever else either holds
72+ let page = classes("@el [padding 10, background red] a\n@el [gap 4] b\n");
73+ let fragment = classes("@row [margin 2] x\n@el [padding 10, background red] y\n");
74+ assert_eq!(page[0], fragment[1]);
75+ assert_ne!(page[1].style, fragment[0].style);
76+ assert_ne!(page[1].name, fragment[0].name);
77+ for class in page.iter().chain(&fragment) {
78+ let digits = class.name.strip_prefix("hl-").expect("hl-");
79+ assert_eq!(digits.len(), crate::codegen::CLASS_DIGITS, "{}", class.name);
80+ assert!(
81+ digits
82+ .bytes()
83+ .all(|b| b.is_ascii_digit() || b.is_ascii_lowercase()),
84+ "{}",
85+ class.name
86+ );
87+ }
88+ }
89+
90+ #[test]
91+ fn page_title_appears_in_head() {
92+ let out = compile("@page Welcome\n");
93+ assert!(
94+ out.contains("<title>Welcome</title>"),
95+ "title missing in:\n{out}"
96+ );
97+ }
98+
99+ #[test]
100+ fn same_styles_share_one_class() {
101+ // Both elements request padding:10 + background red. The collector must
102+ // dedupe them into a single generated class rather than emitting two.
103+ let src =
104+ "@row\n @el [padding 10, background red] a\n @el [padding 10, background red] b\n";
105+ let out = compile(src);
106+ // Count occurrences of a `.X{` CSS class declaration that contains both
107+ // padding and the red color. With dedup, the rule body should appear at
108+ // most once in the <style> block.
109+ let mut count = 0;
110+ let needle = "padding:10px;background:red";
111+ let mut rest = out.as_str();
112+ while let Some(pos) = rest.find(needle) {
113+ count += 1;
114+ rest = &rest[pos + needle.len()..];
115+ }
116+ assert!(
117+ count <= 1,
118+ "duplicate CSS rule emitted ({count} times) in:\n{out}"
119+ );
120+ }
121+}
crates/htmlang-core/src/diagnostic.rsnew file+245
@@ -0,0 +1,245 @@
1+//! Diagnostics: what the compiler reports about a source file.
2+//!
3+//! Every diagnostic has a stable `code` (see [`code`]), so tools such as the
4+//! language server key their quick fixes on the code rather than on the
5+//! wording of the message. `subject` and `suggestion` carry the name the
6+//! diagnostic is about and the name to use instead, when there is one.
7+
8+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
9+pub enum Severity {
10+ Error,
11+ Warning,
12+ Info,
13+ Help,
14+}
15+
16+#[derive(Debug, Clone)]
17+pub struct Diagnostic {
18+ /// Stable identifier of the kind of problem, e.g. `unknown-element`.
19+ pub code: &'static str,
20+ pub line: usize,
21+ pub column: Option<usize>,
22+ pub message: String,
23+ pub severity: Severity,
24+ pub source_line: Option<Box<str>>,
25+ /// The name the diagnostic is about, as written (`@nosuch` without the
26+ /// `@`, an attribute key, a definition's name).
27+ pub subject: Option<Box<str>>,
28+ /// The name to write instead of `subject` ("did you mean ...?").
29+ pub suggestion: Option<Box<str>>,
30+}
31+
32+impl Diagnostic {
33+ pub fn new(code: &'static str, severity: Severity, line: usize, message: String) -> Self {
34+ Diagnostic {
35+ code,
36+ line,
37+ column: None,
38+ message,
39+ severity,
40+ source_line: None,
41+ subject: None,
42+ suggestion: None,
43+ }
44+ }
45+
46+ pub fn error(code: &'static str, line: usize, message: String) -> Self {
47+ Self::new(code, Severity::Error, line, message)
48+ }
49+
50+ pub fn warning(code: &'static str, line: usize, message: String) -> Self {
51+ Self::new(code, Severity::Warning, line, message)
52+ }
53+
54+ pub fn column(mut self, column: usize) -> Self {
55+ self.column = Some(column);
56+ self
57+ }
58+
59+ pub fn source(mut self, source: impl Into<String>) -> Self {
60+ self.source_line = Some(source.into().into_boxed_str());
61+ self
62+ }
63+
64+ pub fn subject(mut self, subject: impl Into<String>) -> Self {
65+ self.subject = Some(subject.into().into_boxed_str());
66+ self
67+ }
68+
69+ pub fn suggest(mut self, suggestion: Option<impl Into<String>>) -> Self {
70+ self.suggestion = suggestion.map(|s| s.into().into_boxed_str());
71+ self
72+ }
73+}
74+
75+/// The diagnostic codes. A code names a kind of problem and never changes,
76+/// even when a message is reworded.
77+pub mod code {
78+ // Syntax: found while reading the file, before anything runs
79+ pub const UNCLOSED_BRACKET: &str = "unclosed-bracket";
80+ /// A `]` that ends an attribute list inside what reads as a `'...'`
81+ /// string in a value (`hx-on:click=alert(']')`).
82+ pub const UNBALANCED_QUOTE: &str = "unbalanced-quote";
83+ pub const UNEXPECTED_BODY: &str = "unexpected-body";
84+ pub const UNEXPECTED_ARGUMENT: &str = "unexpected-argument";
85+ pub const MISSING_ARGUMENT: &str = "missing-argument";
86+ pub const INVALID_LOOP: &str = "invalid-loop";
87+ /// A `@let` whose name, parameters or body don't fit its kind.
88+ pub const INVALID_DEFINITION: &str = "invalid-definition";
89+ pub const STRAY_ELSE: &str = "stray-else";
90+ /// Indentation with tabs and spaces mixed, which nests lines in ways
91+ /// the eye doesn't see.
92+ pub const MIXED_INDENTATION: &str = "mixed-indentation";
93+
94+ // Names
95+ pub const UNKNOWN_ELEMENT: &str = "unknown-element";
96+ /// An attribute name htmlang doesn't know: a warning when CSS could
97+ /// have the name (it is written to the CSS as it is), an error otherwise.
98+ pub const UNKNOWN_ATTRIBUTE: &str = "unknown-attribute";
99+ /// A misspelled prefix (`hovr:color red`).
100+ pub const UNKNOWN_PREFIX: &str = "unknown-prefix";
101+ /// A prefix the attribute can't take: a second one (`md:hover:`), or
102+ /// one on an HTML attribute (`hover:required`).
103+ pub const INVALID_PREFIX: &str = "invalid-prefix";
104+ /// A style written without its value (`[padding]`).
105+ pub const MISSING_VALUE: &str = "missing-value";
106+ pub const HTML_ATTRIBUTE_FORM: &str = "html-attribute-form";
107+ /// A second `@page`: a page has one root, so one `@page`.
108+ pub const DUPLICATE_PAGE: &str = "duplicate-page";
109+ pub const UNDEFINED_VARIABLE: &str = "undefined-variable";
110+ /// An attribute, or an attribute's name, made from a variable.
111+ pub const ATTRIBUTE_FROM_VARIABLE: &str = "attribute-from-variable";
112+ pub const DUPLICATE_ATTRIBUTE: &str = "duplicate-attribute";
113+
114+ // Values
115+ /// A value that can't be written into the page's CSS (an error), or
116+ /// one that can't mean what it says (a warning).
117+ pub const INVALID_VALUE: &str = "invalid-value";
118+ pub const INVALID_COLOR: &str = "invalid-color";
119+ pub const INVALID_EXPRESSION: &str = "invalid-expression";
120+ pub const INVALID_JSON: &str = "invalid-json";
121+ /// A name htmlang doesn't know right after a `key=value`: the rest of
122+ /// the value, which a comma ended (`hx-trigger=load, every 2s`).
123+ pub const SPLIT_VALUE: &str = "split-value";
124+ /// A leading argument taken as a URL that reads as text (`@link
125+ /// [hx-get=/x] Open panel`, whose href is `Open`).
126+ pub const TEXT_AS_URL: &str = "text-as-url";
127+
128+ // Definitions and functions
129+ pub const UNUSED_VARIABLE: &str = "unused-variable";
130+ pub const UNUSED_BUNDLE: &str = "unused-bundle";
131+ pub const UNUSED_FUNCTION: &str = "unused-function";
132+ pub const RECURSIVE_CALL: &str = "recursive-call";
133+ pub const NO_SINGLE_ROOT: &str = "no-single-root";
134+ /// A call that leaves out a parameter without a default.
135+ pub const MISSING_PARAMETER: &str = "missing-parameter";
136+ /// A parameter passed `name=value`: parameters are written `name value`.
137+ pub const PARAMETER_FORM: &str = "parameter-form";
138+ /// A function named like a built-in element (which it replaces) or a
139+ /// directive (which it can't replace).
140+ pub const SHADOWS_BUILT_IN: &str = "shadows-built-in";
141+ /// A `@slot NAME` block at a call whose function has no such slot.
142+ pub const UNKNOWN_SLOT: &str = "unknown-slot";
143+ /// Content passed to a function whose body has no `@children`.
144+ pub const UNEXPECTED_CONTENT: &str = "unexpected-content";
145+ /// A `@slot` or `@children` where it marks or fills nothing: outside
146+ /// a function's body, inside an element at a call, or inline in text.
147+ pub const MISPLACED_SLOT: &str = "misplaced-slot";
148+ /// A slot name that isn't one name (`@slot my footer`).
149+ pub const INVALID_SLOT_NAME: &str = "invalid-slot-name";
150+
151+ // Files
152+ pub const UNREADABLE_FILE: &str = "unreadable-file";
153+ pub const CIRCULAR_INCLUDE: &str = "circular-include";
154+ /// Two files of one build whose different styles got one class name:
155+ /// a name is a hash of its style (`htmlang build` checks).
156+ pub const CLASS_COLLISION: &str = "class-collision";
157+ pub const UNSET_ENVIRONMENT: &str = "unset-environment";
158+
159+ // Context: an attribute or element where it has no effect
160+ /// An attribute the element ignores (a warning), or a layout word such
161+ /// as `spacing` on an element that doesn't lay out its children (an
162+ /// error: it is left out).
163+ pub const NO_EFFECT: &str = "no-effect";
164+ /// An element whose HTML ends a `<p>`, written inside a `@paragraph`.
165+ pub const BLOCK_IN_PARAGRAPH: &str = "block-in-paragraph";
166+
167+ // Accessibility
168+ pub const MISSING_ALT: &str = "missing-alt";
169+ pub const MISSING_INPUT_TYPE: &str = "missing-input-type";
170+ pub const MISSING_LINK_TEXT: &str = "missing-link-text";
171+ pub const MISSING_LABEL: &str = "missing-label";
172+ pub const MISSING_TITLE: &str = "missing-title";
173+ pub const MISSING_BUTTON_TEXT: &str = "missing-button-text";
174+ pub const MISSING_CAPTIONS: &str = "missing-captions";
175+ pub const LOW_CONTRAST: &str = "low-contrast";
176+ pub const POSITIVE_TABINDEX: &str = "positive-tabindex";
177+
178+ // `htmlang lint`
179+ pub const DEEP_NESTING: &str = "deep-nesting";
180+ pub const EMPTY_CONTAINER: &str = "empty-container";
181+ pub const MISSING_BUTTON_TYPE: &str = "missing-button-type";
182+
183+ /// A bug in the compiler itself.
184+ pub const INTERNAL: &str = "internal";
185+
186+ /// Every code, for tools and tests.
187+ pub const ALL: &[&str] = &[
188+ UNCLOSED_BRACKET,
189+ UNBALANCED_QUOTE,
190+ UNEXPECTED_BODY,
191+ UNEXPECTED_ARGUMENT,
192+ MISSING_ARGUMENT,
193+ INVALID_LOOP,
194+ INVALID_DEFINITION,
195+ STRAY_ELSE,
196+ MIXED_INDENTATION,
197+ UNKNOWN_ELEMENT,
198+ UNKNOWN_ATTRIBUTE,
199+ UNKNOWN_PREFIX,
200+ INVALID_PREFIX,
201+ MISSING_VALUE,
202+ HTML_ATTRIBUTE_FORM,
203+ DUPLICATE_PAGE,
204+ UNDEFINED_VARIABLE,
205+ ATTRIBUTE_FROM_VARIABLE,
206+ DUPLICATE_ATTRIBUTE,
207+ INVALID_VALUE,
208+ INVALID_COLOR,
209+ INVALID_EXPRESSION,
210+ INVALID_JSON,
211+ SPLIT_VALUE,
212+ TEXT_AS_URL,
213+ UNUSED_VARIABLE,
214+ UNUSED_BUNDLE,
215+ UNUSED_FUNCTION,
216+ RECURSIVE_CALL,
217+ NO_SINGLE_ROOT,
218+ MISSING_PARAMETER,
219+ PARAMETER_FORM,
220+ SHADOWS_BUILT_IN,
221+ UNKNOWN_SLOT,
222+ UNEXPECTED_CONTENT,
223+ MISPLACED_SLOT,
224+ INVALID_SLOT_NAME,
225+ UNREADABLE_FILE,
226+ CIRCULAR_INCLUDE,
227+ CLASS_COLLISION,
228+ UNSET_ENVIRONMENT,
229+ NO_EFFECT,
230+ BLOCK_IN_PARAGRAPH,
231+ MISSING_ALT,
232+ MISSING_INPUT_TYPE,
233+ MISSING_LINK_TEXT,
234+ MISSING_LABEL,
235+ MISSING_TITLE,
236+ MISSING_BUTTON_TEXT,
237+ MISSING_CAPTIONS,
238+ LOW_CONTRAST,
239+ POSITIVE_TABINDEX,
240+ DEEP_NESTING,
241+ EMPTY_CONTAINER,
242+ MISSING_BUTTON_TYPE,
243+ INTERNAL,
244+ ];
245+}
crates/htmlang-core/src/expr.rsnew file+801
@@ -0,0 +1,801 @@
1+//! Expressions: conditions (`@if $count > 2 and not $hidden`), computed
2+//! values (`@let gap = $base * 2`) and `${...}` in text and values
3+//! (`${if($featured, 24, 0)}`).
4+//!
5+//! Expressions are tokenized and evaluated as a whole. Variables are looked
6+//! up while evaluating, never pasted into the text first, so a value that
7+//! happens to contain `==` or spaces can't change how an expression parses.
8+//!
9+//! Only what decides the result is evaluated: `if()` evaluates the branch
10+//! it takes, `and` and `or` stop at the first side that decides. The rest
11+//! is still parsed (and its function names and argument counts checked),
12+//! so `$n != 0 and 10 / $n > 1` is false for `$n` = 0, not an error.
13+//!
14+//! ```text
15+//! expr := or
16+//! or := and ("or" and)*
17+//! and := not ("and" not)*
18+//! not := "not" not | compare
19+//! compare := range (("==" | "!=" | "<" | ">" | "<=" | ">=") range)?
20+//! range := sum (".." sum ("step" sum)?)?
21+//! sum := product (("+" | "-") product)*
22+//! product := unary (("*" | "/" | "%") unary)*
23+//! unary := "-" unary | primary
24+//! primary := NUMBER | "STRING" | $VAR | WORD | true | false
25+//! | NAME "(" expr ("," expr)* ")" | "(" expr ")"
26+//! ```
27+//!
28+//! A bare word (`dark`, `red`, `#3b82f6`, `10px`) is text. Values are
29+//! typed (see `value.rs`, which also defines truthiness and comparison):
30+//! `$name` keeps whatever it holds, a list or a record included, and
31+//! `A..B` (with `step N`) is a list of whole numbers. Functions:
32+//! `if(cond, a, b)` (`b` may be left out: empty), tests (`contains(s, x)`,
33+//! `starts-with(s, x)`, `ends-with(s, x)`), text (`uppercase`, `lowercase`,
34+//! `capitalize`, `trim`, `length`, `reverse`, `truncate(s, n)`,
35+//! `replace(s, old, new)`, `default(s, fallback)`). A colour variant is
36+//! CSS, not a function here: `color-mix(in srgb, var(--brand), black 8%)`
37+//! is an attribute's value, written as it is.
38+//! `length`, `contains` and `reverse` work on the items of a list; the other
39+//! text functions take text, and a list is an error (a text with commas in
40+//! it is written in quotes or with `\,`, so it isn't a list).
41+//!
42+//! A `$name` ends as it does in text (see `interp.rs`), so `$post.title`
43+//! reads a field and `$a..$b` is two names. An undefined name is an error.
44+
45+use std::fmt;
46+
47+use crate::interp::{self, Problem, Reference, Scope};
48+
49+pub use crate::value::Value;
50+
51+/// Why an expression has no value.
52+#[derive(Debug, Clone, PartialEq)]
53+pub enum Error {
54+ /// `$name` has no definition; `offset` is where the `$` is.
55+ Undefined { name: String, offset: usize },
56+ /// Anything else: a syntax error, a type error, division by zero.
57+ Invalid(String),
58+}
59+
60+impl Error {
61+ /// This error as a problem of a text in which the expression starts
62+ /// at `base`.
63+ pub(crate) fn at(self, base: usize) -> Problem {
64+ match self {
65+ Error::Undefined { name, offset } => Problem::Undefined {
66+ name,
67+ offset: base + offset,
68+ },
69+ Error::Invalid(message) => Problem::Invalid {
70+ message,
71+ offset: base,
72+ },
73+ }
74+ }
75+}
76+
77+impl From<String> for Error {
78+ fn from(message: String) -> Self {
79+ Error::Invalid(message)
80+ }
81+}
82+
83+impl fmt::Display for Error {
84+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
85+ match self {
86+ Error::Undefined { name, .. } => write!(f, "undefined variable '${}'", name),
87+ Error::Invalid(message) => f.write_str(message),
88+ }
89+ }
90+}
91+
92+/// Evaluate `src` with the variables of `scope`. An undefined variable is
93+/// an error; a field that a record doesn't have is empty.
94+pub fn eval(src: &str, scope: &dyn Scope) -> Result<Value, Error> {
95+ let mut tokens = Vec::new();
96+ tokenize(src, scope, 0, &mut tokens)?;
97+ let mut parser = Parser {
98+ tokens: &tokens,
99+ pos: 0,
100+ scope,
101+ skip: false,
102+ };
103+ let value = parser.expr()?;
104+ match parser.tokens.get(parser.pos) {
105+ None => Ok(value),
106+ Some((tok, _)) => Err(Error::Invalid(format!(
107+ "unexpected {} in `{}`",
108+ tok,
109+ src.trim()
110+ ))),
111+ }
112+}
113+
114+#[derive(Debug, Clone, PartialEq)]
115+enum Token {
116+ Num(f64),
117+ Str(String),
118+ Var(String),
119+ Word(String),
120+ Op(&'static str),
121+ LParen,
122+ RParen,
123+ Comma,
124+}
125+
126+impl fmt::Display for Token {
127+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
128+ match self {
129+ Token::Num(n) => write!(f, "`{}`", n),
130+ Token::Str(s) => write!(f, "`\"{}\"`", s),
131+ Token::Var(v) => write!(f, "`${}`", v),
132+ Token::Word(w) => write!(f, "`{}`", w),
133+ Token::Op(op) => write!(f, "`{}`", op),
134+ Token::LParen => f.write_str("`(`"),
135+ Token::RParen => f.write_str("`)`"),
136+ Token::Comma => f.write_str("`,`"),
137+ }
138+ }
139+}
140+
141+const OPERATORS: &[&str] = &[
142+ "..", "==", "!=", "<=", ">=", "<", ">", "+", "-", "*", "/", "%",
143+];
144+
145+/// Read `src` into tokens, each with its byte offset (plus `base`).
146+/// Variable names end as in text (see `interp.rs`), and `${...}` is a
147+/// variable (`${name}`) or a parenthesized expression.
148+fn tokenize(
149+ src: &str,
150+ scope: &dyn Scope,
151+ base: usize,
152+ tokens: &mut Vec<(Token, usize)>,
153+) -> Result<(), Error> {
154+ let is_word_char = |c: char| c.is_alphanumeric() || matches!(c, '#' | '.' | '_' | '-' | '%');
155+ let mut i = 0;
156+ while let Some(c) = src[i..].chars().next() {
157+ let at = base + i;
158+ if c.is_whitespace() {
159+ i += c.len_utf8();
160+ } else if c == '(' {
161+ tokens.push((Token::LParen, at));
162+ i += 1;
163+ } else if c == ')' {
164+ tokens.push((Token::RParen, at));
165+ i += 1;
166+ } else if c == ',' {
167+ tokens.push((Token::Comma, at));
168+ i += 1;
169+ } else if c == '"' {
170+ let start = i + 1;
171+ let end = src[start..]
172+ .find('"')
173+ .map(|p| start + p)
174+ .ok_or_else(|| format!("unclosed string in `{}`", src.trim()))?;
175+ tokens.push((Token::Str(src[start..end].to_string()), at));
176+ i = end + 1;
177+ } else if c == '$' {
178+ match interp::reference(&src[i + 1..], scope) {
179+ Some((Reference::Var(path), len)) => {
180+ tokens.push((Token::Var(path), at));
181+ i += 1 + len;
182+ }
183+ Some((Reference::Expr(inner), len)) => {
184+ tokens.push((Token::LParen, at));
185+ tokenize(inner, scope, at + 2, tokens)?;
186+ tokens.push((Token::RParen, at + len));
187+ i += 1 + len;
188+ }
189+ None => {
190+ let n = interp::custom_property_len(&src[i + 1..]);
191+ return Err(Error::Invalid(match n {
192+ 0 => format!("`$` without a variable name in `{}`", src.trim()),
193+ n => interp::custom_property_message(&src[i + 1..i + 1 + n]),
194+ }));
195+ }
196+ }
197+ } else if let Some(op) = OPERATORS
198+ .iter()
199+ .find(|op| src[i..].starts_with(**op))
200+ // A `-` followed by a letter starts a word (`-webkit-box`);
201+ // inside words (`ease-in`) it is consumed by the word itself.
202+ .filter(|op| **op != "-" || !src[i + 1..].starts_with(char::is_alphabetic))
203+ {
204+ tokens.push((Token::Op(op), at));
205+ i += op.len();
206+ } else if is_word_char(c) {
207+ let start = i;
208+ // A word ends at `..`, so `1..5` is a range
209+ while let Some(c) = src[i..]
210+ .chars()
211+ .next()
212+ .filter(|&c| is_word_char(c) && !src[i..].starts_with(".."))
213+ {
214+ i += c.len_utf8();
215+ }
216+ let word = &src[start..i];
217+ tokens.push((
218+ match word.parse::<f64>() {
219+ Ok(n) if !word.ends_with('.') => Token::Num(n),
220+ _ => Token::Word(word.to_string()),
221+ },
222+ at,
223+ ));
224+ } else {
225+ return Err(Error::Invalid(format!(
226+ "unexpected `{}` in `{}`",
227+ c,
228+ src.trim()
229+ )));
230+ }
231+ }
232+ Ok(())
233+}
234+
235+struct Parser<'a> {
236+ tokens: &'a [(Token, usize)],
237+ pos: usize,
238+ scope: &'a dyn Scope,
239+ /// Parsing a part whose value isn't needed (the branch `if()` doesn't
240+ /// take, the side of `and`/`or` that doesn't decide): it is read and
241+ /// checked for syntax, not evaluated.
242+ skip: bool,
243+}
244+
245+/// The value a skipped part stands for; nothing reads it.
246+const SKIPPED: Value = Value::Bool(false);
247+
248+impl Parser<'_> {
249+ fn peek(&self) -> Option<&Token> {
250+ self.tokens.get(self.pos).map(|(token, _)| token)
251+ }
252+
253+ fn eat_word(&mut self, word: &str) -> bool {
254+ if matches!(self.peek(), Some(Token::Word(w)) if w == word) {
255+ self.pos += 1;
256+ true
257+ } else {
258+ false
259+ }
260+ }
261+
262+ fn eat_op(&mut self, ops: &[&'static str]) -> Option<&'static str> {
263+ match self.peek() {
264+ Some(Token::Op(op)) if ops.contains(op) => {
265+ let op = *op;
266+ self.pos += 1;
267+ Some(op)
268+ }
269+ _ => None,
270+ }
271+ }
272+
273+ fn expect(&mut self, token: Token) -> Result<(), Error> {
274+ match self.peek() {
275+ Some(t) if *t == token => {
276+ self.pos += 1;
277+ Ok(())
278+ }
279+ Some(t) => Err(format!("expected {} but found {}", token, t).into()),
280+ None => Err(format!("expected {} at the end", token).into()),
281+ }
282+ }
283+
284+ /// Parse with `f`, skipping evaluation when `skip` (or when already
285+ /// skipping).
286+ fn skipping(
287+ &mut self,
288+ skip: bool,
289+ f: impl FnOnce(&mut Self) -> Result<Value, Error>,
290+ ) -> Result<Value, Error> {
291+ let outer = self.skip;
292+ self.skip |= skip;
293+ let value = f(self);
294+ self.skip = outer;
295+ value
296+ }
297+
298+ fn expr(&mut self) -> Result<Value, Error> {
299+ let mut left = self.and()?;
300+ while self.eat_word("or") {
301+ let decided = left.truthy();
302+ let right = self.skipping(decided, Self::and)?;
303+ left = Value::Bool(decided || right.truthy());
304+ }
305+ Ok(left)
306+ }
307+
308+ fn and(&mut self) -> Result<Value, Error> {
309+ let mut left = self.not()?;
310+ while self.eat_word("and") {
311+ let decided = !left.truthy();
312+ let right = self.skipping(decided, Self::not)?;
313+ left = Value::Bool(!decided && right.truthy());
314+ }
315+ Ok(left)
316+ }
317+
318+ fn not(&mut self) -> Result<Value, Error> {
319+ if self.eat_word("not") {
320+ return Ok(Value::Bool(!self.not()?.truthy()));
321+ }
322+ self.compare()
323+ }
324+
325+ fn compare(&mut self) -> Result<Value, Error> {
326+ let left = self.range()?;
327+ let Some(op) = self.eat_op(&["==", "!=", "<=", ">=", "<", ">"]) else {
328+ return Ok(left);
329+ };
330+ let right = self.range()?;
331+ if self.skip {
332+ return Ok(SKIPPED);
333+ }
334+ Ok(Value::Bool(left.compare(op, &right)?))
335+ }
336+
337+ /// `A..B` or `A..B step N`: the whole numbers from A to B.
338+ fn range(&mut self) -> Result<Value, Error> {
339+ let start = self.sum()?;
340+ if self.eat_op(&[".."]).is_none() {
341+ return Ok(start);
342+ }
343+ let end = self.sum()?;
344+ let step = match self.eat_word("step") {
345+ true => Some(self.sum()?),
346+ false => None,
347+ };
348+ if self.skip {
349+ return Ok(SKIPPED);
350+ }
351+ let number = |value: &Value| {
352+ value.as_num().ok_or_else(|| {
353+ Error::Invalid(format!(
354+ "a range goes from one number to another, not from {} (`{}`)",
355+ value.describe(),
356+ value
357+ ))
358+ })
359+ };
360+ let step = match &step {
361+ Some(step) => number(step)?,
362+ None => 1.0,
363+ };
364+ Ok(crate::value::range(number(&start)?, number(&end)?, step)?)
365+ }
366+
367+ fn sum(&mut self) -> Result<Value, Error> {
368+ let mut left = self.product()?;
369+ while let Some(op) = self.eat_op(&["+", "-"]) {
370+ let right = self.product()?;
371+ left = self.arithmetic(op, &left, &right)?;
372+ }
373+ Ok(left)
374+ }
375+
376+ fn product(&mut self) -> Result<Value, Error> {
377+ let mut left = self.unary()?;
378+ while let Some(op) = self.eat_op(&["*", "/", "%"]) {
379+ let right = self.unary()?;
380+ left = self.arithmetic(op, &left, &right)?;
381+ }
382+ Ok(left)
383+ }
384+
385+ fn unary(&mut self) -> Result<Value, Error> {
386+ if self.eat_op(&["-"]).is_some() {
387+ let value = self.unary()?;
388+ if self.skip {
389+ return Ok(SKIPPED);
390+ }
391+ return value
392+ .as_num()
393+ .map(|n| Value::Num(-n))
394+ .ok_or_else(|| Error::Invalid(format!("cannot negate `{}`", value)));
395+ }
396+ self.primary()
397+ }
398+
399+ fn primary(&mut self) -> Result<Value, Error> {
400+ let (token, at) = self
401+ .tokens
402+ .get(self.pos)
403+ .cloned()
404+ .ok_or_else(|| "expected a value at the end".to_string())?;
405+ self.pos += 1;
406+ match token {
407+ Token::Num(n) => Ok(Value::Num(n)),
408+ Token::Str(_) | Token::Var(_) if self.skip => Ok(SKIPPED),
409+ Token::Str(s) => {
410+ let (text, problems) = interp::interpolate(&s, self.scope);
411+ match problems.into_iter().next() {
412+ None => Ok(Value::Str(text)),
413+ Some(Problem::Undefined { name, offset }) => Err(Error::Undefined {
414+ name,
415+ offset: at + 1 + offset,
416+ }),
417+ Some(Problem::Invalid { message, .. } | Problem::Record { message, .. }) => {
418+ Err(Error::Invalid(message))
419+ }
420+ Some(Problem::CustomProperty { name, .. }) => {
421+ Err(Error::Invalid(interp::custom_property_message(&name)))
422+ }
423+ }
424+ }
425+ Token::Var(name) => {
426+ interp::resolve(&name, self.scope).ok_or(Error::Undefined { name, offset: at })
427+ }
428+ Token::Word(w) if w == "true" => Ok(Value::Bool(true)),
429+ Token::Word(w) if w == "false" => Ok(Value::Bool(false)),
430+ Token::Word(name) if name == "if" && self.peek() == Some(&Token::LParen) => {
431+ self.pos += 1;
432+ self.choice()
433+ }
434+ Token::Word(name) if self.peek() == Some(&Token::LParen) => {
435+ self.pos += 1;
436+ let mut args = Vec::new();
437+ if self.peek() != Some(&Token::RParen) {
438+ args.push(self.expr()?);
439+ while self.peek() == Some(&Token::Comma) {
440+ self.pos += 1;
441+ args.push(self.expr()?);
442+ }
443+ }
444+ self.expect(Token::RParen)?;
445+ check_call(&name, args.len())?;
446+ if self.skip {
447+ return Ok(SKIPPED);
448+ }
449+ Ok(call(&name, args)?)
450+ }
451+ Token::Word(w) => Ok(Value::Str(w)),
452+ Token::LParen => {
453+ let value = self.expr()?;
454+ self.expect(Token::RParen)?;
455+ Ok(value)
456+ }
457+ other => Err(format!("unexpected {}", other).into()),
458+ }
459+ }
460+}
461+
462+impl Parser<'_> {
463+ /// `if(cond, a, b)` after its `(`: the branch that `cond` picks is
464+ /// evaluated, the other only read. Without `b`, a false `cond` gives
465+ /// an empty value.
466+ fn choice(&mut self) -> Result<Value, Error> {
467+ let arguments =
468+ || Error::Invalid("if() takes 2 or 3 arguments: if(CONDITION, A, B)".into());
469+ let condition = self.expr()?;
470+ match self.peek() {
471+ Some(Token::RParen) | None => return Err(arguments()),
472+ _ => self.expect(Token::Comma)?,
473+ }
474+ let taken = condition.truthy();
475+ let then = self.skipping(!taken, Self::expr)?;
476+ let otherwise = if self.peek() == Some(&Token::Comma) {
477+ self.pos += 1;
478+ self.skipping(taken, Self::expr)?
479+ } else {
480+ Value::Str(String::new())
481+ };
482+ if self.peek() == Some(&Token::Comma) {
483+ return Err(arguments());
484+ }
485+ self.expect(Token::RParen)?;
486+ Ok(if taken { then } else { otherwise })
487+ }
488+
489+ fn arithmetic(&self, op: &str, left: &Value, right: &Value) -> Result<Value, Error> {
490+ if self.skip {
491+ return Ok(SKIPPED);
492+ }
493+ Ok(arithmetic(op, left, right)?)
494+ }
495+}
496+
497+fn arithmetic(op: &str, left: &Value, right: &Value) -> Result<Value, String> {
498+ let (Some(a), Some(b)) = (left.as_num(), right.as_num()) else {
499+ return Err(format!("`{} {} {}` needs numbers", left, op, right));
500+ };
501+ Ok(Value::Num(match op {
502+ "+" => a + b,
503+ "-" => a - b,
504+ "*" => a * b,
505+ "/" if b == 0.0 => return Err("division by zero".to_string()),
506+ "/" => a / b,
507+ "%" if b == 0.0 => return Err("division by zero".to_string()),
508+ "%" => a % b,
509+ _ => unreachable!(),
510+ }))
511+}
512+
513+/// The built-in functions (other than `if`) and how many arguments each
514+/// takes.
515+const FUNCTIONS: &[(&str, usize)] = &[
516+ ("contains", 2),
517+ ("starts-with", 2),
518+ ("ends-with", 2),
519+ ("uppercase", 1),
520+ ("lowercase", 1),
521+ ("capitalize", 1),
522+ ("trim", 1),
523+ ("length", 1),
524+ ("reverse", 1),
525+ ("truncate", 2),
526+ ("replace", 3),
527+ ("default", 2),
528+];
529+
530+/// Check that `name` is a built-in function and gets `count` arguments.
531+fn check_call(name: &str, count: usize) -> Result<(), String> {
532+ let Some(&(_, arity)) = FUNCTIONS.iter().find(|(n, _)| *n == name) else {
533+ return Err(format!("unknown function `{}()`", name));
534+ };
535+ if count == arity {
536+ Ok(())
537+ } else {
538+ Err(format!(
539+ "{}() takes {} argument{}",
540+ name,
541+ arity,
542+ if arity == 1 { "" } else { "s" }
543+ ))
544+ }
545+}
546+
547+/// Call a built-in function with the right number of arguments (see
548+/// [`check_call`]). The text functions take text (a number or `true` and
549+/// `false` count as their text); a list or a record is an error, except
550+/// for `length`, `contains`, `reverse` and `default`, which also work on
551+/// a list's items.
552+fn call(name: &str, args: Vec<Value>) -> Result<Value, String> {
553+ let text = |i: usize| -> Result<String, String> {
554+ match &args[i] {
555+ value @ Value::List(_) => Err(format!(
556+ "{}() takes text, but `{}` is {}: to write one text with commas in \
557+ it, quote it or write `\\,`",
558+ name,
559+ value,
560+ value.describe()
561+ )),
562+ Value::Record(_) => Err(format!(
563+ "{}() takes text, but argument {} is a record: use one of its fields",
564+ name,
565+ i + 1
566+ )),
567+ value => Ok(value.to_string()),
568+ }
569+ };
570+ let num = |i: usize| {
571+ args.get(i)
572+ .and_then(Value::as_num)
573+ .ok_or_else(|| format!("{}() needs a number as argument {}", name, i + 1))
574+ };
575+ Ok(match name {
576+ "contains" => Value::Bool(match &args[0] {
577+ Value::List(list) => list.items.iter().any(|item| item.equals(&args[1])),
578+ _ => text(0)?.contains(&text(1)?),
579+ }),
580+ "starts-with" => Value::Bool(text(0)?.starts_with(&text(1)?)),
581+ "ends-with" => Value::Bool(text(0)?.ends_with(&text(1)?)),
582+ "uppercase" => Value::Str(text(0)?.to_uppercase()),
583+ "lowercase" => Value::Str(text(0)?.to_lowercase()),
584+ "capitalize" => {
585+ let s = text(0)?;
586+ let mut chars = s.chars();
587+ Value::Str(match chars.next() {
588+ Some(c) => format!("{}{}", c.to_uppercase(), chars.as_str()),
589+ None => String::new(),
590+ })
591+ }
592+ "trim" => Value::Str(text(0)?.trim().to_string()),
593+ "length" => Value::Num(match &args[0] {
594+ Value::List(list) => list.items.len(),
595+ Value::Record(fields) => fields.len(),
596+ _ => text(0)?.chars().count(),
597+ } as f64),
598+ "reverse" => match &args[0] {
599+ Value::List(list) => Value::list(list.items.iter().rev().cloned().collect()),
600+ _ => Value::Str(text(0)?.chars().rev().collect()),
601+ },
602+ "truncate" => {
603+ let (s, n) = (text(0)?, num(1)? as usize);
604+ Value::Str(if s.chars().count() > n {
605+ format!("{}...", s.chars().take(n).collect::<String>())
606+ } else {
607+ s
608+ })
609+ }
610+ "replace" => Value::Str(text(0)?.replace(&text(1)?, &text(2)?)),
611+ "default" => {
612+ let empty = match &args[0] {
613+ Value::List(list) => list.items.is_empty(),
614+ Value::Record(_) => false,
615+ value => value.to_string().is_empty(),
616+ };
617+ let mut args = args;
618+ args.swap_remove(usize::from(empty))
619+ }
620+ _ => return Err(format!("unknown function `{}()`", name)),
621+ })
622+}
623+
624+#[cfg(test)]
625+mod tests {
626+ use super::*;
627+
628+ use crate::interp::tests::{Map, record, text_list};
629+
630+ fn scope() -> Map {
631+ Map::new(&[
632+ ("count", "3"),
633+ ("name", "World"),
634+ ("theme", "dark"),
635+ ("tricky", "a == b"),
636+ ("empty", ""),
637+ ])
638+ .with("tags", text_list(&["rust", "web dev"]))
639+ .with("post", record(&[("title", "Hi")]))
640+ }
641+
642+ fn ev(src: &str) -> Value {
643+ eval(src, &scope()).unwrap()
644+ }
645+
646+ #[test]
647+ fn arithmetic_has_precedence() {
648+ assert_eq!(ev("2 + 3 * 4").to_string(), "14");
649+ assert_eq!(ev("(2 + 3) * 4").to_string(), "20");
650+ assert_eq!(ev("$count * 2 - 1").to_string(), "5");
651+ assert_eq!(ev("7 / 2").to_string(), "3.5");
652+ assert_eq!(ev("-$count").to_string(), "-3");
653+ }
654+
655+ #[test]
656+ fn comparisons_and_logic() {
657+ assert!(ev("$count > 2").truthy());
658+ assert!(ev("$theme == dark").truthy());
659+ assert!(ev("$theme != light and not $empty").truthy());
660+ assert!(!ev("$count < 2 or $empty").truthy());
661+ assert!(ev("contains($name, or)").truthy());
662+ assert!(ev("starts-with($name, Wo) and ends-with($name, ld)").truthy());
663+ assert!(ev("uppercase($name) == WORLD").truthy());
664+ assert!(ev("#3b82f6 != red").truthy());
665+ }
666+
667+ #[test]
668+ fn variable_values_are_never_reparsed() {
669+ // The value contains `==`, but it's just a string.
670+ assert!(ev("$tricky == \"a == b\"").truthy());
671+ assert!(ev("$tricky").truthy());
672+ }
673+
674+ #[test]
675+ fn strings_and_if() {
676+ assert_eq!(ev("\"Hi $name!\"").to_string(), "Hi World!");
677+ assert_eq!(ev("if($count > 2, big, small)").to_string(), "big");
678+ assert_eq!(ev("${name}").to_string(), "World");
679+ assert_eq!(ev("${$count + 1} * 2").to_string(), "8");
680+ }
681+
682+ #[test]
683+ fn only_the_branch_taken_is_evaluated() {
684+ let zero = Map::new(&[("n", "0"), ("on", "true")]);
685+ let ev0 = |src: &str| eval(src, &zero).map(|v| v.to_string());
686+ assert_eq!(ev0("if($n != 0, 10 / $n, 0)"), Ok("0".into()));
687+ assert_eq!(ev0("if($n == 0, none, 10 / $n)"), Ok("none".into()));
688+ assert_eq!(ev0("if($on, 24)"), Ok("24".into()));
689+ assert_eq!(ev0("if(not $on, 24)"), Ok("".into()));
690+ assert_eq!(
691+ ev0("if($on, \"#10b981\", \"var(--muted)\")"),
692+ Ok("#10b981".into())
693+ );
694+ // and / or stop at the side that decides
695+ assert_eq!(ev0("$n != 0 and 10 / $n > 1"), Ok("false".into()));
696+ assert_eq!(ev0("$n == 0 or 10 / $n > 1"), Ok("true".into()));
697+ assert_eq!(ev0("$on or truncate(abc, x)"), Ok("true".into()));
698+ // The branch not taken is still read: its syntax, function names and
699+ // argument counts are checked; its variables and values are not
700+ assert_eq!(ev0("if($on, 1, $undefined)"), Ok("1".into()));
701+ assert!(eval("if($on, 1, (2)", &zero).is_err());
702+ assert!(eval("if($on, 1, nope(2))", &zero).is_err());
703+ assert!(eval("if($on, 1, uppercase(a, b))", &zero).is_err());
704+ // if() itself takes 2 or 3 arguments
705+ assert!(eval("if($on)", &zero).is_err());
706+ assert!(eval("if($on, 1, 2, 3)", &zero).is_err());
707+ // Something else after the condition is what is reported
708+ let error = eval("if($n.x, 1, 2)", &zero).unwrap_err().to_string();
709+ assert!(error.contains("`.x`"), "{}", error);
710+ // The taken branch still reports its errors
711+ assert!(eval("if($n == 0, 10 / $n, 0)", &zero).is_err());
712+ assert!(eval("$n == 0 and 10 / $n > 1", &zero).is_err());
713+ }
714+
715+ #[test]
716+ fn names_and_fields() {
717+ assert_eq!(ev("$post.title").to_string(), "Hi");
718+ // A field the record doesn't have is empty
719+ assert_eq!(ev("default($post.draft, no)").to_string(), "no");
720+ assert_eq!(
721+ eval("$missing == 1", &scope()),
722+ Err(Error::Undefined {
723+ name: "missing".into(),
724+ offset: 0
725+ })
726+ );
727+ assert_eq!(
728+ eval("\"a $nope\"", &scope()),
729+ Err(Error::Undefined {
730+ name: "nope".into(),
731+ offset: 3
732+ })
733+ );
734+ }
735+
736+ #[test]
737+ fn functions() {
738+ assert_eq!(ev("uppercase($name)").to_string(), "WORLD");
739+ assert_eq!(ev("length($name) + 1").to_string(), "6");
740+ assert_eq!(ev("truncate($name, 2)").to_string(), "Wo...");
741+ assert_eq!(ev("replace($name, o, 0)").to_string(), "W0rld");
742+ assert_eq!(ev("default($empty, none)").to_string(), "none");
743+ }
744+
745+ #[test]
746+ fn lists() {
747+ assert_eq!(ev("length($tags)").to_string(), "2");
748+ assert!(ev("contains($tags, \"web dev\")").truthy());
749+ assert!(!ev("contains($tags, web)").truthy());
750+ assert_eq!(ev("$tags").to_string(), "rust, web dev");
751+ assert_eq!(ev("reverse($tags)").to_string(), "web dev, rust");
752+ assert_eq!(ev("default($tags, none)").to_string(), "rust, web dev");
753+ // Text functions don't guess what a list means
754+ let error = eval("uppercase($tags)", &scope()).unwrap_err().to_string();
755+ assert!(error.contains("a list of 2 items"), "{}", error);
756+ assert!(eval("truncate($post, 2)", &scope()).is_err());
757+ }
758+
759+ #[test]
760+ fn ranges() {
761+ assert_eq!(ev("1..5").to_string(), "1, 2, 3, 4, 5");
762+ assert_eq!(ev("reverse(1..5)").to_string(), "5, 4, 3, 2, 1");
763+ assert_eq!(ev("length(0..10 step 5)").to_string(), "3");
764+ assert_eq!(ev("$count..1").to_string(), "3, 2, 1");
765+ assert_eq!(ev("1..$count + 1").to_string(), "1, 2, 3, 4");
766+ assert!(ev("contains(1..3, 2)").truthy());
767+ assert!(eval("1..x", &scope()).is_err());
768+ assert!(eval("1..5 step 0", &scope()).is_err());
769+ }
770+
771+ #[test]
772+ fn truthiness_and_comparison_follow_the_types() {
773+ let zero = Map::new(&[("z", "0.0"), ("upper", "#FFF")]);
774+ assert!(!eval("$z", &zero).unwrap().truthy());
775+ assert!(eval("$z == 0", &zero).unwrap().truthy());
776+ assert!(!eval("$upper == #fff", &zero).unwrap().truthy());
777+ assert_eq!(ev("100 / 3").to_string(), "33.3333");
778+ assert!(eval("1..3 < 2", &scope()).is_err());
779+ }
780+
781+ #[test]
782+ fn errors_are_reported() {
783+ let none = Map::new(&[]);
784+ assert!(eval("dark * 2", &none).is_err());
785+ assert!(eval("1 +", &none).is_err());
786+ assert!(eval("(1", &none).is_err());
787+ assert!(eval("1 / 0", &none).is_err());
788+ assert!(eval("nope(1)", &none).is_err());
789+ assert!(eval("uppercase(a, b)", &none).is_err());
790+ // Colour maths is CSS's (`color-mix()`), and a custom property is
791+ // read with `var()`
792+ for gone in ["darken", "lighten", "alpha", "mix"] {
793+ let error = eval(&format!("{}(red, 10)", gone), &none).unwrap_err();
794+ assert!(error.to_string().contains("unknown function"), "{}", error);
795+ }
796+ let error = eval("$--brand == red", &none).unwrap_err().to_string();
797+ assert!(error.contains("`var(--brand)`"), "{}", error);
798+ let error = eval("\"a $--brand\"", &none).unwrap_err().to_string();
799+ assert!(error.contains("`var(--brand)`"), "{}", error);
800+ }
801+}
crates/htmlang-core/src/interp.rsnew file+651
@@ -0,0 +1,651 @@
1+//! Variables in htmlang strings: `$name`, `$record.field` and `${...}`.
2+//!
3+//! The syntax tree finds every slot first: a run of text, an attribute's
4+//! value, an element's argument, a `@let` value, a file path, the title of
5+//! `@page`, the value of `@meta`. Each slot is then interpolated here, once.
6+//! A reference fills its own slot, and what it inserts is never read again
7+//! as htmlang: a value can't become an attribute name, a whole attribute, a
8+//! comma between attributes, markup or another `$name`.
9+//!
10+//! - `$` followed by a letter or `_` starts a name, which goes on with
11+//! letters, digits, `_` and `-` (a `-` only when a name character follows
12+//! it).
13+//! - `$--name` is an error: a custom property is read one way, with
14+//! `var(--name)`, in the browser, so it follows a token redefined under
15+//! `dark:`. See [`custom_property_len`].
16+//! - `.field` continues the name only when the value is a record or a list
17+//! (`$post.title`, `$tags.0`). After `@let lang fr`, `$lang.json` is
18+//! `fr.json`, and `$a..$b` is two names.
19+//! - `${name}` is the same name, delimited (`${size}px`), and `${EXPR}`
20+//! inserts the value of an expression (see `expr.rs`).
21+//! - A `$` before anything else is text: `$5`, `$$`, a `$` at the end.
22+//! - An undefined name is an error. A field that a record doesn't have is
23+//! empty, and so are its fields (`$post.author.name` when `$post` has no
24+//! `author`), so optional fields of `@data` records work.
25+//! - Quoted text (`@let arrow "→ "`, `@card [quote "→ "]`) remembers its
26+//! quotes: a CSS value gets them (`content $arrow` is `content:"→ "`),
27+//! text and HTML attribute values don't. See [`Sink`].
28+
29+use crate::expr;
30+use crate::value::Value;
31+
32+/// The variables in scope, as the evaluator stores them.
33+pub trait Scope {
34+ /// The value of a variable, by its name (without fields).
35+ fn get(&self, name: &str) -> Option<Value>;
36+}
37+
38+/// Where a slot's value goes, which decides what quoted text inserts.
39+#[derive(Clone, Copy, Debug, PartialEq, Eq)]
40+pub enum Sink {
41+ /// Text, an HTML attribute value, a path, a parameter: quoted text
42+ /// inserts what it says, without the quotes.
43+ Text,
44+ /// A CSS value: quoted text inserts itself with its quotes, or, inside a
45+ /// quoted string of the value, what it says with `"` escaped as `\"`.
46+ Css,
47+}
48+
49+/// Whether a CSS value is inside a quoted string after `text`, when it
50+/// was (`inside`) before it. A backslash inside a string escapes the next
51+/// character.
52+fn css_string_after(text: &str, mut inside: bool) -> bool {
53+ let mut chars = text.chars();
54+ while let Some(c) = chars.next() {
55+ match c {
56+ '\\' if inside => {
57+ chars.next();
58+ }
59+ '"' => inside = !inside,
60+ _ => {}
61+ }
62+ }
63+ inside
64+}
65+
66+/// `text` as it goes inside a CSS string: `"` escaped as `\"`. A backslash
67+/// and the character after it are a CSS escape and stay as written
68+/// (`\201C`), but a backslash at the end is doubled, so it can't escape
69+/// the rest of the string (`a\` gives `a\\`).
70+pub fn css_string_body(text: &str) -> String {
71+ let mut out = String::with_capacity(text.len());
72+ let mut chars = text.chars();
73+ while let Some(c) = chars.next() {
74+ match c {
75+ '\\' => {
76+ out.push('\\');
77+ out.push(chars.next().unwrap_or('\\'));
78+ }
79+ '"' => out.push_str("\\\""),
80+ _ => out.push(c),
81+ }
82+ }
83+ out
84+}
85+
86+/// A problem found while interpolating, at a byte offset into the text.
87+#[derive(Debug, Clone, PartialEq)]
88+pub enum Problem {
89+ /// A name with no definition.
90+ Undefined { name: String, offset: usize },
91+ /// `$--name`: a custom property, which is read with `var(--name)`.
92+ CustomProperty { name: String, offset: usize },
93+ /// A `${...}` whose expression doesn't evaluate.
94+ Invalid { message: String, offset: usize },
95+ /// A record put where text goes, which it has none of: it would print
96+ /// nothing.
97+ Record { message: String, offset: usize },
98+}
99+
100+/// The problem with putting `value`, written `written`, where text goes:
101+/// a record has no text.
102+fn no_text(written: &str, value: &Value, offset: usize) -> Option<Problem> {
103+ let name = written.strip_prefix('$').map(|name| {
104+ name.strip_prefix('{')
105+ .and_then(|n| n.strip_suffix('}'))
106+ .map_or(name, str::trim)
107+ });
108+ let fields = match value {
109+ Value::Record(fields) => fields,
110+ // A list of records, which would print only what isn't a record
111+ Value::List(list)
112+ if list.written.is_none()
113+ && list
114+ .items
115+ .iter()
116+ .any(|item| matches!(item, Value::Record(_))) =>
117+ {
118+ let example = match (name, list.items.first()) {
119+ (Some(name), Some(Value::Record(fields))) if is_path(name) => {
120+ match fields.first() {
121+ Some((field, _)) => format!(", such as `${}.0.{}`", name, field),
122+ None => String::new(),
123+ }
124+ }
125+ _ => String::new(),
126+ };
127+ return Some(Problem::Record {
128+ message: format!(
129+ "'{}' is a list of records, which has no text of its own: loop over it \
130+ with @each, or write a field of one of its items{}",
131+ written, example
132+ ),
133+ offset,
134+ });
135+ }
136+ _ => return None,
137+ };
138+ let example = match (name, fields.first()) {
139+ (Some(name), Some((field, _))) if is_path(name) => {
140+ format!(", such as `${}.{}`", name, field)
141+ }
142+ _ => String::new(),
143+ };
144+ Some(Problem::Record {
145+ message: format!(
146+ "'{}' is a record, which has no text of its own: write one of its fields{}",
147+ written, example
148+ ),
149+ offset,
150+ })
151+}
152+
153+fn is_name_char(c: char) -> bool {
154+ c.is_alphanumeric() || c == '_'
155+}
156+
157+/// The length of a word at the start of `s` whose first character passes
158+/// `first`: name characters, with `-` between them.
159+fn word_len(s: &str, first: impl Fn(char) -> bool) -> usize {
160+ let Some(c) = s.chars().next().filter(|&c| first(c)) else {
161+ return 0;
162+ };
163+ let mut end = c.len_utf8();
164+ let mut i = end;
165+ while let Some(c) = s[i..].chars().next() {
166+ if is_name_char(c) {
167+ i += c.len_utf8();
168+ end = i;
169+ } else if c == '-' {
170+ let rest = &s[i..];
171+ let dashes = rest.len() - rest.trim_start_matches('-').len();
172+ if !rest[dashes..].starts_with(is_name_char) {
173+ break;
174+ }
175+ i += dashes;
176+ } else {
177+ break;
178+ }
179+ }
180+ end
181+}
182+
183+/// The length of the variable name at the start of `s` (the text after a
184+/// `$`), by syntax alone, or 0 when `s` doesn't start one.
185+pub fn name_len(s: &str) -> usize {
186+ word_len(s, |c| c.is_alphabetic() || c == '_')
187+}
188+
189+/// The length of the custom property's name `--name` at the start of `s`
190+/// (the text after a `$`), or 0. `$--name` is not a variable and not text
191+/// either: it is an error that says to write `var(--name)`.
192+pub fn custom_property_len(s: &str) -> usize {
193+ match s.strip_prefix("--") {
194+ Some(rest) => match word_len(rest, |c| c.is_alphanumeric() || c == '_') {
195+ 0 => 0,
196+ n => n + 2,
197+ },
198+ None => 0,
199+ }
200+}
201+
202+/// What is wrong with `$NAME`, where `name` is a custom property's name
203+/// (`--brand`).
204+pub fn custom_property_message(name: &str) -> String {
205+ format!(
206+ "`${}` is not a variable: a custom property is read with `var({})`",
207+ name, name
208+ )
209+}
210+
211+/// Whether `s` is a whole name path, `name` or `name.field.field`.
212+fn is_path(s: &str) -> bool {
213+ let n = name_len(s);
214+ if n == 0 || matches!(&s[..n], "true" | "false" | "not" | "and" | "or") {
215+ return false;
216+ }
217+ let mut rest = &s[n..];
218+ while let Some(field) = rest.strip_prefix('.') {
219+ let f = word_len(field, is_name_char);
220+ if f == 0 {
221+ return false;
222+ }
223+ rest = &field[f..];
224+ }
225+ rest.is_empty()
226+}
227+
228+/// What a name path leads to so far: a value, or a field that a record
229+/// (or an item that a list) doesn't have, which is empty, and so is every
230+/// field of it.
231+#[derive(Clone)]
232+enum Step {
233+ Value(Value),
234+ Missing,
235+}
236+
237+impl Step {
238+ /// The field `name` of this step, or `None` when it has no fields
239+ /// (text, a number, true or false).
240+ fn field(&self, name: &str) -> Option<Step> {
241+ let Step::Value(value) = self else {
242+ return Some(Step::Missing);
243+ };
244+ match value {
245+ Value::Record(fields) => Some(
246+ fields
247+ .iter()
248+ .find(|(key, _)| key == name)
249+ .map_or(Step::Missing, |(_, value)| Step::Value(value.clone())),
250+ ),
251+ Value::List(list) => Some(
252+ name.parse::<usize>()
253+ .ok()
254+ .and_then(|i| list.items.get(i).cloned())
255+ .map_or(Step::Missing, Step::Value),
256+ ),
257+ _ => None,
258+ }
259+ }
260+
261+ fn value(self) -> Value {
262+ match self {
263+ Step::Value(value) => value,
264+ Step::Missing => Value::empty(),
265+ }
266+ }
267+}
268+
269+/// The name path at the start of `s` (after a `$`) and its length: the
270+/// name, and each `.field` while the value so far is a record or a list,
271+/// or a field one of them doesn't have.
272+fn path_at(s: &str, scope: &dyn Scope) -> Option<(String, usize)> {
273+ let n = name_len(s);
274+ if n == 0 {
275+ return None;
276+ }
277+ let mut path = s[..n].to_string();
278+ let mut len = n;
279+ let mut step = scope.get(&path).map(Step::Value);
280+ while let Some(rest) = s[len..].strip_prefix('.') {
281+ let f = word_len(rest, is_name_char);
282+ let Some(field) = step
283+ .as_ref()
284+ .filter(|_| f > 0)
285+ .and_then(|v| v.field(&rest[..f]))
286+ else {
287+ break;
288+ };
289+ path = format!("{}.{}", path, &rest[..f]);
290+ len += 1 + f;
291+ step = Some(field);
292+ }
293+ Some((path, len))
294+}
295+
296+/// A reference, after its `$`.
297+#[derive(Debug, Clone, PartialEq)]
298+pub enum Reference<'a> {
299+ /// `$name`, `$name.field` or `${name}`: the name path.
300+ Var(String),
301+ /// `${EXPR}`: the expression.
302+ Expr(&'a str),
303+}
304+
305+/// The reference that `s` (the text after a `$`) starts with, and its
306+/// length. `None` when the `$` is text.
307+pub fn reference<'a>(s: &'a str, scope: &dyn Scope) -> Option<(Reference<'a>, usize)> {
308+ if s.starts_with('{') {
309+ let close = matching_brace(s)?;
310+ let inner = &s[1..close];
311+ let reference = if is_path(inner.trim()) {
312+ Reference::Var(inner.trim().to_string())
313+ } else {
314+ Reference::Expr(inner)
315+ };
316+ return Some((reference, close + 1));
317+ }
318+ let (path, len) = path_at(s, scope)?;
319+ Some((Reference::Var(path), len))
320+}
321+
322+/// The value of a name path, or `None` when it is undefined. A field that
323+/// a record doesn't have is empty, and so is any field of it.
324+pub fn resolve(path: &str, scope: &dyn Scope) -> Option<Value> {
325+ let mut parts = path.split('.');
326+ let mut step = Step::Value(scope.get(parts.next()?)?);
327+ for field in parts {
328+ step = step.field(field)?;
329+ }
330+ Some(step.value())
331+}
332+
333+/// Fill in the `$name`s and `${...}`s of one slot's text, for text (see
334+/// [`Sink::Text`]). Each one that can't be filled is left as written and
335+/// reported.
336+pub fn interpolate(text: &str, scope: &dyn Scope) -> (String, Vec<Problem>) {
337+ interpolate_for(text, scope, Sink::Text)
338+}
339+
340+/// [`interpolate`] for a slot whose value goes to `sink`.
341+pub fn interpolate_for(text: &str, scope: &dyn Scope, sink: Sink) -> (String, Vec<Problem>) {
342+ let mut problems = Vec::new();
343+ if !text.contains('$') {
344+ return (text.to_string(), problems);
345+ }
346+ let mut out = String::with_capacity(text.len());
347+ let mut pos = 0;
348+ // Whether the CSS value is inside a quoted string at `pos`
349+ let mut in_string = false;
350+ while let Some(found) = text[pos..].find('$') {
351+ let dollar = pos + found;
352+ out.push_str(&text[pos..dollar]);
353+ if sink == Sink::Css {
354+ in_string = css_string_after(&text[pos..dollar], in_string);
355+ }
356+ let after = &text[dollar + 1..];
357+ let Some((reference, len)) = reference(after, scope) else {
358+ let n = custom_property_len(after);
359+ if n > 0 {
360+ problems.push(Problem::CustomProperty {
361+ name: after[..n].to_string(),
362+ offset: dollar,
363+ });
364+ }
365+ out.push_str(&text[dollar..dollar + 1 + n]);
366+ pos = dollar + 1 + n;
367+ continue;
368+ };
369+ let written = &text[dollar..dollar + 1 + len];
370+ let insert = |value: String, quoted: Option<String>| match (sink, quoted) {
371+ (Sink::Css, Some(css)) if in_string => {
372+ // The string's body, without its quotes
373+ let body = css.strip_prefix('"').unwrap_or(&css);
374+ body.strip_suffix('"').unwrap_or(body).to_string()
375+ }
376+ (Sink::Css, Some(css)) => css,
377+ (Sink::Css, None) if in_string => css_string_body(&value),
378+ _ => value,
379+ };
380+ match reference {
381+ Reference::Var(path) => match resolve(&path, scope) {
382+ Some(value) => match no_text(written, &value, dollar) {
383+ Some(problem) => problems.push(problem),
384+ None => out.push_str(&insert(
385+ value.to_string(),
386+ value.quoted_css().map(str::to_string),
387+ )),
388+ },
389+ None => {
390+ problems.push(Problem::Undefined {
391+ name: path,
392+ offset: dollar,
393+ });
394+ out.push_str(written);
395+ }
396+ },
397+ Reference::Expr(source) => match expr::eval(source, scope) {
398+ Ok(value) => match no_text(written, &value, dollar) {
399+ Some(problem) => problems.push(problem),
400+ None => out.push_str(&insert(value.to_string(), None)),
401+ },
402+ Err(error) => {
403+ problems.push(match error {
404+ // At the `${`
405+ expr::Error::Invalid(message) => Problem::Invalid {
406+ message,
407+ offset: dollar,
408+ },
409+ // At the name, inside the braces
410+ error => error.at(dollar + 2),
411+ });
412+ out.push_str(written);
413+ }
414+ },
415+ }
416+ pos = dollar + 1 + len;
417+ }
418+ out.push_str(&text[pos..]);
419+ (out, problems)
420+}
421+
422+/// The names `text` refers to, by syntax alone: the first name of each
423+/// path, including those inside `${...}`.
424+pub fn names(text: &str) -> Vec<&str> {
425+ name_spans(text)
426+ .into_iter()
427+ .map(|span| &text[span])
428+ .collect()
429+}
430+
431+/// Where the names of [`names`] are in `text`, as byte ranges of the name
432+/// alone: after the `$` of `$name`, inside the braces of `${name}`.
433+pub fn name_spans(text: &str) -> Vec<std::ops::Range<usize>> {
434+ let mut found = Vec::new();
435+ collect_name_spans(text, 0, &mut found);
436+ found
437+}
438+
439+fn collect_name_spans(text: &str, base: usize, found: &mut Vec<std::ops::Range<usize>>) {
440+ let mut pos = 0;
441+ while let Some(i) = text[pos..].find('$') {
442+ let after = pos + i + 1;
443+ let rest = &text[after..];
444+ pos = after;
445+ // `\$` is a dollar sign (and `\\$` a backslash before a name)
446+ let backslashes = text[..after - 1].len() - text[..after - 1].trim_end_matches('\\').len();
447+ if backslashes % 2 == 1 {
448+ continue;
449+ }
450+ if rest.starts_with('{')
451+ && let Some(close) = matching_brace(rest)
452+ {
453+ let inner = &rest[1..close];
454+ let trimmed = inner.trim_start();
455+ if is_path(trimmed.trim_end()) {
456+ let start = base + after + 1 + inner.len() - trimmed.len();
457+ found.push(start..start + name_len(trimmed));
458+ } else {
459+ collect_name_spans(inner, base + after + 1, found);
460+ }
461+ pos = after + close + 1;
462+ continue;
463+ }
464+ let n = name_len(rest);
465+ if n > 0 {
466+ found.push(base + after..base + after + n);
467+ pos = after + n;
468+ }
469+ }
470+}
471+
472+/// Index of the `}` matching the `{` that `s` starts with (skipping
473+/// braces inside string literals).
474+pub(crate) fn matching_brace(s: &str) -> Option<usize> {
475+ let mut depth = 0;
476+ let mut in_string = false;
477+ for (i, c) in s.char_indices() {
478+ match c {
479+ '"' => in_string = !in_string,
480+ _ if in_string => {}
481+ '{' => depth += 1,
482+ '}' => {
483+ depth -= 1;
484+ if depth == 0 {
485+ return Some(i);
486+ }
487+ }
488+ _ => {}
489+ }
490+ }
491+ None
492+}
493+
494+#[cfg(test)]
495+pub(crate) mod tests {
496+ use super::*;
497+ use std::collections::HashMap;
498+
499+ /// Variables by name: text from `new`, any value from `with`.
500+ pub(crate) struct Map(pub HashMap<String, Value>);
501+
502+ impl Map {
503+ pub(crate) fn new(pairs: &[(&str, &str)]) -> Self {
504+ Map(pairs
505+ .iter()
506+ .map(|(k, v)| (k.to_string(), Value::Str(v.to_string())))
507+ .collect())
508+ }
509+
510+ pub(crate) fn with(mut self, name: &str, value: Value) -> Self {
511+ self.0.insert(name.to_string(), value);
512+ self
513+ }
514+ }
515+
516+ impl Scope for Map {
517+ fn get(&self, name: &str) -> Option<Value> {
518+ self.0.get(name).cloned()
519+ }
520+ }
521+
522+ pub(crate) fn text_list(items: &[&str]) -> Value {
523+ Value::list(items.iter().map(|s| Value::Str(s.to_string())).collect())
524+ }
525+
526+ pub(crate) fn record(fields: &[(&str, &str)]) -> Value {
527+ Value::Record(std::rc::Rc::new(
528+ fields
529+ .iter()
530+ .map(|(k, v)| (k.to_string(), Value::Str(v.to_string())))
531+ .collect(),
532+ ))
533+ }
534+
535+ fn vars() -> Map {
536+ Map::new(&[("lang", "fr"), ("n", "3"), ("n-1", "two")])
537+ .with("post", record(&[("title", "Hello")]))
538+ .with("tags", text_list(&["a", "b"]))
539+ }
540+
541+ fn fill(text: &str) -> String {
542+ interpolate(text, &vars()).0
543+ }
544+
545+ #[test]
546+ fn names_end_where_they_must() {
547+ assert_eq!(fill("locales/$lang.json"), "locales/fr.json");
548+ assert_eq!(fill("$post.title!"), "Hello!");
549+ assert_eq!(fill("$tags.1 and $tags"), "b and a, b");
550+ assert_eq!(fill("${lang}uage"), "fruage");
551+ assert_eq!(fill("$lang- $lang:"), "fr- fr:");
552+ assert_eq!(fill("$n-1"), "two");
553+ assert_eq!(fill("1..$n"), "1..3");
554+ // A name ends at `..`
555+ assert_eq!(fill("$n..$n $post.title..x"), "3..3 Hello..x");
556+ }
557+
558+ #[test]
559+ fn a_dollar_before_anything_else_is_text() {
560+ assert_eq!(fill("$5 and $$ and $"), "$5 and $$ and $");
561+ assert_eq!(fill("a $-x ${"), "a $-x ${");
562+ }
563+
564+ #[test]
565+ fn a_custom_property_is_not_a_variable() {
566+ let (out, problems) = interpolate("x $--brand-dark $-- $--1", &vars());
567+ assert_eq!(out, "x $--brand-dark $-- $--1");
568+ assert_eq!(
569+ problems,
570+ [
571+ Problem::CustomProperty {
572+ name: "--brand-dark".into(),
573+ offset: 2
574+ },
575+ Problem::CustomProperty {
576+ name: "--1".into(),
577+ offset: 20
578+ }
579+ ]
580+ );
581+ assert!(custom_property_message("--brand").contains("`var(--brand)`"));
582+ assert_eq!(names("$--e $f"), ["f"]);
583+ }
584+
585+ #[test]
586+ fn missing_fields_are_empty_and_undefined_names_are_errors() {
587+ assert_eq!(fill("[$post.summary]"), "[]");
588+ let (out, problems) = interpolate("x $nope y", &vars());
589+ assert_eq!(out, "x $nope y");
590+ assert_eq!(
591+ problems,
592+ [Problem::Undefined {
593+ name: "nope".into(),
594+ offset: 2
595+ }]
596+ );
597+ }
598+
599+ #[test]
600+ fn expressions() {
601+ assert_eq!(fill("${$n * 2}px"), "6px");
602+ let (_, problems) = interpolate("a ${$n + $m}", &vars());
603+ assert_eq!(
604+ problems,
605+ [Problem::Undefined {
606+ name: "m".into(),
607+ offset: 9
608+ }]
609+ );
610+ }
611+
612+ #[test]
613+ fn quoted_text_keeps_its_quotes_only_in_css() {
614+ let quoted = Value::Quoted(crate::ast::Quoted {
615+ text: r#"a"b"#.into(),
616+ css: r#""a\"b""#.into(),
617+ });
618+ let scope = Map::new(&[("n", r#"x"y"#)]).with("q", quoted);
619+ let fill = |text: &str, sink| interpolate_for(text, &scope, sink).0;
620+ assert_eq!(fill("$q", Sink::Text), r#"a"b"#);
621+ assert_eq!(fill("$q", Sink::Css), r#""a\"b""#);
622+ // Inside a CSS string, what it says, escaped as the string needs
623+ assert_eq!(
624+ fill(r#""($q) $n" $q"#, Sink::Css),
625+ r#""(a\"b) x\"y" "a\"b""#
626+ );
627+ assert_eq!(fill(r#""\" $q""#, Sink::Css), r#""\" a\"b""#);
628+ // What an unquoted value holds goes into a string that stays valid
629+ let scope = Map::new(&[("end", r"a\"), ("esc", r"\201C"), ("q", r#"x\"y"#)]);
630+ let fill = |text: &str| interpolate_for(text, &scope, Sink::Css).0;
631+ assert_eq!(fill(r#""$end""#), r#""a\\""#);
632+ assert_eq!(fill(r#""$esc""#), r#""\201C""#);
633+ assert_eq!(fill(r#""$q""#), r#""x\"y""#);
634+ }
635+
636+ #[test]
637+ fn inserted_values_are_never_read_again() {
638+ let scope = Map::new(&[("a", "$b"), ("b", "no")]);
639+ assert_eq!(interpolate("$a", &scope).0, "$b");
640+ }
641+
642+ #[test]
643+ fn names_by_syntax() {
644+ assert_eq!(names("$a.b ${c} ${upper($d)} $5 $--e"), ["a", "c", "d"]);
645+ assert_eq!(names(r"\$a \\$b \\\$c"), ["b"]);
646+ assert_eq!(
647+ name_spans("x ${ size }px ${$n + ${m}} $a- b"),
648+ [5..9, 17..18, 23..24, 28..29]
649+ );
650+ }
651+}
crates/htmlang-core/src/lib.rsnew file+12
@@ -0,0 +1,12 @@
1+pub mod ast;
2+pub mod codegen;
3+pub mod diagnostic;
4+pub mod expr;
5+pub mod interp;
6+pub mod parser;
7+pub mod syntax;
8+pub mod value;
9+pub mod vocab;
10+
11+#[cfg(test)]
12+mod codegen_tests;
crates/htmlang-core/src/parser.rsnew file+7651
@@ -0,0 +1,7651 @@
1+use std::collections::{HashMap, HashSet};
2+use std::path::{Path, PathBuf};
3+use std::rc::Rc;
4+
5+use crate::ast::*;
6+use crate::diagnostic::code;
7+pub use crate::diagnostic::{Diagnostic, Severity};
8+use crate::interp::{self, Sink};
9+use crate::syntax::{self, DirectiveArgs, LetForm, NodeKind, Segment, Tree};
10+use crate::value::{self, Value};
11+
12+// ---------------------------------------------------------------------------
13+// Public types
14+// ---------------------------------------------------------------------------
15+
16+pub struct ParseResult {
17+ pub document: Document,
18+ pub diagnostics: Vec<Diagnostic>,
19+ pub included_files: Vec<PathBuf>,
20+}
21+
22+/// An error that stops one line from being evaluated.
23+type ParseError = Diagnostic;
24+
25+// ---------------------------------------------------------------------------
26+// Internal types
27+// ---------------------------------------------------------------------------
28+
29+#[derive(Clone)]
30+struct FnDef {
31+ /// The parameters in the order they are declared; one without a
32+ /// default is required.
33+ params: Vec<syntax::Param>,
34+ /// The definition's line and its text (when it is one physical line),
35+ /// and its node, for diagnostics about a default.
36+ line: usize,
37+ source: Option<String>,
38+ node: usize,
39+ body: Vec<syntax::Node>,
40+ /// The file it is defined in, when that isn't the file being compiled
41+ /// (see `ParseContext::current_file`).
42+ file: Option<String>,
43+ /// The slots its body declares (`@slot NAME`), in order.
44+ slots: Vec<String>,
45+ /// Whether its body has a `@children` for the content of a call.
46+ has_children: bool,
47+ /// Its scoped `@style`: its class (`hl-fn-NAME-HASH`), and the
48+ /// stylesheet nested under it, written into the page once the function
49+ /// is called (see `Document::scoped_css`).
50+ scoped: Option<(String, String)>,
51+ /// What was visible where it was defined: its body and its defaults
52+ /// see this, plus its parameters.
53+ env: Env,
54+ /// It is named like a built-in element and its body calls that name
55+ /// outside any `@if`, meaning the element (`@let @nav` around `@nav`):
56+ /// it would call itself forever, so a call writes nothing (the
57+ /// definition's error says so).
58+ wraps_itself: bool,
59+}
60+
61+impl FnDef {
62+ fn is_param(&self, name: &str) -> bool {
63+ self.params.iter().any(|p| p.name == name)
64+ }
65+}
66+
67+/// What a name means: every `@let`, parameter, loop variable and `@data`
68+/// binds one, and they share one namespace.
69+#[derive(Clone)]
70+enum Binding {
71+ Value(Value),
72+ Bundle(Rc<Vec<Attribute>>),
73+ Function(Rc<FnDef>),
74+}
75+
76+/// The names visible at a line: one frame per block it is in (the
77+/// standard library, the file, an element's children, an `@if` branch, an
78+/// iteration of `@each`, a function's body), the innermost last. A
79+/// definition goes into the innermost frame, so it is visible from its
80+/// line to the end of its block. A function keeps the frames visible
81+/// where it is defined; a frame is shared until one side changes it.
82+#[derive(Clone, Default)]
83+struct Env {
84+ frames: Vec<Rc<HashMap<String, Binding>>>,
85+}
86+
87+impl Env {
88+ fn push(&mut self) {
89+ self.frames.push(Rc::default());
90+ }
91+
92+ fn pop(&mut self) {
93+ self.frames.pop();
94+ }
95+
96+ /// Give `name` a meaning in the innermost frame, replacing what it
97+ /// meant there and hiding what it means outside it.
98+ fn define(&mut self, name: &str, binding: Binding) {
99+ if self.frames.is_empty() {
100+ self.push();
101+ }
102+ if let Some(frame) = self.frames.last_mut() {
103+ Rc::make_mut(frame).insert(name.to_string(), binding);
104+ }
105+ }
106+
107+ /// What `name` means here: the innermost definition.
108+ fn get(&self, name: &str) -> Option<&Binding> {
109+ self.frames.iter().rev().find_map(|frame| frame.get(name))
110+ }
111+
112+ fn value(&self, name: &str) -> Option<&Value> {
113+ match self.get(name)? {
114+ Binding::Value(value) => Some(value),
115+ _ => None,
116+ }
117+ }
118+
119+ fn bundle(&self, name: &str) -> Option<&Rc<Vec<Attribute>>> {
120+ match self.get(name)? {
121+ Binding::Bundle(attrs) => Some(attrs),
122+ _ => None,
123+ }
124+ }
125+
126+ fn function(&self, name: &str) -> Option<&Rc<FnDef>> {
127+ match self.get(name)? {
128+ Binding::Function(function) => Some(function),
129+ _ => None,
130+ }
131+ }
132+
133+ /// Every name visible here, with what it means.
134+ fn visible(&self) -> HashMap<&str, &Binding> {
135+ let mut names = HashMap::new();
136+ for frame in &self.frames {
137+ for (name, binding) in frame.iter() {
138+ names.insert(name.as_str(), binding);
139+ }
140+ }
141+ names
142+ }
143+
144+ /// The names of the values visible here.
145+ fn value_names(&self) -> Vec<&str> {
146+ self.visible()
147+ .into_iter()
148+ .filter(|(_, binding)| matches!(binding, Binding::Value(_)))
149+ .map(|(name, _)| name)
150+ .collect()
151+ }
152+
153+ /// The names of the bundles visible here.
154+ fn bundle_names(&self) -> Vec<&str> {
155+ self.visible()
156+ .into_iter()
157+ .filter(|(_, binding)| matches!(binding, Binding::Bundle(_)))
158+ .map(|(name, _)| name)
159+ .collect()
160+ }
161+}
162+
163+impl interp::Scope for Env {
164+ fn get(&self, name: &str) -> Option<Value> {
165+ self.value(name).cloned()
166+ }
167+}
168+
169+struct ParseContext {
170+ /// Source line currently being parsed, for diagnostics raised deep
171+ /// inside helpers that don't take a line number.
172+ current_line: usize,
173+ /// What the `@page` said, once one has run
174+ page: Option<Page>,
175+ /// Where that `@page` is, for the error a second one gets
176+ page_at: Option<String>,
177+ meta_tags: Vec<(String, String)>,
178+ head_blocks: Vec<String>,
179+ /// The first `@meta` or `@head` that ran, for the warning a file
180+ /// without `@page` gets: a fragment has no `<head>` for them.
181+ head_at: Option<usize>,
182+ /// What each name means at the line being evaluated.
183+ env: Env,
184+ /// Every function whose definition ran, by name (the last one), for
185+ /// the checks of code that never runs.
186+ defined_functions: HashMap<String, Rc<FnDef>>,
187+ css_vars: Vec<(String, String)>,
188+ custom_css: Vec<String>,
189+ /// The scoped `@style` of each function called so far
190+ scoped_css: Vec<String>,
191+ og_tags: Vec<(String, String)>,
192+ diagnostics: Vec<Diagnostic>,
193+ base_path: Option<PathBuf>,
194+ included_files: Vec<PathBuf>,
195+ include_stack: Vec<PathBuf>,
196+ fn_call_stack: Vec<String>,
197+ file_cache: HashMap<PathBuf, String>,
198+ /// Track which @let variables are referenced (for unused warnings)
199+ used_variables: HashSet<String>,
200+ /// Track which functions are called (for unused warnings)
201+ used_functions: HashSet<String>,
202+ /// Track which attribute bundles are referenced (for unused warnings)
203+ used_defines: HashSet<String>,
204+ /// Line numbers of @let definitions (name -> line)
205+ let_lines: HashMap<String, usize>,
206+ /// Line numbers of function definitions (name -> line)
207+ fn_lines: HashMap<String, usize>,
208+ /// Line numbers of attribute bundle definitions (name -> line)
209+ define_lines: HashMap<String, usize>,
210+ /// Syntax nodes evaluated at least once, by id.
211+ visited: HashSet<usize>,
212+ /// The id the next parsed tree starts at, so ids are unique across
213+ /// the file, its includes and the standard library.
214+ next_id: usize,
215+ /// The file's tree and those of the files it includes, with the
216+ /// include chain that leads to each, for the checks of code that never
217+ /// runs.
218+ trees: Vec<(Rc<Tree>, Option<String>)>,
219+ /// The files each `@include` line brought in (by the line's node id),
220+ /// with the include chain that leads to each, so the checks of
221+ /// `@slot` and `@children` see an included file's lines where the
222+ /// `@include` is written.
223+ included_by: Rc<IncludedBy>,
224+ /// Every function defined anywhere in the file or the files it
225+ /// includes, whether or not its definition runs.
226+ namespace: HashSet<String>,
227+ /// The line being evaluated, and its text as written when it is one
228+ /// physical line, for diagnostics that point at a column.
229+ current_source: (usize, Option<String>),
230+ /// Variable diagnostics already reported, so a line evaluated many
231+ /// times (in a loop, in a function) reports each problem once.
232+ /// Keyed by the syntax node (ids are unique across files), line,
233+ /// column and message.
234+ reported: HashSet<(usize, usize, Option<usize>, String)>,
235+ /// The id of the syntax node being evaluated.
236+ current_node: usize,
237+ /// The file whose lines are being evaluated, when it isn't the file
238+ /// being compiled: the standard library, or an included file (by its
239+ /// include chain).
240+ current_file: Option<String>,
241+ /// A call went deeper than [`MAX_CALL_DEPTH`]: the calls it is nested
242+ /// in expand to nothing, until the outermost one returns.
243+ too_deep: bool,
244+ /// A bundle's attributes are being read: a name that could be a
245+ /// parameter of the function the bundle is passed to is checked where
246+ /// the bundle is used instead.
247+ in_bundle: bool,
248+ /// `@page`'s attributes are being read: a name close to `favicon` is
249+ /// a misspelled word of `@page`'s.
250+ in_page: bool,
251+}
252+
253+/// How deeply function calls may nest, so that a function that calls
254+/// itself without an `@if` that stops it is an error instead of a hang.
255+const MAX_CALL_DEPTH: usize = 64;
256+
257+/// A CSS rule at the top level of a stylesheet that starts with `&`
258+/// (outside any `{}`, strings and comments).
259+fn has_top_level_ampersand(css: &str) -> bool {
260+ let mut depth = 0usize;
261+ let mut chars = css.chars().peekable();
262+ let mut at_rule_start = true;
263+ while let Some(c) = chars.next() {
264+ match c {
265+ '/' if chars.peek() == Some(&'*') => {
266+ chars.next();
267+ let mut last = ' ';
268+ for c in chars.by_ref() {
269+ if last == '*' && c == '/' {
270+ break;
271+ }
272+ last = c;
273+ }
274+ continue;
275+ }
276+ '"' | '\'' => {
277+ for d in chars.by_ref() {
278+ if d == c {
279+ break;
280+ }
281+ }
282+ }
283+ '{' => depth += 1,
284+ '}' => depth = depth.saturating_sub(1),
285+ '&' if depth == 0 && at_rule_start => return true,
286+ _ => {}
287+ }
288+ at_rule_start = match c {
289+ '{' | '}' | ';' => true,
290+ c if c.is_whitespace() => at_rule_start,
291+ _ => false,
292+ };
293+ }
294+ false
295+}
296+
297+/// Whether a file is a library (see [`Tree::is_library`]), with the files
298+/// its `@include` lines name read relative to `base`.
299+fn is_library_file(
300+ tree: &Tree,
301+ base: Option<&Path>,
302+ ctx: &mut ParseContext,
303+ seen: &mut Vec<PathBuf>,
304+) -> bool {
305+ tree.is_library_with(&mut |path| {
306+ if path.contains('$') {
307+ return false;
308+ }
309+ let resolved = base.map_or_else(|| PathBuf::from(path), |base| base.join(path));
310+ if seen.contains(&resolved) {
311+ return false;
312+ }
313+ seen.push(resolved.clone());
314+ let Ok(text) = ctx.read_file(&resolved) else {
315+ return false;
316+ };
317+ let included = syntax::parse(&text);
318+ is_library_file(&included, resolved.parent(), ctx, seen)
319+ })
320+}
321+
322+/// The frames around the file's top level: the standard library's and
323+/// the file's own (see [`load_prelude`]).
324+const FILE_FRAMES: usize = 2;
325+
326+/// Evaluates a syntax tree (see `syntax.rs`) into the document's nodes.
327+struct Evaluator;
328+
329+impl ParseContext {
330+ /// Bind a value to `name` in the innermost block.
331+ fn bind(&mut self, name: &str, value: Value) {
332+ self.env.define(name, Binding::Value(value));
333+ }
334+
335+ /// Evaluate an expression (see `expr.rs`) written at `line` and
336+ /// `column` (when known), reporting its errors there.
337+ fn eval(
338+ &mut self,
339+ src: &str,
340+ line: usize,
341+ column: Option<usize>,
342+ ) -> Option<crate::expr::Value> {
343+ track_var_refs(src, &mut self.used_variables);
344+ match crate::expr::eval(src, &self.env) {
345+ Ok(value) => Some(value),
346+ Err(error) => {
347+ // Without the line to point into, show the expression
348+ let shown = matches!(&self.current_source, (current, Some(_)) if *current == line);
349+ let before = self.diagnostics.len();
350+ self.report(error.at(0), line, column);
351+ if !shown && let Some(diagnostic) = self.diagnostics.get_mut(before) {
352+ diagnostic.source_line = Some(src.into());
353+ }
354+ None
355+ }
356+ }
357+ }
358+
359+ /// Evaluate a condition; an invalid one is reported and counts as false.
360+ fn condition(&mut self, src: &str, line: usize, column: Option<usize>) -> bool {
361+ self.eval(src, line, column)
362+ .is_some_and(|value| value.truthy())
363+ }
364+
365+ /// Fill in one slot of htmlang text written at `line` and `column`
366+ /// (when known), for `sink`: its escapes stand for themselves and its
367+ /// variables are filled in (see `interp.rs`). What can't be filled is
368+ /// left as written and reported; the flag says whether everything was
369+ /// filled.
370+ fn fill(
371+ &mut self,
372+ raw: &str,
373+ line: usize,
374+ column: Option<usize>,
375+ sink: Sink,
376+ ) -> (String, bool) {
377+ let (filled, ok) = self.fill_protected(raw, line, column, sink);
378+ (restore_escapes(&filled), ok)
379+ }
380+
381+ /// [`fill`](Self::fill) for text.
382+ fn interpolate_text(&mut self, raw: &str, line: usize, column: Option<usize>) -> String {
383+ self.fill(raw, line, column, Sink::Text).0
384+ }
385+
386+ /// [`fill`](Self::fill), with the escapes still placeholders (see
387+ /// [`protect_escapes`]).
388+ fn fill_protected(
389+ &mut self,
390+ raw: &str,
391+ line: usize,
392+ column: Option<usize>,
393+ sink: Sink,
394+ ) -> (String, bool) {
395+ let mut protected = protect_escapes(raw);
396+ if sink == Sink::Css {
397+ protected = keep_css_string_escapes(&protected);
398+ }
399+ if !protected.contains('$') {
400+ return (protected, true);
401+ }
402+ track_var_refs(&protected, &mut self.used_variables);
403+ let (out, problems) = interp::interpolate_for(&protected, &self.env, sink);
404+ let filled = problems.is_empty();
405+ for mut problem in problems {
406+ match &mut problem {
407+ interp::Problem::Undefined { offset, .. }
408+ | interp::Problem::CustomProperty { offset, .. }
409+ | interp::Problem::Invalid { offset, .. }
410+ | interp::Problem::Record { offset, .. } => {
411+ // An offset into the protected text, as one into `raw`
412+ *offset = protected[..*offset]
413+ .chars()
414+ .map(|c| escape_of(c).map_or(c.len_utf8(), str::len))
415+ .sum();
416+ }
417+ }
418+ self.report(problem, line, column);
419+ }
420+ (out, filled)
421+ }
422+
423+ /// Fill in a value slot (an attribute's value, a `@let` value, `@meta`'s
424+ /// value) for `sink`, and say whether it is quoted text: one `"..."`, or
425+ /// one variable that holds quoted text. Quoted text keeps its quotes
426+ /// only in CSS.
427+ fn fill_value(
428+ &mut self,
429+ raw: &str,
430+ line: usize,
431+ column: Option<usize>,
432+ sink: Sink,
433+ ) -> (String, Option<Quoted>, bool) {
434+ if let Some(inner) = syntax::quoted_string(raw) {
435+ let (css, ok) = self.fill(raw, line, column, Sink::Css);
436+ // Already reported by the CSS pass, so filled in quietly
437+ let (text, _) = interp::interpolate(&protect_escapes(inner), &self.env);
438+ let quoted = Quoted {
439+ text: restore_escapes(&text),
440+ css,
441+ };
442+ let out = match sink {
443+ Sink::Css => quoted.css.clone(),
444+ Sink::Text => quoted.text.clone(),
445+ };
446+ return (out, Some(quoted), ok);
447+ }
448+ let (out, ok) = self.fill(raw, line, column, sink);
449+ let quoted = whole_reference(raw, &self.env).and_then(|path| {
450+ match interp::resolve(&path, &self.env)? {
451+ Value::Quoted(quoted) => Some(quoted),
452+ _ => None,
453+ }
454+ });
455+ (out, quoted, ok)
456+ }
457+
458+ /// The value of a value slot (a `@let` value, the source of `@each`, a
459+ /// parameter's value or default), written at `line` and `column`:
460+ ///
461+ /// - exactly one `$name` or `${...}` is the value it holds or gives,
462+ /// whatever its type (a list, a record, quoted text);
463+ /// - one `"..."` is quoted text;
464+ /// - commas outside quotes, brackets and `${...}`, and not escaped
465+ /// (`\,`), make a list, which prints as written;
466+ /// - `A..B` or `A..B step N` with whole numbers is a range;
467+ /// - anything else is text, with its variables filled in.
468+ ///
469+ /// What can't be filled in is reported; the flag says whether
470+ /// everything was.
471+ fn slot_value(&mut self, raw: &str, line: usize, column: Option<usize>) -> (Value, bool) {
472+ let trimmed = raw.trim();
473+ let column = column.map(|c| c + (raw.len() - raw.trim_start().len()));
474+ if let Some(value) = self.whole_value(trimmed, line, column) {
475+ return value;
476+ }
477+ if syntax::quoted_string(trimmed).is_some() {
478+ let (text, quoted, ok) = self.fill_value(trimmed, line, column, Sink::Text);
479+ return (quoted.map_or(Value::Str(text), Value::Quoted), ok);
480+ }
481+ let parts = syntax::split_list(trimmed);
482+ if parts.len() > 1 {
483+ // Each item is a value of its own; the list prints as written
484+ let mut items = Vec::new();
485+ let mut written = String::new();
486+ let mut ok = true;
487+ let mut end = 0;
488+ for part in parts {
489+ let item = &trimmed[part.clone()];
490+ let lead = item.len() - item.trim_start().len();
491+ written.push_str(&trimmed[end..part.start + lead]);
492+ end = part.start + lead + item.trim().len();
493+ if item.trim().is_empty() {
494+ continue;
495+ }
496+ let at = column.map(|c| c + part.start + lead);
497+ let (value, text, filled) = self.item_value(item.trim(), line, at);
498+ ok &= filled;
499+ written.push_str(&text);
500+ items.push(value);
501+ }
502+ written.push_str(&trimmed[end..]);
503+ let list = value::List {
504+ items: Rc::new(items),
505+ written: Some(written.into()),
506+ };
507+ return (Value::List(list), ok);
508+ }
509+ let (text, ok) = self.fill(trimmed, line, column, Sink::Text);
510+ match value::written_range(&text) {
511+ Some(Ok(range)) => (range, ok),
512+ Some(Err(message)) => {
513+ self.report(
514+ interp::Problem::Invalid { message, offset: 0 },
515+ line,
516+ column,
517+ );
518+ (Value::list(Vec::new()), false)
519+ }
520+ None => (Value::Str(text), ok),
521+ }
522+ }
523+
524+ /// An item of a list written in the source (see
525+ /// [`slot_value`](Self::slot_value)), and how it is written in the
526+ /// list's text.
527+ fn item_value(
528+ &mut self,
529+ item: &str,
530+ line: usize,
531+ column: Option<usize>,
532+ ) -> (Value, String, bool) {
533+ let (value, ok) = match self.whole_value(item, line, column) {
534+ Some(value) => value,
535+ None if syntax::quoted_string(item).is_some() => {
536+ let (text, quoted, ok) = self.fill_value(item, line, column, Sink::Text);
537+ (quoted.map_or(Value::Str(text), Value::Quoted), ok)
538+ }
539+ None => {
540+ let (text, ok) = self.fill(item, line, column, Sink::Text);
541+ (Value::Str(text), ok)
542+ }
543+ };
544+ // Quoted text keeps its quotes in the list's text, as written
545+ let text = value
546+ .quoted_css()
547+ .map_or_else(|| value.to_string(), str::to_string);
548+ (value, text, ok)
549+ }
550+
551+ /// The value of a slot that is exactly one `$name` or `${...}`, with its
552+ /// type; `None` when it is anything else.
553+ fn whole_value(
554+ &mut self,
555+ raw: &str,
556+ line: usize,
557+ column: Option<usize>,
558+ ) -> Option<(Value, bool)> {
559+ let after = raw.strip_prefix('$')?;
560+ let (reference, len) = interp::reference(after, &self.env)?;
561+ if len != after.len() {
562+ return None;
563+ }
564+ track_var_refs(raw, &mut self.used_variables);
565+ let problem = match reference {
566+ interp::Reference::Var(path) => match interp::resolve(&path, &self.env) {
567+ Some(value) => return Some((value, true)),
568+ None => interp::Problem::Undefined {
569+ name: path,
570+ offset: 0,
571+ },
572+ },
573+ interp::Reference::Expr(source) => match crate::expr::eval(source, &self.env) {
574+ Ok(value) => return Some((value, true)),
575+ Err(crate::expr::Error::Invalid(message)) => {
576+ interp::Problem::Invalid { message, offset: 0 }
577+ }
578+ Err(error) => error.at(2),
579+ },
580+ };
581+ self.report(problem, line, column);
582+ Some((Value::Str(raw.to_string()), false))
583+ }
584+
585+ /// Report a variable that can't be filled in, or an invalid `${...}`,
586+ /// at `offset` from `column`.
587+ fn report(&mut self, problem: interp::Problem, line: usize, column: Option<usize>) {
588+ let (line_text, column) = match &self.current_source {
589+ // The column is only shown with the line it points into
590+ (current, Some(text)) if *current == line => (Some(text.clone()), column),
591+ _ => (None, None),
592+ };
593+ let diagnostic = match problem {
594+ interp::Problem::Undefined { name, offset } => {
595+ let column = column.map(|c| c + offset);
596+ let mut diagnostic = self.undefined(&name, line);
597+ if let Some(column) = column {
598+ diagnostic = diagnostic.column(column);
599+ }
600+ diagnostic
601+ }
602+ interp::Problem::Invalid { message, offset } => {
603+ let diagnostic = Diagnostic::error(
604+ code::INVALID_EXPRESSION,
605+ line,
606+ format!("invalid expression: {}", message),
607+ );
608+ match column {
609+ Some(column) => diagnostic.column(column + offset),
610+ None => diagnostic,
611+ }
612+ }
613+ interp::Problem::CustomProperty { name, offset } => {
614+ let diagnostic = Diagnostic::error(
615+ code::INVALID_VALUE,
616+ line,
617+ interp::custom_property_message(&name),
618+ )
619+ .subject(format!("${}", name))
620+ .suggest(Some(format!("var({})", name)));
621+ match column {
622+ Some(column) => diagnostic.column(column + offset),
623+ None => diagnostic,
624+ }
625+ }
626+ interp::Problem::Record { message, offset } => {
627+ let diagnostic = Diagnostic::error(code::INVALID_VALUE, line, message);
628+ match column {
629+ Some(column) => diagnostic.column(column + offset),
630+ None => diagnostic,
631+ }
632+ }
633+ };
634+ let diagnostic = match line_text {
635+ Some(text) => diagnostic.source(text),
636+ None => diagnostic,
637+ };
638+ self.push_once(diagnostic);
639+ }
640+
641+ /// Report a diagnostic unless the node being evaluated already did,
642+ /// so a line evaluated many times (in a loop, in a function) reports
643+ /// each problem once.
644+ fn push_once(&mut self, diagnostic: Diagnostic) {
645+ let key = (
646+ self.current_node,
647+ diagnostic.line,
648+ diagnostic.column,
649+ diagnostic.message.clone(),
650+ );
651+ if self.reported.insert(key) {
652+ self.diagnostics.push(diagnostic);
653+ }
654+ }
655+
656+ /// The error for `$name` with no definition: what the name is if it is
657+ /// something else, or the closest defined name.
658+ fn undefined(&mut self, name: &str, line: usize) -> Diagnostic {
659+ if self.env.bundle(name).is_some() {
660+ // Reported here, so not also as unused
661+ self.used_defines.insert(name.to_string());
662+ return Diagnostic::error(
663+ code::UNDEFINED_VARIABLE,
664+ line,
665+ format!(
666+ "'${}' is an attribute bundle, not a value: it goes in an attribute list \
667+ as a whole attribute, `[${}]`",
668+ name, name
669+ ),
670+ )
671+ .subject(name);
672+ }
673+ if self.env.function(name).is_some() {
674+ self.used_functions.insert(name.to_string());
675+ return Diagnostic::error(
676+ code::UNDEFINED_VARIABLE,
677+ line,
678+ format!(
679+ "'${}' is a function, not a value: it is called as an element, `@{}`",
680+ name, name
681+ ),
682+ )
683+ .subject(name);
684+ }
685+ // `$i-label` where `$i` is defined: a `-` joins a name
686+ if let Some((defined, rest)) = name
687+ .match_indices('-')
688+ .map(|(i, _)| (&name[..i], &name[i..]))
689+ .find(|(before, _)| self.env.value(before).is_some())
690+ {
691+ return Diagnostic::error(
692+ code::UNDEFINED_VARIABLE,
693+ line,
694+ format!(
695+ "undefined variable '${}': a `-` is part of a name. For '${}' followed \
696+ by '{}', write `${{{}}}{}`",
697+ name, defined, rest, defined, rest
698+ ),
699+ )
700+ .subject(name);
701+ }
702+ let suggestion = suggest_var_name(name, &self.env.value_names());
703+ let message = match (&suggestion, self.let_lines.get(name)) {
704+ (Some(closest), _) => format!(
705+ "undefined variable '${}', did you mean '${}'?",
706+ name, closest
707+ ),
708+ // Defined, but not where this line can see it
709+ (None, Some(_)) => format!(
710+ "undefined variable '${}': a `@let` defines it, but not where this line \
711+ can see it. A definition is visible from its line to the end of its \
712+ block, and a function's body sees what is defined above the function",
713+ name
714+ ),
715+ (None, None) => format!("undefined variable '${}'", name),
716+ };
717+ Diagnostic::error(code::UNDEFINED_VARIABLE, line, message)
718+ .subject(name)
719+ .suggest(suggestion)
720+ }
721+
722+ /// Note the node being evaluated, for diagnostics.
723+ fn enter(&mut self, node: &syntax::Node) {
724+ self.current_line = node.span.line;
725+ self.current_node = node.id;
726+ let text =
727+ (node.line_count <= 1).then(|| format!("{}{}", " ".repeat(node.indent), node.source));
728+ self.current_source = (node.span.line, text);
729+ }
730+
731+ /// Parse a file's text into a tree whose ids don't clash with the
732+ /// trees parsed before it.
733+ fn parse_tree(&mut self, text: &str) -> Rc<Tree> {
734+ let tree = syntax::parse_from(text, self.next_id);
735+ self.next_id = tree.end_id;
736+ Rc::new(tree)
737+ }
738+
739+ /// Read a file (once), relative to the current file.
740+ fn read_file(&mut self, resolved: &Path) -> std::io::Result<String> {
741+ if let Some(cached) = self.file_cache.get(resolved) {
742+ return Ok(cached.clone());
743+ }
744+ let text = std::fs::read_to_string(resolved)?;
745+ self.file_cache.insert(resolved.to_path_buf(), text.clone());
746+ Ok(text)
747+ }
748+
749+ fn resolve(&self, filename: &str) -> PathBuf {
750+ match &self.base_path {
751+ Some(base) => base.join(filename),
752+ None => PathBuf::from(filename),
753+ }
754+ }
755+}
756+
757+/// The standard library (`std.hl`): components and bundles defined in
758+/// htmlang itself and available in every file.
759+const PRELUDE: &str = include_str!("std.hl");
760+
761+fn load_prelude(ctx: &mut ParseContext) {
762+ // The library's definitions are in a block of their own, around the
763+ // file's, so the file's own `@let` of the same name hides them
764+ ctx.env.push();
765+ let tree = ctx.parse_tree(PRELUDE);
766+ collect_namespace(&tree.nodes, None, &mut HashSet::new(), ctx);
767+ ctx.current_file = Some("std.hl".to_string());
768+ let _ = Evaluator.eval_block(&tree.nodes, ctx);
769+ ctx.current_file = None;
770+ // Library definitions aren't the file's own: never report them unused.
771+ ctx.fn_lines.clear();
772+ ctx.define_lines.clear();
773+ ctx.let_lines.clear();
774+ ctx.env.push();
775+}
776+
777+pub fn parse(input: &str) -> ParseResult {
778+ parse_with_base(input, None)
779+}
780+
781+pub fn parse_with_base(input: &str, base_path: Option<&Path>) -> ParseResult {
782+ let mut ctx = ParseContext {
783+ current_line: 0,
784+ page: None,
785+ page_at: None,
786+ meta_tags: Vec::new(),
787+ head_blocks: Vec::new(),
788+ head_at: None,
789+ env: Env::default(),
790+ defined_functions: HashMap::new(),
791+ css_vars: Vec::new(),
792+ custom_css: Vec::new(),
793+ scoped_css: Vec::new(),
794+ og_tags: Vec::new(),
795+ diagnostics: Vec::new(),
796+ base_path: base_path.map(|p| p.to_path_buf()),
797+ included_files: Vec::new(),
798+ include_stack: Vec::new(),
799+ fn_call_stack: Vec::new(),
800+ file_cache: HashMap::new(),
801+ used_variables: HashSet::new(),
802+ used_functions: HashSet::new(),
803+ used_defines: HashSet::new(),
804+ let_lines: HashMap::new(),
805+ fn_lines: HashMap::new(),
806+ define_lines: HashMap::new(),
807+ visited: HashSet::new(),
808+ next_id: 0,
809+ trees: Vec::new(),
810+ included_by: Rc::default(),
811+ namespace: HashSet::new(),
812+ current_source: (0, None),
813+ reported: HashSet::new(),
814+ current_node: 0,
815+ current_file: None,
816+ too_deep: false,
817+ in_bundle: false,
818+ in_page: false,
819+ };
820+ load_prelude(&mut ctx);
821+ let tree = ctx.parse_tree(input);
822+ ctx.diagnostics.extend(tree.diagnostics.iter().cloned());
823+ ctx.trees.push((tree.clone(), None));
824+ collect_namespace(
825+ &tree.nodes,
826+ base_path.map(Path::to_path_buf),
827+ &mut HashSet::new(),
828+ &mut ctx,
829+ );
830+ let nodes = Evaluator.eval_block(&tree.nodes, &mut ctx);
831+ check_unevaluated(&mut ctx);
832+ check_slot_places(&mut ctx);
833+ validate_tree(&nodes, None, false, &mut ctx.diagnostics);
834+ // A library's definitions are for the files that include it
835+ let library = is_library_file(&tree, base_path, &mut ctx, &mut Vec::new());
836+ let exported: HashSet<String> = if library {
837+ tree.nodes
838+ .iter()
839+ .filter_map(|node| match node.directive().map(|d| &d.args) {
840+ Some(DirectiveArgs::Let(def)) => Some(def.name.clone()),
841+ _ => None,
842+ })
843+ .collect()
844+ } else {
845+ HashSet::new()
846+ };
847+ check_unused(&mut ctx, &exported);
848+ if let (None, Some(line)) = (&ctx.page, ctx.head_at)
849+ && !library
850+ {
851+ ctx.diagnostics.push(Diagnostic::warning(
852+ code::NO_EFFECT,
853+ line,
854+ "a file without @page is a fragment, which has no <head>: @meta and @head are \
855+ left out of it (give the file a @page, or put them in the page that includes it)"
856+ .to_string(),
857+ ));
858+ }
859+ dedupe(&mut ctx.diagnostics);
860+ // What the file itself defines at its top level
861+ let file = ctx.env.frames.last().cloned().unwrap_or_default();
862+ let mut variables = HashMap::new();
863+ let mut defines = HashMap::new();
864+ for (name, binding) in file.iter() {
865+ match binding {
866+ Binding::Value(value) => {
867+ variables.insert(name.clone(), value.to_string());
868+ }
869+ Binding::Bundle(attrs) => {
870+ defines.insert(name.clone(), attrs.to_vec());
871+ }
872+ Binding::Function(_) => {}
873+ }
874+ }
875+ ParseResult {
876+ document: Document {
877+ page: ctx.page,
878+ meta_tags: ctx.meta_tags,
879+ head_blocks: ctx.head_blocks,
880+ variables,
881+ defines,
882+ css_vars: ctx.css_vars,
883+ custom_css: ctx.custom_css,
884+ scoped_css: ctx.scoped_css,
885+ og_tags: ctx.og_tags,
886+ nodes,
887+ },
888+ diagnostics: ctx.diagnostics,
889+ included_files: ctx.included_files,
890+ }
891+}
892+
893+// ---------------------------------------------------------------------------
894+// Code that never runs: an untaken branch, an uncalled function, a loop over
895+// an empty list
896+// ---------------------------------------------------------------------------
897+
898+/// Collect the functions defined anywhere in `nodes` and in the files they
899+/// include (by a literal path), into `ctx.namespace`.
900+fn collect_namespace(
901+ nodes: &[syntax::Node],
902+ base: Option<PathBuf>,
903+ seen: &mut HashSet<PathBuf>,
904+ ctx: &mut ParseContext,
905+) {
906+ let mut includes = Vec::new();
907+ for node in nodes {
908+ node.walk(&mut |node| match node.directive().map(|d| &d.args) {
909+ Some(DirectiveArgs::Let(def)) if matches!(def.form, LetForm::Function(_)) => {
910+ ctx.namespace.insert(def.name.clone());
911+ }
912+ Some(DirectiveArgs::Text(Some(path))) if node.is_directive("include") => {
913+ includes.push(path.raw.clone());
914+ }
915+ _ => {}
916+ });
917+ }
918+ for path in includes {
919+ let path = path.trim_matches('"');
920+ if path.contains('$') {
921+ continue;
922+ }
923+ let resolved = match &base {
924+ Some(base) => base.join(path),
925+ None => PathBuf::from(path),
926+ };
927+ if !seen.insert(resolved.clone()) {
928+ continue;
929+ }
930+ let Ok(text) = ctx.read_file(&resolved) else {
931+ continue;
932+ };
933+ let tree = syntax::parse(&text);
934+ let parent = resolved.parent().map(Path::to_path_buf);
935+ collect_namespace(&tree.nodes, parent, seen, ctx);
936+ }
937+}
938+
939+/// Check the lines that were never evaluated: element and function names,
940+/// and the attributes of built-in elements (those that don't depend on a
941+/// variable). Names that come from data are only checked when evaluated.
942+fn check_unevaluated(ctx: &mut ParseContext) {
943+ let trees = std::mem::take(&mut ctx.trees);
944+ let mut seen = HashSet::new();
945+ for (tree, chain) in &trees {
946+ let before = ctx.diagnostics.len();
947+ for node in &tree.nodes {
948+ check_unevaluated_node(node, ctx);
949+ }
950+ let mut found = ctx.diagnostics.split_off(before);
951+ if let Some(chain) = chain {
952+ for d in &mut found {
953+ d.message = format!("{}\n in {}", d.message, chain);
954+ }
955+ }
956+ // A file included twice is checked twice: report each problem once
957+ found.retain(|d| seen.insert((d.line, d.message.clone())));
958+ ctx.diagnostics.extend(found);
959+ }
960+ ctx.trees = trees;
961+}
962+
963+fn check_unevaluated_node(node: &syntax::Node, ctx: &mut ParseContext) {
964+ if !ctx.visited.contains(&node.id) {
965+ let line = node.span.line;
966+ // A reference from code that doesn't run still counts as a use
967+ track_var_refs(&node.source, &mut ctx.used_variables);
968+ let before = ctx.diagnostics.len();
969+ match &node.kind {
970+ NodeKind::Element(element) => {
971+ for head in &element.chain {
972+ check_head(head, line, ctx);
973+ }
974+ check_unevaluated_content(node, element, ctx);
975+ if let Some(text) = &element.text {
976+ check_inline_heads(text, line, ctx);
977+ }
978+ }
979+ NodeKind::Text(text) => check_inline_heads(text, line, ctx),
980+ // `@page`'s attributes are checked like an element's (a layout's
981+ // `@page` is in a function that may not run in this file)
982+ NodeKind::Directive(syntax::Directive {
983+ args:
984+ DirectiveArgs::Page {
985+ attrs: Some(list), ..
986+ },
987+ ..
988+ }) => {
989+ let words: Vec<String> = crate::vocab::PAGE_WORDS
990+ .iter()
991+ .map(|w| w.to_string())
992+ .collect();
993+ ctx.in_page = true;
994+ check_attrs(&list.attrs, line, ctx, &words);
995+ ctx.in_page = false;
996+ check_page_tokens(&list.attrs, line, ctx);
997+ }
998+ _ => {}
999+ }
1000+ let text = written_line(node);
1001+ for d in &mut ctx.diagnostics[before..] {
1002+ d.source_line.get_or_insert_with(|| text.as_str().into());
1003+ }
1004+ }
1005+ for child in &node.children {
1006+ check_unevaluated_node(child, ctx);
1007+ }
1008+}
1009+
1010+/// Check the content passed to the calls of a line that was never
1011+/// evaluated: its `@slot NAME` blocks, and, for a function without
1012+/// `@children`, any other content.
1013+fn check_unevaluated_content(
1014+ node: &syntax::Node,
1015+ element: &syntax::ElementLine,
1016+ ctx: &mut ParseContext,
1017+) {
1018+ let calls: Vec<Option<(String, Rc<FnDef>)>> = element
1019+ .chain
1020+ .iter()
1021+ .map(|head| {
1022+ let function = ctx.defined_functions.get(&head.name)?;
1023+ Some((head.name.clone(), function.clone()))
1024+ })
1025+ .collect();
1026+ check_fillers(node, element, &calls, ctx);
1027+ let last = calls.len() - 1;
1028+ for (i, call) in calls.iter().enumerate() {
1029+ let Some((name, function)) = call else {
1030+ continue;
1031+ };
1032+ if function.has_children || function.wraps_itself {
1033+ continue;
1034+ }
1035+ let content = if i == last {
1036+ element.text.is_some() || holds_content(&node.children, ctx)
1037+ } else {
1038+ element.chain[i + 1].name != "slot" || !slot_is_built_in(ctx)
1039+ };
1040+ if content {
1041+ let head = &element.chain[i];
1042+ ctx.push_once(no_children(
1043+ name,
1044+ node.span.line,
1045+ name_column(head, node.span.line),
1046+ ));
1047+ }
1048+ }
1049+}
1050+
1051+/// Check a head that was never evaluated: its name, and its attributes
1052+/// (for a call, see [`check_call`]).
1053+fn check_head(head: &syntax::Head, line: usize, ctx: &mut ParseContext) {
1054+ let is_function =
1055+ ctx.namespace.contains(&head.name) || ctx.defined_functions.contains_key(&head.name);
1056+ if is_function {
1057+ ctx.used_functions.insert(head.name.clone());
1058+ if let Some(function) = ctx.defined_functions.get(&head.name).cloned()
1059+ && !function.wraps_itself
1060+ {
1061+ check_call(head, &function, line, ctx);
1062+ }
1063+ return;
1064+ }
1065+ let kind = match parse_element_kind(&head.name, line, ctx) {
1066+ Ok(kind) => kind,
1067+ Err(e) => {
1068+ ctx.diagnostics.push(e);
1069+ return;
1070+ }
1071+ };
1072+ if let Some(list) = &head.attrs {
1073+ check_attrs(&list.attrs, line, ctx, &[]);
1074+ // A word for laying out children on an element that doesn't lay
1075+ // them out, as where the code runs (see `validate_tree`)
1076+ if !kind.layout().is_container() && !has_no_element(&kind) {
1077+ for attr in &list.attrs {
1078+ let base = crate::vocab::base_attribute(&attr.key);
1079+ if !attr.html
1080+ && attr.choice.is_none()
1081+ && attr.prefixed.is_none()
1082+ && crate::vocab::CONTAINER_ATTRIBUTES.contains(&base)
1083+ && !crate::vocab::split_prefixes(&attr.key)
1084+ .0
1085+ .contains(&"children:")
1086+ {
1087+ ctx.push_once(not_a_container(&kind, line, base).column(attr.span.column));
1088+ }
1089+ }
1090+ }
1091+ }
1092+}
1093+
1094+/// The attributes of a list that is never evaluated that can be checked
1095+/// together: not bundles or `if()`s. Names are checked; a value with a
1096+/// variable in it depends on what the variable holds, so only a literal
1097+/// value is (the other is checked as an empty value).
1098+/// `@page`'s own rules (see `check_page_attr`) for a list that isn't
1099+/// evaluated, as written: a value made from a variable counts as given.
1100+fn check_page_tokens(tokens: &[syntax::Attr], line: usize, ctx: &mut ParseContext) {
1101+ for token in tokens {
1102+ match &token.choice {
1103+ Some(choice) => {
1104+ for branch in &choice.branches {
1105+ check_page_tokens(branch.attrs(), line, ctx);
1106+ }
1107+ }
1108+ // Under prefixes there are only styles
1109+ None if token.key.starts_with('$') || token.prefixed.is_some() => {}
1110+ None => {
1111+ let value = token.value.as_deref().map(|v| v.trim_matches('"'));
1112+ let value = match value {
1113+ Some(v) if v.contains('$') => Some("$"),
1114+ other => other,
1115+ };
1116+ check_page_attr(
1117+ &token.key,
1118+ token.html,
1119+ value,
1120+ line,
1121+ Some(token.span.column),
1122+ ctx,
1123+ );
1124+ }
1125+ }
1126+ }
1127+}
1128+
1129+fn literal_attrs(tokens: &[syntax::Attr]) -> Vec<syntax::Attr> {
1130+ // A prefixed group is checked with its prefixes, as far as its own
1131+ // attributes can be; a prefixed bundle or `if()` depends on what it holds
1132+ let group = |a: &syntax::Attr| {
1133+ let prefixed = a.prefixed.as_ref()?;
1134+ let syntax::Branch::Group { list, trailing } = &prefixed.target else {
1135+ return None;
1136+ };
1137+ let mut list = list.clone();
1138+ list.attrs = literal_attrs(&list.attrs);
1139+ let mut a = a.clone();
1140+ a.prefixed = Some(Box::new(syntax::Prefixed {
1141+ target: syntax::Branch::Group {
1142+ list,
1143+ trailing: trailing.clone(),
1144+ },
1145+ ..(**prefixed).clone()
1146+ }));
1147+ Some(a)
1148+ };
1149+ let groups = tokens.iter().filter_map(group);
1150+ tokens
1151+ .iter()
1152+ .filter(|a| {
1153+ let bundle = a.key.starts_with('$') && a.value.is_none() && !a.html;
1154+ a.choice.is_none() && a.prefixed.is_none() && !bundle
1155+ })
1156+ .map(|a| {
1157+ let mut a = a.clone();
1158+ let variable = |v: &String| v.contains('$');
1159+ if !a.key.contains('$') && a.value.as_ref().is_some_and(variable) {
1160+ a.value = Some(String::new());
1161+ a.raw = format!("{} ", a.key);
1162+ }
1163+ a
1164+ })
1165+ .chain(groups)
1166+ .collect()
1167+}
1168+
1169+/// Check a call that was never evaluated: how it passes its parameters
1170+/// (none written `name=value`, and every one without a default passed,
1171+/// when no bundle or `if()` could pass it), and its other attributes, like
1172+/// those of an element.
1173+fn check_call(head: &syntax::Head, function: &FnDef, line: usize, ctx: &mut ParseContext) {
1174+ let name = head.name.as_str();
1175+ let attrs = head.attrs.as_ref().map_or(&[][..], |list| &list.attrs[..]);
1176+ written_parameter_forms(name, function, attrs, line, ctx);
1177+ if let Some(list) = &head.attrs {
1178+ let params: Vec<String> = function.params.iter().map(|p| p.name.clone()).collect();
1179+ check_attrs(&list.attrs, line, ctx, &params);
1180+ }
1181+ let unknown = attrs
1182+ .iter()
1183+ .any(|a| a.choice.is_some() || (a.key.starts_with('$') && a.value.is_none()));
1184+ if unknown {
1185+ return;
1186+ }
1187+ for param in function.params.iter().filter(|p| p.default.is_none()) {
1188+ if !attrs.iter().any(|a| a.key == param.name) {
1189+ let column = name_column(head, line);
1190+ ctx.push_once(missing_parameter(name, &param.name, line, column));
1191+ }
1192+ }
1193+}
1194+
1195+/// Report each parameter a call's list writes `name=value`, with the value
1196+/// as written and its column; returns their names, so the evaluated call
1197+/// doesn't report them again.
1198+fn written_parameter_forms(
1199+ name: &str,
1200+ function: &FnDef,
1201+ attrs: &[syntax::Attr],
1202+ line: usize,
1203+ ctx: &mut ParseContext,
1204+) -> Vec<String> {
1205+ let mut reported = Vec::new();
1206+ for attr in attrs {
1207+ if !(attr.html && function.is_param(&attr.key)) {
1208+ continue;
1209+ }
1210+ let at = if attr.span.line == 0 {
1211+ line
1212+ } else {
1213+ attr.span.line
1214+ };
1215+ let value = attr.value.as_deref().unwrap_or("");
1216+ let diagnostic = parameter_form(name, &attr.key, value, at).column(attr.span.column);
1217+ ctx.push_once(match &ctx.current_source {
1218+ (current, Some(text)) if *current == at => diagnostic.source(text.clone()),
1219+ _ => diagnostic,
1220+ });
1221+ reported.push(attr.key.clone());
1222+ }
1223+ reported
1224+}
1225+
1226+fn check_inline_heads(text: &syntax::Text, line: usize, ctx: &mut ParseContext) {
1227+ for segment in &text.segments {
1228+ if let Segment::Inline(inline) = segment {
1229+ check_head(&inline.head, line, ctx);
1230+ if let Some(text) = &inline.text {
1231+ check_inline_heads(text, line, ctx);
1232+ }
1233+ }
1234+ }
1235+}
1236+
1237+// ---------------------------------------------------------------------------
1238+// Evaluation
1239+// ---------------------------------------------------------------------------
1240+
1241+/// The `@else` lines that continue the `@if` or `@each` before `from`, and
1242+/// the position after them.
1243+fn else_branches(block: &[syntax::Node], from: usize, is_if: bool) -> (Vec<&syntax::Node>, usize) {
1244+ let mut branches = Vec::new();
1245+ let mut next = from;
1246+ let mut i = from;
1247+ while i < block.len() {
1248+ let node = &block[i];
1249+ i += 1;
1250+ if node.is_trivia() {
1251+ continue;
1252+ }
1253+ let condition = match node.directive().map(|d| &d.args) {
1254+ Some(DirectiveArgs::Else { condition }) => condition.is_some(),
1255+ _ => break,
1256+ };
1257+ if condition && !is_if {
1258+ break;
1259+ }
1260+ branches.push(node);
1261+ next = i;
1262+ if !condition {
1263+ break;
1264+ }
1265+ }
1266+ (branches, next)
1267+}
1268+
1269+impl Evaluator {
1270+ fn eval_block(&mut self, block: &[syntax::Node], ctx: &mut ParseContext) -> Vec<Node> {
1271+ let mut nodes = Vec::new();
1272+ let mut i = 0;
1273+ while i < block.len() {
1274+ let node = &block[i];
1275+ i += 1;
1276+ if node.is_trivia() {
1277+ continue;
1278+ }
1279+ let result = match node.directive().map(|d| d.name()) {
1280+ Some(name @ ("if" | "each")) => {
1281+ let (branches, next) = else_branches(block, i, name == "if");
1282+ i = next;
1283+ if name == "if" {
1284+ Ok(Some(self.eval_if(node, &branches, ctx)))
1285+ } else {
1286+ self.eval_each(node, branches.first().copied(), ctx)
1287+ }
1288+ }
1289+ // Reported as a syntax error
1290+ Some("else") => {
1291+ ctx.visited.insert(node.id);
1292+ Ok(None)
1293+ }
1294+ _ => self.eval(node, ctx),
1295+ };
1296+ match result {
1297+ Ok(Some(new_nodes)) => nodes.extend(new_nodes),
1298+ Ok(None) => {}
1299+ // Record the error and go on, to report several in one pass
1300+ Err(mut e) => {
1301+ e.source_line
1302+ .get_or_insert_with(|| node.source.as_str().into());
1303+ ctx.diagnostics.push(e);
1304+ }
1305+ }
1306+ }
1307+ nodes
1308+ }
1309+
1310+ /// Evaluate a block in its own scope: what it defines is visible to
1311+ /// the end of the block, and not after it.
1312+ fn eval_scoped(&mut self, block: &[syntax::Node], ctx: &mut ParseContext) -> Vec<Node> {
1313+ ctx.env.push();
1314+ let nodes = self.eval_block(block, ctx);
1315+ ctx.env.pop();
1316+ nodes
1317+ }
1318+
1319+ /// `@if` with its `@else if` / `@else` branches. Every condition is
1320+ /// checked (and its errors reported); the first that holds picks the
1321+ /// branch.
1322+ fn eval_if(
1323+ &mut self,
1324+ node: &syntax::Node,
1325+ branches: &[&syntax::Node],
1326+ ctx: &mut ParseContext,
1327+ ) -> Vec<Node> {
1328+ let mut chosen = None;
1329+ for branch in std::iter::once(node).chain(branches.iter().copied()) {
1330+ ctx.visited.insert(branch.id);
1331+ ctx.enter(branch);
1332+ let holds = match branch.directive().map(|d| &d.args) {
1333+ Some(DirectiveArgs::Condition(condition))
1334+ | Some(DirectiveArgs::Else {
1335+ condition: Some(condition),
1336+ }) => {
1337+ !condition.raw.is_empty()
1338+ && ctx.condition(
1339+ &condition.raw,
1340+ branch.span.line,
1341+ Some(condition.span.column),
1342+ )
1343+ }
1344+ Some(DirectiveArgs::Else { condition: None }) => true,
1345+ // A syntax error, already reported
1346+ _ => false,
1347+ };
1348+ if holds && chosen.is_none() {
1349+ chosen = Some(&branch.children);
1350+ }
1351+ }
1352+ chosen.map_or_else(Vec::new, |body| self.eval_scoped(body, ctx))
1353+ }
1354+
1355+ fn eval(
1356+ &mut self,
1357+ node: &syntax::Node,
1358+ ctx: &mut ParseContext,
1359+ ) -> Result<Option<Vec<Node>>, ParseError> {
1360+ ctx.visited.insert(node.id);
1361+ ctx.enter(node);
1362+ match &node.kind {
1363+ NodeKind::Blank | NodeKind::Comment => Ok(None),
1364+ // `@code` and `@textarea` show their body as text; `@script`'s
1365+ // goes into the page as it is
1366+ NodeKind::Verbatim(body) if body.escaped => {
1367+ let text = body.text.trim_matches('\n').to_string();
1368+ Ok(Some(vec![Node::Text(vec![TextSegment::Plain(text)])]))
1369+ }
1370+ NodeKind::Verbatim(body) => Ok(Some(vec![Node::Raw(body.text.clone())])),
1371+ NodeKind::Directive(directive) => {
1372+ let mut nodes = self.eval_directive(node, directive, ctx)?;
1373+ // A directive that takes no body: the lines indented under
1374+ // it (a syntax error) are evaluated as its siblings. A
1375+ // @let's body belongs to it even under a value (also an
1376+ // error), so it is never evaluated in place.
1377+ let takes_body = directive.spec.body != BodyKind::None;
1378+ if !takes_body {
1379+ let siblings = self.eval_block(&node.children, ctx);
1380+ nodes.get_or_insert_with(Vec::new).extend(siblings);
1381+ }
1382+ Ok(nodes)
1383+ }
1384+ NodeKind::Element(element) => self.eval_element(node, element, ctx).map(Some),
1385+ NodeKind::Text(text) => {
1386+ let mut nodes = vec![Node::Text(text_segments(text, ctx))];
1387+ // Text takes no body: lines indented under it are its
1388+ // siblings
1389+ nodes.extend(self.eval_block(&node.children, ctx));
1390+ Ok(Some(nodes))
1391+ }
1392+ }
1393+ }
1394+
1395+ fn eval_directive(
1396+ &mut self,
1397+ node: &syntax::Node,
1398+ directive: &syntax::Directive,
1399+ ctx: &mut ParseContext,
1400+ ) -> Result<Option<Vec<Node>>, ParseError> {
1401+ let line_num = node.span.line;
1402+ let content = &node.source;
1403+ match (directive.name(), &directive.args) {
1404+ // @page [lang=en, favicon /f.png, background #f8fafc] Title
1405+ ("page", DirectiveArgs::Page { attrs, title }) => {
1406+ let page = read_page(attrs.as_ref(), title.as_ref(), line_num, ctx);
1407+ // A page has one root: a second `@page` (a layout called
1408+ // twice, or one called after the page's own) is an error
1409+ let here = match &ctx.current_file {
1410+ Some(file) => format!("line {} of {}", line_num, file),
1411+ None => format!("line {}", line_num),
1412+ };
1413+ if let Some(first) = &ctx.page_at {
1414+ let again = if *first == here {
1415+ "this @page runs a second time (in a loop, or in a function called \
1416+ twice)"
1417+ .to_string()
1418+ } else {
1419+ format!("a second @page (this page already has one, on {})", first)
1420+ };
1421+ let diagnostic = Diagnostic::error(
1422+ code::DUPLICATE_PAGE,
1423+ line_num,
1424+ format!(
1425+ "{}: a page has one @page, the root element that styles its <body>",
1426+ again
1427+ ),
1428+ )
1429+ .source(content.clone())
1430+ .subject("@page");
1431+ ctx.diagnostics.push(diagnostic);
1432+ } else {
1433+ ctx.page_at = Some(here);
1434+ ctx.page = Some(page);
1435+ }
1436+ Ok(None)
1437+ }
1438+
1439+ ("let", DirectiveArgs::Let(def)) => {
1440+ let name = def.name.as_str();
1441+ // Values, bundles and functions share one namespace: a
1442+ // definition replaces whatever the name meant in its block
1443+ match &def.form {
1444+ LetForm::Function(function) => {
1445+ self.define_function(name, &function.params, node, ctx);
1446+ }
1447+ // `@let name = EXPR` computes its value (see expr.rs)
1448+ LetForm::Computed(expression) => {
1449+ let value = ctx
1450+ .eval(&expression.raw, line_num, Some(expression.span.column))
1451+ .unwrap_or_else(Value::empty);
1452+ set_variable(name, value, line_num, ctx);
1453+ }
1454+ // Attribute bundle: @let name [attr1, attr2, ...]
1455+ LetForm::Bundle(list) => {
1456+ ctx.in_bundle = true;
1457+ let attrs = parse_attr_list(&list.attrs, line_num, ctx, true, &[]);
1458+ ctx.in_bundle = false;
1459+ ctx.env.define(name, Binding::Bundle(Rc::new(attrs)));
1460+ ctx.define_lines.entry(name.to_string()).or_insert(line_num);
1461+ }
1462+ // `@let size 16px`, `@let fruits apple, banana`,
1463+ // `@let post $posts.0`: see `slot_value`
1464+ LetForm::Value(value) => {
1465+ let (value, _) =
1466+ ctx.slot_value(&value.raw, value.span.line, Some(value.span.column));
1467+ set_variable(name, value, line_num, ctx);
1468+ }
1469+ // Quoted text: `@let arrow "→ "`
1470+ LetForm::Quoted(value) => {
1471+ let raw = format!("\"{}\"", value.raw);
1472+ let column = value.span.column.saturating_sub(1);
1473+ let (text, quoted, _) =
1474+ ctx.fill_value(&raw, value.span.line, Some(column), Sink::Text);
1475+ let value = quoted.map_or(Value::Str(text), Value::Quoted);
1476+ set_variable(name, value, line_num, ctx);
1477+ }
1478+ }
1479+ Ok(None)
1480+ }
1481+
1482+ // @meta NAME VALUE; `og:` names become Open Graph property tags
1483+ ("meta", DirectiveArgs::Text(Some(arg))) => {
1484+ let Some((name, value)) = arg.raw.split_once(char::is_whitespace) else {
1485+ ctx.diagnostics.push(
1486+ Diagnostic::error(
1487+ code::MISSING_ARGUMENT,
1488+ line_num,
1489+ format!("@meta needs a name and a value: `@meta {} VALUE`", arg.raw),
1490+ )
1491+ .source(content.clone()),
1492+ );
1493+ return Ok(None);
1494+ };
1495+ let value_column = arg.span.column + arg.raw.len() - value.trim_start().len();
1496+ // An HTML attribute value: quoted text loses its quotes
1497+ let (value, _, _) =
1498+ ctx.fill_value(value.trim(), line_num, Some(value_column), Sink::Text);
1499+ // The same tag twice says nothing more (a layout called
1500+ // twice): it is written once
1501+ let (tags, tag) = match name.trim().strip_prefix("og:") {
1502+ Some(property) => (&mut ctx.og_tags, (property.to_string(), value)),
1503+ None => (&mut ctx.meta_tags, (name.trim().to_string(), value)),
1504+ };
1505+ if !tags.contains(&tag) {
1506+ tags.push(tag);
1507+ }
1508+ ctx.head_at.get_or_insert(line_num);
1509+ Ok(None)
1510+ }
1511+
1512+ ("head", _) => {
1513+ let text = verbatim_content(node);
1514+ if !text.trim().is_empty() {
1515+ ctx.head_blocks.push(text.trim().to_string());
1516+ ctx.head_at.get_or_insert(line_num);
1517+ }
1518+ Ok(None)
1519+ }
1520+
1521+ // @style: raw CSS
1522+ ("style", _) => {
1523+ let text = verbatim_content(node);
1524+ // Only the @style at the top of a function's body is
1525+ // scoped; anywhere else `&` is `:scope`, the whole page
1526+ if has_top_level_ampersand(&text) {
1527+ ctx.push_once(Diagnostic::warning(
1528+ code::INVALID_VALUE,
1529+ node.span.line,
1530+ "`&` in this @style is the whole page: only an @style at the top of a \
1531+ function's body is scoped to the function, with `&` its root element"
1532+ .to_string(),
1533+ ));
1534+ }
1535+ if !text.trim().is_empty() {
1536+ ctx.custom_css.push(text.trim().to_string());
1537+ }
1538+ Ok(None)
1539+ }
1540+
1541+ // @markdown: an indented block, or a file
1542+ ("markdown", DirectiveArgs::Text(file)) => {
1543+ let Some(file) = file else {
1544+ let md_lines: Vec<String> = verbatim_text(&node.children)
1545+ .lines()
1546+ .map(String::from)
1547+ .collect();
1548+ return Ok(Some(vec![Node::Raw(markdown_to_html(&md_lines))]));
1549+ };
1550+ let filename = ctx.interpolate_text(&file.raw, line_num, Some(file.span.column));
1551+ let resolved = ctx.resolve(&filename);
1552+ let md_text = match ctx.read_file(&resolved) {
1553+ Ok(text) => text,
1554+ Err(e) => {
1555+ ctx.diagnostics.push(
1556+ Diagnostic::error(
1557+ code::UNREADABLE_FILE,
1558+ line_num,
1559+ format!("cannot read markdown '{}': {}", filename, e),
1560+ )
1561+ .source(content.clone()),
1562+ );
1563+ return Ok(None);
1564+ }
1565+ };
1566+ ctx.included_files.push(resolved);
1567+ let md_lines: Vec<String> = md_text.lines().map(|l| l.to_string()).collect();
1568+ Ok(Some(vec![Node::Raw(markdown_to_html(&md_lines))]))
1569+ }
1570+
1571+ ("include", DirectiveArgs::Text(Some(path))) => {
1572+ self.eval_include(node.id, path, line_num, content, ctx)
1573+ }
1574+
1575+ ("data", DirectiveArgs::Data { name, source, .. }) => {
1576+ self.eval_data(name, source, line_num, content, ctx);
1577+ Ok(None)
1578+ }
1579+
1580+ // @raw: the rest of its line, or its indented body, verbatim
1581+ ("raw", _) => {
1582+ let text = verbatim_content(node);
1583+ let text = text.trim_end_matches('\n');
1584+ Ok((!text.is_empty()).then(|| vec![Node::Raw(text.to_string())]))
1585+ }
1586+
1587+ // A header with a syntax error (reported), or a directive
1588+ // without its argument
1589+ _ => Ok(None),
1590+ }
1591+ }
1592+
1593+ fn eval_include(
1594+ &mut self,
1595+ id: usize,
1596+ path: &syntax::Arg,
1597+ line_num: usize,
1598+ content: &str,
1599+ ctx: &mut ParseContext,
1600+ ) -> Result<Option<Vec<Node>>, ParseError> {
1601+ let (filename, column) = match path.raw.strip_prefix('"').and_then(|f| f.strip_suffix('"'))
1602+ {
1603+ Some(quoted) => (quoted, path.span.column + 1),
1604+ None => (path.raw.as_str(), path.span.column),
1605+ };
1606+ let filename = ctx.interpolate_text(filename, line_num, Some(column));
1607+ let resolved = ctx.resolve(&filename);
1608+
1609+ if ctx.include_stack.contains(&resolved) {
1610+ let cycle_chain = format_include_chain(&ctx.include_stack);
1611+ ctx.diagnostics.push(
1612+ Diagnostic::error(
1613+ code::CIRCULAR_INCLUDE,
1614+ line_num,
1615+ format!(
1616+ "circular include '{}' (cycle: {} → {})",
1617+ filename, cycle_chain, filename
1618+ ),
1619+ )
1620+ .source(content),
1621+ );
1622+ return Ok(None);
1623+ }
1624+
1625+ let imported_text = match ctx.read_file(&resolved) {
1626+ Ok(text) => text,
1627+ Err(e) => {
1628+ ctx.diagnostics.push(
1629+ Diagnostic::error(
1630+ code::UNREADABLE_FILE,
1631+ line_num,
1632+ format!("cannot include '{}': {}", filename, e),
1633+ )
1634+ .source(content),
1635+ );
1636+ return Ok(None);
1637+ }
1638+ };
1639+
1640+ ctx.included_files.push(resolved.clone());
1641+ ctx.include_stack.push(resolved.clone());
1642+ let saved_base = ctx.base_path.clone();
1643+ ctx.base_path = resolved.parent().map(|p| p.to_path_buf());
1644+
1645+ let diag_count_before = ctx.diagnostics.len();
1646+ let import_chain = format_include_chain(&ctx.include_stack);
1647+ let tree = ctx.parse_tree(&imported_text);
1648+ ctx.diagnostics.extend(tree.diagnostics.iter().cloned());
1649+ ctx.trees.push((tree.clone(), Some(import_chain.clone())));
1650+ let files = Rc::make_mut(&mut ctx.included_by).entry(id).or_default();
1651+ if !files.iter().any(|(_, chain)| *chain == import_chain) {
1652+ files.push((tree.clone(), import_chain.clone()));
1653+ }
1654+ let saved_file = ctx.current_file.replace(import_chain.clone());
1655+ let defined_before: HashSet<String> = ctx
1656+ .let_lines
1657+ .keys()
1658+ .chain(ctx.define_lines.keys())
1659+ .chain(ctx.fn_lines.keys())
1660+ .cloned()
1661+ .collect();
1662+ let included_nodes = self.eval_block(&tree.nodes, ctx);
1663+ ctx.current_file = saved_file;
1664+ // An included file's definitions aren't reported unused here, where
1665+ // their lines aren't this file's: a library's are there to be
1666+ // picked from, and any other file reports its own when checked
1667+ let keep = |name: &String, _: &mut usize| defined_before.contains(name);
1668+ ctx.let_lines.retain(keep);
1669+ ctx.define_lines.retain(keep);
1670+ ctx.fn_lines.retain(keep);
1671+
1672+ // Annotate new diagnostics with import chain
1673+ for d in &mut ctx.diagnostics[diag_count_before..] {
1674+ d.message = format!("{}\n in {}", d.message, import_chain);
1675+ }
1676+
1677+ ctx.base_path = saved_base;
1678+ ctx.include_stack.pop();
1679+ Ok(Some(included_nodes))
1680+ }
1681+
1682+ /// @data $name file.json values as $name.key
1683+ /// @data $name dir/*.json a list of the files' records
1684+ /// @data $name [...] / {...} inline JSON
1685+ /// @data $name env:NAME [DEFAULT] an environment variable
1686+ fn eval_data(
1687+ &mut self,
1688+ prefix: &str,
1689+ source: &syntax::Arg,
1690+ line_num: usize,
1691+ content: &str,
1692+ ctx: &mut ParseContext,
1693+ ) {
1694+ let prefix = prefix.to_string();
1695+ let filename = source.raw.as_str();
1696+ if let Some(env) = filename.strip_prefix("env:") {
1697+ let (var, default) = match env.split_once(char::is_whitespace) {
1698+ Some((var, default)) => (var, Some(default.trim())),
1699+ None => (env, None),
1700+ };
1701+ let default_column = default.map(|d| source.span.column + filename.len() - d.len());
1702+ let value = std::env::var(var)
1703+ .ok()
1704+ .or_else(|| default.map(|d| ctx.interpolate_text(d, line_num, default_column)));
1705+ if value.is_none() {
1706+ ctx.diagnostics.push(
1707+ Diagnostic::warning(
1708+ code::UNSET_ENVIRONMENT,
1709+ line_num,
1710+ format!(
1711+ "environment variable '{}' is not set and has no default",
1712+ var
1713+ ),
1714+ )
1715+ .source(content),
1716+ );
1717+ }
1718+ ctx.bind(&prefix, Value::Str(value.unwrap_or_default()));
1719+ return;
1720+ }
1721+
1722+ // Inline JSON: @data $links [{"label": "Home", "url": "/"}]
1723+ let (json_text, source) = if filename.starts_with(['[', '{']) {
1724+ (filename.to_string(), "the inline data".to_string())
1725+ } else {
1726+ let filename = ctx.interpolate_text(filename, line_num, Some(source.span.column));
1727+ if filename.contains('*') {
1728+ self.load_data_glob(&prefix, &filename, line_num, content, ctx);
1729+ return;
1730+ }
1731+ let resolved = ctx.resolve(&filename);
1732+ match std::fs::read_to_string(&resolved) {
1733+ Ok(text) => {
1734+ ctx.included_files.push(resolved);
1735+ (text, format!("'{}'", filename))
1736+ }
1737+ Err(e) => {
1738+ ctx.diagnostics.push(
1739+ Diagnostic::error(
1740+ code::UNREADABLE_FILE,
1741+ line_num,
1742+ format!("cannot load data '{}': {}", filename, e),
1743+ )
1744+ .source(content),
1745+ );
1746+ return;
1747+ }
1748+ }
1749+ };
1750+ match parse_json_with_error(&json_text) {
1751+ Ok(json) => ctx.bind(&prefix, json_value(json)),
1752+ Err(detail) => ctx.diagnostics.push(
1753+ Diagnostic::error(
1754+ code::INVALID_JSON,
1755+ line_num,
1756+ format!("invalid JSON in {}: {}", source, detail),
1757+ )
1758+ .source(content),
1759+ ),
1760+ }
1761+ }
1762+
1763+ /// `@data $name dir/*.json`: a list with one record per matching file
1764+ /// (in name order), whose `file` is the file's name without extension.
1765+ fn load_data_glob(
1766+ &mut self,
1767+ name: &str,
1768+ pattern: &str,
1769+ line_num: usize,
1770+ content: &str,
1771+ ctx: &mut ParseContext,
1772+ ) {
1773+ let base = ctx.base_path.clone().unwrap_or_else(|| PathBuf::from("."));
1774+ let pattern_path = Path::new(pattern);
1775+ let dir = match pattern_path.parent() {
1776+ Some(dir) if !dir.as_os_str().is_empty() => base.join(dir),
1777+ _ => base,
1778+ };
1779+ let file_pattern = pattern_path
1780+ .file_name()
1781+ .unwrap_or_default()
1782+ .to_string_lossy()
1783+ .to_string();
1784+ let mut files: Vec<PathBuf> = match std::fs::read_dir(&dir) {
1785+ Ok(entries) => entries
1786+ .flatten()
1787+ .map(|e| e.path())
1788+ .filter(|p| {
1789+ p.file_name()
1790+ .is_some_and(|n| glob_match(&file_pattern, &n.to_string_lossy()))
1791+ })
1792+ .collect(),
1793+ Err(e) => {
1794+ ctx.diagnostics.push(
1795+ Diagnostic::new(
1796+ code::UNREADABLE_FILE,
1797+ Severity::Error,
1798+ line_num,
1799+ format!("cannot read directory for '{}': {}", pattern, e),
1800+ )
1801+ .source(content.to_string()),
1802+ );
1803+ return;
1804+ }
1805+ };
1806+ files.sort();
1807+ let mut records = Vec::new();
1808+ for file in files {
1809+ let stem = file
1810+ .file_stem()
1811+ .unwrap_or_default()
1812+ .to_string_lossy()
1813+ .to_string();
1814+ let text = match std::fs::read_to_string(&file) {
1815+ Ok(text) => text,
1816+ Err(e) => {
1817+ ctx.diagnostics.push(
1818+ Diagnostic::new(
1819+ code::UNREADABLE_FILE,
1820+ Severity::Error,
1821+ line_num,
1822+ format!("cannot load data '{}': {}", file.display(), e),
1823+ )
1824+ .source(content.to_string()),
1825+ );
1826+ continue;
1827+ }
1828+ };
1829+ match parse_json_with_error(&text) {
1830+ Ok(JsonValue::Object(mut pairs)) => {
1831+ if !pairs.iter().any(|(key, _)| key == "file") {
1832+ pairs.push(("file".to_string(), JsonValue::Str(stem)));
1833+ }
1834+ records.push(JsonValue::Object(pairs));
1835+ }
1836+ Ok(_) => ctx.diagnostics.push(
1837+ Diagnostic::new(
1838+ code::INVALID_JSON,
1839+ Severity::Error,
1840+ line_num,
1841+ format!("'{}' should hold a JSON object", file.display()),
1842+ )
1843+ .source(content.to_string()),
1844+ ),
1845+ Err(detail) => ctx.diagnostics.push(
1846+ Diagnostic::new(
1847+ code::INVALID_JSON,
1848+ Severity::Error,
1849+ line_num,
1850+ format!("invalid JSON in '{}': {}", file.display(), detail),
1851+ )
1852+ .source(content.to_string()),
1853+ ),
1854+ }
1855+ ctx.included_files.push(file);
1856+ }
1857+ ctx.bind(name, json_value(JsonValue::Array(records)));
1858+ }
1859+
1860+ /// `@each $item in LIST` or `@each $item, $index in LIST`, with the
1861+ /// `@else` that follows it. LIST is a value (see
1862+ /// [`ParseContext::slot_value`]): a list written with commas, a range,
1863+ /// or one `$name` or `${...}` that holds a list. Each item is bound
1864+ /// whole to `$item`, and each iteration is a block of its own.
1865+ fn eval_each(
1866+ &mut self,
1867+ node: &syntax::Node,
1868+ empty_branch: Option<&syntax::Node>,
1869+ ctx: &mut ParseContext,
1870+ ) -> Result<Option<Vec<Node>>, ParseError> {
1871+ ctx.visited.insert(node.id);
1872+ if let Some(branch) = empty_branch {
1873+ ctx.visited.insert(branch.id);
1874+ }
1875+ ctx.enter(node);
1876+ // A malformed header is a syntax error, already reported
1877+ let Some(DirectiveArgs::Each(header)) = node.directive().map(|d| &d.args) else {
1878+ return Ok(None);
1879+ };
1880+ let body = &node.children;
1881+ let empty: &[syntax::Node] = empty_branch.map_or(&[], |b| &b.children);
1882+ let (item, index) = (header.item.as_str(), header.index.as_deref());
1883+ let list = &header.list;
1884+ // `[...]` is an attribute list or JSON elsewhere, not a list here
1885+ let bracketed = list.raw.starts_with('[') && list.raw.ends_with(']');
1886+ let (source, filled) = match bracketed {
1887+ true => (Value::empty(), false),
1888+ false => ctx.slot_value(&list.raw, list.span.line, Some(list.span.column)),
1889+ };
1890+ let not_a_list = |message: String, ctx: &ParseContext| {
1891+ let diagnostic = Diagnostic::error(code::INVALID_LOOP, list.span.line, message)
1892+ .column(list.span.column)
1893+ .subject(list.raw.as_str());
1894+ match &ctx.current_source {
1895+ (current, Some(text)) if *current == list.span.line => {
1896+ diagnostic.source(text.clone())
1897+ }
1898+ _ => diagnostic,
1899+ }
1900+ };
1901+ if bracketed {
1902+ let inner = list.raw[1..list.raw.len() - 1].trim().to_string();
1903+ let diagnostic = not_a_list(
1904+ format!(
1905+ "@each takes a list written without brackets, `@each ${} in {}`; \
1906+ JSON data goes in `@data`",
1907+ item, inner
1908+ ),
1909+ ctx,
1910+ )
1911+ .suggest(Some(inner));
1912+ ctx.push_once(diagnostic);
1913+ }
1914+ let items: Vec<Value> = match source {
1915+ Value::List(list) => list.items.to_vec(),
1916+ // Reported (an undefined `$name`, brackets): there is nothing
1917+ // to repeat
1918+ _ if !filled => Vec::new(),
1919+ Value::Record(_) => {
1920+ let diagnostic = not_a_list(
1921+ format!(
1922+ "@each repeats for the items of a list, and `{}` is a record: \
1923+ loop over a list of records, or use its fields",
1924+ list.raw
1925+ ),
1926+ ctx,
1927+ );
1928+ ctx.push_once(diagnostic);
1929+ Vec::new()
1930+ }
1931+ // Empty text (a field a record doesn't have) is no items; any
1932+ // other value is one
1933+ value if value.to_string().is_empty() => Vec::new(),
1934+ value => vec![value],
1935+ };
1936+
1937+ if body.iter().all(syntax::Node::is_trivia) {
1938+ return Ok(Some(Vec::new()));
1939+ }
1940+ if items.is_empty() {
1941+ return Ok(Some(self.eval_scoped(empty, ctx)));
1942+ }
1943+ let mut nodes = Vec::new();
1944+ for (i, value) in items.into_iter().enumerate() {
1945+ ctx.env.push();
1946+ ctx.bind(item, value);
1947+ if let Some(index) = index {
1948+ ctx.bind(index, Value::Num(i as f64));
1949+ }
1950+ nodes.extend(self.eval_block(body, ctx));
1951+ ctx.env.pop();
1952+ }
1953+ Ok(Some(nodes))
1954+ }
1955+
1956+ fn define_function(
1957+ &mut self,
1958+ name: &str,
1959+ params: &[syntax::Param],
1960+ node: &syntax::Node,
1961+ ctx: &mut ParseContext,
1962+ ) {
1963+ let line_num = node.span.line;
1964+ let body = &node.children;
1965+ // An @style block at the top of the body is scoped to the
1966+ // function: its rules apply inside a `.hl-fn-NAME-HASH` wrapper (a
1967+ // generated class never has a second `-`, so the two can't meet).
1968+ // The hash is the stylesheet's, so two functions of one name with
1969+ // two stylesheets, in two files, don't style each other's elements
1970+ // in a page that has both. It is written into the page when the
1971+ // function is called.
1972+ let (style, body): (Vec<&syntax::Node>, Vec<&syntax::Node>) =
1973+ body.iter().partition(|node| node.is_directive("style"));
1974+ let scoped = (!style.is_empty()).then(|| {
1975+ let css: String = style
1976+ .iter()
1977+ .map(|node| {
1978+ ctx.visited.insert(node.id);
1979+ verbatim_content(node)
1980+ })
1981+ .collect();
1982+ let digits = crate::codegen::CLASS_DIGITS;
1983+ let hash = crate::codegen::hash_digits(crate::codegen::stable_hash(&css), digits);
1984+ let class = format!("hl-fn-{}-{}", name, hash);
1985+ // Nested under the scope class, so any CSS works (multi-line
1986+ // rules, at-rules)
1987+ let css = if css.trim().is_empty() {
1988+ String::new()
1989+ } else {
1990+ format!(".{} {{\n{}}}", class, css)
1991+ };
1992+ (class, css)
1993+ });
1994+
1995+ // A default is filled in only when a call leaves its parameter
1996+ // out, so the names in it count as used here
1997+ for default in params.iter().filter_map(|p| p.default.as_ref()) {
1998+ track_var_refs(default, &mut ctx.used_variables);
1999+ }
2000+ ctx.fn_lines.entry(name.to_string()).or_insert(line_num);
2001+ let wraps_itself = ElementKind::from_name(name).is_some()
2002+ && body.iter().any(|node| calls_unguarded(node, name));
2003+ if wraps_itself {
2004+ ctx.push_once(
2005+ Diagnostic::error(
2006+ code::RECURSIVE_CALL,
2007+ line_num,
2008+ format!(
2009+ "@{0} in the body of `@let @{0}` calls the function itself, not the \
2010+ element @{0}, so it would never stop: give the function another name \
2011+ (such as @site-{0})",
2012+ name
2013+ ),
2014+ )
2015+ .subject(name),
2016+ );
2017+ }
2018+ for node in &body {
2019+ node.walk(&mut |node| {
2020+ if let Some(d) = marker_in_text(node) {
2021+ ctx.push_once(d);
2022+ }
2023+ });
2024+ }
2025+ let body: Vec<syntax::Node> = body.into_iter().cloned().collect();
2026+ let (slots, has_children) = declared_slots(&body, ctx);
2027+ let function = Rc::new(FnDef {
2028+ params: params.to_vec(),
2029+ line: line_num,
2030+ source: ctx.current_source.1.clone(),
2031+ node: node.id,
2032+ body,
2033+ file: ctx.current_file.clone(),
2034+ slots,
2035+ has_children,
2036+ scoped,
2037+ env: ctx.env.clone(),
2038+ wraps_itself,
2039+ });
2040+ ctx.defined_functions
2041+ .insert(name.to_string(), function.clone());
2042+ ctx.env.define(name, Binding::Function(function));
2043+ }
2044+
2045+ /// An element line: a chain of elements and function calls, the last of
2046+ /// which gets the indented children.
2047+ fn eval_element(
2048+ &mut self,
2049+ node: &syntax::Node,
2050+ element: &syntax::ElementLine,
2051+ ctx: &mut ParseContext,
2052+ ) -> Result<Vec<Node>, ParseError> {
2053+ // An unclosed attribute list is a syntax error, already reported
2054+ if element
2055+ .chain
2056+ .iter()
2057+ .any(|h| h.attrs.as_ref().is_some_and(|a| !a.closed))
2058+ {
2059+ return Ok(Vec::new());
2060+ }
2061+ let line_num = node.span.line;
2062+ let last = element.chain.len() - 1;
2063+ // Each head is read where it is written, left to right. The
2064+ // children belong to the last one, so the chain is built right to
2065+ // left, each link wrapping the next.
2066+ let mut links = Vec::new();
2067+ for (i, head) in element.chain.iter().enumerate() {
2068+ let text = if i == last {
2069+ element.text.as_ref()
2070+ } else {
2071+ None
2072+ };
2073+ links.push(resolve(head, text, line_num, &node.source, ctx)?);
2074+ }
2075+ let calls: Vec<Option<(String, Rc<FnDef>)>> = links
2076+ .iter()
2077+ .map(|link| match link {
2078+ Resolved::Call(call) => Some((call.name.clone(), call.function.clone())),
2079+ Resolved::Element(_) => None,
2080+ })
2081+ .collect();
2082+ let mut current = self.eval_scoped(&node.children, ctx);
2083+ // After the lines under the call ran, so the files they include
2084+ // are read
2085+ check_fillers(node, element, &calls, ctx);
2086+ for link in links.into_iter().rev() {
2087+ current = self.complete(link, current, ctx)?;
2088+ }
2089+ Ok(current)
2090+ }
2091+
2092+ /// Give a resolved `@name` its children: an element holds them, and a
2093+ /// function's body puts them where its `@children` is.
2094+ fn complete(
2095+ &mut self,
2096+ resolved: Resolved,
2097+ children: Vec<Node>,
2098+ ctx: &mut ParseContext,
2099+ ) -> Result<Vec<Node>, ParseError> {
2100+ match resolved {
2101+ Resolved::Element(mut element) => {
2102+ element.children.extend(children);
2103+ let line = element.line_num;
2104+ Ok(vec![inline_svg(Node::Element(element), line, ctx)])
2105+ }
2106+ Resolved::Call(call) => self.expand_fn_call(*call, children, ctx),
2107+ }
2108+ }
2109+
2110+ fn expand_fn_call(
2111+ &mut self,
2112+ call: Call,
2113+ all_caller_children: Vec<Node>,
2114+ ctx: &mut ParseContext,
2115+ ) -> Result<Vec<Node>, ParseError> {
2116+ let Call {
2117+ name,
2118+ function: fn_def,
2119+ args,
2120+ values,
2121+ text: trailing_text,
2122+ written_form,
2123+ written_keys,
2124+ line: line_num,
2125+ name_at,
2126+ source: content,
2127+ } = call;
2128+ let (name, content) = (name.as_str(), content.as_str());
2129+
2130+ // Separate the caller's `@slot NAME` blocks from its other
2131+ // children. A block for a slot the function doesn't declare was
2132+ // reported where it is written (see `check_fillers`), like one
2133+ // without a name.
2134+ let mut slot_contents: HashMap<String, Vec<Node>> = HashMap::new();
2135+ let mut caller_children = Vec::new();
2136+ for child in all_caller_children {
2137+ if let Node::Element(elem) = child {
2138+ match elem.kind {
2139+ ElementKind::Slot(slot_name) => {
2140+ slot_contents
2141+ .entry(slot_name)
2142+ .or_default()
2143+ .extend(elem.children);
2144+ }
2145+ kind => caller_children.push(Node::Element(Element { kind, ..elem })),
2146+ }
2147+ continue;
2148+ }
2149+ caller_children.push(child);
2150+ }
2151+ // Text after the call, as in `@card [color red] New`, is content:
2152+ // it goes first among the caller's children, and like them it is
2153+ // evaluated where the call is written.
2154+ if let Some(text) = &trailing_text {
2155+ caller_children.insert(0, Node::Text(text_segments(text, ctx)));
2156+ }
2157+ // Content goes where the body's `@children` is: without one, it
2158+ // would be dropped
2159+ if !fn_def.has_children && !caller_children.is_empty() {
2160+ let (column, text) = match &name_at {
2161+ Some((column, text)) => (Some(*column), text.as_str()),
2162+ None => (None, content),
2163+ };
2164+ ctx.push_once(no_children(name, line_num, column).source(text));
2165+ }
2166+
2167+ if fn_def.wraps_itself {
2168+ return Ok(Vec::new());
2169+ }
2170+ // Only the body is inside the call, so a function may appear in the
2171+ // content its caller passes it. A function may call itself, under
2172+ // a condition that stops it; one that doesn't stop goes too deep.
2173+ if ctx.too_deep {
2174+ return Ok(Vec::new());
2175+ }
2176+ if ctx.fn_call_stack.len() >= MAX_CALL_DEPTH {
2177+ ctx.too_deep = true;
2178+ return Err(too_deep(name, &ctx.fn_call_stack, line_num).source(content));
2179+ }
2180+ let caller = (
2181+ ctx.current_line,
2182+ ctx.current_source.clone(),
2183+ ctx.current_node,
2184+ );
2185+ ctx.fn_call_stack.push(name.to_string());
2186+
2187+ // The body runs where the function is defined: it sees what was
2188+ // visible there, the function itself (so it can call itself), and
2189+ // its parameters, bound by name in the order they are declared. A
2190+ // default is filled in at the call, seeing the same, with the
2191+ // parameters before it.
2192+ let caller_env = std::mem::replace(&mut ctx.env, fn_def.env.clone());
2193+ ctx.env.push();
2194+ ctx.env.define(name, Binding::Function(fn_def.clone()));
2195+ let mut consumed = vec![false; args.len()];
2196+ for param in &fn_def.params {
2197+ let mut passed = None;
2198+ for (j, arg) in args.iter().enumerate() {
2199+ if arg.key != param.name {
2200+ continue;
2201+ }
2202+ consumed[j] = true;
2203+ // The later one wins, as for any attribute: one written
2204+ // after a bundle overrides it, and only one written twice
2205+ // in the call's own list is reported
2206+ if passed.is_some() && written_keys.iter().filter(|k| **k == param.name).count() > 1
2207+ {
2208+ ctx.push_once(
2209+ Diagnostic::warning(
2210+ code::DUPLICATE_ATTRIBUTE,
2211+ line_num,
2212+ format!(
2213+ "parameter '{}' of @{} is passed twice: the later one wins",
2214+ param.name, name
2215+ ),
2216+ )
2217+ .source(content)
2218+ .subject(param.name.as_str()),
2219+ );
2220+ }
2221+ // Written `name=value` in the call's own list is reported
2222+ // as written; this is one from a bundle
2223+ if arg.html && !written_form.contains(&arg.key) {
2224+ let value = arg.value.as_deref().unwrap_or("");
2225+ ctx.push_once(parameter_form(name, &arg.key, value, line_num).source(content));
2226+ }
2227+ passed = Some(j);
2228+ }
2229+ let value = match passed {
2230+ // A parameter's name alone is true: `@post-card [featured]`
2231+ Some(j) if args[j].value.is_none() => Value::Bool(true),
2232+ // What the call passed, with its type: a record, a list,
2233+ // quoted text
2234+ Some(j) => values[j].clone().unwrap_or_else(|| {
2235+ let arg = &args[j];
2236+ match &arg.quoted {
2237+ Some(quoted) => Value::Quoted(quoted.clone()),
2238+ None => Value::Str(arg.value.clone().unwrap_or_default()),
2239+ }
2240+ }),
2241+ None => match &param.default {
2242+ Some(default) => {
2243+ let before = ctx.diagnostics.len();
2244+ let value = fill_default(&fn_def, param, default, ctx);
2245+ point_at_call(ctx, before, &fn_def, name, line_num, content);
2246+ value
2247+ }
2248+ None => {
2249+ let (column, text) = match &name_at {
2250+ Some((column, text)) => (Some(*column), text.as_str()),
2251+ None => (None, content),
2252+ };
2253+ ctx.push_once(
2254+ missing_parameter(name, &param.name, line_num, column).source(text),
2255+ );
2256+ Value::empty()
2257+ }
2258+ },
2259+ };
2260+ ctx.bind(&param.name, value);
2261+ }
2262+ // Arguments that aren't parameters are attributes for the
2263+ // function's root element, so a function can be styled like an
2264+ // element: `@card [background red] New`.
2265+ let forwarded: Vec<Attribute> = args
2266+ .iter()
2267+ .zip(&consumed)
2268+ .filter(|&(_, &used)| !used)
2269+ .map(|(a, _)| a.clone())
2270+ .collect();
2271+
2272+ // Evaluate the body with the parameters in scope, as lines of the
2273+ // file that defines the function
2274+ let caller_file = std::mem::replace(&mut ctx.current_file, fn_def.file.clone());
2275+ let before = ctx.diagnostics.len();
2276+ let mut body_nodes = self.eval_block(&fn_def.body, ctx);
2277+ ctx.current_file = caller_file;
2278+ point_at_call(ctx, before, &fn_def, name, line_num, content);
2279+
2280+ // Back to the caller's names and call stack
2281+ ctx.env = caller_env;
2282+ ctx.fn_call_stack.pop();
2283+ if ctx.fn_call_stack.is_empty() {
2284+ ctx.too_deep = false;
2285+ }
2286+ (ctx.current_line, ctx.current_source, ctx.current_node) = caller;
2287+
2288+ // What the body wrote is the call's
2289+ belongs_to_call(&mut body_nodes, name, line_num);
2290+
2291+ // Replace @children with caller's children and @slot with slot content
2292+ let mut result_nodes =
2293+ replace_children_and_slots(body_nodes, &caller_children, &slot_contents);
2294+
2295+ // Attributes that aren't parameters style the function's root
2296+ // element, and a scoped @style's class goes on it too.
2297+ let scope_class = fn_def.scoped.as_ref().map(|(class, _)| class.clone());
2298+ if !forwarded.is_empty() || scope_class.is_some() {
2299+ let mut roots = result_nodes.iter_mut().filter_map(|n| match n {
2300+ Node::Element(e) => Some(e),
2301+ _ => None,
2302+ });
2303+ let root = match (roots.next(), roots.next()) {
2304+ (Some(root), None) => Some(root),
2305+ _ => None,
2306+ };
2307+ let mut problems = Vec::new();
2308+ match root {
2309+ Some(root) => {
2310+ // A call's `class=` adds to the root's own classes
2311+ for attr in forwarded {
2312+ let existing = (attr.html && attr.key == "class")
2313+ .then(|| root.attrs.iter_mut().find(|a| a.html && a.key == "class"))
2314+ .flatten();
2315+ match existing {
2316+ Some(class) => {
2317+ let mut value = class.value.take().unwrap_or_default();
2318+ for name in attr.value.as_deref().unwrap_or("").split_whitespace() {
2319+ if !value.split_whitespace().any(|c| c == name) {
2320+ value.push(' ');
2321+ value.push_str(name);
2322+ }
2323+ }
2324+ class.value = Some(value.trim().to_string());
2325+ }
2326+ None => root.attrs.push(attr),
2327+ }
2328+ }
2329+ // The scoped `@style` goes into the page once, when the
2330+ // function is first called
2331+ if let Some((_, css)) = &fn_def.scoped
2332+ && !css.is_empty()
2333+ && !ctx.scoped_css.contains(css)
2334+ {
2335+ ctx.scoped_css.push(css.clone());
2336+ }
2337+ if let Some(class) = scope_class {
2338+ match root.attrs.iter_mut().find(|a| a.html && a.key == "class") {
2339+ Some(attr) => {
2340+ let existing = attr.value.take().unwrap_or_default();
2341+ attr.value =
2342+ Some(format!("{} {}", existing, class).trim().to_string());
2343+ }
2344+ None => root.attrs.push(Attribute {
2345+ key: "class".to_string(),
2346+ value: Some(class),
2347+ html: true,
2348+ quoted: None,
2349+ }),
2350+ }
2351+ }
2352+ }
2353+ None => {
2354+ if !forwarded.is_empty() {
2355+ problems.push(format!(
2356+ "attributes {} on @{} are not parameters, and its body has no single \
2357+ root element to receive them",
2358+ forwarded
2359+ .iter()
2360+ .map(|a| format!("'{}'", a.key))
2361+ .collect::<Vec<_>>()
2362+ .join(", "),
2363+ name
2364+ ));
2365+ }
2366+ if scope_class.is_some() {
2367+ problems.push(format!(
2368+ "@{} has a scoped @style, but its body has no single root element \
2369+ to scope it to",
2370+ name
2371+ ));
2372+ }
2373+ }
2374+ }
2375+ for message in problems {
2376+ ctx.diagnostics.push(
2377+ Diagnostic::error(code::NO_SINGLE_ROOT, line_num, message)
2378+ .source(content)
2379+ .subject(name),
2380+ );
2381+ }
2382+ }
2383+
2384+ Ok(result_nodes)
2385+ }
2386+}
2387+
2388+/// A `@name` read where it is written: a built-in element, or a call.
2389+enum Resolved {
2390+ Element(Element),
2391+ Call(Box<Call>),
2392+}
2393+
2394+/// A call of a function, with its arguments evaluated where it is written.
2395+struct Call {
2396+ name: String,
2397+ function: Rc<FnDef>,
2398+ args: Vec<Attribute>,
2399+ /// The value of each argument that passes a parameter, with its type
2400+ /// (see [`ParseContext::slot_value`]), in the order of `args`.
2401+ values: Vec<Option<Value>>,
2402+ /// Text after the attributes, which is content.
2403+ text: Option<syntax::Text>,
2404+ /// Parameters written `name=value`, already reported.
2405+ written_form: Vec<String>,
2406+ /// The keys written in the call's own list, not from a bundle.
2407+ written_keys: Vec<String>,
2408+ line: usize,
2409+ /// The column of the call's name and the line it is on, for a missing
2410+ /// parameter.
2411+ name_at: Option<(usize, String)>,
2412+ /// The line as written, for diagnostics.
2413+ source: String,
2414+}
2415+
2416+/// What `@name` is where it is written: a call of the function `name`
2417+/// when one is defined, else the built-in element. A whole line, each link
2418+/// of a chain and an inline element in text all resolve here.
2419+fn resolve(
2420+ head: &syntax::Head,
2421+ text: Option<&syntax::Text>,
2422+ line: usize,
2423+ source: &str,
2424+ ctx: &mut ParseContext,
2425+) -> Result<Resolved, ParseError> {
2426+ let Some(function) = ctx.env.function(&head.name).cloned() else {
2427+ return parse_single_element(head, text, line, ctx).map(Resolved::Element);
2428+ };
2429+ ctx.used_functions.insert(head.name.clone());
2430+ let params: Vec<String> = function.params.iter().map(|p| p.name.clone()).collect();
2431+ let written = head.attrs.as_ref().map_or(&[][..], |list| &list.attrs[..]);
2432+ let written_form = written_parameter_forms(&head.name, &function, written, line, ctx);
2433+ let written_keys = written.iter().map(|a| a.key.clone()).collect();
2434+ // Parameters are bound by name; every other attribute goes to the
2435+ // root element, and is checked like any attribute
2436+ let (args, values) = parse_attrs(written, line, ctx, true, &params)
2437+ .into_iter()
2438+ .unzip();
2439+ let name_at = name_column(head, line).zip(match &ctx.current_source {
2440+ (current, Some(text)) if *current == line => Some(text.clone()),
2441+ _ => None,
2442+ });
2443+ Ok(Resolved::Call(Box::new(Call {
2444+ name: head.name.clone(),
2445+ function,
2446+ args,
2447+ values,
2448+ text: text.cloned(),
2449+ written_form,
2450+ written_keys,
2451+ line,
2452+ name_at,
2453+ source: source.to_string(),
2454+ })))
2455+}
2456+
2457+/// A line of another file (the standard library, an included file) means
2458+/// nothing in this one: the problems reported since `before` while
2459+/// evaluating the function (its body, a default) are moved to the call.
2460+fn point_at_call(
2461+ ctx: &mut ParseContext,
2462+ before: usize,
2463+ function: &FnDef,
2464+ name: &str,
2465+ line: usize,
2466+ source: &str,
2467+) {
2468+ if function.file == ctx.current_file {
2469+ return;
2470+ }
2471+ let defined_in = function
2472+ .file
2473+ .as_deref()
2474+ .unwrap_or("the file being compiled");
2475+ for d in &mut ctx.diagnostics[before..] {
2476+ d.message = format!(
2477+ "{}\n in @{} (line {} of {})",
2478+ d.message, name, d.line, defined_in
2479+ );
2480+ d.line = line;
2481+ d.column = None;
2482+ d.subject = None;
2483+ d.suggestion = None;
2484+ d.source_line = Some(source.into());
2485+ }
2486+}
2487+
2488+/// A call nested deeper than [`MAX_CALL_DEPTH`].
2489+fn too_deep(name: &str, stack: &[String], line: usize) -> Diagnostic {
2490+ let message = if stack.iter().any(|n| n == name) {
2491+ format!(
2492+ "recursive function call to @{} goes more than {} calls deep: a function that \
2493+ calls itself needs a condition that stops it (`@if`)",
2494+ name, MAX_CALL_DEPTH
2495+ )
2496+ } else {
2497+ format!(
2498+ "function calls nest more than {} deep at @{} (starting with {})",
2499+ MAX_CALL_DEPTH,
2500+ name,
2501+ stack
2502+ .iter()
2503+ .take(3)
2504+ .map(|n| format!("@{}", n))
2505+ .collect::<Vec<_>>()
2506+ .join(" → ")
2507+ )
2508+ };
2509+ Diagnostic::error(code::RECURSIVE_CALL, line, message).subject(name)
2510+}
2511+
2512+/// Mark what a function's body wrote as the call's: it gets the call's
2513+/// line, so what is reported about it points at the call, and the name of
2514+/// the function, unless a call inside the body already claimed it.
2515+fn belongs_to_call(nodes: &mut [Node], function: &str, line: usize) {
2516+ fn claim(element: &mut Element, function: &str, line: usize) {
2517+ element.line_num = line;
2518+ element.function.get_or_insert_with(|| function.to_string());
2519+ belongs_to_call(&mut element.children, function, line);
2520+ }
2521+ for node in nodes {
2522+ match node {
2523+ Node::Element(element) => claim(element, function, line),
2524+ Node::Text(segments) => {
2525+ for segment in segments {
2526+ if let TextSegment::Inline(element) = segment {
2527+ claim(element, function, line);
2528+ }
2529+ }
2530+ }
2531+ Node::Raw(_) => {}
2532+ }
2533+ }
2534+}
2535+
2536+/// What an inline `{@name ...}` stands for in its line of text: an
2537+/// element; the text of a function whose body is text; or, for a body with
2538+/// several roots, its nodes as a fragment.
2539+fn inline_segments(mut nodes: Vec<Node>, line: usize) -> Vec<TextSegment> {
2540+ if let [Node::Element(_)] = nodes.as_slice()
2541+ && let Some(Node::Element(element)) = nodes.pop()
2542+ {
2543+ return vec![TextSegment::Inline(element)];
2544+ }
2545+ if nodes.iter().all(|n| matches!(n, Node::Text(_))) {
2546+ let mut segments = Vec::new();
2547+ for node in nodes {
2548+ if let Node::Text(run) = node {
2549+ if !segments.is_empty() {
2550+ segments.push(TextSegment::Plain(" ".to_string()));
2551+ }
2552+ segments.extend(run);
2553+ }
2554+ }
2555+ return segments;
2556+ }
2557+ vec![TextSegment::Inline(Element {
2558+ kind: ElementKind::Fragment,
2559+ attrs: Vec::new(),
2560+ argument: None,
2561+ children: nodes,
2562+ line_num: line,
2563+ function: None,
2564+ })]
2565+}
2566+
2567+/// Fill in the default of a parameter that a call leaves out, like the
2568+/// value of an attribute passed for it: variables are filled in, one
2569+/// `$name` keeps its type and one `"..."` is quoted text. It sees what the
2570+/// body sees: the names visible where the function is defined, and the
2571+/// parameters before it. Its problems are reported at the definition, once.
2572+fn fill_default(
2573+ fn_def: &FnDef,
2574+ param: &syntax::Param,
2575+ default: &str,
2576+ ctx: &mut ParseContext,
2577+) -> Value {
2578+ // A default that uses a later parameter is an error in the
2579+ // definition; the later one isn't bound yet, so don't report it again
2580+ let later = fn_def
2581+ .params
2582+ .iter()
2583+ .skip_while(|p| p.name != param.name)
2584+ .skip(1);
2585+ let names = interp::names(default);
2586+ if later.clone().any(|p| names.contains(&p.name.as_str())) {
2587+ return Value::empty();
2588+ }
2589+ let line = param.span.line;
2590+ let at_head = line == fn_def.line && fn_def.source.is_some();
2591+ let column =
2592+ at_head.then(|| param.span.column + (param.span.end - param.span.start) - default.len());
2593+ let caller = (
2594+ std::mem::replace(
2595+ &mut ctx.current_source,
2596+ (fn_def.line, fn_def.source.clone()),
2597+ ),
2598+ std::mem::replace(&mut ctx.current_node, fn_def.node),
2599+ );
2600+ let (value, _) = ctx.slot_value(default, line, column);
2601+ (ctx.current_source, ctx.current_node) = caller;
2602+ value
2603+}
2604+
2605+/// Read `@page`'s attribute list and title. The page is the root element,
2606+/// and its attributes are checked like any element's: `key=value` (and a
2607+/// bare boolean HTML attribute) go on `<html>`, styles on `<body>`, and
2608+/// `favicon FILE` is its one word of htmlang's own.
2609+fn read_page(
2610+ attrs: Option<&syntax::AttrList>,
2611+ title: Option<&syntax::Arg>,
2612+ line: usize,
2613+ ctx: &mut ParseContext,
2614+) -> Page {
2615+ let mut page = Page::default();
2616+ if let Some(list) = attrs {
2617+ let words: Vec<String> = crate::vocab::PAGE_WORDS
2618+ .iter()
2619+ .map(|w| w.to_string())
2620+ .collect();
2621+ ctx.in_page = true;
2622+ let read = parse_attr_list(&list.attrs, line, ctx, true, &words);
2623+ ctx.in_page = false;
2624+ // How many of each name have been read, to find where the next
2625+ // one is written
2626+ let mut seen: HashMap<String, usize> = HashMap::new();
2627+ for attr in read {
2628+ let boolean = attr.value.is_none() && crate::vocab::is_html_flag(&attr.key);
2629+ // Where it is written, when it is written in the list itself
2630+ let nth = seen.entry(attr.key.clone()).or_default();
2631+ let column = list
2632+ .attrs
2633+ .iter()
2634+ .filter(|token| token.key == attr.key)
2635+ .nth(*nth)
2636+ .map(|token| token.span.column);
2637+ *nth += 1;
2638+ let value = attr
2639+ .quoted
2640+ .as_ref()
2641+ .map(|q| q.text.clone())
2642+ .or(attr.value.clone());
2643+ if !check_page_attr(&attr.key, attr.html, value.as_deref(), line, column, ctx) {
2644+ continue;
2645+ }
2646+ if words.contains(&attr.key) {
2647+ if page.favicon.is_some() {
2648+ let diagnostic = Diagnostic::warning(
2649+ code::DUPLICATE_ATTRIBUTE,
2650+ line,
2651+ "duplicate attribute 'favicon': the later one wins".to_string(),
2652+ )
2653+ .subject("favicon");
2654+ ctx.diagnostics.push(at_attribute(diagnostic, column, ctx));
2655+ }
2656+ // The file itself goes into the page when it can be read
2657+ // (relative to the file); otherwise it is linked
2658+ page.favicon = value.map(|path| match std::fs::read(ctx.resolve(&path)) {
2659+ Ok(data) => crate::codegen::data_uri(&path, &data),
2660+ Err(_) => path,
2661+ });
2662+ } else if attr.html || boolean {
2663+ page.html_attrs.push(attr);
2664+ } else {
2665+ page.styles.push(attr);
2666+ }
2667+ }
2668+ }
2669+ page.title = match title {
2670+ Some(title) => ctx.interpolate_text(&title.raw, title.span.line, Some(title.span.column)),
2671+ None => String::new(),
2672+ };
2673+ page
2674+}
2675+
2676+/// `@page`'s own rules for one of its attributes, checked where the
2677+/// `@page` runs and where it doesn't (a layout that isn't called): its
2678+/// word is written `favicon FILE`, and `inline` belongs to `@image`.
2679+/// Returns whether the attribute can be used (a `favicon` with its file,
2680+/// or any other attribute but `inline`).
2681+fn check_page_attr(
2682+ key: &str,
2683+ html: bool,
2684+ value: Option<&str>,
2685+ line: usize,
2686+ column: Option<usize>,
2687+ ctx: &mut ParseContext,
2688+) -> bool {
2689+ let report = |ctx: &mut ParseContext, diagnostic: Diagnostic| {
2690+ let diagnostic = at_attribute(diagnostic, column, ctx);
2691+ ctx.diagnostics.push(diagnostic);
2692+ };
2693+ if crate::vocab::PAGE_WORDS.contains(&key) {
2694+ if html {
2695+ report(
2696+ ctx,
2697+ Diagnostic::error(
2698+ code::PARAMETER_FORM,
2699+ line,
2700+ format!(
2701+ "'{0}' is @page's own word, not an HTML attribute: write `{0} {1}`",
2702+ key,
2703+ value.filter(|v| !v.is_empty()).unwrap_or("FILE")
2704+ ),
2705+ )
2706+ .subject(format!("{}=", key))
2707+ .suggest(Some(format!("{} ", key))),
2708+ );
2709+ }
2710+ if value.is_none_or(|v| v.trim().is_empty()) {
2711+ report(
2712+ ctx,
2713+ Diagnostic::error(
2714+ code::MISSING_VALUE,
2715+ line,
2716+ format!("'{0}' needs its file: `{0} favicon.png`", key),
2717+ )
2718+ .subject(key),
2719+ );
2720+ return false;
2721+ }
2722+ return true;
2723+ }
2724+ if !html && crate::vocab::base_attribute(key) == "inline" {
2725+ report(
2726+ ctx,
2727+ Diagnostic::error(
2728+ code::UNEXPECTED_ARGUMENT,
2729+ line,
2730+ "`inline` puts an image's file into the page, and @page has none: it only \
2731+ goes on @image"
2732+ .to_string(),
2733+ )
2734+ .subject("inline"),
2735+ );
2736+ return false;
2737+ }
2738+ true
2739+}
2740+
2741+/// A parameter passed `name=value`, the form of an HTML attribute.
2742+fn parameter_form(function: &str, key: &str, value: &str, line: usize) -> Diagnostic {
2743+ Diagnostic::error(
2744+ code::PARAMETER_FORM,
2745+ line,
2746+ format!(
2747+ "'{}' is a parameter of @{}: parameters are written `name value`, so write `{} {}`",
2748+ key, function, key, value
2749+ ),
2750+ )
2751+ .subject(format!("{}=", key))
2752+ .suggest(Some(format!("{} ", key)))
2753+}
2754+
2755+/// A call that leaves out a parameter without a default.
2756+fn missing_parameter(
2757+ function: &str,
2758+ param: &str,
2759+ line: usize,
2760+ column: Option<usize>,
2761+) -> Diagnostic {
2762+ let diagnostic = Diagnostic::error(
2763+ code::MISSING_PARAMETER,
2764+ line,
2765+ format!(
2766+ "@{} needs '{}': the parameter has no default, so pass it as `{} VALUE`",
2767+ function, param, param
2768+ ),
2769+ )
2770+ .subject(param);
2771+ match column {
2772+ Some(column) => diagnostic.column(column),
2773+ None => diagnostic,
2774+ }
2775+}
2776+
2777+/// The column of a call's `@name`, when it is on the call's line.
2778+fn name_column(head: &syntax::Head, line: usize) -> Option<usize> {
2779+ (head.name_span.line == line).then_some(head.name_span.column)
2780+}
2781+
2782+/// Define `$name`, or, for `--name`, the CSS custom property on `:root`
2783+/// (which gets quoted text with its quotes, and is read with
2784+/// `var(--name)`, never as a variable). `@let name.field value` gives the
2785+/// record `$name` that field (or the list `$name` a new item at that
2786+/// index), as a new value in this block.
2787+fn set_variable(name: &str, value: Value, line_num: usize, ctx: &mut ParseContext) {
2788+ if name.starts_with("--") {
2789+ let css = value
2790+ .quoted_css()
2791+ .map_or_else(|| value.to_string(), str::to_string);
2792+ let at_line = |diagnostic: Diagnostic, ctx: &ParseContext| match &ctx.current_source {
2793+ (current, Some(text)) if *current == line_num => diagnostic.source(text.clone()),
2794+ _ => diagnostic,
2795+ };
2796+ // `:root` is one place for the whole page: a declaration inside a
2797+ // block (an element, a loop, a function's body) would not be
2798+ // kept to it, and each run would replace the last
2799+ if ctx.env.frames.len() > FILE_FRAMES {
2800+ let diagnostic = Diagnostic::error(
2801+ code::INVALID_DEFINITION,
2802+ line_num,
2803+ format!(
2804+ "`@let {name}` declares {name} on :root, for the whole page, so it goes at \
2805+ the top level of the file: to set it on an element and what is inside \
2806+ it, write `[{name} value]` on that element"
2807+ ),
2808+ )
2809+ .subject(name);
2810+ ctx.push_once(at_line(diagnostic, ctx));
2811+ return;
2812+ }
2813+ match css_breakout(&css) {
2814+ Some(reason) => {
2815+ let diagnostic = Diagnostic::error(
2816+ code::INVALID_VALUE,
2817+ line_num,
2818+ format!(
2819+ "the value of '{}' has {}: `{}` can't be written into the page's CSS",
2820+ name, reason, css
2821+ ),
2822+ )
2823+ .subject(css.as_str());
2824+ ctx.push_once(at_line(diagnostic, ctx));
2825+ }
2826+ None => match ctx.css_vars.iter_mut().find(|(n, _)| n == name) {
2827+ Some(declared) => {
2828+ let diagnostic = Diagnostic::warning(
2829+ code::DUPLICATE_ATTRIBUTE,
2830+ line_num,
2831+ format!(
2832+ "{name} is declared again: :root has one value for the whole page, \
2833+ so every element gets this one, also above this line (a theme \
2834+ redefines a token on an element: `[dark:{name} {css}]`)"
2835+ ),
2836+ )
2837+ .subject(name);
2838+ declared.1 = css;
2839+ ctx.push_once(at_line(diagnostic, ctx));
2840+ }
2841+ None => ctx.css_vars.push((name.to_string(), css)),
2842+ },
2843+ }
2844+ return;
2845+ }
2846+ let mut path = name.split('.');
2847+ let root = path.next().unwrap_or(name);
2848+ let fields: Vec<&str> = path.collect();
2849+ let value = match fields.is_empty() {
2850+ true => value,
2851+ false => match with_field(ctx.env.value(root).cloned(), root, &fields, value) {
2852+ Ok(value) => value,
2853+ Err(message) => {
2854+ let diagnostic =
2855+ Diagnostic::error(code::INVALID_DEFINITION, line_num, message).subject(name);
2856+ let diagnostic = match &ctx.current_source {
2857+ (current, Some(text)) if *current == line_num => {
2858+ diagnostic.source(text.clone())
2859+ }
2860+ _ => diagnostic,
2861+ };
2862+ ctx.push_once(diagnostic);
2863+ // Reported: the name keeps what it held
2864+ ctx.let_lines.entry(root.to_string()).or_insert(line_num);
2865+ return;
2866+ }
2867+ },
2868+ };
2869+ ctx.bind(root, value);
2870+ ctx.let_lines.entry(root.to_string()).or_insert(line_num);
2871+}
2872+
2873+/// `value` (the value of `$name`) with the field at `path` set to `new`:
2874+/// a record's field, or the item of a list at an index it has. A name
2875+/// without a value, or one whose value is empty (a field a record doesn't
2876+/// have), becomes a record; any other value has no fields to set.
2877+fn with_field(
2878+ value: Option<Value>,
2879+ name: &str,
2880+ path: &[&str],
2881+ new: Value,
2882+) -> Result<Value, String> {
2883+ let Some((field, rest)) = path.split_first() else {
2884+ return Ok(new);
2885+ };
2886+ let inner = format!("{}.{}", name, field);
2887+ match value {
2888+ Some(Value::Record(fields)) => {
2889+ let mut fields = fields.as_ref().clone();
2890+ match fields.iter().position(|(key, _)| key == field) {
2891+ Some(i) => {
2892+ let old = std::mem::replace(&mut fields[i].1, Value::empty());
2893+ fields[i].1 = with_field(Some(old), &inner, rest, new)?;
2894+ }
2895+ None => fields.push((field.to_string(), with_field(None, &inner, rest, new)?)),
2896+ }
2897+ Ok(Value::Record(Rc::new(fields)))
2898+ }
2899+ Some(Value::List(list)) => {
2900+ let count = list.items.len();
2901+ let Some(i) = field.parse::<usize>().ok().filter(|&i| i < count) else {
2902+ return Err(format!(
2903+ "`${}` is {}, so `.{}` isn't one of its items (they are `.0` to `.{}`)",
2904+ name,
2905+ Value::List(list).describe(),
2906+ field,
2907+ count.saturating_sub(1)
2908+ ));
2909+ };
2910+ let mut items = list.items.as_ref().clone();
2911+ let old = std::mem::replace(&mut items[i], Value::empty());
2912+ items[i] = with_field(Some(old), &inner, rest, new)?;
2913+ // Its items changed, so it no longer prints as written
2914+ Ok(Value::list(items))
2915+ }
2916+ None => Ok(Value::Record(Rc::new(vec![(
2917+ field.to_string(),
2918+ with_field(None, &inner, rest, new)?,
2919+ )]))),
2920+ Some(value) if value.to_string().is_empty() => with_field(None, name, path, new),
2921+ Some(value) => Err(format!(
2922+ "`@let {}.{}` sets a field of a record, but `${}` is {} (`{}`), which has no fields",
2923+ name,
2924+ path.join("."),
2925+ name,
2926+ value.describe(),
2927+ value
2928+ )),
2929+ }
2930+}
2931+
2932+/// What a verbatim directive holds (`@head`, `@style`, `@raw`): the rest
2933+/// of its line (`@style .a { color: red }`), or else its indented block.
2934+/// The two together are a syntax error, reported by the tree; the line
2935+/// wins.
2936+fn verbatim_content(node: &syntax::Node) -> String {
2937+ match node.directive().map(|d| &d.args) {
2938+ Some(DirectiveArgs::Text(Some(line))) => format!("{}\n", line.raw),
2939+ _ => verbatim_text(&node.children),
2940+ }
2941+}
2942+
2943+/// The text of a verbatim body (`@head`, `@style`, `@markdown`, `@raw`).
2944+fn verbatim_text(children: &[syntax::Node]) -> String {
2945+ let mut text = String::new();
2946+ for child in children {
2947+ if let NodeKind::Verbatim(body) = &child.kind {
2948+ text.push_str(&body.text);
2949+ text.push('\n');
2950+ }
2951+ }
2952+ text
2953+}
2954+
2955+// ---------------------------------------------------------------------------
2956+// @children replacement
2957+// ---------------------------------------------------------------------------
2958+
2959+fn replace_children_and_slots(
2960+ nodes: Vec<Node>,
2961+ caller_children: &[Node],
2962+ slot_contents: &HashMap<String, Vec<Node>>,
2963+) -> Vec<Node> {
2964+ let mut result = Vec::new();
2965+ for node in nodes {
2966+ match node {
2967+ Node::Element(elem) if elem.kind == ElementKind::Children => {
2968+ if caller_children.is_empty() && !elem.children.is_empty() {
2969+ // Use @children's own children as default/fallback content
2970+ result.extend(elem.children);
2971+ } else {
2972+ result.extend(caller_children.iter().cloned());
2973+ }
2974+ }
2975+ Node::Element(elem) if matches!(&elem.kind, ElementKind::Slot(name) if !name.is_empty()) =>
2976+ {
2977+ if let ElementKind::Slot(ref name) = elem.kind {
2978+ if let Some(content) = slot_contents.get(name) {
2979+ result.extend(content.iter().cloned());
2980+ }
2981+ // If no content provided for this slot, use the slot's own children as default
2982+ else if !elem.children.is_empty() {
2983+ result.extend(elem.children);
2984+ }
2985+ }
2986+ }
2987+ Node::Element(mut elem) => {
2988+ elem.children =
2989+ replace_children_and_slots(elem.children, caller_children, slot_contents);
2990+ result.push(Node::Element(elem));
2991+ }
2992+ other => result.push(other),
2993+ }
2994+ }
2995+ result
2996+}
2997+
2998+// ---------------------------------------------------------------------------
2999+// Where @slot and @children are written
3000+// ---------------------------------------------------------------------------
3001+
3002+/// The files each `@include` line brought in, by the line's node id, with
3003+/// the include chain that leads to each.
3004+type IncludedBy = HashMap<usize, Vec<(Rc<Tree>, String)>>;
3005+
3006+/// The lines of the files an `@include` line brings in, and the include
3007+/// chain of each (for diagnostics).
3008+type Included<'a, 'f> = &'f dyn Fn(&syntax::Node) -> Vec<(&'a [syntax::Node], Option<&'a str>)>;
3009+
3010+/// Whether `name` is a function here: defined so far, or anywhere in the
3011+/// file and the files it includes.
3012+fn is_function(name: &str, ctx: &ParseContext) -> bool {
3013+ ctx.env.function(name).is_some() || ctx.namespace.contains(name)
3014+}
3015+
3016+/// Whether `name` is one slot name: letters, digits, `-` and `_`,
3017+/// starting with a letter (like a function's name).
3018+fn is_slot_name(name: &str) -> bool {
3019+ name.chars().next().is_some_and(char::is_alphabetic)
3020+ && name
3021+ .chars()
3022+ .all(|c| c.is_alphanumeric() || c == '-' || c == '_')
3023+}
3024+
3025+/// What a `@slot` or `@children` line is written in.
3026+#[derive(Clone, Copy)]
3027+enum Place<'a> {
3028+ /// The top of a file or of a function's body, or a built-in element
3029+ /// (by its name).
3030+ Element(Option<&'a str>),
3031+ /// A call: its content.
3032+ Call,
3033+}
3034+
3035+/// Where a line is, for [`slot_uses`].
3036+#[derive(Clone, Copy)]
3037+struct At<'a> {
3038+ /// Inside a function's body.
3039+ body: bool,
3040+ place: Place<'a>,
3041+ /// Outside a body: the call (and its line) whose content it is in.
3042+ call: Option<(&'a str, usize)>,
3043+ /// The include chain of the file it is in, when that isn't the file
3044+ /// being compiled.
3045+ file: Option<&'a str>,
3046+}
3047+
3048+impl At<'_> {
3049+ /// The top of a file, or of a function's body.
3050+ fn top(body: bool) -> Self {
3051+ At {
3052+ body,
3053+ place: Place::Element(None),
3054+ call: None,
3055+ file: None,
3056+ }
3057+ }
3058+}
3059+
3060+/// What [`slot_uses`] knows about the names and files it walks.
3061+struct Scan<'a, 'f> {
3062+ is_function: &'f dyn Fn(&str) -> bool,
3063+ included: Included<'a, 'f>,
3064+ /// Visit the bodies of the functions defined in the lines too.
3065+ into_lets: bool,
3066+}
3067+
3068+/// A `@slot` or `@children` written in a file, and where.
3069+struct SlotUse<'a> {
3070+ node: &'a syntax::Node,
3071+ head: &'a syntax::Head,
3072+ /// The text after it, which is a slot's name; `None` when it isn't
3073+ /// the last head of its chain.
3074+ text: Option<&'a syntax::Text>,
3075+ /// Written inline in a line of text, `{@slot x}`.
3076+ inline: bool,
3077+ at: At<'a>,
3078+}
3079+
3080+impl SlotUse<'_> {
3081+ fn is_slot(&self) -> bool {
3082+ self.head.name == "slot"
3083+ }
3084+
3085+ /// The slot's name as written.
3086+ fn name(&self) -> &str {
3087+ self.text.map_or("", |t| t.raw.trim())
3088+ }
3089+
3090+ /// A `@slot NAME` that marks a place in a function's body (not one
3091+ /// that fills a slot of a call).
3092+ fn declares(&self) -> bool {
3093+ self.is_slot() && !self.inline && !matches!(self.at.place, Place::Call)
3094+ }
3095+}
3096+
3097+/// Where each `@slot` and `@children` in `block` is written. A `@slot`
3098+/// directly under a call (under its `@if`, `@else` and `@each` too) fills
3099+/// one of its slots; anywhere else in a function's body it declares one.
3100+/// An included file's lines are where its `@include` is.
3101+fn slot_uses<'a>(
3102+ block: &'a [syntax::Node],
3103+ at: At<'a>,
3104+ scan: &Scan<'a, '_>,
3105+ out: &mut Vec<SlotUse<'a>>,
3106+) {
3107+ fn inline<'a>(
3108+ text: &'a syntax::Text,
3109+ node: &'a syntax::Node,
3110+ at: At<'a>,
3111+ scan: &Scan<'a, '_>,
3112+ out: &mut Vec<SlotUse<'a>>,
3113+ ) {
3114+ for segment in &text.segments {
3115+ if let Segment::Inline(inline_element) = segment {
3116+ let head = &inline_element.head;
3117+ if matches!(head.name.as_str(), "slot" | "children")
3118+ && !(scan.is_function)(&head.name)
3119+ {
3120+ out.push(SlotUse {
3121+ node,
3122+ head,
3123+ text: inline_element.text.as_ref(),
3124+ inline: true,
3125+ at,
3126+ });
3127+ }
3128+ if let Some(text) = &inline_element.text {
3129+ inline(text, node, at, scan, out);
3130+ }
3131+ }
3132+ }
3133+ }
3134+ for node in block {
3135+ match &node.kind {
3136+ NodeKind::Directive(directive) => match &directive.args {
3137+ DirectiveArgs::Let(def) if matches!(def.form, LetForm::Function(_)) => {
3138+ if scan.into_lets {
3139+ let top = At {
3140+ file: at.file,
3141+ ..At::top(true)
3142+ };
3143+ slot_uses(&node.children, top, scan, out);
3144+ }
3145+ }
3146+ // A value's body is an error of its own
3147+ DirectiveArgs::Let(_) => {}
3148+ _ if directive.spec.body == BodyKind::Verbatim => {}
3149+ // `@if`, `@else` and `@each` put their lines in place, and
3150+ // `@include` its file's; the lines under a directive that
3151+ // takes no body are its siblings
3152+ _ => {
3153+ for (lines, file) in (scan.included)(node) {
3154+ slot_uses(lines, At { file, ..at }, scan, out);
3155+ }
3156+ slot_uses(&node.children, at, scan, out);
3157+ }
3158+ },
3159+ NodeKind::Element(line) => {
3160+ let mut at = at;
3161+ let last = line.chain.len() - 1;
3162+ for (i, head) in line.chain.iter().enumerate() {
3163+ let text = if i == last { line.text.as_ref() } else { None };
3164+ let function = (scan.is_function)(&head.name);
3165+ if !function && matches!(head.name.as_str(), "slot" | "children") {
3166+ out.push(SlotUse {
3167+ node,
3168+ head,
3169+ text,
3170+ inline: false,
3171+ at,
3172+ });
3173+ } else if let Some(text) = text {
3174+ inline(text, node, at, scan, out);
3175+ }
3176+ if function {
3177+ at.place = Place::Call;
3178+ if !at.body {
3179+ at.call = Some((&head.name, node.span.line));
3180+ }
3181+ } else {
3182+ at.place = Place::Element(Some(&head.name));
3183+ }
3184+ }
3185+ slot_uses(&node.children, at, scan, out);
3186+ }
3187+ NodeKind::Text(text) => {
3188+ inline(text, node, at, scan, out);
3189+ slot_uses(&node.children, at, scan, out);
3190+ }
3191+ NodeKind::Blank | NodeKind::Comment | NodeKind::Verbatim(_) => {}
3192+ }
3193+ }
3194+}
3195+
3196+/// The slots a function's body declares, and whether it has a
3197+/// `@children`, when it is defined. The files its `@include` lines bring
3198+/// in count too: they are read now, since they run only at a call.
3199+fn declared_slots(body: &[syntax::Node], ctx: &mut ParseContext) -> (Vec<String>, bool) {
3200+ let mut files = HashMap::new();
3201+ read_includes(
3202+ body,
3203+ ctx.base_path.clone(),
3204+ &mut Vec::new(),
3205+ ctx,
3206+ &mut files,
3207+ );
3208+ let included = |node: &syntax::Node| match files.get(&node.id) {
3209+ Some(tree) => vec![(&tree.nodes[..], None)],
3210+ None => Vec::new(),
3211+ };
3212+ let is_function = |name: &str| is_function(name, ctx);
3213+ slots_of(body, &is_function, &included)
3214+}
3215+
3216+/// Read and parse the files the `@include` lines in `nodes` bring in (by
3217+/// a literal path, relative to `base`), and the files those include, by
3218+/// the node id of each `@include` line.
3219+fn read_includes(
3220+ nodes: &[syntax::Node],
3221+ base: Option<PathBuf>,
3222+ stack: &mut Vec<PathBuf>,
3223+ ctx: &mut ParseContext,
3224+ files: &mut HashMap<usize, Rc<Tree>>,
3225+) {
3226+ let mut includes = Vec::new();
3227+ for node in nodes {
3228+ node.walk(&mut |node| {
3229+ if let Some(DirectiveArgs::Text(Some(path))) = node.directive().map(|d| &d.args)
3230+ && node.is_directive("include")
3231+ {
3232+ includes.push((node.id, path.raw.clone()));
3233+ }
3234+ });
3235+ }
3236+ for (id, path) in includes {
3237+ let path = path.trim_matches('"');
3238+ if path.contains('$') {
3239+ continue;
3240+ }
3241+ let resolved = match &base {
3242+ Some(base) => base.join(path),
3243+ None => PathBuf::from(path),
3244+ };
3245+ if stack.contains(&resolved) {
3246+ continue;
3247+ }
3248+ let Ok(text) = ctx.read_file(&resolved) else {
3249+ continue;
3250+ };
3251+ let tree = ctx.parse_tree(&text);
3252+ stack.push(resolved.clone());
3253+ let parent = resolved.parent().map(Path::to_path_buf);
3254+ read_includes(&tree.nodes, parent, stack, ctx, files);
3255+ stack.pop();
3256+ files.insert(id, tree);
3257+ }
3258+}
3259+
3260+/// The slots a function's body declares (`@slot NAME`, in order), and
3261+/// whether it has a `@children` for the content of a call. A `@slot`
3262+/// directly under a call in the body fills that call's slot instead, so
3263+/// `is_function` says which names are functions. The files the body
3264+/// includes aren't read.
3265+pub fn function_slots(
3266+ body: &[syntax::Node],
3267+ is_function: &dyn Fn(&str) -> bool,
3268+) -> (Vec<String>, bool) {
3269+ slots_of(body, is_function, &|_| Vec::new())
3270+}
3271+
3272+fn slots_of<'a>(
3273+ body: &'a [syntax::Node],
3274+ is_function: &dyn Fn(&str) -> bool,
3275+ included: Included<'a, '_>,
3276+) -> (Vec<String>, bool) {
3277+ let scan = Scan {
3278+ is_function,
3279+ included,
3280+ into_lets: false,
3281+ };
3282+ let mut uses = Vec::new();
3283+ slot_uses(body, At::top(true), &scan, &mut uses);
3284+ let mut slots: Vec<String> = Vec::new();
3285+ for slot in uses.iter().filter(|u| u.declares()) {
3286+ let name = slot.name();
3287+ if is_slot_name(name) && !slots.iter().any(|s| s == name) {
3288+ slots.push(name.to_string());
3289+ }
3290+ }
3291+ let has_children = uses.iter().any(|u| !u.is_slot() && !u.inline);
3292+ (slots, has_children)
3293+}
3294+
3295+/// The line as written, indented, when it is one physical line, so a
3296+/// column points into it.
3297+fn written_line(node: &syntax::Node) -> String {
3298+ match node.line_count <= 1 {
3299+ true => format!("{}{}", " ".repeat(node.indent), node.source),
3300+ false => node.source.clone(),
3301+ }
3302+}
3303+
3304+/// The lines of the files an `@include` line brought in when it ran, from
3305+/// `included_by`.
3306+fn ran_includes<'a>(
3307+ included_by: &'a IncludedBy,
3308+ node: &syntax::Node,
3309+) -> Vec<(&'a [syntax::Node], Option<&'a str>)> {
3310+ match included_by.get(&node.id) {
3311+ Some(files) => files
3312+ .iter()
3313+ .map(|(tree, chain)| (&tree.nodes[..], Some(chain.as_str())))
3314+ .collect(),
3315+ None => Vec::new(),
3316+ }
3317+}
3318+
3319+/// Check where every `@slot` and `@children` of the file and the files it
3320+/// includes is written, whether or not it runs: a slot has one name, a
3321+/// function's body marks places with them, and a call fills its slots
3322+/// with `@slot` blocks directly under it. An included file's lines are
3323+/// where its `@include` is (in a body, under a call), so an `@include`
3324+/// that never ran leaves its file unchecked.
3325+fn check_slot_places(ctx: &mut ParseContext) {
3326+ let trees = std::mem::take(&mut ctx.trees);
3327+ let included_by = ctx.included_by.clone();
3328+ let is_function = |name: &str| is_function(name, ctx);
3329+ let scan = Scan {
3330+ is_function: &is_function,
3331+ included: &|node| ran_includes(&included_by, node),
3332+ into_lets: true,
3333+ };
3334+ let mut uses = Vec::new();
3335+ for (tree, _) in trees.iter().filter(|(_, chain)| chain.is_none()) {
3336+ slot_uses(&tree.nodes, At::top(false), &scan, &mut uses);
3337+ }
3338+ let found: Vec<Diagnostic> = uses
3339+ .iter()
3340+ .filter_map(|slot| {
3341+ let mut d = slot_problem(slot)?;
3342+ if d.column.is_none() {
3343+ d = d.column(slot.head.name_span.column);
3344+ }
3345+ d = d.source(written_line(slot.node));
3346+ if let Some(file) = slot.at.file {
3347+ d.message = format!("{}\n in {}", d.message, file);
3348+ }
3349+ Some(d)
3350+ })
3351+ .collect();
3352+ ctx.diagnostics.extend(found);
3353+ ctx.trees = trees;
3354+}
3355+
3356+/// What is wrong with a `@slot` or `@children` where it is written.
3357+fn slot_problem(slot: &SlotUse) -> Option<Diagnostic> {
3358+ let line = slot.node.span.line;
3359+ let what = if slot.is_slot() {
3360+ match slot.name() {
3361+ "" => "@slot".to_string(),
3362+ name => format!("@slot {}", name),
3363+ }
3364+ } else {
3365+ "@children".to_string()
3366+ };
3367+ if slot.inline {
3368+ return Some(Diagnostic::error(
3369+ code::MISPLACED_SLOT,
3370+ line,
3371+ format!(
3372+ "{} goes on a line of its own: inline in text it marks and fills nothing",
3373+ what
3374+ ),
3375+ ));
3376+ }
3377+ if let Some(list) = &slot.head.attrs {
3378+ return Some(
3379+ Diagnostic::error(
3380+ code::UNEXPECTED_ARGUMENT,
3381+ line,
3382+ format!(
3383+ "{} takes no attributes: it is replaced by content, so style the \
3384+ element around it",
3385+ what
3386+ ),
3387+ )
3388+ .column(list.span.column),
3389+ );
3390+ }
3391+ if slot.is_slot() {
3392+ let name = slot.name();
3393+ if name.is_empty() {
3394+ return Some(Diagnostic::error(
3395+ code::MISSING_ARGUMENT,
3396+ line,
3397+ "@slot needs a name: `@slot footer` (the caller's content without a \
3398+ name goes where `@children` is)"
3399+ .to_string(),
3400+ ));
3401+ }
3402+ if !is_slot_name(name) {
3403+ let joined = name.split_whitespace().collect::<Vec<_>>().join("-");
3404+ let suggestion = is_slot_name(&joined).then_some(joined);
3405+ let column = slot.text.map(|t| t.span.column);
3406+ let d = Diagnostic::error(
3407+ code::INVALID_SLOT_NAME,
3408+ line,
3409+ format!(
3410+ "'{}' is not a slot name: a slot's name is one word of letters, digits, \
3411+ `-` and `_`, starting with a letter, and its content goes on the lines \
3412+ under it",
3413+ name
3414+ ),
3415+ )
3416+ .subject(name)
3417+ .suggest(suggestion);
3418+ return Some(match column {
3419+ Some(column) => d.column(column),
3420+ None => d,
3421+ });
3422+ }
3423+ if matches!(slot.at.place, Place::Call) || slot.at.body {
3424+ return None;
3425+ }
3426+ let message = match (slot.at.call, slot.at.place) {
3427+ (Some((call, call_line)), Place::Element(Some(element))) => format!(
3428+ "{} is inside @{}, so it fills nothing: a @slot block that fills a slot of \
3429+ @{} (line {}) goes directly under the call",
3430+ what, element, call, call_line
3431+ ),
3432+ _ => format!(
3433+ "{} is outside a function's body: `@slot NAME` marks a place in a body \
3434+ (`@let @name`), and directly under a call it fills one",
3435+ what
3436+ ),
3437+ };
3438+ return Some(Diagnostic::error(code::MISPLACED_SLOT, line, message));
3439+ }
3440+ if slot.at.body {
3441+ return None;
3442+ }
3443+ let message = match slot.at.call {
3444+ Some((call, _)) => format!(
3445+ "@children is outside a function's body, so it stands for nothing: the content \
3446+ for @{} is written directly under the call",
3447+ call
3448+ ),
3449+ None => "@children is outside a function's body: it marks where a body puts the \
3450+ content of each call"
3451+ .to_string(),
3452+ };
3453+ Some(Diagnostic::error(code::MISPLACED_SLOT, line, message))
3454+}
3455+
3456+/// A `@slot NAME` block that fills a slot of a call.
3457+struct Filler<'a> {
3458+ node: &'a syntax::Node,
3459+ text: &'a syntax::Text,
3460+ /// The include chain of the file it is in, when that isn't the file
3461+ /// being compiled.
3462+ file: Option<&'a str>,
3463+}
3464+
3465+/// Whether `@slot` is the built-in element here, and not a function
3466+/// defined so far that took its name.
3467+fn slot_is_built_in(ctx: &ParseContext) -> bool {
3468+ ctx.env.function("slot").is_none()
3469+}
3470+
3471+/// The `@slot NAME` blocks directly under a call, in `block` (under its
3472+/// `@if`, `@else` and `@each` too, and in the files its `@include` lines
3473+/// brought in).
3474+fn fillers<'a>(
3475+ block: &'a [syntax::Node],
3476+ file: Option<&'a str>,
3477+ included: &'a IncludedBy,
3478+ out: &mut Vec<Filler<'a>>,
3479+) {
3480+ for node in block {
3481+ match &node.kind {
3482+ NodeKind::Directive(directive)
3483+ if matches!(directive.name(), "if" | "else" | "each") =>
3484+ {
3485+ fillers(&node.children, file, included, out);
3486+ }
3487+ NodeKind::Directive(directive) if directive.name() == "include" => {
3488+ for (lines, file) in ran_includes(included, node) {
3489+ fillers(lines, file, included, out);
3490+ }
3491+ }
3492+ NodeKind::Element(line) if line.chain.len() == 1 && line.chain[0].name == "slot" => {
3493+ if let Some(text) = &line.text {
3494+ out.push(Filler { node, text, file });
3495+ }
3496+ }
3497+ _ => {}
3498+ }
3499+ }
3500+}
3501+
3502+/// Whether `block`, the lines under a call, holds content other than
3503+/// `@slot` blocks (under `@if`, `@else` and `@each` too): text, an
3504+/// element, raw HTML, Markdown or an included file. For code that doesn't
3505+/// run.
3506+fn holds_content(block: &[syntax::Node], ctx: &ParseContext) -> bool {
3507+ block.iter().any(|node| match &node.kind {
3508+ NodeKind::Directive(directive) => match directive.name() {
3509+ "if" | "else" | "each" => holds_content(&node.children, ctx),
3510+ name => matches!(name, "raw" | "markdown" | "include"),
3511+ },
3512+ NodeKind::Element(line) => {
3513+ line.chain[0].name != "slot" || !slot_is_built_in(ctx) || line.chain.len() > 1
3514+ }
3515+ NodeKind::Text(_) => true,
3516+ _ => false,
3517+ })
3518+}
3519+
3520+/// Check the `@slot NAME` blocks passed to each call of a line against
3521+/// the slots its function declares. `calls` has the function of each head
3522+/// of the chain that is a call.
3523+fn check_fillers(
3524+ node: &syntax::Node,
3525+ element: &syntax::ElementLine,
3526+ calls: &[Option<(String, Rc<FnDef>)>],
3527+ ctx: &mut ParseContext,
3528+) {
3529+ if !slot_is_built_in(ctx) {
3530+ return;
3531+ }
3532+ let included = ctx.included_by.clone();
3533+ let last = element.chain.len() - 1;
3534+ for (i, call) in calls.iter().enumerate() {
3535+ let Some((name, function)) = call else {
3536+ continue;
3537+ };
3538+ let mut found = Vec::new();
3539+ if i == last {
3540+ fillers(&node.children, None, &included, &mut found);
3541+ } else if i + 1 == last
3542+ && element.chain[last].name == "slot"
3543+ && let Some(text) = &element.text
3544+ {
3545+ // `@card > @slot footer`
3546+ found.push(Filler {
3547+ node,
3548+ text,
3549+ file: None,
3550+ });
3551+ }
3552+ for filler in found {
3553+ let slot = filler.text.raw.trim();
3554+ if !is_slot_name(slot) || function.slots.iter().any(|s| s == slot) {
3555+ continue;
3556+ }
3557+ let mut d = unknown_slot(name, slot, &function.slots, filler.text.span.line)
3558+ .column(filler.text.span.column)
3559+ .source(written_line(filler.node));
3560+ if let Some(file) = filler.file {
3561+ d.message = format!("{}\n in {}", d.message, file);
3562+ }
3563+ ctx.push_once(d);
3564+ }
3565+ }
3566+}
3567+
3568+/// A `@slot NAME` block for a slot the function doesn't declare.
3569+fn unknown_slot(function: &str, slot: &str, slots: &[String], line: usize) -> Diagnostic {
3570+ let candidates: Vec<&str> = slots.iter().map(String::as_str).collect();
3571+ let suggestion = suggest_closest(slot, &candidates);
3572+ let message = match (slots.is_empty(), suggestion) {
3573+ (true, _) => format!(
3574+ "@{} has no slot '{}': its body declares no slots (`@slot NAME`)",
3575+ function, slot
3576+ ),
3577+ (false, Some(close)) => format!(
3578+ "@{} has no slot '{}', did you mean '{}'? (its slots: {})",
3579+ function,
3580+ slot,
3581+ close,
3582+ slots.join(", ")
3583+ ),
3584+ (false, None) => format!(
3585+ "@{} has no slot '{}' (its slots: {})",
3586+ function,
3587+ slot,
3588+ slots.join(", ")
3589+ ),
3590+ };
3591+ Diagnostic::error(code::UNKNOWN_SLOT, line, message)
3592+ .subject(slot)
3593+ .suggest(suggestion)
3594+}
3595+
3596+/// Content passed to a function whose body has no `@children`.
3597+fn no_children(function: &str, line: usize, column: Option<usize>) -> Diagnostic {
3598+ let d = Diagnostic::error(
3599+ code::UNEXPECTED_CONTENT,
3600+ line,
3601+ format!(
3602+ "@{0} takes no content: its body has no `@children`, so the text and lines \
3603+ passed to it would be dropped (pass text as a parameter, `@{0} [name value]`, \
3604+ or add `@children` to the body)",
3605+ function
3606+ ),
3607+ )
3608+ .subject(function);
3609+ match column {
3610+ Some(column) => d.column(column),
3611+ None => d,
3612+ }
3613+}
3614+
3615+// ---------------------------------------------------------------------------
3616+// Element parsing
3617+// ---------------------------------------------------------------------------
3618+
3619+/// Build the element for `@name [attrs] text` (on its own line, in a chain,
3620+/// or inline in text).
3621+fn parse_single_element(
3622+ head: &syntax::Head,
3623+ text: Option<&syntax::Text>,
3624+ line_num: usize,
3625+ ctx: &mut ParseContext,
3626+) -> Result<Element, ParseError> {
3627+ let kind = parse_element_kind(&head.name, line_num, ctx)?;
3628+ let mut attrs = head.attrs.as_ref().map_or_else(Vec::new, |list| {
3629+ parse_attr_list(&list.attrs, line_num, ctx, true, &[])
3630+ });
3631+
3632+ // The leading argument: for an element whose row names a leading
3633+ // attribute (`@link`'s href, `@image`'s src, `@form`'s action, ...),
3634+ // the first token of the text fills it, split before anything is
3635+ // filled in, and the rest is content (an error on an element without
3636+ // content). `@slot`'s whole text is its name. Any other element's text
3637+ // is content, parsed like any line of text, as in `@el [padding 8]
3638+ // Hello` or `@h2 Meet {@text htmlang}`; its layout decides how it
3639+ // combines with the lines under it.
3640+ let mut children = Vec::new();
3641+ let mut argument = None;
3642+ let leading = kind.arg().attributes();
3643+ match text {
3644+ Some(text) if !leading.is_empty() => {
3645+ let (token, rest) = text.split_leading();
3646+ let given = attrs
3647+ .iter()
3648+ .find(|a| a.html && leading.contains(&a.key.as_str()))
3649+ .map(|a| (a.key.clone(), a.value.clone().unwrap_or_default()));
3650+ if let Some((key, value)) = given {
3651+ // The attribute wins; the text is content, as if the
3652+ // element had no leading argument
3653+ ctx.push_once(leading_twice(&kind, &token, &key, &value, text, ctx));
3654+ if !takes_no_text(&kind) {
3655+ children.push(Node::Text(text_segments(text, ctx)));
3656+ }
3657+ } else if let Some(d) = bad_leading_token(&kind, &token, &text.raw, ctx) {
3658+ // Nothing is taken as the argument; the line is content
3659+ ctx.push_once(d);
3660+ if !takes_no_text(&kind) {
3661+ children.push(Node::Text(text_segments(text, ctx)));
3662+ }
3663+ } else {
3664+ let column = Some(token.span.column);
3665+ if let Some(d) = text_as_url(&kind, &token, ctx) {
3666+ ctx.push_once(d);
3667+ }
3668+ argument = Some(
3669+ ctx.fill_value(&token.raw, text.span.line, column, Sink::Text)
3670+ .0,
3671+ );
3672+ if let Some(rest) = rest {
3673+ if let Some(d) = chain_after_argument(&kind, &token.raw, &rest, ctx) {
3674+ ctx.push_once(d);
3675+ }
3676+ if takes_no_text(&kind) {
3677+ let d = after_the_leading_argument(&kind, &token.raw, &rest);
3678+ let d = at_attribute(d, Some(rest.span.column), ctx);
3679+ ctx.push_once(d);
3680+ } else {
3681+ children.push(Node::Text(text_segments(&rest, ctx)));
3682+ }
3683+ }
3684+ }
3685+ }
3686+ Some(text) if matches!(kind, ElementKind::Slot(_)) => {
3687+ argument =
3688+ Some(ctx.interpolate_text(&text.raw, text.span.line, Some(text.span.column)));
3689+ }
3690+ Some(text) => children.push(Node::Text(text_segments(text, ctx))),
3691+ // `@link [href=/about]`: the attribute is the leading argument, so
3692+ // both forms compile the same (`@image [src=a.svg, inline]`). Not
3693+ // for `@source`, whose attribute depends on where it is.
3694+ None if leading.len() == 1 => {
3695+ if let Some(i) = attrs.iter().position(|a| a.html && a.key == leading[0]) {
3696+ argument = Some(attrs.remove(i).value.unwrap_or_default());
3697+ }
3698+ }
3699+ None => {}
3700+ }
3701+
3702+ // For @slot, the argument is the slot name
3703+ let kind = if let ElementKind::Slot(_) = kind {
3704+ ElementKind::Slot(argument.clone().unwrap_or_default())
3705+ } else {
3706+ kind
3707+ };
3708+
3709+ Ok(Element {
3710+ kind,
3711+ attrs,
3712+ argument,
3713+ children,
3714+ line_num,
3715+ function: None,
3716+ })
3717+}
3718+
3719+/// Whether `node` or a line inside it calls `@name` outside any `@if`
3720+/// (in a chain, or inline in text).
3721+fn calls_unguarded(node: &syntax::Node, name: &str) -> bool {
3722+ if node.is_directive("if") || node.is_directive("else") {
3723+ return false;
3724+ }
3725+ let text_calls = |text: &syntax::Text| {
3726+ text.segments
3727+ .iter()
3728+ .any(|s| matches!(s, Segment::Inline(inline) if inline.head.name == name))
3729+ };
3730+ let here = match &node.kind {
3731+ NodeKind::Element(element) => {
3732+ element.chain.iter().any(|head| head.name == name)
3733+ || element.text.as_ref().is_some_and(text_calls)
3734+ }
3735+ NodeKind::Text(text) => text_calls(text),
3736+ _ => false,
3737+ };
3738+ here || node
3739+ .children
3740+ .iter()
3741+ .any(|child| calls_unguarded(child, name))
3742+}
3743+
3744+/// `@td [padding 8] @children`: `@children` and `@slot NAME` mark where a
3745+/// call's content goes only on a line of their own; after an element's
3746+/// attributes, or in a verbatim body, they are text.
3747+fn marker_in_text(node: &syntax::Node) -> Option<Diagnostic> {
3748+ let is_marker = |text: &str| {
3749+ let text = text.trim();
3750+ text == "@children" || text == "@slot" || text.starts_with("@slot ")
3751+ };
3752+ let mut line = node.span.line;
3753+ let mut source = written_line(node);
3754+ let (marker, message) = match &node.kind {
3755+ NodeKind::Element(element) => {
3756+ let text = element.text.as_ref()?;
3757+ if !is_marker(&text.raw) {
3758+ return None;
3759+ }
3760+ let name = &element.chain.last()?.name;
3761+ let marker = text.raw.trim().to_string();
3762+ let message = format!(
3763+ "`{marker}` after @{name}'s attributes is text: it marks where a call's content \
3764+ goes only on a line of its own, so write it on the next line, indented under \
3765+ @{name}"
3766+ );
3767+ (marker, message)
3768+ }
3769+ NodeKind::Verbatim(verbatim) if verbatim.escaped => {
3770+ let (i, written) = verbatim
3771+ .text
3772+ .lines()
3773+ .enumerate()
3774+ .find(|(_, l)| is_marker(l))?;
3775+ let marker = written.trim().to_string();
3776+ line += i;
3777+ source = written.to_string();
3778+ let message = format!(
3779+ "`{marker}` in a verbatim body is text: the body is written as it is, so it can't \
3780+ hold a call's content (pass the text as a parameter instead)"
3781+ );
3782+ (marker, message)
3783+ }
3784+ _ => return None,
3785+ };
3786+ Some(
3787+ Diagnostic::error(code::MISPLACED_SLOT, line, message)
3788+ .subject(marker)
3789+ .source(source),
3790+ )
3791+}
3792+
3793+/// A first word that can't be a leading argument: an inline element
3794+/// (`@link {@b x} y`), or a quote that isn't closed (`@link "a b`).
3795+fn bad_leading_token(
3796+ kind: &ElementKind,
3797+ token: &syntax::Arg,
3798+ text: &str,
3799+ ctx: &ParseContext,
3800+) -> Option<Diagnostic> {
3801+ let what = leading_name(kind);
3802+ let name = kind.name();
3803+ let message = if token.raw.starts_with("{@") {
3804+ format!(
3805+ "@{0} takes its {1} first, before any text: write `@{0} VALUE {2}`, or give it as \
3806+ `[{1}=VALUE]`",
3807+ name,
3808+ what,
3809+ text.trim()
3810+ )
3811+ } else if token.raw.starts_with('"') && syntax::quoted_string(&token.raw).is_none() {
3812+ format!(
3813+ "@{}'s {} starts with a `\"` that isn't closed: close it (`\"...\"`), or write \
3814+ `\\\"` for a quote in the value",
3815+ name, what
3816+ )
3817+ } else {
3818+ return None;
3819+ };
3820+ let d = Diagnostic::error(code::UNEXPECTED_ARGUMENT, token.span.line, message)
3821+ .subject(token.raw.clone());
3822+ Some(at_attribute(d, Some(token.span.column), ctx))
3823+}
3824+
3825+/// A first word taken as a URL that reads as text: a word with a capital
3826+/// and nothing a URL or a file name has, as in `@link [hx-get=/panel] Open
3827+/// panel`, whose href would be `Open`. It still is (a relative URL can be
3828+/// such a word), with a warning.
3829+fn text_as_url(kind: &ElementKind, token: &syntax::Arg, ctx: &ParseContext) -> Option<Diagnostic> {
3830+ const URLS: &[&str] = &["href", "src", "srcset", "action", "data"];
3831+ let word = token.raw.as_str();
3832+ let reads_as_text = word.starts_with(char::is_uppercase)
3833+ && !word.contains([
3834+ '/', '.', ':', '#', '?', '=', '&', '%', '~', '$', '{', '\\', '"',
3835+ ]);
3836+ if !reads_as_text || !kind.arg().attributes().iter().any(|a| URLS.contains(a)) {
3837+ return None;
3838+ }
3839+ let name = kind.name();
3840+ let attr = leading_name(kind);
3841+ let text = if takes_no_text(kind) {
3842+ String::new()
3843+ } else {
3844+ format!(": write the {attr} before the text, or put the text on the lines under it")
3845+ };
3846+ let message = format!(
3847+ "@{name} takes '{word}', its first word, as its {attr}{text}. A relative URL that \
3848+ starts with a capital is written `./{word}`"
3849+ );
3850+ let d = Diagnostic::warning(code::TEXT_AS_URL, token.span.line, message).subject(word);
3851+ Some(at_attribute(d, Some(token.span.column), ctx))
3852+}
3853+
3854+/// `@link /a > @image logo.png`: a `>` chains only after an element's
3855+/// name or its `[attributes]`, so after a leading argument it is text.
3856+/// Said when what follows names an element or a function.
3857+fn chain_after_argument(
3858+ kind: &ElementKind,
3859+ token: &str,
3860+ rest: &syntax::Text,
3861+ ctx: &ParseContext,
3862+) -> Option<Diagnostic> {
3863+ let after = rest.raw.strip_prefix('>')?;
3864+ let name_start = after.trim_start().strip_prefix('@')?;
3865+ if after.len() == after.trim_start().len() {
3866+ return None;
3867+ }
3868+ let name: String = name_start
3869+ .chars()
3870+ .take_while(|c| c.is_ascii_alphanumeric() || *c == '-')
3871+ .collect();
3872+ if ElementKind::from_name(&name).is_none() && ctx.env.function(&name).is_none() {
3873+ return None;
3874+ }
3875+ let attr = leading_name(kind);
3876+ let d = Diagnostic::warning(
3877+ code::UNEXPECTED_ARGUMENT,
3878+ rest.span.line,
3879+ format!(
3880+ "`{}` after @{}'s {} is text, not a chain: `>` chains after an element's name or \
3881+ its [attributes], so write `@{} [{}={}] {}`",
3882+ rest.raw.trim_end(),
3883+ kind.name(),
3884+ attr,
3885+ kind.name(),
3886+ attr,
3887+ token,
3888+ rest.raw.trim_end()
3889+ ),
3890+ )
3891+ .subject(rest.raw.trim_end());
3892+ Some(at_attribute(d, Some(rest.span.column), ctx))
3893+}
3894+
3895+/// A leading argument given twice, as the first token and as its
3896+/// attribute: `@link [href=/a] About`.
3897+fn leading_twice(
3898+ kind: &ElementKind,
3899+ token: &syntax::Arg,
3900+ key: &str,
3901+ value: &str,
3902+ text: &syntax::Text,
3903+ ctx: &ParseContext,
3904+) -> Diagnostic {
3905+ let name = kind.name();
3906+ let what = leading_name(kind);
3907+ // The value as one token: quoted when it is empty or has a space in it
3908+ let value = if !value.is_empty() && syntax::leading_token_len(value) == value.len() {
3909+ value.to_string()
3910+ } else {
3911+ format!("\"{}\"", value.replace('\\', "\\\\").replace('"', "\\\""))
3912+ };
3913+ let written = if takes_no_text(kind) {
3914+ format!("@{} {}", name, value)
3915+ } else {
3916+ format!("@{} {} {}", name, value, text.raw)
3917+ };
3918+ let d = Diagnostic::error(
3919+ code::DUPLICATE_ATTRIBUTE,
3920+ text.span.line,
3921+ format!(
3922+ "@{} takes its first word '{}' as its {}, and it also has {}=: give it once, \
3923+ as `{}`",
3924+ name, token.raw, what, key, written
3925+ ),
3926+ )
3927+ .subject(token.raw.clone());
3928+ at_attribute(d, Some(token.span.column), ctx)
3929+}
3930+
3931+/// The attribute an element's leading argument fills, for messages.
3932+fn leading_name(kind: &ElementKind) -> &'static str {
3933+ match kind.arg() {
3934+ TagArg::Source => "srcset in @picture or src elsewhere",
3935+ arg => arg.attribute(false).unwrap_or("argument"),
3936+ }
3937+}
3938+
3939+/// Whether text after an element's leading argument has nowhere to go:
3940+/// an element without content (`@image`, `@source`, ...), or `@optgroup`,
3941+/// which holds only `@option` lines, so `@optgroup Citrus fruits` would
3942+/// otherwise make `Citrus` the label and drop `fruits`.
3943+fn takes_no_text(kind: &ElementKind) -> bool {
3944+ kind.layout() == Layout::Void || kind.is_tag("optgroup")
3945+}
3946+
3947+/// Text after the leading argument of an element without content:
3948+/// `@image logo.png Our logo`.
3949+fn after_the_leading_argument(kind: &ElementKind, token: &str, rest: &syntax::Text) -> Diagnostic {
3950+ let name = kind.name();
3951+ let attr = leading_name(kind);
3952+ let alt = if matches!(kind, ElementKind::Image) || kind.is_tag("area") {
3953+ " For a text alternative, write `alt=...`."
3954+ } else {
3955+ ""
3956+ };
3957+ let holds = if kind.layout() == Layout::Void {
3958+ "it has no content"
3959+ } else {
3960+ "it holds only the elements on the lines under it"
3961+ };
3962+ let bare = syntax::quoted_string(token).unwrap_or(token);
3963+ Diagnostic::error(
3964+ code::UNEXPECTED_ARGUMENT,
3965+ rest.span.line,
3966+ format!(
3967+ "@{0} takes one word after its attributes, its {1} ('{2}'), and {5}, so '{3}' \
3968+ would go nowhere. A value with a space in it is quoted: `\"{6} {3}\"`.{4}",
3969+ name, attr, token, rest.raw, alt, holds, bare
3970+ ),
3971+ )
3972+ .subject(rest.raw.clone())
3973+}
3974+
3975+/// The element named `name`, or an "unknown element" error that suggests
3976+/// the closest element, directive or function.
3977+fn parse_element_kind(
3978+ name: &str,
3979+ line_num: usize,
3980+ ctx: &mut ParseContext,
3981+) -> Result<ElementKind, ParseError> {
3982+ if let Some(kind) = ElementKind::from_name(name) {
3983+ return Ok(kind);
3984+ }
3985+ // A known name in a place it can't go: say why instead of suggesting
3986+ // the name itself.
3987+ let misplaced = if crate::ast::directive(name).is_some() {
3988+ Some(format!(
3989+ "unknown element @{}: @{} is a directive, which goes at the start of its own line",
3990+ name, name
3991+ ))
3992+ } else if ctx.env.bundle(name).is_some() {
3993+ Some(format!(
3994+ "unknown element @{}: '{}' is an attribute bundle, used as `[${}]` \
3995+ (a function is defined with `@let @{}`)",
3996+ name, name, name, name
3997+ ))
3998+ } else if ctx.env.value(name).is_some() {
3999+ Some(format!(
4000+ "unknown element @{}: '{}' is a value, used as `${}` \
4001+ (a function is defined with `@let @{}`)",
4002+ name, name, name, name
4003+ ))
4004+ } else if ctx.namespace.contains(name) {
4005+ ctx.used_functions.insert(name.to_string());
4006+ Some(format!(
4007+ "unknown element @{}: the function @{} isn't visible here. A definition is \
4008+ visible from its line to the end of its block, and a function's body sees what \
4009+ is defined above the function, so define @{} above this line, outside the block \
4010+ it is in",
4011+ name, name, name
4012+ ))
4013+ } else if matches!(name, "svg" | "math" | "template") {
4014+ Some(format!(
4015+ "unknown element @{}: htmlang doesn't write <{}>; put its markup in the page with \
4016+ @raw{}",
4017+ name,
4018+ name,
4019+ if name == "svg" {
4020+ " (or an SVG file with `@image [inline] file.svg`)"
4021+ } else {
4022+ ""
4023+ }
4024+ ))
4025+ } else {
4026+ None
4027+ };
4028+ if let Some(message) = misplaced {
4029+ return Err(Diagnostic::error(code::UNKNOWN_ELEMENT, line_num, message).subject(name));
4030+ }
4031+ let all_known: Vec<&str> = ElementKind::all_names()
4032+ .chain(DIRECTIVES.iter().map(|d| d.name))
4033+ .collect();
4034+ // An HTML element htmlang writes under its own name (`@a` is `@link`).
4035+ let written_otherwise = crate::ast::HTML_NAMES_WRITTEN_OTHERWISE
4036+ .iter()
4037+ .find(|(html, _)| *html == name)
4038+ .map(|(_, htmlang)| *htmlang);
4039+ let closest = written_otherwise.or_else(|| suggest_closest(name, &all_known));
4040+ let mut message = match (closest, written_otherwise) {
4041+ (Some(closest), Some(_)) => format!(
4042+ "unknown element @{}, did you mean @{}? (@{} writes <{}>)",
4043+ name, closest, closest, name
4044+ ),
4045+ (Some(closest), None) => format!("unknown element @{}, did you mean @{}?", name, closest),
4046+ (None, _) => format!("unknown element @{}", name),
4047+ };
4048+ let function = suggest_fn_name(name, ctx);
4049+ if let Some(function) = &function {
4050+ message = format!("{}, or did you mean @{}?", message, function);
4051+ }
4052+ Err(Diagnostic::error(code::UNKNOWN_ELEMENT, line_num, message)
4053+ .subject(name)
4054+ .suggest(closest.map(str::to_string).or(function)))
4055+}
4056+
4057+/// Format include/import stack as a readable chain for error messages.
4058+fn format_include_chain(stack: &[PathBuf]) -> String {
4059+ stack
4060+ .iter()
4061+ .map(|p| {
4062+ p.file_name()
4063+ .unwrap_or_default()
4064+ .to_string_lossy()
4065+ .to_string()
4066+ })
4067+ .collect::<Vec<_>>()
4068+ .join(" → ")
4069+}
4070+
4071+/// Levenshtein distance with a rolling two-row buffer (O(min(a,b)) memory) and an
4072+/// early-exit cutoff: if every cell in a row exceeds `cutoff`, no further cell can
4073+/// be <= `cutoff`, so we return `cutoff + 1` immediately. Used for typo-suggestion
4074+/// hot paths where we only care about distances <= 2.
4075+fn levenshtein_bounded(a: &[char], b: &[char], cutoff: usize) -> usize {
4076+ let (a, b) = if a.len() > b.len() { (b, a) } else { (a, b) };
4077+ if b.len() - a.len() > cutoff {
4078+ return cutoff + 1;
4079+ }
4080+ if a.is_empty() {
4081+ return b.len();
4082+ }
4083+
4084+ let mut prev: Vec<usize> = (0..=a.len()).collect();
4085+ let mut curr: Vec<usize> = vec![0; a.len() + 1];
4086+
4087+ for (j, &bc) in b.iter().enumerate() {
4088+ curr[0] = j + 1;
4089+ let mut row_min = curr[0];
4090+ for (i, &ac) in a.iter().enumerate() {
4091+ let cost = if ac == bc { 0 } else { 1 };
4092+ curr[i + 1] = (prev[i + 1] + 1).min(curr[i] + 1).min(prev[i] + cost);
4093+ row_min = row_min.min(curr[i + 1]);
4094+ }
4095+ if row_min > cutoff {
4096+ return cutoff + 1;
4097+ }
4098+ std::mem::swap(&mut prev, &mut curr);
4099+ }
4100+ prev[a.len()]
4101+}
4102+
4103+fn suggest_closest<'a>(input: &str, candidates: &[&'a str]) -> Option<&'a str> {
4104+ let input_chars: Vec<char> = input.chars().collect();
4105+ let max_allowed = 2usize.min(input_chars.len().saturating_sub(1));
4106+ let mut best = None;
4107+ let mut best_dist = usize::MAX;
4108+ for &candidate in candidates {
4109+ // Cheap length-based prune before allocating chars.
4110+ let clen = candidate.chars().count();
4111+ let diff = clen.abs_diff(input_chars.len());
4112+ if diff > max_allowed {
4113+ continue;
4114+ }
4115+ let cand_chars: Vec<char> = candidate.chars().collect();
4116+ let dist = levenshtein_bounded(&input_chars, &cand_chars, max_allowed);
4117+ if dist < best_dist && dist <= max_allowed {
4118+ best_dist = dist;
4119+ best = Some(candidate);
4120+ }
4121+ }
4122+ best
4123+}
4124+
4125+/// Suggest the closest user-defined function name for typos, from the
4126+/// functions defined so far and those defined anywhere in the file.
4127+fn suggest_fn_name(input: &str, ctx: &ParseContext) -> Option<String> {
4128+ let input_chars: Vec<char> = input.chars().collect();
4129+ let max_allowed = 2usize.min(input_chars.len().saturating_sub(1));
4130+ let mut best: Option<(usize, &String)> = None;
4131+ let visible: Vec<&String> = ctx.defined_functions.keys().collect();
4132+ for name in visible.into_iter().chain(ctx.namespace.iter()) {
4133+ let nlen = name.chars().count();
4134+ if nlen.abs_diff(input_chars.len()) > max_allowed {
4135+ continue;
4136+ }
4137+ let name_chars: Vec<char> = name.chars().collect();
4138+ let dist = levenshtein_bounded(&input_chars, &name_chars, max_allowed);
4139+ if dist <= max_allowed && best.is_none_or(|b| (dist, name) < b) {
4140+ best = Some((dist, name));
4141+ }
4142+ }
4143+ best.map(|(_, name)| name.clone())
4144+}
4145+
4146+/// Suggest the closest variable name for undefined `$var` references.
4147+fn suggest_var_name(input: &str, vars: &[&str]) -> Option<String> {
4148+ let input_chars: Vec<char> = input.chars().collect();
4149+ let max_allowed = 2usize.min(input_chars.len().saturating_sub(1));
4150+ let mut best: Option<String> = None;
4151+ let mut best_dist = usize::MAX;
4152+ let mut vars = vars.to_vec();
4153+ // The same answer every time, whatever the order of the names
4154+ vars.sort_unstable();
4155+ for name in vars {
4156+ let nlen = name.chars().count();
4157+ if nlen.abs_diff(input_chars.len()) > max_allowed {
4158+ continue;
4159+ }
4160+ let name_chars: Vec<char> = name.chars().collect();
4161+ let dist = levenshtein_bounded(&input_chars, &name_chars, max_allowed);
4162+ if dist < best_dist && dist <= max_allowed {
4163+ best_dist = dist;
4164+ best = Some(name.to_string());
4165+ }
4166+ }
4167+ best
4168+}
4169+
4170+// ---------------------------------------------------------------------------
4171+// Attribute parsing
4172+// ---------------------------------------------------------------------------
4173+
4174+/// The quoted strings of a CSS value, without their quotes.
4175+fn css_strings(value: &str) -> Vec<&str> {
4176+ let mut strings = Vec::new();
4177+ let mut start = None;
4178+ let mut escaped = false;
4179+ for (i, c) in value.char_indices() {
4180+ match (c, start) {
4181+ _ if escaped => escaped = false,
4182+ ('\\', Some(_)) => escaped = true,
4183+ ('"', None) => start = Some(i + 1),
4184+ ('"', Some(from)) => {
4185+ strings.push(&value[from..i]);
4186+ start = None;
4187+ }
4188+ _ => {}
4189+ }
4190+ }
4191+ strings
4192+}
4193+
4194+/// An `if(...)` in a CSS value that isn't CSS's if(): CSS writes each
4195+/// branch `CONDITION: VALUE`, so an if() without a `:` is something else.
4196+/// Quoted CSS strings are text, not calls.
4197+fn not_css_if(value: &str) -> Option<&str> {
4198+ let mut quote = None;
4199+ let mut prev = None;
4200+ let mut chars = value.char_indices();
4201+ while let Some((at, c)) = chars.next() {
4202+ match quote {
4203+ Some(_) if c == '\\' => {
4204+ chars.next();
4205+ }
4206+ Some(q) if c == q => quote = None,
4207+ Some(_) => {}
4208+ None if matches!(c, '"' | '\'') => quote = Some(c),
4209+ None => {
4210+ let word_before =
4211+ prev.is_some_and(|p: char| p.is_alphanumeric() || matches!(p, '-' | '_'));
4212+ if !word_before && value[at..].starts_with("if(") {
4213+ let mut depth = 0;
4214+ let close = value[at + 2..].char_indices().find_map(|(i, c)| {
4215+ match c {
4216+ '(' => depth += 1,
4217+ ')' => depth -= 1,
4218+ _ => {}
4219+ }
4220+ (depth == 0).then_some(at + 2 + i)
4221+ });
4222+ let end = close.map_or(value.len(), |c| c + 1);
4223+ if !value[at + 3..end].contains(':') {
4224+ return Some(&value[at..end]);
4225+ }
4226+ }
4227+ }
4228+ }
4229+ prev = Some(c);
4230+ }
4231+ None
4232+}
4233+
4234+/// Why a CSS value can't be written into a rule as it is, whatever it
4235+/// means: a `;` (outside parentheses, where CSS's own `if()` uses it), a
4236+/// `{` or a `}` would end the declaration or the rule, and an unclosed
4237+/// quote or parenthesis would run on into the rules after it. Quoted
4238+/// strings are text, and a backslash escapes the character after it, as
4239+/// in CSS. A `</style` anywhere, even in a string, would end the page's
4240+/// `<style>` element and start HTML.
4241+fn css_breakout(value: &str) -> Option<&'static str> {
4242+ if value.to_ascii_lowercase().contains("</style") {
4243+ return Some("a `</style`, which would end the page's style element");
4244+ }
4245+ let mut quote = None;
4246+ let mut depth = 0usize;
4247+ let mut chars = value.chars();
4248+ while let Some(c) = chars.next() {
4249+ match (quote, c) {
4250+ (_, '\\') => {
4251+ chars.next();
4252+ }
4253+ (Some(q), c) if c == q => quote = None,
4254+ (Some(_), _) => {}
4255+ (None, '"' | '\'') => quote = Some(c),
4256+ (None, '(') => depth += 1,
4257+ (None, ')') if depth == 0 => return Some("a `)` that closes nothing"),
4258+ (None, ')') => depth -= 1,
4259+ (None, ';') if depth == 0 => return Some("a `;`, which would end the declaration"),
4260+ (None, '{' | '}') => return Some("a `{` or `}`, which would end the CSS rule"),
4261+ _ => {}
4262+ }
4263+ }
4264+ match (quote, depth) {
4265+ (Some('"'), _) => Some("a `\"` that isn't closed"),
4266+ (Some(_), _) => Some("a `'` that isn't closed"),
4267+ (None, 0) => None,
4268+ (None, _) => Some("a `(` that isn't closed"),
4269+ }
4270+}
4271+
4272+/// The hex colors of a CSS value that don't have 3, 4, 6 or 8 hex
4273+/// digits. A `#` word in a CSS value is a color, except inside `url(...)`
4274+/// and quoted strings.
4275+fn bad_hex_colors(value: &str) -> Vec<&str> {
4276+ let mut bad = Vec::new();
4277+ let mut quote = None;
4278+ let mut in_url = 0usize;
4279+ let mut depth = 0usize;
4280+ let mut chars = value.char_indices().peekable();
4281+ while let Some((at, c)) = chars.next() {
4282+ match (quote, c) {
4283+ (_, '\\') => {
4284+ chars.next();
4285+ }
4286+ (Some(q), c) if c == q => quote = None,
4287+ (Some(_), _) => {}
4288+ (None, '"' | '\'') => quote = Some(c),
4289+ (None, '(') => {
4290+ depth += 1;
4291+ if value[..at].ends_with("url") && in_url == 0 {
4292+ in_url = depth;
4293+ }
4294+ }
4295+ (None, ')') => {
4296+ if in_url == depth {
4297+ in_url = 0;
4298+ }
4299+ depth = depth.saturating_sub(1);
4300+ }
4301+ (None, '#') if in_url == 0 => {
4302+ let end = value[at + 1..]
4303+ .find(|c: char| !(c.is_alphanumeric() || c == '-' || c == '_'))
4304+ .map_or(value.len(), |n| at + 1 + n);
4305+ let hex = &value[at + 1..end];
4306+ if !(matches!(hex.len(), 3 | 4 | 6 | 8)
4307+ && hex.chars().all(|c| c.is_ascii_hexdigit()))
4308+ {
4309+ bad.push(&value[at..end]);
4310+ }
4311+ }
4312+ _ => {}
4313+ }
4314+ }
4315+ bad
4316+}
4317+
4318+/// A diagnostic about an attribute, with its column and source line when
4319+/// it is on the line being evaluated.
4320+fn at_attribute(diagnostic: Diagnostic, column: Option<usize>, ctx: &ParseContext) -> Diagnostic {
4321+ match (&ctx.current_source, column) {
4322+ ((current, Some(text)), Some(column)) if *current == diagnostic.line => {
4323+ diagnostic.column(column).source(text.clone())
4324+ }
4325+ _ => diagnostic,
4326+ }
4327+}
4328+
4329+/// Check a style's value. Values go to the CSS as written, so only what
4330+/// can't be wrong in any CSS is checked: a value that would break out of
4331+/// its rule is an error (and it is left out); a hex color without 3, 4, 6
4332+/// or 8 digits, an `if()` that isn't CSS's and a quoted font stack are
4333+/// warnings. Returns whether the value can be written.
4334+fn check_css_value(
4335+ attr: &Attribute,
4336+ base: &str,
4337+ line: usize,
4338+ column: Option<usize>,
4339+ ctx: &mut ParseContext,
4340+) -> bool {
4341+ let Some(value) = &attr.value else {
4342+ return true;
4343+ };
4344+ if let Some(reason) = css_breakout(value) {
4345+ let diagnostic = Diagnostic::error(
4346+ code::INVALID_VALUE,
4347+ line,
4348+ format!(
4349+ "the value of '{}' has {}: `{}` can't be written into the page's CSS",
4350+ attr.key, reason, value
4351+ ),
4352+ )
4353+ .subject(value.as_str());
4354+ ctx.diagnostics.push(at_attribute(diagnostic, column, ctx));
4355+ return false;
4356+ }
4357+ if crate::vocab::is_custom_property(base) {
4358+ return true;
4359+ }
4360+
4361+ let warn = |ctx: &mut ParseContext, diagnostic: Diagnostic| {
4362+ let diagnostic = at_attribute(diagnostic, column, ctx);
4363+ ctx.diagnostics.push(diagnostic);
4364+ };
4365+ // In CSS, a quoted font-family is one family, commas and all
4366+ if base == "font-family"
4367+ && let Some(family) = css_strings(value).into_iter().find(|s| s.contains(','))
4368+ {
4369+ let stack = family
4370+ .split(',')
4371+ .map(str::trim)
4372+ .collect::<Vec<_>>()
4373+ .join("\\, ");
4374+ warn(
4375+ ctx,
4376+ Diagnostic::warning(
4377+ code::INVALID_VALUE,
4378+ line,
4379+ format!(
4380+ "font-family \"{}\" is one family, whose name has a comma in it: \
4381+ for a font stack, write `font-family {}`",
4382+ family, stack
4383+ ),
4384+ )
4385+ .subject(format!("\"{}\"", family))
4386+ .suggest(Some(stack)),
4387+ );
4388+ }
4389+ if let Some(call) = not_css_if(value) {
4390+ warn(
4391+ ctx,
4392+ Diagnostic::warning(
4393+ code::INVALID_VALUE,
4394+ line,
4395+ format!(
4396+ "'{}' is not CSS's if(), whose branches are written \
4397+ `if(CONDITION: VALUE; else: VALUE)`",
4398+ call
4399+ ),
4400+ )
4401+ .subject(call),
4402+ );
4403+ }
4404+ for color in bad_hex_colors(value) {
4405+ warn(
4406+ ctx,
4407+ Diagnostic::warning(
4408+ code::INVALID_COLOR,
4409+ line,
4410+ format!(
4411+ "invalid hex color '{}': a hex color has 3, 4, 6 or 8 hex digits",
4412+ color
4413+ ),
4414+ )
4415+ .subject(color),
4416+ );
4417+ }
4418+ true
4419+}
4420+
4421+/// An unknown prefix: the message, the text it is about, and what to write
4422+/// instead, when something is close enough.
4423+struct PrefixProblem {
4424+ message: String,
4425+ subject: String,
4426+ suggestion: Option<String>,
4427+}
4428+
4429+/// What is wrong with the prefix `rest` starts with, when the known
4430+/// prefixes are already split off it and what is left still starts with
4431+/// one: a word and a `:` (`hovr:`), or a word and a parenthesised argument
4432+/// and a `:` (`nth-chld(2):`). Selector prefixes are CSS's pseudo-classes
4433+/// and pseudo-elements under their CSS names, so an unknown one gets the
4434+/// closest name as a suggestion. Only names with the same first letter are
4435+/// suggested: `odd:` is two edits from `md:`, which it doesn't mean.
4436+fn unknown_prefix(rest: &str) -> Option<PrefixProblem> {
4437+ use crate::vocab::{self, Pseudo};
4438+ let name_len = rest.find(|c: char| !(c.is_ascii_alphanumeric() || c == '-'))?;
4439+ let name = &rest[..name_len];
4440+ if name.is_empty() {
4441+ return None;
4442+ }
4443+ if rest[name_len..].starts_with('(') {
4444+ // `name(...):`: a pseudo-class with an argument
4445+ let close = vocab::closing_paren(rest, name_len)?;
4446+ if !rest[close + 1..].starts_with(':') {
4447+ return None;
4448+ }
4449+ let written = &rest[..close + 2];
4450+ if matches!(vocab::pseudo(name), Some(Pseudo::Class | Pseudo::Element)) {
4451+ let bare = format!("{}:", name);
4452+ return Some(PrefixProblem {
4453+ message: format!(
4454+ "'{}': `{}` takes no argument: write `{}`",
4455+ written,
4456+ vocab::pseudo_selector(&bare).unwrap_or_default(),
4457+ bare
4458+ ),
4459+ subject: written.to_string(),
4460+ suggestion: Some(bare),
4461+ });
4462+ }
4463+ let functional: Vec<&str> = vocab::functional_pseudos()
4464+ .into_iter()
4465+ .filter(|p| p.chars().next() == name.chars().next())
4466+ .collect();
4467+ let suggestion = suggest_closest(name, &functional)
4468+ .filter(|&closest| closest != name)
4469+ .map(|closest| format!("{}(", closest));
4470+ let written = format!("{}(", name);
4471+ let message = match &suggestion {
4472+ Some(closest) => format!("unknown prefix '{}', did you mean '{}'?", written, closest),
4473+ None => format!("unknown prefix '{}'", written),
4474+ };
4475+ return Some(PrefixProblem {
4476+ message,
4477+ subject: written,
4478+ suggestion,
4479+ });
4480+ }
4481+ if !rest[name_len..].starts_with(':') {
4482+ return None;
4483+ }
4484+ let written = &rest[..name_len + 1];
4485+ // `has:`: its argument is missing
4486+ if vocab::pseudo(name) == Some(Pseudo::Function) {
4487+ return Some(PrefixProblem {
4488+ message: format!(
4489+ "'{}': `:{}()` takes an argument, in parentheses, as in CSS: `{}(...):`",
4490+ written, name, name
4491+ ),
4492+ subject: written.to_string(),
4493+ suggestion: None,
4494+ });
4495+ }
4496+ let prefixes = vocab::all_prefixes();
4497+ let candidates: Vec<&str> = prefixes
4498+ .iter()
4499+ .map(String::as_str)
4500+ .filter(|p| p.chars().next() == written.chars().next())
4501+ .collect();
4502+ // The closest name that starts with the same letter (`hvoer:` →
4503+ // `hover:`), else the first that starts with the word written and a `-`
4504+ // (`first:` → `first-child:`)
4505+ let suggestion = suggest_closest(written, &candidates)
4506+ .or_else(|| {
4507+ let longer = format!("{}-", name);
4508+ candidates.iter().copied().find(|p| p.starts_with(&longer))
4509+ })
4510+ .filter(|&closest| closest != written)
4511+ .map(str::to_string);
4512+ let message = match &suggestion {
4513+ Some(closest) => format!("unknown prefix '{}', did you mean '{}'?", written, closest),
4514+ None => format!("unknown prefix '{}'", written),
4515+ };
4516+ Some(PrefixProblem {
4517+ message,
4518+ subject: written.to_string(),
4519+ suggestion,
4520+ })
4521+}
4522+
4523+/// Check an attribute's element prefix (`@td:padding 8`), when it has one:
4524+/// it names a built-in element that has an HTML tag of its own (not a
4525+/// function, and not `@el`, whose `<div>` other elements write too), there
4526+/// is one, not with `children:`, and what it styles is a CSS property, not
4527+/// one of htmlang's words, which compile against each element's layout and
4528+/// its parent's. Returns false, after reporting, when the attribute can't
4529+/// be written.
4530+fn check_element_prefixes(
4531+ attr: &Attribute,
4532+ prefixes: &[&str],
4533+ base: &str,
4534+ line: usize,
4535+ column: Option<usize>,
4536+ ctx: &mut ParseContext,
4537+) -> bool {
4538+ use crate::ast::ElementKind;
4539+ use crate::vocab;
4540+ let elements: Vec<&str> = prefixes
4541+ .iter()
4542+ .copied()
4543+ .filter(|p| vocab::element_prefix(p).is_some())
4544+ .collect();
4545+ let Some(&prefix) = elements.first() else {
4546+ return true;
4547+ };
4548+ let fail = |ctx: &mut ParseContext,
4549+ code: &'static str,
4550+ message: String,
4551+ subject: &str,
4552+ suggestion: Option<String>| {
4553+ let diagnostic = Diagnostic::error(code, line, message)
4554+ .subject(subject)
4555+ .suggest(suggestion);
4556+ let diagnostic = at_attribute(diagnostic, column, ctx);
4557+ ctx.diagnostics.push(diagnostic);
4558+ false
4559+ };
4560+ let name = vocab::element_prefix(prefix).unwrap_or_default();
4561+ if is_function(name, ctx) {
4562+ return fail(
4563+ ctx,
4564+ code::INVALID_PREFIX,
4565+ format!(
4566+ "'{}': @{} is a function, and `{}` would pick elements out by their HTML tag, \
4567+ which a function doesn't have: style what @{} writes in its body, or pass it \
4568+ attributes",
4569+ attr.key, name, prefix, name
4570+ ),
4571+ prefix,
4572+ None,
4573+ );
4574+ }
4575+ match ElementKind::from_name(name) {
4576+ None => {
4577+ let own: Vec<&str> = ElementKind::all_names()
4578+ .filter(|n| ElementKind::from_name(n).is_some_and(|k| k.own_tag().is_some()))
4579+ .collect();
4580+ // An HTML name htmlang writes under another (`@a:` is `@link:`)
4581+ let (written_otherwise, shared) = match crate::ast::HTML_NAMES_WRITTEN_OTHERWISE
4582+ .iter()
4583+ .find(|(html, _)| *html == name)
4584+ {
4585+ Some((_, htmlang)) if own.contains(htmlang) => (Some(*htmlang), false),
4586+ Some(_) => (None, true),
4587+ None => (None, false),
4588+ };
4589+ // `@each:`, `@markdown:`: a directive, which is no element
4590+ if crate::ast::directive(name).is_some() {
4591+ return fail(
4592+ ctx,
4593+ code::UNKNOWN_PREFIX,
4594+ format!(
4595+ "unknown element @{} in '{}': @{} is a directive, and an element \
4596+ prefix names an element with an HTML tag of its own, such as `@td:`",
4597+ name, prefix, name
4598+ ),
4599+ prefix,
4600+ None,
4601+ );
4602+ }
4603+ // `@div:`, `@span:`: several elements write it
4604+ if shared {
4605+ return fail(
4606+ ctx,
4607+ code::UNKNOWN_PREFIX,
4608+ format!(
4609+ "unknown element @{} in '{}': htmlang writes <{}> for several \
4610+ elements, so no element prefix picks it out",
4611+ name, prefix, name
4612+ ),
4613+ prefix,
4614+ None,
4615+ );
4616+ }
4617+ // A name with the same first letter first (`@tdd:` is `@td:`)
4618+ let same_letter: Vec<&str> = own
4619+ .iter()
4620+ .copied()
4621+ .filter(|n| n.chars().next() == name.chars().next())
4622+ .collect();
4623+ let closest = written_otherwise
4624+ .or_else(|| suggest_closest(name, &same_letter))
4625+ .or_else(|| suggest_closest(name, &own));
4626+ let message = match (closest, written_otherwise) {
4627+ (Some(closest), Some(_)) => format!(
4628+ "unknown element @{} in '{}', did you mean '@{}:'? (@{} writes <{}>)",
4629+ name, prefix, closest, closest, name
4630+ ),
4631+ (Some(closest), None) => format!(
4632+ "unknown element @{} in '{}', did you mean '@{}:'?",
4633+ name, prefix, closest
4634+ ),
4635+ (None, _) => format!("unknown element @{} in '{}'", name, prefix),
4636+ };
4637+ let suggestion = closest.map(|c| format!("@{}:", c));
4638+ fail(ctx, code::UNKNOWN_PREFIX, message, prefix, suggestion)
4639+ }
4640+ Some(kind) if kind.own_tag().is_none() => {
4641+ let reason = match kind.tag() {
4642+ None => format!(
4643+ "@{} writes no element of its own, so there is nothing for `{}` to style",
4644+ name, prefix
4645+ ),
4646+ Some(_) if kind.is_verbatim() => {
4647+ format!("@{} isn't shown, so there is nothing to style", name)
4648+ }
4649+ Some("span") => format!(
4650+ "@{} writes a <span>, as every line of text in a row or column does, so \
4651+ `{}` can't pick it out",
4652+ name, prefix
4653+ ),
4654+ Some(tag) => {
4655+ let others: Vec<String> = ElementKind::all_names()
4656+ .filter(|n| {
4657+ *n != name
4658+ && ElementKind::from_name(n).and_then(|k| k.tag()) == Some(tag)
4659+ })
4660+ .map(|n| format!("@{}", n))
4661+ .collect();
4662+ let others = match others.split_last() {
4663+ Some((last, [])) => last.clone(),
4664+ Some((last, rest)) => format!("{} and {}", rest.join(", "), last),
4665+ None => String::new(),
4666+ };
4667+ format!(
4668+ "@{} writes a <{}>, as {} do, so `{}` can't pick it out",
4669+ name, tag, others, prefix
4670+ )
4671+ }
4672+ };
4673+ fail(
4674+ ctx,
4675+ code::INVALID_PREFIX,
4676+ format!(
4677+ "'{}': {}. Give those elements their styles themselves, or a bundle \
4678+ (`@let name [...]`, used as `[$name]`)",
4679+ attr.key, reason
4680+ ),
4681+ prefix,
4682+ None,
4683+ )
4684+ }
4685+ Some(_) if elements.len() > 1 => fail(
4686+ ctx,
4687+ code::INVALID_PREFIX,
4688+ format!(
4689+ "'{}': a style takes one element prefix, which styles every such element \
4690+ inside this one, at any depth",
4691+ attr.key
4692+ ),
4693+ &attr.key,
4694+ None,
4695+ ),
4696+ Some(_) if prefixes.contains(&vocab::CHILDREN) => fail(
4697+ ctx,
4698+ code::INVALID_PREFIX,
4699+ format!(
4700+ "'{}': `children:` and `{}` each say which elements the style is for: write \
4701+ one of them",
4702+ attr.key, prefix
4703+ ),
4704+ &attr.key,
4705+ None,
4706+ ),
4707+ Some(_) if vocab::is_htmlang_word(base, attr.value.as_deref()) => {
4708+ let value = attr.value.as_deref().map(str::trim);
4709+ let css = match (base, value) {
4710+ ("spacing", _) => " (`gap`)",
4711+ ("wrap", _) => " (`flex-wrap wrap`)",
4712+ ("grid-cols", _) => " (`grid-template-columns`)",
4713+ ("grid-rows", _) => " (`grid-template-rows`)",
4714+ ("col-span", _) => " (`grid-column span N`)",
4715+ ("row-span", _) => " (`grid-row span N`)",
4716+ ("width", Some("fill")) => " (`flex 1` in a row, `width 100%` otherwise)",
4717+ ("height", Some("fill")) => " (`flex 1` in a column, `height 100%` otherwise)",
4718+ ("width", _) => " (`flex-shrink 0` in a row, `width fit-content` otherwise)",
4719+ ("height", _) => " (`flex-shrink 0` in a column, `height fit-content` otherwise)",
4720+ ("center-x", _) => " (`margin-inline auto`)",
4721+ ("center-y", _) => " (`margin-block auto`)",
4722+ _ => "",
4723+ };
4724+ let word = match value {
4725+ Some(v) if matches!(base, "width" | "height") => format!("{} {}", base, v),
4726+ _ => base.to_string(),
4727+ };
4728+ fail(
4729+ ctx,
4730+ code::INVALID_PREFIX,
4731+ format!(
4732+ "'{}': `{}` is one of htmlang's layout words, which compile against each \
4733+ element's layout and its parent's, and `{}` styles elements whose \
4734+ parents it doesn't know: write `{}` on the elements themselves, or the \
4735+ CSS you mean{}",
4736+ attr.key, word, prefix, word, css
4737+ ),
4738+ &attr.key,
4739+ None,
4740+ )
4741+ }
4742+ Some(_) => true,
4743+ }
4744+}
4745+
4746+/// Check an attribute's prefixes: each is known, their selector prefixes
4747+/// read left to right with a pseudo-element (`before:`) last, the argument
4748+/// of `has(...)` or `nth-child(...)` can be written into the CSS, and a word that
4749+/// places an element in its parent (`width fill`, `center-x`, `align-*`)
4750+/// isn't under `children:`, whose styles go on the children. Media,
4751+/// container and width prefixes go anywhere. Returns false, after
4752+/// reporting, when the attribute can't be written.
4753+fn check_prefixes(
4754+ attr: &Attribute,
4755+ line: usize,
4756+ column: Option<usize>,
4757+ ctx: &mut ParseContext,
4758+) -> bool {
4759+ use crate::vocab;
4760+ let (prefixes, base) = vocab::split_prefixes(&attr.key);
4761+ let fail =
4762+ |ctx: &mut ParseContext, message: String, subject: &str, suggestion: Option<String>| {
4763+ let diagnostic = Diagnostic::error(code::INVALID_PREFIX, line, message)
4764+ .subject(subject)
4765+ .suggest(suggestion);
4766+ let diagnostic = at_attribute(diagnostic, column, ctx);
4767+ ctx.diagnostics.push(diagnostic);
4768+ false
4769+ };
4770+
4771+ if let Some(problem) = unknown_prefix(base) {
4772+ let diagnostic = Diagnostic::error(code::UNKNOWN_PREFIX, line, problem.message)
4773+ .subject(problem.subject)
4774+ .suggest(problem.suggestion);
4775+ let diagnostic = at_attribute(diagnostic, column, ctx);
4776+ ctx.diagnostics.push(diagnostic);
4777+ return false;
4778+ }
4779+ if !check_element_prefixes(attr, &prefixes, base, line, column, ctx) {
4780+ return false;
4781+ }
4782+ // The argument of `has(...)` or `nth-child(...)` goes into the CSS as
4783+ // written
4784+ for prefix in &prefixes {
4785+ if let Some(reason) = css_breakout(prefix.trim_end_matches(':')) {
4786+ return fail(
4787+ ctx,
4788+ format!(
4789+ "the prefix '{}' has {}: it can't be written into the page's CSS",
4790+ prefix, reason
4791+ ),
4792+ prefix,
4793+ None,
4794+ );
4795+ }
4796+ }
4797+ // `nth-child():` or `has( ):`: CSS has no pseudo-class with an empty
4798+ // argument
4799+ let empty_argument = |prefix: &str| {
4800+ prefix
4801+ .strip_suffix("):")
4802+ .and_then(|p| p.split_once('('))
4803+ .is_some_and(|(_, argument)| argument.trim().is_empty())
4804+ };
4805+ if let Some(empty) = prefixes.iter().find(|p| empty_argument(p)) {
4806+ return fail(
4807+ ctx,
4808+ format!(
4809+ "'{}': `:{}()` takes an argument between its parentheses, as in CSS",
4810+ attr.key,
4811+ vocab::pseudo_name(empty)
4812+ ),
4813+ empty,
4814+ None,
4815+ );
4816+ }
4817+ // A pseudo-element is the last selector prefix: CSS has no
4818+ // `::before:hover`
4819+ let selectors: Vec<&str> = prefixes
4820+ .iter()
4821+ .copied()
4822+ .filter(|p| vocab::at_rule_rank(p).is_none())
4823+ .collect();
4824+ // Only one: an element has one `::before`, which has no `::after`
4825+ let elements: Vec<&str> = selectors
4826+ .iter()
4827+ .copied()
4828+ .filter(|p| vocab::is_pseudo_element(p))
4829+ .collect();
4830+ if elements.len() > 1 {
4831+ return fail(
4832+ ctx,
4833+ format!(
4834+ "'{}': `{}` and `{}` each select a pseudo-element, and a style applies to one \
4835+ of them",
4836+ attr.key, elements[0], elements[1]
4837+ ),
4838+ &attr.key,
4839+ None,
4840+ );
4841+ }
4842+ if let Some(at) = selectors.iter().position(|p| vocab::is_pseudo_element(p))
4843+ && at + 1 < selectors.len()
4844+ {
4845+ let element = selectors[at];
4846+ // The same prefixes, with the pseudo-element moved after the other
4847+ // selector prefixes
4848+ let mut order: Vec<&str> = prefixes.iter().copied().filter(|p| *p != element).collect();
4849+ let last_selector = order
4850+ .iter()
4851+ .rposition(|p| vocab::at_rule_rank(p).is_none())
4852+ .map_or(order.len(), |i| i + 1);
4853+ order.insert(last_selector, element);
4854+ let fixed = format!("{}{}", order.concat(), base);
4855+ return fail(
4856+ ctx,
4857+ format!(
4858+ "'{}': `{}` selects a pseudo-element, which comes after the other selector \
4859+ prefixes, as in CSS: write `{}`",
4860+ attr.key, element, fixed
4861+ ),
4862+ &attr.key,
4863+ Some(fixed),
4864+ );
4865+ }
4866+ // Under `children:` the styles go on the children, whose parent is this
4867+ // element: a word that places an element in its parent can't say where
4868+ if prefixes.contains(&"children:") && vocab::places_in_parent(base, attr.value.as_deref()) {
4869+ // The CSS of `fill` and `shrink` depends on the direction: along
4870+ // it, they are flex properties
4871+ let (word, css) = match (base, attr.value.as_deref().map(str::trim)) {
4872+ ("width", Some("fill")) => (
4873+ "width fill",
4874+ " (`children:flex 1` in a row, `children:width 100%` otherwise)",
4875+ ),
4876+ ("height", Some("fill")) => (
4877+ "height fill",
4878+ " (`children:flex 1` in a column, `children:height 100%` otherwise)",
4879+ ),
4880+ ("width", Some(_)) => (
4881+ "width shrink",
4882+ " (`children:flex-shrink 0` in a row, `children:width fit-content` otherwise)",
4883+ ),
4884+ ("height", Some(_)) => (
4885+ "height shrink",
4886+ " (`children:flex-shrink 0` in a column, `children:height fit-content` \
4887+ otherwise)",
4888+ ),
4889+ _ => (base, ""),
4890+ };
4891+ return fail(
4892+ ctx,
4893+ format!(
4894+ "'{}{}': `{}` places an element in its parent, and under `children:` that \
4895+ parent is this element: write `{}` on the children themselves, or the CSS \
4896+ you mean{}",
4897+ attr.key,
4898+ attr.value
4899+ .as_deref()
4900+ .map_or(String::new(), |v| format!(" {}", v.trim())),
4901+ word,
4902+ word,
4903+ css
4904+ ),
4905+ &attr.key,
4906+ None,
4907+ );
4908+ }
4909+ true
4910+}
4911+
4912+/// Check an attribute written as a style or a flag (not `key=value`): its
4913+/// prefix, its name, and, for a style, its value. A name htmlang doesn't
4914+/// know but CSS could have (`corner-shape`) is passed to the CSS as written,
4915+/// with a warning; custom properties (`--brand`) and vendor-prefixed ones
4916+/// (`-webkit-...`) without one. Anything that can't be written into the
4917+/// page is an error; returns false then, and the attribute is left out.
4918+fn check_attribute(
4919+ attr: &Attribute,
4920+ line: usize,
4921+ column: Option<usize>,
4922+ before: Option<&Attribute>,
4923+ ctx: &mut ParseContext,
4924+) -> bool {
4925+ use crate::vocab;
4926+ let (prefixes, base) = vocab::split_prefixes(&attr.key);
4927+ let fail = |ctx: &mut ParseContext, code: &'static str, message: String, subject: &str| {
4928+ let diagnostic = Diagnostic::error(code, line, message).subject(subject);
4929+ let diagnostic = at_attribute(diagnostic, column, ctx);
4930+ ctx.diagnostics.push(diagnostic);
4931+ false
4932+ };
4933+
4934+ if !check_prefixes(attr, line, column, ctx) {
4935+ return false;
4936+ }
4937+ let prefixed = !prefixes.is_empty();
4938+ // `md:id=x`: `=` makes an HTML attribute, which has no states
4939+ if prefixed && let Some((name, _)) = base.split_once('=') {
4940+ return fail(
4941+ ctx,
4942+ code::INVALID_PREFIX,
4943+ format!(
4944+ "'{}': a prefix applies to a style, and `{}=` is an HTML attribute",
4945+ attr.key, name
4946+ ),
4947+ &attr.key,
4948+ );
4949+ }
4950+ let Some(value) = &attr.value else {
4951+ // `inline` puts a file into the page as it compiles, which no
4952+ // state or media condition can undo
4953+ if base == "inline" && prefixed {
4954+ return fail(
4955+ ctx,
4956+ code::INVALID_PREFIX,
4957+ format!(
4958+ "'{}': `inline` puts the image's file into the page, which can't depend \
4959+ on a prefix",
4960+ attr.key
4961+ ),
4962+ &attr.key,
4963+ );
4964+ }
4965+ if vocab::HTMLANG_FLAGS.contains(&base) {
4966+ return true;
4967+ }
4968+ if vocab::is_html_flag(base) {
4969+ if !prefixed {
4970+ return true;
4971+ }
4972+ return fail(
4973+ ctx,
4974+ code::INVALID_PREFIX,
4975+ format!(
4976+ "'{}': a prefix applies to a style, and '{}' is an HTML attribute",
4977+ attr.key, base
4978+ ),
4979+ &attr.key,
4980+ );
4981+ }
4982+ if vocab::is_style_attribute(base)
4983+ || vocab::is_custom_property(base)
4984+ || vocab::is_vendor_property(base)
4985+ {
4986+ return fail(
4987+ ctx,
4988+ code::MISSING_VALUE,
4989+ format!("'{}' needs a value: `{} VALUE`", attr.key, attr.key),
4990+ &attr.key,
4991+ );
4992+ }
4993+ if vocab::is_html_attribute(base) && !prefixed {
4994+ return fail(
4995+ ctx,
4996+ code::HTML_ATTRIBUTE_FORM,
4997+ format!(
4998+ "'{}' is an HTML attribute that isn't a flag: write `{}=VALUE`",
4999+ base, base
5000+ ),
5001+ base,
5002+ );
5003+ }
5004+ return unknown_attribute(attr, base, line, column, before, true, ctx);
5005+ };
5006+
5007+ if vocab::HTMLANG_FLAGS.contains(&base) {
5008+ return fail(
5009+ ctx,
5010+ code::INVALID_VALUE,
5011+ format!(
5012+ "'{}' is a flag and takes no value: write `{}` alone",
5013+ base, attr.key
5014+ ),
5015+ &attr.key,
5016+ );
5017+ }
5018+ if vocab::is_style_attribute(base)
5019+ || vocab::is_custom_property(base)
5020+ || vocab::is_vendor_property(base)
5021+ {
5022+ return check_css_value(attr, base, line, column, ctx);
5023+ }
5024+ if vocab::is_html_attribute(base) && !prefixed {
5025+ let diagnostic = Diagnostic::error(
5026+ code::HTML_ATTRIBUTE_FORM,
5027+ line,
5028+ format!(
5029+ "'{}' is an HTML attribute: write `{}={}`",
5030+ attr.key, attr.key, value
5031+ ),
5032+ )
5033+ .subject(attr.key.as_str());
5034+ let diagnostic = at_attribute(diagnostic, column, ctx);
5035+ ctx.diagnostics.push(diagnostic);
5036+ return false;
5037+ }
5038+ let passes = vocab::is_property_name(base);
5039+ unknown_attribute(attr, base, line, column, before, !passes, ctx)
5040+ && check_css_value(attr, base, line, column, ctx)
5041+}
5042+
5043+/// Whether an attribute of a bundle could pass a parameter to a function
5044+/// it is spliced into (`@let t [title Hello]`): a name without a prefix
5045+/// that isn't a style or a flag. Such a name is checked where the bundle is
5046+/// used.
5047+fn could_be_parameter(attr: &Attribute) -> bool {
5048+ use crate::vocab;
5049+ let key = attr.key.as_str();
5050+ let flag =
5051+ attr.value.is_none() && (vocab::HTMLANG_FLAGS.contains(&key) || vocab::is_html_flag(key));
5052+ !attr.html
5053+ && !flag
5054+ && !vocab::is_style_attribute(key)
5055+ && key.starts_with(|c: char| c.is_alphabetic())
5056+ && key
5057+ .chars()
5058+ .all(|c| c.is_alphanumeric() || matches!(c, '-' | '_'))
5059+}
5060+
5061+/// At a call, a name close to one of the function's parameters is a
5062+/// misspelled parameter, not an attribute for its root: report it, and
5063+/// return true (it is left out).
5064+fn misspelled_parameter(
5065+ attr: &Attribute,
5066+ text_keys: &[String],
5067+ line: usize,
5068+ column: Option<usize>,
5069+ ctx: &mut ParseContext,
5070+) -> bool {
5071+ if text_keys.is_empty() || !could_be_parameter(attr) {
5072+ return false;
5073+ }
5074+ let params: Vec<&str> = text_keys.iter().map(String::as_str).collect();
5075+ let Some(closest) = suggest_closest(&attr.key, &params) else {
5076+ return false;
5077+ };
5078+ let what = if ctx.in_page {
5079+ "@page word"
5080+ } else {
5081+ "parameter"
5082+ };
5083+ let diagnostic = Diagnostic::error(
5084+ code::UNKNOWN_ATTRIBUTE,
5085+ line,
5086+ format!(
5087+ "unknown {} '{}', did you mean '{}'?",
5088+ what, attr.key, closest
5089+ ),
5090+ )
5091+ .subject(attr.key.as_str())
5092+ .suggest(Some(closest));
5093+ let diagnostic = at_attribute(diagnostic, column, ctx);
5094+ ctx.diagnostics.push(diagnostic);
5095+ true
5096+}
5097+
5098+/// An attribute name htmlang doesn't know. A style whose name CSS could
5099+/// have goes to the CSS as written, with a warning; anything else (a flag,
5100+/// a name that isn't a word) is an error. Returns whether it is kept.
5101+fn unknown_attribute(
5102+ attr: &Attribute,
5103+ base: &str,
5104+ line: usize,
5105+ column: Option<usize>,
5106+ before: Option<&Attribute>,
5107+ error: bool,
5108+ ctx: &mut ParseContext,
5109+) -> bool {
5110+ // `@td padding 8`: an element prefix without its colon
5111+ if let Some(name) = base.strip_prefix('@')
5112+ && crate::ast::ElementKind::from_name(name).is_some()
5113+ {
5114+ let example = match attr.value.as_deref() {
5115+ Some(value) => format!("{}:{}", attr.key, value.trim()),
5116+ None => format!("{}:padding 8", attr.key),
5117+ };
5118+ let diagnostic = Diagnostic::error(
5119+ code::UNKNOWN_ATTRIBUTE,
5120+ line,
5121+ format!(
5122+ "unknown attribute '{}': an element prefix ends in a colon, as in `{}`",
5123+ attr.key, example
5124+ ),
5125+ )
5126+ .subject(base);
5127+ let diagnostic = at_attribute(diagnostic, column, ctx);
5128+ ctx.diagnostics.push(diagnostic);
5129+ return false;
5130+ }
5131+ // `[card]` where `card` is a bundle: it is used as `$card`
5132+ if attr.value.is_none() && ctx.env.bundle(base).is_some() && base == attr.key {
5133+ ctx.used_defines.insert(base.to_string());
5134+ let diagnostic = Diagnostic::error(
5135+ code::UNKNOWN_ATTRIBUTE,
5136+ line,
5137+ format!(
5138+ "unknown attribute '{}': '{}' is an attribute bundle, used as `${}`",
5139+ base, base, base
5140+ ),
5141+ )
5142+ .subject(base)
5143+ .suggest(Some(format!("${}", base)));
5144+ let diagnostic = at_attribute(diagnostic, column, ctx);
5145+ ctx.diagnostics.push(diagnostic);
5146+ return false;
5147+ }
5148+ // `hover:title x`: an HTML attribute's name is not a suggestion for
5149+ // itself
5150+ let suggestion =
5151+ suggest_closest(base, &crate::vocab::all_attributes()).filter(|&closest| closest != base);
5152+ // `hx-trigger=load, every 2s`: right after a `key=value`, a name that
5153+ // isn't close to one htmlang knows is the rest of that value, which
5154+ // the comma ended. It is left out.
5155+ let cut = before.filter(|b| b.html && b.value.is_some());
5156+ let rest = match &attr.value {
5157+ Some(value) => format!("{} {}", attr.key, value),
5158+ None => attr.key.clone(),
5159+ };
5160+ let joined = cut.map(|cut| {
5161+ let value = cut.value.as_deref().unwrap_or("");
5162+ (
5163+ format!("{}={}", cut.key, value),
5164+ format!("{}={}\\, {}", cut.key, value, rest),
5165+ )
5166+ });
5167+ if let (Some((cut, joined)), None) = (&joined, suggestion) {
5168+ let diagnostic = Diagnostic::error(
5169+ code::SPLIT_VALUE,
5170+ line,
5171+ format!(
5172+ "unknown attribute '{}' after `{}`: if '{}' is the rest of its value, the comma \
5173+ ended it. To keep a comma in a value, write `\\,`: `{}`",
5174+ base, cut, rest, joined
5175+ ),
5176+ )
5177+ .subject(base);
5178+ let diagnostic = at_attribute(diagnostic, column, ctx);
5179+ ctx.diagnostics.push(diagnostic);
5180+ return false;
5181+ }
5182+ let mut message = match (&suggestion, error) {
5183+ (Some(closest), true) => {
5184+ format!(
5185+ "unknown attribute '{}', did you mean '{}'?",
5186+ attr.key, closest
5187+ )
5188+ }
5189+ (None, true) => format!("unknown attribute '{}'", attr.key),
5190+ (Some(closest), false) => format!(
5191+ "unknown CSS property '{}', did you mean '{}'? It is written to the CSS as it is",
5192+ base, closest
5193+ ),
5194+ (None, false) => format!(
5195+ "unknown CSS property '{}': it is written to the CSS as it is",
5196+ base
5197+ ),
5198+ };
5199+ // `box-shadow 0 1px red, 0 2px blue` or `font-family Inter,
5200+ // sans-serif`: the comma ended the attribute, and the rest of the
5201+ // value became one
5202+ let rest_of_a_value = !base.starts_with(|c: char| c.is_ascii_alphabetic() || c == '-')
5203+ || (suggestion.is_none() && attr.value.is_none() && before.is_some());
5204+ if joined.is_some() || (rest_of_a_value && error) {
5205+ if !message.ends_with('?') {
5206+ message.push('.');
5207+ }
5208+ match &joined {
5209+ Some((cut, joined)) => message.push_str(&format!(
5210+ " If it is the rest of `{}`, the comma ended it: write `{}`",
5211+ cut, joined
5212+ )),
5213+ None => message
5214+ .push_str(" A comma separates attributes: to keep one in a value, write `\\,`"),
5215+ }
5216+ }
5217+ let severity = if error {
5218+ Severity::Error
5219+ } else {
5220+ Severity::Warning
5221+ };
5222+ let diagnostic = Diagnostic::new(code::UNKNOWN_ATTRIBUTE, severity, line, message)
5223+ .subject(base)
5224+ .suggest(suggestion);
5225+ let diagnostic = at_attribute(diagnostic, column, ctx);
5226+ ctx.diagnostics.push(diagnostic);
5227+ !error
5228+}
5229+
5230+/// Evaluate the attributes of a list: bundles are spliced in, `if()`
5231+/// chooses, and variables fill values. A variable fills only the value it
5232+/// is written in: attributes come from bundles, never from text. With
5233+/// `validate`, unknown names and invalid values are reported. `text_keys`
5234+/// are a called function's parameters: their values are text rather than
5235+/// CSS, and they aren't checked as attributes.
5236+fn parse_attr_list(
5237+ tokens: &[syntax::Attr],
5238+ line_num: usize,
5239+ ctx: &mut ParseContext,
5240+ validate: bool,
5241+ text_keys: &[String],
5242+) -> Vec<Attribute> {
5243+ parse_attrs(tokens, line_num, ctx, validate, text_keys)
5244+ .into_iter()
5245+ .map(|(attr, _)| attr)
5246+ .collect()
5247+}
5248+
5249+/// [`parse_attr_list`], with the value of each attribute whose key is one
5250+/// of `text_keys` (a call's parameters) as a value with its type (see
5251+/// [`ParseContext::slot_value`]), so a parameter can get a list or a
5252+/// record.
5253+fn parse_attrs(
5254+ tokens: &[syntax::Attr],
5255+ line_num: usize,
5256+ ctx: &mut ParseContext,
5257+ validate: bool,
5258+ text_keys: &[String],
5259+) -> Vec<(Attribute, Option<Value>)> {
5260+ let mut read = ReadAttrs::default();
5261+ read_attrs(tokens, "", line_num, ctx, validate, text_keys, &mut read);
5262+ read.attrs
5263+}
5264+
5265+/// The attributes of a list read so far, and the keys written (for the
5266+/// duplicate check).
5267+#[derive(Default)]
5268+struct ReadAttrs {
5269+ attrs: Vec<(Attribute, Option<Value>)>,
5270+ seen_keys: Vec<(String, bool)>,
5271+}
5272+
5273+/// [`parse_attrs`] for the attributes of `tokens`, each under the prefixes
5274+/// `prefix` (`md:` for those of `md:[...]`), which distribute over a
5275+/// group, a bundle and the branch an `if()` takes. Only styles take a
5276+/// prefix, so an HTML attribute there is an error.
5277+fn read_attrs(
5278+ tokens: &[syntax::Attr],
5279+ prefix: &str,
5280+ line_num: usize,
5281+ ctx: &mut ParseContext,
5282+ validate: bool,
5283+ text_keys: &[String],
5284+ out: &mut ReadAttrs,
5285+) {
5286+ let mut chosen = Vec::new();
5287+ choose_attrs(
5288+ tokens,
5289+ prefix,
5290+ line_num,
5291+ ctx,
5292+ validate,
5293+ text_keys,
5294+ &mut chosen,
5295+ );
5296+
5297+ for token in &chosen {
5298+ let line = if token.span.line == 0 {
5299+ line_num
5300+ } else {
5301+ token.span.line
5302+ };
5303+ let (key, value, html) = (token.key.clone(), token.value.clone(), token.html);
5304+ let column = |at: usize| Some(token.span.column + at);
5305+
5306+ // `md:[...]`, `md:$card`, `md:if(...)`: the prefixes apply to each
5307+ // attribute there, and a prefix a parameter can't have
5308+ if let Some(prefixed) = &token.prefixed {
5309+ if let Some(inner) = group_prefix(token, prefixed, prefix, line, ctx) {
5310+ read_attrs(
5311+ prefixed.target.attrs(),
5312+ &inner,
5313+ line_num,
5314+ ctx,
5315+ validate,
5316+ text_keys,
5317+ out,
5318+ );
5319+ }
5320+ continue;
5321+ }
5322+
5323+ // `$name` (or `${name}`) alone: an attribute bundle, spliced in
5324+ let bundle = key.strip_prefix('$').filter(|_| value.is_none() && !html);
5325+ let bundle = bundle.and_then(|after| match interp::reference(after, &ctx.env)? {
5326+ (interp::Reference::Var(name), len) if len == after.len() => Some(name),
5327+ _ => None,
5328+ });
5329+ if let Some(name) = bundle {
5330+ if let Some(define_attrs) = ctx.env.bundle(&name).cloned() {
5331+ ctx.used_defines.insert(name.clone());
5332+ for attr in define_attrs.iter() {
5333+ if !prefix.is_empty() {
5334+ let prefixed = Attribute {
5335+ key: format!("{}{}", prefix, attr.key),
5336+ ..attr.clone()
5337+ };
5338+ if prefixed_parameter(&prefixed, text_keys, line, column(0), validate, ctx)
5339+ {
5340+ continue;
5341+ }
5342+ if let Some(attr) =
5343+ prefixed_member(attr, prefix, &name, line, column(0), validate, ctx)
5344+ {
5345+ out.attrs.push((attr, None));
5346+ }
5347+ continue;
5348+ }
5349+ let attrs = &out.attrs;
5350+ // Checked here, where it is either a parameter or not
5351+ let checked_here = validate
5352+ && !ctx.in_bundle
5353+ && could_be_parameter(attr)
5354+ && !text_keys.contains(&attr.key);
5355+ if checked_here
5356+ && (misspelled_parameter(attr, text_keys, line, column(0), ctx)
5357+ || !check_attribute(
5358+ attr,
5359+ line,
5360+ column(0),
5361+ attrs.last().map(|(a, _)| a),
5362+ ctx,
5363+ ))
5364+ {
5365+ continue;
5366+ }
5367+ out.attrs.push((attr.clone(), None));
5368+ }
5369+ } else {
5370+ not_a_bundle(&name, line, column(0), ctx);
5371+ }
5372+ continue;
5373+ }
5374+ // A name never comes from a variable
5375+ if key.contains('$') {
5376+ track_var_refs(&key, &mut ctx.used_variables);
5377+ ctx.diagnostics.push(
5378+ Diagnostic::error(
5379+ code::ATTRIBUTE_FROM_VARIABLE,
5380+ line,
5381+ format!(
5382+ "'{}': an attribute's name can't come from a variable. A variable \
5383+ fills a value (`padding $size`), and whole attributes come from a \
5384+ bundle (`@let name [padding 8]`, used as `[$name]`)",
5385+ key
5386+ ),
5387+ )
5388+ .subject(key.as_str()),
5389+ );
5390+ continue;
5391+ }
5392+
5393+ // Only a style has states: `md:[id=x]`, `md:id=x`
5394+ if html && (!prefix.is_empty() || !crate::vocab::split_prefixes(&key).0.is_empty()) {
5395+ let written = format!("{}{}", prefix, key);
5396+ let (name, _) = crate::vocab::split_prefixes(&written);
5397+ let diagnostic = Diagnostic::error(
5398+ code::INVALID_PREFIX,
5399+ line,
5400+ format!(
5401+ "'{}=': a prefix applies to a style, and `{}=` is an HTML attribute, \
5402+ which has no states",
5403+ written,
5404+ &written[name.concat().len()..]
5405+ ),
5406+ )
5407+ .subject(token.key.as_str());
5408+ let diagnostic = at_attribute(diagnostic, column(0), ctx);
5409+ ctx.diagnostics.push(diagnostic);
5410+ continue;
5411+ }
5412+ let key = if prefix.is_empty() {
5413+ key
5414+ } else {
5415+ format!("{}{}", prefix, key)
5416+ };
5417+
5418+ // A value's variables are filled in. A style's value is CSS, where
5419+ // quoted text keeps its quotes; an HTML attribute's (and a
5420+ // parameter's) is text, where it loses them.
5421+ let sink = if html || text_keys.contains(&key) {
5422+ Sink::Text
5423+ } else {
5424+ Sink::Css
5425+ };
5426+ let mut filled = true;
5427+ let mut quoted = None;
5428+ let mut typed = None;
5429+ let value = match value {
5430+ None => None,
5431+ // A parameter's value keeps its type
5432+ Some(value) if !html && text_keys.contains(&key) => {
5433+ let at = column(token.raw.len() - value.len());
5434+ let (value, ok) = ctx.slot_value(&value, line, at);
5435+ filled = ok;
5436+ if let Value::Quoted(q) = &value {
5437+ quoted = Some(q.clone());
5438+ }
5439+ let text = value.to_string();
5440+ typed = Some(value);
5441+ Some(text)
5442+ }
5443+ Some(value) => {
5444+ let at = column(token.raw.len() - value.len());
5445+ let (text, is_quoted, ok) = ctx.fill_value(&value, line, at, sink);
5446+ filled = ok;
5447+ quoted = is_quoted;
5448+ Some(text)
5449+ }
5450+ };
5451+ let attr = Attribute {
5452+ key,
5453+ value,
5454+ html,
5455+ quoted,
5456+ };
5457+ // A value that couldn't be filled in is already reported, and a
5458+ // parameter's value is text for the function
5459+ let validate = validate && filled && !text_keys.contains(&attr.key);
5460+
5461+ // A duplicate is reported (compare the full key, so `border` and
5462+ // `hover:border` differ, and the form, so `width=800` and
5463+ // `width 200` do too), and the later one wins
5464+ if validate {
5465+ let seen = (normal_key(&attr.key), attr.html);
5466+ if out.seen_keys.contains(&seen) {
5467+ let written = if attr.html { "=" } else { "" };
5468+ let message = format!(
5469+ "duplicate attribute '{}{}': the later one wins",
5470+ attr.key, written
5471+ );
5472+ let diagnostic = Diagnostic::warning(code::DUPLICATE_ATTRIBUTE, line, message)
5473+ .subject(attr.key.as_str());
5474+ let diagnostic = at_attribute(diagnostic, column(0), ctx);
5475+ ctx.diagnostics.push(diagnostic);
5476+ } else {
5477+ out.seen_keys.push(seen);
5478+ }
5479+ }
5480+
5481+ if validate && misspelled_parameter(&attr, text_keys, line, column(0), ctx) {
5482+ continue;
5483+ }
5484+ if prefixed_parameter(&attr, text_keys, line, column(0), validate, ctx) {
5485+ continue;
5486+ }
5487+ if validate && attr.html && attr.key == "class" {
5488+ reserved_class(&attr, line, column(0), ctx);
5489+ }
5490+ // `padding=4`: a style written as an HTML attribute, which the
5491+ // browser ignores (`width=` and `height=` are real on some
5492+ // elements, see `validate_tree`)
5493+ if validate
5494+ && attr.html
5495+ && crate::vocab::is_style_attribute(&attr.key)
5496+ && !crate::vocab::HTML_ATTRIBUTES.contains(&attr.key.as_str())
5497+ {
5498+ let value = token.value.as_deref().unwrap_or("").trim();
5499+ let diagnostic = Diagnostic::warning(
5500+ code::HTML_ATTRIBUTE_FORM,
5501+ line,
5502+ format!(
5503+ "'{0}={1}' is an HTML attribute, but {0} is a style: write `{0} {1}`",
5504+ attr.key, value
5505+ ),
5506+ )
5507+ .subject(token.raw.as_str())
5508+ .suggest(Some(format!("{} {}", attr.key, value)));
5509+ let diagnostic = at_attribute(diagnostic, column(0), ctx);
5510+ ctx.diagnostics.push(diagnostic);
5511+ }
5512+
5513+ // A style or a flag: its name is checked, and what can't be
5514+ // written into the page is an error and left out
5515+ let checked = validate && !attr.html && !(ctx.in_bundle && could_be_parameter(&attr));
5516+ let before = out.attrs.last().map(|(a, _)| a);
5517+ if checked && !check_attribute(&attr, line, column(0), before, ctx) {
5518+ continue;
5519+ }
5520+
5521+ out.attrs.push((attr, typed));
5522+ }
5523+}
5524+
5525+/// At a call, a parameter under prefixes (`md:title x`, `md:[title x]`):
5526+/// a parameter has one value, with no states, so it is reported (with
5527+/// `validate`) and left out; returns true then. A parameter named like a
5528+/// style (`color`) is a style under a prefix, for the root element.
5529+fn prefixed_parameter(
5530+ attr: &Attribute,
5531+ text_keys: &[String],
5532+ line: usize,
5533+ column: Option<usize>,
5534+ validate: bool,
5535+ ctx: &mut ParseContext,
5536+) -> bool {
5537+ let (prefixes, name) = crate::vocab::split_prefixes(&attr.key);
5538+ if attr.html
5539+ || prefixes.is_empty()
5540+ || !text_keys.iter().any(|k| k == name)
5541+ || crate::vocab::is_style_attribute(name)
5542+ {
5543+ return false;
5544+ }
5545+ if validate {
5546+ let what = if ctx.in_page {
5547+ "@page's own word"
5548+ } else {
5549+ "a parameter"
5550+ };
5551+ let diagnostic = Diagnostic::error(
5552+ code::INVALID_PREFIX,
5553+ line,
5554+ format!(
5555+ "'{}': `{}` is {}, which has one value, and a prefix applies to a style, \
5556+ which has states",
5557+ attr.key, name, what
5558+ ),
5559+ )
5560+ .subject(attr.key.as_str());
5561+ let diagnostic = at_attribute(diagnostic, column, ctx);
5562+ ctx.diagnostics.push(diagnostic);
5563+ }
5564+ true
5565+}
5566+
5567+/// The prefixes of a prefixed group, bundle or `if()` inside `outer` (the
5568+/// prefixes of the groups it is in), when they are all known; else the
5569+/// unknown one is reported. Text after a group's `]` is an error too.
5570+fn group_prefix(
5571+ token: &syntax::Attr,
5572+ prefixed: &syntax::Prefixed,
5573+ outer: &str,
5574+ line: usize,
5575+ ctx: &mut ParseContext,
5576+) -> Option<String> {
5577+ let at = |ctx: &ParseContext, diagnostic: Diagnostic, span: syntax::Span| match &ctx
5578+ .current_source
5579+ {
5580+ (current, Some(text)) if span.line != 0 && *current == span.line => {
5581+ diagnostic.column(span.column).source(text.clone())
5582+ }
5583+ _ => diagnostic,
5584+ };
5585+ if let syntax::Branch::Group {
5586+ trailing: Some(trailing),
5587+ ..
5588+ } = &prefixed.target
5589+ {
5590+ let diagnostic = Diagnostic::error(
5591+ code::UNEXPECTED_ARGUMENT,
5592+ line,
5593+ format!(
5594+ "'{}' after the `]` of `{}[...]`: the prefixes apply to the attributes in the \
5595+ group, so it goes inside it",
5596+ trailing.raw, prefixed.prefix
5597+ ),
5598+ )
5599+ .subject(trailing.raw.as_str());
5600+ let diagnostic = at(ctx, diagnostic, trailing.span);
5601+ ctx.push_once(diagnostic);
5602+ }
5603+ let (known, rest) = crate::vocab::split_prefixes(&prefixed.prefix);
5604+ if !rest.is_empty() {
5605+ let problem = unknown_prefix(rest).unwrap_or_else(|| {
5606+ let written = rest.split_inclusive(':').next().unwrap_or(rest);
5607+ PrefixProblem {
5608+ message: format!("unknown prefix '{}'", written),
5609+ subject: written.to_string(),
5610+ suggestion: None,
5611+ }
5612+ });
5613+ let diagnostic = Diagnostic::error(code::UNKNOWN_PREFIX, line, problem.message)
5614+ .subject(problem.subject)
5615+ .suggest(problem.suggestion);
5616+ let diagnostic = at(ctx, diagnostic, token.span);
5617+ ctx.push_once(diagnostic);
5618+ return None;
5619+ }
5620+ Some(format!("{}{}", outer, known.concat()))
5621+}
5622+
5623+/// An attribute of the bundle `bundle`, spliced in under `prefix`
5624+/// (`md:$card`): the same attribute with the prefixes in front, when it can
5625+/// take them. An HTML attribute can't; a style's prefixes are checked, as
5626+/// is a flag or a name that isn't a style (a bundle's parameter), which
5627+/// under a prefix are attributes like any other.
5628+fn prefixed_member(
5629+ attr: &Attribute,
5630+ prefix: &str,
5631+ bundle: &str,
5632+ line: usize,
5633+ column: Option<usize>,
5634+ validate: bool,
5635+ ctx: &mut ParseContext,
5636+) -> Option<Attribute> {
5637+ let key = format!("{}{}", prefix, attr.key);
5638+ if attr.html {
5639+ if validate {
5640+ let diagnostic = Diagnostic::error(
5641+ code::INVALID_PREFIX,
5642+ line,
5643+ format!(
5644+ "'{}${}': the bundle has `{}=`, an HTML attribute, and a prefix applies to \
5645+ styles, which have states",
5646+ prefix, bundle, attr.key
5647+ ),
5648+ )
5649+ .subject(format!("{}${}", prefix, bundle));
5650+ let diagnostic = at_attribute(diagnostic, column, ctx);
5651+ ctx.diagnostics.push(diagnostic);
5652+ }
5653+ return None;
5654+ }
5655+ let prefixed = Attribute {
5656+ key,
5657+ ..attr.clone()
5658+ };
5659+ if validate {
5660+ let fine = if attr.value.is_none() || could_be_parameter(attr) {
5661+ check_attribute(&prefixed, line, column, None, ctx)
5662+ } else {
5663+ check_prefixes(&prefixed, line, column, ctx)
5664+ };
5665+ if !fine {
5666+ return None;
5667+ }
5668+ }
5669+ Some(prefixed)
5670+}
5671+
5672+/// `class=hl-x`: the `hl-` prefix is htmlang's, for its generated classes,
5673+/// whose rules would then apply to the element too. It goes into the page
5674+/// as written, so this is a warning.
5675+fn reserved_class(attr: &Attribute, line: usize, column: Option<usize>, ctx: &mut ParseContext) {
5676+ let classes = attr.value.as_deref().unwrap_or_default();
5677+ for class in classes.split_whitespace() {
5678+ if class.starts_with(crate::codegen::CLASS_PREFIX) {
5679+ let diagnostic = Diagnostic::warning(
5680+ code::INVALID_VALUE,
5681+ line,
5682+ format!(
5683+ "class '{}' starts with `{}`, which htmlang keeps for the classes it \
5684+ generates, so their styles could apply to this element: give it \
5685+ another name",
5686+ class,
5687+ crate::codegen::CLASS_PREFIX
5688+ ),
5689+ )
5690+ .subject(class);
5691+ let diagnostic = at_attribute(diagnostic, column, ctx);
5692+ ctx.diagnostics.push(diagnostic);
5693+ }
5694+ }
5695+}
5696+
5697+/// A style's key as the CSS reads it, for finding duplicates: its at-rule
5698+/// prefixes in one order (`dark:md:` is `md:dark:`), then its selector
5699+/// prefixes as written, whose order is the selector's.
5700+fn normal_key(key: &str) -> String {
5701+ let (prefixes, name) = crate::vocab::split_prefixes(key);
5702+ let mut at: Vec<(usize, &str)> = prefixes
5703+ .iter()
5704+ .filter_map(|p| crate::vocab::at_rule_rank(p).map(|rank| (rank, *p)))
5705+ .collect();
5706+ at.sort_unstable();
5707+ at.dedup();
5708+ let mut normal: String = at.iter().map(|(_, p)| *p).collect();
5709+ for prefix in prefixes
5710+ .iter()
5711+ .filter(|p| crate::vocab::at_rule_rank(p).is_none())
5712+ {
5713+ normal.push_str(prefix);
5714+ }
5715+ normal.push_str(name);
5716+ normal
5717+}
5718+
5719+/// `[$name]` where `$name` isn't an attribute bundle.
5720+fn not_a_bundle(name: &str, line: usize, column: Option<usize>, ctx: &mut ParseContext) {
5721+ track_var_refs(&format!("${}", name), &mut ctx.used_variables);
5722+ let is_value = interp::name_len(name) > 0 && interp::resolve(name, &ctx.env).is_some();
5723+ let diagnostic = if is_value {
5724+ Diagnostic::error(
5725+ code::ATTRIBUTE_FROM_VARIABLE,
5726+ line,
5727+ format!(
5728+ "'${}' is a value, not an attribute: attributes come from a bundle \
5729+ (`@let name [padding 8]`, used as `[$name]`), and a value fills an \
5730+ attribute's value (`padding ${}`)",
5731+ name, name
5732+ ),
5733+ )
5734+ .subject(name)
5735+ } else if ctx.env.function(name).is_some() {
5736+ ctx.used_functions.insert(name.to_string());
5737+ Diagnostic::error(
5738+ code::UNDEFINED_VARIABLE,
5739+ line,
5740+ format!(
5741+ "'${}' is a function, not an attribute bundle: it is called as an element, \
5742+ `@{}`",
5743+ name, name
5744+ ),
5745+ )
5746+ .subject(name)
5747+ } else {
5748+ let mut bundles = ctx.env.bundle_names();
5749+ bundles.sort_unstable();
5750+ let suggestion = suggest_closest(name, &bundles);
5751+ let message = match suggestion {
5752+ Some(closest) => format!(
5753+ "undefined attribute bundle '${}', did you mean '${}'?",
5754+ name, closest
5755+ ),
5756+ None => format!("undefined attribute bundle '${}'", name),
5757+ };
5758+ Diagnostic::error(code::UNDEFINED_VARIABLE, line, message)
5759+ .subject(name)
5760+ .suggest(suggestion)
5761+ };
5762+ let diagnostic = match (&ctx.current_source, column) {
5763+ ((current, Some(text)), Some(column)) if *current == line => {
5764+ diagnostic.column(column).source(text.clone())
5765+ }
5766+ _ => diagnostic,
5767+ };
5768+ ctx.diagnostics.push(diagnostic);
5769+}
5770+
5771+// ---------------------------------------------------------------------------
5772+// Text segment parsing (inline {...} elements)
5773+// ---------------------------------------------------------------------------
5774+
5775+/// While a slot is filled in, each escape (see [`syntax::ESCAPES`]) is a
5776+/// private-use placeholder, U+E000 plus its place in the table, so it
5777+/// can't start a variable, a quote or an inline element. Afterwards it
5778+/// becomes what it stands for.
5779+fn protect_escapes(text: &str) -> String {
5780+ if !text.contains('\\') {
5781+ return text.to_string();
5782+ }
5783+ let mut out = String::with_capacity(text.len());
5784+ let mut i = 0;
5785+ while let Some(c) = text[i..].chars().next() {
5786+ let len = syntax::escape_len(&text[i..]);
5787+ if len == 0 {
5788+ out.push(c);
5789+ i += c.len_utf8();
5790+ continue;
5791+ }
5792+ let escape = &text[i..i + len];
5793+ let index = syntax::ESCAPES.iter().position(|e| *e == escape);
5794+ out.extend(index.and_then(|n| char::from_u32(0xE000 + n as u32)));
5795+ i += len;
5796+ }
5797+ out
5798+}
5799+
5800+/// The escape a placeholder stands for, as written (`\,`).
5801+fn escape_of(c: char) -> Option<&'static str> {
5802+ let index = (c as u32).checked_sub(0xE000)?;
5803+ syntax::ESCAPES.get(index as usize).copied()
5804+}
5805+
5806+fn restore_escapes(text: &str) -> String {
5807+ text.chars()
5808+ .fold(String::with_capacity(text.len()), |mut out, c| {
5809+ match escape_of(c) {
5810+ // What the escape stands for: what follows the backslash
5811+ Some(escape) => out.push_str(&escape[1..]),
5812+ None => out.push(c),
5813+ }
5814+ out
5815+ })
5816+}
5817+
5818+/// Inside the quoted strings of a CSS value, `\"` and `\\` mean in CSS what
5819+/// they mean in htmlang, so they stay as written there.
5820+fn keep_css_string_escapes(protected: &str) -> String {
5821+ let mut out = String::with_capacity(protected.len());
5822+ let mut inside = false;
5823+ for c in protected.chars() {
5824+ match escape_of(c) {
5825+ Some(escape @ ("\\\"" | "\\\\")) if inside => out.push_str(escape),
5826+ _ => {
5827+ if c == '"' {
5828+ inside = !inside;
5829+ }
5830+ out.push(c);
5831+ }
5832+ }
5833+ }
5834+ out
5835+}
5836+
5837+/// Evaluate text: fill in the variables of its plain runs and build its
5838+/// inline elements. Each run is one slot, so a value can't make markup.
5839+fn text_segments(text: &syntax::Text, ctx: &mut ParseContext) -> Vec<TextSegment> {
5840+ let mut segments = Vec::new();
5841+ // The plain text so far, and where it starts
5842+ let mut plain = String::new();
5843+ let mut start: Option<syntax::Span> = None;
5844+ let flush = |plain: &mut String,
5845+ start: &mut Option<syntax::Span>,
5846+ segments: &mut Vec<TextSegment>,
5847+ ctx: &mut ParseContext| {
5848+ if !plain.is_empty() {
5849+ let at = start.unwrap_or(text.span);
5850+ let filled = ctx.interpolate_text(plain, at.line, Some(at.column));
5851+ segments.push(TextSegment::Plain(filled));
5852+ plain.clear();
5853+ }
5854+ *start = None;
5855+ };
5856+ for segment in &text.segments {
5857+ match segment {
5858+ Segment::Plain { raw, span } => {
5859+ start.get_or_insert(*span);
5860+ plain.push_str(raw);
5861+ }
5862+ Segment::Inline(inline) => {
5863+ let line = ctx.current_line;
5864+ match resolve(&inline.head, inline.text.as_ref(), line, &text.raw, ctx) {
5865+ Ok(resolved) => {
5866+ if !inline.closed {
5867+ let d = Diagnostic::warning(
5868+ code::UNCLOSED_BRACKET,
5869+ inline.span.line,
5870+ format!(
5871+ "unclosed `{{`: the inline @{} runs to the end of the line. \
5872+ An inline element ends with `}}` (a brace that is text is \
5873+ written `\\{{`)",
5874+ inline.head.name
5875+ ),
5876+ );
5877+ let d = at_attribute(d, Some(inline.span.column), ctx);
5878+ ctx.push_once(d);
5879+ }
5880+ flush(&mut plain, &mut start, &mut segments, ctx);
5881+ // A function called inline gets no children: its
5882+ // content is the text after its attributes
5883+ match Evaluator.complete(resolved, Vec::new(), ctx) {
5884+ Ok(nodes) => segments.extend(inline_segments(nodes, line)),
5885+ Err(mut e) => {
5886+ e.source_line
5887+ .get_or_insert_with(|| text.raw.as_str().into());
5888+ ctx.diagnostics.push(e);
5889+ }
5890+ }
5891+ }
5892+ Err(mut e) => {
5893+ // A misspelled element is an error inline too (a
5894+ // brace that is text is written `\{`); the braces
5895+ // stay as written
5896+ e.source_line = Some(text.raw.as_str().into());
5897+ ctx.diagnostics.push(e);
5898+ start.get_or_insert(inline.span);
5899+ plain.push('{');
5900+ plain.push_str(&inline.raw);
5901+ if inline.closed {
5902+ plain.push('}');
5903+ }
5904+ }
5905+ }
5906+ }
5907+ }
5908+ }
5909+ flush(&mut plain, &mut start, &mut segments, ctx);
5910+ segments
5911+}
5912+
5913+/// The variable `raw` is, when it is exactly one `$name` or `${name}`.
5914+fn whole_reference(raw: &str, env: &Env) -> Option<String> {
5915+ let after = raw.trim().strip_prefix('$')?;
5916+ match interp::reference(after, env)? {
5917+ (interp::Reference::Var(path), len) if len == after.len() => Some(path),
5918+ _ => None,
5919+ }
5920+}
5921+
5922+/// The attributes of `tokens` after each whole-attribute `if()` has
5923+/// chosen (see [`syntax::Choice`]), in order, into `out`. The branch not
5924+/// taken isn't evaluated; with `validate`, its attribute names are checked
5925+/// like code that doesn't run, under the prefixes `prefix` the `if()` is
5926+/// under (`hover:if(...)`).
5927+fn choose_attrs(
5928+ tokens: &[syntax::Attr],
5929+ prefix: &str,
5930+ line_num: usize,
5931+ ctx: &mut ParseContext,
5932+ validate: bool,
5933+ text_keys: &[String],
5934+ out: &mut Vec<syntax::Attr>,
5935+) {
5936+ for token in tokens {
5937+ let Some(choice) = &token.choice else {
5938+ out.push(token.clone());
5939+ continue;
5940+ };
5941+ let Some(condition) = choice_shape(token, choice, line_num, ctx) else {
5942+ continue;
5943+ };
5944+ let taken = match condition.span.line {
5945+ 0 => ctx.condition(&condition.raw, line_num, None),
5946+ line => ctx.condition(&condition.raw, line, Some(condition.span.column)),
5947+ };
5948+ let (chosen, other) = match taken {
5949+ true => (choice.branches.first(), choice.branches.get(1)),
5950+ false => (choice.branches.get(1), choice.branches.first()),
5951+ };
5952+ if let Some(other) = other {
5953+ track_var_refs(&branch_text(other), &mut ctx.used_variables);
5954+ if validate {
5955+ check_branch(token, other, prefix, line_num, ctx, text_keys);
5956+ }
5957+ }
5958+ if let Some(branch) = chosen {
5959+ choose_attrs(
5960+ branch.attrs(),
5961+ prefix,
5962+ line_num,
5963+ ctx,
5964+ validate,
5965+ text_keys,
5966+ out,
5967+ );
5968+ }
5969+ }
5970+}
5971+
5972+/// Report what is wrong with the shape of `if()`: an empty condition, a
5973+/// number of branches other than one or two, text after a group's `]`.
5974+/// Returns the condition when the `if()` can be evaluated.
5975+fn choice_shape<'a>(
5976+ token: &syntax::Attr,
5977+ choice: &'a syntax::Choice,
5978+ line_num: usize,
5979+ ctx: &mut ParseContext,
5980+) -> Option<&'a syntax::Arg> {
5981+ let line = if token.span.line == 0 {
5982+ line_num
5983+ } else {
5984+ token.span.line
5985+ };
5986+ // The line the column points into, when it is the one being evaluated
5987+ let source = |ctx: &ParseContext, diagnostic: Diagnostic, at: usize| match &ctx.current_source {
5988+ (current, Some(text)) if *current == at => diagnostic.source(text.clone()),
5989+ _ => diagnostic,
5990+ };
5991+ for branch in &choice.branches {
5992+ if let syntax::Branch::Group {
5993+ trailing: Some(trailing),
5994+ ..
5995+ } = branch
5996+ {
5997+ let diagnostic = source(
5998+ ctx,
5999+ Diagnostic::error(
6000+ code::UNEXPECTED_ARGUMENT,
6001+ trailing.span.line,
6002+ format!(
6003+ "'{}' after the `]` of a group in if(): a branch is one attribute, \
6004+ one `[group]` of attributes or one `$bundle`",
6005+ trailing.raw
6006+ ),
6007+ )
6008+ .column(trailing.span.column)
6009+ .subject(trailing.raw.as_str()),
6010+ trailing.span.line,
6011+ );
6012+ ctx.push_once(diagnostic);
6013+ }
6014+ }
6015+ match &choice.condition {
6016+ Some(condition) if (1..=2).contains(&choice.branches.len()) => Some(condition),
6017+ _ => {
6018+ let diagnostic = source(
6019+ ctx,
6020+ Diagnostic::error(
6021+ code::INVALID_EXPRESSION,
6022+ line,
6023+ format!(
6024+ "`{}`: if() takes a condition and one or two branches, \
6025+ `if(CONDITION, A, B)`",
6026+ token.raw
6027+ ),
6028+ )
6029+ .column(token.span.column),
6030+ line,
6031+ );
6032+ ctx.push_once(diagnostic);
6033+ None
6034+ }
6035+ }
6036+}
6037+
6038+/// A branch's text, for the names it uses.
6039+fn branch_text(branch: &syntax::Branch) -> String {
6040+ let raws: Vec<&str> = branch.attrs().iter().map(|a| a.raw.as_str()).collect();
6041+ raws.join(", ")
6042+}
6043+
6044+/// Check attributes that are never evaluated (in code that doesn't run,
6045+/// or the branch an `if()` didn't take), as far as they can be checked:
6046+/// names are, and literal values; a value with a variable depends on what
6047+/// the variable holds. Each branch of an `if()` is checked on its own.
6048+fn check_attrs(tokens: &[syntax::Attr], line: usize, ctx: &mut ParseContext, text_keys: &[String]) {
6049+ parse_attr_list(&literal_attrs(tokens), line, ctx, true, text_keys);
6050+ check_choices(tokens, "", line, ctx, text_keys);
6051+}
6052+
6053+/// [`check_attrs`] for a branch of the `if()` `token`, under the prefixes
6054+/// `prefix` it is under: `hover:if($on, color red, [id=x])` checks
6055+/// `hover:[id=x]`, an error whichever branch is taken.
6056+fn check_branch(
6057+ token: &syntax::Attr,
6058+ branch: &syntax::Branch,
6059+ prefix: &str,
6060+ line: usize,
6061+ ctx: &mut ParseContext,
6062+ text_keys: &[String],
6063+) {
6064+ if prefix.is_empty() {
6065+ check_attrs(branch.attrs(), line, ctx, text_keys);
6066+ return;
6067+ }
6068+ let list = syntax::AttrList {
6069+ attrs: branch.attrs().to_vec(),
6070+ span: token.span,
6071+ closed: true,
6072+ quoted_close: None,
6073+ };
6074+ let grouped = syntax::Attr {
6075+ key: prefix.to_string(),
6076+ value: None,
6077+ html: false,
6078+ raw: token.raw.clone(),
6079+ span: token.span,
6080+ choice: None,
6081+ prefixed: Some(Box::new(syntax::Prefixed {
6082+ prefix: prefix.to_string(),
6083+ prefix_span: token.span,
6084+ target: syntax::Branch::Group {
6085+ list,
6086+ trailing: None,
6087+ },
6088+ })),
6089+ };
6090+ check_attrs(std::slice::from_ref(&grouped), line, ctx, text_keys);
6091+}
6092+
6093+/// [`check_attrs`] for the branches of each `if()` of `tokens`, which are
6094+/// under the prefixes `prefix`, also inside a prefixed group or as a
6095+/// prefixed `if()`.
6096+fn check_choices(
6097+ tokens: &[syntax::Attr],
6098+ prefix: &str,
6099+ line: usize,
6100+ ctx: &mut ParseContext,
6101+ text_keys: &[String],
6102+) {
6103+ for token in tokens {
6104+ if let Some(choice) = &token.choice
6105+ && choice_shape(token, choice, line, ctx).is_some()
6106+ {
6107+ for branch in &choice.branches {
6108+ check_branch(token, branch, prefix, line, ctx, text_keys);
6109+ }
6110+ }
6111+ if let Some(prefixed) = &token.prefixed {
6112+ let inner = format!("{}{}", prefix, prefixed.prefix);
6113+ check_choices(prefixed.target.attrs(), &inner, line, ctx, text_keys);
6114+ }
6115+ }
6116+}
6117+
6118+// ---------------------------------------------------------------------------
6119+// Post-parse validation (context-dependent warnings)
6120+// ---------------------------------------------------------------------------
6121+
6122+fn element_kind_name(kind: &ElementKind) -> String {
6123+ format!("@{}", kind.name())
6124+}
6125+
6126+/// HTML elements whose start tag ends an open `<p>`: written inside a
6127+/// `@paragraph`, the browser moves them out of it. (`div` isn't here:
6128+/// inside text, htmlang writes its `<div>`s as `<span>`s.)
6129+#[rustfmt::skip]
6130+const ENDS_A_PARAGRAPH: &[&str] = &[
6131+ "address", "article", "aside", "blockquote", "dd", "details", "dialog", "dl", "dt",
6132+ "fieldset", "figcaption", "figure", "footer", "form", "h1", "h2", "h3", "h4", "h5", "h6",
6133+ "header", "hgroup", "hr", "li", "main", "menu", "nav", "ol", "p", "pre", "search",
6134+ "section", "summary", "table", "ul",
6135+];
6136+
6137+/// The HTML element `kind` is written as, if the browser would take it out
6138+/// of a `<p>`.
6139+fn ends_a_paragraph(kind: &ElementKind) -> Option<&'static str> {
6140+ let html = match kind {
6141+ ElementKind::Paragraph => "p",
6142+ ElementKind::Tag(spec) => spec.html,
6143+ _ => return None,
6144+ };
6145+ ENDS_A_PARAGRAPH.contains(&html).then_some(html)
6146+}
6147+
6148+/// Stricter checks for `htmlang lint`, on top of the diagnostics every
6149+/// compile reports: deep nesting, empty layout containers, and buttons
6150+/// without an explicit `type`.
6151+pub fn lint(nodes: &[Node]) -> Vec<Diagnostic> {
6152+ fn walk(nodes: &[Node], depth: usize, out: &mut Vec<Diagnostic>) {
6153+ for node in nodes {
6154+ let Node::Element(elem) = node else { continue };
6155+ let start = out.len();
6156+ let mut warn = |code: &'static str, message: String| {
6157+ out.push(Diagnostic::warning(code, elem.line_num, message))
6158+ };
6159+ if depth > 10 {
6160+ warn(
6161+ code::DEEP_NESTING,
6162+ format!(
6163+ "deeply nested element ({} levels): consider simplifying",
6164+ depth
6165+ ),
6166+ );
6167+ }
6168+ // A function's body may draw with an empty element (a spacer,
6169+ // a dot): only one written in the page is flagged
6170+ if elem.kind.layout().is_container()
6171+ && elem.children.is_empty()
6172+ && elem.function.is_none()
6173+ {
6174+ warn(
6175+ code::EMPTY_CONTAINER,
6176+ format!("empty container (@{}) has no children", elem.kind.name()),
6177+ );
6178+ }
6179+ if elem.kind.is_tag("button") && !elem.attrs.iter().any(|a| a.key == "type") {
6180+ warn(
6181+ code::MISSING_BUTTON_TYPE,
6182+ "@button missing 'type' attribute (defaults to submit)".to_string(),
6183+ );
6184+ }
6185+ in_function_body(elem, &mut out[start..]);
6186+ walk(&elem.children, depth + 1, out);
6187+ }
6188+ }
6189+ let mut out = Vec::new();
6190+ walk(nodes, 0, &mut out);
6191+ dedupe(&mut out);
6192+ out
6193+}
6194+
6195+/// `in_paragraph`: the nodes are inside a `@paragraph` (and not inside a
6196+/// `@button` in it, which the browser keeps whole).
6197+fn validate_tree(
6198+ nodes: &[Node],
6199+ parent_kind: Option<&ElementKind>,
6200+ in_paragraph: bool,
6201+ diagnostics: &mut Vec<Diagnostic>,
6202+) {
6203+ for node in nodes {
6204+ // An element inside a line of text (`{@kbd ...}`, an inline call)
6205+ // is checked like one on a line of its own
6206+ if let Node::Text(segments) = node {
6207+ let inline: Vec<Node> = segments
6208+ .iter()
6209+ .filter_map(|segment| match segment {
6210+ TextSegment::Inline(elem) => Some(Node::Element(elem.clone())),
6211+ _ => None,
6212+ })
6213+ .collect();
6214+ validate_tree(&inline, parent_kind, in_paragraph, diagnostics);
6215+ }
6216+ if let Node::Element(elem) = node {
6217+ let start = diagnostics.len();
6218+ dropped_by_the_element(elem, diagnostics);
6219+ if in_paragraph && let Some(html) = ends_a_paragraph(&elem.kind) {
6220+ diagnostics.push(
6221+ Diagnostic::warning(
6222+ code::BLOCK_IN_PARAGRAPH,
6223+ elem.line_num,
6224+ format!(
6225+ "{0} inside @paragraph: HTML ends a <p> before a <{1}>, so the \
6226+ browser moves the <{1}> out of the paragraph. Put {0} after the \
6227+ paragraph, or use @el, @row or @grid, which are laid out inline \
6228+ in text",
6229+ element_kind_name(&elem.kind),
6230+ html
6231+ ),
6232+ )
6233+ .subject(elem.kind.name()),
6234+ );
6235+ }
6236+ for attr in &elem.attrs {
6237+ let base = crate::vocab::base_attribute(&attr.key);
6238+
6239+ // htmlang's words for laying out children, on an element
6240+ // that doesn't lay out its children: left out (codegen)
6241+ if !attr.html
6242+ && crate::vocab::CONTAINER_ATTRIBUTES.contains(&base)
6243+ && !elem.kind.layout().is_container()
6244+ && !has_no_element(&elem.kind)
6245+ && !crate::vocab::split_prefixes(&attr.key)
6246+ .0
6247+ .contains(&"children:")
6248+ {
6249+ diagnostics.push(not_a_container(&elem.kind, elem.line_num, base));
6250+ }
6251+
6252+ // Form-specific: placeholder only on @input/@textarea
6253+ if base == "placeholder"
6254+ && !(elem.kind.is_tag("input") || elem.kind.is_tag("textarea"))
6255+ {
6256+ diagnostics.push(Diagnostic::new(
6257+ code::NO_EFFECT,
6258+ Severity::Warning,
6259+ elem.line_num,
6260+ format!(
6261+ "'placeholder' has no effect on {} (only works on @input, @textarea)",
6262+ element_kind_name(&elem.kind)
6263+ ),
6264+ ));
6265+ }
6266+
6267+ // 'for' only on @label and @output
6268+ if base == "for" && !(elem.kind.is_tag("label") || elem.kind.is_tag("output")) {
6269+ diagnostics.push(Diagnostic::new(
6270+ code::NO_EFFECT,
6271+ Severity::Warning,
6272+ elem.line_num,
6273+ format!(
6274+ "'for' has no effect on {} (only works on @label and @output)",
6275+ element_kind_name(&elem.kind)
6276+ ),
6277+ ));
6278+ }
6279+
6280+ // `width=` and `height=` are HTML attributes of media and
6281+ // embedded content only; elsewhere they are styles
6282+ if attr.html
6283+ && (base == "width" || base == "height")
6284+ && !matches!(elem.kind, ElementKind::Image)
6285+ && ![
6286+ "video", "canvas", "iframe", "embed", "object", "input", "source",
6287+ ]
6288+ .iter()
6289+ .any(|tag| elem.kind.is_tag(tag))
6290+ {
6291+ let value = attr.value.as_deref().unwrap_or("");
6292+ diagnostics.push(
6293+ Diagnostic::warning(
6294+ code::HTML_ATTRIBUTE_FORM,
6295+ elem.line_num,
6296+ format!(
6297+ "'{0}={1}' has no effect on {2}, which has no {0} attribute: \
6298+ the style is written `{0} {1}`",
6299+ base,
6300+ value,
6301+ element_kind_name(&elem.kind)
6302+ ),
6303+ )
6304+ .subject(format!("{}={}", base, value)),
6305+ );
6306+ }
6307+
6308+ // 'rows'/'cols' only on @textarea
6309+ if (base == "rows" || base == "cols") && !elem.kind.is_tag("textarea") {
6310+ diagnostics.push(Diagnostic::new(
6311+ code::NO_EFFECT,
6312+ Severity::Warning,
6313+ elem.line_num,
6314+ format!(
6315+ "'{}' has no effect on {} (only works on @textarea)",
6316+ base,
6317+ element_kind_name(&elem.kind)
6318+ ),
6319+ ));
6320+ }
6321+
6322+ // Media-specific attributes only on @video/@audio
6323+ if matches!(
6324+ base,
6325+ "controls"
6326+ | "autoplay"
6327+ | "loop"
6328+ | "muted"
6329+ | "playsinline"
6330+ | "poster"
6331+ | "preload"
6332+ ) && !matches!(elem.kind.name(), "video" | "audio")
6333+ {
6334+ diagnostics.push(Diagnostic::new(
6335+ code::NO_EFFECT,
6336+ Severity::Warning,
6337+ elem.line_num,
6338+ format!(
6339+ "'{}' has no effect on {} (only works on @video, @audio)",
6340+ base,
6341+ element_kind_name(&elem.kind)
6342+ ),
6343+ ));
6344+ }
6345+ }
6346+ // Missing alt text on @image
6347+ if matches!(elem.kind, ElementKind::Image) && !elem.attrs.iter().any(|a| a.key == "alt")
6348+ {
6349+ diagnostics.push(Diagnostic::new(
6350+ code::MISSING_ALT,
6351+ Severity::Warning,
6352+ elem.line_num,
6353+ "@image missing 'alt' attribute (accessibility)".to_string(),
6354+ ));
6355+ }
6356+ if elem.kind.is_tag("input") && !elem.attrs.iter().any(|a| a.key == "type") {
6357+ diagnostics.push(Diagnostic::new(
6358+ code::MISSING_INPUT_TYPE,
6359+ Severity::Warning,
6360+ elem.line_num,
6361+ "@input missing 'type' attribute (defaults to 'text')".to_string(),
6362+ ));
6363+ }
6364+ if matches!(elem.kind, ElementKind::Link) {
6365+ // For @link, argument is the URL, not text content
6366+ let has_text = !elem.children.is_empty();
6367+ if !has_text
6368+ && !elem
6369+ .attrs
6370+ .iter()
6371+ .any(|a| a.key == "aria-label" || a.key == "title")
6372+ {
6373+ diagnostics.push(Diagnostic::new(
6374+ code::MISSING_LINK_TEXT,
6375+ Severity::Warning,
6376+ elem.line_num,
6377+ "@link has no visible text or aria-label (accessibility)".to_string(),
6378+ ));
6379+ }
6380+ }
6381+
6382+ // Contrast ratio check for hex color pairs, each pair on the
6383+ // same elements: the element's own, or those an element prefix
6384+ // (`@td:`) picks out inside it
6385+ let inside = |key: &str| {
6386+ crate::vocab::split_prefixes(key)
6387+ .0
6388+ .into_iter()
6389+ .find_map(crate::vocab::element_prefix)
6390+ .map(str::to_string)
6391+ };
6392+ let mut targets: Vec<Option<String>> = Vec::new();
6393+ for attr in elem.attrs.iter().filter(|a| !a.html) {
6394+ let target = inside(&attr.key);
6395+ if !targets.contains(&target) {
6396+ targets.push(target);
6397+ }
6398+ }
6399+ for target in targets {
6400+ let color = |property: &str| {
6401+ elem.attrs
6402+ .iter()
6403+ .filter(|a| !a.html && inside(&a.key) == target)
6404+ .find(|a| crate::vocab::base_attribute(&a.key) == property)
6405+ .and_then(|a| a.value.as_deref())
6406+ };
6407+ let (bg_color, fg_color) = (color("background"), color("color"));
6408+ if let (Some(bg), Some(fg)) = (bg_color, fg_color)
6409+ && let (Some(bg_rgb), Some(fg_rgb)) = (parse_hex_rgb(bg), parse_hex_rgb(fg))
6410+ {
6411+ let ratio = contrast_ratio(bg_rgb, fg_rgb);
6412+ if ratio < 4.5 {
6413+ diagnostics.push(Diagnostic::new(code::LOW_CONTRAST, Severity::Warning, elem.line_num, format!(
6414+ "low contrast ratio {:.1}:1 between '{}' and '{}' (WCAG AA requires 4.5:1)",
6415+ ratio, fg, bg
6416+ )));
6417+ }
6418+ }
6419+ }
6420+
6421+ // @form inputs should have associated @label
6422+ if matches!(elem.kind.name(), "input" | "select" | "textarea") {
6423+ let has_id = elem.attrs.iter().any(|a| a.key == "id");
6424+ let has_aria_label = elem
6425+ .attrs
6426+ .iter()
6427+ .any(|a| a.key == "aria-label" || a.key == "aria-labelledby");
6428+ let has_title = elem.attrs.iter().any(|a| a.key == "title");
6429+ let in_label = parent_kind.is_some_and(|k| k.is_tag("label"));
6430+ if !has_id && !has_aria_label && !has_title && !in_label {
6431+ diagnostics.push(Diagnostic::new(code::MISSING_LABEL, Severity::Warning, elem.line_num, format!(
6432+ "{} should have an 'id' (with matching @label[for]), 'aria-label', or be wrapped in @label (accessibility)",
6433+ element_kind_name(&elem.kind)
6434+ )));
6435+ }
6436+ }
6437+
6438+ // @iframe should have title attribute
6439+ if elem.kind.is_tag("iframe") && !elem.attrs.iter().any(|a| a.key == "title") {
6440+ diagnostics.push(Diagnostic::new(
6441+ code::MISSING_TITLE,
6442+ Severity::Warning,
6443+ elem.line_num,
6444+ "@iframe missing 'title' attribute (accessibility)".to_string(),
6445+ ));
6446+ }
6447+
6448+ // @button should have accessible text
6449+ if elem.kind.is_tag("button") {
6450+ let has_text = !elem.children.is_empty();
6451+ let has_aria = elem.attrs.iter().any(|a| a.key == "aria-label");
6452+ if !has_text && !has_aria {
6453+ diagnostics.push(Diagnostic::new(
6454+ code::MISSING_BUTTON_TEXT,
6455+ Severity::Warning,
6456+ elem.line_num,
6457+ "@button has no text content or aria-label (accessibility)".to_string(),
6458+ ));
6459+ }
6460+ }
6461+
6462+ // @video should have captions or aria-label
6463+ if elem.kind.is_tag("video") {
6464+ let has_aria = elem
6465+ .attrs
6466+ .iter()
6467+ .any(|a| a.key == "aria-label" || a.key == "aria-describedby");
6468+ let has_track = elem
6469+ .children
6470+ .iter()
6471+ .any(|c| matches!(c, Node::Element(e) if e.kind.is_tag("track")));
6472+ if !has_aria && !has_track {
6473+ diagnostics.push(Diagnostic::new(
6474+ code::MISSING_CAPTIONS,
6475+ Severity::Warning,
6476+ elem.line_num,
6477+ "@video should have aria-label or a captions @track for accessibility"
6478+ .to_string(),
6479+ ));
6480+ }
6481+ }
6482+
6483+ // Tabindex > 0 is an anti-pattern
6484+ if let Some(tabindex_attr) = elem.attrs.iter().find(|a| a.key == "tabindex")
6485+ && let Some(ref val) = tabindex_attr.value
6486+ && let Ok(n) = val.parse::<i32>()
6487+ && n > 0
6488+ {
6489+ diagnostics.push(Diagnostic::new(code::POSITIVE_TABINDEX, Severity::Warning, elem.line_num, format!("tabindex {} is positive — avoid positive tabindex values as they disrupt natural tab order", n)));
6490+ }
6491+ in_function_body(elem, &mut diagnostics[start..]);
6492+
6493+ // An element that ends the <p> takes what is inside it out of
6494+ // the paragraph too, so only it is reported
6495+ let in_paragraph = elem.kind == ElementKind::Paragraph
6496+ || (in_paragraph
6497+ && ends_a_paragraph(&elem.kind).is_none()
6498+ && !elem.kind.is_tag("button"));
6499+ validate_tree(&elem.children, Some(&elem.kind), in_paragraph, diagnostics);
6500+ }
6501+ }
6502+}
6503+
6504+/// What an element has no place for in HTML, which would otherwise be
6505+/// left out of the page: attributes on `@fragment` (which has no element
6506+/// of its own), styles on `@script` (which isn't shown), a body under a
6507+/// `@script` that has a src (which the browser doesn't run), an element
6508+/// under a `@script` (whose body is code), and content in a void element
6509+/// such as `@input`.
6510+fn dropped_by_the_element(elem: &Element, diagnostics: &mut Vec<Diagnostic>) {
6511+ let name = elem.kind.name();
6512+ let keys = |attrs: Vec<&Attribute>| {
6513+ attrs
6514+ .iter()
6515+ .map(|a| format!("'{}'", a.key))
6516+ .collect::<Vec<_>>()
6517+ .join(", ")
6518+ };
6519+ let mut error = |code: &'static str, message: String| {
6520+ diagnostics.push(Diagnostic::error(code, elem.line_num, message).subject(name))
6521+ };
6522+ if elem.kind == ElementKind::Fragment && !elem.attrs.is_empty() {
6523+ error(
6524+ code::UNEXPECTED_ARGUMENT,
6525+ format!(
6526+ "@fragment has no element of its own to put attributes on, so {} would go \
6527+ nowhere: put them on its children, or use @el",
6528+ keys(elem.attrs.iter().collect())
6529+ ),
6530+ );
6531+ }
6532+ // The leading argument given twice: an attribute passed to the root
6533+ // of a function whose body gives the argument (written on one line,
6534+ // it is reported where it is read, and the attribute wins there)
6535+ if let Some(argument) = &elem.argument
6536+ && let Some(attr) = elem
6537+ .attrs
6538+ .iter()
6539+ .find(|a| a.html && elem.kind.arg().attributes().contains(&a.key.as_str()))
6540+ {
6541+ error(
6542+ code::DUPLICATE_ATTRIBUTE,
6543+ format!(
6544+ "@{} takes '{}' as its {}, and it also has {}={}: give it once",
6545+ name,
6546+ argument,
6547+ leading_name(&elem.kind),
6548+ attr.key,
6549+ attr.value.as_deref().unwrap_or("")
6550+ ),
6551+ );
6552+ }
6553+ if elem.kind.is_verbatim() {
6554+ let styles: Vec<&Attribute> = elem
6555+ .attrs
6556+ .iter()
6557+ .filter(|a| !a.html && !crate::vocab::is_html_flag(&a.key))
6558+ .collect();
6559+ if !styles.is_empty() {
6560+ error(
6561+ code::UNEXPECTED_ARGUMENT,
6562+ format!(
6563+ "@{} isn't shown on the page, so its styles {} would go nowhere",
6564+ name,
6565+ keys(styles)
6566+ ),
6567+ );
6568+ }
6569+ let src = elem.argument.clone().or_else(|| {
6570+ elem.attrs
6571+ .iter()
6572+ .find(|a| a.html && a.key == "src")
6573+ .map(|a| a.value.clone().unwrap_or_default())
6574+ });
6575+ if let Some(src) = src
6576+ && !elem.children.is_empty()
6577+ {
6578+ error(
6579+ code::UNEXPECTED_CONTENT,
6580+ format!(
6581+ "@{0} has both a src ('{1}') and a body: the browser runs only the file, \
6582+ so the body would go nowhere. Put the code in {1}, or leave out the src",
6583+ name, src
6584+ ),
6585+ );
6586+ } else if let Some(Node::Element(child)) = elem
6587+ .children
6588+ .iter()
6589+ .find(|child| matches!(child, Node::Element(_)))
6590+ {
6591+ // `@script > @b x`: its body is code, not elements
6592+ error(
6593+ code::UNEXPECTED_CONTENT,
6594+ format!(
6595+ "@{} holds its code as the lines under it, kept as written, so @{} would \
6596+ go nowhere",
6597+ name,
6598+ child.kind.name()
6599+ ),
6600+ );
6601+ }
6602+ }
6603+ if elem.kind != ElementKind::Image && elem.attrs.iter().any(|a| !a.html && a.key == "inline") {
6604+ error(
6605+ code::UNEXPECTED_ARGUMENT,
6606+ format!(
6607+ "`inline` puts an image's file into the page, and @{} has none: it only \
6608+ works on @image",
6609+ name
6610+ ),
6611+ );
6612+ }
6613+ if elem.kind.layout() == Layout::Void && !elem.children.is_empty() {
6614+ error(
6615+ code::UNEXPECTED_CONTENT,
6616+ format!(
6617+ "@{} takes no content: it is an element without a closing tag, so its text \
6618+ and indented lines would go nowhere",
6619+ name
6620+ ),
6621+ );
6622+ }
6623+}
6624+
6625+/// `@fragment`, `@script`, `@children` and `@slot`, whose attributes are
6626+/// reported on their own (see `dropped_by_the_element`).
6627+fn has_no_element(kind: &ElementKind) -> bool {
6628+ matches!(
6629+ kind,
6630+ ElementKind::Fragment | ElementKind::Children | ElementKind::Slot(_)
6631+ ) || kind.is_verbatim()
6632+}
6633+
6634+/// htmlang's word `word` for laying out children (`spacing`, `wrap`,
6635+/// `grid-cols`, `grid-rows`) on an element that doesn't lay out its
6636+/// children: an error, and the word is left out.
6637+fn not_a_container(kind: &ElementKind, line: usize, word: &str) -> Diagnostic {
6638+ let name = element_kind_name(kind);
6639+ let (what, instead) = match kind.layout() {
6640+ Layout::Text => (
6641+ "is text, whose lines and children flow together with no gap between them",
6642+ "; to space the children out, put them in an @el or @row",
6643+ ),
6644+ Layout::Void => ("has no content to lay out", ""),
6645+ _ => (
6646+ "keeps HTML's own layout",
6647+ "; for a flex layout of your own, write CSS, such as `display flex, gap 8`",
6648+ ),
6649+ };
6650+ Diagnostic::error(
6651+ code::NO_EFFECT,
6652+ line,
6653+ format!(
6654+ "'{0}' can't go on {1}: {1} {2}. `{0}` works on a row, column or grid \
6655+ (@el, @row, @grid, @section, ...){3}",
6656+ word, name, what, instead
6657+ ),
6658+ )
6659+ .subject(word)
6660+}
6661+
6662+/// Diagnostics about an element a function's body wrote are reported at
6663+/// the call (see `belongs_to_call`); say which body the element is in.
6664+fn in_function_body(elem: &Element, diagnostics: &mut [Diagnostic]) {
6665+ if let Some(function) = &elem.function {
6666+ for d in diagnostics {
6667+ d.message = format!("{}\n in the body of @{}", d.message, function);
6668+ }
6669+ }
6670+}
6671+
6672+/// Report each diagnostic once: a line that runs many times (in a loop, in
6673+/// a function called from one place many times) reports its problems once.
6674+fn dedupe(diagnostics: &mut Vec<Diagnostic>) {
6675+ let mut seen = HashSet::new();
6676+ diagnostics.retain(|d| {
6677+ seen.insert((
6678+ d.code,
6679+ d.line,
6680+ d.column,
6681+ d.message.clone(),
6682+ d.severity as u8,
6683+ ))
6684+ });
6685+}
6686+
6687+fn relative_luminance(r: u8, g: u8, b: u8) -> f64 {
6688+ fn linearize(c: u8) -> f64 {
6689+ let s = c as f64 / 255.0;
6690+ if s <= 0.03928 {
6691+ s / 12.92
6692+ } else {
6693+ ((s + 0.055) / 1.055).powf(2.4)
6694+ }
6695+ }
6696+ 0.2126 * linearize(r) + 0.7152 * linearize(g) + 0.0722 * linearize(b)
6697+}
6698+
6699+/// The red, green and blue of a `#rgb` or `#rrggbb` colour.
6700+fn parse_hex_rgb(s: &str) -> Option<(u8, u8, u8)> {
6701+ let s = s.strip_prefix('#')?;
6702+ if !s.bytes().all(|b| b.is_ascii_hexdigit()) {
6703+ return None;
6704+ }
6705+ let channel = |i: usize, len: usize| u8::from_str_radix(&s[i..i + len], 16).ok();
6706+ match s.len() {
6707+ 3 => Some((
6708+ channel(0, 1)? * 17,
6709+ channel(1, 1)? * 17,
6710+ channel(2, 1)? * 17,
6711+ )),
6712+ 6 => Some((channel(0, 2)?, channel(2, 2)?, channel(4, 2)?)),
6713+ _ => None,
6714+ }
6715+}
6716+
6717+fn contrast_ratio(c1: (u8, u8, u8), c2: (u8, u8, u8)) -> f64 {
6718+ let l1 = relative_luminance(c1.0, c1.1, c1.2);
6719+ let l2 = relative_luminance(c2.0, c2.1, c2.2);
6720+ let (lighter, darker) = if l1 > l2 { (l1, l2) } else { (l2, l1) };
6721+ (lighter + 0.05) / (darker + 0.05)
6722+}
6723+
6724+/// `@image [inline] icon.svg` becomes the SVG's markup, with `width`,
6725+/// `height`, `color` / `fill` and the HTML attributes (`class=`, `id=`,
6726+/// `aria-label=`, ...) applied to the `<svg>` tag; any other attribute is
6727+/// an error. Other nodes are returned unchanged.
6728+fn inline_svg(node: Node, line_num: usize, ctx: &mut ParseContext) -> Node {
6729+ let Node::Element(elem) = &node else {
6730+ return node;
6731+ };
6732+ let inline = elem.kind == ElementKind::Image
6733+ && elem.attrs.iter().any(|a| a.key == "inline" && !a.html)
6734+ && elem.argument.as_deref().is_some_and(|src| !src.is_empty());
6735+ if !inline {
6736+ return node;
6737+ }
6738+ // A raster image: its file, read relative to this one, as a `data:` URI
6739+ if !elem
6740+ .argument
6741+ .as_deref()
6742+ .is_some_and(|src| src.ends_with(".svg"))
6743+ {
6744+ let Node::Element(mut elem) = node else {
6745+ return node;
6746+ };
6747+ let filename = elem.argument.clone().unwrap_or_default();
6748+ let resolved = ctx.resolve(&filename);
6749+ match std::fs::read(&resolved) {
6750+ Ok(data) => {
6751+ elem.argument = Some(crate::codegen::data_uri(&filename, &data));
6752+ ctx.included_files.push(resolved);
6753+ }
6754+ Err(e) => ctx.diagnostics.push(Diagnostic::new(
6755+ code::UNREADABLE_FILE,
6756+ Severity::Error,
6757+ line_num,
6758+ format!(
6759+ "cannot load image '{}' to put it into the page: {}",
6760+ filename, e
6761+ ),
6762+ )),
6763+ }
6764+ return Node::Element(elem);
6765+ }
6766+ let filename = elem.argument.clone().unwrap_or_default();
6767+ let resolved = match &ctx.base_path {
6768+ Some(base) => base.join(&filename),
6769+ None => PathBuf::from(&filename),
6770+ };
6771+ let mut svg = match std::fs::read_to_string(&resolved) {
6772+ Ok(text) => text.trim().to_string(),
6773+ Err(e) => {
6774+ ctx.diagnostics.push(Diagnostic::new(
6775+ code::UNREADABLE_FILE,
6776+ Severity::Error,
6777+ line_num,
6778+ format!("cannot load SVG '{}': {}", filename, e),
6779+ ));
6780+ return node;
6781+ }
6782+ };
6783+ ctx.included_files.push(resolved);
6784+ // The file's markup has no class of its own, so a style reaches it only
6785+ // as one of the root's attributes: anything else is reported, never
6786+ // left out silently
6787+ let mut left_out: Vec<String> = Vec::new();
6788+ // The styles go in the root's `style=`, where a length takes its unit
6789+ // and `var(--name)` works, as in any CSS
6790+ let mut style: Vec<String> = Vec::new();
6791+ for attr in &elem.attrs {
6792+ let target = match (attr.key.as_str(), attr.html, &attr.value) {
6793+ ("inline", false, None) | ("src", true, _) => continue,
6794+ // `fill` and `shrink` are layout words, which need a class
6795+ ("width" | "height", false, Some(value))
6796+ if matches!(value.as_str(), "fill" | "shrink") =>
6797+ {
6798+ left_out.push(format!("{} {}", attr.key, value));
6799+ continue;
6800+ }
6801+ ("width" | "height", false, Some(value)) => {
6802+ let value = crate::vocab::with_px(&attr.key, value);
6803+ style.push(format!("{}:{}", attr.key, value));
6804+ continue;
6805+ }
6806+ ("color" | "fill", false, Some(value)) => {
6807+ style.push(format!("fill:{}", value));
6808+ continue;
6809+ }
6810+ ("style", true, Some(value)) => {
6811+ style.insert(0, value.trim().trim_end_matches(';').to_string());
6812+ continue;
6813+ }
6814+ ("alt", true, _) => {
6815+ left_out.push("alt".to_string());
6816+ continue;
6817+ }
6818+ (key, true, Some(_)) => key,
6819+ (key, false, None) if crate::vocab::is_html_flag(key) => key,
6820+ _ => {
6821+ left_out.push(attr.key.clone());
6822+ continue;
6823+ }
6824+ };
6825+ let value = attr.value.as_deref().unwrap_or("");
6826+ svg = set_svg_attr(&svg, target, &html_escape_md(value));
6827+ }
6828+ if !style.is_empty() {
6829+ // After the file's own `style=`, which stays: these come later, so
6830+ // they win where both set a property
6831+ let mut value = html_escape_md(&style.join(";"));
6832+ if let Some(own) = svg_attr_value(&svg, "style")
6833+ .map(|range| svg[range].trim().trim_end_matches(';').to_string())
6834+ .filter(|own| !own.is_empty())
6835+ {
6836+ value = format!("{};{}", own, value);
6837+ }
6838+ svg = set_svg_attr(&svg, "style", &value);
6839+ }
6840+ if !left_out.is_empty() {
6841+ let alt = left_out.iter().any(|name| name == "alt");
6842+ let names = left_out
6843+ .iter()
6844+ .map(|name| format!("'{}'", name))
6845+ .collect::<Vec<_>>()
6846+ .join(", ");
6847+ let mut message = format!(
6848+ "{} can't go on an inline SVG: `@image [inline]` puts the file's own markup into the page, which takes `width` and `height` as lengths, `color` or `fill` (as its fill) and HTML attributes (`class=`, `aria-label=`, ...)",
6849+ names
6850+ );
6851+ if alt {
6852+ message.push_str("; an SVG has no alt text: name it with `aria-label=` and `role=img`");
6853+ }
6854+ ctx.diagnostics.push(Diagnostic::new(
6855+ code::UNEXPECTED_ARGUMENT,
6856+ Severity::Error,
6857+ line_num,
6858+ message,
6859+ ));
6860+ }
6861+ Node::Raw(svg)
6862+}
6863+
6864+// ---------------------------------------------------------------------------
6865+// Variable usage tracking
6866+// ---------------------------------------------------------------------------
6867+
6868+/// Record the names a string refers to (by syntax) as used.
6869+fn track_var_refs(input: &str, used: &mut HashSet<String>) {
6870+ if input.contains('$') {
6871+ used.extend(interp::names(input).into_iter().map(String::from));
6872+ }
6873+}
6874+
6875+// ---------------------------------------------------------------------------
6876+// Unused definition warnings
6877+// ---------------------------------------------------------------------------
6878+
6879+/// Warn about definitions nothing uses, except `exported` ones (the
6880+/// definitions of a library, for the files that include it).
6881+fn check_unused(ctx: &mut ParseContext, exported: &HashSet<String>) {
6882+ // Check unused @let variables
6883+ for (name, &line) in &ctx.let_lines {
6884+ if exported.contains(name) {
6885+ // A library's names are for other files (a custom property
6886+ // isn't a variable, so it is never listed here)
6887+ continue;
6888+ }
6889+ if !ctx.used_variables.contains(name) {
6890+ ctx.diagnostics.push(
6891+ Diagnostic::new(
6892+ code::UNUSED_VARIABLE,
6893+ Severity::Warning,
6894+ line,
6895+ format!("unused variable '${}' (defined but never referenced)", name),
6896+ )
6897+ .subject(name.as_str()),
6898+ );
6899+ }
6900+ }
6901+
6902+ // Check unused attribute bundles (@let name [...]). A `$name` in code
6903+ // that doesn't run (an `if()` branch or `@if` not taken) counts too.
6904+ for (name, &line) in &ctx.define_lines {
6905+ if !ctx.used_defines.contains(name)
6906+ && !ctx.used_variables.contains(name)
6907+ && !exported.contains(name)
6908+ {
6909+ ctx.diagnostics.push(
6910+ Diagnostic::new(
6911+ code::UNUSED_BUNDLE,
6912+ Severity::Warning,
6913+ line,
6914+ format!(
6915+ "unused attribute bundle '${}' (defined but never referenced)",
6916+ name
6917+ ),
6918+ )
6919+ .subject(name.as_str()),
6920+ );
6921+ }
6922+ }
6923+
6924+ // Check unused functions (@let name ... with body)
6925+ for (name, &line) in &ctx.fn_lines {
6926+ if !ctx.used_functions.contains(name) && !exported.contains(name) {
6927+ ctx.diagnostics.push(
6928+ Diagnostic::new(
6929+ code::UNUSED_FUNCTION,
6930+ Severity::Warning,
6931+ line,
6932+ format!("unused function '@{}' (defined but never called)", name),
6933+ )
6934+ .subject(name.as_str()),
6935+ );
6936+ }
6937+ }
6938+}
6939+
6940+// ---------------------------------------------------------------------------
6941+// Minimal JSON parser for @data directive
6942+// ---------------------------------------------------------------------------
6943+
6944+#[derive(Debug, Clone)]
6945+enum JsonValue {
6946+ Null,
6947+ Bool(bool),
6948+ Number(String),
6949+ Str(String),
6950+ Array(Vec<JsonValue>),
6951+ Object(Vec<(String, JsonValue)>),
6952+}
6953+
6954+/// Parse JSON with an error message indicating where parsing failed.
6955+fn parse_json_with_error(input: &str) -> Result<JsonValue, String> {
6956+ let trimmed = input.trim();
6957+ if trimmed.is_empty() {
6958+ return Err("empty input".to_string());
6959+ }
6960+ let chars: Vec<char> = trimmed.chars().collect();
6961+ match parse_json_value(&chars, 0) {
6962+ Some((val, _)) => Ok(val),
6963+ None => {
6964+ // Find approximate error position by parsing as far as possible
6965+ let mut deepest = 0usize;
6966+ fn probe(chars: &[char], pos: usize, deepest: &mut usize) {
6967+ let mut p = pos;
6968+ while p < chars.len() {
6969+ if p > *deepest {
6970+ *deepest = p;
6971+ }
6972+ match chars[p] {
6973+ '{' | '[' => {
6974+ p += 1;
6975+ probe(chars, p, deepest);
6976+ return;
6977+ }
6978+ '"' => {
6979+ p += 1;
6980+ while p < chars.len() && chars[p] != '"' {
6981+ if chars[p] == '\\' {
6982+ p += 1;
6983+ }
6984+ p += 1;
6985+ }
6986+ if p < chars.len() {
6987+ p += 1;
6988+ }
6989+ if p > *deepest {
6990+ *deepest = p;
6991+ }
6992+ return;
6993+ }
6994+ _ => {
6995+ p += 1;
6996+ }
6997+ }
6998+ }
6999+ }
7000+ probe(&chars, 0, &mut deepest);
7001+ // Convert char position to line:col
7002+ let prefix: String = chars[..deepest.min(chars.len())].iter().collect();
7003+ let line = prefix.chars().filter(|&c| c == '\n').count() + 1;
7004+ let col = prefix
7005+ .rfind('\n')
7006+ .map_or(prefix.len(), |p| prefix.len() - p - 1)
7007+ + 1;
7008+ let context: String = chars[deepest.saturating_sub(20)..deepest.min(chars.len())]
7009+ .iter()
7010+ .collect();
7011+ Err(format!(
7012+ "at line {}:{} near \"{}\"",
7013+ line,
7014+ col,
7015+ context.trim()
7016+ ))
7017+ }
7018+ }
7019+}
7020+
7021+fn parse_json_value(chars: &[char], mut pos: usize) -> Option<(JsonValue, usize)> {
7022+ pos = skip_ws(chars, pos);
7023+ if pos >= chars.len() {
7024+ return None;
7025+ }
7026+ match chars[pos] {
7027+ '"' => {
7028+ let (s, p) = parse_json_string(chars, pos)?;
7029+ Some((JsonValue::Str(s), p))
7030+ }
7031+ '{' => parse_json_object(chars, pos),
7032+ '[' => parse_json_array(chars, pos),
7033+ 't' => {
7034+ if chars.get(pos..pos + 4)?.iter().collect::<String>() == "true" {
7035+ Some((JsonValue::Bool(true), pos + 4))
7036+ } else {
7037+ None
7038+ }
7039+ }
7040+ 'f' => {
7041+ if chars.get(pos..pos + 5)?.iter().collect::<String>() == "false" {
7042+ Some((JsonValue::Bool(false), pos + 5))
7043+ } else {
7044+ None
7045+ }
7046+ }
7047+ 'n' => {
7048+ if chars.get(pos..pos + 4)?.iter().collect::<String>() == "null" {
7049+ Some((JsonValue::Null, pos + 4))
7050+ } else {
7051+ None
7052+ }
7053+ }
7054+ c if c == '-' || c.is_ascii_digit() => {
7055+ let start = pos;
7056+ if chars[pos] == '-' {
7057+ pos += 1;
7058+ }
7059+ while pos < chars.len()
7060+ && (chars[pos].is_ascii_digit()
7061+ || chars[pos] == '.'
7062+ || chars[pos] == 'e'
7063+ || chars[pos] == 'E'
7064+ || chars[pos] == '+'
7065+ || chars[pos] == '-')
7066+ {
7067+ if (chars[pos] == '+' || chars[pos] == '-')
7068+ && pos > start + 1
7069+ && chars[pos - 1] != 'e'
7070+ && chars[pos - 1] != 'E'
7071+ {
7072+ break;
7073+ }
7074+ pos += 1;
7075+ }
7076+ let num: String = chars[start..pos].iter().collect();
7077+ Some((JsonValue::Number(num), pos))
7078+ }
7079+ _ => None,
7080+ }
7081+}
7082+
7083+fn parse_json_string(chars: &[char], mut pos: usize) -> Option<(String, usize)> {
7084+ if chars.get(pos) != Some(&'"') {
7085+ return None;
7086+ }
7087+ pos += 1;
7088+ let mut s = String::new();
7089+ while pos < chars.len() && chars[pos] != '"' {
7090+ if chars[pos] == '\\' && pos + 1 < chars.len() {
7091+ pos += 1;
7092+ match chars[pos] {
7093+ '"' | '\\' | '/' => s.push(chars[pos]),
7094+ 'n' => s.push('\n'),
7095+ 't' => s.push('\t'),
7096+ 'r' => s.push('\r'),
7097+ 'b' => s.push('\u{8}'),
7098+ 'f' => s.push('\u{c}'),
7099+ 'u' => {
7100+ let hex4 = |at: usize| -> Option<u32> {
7101+ let digits: String = chars.get(at..at + 4)?.iter().collect();
7102+ u32::from_str_radix(&digits, 16).ok()
7103+ };
7104+ let hi = hex4(pos + 1)?;
7105+ pos += 4;
7106+ let code = if (0xD800..0xDC00).contains(&hi)
7107+ && chars.get(pos + 1) == Some(&'\\')
7108+ && chars.get(pos + 2) == Some(&'u')
7109+ && let Some(lo) = hex4(pos + 3)
7110+ && (0xDC00..0xE000).contains(&lo)
7111+ {
7112+ pos += 6;
7113+ 0x10000 + ((hi - 0xD800) << 10) + (lo - 0xDC00)
7114+ } else {
7115+ hi
7116+ };
7117+ s.push(char::from_u32(code).unwrap_or('\u{FFFD}'));
7118+ }
7119+ _ => {
7120+ s.push('\\');
7121+ s.push(chars[pos]);
7122+ }
7123+ }
7124+ } else {
7125+ s.push(chars[pos]);
7126+ }
7127+ pos += 1;
7128+ }
7129+ if pos < chars.len() {
7130+ pos += 1; // closing quote
7131+ }
7132+ Some((s, pos))
7133+}
7134+
7135+fn parse_json_object(chars: &[char], mut pos: usize) -> Option<(JsonValue, usize)> {
7136+ pos += 1; // skip '{'
7137+ pos = skip_ws(chars, pos);
7138+ let mut pairs = Vec::new();
7139+ if pos < chars.len() && chars[pos] == '}' {
7140+ return Some((JsonValue::Object(pairs), pos + 1));
7141+ }
7142+ loop {
7143+ pos = skip_ws(chars, pos);
7144+ let (key, p) = parse_json_string(chars, pos)?;
7145+ pos = skip_ws(chars, p);
7146+ if pos >= chars.len() || chars[pos] != ':' {
7147+ return None;
7148+ }
7149+ pos += 1;
7150+ let (val, p) = parse_json_value(chars, pos)?;
7151+ pos = p;
7152+ pairs.push((key, val));
7153+ pos = skip_ws(chars, pos);
7154+ if pos >= chars.len() {
7155+ break;
7156+ }
7157+ if chars[pos] == '}' {
7158+ pos += 1;
7159+ break;
7160+ }
7161+ if chars[pos] == ',' {
7162+ pos += 1;
7163+ }
7164+ }
7165+ Some((JsonValue::Object(pairs), pos))
7166+}
7167+
7168+fn parse_json_array(chars: &[char], mut pos: usize) -> Option<(JsonValue, usize)> {
7169+ pos += 1; // skip '['
7170+ pos = skip_ws(chars, pos);
7171+ let mut items = Vec::new();
7172+ if pos < chars.len() && chars[pos] == ']' {
7173+ return Some((JsonValue::Array(items), pos + 1));
7174+ }
7175+ loop {
7176+ let (val, p) = parse_json_value(chars, pos)?;
7177+ pos = p;
7178+ items.push(val);
7179+ pos = skip_ws(chars, pos);
7180+ if pos >= chars.len() {
7181+ break;
7182+ }
7183+ if chars[pos] == ']' {
7184+ pos += 1;
7185+ break;
7186+ }
7187+ if chars[pos] == ',' {
7188+ pos += 1;
7189+ }
7190+ }
7191+ Some((JsonValue::Array(items), pos))
7192+}
7193+
7194+fn skip_ws(chars: &[char], mut pos: usize) -> usize {
7195+ while pos < chars.len() && chars[pos].is_ascii_whitespace() {
7196+ pos += 1;
7197+ }
7198+ pos
7199+}
7200+
7201+/// A JSON value as an htmlang value: an object is a record, an array a
7202+/// list, a string text (never quoted text), `null` empty. A number keeps
7203+/// the text it is written with (`1.50`), and reads as a number.
7204+fn json_value(json: JsonValue) -> Value {
7205+ match json {
7206+ JsonValue::Null => Value::empty(),
7207+ JsonValue::Bool(b) => Value::Bool(b),
7208+ JsonValue::Number(n) | JsonValue::Str(n) => Value::Str(n),
7209+ JsonValue::Array(items) => Value::list(items.into_iter().map(json_value).collect()),
7210+ JsonValue::Object(pairs) => Value::Record(Rc::new(
7211+ pairs
7212+ .into_iter()
7213+ .map(|(key, value)| (key, json_value(value)))
7214+ .collect(),
7215+ )),
7216+ }
7217+}
7218+
7219+// ---------------------------------------------------------------------------
7220+// SVG attribute injection helper
7221+// ---------------------------------------------------------------------------
7222+
7223+/// Where the root `<svg ...>` tag's `attr_name="..."` value is, as a byte
7224+/// range of `svg`. Only the opening tag is read, so a child's attribute is
7225+/// never found, and the name must follow whitespace, so `width` doesn't
7226+/// match `stroke-width`.
7227+fn svg_attr_value(svg: &str, attr_name: &str) -> Option<std::ops::Range<usize>> {
7228+ let tag_start = svg.find("<svg")?;
7229+ let tag_end = svg[tag_start..]
7230+ .find('>')
7231+ .map(|p| tag_start + p)
7232+ .unwrap_or(svg.len());
7233+ let tag = &svg[tag_start..tag_end];
7234+ let pattern = format!("{}=\"", attr_name);
7235+ let (pos, _) = tag.match_indices(&pattern).find(|(pos, _)| {
7236+ tag[..*pos]
7237+ .chars()
7238+ .next_back()
7239+ .is_some_and(char::is_whitespace)
7240+ })?;
7241+ let value_start = tag_start + pos + pattern.len();
7242+ let end = svg[value_start..tag_end].find('"')?;
7243+ Some(value_start..value_start + end)
7244+}
7245+
7246+fn set_svg_attr(svg: &str, attr_name: &str, value: &str) -> String {
7247+ // Only the opening <svg ...> tag is touched, so child attributes such as
7248+ // `stroke-width` are left alone.
7249+ let Some(tag_start) = svg.find("<svg") else {
7250+ return svg.to_string();
7251+ };
7252+ let tag_end = svg[tag_start..]
7253+ .find('>')
7254+ .map(|p| tag_start + p)
7255+ .unwrap_or(svg.len());
7256+
7257+ // Replace an existing attribute
7258+ if let Some(existing) = svg_attr_value(svg, attr_name) {
7259+ let mut result = String::with_capacity(svg.len());
7260+ result.push_str(&svg[..existing.start]);
7261+ result.push_str(value);
7262+ result.push_str(&svg[existing.end..]);
7263+ return result;
7264+ }
7265+
7266+ // Otherwise inject it into the opening tag (before a self-closing `/`).
7267+ let insert_at = if svg[..tag_end].ends_with('/') {
7268+ tag_end - 1
7269+ } else {
7270+ tag_end
7271+ };
7272+ let mut result = String::with_capacity(svg.len() + attr_name.len() + value.len() + 4);
7273+ result.push_str(svg[..insert_at].trim_end());
7274+ result.push(' ');
7275+ result.push_str(attr_name);
7276+ result.push_str("=\"");
7277+ result.push_str(value);
7278+ result.push('"');
7279+ result.push_str(&svg[insert_at..]);
7280+ result
7281+}
7282+
7283+// ---------------------------------------------------------------------------
7284+// Markdown → HTML conversion (minimal subset)
7285+// ---------------------------------------------------------------------------
7286+
7287+fn markdown_to_html(lines: &[String]) -> String {
7288+ let mut html = String::new();
7289+ // Tag of the list currently open ("ul" or "ol"), if any.
7290+ let mut list: Option<&'static str> = None;
7291+ let mut in_code_block = false;
7292+ let mut code_lang = String::new();
7293+ let mut code_buf = String::new();
7294+ let mut para_buf = String::new();
7295+
7296+ let flush_para = |para: &mut String, out: &mut String| {
7297+ let trimmed = para.trim();
7298+ if !trimmed.is_empty() {
7299+ out.push_str("<p>");
7300+ out.push_str(&md_inline(trimmed));
7301+ out.push_str("</p>\n");
7302+ }
7303+ para.clear();
7304+ };
7305+ let close_list = |list: &mut Option<&'static str>, out: &mut String| {
7306+ if let Some(tag) = list.take() {
7307+ out.push_str(&format!("</{}>\n", tag));
7308+ }
7309+ };
7310+ let open_list = |list: &mut Option<&'static str>, tag: &'static str, out: &mut String| {
7311+ if *list != Some(tag) {
7312+ if let Some(prev) = list.take() {
7313+ out.push_str(&format!("</{}>\n", prev));
7314+ }
7315+ out.push_str(&format!("<{}>\n", tag));
7316+ *list = Some(tag);
7317+ }
7318+ };
7319+
7320+ for line in lines {
7321+ let trimmed = line.trim();
7322+
7323+ // Fenced code blocks
7324+ if let Some(after_fence) = trimmed.strip_prefix("```") {
7325+ if in_code_block {
7326+ html.push_str("<pre><code");
7327+ if !code_lang.is_empty() {
7328+ html.push_str(&format!(" class=\"language-{}\"", code_lang));
7329+ }
7330+ html.push('>');
7331+ html.push_str(&html_escape_md(&code_buf));
7332+ html.push_str("</code></pre>\n");
7333+ code_buf.clear();
7334+ code_lang.clear();
7335+ in_code_block = false;
7336+ } else {
7337+ flush_para(&mut para_buf, &mut html);
7338+ close_list(&mut list, &mut html);
7339+ code_lang = after_fence.trim().to_string();
7340+ in_code_block = true;
7341+ }
7342+ continue;
7343+ }
7344+ if in_code_block {
7345+ if !code_buf.is_empty() {
7346+ code_buf.push('\n');
7347+ }
7348+ // Keep indentation inside code blocks.
7349+ code_buf.push_str(line.trim_end());
7350+ continue;
7351+ }
7352+
7353+ // Blank line ends paragraph
7354+ if trimmed.is_empty() {
7355+ flush_para(&mut para_buf, &mut html);
7356+ close_list(&mut list, &mut html);
7357+ continue;
7358+ }
7359+
7360+ // Headings
7361+ let heading_level = trimmed.bytes().take_while(|&b| b == b'#').count();
7362+ if (1..=6).contains(&heading_level) && trimmed.as_bytes().get(heading_level) == Some(&b' ')
7363+ {
7364+ flush_para(&mut para_buf, &mut html);
7365+ close_list(&mut list, &mut html);
7366+ let text = &trimmed[heading_level + 1..];
7367+ html.push_str(&format!(
7368+ "<h{}>{}</h{}>\n",
7369+ heading_level,
7370+ md_inline(text),
7371+ heading_level
7372+ ));
7373+ continue;
7374+ }
7375+
7376+ // Horizontal rule (checked before list items so `---`/`***` aren't
7377+ // mistaken for bullets)
7378+ if trimmed == "---" || trimmed == "***" || trimmed == "___" {
7379+ flush_para(&mut para_buf, &mut html);
7380+ close_list(&mut list, &mut html);
7381+ html.push_str("<hr>\n");
7382+ continue;
7383+ }
7384+
7385+ // Unordered list items
7386+ if (trimmed.starts_with("- ") || trimmed.starts_with("* ")) && trimmed.len() > 2 {
7387+ flush_para(&mut para_buf, &mut html);
7388+ open_list(&mut list, "ul", &mut html);
7389+ html.push_str(&format!("<li>{}</li>\n", md_inline(&trimmed[2..])));
7390+ continue;
7391+ }
7392+
7393+ // Ordered list items
7394+ if let Some(dot_pos) = trimmed.find(". ")
7395+ && (1..=3).contains(&dot_pos)
7396+ && trimmed[..dot_pos].chars().all(|c| c.is_ascii_digit())
7397+ {
7398+ flush_para(&mut para_buf, &mut html);
7399+ open_list(&mut list, "ol", &mut html);
7400+ html.push_str(&format!(
7401+ "<li>{}</li>\n",
7402+ md_inline(&trimmed[dot_pos + 2..])
7403+ ));
7404+ continue;
7405+ }
7406+
7407+ // Blockquote
7408+ if let Some(quote_content) = trimmed.strip_prefix("> ") {
7409+ flush_para(&mut para_buf, &mut html);
7410+ close_list(&mut list, &mut html);
7411+ html.push_str(&format!(
7412+ "<blockquote><p>{}</p></blockquote>\n",
7413+ md_inline(quote_content)
7414+ ));
7415+ continue;
7416+ }
7417+
7418+ // Otherwise, accumulate paragraph text
7419+ close_list(&mut list, &mut html);
7420+ if !para_buf.is_empty() {
7421+ para_buf.push(' ');
7422+ }
7423+ para_buf.push_str(trimmed);
7424+ }
7425+
7426+ // Flush remaining
7427+ close_list(&mut list, &mut html);
7428+ flush_para(&mut para_buf, &mut html);
7429+
7430+ html
7431+}
7432+
7433+fn md_inline(text: &str) -> String {
7434+ let mut result = String::new();
7435+ let chars: Vec<char> = text.chars().collect();
7436+ let mut i = 0;
7437+
7438+ while i < chars.len() {
7439+ // Bold: **text** or __text__
7440+ if i + 1 < chars.len()
7441+ && ((chars[i] == '*' && chars[i + 1] == '*')
7442+ || (chars[i] == '_' && chars[i + 1] == '_'))
7443+ {
7444+ let marker = chars[i];
7445+ if let Some(end) = find_closing_double(&chars, i + 2, marker) {
7446+ let inner: String = chars[i + 2..end].iter().collect();
7447+ result.push_str("<strong>");
7448+ result.push_str(&md_inline(&inner));
7449+ result.push_str("</strong>");
7450+ i = end + 2;
7451+ continue;
7452+ }
7453+ }
7454+ // Italic: *text* or _text_
7455+ if (chars[i] == '*' || chars[i] == '_') && i + 1 < chars.len() && chars[i + 1] != chars[i] {
7456+ let marker = chars[i];
7457+ if let Some(end) = find_closing_single(&chars, i + 1, marker) {
7458+ let inner: String = chars[i + 1..end].iter().collect();
7459+ result.push_str("<em>");
7460+ result.push_str(&md_inline(&inner));
7461+ result.push_str("</em>");
7462+ i = end + 1;
7463+ continue;
7464+ }
7465+ }
7466+ // Inline code: `text`
7467+ if chars[i] == '`'
7468+ && let Some(end) = chars[i + 1..].iter().position(|&c| c == '`')
7469+ {
7470+ let inner: String = chars[i + 1..i + 1 + end].iter().collect();
7471+ result.push_str("<code>");
7472+ result.push_str(&html_escape_md(&inner));
7473+ result.push_str("</code>");
7474+ i = i + 2 + end;
7475+ continue;
7476+ }
7477+ // Links: [text](url)
7478+ if chars[i] == '['
7479+ && let Some(close_bracket) = chars[i + 1..].iter().position(|&c| c == ']')
7480+ {
7481+ let after = i + 1 + close_bracket + 1;
7482+ if after < chars.len()
7483+ && chars[after] == '('
7484+ && let Some(close_paren) = chars[after + 1..].iter().position(|&c| c == ')')
7485+ {
7486+ let text: String = chars[i + 1..i + 1 + close_bracket].iter().collect();
7487+ let url: String = chars[after + 1..after + 1 + close_paren].iter().collect();
7488+ result.push_str(&format!(
7489+ "<a href=\"{}\">{}</a>",
7490+ html_escape_md(&url),
7491+ md_inline(&text)
7492+ ));
7493+ i = after + 2 + close_paren;
7494+ continue;
7495+ }
7496+ }
7497+ result.push(chars[i]);
7498+ i += 1;
7499+ }
7500+
7501+ result
7502+}
7503+
7504+fn find_closing_double(chars: &[char], start: usize, marker: char) -> Option<usize> {
7505+ let mut i = start;
7506+ while i + 1 < chars.len() {
7507+ if chars[i] == marker && chars[i + 1] == marker {
7508+ return Some(i);
7509+ }
7510+ i += 1;
7511+ }
7512+ None
7513+}
7514+
7515+fn find_closing_single(chars: &[char], start: usize, marker: char) -> Option<usize> {
7516+ (start..chars.len()).find(|&i| chars[i] == marker)
7517+}
7518+
7519+/// Simple glob matching supporting `*` as wildcard for any characters and `?` for a single character.
7520+fn glob_match(pattern: &str, text: &str) -> bool {
7521+ let mut pi = 0;
7522+ let mut ti = 0;
7523+ let pb = pattern.as_bytes();
7524+ let tb = text.as_bytes();
7525+ let mut star_pi = usize::MAX;
7526+ let mut star_ti = 0;
7527+ while ti < tb.len() {
7528+ if pi < pb.len() && (pb[pi] == b'?' || pb[pi] == tb[ti]) {
7529+ pi += 1;
7530+ ti += 1;
7531+ } else if pi < pb.len() && pb[pi] == b'*' {
7532+ star_pi = pi;
7533+ star_ti = ti;
7534+ pi += 1;
7535+ } else if star_pi != usize::MAX {
7536+ pi = star_pi + 1;
7537+ star_ti += 1;
7538+ ti = star_ti;
7539+ } else {
7540+ return false;
7541+ }
7542+ }
7543+ while pi < pb.len() && pb[pi] == b'*' {
7544+ pi += 1;
7545+ }
7546+ pi == pb.len()
7547+}
7548+
7549+fn html_escape_md(s: &str) -> String {
7550+ s.replace('&', "&amp;")
7551+ .replace('<', "&lt;")
7552+ .replace('>', "&gt;")
7553+ .replace('"', "&quot;")
7554+}
7555+
7556+#[cfg(test)]
7557+mod tests {
7558+ use super::*;
7559+
7560+ fn parse_ok(src: &str) -> ParseResult {
7561+ let r = parse(src);
7562+ assert!(
7563+ r.diagnostics.iter().all(|d| d.severity != Severity::Error),
7564+ "unexpected error diagnostics: {:?}",
7565+ r.diagnostics,
7566+ );
7567+ r
7568+ }
7569+
7570+ #[test]
7571+ fn parses_empty_input() {
7572+ let r = parse("");
7573+ assert!(r.document.nodes.is_empty());
7574+ assert!(r.diagnostics.is_empty());
7575+ }
7576+
7577+ #[test]
7578+ fn parses_bare_text_node() {
7579+ let r = parse_ok("Hello world\n");
7580+ assert_eq!(r.document.nodes.len(), 1);
7581+ }
7582+
7583+ #[test]
7584+ fn parses_page_directive() {
7585+ let r = parse_ok("@page My Title\n");
7586+ assert_eq!(
7587+ r.document.page.map(|p| p.title).as_deref(),
7588+ Some("My Title")
7589+ );
7590+ }
7591+
7592+ #[test]
7593+ fn let_variable_substitution() {
7594+ let r = parse_ok("@let color red\n@text [color $color] hi\n");
7595+ assert_eq!(
7596+ r.document.variables.get("color").map(|s| s.as_str()),
7597+ Some("red")
7598+ );
7599+ }
7600+
7601+ #[test]
7602+ fn error_recovery_continues_after_unknown_element() {
7603+ // Intentionally malformed line followed by a valid one — recovery must
7604+ // let us still see the good line in diagnostics / output.
7605+ let r = parse("@notareal\n@text hi\n");
7606+ let has_error = r.diagnostics.iter().any(|d| d.severity == Severity::Error);
7607+ assert!(has_error, "expected at least one error for @notareal");
7608+ }
7609+
7610+ #[test]
7611+ fn undefined_fn_is_reported_not_panics() {
7612+ // Prior to the unwrap fix this panicked.
7613+ let r = parse("@missing\n");
7614+ assert!(r.diagnostics.iter().any(|d| d.severity == Severity::Error));
7615+ }
7616+
7617+ #[test]
7618+ fn scope_without_selector_does_not_panic() {
7619+ let r = parse("@scope\n body { background red; }\n");
7620+ // Should parse — may or may not emit diagnostics, but must not panic.
7621+ let _ = r;
7622+ }
7623+
7624+ #[test]
7625+ fn levenshtein_bounded_respects_cutoff() {
7626+ let a: Vec<char> = "hello".chars().collect();
7627+ let b: Vec<char> = "world".chars().collect();
7628+ // Full distance is 4, but asking for cutoff 2 should early-exit.
7629+ let d = levenshtein_bounded(&a, &b, 2);
7630+ assert!(d > 2, "expected early exit above cutoff, got {}", d);
7631+ }
7632+
7633+ #[test]
7634+ fn severity_has_all_variants() {
7635+ // This compiles only if Severity has Error, Warning, Info, Help.
7636+ let all = [
7637+ Severity::Error,
7638+ Severity::Warning,
7639+ Severity::Info,
7640+ Severity::Help,
7641+ ];
7642+ assert_eq!(all.len(), 4);
7643+ }
7644+
7645+ #[test]
7646+ fn arithmetic_empty_operator_does_not_panic() {
7647+ // Guards the `op.trim().chars().next().unwrap()` fix.
7648+ let r = parse("@let x = 1 + 2\n");
7649+ assert_eq!(r.document.variables.get("x").map(|s| s.as_str()), Some("3"));
7650+ }
7651+}
crates/htmlang-core/src/std.hlnew file+9
@@ -0,0 +1,9 @@
1+-- The htmlang standard library, available in every file. It is ordinary
2+-- htmlang: a file's own @let with the same name takes precedence.
3+
4+-- Takes up the remaining space in a row or column.
5+@let @spacer
6+ @el [flex 1]
7+
8+-- Cut text off at one line with an ellipsis: [$truncate]
9+@let truncate [overflow hidden, text-overflow ellipsis, white-space nowrap]
crates/htmlang-core/src/syntax.rsnew file+2943
@@ -0,0 +1,2943 @@
1+//! The syntax tree: source text read into lines, element heads, attribute
2+//! lists and text, before anything is evaluated.
3+//!
4+//! The tree is lossless enough to print the file back: comments and blank
5+//! lines are nodes, every piece keeps its source [`Span`], and verbatim
6+//! bodies keep their text. It reads no files and substitutes no variables.
7+//! The evaluator (`parser.rs`), the formatter and the language server all
8+//! work on this one tree, and what a directive accepts comes from the
9+//! [`DIRECTIVES`](crate::ast::DIRECTIVES) table.
10+//!
11+//! The grammar, line by line:
12+//! - A line whose first word is `--` (a `--` followed by a space or the end
13+//! of the line) is a comment; an empty line is blank. `--gap 12px` is not
14+//! a comment: on a line of an attribute list it is a custom property.
15+//! - A line starting with `@NAME` is a directive when `NAME` is in the
16+//! directive table, and an element (or function call) otherwise. An
17+//! element line is a chain of heads `@name [attributes]` joined by `>`,
18+//! then text. A `[` opens an attribute list only right after a head's
19+//! name, or where a directive's grammar has one (`@page [..]`,
20+//! `@let name [..]`, `@let @name [..]`); anywhere else it is text.
21+//! - What a `@let` defines is decided here, from its line: `@let @name` is
22+//! a function (its body is the indented block), `@let name [..]` an
23+//! attribute bundle and any other `@let name ...` a value.
24+//! - Any other line is text, in which `{@name [attributes] text}` is an
25+//! inline element.
26+//! - An attribute list (or `@data`'s inline JSON) may continue onto the
27+//! following lines until it closes.
28+//! - Lines indented deeper than a line are its body. What the body may be
29+//! is the directive's or element's [`BodyKind`].
30+
31+use crate::ast::{self, ArgGrammar, BodyKind, DirectiveSpec};
32+use crate::diagnostic::{Diagnostic, Severity, code};
33+
34+/// A range of the source.
35+#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
36+pub struct Span {
37+ /// Byte offsets into the source.
38+ pub start: usize,
39+ pub end: usize,
40+ /// 1-based line and 0-based byte column of `start`.
41+ pub line: usize,
42+ pub column: usize,
43+}
44+
45+/// A parsed file.
46+#[derive(Clone, Debug)]
47+pub struct Tree {
48+ pub nodes: Vec<Node>,
49+ /// Syntax errors: they are reported for every line, whether or not it
50+ /// is ever evaluated.
51+ pub diagnostics: Vec<Diagnostic>,
52+ /// One past the largest node id.
53+ pub(crate) end_id: usize,
54+}
55+
56+/// One line of the file (with its continuation lines), and the lines
57+/// indented under it.
58+#[derive(Clone, Debug)]
59+pub struct Node {
60+ /// Unique within a parse, in source order.
61+ pub id: usize,
62+ /// Width of the leading whitespace of its first line, in bytes.
63+ pub indent: usize,
64+ /// The node's own line(s), without its children.
65+ pub span: Span,
66+ /// How many source lines `span` covers.
67+ pub line_count: usize,
68+ /// The node's own lines joined into one (continuation lines joined with
69+ /// a space), without surrounding whitespace.
70+ pub source: String,
71+ pub kind: NodeKind,
72+ /// The lines indented under it, trivia included.
73+ pub children: Vec<Node>,
74+}
75+
76+#[derive(Clone, Debug)]
77+pub enum NodeKind {
78+ /// An empty line.
79+ Blank,
80+ /// A `--` comment line; its text is the node's `source`.
81+ Comment,
82+ /// A line of text.
83+ Text(Text),
84+ /// `@name [attrs] > @name [attrs] text`: an element or a function call.
85+ Element(ElementLine),
86+ Directive(Directive),
87+ /// The body of a verbatim directive or element (`@style`, `@script`).
88+ Verbatim(Verbatim),
89+}
90+
91+/// Text: plain runs and inline elements.
92+#[derive(Clone, Debug)]
93+pub struct Text {
94+ pub raw: String,
95+ pub span: Span,
96+ pub segments: Vec<Segment>,
97+}
98+
99+#[derive(Clone, Debug)]
100+pub enum Segment {
101+ /// Text as written: escapes are still in it and `$name`s are not
102+ /// substituted.
103+ Plain { raw: String, span: Span },
104+ /// `{@name [attrs] text}`.
105+ Inline(Box<Inline>),
106+}
107+
108+#[derive(Clone, Debug)]
109+pub struct Inline {
110+ /// What is between the braces.
111+ pub raw: String,
112+ /// Including the braces.
113+ pub span: Span,
114+ pub head: Head,
115+ pub text: Option<Text>,
116+ /// Whether the closing `}` was found.
117+ pub closed: bool,
118+}
119+
120+/// `@name [attributes]`.
121+#[derive(Clone, Debug)]
122+pub struct Head {
123+ /// Without the `@`.
124+ pub name: String,
125+ /// Including the `@`.
126+ pub name_span: Span,
127+ pub attrs: Option<AttrList>,
128+ pub span: Span,
129+}
130+
131+/// `[attr, attr]`.
132+#[derive(Clone, Debug)]
133+pub struct AttrList {
134+ pub attrs: Vec<Attr>,
135+ /// Including the brackets.
136+ pub span: Span,
137+ /// Whether the closing `]` was found.
138+ pub closed: bool,
139+ /// The closing `]`, when it looks like it was meant to be inside a
140+ /// `'...'` string: a `'` before it in the list isn't closed, and the
141+ /// word right after it has one, as in `hx-on:click=alert(']')`.
142+ pub quoted_close: Option<Span>,
143+}
144+
145+/// One attribute of a list, as written.
146+#[derive(Clone, Debug)]
147+pub struct Attr {
148+ /// The attribute's text, trimmed.
149+ pub raw: String,
150+ pub key: String,
151+ pub value: Option<String>,
152+ /// Written `key=value`.
153+ pub html: bool,
154+ pub span: Span,
155+ /// The attribute is `if(CONDITION, A, B)` as a whole.
156+ pub choice: Option<Box<Choice>>,
157+ /// The attribute is prefixes applied to a `[group]`, a `$bundle` or an
158+ /// `if()`: `md:[padding 32, font-size 20]`, `dark:$card`. Its `key` is
159+ /// then the prefixes, and it has no value.
160+ pub prefixed: Option<Box<Prefixed>>,
161+}
162+
163+/// Prefixes applied to several attributes at once, which they distribute
164+/// over: `md:[padding 32, font-size 20]` is `md:padding 32, md:font-size 20`.
165+#[derive(Clone, Debug)]
166+pub struct Prefixed {
167+ /// The prefixes as written, each with its `:` (`md:hover:`).
168+ pub prefix: String,
169+ pub prefix_span: Span,
170+ /// What they apply to: a group, or one attribute that is a `$bundle`
171+ /// or an `if()`.
172+ pub target: Branch,
173+}
174+
175+/// A whole attribute `if(CONDITION, A, B)`: `A` or `B`, by the condition.
176+#[derive(Clone, Debug)]
177+pub struct Choice {
178+ /// The condition, an expression; `None` when it is empty.
179+ pub condition: Option<Arg>,
180+ /// The branches after the condition, as written: `A`, and `B` when
181+ /// there is one. Any other number is an error the evaluator reports.
182+ pub branches: Vec<Branch>,
183+}
184+
185+/// One branch of an [`if()`](Choice).
186+#[derive(Clone, Debug)]
187+pub enum Branch {
188+ /// Nothing: the attribute is left out.
189+ Empty,
190+ /// One attribute (or `$bundle`, or another `if()`).
191+ Attr(Attr),
192+ /// `[attr, attr]`: several attributes at once. `trailing` is text
193+ /// written after the `]`, an error.
194+ Group {
195+ list: AttrList,
196+ trailing: Option<Arg>,
197+ },
198+}
199+
200+impl Branch {
201+ /// The branch's attributes as written.
202+ pub fn attrs(&self) -> &[Attr] {
203+ match self {
204+ Branch::Empty => &[],
205+ Branch::Attr(attr) => std::slice::from_ref(attr),
206+ Branch::Group { list, .. } => &list.attrs,
207+ }
208+ }
209+}
210+
211+/// A directive's argument text, as written.
212+#[derive(Clone, Debug)]
213+pub struct Arg {
214+ pub raw: String,
215+ pub span: Span,
216+}
217+
218+#[derive(Clone, Debug)]
219+pub struct ElementLine {
220+ /// The heads joined by `>`; the last one gets the children.
221+ pub chain: Vec<Head>,
222+ /// Text after the last head.
223+ pub text: Option<Text>,
224+}
225+
226+#[derive(Clone, Debug)]
227+pub struct Directive {
228+ pub spec: &'static DirectiveSpec,
229+ /// Including the `@`.
230+ pub name_span: Span,
231+ pub args: DirectiveArgs,
232+}
233+
234+impl Directive {
235+ pub fn name(&self) -> &'static str {
236+ self.spec.name
237+ }
238+}
239+
240+/// A directive's arguments, read by its [`ArgGrammar`].
241+#[derive(Clone, Debug)]
242+pub enum DirectiveArgs {
243+ Text(Option<Arg>),
244+ Page {
245+ attrs: Option<AttrList>,
246+ title: Option<Arg>,
247+ },
248+ Let(LetDef),
249+ Condition(Arg),
250+ Else {
251+ condition: Option<Arg>,
252+ },
253+ Each(Loop),
254+ Data {
255+ name: String,
256+ name_span: Span,
257+ source: Arg,
258+ },
259+ /// The header has a syntax error, which is already reported.
260+ Invalid,
261+}
262+
263+/// `@let NAME ...` or `@let @NAME [params]`. Its kind is decided here,
264+/// from the line alone: an `@` before the name makes a function, a `[`
265+/// after it a bundle, anything else a value.
266+#[derive(Clone, Debug)]
267+pub struct LetDef {
268+ /// Without the function's `@`.
269+ pub name: String,
270+ /// Just the name, without the function's `@`.
271+ pub name_span: Span,
272+ pub form: LetForm,
273+}
274+
275+#[derive(Clone, Debug)]
276+pub enum LetForm {
277+ /// `@let name text`.
278+ Value(Arg),
279+ /// `@let name "text"`: the text between the quotes.
280+ Quoted(Arg),
281+ /// `@let name = EXPR`: the expression.
282+ Computed(Arg),
283+ /// `@let name [attrs]`.
284+ Bundle(AttrList),
285+ /// `@let @name [param, param default]` (or `@let @name`) with an
286+ /// indented body.
287+ Function(Function),
288+}
289+
290+/// A function's head: its parameter list as written, and the parameters
291+/// read from it.
292+#[derive(Clone, Debug, Default)]
293+pub struct Function {
294+ /// `[param, param default]`; `None` for `@let @name`.
295+ pub list: Option<AttrList>,
296+ pub params: Vec<Param>,
297+}
298+
299+/// One parameter: `title` (required) or `tone #f9fafb` (with a default).
300+/// The body uses it as `$title`.
301+#[derive(Clone, Debug)]
302+pub struct Param {
303+ pub name: String,
304+ /// The default as written, for `name value`.
305+ pub default: Option<String>,
306+ /// Just the name.
307+ pub name_span: Span,
308+ /// The whole parameter.
309+ pub span: Span,
310+}
311+
312+/// `@each $item, $index in LIST`.
313+#[derive(Clone, Debug)]
314+pub struct Loop {
315+ pub item: String,
316+ pub index: Option<String>,
317+ pub list: Arg,
318+}
319+
320+#[derive(Clone, Debug)]
321+pub struct Verbatim {
322+ /// The body's lines without their common indentation.
323+ pub text: String,
324+ /// Shown on the page as text, HTML-escaped: the body of `@code` and
325+ /// `@textarea`. Otherwise it goes into the page as it is (`@raw`,
326+ /// `@script`) or is read by its directive (`@style`, `@markdown`).
327+ pub escaped: bool,
328+}
329+
330+// ---------------------------------------------------------------------------
331+// Queries used by the evaluator and the tools
332+// ---------------------------------------------------------------------------
333+
334+impl Node {
335+ /// Blank lines and comments.
336+ pub fn is_trivia(&self) -> bool {
337+ matches!(self.kind, NodeKind::Blank | NodeKind::Comment)
338+ }
339+
340+ /// The directive on this line, if it is one.
341+ pub fn directive(&self) -> Option<&Directive> {
342+ match &self.kind {
343+ NodeKind::Directive(d) => Some(d),
344+ _ => None,
345+ }
346+ }
347+
348+ /// Whether this line is the directive `@name`.
349+ pub fn is_directive(&self, name: &str) -> bool {
350+ self.directive().is_some_and(|d| d.name() == name)
351+ }
352+
353+ /// Children other than blank lines and comments.
354+ pub fn body(&self) -> impl Iterator<Item = &Node> {
355+ self.children.iter().filter(|c| !c.is_trivia())
356+ }
357+
358+ /// The last source line of the node and its children.
359+ pub fn end_line(&self) -> usize {
360+ let own = self.span.line + self.source_lines() - 1;
361+ self.children
362+ .iter()
363+ .filter(|c| !matches!(c.kind, NodeKind::Blank))
364+ .map(Node::end_line)
365+ .fold(own, usize::max)
366+ }
367+
368+ fn source_lines(&self) -> usize {
369+ self.line_count.max(1)
370+ }
371+
372+ /// Visit this node and everything under it, in source order.
373+ pub fn walk<'a>(&'a self, f: &mut impl FnMut(&'a Node)) {
374+ f(self);
375+ for child in &self.children {
376+ child.walk(f);
377+ }
378+ }
379+
380+ /// The heads on this line: an element's chain, and the inline
381+ /// elements in its text.
382+ pub fn heads(&self) -> Vec<&Head> {
383+ let mut heads = Vec::new();
384+ match &self.kind {
385+ NodeKind::Element(line) => {
386+ heads.extend(line.chain.iter());
387+ if let Some(text) = &line.text {
388+ text.inline_heads(&mut heads);
389+ }
390+ }
391+ NodeKind::Text(text) => text.inline_heads(&mut heads),
392+ _ => {}
393+ }
394+ heads
395+ }
396+}
397+
398+impl Text {
399+ fn inline_heads<'a>(&'a self, out: &mut Vec<&'a Head>) {
400+ for segment in &self.segments {
401+ if let Segment::Inline(inline) = segment {
402+ out.push(&inline.head);
403+ if let Some(text) = &inline.text {
404+ text.inline_heads(out);
405+ }
406+ }
407+ }
408+ }
409+
410+ /// Split off the leading argument, the first token, with the rest as
411+ /// text: `/about` and `About us` in `@link /about About us`. The token
412+ /// ends at a space outside `"..."` and `${...}`, so neither is split,
413+ /// and it is taken before any `$name` is filled in.
414+ pub fn split_leading(&self) -> (Arg, Option<Text>) {
415+ let end = leading_token_len(&self.raw);
416+ let shifted = Shifted { base: self.span };
417+ let token = Arg {
418+ raw: self.raw[..end].to_string(),
419+ span: shifted.span(0, end),
420+ };
421+ let rest_start = self.raw.len() - self.raw[end..].trim_start().len();
422+ if rest_start >= self.raw.len() {
423+ return (token, None);
424+ }
425+ let reader = Reader {
426+ text: &self.raw,
427+ spans: &shifted,
428+ };
429+ (token, Some(reader.text(rest_start, self.raw.len()).0))
430+ }
431+}
432+
433+/// The length of the first token of `s`: up to the first whitespace that
434+/// isn't inside `"..."` or `${...}` and isn't escaped.
435+pub fn leading_token_len(s: &str) -> usize {
436+ let mut i = 0;
437+ while i < s.len() {
438+ let rest = &s[i..];
439+ let escape = escape_len(rest);
440+ if escape > 0 {
441+ i += escape;
442+ continue;
443+ }
444+ if rest.starts_with('"') {
445+ // To the closing quote, or the end of the text
446+ let mut j = 1;
447+ while j < rest.len() && !rest[j..].starts_with('"') {
448+ j += match escape_len(&rest[j..]) {
449+ 0 => rest[j..].chars().next().map_or(1, char::len_utf8),
450+ n => n,
451+ };
452+ }
453+ i += (j + 1).min(rest.len());
454+ continue;
455+ }
456+ if rest.starts_with("${")
457+ && let Some(close) = crate::interp::matching_brace(&rest[1..])
458+ {
459+ i += close + 2;
460+ continue;
461+ }
462+ let c = rest.chars().next().unwrap_or(' ');
463+ if c.is_whitespace() {
464+ break;
465+ }
466+ i += c.len_utf8();
467+ }
468+ i
469+}
470+
471+impl Tree {
472+ /// Whether the file holds only definitions: at its top level, `@let`s
473+ /// (at least one), comments and blank lines. Such a file is a library,
474+ /// such as a layout, whose definitions are for the files that
475+ /// `@include` it: it isn't built into a page of its own, and its
476+ /// definitions aren't reported unused.
477+ pub fn is_library(&self) -> bool {
478+ self.is_library_with(&mut |_| false)
479+ }
480+
481+ /// Whether the file is a library (see [`Tree::is_library`]), which may
482+ /// also read data (`@data`) and include other libraries: `library`
483+ /// says whether the file an `@include` names, as written, is one.
484+ pub fn is_library_with(&self, library: &mut dyn FnMut(&str) -> bool) -> bool {
485+ let mut lets = 0;
486+ for node in &self.nodes {
487+ match &node.kind {
488+ NodeKind::Blank | NodeKind::Comment => {}
489+ _ if node.is_directive("let") => lets += 1,
490+ _ if node.is_directive("data") => {}
491+ NodeKind::Directive(Directive {
492+ args: DirectiveArgs::Text(Some(path)),
493+ ..
494+ }) if node.is_directive("include") && library(path.raw.trim_matches('"')) => {}
495+ _ => return false,
496+ }
497+ }
498+ lets > 0
499+ }
500+
501+ /// Visit every node, in source order.
502+ pub fn walk<'a>(&'a self, f: &mut impl FnMut(&'a Node)) {
503+ for node in &self.nodes {
504+ node.walk(f);
505+ }
506+ }
507+
508+ /// Every `@let` in the file, wherever it is.
509+ pub fn definitions(&self) -> Vec<Definition<'_>> {
510+ let mut out = Vec::new();
511+ self.walk(&mut |node| {
512+ let Some(Directive {
513+ args: DirectiveArgs::Let(def),
514+ ..
515+ }) = node.directive()
516+ else {
517+ return;
518+ };
519+ let (kind, params, value): (_, &[Param], _) = match &def.form {
520+ LetForm::Value(value) => (DefinitionKind::Value, &[], Some(value.raw.clone())),
521+ LetForm::Quoted(value) => (
522+ DefinitionKind::Value,
523+ &[],
524+ Some(format!("\"{}\"", value.raw)),
525+ ),
526+ LetForm::Computed(expr) => {
527+ (DefinitionKind::Value, &[], Some(format!("= {}", expr.raw)))
528+ }
529+ LetForm::Bundle(attrs) => (
530+ DefinitionKind::Bundle,
531+ &[],
532+ Some(
533+ attrs
534+ .attrs
535+ .iter()
536+ .map(|a| a.raw.as_str())
537+ .collect::<Vec<_>>()
538+ .join(", "),
539+ ),
540+ ),
541+ LetForm::Function(function) => {
542+ (DefinitionKind::Function, function.params.as_slice(), None)
543+ }
544+ };
545+ out.push(Definition {
546+ name: &def.name,
547+ name_span: def.name_span,
548+ kind,
549+ params,
550+ value,
551+ node,
552+ });
553+ });
554+ out
555+ }
556+
557+ /// The names visible at `line` (1-based), by the lexical rule the
558+ /// compiler follows: a definition (`@let`, `@data`) is visible from the
559+ /// line after it to the end of its block; an `@each` line's variables
560+ /// in its body; a function's parameters (and the function itself) in
561+ /// its body, which also sees what is visible where the function is
562+ /// defined. In the order they are defined, so a later one with the same
563+ /// name hides an earlier one.
564+ pub fn visible_at(&self, line: usize) -> Vec<Visible<'_>> {
565+ let mut out = Vec::new();
566+ visible_in(&self.nodes, line, &mut out);
567+ out
568+ }
569+
570+ /// The innermost node whose own lines include `line` (1-based).
571+ pub fn node_at_line(&self, line: usize) -> Option<&Node> {
572+ let mut found = None;
573+ self.walk(&mut |node| {
574+ let last = node.span.line + node.source_lines() - 1;
575+ if (node.span.line..=last).contains(&line) && !matches!(node.kind, NodeKind::Blank) {
576+ found = Some(node);
577+ }
578+ });
579+ found
580+ }
581+}
582+
583+/// What a `@let` defines.
584+#[derive(Clone, Copy, Debug, PartialEq, Eq)]
585+pub enum DefinitionKind {
586+ /// A value (`@let x 1`, `@let x = 1 + 1`, `@let x "text"`), used as `$x`.
587+ Value,
588+ /// An attribute bundle (`@let x [...]`), used as `[$x]`.
589+ Bundle,
590+ /// A function (`@let @x [a]` with a body), called as `@x`.
591+ Function,
592+}
593+
594+/// A `@let`, for tools.
595+#[derive(Clone, Debug)]
596+pub struct Definition<'a> {
597+ pub name: &'a str,
598+ pub name_span: Span,
599+ pub kind: DefinitionKind,
600+ pub params: &'a [Param],
601+ /// The value as written, for a value or a bundle.
602+ pub value: Option<String>,
603+ /// The `@let` line, with the function's body as its children.
604+ pub node: &'a Node,
605+}
606+
607+/// A name visible at a line (see [`Tree::visible_at`]).
608+#[derive(Clone, Debug)]
609+pub struct Visible<'a> {
610+ pub name: &'a str,
611+ pub kind: VisibleKind,
612+ /// Where the name is written in its definition (for a loop variable,
613+ /// the `@each` line).
614+ pub span: Span,
615+}
616+
617+/// What defines a visible name.
618+#[derive(Clone, Copy, Debug, PartialEq, Eq)]
619+pub enum VisibleKind {
620+ /// A `@let`, of this kind.
621+ Let(DefinitionKind),
622+ /// A function's parameter, in its body.
623+ Parameter,
624+ /// An `@each` variable, in its body.
625+ Loop,
626+ /// `@data $name`.
627+ Data,
628+}
629+
630+fn visible_in<'a>(block: &'a [Node], line: usize, out: &mut Vec<Visible<'a>>) {
631+ for node in block {
632+ if node.span.line >= line {
633+ break;
634+ }
635+ let inside = line <= node.end_line();
636+ match node.directive().map(|d| &d.args) {
637+ Some(DirectiveArgs::Let(def)) => {
638+ let kind = match &def.form {
639+ LetForm::Function(_) => DefinitionKind::Function,
640+ LetForm::Bundle(_) => DefinitionKind::Bundle,
641+ _ => DefinitionKind::Value,
642+ };
643+ // `@let t.greeting` gives the record `t` a field; `@let
644+ // --brand` is a custom property, read with `var(--brand)`
645+ let name = def.name.split('.').next().unwrap_or(&def.name);
646+ if !name.starts_with("--") {
647+ out.push(Visible {
648+ name,
649+ kind: VisibleKind::Let(kind),
650+ span: def.name_span,
651+ });
652+ }
653+ if let (true, LetForm::Function(function)) = (inside, &def.form) {
654+ out.extend(function.params.iter().map(|p| Visible {
655+ name: &p.name,
656+ kind: VisibleKind::Parameter,
657+ span: p.name_span,
658+ }));
659+ }
660+ }
661+ Some(DirectiveArgs::Data {
662+ name, name_span, ..
663+ }) => out.push(Visible {
664+ name,
665+ kind: VisibleKind::Data,
666+ span: *name_span,
667+ }),
668+ Some(DirectiveArgs::Each(each)) if inside => {
669+ for name in std::iter::once(&each.item).chain(&each.index) {
670+ out.push(Visible {
671+ name,
672+ kind: VisibleKind::Loop,
673+ span: node.span,
674+ });
675+ }
676+ }
677+ _ => {}
678+ }
679+ if inside {
680+ visible_in(&node.children, line, out);
681+ return;
682+ }
683+ }
684+}
685+
686+// ---------------------------------------------------------------------------
687+// Parsing
688+// ---------------------------------------------------------------------------
689+
690+/// Whether a line (without its indentation) is a comment: its first word
691+/// is `--`, so `-- note` and a bare `--` are comments, while `--gap 12px`
692+/// (a custom property on a line of an attribute list) and `---` are not.
693+pub fn is_comment(trimmed: &str) -> bool {
694+ trimmed
695+ .strip_prefix("--")
696+ .is_some_and(|rest| rest.is_empty() || rest.starts_with(char::is_whitespace))
697+}
698+
699+/// Parse source text into a syntax tree.
700+pub fn parse(source: &str) -> Tree {
701+ parse_from(source, 0)
702+}
703+
704+/// Parse, numbering the nodes from `first_id`.
705+pub(crate) fn parse_from(source: &str, first_id: usize) -> Tree {
706+ let lines = physical_lines(source);
707+ let index = LineIndex {
708+ starts: lines.iter().map(|l| l.0).collect(),
709+ };
710+ let mut diagnostics = Vec::new();
711+ let mut indents = Vec::new();
712+ let entries = scan(&lines, &index, &mut diagnostics, &mut indents);
713+ mixed_indentation(&lines, &indents, &mut diagnostics);
714+ let mut next_id = first_id;
715+ let mut pos = 0;
716+ let mut nodes = build(entries, &mut pos, None, &mut next_id);
717+ literal_text(&mut nodes, false);
718+ check(&mut nodes, &mut diagnostics);
719+ diagnostics.sort_by_key(|d| d.line);
720+ Tree {
721+ nodes,
722+ diagnostics,
723+ end_id: next_id,
724+ }
725+}
726+
727+/// The source's lines with their byte offsets, like `str::lines`.
728+fn physical_lines(source: &str) -> Vec<(usize, &str)> {
729+ let mut lines = Vec::new();
730+ let mut start = 0;
731+ for piece in source.split('\n') {
732+ lines.push((start, piece.strip_suffix('\r').unwrap_or(piece)));
733+ start += piece.len() + 1;
734+ }
735+ if source.is_empty() || source.ends_with('\n') {
736+ lines.pop();
737+ }
738+ lines
739+}
740+
741+struct LineIndex {
742+ starts: Vec<usize>,
743+}
744+
745+impl LineIndex {
746+ fn span(&self, start: usize, end: usize) -> Span {
747+ let line = self.starts.partition_point(|&s| s <= start).max(1);
748+ Span {
749+ start,
750+ end,
751+ line,
752+ column: start - self.starts.get(line - 1).copied().unwrap_or(0),
753+ }
754+ }
755+}
756+
757+/// A tab counts as one column, like a space, so indentation that mixes
758+/// them nests lines in ways the eye doesn't see: the first line whose
759+/// indentation mixes them, or uses the other one than the lines before
760+/// it, is reported. `indents` holds, for each line whose indentation
761+/// places it, its index and how many of its leading bytes do: a verbatim
762+/// body's own indentation after the body's is its content (a tab in a
763+/// `@code` sample), and so is a continuation line's.
764+fn mixed_indentation(
765+ lines: &[(usize, &str)],
766+ indents: &[(usize, usize)],
767+ diagnostics: &mut Vec<Diagnostic>,
768+) {
769+ let mut first: Option<char> = None;
770+ for &(number, width) in indents {
771+ let Some((_, line)) = lines.get(number) else {
772+ continue;
773+ };
774+ let indent = line.get(..width).unwrap_or("");
775+ let (tabs, spaces) = (indent.contains('\t'), indent.contains(' '));
776+ let used = match (tabs, spaces) {
777+ (false, false) => continue,
778+ (true, true) => None,
779+ (true, false) => Some('\t'),
780+ (false, true) => Some(' '),
781+ };
782+ if used.is_some() && (first.is_none() || first == used) {
783+ first = used;
784+ continue;
785+ }
786+ diagnostics.push(
787+ Diagnostic::warning(
788+ code::MIXED_INDENTATION,
789+ number + 1,
790+ "this line's indentation mixes tabs and spaces with the lines before it: a \
791+ tab counts as one space, so the nesting may not be what it looks like. \
792+ Indent with one of them"
793+ .to_string(),
794+ )
795+ .source(line.to_string()),
796+ );
797+ return;
798+ }
799+}
800+
801+fn leading_whitespace(line: &str) -> usize {
802+ line.len() - line.trim_start().len()
803+}
804+
805+/// A node before the tree is built: one logical line.
806+struct Entry {
807+ indent: usize,
808+ span: Span,
809+ span_lines: usize,
810+ source: String,
811+ kind: NodeKind,
812+}
813+
814+/// Read the lines into entries: comments, blank lines, headers (with their
815+/// continuation lines joined) and verbatim bodies.
816+fn scan(
817+ lines: &[(usize, &str)],
818+ index: &LineIndex,
819+ diagnostics: &mut Vec<Diagnostic>,
820+ indents: &mut Vec<(usize, usize)>,
821+) -> Vec<Entry> {
822+ let mut entries: Vec<Entry> = Vec::new();
823+ let mut i = 0;
824+ while i < lines.len() {
825+ let (start, line) = lines[i];
826+ let trimmed = line.trim();
827+ let indent = leading_whitespace(line);
828+ let begin = start + indent;
829+ if trimmed.is_empty() {
830+ entries.push(Entry {
831+ // Resolved below, from the next line
832+ indent: 0,
833+ span: index.span(start, start + line.len()),
834+ span_lines: 1,
835+ source: String::new(),
836+ kind: NodeKind::Blank,
837+ });
838+ i += 1;
839+ continue;
840+ }
841+ indents.push((i, indent));
842+ if is_comment(trimmed) {
843+ entries.push(Entry {
844+ indent,
845+ span: index.span(begin, begin + trimmed.len()),
846+ span_lines: 1,
847+ source: trimmed.to_string(),
848+ kind: NodeKind::Comment,
849+ });
850+ i += 1;
851+ continue;
852+ }
853+
854+ // A header, joined with its continuation lines while an attribute
855+ // list (or inline JSON) is open. Blank lines and comments inside it
856+ // are skipped.
857+ let mut logical = Logical::default();
858+ logical.push(trimmed, begin);
859+ let (mut kind, mut open, mut problems) = logical.header(index);
860+ let mut last = i;
861+ while open && last + 1 < lines.len() {
862+ last += 1;
863+ let (next_start, next) = lines[last];
864+ let t = next.trim();
865+ if t.is_empty() || is_comment(t) {
866+ continue;
867+ }
868+ logical.push(t, next_start + leading_whitespace(next));
869+ (kind, open, problems) = logical.header(index);
870+ }
871+ diagnostics.extend(problems);
872+ let end = lines[last].0 + lines[last].1.len();
873+ // What the lines under it are is decided by the directive, or by
874+ // the last element of a chain (`@pre > @code`)
875+ let (body, escaped) = match &kind {
876+ NodeKind::Directive(d) => (d.spec.body, false),
877+ NodeKind::Element(line) => line.chain.last().map_or((BodyKind::Htmlang, false), |h| {
878+ (ast::body_kind(&h.name), ast::has_literal_text(&h.name))
879+ }),
880+ _ => (BodyKind::Htmlang, false),
881+ };
882+ entries.push(Entry {
883+ indent,
884+ span: index.span(begin, end),
885+ span_lines: last - i + 1,
886+ source: logical.text.clone(),
887+ kind,
888+ });
889+ i = last + 1;
890+
891+ // A verbatim body: every following line indented deeper (or blank),
892+ // up to the last such non-blank line.
893+ if body == BodyKind::Verbatim {
894+ let mut body_end = i;
895+ let mut k = i;
896+ while k < lines.len() {
897+ let l = lines[k].1;
898+ k += 1;
899+ if l.trim().is_empty() {
900+ continue;
901+ }
902+ if leading_whitespace(l) <= indent {
903+ break;
904+ }
905+ body_end = k;
906+ }
907+ if body_end > i {
908+ let body = &lines[i..body_end];
909+ let common = body
910+ .iter()
911+ .filter(|(_, l)| !l.trim().is_empty())
912+ .map(|(_, l)| leading_whitespace(l))
913+ .min()
914+ .unwrap_or(0);
915+ indents.extend(
916+ (i..body_end)
917+ .filter(|&k| !lines[k].1.trim().is_empty())
918+ .map(|k| (k, common)),
919+ );
920+ let text: Vec<&str> = body
921+ .iter()
922+ .map(|(_, l)| l.get(common..).unwrap_or("").trim_end())
923+ .collect();
924+ let (last_start, last_line) = lines[body_end - 1];
925+ entries.push(Entry {
926+ indent: indent + 1,
927+ span: index.span(lines[i].0, last_start + last_line.len()),
928+ span_lines: body_end - i,
929+ source: String::new(),
930+ kind: NodeKind::Verbatim(Verbatim {
931+ text: text.join("\n"),
932+ escaped,
933+ }),
934+ });
935+ i = body_end;
936+ }
937+ }
938+ }
939+
940+ // A blank line belongs where the next line does.
941+ let mut next_indent = 0;
942+ for entry in entries.iter_mut().rev() {
943+ if matches!(entry.kind, NodeKind::Blank) {
944+ entry.indent = next_indent;
945+ } else {
946+ next_indent = entry.indent;
947+ }
948+ }
949+ entries
950+}
951+
952+/// Build the nodes for the entries from `pos` indented deeper than `parent`.
953+fn build(
954+ entries: Vec<Entry>,
955+ pos: &mut usize,
956+ parent: Option<usize>,
957+ next_id: &mut usize,
958+) -> Vec<Node> {
959+ // Entries are taken out of the vector one by one, in order.
960+ let mut entries: Vec<Option<Entry>> = entries.into_iter().map(Some).collect();
961+ build_from(&mut entries, pos, parent, next_id)
962+}
963+
964+fn build_from(
965+ entries: &mut [Option<Entry>],
966+ pos: &mut usize,
967+ parent: Option<usize>,
968+ next_id: &mut usize,
969+) -> Vec<Node> {
970+ let mut nodes = Vec::new();
971+ while let Some(Some(entry)) = entries.get(*pos) {
972+ if parent.is_some_and(|p| entry.indent <= p) {
973+ break;
974+ }
975+ let Some(entry) = entries[*pos].take() else {
976+ break;
977+ };
978+ *pos += 1;
979+ let id = *next_id;
980+ *next_id += 1;
981+ let takes_children = !matches!(
982+ entry.kind,
983+ NodeKind::Blank | NodeKind::Comment | NodeKind::Verbatim(_)
984+ );
985+ let children = if takes_children {
986+ build_from(entries, pos, Some(entry.indent), next_id)
987+ } else {
988+ Vec::new()
989+ };
990+ nodes.push(Node {
991+ id,
992+ indent: entry.indent,
993+ span: entry.span,
994+ line_count: entry.span_lines,
995+ source: entry.source,
996+ kind: entry.kind,
997+ children,
998+ });
999+ }
1000+ nodes
1001+}
1002+
1003+/// Make the text of `@code` and `@textarea` literal, on their line, inline
1004+/// (`{@code {@link /x y}}`) and in the lines under a chain they are in the
1005+/// middle of (`@code > @b`): a `{@...}` in it is text. (The lines under
1006+/// `@code` itself are a verbatim body, see `scan`.) `inside` says that
1007+/// `nodes` are in such an element.
1008+fn literal_text(nodes: &mut [Node], inside: bool) {
1009+ for node in nodes {
1010+ let mut literal = inside;
1011+ match &mut node.kind {
1012+ NodeKind::Text(text) => text.literal_where_asked(inside),
1013+ NodeKind::Element(line) => {
1014+ literal |= line
1015+ .chain
1016+ .iter()
1017+ .any(|head| ast::has_literal_text(&head.name));
1018+ if let Some(text) = &mut line.text {
1019+ text.literal_where_asked(literal);
1020+ }
1021+ }
1022+ _ => {}
1023+ }
1024+ literal_text(&mut node.children, literal);
1025+ }
1026+}
1027+
1028+impl Text {
1029+ /// Make the whole text literal when `literal`, and otherwise the text
1030+ /// of the inline elements in it that show their text as written.
1031+ fn literal_where_asked(&mut self, literal: bool) {
1032+ if literal {
1033+ self.segments = match self.raw.is_empty() {
1034+ true => Vec::new(),
1035+ false => vec![Segment::Plain {
1036+ raw: self.raw.clone(),
1037+ span: self.span,
1038+ }],
1039+ };
1040+ return;
1041+ }
1042+ for segment in &mut self.segments {
1043+ if let Segment::Inline(inline) = segment
1044+ && let Some(text) = &mut inline.text
1045+ {
1046+ text.literal_where_asked(ast::has_literal_text(&inline.head.name));
1047+ }
1048+ }
1049+ }
1050+}
1051+
1052+/// Checks on the built tree: what each line's body may be, and `@else`
1053+/// placement.
1054+fn check(nodes: &mut [Node], diagnostics: &mut Vec<Diagnostic>) {
1055+ #[derive(PartialEq)]
1056+ enum Opener {
1057+ If,
1058+ Each,
1059+ }
1060+ let mut opener = None;
1061+ for node in nodes.iter_mut() {
1062+ if node.is_trivia() {
1063+ continue;
1064+ }
1065+ let line = node.span.line;
1066+ match node.directive().map(|d| (d.name(), &d.args)) {
1067+ Some(("if", _)) => opener = Some(Opener::If),
1068+ Some(("each", _)) => opener = Some(Opener::Each),
1069+ Some(("else", args)) => {
1070+ let else_if = matches!(args, DirectiveArgs::Else { condition: Some(_) });
1071+ opener = match opener {
1072+ Some(Opener::If) if else_if => Some(Opener::If),
1073+ Some(Opener::If) | Some(Opener::Each) if !else_if => None,
1074+ _ => {
1075+ diagnostics.push(
1076+ Diagnostic::error(
1077+ code::STRAY_ELSE,
1078+ line,
1079+ "@else without matching @if".to_string(),
1080+ )
1081+ .source(node.source.clone()),
1082+ );
1083+ None
1084+ }
1085+ };
1086+ }
1087+ _ => opener = None,
1088+ }
1089+ check_body(node, diagnostics);
1090+ check(&mut node.children, diagnostics);
1091+ }
1092+}
1093+
1094+/// Whether the lines indented under `node` fit what it takes.
1095+fn check_body(node: &mut Node, diagnostics: &mut Vec<Diagnostic>) {
1096+ let first_child = node.body().next().map(|c| (c.span.line, c.source.clone()));
1097+ let has_verbatim = node
1098+ .children
1099+ .iter()
1100+ .any(|c| matches!(c.kind, NodeKind::Verbatim(_)));
1101+ let (line, source) = (node.span.line, node.source.clone());
1102+ // `@code` and `@textarea` (also at the end of a chain) take their text
1103+ // on their line or as a verbatim block, like a verbatim directive
1104+ if let NodeKind::Element(element) = &node.kind
1105+ && element.text.is_some()
1106+ && has_verbatim
1107+ && let Some(head) = element.chain.last()
1108+ && ast::has_literal_text(&head.name)
1109+ {
1110+ diagnostics.push(
1111+ Diagnostic::error(
1112+ code::UNEXPECTED_BODY,
1113+ line,
1114+ format!(
1115+ "@{} takes its text either on its own line or in an indented block, not both",
1116+ head.name
1117+ ),
1118+ )
1119+ .source(source.clone()),
1120+ );
1121+ }
1122+ let NodeKind::Directive(directive) = &mut node.kind else {
1123+ return;
1124+ };
1125+ let name = directive.spec.name;
1126+ let mut report = |code, (line, source): (usize, String), message: String| {
1127+ diagnostics.push(Diagnostic::error(code, line, message).source(source))
1128+ };
1129+ let mut problem = |at, message| report(code::UNEXPECTED_BODY, at, message);
1130+ match (&mut directive.args, directive.spec.body) {
1131+ // Only a function takes a body, and it needs one
1132+ (DirectiveArgs::Let(def), _) => {
1133+ let what = match &def.form {
1134+ LetForm::Function(_) => {
1135+ if first_child.is_none() {
1136+ report(
1137+ code::INVALID_DEFINITION,
1138+ (line, source),
1139+ format!(
1140+ "`@let @{}` needs an indented body: the lines the function \
1141+ produces",
1142+ def.name
1143+ ),
1144+ );
1145+ }
1146+ return;
1147+ }
1148+ LetForm::Bundle(_) => "an attribute bundle",
1149+ _ => "a value",
1150+ };
1151+ if let Some(child) = first_child {
1152+ let message = if def.name.starts_with("--") {
1153+ format!(
1154+ "`@let {}` declares a custom property, which takes no indented block",
1155+ def.name
1156+ )
1157+ } else {
1158+ format!(
1159+ "`@let {}` defines {}, which takes no indented block \
1160+ (a function is `@let @{} [param]` with a body)",
1161+ def.name, what, def.name
1162+ )
1163+ };
1164+ problem(child, message);
1165+ }
1166+ }
1167+ (_, BodyKind::None) => {
1168+ if let Some(child) = first_child {
1169+ problem(
1170+ child,
1171+ format!(
1172+ "@{} takes no indented block: this line isn't part of it, so unindent it",
1173+ name
1174+ ),
1175+ );
1176+ }
1177+ }
1178+ (DirectiveArgs::Text(Some(_)), BodyKind::Verbatim) if has_verbatim => problem(
1179+ (line, source),
1180+ match name {
1181+ "markdown" => "@markdown reads either a file named on its line or the Markdown \
1182+ in its indented block, not both"
1183+ .to_string(),
1184+ _ => format!(
1185+ "@{} takes its content either on its own line or in an indented block, not both",
1186+ name
1187+ ),
1188+ },
1189+ ),
1190+ _ => {}
1191+ }
1192+}
1193+
1194+/// The parameters in a function's list, `[title, tone #f9fafb]`: read
1195+/// like a call's attributes, a bare word is a required parameter and
1196+/// `name value` one with a default.
1197+fn params(list: &AttrList, source: &str, problems: &mut Vec<Diagnostic>) -> Vec<Param> {
1198+ let mut out: Vec<Param> = Vec::new();
1199+ for attr in &list.attrs {
1200+ let problem = |message: String| {
1201+ let diagnostic = Diagnostic::error(code::INVALID_DEFINITION, attr.span.line, message)
1202+ .source(source)
1203+ .subject(attr.raw.clone());
1204+ // The column, where the line shown is the parameter's own
1205+ match attr.span.line == list.span.line {
1206+ true => diagnostic.column(attr.span.column),
1207+ false => diagnostic,
1208+ }
1209+ };
1210+ let name = attr.key.strip_prefix('$').unwrap_or(&attr.key);
1211+ if attr.key.starts_with('$') {
1212+ problems.push(
1213+ problem(format!(
1214+ "a parameter is named without `$`: `{}`, used as `${}` in the body",
1215+ name, name
1216+ ))
1217+ .subject(attr.key.clone())
1218+ .suggest(Some(name)),
1219+ );
1220+ } else if attr.html {
1221+ problems.push(problem(format!(
1222+ "a parameter's default is written `{} VALUE`, without `=`",
1223+ name
1224+ )));
1225+ } else if crate::interp::name_len(name) != name.len() || name.starts_with("--") {
1226+ problems.push(problem(format!(
1227+ "'{}' is not a parameter name: a parameter is a name, or a name and its \
1228+ default (`tone #f9fafb`)",
1229+ attr.raw
1230+ )));
1231+ continue;
1232+ }
1233+ if out.iter().any(|p| p.name == name) {
1234+ problems.push(problem(format!("parameter '{}' is declared twice", name)));
1235+ continue;
1236+ }
1237+ let skip = attr.key.len() - name.len();
1238+ out.push(Param {
1239+ name: name.to_string(),
1240+ default: attr.value.clone(),
1241+ name_span: Span {
1242+ start: attr.span.start + skip,
1243+ end: attr.span.start + attr.key.len(),
1244+ line: attr.span.line,
1245+ column: attr.span.column + skip,
1246+ },
1247+ span: attr.span,
1248+ });
1249+ }
1250+ // A default is filled in when the function is called, with the
1251+ // parameters before it already bound: a later one isn't there yet.
1252+ for (i, param) in out.iter().enumerate() {
1253+ let Some(default) = &param.default else {
1254+ continue;
1255+ };
1256+ for later in &out[i + 1..] {
1257+ if crate::interp::names(default).contains(&later.name.as_str()) {
1258+ let diagnostic = Diagnostic::error(
1259+ code::INVALID_DEFINITION,
1260+ param.span.line,
1261+ format!(
1262+ "the default of '{}' uses `${}`, a parameter declared after it: \
1263+ a default can use only the parameters before it, so declare '{}' \
1264+ first",
1265+ param.name, later.name, later.name
1266+ ),
1267+ )
1268+ .source(source)
1269+ .subject(later.name.clone());
1270+ problems.push(match param.span.line == list.span.line {
1271+ true => diagnostic.column(param.span.column),
1272+ false => diagnostic,
1273+ });
1274+ }
1275+ }
1276+ }
1277+ out
1278+}
1279+
1280+// ---------------------------------------------------------------------------
1281+// Reading one logical line
1282+// ---------------------------------------------------------------------------
1283+
1284+/// Maps positions in a text to source spans.
1285+trait Spans {
1286+ fn span(&self, start: usize, end: usize) -> Span;
1287+}
1288+
1289+/// One logical line: physical lines joined with a space, and where each
1290+/// piece came from.
1291+#[derive(Default)]
1292+struct Logical {
1293+ text: String,
1294+ /// (offset in `text`, offset in the source, length)
1295+ pieces: Vec<(usize, usize, usize)>,
1296+}
1297+
1298+impl Logical {
1299+ fn push(&mut self, piece: &str, source_offset: usize) {
1300+ if !self.text.is_empty() {
1301+ self.text.push(' ');
1302+ }
1303+ self.pieces
1304+ .push((self.text.len(), source_offset, piece.len()));
1305+ self.text.push_str(piece);
1306+ }
1307+
1308+ fn source_offset(&self, pos: usize) -> usize {
1309+ let i = self.pieces.partition_point(|p| p.0 <= pos).max(1) - 1;
1310+ let (at, source, len) = self.pieces[i];
1311+ source + (pos - at).min(len)
1312+ }
1313+
1314+ /// Parse the line: its kind, whether an attribute list (or inline JSON)
1315+ /// is still open at its end, and its syntax errors.
1316+ fn header(&self, index: &LineIndex) -> (NodeKind, bool, Vec<Diagnostic>) {
1317+ let spans = LogicalSpans {
1318+ logical: self,
1319+ index,
1320+ };
1321+ let reader = Reader {
1322+ text: &self.text,
1323+ spans: &spans,
1324+ };
1325+ reader.line()
1326+ }
1327+}
1328+
1329+struct LogicalSpans<'a> {
1330+ logical: &'a Logical,
1331+ index: &'a LineIndex,
1332+}
1333+
1334+impl Spans for LogicalSpans<'_> {
1335+ fn span(&self, start: usize, end: usize) -> Span {
1336+ let start_src = self.logical.source_offset(start);
1337+ let end_src = self.logical.source_offset(end).max(start_src);
1338+ self.index.span(start_src, end_src)
1339+ }
1340+}
1341+
1342+/// Spans of a single-line text that starts at `base`.
1343+struct Shifted {
1344+ base: Span,
1345+}
1346+
1347+impl Spans for Shifted {
1348+ fn span(&self, start: usize, end: usize) -> Span {
1349+ Span {
1350+ start: self.base.start + start,
1351+ end: self.base.start + end,
1352+ line: self.base.line,
1353+ column: self.base.column + start,
1354+ }
1355+ }
1356+}
1357+
1358+/// The grammar of one logical line.
1359+struct Reader<'a> {
1360+ text: &'a str,
1361+ spans: &'a dyn Spans,
1362+}
1363+
1364+/// The escapes, the same in every htmlang string (text, arguments,
1365+/// attribute values, `@let`, `@page`, `@meta`): the character(s) after the
1366+/// backslash stand for themselves. A backslash before anything else is
1367+/// kept as written, so CSS's `\201C` and a pattern's `\d` pass through.
1368+pub const ESCAPES: &[&str] = &[
1369+ "\\\\", "\\$", "\\@", "\\{", "\\}", "\\[", "\\]", "\\,", "\\\"", "\\--",
1370+];
1371+
1372+/// The length of the escape `s` starts with, or 0.
1373+pub fn escape_len(s: &str) -> usize {
1374+ if !s.starts_with('\\') {
1375+ return 0;
1376+ }
1377+ ESCAPES
1378+ .iter()
1379+ .find(|escape| s.starts_with(**escape))
1380+ .map_or(0, |escape| escape.len())
1381+}
1382+
1383+/// `s` with its escapes replaced by what they stand for.
1384+pub fn unescape(s: &str) -> String {
1385+ let mut out = String::with_capacity(s.len());
1386+ let mut i = 0;
1387+ while let Some(found) = s[i..].find('\\') {
1388+ let at = i + found;
1389+ out.push_str(&s[i..at]);
1390+ let len = escape_len(&s[at..]);
1391+ if len == 0 {
1392+ out.push('\\');
1393+ i = at + 1;
1394+ } else {
1395+ out.push_str(&s[at + 1..at + len]);
1396+ i = at + len;
1397+ }
1398+ }
1399+ out.push_str(&s[i..]);
1400+ out
1401+}
1402+
1403+/// The parts of `text` between the commas that aren't escaped (`\,`) or
1404+/// inside `(...)`, `[...]`, `{...}` (so `${...}` too) or `"..."`: the items
1405+/// of a list written in the source, or the attributes of a list.
1406+pub fn split_list(text: &str) -> Vec<std::ops::Range<usize>> {
1407+ let mut parts = Vec::new();
1408+ let mut from = 0;
1409+ let mut depth = 0i32;
1410+ let mut quoted = false;
1411+ let mut i = 0;
1412+ while i < text.len() {
1413+ let rest = &text[i..];
1414+ let escape = escape_len(rest);
1415+ if escape > 0 {
1416+ i += escape;
1417+ continue;
1418+ }
1419+ let Some(c) = rest.chars().next() else { break };
1420+ match c {
1421+ '"' => quoted = !quoted,
1422+ _ if quoted => {}
1423+ '(' | '[' | '{' => depth += 1,
1424+ ')' | ']' | '}' => depth -= 1,
1425+ ',' if depth <= 0 => {
1426+ parts.push(from..i);
1427+ from = i + 1;
1428+ }
1429+ _ => {}
1430+ }
1431+ i += c.len_utf8();
1432+ }
1433+ parts.push(from..text.len());
1434+ parts
1435+}
1436+
1437+/// The text between the quotes when `s` is one quoted string, `"..."`, and
1438+/// nothing else: `\"` inside it is not its end.
1439+pub fn quoted_string(s: &str) -> Option<&str> {
1440+ let inner = s.strip_prefix('"')?;
1441+ let mut i = 0;
1442+ while i < inner.len() {
1443+ let rest = &inner[i..];
1444+ if rest.starts_with('"') {
1445+ return (i + 1 == inner.len()).then(|| &inner[..i]);
1446+ }
1447+ i += match escape_len(rest) {
1448+ 0 => rest.chars().next().map_or(1, char::len_utf8),
1449+ n => n,
1450+ };
1451+ }
1452+ None
1453+}
1454+
1455+impl Reader<'_> {
1456+ fn span(&self, start: usize, end: usize) -> Span {
1457+ self.spans.span(start, end)
1458+ }
1459+
1460+ fn skip_ws(&self, mut pos: usize, limit: usize) -> usize {
1461+ while pos < limit {
1462+ match self.text[pos..].chars().next() {
1463+ Some(c) if c.is_whitespace() => pos += c.len_utf8(),
1464+ _ => break,
1465+ }
1466+ }
1467+ pos
1468+ }
1469+
1470+ /// The end of a name starting at `pos`: the first whitespace or `[`.
1471+ fn name_end(&self, pos: usize, limit: usize) -> usize {
1472+ self.text[pos..limit]
1473+ .find(|c: char| c.is_whitespace() || c == '[')
1474+ .map_or(limit, |i| pos + i)
1475+ }
1476+
1477+ fn arg(&self, start: usize, end: usize) -> Option<Arg> {
1478+ let piece = &self.text[start..end];
1479+ let trimmed = piece.trim();
1480+ if trimmed.is_empty() {
1481+ return None;
1482+ }
1483+ let s = start + (piece.len() - piece.trim_start().len());
1484+ Some(Arg {
1485+ raw: trimmed.to_string(),
1486+ span: self.span(s, s + trimmed.len()),
1487+ })
1488+ }
1489+
1490+ fn line(&self) -> (NodeKind, bool, Vec<Diagnostic>) {
1491+ let mut problems = Vec::new();
1492+ let (kind, open) = if self.text.starts_with('@') {
1493+ let end = self.name_end(1, self.text.len());
1494+ match ast::directive(&self.text[1..end]) {
1495+ Some(spec) => {
1496+ let (args, open) = self.directive_args(spec, end, &mut problems);
1497+ let directive = Directive {
1498+ spec,
1499+ name_span: self.span(0, end),
1500+ args,
1501+ };
1502+ (NodeKind::Directive(directive), open)
1503+ }
1504+ None => {
1505+ let (line, open) = self.element_line();
1506+ (NodeKind::Element(line), open)
1507+ }
1508+ }
1509+ } else {
1510+ let (text, open) = self.text(0, self.text.len());
1511+ (NodeKind::Text(text), open)
1512+ };
1513+ if let NodeKind::Element(element) = &kind {
1514+ let closes = element
1515+ .chain
1516+ .iter()
1517+ .filter_map(|head| head.attrs.as_ref()?.quoted_close);
1518+ for close in closes {
1519+ problems.push(
1520+ Diagnostic::warning(
1521+ code::UNBALANCED_QUOTE,
1522+ close.line,
1523+ "this `]` ends the attribute list, but it looks like it is inside a \
1524+ `'...'` in the value: write `\\]` to keep it in the value"
1525+ .to_string(),
1526+ )
1527+ .column(close.column)
1528+ .source(self.text.to_string()),
1529+ );
1530+ }
1531+ }
1532+ if open {
1533+ // An unclosed quote keeps the list open to the end of the file
1534+ let mut quotes = 0;
1535+ let mut chars = self.text.chars();
1536+ while let Some(c) = chars.next() {
1537+ match c {
1538+ '\\' => {
1539+ chars.next();
1540+ }
1541+ '"' => quotes += 1,
1542+ _ => {}
1543+ }
1544+ }
1545+ let message = if quotes % 2 == 1 {
1546+ "unclosed '[' in attribute list: a `\"` in it isn't closed (write `\\\"` for a \
1547+ quote character)"
1548+ } else {
1549+ "unclosed '[' in attribute list"
1550+ };
1551+ problems.push(self.error(code::UNCLOSED_BRACKET, message.to_string()));
1552+ }
1553+ (kind, open, problems)
1554+ }
1555+
1556+ fn error(&self, code: &'static str, message: String) -> Diagnostic {
1557+ Diagnostic::error(code, self.span(0, 0).line, message).source(self.text.to_string())
1558+ }
1559+
1560+ /// `@name [attrs] > @name [attrs] text`.
1561+ fn element_line(&self) -> (ElementLine, bool) {
1562+ let len = self.text.len();
1563+ let mut chain = Vec::new();
1564+ let mut pos = 0;
1565+ loop {
1566+ let (head, end) = self.head(pos, len);
1567+ let unclosed = head.attrs.as_ref().is_some_and(|a| !a.closed);
1568+ chain.push(head);
1569+ if unclosed {
1570+ return (ElementLine { chain, text: None }, true);
1571+ }
1572+ let after = self.skip_ws(end, len);
1573+ if let Some(rest) = self.text[after..].strip_prefix('>') {
1574+ let next = self.skip_ws(after + 1, len);
1575+ if next > after + 1 && rest.trim_start().starts_with('@') {
1576+ pos = next;
1577+ continue;
1578+ }
1579+ }
1580+ let (text, open) = if after < len {
1581+ let (text, open) = self.text(after, len);
1582+ (Some(text), open)
1583+ } else {
1584+ (None, false)
1585+ };
1586+ return (ElementLine { chain, text }, open);
1587+ }
1588+ }
1589+
1590+ /// `@name [attrs]` at `pos`, and where it ends.
1591+ fn head(&self, pos: usize, limit: usize) -> (Head, usize) {
1592+ let name_end = self.name_end(pos + 1, limit);
1593+ let name = self.text[pos + 1..name_end].to_string();
1594+ let bracket = self.skip_ws(name_end, limit);
1595+ let (attrs, end) = if self.text[bracket..limit].starts_with('[') {
1596+ let list = self.attr_list(bracket, limit);
1597+ let end = list.1;
1598+ (Some(list.0), end)
1599+ } else {
1600+ (None, name_end)
1601+ };
1602+ let head = Head {
1603+ name,
1604+ name_span: self.span(pos, name_end),
1605+ attrs,
1606+ span: self.span(pos, end),
1607+ };
1608+ (head, end)
1609+ }
1610+
1611+ /// `[attr, attr]` starting at `open`, and where it ends. Brackets
1612+ /// inside `"..."` and escaped ones (`\]`) don't count.
1613+ fn attr_list(&self, open: usize, limit: usize) -> (AttrList, usize) {
1614+ let mut depth = 0;
1615+ let mut quoted = false;
1616+ // The `'`s outside `"..."`, which don't quote anything in htmlang
1617+ let mut apostrophes = 0;
1618+ let mut close = None;
1619+ let mut i = open;
1620+ while i < limit {
1621+ let rest = &self.text[i..limit];
1622+ let escape = escape_len(rest);
1623+ if escape > 0 {
1624+ i += escape;
1625+ continue;
1626+ }
1627+ let Some(c) = rest.chars().next() else { break };
1628+ match c {
1629+ '"' => quoted = !quoted,
1630+ _ if quoted => {}
1631+ '\'' => apostrophes += 1,
1632+ '[' => depth += 1,
1633+ ']' => {
1634+ depth -= 1;
1635+ if depth == 0 {
1636+ close = Some(i);
1637+ break;
1638+ }
1639+ }
1640+ _ => {}
1641+ }
1642+ i += c.len_utf8();
1643+ }
1644+ let inner_end = close.unwrap_or(limit);
1645+ let attrs = self
1646+ .split_commas(open + 1, inner_end)
1647+ .into_iter()
1648+ .filter_map(|(s, e)| self.attr(s, e))
1649+ .collect();
1650+ let end = close.map_or(limit, |c| c + 1);
1651+ let quoted_close = close.filter(|&c| {
1652+ let word = self.text[c + 1..limit].split(char::is_whitespace).next();
1653+ apostrophes % 2 == 1 && word.is_some_and(|word| word.contains('\''))
1654+ });
1655+ let list = AttrList {
1656+ attrs,
1657+ span: self.span(open, end),
1658+ closed: close.is_some(),
1659+ quoted_close: quoted_close.map(|c| self.span(c, c + 1)),
1660+ };
1661+ (list, end)
1662+ }
1663+
1664+ /// Ranges between the commas that aren't escaped (`\,`) or inside
1665+ /// `(...)`, `[...]`, `{...}` or `"..."`.
1666+ fn split_commas(&self, start: usize, end: usize) -> Vec<(usize, usize)> {
1667+ split_list(&self.text[start..end])
1668+ .into_iter()
1669+ .map(|part| (start + part.start, start + part.end))
1670+ .collect()
1671+ }
1672+
1673+ fn attr(&self, start: usize, end: usize) -> Option<Attr> {
1674+ let arg = self.arg(start, end)?;
1675+ let (key, value, html) = split_attribute(&arg.raw);
1676+ let piece = &self.text[start..end];
1677+ let s = start + (piece.len() - piece.trim_start().len());
1678+ if let Some(prefixed) = self.prefixed(s, s + arg.raw.len()) {
1679+ return Some(Attr {
1680+ key: prefixed.prefix.clone(),
1681+ value: None,
1682+ html: false,
1683+ raw: arg.raw,
1684+ span: arg.span,
1685+ choice: None,
1686+ prefixed: Some(Box::new(prefixed)),
1687+ });
1688+ }
1689+ let choice = self.choice(s, s + arg.raw.len()).map(Box::new);
1690+ Some(Attr {
1691+ key,
1692+ value,
1693+ html,
1694+ raw: arg.raw,
1695+ span: arg.span,
1696+ choice,
1697+ prefixed: None,
1698+ })
1699+ }
1700+
1701+ /// Prefixes applied to a `[group]`, a `$bundle` or an `if()`, when that
1702+ /// is all of `start..end`: a key that ends in `:` directly followed by
1703+ /// `[`, `$` or `if(`. A value is always after a space, so the `[` of a
1704+ /// value (`grid-template-columns [a] 1fr`) is never a group, and one
1705+ /// inside a prefix's parentheses (`has([open]):`) isn't either.
1706+ fn prefixed(&self, start: usize, end: usize) -> Option<Prefixed> {
1707+ let text = &self.text[start..end];
1708+ let mut depth = 0;
1709+ for (i, c) in text.char_indices() {
1710+ match c {
1711+ '(' => depth += 1,
1712+ ')' => depth -= 1,
1713+ _ if depth > 0 => {}
1714+ '=' | '"' | '[' | '$' | '\\' => return None,
1715+ c if c.is_whitespace() => return None,
1716+ ':' => {
1717+ let rest = &text[i + 1..];
1718+ if !(rest.starts_with(['[', '$']) || rest.starts_with("if(")) || i == 0 {
1719+ continue;
1720+ }
1721+ let at = start + i + 1;
1722+ let target = if rest.starts_with('[') {
1723+ let (list, after) = self.attr_list(at, end);
1724+ let trailing = self.arg(after, end);
1725+ Branch::Group { list, trailing }
1726+ } else {
1727+ self.attr(at, end).map_or(Branch::Empty, Branch::Attr)
1728+ };
1729+ return Some(Prefixed {
1730+ prefix: text[..i + 1].to_string(),
1731+ prefix_span: self.span(start, at),
1732+ target,
1733+ });
1734+ }
1735+ _ => {}
1736+ }
1737+ }
1738+ None
1739+ }
1740+
1741+ /// `if(CONDITION, A, B)` when it is all of `start..end`: the condition
1742+ /// and the branches, each an attribute, a `[group]` (a branch that
1743+ /// starts with `[`) or nothing.
1744+ fn choice(&self, start: usize, end: usize) -> Option<Choice> {
1745+ let text = &self.text[start..end];
1746+ if !text.starts_with("if(") || self.closing_paren(start + 2, end)? + 1 != end {
1747+ return None;
1748+ }
1749+ let mut parts = self.split_commas(start + 3, end - 1).into_iter();
1750+ let (s, e) = parts.next()?;
1751+ let condition = self.arg(s, e);
1752+ let branches = parts
1753+ .map(|(s, e)| {
1754+ let at = self.skip_ws(s, e);
1755+ if self.text[at..e].starts_with('[') {
1756+ let (list, after) = self.attr_list(at, e);
1757+ let trailing = self.arg(after, e);
1758+ Branch::Group { list, trailing }
1759+ } else {
1760+ self.attr(s, e).map_or(Branch::Empty, Branch::Attr)
1761+ }
1762+ })
1763+ .collect();
1764+ Some(Choice {
1765+ condition,
1766+ branches,
1767+ })
1768+ }
1769+
1770+ /// The `)` that closes the `(` at `open`, before `limit`. Parentheses
1771+ /// inside `"..."` and escaped characters don't count.
1772+ fn closing_paren(&self, open: usize, limit: usize) -> Option<usize> {
1773+ let mut depth = 0;
1774+ let mut quoted = false;
1775+ let mut i = open;
1776+ while i < limit {
1777+ let rest = &self.text[i..limit];
1778+ let escape = escape_len(rest);
1779+ if escape > 0 {
1780+ i += escape;
1781+ continue;
1782+ }
1783+ let c = rest.chars().next()?;
1784+ match c {
1785+ '"' => quoted = !quoted,
1786+ _ if quoted => {}
1787+ '(' => depth += 1,
1788+ ')' => {
1789+ depth -= 1;
1790+ if depth == 0 {
1791+ return Some(i);
1792+ }
1793+ }
1794+ _ => {}
1795+ }
1796+ i += c.len_utf8();
1797+ }
1798+ None
1799+ }
1800+
1801+ /// Text from `start` to `end` (trimmed), and whether an inline
1802+ /// element's attribute list is still open at its end.
1803+ fn text(&self, start: usize, end: usize) -> (Text, bool) {
1804+ let piece = &self.text[start..end];
1805+ let s = start + (piece.len() - piece.trim_start().len());
1806+ let e = s + piece.trim().len();
1807+ let mut segments = Vec::new();
1808+ let mut open = false;
1809+ let mut plain = s;
1810+ let mut i = s;
1811+ let flush = |segments: &mut Vec<Segment>, from: usize, to: usize| {
1812+ if to > from {
1813+ segments.push(Segment::Plain {
1814+ raw: self.text[from..to].to_string(),
1815+ span: self.span(from, to),
1816+ });
1817+ }
1818+ };
1819+ while i < e {
1820+ let rest = &self.text[i..e];
1821+ if rest.starts_with('\\') {
1822+ i += escape_len(rest).max(1);
1823+ continue;
1824+ }
1825+ if rest.starts_with("{@") {
1826+ flush(&mut segments, plain, i);
1827+ let (inline, inline_open, next) = self.inline(i, e);
1828+ open |= inline_open;
1829+ segments.push(Segment::Inline(Box::new(inline)));
1830+ i = next;
1831+ plain = i;
1832+ continue;
1833+ }
1834+ i += rest.chars().next().map_or(1, char::len_utf8);
1835+ }
1836+ flush(&mut segments, plain, e);
1837+ let text = Text {
1838+ raw: self.text[s..e].to_string(),
1839+ span: self.span(s, e),
1840+ segments,
1841+ };
1842+ (text, open)
1843+ }
1844+
1845+ /// `{@name [attrs] text}` at `start`: the element, whether its
1846+ /// attribute list is open at `limit`, and where it ends.
1847+ fn inline(&self, start: usize, limit: usize) -> (Inline, bool, usize) {
1848+ let mut depth = 0;
1849+ let mut close = None;
1850+ let mut i = start + 1;
1851+ while i < limit {
1852+ let rest = &self.text[i..limit];
1853+ if rest.starts_with('\\') {
1854+ i += escape_len(rest).max(1);
1855+ continue;
1856+ }
1857+ match rest.chars().next() {
1858+ Some('{') => depth += 1,
1859+ Some('}') if depth == 0 => {
1860+ close = Some(i);
1861+ break;
1862+ }
1863+ Some('}') => depth -= 1,
1864+ _ => {}
1865+ }
1866+ i += rest.chars().next().map_or(1, char::len_utf8);
1867+ }
1868+ let inner_end = close.unwrap_or(limit);
1869+ let (head, head_end) = self.head(start + 1, inner_end);
1870+ let attrs_open = head.attrs.as_ref().is_some_and(|a| !a.closed);
1871+ let after = self.skip_ws(head_end, inner_end);
1872+ let (text, text_open) = if after < inner_end {
1873+ let (text, open) = self.text(after, inner_end);
1874+ (Some(text), open)
1875+ } else {
1876+ (None, false)
1877+ };
1878+ let end = close.map_or(limit, |c| c + 1);
1879+ let inline = Inline {
1880+ raw: self.text[start + 1..inner_end].to_string(),
1881+ span: self.span(start, end),
1882+ head,
1883+ text,
1884+ closed: close.is_some(),
1885+ };
1886+ (inline, close.is_none() && (attrs_open || text_open), end)
1887+ }
1888+
1889+ /// A directive's arguments, by its grammar, and whether they continue
1890+ /// onto the next line.
1891+ fn directive_args(
1892+ &self,
1893+ spec: &'static DirectiveSpec,
1894+ name_end: usize,
1895+ problems: &mut Vec<Diagnostic>,
1896+ ) -> (DirectiveArgs, bool) {
1897+ let len = self.text.len();
1898+ let name = spec.name;
1899+ // A verbatim directive takes no attributes: `[` right after its name
1900+ // opens a list, as after any name, and the list is an error
1901+ let mut name_end = name_end;
1902+ let bracket = self.skip_ws(name_end, len);
1903+ if spec.body == BodyKind::Verbatim && self.text[bracket..].starts_with('[') {
1904+ let (list, end) = self.attr_list(bracket, len);
1905+ let reason = match name {
1906+ "raw" => "its HTML goes into the page as written, so put them in the HTML",
1907+ "head" => "its HTML goes into the <head> as written, so put them in the HTML",
1908+ "markdown" => {
1909+ "to style the Markdown, put @markdown in an element that has them \
1910+ (`@el [padding 8]` with @markdown indented under it)"
1911+ }
1912+ _ => "its CSS goes into the page as written",
1913+ };
1914+ let hint = match name {
1915+ "markdown" => String::new(),
1916+ _ => format!(
1917+ ". Content that starts with `[` goes in an indented block under @{}",
1918+ name
1919+ ),
1920+ };
1921+ problems.push(
1922+ self.error(
1923+ code::UNEXPECTED_ARGUMENT,
1924+ format!("@{} takes no attributes: {}{}", name, reason, hint),
1925+ )
1926+ .subject(self.text[bracket..end].to_string())
1927+ .column(list.span.column),
1928+ );
1929+ if !list.closed {
1930+ return (DirectiveArgs::Invalid, true);
1931+ }
1932+ name_end = end;
1933+ }
1934+ let rest = self.text[name_end..].trim();
1935+ let mut missing = |what: &str| {
1936+ problems.push(self.error(code::MISSING_ARGUMENT, format!("@{} needs {}", name, what)));
1937+ (DirectiveArgs::Invalid, false)
1938+ };
1939+ match spec.args {
1940+ ArgGrammar::Text => match self.arg(name_end, len) {
1941+ // Without a body, the line is all the directive has
1942+ None if spec.body == BodyKind::None => missing(match name {
1943+ "include" => "a file: `@include header.hl`",
1944+ "meta" => "a name and a value: `@meta description A small site`",
1945+ _ => "an argument",
1946+ }),
1947+ arg => (DirectiveArgs::Text(arg), false),
1948+ },
1949+ ArgGrammar::AttrsText => {
1950+ let bracket = self.skip_ws(name_end, len);
1951+ let (attrs, after) = if self.text[bracket..].starts_with('[') {
1952+ let (list, end) = self.attr_list(bracket, len);
1953+ (Some(list), end)
1954+ } else {
1955+ (None, name_end)
1956+ };
1957+ let open = attrs.as_ref().is_some_and(|a| !a.closed);
1958+ let title = if open { None } else { self.arg(after, len) };
1959+ (DirectiveArgs::Page { attrs, title }, open)
1960+ }
1961+ ArgGrammar::Expression => match self.arg(name_end, len) {
1962+ Some(condition) => (DirectiveArgs::Condition(condition), false),
1963+ None => missing("a condition"),
1964+ },
1965+ ArgGrammar::Else => {
1966+ if rest.is_empty() {
1967+ return (DirectiveArgs::Else { condition: None }, false);
1968+ }
1969+ let at = self.skip_ws(name_end, len);
1970+ let after_if = at + 2;
1971+ let is_if = self.text[at..].starts_with("if")
1972+ && self.text[after_if..]
1973+ .chars()
1974+ .next()
1975+ .is_none_or(char::is_whitespace);
1976+ if !is_if {
1977+ problems.push(
1978+ self.error(
1979+ code::UNEXPECTED_ARGUMENT,
1980+ "@else takes nothing on its line (a condition is `@else if COND`)"
1981+ .to_string(),
1982+ ),
1983+ );
1984+ return (DirectiveArgs::Else { condition: None }, false);
1985+ }
1986+ match self.arg(after_if, len) {
1987+ Some(condition) => (
1988+ DirectiveArgs::Else {
1989+ condition: Some(condition),
1990+ },
1991+ false,
1992+ ),
1993+ None => {
1994+ problems.push(self.error(
1995+ code::MISSING_ARGUMENT,
1996+ "@else if needs a condition".to_string(),
1997+ ));
1998+ (
1999+ DirectiveArgs::Else {
2000+ condition: Some(Arg {
2001+ raw: String::new(),
2002+ span: self.span(after_if, after_if),
2003+ }),
2004+ },
2005+ false,
2006+ )
2007+ }
2008+ }
2009+ }
2010+ ArgGrammar::Loop => {
2011+ let Some((names, list)) = rest.split_once(" in ") else {
2012+ problems.push(self.error(
2013+ code::INVALID_LOOP,
2014+ "@each requires: @each $item in LIST".to_string(),
2015+ ));
2016+ return (DirectiveArgs::Invalid, false);
2017+ };
2018+ let written: Vec<&str> = names.split(',').map(str::trim).collect();
2019+ // Like `@data $name`, the variables are written with `$`
2020+ if let Some(bare) = written.iter().find(|n| !n.starts_with('$') || n.len() == 1) {
2021+ let fixed: Vec<String> = written
2022+ .iter()
2023+ .enumerate()
2024+ .map(|(i, n)| match n.trim_start_matches('$') {
2025+ "" if i == 0 => "$item".to_string(),
2026+ "" => "$index".to_string(),
2027+ name => format!("${}", name),
2028+ })
2029+ .collect();
2030+ let problem = self.error(
2031+ code::INVALID_LOOP,
2032+ format!(
2033+ "@each names its variables with `$`: `@each {} in LIST`",
2034+ fixed.join(", ")
2035+ ),
2036+ );
2037+ // A name without its `$` gets it; a missing name has
2038+ // nothing to replace
2039+ let problem = match bare.trim_start_matches('$').is_empty() {
2040+ true => problem,
2041+ false => problem.subject(*bare).suggest(Some(format!("${}", bare))),
2042+ };
2043+ problems.push(problem);
2044+ }
2045+ let names: Vec<&str> = written
2046+ .iter()
2047+ .map(|v| v.strip_prefix('$').unwrap_or(v))
2048+ .collect();
2049+ if names.len() > 2 {
2050+ problems.push(
2051+ self.error(
2052+ code::INVALID_LOOP,
2053+ "@each takes `$item` or `$item, $index`: to loop over records, \
2054+ load them with @data and use `$item.key`"
2055+ .to_string(),
2056+ ),
2057+ );
2058+ return (DirectiveArgs::Invalid, false);
2059+ }
2060+ let list_start = len - list.trim_start().len();
2061+ let list = Arg {
2062+ raw: list.trim().to_string(),
2063+ span: self.span(list_start, len),
2064+ };
2065+ let each = Loop {
2066+ item: names[0].to_string(),
2067+ index: names.get(1).map(|s| s.to_string()),
2068+ list,
2069+ };
2070+ (DirectiveArgs::Each(each), false)
2071+ }
2072+ ArgGrammar::Data => {
2073+ let at = self.skip_ws(name_end, len);
2074+ let named = self.text[at..].strip_prefix('$').and_then(|named| {
2075+ let (name, source) = named.split_once(char::is_whitespace)?;
2076+ Some((name, source.trim()))
2077+ });
2078+ let Some((data_name, source)) = named.filter(|(_, source)| !source.is_empty())
2079+ else {
2080+ problems.push(self.error(
2081+ code::MISSING_ARGUMENT,
2082+ format!(
2083+ "@data needs a name: write `@data $name {}` and use `$name.key`",
2084+ rest.trim_start_matches('$')
2085+ ),
2086+ ));
2087+ return (DirectiveArgs::Invalid, false);
2088+ };
2089+ let name_start = at + 1;
2090+ let source_start = len - source.len();
2091+ let open = source.starts_with(['[', '{']) && !json_balanced(source);
2092+ let args = DirectiveArgs::Data {
2093+ name: data_name.to_string(),
2094+ name_span: self.span(name_start, name_start + data_name.len()),
2095+ source: Arg {
2096+ raw: source.to_string(),
2097+ span: self.span(source_start, len),
2098+ },
2099+ };
2100+ (args, open)
2101+ }
2102+ ArgGrammar::Definition => {
2103+ let at = self.skip_ws(name_end, len);
2104+ if at >= len {
2105+ return missing("a name: `@let name value`");
2106+ }
2107+ // `@let @name`: a function
2108+ let function = self.text[at..].starts_with('@');
2109+ let name_at = at + usize::from(function);
2110+ let def_name_end = self.name_end(name_at, len);
2111+ let written = &self.text[name_at..def_name_end];
2112+ let def_name = written.strip_prefix('$').unwrap_or(written).to_string();
2113+ let name_span = self.span(name_at + written.len() - def_name.len(), def_name_end);
2114+ let invalid = |message: String| {
2115+ self.error(code::INVALID_DEFINITION, message)
2116+ .subject(written.to_string())
2117+ };
2118+ if function {
2119+ let valid = def_name.chars().next().is_some_and(char::is_alphabetic)
2120+ && def_name
2121+ .chars()
2122+ .all(|c| c.is_alphanumeric() || c == '-' || c == '_');
2123+ if def_name.is_empty() {
2124+ return missing("a function name: `@let @name [param]`");
2125+ }
2126+ if !valid || written.starts_with('$') {
2127+ problems.push(invalid(format!(
2128+ "'{}' is not a function name: a function is named with letters, \
2129+ digits, `-` and `_`, starting with a letter, as in `@let @card`",
2130+ written
2131+ )));
2132+ } else if let Some(message) = shadowed(&def_name) {
2133+ let mut warning = self
2134+ .error(code::SHADOWS_BUILT_IN, message)
2135+ .subject(def_name.clone())
2136+ .column(name_span.column);
2137+ warning.severity = Severity::Warning;
2138+ problems.push(warning);
2139+ }
2140+ } else if written.starts_with('$') {
2141+ problems.push(
2142+ invalid(format!(
2143+ "`@let` names are written without `$`: `@let {}`, used as `${}`",
2144+ def_name, def_name
2145+ ))
2146+ .suggest(Some(def_name.clone())),
2147+ );
2148+ } else if !is_definition_name(&def_name) {
2149+ problems.push(invalid(if def_name.starts_with("--") {
2150+ format!(
2151+ "'{}' is not a custom property's name: `--` and then letters, \
2152+ digits, `-` and `_` (`@let --brand #3b82f6`)",
2153+ written
2154+ )
2155+ } else {
2156+ format!(
2157+ "'{}' is not a name: a @let name is letters, digits, `-` and `_`, \
2158+ starting with a letter (`@let gap 8`)",
2159+ written
2160+ )
2161+ }));
2162+ }
2163+ let value_at = self.skip_ws(def_name_end, len);
2164+ let value = &self.text[value_at..];
2165+ let mut open = false;
2166+ // Text after a closed list's `]`
2167+ let mut after_list = |end: usize, what: &str| {
2168+ let rest = self.text[end..].trim();
2169+ if !rest.is_empty() {
2170+ problems.push(self.error(
2171+ code::UNEXPECTED_ARGUMENT,
2172+ format!("unexpected '{}' after the {}", rest, what),
2173+ ));
2174+ }
2175+ };
2176+ let form = if function {
2177+ let list = if value.starts_with('[') {
2178+ let (list, end) = self.attr_list(value_at, len);
2179+ open = !list.closed;
2180+ if list.closed {
2181+ after_list(end, "parameter list");
2182+ }
2183+ Some(list)
2184+ } else {
2185+ if !value.is_empty() {
2186+ problems.push(self.error(
2187+ code::INVALID_DEFINITION,
2188+ format!(
2189+ "a function's parameters go in brackets: \
2190+ `@let @{} [param, param default]`",
2191+ def_name
2192+ ),
2193+ ));
2194+ }
2195+ None
2196+ };
2197+ let params = match &list {
2198+ Some(list) => params(list, self.text, problems),
2199+ None => Vec::new(),
2200+ };
2201+ LetForm::Function(Function { list, params })
2202+ } else if value.is_empty() {
2203+ let message = if def_name.starts_with("--") {
2204+ format!(
2205+ "`@let {}` needs a value: a custom property is declared with one, \
2206+ `@let {} 8px`",
2207+ def_name, def_name
2208+ )
2209+ } else {
2210+ format!(
2211+ "`@let {}` needs a value: `@let {} VALUE` \
2212+ (a function is `@let @{}` with an indented body)",
2213+ def_name, def_name, def_name
2214+ )
2215+ };
2216+ problems.push(self.error(code::MISSING_ARGUMENT, message));
2217+ return (DirectiveArgs::Invalid, false);
2218+ } else if let Some(expr) = value.strip_prefix('=') {
2219+ let expr_at = len - expr.trim_start().len();
2220+ LetForm::Computed(Arg {
2221+ raw: expr.trim().to_string(),
2222+ span: self.span(expr_at, len),
2223+ })
2224+ } else if value.starts_with('[') {
2225+ let (list, end) = self.attr_list(value_at, len);
2226+ open = !list.closed;
2227+ if list.closed {
2228+ after_list(end, "attribute bundle");
2229+ }
2230+ LetForm::Bundle(list)
2231+ } else if let Some(inner) = quoted_string(value) {
2232+ LetForm::Quoted(Arg {
2233+ raw: inner.to_string(),
2234+ span: self.span(value_at + 1, len - 1),
2235+ })
2236+ } else {
2237+ match self.arg(value_at, len) {
2238+ Some(arg) => LetForm::Value(arg),
2239+ None => return (DirectiveArgs::Invalid, false),
2240+ }
2241+ };
2242+ let def = LetDef {
2243+ name: def_name,
2244+ name_span,
2245+ form,
2246+ };
2247+ (DirectiveArgs::Let(def), open)
2248+ }
2249+ }
2250+ }
2251+}
2252+
2253+/// Why a function can't be named `name`: it is the name of a built-in
2254+/// element, which the function would replace everywhere after it, or of a
2255+/// directive, which it could never replace.
2256+fn shadowed(name: &str) -> Option<String> {
2257+ if ast::ElementKind::from_name(name).is_some() {
2258+ Some(format!(
2259+ "@let @{0} replaces the built-in element @{0}: every @{0} after this line \
2260+ calls the function. Give the function another name",
2261+ name
2262+ ))
2263+ } else if ast::directive(name).is_some() {
2264+ Some(format!(
2265+ "@{0} is a directive, so a function named @{0} can never be called: give it \
2266+ another name",
2267+ name
2268+ ))
2269+ } else {
2270+ None
2271+ }
2272+}
2273+
2274+/// Whether `name` can be a value's or bundle's name, as `@let name`: a
2275+/// name `$name` reaches (`t.greeting` too, for a record's field), or a
2276+/// custom property `--name`, named as on an element (`[--name value]`).
2277+fn is_definition_name(name: &str) -> bool {
2278+ if name.starts_with("--") {
2279+ return crate::vocab::is_custom_property(name);
2280+ }
2281+ let n = crate::interp::name_len(name);
2282+ if n == 0 || matches!(&name[..n], "true" | "false" | "not" | "and" | "or") {
2283+ return false;
2284+ }
2285+ name[n..].split('.').skip(1).all(|field| {
2286+ !field.is_empty()
2287+ && field
2288+ .chars()
2289+ .all(|c| c.is_alphanumeric() || c == '_' || c == '-')
2290+ }) && (n == name.len() || name[n..].starts_with('.'))
2291+}
2292+
2293+/// An attribute's key, value, and whether it is written `key=value`:
2294+/// `padding 20`, `type=email`, `required`.
2295+pub(crate) fn split_attribute(raw: &str) -> (String, Option<String>, bool) {
2296+ if let Some((key, value)) = split_html_attribute(raw) {
2297+ return (key.to_string(), Some(value.to_string()), true);
2298+ }
2299+ match key_end(raw) {
2300+ Some(end) => (
2301+ raw[..end].trim().to_string(),
2302+ Some(raw[end + 1..].trim().to_string()),
2303+ false,
2304+ ),
2305+ None => (raw.to_string(), None, false),
2306+ }
2307+}
2308+
2309+/// Where a style's key ends: at the first space outside parentheses, so a
2310+/// prefix's argument can hold spaces (`has(> img):padding 0`). Inside
2311+/// parentheses, a quoted string and a character after a backslash don't
2312+/// count, as in [`crate::vocab::closing_paren`]
2313+/// (`not([title=") x"]):color red`). When a `(` is never closed, at the
2314+/// first space.
2315+fn key_end(raw: &str) -> Option<usize> {
2316+ let mut depth = 0usize;
2317+ let mut quote = None;
2318+ let mut chars = raw.char_indices();
2319+ while let Some((i, c)) = chars.next() {
2320+ match (quote, c) {
2321+ (_, '\\') if depth > 0 => {
2322+ chars.next();
2323+ }
2324+ (Some(q), c) if c == q => quote = None,
2325+ (Some(_), _) => {}
2326+ (None, '"' | '\'') if depth > 0 => quote = Some(c),
2327+ (None, '(') => depth += 1,
2328+ (None, ')') => depth = depth.saturating_sub(1),
2329+ (None, ' ') if depth == 0 => return Some(i),
2330+ _ => {}
2331+ }
2332+ }
2333+ if depth > 0 || quote.is_some() {
2334+ raw.find(' ')
2335+ } else {
2336+ None
2337+ }
2338+}
2339+
2340+/// Split an HTML attribute written `key=value` (`alt=`, `type=email`,
2341+/// `aria-label=Close menu`, and names with a colon such as `xml:lang=en`
2342+/// or `x-on:click=open`). Returns `None` for style attributes.
2343+pub(crate) fn split_html_attribute(part: &str) -> Option<(&str, &str)> {
2344+ let first_token = part.split(char::is_whitespace).next()?;
2345+ let eq = first_token.find('=')?;
2346+ let key = &part[..eq];
2347+ let valid_key = key.starts_with(|c: char| c.is_ascii_alphabetic())
2348+ && key
2349+ .chars()
2350+ .all(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_' | '.' | ':'));
2351+ valid_key.then(|| (key, part[eq + 1..].trim()))
2352+}
2353+
2354+/// Whether the brackets and braces of inline JSON are balanced.
2355+fn json_balanced(json: &str) -> bool {
2356+ let mut depth = 0i32;
2357+ let mut in_string = false;
2358+ let mut escaped = false;
2359+ for c in json.chars() {
2360+ if in_string {
2361+ match c {
2362+ _ if escaped => escaped = false,
2363+ '\\' => escaped = true,
2364+ '"' => in_string = false,
2365+ _ => {}
2366+ }
2367+ continue;
2368+ }
2369+ match c {
2370+ '"' => in_string = true,
2371+ '[' | '{' => depth += 1,
2372+ ']' | '}' => depth -= 1,
2373+ _ => {}
2374+ }
2375+ }
2376+ depth <= 0
2377+}
2378+
2379+#[cfg(test)]
2380+mod tests {
2381+ use super::*;
2382+
2383+ fn kinds(nodes: &[Node]) -> Vec<&'static str> {
2384+ nodes
2385+ .iter()
2386+ .map(|n| match &n.kind {
2387+ NodeKind::Blank => "blank",
2388+ NodeKind::Comment => "comment",
2389+ NodeKind::Text(_) => "text",
2390+ NodeKind::Element(_) => "element",
2391+ NodeKind::Directive(d) => d.name(),
2392+ NodeKind::Verbatim(_) => "verbatim",
2393+ })
2394+ .collect()
2395+ }
2396+
2397+ fn codes(tree: &Tree) -> Vec<&'static str> {
2398+ tree.diagnostics.iter().map(|d| d.code).collect()
2399+ }
2400+
2401+ #[test]
2402+ fn lines_become_nodes_with_trivia() {
2403+ let tree = parse("-- intro\n@el [padding 4]\n Hello\n\n @text x\n@text y\n");
2404+ assert_eq!(kinds(&tree.nodes), ["comment", "element", "element"]);
2405+ assert_eq!(kinds(&tree.nodes[1].children), ["text", "blank", "element"]);
2406+ assert!(tree.diagnostics.is_empty());
2407+ }
2408+
2409+ #[test]
2410+ fn a_comment_is_a_double_dash_followed_by_a_space_or_nothing() {
2411+ for line in ["-- note", "--", "--\tnote", "-- "] {
2412+ assert!(is_comment(line), "{line:?}");
2413+ }
2414+ for line in ["--gap 12px", "---", "--x", "- - x", "text -- x"] {
2415+ assert!(!is_comment(line), "{line:?}");
2416+ }
2417+ // `--gap 12px` on a line of a list is one of its attributes
2418+ let tree = parse("@el [\n padding 4,\n -- note\n --gap 12px,\n --\n color red\n]\n");
2419+ assert!(tree.diagnostics.is_empty(), "{:?}", tree.diagnostics);
2420+ let NodeKind::Element(line) = &tree.nodes[0].kind else {
2421+ panic!()
2422+ };
2423+ let keys: Vec<_> = line.chain[0]
2424+ .attrs
2425+ .as_ref()
2426+ .unwrap()
2427+ .attrs
2428+ .iter()
2429+ .map(|a| a.key.as_str())
2430+ .collect();
2431+ assert_eq!(keys, ["padding", "--gap", "color"]);
2432+ // At the start of a line outside a list, `--x` is text
2433+ assert_eq!(kinds(&parse("--x marks the spot\n").nodes), ["text"]);
2434+ }
2435+
2436+ #[test]
2437+ fn heads_attributes_and_spans() {
2438+ let src = "@row [spacing 8, id=main] > @link [color red] /home Home\n";
2439+ let tree = parse(src);
2440+ let NodeKind::Element(line) = &tree.nodes[0].kind else {
2441+ panic!()
2442+ };
2443+ let names: Vec<_> = line.chain.iter().map(|h| h.name.as_str()).collect();
2444+ assert_eq!(names, ["row", "link"]);
2445+ let attrs = &line.chain[0].attrs.as_ref().unwrap().attrs;
2446+ assert_eq!(attrs[0].key, "spacing");
2447+ assert_eq!(attrs[0].value.as_deref(), Some("8"));
2448+ assert!(attrs[1].html);
2449+ assert_eq!(&src[attrs[1].span.start..attrs[1].span.end], "id=main");
2450+ assert_eq!(attrs[1].span.column, 17);
2451+ assert_eq!(line.text.as_ref().unwrap().raw, "/home Home");
2452+ }
2453+
2454+ #[test]
2455+ fn a_bracket_opens_a_list_only_after_a_head() {
2456+ let tree = parse("@text Use [ to open\n@text next\n");
2457+ assert_eq!(kinds(&tree.nodes), ["element", "element"]);
2458+ assert!(tree.diagnostics.is_empty());
2459+ let tree = parse("@el [\n padding 4,\n -- note\n color red\n]\n child\n");
2460+ assert_eq!(kinds(&tree.nodes), ["element"]);
2461+ let NodeKind::Element(line) = &tree.nodes[0].kind else {
2462+ panic!()
2463+ };
2464+ let list = line.chain[0].attrs.as_ref().unwrap();
2465+ assert_eq!(list.attrs.len(), 2);
2466+ assert_eq!(list.attrs[1].span.line, 4);
2467+ assert_eq!(kinds(&tree.nodes[0].children), ["text"]);
2468+ }
2469+
2470+ #[test]
2471+ fn a_whole_attribute_if_is_read_into_its_branches() {
2472+ let src = "@el [if($a == \"x, y\", [padding 4, if($b, gap 1)], $card), width if(media(print): 1px), if(c, )]\n";
2473+ let tree = parse(src);
2474+ let NodeKind::Element(line) = &tree.nodes[0].kind else {
2475+ panic!()
2476+ };
2477+ let attrs = &line.chain[0].attrs.as_ref().unwrap().attrs;
2478+ assert_eq!(attrs.len(), 3);
2479+ let choice = attrs[0].choice.as_ref().expect("an if()");
2480+ let condition = choice.condition.as_ref().unwrap();
2481+ assert_eq!(condition.raw, "$a == \"x, y\"");
2482+ assert_eq!(
2483+ &src[condition.span.start..condition.span.end],
2484+ condition.raw
2485+ );
2486+ let Branch::Group { list, trailing } = &choice.branches[0] else {
2487+ panic!("{:?}", choice.branches[0])
2488+ };
2489+ assert!(trailing.is_none());
2490+ assert_eq!(list.attrs.len(), 2);
2491+ assert_eq!(list.attrs[0].key, "padding");
2492+ assert_eq!(
2493+ &src[list.attrs[0].span.start..list.attrs[0].span.end],
2494+ "padding 4"
2495+ );
2496+ assert!(list.attrs[1].choice.is_some(), "an if() inside a group");
2497+ assert!(matches!(&choice.branches[1], Branch::Attr(a) if a.key == "$card"));
2498+ // An if() inside a value is CSS's; an empty branch is empty
2499+ assert!(attrs[1].choice.is_none());
2500+ let empty = attrs[2].choice.as_ref().unwrap();
2501+ assert!(matches!(empty.branches[..], [Branch::Empty]));
2502+ // A group spanning lines keeps each attribute's line
2503+ let tree = parse("@el [if($on, [\n padding 4,\n margin 2\n])]\n");
2504+ let NodeKind::Element(line) = &tree.nodes[0].kind else {
2505+ panic!()
2506+ };
2507+ let choice = line.chain[0].attrs.as_ref().unwrap().attrs[0]
2508+ .choice
2509+ .clone()
2510+ .unwrap();
2511+ let group = choice.branches[0].attrs();
2512+ assert_eq!((group[0].span.line, group[0].span.column), (2, 2));
2513+ assert_eq!((group[1].span.line, group[1].span.column), (3, 2));
2514+ }
2515+
2516+ #[test]
2517+ fn prefixes_apply_to_a_group_a_bundle_or_an_if() {
2518+ let src = "@el [md:hover:[padding 32, dark:color red], dark:$card, hover:if($on, color red), grid-template-columns [a] 1fr, has([open]):color red, xml:lang=en, md:x]\n";
2519+ let tree = parse(src);
2520+ let NodeKind::Element(line) = &tree.nodes[0].kind else {
2521+ panic!()
2522+ };
2523+ let attrs = &line.chain[0].attrs.as_ref().unwrap().attrs;
2524+ assert_eq!(attrs.len(), 7);
2525+ let group = attrs[0].prefixed.as_ref().expect("a prefixed group");
2526+ assert_eq!(group.prefix, "md:hover:");
2527+ assert_eq!(attrs[0].key, "md:hover:");
2528+ assert_eq!(
2529+ &src[group.prefix_span.start..group.prefix_span.end],
2530+ "md:hover:"
2531+ );
2532+ let keys: Vec<&str> = group
2533+ .target
2534+ .attrs()
2535+ .iter()
2536+ .map(|a| a.key.as_str())
2537+ .collect();
2538+ assert_eq!(keys, ["padding", "dark:color"]);
2539+ let bundle = attrs[1].prefixed.as_ref().expect("a prefixed bundle");
2540+ assert!(matches!(&bundle.target, Branch::Attr(a) if a.key == "$card"));
2541+ let choice = attrs[2].prefixed.as_ref().expect("a prefixed if()");
2542+ assert!(matches!(&choice.target, Branch::Attr(a) if a.choice.is_some()));
2543+ // A value's `[` and a `[` inside a prefix's parentheses are not groups
2544+ assert!(attrs[3].prefixed.is_none());
2545+ assert_eq!(attrs[3].key, "grid-template-columns");
2546+ assert!(attrs[4].prefixed.is_none());
2547+ // A name with a colon and `=` is an HTML attribute
2548+ assert!(attrs[5].html && attrs[5].key == "xml:lang");
2549+ assert!(attrs[6].prefixed.is_none());
2550+ }
2551+
2552+ #[test]
2553+ fn a_chain_needs_complete_heads() {
2554+ let tree = parse("@text Ask me > @support\n");
2555+ let NodeKind::Element(line) = &tree.nodes[0].kind else {
2556+ panic!()
2557+ };
2558+ assert_eq!(line.chain.len(), 1);
2559+ assert_eq!(line.text.as_ref().unwrap().raw, "Ask me > @support");
2560+ }
2561+
2562+ #[test]
2563+ fn escapes_are_one_closed_table() {
2564+ assert_eq!(
2565+ unescape(r#"\\ \$ \@ \{ \} \[ \] \, \" \-- \201C \d \"#),
2566+ r#"\ $ @ { } [ ] , " -- \201C \d \"#
2567+ );
2568+ assert_eq!(quoted_string(r#""a\"b""#), Some(r#"a\"b"#));
2569+ assert_eq!(quoted_string(r#""head head" "side main""#), None);
2570+ assert_eq!(quoted_string(r#""a"#), None);
2571+ assert_eq!(quoted_string(r#""""#), Some(""));
2572+ }
2573+
2574+ #[test]
2575+ fn escaped_commas_and_brackets_stay_in_the_value() {
2576+ let tree = parse("@el [transition opacity 1s\\, color 1s, content \"]\", width 4\\]] x\n");
2577+ let NodeKind::Element(line) = &tree.nodes[0].kind else {
2578+ panic!()
2579+ };
2580+ let attrs = &line.chain[0].attrs.as_ref().unwrap().attrs;
2581+ let raw: Vec<&str> = attrs.iter().map(|a| a.raw.as_str()).collect();
2582+ assert_eq!(
2583+ raw,
2584+ [
2585+ r"transition opacity 1s\, color 1s",
2586+ r#"content "]""#,
2587+ r"width 4\]"
2588+ ]
2589+ );
2590+ assert_eq!(line.text.as_ref().unwrap().raw, "x");
2591+ }
2592+
2593+ #[test]
2594+ fn a_let_is_quoted_only_when_it_is_one_string() {
2595+ let tree = parse("@let a \"x \\\" y\"\n@let b \"h h\" \"s m\"\n");
2596+ let forms: Vec<&LetForm> = tree
2597+ .nodes
2598+ .iter()
2599+ .map(|n| match &n.directive().unwrap().args {
2600+ DirectiveArgs::Let(def) => &def.form,
2601+ _ => panic!(),
2602+ })
2603+ .collect();
2604+ assert!(matches!(forms[0], LetForm::Quoted(arg) if arg.raw == r#"x \" y"#));
2605+ assert!(matches!(forms[1], LetForm::Value(arg) if arg.raw == r#""h h" "s m""#));
2606+ }
2607+
2608+ #[test]
2609+ fn inline_elements_and_escapes() {
2610+ let tree = parse("Read {@link /docs the {@b docs}} \\{@not} now\n");
2611+ let NodeKind::Text(text) = &tree.nodes[0].kind else {
2612+ panic!()
2613+ };
2614+ assert_eq!(text.segments.len(), 3);
2615+ let Segment::Inline(inline) = &text.segments[1] else {
2616+ panic!()
2617+ };
2618+ assert_eq!(inline.head.name, "link");
2619+ assert_eq!(inline.text.as_ref().unwrap().segments.len(), 2);
2620+ }
2621+
2622+ #[test]
2623+ fn the_text_of_code_and_textarea_has_no_inline_elements() {
2624+ let plain = |text: &Text| {
2625+ text.segments.len() == 1 && matches!(text.segments[0], Segment::Plain { .. })
2626+ };
2627+ // On the element's line and in a chain
2628+ let tree = parse("@code {@link /x y}\n@pre > @code {@b x}\n");
2629+ for node in &tree.nodes[..2] {
2630+ let NodeKind::Element(line) = &node.kind else {
2631+ panic!()
2632+ };
2633+ assert!(plain(line.text.as_ref().unwrap()), "{:?}", line.text);
2634+ }
2635+ // The lines under it are a verbatim body, shown as text, also at
2636+ // the end of a chain; @pre's own lines are htmlang
2637+ let tree = parse("@textarea\n {@b x}\n@pre > @code\n @b y\n -- z\n@pre\n @b w\n");
2638+ for (node, text) in [(0, "{@b x}"), (1, "@b y\n -- z")] {
2639+ let NodeKind::Verbatim(body) = &tree.nodes[node].children[0].kind else {
2640+ panic!("{:?}", tree.nodes[node].children)
2641+ };
2642+ assert!(body.escaped);
2643+ assert_eq!(body.text, text);
2644+ }
2645+ assert!(matches!(
2646+ tree.nodes[2].children[0].kind,
2647+ NodeKind::Element(_)
2648+ ));
2649+ assert!(tree.diagnostics.is_empty(), "{:?}", tree.diagnostics);
2650+ // Its line and a body together are an error
2651+ assert_eq!(codes(&parse("@code x\n y\n")), [code::UNEXPECTED_BODY]);
2652+ assert_eq!(
2653+ codes(&parse("@pre > @code x\n y\n")),
2654+ [code::UNEXPECTED_BODY]
2655+ );
2656+ // Inline: `{@code ...}`'s text is literal, the line around it isn't
2657+ let tree = parse("@h2 Write {@code {@link /x y}} or {@b {@code {@i z}}}\n");
2658+ let NodeKind::Element(line) = &tree.nodes[0].kind else {
2659+ panic!()
2660+ };
2661+ let heads: Vec<&str> = tree.nodes[0]
2662+ .heads()
2663+ .iter()
2664+ .map(|h| h.name.as_str())
2665+ .collect();
2666+ assert_eq!(heads, ["h2", "code", "b", "code"]);
2667+ let Segment::Inline(code) = &line.text.as_ref().unwrap().segments[1] else {
2668+ panic!()
2669+ };
2670+ assert!(plain(code.text.as_ref().unwrap()));
2671+ assert_eq!(code.text.as_ref().unwrap().raw, "{@link /x y}");
2672+ // Any other element's text is parsed
2673+ let tree = parse("@h1 Hello {@text [color red] world}\n");
2674+ assert_eq!(tree.nodes[0].heads().len(), 2);
2675+ }
2676+
2677+ #[test]
2678+ fn inline_attribute_lists_continue() {
2679+ let tree = parse("Press {@kbd [font-weight bold,\n color red] K} to go\n@text x\n");
2680+ assert_eq!(kinds(&tree.nodes), ["text", "element"]);
2681+ assert!(tree.diagnostics.is_empty());
2682+ }
2683+
2684+ #[test]
2685+ fn directives_follow_the_table() {
2686+ let tree = parse(
2687+ "@let @card [title, icon x]\n @el\n @children\n@if $a\n A\n@else if $b\n B\n@else\n C\n@each $x in 1..3\n $x\n@else\n none\n",
2688+ );
2689+ assert_eq!(
2690+ kinds(&tree.nodes),
2691+ ["let", "if", "else", "else", "each", "else"]
2692+ );
2693+ let defs = tree.definitions();
2694+ assert_eq!(defs[0].kind, DefinitionKind::Function);
2695+ assert_eq!(defs[0].params[1].default.as_deref(), Some("x"));
2696+ assert!(tree.diagnostics.is_empty(), "{:?}", tree.diagnostics);
2697+ }
2698+
2699+ #[test]
2700+ fn names_are_visible_to_the_end_of_their_block() {
2701+ let tree = parse(
2702+ "@let a 1\n@let @card [title]\n @let inner 2\n @el $title\n@if $a\n @let b [padding 4]\n @el x\n@each $x, $i in 1, 2\n @text $x\n@data $d {}\n@let t.greeting hi\n@el end\n",
2703+ );
2704+ let names = |line| {
2705+ tree.visible_at(line)
2706+ .iter()
2707+ .map(|v| v.name.to_string())
2708+ .collect::<Vec<_>>()
2709+ };
2710+ // In a function's body: its parameters, itself, and what is above it
2711+ assert_eq!(names(4), ["a", "card", "title", "inner"]);
2712+ assert_eq!(names(7), ["a", "card", "b"]);
2713+ assert_eq!(names(9), ["a", "card", "x", "i"]);
2714+ assert_eq!(names(12), ["a", "card", "d", "t"]);
2715+ assert_eq!(names(1), Vec::<String>::new());
2716+ let kinds: Vec<VisibleKind> = tree.visible_at(9).iter().map(|v| v.kind).collect();
2717+ assert_eq!(kinds[2], VisibleKind::Loop);
2718+ }
2719+
2720+ #[test]
2721+ fn a_file_of_definitions_only_is_a_library() {
2722+ let library = |src: &str| parse(src).is_library();
2723+ assert!(library(
2724+ "-- layout\n@let @layout\n @page Home\n @children\n\n@let gap 8\n"
2725+ ));
2726+ assert!(library("@let card [\n padding 8,\n color red\n]\n"));
2727+ assert!(!library("@let gap 8\n@text $gap\n"));
2728+ assert!(!library("@page Home\n@let gap 8\n"));
2729+ assert!(!library("@include layout.hl\n"));
2730+ assert!(library("@data $site {\"a\": 1}\n@let gap 8\n"));
2731+ // An included file counts when it is a library too
2732+ let with = |src: &str, included: bool| parse(src).is_library_with(&mut |_| included);
2733+ assert!(with("@include base.hl\n@let accent red\n", true));
2734+ assert!(!with("@include header.hl\n@let accent red\n", false));
2735+ assert!(!library("-- nothing\n\n"));
2736+ assert!(!library(""));
2737+ }
2738+
2739+ #[test]
2740+ fn a_let_says_its_kind_on_its_line() {
2741+ let tree = parse(
2742+ "@let a 1\n@let b [padding 4]\n@let @c [p, q two words]\n @el\n@let @d\n @el\n@let @e [\n x,\n y 1\n]\n @el\n",
2743+ );
2744+ assert!(tree.diagnostics.is_empty(), "{:?}", tree.diagnostics);
2745+ let defs = tree.definitions();
2746+ let kinds: Vec<_> = defs.iter().map(|d| (d.name, d.kind)).collect();
2747+ assert_eq!(
2748+ kinds,
2749+ [
2750+ ("a", DefinitionKind::Value),
2751+ ("b", DefinitionKind::Bundle),
2752+ ("c", DefinitionKind::Function),
2753+ ("d", DefinitionKind::Function),
2754+ ("e", DefinitionKind::Function),
2755+ ]
2756+ );
2757+ // A bare word is required; `name value` has a default, spaces and all
2758+ let c = &defs[2];
2759+ assert_eq!(
2760+ (c.params[0].name.as_str(), c.params[0].default.as_deref()),
2761+ ("p", None)
2762+ );
2763+ assert_eq!(c.params[1].default.as_deref(), Some("two words"));
2764+ // The name's span leaves out the `@`
2765+ assert_eq!((c.name_span.column, c.params[1].name_span.column), (6, 12));
2766+ assert!(defs[3].params.is_empty());
2767+ let e: Vec<_> = defs[4]
2768+ .params
2769+ .iter()
2770+ .map(|p| (p.name.as_str(), p.name_span.line))
2771+ .collect();
2772+ assert_eq!(e, [("x", 8), ("y", 9)]);
2773+ }
2774+
2775+ #[test]
2776+ fn verbatim_bodies() {
2777+ let tree = parse("@style\n :root {\n --brand: red;\n }\n\n@raw <hr>\n@text x\n");
2778+ assert_eq!(kinds(&tree.nodes), ["style", "blank", "raw", "element"]);
2779+ let [child] = tree.nodes[0].children.as_slice() else {
2780+ panic!()
2781+ };
2782+ let NodeKind::Verbatim(body) = &child.kind else {
2783+ panic!()
2784+ };
2785+ assert_eq!(body.text, ":root {\n --brand: red;\n}");
2786+ }
2787+
2788+ #[test]
2789+ fn multi_line_inline_json() {
2790+ let tree = parse("@data $x {\n \"a\": [1, 2],\n \"b\": \"]\"\n}\n@text $x.a\n");
2791+ assert_eq!(kinds(&tree.nodes), ["data", "element"]);
2792+ let Some(Directive {
2793+ args: DirectiveArgs::Data { source, .. },
2794+ ..
2795+ }) = tree.nodes[0].directive()
2796+ else {
2797+ panic!()
2798+ };
2799+ assert!(source.raw.ends_with('}'));
2800+ }
2801+
2802+ #[test]
2803+ fn the_leading_token_keeps_quotes_and_expressions_whole() {
2804+ fn token(s: &str) -> &str {
2805+ &s[..leading_token_len(s)]
2806+ }
2807+ assert_eq!(token("/about About us"), "/about");
2808+ assert_eq!(token("$url More"), "$url");
2809+ assert_eq!(token("/page/${$n + 1} Next"), "/page/${$n + 1}");
2810+ assert_eq!(token("${ {\"a\": 1} } x"), "${ {\"a\": 1} }");
2811+ assert_eq!(token("\"my page.html\" Open"), "\"my page.html\"");
2812+ assert_eq!(token("\"a \\\" b\" c"), "\"a \\\" b\"");
2813+ assert_eq!(token("a\\,b c"), "a\\,b");
2814+ assert_eq!(token("${unclosed x"), "${unclosed");
2815+ assert_eq!(token("\"unclosed x"), "\"unclosed x");
2816+ assert_eq!(token("single"), "single");
2817+
2818+ let tree = parse("@link /page/${$n + 1} Next page\n");
2819+ let NodeKind::Element(line) = &tree.nodes[0].kind else {
2820+ panic!("an element")
2821+ };
2822+ let (token, rest) = line.text.as_ref().unwrap().split_leading();
2823+ assert_eq!(token.raw, "/page/${$n + 1}");
2824+ assert_eq!(token.span.column, 6);
2825+ let rest = rest.unwrap();
2826+ assert_eq!(rest.raw, "Next page");
2827+ assert_eq!(rest.span.column, 22);
2828+ }
2829+
2830+ #[test]
2831+ fn body_kinds_are_checked() {
2832+ let tree = parse("@page Home\n @text x\n@meta a b\n-- fine\n");
2833+ assert_eq!(codes(&tree), [code::UNEXPECTED_BODY]);
2834+ assert_eq!(tree.diagnostics[0].line, 2);
2835+ let tree = parse("@let x = 1\n @text y\n");
2836+ assert_eq!(codes(&tree), [code::UNEXPECTED_BODY]);
2837+ let tree = parse("@raw <hr>\n <br>\n");
2838+ assert_eq!(codes(&tree), [code::UNEXPECTED_BODY]);
2839+ let tree = parse("@style x\n a {}\n");
2840+ assert_eq!(codes(&tree), [code::UNEXPECTED_BODY]);
2841+ }
2842+
2843+ #[test]
2844+ fn verbatim_directives_take_their_line_and_no_attributes() {
2845+ // The rest of the line is the one-line body (or @markdown's file)
2846+ for src in [
2847+ "@style .a { color: red }\n",
2848+ "@head <meta name=x>\n",
2849+ "@raw <hr>\n",
2850+ "@markdown notes.md\n",
2851+ ] {
2852+ let tree = parse(src);
2853+ assert!(
2854+ tree.diagnostics.is_empty(),
2855+ "{}: {:?}",
2856+ src,
2857+ tree.diagnostics
2858+ );
2859+ let Some(DirectiveArgs::Text(Some(arg))) = tree.nodes[0].directive().map(|d| &d.args)
2860+ else {
2861+ panic!("{}", src)
2862+ };
2863+ assert_eq!(arg.raw, src.split_once(' ').unwrap().1.trim_end());
2864+ }
2865+ // `[` right after the name is an attribute list, which is an error;
2866+ // the text after it is still the line's content
2867+ for name in ["style", "head", "raw", "markdown"] {
2868+ let tree = parse(&format!("@{} [id=x] rest\n", name));
2869+ assert_eq!(codes(&tree), [code::UNEXPECTED_ARGUMENT], "@{}", name);
2870+ assert_eq!(tree.diagnostics[0].column, Some(name.len() + 2));
2871+ let Some(DirectiveArgs::Text(Some(arg))) = tree.nodes[0].directive().map(|d| &d.args)
2872+ else {
2873+ panic!("@{}", name)
2874+ };
2875+ assert_eq!(arg.raw, "rest");
2876+ }
2877+ // A line and a block together: @markdown's line is a file
2878+ let tree = parse("@markdown notes.md\n # Title\n");
2879+ assert_eq!(codes(&tree), [code::UNEXPECTED_BODY]);
2880+ assert!(
2881+ tree.diagnostics[0]
2882+ .message
2883+ .contains("a file named on its line"),
2884+ "{}",
2885+ tree.diagnostics[0].message
2886+ );
2887+ // In the indented block, `[` is content
2888+ assert!(
2889+ parse("@style\n [hidden] { display: none }\n")
2890+ .diagnostics
2891+ .is_empty()
2892+ );
2893+ }
2894+
2895+ #[test]
2896+ fn syntax_errors() {
2897+ assert_eq!(codes(&parse("@else\n x\n")), [code::STRAY_ELSE]);
2898+ assert_eq!(codes(&parse("@if\n x\n")), [code::MISSING_ARGUMENT]);
2899+ assert_eq!(codes(&parse("@each $x\n x\n")), [code::INVALID_LOOP]);
2900+ assert_eq!(
2901+ codes(&parse("@el [padding 4\n@text x\n")),
2902+ [code::UNCLOSED_BRACKET]
2903+ );
2904+ assert_eq!(codes(&parse("@data x.json\n")), [code::MISSING_ARGUMENT]);
2905+ }
2906+
2907+ #[test]
2908+ fn node_lookup_and_extent() {
2909+ let tree = parse("@el [\n padding 4\n]\n @text a\n\n@text b\n");
2910+ assert_eq!(tree.nodes[0].end_line(), 4);
2911+ assert_eq!(tree.node_at_line(2).map(|n| n.span.line), Some(1));
2912+ assert_eq!(tree.node_at_line(4).map(|n| n.span.line), Some(4));
2913+ }
2914+
2915+ #[test]
2916+ fn a_key_ends_at_the_first_space_outside_parentheses() {
2917+ let split = |raw: &str| {
2918+ let (key, value, _) = split_attribute(raw);
2919+ (key, value)
2920+ };
2921+ let pair = |k: &str, v: &str| (k.to_string(), Some(v.to_string()));
2922+ assert_eq!(
2923+ split("has(> img):padding 0"),
2924+ pair("has(> img):padding", "0")
2925+ );
2926+ assert_eq!(
2927+ split("is(:hover, .a b):color red"),
2928+ pair("is(:hover, .a b):color", "red")
2929+ );
2930+ assert_eq!(
2931+ split("grid-template-columns repeat(2, 1fr)"),
2932+ pair("grid-template-columns", "repeat(2, 1fr)")
2933+ );
2934+ // A quoted `)` inside the argument doesn't close it
2935+ assert_eq!(
2936+ split("not([title=\") x\"]):color red"),
2937+ pair("not([title=\") x\"]):color", "red")
2938+ );
2939+ // A `(` never closed: the first space, as before
2940+ assert_eq!(split("has(.a:color red"), pair("has(.a:color", "red"));
2941+ assert_eq!(split("hover:bold"), ("hover:bold".to_string(), None));
2942+ }
2943+}
crates/htmlang-core/src/value.rsnew file+406
@@ -0,0 +1,406 @@
1+//! Values: what a `$name` holds, and the rules every part of htmlang
2+//! applies to them (truthiness, comparison, how a value prints).
3+//!
4+//! A value is text, a number, `true` or `false`, a list or a record. A
5+//! `@let`, a parameter, `@each` and `@data` bind a whole value to a name,
6+//! so a list stays a list and a record a record wherever it is passed.
7+//!
8+//! - **Text** is what the source (or a JSON string) says. Written without
9+//! quotes, it reads as a number when it is one (`3`, `0.5`) and as false
10+//! when it is `false`, since that is how htmlang writes numbers and flags
11+//! (`@let gap 8`, `@card [dot false]`). **Quoted text** (`"0"`) is always
12+//! text, and a CSS value writes it with its quotes.
13+//! - **Numbers** come from arithmetic, ranges, `length()` and an `@each`
14+//! index, and print without float noise: at most four decimals.
15+//! - **Lists** come from commas in the source (`apple, banana`), from a
16+//! range (`1..5`), from JSON arrays and from list functions. A list
17+//! written in the source prints as it was written; any other prints its
18+//! items joined with `, `.
19+//! - **Records** come from JSON objects (and `@let name.field value`); a
20+//! record has no text of its own, and a field it doesn't have is empty.
21+//!
22+//! False: `false`, empty text, `0` (as a number or as unquoted text), an
23+//! empty list and an empty record. Everything else is true.
24+//!
25+//! `==` and `!=` compare numbers as numbers (`1.0 == 1`), lists and records
26+//! item by item, and anything else as text, exactly (`#FFF != #fff`). `<`,
27+//! `>`, `<=` and `>=` compare numbers as numbers and text by character
28+//! order; a list or a record can't be ordered.
29+
30+use std::fmt;
31+use std::rc::Rc;
32+
33+use crate::ast::Quoted;
34+
35+#[derive(Debug, Clone, PartialEq)]
36+pub enum Value {
37+ /// Text, as written or loaded.
38+ Str(String),
39+ /// Quoted text: what it says, and how a CSS value writes it.
40+ Quoted(Quoted),
41+ Num(f64),
42+ Bool(bool),
43+ List(List),
44+ /// A record's fields, in order.
45+ Record(Rc<Vec<(String, Value)>>),
46+}
47+
48+/// A list's items, and how the source wrote it, which is how it prints.
49+#[derive(Debug, Clone, PartialEq)]
50+pub struct List {
51+ pub items: Rc<Vec<Value>>,
52+ pub written: Option<Rc<str>>,
53+}
54+
55+/// The most items a range may have, so a typo can't exhaust memory.
56+pub const MAX_RANGE: usize = 100_000;
57+
58+impl Value {
59+ /// Empty text: what a field a record doesn't have holds.
60+ pub fn empty() -> Value {
61+ Value::Str(String::new())
62+ }
63+
64+ /// A list of `items`, which prints them joined with `, `.
65+ pub fn list(items: Vec<Value>) -> Value {
66+ Value::List(List {
67+ items: Rc::new(items),
68+ written: None,
69+ })
70+ }
71+
72+ /// See the module documentation.
73+ pub fn truthy(&self) -> bool {
74+ match self {
75+ Value::Bool(b) => *b,
76+ Value::Num(n) => *n != 0.0 && !n.is_nan(),
77+ Value::Str(s) => !(s.is_empty() || s == "false" || parse_number(s) == Some(0.0)),
78+ Value::Quoted(q) => !q.text.is_empty(),
79+ Value::List(list) => !list.items.is_empty(),
80+ Value::Record(fields) => !fields.is_empty(),
81+ }
82+ }
83+
84+ /// The number a value is: a number, or unquoted text that is one.
85+ pub fn as_num(&self) -> Option<f64> {
86+ match self {
87+ Value::Num(n) => Some(*n),
88+ Value::Str(s) => parse_number(s),
89+ _ => None,
90+ }
91+ }
92+
93+ /// Whether `.field` reads into it: a record or a list.
94+ pub fn has_fields(&self) -> bool {
95+ matches!(self, Value::Record(_) | Value::List(_))
96+ }
97+
98+ /// The field `name` of a record, or the item at index `name` of a list:
99+ /// empty when there is none. `None` for a value without fields.
100+ pub fn field(&self, name: &str) -> Option<Value> {
101+ match self {
102+ Value::Record(fields) => Some(
103+ fields
104+ .iter()
105+ .find(|(key, _)| key == name)
106+ .map_or_else(Value::empty, |(_, value)| value.clone()),
107+ ),
108+ Value::List(list) => Some(
109+ name.parse::<usize>()
110+ .ok()
111+ .and_then(|i| list.items.get(i).cloned())
112+ .unwrap_or_else(Value::empty),
113+ ),
114+ _ => None,
115+ }
116+ }
117+
118+ /// How CSS writes it, when it is quoted text.
119+ pub fn quoted_css(&self) -> Option<&str> {
120+ match self {
121+ Value::Quoted(q) => Some(&q.css),
122+ _ => None,
123+ }
124+ }
125+
126+ /// What kind of value it is, for messages: `a list of 3 items`.
127+ pub fn describe(&self) -> String {
128+ match self {
129+ Value::Str(_) | Value::Quoted(_) => "text".to_string(),
130+ Value::Num(_) => "a number".to_string(),
131+ Value::Bool(_) => "true or false".to_string(),
132+ Value::List(list) => match list.items.len() {
133+ 1 => "a list of 1 item".to_string(),
134+ n => format!("a list of {} items", n),
135+ },
136+ Value::Record(_) => "a record".to_string(),
137+ }
138+ }
139+
140+ /// `==`: see the module documentation.
141+ pub fn equals(&self, other: &Value) -> bool {
142+ if let (Some(a), Some(b)) = (self.as_num(), other.as_num()) {
143+ return a == b;
144+ }
145+ match (self, other) {
146+ (Value::List(a), Value::List(b)) => {
147+ a.items.len() == b.items.len()
148+ && a.items.iter().zip(b.items.iter()).all(|(x, y)| x.equals(y))
149+ }
150+ (Value::Record(a), Value::Record(b)) => {
151+ a.len() == b.len()
152+ && a.iter().all(|(key, x)| {
153+ b.iter()
154+ .find(|(k, _)| k == key)
155+ .is_some_and(|(_, y)| x.equals(y))
156+ })
157+ }
158+ (Value::List(_) | Value::Record(_), _) | (_, Value::List(_) | Value::Record(_)) => {
159+ false
160+ }
161+ _ => self.to_string() == other.to_string(),
162+ }
163+ }
164+
165+ /// A comparison operator (`==`, `!=`, `<`, `>`, `<=`, `>=`).
166+ pub fn compare(&self, op: &str, other: &Value) -> Result<bool, String> {
167+ match op {
168+ "==" => return Ok(self.equals(other)),
169+ "!=" => return Ok(!self.equals(other)),
170+ _ => {}
171+ }
172+ let order = match (self.as_num(), other.as_num()) {
173+ (Some(a), Some(b)) => a.partial_cmp(&b),
174+ _ => {
175+ for side in [self, other] {
176+ if matches!(side, Value::List(_) | Value::Record(_)) {
177+ return Err(format!(
178+ "`{}` compares numbers or text, not {}",
179+ op,
180+ side.describe()
181+ ));
182+ }
183+ }
184+ Some(self.to_string().cmp(&other.to_string()))
185+ }
186+ };
187+ let Some(order) = order else {
188+ return Ok(false);
189+ };
190+ Ok(match op {
191+ "<" => order.is_lt(),
192+ ">" => order.is_gt(),
193+ "<=" => order.is_le(),
194+ ">=" => order.is_ge(),
195+ _ => return Err(format!("unknown comparison `{}`", op)),
196+ })
197+ }
198+}
199+
200+impl fmt::Display for Value {
201+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
202+ match self {
203+ Value::Str(s) => f.write_str(s),
204+ Value::Quoted(q) => f.write_str(&q.text),
205+ Value::Num(n) => f.write_str(&format_number(*n)),
206+ Value::Bool(b) => write!(f, "{}", b),
207+ Value::List(list) => match &list.written {
208+ Some(written) => f.write_str(written),
209+ None => {
210+ // A record in it has no text of its own
211+ let items: Vec<String> = list
212+ .items
213+ .iter()
214+ .filter(|item| !matches!(item, Value::Record(_)))
215+ .map(Value::to_string)
216+ .filter(|s| !s.is_empty())
217+ .collect();
218+ f.write_str(&items.join(", "))
219+ }
220+ },
221+ // A record has no text of its own
222+ Value::Record(_) => Ok(()),
223+ }
224+ }
225+}
226+
227+/// A number as htmlang prints it: a whole number without decimals, any
228+/// other rounded to at most four decimals, so `100 / 3` is `33.3333`.
229+pub fn format_number(n: f64) -> String {
230+ if !n.is_finite() {
231+ return "0".to_string();
232+ }
233+ let rounded = (n * 10_000.0).round() / 10_000.0;
234+ if rounded.fract() == 0.0 && rounded.abs() < 1e15 {
235+ // `-0` is `0`
236+ return format!("{}", rounded as i64);
237+ }
238+ format!("{}", rounded)
239+}
240+
241+/// The number text is, when it is written as one: digits with an optional
242+/// sign, point and exponent (`3`, `-0.5`, `.5`, `1e3`), and nothing else,
243+/// so `inf` or `10px` aren't numbers.
244+pub fn parse_number(text: &str) -> Option<f64> {
245+ let s = text.trim();
246+ let digits = s.strip_prefix(['-', '+']).unwrap_or(s);
247+ if !digits.starts_with(|c: char| c.is_ascii_digit() || c == '.')
248+ || !digits
249+ .chars()
250+ .all(|c| c.is_ascii_digit() || matches!(c, '.' | 'e' | 'E' | '+' | '-'))
251+ {
252+ return None;
253+ }
254+ s.parse::<f64>().ok().filter(|n| n.is_finite())
255+}
256+
257+/// The whole numbers from `start` to `end`, both included, `step` apart:
258+/// counting down when `start` is greater than `end`.
259+pub fn range(start: f64, end: f64, step: f64) -> Result<Value, String> {
260+ // Exact as whole numbers up to 2^53
261+ let whole = |n: f64| n.fract() == 0.0 && n.abs() <= 9_007_199_254_740_992.0;
262+ if !whole(start) || !whole(end) {
263+ return Err(format!(
264+ "a range goes from one whole number to another, not `{}..{}`",
265+ format_number(start),
266+ format_number(end)
267+ ));
268+ }
269+ if !whole(step) || step < 1.0 {
270+ return Err(format!(
271+ "a range's step is a whole number above 0, not `{}`",
272+ format_number(step)
273+ ));
274+ }
275+ whole_range(start as i64, end as i64, step as i64)
276+}
277+
278+/// [`range`] of whole numbers. A number too large for a number value to
279+/// hold exactly is text, which still reads as that number.
280+pub fn whole_range(start: i64, end: i64, step: i64) -> Result<Value, String> {
281+ if step < 1 {
282+ return Err(format!(
283+ "a range's step is a whole number above 0, not `{}`",
284+ step
285+ ));
286+ }
287+ let count = (start.abs_diff(end) / step.unsigned_abs()) as usize + 1;
288+ if count > MAX_RANGE {
289+ return Err(format!(
290+ "the range `{}..{}` has {} items, more than the {} a range may have",
291+ start, end, count, MAX_RANGE
292+ ));
293+ }
294+ let exact = |n: i64| n.unsigned_abs() <= 1 << 53;
295+ let mut items = Vec::with_capacity(count);
296+ let mut n = start;
297+ for i in 0..count {
298+ items.push(match exact(n) {
299+ true => Value::Num(n as f64),
300+ false => Value::Str(n.to_string()),
301+ });
302+ if i + 1 < count {
303+ n = match start > end {
304+ true => n - step,
305+ false => n + step,
306+ };
307+ }
308+ }
309+ Ok(Value::list(items))
310+}
311+
312+/// A range written as a whole value, `A..B` or `A..B step N` with whole
313+/// numbers (after its variables are filled in): `None` when `text` isn't
314+/// one.
315+pub fn written_range(text: &str) -> Option<Result<Value, String>> {
316+ let (start, rest) = text.trim().split_once("..")?;
317+ let (end, step) = match rest.split_once(" step ") {
318+ Some((end, step)) => (end, Some(step)),
319+ None => (rest, None),
320+ };
321+ let whole = |s: &str| s.trim().parse::<i64>().ok();
322+ let (start, end) = (whole(start)?, whole(end)?);
323+ let step = match step {
324+ Some(step) => whole(step)?,
325+ None => 1,
326+ };
327+ Some(whole_range(start, end, step).map(|value| match value {
328+ Value::List(list) => Value::List(List {
329+ written: Some(text.trim().into()),
330+ ..list
331+ }),
332+ other => other,
333+ }))
334+}
335+
336+#[cfg(test)]
337+mod tests {
338+ use super::*;
339+
340+ fn text(s: &str) -> Value {
341+ Value::Str(s.to_string())
342+ }
343+
344+ #[test]
345+ fn truthiness_is_defined_once() {
346+ for falsy in [
347+ text(""),
348+ text("false"),
349+ text("0"),
350+ text("0.0"),
351+ Value::Num(0.0),
352+ Value::Bool(false),
353+ Value::list(vec![]),
354+ ] {
355+ assert!(!falsy.truthy(), "{:?}", falsy);
356+ }
357+ let quoted_zero = Value::Quoted(Quoted {
358+ text: "0".into(),
359+ css: "\"0\"".into(),
360+ });
361+ for truthy in [text("no"), text("False"), text("0px"), quoted_zero] {
362+ assert!(truthy.truthy(), "{:?}", truthy);
363+ }
364+ }
365+
366+ #[test]
367+ fn comparison() {
368+ assert!(text("1.0").equals(&Value::Num(1.0)));
369+ assert!(!text("#FFF").equals(&text("#fff")));
370+ assert!(Value::Bool(true).equals(&text("true")));
371+ assert_eq!(text("2").compare("<", &text("10")), Ok(true));
372+ assert_eq!(text("b").compare(">", &text("a")), Ok(true));
373+ assert!(Value::list(vec![]).compare("<", &text("a")).is_err());
374+ // `inf` and `10px` are text
375+ assert_eq!(parse_number("inf"), None);
376+ assert_eq!(parse_number("10px"), None);
377+ assert_eq!(parse_number(" -.5 "), Some(-0.5));
378+ }
379+
380+ #[test]
381+ fn numbers_print_without_float_noise() {
382+ assert_eq!(format_number(100.0 / 3.0), "33.3333");
383+ assert_eq!(format_number(0.1 + 0.2), "0.3");
384+ assert_eq!(format_number(-0.0), "0");
385+ assert_eq!(format_number(3.5), "3.5");
386+ assert_eq!(format_number(16.0), "16");
387+ }
388+
389+ #[test]
390+ fn ranges() {
391+ let items = |v: Value| match v {
392+ Value::List(list) => list.items.iter().map(Value::to_string).collect::<Vec<_>>(),
393+ other => panic!("{:?}", other),
394+ };
395+ assert_eq!(items(range(1.0, 3.0, 1.0).unwrap()), ["1", "2", "3"]);
396+ assert_eq!(items(range(10.0, 0.0, 5.0).unwrap()), ["10", "5", "0"]);
397+ assert!(range(1.0, 5.0, 0.0).is_err());
398+ assert!(range(0.5, 5.0, 1.0).is_err());
399+ assert!(range(0.0, 1e9, 1.0).is_err());
400+ let written = written_range(" 1..5 step 2").unwrap().unwrap();
401+ assert_eq!(written.to_string(), "1..5 step 2");
402+ assert_eq!(items(written), ["1", "3", "5"]);
403+ assert!(written_range("a..b").is_none());
404+ assert!(written_range("1..2..3").is_none());
405+ }
406+}
crates/htmlang-core/src/vocab.rsnew file+891

This diff is too big to show here.

crates/htmlang-wasm/Cargo.tomlnew file+11

This diff is too big to show here.

crates/htmlang-wasm/playground/index.htmlnew file+113

This diff is too big to show here.

crates/htmlang-wasm/src/lib.rsnew file+91

This diff is too big to show here.

editors/vscode/README.mdnew file+115

This diff is too big to show here.

editors/vscode/package.json+33−1

This diff is too big to show here.

editors/vscode/snippets/htmlang.json+256−192

This diff is too big to show here.

editors/vscode/src/extension.ts+112−4

This diff is too big to show here.

editors/vscode/syntaxes/htmlang.tmLanguage.json+346−64

This diff is too big to show here.

examples/blog.hlnew file+86

This diff is too big to show here.

examples/blog.html.mapnew file+1

This diff is too big to show here.

examples/demo.hl+299−37

This diff is too big to show here.

examples/demo.html+800−1

This diff is too big to show here.

examples/demo.html.mapnew file+1

This diff is too big to show here.

examples/docs.hlnew file+146

This diff is too big to show here.

examples/docs.html.mapnew file+1

This diff is too big to show here.

examples/landing.hlnew file+136

This diff is too big to show here.

examples/landing.html.mapnew file+1

This diff is too big to show here.

examples/posts.jsonnew file+27

This diff is too big to show here.

src/ast.rsdeleted−163

This diff is too big to show here.

src/bin/htmlang_lsp/analysis.rs+1419−916

This diff is too big to show here.

src/bin/htmlang_lsp/completion.rs+1947−807

This diff is too big to show here.

src/bin/htmlang_lsp/docs.rsnew file+616

This diff is too big to show here.

src/bin/htmlang_lsp/hover.rs+343−488

This diff is too big to show here.

src/bin/htmlang_lsp/main.rs+637−238

This diff is too big to show here.

src/bin/htmlang_lsp/navigation.rs+596−245

This diff is too big to show here.

src/bin/htmlang_lsp/state.rsnew file+315

This diff is too big to show here.

src/bin/htmlang_lsp/tree.rsnew file+222

This diff is too big to show here.

src/cli.rsnew file+92

This diff is too big to show here.

src/codegen.rsdeleted−3142

This diff is too big to show here.

src/convert.rsdeleted−1310

This diff is too big to show here.

src/fmt.rs+499−236

This diff is too big to show here.

src/lib.rs+7−4

This diff is too big to show here.

src/main.rs+980−2942

This diff is too big to show here.

src/parser.rsdeleted−5135

This diff is too big to show here.

src/serve.rs+290−107

This diff is too big to show here.

tests/common/mod.rsnew file+140

This diff is too big to show here.

tests/docs.rsnew file+198

This diff is too big to show here.

tests/editor.rsnew file+157

This diff is too big to show here.

tests/fmt.rsnew file+55

This diff is too big to show here.

tests/regressions.rsnew file+2471

This diff is too big to show here.

tests/snapshots.rs+5759−1031

This diff is too big to show here.

tests/snapshots/accessibility.hl+5−5

This diff is too big to show here.

tests/snapshots/accessibility.htmlnew file+1

This diff is too big to show here.

tests/snapshots/alignment.hl+1−1

This diff is too big to show here.

tests/snapshots/alignment.htmlnew file+1

This diff is too big to show here.

tests/snapshots/anchor_positioning.htmlnew file+1

This diff is too big to show here.

tests/snapshots/animate_shorthand.hl+13−9

This diff is too big to show here.

tests/snapshots/animate_shorthand.htmlnew file+1

This diff is too big to show here.

tests/snapshots/animations.hl+9−5

This diff is too big to show here.

tests/snapshots/animations.htmlnew file+1

This diff is too big to show here.

tests/snapshots/arithmetic.hl+4−4

This diff is too big to show here.

tests/snapshots/arithmetic.htmlnew file+1

This diff is too big to show here.

tests/snapshots/assert_directive.hldeleted−10

This diff is too big to show here.

tests/snapshots/attributes.hl+5−5

This diff is too big to show here.

tests/snapshots/attributes.htmlnew file+1

This diff is too big to show here.

tests/snapshots/basic_elements.hl+2−2

This diff is too big to show here.

tests/snapshots/basic_elements.htmlnew file+1

This diff is too big to show here.

tests/snapshots/breadcrumb.hldeleted−4

This diff is too big to show here.

tests/snapshots/chain_operator.hl+1−1

This diff is too big to show here.

tests/snapshots/chain_operator.htmlnew file+1

This diff is too big to show here.

tests/snapshots/clamp_css.hl+1−1

This diff is too big to show here.

tests/snapshots/clamp_css.htmlnew file+1

This diff is too big to show here.

tests/snapshots/code_samples.hlnew file+28

This diff is too big to show here.

tests/snapshots/code_samples.htmlnew file+5

This diff is too big to show here.

tests/snapshots/color_scheme.hl+1−1

This diff is too big to show here.

tests/snapshots/color_scheme.htmlnew file+1

This diff is too big to show here.

tests/snapshots/colour_variants.hlnew file+12

This diff is too big to show here.

tests/snapshots/colour_variants.htmlnew file+1

This diff is too big to show here.

tests/snapshots/compat_test.hl+1−1

This diff is too big to show here.

tests/snapshots/computed_let.hl+3−3

This diff is too big to show here.

tests/snapshots/computed_let.htmlnew file+1

This diff is too big to show here.

tests/snapshots/conditionals.htmlnew file+1

This diff is too big to show here.

tests/snapshots/container_queries.hl+2−2

This diff is too big to show here.

tests/snapshots/container_queries.htmlnew file+1

This diff is too big to show here.

tests/snapshots/convert_basic.hl+1−1

This diff is too big to show here.

tests/snapshots/css_property.hl+6−4

This diff is too big to show here.

tests/snapshots/css_property.htmlnew file+1

This diff is too big to show here.

tests/snapshots/css_shorthands.hl+7−10

This diff is too big to show here.

tests/snapshots/css_shorthands.htmlnew file+1

This diff is too big to show here.

tests/snapshots/css_units.hl+3−3

This diff is too big to show here.

tests/snapshots/css_units.htmlnew file+1

This diff is too big to show here.

tests/snapshots/css_vars.hl+5−5

This diff is too big to show here.

tests/snapshots/css_vars.htmlnew file+1

This diff is too big to show here.

tests/snapshots/custom_properties.hlnew file+47

This diff is too big to show here.

tests/snapshots/custom_properties.htmlnew file+1

This diff is too big to show here.

tests/snapshots/dark_mode.hl+2−2

This diff is too big to show here.

tests/snapshots/dark_mode.htmlnew file+1

This diff is too big to show here.

tests/snapshots/data_directive.hl+7−6

This diff is too big to show here.

tests/snapshots/data_directive.htmlnew file+1

This diff is too big to show here.

tests/snapshots/direction_attr.htmlnew file+1

This diff is too big to show here.

tests/snapshots/each_destructuring.hl+4−3

This diff is too big to show here.

tests/snapshots/each_destructuring.htmlnew file+1

This diff is too big to show here.

tests/snapshots/each_else.hl+2−2

This diff is too big to show here.

tests/snapshots/each_else.htmlnew file+1

This diff is too big to show here.

tests/snapshots/each_index.htmlnew file+1

This diff is too big to show here.

tests/snapshots/each_range.htmlnew file+1

This diff is too big to show here.

tests/snapshots/each_step.hl+4−4

This diff is too big to show here.

tests/snapshots/each_step.htmlnew file+1

This diff is too big to show here.

tests/snapshots/element_prefixes.hlnew file+42

This diff is too big to show here.

tests/snapshots/element_prefixes.htmlnew file+3

This diff is too big to show here.

tests/snapshots/else_if.htmlnew file+1

This diff is too big to show here.

tests/snapshots/env_directive.hl+1−1

This diff is too big to show here.

tests/snapshots/env_directive.htmlnew file+1

This diff is too big to show here.

tests/snapshots/escapes_and_quotes.hlnew file+19

This diff is too big to show here.

tests/snapshots/escapes_and_quotes.htmlnew file+1

This diff is too big to show here.

tests/snapshots/extra_css.hl+3−3

This diff is too big to show here.

tests/snapshots/extra_css.htmlnew file+1

This diff is too big to show here.

tests/snapshots/fn_defaults.hl+2−2

This diff is too big to show here.

tests/snapshots/fn_defaults.htmlnew file+1

This diff is too big to show here.

tests/snapshots/form_elements.hl+9−9

This diff is too big to show here.

tests/snapshots/form_elements.htmlnew file+1

This diff is too big to show here.

tests/snapshots/fragment.hl+1−1

This diff is too big to show here.

tests/snapshots/fragment.htmlnew file+1

This diff is too big to show here.

tests/snapshots/function_calls.hlnew file+66

This diff is too big to show here.

tests/snapshots/function_calls.htmlnew file+1

This diff is too big to show here.

tests/snapshots/function_definitions.hlnew file+35

This diff is too big to show here.

tests/snapshots/function_definitions.htmlnew file+1

This diff is too big to show here.

tests/snapshots/functions.hl+5−5

This diff is too big to show here.

tests/snapshots/functions.htmlnew file+1

This diff is too big to show here.

tests/snapshots/grid_areas.hl+1−1

This diff is too big to show here.

tests/snapshots/grid_areas.htmlnew file+1

This diff is too big to show here.

tests/snapshots/has_pseudo.hl+2−2

This diff is too big to show here.

tests/snapshots/has_pseudo.htmlnew file+1

This diff is too big to show here.

tests/snapshots/hidden_attr.hl+1−1

This diff is too big to show here.

tests/snapshots/hidden_attr.htmlnew file+1

This diff is too big to show here.

tests/snapshots/html_elements.hlnew file+42

This diff is too big to show here.

tests/snapshots/html_elements.htmlnew file+1

This diff is too big to show here.

tests/snapshots/if_expr.hl+21−3

This diff is too big to show here.

tests/snapshots/if_expr.htmlnew file+1

This diff is too big to show here.

tests/snapshots/implicit_el.hldeleted−7

This diff is too big to show here.

tests/snapshots/initial_letter.htmlnew file+1

This diff is too big to show here.

tests/snapshots/inline_text.hl+2−2

This diff is too big to show here.

tests/snapshots/inline_text.htmlnew file+1

This diff is too big to show here.

tests/snapshots/lang_directive.hl+1−2

This diff is too big to show here.

tests/snapshots/lang_directive.htmlnew file+1

This diff is too big to show here.

tests/snapshots/layer_wrapping.htmlnew file+1

This diff is too big to show here.

tests/snapshots/layout_direction.hlnew file+33

This diff is too big to show here.

tests/snapshots/layout_direction.htmlnew file+1

This diff is too big to show here.

tests/snapshots/layout_modes.hlnew file+44

This diff is too big to show here.

tests/snapshots/layout_modes.htmlnew file+2

This diff is too big to show here.

tests/snapshots/leading_argument.hlnew file+50

This diff is too big to show here.

tests/snapshots/leading_argument.htmlnew file+1

This diff is too big to show here.

tests/snapshots/list_elements.hl+11−11

This diff is too big to show here.

tests/snapshots/list_elements.htmlnew file+1

This diff is too big to show here.

tests/snapshots/loops.htmlnew file+1

This diff is too big to show here.

tests/snapshots/manifest_directive.hl+3−8

This diff is too big to show here.

tests/snapshots/manifest_directive.htmlnew file+1

This diff is too big to show here.

tests/snapshots/markdown_block.hl+1−1

This diff is too big to show here.

tests/snapshots/markdown_block.htmlnew file+10

This diff is too big to show here.

tests/snapshots/match_directive.hl+9−10

This diff is too big to show here.

tests/snapshots/match_directive.htmlnew file+1

This diff is too big to show here.

tests/snapshots/media_elements.hl+1−1

This diff is too big to show here.

tests/snapshots/media_elements.htmlnew file+1

This diff is too big to show here.

tests/snapshots/media_extended.htmlnew file+1

This diff is too big to show here.

tests/snapshots/meta_head.hl+1−1

This diff is too big to show here.

tests/snapshots/meta_head.htmlnew file+1

This diff is too big to show here.

tests/snapshots/mixin_spread.hl+5−5

This diff is too big to show here.

tests/snapshots/mixin_spread.htmlnew file+1

This diff is too big to show here.

tests/snapshots/named_slots.hl+2−2

This diff is too big to show here.

tests/snapshots/named_slots.htmlnew file+1

This diff is too big to show here.

tests/snapshots/names_and_values.hlnew file+18

This diff is too big to show here.

tests/snapshots/names_and_values.htmlnew file+1

This diff is too big to show here.

tests/snapshots/new_css.hl+1−1

This diff is too big to show here.

tests/snapshots/new_css.htmlnew file+1

This diff is too big to show here.

tests/snapshots/new_css_attrs.hl+1−1

This diff is too big to show here.

tests/snapshots/new_css_attrs.htmlnew file+1

This diff is too big to show here.

tests/snapshots/new_css_properties.hl+7−7

This diff is too big to show here.

tests/snapshots/new_css_properties.htmlnew file+1

This diff is too big to show here.

tests/snapshots/new_css_properties_2.hl+2−2

This diff is too big to show here.

tests/snapshots/new_css_properties_2.htmlnew file+1

This diff is too big to show here.

tests/snapshots/new_css_properties_3.hl+2−2

This diff is too big to show here.

tests/snapshots/new_css_properties_3.htmlnew file+1

This diff is too big to show here.

tests/snapshots/new_css_properties_4.hl+1−1

This diff is too big to show here.

tests/snapshots/new_css_properties_4.htmlnew file+1

This diff is too big to show here.

tests/snapshots/new_directives.hl+18−9

This diff is too big to show here.

tests/snapshots/new_directives.htmlnew file+8

This diff is too big to show here.

tests/snapshots/new_elements.hl+7−7

This diff is too big to show here.

tests/snapshots/new_elements.htmlnew file+1

This diff is too big to show here.

tests/snapshots/new_elements_2.hl+10−10

This diff is too big to show here.

tests/snapshots/new_elements_2.htmlnew file+1

This diff is too big to show here.

tests/snapshots/new_elements_3.hl+2−2

This diff is too big to show here.

tests/snapshots/new_elements_3.htmlnew file+1

This diff is too big to show here.

tests/snapshots/new_elements_4.hl+4−13

This diff is too big to show here.

tests/snapshots/new_elements_4.htmlnew file+1

This diff is too big to show here.

tests/snapshots/new_elements_5.hldeleted−19

This diff is too big to show here.

tests/snapshots/new_elements_6.hl+3−3

This diff is too big to show here.

tests/snapshots/new_elements_6.htmlnew file+1

This diff is too big to show here.

tests/snapshots/new_html_attrs.hl+5−5

This diff is too big to show here.

tests/snapshots/new_html_attrs.htmlnew file+1

This diff is too big to show here.

tests/snapshots/new_pseudos.hl+2−2

This diff is too big to show here.

tests/snapshots/new_pseudos.htmlnew file+1

This diff is too big to show here.

tests/snapshots/no_page.hl+1−1

This diff is too big to show here.

tests/snapshots/no_page.htmlnew file+1

This diff is too big to show here.

tests/snapshots/nth_pseudo.hl+3−3

This diff is too big to show here.

tests/snapshots/nth_pseudo.htmlnew file+1

This diff is too big to show here.

tests/snapshots/og_directive.hl+3−3

This diff is too big to show here.

tests/snapshots/og_directive.htmlnew file+1

This diff is too big to show here.

tests/snapshots/one_css_path.hlnew file+14

This diff is too big to show here.

tests/snapshots/one_css_path.htmlnew file+4

This diff is too big to show here.

tests/snapshots/page_root.hlnew file+15

This diff is too big to show here.

tests/snapshots/page_root.htmlnew file+1

This diff is too big to show here.

tests/snapshots/pagination_each.hldeleted−3

This diff is too big to show here.

tests/snapshots/parameters.hlnew file+31

This diff is too big to show here.

tests/snapshots/parameters.htmlnew file+1

This diff is too big to show here.

tests/snapshots/popover_api.hl+2−2

This diff is too big to show here.

tests/snapshots/popover_api.htmlnew file+1

This diff is too big to show here.

tests/snapshots/positional.htmlnew file+1

This diff is too big to show here.

tests/snapshots/prefixes_compose.hlnew file+17

This diff is too big to show here.

tests/snapshots/prefixes_compose.htmlnew file+1

This diff is too big to show here.

tests/snapshots/pseudo_elements.hl+1−1

This diff is too big to show here.

tests/snapshots/pseudo_elements.htmlnew file+1

This diff is too big to show here.

tests/snapshots/pseudo_states.htmlnew file+1

This diff is too big to show here.

tests/snapshots/pseudo_states_extended.hl+5−5

This diff is too big to show here.

tests/snapshots/pseudo_states_extended.htmlnew file+1

This diff is too big to show here.

tests/snapshots/px_rule.hlnew file+20

This diff is too big to show here.

tests/snapshots/px_rule.htmlnew file+1

This diff is too big to show here.

tests/snapshots/raw_html.hl+2−2

This diff is too big to show here.

tests/snapshots/raw_html.htmlnew file+1

This diff is too big to show here.

tests/snapshots/repeat_directive.hl+2−2

This diff is too big to show here.

tests/snapshots/repeat_directive.htmlnew file+1

This diff is too big to show here.

tests/snapshots/responsive.hl+1−1

This diff is too big to show here.

tests/snapshots/responsive.htmlnew file+1

This diff is too big to show here.

tests/snapshots/responsive_images.hl+2−2

This diff is too big to show here.

tests/snapshots/responsive_images.htmlnew file+1

This diff is too big to show here.

tests/snapshots/scope_css.hl+6−4

This diff is too big to show here.

tests/snapshots/scope_css.htmlnew file+1

This diff is too big to show here.

tests/snapshots/script_element.hl+1−1

This diff is too big to show here.

tests/snapshots/script_element.htmlnew file+4

This diff is too big to show here.

tests/snapshots/scroll_driven_animations.hl+6−4

This diff is too big to show here.

tests/snapshots/scroll_driven_animations.htmlnew file+1

This diff is too big to show here.

tests/snapshots/selection_pseudo.hl+1−1

This diff is too big to show here.

tests/snapshots/selection_pseudo.htmlnew file+1

This diff is too big to show here.

tests/snapshots/semantic_elements.hl+4−4

This diff is too big to show here.

tests/snapshots/semantic_elements.htmlnew file+1

This diff is too big to show here.

tests/snapshots/sizing.hl+1−1

This diff is too big to show here.

tests/snapshots/sizing.htmlnew file+1

This diff is too big to show here.

tests/snapshots/slots_and_children.hlnew file+59

This diff is too big to show here.

tests/snapshots/slots_and_children.htmlnew file+1

This diff is too big to show here.

tests/snapshots/starting_style.hl+5−3

This diff is too big to show here.

tests/snapshots/starting_style.htmlnew file+1

This diff is too big to show here.

tests/snapshots/stress_deeply_nested.hlnew file+184

This diff is too big to show here.

tests/snapshots/stress_deeply_nested.htmlnew file+1

This diff is too big to show here.

tests/snapshots/stress_large.hlnew file+396

This diff is too big to show here.

tests/snapshots/stress_large.htmlnew file+1

This diff is too big to show here.

tests/snapshots/string_interpolation.htmlnew file+1

This diff is too big to show here.

tests/snapshots/style_block.hl+1−1

This diff is too big to show here.

tests/snapshots/style_block.htmlnew file+1

This diff is too big to show here.

tests/snapshots/subgrid_css.htmlnew file+1

This diff is too big to show here.

tests/snapshots/table_elements.htmlnew file+1

This diff is too big to show here.

tests/snapshots/text_everywhere.hlnew file+41

This diff is too big to show here.

tests/snapshots/text_everywhere.htmlnew file+3

This diff is too big to show here.

tests/snapshots/translations_i18n.hl+3−8

This diff is too big to show here.

tests/snapshots/translations_i18n.htmlnew file+1

This diff is too big to show here.

tests/snapshots/unless_directive.hl+2−2

This diff is too big to show here.

tests/snapshots/unless_directive.htmlnew file+1

This diff is too big to show here.

tests/snapshots/values_and_scope.hlnew file+62

This diff is too big to show here.

tests/snapshots/values_and_scope.htmlnew file+1

This diff is too big to show here.

tests/snapshots/variable_filters.hl+8−8

This diff is too big to show here.

tests/snapshots/variable_filters.htmlnew file+1

This diff is too big to show here.

tests/snapshots/variable_slots.hlnew file+18

This diff is too big to show here.

tests/snapshots/variable_slots.htmlnew file+1

This diff is too big to show here.

tests/snapshots/variables_defines.hl+3−3

This diff is too big to show here.

tests/snapshots/variables_defines.htmlnew file+1

This diff is too big to show here.

tests/snapshots/view_transitions.hl+2−2

This diff is too big to show here.

tests/snapshots/view_transitions.htmlnew file+1

This diff is too big to show here.

tests/snapshots/with_directive.hl+2−2

This diff is too big to show here.

tests/snapshots/with_directive.htmlnew file+1

This diff is too big to show here.