Skip to main content

kui_core/
schema.rs

1//! The prop schema: the one table of node props, elements, events and
2//! readings that every kui binding is generated from or checked against.
3//!
4//! A Rust app does not read this module; it builds a `NodeSpec` with its
5//! methods. The tables here are for the bindings and for tooling. Each
6//! [`PROPS`] row names a prop (camelCase, with the snake_case spelling
7//! derived), its wire id, its value kind, how it applies to a `NodeSpec`
8//! and its documentation: `kui-node` parses JSON and its binary stream by
9//! kind and generates the TypeScript types from the rows, `kui-lua` looks
10//! each table key up by name, and `kui-ffi` mirrors the rows in a C struct
11//! that a parity test pins to this table. [`CUSTOM`] lists the composite
12//! props a binding extracts itself (padding shorthands, border, overflow,
13//! floats), [`ELEMENTS`] the props each element lowers, [`DOORS`] the
14//! verbs (calls rather than props) with their spelling in every binding,
15//! and [`known_prop`] answers whether a name is any of these, which is
16//! what an `unknown-prop` warning checks against.
17//!
18//! ```rust
19//! use kui_core::schema::{PROPS, P_WIDTH};
20//!
21//! let width = PROPS.iter().find(|p| p.id == P_WIDTH).expect("a core prop");
22//! assert_eq!(width.name, "width");
23//! assert!(!width.doc.is_empty());
24//! ```
25//!
26//! Adding a simple prop is one row here (plus `npm run gen` for the TS
27//! types, and a field in the C struct when the parity test says so).
28//! Composite props need per-binding extraction but not per-binding
29//! decisions: what a shorthand means lives in one place in `spec`, and
30//! `crate::conformance` makes every binding agree on behaviour.
31
32use std::sync::LazyLock;
33
34use rustc_hash::FxHashSet;
35
36use crate::access::Role;
37use crate::anim::{Easing, Repeat};
38use crate::color::Color;
39use crate::cursor::CursorShape;
40use crate::enter::Enter;
41use crate::keyframes::Keyframe;
42use crate::spec::{
43    Align, Bound, FontFamily, NodeSpec, PadShorthand, Sizing, TextStyle, TextWrap, UnderlineStyle,
44};
45use crate::value::Value;
46use crate::window::{WindowButton, WindowConfig};
47
48mod doors;
49pub use doors::{Cell, DOORS, Door, GUEST};
50
51// Wire ids, stable within a binary protocol version (see kui-node).
52pub const P_DIR: u32 = 1;
53pub const P_WIDTH: u32 = 2;
54pub const P_HEIGHT: u32 = 3;
55pub const P_MIN_W: u32 = 4;
56pub const P_MAX_W: u32 = 5;
57pub const P_MIN_H: u32 = 6;
58pub const P_MAX_H: u32 = 7;
59pub const P_PAD: u32 = 8;
60pub const P_GAP: u32 = 9;
61pub const P_MAIN_ALIGN: u32 = 10;
62pub const P_CROSS_ALIGN: u32 = 11;
63pub const P_BG: u32 = 12;
64pub const P_BORDER: u32 = 13;
65pub const P_RADIUS: u32 = 14;
66pub const P_OVERFLOW: u32 = 15;
67pub const P_FLOAT: u32 = 16;
68pub const P_HOVERABLE: u32 = 17;
69pub const P_ON_CLICK: u32 = 18;
70pub const P_ON_DRAG: u32 = 19;
71pub const P_ON_KEY: u32 = 20;
72pub const P_WINDOW: u32 = 21;
73pub const P_KEY_FOCUS: u32 = 22;
74pub const P_CENTER: u32 = 23;
75pub const P_SIZE: u32 = 24;
76pub const P_LINE_HEIGHT: u32 = 25;
77pub const P_COLOR: u32 = 26;
78pub const P_FAMILY: u32 = 27;
79pub const P_KEY: u32 = 28;
80pub const P_TITLE: u32 = 29;
81pub const P_TOOLTIP: u32 = 30;
82pub const P_TRANSITION: u32 = 31;
83pub const P_EASING: u32 = 32;
84pub const P_SLIDE: u32 = 33;
85pub const P_HOVER_BG: u32 = 34;
86pub const P_PRESSED_BG: u32 = 35;
87pub const P_HOVER_GROUP: u32 = 36;
88pub const P_ON_HOVER: u32 = 37;
89pub const P_RADIUS_TL: u32 = 38;
90pub const P_RADIUS_TR: u32 = 39;
91pub const P_RADIUS_BR: u32 = 40;
92pub const P_RADIUS_BL: u32 = 41;
93pub const P_FONT: u32 = 42;
94pub const P_KEYFRAMES: u32 = 43;
95pub const P_REPEAT: u32 = 44;
96pub const P_DELAY: u32 = 45;
97pub const P_WRAP: u32 = 46;
98pub const P_MAX_LINES: u32 = 47;
99pub const P_ELLIPSIS: u32 = 48;
100pub const P_ENTER: u32 = 49;
101pub const P_CLICK_SOUND: u32 = 50;
102pub const P_HOVER_SOUND: u32 = 51;
103pub const P_ON_LAYOUT: u32 = 52;
104pub const P_ROLE: u32 = 53;
105pub const P_LABEL: u32 = 54;
106pub const P_CHECKED: u32 = 55;
107pub const P_VALUE_NOW: u32 = 56;
108pub const P_VALUE_MIN: u32 = 57;
109pub const P_VALUE_MAX: u32 = 58;
110pub const P_CARET: u32 = 59;
111pub const P_SELECTION_ANCHOR: u32 = 60;
112pub const P_FOCUSABLE: u32 = 61;
113pub const P_DISABLED: u32 = 62;
114pub const P_FOCUS_BG: u32 = 63;
115pub const P_MODAL: u32 = 64;
116pub const P_ON_CONTEXT_MENU: u32 = 65;
117pub const P_CURSOR: u32 = 66;
118pub const P_SELECTED: u32 = 67;
119pub const P_EXPANDED: u32 = 68;
120pub const P_OPACITY: u32 = 69;
121pub const P_SHADOW_COLOR: u32 = 70;
122pub const P_SHADOW_BLUR: u32 = 71;
123pub const P_SHADOW_X: u32 = 72;
124pub const P_SHADOW_Y: u32 = 73;
125pub const P_SHADOW_SPREAD: u32 = 74;
126pub const P_WRAP_CHILDREN: u32 = 75;
127pub const P_CROSS_GAP: u32 = 76;
128pub const P_INITIAL_FOCUS: u32 = 77;
129pub const P_EXIT: u32 = 78;
130pub const P_WINDOWS: u32 = 79;
131pub const P_LIVE: u32 = 80;
132pub const P_KEY_UP: u32 = 81;
133pub const P_VALUE_TEXT: u32 = 82;
134pub const P_DESCRIPTION: u32 = 83;
135pub const P_FEATURES: u32 = 84;
136pub const P_UNDERLINE: u32 = 85;
137pub const P_STRIKETHROUGH: u32 = 86;
138pub const P_ANIMATE: u32 = 87;
139pub const P_ACCENT: u32 = 88;
140pub const P_INDEX: u32 = 89;
141pub const P_SELECTABLE: u32 = 90;
142pub const P_ON_FORCE_CLICK: u32 = 91;
143pub const P_FOCUS_REGION: u32 = 92;
144pub const P_SCROLLBAR: u32 = 93;
145pub const P_SCROLLBAR_WIDTH: u32 = 94;
146pub const P_SCROLLBAR_COLOR: u32 = 95;
147pub const P_SCROLLBAR_ACTIVE_COLOR: u32 = 96;
148pub const P_ANCHOR: u32 = 97;
149pub const P_ALWAYS_ON_TOP: u32 = 98;
150pub const P_ON_SCROLL: u32 = 99;
151pub const P_ROW_COUNT: u32 = 100;
152pub const P_UNDERLINE_COLOR: u32 = 101;
153pub const P_UNDERLINE_STYLE: u32 = 102;
154pub const P_ON_DROP: u32 = 103;
155pub const P_DROP_BG: u32 = 104;
156pub const P_CARET_SOLID: u32 = 105;
157pub const P_SECURE_INPUT: u32 = 106;
158pub const P_ASPECT_RATIO: u32 = 107;
159pub const P_MIXED: u32 = 108;
160pub const P_VALUE_STEP: u32 = 109;
161pub const P_ON_CHANGE: u32 = 110;
162pub const P_PIXEL_SNAP: u32 = 111;
163pub const P_KEEP_FOCUS: u32 = 112;
164pub const P_ON_FOCUS: u32 = 113;
165pub const P_RULES: u32 = 114;
166pub const P_RULE_WIDTH: u32 = 115;
167pub const P_ON_BUTTON: u32 = 116;
168pub const P_BUTTONS: u32 = 117;
169pub const P_OVERSCROLL: u32 = 118;
170pub const P_SCROLL_AXES: u32 = 119;
171pub const P_MODIFIER_KEYS: u32 = 120;
172pub const P_OPTION_AS_ALT: u32 = 121;
173pub const P_BOUNCE: u32 = 122;
174pub const P_GRADIENT: u32 = 123;
175pub const P_SCROLL_MODS: u32 = 124;
176
177/// The `mainAlign` / `crossAlign` rows and a float's attach points, in
178/// `Align`'s order. Append-only: the Lua and Node wires carry the index,
179/// and C's `KUI_ALIGN_*` is it. The spreads mean something on `mainAlign`
180/// and `baseline` on a row's `crossAlign` only.
181pub const ALIGNS: &[&str] = &[
182    "start",
183    "center",
184    "end",
185    "spaceBetween",
186    "spaceAround",
187    "spaceEvenly",
188    "baseline",
189];
190pub const WINDOW_ROLES: &[&str] = &["drag", "close", "minimize", "maximize"];
191/// The `scrollbar` row, in `ScrollbarMode::ALL`'s order: the stock
192/// overlay bar, none, or one that fades out when the scroll state has not
193/// changed. C spells it as the index plus one (`KUI_SCROLLBAR_*`), so a
194/// zeroed field is "unset".
195pub const SCROLLBARS: &[&str] = &["visible", "hidden", "auto"];
196/// The `overscroll` row, in `Overscroll::ALL`'s order: a
197/// scroll gesture starting over a scroller at its limit goes on to the one
198/// around it, or stays. C spells it as the index plus one
199/// (`KUI_OVERSCROLL_*`), a zeroed field being `auto`.
200pub const OVERSCROLLS: &[&str] = &["auto", "contain"];
201/// The `scrollAxes` row, in `ScrollAxes::ALL`'s order: the
202/// axes an `onScroll` node takes. C spells it as the index plus one
203/// (`KUI_SCROLL_AXES_*`), a zeroed field being `both`.
204pub const SCROLL_AXES: &[&str] = &["both", "x", "y"];
205/// The stock families (`FontFamily::name` spellings, in `FontFamily::ALL`
206/// order); a registered font travels as the `font` row's handle instead.
207pub const FAMILIES: &[&str] = &["sans", "serif", "mono"];
208/// The pointer shapes a view can declare (`CursorShape::name` spellings, in
209/// `CursorShape::ALL` order — a `cursor.rs` test pins the two together).
210pub const CURSORS: &[&str] = &[
211    "default",
212    "text",
213    "pointer",
214    "grab",
215    "grabbing",
216    "notAllowed",
217    "ewResize",
218    "nsResize",
219    "nwseResize",
220    "neswResize",
221];
222
223pub fn cursor_idx(i: usize) -> CursorShape {
224    CURSORS
225        .get(i)
226        .and_then(|n| CursorShape::parse(n))
227        .unwrap_or(CursorShape::Default)
228}
229pub const WRAPS: &[&str] = &["word", "glyph", "none", "break-spaces"];
230/// `underlineStyle` / `underline_style`; `UnderlineStyle::NAMES`.
231pub const UNDERLINE_STYLES: &[&str] = UnderlineStyle::NAMES;
232/// `expanded` names its state rather than being a flag: a disclosure that
233/// is shut has to say "collapsed", and an absent flag cannot — absent has
234/// to keep meaning "this node does not expand" (AccessKit's `expanded`,
235/// ARIA's `aria-expanded`, are three-state for the same reason).
236pub const EXPANDED: &[&str] = &["collapsed", "expanded"];
237/// How urgently a reader should read a change it was not asked to read
238/// (`crate::access::Live::name` spellings, in wire order — a binding
239/// sends the index). `off` is the default and means "not a live region".
240pub const LIVE: &[&str] = &["off", "polite", "assertive"];
241/// The roles a view can declare (`crate::access::Role::name` spellings),
242/// in wire order — a binding sends the index. The purely derived roles are
243/// the ones [`DERIVED_ONLY`] names, and every other `Role::ALL` variant is
244/// here; `textInput`, `multilineTextInput` and `line` are, because an app
245/// that draws its own text declares them.
246pub const ROLES: &[&str] = &[
247    "none",
248    "button",
249    "checkbox",
250    "radio",
251    "switch",
252    "slider",
253    "tab",
254    "tabList",
255    "link",
256    "heading",
257    "list",
258    "listItem",
259    "image",
260    "dialog",
261    "group",
262    "textInput",
263    "multilineTextInput",
264    "line",
265    // Appended later. The tail is the only free position,
266    // which is what makes "the first fifteen can be declared" a list rather
267    // than a range.
268    "radioGroup",
269    "menu",
270    "menuItem",
271    // Appended later: a cell grid's derived role.
272    "terminal",
273];
274
275/// How a composite container arranges its items
276/// (`crate::access::Orientation::name` spellings), in wire order. Derived
277/// from the container's `dir` and reported on its access node, never
278/// declared — so unlike [`ROLES`] this is not a prop's enum, only a list
279/// the C header restates.
280pub const ORIENTATIONS: &[&str] = &["horizontal", "vertical"];
281
282/// The OS light/dark setting (`crate::env::Appearance::name` spellings, in
283/// `Appearance::ALL` order — an `env.rs` test pins the two together). Like
284/// [`ORIENTATIONS`] this is not a prop's enum: it is a fact a host pushes
285/// and every binding spells the same way. Index 0 is `unknown`, so a
286/// zeroed C call reports what it actually knows.
287pub const APPEARANCES: &[&str] = &["unknown", "light", "dark"];
288
289/// The OS reduce-motion setting (`crate::env::MotionPref::name` spellings, in
290/// `MotionPref::ALL` order), `unknown` first for the same reason.
291pub const MOTIONS: &[&str] = &["unknown", "full", "reduced"];
292
293/// Whether assistive technology is listening (`crate::env::Assistive::name`
294/// spellings, in `Assistive::ALL` order), `unknown` first for the same
295/// reason: a host with no bridge reports that it cannot tell.
296pub const ASSISTIVE: &[&str] = &["unknown", "none", "listening"];
297
298/// The audio output device's state (`crate::env::AudioDevice::name`
299/// spellings, in `AudioDevice::ALL` order), `closed` first so a zeroed C
300/// call reports the default.
301pub const AUDIO_DEVICES: &[&str] = &["closed", "opening", "open", "failed"];
302
303/// The roles no view can declare, because the core derives them itself,
304/// with what derives each one. Every
305/// [`Role::ALL`] variant is on this list or in [`ROLES`], and
306/// `every_role_is_declarable_or_derived` keeps both halves honest: a role
307/// exempted here has to be one a frame really does derive, so the list
308/// cannot absorb a variant that was simply forgotten from `ROLES`.
309pub const DERIVED_ONLY: &[(&str, &str)] = &[
310    (
311        "window",
312        "the root node of a frame, named by the window title",
313    ),
314    ("titleBar", "a `windowDrag` node"),
315    ("staticText", "a text node"),
316    ("scrollView", "a `scrollX` / `scrollY` node"),
317];
318
319/// The role at wire index `i` — `ROLES`' order is the protocol, so this
320/// and [`ROLES`] are pinned to each other by
321/// `every_declarable_role_name_is_a_real_role`.
322///
323/// Neither way of missing can happen today. A name in `ROLES` that no
324/// longer parses is what that test catches, by construction rather than
325/// at run time. Out of range cannot arrive through a transport: Node's
326/// binary reader rejects `i >= names.len()` before it builds a
327/// `Parsed::Enum`, Node's JSON and Lua resolve a *name* through
328/// [`enum_index`], and C carries `Role::ALL` positions that
329/// [`crate::access::Role`] itself bounds.
330///
331/// So the fallback is reachable only from a future transport that forgets
332/// its check, and it is `Role::Group` rather than `Role::None` for that
333/// reader: `None` takes the node *and its whole subtree* out of the access
334/// tree, which is a destructive answer to "an index I do not have", while
335/// a group is what the core already derives for a box that is merely
336/// somewhere focus can land — the node keeps its children, and a wrong
337/// role is recoverable where a missing subtree is not. It stays silent
338/// because this is a pure schema function with no warning sink, and the
339/// transports' own errors name the prop and the index, which is a better
340/// report than a warning here.
341pub fn role_idx(i: usize) -> Role {
342    ROLES
343        .get(i)
344        .and_then(|n| Role::parse(n))
345        .unwrap_or(Role::Group)
346}
347/// The easing curves (`Easing::name` spellings, in `Easing::ALL` order —
348/// the test below pins the two together, as `CURSORS` is pinned).
349pub const EASINGS: &[&str] = &[
350    "easeOut",
351    "linear",
352    "easeIn",
353    "easeInOut",
354    "spring",
355    "bouncy",
356    "smooth",
357    "snappy",
358];
359
360/// CSS's `animation-direction` values, in `Repeat::ALL`'s order.
361pub const REPEATS: &[&str] = &["normal", "reverse", "alternate", "alternateReverse"];
362
363pub fn repeat_idx(i: usize) -> Repeat {
364    Repeat::from_index(i)
365}
366
367pub fn easing_idx(i: usize) -> Easing {
368    Easing::from_index(i)
369}
370
371/// How a prop's value is parsed (per transport) and encoded (binary slots).
372pub enum Kind {
373    /// One number, or a `"$length"` token. Binary: 1 slot.
374    F32,
375    /// One color: `0xRRGGBBAA` number or `#hex` string, or a `"$color"`
376    /// token. Binary: 1 slot (u32).
377    Color,
378    /// Marker, present-or-absent (`false` = absent). Binary: 0 slots.
379    Flag,
380    /// One of a closed name list. Binary: 1 slot (index).
381    Enum(&'static [&'static str]),
382    /// A sizing: number | "fit" | "grow" | "N%" | a size expression
383    /// (`"clamp(400px, 80%, 1000px)"`, [`crate::calc`]) | {grow} |
384    /// {percent}, or a `"$length"` token (a fixed length). Binary: 2 slots
385    /// (mode, value), or with mode [`SIZE_MODE_CALC`] the mode and a
386    /// strref, the expression's spelling (v19); tagged, 1 slot (the index).
387    Sizing,
388    /// A lower clamp: number | "fit" (the node's own fit size on that axis)
389    /// | a size expression, or a `"$length"` token. Binary: 2 slots (mode,
390    /// value), a sizing's first two modes, or [`SIZE_MODE_CALC`] and a
391    /// strref; tagged, 1 slot (the index).
392    Min,
393    /// An upper clamp: number | a size expression, or a `"$length"` token.
394    /// Binary as a `Min` (v19; a plain number before): mode 0 and px, or
395    /// [`SIZE_MODE_CALC`] and a strref; tagged, 1 slot (the index).
396    Max,
397    /// An arbitrary message payload (a `Value`). Binary: strref to JSON.
398    Msg,
399    /// A message merged into the core's own event under `tag` (`onDrag`,
400    /// `onKey`, `onHover`, `onLayout`). Parsed and carried exactly like a
401    /// `Msg`, but null is a legal value: the node still gets the behaviour
402    /// (a key sink, a drag source) and its events simply carry no `tag` —
403    /// so an app whose messages are a typed union needs no inert member
404    /// just to name a sink.
405    Tag,
406    /// A plain string (a name, not a message). Binary: strref.
407    Str,
408    /// A font family: one of the stock names (`FAMILIES`) or an installed
409    /// or loaded family's name, which the parser registers and turns into
410    /// its handle. Binary: strref (v18).
411    Family,
412    /// A registered resource handle (a font or sound id): the integer form
413    /// of the slotmap key. JSON/binary carry it as the 16-hex string the
414    /// addon hands out; Lua as an integer; C as a `uint64_t`.
415    Resource,
416    /// A keyframe stop list (`crate::keyframes::parse` reads the plain-data
417    /// form). JSON/binary/Lua carry it like a `Msg` and parse it in the
418    /// core; C passes a `KuiKeyframe` array.
419    Keyframes,
420    /// An entrance (`crate::enter::parse` reads the plain-data form).
421    /// Carried like a `Msg` and parsed in the core; C fills a `KuiEnter`.
422    Enter,
423    /// A gradient (`crate::gradient::parse` reads the plain-data form).
424    /// Carried like a `Msg` and parsed in the core; C fills a
425    /// `KuiGradient`.
426    Gradient,
427}
428
429/// Where a parsed value lands. `PropDef::target` derives from this.
430pub enum Apply {
431    SpecF32(fn(NodeSpec, f32) -> NodeSpec),
432    SpecColor(fn(NodeSpec, Color) -> NodeSpec),
433    SpecFlag(fn(NodeSpec) -> NodeSpec),
434    SpecEnum(fn(NodeSpec, usize) -> NodeSpec),
435    SpecSizing(fn(NodeSpec, Sizing) -> NodeSpec),
436    SpecBound(fn(NodeSpec, Bound) -> NodeSpec),
437    SpecMsg(fn(NodeSpec, Value) -> NodeSpec),
438    SpecStr(fn(NodeSpec, &str) -> NodeSpec),
439    SpecKeyframes(fn(NodeSpec, Vec<Keyframe>) -> NodeSpec),
440    SpecEnter(fn(NodeSpec, Enter) -> NodeSpec),
441    SpecGradient(fn(NodeSpec, crate::gradient::Gradient) -> NodeSpec),
442    SpecResource(fn(NodeSpec, u64) -> NodeSpec),
443    StyleF32(fn(TextStyle, f32) -> TextStyle),
444    StyleColor(fn(TextStyle, Color) -> TextStyle),
445    StyleEnum(fn(TextStyle, usize) -> TextStyle),
446    StyleFlag(fn(TextStyle) -> TextStyle),
447    StyleResource(fn(TextStyle, u64) -> TextStyle),
448    StyleStr(fn(TextStyle, &str) -> TextStyle),
449    StyleFamily(fn(TextStyle, FontFamily) -> TextStyle),
450}
451
452#[derive(Clone, Copy, Debug, PartialEq, Eq)]
453pub enum Target {
454    /// Lands on the node's `NodeSpec` (containers, edits, images).
455    Spec,
456    /// Lands on a `TextStyle` (text, rich text, edits).
457    Style,
458}
459
460pub struct PropDef {
461    /// Canonical camelCase name (the JSX prop). Lua uses `snake_name()`.
462    pub name: &'static str,
463    pub id: u32,
464    pub kind: Kind,
465    pub apply: Apply,
466    pub doc: &'static str,
467}
468
469impl PropDef {
470    pub fn target(&self) -> Target {
471        match self.apply {
472            Apply::StyleF32(_)
473            | Apply::StyleColor(_)
474            | Apply::StyleEnum(_)
475            | Apply::StyleFlag(_)
476            | Apply::StyleResource(_)
477            | Apply::StyleStr(_)
478            | Apply::StyleFamily(_) => Target::Style,
479            _ => Target::Spec,
480        }
481    }
482
483    /// The Lua-side name: `minWidth` → `min_width`.
484    pub fn snake_name(&self) -> &'static str {
485        SNAKE_NAMES[self.index()]
486    }
487
488    fn index(&self) -> usize {
489        // By name, not by address: `PROPS` is a const, so another crate
490        // iterating it sees its own copy of the rows.
491        PROPS
492            .iter()
493            .position(|d| d.name == self.name)
494            .expect("PropDef not from PROPS")
495    }
496}
497
498pub fn align_idx(i: usize) -> Align {
499    match i {
500        1 => Align::Center,
501        2 => Align::End,
502        3 => Align::SpaceBetween,
503        4 => Align::SpaceAround,
504        5 => Align::SpaceEvenly,
505        6 => Align::Baseline,
506        _ => Align::Start,
507    }
508}
509
510/// Binary min or max decode: (mode, value) → a clamp, the first two
511/// sizing modes ([`SIZE_MODE_CALC`] is read by the transport, which
512/// holds the strref).
513pub fn min_num(mode: u32, value: f64) -> Bound {
514    match mode {
515        1 => Bound::Fit,
516        _ => Bound::Px(value as f32),
517    }
518}
519
520/// Binary sizing decode: (mode, value) → Sizing.
521pub fn sizing_num(mode: u32, value: f64) -> Sizing {
522    match mode {
523        1 => Sizing::Fit,
524        2 => Sizing::Grow(value as f32),
525        3 => Sizing::Percent(value as f32),
526        _ => Sizing::Fixed(value as f32),
527    }
528}
529
530pub const PROPS: &[PropDef] = &[
531    PropDef {
532        name: "width",
533        id: P_WIDTH,
534        kind: Kind::Sizing,
535        apply: Apply::SpecSizing(|s, v| s.width(v)),
536        doc: "Horizontal size: px | \"fit\" | \"grow\" | \"N%\" | a size expression — \
537              `\"clamp(400px, 80%, 1000px)\"`, `\"min(720px, 100%)\"`, `\"max(50%, 300)\"`, \
538              nested — which layout resolves against the parent's content box, the box a \
539              percentage takes its cut of (backlog F109). An expression with no percentage \
540              in it is a length; a calc does not ease under `transition`. A percentage \
541              or an expression gives, with the fit children, when its parent overflows \
542              — two `\"50%\"` children and a gap fit their row (backlog F110) — where a \
543              px size keeps its own. A row holding one gives as CSS's flex items do: \
544              every child that can give gives in proportion to its size, and stops at \
545              its content — the widest thing in it that cannot wrap, a label's longest \
546              word — unless `minWidth` says otherwise (backlog RG92). The process keeps \
547              65 536 distinct expressions and never lets one go: past that a new one leaves \
548              its prop at its default, with a `size-expressions-full` warning, so declare \
549              one per layout — a px size for the part that moves each frame, a splitter's \
550              drag — not one per frame (backlog RG93).",
551    },
552    PropDef {
553        name: "height",
554        id: P_HEIGHT,
555        kind: Kind::Sizing,
556        apply: Apply::SpecSizing(|s, v| s.height(v)),
557        doc: "Vertical size: px | \"fit\" | \"grow\" | \"N%\" | a size expression (see `width`).",
558    },
559    PropDef {
560        name: "minWidth",
561        id: P_MIN_W,
562        kind: Kind::Min,
563        apply: Apply::SpecBound(|s, v| s.min_width(v)),
564        doc: "Lower width clamp: logical px, a size expression (see `width`; a percentage \
565              clamp is none until the parent's width is known, as in CSS), or \"fit\" for \
566              the node's own fit width. \
567              \"fit\" under `width=\"grow\"` is a content floor — CSS's `flex: 1 0 auto` — \
568              which is what an i3-style tab bar is: tabs that split the bar evenly \
569              while they fit and sit at their label's width, scrolling, once they do \
570              not. Opt-in, because a fit width is the unwrapped one: a paragraph in a \
571              grow column would stop wrapping under it. Left out, a child giving in an \
572              overflowing row that holds a percentage or a size expression stops at its \
573              content, CSS's `min-width: auto`; `0` lets it go below, CSS's \
574              `min-width: 0` (backlog RG92). A fit node across a column is no wider \
575              than the column's box — CSS's `fit-content` — down to this floor, 0 left \
576              out, unless the column scrolls x, so a text one wrapper deep in a capped \
577              card wraps there; \"fit\" keeps its content's width and runs past \
578              (backlog F116).",
579    },
580    PropDef {
581        name: "maxWidth",
582        id: P_MAX_W,
583        kind: Kind::Max,
584        apply: Apply::SpecBound(|s, v| s.max_width(v)),
585        doc: "Upper width clamp: logical px or a size expression (see `width`); \
586              grow+maxWidth is the responsive-width pattern.",
587    },
588    PropDef {
589        name: "minHeight",
590        id: P_MIN_H,
591        kind: Kind::Min,
592        apply: Apply::SpecBound(|s, v| s.min_height(v)),
593        doc: "Lower height clamp: logical px, a size expression, or \"fit\" for the node's own fit height. Undeclared, it is the node's content where its column overflows — CSS's `min-height: auto`, none for a node that scrolls or clips — so a row keeps the height of its text; `0` asks for the squeeze back (see `minWidth`).",
594    },
595    PropDef {
596        name: "maxHeight",
597        id: P_MAX_H,
598        kind: Kind::Max,
599        apply: Apply::SpecBound(|s, v| s.max_height(v)),
600        doc: "Upper height clamp: logical px or a size expression (see `width`).",
601    },
602    PropDef {
603        name: "gap",
604        id: P_GAP,
605        kind: Kind::F32,
606        apply: Apply::SpecF32(|s, v| s.gap(v)),
607        doc: "Space between children along the main axis.",
608    },
609    // Not `wrap`: that name is taken, by the text prop that picks where a
610    // line breaks inside one paragraph. One name cannot mean both, and the
611    // two meet on `<edit>`, which takes container and text props at once.
612    PropDef {
613        name: "wrapChildren",
614        id: P_WRAP_CHILDREN,
615        kind: Kind::Flag,
616        apply: Apply::SpecFlag(NodeSpec::wrap),
617        doc: "Children that don't fit the main axis start a new line instead of overflowing or shrinking. Rows only (a column is ignored, with a warning), and never on a scrollX row.",
618    },
619    PropDef {
620        name: "crossGap",
621        id: P_CROSS_GAP,
622        kind: Kind::F32,
623        apply: Apply::SpecF32(|s, v| s.cross_gap(v)),
624        doc: "Space between wrap lines, across the main axis (`gap` stays the space along it).",
625    },
626    PropDef {
627        name: "mainAlign",
628        id: P_MAIN_ALIGN,
629        kind: Kind::Enum(ALIGNS),
630        apply: Apply::SpecEnum(|s, i| s.main_align(align_idx(i))),
631        doc: "Child alignment along the main axis. `start`, `center` and `end` put the children together; `spaceBetween` deals the free space out between them (none at the ends), `spaceAround` gives each child an equal share split to its two sides, and `spaceEvenly` makes every gap and both ends equal — CSS's `justify-content`. The spread is added to `gap`, and there is none when nothing is free: a `grow` child takes it all, and an overflowing run keeps its gaps. `baseline` means nothing here and lays out as `start`, with a warning.",
632    },
633    PropDef {
634        name: "crossAlign",
635        id: P_CROSS_ALIGN,
636        kind: Kind::Enum(ALIGNS),
637        apply: Apply::SpecEnum(|s, i| s.cross_align(align_idx(i))),
638        doc: "Child alignment across the main axis. On a row, `baseline` lines up the first baselines of the children's text, so a label and a larger value read as one line; a child with no text aligns by its bottom edge, a `grow` or percent height fills the line from its top, and a fit-height row grows to hold the aligned children. A column lays `baseline` out as `start` (as CSS does), and the three spreads mean nothing across an axis — each with a warning.",
639    },
640    PropDef {
641        name: "aspectRatio",
642        id: P_ASPECT_RATIO,
643        kind: Kind::F32,
644        apply: Apply::SpecF32(|s, v| s.aspect_ratio(v)),
645        doc: "Width over height — `16/9`, `1` for a square — CSS's `aspect-ratio`. It sizes the axis left `fit`: a fit height is the final width over the ratio (so `width: grow` and a ratio is a box that keeps its shape as the window resizes), and a fit width under a fixed height is that height times it. With both axes declared, or a fit width under a `grow` or percent height, it has nothing it can set and warns. The derived axis is neither shrunk nor fitted to the children, which overflow it; `minHeight: 'fit'` floors it at them. On an image it wins over the pixels' own aspect.",
646    },
647    PropDef {
648        name: "bg",
649        id: P_BG,
650        kind: Kind::Color,
651        apply: Apply::SpecColor(|s, c| s.bg(c)),
652        doc: "Background fill.",
653    },
654    PropDef {
655        name: "radius",
656        id: P_RADIUS,
657        kind: Kind::F32,
658        apply: Apply::SpecF32(|s, v| s.radius(v)),
659        doc: "Corner radius for all four corners (logical px); the per-corner props override it when listed after it. On a node that also clips or scrolls it rounds the clip as well, so children stay inside the corners.",
660    },
661    PropDef {
662        name: "opacity",
663        id: P_OPACITY,
664        kind: Kind::F32,
665        apply: Apply::SpecF32(|s, v| s.opacity(v)),
666        doc: "Group opacity 0..1 (default 1): fades this node and its whole subtree. A per-quad alpha multiply rather than an offscreen composite, so overlapping pieces of one subtree show their seams through the fade. Layout, hit-testing and the access tree are untouched; eases with `transition`, and `enter: { opacity: 0 }` fades a panel in.",
667    },
668    PropDef {
669        name: "pixelSnap",
670        id: P_PIXEL_SNAP,
671        kind: Kind::Flag,
672        apply: Apply::SpecFlag(|s| s.pixel_snap()),
673        doc: "Paint this node's background, border, shadow and fragment with each edge on a whole physical pixel: `x` and `x + width` rounded on their own, from where layout put them, as a text's span backgrounds are. Off by default, and a box is drawn where layout put it, so a 1 px `gap` between boxes is there at any scale. On, boxes that share an edge in layout meet on one pixel line, where a join inside a pixel was drawn by halves and left a seam — rows of a band stacked at a pitch that is not whole pixels, or a box that continues a text's selection. Layout, hit-testing, the clip and the children are untouched. A snapped box can draw up to half a pixel from its layout edge and its size can differ by a pixel, so a snapped hairline is 1 or 2 px thick by where it sits.",
674    },
675    PropDef {
676        name: "shadowColor",
677        id: P_SHADOW_COLOR,
678        kind: Kind::Color,
679        apply: Apply::SpecColor(|s, c| s.shadow_color(c)),
680        doc: "Drop-shadow color; nothing else about a shadow draws without it. On its own it is a hard shadow exactly behind the node — add `shadowBlur` / `shadowY` to lift it. Outer shadows only, and the shape is not knocked out of the middle, so a translucent background shows it through.",
681    },
682    PropDef {
683        name: "shadowBlur",
684        id: P_SHADOW_BLUR,
685        kind: Kind::F32,
686        apply: Apply::SpecF32(|s, v| s.shadow_blur(v)),
687        doc: "Drop-shadow blur radius (logical px): the edge ramps over this distance and reaches this far past the shape. 0 = a hard edge.",
688    },
689    PropDef {
690        name: "shadowX",
691        id: P_SHADOW_X,
692        kind: Kind::F32,
693        apply: Apply::SpecF32(|s, v| s.shadow_x(v)),
694        doc: "Drop-shadow horizontal offset (logical px).",
695    },
696    PropDef {
697        name: "shadowY",
698        id: P_SHADOW_Y,
699        kind: Kind::F32,
700        apply: Apply::SpecF32(|s, v| s.shadow_y(v)),
701        doc: "Drop-shadow vertical offset (logical px); positive casts downward.",
702    },
703    PropDef {
704        name: "shadowSpread",
705        id: P_SHADOW_SPREAD,
706        kind: Kind::F32,
707        apply: Apply::SpecF32(|s, v| s.shadow_spread(v)),
708        doc: "Grows (or, negative, shrinks) the drop shadow's shape before blurring (logical px).",
709    },
710    PropDef {
711        name: "radiusTL",
712        id: P_RADIUS_TL,
713        kind: Kind::F32,
714        apply: Apply::SpecF32(|s, v| s.radius_tl(v)),
715        doc: "Top-left corner radius (logical px).",
716    },
717    PropDef {
718        name: "radiusTR",
719        id: P_RADIUS_TR,
720        kind: Kind::F32,
721        apply: Apply::SpecF32(|s, v| s.radius_tr(v)),
722        doc: "Top-right corner radius (logical px).",
723    },
724    PropDef {
725        name: "radiusBR",
726        id: P_RADIUS_BR,
727        kind: Kind::F32,
728        apply: Apply::SpecF32(|s, v| s.radius_br(v)),
729        doc: "Bottom-right corner radius (logical px).",
730    },
731    PropDef {
732        name: "radiusBL",
733        id: P_RADIUS_BL,
734        kind: Kind::F32,
735        apply: Apply::SpecF32(|s, v| s.radius_bl(v)),
736        doc: "Bottom-left corner radius (logical px).",
737    },
738    PropDef {
739        name: "center",
740        id: P_CENTER,
741        kind: Kind::Flag,
742        apply: Apply::SpecFlag(|s| s.center()),
743        doc: "Center children on both axes.",
744    },
745    PropDef {
746        name: "hoverable",
747        id: P_HOVERABLE,
748        kind: Kind::Flag,
749        apply: Apply::SpecFlag(|s| s.hoverable()),
750        doc: "Hover-track without a click payload (for isHovered-driven styling).",
751    },
752    PropDef {
753        name: "animate",
754        id: P_ANIMATE,
755        kind: Kind::Flag,
756        apply: Apply::SpecFlag(|s| s.animate()),
757        doc: "Ask for another frame after this one, every frame this node is declared. What a `fragment` that reads `time` needs, and what anything driving itself off the clock rather than off input needs. Opt-in like `exit`, and for the same reason: it takes the loop off input-driven and onto the display's cadence for as long as it is declared, so a still node must not carry it. One node asking is enough for the whole window.",
758    },
759    PropDef {
760        name: "accent",
761        id: P_ACCENT,
762        kind: Kind::Flag,
763        apply: Apply::SpecFlag(|s| s.accent()),
764        doc: "Paint this node's background in the OS accent colour — `env.system.accent` — keeping the declared `bg` on a host that cannot tell what it is. The one prop whose paint depends on the environment, which is why it is opt-in: the same tree is a different colour on two machines, and that is the point here and a surprise anywhere else. On the stock button it does the whole job — the hover and pressed shades are derived from the accent, and the label goes black or white by its luminance, so a yellow accent is still readable — which is what `<button accent>` is for.",
765    },
766    PropDef {
767        name: "selectable",
768        id: P_SELECTABLE,
769        kind: Kind::Flag,
770        apply: Apply::SpecFlag(|s| s.selectable()),
771        doc: "Makes this node a selection scope: the text of every node inside it is one selectable run, in tree order, and a press-drag across them selects the lot — as do Shift with Left / Right / Home / End on a focused node inside it, a character or a word at a time, a scope with nothing selected anchoring at its start (`docs/adr/0017-selection-as-a-scope.md`). Declared on the container and not on each label, because what a reader selects is a paragraph or a card rather than one run of it — three labels in a column under one `selectable` select as three lines of one text. The selection is the window's: starting one anywhere clears the last, an editor's included. Scopes do not nest; an outer one around an inner one is warned about (`nested-selection-scope`) and the innermost owns the text. Text scrolled out of view inside the scope is still part of it — selection and copy reach it, hit-testing does not. On a `cells` grid the scope selects in cells rather than in bytes: a drag takes lines (with a modifier, a rectangle), a double click the word under the pointer and a triple click the whole row, its ends are absolute lines so a scroll does not move them, and a copy trims each line's trailing blanks.",
772    },
773    PropDef {
774        name: "focusable",
775        id: P_FOCUSABLE,
776        kind: Kind::Flag,
777        apply: Apply::SpecFlag(|s| s.focusable()),
778        doc: "Reachable by Tab (and focused by a click) without a click payload or a control role — a row that opens on Enter. Editors, key sinks, `onClick` boxes and the control roles are focusable already.",
779    },
780    PropDef {
781        name: "keepFocus",
782        id: P_KEEP_FOCUS,
783        kind: Kind::Flag,
784        apply: Apply::SpecFlag(|s| s.keep_focus()),
785        doc: "A press on this node, or anywhere inside it, leaves keyboard focus where it was: a toolbar button, a tab or a divider that acts without taking the keyboard from the editor or key sink that had it. Without it a press on an `onClick` node focuses the node, and the app's keys stop reaching the sink until it takes focus back. The press also leaves a text or cell selection and the Tab ring where they were, so a Copy button copies what was selected. An `<edit>` inside still takes its caret and focus, as the keyboard's own owner. The click, drag and hover are unchanged, and Tab and assistive technology still reach the node.",
786    },
787    PropDef {
788        name: "focusRegion",
789        id: P_FOCUS_REGION,
790        kind: Kind::Flag,
791        apply: Apply::SpecFlag(|s| s.focus_region()),
792        doc: "Makes this node's subtree a focus region: a Tab ring of its own that the ring outside never enters and that never leaves — a devtools dock, an inspector beside the app (`docs/adr/0022-focus-regions.md`). Entered on purpose: `focusRegion(name)` (`Ui::focus_region`, `env.focus_region`, `kui_focus_region`) moves focus in — to the focus the region last held, else its `initialFocus`, else its first stop — and `focusRegion(null)` moves it back to the main ring the same way; a press inside the region, or an explicit focus on a node in it, enters it too. Tab then walks that ring alone, wrapping inside it; with nothing focused, Tab enters the ring of the region in effect (`region()`). A region that stops being declared hands focus back to what the main ring last held. Only the ring is scoped: keys still bubble through the boundary to the sink above (a region that wants its own keymap is an `onKey` sink), the pointer and assistive technology see a plain node, and a `modal` in effect is the ring wherever it sits. Nested regions are skipped by the outer ring the way the main ring skips them.",
793    },
794    PropDef {
795        name: "scrollbar",
796        id: P_SCROLLBAR,
797        kind: Kind::Enum(SCROLLBARS),
798        apply: Apply::SpecEnum(|s, i| s.scrollbar(crate::spec::ScrollbarMode::ALL[i])),
799        doc: "When a scrolling node draws its bars: `visible` (the default — the stock overlay thumb, drawn while the content overflows), `hidden` (no thumb, no track to press; the wheel, the keyboard, `reveal` and the caret still scroll it — for a list that draws its own indicator, or a pane whose bar would sit on a border), or `auto` (shown while the scroll state is changing — the offset or the content's extent moved, the pointer is on the track, a thumb is dragged — and for a second after, then faded out over a quarter of one; a node first seen shows it the same second; what an overlay bar does on macOS). `auto` needs the driver's clock and is `visible` without one. The bars are overlays and take no layout space in any mode. From the last change until it has faded — a second and a quarter — an `auto` bar asks for frames the way a transition of that length would (nothing else could wake the core when the hold ends); while the pointer holds it, it asks for none.",
800    },
801    PropDef {
802        name: "anchor",
803        id: P_ANCHOR,
804        kind: Kind::Flag,
805        apply: Apply::SpecFlag(|s| s.anchor()),
806        doc: "Scroll anchoring on a scrolling node (backlog C26, CSS's `overflow-anchor`): the first child in view keeps its place on screen when the content before it changes size — a chat that prepends history, a log that inserts rows above the viewport, a list whose row heights are corrected as they are measured — with no `setScroll` and no arithmetic in the view. The core remembers which child was first in view and where its edge was, and moves the offset by however far that edge moved in the next layout, before the offset is clamped; a wheel notch or a `setScroll` between the frames is kept and the correction added to it. The child is found by key, so give the rows stable keys (a `key` or an `index`); a child that is gone anchors nothing that frame. On the scroll axis that is the node's main axis only — `scrollY` on a column, `scrollX` on a row — and content appended *after* the anchor moves nothing, so a log that is tailing still asks for the end itself.",
807    },
808    PropDef {
809        name: "scrollbarWidth",
810        id: P_SCROLLBAR_WIDTH,
811        kind: Kind::F32,
812        apply: Apply::SpecF32(|s, v| s.scrollbar_width(v)),
813        doc: "The thumb's width at rest, logical px (default 4); under the pointer or dragged it is 2 px wider. The grabbable track grows to fit a wide thumb.",
814    },
815    PropDef {
816        name: "scrollbarColor",
817        id: P_SCROLLBAR_COLOR,
818        kind: Kind::Color,
819        apply: Apply::SpecColor(|s, c| s.scrollbar_color(c)),
820        doc: "The thumb at rest; the default is the theme's `scrollbar` role, a translucent wash over whatever it sits on.",
821    },
822    PropDef {
823        name: "scrollbarActiveColor",
824        id: P_SCROLLBAR_ACTIVE_COLOR,
825        kind: Kind::Color,
826        apply: Apply::SpecColor(|s, c| s.scrollbar_active_color(c)),
827        doc: "The thumb under the pointer or while dragged; the default is the theme's `scrollbar_active` role.",
828    },
829    PropDef {
830        name: "overscroll",
831        id: P_OVERSCROLL,
832        kind: Kind::Enum(OVERSCROLLS),
833        apply: Apply::SpecEnum(|s, i| s.overscroll(crate::spec::Overscroll::ALL[i])),
834        doc: "What a scroll gesture that starts over this scroller does when it is already at its limit that way (backlog F107, CSS's `overscroll-behavior`): `auto` (the default) passes the gesture on to the scroller around it, `contain` keeps it here, moving nothing until it turns back. A gesture picks its target once, when it starts — the innermost scroller under the pointer that can still move the way it goes — and keeps it until it ends, wherever the pointer or the content has gone; one that reaches a limit midway stops there, whatever this says. Only on the axes the node scrolls: a `scrollY` list that contains still passes a sideways swipe to the strip around it. For a panel or a popup's list whose scrolling must never move what is behind it.",
835    },
836    PropDef {
837        name: "disabled",
838        id: P_DISABLED,
839        kind: Kind::Flag,
840        apply: Apply::SpecFlag(|s| s.disabled(true)),
841        doc: "Inert: no click, drag or key sink, no hover / pressed / focus background, skipped by Tab, reported disabled to assistive technology; hover tracking stays so a `tooltip` can say why.",
842    },
843    PropDef {
844        name: "hoverBg",
845        id: P_HOVER_BG,
846        kind: Kind::Color,
847        apply: Apply::SpecColor(|s, c| s.hover_bg(c)),
848        doc: "Background while hovered (or while any node in its hoverGroup is); implies hover tracking, eases with `transition`.",
849    },
850    PropDef {
851        name: "gradient",
852        id: P_GRADIENT,
853        kind: Kind::Gradient,
854        apply: Apply::SpecGradient(|s, g| s.gradient(g)),
855        doc: "A gradient painted over the node's `bg` and under its border and its children (`docs/adr/0042-a-gradient-is-an-image-the-core-paints.md`): `{ to: 'bottom', stops: [...] }` towards a side or a corner (`right`, `bottom left`, …; the default is `bottom`), `{ angle: 0.125, stops }` in turns clockwise from east, or `{ radial: true, at: [0.5, 0], stops }` out from a centre (fractions of the box, the middle by default) to its farthest corner. A stop is a colour — a `$token` too — or `[colour, position]` with the position 0 to 1; stops without one are spaced evenly between those with. Two stops at one position are a hard edge. The gradient is defined on the box's unit square and stretched to it, so a side or a corner is CSS's and any other `angle` runs corner to corner at an eighth of a turn whatever the box's aspect, where CSS's pixel-measured `45deg` does not. Stops mix in straight sRGB with the alpha premultiplied, as CSS's do. What it costs is one image quad: the core rasterizes each distinct gradient once into the glyph atlas — a 256-texel strip along an axis, a 128-texel square otherwise, within half an 8-bit level of the gradient computed per pixel for a linear one and 1.2 for a radial — keyed by the gradient and not the box, so a box that resizes and a thousand boxes that share one rasterize nothing, and a host that draws an image draws it; a gradient box costs about 55 ns over a flat one, so ten thousand of them are half a millisecond. A hard edge is as soft as the raster stretched to the box (a 256th of its length along a strip); stripes are boxes. It does not tween — `transition` eases the `bg` under it and `opacity` fades it — and `hoverBg` and the other state backgrounds replace `bg`, not the gradient; one that changes every frame is a raster a frame, and a shimmer is a `fragment`'s. Ignored on a `line`, a `polygon` and a `path`. Fewer than two stops are an error in JSX and Lua, as a malformed `keyframes` is, and draw nothing in Rust and C.",
856    },
857    PropDef {
858        name: "rules",
859        id: P_RULES,
860        kind: Kind::Color,
861        apply: Apply::SpecColor(|s, c| s.rules(c)),
862        doc: "On a table (`dir=\"table\"`, ADR 0033): grid lines of this colour between its columns and between its rows (backlog DX21) — down the middle of each gap between the columns of its widest row, from the first row's top to the last row's bottom, and across the middle of each gap between rows, the content box wide. Drawn with the table's box, under its cells and on whole pixels, so give the table and its rows a `gap` at least `ruleWidth` for the lines to show between cells; the outer edge is the table's `border`. Ignored on anything but a table.",
863    },
864    PropDef {
865        name: "ruleWidth",
866        id: P_RULE_WIDTH,
867        kind: Kind::F32,
868        apply: Apply::SpecF32(|s, v| s.rule_width(v)),
869        doc: "The width of a table's `rules` in logical px; 1 when unset.",
870    },
871    PropDef {
872        name: "dropBg",
873        id: P_DROP_BG,
874        kind: Kind::Color,
875        apply: Apply::SpecColor(|s, c| s.drop_bg(c)),
876        doc: "Background while files dragged in from the OS are over this node (ADR 0031); wins over pressedBg, focusBg and hoverBg, clears when they leave, land or the drag is cancelled. Implies hover tracking, eases with `transition`.",
877    },
878    PropDef {
879        name: "pressedBg",
880        id: P_PRESSED_BG,
881        kind: Kind::Color,
882        apply: Apply::SpecColor(|s, c| s.pressed_bg(c)),
883        doc: "Background while pressed (or while its hoverGroup is); implies hover tracking.",
884    },
885    PropDef {
886        name: "focusBg",
887        id: P_FOCUS_BG,
888        kind: Kind::Color,
889        apply: Apply::SpecColor(|s, c| s.focus_bg(c)),
890        doc: "Background while the node holds keyboard-visible focus (moved there by Tab or assistive technology, not a click); replaces the default focus ring. Pressed wins over focus wins over hover; eases with `transition`.",
891    },
892    PropDef {
893        name: "modal",
894        id: P_MODAL,
895        kind: Kind::Tag,
896        apply: Apply::SpecMsg(|s, v| s.modal(v)),
897        doc: "Modal surface: the Tab ring becomes this node's subtree, everything outside it is inert to the pointer, the wheel and assistive technology, and Escape or a press outside emits {kind:\"dismiss\", reason:\"escape\"|\"outside\", tag} on it — the app stops declaring the node. The last one declared in tree order is the one in effect (a confirm inside a dialog); a modal that must cover the app is a float. The access tree is not pruned to the modal: it keeps every node of the frame and marks the one in effect `modal` (`docs/adr/0003-modal-surfaces.md`, decision 7), which is what assistive technology acts on.",
898    },
899    PropDef {
900        name: "initialFocus",
901        id: P_INITIAL_FOCUS,
902        kind: Kind::Flag,
903        apply: Apply::SpecFlag(|s| s.initial_focus()),
904        doc: "Where focus lands when the enclosing `modal` scope is entered: the first node in the modal\'s Tab ring declaring it, so a destructive confirm opens on its Cancel rather than on whichever control is declared first. Read on entry only — a Tab press afterwards stands, and the scope re-entered (a nested confirm closing) leaves focus where it was. Declared on nothing, or only on nodes the ring skips (disabled, `role=\"none\"`, not focusable), entry stays the ring\'s first node.",
905    },
906    PropDef {
907        name: "hoverGroup",
908        id: P_HOVER_GROUP,
909        kind: Kind::Str,
910        apply: Apply::SpecStr(|s, name| s.hover_group(name)),
911        doc: "Nodes sharing a group name show hoverBg/pressedBg together (a split button, a multi-piece shape).",
912    },
913    PropDef {
914        name: "onHover",
915        id: P_ON_HOVER,
916        kind: Kind::Tag,
917        apply: Apply::SpecMsg(|s, v| s.on_hover(v)),
918        doc: "Hover tag: the pointer entering/leaving emits {kind:\"hover\", phase:\"enter\"|\"leave\", tag} events.",
919    },
920    PropDef {
921        name: "onDrop",
922        id: P_ON_DROP,
923        kind: Kind::Tag,
924        apply: Apply::SpecMsg(|s, v| s.on_drop(v)),
925        doc: "Drop-zone tag (`docs/adr/0031-a-drop-zone-is-a-row-and-the-files-are-an-event.md`): files dragged in from the OS over this node emit {kind:\"drop\", phase:\"enter\"|\"move\"|\"leave\"|\"drop\", paths, x, y, tag} — `paths` the OS paths as strings, `x`/`y` the pointer in logical viewport coordinates (absent on `leave`). The zone under the files is the topmost zone by paint order: a node inside a zone is the zone's (a button in it, a field in it), and a node that is no zone and has none enclosing it is looked past, so an overlay shown on `enter` cannot make the zone lose the files. No `leave` follows a `drop`; a drop off every zone is refused by the driver. Implies hover tracking. No access row — a screen-reader user's way in is a button beside the zone. On Windows and Linux the position is the OS cursor at enter and release only, so `move` never fires there.",
926    },
927    PropDef {
928        name: "onLayout",
929        id: P_ON_LAYOUT,
930        kind: Kind::Tag,
931        apply: Apply::SpecMsg(|s, v| s.on_layout(v)),
932        doc: "Layout tag: the node's laid-out rect arrives as {kind:\"layout\", x, y, w, h, parent, tag} on its first frame and whenever it changes (needs a stable key).",
933    },
934    PropDef {
935        name: "onClick",
936        id: P_ON_CLICK,
937        kind: Kind::Msg,
938        apply: Apply::SpecMsg(|s, v| s.on_click(v)),
939        doc: "Message emitted when clicked (data, not a callback).",
940    },
941    PropDef {
942        name: "onDrag",
943        id: P_ON_DRAG,
944        kind: Kind::Tag,
945        apply: Apply::SpecMsg(|s, v| s.on_drag(v)),
946        doc: "Drag tag: emits {kind:\"drag\", phase, x, y, dx, dy, parent, tag} events, `dx`/`dy` measured from the press point in every phase. On a `cells` grid the events also carry `cell: {row, col}`; inside an `onKey` sink that draws `role=\"line\"` rows they carry `line`, `byte` and `clicks` — see the events table.",
947    },
948    PropDef {
949        name: "onKey",
950        id: P_ON_KEY,
951        kind: Kind::Tag,
952        apply: Apply::SpecMsg(|s, v| s.on_key(v)),
953        doc: "Key-sink tag: with key focus held, presses arrive as {kind:\"key\", phase:\"down\", code, ...} events. Releases only with `keyUp` beside it.",
954    },
955    PropDef {
956        name: "keyUp",
957        id: P_KEY_UP,
958        kind: Kind::Flag,
959        apply: Apply::SpecFlag(|s| s.key_up()),
960        doc: "With `onKey`: releases arrive too, as the same payload with phase:\"up\" (`text` null, `repeat` false) — for a held-key interaction (WASD, press-and-hold, a key that arms a mode while it is down). A key only comes up where it went down: a release whose press the sink never got is dropped, and focus leaving while a key is held delivers the `up` first, so nothing is left stuck down. Without it a sink hears presses only, which is what a keymap wants — one that heard both halves would run every binding twice.",
961    },
962    PropDef {
963        name: "modifierKeys",
964        id: P_MODIFIER_KEYS,
965        kind: Kind::Flag,
966        apply: Apply::SpecFlag(|s| s.modifier_keys()),
967        doc: "With `onKey`: the modifier and lock keys arrive as keys of their own (backlog F108) — `code` \"shift\", \"ctrl\", \"alt\", \"super\", \"capslock\", \"numlock\", \"scrolllock\", which side in `location` (\"left\" / \"right\"), releases too with `keyUp`. Without it a modifier is only ever held — the next key's `shift`, `ctrl`, … and the `modifiers` event — so a keymap mid-sequence never reads a Shift as a key between two others. For a terminal speaking kitty's keyboard protocol, or a game that binds a lone Shift.",
968    },
969    PropDef {
970        name: "onContextMenu",
971        id: P_ON_CONTEXT_MENU,
972        kind: Kind::Tag,
973        apply: Apply::SpecMsg(|s, v| s.on_context_menu(v)),
974        doc: "Context-menu tag: a secondary-button (right) press emits {kind:\"contextmenu\", x, y, tag} on the node, at the logical viewport point to open the menu at. The press moves no focus, places no caret and produces no click, so right-clicking a selection keeps it. Asked of the topmost node under the pointer, and when that node offers no menu the press reaches the nearest enclosing node that does — a container declaring a menu for everything inside it is the common case — the way an unclaimed key reaches the enclosing sink (`docs/adr/0011`): the event carries the *owner's* key and tag, a nested declaration wins over its ancestor's, a disabled node's own is skipped, and the walk stops at the modal boundary.",
975    },
976    PropDef {
977        name: "onForceClick",
978        id: P_ON_FORCE_CLICK,
979        kind: Kind::Tag,
980        apply: Apply::SpecMsg(|s, v| s.on_force_click(v)),
981        doc: "Force-click tag: a press that deepens past the second stage of a Force Touch trackpad emits {kind:\"forceclick\", x, y, tag} on the node, at the logical viewport point it happened at (`docs/adr/0017-selection-as-a-scope.md`). Routed as a secondary press is — no focus moved, no caret placed, no click — but asked of the topmost node only, with no walk to an enclosing declaration — and the ordinary click the press is still producing arrives afterwards, as it does on macOS. Text needs none of this: a force click over an `edit` or a `selectable` scope selects the word under it and asks the host for its Look Up panel. macOS-only in practice, and there the user can switch the gesture off, so nothing may declare itself the only way to reach something.",
982    },
983    PropDef {
984        name: "onButton",
985        id: P_ON_BUTTON,
986        kind: Kind::Tag,
987        apply: Apply::SpecMsg(|s, v| s.on_button(v)),
988        doc: "Button tag (backlog F105): a press of a non-primary button — middle, secondary, or one past those — emits {kind:\"button\", phase:\"press\", button, x, y, clicks, tag} on the node, and the button is then captured by it: every pointer move while it is held arrives as phase:\"move\" and its release as phase:\"release\", on this node wherever the pointer is. `button` is `\"secondary\"`, `\"middle\"` or a further button's number (3 and up); `x`/`y` are logical viewport coordinates, and on a `cells` grid each event carries `cell: {row, col}` as a click does. Several buttons can be held at once, each its own capture, and a primary drag is untouched. `buttons` says which buttons it claims — all of them unless it narrows them. Asked of the topmost node under the pointer, and when that node claims no such button the press reaches the nearest enclosing node that does, the way a context menu's does: a disabled node's own is skipped and the walk stops at the modal boundary. A claimed secondary press is this event *instead of* a `contextmenu` event and the stock menu (a nearer `onContextMenu` still wins, being the nested declaration). Like every non-primary press it moves no focus, places no caret and touches no selection or scrollbar. For a terminal's middle-click paste, and the mouse reports a program in it asked for.",
989    },
990    PropDef {
991        name: "buttons",
992        id: P_BUTTONS,
993        kind: Kind::Str,
994        apply: Apply::SpecStr(|s, v| s.buttons(crate::input::Buttons::parse(v))),
995        doc: "Which non-primary buttons `onButton` claims (backlog F105): `\"secondary\"`, `\"middle\"` and `\"other\"` (every button past those), separated by spaces or commas — `\"middle\"`, `\"secondary middle\"`. Unset, all three: a node that wants the middle button and leaves the secondary one to its context menu says `\"middle\"`. A word that is none of the three is skipped, so a string of none of them claims nothing, and a typo never takes the secondary button from a context menu. Meaningless without `onButton`.",
996    },
997    PropDef {
998        name: "onScroll",
999        id: P_ON_SCROLL,
1000        kind: Kind::Tag,
1001        apply: Apply::SpecMsg(|s, v| s.on_scroll(v)),
1002        doc: "Scroll tag: the wheel over this node emits {kind:\"scroll\", x, y, dx, dy, lines, tag} on it instead of scrolling anything — `dx`/`dy` the delta in logical px as the driver reported it (positive `dy` is the wheel rolling up, toward earlier content), `x`/`y` the pointer, and `lines` on a `cells` grid the whole lines the delta covers (positive = later history, the sign `originLine` grows in; the fraction is carried to the next notch so a trackpad's small steps add up) and null on any other node. The node takes the wheel on the axes `scrollAxes` names (both unless it narrows them): a gesture that starts over it is its own whether or not it has anywhere to go — except on an axis the node also scrolls (`scrollX`/`scrollY`, its offset the app's to set), where it is answered by its room as a container is, so at its edge a gesture that way passes to the scroller around it (backlog F118) — and stays its own until it ends, wherever the pointer goes (backlog F107); it reaches no scroll container above it, and a scroller inside it still takes the axes it scrolls while it can move that way, passing this node the rest — the other axis, and a gesture that begins with that scroller at its limit (`overscroll: \"contain\"` on the scroller keeps it there). The core moves nothing — a grid re-declares `originLine`, a canvas zooms. A drag-select held past a `cells` grid's top or bottom edge arrives here too, once a frame with the lines that frame scrolled by (`docs/adr/0029-a-selection-follows-the-pointer-past-the-edge.md`).",
1003    },
1004    PropDef {
1005        name: "scrollAxes",
1006        id: P_SCROLL_AXES,
1007        kind: Kind::Enum(SCROLL_AXES),
1008        apply: Apply::SpecEnum(|s, i| s.scroll_axes(crate::spec::ScrollAxes::ALL[i])),
1009        doc: "Which axes `onScroll` takes (backlog F107): `both` (the default), `x` or `y`. A scroll gesture on an axis the node does not take passes it by, to the scroller around it, and hears nothing here: a terminal that scrolls its history says `y`, and a sideways swipe that starts over it moves the strip it sits in. (A swipe that started elsewhere is not the node's either way: a gesture keeps the target it started with.) Meaningless without `onScroll`.",
1010    },
1011    PropDef {
1012        name: "scrollMods",
1013        id: P_SCROLL_MODS,
1014        kind: Kind::Str,
1015        apply: Apply::SpecStr(|s, v| s.scroll_mods(crate::input::KeyMods::parse(v))),
1016        doc: "The modifiers `onScroll` is for (backlog F122): `\"shift\"`, `\"ctrl\"`, `\"alt\"` and `\"super\"` (⌘, the Windows key), separated by spaces or commas — `\"ctrl super\"`. With any named, the node hears only a scroll gesture that began with one of them held, and hears it first: ahead of every scroll container and every `onScroll` that names none, wherever under the pointer the gesture began, the innermost such node winning — so a Ctrl-wheel zoom declared on the window's root is heard over a list, and the list does not scroll. A wheel with none of them held passes the node by, as if it had no `onScroll`: a node that scrolls as well (`overflow`) scrolls for it as any container does. Its `scroll` events carry `mods`, the modifiers held when the gesture began; the gesture stays the node's to the end of its glide, whatever is let go meanwhile, and one begun without them never becomes its. A word that is none of the four is skipped. Unset, a handler like any other. Meaningless without `onScroll`.",
1017    },
1018    PropDef {
1019        name: "window",
1020        id: P_WINDOW,
1021        kind: Kind::Enum(WINDOW_ROLES),
1022        apply: Apply::SpecEnum(|s, i| match i {
1023            0 => s.window_drag(),
1024            1 => s.window_button(WindowButton::Close),
1025            2 => s.window_button(WindowButton::Minimize),
1026            3 => s.window_button(WindowButton::Maximize),
1027            _ => s,
1028        }),
1029        doc: "Window-chrome role: interactions become window commands, not events.",
1030    },
1031    PropDef {
1032        name: "cursor",
1033        id: P_CURSOR,
1034        kind: Kind::Enum(CURSORS),
1035        apply: Apply::SpecEnum(|s, i| s.cursor(cursor_idx(i))),
1036        doc: "The pointer shape over this node. Unset, the pointer is `text` over an editor or a `selectable` scope and `default` over everything else — an `onClick`, `focusable` or `onDrag` node included, as a native button is — so a hand (`pointer`) over a control, a `grab` over a handle (and `grabbing` while its drag runs, which the view declares as its drag state changes), a splitter's `ewResize` / `nsResize` and a `disabled` control's `notAllowed` are all declared. The stock `button` declares `pointer` itself. A captured drag keeps the dragged node's shape wherever the pointer goes.",
1037    },
1038    PropDef {
1039        name: "transition",
1040        id: P_TRANSITION,
1041        kind: Kind::F32,
1042        apply: Apply::SpecF32(|s, v| s.transition(v)),
1043        doc: "Animate sizing/colors/radius changes over this many ms — and, on a scroll container, the offset a reveal or a set_scroll moves it to (needs a stable key).",
1044    },
1045    PropDef {
1046        name: "easing",
1047        id: P_EASING,
1048        kind: Kind::Enum(EASINGS),
1049        apply: Apply::SpecEnum(|s, i| s.easing(easing_idx(i))),
1050        doc: "Easing for `transition` (default easeOut). The springs — `smooth` (no overshoot), `snappy`, `spring` and `bouncy` (the most), each a `bounce` of its own — integrate with momentum, so a value retargeted mid-flight keeps moving the way it was; `transition` is then about how long one takes to get there.",
1051    },
1052    PropDef {
1053        name: "bounce",
1054        id: P_BOUNCE,
1055        kind: Kind::F32,
1056        apply: Apply::SpecF32(|s, v| s.bounce(v)),
1057        doc: "How far a spring overshoots its target: 0 glides in with none, 0.5 bounces visibly, and values past 0.9 are held there (a spring at 1 would never settle). It replaces a spring `easing`'s own bounce (`smooth` 0, `snappy` 0.15, `spring` 0.25, `bouncy` 0.5), and on a timed easing makes the transition a spring — so `transition` plus `bounce` is a spring of that length and bounce.",
1058    },
1059    PropDef {
1060        name: "slide",
1061        id: P_SLIDE,
1062        kind: Kind::Flag,
1063        apply: Apply::SpecFlag(|s| s.slide()),
1064        doc: "With transition: also ease the node's position (reordered siblings slide). While it eases, the node is drawn between where it was and where this frame put it — not at the declared `dx`/`dy`, or its slot in the row — so anything else positioned from those numbers drifts for the transition's length: a canvas of floats eases everything or nothing.",
1065    },
1066    PropDef {
1067        name: "keyframes",
1068        id: P_KEYFRAMES,
1069        kind: Kind::Keyframes,
1070        apply: Apply::SpecKeyframes(|s, k| s.keyframes(k)),
1071        doc: "CSS-style stops `[{ at?, width?, height?, bg?, radius?, opacity? }, …]`: the slots they name cycle through them over `transition` ms, forever, without the view redrawing; `at` is 0..1 and spreads evenly when omitted.",
1072    },
1073    PropDef {
1074        name: "enter",
1075        id: P_ENTER,
1076        kind: Kind::Enter,
1077        apply: Apply::SpecEnter(|s, e| s.enter(e)),
1078        doc: "Where the node starts the first frame it is seen `{ dx?, dy?, width?, height?, bg?, radius?, opacity? }`: those slots ease in from there over `transition` ms instead of snapping (`dx`/`dy` slide it in from that far away, `opacity: 0` fades the whole subtree in).",
1079    },
1080    PropDef {
1081        name: "exit",
1082        id: P_EXIT,
1083        kind: Kind::Enter,
1084        apply: Apply::SpecEnter(|s, e| s.exit(e)),
1085        doc: "Where the node ends the frame after the view stops declaring it `{ dx?, dy?, width?, height?, bg?, radius?, opacity? }` — an `enter` read the other way. It plays when the node itself is removed, its parent still declared; a node that goes because an ancestor went — a tab switched away, a panel closed around it — goes at once with it, unless that ancestor has an `exit` of its own, whose picture carries it (backlog DX19; React's `AnimatePresence` rule). With a `transition`, the departing subtree is copied out of the last frame that had it and replayed frozen, in its place (the pass it painted in, just under the node that painted after it — a panel under a HUD leaves under it) and inert (no clicks, no Tab stop, no access row) while those slots ease from where they were, then dropped; without one it vanishes at once as it always did. `width`/`height` resize the departing node's own box only — the subtree inside it is a picture and is not laid out again. Needs a stable key across frames.",
1086    },
1087    PropDef {
1088        name: "repeat",
1089        id: P_REPEAT,
1090        kind: Kind::Enum(REPEATS),
1091        apply: Apply::SpecEnum(|s, i| s.repeat(repeat_idx(i))),
1092        doc: "How `keyframes` cycle (CSS `animation-direction`, default normal). Lua: `direction`, since `repeat` is a keyword.",
1093    },
1094    PropDef {
1095        name: "delay",
1096        id: P_DELAY,
1097        kind: Kind::F32,
1098        apply: Apply::SpecF32(|s, v| s.delay(v)),
1099        doc: "Holds the `keyframes` cycle back by this many ms (CSS `animation-delay`); siblings with different delays run out of phase.",
1100    },
1101    PropDef {
1102        name: "clickSound",
1103        id: P_CLICK_SOUND,
1104        kind: Kind::Resource,
1105        apply: Apply::SpecResource(|s, id| s.click_sound(crate::resources::SoundId::from_ffi(id))),
1106        doc: "A registered sound (addSound) played when the node is clicked; implies hover tracking.",
1107    },
1108    PropDef {
1109        name: "hoverSound",
1110        id: P_HOVER_SOUND,
1111        kind: Kind::Resource,
1112        apply: Apply::SpecResource(|s, id| s.hover_sound(crate::resources::SoundId::from_ffi(id))),
1113        doc: "A registered sound (addSound) played when the pointer enters the node; implies hover tracking.",
1114    },
1115    PropDef {
1116        name: "lineHeight",
1117        id: P_LINE_HEIGHT,
1118        kind: Kind::F32,
1119        apply: Apply::StyleF32(|t, v| t.line_height(v)),
1120        doc: "Line height (logical px); default size * 1.35.",
1121    },
1122    PropDef {
1123        name: "color",
1124        id: P_COLOR,
1125        kind: Kind::Color,
1126        apply: Apply::StyleColor(|t, c| t.color(c)),
1127        doc: "Text color; default foreground when omitted.",
1128    },
1129    PropDef {
1130        name: "family",
1131        id: P_FAMILY,
1132        kind: Kind::Family,
1133        apply: Apply::StyleFamily(|t, f| t.family(f)),
1134        doc: "Font family: `sans`, `serif` or `mono`, kui's own, or the name of an installed family or one loaded with `loadFontsDir` / `loadFontFile` — `\"Berkeley Mono\"` — drawn in its face in the frame that names it (ADR 0037). A name is matched as `addSystemFont` matches it and registered in the session on first sight, exactly as the font database spells it (`\"menlo\"` is not `\"Menlo\"`); the session's first registration of any font maps the installed font files once (~30 ms on a Mac, backlog DX24), which a family named in a view pays in that frame. `systemFonts()` lists the names there are. A name nothing matches shapes as sans and raises `unknown-family`. It and `font` set the same thing, so declare one.",
1135    },
1136    PropDef {
1137        name: "font",
1138        id: P_FONT,
1139        kind: Kind::Resource,
1140        apply: Apply::StyleResource(|t, id| t.font(crate::resources::FontId::from_ffi(id))),
1141        doc: "A registered font handle (addFont / addSystemFont); overrides `family`.",
1142    },
1143    PropDef {
1144        name: "wrap",
1145        id: P_WRAP,
1146        kind: Kind::Enum(WRAPS),
1147        apply: Apply::StyleEnum(|t, i| match i {
1148            1 => t.wrap(TextWrap::Glyph),
1149            2 => t.wrap(TextWrap::None),
1150            3 => t.wrap(TextWrap::BreakSpaces),
1151            _ => t.wrap(TextWrap::Word),
1152        }),
1153        doc: "Line breaking at the node's width: between words (default), anywhere, never (one line per paragraph, clipped to the node), or between words with whitespace taking its room (`break-spaces`: a space that does not fit starts the next row rather than hanging past the edge — an editor's wrapped line). On a single-line `edit` — a field, which otherwise takes one line and scrolls it — declaring it is what makes the field fold to its width like a document, by this mode, while Enter still submits (see `edit`).",
1154    },
1155    PropDef {
1156        name: "maxLines",
1157        id: P_MAX_LINES,
1158        kind: Kind::F32,
1159        apply: Apply::StyleF32(|t, v| t.max_lines(v.max(0.0) as u32)),
1160        doc: "Lay out at most this many lines (0 = unlimited); with `ellipsis`, a line clamp.",
1161    },
1162    PropDef {
1163        name: "ellipsis",
1164        id: P_ELLIPSIS,
1165        kind: Kind::Flag,
1166        apply: Apply::StyleFlag(|t| t.ellipsis()),
1167        doc: "End the last line with an ellipsis when the text is cut off: a single line unless `maxLines` says otherwise.",
1168    },
1169    PropDef {
1170        name: "underline",
1171        id: P_UNDERLINE,
1172        kind: Kind::Flag,
1173        apply: Apply::StyleFlag(|t| t.underline()),
1174        doc: "A line under the text, where the face puts its underline and as thick as it says, in the text colour. Paint only. On a `<span>` it covers the span alone and follows it across a wrap, one rect per line. `underlineColor` gives it a colour of its own and `underlineStyle` a shape; either implies it.",
1175    },
1176    PropDef {
1177        name: "underlineColor",
1178        id: P_UNDERLINE_COLOR,
1179        kind: Kind::Color,
1180        apply: Apply::StyleColor(|t, c| t.underline_color(c)),
1181        doc: "The underline's own colour — a diagnostic's red under keyword-coloured text (backlog K4). Implies `underline`. On a `<span>` the span's; a span with no colour of its own takes the text's.",
1182    },
1183    PropDef {
1184        name: "underlineStyle",
1185        id: P_UNDERLINE_STYLE,
1186        kind: Kind::Enum(UNDERLINE_STYLES),
1187        apply: Apply::StyleEnum(|t, i| t.underline_style(UnderlineStyle::from_index(i as u32))),
1188        doc: "The underline's shape (backlog K4): `solid` (the face's line), `wavy` (three strokes tall around the line, a six-stroke period — a diagnostic's squiggle, a terminal's undercurl) or `dotted` (dots two strokes across, four apart). Implies `underline`. A wave or dots are runs of the segment primitive a `line` draws, so no backend learns a kind; the cost is two quads per period.",
1189    },
1190    PropDef {
1191        name: "strikethrough",
1192        id: P_STRIKETHROUGH,
1193        kind: Kind::Flag,
1194        apply: Apply::StyleFlag(|t| t.strikethrough()),
1195        doc: "A line through the text, where the face puts its strikeout. Paint only; on a `<span>` the span alone, per line.",
1196    },
1197    PropDef {
1198        name: "features",
1199        id: P_FEATURES,
1200        kind: Kind::Str,
1201        apply: Apply::StyleStr(|t, s| t.features(crate::spec::FontFeatures::parse(s))),
1202        doc: "OpenType features for the shaper, as `tag=value` pairs separated by spaces or commas — a bare `tag` is 1, `-tag` is 0: `\"liga=0 calt=0\"` keeps a coding font from joining `->` and `!=` (what a terminal built on runs needs to hold its grid), `\"tnum\"` lines figures up in a gutter, `\"ss01\"` picks a stylistic set. Unset, the font's own defaults apply. At most 8; part of what the text is shaped as, so two texts differing only here are shaped twice.",
1203    },
1204    PropDef {
1205        name: "role",
1206        id: P_ROLE,
1207        kind: Kind::Enum(ROLES),
1208        apply: Apply::SpecEnum(|s, i| s.role(role_idx(i))),
1209        doc: "What the node is to assistive technology. Unset, the core derives one (an `onClick` node is a button, an editor a text input, a scrolling box a scroll view, a plain box nothing); `none` hides the node and its subtree from the access tree. A `radio` belongs inside a `radioGroup` and a `tab` inside a `tabList`, labelled with what the choice is: the pair is a composite (`docs/adr/0007-composite-keyboard-patterns.md`) — one Tab stop for the set, the arrows, Home and End moving the choice inside it (each step is the item's click, so the choice follows focus), and a screen reader reading \"2 of 3\". A `radio` or `tab` with no container above it is a Tab stop of its own that no arrow moves, and the core warns (`item-outside-container`). `menu` holds `menuItem`s and `list` holds `listItem`s the same way.",
1210    },
1211    PropDef {
1212        name: "label",
1213        id: P_LABEL,
1214        kind: Kind::Str,
1215        apply: Apply::SpecStr(|s, v| s.label(v)),
1216        doc: "The accessible name. Without one a button, link, tab or heading is named by the text inside it; an image, an icon-only button and a `modal` dialog have none, and the core warns (`image-without-label`, `control-without-name`, `modal-without-name`).",
1217    },
1218    PropDef {
1219        name: "description",
1220        id: P_DESCRIPTION,
1221        kind: Kind::Str,
1222        apply: Apply::SpecStr(|s, v| s.description(v)),
1223        doc: "The accessible description: the extra sentence a reader says after the name, for what the name cannot say on its own — what a button will do, why a control is disabled, what format a field wants. `tooltip` is the shorthand that also draws the string and hover-tracks the node; this is the description alone, for a hint that is spoken and never drawn. Both write the one slot, so a node declaring both keeps whichever its binding applied last. It reads only on a node that reaches the access tree — a role, a label, a control — since a plain box is elided and takes its description with it.",
1224    },
1225    PropDef {
1226        name: "checked",
1227        id: P_CHECKED,
1228        kind: Kind::Flag,
1229        apply: Apply::SpecFlag(|s| s.checked(true)),
1230        doc: "The on state of a `checkbox` / `radio` / `switch` role.",
1231    },
1232    PropDef {
1233        name: "mixed",
1234        id: P_MIXED,
1235        kind: Kind::Flag,
1236        apply: Apply::SpecFlag(|s| s.mixed(true)),
1237        doc: "A `checkbox` that is neither on nor off — the select-all box over a list some of whose rows are selected (ADR 0034). Read as mixed by assistive technology whatever `checked` says, and drawn as a dash by the stock `<checkbox>`. Meaningful on the checkbox role alone.",
1238    },
1239    PropDef {
1240        name: "selected",
1241        id: P_SELECTED,
1242        kind: Kind::Flag,
1243        apply: Apply::SpecFlag(|s| s.selected(true)),
1244        doc: "The current one of a set: which `tab` a `tabList` shows, which `listItem` a list has picked, which `link` is the page you are on. A `tab` always carries the state — its siblings read as \"not selected\" — while a list row or a link carries it only where it is set, since an ordinary list or navigation bar is not a selection and a reader saying \"not selected\" on every row of it is noise.",
1245    },
1246    PropDef {
1247        name: "expanded",
1248        id: P_EXPANDED,
1249        kind: Kind::Enum(EXPANDED),
1250        apply: Apply::SpecEnum(|s, i| s.expanded(i == 1)),
1251        doc: "A disclosure's state: what a node that shows and hides something (a twisty, an accordion header, a menu button) reads as. Unset, the node does not expand at all — which is why this names its state instead of being a flag.",
1252    },
1253    PropDef {
1254        name: "live",
1255        id: P_LIVE,
1256        kind: Kind::Enum(LIVE),
1257        apply: Apply::SpecEnum(|s, i| s.live(crate::access::Live::from_index(i))),
1258        doc: "Marks this node a live region: when the text inside it changes, a screen reader reads the change without being asked — `polite` at the next pause, `assertive` interrupting. Put it on the smallest node that holds the message, since everything inside a live node is live. For a one-off with no node behind it (\"Saved\") the binding's `announce` verb is the other half.",
1259    },
1260    PropDef {
1261        name: "valueNow",
1262        id: P_VALUE_NOW,
1263        kind: Kind::F32,
1264        apply: Apply::SpecF32(|s, v| s.value_now(v)),
1265        doc: "A `slider` role's current value (the drawing stays yours; this is what assistive technology reads).",
1266    },
1267    PropDef {
1268        name: "valueMin",
1269        id: P_VALUE_MIN,
1270        kind: Kind::F32,
1271        apply: Apply::SpecF32(|s, v| s.value_min(v)),
1272        doc: "A `slider` role's minimum.",
1273    },
1274    PropDef {
1275        name: "valueMax",
1276        id: P_VALUE_MAX,
1277        kind: Kind::F32,
1278        apply: Apply::SpecF32(|s, v| s.value_max(v)),
1279        doc: "A `slider` role's maximum.",
1280    },
1281    PropDef {
1282        name: "valueText",
1283        id: P_VALUE_TEXT,
1284        kind: Kind::Str,
1285        apply: Apply::SpecStr(|s, v| s.value_text(v)),
1286        doc: "What a `slider` role's position reads as (ARIA's `aria-valuetext`). Without one a reader has only `valueNow` and the range and says a percentage — 25 in [5..60] is \"36 percent\" — so a value whose unit carries the meaning says it here: \"25 minutes\". It replaces the number in the reading rather than joining it, and a nudge announces the new text. Meaningful on the slider role alone, like the three numbers; putting the reading in `label` instead renames the control on every nudge, which is the wrong attribute.",
1287    },
1288    PropDef {
1289        name: "valueStep",
1290        id: P_VALUE_STEP,
1291        kind: Kind::F32,
1292        apply: Apply::SpecF32(|s, v| s.value_step(v)),
1293        doc: "How far one arrow key moves a `slider` role, and the grid a value the pointer sets snaps to (ADR 0034). Unset, a hundredth of the range. PageUp / PageDown move ten steps. Read by the core only where the slider declares `onChange`; reported to assistive technology either way.",
1294    },
1295    PropDef {
1296        name: "onFocus",
1297        id: P_ON_FOCUS,
1298        kind: Kind::Tag,
1299        apply: Apply::SpecMsg(|s, v| s.on_focus(v)),
1300        doc: "Keyboard focus entering or leaving this node's subtree — the node itself, or anything focused inside it — emits `{kind:\"focus\", phase:\"in\"|\"out\", by, tag}` (backlog DX18). `by` is what moved it: `pointer` (a press), `keyboard` (Tab, a key a control answered), `assistive` (a screen reader's request) or `program` (the view or the app — `keyFocus`, `setFocus`, a modal's entry). Reported once the move settles, after the input that made it or at the end of the frame that declared it, so an app hears a pane taking the keyboard instead of diffing the focused key every frame. Leaving is reported innermost first, entering outermost first. It makes nothing focusable or interactive.",
1301    },
1302    PropDef {
1303        name: "onChange",
1304        id: P_ON_CHANGE,
1305        kind: Kind::Tag,
1306        apply: Apply::SpecMsg(|s, v| s.on_change(v)),
1307        doc: "A `slider` role's changes (ADR 0034): the core turns a press on the node into the value under the pointer, a drag into the value under it, the arrows and assistive technology's increment / decrement into one `valueStep`, PageUp / PageDown into ten, Home / End into the range's ends — clamped to `valueMin`..`valueMax` (0..100 unset) and snapped to the step — and emits `{kind:\"change\", value, phase, tag}`: `phase` is `\"move\"` while the pointer holds the slider and `\"end\"` when it lets go or a key moved it. The value is proposed and never applied; the slider moves when the view declares it as `valueNow`. A key that lands where the slider already is proposes nothing. The pointer reads the node's content box along its main axis, so a `dir=\"column\"` slider runs bottom to top. Without it a slider's arrows reach the app as `{kind:\"access\", action}`. Ignored on any other role.",
1308    },
1309    PropDef {
1310        name: "caret",
1311        id: P_CARET,
1312        kind: Kind::F32,
1313        apply: Apply::SpecF32(|s, v| s.caret(v.max(0.0) as u32)),
1314        doc: "On a `line` of a custom editor (a `textInput` / `multilineTextInput` role drawn by the app): the caret's byte offset into that line's text.",
1315    },
1316    PropDef {
1317        name: "selectionAnchor",
1318        id: P_SELECTION_ANCHOR,
1319        kind: Kind::F32,
1320        apply: Apply::SpecF32(|s, v| s.selection_anchor(v.max(0.0) as u32)),
1321        doc: "On a `line` of a custom editor: the byte offset where the selection's other end sits (the caret is `caret`, possibly on another line).",
1322    },
1323    PropDef {
1324        name: "caretSolid",
1325        id: P_CARET_SOLID,
1326        kind: Kind::Flag,
1327        apply: Apply::SpecFlag(|s| s.caret_solid()),
1328        doc: "On a `line` declaring `caret`: the caret is solid — a block caret in a modal editor's normal mode — so the driver's blink clock is not armed on it and `caretVisible` stays true, while the offset still anchors the IME and reads to assistive technology. Without it a declared `caret` is a caret to blink, and the one thing that asks an idle app for a frame twice a second; an editor whose caret only blinks while typing declares this on every other mode's line.",
1329    },
1330];
1331
1332/// A prop every binding handles by hand (a composite with real logic, or a
1333/// constructor-order special), with its wire id so transports agree on
1334/// identity and its per-binding spelling so the docs can say so.
1335pub struct CustomProp {
1336    pub name: &'static str,
1337    pub id: u32,
1338    /// Every prop name a JSX view may write for it — the machine-readable
1339    /// half of `jsx`, which is prose for the docs. A composite is spelled
1340    /// differently in each binding (`borderW` here, `border = {…}` there),
1341    /// so the two lists are separate; together with `PROPS` and an element's
1342    /// own props they are the whole allow-list a binding checks a view
1343    /// against (see [`known_prop`]).
1344    pub jsx_names: &'static [&'static str],
1345    /// The same for a Lua node table.
1346    pub lua_names: &'static [&'static str],
1347    /// How JSX spells it.
1348    pub jsx: &'static str,
1349    /// How a Lua table spells it.
1350    pub lua: &'static str,
1351    /// Where it lands in C.
1352    pub c: &'static str,
1353    pub doc: &'static str,
1354}
1355
1356pub const CUSTOM: &[CustomProp] = &[
1357    CustomProp {
1358        name: "dir",
1359        id: P_DIR,
1360        jsx_names: &["dir"],
1361        lua_names: &[],
1362        jsx: "`dir=\"row\" | \"column\" | \"table\"`",
1363        lua: "`row { }` / `column { }` / `grid { }`",
1364        c: "`dir` (`KUI_ROW` / `KUI_COLUMN` / `KUI_TABLE`)",
1365        doc: "Main axis; column is the default. `table` is a column whose rows' children line up in columns (the `table` element).",
1366    },
1367    CustomProp {
1368        name: "size",
1369        id: P_SIZE,
1370        jsx_names: &["size"],
1371        lua_names: &["size"],
1372        jsx: "`size` (text)",
1373        lua: "`size`",
1374        c: "`KuiTextStyle.size`",
1375        doc: "Font size in logical px; the text style is constructed from it, so declare it for the other style props to apply at that size.",
1376    },
1377    CustomProp {
1378        name: "pad",
1379        id: P_PAD,
1380        jsx_names: &["pad", "padX", "padY", "padL", "padR", "padT", "padB"],
1381        lua_names: &["pad"],
1382        jsx: "`pad`, `padX`, `padY`, `padL`, `padR`, `padT`, `padB`",
1383        lua: "`pad = n` or `pad = { all=, x=, y=, l=, r=, t=, b= }`",
1384        c: "`pad_l`, `pad_r`, `pad_t`, `pad_b`",
1385        doc: "Padding; a frontend reports the names it saw and `PadShorthand::resolve` turns them into four edges — an edge falls back to its axis, an axis to the all-round `pad`, and the specific one always wins.",
1386    },
1387    CustomProp {
1388        name: "border",
1389        id: P_BORDER,
1390        jsx_names: &["borderW", "borderColor"],
1391        lua_names: &["border"],
1392        jsx: "`borderW`, `borderColor`",
1393        lua: "`border = { w=, color= }`",
1394        c: "`border_w`, `border_color`",
1395        doc: "Border width and color (drawn inside the rect).",
1396    },
1397    CustomProp {
1398        name: "overflow",
1399        id: P_OVERFLOW,
1400        jsx_names: &["clip", "scrollX", "scrollY"],
1401        lua_names: &["clip", "scroll", "scroll_x", "scroll_y"],
1402        jsx: "`clip`, `scrollX`, `scrollY`",
1403        lua: "`clip`, `scroll_x`, `scroll_y` (`scroll` = `scroll_y`)",
1404        c: "`overflow` bits `KUI_CLIP` | `KUI_SCROLL_X` | `KUI_SCROLL_Y`",
1405        doc: "Clip children; scroll (implies clip) with retained offsets and live scrollbars. A `radius` on the same node rounds the clip, so a rounded card does not show square corners poking out of it; nesting two rounded clippers keeps only the corners neither of them moved, and hit-testing stays rectangular. Every frontend ORs the same bits and hands them to `NodeSpec::overflow_bits`. The wheel goes to the scroller under the pointer on the axes it scrolls, and the rest of the notch to the one around it: a `scrollY` list inside a `scrollX` strip moves the strip on a sideways swipe (backlog DX13). A scroll gesture — a swipe and its glide, a wheel spun without a pause — picks that scroller when it starts, skipping one already at its limit that way for the one around it (unless it says `overscroll: contain`), and keeps it until it ends, so content moving under a still pointer does not hand the rest of a swipe to what came under it (backlog F107). An offset is kept while the key is declared; an undeclared one is kept until the budget needs the room (1024 undeclared entries, longest-undeclared evicted first).",
1406    },
1407    CustomProp {
1408        name: "float",
1409        id: P_FLOAT,
1410        jsx_names: &["float"],
1411        lua_names: &["float"],
1412        jsx: "`float=\"below\" | \"above\" | \"parent\" | \"viewport\"` or `{ anchor, at, self, dx, dy, fit, clip }`",
1413        lua: "`float = \"below\"` or `float = { anchor=, at=, self=, dx=, dy=, fit=, clip= }`",
1414        c: "`float_mode`, `float_anchor_x/y`, `float_self_x/y`, `float_dx/dy`, `float_fit`, `float_clip`; `kui_spec_float_preset` fills them from a preset name",
1415        doc: "Out-of-flow positioning against the parent or the viewport; `fit` flips/clamps to stay on screen. A float escapes every ancestor's clip — a tooltip is not cut by the scroller it hangs from — unless it declares `clip` and is anchored to its parent (`parent`, `below`, `above`): then the parent's clip holds it as it holds a child, so a node on a `clip` canvas panned past the canvas's edge is cut there and cannot be hit past it; it still paints as a layer over its in-flow siblings. A `line`, `polygon` or `path` in its parent's box is always clipped this way. The four preset names resolve in `FloatConfig::preset`, and `anchor` takes any of them — an override left out keeps the preset's own value, so `{ anchor: \"below\", dx: 4 }` still hangs below with its 6px gap. A float is a layer of its own: above the in-flow tree and every float that opened before it, under every float that opened after, and hit-tested in the same order — so a tooltip that appears over an open menu is over it, and a popover over a scroller's bar takes the press there. A scroller's bars and the focus ring belong to the layer that owns them. There is no z-index; a float declared under a fresh key reopens on top (`docs/adr/0023-layers-stack-in-the-order-they-open.md`).",
1416    },
1417    CustomProp {
1418        name: "keyFocus",
1419        id: P_KEY_FOCUS,
1420        jsx_names: &["keyFocus"],
1421        lua_names: &["key_focus"],
1422        jsx: "`keyFocus`",
1423        lua: "`key_focus`",
1424        c: "`kui_set_key_focus`",
1425        doc: "Focuses this node (an `onKey` sink, an editor, any focusable node) when it starts being declared: declared every frame it takes focus once, so a later Tab press is not clobbered. Declaring it on the frame a `modal` stops being declared is how a view says where focus lands on the way out — the edge stands, and the focus the modal displaced is not handed back over it (`docs/adr/0003-modal-surfaces.md`, decision 4). To move focus at any time call the binding's focus verb (`ctx.focus`, `kui_focus`, `env.set_focus`).",
1426    },
1427    CustomProp {
1428        name: "key",
1429        id: P_KEY,
1430        jsx_names: &["key"],
1431        lua_names: &["key"],
1432        jsx: "`key`",
1433        lua: "`key`",
1434        c: "`kui_open_keyed` label",
1435        doc: "Stable identity for retained state (scroll offsets, editors, transitions; keys are hashes of the path from the root). Retained state outlives the key's absence, under a budget on the states nobody declares (see `<edit>` and the overflow props).",
1436    },
1437    CustomProp {
1438        name: "index",
1439        id: P_INDEX,
1440        jsx_names: &["index"],
1441        lua_names: &["index"],
1442        jsx: "`index`",
1443        lua: "`index`",
1444        c: "`kui_open_indexed`",
1445        doc: "Stable identity by *data* index rather than by name: the key auto-keying would have given this node as the `i`th child, given to it wherever it actually sits. What a virtualised list is for — a view that builds rows 900..930 of ten thousand opens each with its own row number, so the row keeps its hover, focus, edit buffer and tweens as the built range slides over it, and a list that builds every row agrees with one that builds a screenful. Wherever `key` names a node this numbers it (a box, a `line`, a `cells`, a `fragment`); declared beside `key` the index wins. Indices and names are separate namespaces, so a spacer keyed `\"lead\"` cannot collide with row 0 — but two rows on one index do, exactly as two on one name would.",
1446    },
1447    CustomProp {
1448        name: "rowCount",
1449        id: P_ROW_COUNT,
1450        jsx_names: &["rowCount"],
1451        lua_names: &["row_count"],
1452        jsx: "`rowCount`",
1453        lua: "`row_count`",
1454        c: "`kui_row_count`",
1455        doc: "How many `index`ed rows this node's virtual list has, built or not. `uniformList` / `uniform_list` / `widgets::uniform_list` and `widgets::list` declare it on their container; a list composed by hand says it beside `scrollY`. What it buys: Select All (Cmd/Ctrl-A, the menu's row) inside a `selectable` virtual list selects the *data*, rows `0..rowCount`, rather than the rows the frame built, and the copy is a `selectionrange` ask whose `to.byte` is past the last row's length when that row is not built — cut it to the row. Without it Select All is the built rows, which is all the core can see.",
1456    },
1457    CustomProp {
1458        name: "title",
1459        id: P_TITLE,
1460        jsx_names: &["title"],
1461        lua_names: &["window_title"],
1462        jsx: "`title` (root box only)",
1463        lua: "`window_title` (root table)",
1464        c: "`kui_window_title`",
1465        doc: "Declares the window title for this frame; the driver diffs and applies.",
1466    },
1467    CustomProp {
1468        name: "alwaysOnTop",
1469        id: P_ALWAYS_ON_TOP,
1470        jsx_names: &["alwaysOnTop"],
1471        lua_names: &["always_on_top"],
1472        jsx: "`alwaysOnTop` (root box only)",
1473        lua: "`always_on_top = true` (root table)",
1474        c: "`kui_set_always_on_top`",
1475        doc: "Declares that this frame wants the window kept above every other app's — a floating palette, a picture-in-picture player, a timer (backlog C30). Frame state the way `title` is, applied by the driver on change and free on the frames it does not change, but with a default of false rather than \"leave as-is\": a frame that stops declaring it lowers the window again, so a pin button is a toggle on the app's own state and nothing has to remember to undo it. Whether the platform has a level to set is `env.window.always_on_top`, which is what the pin button should draw its state from — Wayland has no call for it at all, so there the window never moves and the reading says so; it is the driver's record of what it set, not a query, so a level the OS dropped afterwards (a fullscreen space, a tiling manager) is not reported. A popup keeps its own level whatever its owner declares.",
1476    },
1477    CustomProp {
1478        name: "secureInput",
1479        id: P_SECURE_INPUT,
1480        jsx_names: &["secureInput"],
1481        lua_names: &["secure_input"],
1482        jsx: "`secureInput` (root box only)",
1483        lua: "`secure_input = true` (root table)",
1484        c: "`kui_set_secure_input`",
1485        doc: "Declares that this frame wants the keyboard to this window kept from every other process while the window has it — macOS's Secure Keyboard Entry, what a terminal turns on at a password prompt (backlog F85). Frame state the way `alwaysOnTop` is, default false: declare it on every frame the prompt is up, and the frame that stops is what turns it off, so nothing has to remember to undo it. The runner owns the platform call and its balance: `EnableSecureEventInput` is process-wide and counted, and the runner holds one count while a window whose frame asked has the keyboard, giving it back when that window loses the keyboard, closes or stops asking, and at exit — Apple's rule, since while it is on no other process can read the keyboard at all (a launcher's hotkey, a text expander, an accessibility tool). Nothing on Windows or Linux, which have no such switch. A C host with its own loop reads the ask with `kui_secure_input_get` and makes the call itself.",
1486    },
1487    CustomProp {
1488        name: "optionAsAlt",
1489        id: P_OPTION_AS_ALT,
1490        jsx_names: &["optionAsAlt"],
1491        lua_names: &["option_as_alt"],
1492        jsx: "`optionAsAlt=\"left\"` — `\"none\"`, `\"left\"`, `\"right\"`, `\"both\"` (root box only)",
1493        lua: "`option_as_alt = \"left\"` (root table)",
1494        c: "`kui_set_option_as_alt` (`KUI_OPTION_AS_ALT_*`)",
1495        doc: "Declares which Option keys act as Alt in this window on macOS (backlog F113). On a Mac, Option composes: ⌥m types `µ`, and ⌥u, ⌥e, ⌥i, ⌥n and ⌥` are dead keys that start an accent and wait for the next key, so the press never reaches the app as a key and a keymap binding `<A-u>` never hears it. An Option key named here is Alt instead: it composes nothing and types nothing, and a key under it arrives as a chord of the key the layout prints unmodified — a terminal's \"Option as Meta\", an editor's Alt bindings. `\"left\"` or `\"right\"` leaves the other side composing, so a user keeps `ü` on one Option; `\"both\"` takes both; `\"none\"`, the default, is the Mac's own behaviour. Frame state the way `alwaysOnTop` is: declare it on every frame, and the frame that stops gives the Option keys back to the layout; the runner applies it to the window on change, never per frame. A popup's keys arrive through its owner, so the owner's declaration is the one they are read under. Nothing on Windows or Linux, whose Alt composes nothing. A C host with its own loop reads the ask with `kui_option_as_alt_get` and applies it itself.",
1496    },
1497    CustomProp {
1498        name: "windows",
1499        id: P_WINDOWS,
1500        jsx_names: &["windows"],
1501        lua_names: &["windows"],
1502        jsx: "`windows={[{ name, kind?, anchor?, width?, height?, activates? }]}` (root box only; `windows: (model) => [...]` in the loop config)",
1503        lua: "`windows = { { name=, kind=, anchor=, width=, height=, activates= } }` (root table)",
1504        c: "`kui_window_declare`",
1505        doc: "Declares which windows exist this frame, by stable name (`docs/adr/0004-multi-window.md`). A window opens on the first frame any window's frame declares it — its config is read then and never again, since the user owns its geometry once it exists — and closes on the first frame none does. The driver drains the `Open` / `Close` that result, and the app sees `{kind:\"window\", phase, name, id}`. A window the user closed does not reopen while it is still declared: stop declaring it, then declare it again. `kind: \"popup\"` makes it a menu surface instead: borderless, off the taskbar, owned by the window that declared it and closed with it, placed in screen coordinates against `anchor` — the `{x, y, w, h}` an `onLayout` node reported — and non-activating unless `activates` says otherwise, so the field that opened it keeps the focus ring while the arrows walk the list. A press outside it or Escape raises `{kind:\"dismiss\", reason, name, id}` and closes nothing, exactly as a `modal` node's does: stop declaring the window. Reach for a popup only for the placements a float cannot make — a list taller than the window, a menu with nowhere in-window to go, a panel beside the app; everything else stays `fit` plus a `modal` float, which costs one tree instead of an OS surface.",
1506    },
1507    CustomProp {
1508        name: "tooltip",
1509        id: P_TOOLTIP,
1510        jsx_names: &["tooltip"],
1511        lua_names: &["tooltip"],
1512        jsx: "`tooltip=\"hint\"`",
1513        lua: "`tooltip = \"hint\"`",
1514        c: "`KuiSpec.tooltip` (`kui_tooltip` / `kui_tooltip_with` draw a hint that is not hover-gated)",
1515        doc: "Floats a hint below the node while hovered. All three effects — hover tracking, the accessible description, and the float itself — come from `PropsOut::apply_tooltip`, so no frontend can implement two of them; a Rust view has all three in `NodeSpec::tooltip` (`NodeSpec::apply_tooltip` is the spec half, for a caller that floats the hint itself). The `description` row is that middle effect on its own, for a hint that is spoken and never drawn. The float is the node's last child, so it is drawn for a box or a `fragment`; on a leaf that holds no children — an `image`, an `edit`, a `cells` grid — the hint is tracked and spoken but not drawn, so put the tooltip on a box around it (backlog RG75).",
1516    },
1517];
1518
1519/// Where a schema row lands in C when it is not simply the `KuiSpec` /
1520/// `KuiTextStyle` field of the row's snake_case name (`c_field`).
1521pub const C_FIELDS: &[(&str, &str)] = &[
1522    ("width", "`width` (KuiSizing)"),
1523    ("height", "`height` (KuiSizing)"),
1524    ("center", "`main_align` + `cross_align` = `KUI_CENTER`"),
1525    ("window", "`window_role` (`KUI_WINDOW_*`)"),
1526    ("transition", "`transition_ms`"),
1527    ("easing", "`easing` (`KUI_EASE_*`)"),
1528    (
1529        "keyframes",
1530        "`keyframes` + `keyframes_len` (`KuiKeyframe[]`)",
1531    ),
1532    ("gradient", "`gradient` (`const KuiGradient *`)"),
1533    ("repeat", "`repeat` (`KUI_REPEAT_*`)"),
1534    ("delay", "`delay_ms`"),
1535    ("enter", "`enter` (`KuiEnter`, with `set` bits)"),
1536    ("exit", "`exit` (`KuiEnter`, with `set` bits)"),
1537    ("opacity", "`opacity` with `opacity_set`"),
1538    ("radiusTL", "`radius_tl` with `per_corner`"),
1539    ("radiusTR", "`radius_tr` with `per_corner`"),
1540    ("radiusBR", "`radius_br` with `per_corner`"),
1541    ("radiusBL", "`radius_bl` with `per_corner`"),
1542    ("hoverGroup", "`hover_group` (KuiStr)"),
1543    ("role", "`role` (`KUI_ROLE_*`)"),
1544    ("expanded", "`expanded` (`KUI_EXPANDED_*`)"),
1545    ("live", "`live` (`KUI_LIVE_*`)"),
1546    ("cursor", "`cursor` (`KUI_CURSOR_*`)"),
1547    ("label", "`label` (KuiStr)"),
1548    (
1549        "valueNow",
1550        "`value_now` with `KUI_VALUE_NOW` in `value_set`",
1551    ),
1552    (
1553        "valueMin",
1554        "`value_min` with `KUI_VALUE_MIN` in `value_set`",
1555    ),
1556    (
1557        "valueMax",
1558        "`value_max` with `KUI_VALUE_MAX` in `value_set`",
1559    ),
1560    ("valueText", "`value_text` (KuiStr)"),
1561    ("caret", "`caret` with `KUI_VALUE_CARET` in `value_set`"),
1562    (
1563        "selectionAnchor",
1564        "`selection_anchor` with `KUI_VALUE_ANCHOR` in `value_set`",
1565    ),
1566    (
1567        "onClick",
1568        "`on_click` argument of `kui_open` / `kui_open_with`",
1569    ),
1570    (
1571        "onDrag",
1572        "`on_drag` argument of `kui_open_draggable` / `kui_open_with`",
1573    ),
1574    ("onKey", "`on_key` argument of `kui_open_with`"),
1575    (
1576        "onContextMenu",
1577        "`on_context_menu` (a borrowed `KuiValue*`, cloned while the node opens)",
1578    ),
1579    (
1580        "onButton",
1581        "`on_button` (a borrowed `KuiValue*`, cloned while the node opens)",
1582    ),
1583    (
1584        "buttons",
1585        "`buttons` (`KUI_BUTTONS_*` bits; zeroed, all three)",
1586    ),
1587    (
1588        "modal",
1589        "`modal` (a borrowed `KuiValue*`, cloned while the node opens)",
1590    ),
1591    (
1592        "onScroll",
1593        "`on_scroll` (a borrowed `KuiValue*`, cloned while the node opens)",
1594    ),
1595    ("onHover", "`on_hover` argument of `kui_open_with`"),
1596    (
1597        "onFocus",
1598        "`on_focus` (a borrowed `KuiValue*`, cloned while the node opens)",
1599    ),
1600    ("ruleWidth", "`rule_w`"),
1601    (
1602        "overscroll",
1603        "`overscroll` (`KUI_OVERSCROLL_*`; zeroed, auto)",
1604    ),
1605    (
1606        "scrollAxes",
1607        "`scroll_axes` (`KUI_SCROLL_AXES_*`; zeroed, both)",
1608    ),
1609    (
1610        "scrollMods",
1611        "`scroll_mods` (`KUI_KMOD_*` bits; zeroed, none)",
1612    ),
1613    (
1614        "onDrop",
1615        "`on_drop` (a borrowed `KuiValue*`, cloned while the node opens)",
1616    ),
1617    (
1618        "onLayout",
1619        "`on_layout` (a borrowed `KuiValue*`, cloned while the node opens)",
1620    ),
1621    ("family", "`KuiTextStyle.family` (`KUI_FONT_*`)"),
1622    ("font", "`KuiTextStyle.font` (from `kui_font_add*`)"),
1623    ("lineHeight", "`KuiTextStyle.line_height`"),
1624    ("wrap", "`KuiTextStyle.wrap` (`KUI_WRAP_*`)"),
1625    ("maxLines", "`KuiTextStyle.max_lines`"),
1626    ("ellipsis", "`KuiTextStyle.ellipsis`"),
1627    (
1628        "features",
1629        "`KuiTextStyle.features` (a `KuiStr`, the same spelling)",
1630    ),
1631    (
1632        "underline",
1633        "`KuiTextStyle.decoration` (`KUI_DECO_UNDERLINE`); `KuiSpan.flags` (`KUI_SPAN_UNDERLINE`)",
1634    ),
1635    (
1636        "strikethrough",
1637        "`KuiTextStyle.decoration` (`KUI_DECO_STRIKETHROUGH`); `KuiSpan.flags` (`KUI_SPAN_STRIKETHROUGH`)",
1638    ),
1639    (
1640        "underlineColor",
1641        "`KuiTextStyle.underline_color`; `KuiSpan.underline_color`",
1642    ),
1643    (
1644        "underlineStyle",
1645        "`KuiTextStyle.underline_style` (`KUI_UNDERLINE_*`); `KuiSpan.underline_style`",
1646    ),
1647    ("color", "`KuiTextStyle.color`"),
1648];
1649
1650/// The C spelling of a schema row, for docs.
1651pub fn c_field(def: &PropDef) -> String {
1652    C_FIELDS
1653        .iter()
1654        .find(|(n, _)| *n == def.name)
1655        .map(|(_, c)| (*c).to_string())
1656        .unwrap_or_else(|| format!("`{}`", def.snake_name()))
1657}
1658
1659/// An element (node type) and its spelling in each binding. Elements are
1660/// hand-lowered per binding (their shapes differ: JSX children, Lua
1661/// tables, C calls with body callbacks), so this table is documentation
1662/// and a checklist, not a code generator's input.
1663pub struct ElementDef {
1664    pub name: &'static str,
1665    /// The props this element lowers itself, which are therefore in neither
1666    /// `PROPS` nor `CUSTOM`: `<edit initial multiline>`, `<image src>`. They
1667    /// ride in the same prop list as the node's, so a binding needs them to
1668    /// tell a legitimate element prop from a misspelling (see
1669    /// [`known_prop`]) — JSX's spellings here, Lua's below.
1670    pub jsx_own: &'static [&'static str],
1671    /// The same for a Lua node table.
1672    pub lua_own: &'static [&'static str],
1673    /// The schema rows this element reads, or `None` for every one. A
1674    /// composite whose look *is* its spec — the stock button, whose
1675    /// padding, colours and radius are `widgets::button_spec` — cannot take
1676    /// the whole prop list: `dir` alone rebuilds the spec from nothing. It
1677    /// names the rows it reads instead, and a binding drops the rest with a
1678    /// warning that says which rows it does take ([`known_prop`],
1679    /// `diag::unknown_prop`). JSX spellings here, Lua's below.
1680    pub jsx_rows: Option<&'static [&'static str]>,
1681    pub lua_rows: Option<&'static [&'static str]>,
1682    pub jsx: &'static str,
1683    pub lua: &'static str,
1684    pub c: &'static str,
1685    pub doc: &'static str,
1686}
1687
1688/// The rows a `text` reads (`ElementDef::jsx_rows` / `lua_rows`): the
1689/// `TextStyle` rows and `size`, the composite the style is built from —
1690/// and nothing else, because every door lowers a text as content plus a
1691/// style and no spec (`Core::text_node`), so a container or access row
1692/// on it reaches no tree. Before AR13 the element admitted every shared
1693/// row, and `<text live="polite">`, `<text role="heading">`, `<text
1694/// label>` and `<text onClick>` were dropped silently by all four
1695/// bindings — no `unknown-prop`, and `live-region-without-name` could
1696/// never fire for them. Pinned equal to the `Target::Style` rows by a
1697/// test, so a style row added to `PROPS` is a row here or a red test.
1698pub const TEXT_ROWS_JSX: &[&str] = &[
1699    "size",
1700    "lineHeight",
1701    "color",
1702    "family",
1703    "font",
1704    "wrap",
1705    "maxLines",
1706    "ellipsis",
1707    "underline",
1708    "underlineColor",
1709    "underlineStyle",
1710    "strikethrough",
1711    "features",
1712];
1713pub const TEXT_ROWS_LUA: &[&str] = &[
1714    "size",
1715    "line_height",
1716    "color",
1717    "family",
1718    "font",
1719    "wrap",
1720    "max_lines",
1721    "ellipsis",
1722    "underline",
1723    "underline_color",
1724    "underline_style",
1725    "strikethrough",
1726    "features",
1727];
1728
1729/// The rows the stock button reads (`ElementDef::jsx_rows` / `lua_rows`):
1730/// the click, the identity (`key`, or `index` in a virtual list — declared
1731/// beside `key` the index wins, as on a box), the access
1732/// rows — what a button *is* and what a reader says of it — and the one
1733/// paint row it takes, `accent`, which is not a colour but a question put
1734/// to the OS. The two lists are the same rows in each spelling, index for
1735/// index.
1736pub const BUTTON_ROWS_JSX: &[&str] = &[
1737    "onClick",
1738    "key",
1739    "index",
1740    "label",
1741    "description",
1742    "tooltip",
1743    "disabled",
1744    "accent",
1745];
1746pub const BUTTON_ROWS_LUA: &[&str] = &[
1747    "on_click",
1748    "key",
1749    "index",
1750    "label",
1751    "description",
1752    "tooltip",
1753    "disabled",
1754    "accent",
1755];
1756
1757/// The rows a stock toggle — `checkbox`, `radio`, `switch` — reads
1758/// (`widgets::toggle_with`): the button's access rows, its state
1759/// and no layout or paint row, since its look is its spec. `mixed` means
1760/// something on a checkbox alone.
1761pub const TOGGLE_ROWS_JSX: &[&str] = &[
1762    "onClick",
1763    "key",
1764    "label",
1765    "description",
1766    "tooltip",
1767    "disabled",
1768    "checked",
1769    "mixed",
1770];
1771pub const TOGGLE_ROWS_LUA: &[&str] = &[
1772    "on_click",
1773    "key",
1774    "label",
1775    "description",
1776    "tooltip",
1777    "disabled",
1778    "checked",
1779    "mixed",
1780];
1781/// The rows the stock slider reads (`widgets::slider_with`): the
1782/// value rows, its change tag, the access rows, and its width — the one
1783/// piece of its look an app sizes.
1784pub const SLIDER_ROWS_JSX: &[&str] = &[
1785    "key",
1786    "label",
1787    "description",
1788    "tooltip",
1789    "disabled",
1790    "valueNow",
1791    "valueMin",
1792    "valueMax",
1793    "valueStep",
1794    "valueText",
1795    "onChange",
1796    "width",
1797    "minWidth",
1798    "maxWidth",
1799];
1800pub const SLIDER_ROWS_LUA: &[&str] = &[
1801    "key",
1802    "label",
1803    "description",
1804    "tooltip",
1805    "disabled",
1806    "value_now",
1807    "value_min",
1808    "value_max",
1809    "value_step",
1810    "value_text",
1811    "on_change",
1812    "width",
1813    "min_width",
1814    "max_width",
1815];
1816
1817pub const ELEMENTS: &[ElementDef] = &[
1818    ElementDef {
1819        name: "box",
1820        jsx_own: &[],
1821        lua_own: &[],
1822        jsx_rows: None,
1823        lua_rows: None,
1824        jsx: "`<box>`",
1825        lua: "`row { }`, `column { }`",
1826        c: "`kui_open*` … `kui_close`",
1827        doc: "A container: every container prop applies.",
1828    },
1829    ElementDef {
1830        name: "table",
1831        jsx_own: &[],
1832        lua_own: &[],
1833        jsx_rows: None,
1834        lua_rows: None,
1835        jsx: "`<box dir=\"table\">`",
1836        lua: "`grid { }`",
1837        c: "`kui_open*` with `dir = KUI_TABLE`",
1838        doc: "A column whose rows' children line up in columns (`docs/adr/0033-a-table-is-a-column-whose-cells-align.md`): its children are the rows, each row's in-flow children its cells, the nth cell of every row column n, and a column as wide as its widest cell — so a label column sits at its longest label with nothing measured and no width picked by hand, in every binding, since the alignment is the layout's and not a widget's. A cell's `width` says how its column sizes: `fit` (the default) and a fixed number are content the column's fit width is the max of; `grow` makes the whole column grow with the table, `grow` factors splitting the room the fit columns leave; a percent takes its cut of the row; and a column's `minWidth` / `maxWidth` are the strictest its cells declared. Fit columns that overflow the row are compressed toward their floors largest first, as a row's children are, unless the table scrolls x; a fixed column never is. A bare text is a cell too, held at its column's width, so a text straight inside a row is a column; an image straight in a row is a cell the same way, its box the column wide and its own aspect tall, the pixels meeting the box by its `fit` row (wrap an icon in a box to keep its own width). The rows are the table's `row` children, ordinary rows — give them `width=\"grow\"` for the columns to grow into (a `fit` row sits at the columns' width) — with their own `gap` between cells, their own padding, background, click, hover and access rows; a row of a table never wraps (`wrap-ignored`). Anything else straight under the table — a text, a `column` section, another table — is a child with its own width and no cells. The table's own `fit` width is its columns', whatever its rows' sizing, so a table with no width is the aligned list; a `scrollX` table's rows are at least as wide as its columns, and it scrolls to them. Everything else is a column's: `gap` is the space between rows, `scrollY` scrolls them, a float in a row is not a cell. Spelled `grid { }` in Lua, since `table` is Lua's own.",
1839    },
1840    ElementDef {
1841        name: "text",
1842        jsx_own: &["bold", "italic", "bg", "bgRadius"],
1843        lua_own: &["value", "spans"],
1844        jsx_rows: Some(TEXT_ROWS_JSX),
1845        lua_rows: Some(TEXT_ROWS_LUA),
1846        jsx: "`<text>` with `<span bold italic underline strikethrough bg bgRadius color>` children",
1847        lua: "`text(\"s\", {…})`, `text({ \"a\", { \"b\", bold = true, underline = true, bg = 0x.., bg_radius = 4 } })`",
1848        c: "`kui_text`, `kui_rich_text`",
1849        doc: "Plain or rich text; spans shape as one paragraph, so wrapping crosses style boundaries. A text is content plus a style and no box of its own, so the rows it reads are the style rows (`size`, `lineHeight`, `color`, `family`, `font`, `wrap`, `maxLines`, `ellipsis`, `underline`, `strikethrough`, `features`) and nothing else: a container row, an access row (`label`, `role`, `live`), `key` or `onClick` on a text is dropped with an `unknown-prop` warning naming the rows it does take — put them on the box around it. `wrap`, `maxLines` and `ellipsis` control line breaking. A span's `bg` is a background behind its glyphs alone, one rect per line it spans, so it follows the span across a wrap the way a box around a run cannot. With `bgRadius` (`bg_radius` in Lua, `KuiSpan.bg_radius` in C, `Span::bg_radius` in Rust; logical px) the background is rounded and joined into one shape with every rounded background of the same colour and radius it meets: a piece whose edge touches it exactly on the line above or below and overlaps it sideways, or that meets it end to end on its own line, in this text or another. Its corners are then convex where a line reaches past its neighbour, a fillet where it falls short, and round where nothing meets it — a selection over many rows, or over the wrapped lines of a paragraph, is one rounded outline, joined after every text of the frame is laid out and painted, so it is never a frame behind. Nothing names the shape: two that touch are one; `underline` and `strikethrough` on a span or on the whole text are lines where the face puts them. A text with no line breaks that is 4096 bytes or longer (and no `maxLines` or `ellipsis`), plain or spans alike, is shaped in ~1 KB chunks as they come on screen, so a minified bundle or a log line with a blob in it costs the screenful it shows and a keystroke into it — or a span moving along it, an editor's caret — costs the chunk it lands in; wrapped, the rows are broken from the chunks' positions, so a 100k-character paragraph costs the rows it shows. Its size is estimated from the first chunk until the rest shape (exact under monospace), and the access tree carries its value without its runs.",
1850    },
1851    ElementDef {
1852        name: "button",
1853        jsx_own: &[],
1854        lua_own: &["text"],
1855        jsx_rows: Some(BUTTON_ROWS_JSX),
1856        lua_rows: Some(BUTTON_ROWS_LUA),
1857        jsx: "`<button onClick key|index label description tooltip disabled accent>`",
1858        lua: "`button { label=, on_click=, key= | index=, text=, description=, tooltip=, disabled=, accent= }`",
1859        c: "`kui_button`, `kui_button_with`",
1860        doc: "The stock button: `widgets::button_spec(&theme, &metrics)` — the theme's accent trio as its three backgrounds, declared on the node and resolved by the core — keyed by its text (`key` overrides). It paints from the palette like every stock widget (backlog AR41): the OS's accent where the host reports one, the app's where it set or pinned one, kui's blue otherwise; the label goes black or white by the background's luminance. Its look is its spec, so the layout and paint rows are closed — declared, they are dropped with an `unknown-prop` warning naming the rows it does read — and those are the access rows: `label` when the text is not the name, `description`, `tooltip`, and `disabled` (inert, and dimmed to half). The one paint row it takes is `accent`, which on a button changes nothing (it is the accent already) and is kept for the box's sake. In Lua `label` is the name and the text both unless `text` says otherwise; in C the rows ride a `KuiSpec` whose other fields `kui_button_with` ignores. A button that needs any other row is a box with `role=\"button\"` and the same rows spelled out.",
1861    },
1862    ElementDef {
1863        name: "edit",
1864        jsx_own: &["id", "initial", "multiline", "autofocus"],
1865        lua_own: &["initial", "multiline", "autofocus"],
1866        jsx_rows: None,
1867        lua_rows: None,
1868        jsx: "`<edit key initial multiline autofocus>`, `<input label initial>`",
1869        lua: "`edit { key=, initial=, … }`, `input { label=, initial= }`",
1870        c: "`kui_text_edit`, `kui_text_input`",
1871        doc: "Retained editor state by key; read it back with `editText(key)` after a `changed` event. `initial` seeds a new editor only — a key declared again keeps the draft the user typed, and `setEditText(name, text)` is what resets one (it leaves the caret at the end). Name it by the label its `key` prop declares — `setEditText(\'note\', text)` — or by the hex key an event carried. It reaches an editor that does not exist yet: the text is held for the frame that declares that name and seeds it there, over `initial`, so the `update` that opens a rename field can fill it in the same turn, which is what the label spelling is for — the hex key comes from an event an editor being opened has not fired. A name nothing declares on that frame drops its text with an `edit-text-without-editor` warning. A single-line editor is a field and a `multiline` one a document, which decides how each is laid out as well as how it reads: a field takes one line whatever its box, sizes to the text it holds when its width is `fit`, and scrolls that line under the caret when it is not, while a document wraps to its box. The one exception is a field with `wrap` declared (`wrap=\"word\"` or `\"glyph\"`): it folds to its width the way a document does and keeps a field\'s keyboard — Enter still submits, a newline is still never admitted, the caret still opens at the end — so a rename field breaks where the label it renames breaks, and with `width=\"fit\"` plus `maxWidth` it sizes to its wrapped draft on the keystroke frame. A single-line editor opens with the caret after its seeded text, as a native field does; a multiline one is a document and opens at its top — a held `setEditText` is the call, not a seed, so it opens at the end either way. State is kept while the key is declared; an undeclared one is kept until the budget needs the room (256 undeclared editors, longest-undeclared evicted first). `autofocus` asks once: the editor takes focus on the frame the flag starts being declared — a new editor, or one whose flag just turned on — and only while nothing holds focus, so a blur afterwards stands and a focused control is never robbed (`docs/adr/0022-focus-regions.md`, decision 9); `focus(key)` is the call for taking it at any other time.",
1872    },
1873    ElementDef {
1874        name: "select",
1875        jsx_own: &["label", "options", "current"],
1876        lua_own: &["label", "options", "current"],
1877        // Its look is its own, like the button's, and it has no rows of
1878        // the box's to read: the three it takes are all its own.
1879        jsx_rows: Some(&[]),
1880        lua_rows: Some(&[]),
1881        jsx: "`<select label options={[…]} current>`",
1882        lua: "`dropdown { label=, options={…}, current= }`",
1883        c: "`kui_select`",
1884        doc: "The stock select (`widgets::select_items`, backlog F72): a field showing the choice in force that, clicked, opens the core's own menu of the options under it with the current one checked — the menu a right-click opens, drawn in the frame or the platform's where the host shows menus itself, dismissed by Escape or a press outside, its rows walked by the arrows and read as a menu. `label` is the key and the accessible name both; `options` is a list whose entries are strings (an option by its label, posting it) or menu-item objects `{ label, id, enabled }` (posting `id`), and a `{ role: \"separator\" }` is a separator; `current` is the index in force, counted from 0 in JSX and C and from 1 in Lua, or none — one past the options or on a separator is none, with a `select-current-ignored` warning on the field; an empty `options` is refused, and a key of an option object no row reads (`disabled`, where the key is `enabled`) is an `unknown-prop` warning. The app holds no open state: the choice arrives as the `menu` event a menu row posts, on the field's key — `{kind: \"menu\", role: \"custom\", item: <the option>}` — and drawing the field again with the new `current` is the whole loop. A reader hears a button named by the field, described by its choice, expanded while the menu is open. Its look is its spec, so it reads no other row: a layout, paint or access row on it is dropped with an `unknown-prop` warning. Lua spells it `dropdown`, since `select` is Lua's own.",
1885    },
1886    ElementDef {
1887        name: "checkbox",
1888        jsx_own: &[],
1889        lua_own: &["text"],
1890        jsx_rows: Some(TOGGLE_ROWS_JSX),
1891        lua_rows: Some(TOGGLE_ROWS_LUA),
1892        jsx: "`<checkbox checked mixed onClick key label description tooltip disabled>text</checkbox>`",
1893        lua: "`checkbox { label=, checked=, mixed=, on_click=, key=, text=, description=, tooltip=, disabled= }`",
1894        c: "`kui_checkbox`",
1895        doc: "The stock checkbox (`widgets::toggle_with`, ADR 0034): a box drawn from the state the view declares — `checked`, or `mixed` for the select-all box over a list some of whose rows are selected, drawn as a dash and read as mixed — and its label beside it, keyed by its text (`key` overrides). The state is the app's: a press by the pointer, Space, Enter or assistive technology posts `onClick`, and the view flips its model and draws it again. Its look is its spec, so the layout and paint rows are closed and dropped with an `unknown-prop` warning; the rows it reads are its state and the access rows. In Lua `label` is the name and the text both unless `text` says otherwise. The box is the metrics' control text plus one (16 px comfortable), so `compact` and `scaled` move it with the stock button.",
1896    },
1897    ElementDef {
1898        name: "radio",
1899        jsx_own: &[],
1900        lua_own: &["text"],
1901        jsx_rows: Some(TOGGLE_ROWS_JSX),
1902        lua_rows: Some(TOGGLE_ROWS_LUA),
1903        jsx: "`<radio checked onClick key label description tooltip disabled>text</radio>`",
1904        lua: "`radio { label=, checked=, on_click=, key=, text=, description=, tooltip=, disabled= }`",
1905        c: "`kui_radio`",
1906        doc: "The stock radio (`widgets::toggle_with`, ADR 0034): a circle drawn from `checked`, and its label, keyed by its text. Put radios in a `radioGroup`, which makes them one Tab stop whose arrows, Home and End move the choice and press the radio they land on (ADR 0007), so radios whose `onClick` each set the choice answer the keyboard with no more code. The state is the app's, as a checkbox's is; the rows are the checkbox's, `mixed` aside.",
1907    },
1908    ElementDef {
1909        name: "radioGroup",
1910        jsx_own: &[],
1911        lua_own: &[],
1912        jsx_rows: None,
1913        lua_rows: None,
1914        jsx: "`<radioGroup label>…radios…</radioGroup>`",
1915        lua: "`radio_group { label=, … }`",
1916        c: "`kui_radio_group_open` … `kui_close`",
1917        doc: "A container of radios (`widgets::radio_group_with`, ADR 0034): the `radioGroup` role, named by its `label`, laid out as a column with the stock gap — a `dir=\"row\"` lays the radios across, and its arrows run across with it. It reads every box row; the role and the name are its own whatever the rows say.",
1918    },
1919    ElementDef {
1920        name: "switch",
1921        jsx_own: &[],
1922        lua_own: &["text"],
1923        jsx_rows: Some(TOGGLE_ROWS_JSX),
1924        lua_rows: Some(TOGGLE_ROWS_LUA),
1925        jsx: "`<switch checked onClick key label description tooltip disabled>text</switch>`",
1926        lua: "`switch { label=, checked=, on_click=, key=, text=, description=, tooltip=, disabled= }`",
1927        c: "`kui_switch`",
1928        doc: "The stock switch (`widgets::toggle_with`, ADR 0034): a track and a knob drawn from `checked`, the knob sliding across when it changes, and its label; read as a switch, on or off. The state is the app's, as a checkbox's is; the rows are the checkbox's, `mixed` aside.",
1929    },
1930    ElementDef {
1931        name: "slider",
1932        jsx_own: &[],
1933        lua_own: &[],
1934        jsx_rows: Some(SLIDER_ROWS_JSX),
1935        lua_rows: Some(SLIDER_ROWS_LUA),
1936        jsx: "`<slider label valueNow valueMin valueMax valueStep valueText onChange width description tooltip disabled/>`",
1937        lua: "`slider { label=, value_now=, value_min=, value_max=, value_step=, value_text=, on_change=, width=, … }`",
1938        c: "`kui_slider`",
1939        doc: "The stock slider (`widgets::slider_with`, ADR 0034): a track, a fill to `valueNow` and a thumb, as wide as a menu (`width` sizes it), keyed by its `label`, which is also its accessible name. With `onChange` the core does the arithmetic: a press proposes the value under the pointer, a drag each new step, the arrows one `valueStep`, PageUp / PageDown ten, Home / End the ends, all clamped to `valueMin`..`valueMax` (0..100 unset) and snapped to the step, as `{kind:\"change\", value, phase:\"move\"|\"end\", tag}`. The value is proposed, never applied: the view stores it and declares it as `valueNow`. Its look is its spec, so the rows it reads are the value rows, the access rows and its width.",
1940    },
1941    ElementDef {
1942        name: "image",
1943        jsx_own: &["src", "sampling", "fit"],
1944        lua_own: &["id", "sampling", "fit"],
1945        jsx_rows: None,
1946        lua_rows: None,
1947        jsx: "`<image src={id} sampling fit>`",
1948        lua: "`image { id=, sampling=, fit= }`",
1949        c: "`kui_image`, `kui_image_with`",
1950        doc: "A registered RGBA image. Sizing: `width=\"fit\"` takes the pixel size, a fit height against a resolved width keeps the aspect, `radius` rounds it. Two rows say how the pixels meet the box (`docs/adr/0025-the-image-is-the-canvas.md`): `sampling` is `linear` (the default) or `nearest` — pixel art, an emulator, a data grid that must stay square under zoom; `fit` is `fill` (the default: the pixels stretch to the box), `contain` (the largest rect of the image's aspect that fits, centred, the rest of the box showing what is behind) or `cover` (the box filled and the pixels that do not fit cropped, centred). The box — its layout, its hit region, its access rect — is the same in every mode. The pixels come from the atlas, or from a texture of the image's own once `updateImage` has replaced them or when no atlas page could hold them; the node cannot tell and need not.",
1951    },
1952    ElementDef {
1953        name: "polygon",
1954        // `bg` is a schema row already; on a polygon it is the fill.
1955        jsx_own: &["points"],
1956        lua_own: &["points"],
1957        jsx_rows: None,
1958        lua_rows: None,
1959        jsx: "`<polygon points={[[x,y],…]} bg/>`",
1960        lua: "`polygon { points={{x,y},…}, bg= }`",
1961        c: "`kui_polygon`",
1962        doc: "A filled polygon through up to eight `points`, the fill in `bg` (`docs/adr/0025-the-image-is-the-canvas.md`, decision 6): an arrowhead, a pie slice, the area under a curve. Placed as a `line` is — always a float in its parent's box space (`float=\"viewport\"` for viewport space), sized to its own bounding box a pixel out on each side, so it takes no room in a row or column, and painted in the parent's layer at its place in the tree, over the siblings before it and under those after (backlog F123). A polygon in its parent's box space is held by the parent's clip as a child is, its hit region with it, so it is cut at a scroller's edge with the row it is drawn in; a declared float is held that way only when it declares `clip` with a parent anchor, and a `float=\"viewport\"` polygon escapes (backlog F78, `docs/adr/0010-a-segment-primitive.md` decision 5). `transition` eases the fill and, with `slide`, its position. The outline may be concave; a self-intersecting one fills even-odd, its overlaps unfilled. Hit by its outline (`docs/adr/0026-hit-testing-by-shape.md`): with `onClick`, `onDrag`, `onHover` or `hoverable` a press inside the outline hits it and one in its box past the outline falls through, so a pie's wedges need no hit boxes; with none it takes no input and has no access row, and with input it derives one as a box would (a clickable wedge is a button), so name it. A ninth point and later are dropped with `polygon-points-truncated`; fewer than three draw nothing; no `bg`, no fill. On the wire it is one `fragment` quad painted by a WGSL function the core registers itself, so a host that draws the list gets its source from `kui_fragment_source` like any other; what it costs is that quad and one pipeline switch per run of polygons. A stroked outline is a closed `line` over it.",
1963    },
1964    ElementDef {
1965        name: "path",
1966        // `bg` is a schema row already; on a path it is the fill. `width`
1967        // and `color` are rows too; on a path they are the stroke's, as on
1968        // a line.
1969        jsx_own: &["d", "fillRule", "rotate", "pivot", "dash", "dashOffset"],
1970        lua_own: &[
1971            "d",
1972            "ops",
1973            "fill_rule",
1974            "rotate",
1975            "pivot",
1976            "dash",
1977            "dash_offset",
1978        ],
1979        jsx_rows: None,
1980        lua_rows: None,
1981        jsx: "`<path d=\"M … Z\" bg width color fillRule rotate pivot dash dashOffset/>`",
1982        lua: "`path { d = \"M … Z\", bg=, width=, color=, fill_rule=, rotate=, pivot=, dash=, dash_offset= }`",
1983        c: "`kui_path`",
1984        doc: "Any outline — SVG's `d`, a pie wedge with a round arc, a map's region, an icon — filled with `bg` by `fillRule` (`nonzero`, the default, or `evenodd`) and stroked `width` wide in `color` when `width` is given, the stroke over the fill (`docs/adr/0040-a-path-is-a-mask-in-the-atlas.md`). `d` is SVG path data (`M L H V C S Q T A Z`, absolute or relative), parsed by one parser in the core, so every binding draws the same shape; one that does not parse raises `path-malformed` and draws nothing. JSX also takes `d` as a flat number array of op codes and operands, Lua the same as `ops`, and C only that form (`kui_path_parse` turns a string into it). Placed as a `line` is — always a float in its parent's box space (`float=\"viewport\"` for viewport space), sized to its own bounding box two pixels out on each side (half the stroke's width further), so it takes no room in a row or column, held by the parent's clip as a child is and painted in the parent's layer at its place in the tree (backlog F123). `transition` eases the fill and, with `slide`, its position; the stroke's colour does not tween, as a box's border does not. Hit by its outline under the fill rule (`docs/adr/0026-hit-testing-by-shape.md`): with `onClick`, `onDrag`, `onHover` or `hoverable` a press inside hits it and one in its box past the outline falls through, so a pie's wedges need no hit boxes; a stroke with no fill is hit by its stroke as a line is; with input it derives an access row as a box would (a clickable wedge is a button), so name it. On the wire it is one glyph-mask quad per paint, fill and stroke: the outline is rasterized once per shape, scale and quarter-pixel position into the glyph atlas and tinted like a glyph, so a host that draws text draws paths, and nothing is re-rasterized for a colour tween, a hover or a slide. The fill bleeds half a pixel, so two paths sharing an edge meet without the background showing through; a chart that wants separators gaps its own geometry. A mask a quarter of the biggest atlas page or more, or a path whose ops change twice within a few frames, draws from a texture of its own instead (a `texture` quad), and one past 8192 px on a side draws nothing, with `path-too-large`. `rotate` turns the path, in turns clockwise, about `pivot` — a point in the path's own coordinates, the centre of its box without one (`docs/adr/0041-a-mask-turns-about-its-centre.md`): the turn is the quad's and not the mask's, so a path that only turns — a spinner's arc about its circle's centre — is rasterized once and stays in the atlas at every angle. A path with `rotate` or `pivot` is boxed by the square the turn sweeps, its mask centred on the pivot on a whole pixel, and it is hit where it is drawn; `rotate` does not tween. `dash` and `dashOffset` cut the stroke into marks and gaps as a `line`'s do (backlog V2) — lengths as seen, round-capped marks — restarting at every subpath as SVG's do; the pattern is part of the stroke's mask, so a dashed stroke costs what a solid one does, a stroke with no fill is still hit along its gaps, and a `dashOffset` that changes every frame is a shape that changes every frame: the path leaves the atlas for a texture of its own while it marches.",
1985    },
1986    ElementDef {
1987        name: "fragment",
1988        jsx_own: &["src", "image", "params", "animate"],
1989        lua_own: &["id", "image", "params", "animate"],
1990        jsx_rows: None,
1991        lua_rows: None,
1992        jsx: "`<fragment src={id} image={id} params={[…]} animate>`",
1993        lua: "`fragment { id=, image=, params={…}, animate= }`",
1994        c: "`kui_fragment`, `kui_fragment_with`",
1995        doc: "A box a registered WGSL function paints (`docs/adr/0015-a-fragment-element-and-the-painter-it-is-not.md`): a conic or a moving gradient, rings, noise, shimmer — anything the paint vocabulary has no prop for. An ordinary node otherwise — it lays out, rounds, clips, fades, takes input and holds children, which paint over it — but with **no intrinsic size**, so give it a `width`/`height` or `fill` or it is zero by zero. `src` is a handle from `add_fragment`, which validates the source and warns rather than minting one that cannot compile. `params` is up to sixteen numbers the shader reads as four `vec4<f32>`; more are dropped with a warning. `image` is a registered image the function reads — `kui_sample(uv)` (bilinear) and `kui_sample_nearest(uv)` return its texels at `uv` in `[0,1]²`, and `in.image` is its texel rect, `zw` the size — which is what makes a replaced image a waveform, a heatmap, a 50k-point line or an image effect from one quad (`docs/adr/0025-the-image-is-the-canvas.md`, decision 7); the core binds the atlas or the image's own texture, whichever holds it, and a fragment whose image is not live draws nothing, as one whose `src` is not does. `animate` asks for a frame every frame, which is what a fragment that reads `time` needs and what a still one must not declare.",
1996    },
1997    ElementDef {
1998        name: "cells",
1999        jsx_own: &[
2000            "rows",
2001            "cols",
2002            "cells",
2003            "cursorAt",
2004            "cursorShape",
2005            "cursorColor",
2006            "originLine",
2007        ],
2008        lua_own: &[
2009            "rows",
2010            "cols",
2011            "lines",
2012            "runs",
2013            "cursor_at",
2014            "cursor_shape",
2015            "cursor_color",
2016            "origin_line",
2017        ],
2018        jsx_rows: None,
2019        lua_rows: None,
2020        jsx: "`<cells rows cols cells={Uint32Array} cursorAt={[row, col]} cursorShape cursorColor size family lineHeight/>`",
2021        lua: "`cells { rows=, cols=, lines={\"row text\", …}, runs={{row, col, len, fg, bg, flags}, …}, cursor_at={row, col}, cursor_shape=, cursor_color=, size=, family= }`",
2022        c: "`kui_cells`",
2023        doc: "A terminal's screen as one node (backlog C20): `rows × cols` cells, each a character, a foreground and background as `0xRRGGBBAA` (0 = no background), and attribute bits — 1 bold, 2 italic, 4 underline, 8 strikethrough, 16 wide (the glyph spans this cell and the next, which the app leaves blank), 32 the underline is a wave (a terminal's undercurl, SGR 4:3) and 64 dotted (SGR 4:4), either implying it — plus, optionally, the underline's own colour (SGR 58), 0 for the foreground (backlog K4). A glyph is shaped once per character and style variant and thereafter placed at `col × cell_w` without shaping, so a screen whose every cell is new each frame costs what a still one costs (~60 µs for 200 × 50). The cell width is `M`'s advance in the style's font snapped to whole pixels, the height its `lineHeight`; a cell is a cell, so ligatures never form. A character the family has no glyph for is asked of a monospaced face before the platform's fallback list, shaped smaller where it is still wider than its cells (two under wide), and drawn in their middle (backlog F120); the private use area's icons are left as they fall. Box drawing and block elements (U+2500–U+259F) and the Powerline separators (U+E0B0–U+E0BF: the arrows, and the Powerline Extra half circles and wedges) are not shaped at all but drawn from the cell box — a font's are its own line box tall, a cell is `lineHeight` tall, and through the font every `│` was a dash with a gap under it (backlog F66) and a rounded cap a fallback font's squiggle (F112) — so a TUI's frames and rounded rows are seamless in any font, and bold does not thicken a light line (the set has its heavy variants). JSX passes the cells as a `Uint32Array` (or number array) of four entries per cell — codepoint, fg, bg, flags — or five, with the underline colour, in row-major order; Lua a string per row in `lines` plus `runs` of `{row, col, len, fg, bg, flags, ul}` over them (a run's fg, bg or ul of 0 keeps the default: the style's colour, no background, the foreground); C a `KuiCell` array with `ul`. `cursorAt` (`cursor_at`) names a cell to paint under its glyph in `cursorColor` as a `block` (default), `bar` or `underline` — its own name, since `cursor` is the pointer shape. `originLine` (`origin_line`) is the absolute line number of row 0: a grid is one screenful of the app's own history, so a row number means a different line after every scroll, and stamping where the screen sits is what lets a selection keep its ends across one (`docs/adr/0017-selection-as-a-scope.md`). Saying nothing is 0, and a selection then holds only while the screen does not move. The node's own rows apply — an `onKey` makes it the terminal's sink, an `onClick` or `onDrag` carries `cell: {row, col}` on its events — and its access row is `terminal`, the rows joined as its value.",
2024    },
2025    ElementDef {
2026        name: "line",
2027        // `width` and `color` are schema rows already (a sizing and the text
2028        // colour); on a line they are the stroke's width and colour.
2029        jsx_own: &["from", "to", "points", "curve", "dash", "dashOffset"],
2030        lua_own: &["from", "to", "points", "curve", "dash", "dash_offset"],
2031        jsx_rows: None,
2032        lua_rows: None,
2033        jsx: "`<line from={[x,y]} to={[x,y]} width color/>`, `<line points={[[x,y],…]} curve dash={[6, 4]} dashOffset/>`",
2034        lua: "`line { from={x,y}, to={x,y}, width=, color= }`, `line { points={{x,y},…}, curve=true, dash={6, 4}, dash_offset= }`",
2035        c: "`kui_line`, `kui_polyline`",
2036        doc: "A round-capped stroke: one segment, a polyline through `points`, or a smooth curve through them with `curve`. Always a float in its parent's box space (`float=\"viewport\"` for viewport space), sized to its own bounding box, so it takes no room in a row or column — but a float for the room alone: in its parent's box space it paints in the parent's layer at its place in the tree, over the siblings declared before it and under those after, as a child does, and opens no layer of its own (backlog F123; a connector meant to sit under two cards is declared before them). A stroke in its parent's box space is held by the parent's clip as a child is, its hit region with it, so it is cut at a scroller's edge with the row it is drawn in; a declared float is held that way only when it declares `clip` with a parent anchor, and a `float=\"viewport\"` stroke escapes, and is a layer of its own (backlog F78, `docs/adr/0010-a-segment-primitive.md` decision 5). `width` is the stroke width (default 1) and `color` the stroke colour; `transition` eases the colour, and with `slide` beside it the stroke's position too — the points ride its box, so a stroke whose ends all move together slides with them, while one whose ends move apart resizes at once (a canvas of floats eases everything or nothing, connectors included). Hit by its shape (`docs/adr/0026-hit-testing-by-shape.md`): with `onClick`, `onDrag`, `onHover` or `hoverable` a press within half the width of any piece hits it — at least 4 px of grab, so a hairline is a target — and a press elsewhere in its bounding box falls through to what is under; with none it takes no input and has no access row, and with input it derives one as a box would (a clickable connector is a button), so name it. What it costs: one quad per segment, and a curve is flattened in the core at one piece per 6 logical px of chord (at most 32 per span) — fixed rather than tolerance-driven so every binding gets the same pieces and the corpus can pin them — so a nine-point curve over ~50 px spans is ~60 quads, and a `quadCount` budget should expect it. `dash` cuts the stroke into marks and gaps (backlog V2): one length (marks and gaps alike), a mark and a gap, or four lengths for a dash-dot, in px **as seen** — every mark is a short stroke with the stroke's round caps, so `dash` 6, 4 is 6 px of ink and 4 px of nothing at any width, and a mark no longer than the stroke is wide is a dot (SVG's `stroke-dasharray` measures the centre line instead, so with round caps its `4 4` at a width of 4 is solid; this pattern is SVG's `mark − width, gap + width`). The pattern runs along the stroke's whole length, so it keeps its phase round the corners of a polyline and the pieces of a curve, and `dashOffset` starts that far into it — growing it moves the marks towards the first point, a marquee's marching ants; neither tweens. A pattern with no gap, a mark and gap under a physical pixel together, or more than 16384 marks draws solid. A dashed stroke is hit along its whole length, gaps included, and costs a quad per mark per piece the mark lies on.",
2037    },
2038    ElementDef {
2039        name: "titlebar",
2040        jsx_own: &[],
2041        // The window's own title is `window_title` on the root table; this
2042        // is the string the titlebar draws.
2043        lua_own: &["title"],
2044        jsx_rows: None,
2045        lua_rows: None,
2046        jsx: "`<titlebar title>` or `<titlebar>…</titlebar>`",
2047        lua: "`titlebar { title= }` / `titlebar { … }`",
2048        c: "`kui_titlebar`, `kui_titlebar_with`",
2049        doc: "Adaptive titlebar for custom chrome: drag strip, native-control inset, window buttons.",
2050    },
2051    ElementDef {
2052        name: "menuBar",
2053        jsx_own: &["menu"],
2054        lua_own: &["menu"],
2055        jsx_rows: None,
2056        lua_rows: None,
2057        jsx: "`<menuBar menu={[{ label, items: [{ label, id?, role?, accel?, enabled?, checked? }] }]}/>`",
2058        lua: "`menu_bar { menu = { { label=, items= { { label=, id=, role=, accel=, enabled=, checked= } } } } }`",
2059        c: "`kui_menu_bar`",
2060        doc: "The application menu (`docs/adr/0018-a-menu-bar-the-app-declares.md`): `menu` is what it *is*, and where this element sits is where its titles go when they have to be drawn in the window. One call and not two, because declaring the menu and placing the strip are one decision. It draws **nothing** where the platform owns the bar — macOS, where the driver hands the same declaration to the OS — so the frame has still said what the app's menu is and the strip simply is not there; that is the contract `windowButtons` has under native decorations, and it is what makes one view portable. Its rows are the rows a context menu has: the same `role`s the core performs itself (`copy`, `paste`, `selectAll`, `cut`, `lookUp`), the same `id` payload, the same `accel` text, plus `checked` for a setting — and choosing one posts the same `{kind:\"menu\", role, item}` event, so an app handles one thing whichever menu it came from. Declared every frame and diffed: an unchanged menu costs a comparison, and an empty list takes it away. An accelerator kui can parse is rewritten into the platform's spelling, so `\"mod+s\"` reads as `⌘S` on macOS and `Ctrl+S` elsewhere and binds that key in the platform's own bar. On macOS the first menu is the application menu, which the OS titles with the app's own name whatever the label says. While a menu is open the bar is the frame's modal scope, so hovering across the titles moves the open menu, a press on the open title closes it, and Escape or a press in the app below closes it and reaches nothing else.",
2061    },
2062    ElementDef {
2063        name: "windowButtons",
2064        jsx_own: &[],
2065        lua_own: &[],
2066        jsx_rows: None,
2067        lua_rows: None,
2068        jsx: "`<windowButtons/>`",
2069        lua: "`window_buttons()`",
2070        c: "`kui_window_buttons`",
2071        doc: "Just the min/max/close buttons, for fully custom titlebars.",
2072    },
2073    ElementDef {
2074        name: "tooltip",
2075        jsx_own: &["value"],
2076        lua_own: &["value"],
2077        jsx_rows: None,
2078        lua_rows: None,
2079        jsx: "`<tooltip value=\"hint\"/>` / `<tooltip>…</tooltip>` nodes, or the `tooltip=\"hint\"` prop (see composites)",
2080        lua: "`tooltip(\"hint\")` / `tooltip { … }` nodes, or the prop",
2081        c: "`kui_tooltip`, `kui_tooltip_with`",
2082        doc: "A float hanging below the parent; the node form always draws, the prop form is hover-gated.",
2083    },
2084    ElementDef {
2085        name: "latencyGraph",
2086        jsx_own: &["at"],
2087        lua_own: &["at"],
2088        jsx_rows: None,
2089        lua_rows: None,
2090        jsx: "`<latencyGraph/>`, `<latencyHud at/>`",
2091        lua: "`latency_graph()`, `latency_hud { at= }`",
2092        c: "`kui_latency_graph`, `kui_latency_hud`",
2093        doc: "Per-phase frame timing (windowed drivers fill it; headless shows the chrome empty).",
2094    },
2095    ElementDef {
2096        name: "audio",
2097        jsx_own: &["src", "loop", "volume", "paused", "finish", "tag"],
2098        lua_own: &["src", "loop", "volume", "paused", "finish", "tag"],
2099        jsx_rows: None,
2100        lua_rows: None,
2101        jsx: "`<audio src={id} loop volume paused finish tag/>`",
2102        lua: "`audio { src=, loop=, volume=, paused=, finish=, tag= }`",
2103        c: "`kui_audio`",
2104        doc: "A playback retained by node key: present = playing (once, or looped), gone = stopped; `volume` / `paused` apply live, a changed `src` restarts; a `tag` brings back `{kind:\"sound\", phase:\"ended\", tag}`. Draws nothing. `finish` changes what *gone* means: the node's removal releases the playback rather than stopping it, so a one-shot plays to its end and the view need not know the asset's length to declare the node for it (a loop still stops on removal — there is no end to reach — and a paused playback released has nothing to finish). Without it, the way to play a sound whole is to hold the node declared until the `tag`'s `ended` message arrives. A released playback is not free: it holds one of the device's 128 voices until its file ends, and the 129th play is refused — reported as a `playback-refused` warning and, for a `tag`, `phase: \"refused\"` rather than a wait that never returns. In the app's units, voices held = sound length × release rate: a 1.4 s chime released four times a second holds 6 of the 128 at any moment, a 10 s ambience released once a second holds 10, and every playback still declared (a loop included) counts beside them — a `refused` `sound` event is what arriving at 128 sounds like.",
2105    },
2106];
2107
2108/// An event kind hosts receive, with its payload shape.
2109pub struct EventDef {
2110    pub kind: &'static str,
2111    pub payload: &'static str,
2112    pub doc: &'static str,
2113}
2114
2115pub const EVENTS: &[EventDef] = &[
2116    EventDef {
2117        kind: "click",
2118        payload: "the `onClick` payload as-is",
2119        doc: "A press and release on the node (suppressed when a drag moved past the slop). A map payload gains fields where the node can say more: `cell: {row, col}` on a `cells` grid, and inside an `onKey` sink that draws `role=\"line\"` rows, `line`, `byte` and `clicks` as a `drag` inside one carries them.",
2120    },
2121    EventDef {
2122        kind: "drag",
2123        payload: "`{ kind: \"drag\", phase: \"start\" | \"move\" | \"end\", x, y, dx, dy, parent: { x, y, w, h }, tag }`",
2124        doc: "A pointer-captured drag on an `onDrag` node. `x`/`y` are where the pointer is; `dx`/`dy` are its displacement **from the press point**, in every phase — `start` carries zero, a `move` how far the pointer is from where it pressed, `end` the whole distance — so a handler sets `value = start + dx` rather than summing deltas, and can commit from `end` alone. Nothing is dropped under the click slop (3 px, measured from the press): the first `move` already carries the whole distance. `parent` is the container rect, so fractions need no geometry query. On a `cells` grid every phase also carries `cell: {row, col}`. Inside an `onKey` sink that draws `role=\"line\"` rows — an editor the app owns — every phase carries `line` (the ordinal among the sink's lines, the numbering its `access` events use), `byte` (where the point falls in that line's text, what `textHit` would answer) and `clicks` (the press's count), so click-to-caret, drag-select and double-click-word are arithmetic on the event with no query and no frame of lag; a point above the first line is the first, below the last the last, and one in a `role=\"none\"` gutter is the line beside it. Nothing is added where the sink draws no lines.",
2125    },
2126    EventDef {
2127        kind: "key",
2128        payload: "`{ kind: \"key\", phase: \"down\" | \"up\", code, physical, shift, ctrl, alt, super, text, repeat, location, caps_lock, num_lock, tag }`",
2129        doc: "A key press or release on the focused `onKey` sink; `code` is a character or a name (`\"left\"`, `\"f5\"`) and is what a keymap binds against. `physical` is the US-QWERTY key at that *position*, spelled the same way — bind it instead when you want the finger rather than the label (WASD stays a square on every layout). `code` follows the layout while the layout speaks ASCII, so a chord lands on the key the user can see (Dvorak's `⌥v` on the key printed V); on a layout that does not (Cyrillic, Greek, Hebrew, Arabic) the position's US key stands in, as Shift prints it (`J`, `:`; unshifted under Alt, as a chord reads it), so a Latin keymap keeps matching instead of matching nothing. A shifted letter arrives as the upper-case letter — `Z` with `shift` set for ⇧⌘Z, `physical` staying `z` — so a keymap that binds letters folds a one-character `code` to lower case under a chord; a headless press is spelled the same way, since no door re-spells it (`\"z\"` with `shift` is a chord no keyboard produces). `repeat` marks a press the OS auto-repeated; `text` is what the press would insert — always the layout's own character — and is null on every release. A key only comes up where it went down: a release whose press the sink never got is dropped, and focus leaving while a key is held delivers the `up` first, so a held-key binding (WASD, press-and-hold) cannot be left stuck down. `location` says which of a key's twins it was (backlog F108): `\"left\"` or `\"right\"` for a modifier, `\"numpad\"` for the keypad's digits, operators, Enter and (Num Lock off) arrows — `code` still `\"1\"`, `\"enter\"` — else `\"standard\"`; `caps_lock` and `num_lock` what the lock keys held. The keys F13–F35, `printscreen`, `pause`, `menu`, `clear` and the media keys (`mediaplaypause`, `volumeup`, …) are keys like any other; the modifier and lock keys themselves (`shift`, `ctrl`, `alt`, `super`, `capslock`, `numlock`, `scrolllock`) reach only a sink that says `modifierKeys`.",
2130    },
2131    EventDef {
2132        kind: "text",
2133        payload: "`{ kind: \"text\", text, pasted?: true, concealed?: true, transient?: true, tag }`",
2134        doc: "Text an IME committed at the end of a composition — or the clipboard's text, when the app asked for a paste with `requestPaste` / `request_paste` / `kui_request_paste` — on the focused `onKey` sink (or the nearest one above the focused control, or the root sink with nothing focused) — the one committed text the platform never reports as a key press carrying `text`, so a custom editor inserts it as it would a key's `text`. Plain typing does not arrive this way: the `key` event already carries what the press would insert, and a sink hearing both would type every character twice. A focused `<edit>` takes the commit itself and reports `changed`. A paste's answer carries `pasted: true` (backlog DX14) — an answer being the host's paste reply, or any commit while a paste is outstanding — so a sink that asked tells the clipboard's text from an IME's commit without keeping its own flag; an IME commit has no `pasted`. It also says what the pasteboard marked it (backlog F84): `concealed: true` for a secret — a password manager's copy, which a view should not show, log or keep — and `transient: true` for text not to keep in a history, after the nspasteboard.org convention (on Windows the clipboard's exclusion formats); a marker that is not set is absent, never false. The runner reads them on macOS and Windows; on Linux, and from a host that answers with a bare commit, a paste arrives unmarked.",
2135    },
2136    EventDef {
2137        kind: "preedit",
2138        payload: "`{ kind: \"preedit\", text, cursor: [start, end] | null, tag }`",
2139        doc: "An in-progress IME composition on the focused `onKey` sink: `text` is the uncommitted string to show inline at the caret, `cursor` the byte range inside it the IME's own caret covers (null when it does not say), and an empty `text` means the composition ended without a commit, so what was shown goes away. The OS candidate window is anchored for you: the `line` carrying `caret` says where. A focused `<edit>` draws the composition itself.",
2140    },
2141    EventDef {
2142        kind: "selectionrange",
2143        payload: "`{ kind: \"selectionrange\", from: { index, byte }, to: { index, byte } }` on the scope",
2144        doc: "A copy reached rows of a `selectable` virtual list that no frame built (`docs/adr/0017-selection-as-a-scope.md`, tier 3): the core cannot read text it never laid out, so it asks the app for the range — `index` is a row's data index (its `index` prop), `byte` an offset into that row's text, past the row's length for \"the whole row\" (a Select All over a list that declared `rowCount` ends that way, on its last row) — and the app answers with `answerSelectionRange(text)` / `answer_selection_range` / `kui_answer_selection_range`, which is what reaches the clipboard as a `setClipboard` action. Raised only while a copy is outstanding (`requestCopy()` answered `asked`, or the runner's Cmd/Ctrl-C did); a late answer changes nothing. `examples/rust/features/clipboard.rs` and its Node twin show the round trip.",
2145    },
2146    EventDef {
2147        kind: "contextmenu",
2148        payload: "`{ kind: \"contextmenu\", x, y, tag }`",
2149        doc: "A secondary-button press on an `onContextMenu` node, on the press rather than the release; `x`/`y` are logical viewport coordinates — where the menu goes. The core opens nothing: the app declares the menu (a `modal` float) and stops declaring it on `dismiss`.",
2150    },
2151    EventDef {
2152        kind: "menu",
2153        payload: "`{ kind: \"menu\", role, item }`",
2154        doc: "A row of the core's own context menu was chosen (`openMenu` / `open_menu` / `kui_open_menu`), on the node the menu was about. `item` is the row's `id`, or its label when it declared none; `role` is the row's standard role or `custom`. Every chosen row posts, the standard ones included: a `cut` or `paste` role is carried out by the core (its clipboard work queued for the host) *and* reported, so an app can hear its editor being cut from and is free to ignore it (`docs/adr/0017-selection-as-a-scope.md`, decision 5).",
2155    },
2156    EventDef {
2157        kind: "forceclick",
2158        payload: "`{ kind: \"forceclick\", x, y, tag }`",
2159        doc: "A press that deepened past the second stage of a Force Touch trackpad, on an `onForceClick` node, at the logical viewport point it happened at. Routed as a secondary press is — no focus moved, no caret placed, no click — but asked of the topmost node only, and the ordinary click the press is still producing arrives afterwards. Text needs none of this: over an `edit` or a `selectable` scope the core selects the word under it and asks the host for its Look Up panel instead. macOS-only in practice.",
2160    },
2161    EventDef {
2162        kind: "button",
2163        payload: "`{ kind: \"button\", phase: \"press\" | \"move\" | \"release\", button: \"secondary\" | \"middle\" | number, x, y, clicks, cell?: { row, col }, line?, byte?, tag }`",
2164        doc: "A non-primary button on an `onButton` node that claims it (`buttons`), backlog F105: `press` where it went down — with the driver's click count, `clicks`, which the native runner keeps for the primary button alone and so always reports as 1 here — then `move` for every pointer move while it is held and `release` where it came up, both on the same node wherever the pointer went, since the press captured the button. `button` is the button's name, or for one past the middle button its number (`3 + n`, as `kui_input_mouse_button` takes it; Node's `ctx.mouse` takes the three names only); `x`/`y` are logical viewport coordinates. On a `cells` grid each carries `cell: {row, col}`, clamped to the grid, and inside an `onKey` sink that draws `role=\"line\"` rows `line` and `byte` as a drag does. A claimed secondary press is this event instead of `contextmenu`; the press moves no focus, caret, selection or scrollbar.",
2165    },
2166    EventDef {
2167        kind: "scroll",
2168        payload: "`{ kind: \"scroll\", x, y, dx, dy, lines, mods?: { shift, ctrl, alt, super }, tag }`",
2169        doc: "The wheel over an `onScroll` node, or a drag-select held past a `cells` grid's top or bottom edge: `dx`/`dy` the delta in logical px as the driver reported it (positive `dy` is the wheel rolling up, toward earlier content), `x`/`y` the pointer in logical viewport coordinates, `lines` the whole lines a `cells` grid's `dy` covers — positive is later history, the sign `originLine` grows in, the fraction carried to the next notch — and null on any other node. The core scrolls nothing for it: the app re-declares the grid's `originLine`, or zooms its canvas. From the edge drag it comes once a frame while the pointer is held past the edge, with the lines that frame's step covers, and the selection's absolute lines survive the scroll the app answers with (`docs/adr/0029-a-selection-follows-the-pointer-past-the-edge.md`).",
2170    },
2171    EventDef {
2172        kind: "focus",
2173        payload: "`{ kind: \"focus\", phase: \"in\" | \"out\", by: \"pointer\" | \"keyboard\" | \"assistive\" | \"program\", tag }`",
2174        doc: "Keyboard focus entered or left an `onFocus` node's subtree (backlog DX18). `by` is what moved it — a press, a key, a screen reader's request, or the view and the app — so a pane that follows a click into its sink tells that apart from a move the app made itself.",
2175    },
2176    EventDef {
2177        kind: "hover",
2178        payload: "`{ kind: \"hover\", phase: \"enter\" | \"leave\", by: \"pointer\" | \"content\", tag }`",
2179        doc: "The pointer entered or left an `onHover` node — also when a new frame moved it under a still cursor. `by` says which (backlog DX20): `pointer` when the pointer moved or left the window, `content` when it stayed and what is under it changed — a list scrolled by the wheel or the keys, a row that grew, a float that opened. A picker whose selection follows the pointer ignores `content`, or the rows sliding under a still pointer as the keys scroll the list drag the selection with them.",
2180    },
2181    EventDef {
2182        kind: "drop",
2183        payload: "`{ kind: \"drop\", phase: \"enter\" | \"move\" | \"leave\" | \"drop\", paths: string[], x, y, tag }`",
2184        doc: "Files dragged in from the OS over an `onDrop` node (`docs/adr/0031-a-drop-zone-is-a-row-and-the-files-are-an-event.md`): `enter` when they come over the zone, `move` while they move over it (never twice for one point), `leave` when they go to another zone, to no zone or out of the window, `drop` when they land — and no `leave` after a `drop`. `paths` are the OS paths as strings; `x`/`y` the pointer in logical viewport coordinates, absent on `leave`. The zone is the topmost one under the pointer by paint order; a node inside it is its, and a node that is no zone is looked past (an overlay shown on `enter` does not end the hover). Nothing is re-resolved when a frame lands: only the driver's next report moves the files, so a zone the view stops declaring hears its `leave` then.",
2185    },
2186    EventDef {
2187        kind: "files",
2188        payload: "`{ kind: \"files\", paths: string[], tag }`",
2189        doc: "A file dialog's answer (backlog C51): what an Open, Save or folder dialog asked for with `requestFiles` / `request_files` / `kui_request_files` picked — the OS paths, as a `drop` carries them — or no paths when the user cancelled. `tag` is the dialog's own. It reaches whoever asked: the host, or the extension whose fill asked; one dialog is out at a time.",
2190    },
2191    EventDef {
2192        kind: "layout",
2193        payload: "`{ kind: \"layout\", x, y, w, h, parent: { x, y, w, h }, scale, tag }`",
2194        doc: "The rect layout gave an `onLayout` node (logical px, viewport coords, after scrolling and easing): on its first frame and whenever it changes, never on a frame that left it alone. `scale` is physical px per logical px at the node — `w × scale` by `h × scale` is how many pixels to render for it before `updateImage` (the frame's scale today; where a zoom would compose in).",
2195    },
2196    EventDef {
2197        kind: "resize",
2198        payload: "`{ kind: \"resize\", width, height, scale }`",
2199        doc: "The viewport changed size or DPI (logical px, delivered to the host on the root): the window less the devtools' dock while the panel is docked (`docs/adr/0024`), so a dock coming, going or being dragged is a resize too. `KuiWindow.size()` queries the same numbers, before the first frame as well (backlog F43). The first frame establishes the viewport rather than reporting it, so a dock present at launch posts none.",
2200    },
2201    EventDef {
2202        kind: "window",
2203        payload: "`{ kind: \"window\", phase: \"opened\" | \"closed\" | \"focused\" | \"blurred\", name, id }`",
2204        doc: "A declared window opened (the diff queued its `Open`) or closed — because nothing declares it any more, or because the user closed it, in which case it stays closed while still declared: stop declaring `name`, then declare it again to reopen. `id` is what its events carry; the event itself is on the root of whichever window's frame noticed. `focused` and `blurred` are this window gaining and losing the keyboard (backlog DX18) — `env.focused` changing, as the driver reports it — so an app that saves on blur or re-reads the clipboard on return hears it once instead of diffing `env.focused` every frame.",
2205    },
2206    EventDef {
2207        kind: "system",
2208        payload: "`{ kind: \"system\", appearance, accent, motion, locale, assistive }`",
2209        doc: "An OS setting the user changed while the app was open — the light/dark appearance, the accent colour, reduced motion, or the UI language — or assistive technology starting to listen (delivered to the host on the root, one per window that noticed). The payload is `env.system` as it now reads, in the same spellings and with the same nulls, so a handler can keep the whole reading or take the one field it branches on. The first frame establishes the reading rather than reporting it, the way the viewport does; a host whose view is a function the runner calls every frame can equally re-read `env` and ignore this, but a host that retains the tree it was handed (Node, C, Lua) only re-runs its view for a message, so this is how a palette follows the OS.",
2210    },
2211    EventDef {
2212        kind: "fonts",
2213        payload: "`{ kind: \"fonts\" }`",
2214        doc: "The system's installed fonts changed: a rescan found a face installed or removed since the last one (delivered to the host on the root, one per window that noticed). The winit runner rescans itself when macOS or Windows says the set changed; elsewhere it is the app calling `reloadSystemFonts`. Re-read `systemFonts()` / `systemFontFamilies()` here if the model holds them; a view naming a family by `family` needs nothing, it resolves on the same frame. A font the app loads itself raises none, and the first frame establishes the set rather than reporting it.",
2215    },
2216    EventDef {
2217        kind: "modifiers",
2218        payload: "`{ kind: \"modifiers\", shift, ctrl, alt, super }`",
2219        doc: "The physical modifier state changed (delivered to the host on the root).",
2220    },
2221    EventDef {
2222        kind: "changed",
2223        payload: "`{ kind: \"changed\" }`, with the editor's key on the event",
2224        doc: "An editor's text changed.",
2225    },
2226    EventDef {
2227        kind: "submit",
2228        payload: "`{ kind: \"submit\" }`, with the editor's key on the event",
2229        doc: "Enter in a single-line editor.",
2230    },
2231    EventDef {
2232        kind: "sound",
2233        payload: "`{ kind: \"sound\", phase: \"ended\" | \"refused\", playback, tag }`",
2234        doc: "A tagged playback (`play(id, { tag })` or `<audio tag>`) finished on its own — never when something stopped it. `phase: \"refused\"` instead when the device would not take the play at all (its 128 voices are all held, or the sound did not decode): that playback never starts and so never ends, so this is what arrives in place of the `ended` a view would otherwise wait forever for.",
2235    },
2236    EventDef {
2237        kind: "dismiss",
2238        payload: "`{ kind: \"dismiss\", reason: \"escape\" | \"outside\", tag }` on a node; `{ kind: \"dismiss\", reason, name, id }` on the root for a popup window",
2239        doc: "The user asked for a surface to go away — Escape, or a press that landed outside it. The core closes nothing: the app stops declaring the surface (or asks first). A `modal` node gets one on the node, carrying its tag, and only the modal in effect does; a `kind: \"popup\"` window gets one on the root, carrying the window's `name` and `id`, reported by the driver because a press outside a window and a key sent to a non-activating one are both facts only the OS has. The two are the same event, so a dropdown that graduates from a modal float to a popup window changes its declaration and not its handler.",
2240    },
2241    EventDef {
2242        kind: "access",
2243        payload: "`{ kind: \"access\", action, tag, text?, value?, anchor?: { line, offset }, focus?: { line, offset } }`",
2244        doc: "Assistive technology — or the keyboard — asked for what only the app can do: `increment` / `decrement` on a `slider` role that declared no `onChange` (a reader's nudge, or the arrow keys on the focused slider), and `setValue` there with the number asked for as `value` (Windows' UI Automation sets a slider rather than nudging it); `setValue` / `replaceSelectedText` (with `text`) / `setTextSelection` (with `anchor` and `focus` as line ordinals and byte offsets) on a custom editor. `tag` is the node's `onClick` payload (or its `onDrag` / `onKey` tag). Every other request resolves in the core and arrives as the events a pointer would have produced.",
2245    },
2246    EventDef {
2247        kind: "change",
2248        payload: "`{ kind: \"change\", value, phase: \"move\" | \"end\", tag }`",
2249        doc: "A `slider` that declared `onChange` (the stock `<slider>`, ADR 0034): the core turned a press into the value under the pointer, a drag into each new step, an arrow or assistive technology's increment / decrement into one `valueStep` and its set value into that value snapped, PageUp / PageDown into ten, Home / End into the ends — clamped to `valueMin`..`valueMax` and snapped to the step, the decimal the step names. `phase` is `move` while the pointer holds the slider and `end` when it lets go or a key moved it; a key that lands where the slider is proposes nothing. The value is proposed: declare it as `valueNow`. `tag` is the `onChange` payload.",
2250    },
2251];
2252
2253/// A host-registered resource and how each binding registers it.
2254pub struct ResourceDef {
2255    pub what: &'static str,
2256    pub node: &'static str,
2257    pub lua: &'static str,
2258    pub c: &'static str,
2259}
2260
2261pub const RESOURCES: &[ResourceDef] = &[
2262    ResourceDef {
2263        what: "image",
2264        node: "`ctx.addImage(w, h, rgba)` → id for `<image src>`",
2265        lua: "the host registers; `image { id }`",
2266        c: "`kui_image_add` → `kui_image`",
2267    },
2268    ResourceDef {
2269        what: "fragment (WGSL)",
2270        node: "`ctx.addFragment(src)` → id for `<fragment src>`",
2271        lua: "the host registers; `fragment { id }`",
2272        c: "`kui_fragment_add` → `kui_fragment`",
2273    },
2274    ResourceDef {
2275        what: "font from bytes",
2276        node: "`ctx.addFont(buffer)` → id for `font`",
2277        lua: "the host registers; `font = id`",
2278        c: "`kui_font_add` → `KuiTextStyle.font`",
2279    },
2280    ResourceDef {
2281        what: "font file by path",
2282        node: "`ctx.loadFontFile(\"fonts/Antonio.ttf\")` → id for `font`",
2283        lua: "the host registers; `font = id`",
2284        c: "`kui_font_load_file`",
2285    },
2286    ResourceDef {
2287        what: "a folder of fonts",
2288        node: "`ctx.loadFontsDir(\"fonts\")`, then pick by name",
2289        lua: "the host loads",
2290        c: "`kui_font_load_dir`",
2291    },
2292    ResourceDef {
2293        what: "font by family name (installed or loaded)",
2294        node: "`ctx.addSystemFont(\"Antonio\")` (see `systemFontFamilies()`)",
2295        lua: "the host registers; `font = id`",
2296        c: "`kui_font_add_system` (see `kui_font_families`)",
2297    },
2298    ResourceDef {
2299        what: "sound (wav / ogg / mp3 / flac bytes)",
2300        node: "`ctx.addSound(buffer)` → id for `<audio src>`, `clickSound`, `play(id)`",
2301        lua: "the host registers; `audio { src = id }`, `click_sound = id`",
2302        c: "`kui_sound_add` → `kui_audio`, `KuiSpec.click_sound`, `kui_play`",
2303    },
2304];
2305
2306/// One value in the host-environment reading a view gets — `ui.env()` in
2307/// Rust, `view(env)` in Lua, `ctx.env()` / `win.env()` in Node — and the
2308/// key each binding puts it under. C has no reading: a C host is the frame
2309/// driver, so it is the *writer* (`kui_env_set`, `kui_env_set_window`), and
2310/// its column names the argument that carries the fact in.
2311///
2312/// `Env` and `WindowEnv` are the shape; this table is the cross-binding
2313/// restatement of it, and every restatement is pinned to it rather than
2314/// trusted: `schema`'s tests check the rows against the two structs, the
2315/// Lua and Node key-set tests check each binding's reading against the
2316/// `lua` / `node` columns, and kui-ffi checks the header's two prototypes
2317/// against the `c` column. The frame facts a view wants at the same moment
2318/// (the viewport, the focused node) ride in the same reading and have rows
2319/// here too, marked as the frame's rather than `Env`'s.
2320///
2321/// Two divergences are deliberate and named in their rows: `native_controls`
2322/// is the `Rect` the core holds in Node and a width/height at the window
2323/// origin in Lua and C, and `frame_budget_ms` is derived from `refresh_hz`
2324/// but part of the reading everywhere.
2325pub struct EnvField {
2326    /// The canonical name: the Rust field path (`window.custom_chrome`).
2327    pub name: &'static str,
2328    /// Where it comes from — the Rust struct and field for a stored fact,
2329    /// the call for a derived or frame fact.
2330    pub from: &'static str,
2331    /// The key path(s) it occupies in Node's `ctx.env()`; empty when Node
2332    /// carries the fact as a call on the context instead (the `doc` says
2333    /// which) or not at all.
2334    pub node: &'static [&'static str],
2335    /// The same for Lua's `view(env)` table. Two entries where Lua flattens
2336    /// one fact into two keys.
2337    pub lua: &'static [&'static str],
2338    /// The C spelling: `function(argument)` for the setter argument that
2339    /// writes it — the first thing in the cell, so kui-ffi can parse it —
2340    /// or the call that reads it.
2341    pub c: &'static str,
2342    pub doc: &'static str,
2343    /// The fact's reading, as plain data: `Null` for "the host cannot
2344    /// tell", an enum as its wire name, a key as its integer, a rect as
2345    /// `{x, y, w, h}`. What makes the table a reader and not only a pin —
2346    /// a binding iterates the rows and asks each for its value, then
2347    /// spells the key its own way, so a fact added here reaches every
2348    /// reading with no reader restated beside it (the way
2349    /// [`ThemeRole::get`] does for the palette).
2350    pub get: fn(&EnvFacts) -> Value,
2351}
2352
2353/// Everything an env reading is taken from: the stored [`Env`](crate::env::Env) and the
2354/// frame's own facts beside it (`Core::env_facts`).
2355#[derive(Clone, Copy, Debug)]
2356pub struct EnvFacts {
2357    pub env: crate::env::Env,
2358    pub viewport: crate::geom::Size,
2359    pub scale: f32,
2360    pub focus: Option<crate::key::Key>,
2361    pub focus_visible: bool,
2362    pub region: Option<crate::key::Key>,
2363    pub caret_visible: bool,
2364}
2365
2366fn key_value(k: Option<crate::key::Key>) -> Value {
2367    k.map_or(Value::Null, |k| Value::Int(k.0 as i64))
2368}
2369
2370fn rect_value(r: crate::geom::Rect) -> Value {
2371    Value::map([
2372        ("x", Value::Float(r.x as f64)),
2373        ("y", Value::Float(r.y as f64)),
2374        ("w", Value::Float(r.w as f64)),
2375        ("h", Value::Float(r.h as f64)),
2376    ])
2377}
2378
2379pub const ENV_FIELDS: &[EnvField] = &[
2380    EnvField {
2381        name: "refresh_hz",
2382        get: |f| {
2383            f.env
2384                .refresh_hz
2385                .map_or(Value::Null, |hz| Value::Float(hz as f64))
2386        },
2387        from: "`Env::refresh_hz`",
2388        node: &["refreshHz"],
2389        lua: &["refresh_hz"],
2390        c: "`kui_env_set(refresh_hz)`",
2391        doc: "Display refresh rate in Hz. \"The host cannot tell\" is `null` in Node (a stable shape to destructure, typed `number | null`), an absent key in Lua, and a rate at or below zero in C.",
2392    },
2393    EnvField {
2394        name: "frame_budget_ms",
2395        get: |f| Value::Float(f.env.frame_budget_ms() as f64),
2396        from: "`Env::frame_budget_ms()`, derived",
2397        node: &["frameBudgetMs"],
2398        lua: &["frame_budget_ms"],
2399        c: "—",
2400        doc: "One vsync interval at `refresh_hz`, or at 120 Hz when the host cannot tell: the per-frame time budget, and what the latency HUD draws its line at. Derived, and in the reading anyway, so no view restates the fallback. A C host is the one that knows the rate and computes its own.",
2401    },
2402    EnvField {
2403        name: "focused",
2404        get: |f| Value::Bool(f.env.focused),
2405        from: "`Env::focused`",
2406        node: &["focused"],
2407        lua: &["focused"],
2408        c: "`kui_env_set(focused)`",
2409        doc: "Whether the *window* has the keyboard at all. Not the focused node — that is the `focus` row.",
2410    },
2411    EnvField {
2412        name: "system.appearance",
2413        get: |f| Value::str(f.env.system.appearance.name()),
2414        from: "`SystemEnv::appearance`",
2415        node: &["system.appearance"],
2416        lua: &["system.appearance"],
2417        c: "`kui_env_set_system(appearance)`",
2418        doc: "The OS light/dark setting: `\"light\"`, `\"dark\"`, or `\"unknown\"` when the host has no way to ask (`KUI_APPEARANCE_*` in C, where unknown is 0). Unknown is a real answer and the default — a view picks its own palette for it rather than being handed a guess. The core acts on it in one way: the theme is derived from it (ADR 0019), so the stock widgets and a `<text>` with no colour follow the setting — and nothing of the app's own repaints, because only the view knows which of its colours is the background.",
2419    },
2420    EnvField {
2421        name: "system.accent",
2422        get: |f| {
2423            f.env
2424                .system
2425                .accent
2426                .map_or(Value::Null, |c| Value::Int(c.to_hex() as i64))
2427        },
2428        from: "`SystemEnv::accent`",
2429        node: &["system.accent"],
2430        lua: &["system.accent"],
2431        c: "`kui_env_set_system(accent)`",
2432        doc: "The OS accent/highlight colour as `0xRRGGBBAA`, ready to pass straight back as a `bg` or `color`. \"The host cannot tell\" is `null` in Node, an absent key in Lua, and 0 in C — a fully transparent accent is not a colour anyone was given, the way a refresh rate of zero is not a rate. Node's `setEnv` also takes the `\"#rrggbb\"` spelling a prop takes.",
2433    },
2434    EnvField {
2435        name: "system.motion",
2436        get: |f| Value::str(f.env.system.motion.name()),
2437        from: "`SystemEnv::motion`",
2438        node: &["system.motion"],
2439        lua: &["system.motion"],
2440        c: "`kui_env_set_system(motion)`",
2441        doc: "The OS reduce-motion setting: `\"reduced\"` when the user asked for less animation, `\"full\"` when they did not, `\"unknown\"` when nobody asked the OS (`KUI_MOTION_*` in C, unknown 0). Spelled as what the user wants rather than as a `reduceMotion` boolean, because the third reading has no place in a boolean. Nothing in the core shortens an animation for it — a view that honours it does so where it declares one.",
2442    },
2443    EnvField {
2444        name: "system.locale",
2445        get: |f| {
2446            f.env
2447                .system
2448                .locale
2449                .map_or(Value::Null, |l| Value::str(l.as_str()))
2450        },
2451        from: "`SystemEnv::locale`",
2452        node: &["system.locale"],
2453        lua: &["system.locale"],
2454        c: "`kui_env_set_system(locale)`",
2455        doc: "The UI language as a BCP-47 tag (`\"en\"`, `\"en-US\"`, `\"zh-Hant-HK\"`), for whatever the view formats dates and numbers with; kui does not parse it. Carried inline (31 ASCII bytes, `Locale`) so the reading stays `Copy`, and anything that does not fit reads back as unknown: `null` in Node, an absent key in Lua, an empty `KuiStr` in C.",
2456    },
2457    EnvField {
2458        name: "system.assistive",
2459        get: |f| Value::str(f.env.system.assistive.name()),
2460        from: "`SystemEnv::assistive`",
2461        node: &["system.assistive"],
2462        lua: &["system.assistive"],
2463        c: "`kui_env_set_assistive(assistive)`",
2464        doc: "Whether assistive technology is listening: `\"listening\"` once an accessibility client has asked this window for its tree, `\"none\"` while the bridge is up and nobody has, `\"unknown\"` where there is no bridge — a headless `Ctx`, a runner built without `accesskit`, a C host that never called the setter (`KUI_ASSISTIVE_*`, unknown 0). The reading that changes what a view *says* rather than what it draws: an alert that announces when something is listening and blinks when nothing is. Reported through the `system` event when it changes, like the other four. Two limits are the platform's, not kui's. *Any* client counts — a probe, an accessibility inspector, a test driving the AX API and VoiceOver alike all ask for the tree, and nothing tells them apart — so it says something is listening, not that a person is. And it falls back to `\"none\"` only where the adapter reports deactivation, which in the pinned AccessKit is AT-SPI alone (the session's accessibility bus going away); on macOS and Windows nothing reports a client leaving, so once it has risen it stays `\"listening\"` for the window's life.",
2465    },
2466    EnvField {
2467        name: "window.id",
2468        get: |f| Value::Int(f.env.window.id.0 as i64),
2469        from: "`WindowEnv::id`",
2470        node: &["window.id"],
2471        lua: &["window.id"],
2472        c: "`kui_env_set_window(window)`, read back by `kui_ctx_window`",
2473        doc: "Which window this frame draws, assigned by the driver: 0 for the window the app starts in. Every event from it carries the same number.",
2474    },
2475    EnvField {
2476        name: "window.custom_chrome",
2477        get: |f| Value::Bool(f.env.window.custom_chrome),
2478        from: "`WindowEnv::custom_chrome`",
2479        node: &["window.customChrome"],
2480        lua: &["window.custom_chrome"],
2481        c: "`kui_env_set_window(custom_chrome)`",
2482        doc: "The host asked the app to draw its own chrome, so there is no native titlebar to sit under. `<titlebar>` and `<windowButtons>` build nothing when this is false.",
2483    },
2484    EnvField {
2485        name: "window.maximized",
2486        get: |f| Value::Bool(f.env.window.maximized),
2487        from: "`WindowEnv::maximized`",
2488        node: &["window.maximized"],
2489        lua: &["window.maximized"],
2490        c: "`kui_env_set_window(maximized)`",
2491        doc: "The window is maximized — what picks the restore glyph over the maximize one.",
2492    },
2493    EnvField {
2494        name: "window.fullscreen",
2495        get: |f| Value::Bool(f.env.window.fullscreen),
2496        from: "`WindowEnv::fullscreen`",
2497        node: &["window.fullscreen"],
2498        lua: &["window.fullscreen"],
2499        c: "`kui_env_set_window(fullscreen)`",
2500        doc: "The window is fullscreen.",
2501    },
2502    EnvField {
2503        name: "window.always_on_top",
2504        get: |f| Value::Bool(f.env.window.always_on_top),
2505        from: "`WindowEnv::always_on_top`",
2506        node: &["window.alwaysOnTop"],
2507        lua: &["window.always_on_top"],
2508        c: "`kui_env_set_always_on_top(always_on_top)`",
2509        doc: "The window is above every other app's: the level the driver set after the frame asked for it (`alwaysOnTop` / `always_on_top` / `kui_set_always_on_top`, backlog C30), on a platform that has one. On Wayland winit has no call for it, so a driver there reports false however often the app asks — which is why a pin button draws its state from this and not from the app's own flag. It is the driver's record of what it set and not a query (winit has no level getter), so a level the OS dropped afterwards — a fullscreen space, a tiling manager — is not seen here. A C host reports it through its own setter rather than an argument on `kui_env_set_window`, the way `kui_env_set_assistive` is, so an older host that never applies a level has nothing to recompile.",
2510    },
2511    EnvField {
2512        name: "window.native_controls",
2513        get: |f| f.env.window.native_controls.map_or(Value::Null, rect_value),
2514        from: "`WindowEnv::native_controls`",
2515        node: &["window.nativeControls"],
2516        lua: &["window.controls_w", "window.controls_h"],
2517        c: "`kui_env_set_window(controls_w, controls_h)`",
2518        doc: "Area (logical px, window coordinates) covered by controls the OS still draws over our content — the macOS traffic lights under custom chrome. Keep out of it. Node hands back the `Rect` the core holds (`{x, y, w, h}`, or `null` for none); Lua and C flatten it to a width and height anchored at the window origin (absent in Lua, `0` in C, for none), which is the shape C's two numbers can express and where the one real instance sits.",
2519    },
2520    EnvField {
2521        name: "audio.device",
2522        get: |f| Value::str(f.env.audio.device.name()),
2523        from: "`AudioEnv::device`",
2524        node: &["audio.device"],
2525        lua: &["audio.device"],
2526        c: "`kui_env_set_audio(device)`",
2527        doc: "What the driver's output device is doing: `\"closed\"` (the default, and a headless driver's answer), `\"opening\"` (the ~90 ms open, on its own thread), `\"open\"`, or `\"failed\"` (it refused, and commands are dropped) — `KUI_AUDIO_DEVICE_*` in C, closed 0. A fact and not a verb: nothing lets a view close it, the driver does that itself once it has been idle a while. Worth reading because an open stream is a real-time thread whether or not anything plays, which is the whole of an idle app's CPU once a session has held a sound.",
2528    },
2529    EnvField {
2530        name: "audio.live",
2531        get: |f| Value::Int(f.env.audio.live as i64),
2532        from: "`AudioEnv::live`",
2533        node: &["audio.live"],
2534        lua: &["audio.live"],
2535        c: "`kui_env_set_audio(live)`",
2536        doc: "Playbacks started and not yet ended, plus any waiting on the device to open. Zero with the device still `\"open\"` is the idle stream the row above is about. A play that arrives while the device is `\"opening\"` counts here from the frame it was asked, until the open answers: if the device refuses, the play is refused on the next apply — `{kind:\"sound\", phase:\"refused\"}` for a tagged one — and leaves the count with it, so what a machine with no output device shows is `opening`/1 then `failed`/0 with the refusal between (backlog F63).",
2537    },
2538    EnvField {
2539        name: "viewport.w",
2540        get: |f| Value::Float(f.viewport.w as f64),
2541        from: "`Core::viewport()`, the frame's",
2542        node: &["viewport.width"],
2543        lua: &["viewport_w"],
2544        c: "`kui_frame_begin(w)`",
2545        doc: "The logical width of the current (or last) frame's viewport — the window less the devtools' dock while the panel is docked (`docs/adr/0024`), the same number a `resize` reports and Node's `KuiWindow.size()` answers — the other host fact a view wants at the same moment, so it rides in the same reading. Zero before the first frame, since the frame establishes it (backlog F43: this row once read the window instead, so an app under `KUI_DEVTOOLS` sized itself to a viewport it did not have). Node's `viewport` is the `WindowSize` shape `runWindowed` already uses.",
2546    },
2547    EnvField {
2548        name: "viewport.h",
2549        get: |f| Value::Float(f.viewport.h as f64),
2550        from: "`Core::viewport()`, the frame's",
2551        node: &["viewport.height"],
2552        lua: &["viewport_h"],
2553        c: "`kui_frame_begin(h)`",
2554        doc: "Its logical height.",
2555    },
2556    EnvField {
2557        name: "scale",
2558        get: |f| Value::Float(f.scale as f64),
2559        from: "`Core::scale()`, the frame's",
2560        node: &["viewport.scale"],
2561        lua: &[],
2562        c: "`kui_frame_begin(scale)`",
2563        doc: "Device pixels per logical px. Lua has no reading: a script sees logical px only.",
2564    },
2565    EnvField {
2566        name: "focus",
2567        get: |f| key_value(f.focus),
2568        from: "`Core::focus()`, the frame's",
2569        node: &[],
2570        lua: &["focus"],
2571        c: "`kui_focused()`",
2572        doc: "The focused *node*'s key, as events carry it (absent for none). A value the host wrote before the view ran, so it lags a same-frame verb by one frame; `env.is_focused(key)` is the live query. Node spells it as the call `focused()` on the context, and C as `kui_focused`, rather than a key on `env`.",
2573    },
2574    EnvField {
2575        name: "focus_visible",
2576        get: |f| Value::Bool(f.focus_visible),
2577        from: "`Core::focus_visible()`, the frame's",
2578        node: &[],
2579        lua: &["focus_visible"],
2580        c: "`kui_focus_visible()`",
2581        doc: "Whether focus shows — the keyboard or assistive technology put it where it is, or acted on it there; a click alone does not. Node: `focusVisible()` on the context.",
2582    },
2583    EnvField {
2584        name: "caret_visible",
2585        get: |f| Value::Bool(f.caret_visible),
2586        from: "`Core::caret_visible()`, the frame's",
2587        node: &[],
2588        lua: &["caret_visible"],
2589        c: "`kui_caret_visible()`",
2590        doc: "The caret's blink phase — `true` draws it (backlog C35). The driver's clock sets it while there is a caret to blink: a focused `edit`'s, or the `caret` a `line` under a focused `onKey` sink declares; a custom editor draws its caret node on the on phase and skips it on the off, keeping the `caret` row on its `line` either way, so it blinks in step with the stock editor and, in a window without the keyboard, not at all. Always `true` headless. Node: `caretVisible()` on the context (`setCaretVisible` is the driver's half, for a test that drives the phase).",
2591    },
2592    EnvField {
2593        name: "region",
2594        get: |f| key_value(f.region),
2595        from: "`Core::region()`, the frame's",
2596        node: &[],
2597        lua: &["region"],
2598        c: "`kui_region()`",
2599        doc: "The focus region in effect — the key of the `focusRegion` node whose ring Tab walks (absent for the main ring; `docs/adr/0022-focus-regions.md`). What a chord that toggles between a dock and the app reads to know which way it is going. Node spells it as the call `region()` on the context, and C as `kui_region`.",
2600    },
2601];
2602
2603/// One colour role in a [`crate::theme::Theme`], with the spelling each
2604/// binding reads it under and the reading itself.
2605///
2606/// The same pin `ENV_FIELDS` is: the palette is one contract, so the roles
2607/// are written down once and every binding's reading is generated from
2608/// this table rather than restated beside it. `get` is what makes that
2609/// possible — a binding iterates the rows and asks each one for its
2610/// colour, so adding a token is one row here and nothing anywhere else.
2611/// The test below destructures [`crate::theme::Theme`] exhaustively, so a
2612/// field added to it stops the crate compiling until it has a row.
2613pub struct ThemeRole {
2614    /// The Rust field, and the name used everywhere but Node.
2615    pub name: &'static str,
2616    /// What Node calls it (camelCase).
2617    pub node: &'static str,
2618    pub doc: &'static str,
2619    /// This role's colour out of a theme.
2620    pub get: fn(&crate::theme::Theme) -> crate::color::Color,
2621    /// The same colour written: what a binding's theme setter uses, so
2622    /// writing a palette is the table's business the way reading one is.
2623    pub set: fn(&mut crate::theme::Theme, crate::color::Color),
2624}
2625
2626pub const THEME_ROLES: &[ThemeRole] = &[
2627    ThemeRole {
2628        name: "bg",
2629        node: "bg",
2630        get: |t| t.bg,
2631        set: |t, c| t.bg = c,
2632        doc: "The window behind everything.",
2633    },
2634    ThemeRole {
2635        name: "surface",
2636        node: "surface",
2637        get: |t| t.surface,
2638        set: |t, c| t.surface = c,
2639        doc: "A card, panel or list sitting on `bg`.",
2640    },
2641    ThemeRole {
2642        name: "raised",
2643        node: "raised",
2644        get: |t| t.raised,
2645        set: |t, c| t.raised = c,
2646        doc: "A surface floating above content: a menu, a tooltip, a popover. Under a light theme it is no lighter than `surface` — a float on a white page separates by its border.",
2647    },
2648    ThemeRole {
2649        name: "sunken",
2650        node: "sunken",
2651        get: |t| t.sunken,
2652        set: |t, c| t.sunken = c,
2653        doc: "A well cut into a surface: a text field, a code block, a track.",
2654    },
2655    ThemeRole {
2656        name: "border",
2657        node: "border",
2658        get: |t| t.border,
2659        set: |t, c| t.border = c,
2660        doc: "The hairline between two surfaces.",
2661    },
2662    ThemeRole {
2663        name: "border_strong",
2664        node: "borderStrong",
2665        get: |t| t.border_strong,
2666        set: |t, c| t.border_strong = c,
2667        doc: "A border that has to be seen — a float's edge, a focused field.",
2668    },
2669    ThemeRole {
2670        name: "fg",
2671        node: "fg",
2672        get: |t| t.fg,
2673        set: |t, c| t.fg = c,
2674        doc: "Body text, and what a `color`-less text run resolves to.",
2675    },
2676    ThemeRole {
2677        name: "muted",
2678        node: "muted",
2679        get: |t| t.muted,
2680        set: |t, c| t.muted = c,
2681        doc: "Secondary text: captions, hints, an accelerator beside a label.",
2682    },
2683    ThemeRole {
2684        name: "faint",
2685        node: "faint",
2686        get: |t| t.faint,
2687        set: |t, c| t.faint = c,
2688        doc: "Text that is barely there: a placeholder, a gutter number.",
2689    },
2690    ThemeRole {
2691        name: "accent",
2692        node: "accent",
2693        get: |t| t.accent,
2694        set: |t, c| t.accent = c,
2695        doc: "The one saturated colour: the OS accent where the host reports one, the app's where it pinned one, kui's blue otherwise. The `accent` prop paints from this.",
2696    },
2697    ThemeRole {
2698        name: "accent_hover",
2699        node: "accentHover",
2700        get: |t| t.accent_hover,
2701        set: |t, c| t.accent_hover = c,
2702        doc: "`accent` under a pointer.",
2703    },
2704    ThemeRole {
2705        name: "accent_pressed",
2706        node: "accentPressed",
2707        get: |t| t.accent_pressed,
2708        set: |t, c| t.accent_pressed = c,
2709        doc: "`accent` under a press.",
2710    },
2711    ThemeRole {
2712        name: "on_accent",
2713        node: "onAccent",
2714        get: |t| t.on_accent,
2715        set: |t, c| t.on_accent = c,
2716        doc: "Black or white — whichever a reader can see on `accent`. What a button's label is.",
2717    },
2718    ThemeRole {
2719        name: "accent_soft",
2720        node: "accentSoft",
2721        get: |t| t.accent_soft,
2722        set: |t, c| t.accent_soft = c,
2723        doc: "The accent as a translucent wash rather than a fill: a selected menu row, a chosen tab, a highlighted list item. Keeps `fg` readable over it on both bases, which a fill does not.",
2724    },
2725    ThemeRole {
2726        name: "selection",
2727        node: "selection",
2728        get: |t| t.selection,
2729        set: |t, c| t.selection = c,
2730        doc: "What a text selection is painted under, in an editor and over a `selectable` scope alike.",
2731    },
2732    ThemeRole {
2733        name: "focus_ring",
2734        node: "focusRing",
2735        get: |t| t.focus_ring,
2736        set: |t, c| t.focus_ring = c,
2737        doc: "The default keyboard focus ring (ADR 0002).",
2738    },
2739    ThemeRole {
2740        name: "hover",
2741        node: "hover",
2742        get: |t| t.hover,
2743        set: |t, c| t.hover = c,
2744        doc: "A translucent wash over a hovered neutral control. An overlay, not a fill, so one value works on every surface.",
2745    },
2746    ThemeRole {
2747        name: "pressed",
2748        node: "pressed",
2749        get: |t| t.pressed,
2750        set: |t, c| t.pressed = c,
2751        doc: "The same over a pressed one, and the firmer of the two on both bases.",
2752    },
2753    ThemeRole {
2754        name: "success",
2755        node: "success",
2756        get: |t| t.success,
2757        set: |t, c| t.success = c,
2758        doc: "A good outcome. Readable on `surface` on both bases, which is why it is not one colour for both.",
2759    },
2760    ThemeRole {
2761        name: "warning",
2762        node: "warning",
2763        get: |t| t.warning,
2764        set: |t, c| t.warning = c,
2765        doc: "Something that wants attention.",
2766    },
2767    ThemeRole {
2768        name: "danger",
2769        node: "danger",
2770        get: |t| t.danger,
2771        set: |t, c| t.danger = c,
2772        doc: "A destructive action or a failure. The close button's hover, too.",
2773    },
2774    ThemeRole {
2775        name: "scrollbar",
2776        node: "scrollbar",
2777        get: |t| t.scrollbar,
2778        set: |t, c| t.scrollbar = c,
2779        doc: "The scrollbar thumb at rest.",
2780    },
2781    ThemeRole {
2782        name: "scrollbar_active",
2783        node: "scrollbarActive",
2784        get: |t| t.scrollbar_active,
2785        set: |t, c| t.scrollbar_active = c,
2786        doc: "The thumb while hovered or dragged.",
2787    },
2788];
2789
2790/// One size the stock widgets are built from (`crate::metrics::Metrics`), pinned the way [`ThemeRole`] pins a colour: a binding
2791/// iterates the rows to read or write a set, so a field added to
2792/// `Metrics` is one row here and nothing anywhere else. The test below
2793/// destructures the struct exhaustively.
2794pub struct MetricRole {
2795    /// The Rust field, and the name used everywhere but Node.
2796    pub name: &'static str,
2797    /// What Node calls it (camelCase).
2798    pub node: &'static str,
2799    pub doc: &'static str,
2800    pub get: fn(&crate::metrics::Metrics) -> f32,
2801    pub set: fn(&mut crate::metrics::Metrics, f32),
2802    /// `Some` for a row whose stock value is the platform's own rather
2803    /// than a density's: the value on Windows, then everywhere else.
2804    /// `get` answers for the running platform; a generator prints the
2805    /// pair, so `docs/props.md` reads the same whichever machine wrote it.
2806    /// Stock and compact share it — the test below pins
2807    /// that `compact()` leaves such a row alone.
2808    pub platform: Option<PlatformValue>,
2809}
2810
2811/// A metric's value per platform (see [`MetricRole::platform`]).
2812#[derive(Clone, Copy, Debug, PartialEq)]
2813pub struct PlatformValue {
2814    pub windows: f32,
2815    pub elsewhere: f32,
2816}
2817
2818impl PlatformValue {
2819    /// The member in force on the platform this was compiled for.
2820    pub const fn here(self) -> f32 {
2821        if cfg!(target_os = "windows") {
2822            self.windows
2823        } else {
2824            self.elsewhere
2825        }
2826    }
2827}
2828
2829macro_rules! metric_role {
2830    ($field:ident, $node:literal, $doc:literal) => {
2831        MetricRole {
2832            name: stringify!($field),
2833            node: $node,
2834            get: |m| m.$field,
2835            set: |m, v| m.$field = v,
2836            doc: $doc,
2837            platform: None,
2838        }
2839    };
2840    ($field:ident, $node:literal, $doc:literal, windows $w:expr, elsewhere $e:expr) => {
2841        MetricRole {
2842            name: stringify!($field),
2843            node: $node,
2844            get: |m| m.$field,
2845            set: |m, v| m.$field = v,
2846            doc: $doc,
2847            platform: Some(PlatformValue {
2848                windows: $w,
2849                elsewhere: $e,
2850            }),
2851        }
2852    };
2853}
2854
2855pub const METRIC_ROLES: &[MetricRole] = &[
2856    metric_role!(
2857        control_text,
2858        "controlText",
2859        "A stock control's label: the button's text size."
2860    ),
2861    metric_role!(
2862        chrome_text,
2863        "chromeText",
2864        "The chrome's text: a menu row, a menu-bar title, the titlebar's title."
2865    ),
2866    metric_role!(hint_text, "hintText", "A tooltip's text."),
2867    metric_role!(
2868        radius,
2869        "radius",
2870        "The corner of every stock surface: a button, a field, a menu, a tooltip."
2871    ),
2872    metric_role!(
2873        radius_inner,
2874        "radiusInner",
2875        "The corner of a row inside one: a menu row, a menu-bar title."
2876    ),
2877    metric_role!(
2878        control_pad_x,
2879        "controlPadX",
2880        "A button's horizontal padding."
2881    ),
2882    metric_role!(control_pad_y, "controlPadY", "A button's vertical padding."),
2883    metric_role!(
2884        field_pad_x,
2885        "fieldPadX",
2886        "A text field's horizontal padding."
2887    ),
2888    metric_role!(field_pad_y, "fieldPadY", "A text field's vertical padding."),
2889    metric_role!(hint_pad_x, "hintPadX", "A tooltip's horizontal padding."),
2890    metric_role!(hint_pad_y, "hintPadY", "A tooltip's vertical padding."),
2891    metric_role!(
2892        menu_pad_x,
2893        "menuPadX",
2894        "A menu row's horizontal padding, and a menu-bar title's."
2895    ),
2896    metric_role!(
2897        menu_pad_y,
2898        "menuPadY",
2899        "A menu row's vertical padding; a menu-bar title's is two px less."
2900    ),
2901    metric_role!(menu_width, "menuWidth", "A menu panel's width."),
2902    metric_role!(menu_bar_h, "menuBarH", "The drawn menu bar's height."),
2903    metric_role!(
2904        titlebar_h,
2905        "titlebarH",
2906        "The titlebar's height where the strip is the app's alone: the platform's caption height, 32 on Windows and 34 elsewhere. Under macOS custom chrome the strip is the OS's own titlebar, as tall as `window.native_controls` measures it (32 on macOS 27, 28 before), and this row is not read (`widgets::titlebar_height`).",
2907        windows crate::metrics::TITLEBAR_H_WINDOWS,
2908        elsewhere crate::metrics::TITLEBAR_H_ELSEWHERE
2909    ),
2910];
2911
2912static SNAKE_NAMES: LazyLock<Vec<&'static str>> = LazyLock::new(|| {
2913    PROPS
2914        .iter()
2915        .map(|d| Box::leak(snake_case(d.name).into_boxed_str()) as &'static str)
2916        .collect()
2917});
2918
2919/// `minWidth` → `min_width`, `radiusTL` → `radius_tl` (a run of capitals
2920/// is one word); names without capitals pass through.
2921pub fn snake_case(name: &str) -> String {
2922    let mut out = String::with_capacity(name.len() + 2);
2923    let mut prev_upper = false;
2924    for c in name.chars() {
2925        if c.is_ascii_uppercase() {
2926            if !prev_upper {
2927                out.push('_');
2928            }
2929            out.push(c.to_ascii_lowercase());
2930            prev_upper = true;
2931        } else {
2932            out.push(c);
2933            prev_upper = false;
2934        }
2935    }
2936    out
2937}
2938
2939pub fn by_name(name: &str) -> Option<&'static PropDef> {
2940    PROPS.iter().find(|d| d.name == name)
2941}
2942
2943pub fn by_snake_name(name: &str) -> Option<&'static PropDef> {
2944    SNAKE_NAMES
2945        .iter()
2946        .position(|n| *n == name)
2947        .map(|i| &PROPS[i])
2948}
2949
2950pub fn by_id(id: u32) -> Option<&'static PropDef> {
2951    PROPS.iter().find(|d| d.id == id)
2952}
2953
2954/// The spelling a binding writes prop names in: JSX's camelCase rows, or the
2955/// snake_case ones a Lua table takes. The allow-list below is per spelling,
2956/// so `hover_bg` in JSX and `hoverBg` in Lua are each as unknown as a typo —
2957/// which is what they are: neither binding reads the other's spelling.
2958#[derive(Clone, Copy, Debug, PartialEq, Eq)]
2959pub enum Spelling {
2960    Camel,
2961    Snake,
2962}
2963
2964/// A name one binding takes for a row it cannot spell the usual way, with
2965/// the row's own snake_case name: `repeat` is a Lua keyword, so that row
2966/// also answers to CSS's own name for it. The Lua binding remaps through
2967/// this table, and the check below accepts both sides of it.
2968pub const LUA_ALIASES: &[(&str, &str)] = &[("direction", "repeat")];
2969
2970/// `direction` → `repeat`: the schema name a Lua table key stands for, when
2971/// it is not the name itself.
2972pub fn lua_alias(name: &str) -> Option<&'static str> {
2973    LUA_ALIASES
2974        .iter()
2975        .find(|(alias, _)| *alias == name)
2976        .map(|(_, real)| *real)
2977}
2978
2979/// Every prop name that is not tied to one element, per spelling: the schema
2980/// rows, every spelling of every composite, and the aliases.
2981static SHARED_NAMES: LazyLock<[FxHashSet<&'static str>; 2]> = LazyLock::new(|| {
2982    let mut camel: FxHashSet<&'static str> = PROPS.iter().map(|d| d.name).collect();
2983    let mut snake: FxHashSet<&'static str> = PROPS.iter().map(|d| d.snake_name()).collect();
2984    for c in CUSTOM {
2985        camel.extend(c.jsx_names);
2986        snake.extend(c.lua_names);
2987    }
2988    snake.extend(LUA_ALIASES.iter().map(|(alias, _)| *alias));
2989    [camel, snake]
2990});
2991
2992fn shared_names(spelling: Spelling) -> &'static FxHashSet<&'static str> {
2993    &SHARED_NAMES[(spelling == Spelling::Snake) as usize]
2994}
2995
2996/// The props only this element takes, in `spelling`. An element the table
2997/// does not know has none.
2998pub fn element_own(element: &str, spelling: Spelling) -> &'static [&'static str] {
2999    match ELEMENTS.iter().find(|e| e.name == element) {
3000        Some(e) if spelling == Spelling::Camel => e.jsx_own,
3001        Some(e) => e.lua_own,
3002        None => &[],
3003    }
3004}
3005
3006/// The schema rows `element` reads, in `spelling`, when it does not read
3007/// them all (`ElementDef::jsx_rows`); `None` for an element that takes
3008/// every row, and for one the table does not know.
3009pub fn element_rows(element: &str, spelling: Spelling) -> Option<&'static [&'static str]> {
3010    let e = ELEMENTS.iter().find(|e| e.name == element)?;
3011    if spelling == Spelling::Camel {
3012        e.jsx_rows
3013    } else {
3014        e.lua_rows
3015    }
3016}
3017
3018/// Is `name` a row every element reads — a schema row, a composite, an
3019/// alias — as opposed to a misspelling? What [`known_prop`] answers for an
3020/// element that admits only some rows still depends on this: a row the
3021/// element does not read is dropped like a misspelling, but the warning
3022/// can say so instead of hunting for a nearer spelling.
3023pub fn shared_prop(name: &str, spelling: Spelling) -> bool {
3024    shared_names(spelling).contains(name)
3025}
3026
3027/// Is `name` a prop `element` reads — a schema row, a composite, an alias,
3028/// or one of the element's own? A binding drops everything else on the
3029/// floor, so everything else is a `diag::UNKNOWN_PROP` warning. An element
3030/// that names its rows reads those and its own, and nothing else.
3031pub fn known_prop(element: &str, name: &str, spelling: Spelling) -> bool {
3032    if element_own(element, spelling).contains(&name) {
3033        return true;
3034    }
3035    match element_rows(element, spelling) {
3036        Some(rows) => rows.contains(&name),
3037        None => shared_names(spelling).contains(name),
3038    }
3039}
3040
3041/// The name an unknown one was probably meant to be: the same word in the
3042/// other convention (`hoverBg` for `hover_bg`, `onClick` for `onclick`),
3043/// which is what a wrong spelling almost always is. Nothing fuzzier — a
3044/// confident suggestion or none.
3045pub fn suggest(element: &str, name: &str, spelling: Spelling) -> Option<&'static str> {
3046    let squash = |s: &str| s.replace('_', "").to_ascii_lowercase();
3047    let want = squash(name);
3048    let near = |c: &&&str| squash(c) == want;
3049    let own = element_own(element, spelling).iter();
3050    // An element that names its rows is not sent to a row it would drop.
3051    match element_rows(element, spelling) {
3052        Some(rows) => rows.iter().chain(own).find(near).copied(),
3053        None => shared_names(spelling).iter().chain(own).find(near).copied(),
3054    }
3055}
3056
3057/// A parsed prop value, transport-independent.
3058pub enum Parsed {
3059    F32(f32),
3060    Color(Color),
3061    Flag,
3062    Enum(usize),
3063    Sizing(Sizing),
3064    /// A `Min` or a `Max` row's clamp.
3065    Bound(Bound),
3066    Msg(Value),
3067    Str(String),
3068    Resource(u64),
3069    Keyframes(Vec<Keyframe>),
3070    Enter(Enter),
3071    Gradient(crate::gradient::Gradient),
3072    /// A family, already resolved by the parser (`NameRefs::family`).
3073    Family(FontFamily),
3074}
3075
3076/// Everything a prop list can carry; elements pick the parts they use.
3077#[derive(Clone, Debug, PartialEq)]
3078pub struct PropsOut {
3079    pub spec: NodeSpec,
3080    pub style: TextStyle,
3081    pub key: Option<String>,
3082    /// `index`: the data index this node is opened under, which beats `key`
3083    /// when a binding is handed both.
3084    pub index: Option<u64>,
3085    /// `rowCount`: how many indexed rows the node's virtual list has
3086    /// (`Core::row_count`).
3087    pub row_count: Option<u64>,
3088    pub title: Option<String>,
3089    /// `alwaysOnTop`: the root asked for the window above every other
3090    /// app's this frame (`Core::set_always_on_top`).
3091    pub always_on_top: bool,
3092    /// `secureInput`: the root asked for secure keyboard entry while the
3093    /// window has the keyboard (`Core::set_secure_input`).
3094    pub secure_input: bool,
3095    /// `optionAsAlt`: which Option keys the root asked to act as Alt this
3096    /// frame (`Core::set_option_as_alt`).
3097    pub option_as_alt: crate::OptionAsAlt,
3098    pub key_focus: bool,
3099    /// Hover hint: the element lowering floats `widgets::tooltip` below the
3100    /// node while it is hovered (the parser also marks the spec hoverable).
3101    pub tooltip: Option<String>,
3102    /// The windows the root declared (`Core::declare_window`, in order).
3103    pub windows: Vec<(String, WindowConfig)>,
3104    /// Whether the `wrap` row was declared: the mode is in `style.wrap`,
3105    /// whose default is `Word`, so the style alone cannot say. A
3106    /// single-line editor folds to its width when it was
3107    /// (`EditOptions::wrap`); nothing else reads it.
3108    pub wrap: bool,
3109}
3110
3111/// Which key a prop list opens its node under: the next auto key, the
3112/// `key` label, or — beating the label when a binding is handed both — the
3113/// `index` a virtual list opens its rows by.
3114#[derive(Clone, Copy, Debug, PartialEq)]
3115pub enum Identity<'a> {
3116    Auto,
3117    Label(&'a str),
3118    Index(u64),
3119}
3120
3121impl PropsOut {
3122    /// The identity the list gave the node (see [`Identity`]).
3123    pub fn identity(&self) -> Identity<'_> {
3124        match (self.index, &self.key) {
3125            (Some(i), _) => Identity::Index(i),
3126            (None, Some(label)) => Identity::Label(label),
3127            (None, None) => Identity::Auto,
3128        }
3129    }
3130
3131    pub fn new() -> Self {
3132        PropsOut {
3133            spec: NodeSpec::column(),
3134            style: TextStyle::new(16.0),
3135            key: None,
3136            index: None,
3137            row_count: None,
3138            title: None,
3139            always_on_top: false,
3140            secure_input: false,
3141            option_as_alt: crate::OptionAsAlt::None,
3142            key_focus: false,
3143            tooltip: None,
3144            windows: Vec::new(),
3145            wrap: false,
3146        }
3147    }
3148
3149    /// Applies a builder step to the spec in place.
3150    pub fn with_spec(&mut self, f: impl FnOnce(NodeSpec) -> NodeSpec) {
3151        self.spec = f(std::mem::take(&mut self.spec));
3152    }
3153
3154    /// All three effects of the `tooltip` prop at once: hover tracking and
3155    /// the accessible description (both [`NodeSpec::apply_tooltip`]), plus
3156    /// the hint the element lowering floats. A parser that only extracted
3157    /// the string cannot end up implementing two of the three.
3158    pub fn apply_tooltip(&mut self, hint: impl Into<String>) {
3159        let hint = hint.into();
3160        self.with_spec(|s| s.apply_tooltip(&hint));
3161        self.tooltip = Some(hint);
3162    }
3163
3164    /// Resolves the `pad` shorthand family and applies it — a no-op when the
3165    /// frontend saw none of the seven names, so a spec built from another
3166    /// source keeps its padding.
3167    pub fn apply_pad(&mut self, pad: PadShorthand) {
3168        if pad.declared() {
3169            let edges = pad.resolve();
3170            self.with_spec(|s| s.padding(edges));
3171        }
3172    }
3173}
3174
3175impl Default for PropsOut {
3176    fn default() -> Self {
3177        Self::new()
3178    }
3179}
3180
3181/// Applies one parsed value through its row. Errors on a kind mismatch,
3182/// which can only come from a transport bug (each transport parses by the
3183/// same `Kind`).
3184pub fn apply(def: &PropDef, value: Parsed, out: &mut PropsOut) -> Result<(), String> {
3185    let spec = std::mem::take(&mut out.spec);
3186    let style = out.style;
3187    // Declared at all is a fact of its own for one element (see
3188    // `PropsOut::wrap`); the mode still lands in the style below.
3189    out.wrap |= def.id == P_WRAP;
3190    match (&def.apply, value) {
3191        (Apply::SpecF32(f), Parsed::F32(v)) => out.spec = f(spec, v),
3192        (Apply::SpecColor(f), Parsed::Color(v)) => out.spec = f(spec, v),
3193        (Apply::SpecFlag(f), Parsed::Flag) => out.spec = f(spec),
3194        (Apply::SpecEnum(f), Parsed::Enum(v)) => out.spec = f(spec, v),
3195        (Apply::SpecSizing(f), Parsed::Sizing(v)) => out.spec = f(spec, v),
3196        (Apply::SpecBound(f), Parsed::Bound(v)) => out.spec = f(spec, v),
3197        (Apply::SpecMsg(f), Parsed::Msg(v)) => out.spec = f(spec, v),
3198        (Apply::SpecStr(f), Parsed::Str(v)) => out.spec = f(spec, &v),
3199        (Apply::SpecKeyframes(f), Parsed::Keyframes(v)) => out.spec = f(spec, v),
3200        (Apply::SpecEnter(f), Parsed::Enter(v)) => out.spec = f(spec, v),
3201        (Apply::SpecGradient(f), Parsed::Gradient(v)) => out.spec = f(spec, v),
3202        (Apply::SpecResource(f), Parsed::Resource(v)) => out.spec = f(spec, v),
3203        (Apply::StyleF32(f), Parsed::F32(v)) => {
3204            out.spec = spec;
3205            out.style = f(style, v);
3206        }
3207        (Apply::StyleColor(f), Parsed::Color(v)) => {
3208            out.spec = spec;
3209            out.style = f(style, v);
3210        }
3211        (Apply::StyleEnum(f), Parsed::Enum(v)) => {
3212            out.spec = spec;
3213            out.style = f(style, v);
3214        }
3215        (Apply::StyleFlag(f), Parsed::Flag) => {
3216            out.spec = spec;
3217            out.style = f(style);
3218        }
3219        (Apply::StyleResource(f), Parsed::Resource(v)) => {
3220            out.spec = spec;
3221            out.style = f(style, v);
3222        }
3223        (Apply::StyleStr(f), Parsed::Str(v)) => {
3224            out.spec = spec;
3225            out.style = f(style, &v);
3226        }
3227        (Apply::StyleFamily(f), Parsed::Family(v)) => {
3228            out.spec = spec;
3229            out.style = f(style, v);
3230        }
3231        _ => {
3232            out.spec = spec;
3233            return Err(format!("prop {} value/kind mismatch", def.name));
3234        }
3235    }
3236    Ok(())
3237}
3238
3239/// Looks an enum name up in its row's list.
3240pub fn enum_index(names: &[&str], s: &str) -> Result<usize, String> {
3241    names
3242        .iter()
3243        .position(|n| *n == s)
3244        .ok_or_else(|| format!("bad value {s:?} (one of {names:?})"))
3245}
3246
3247// ---------------------------------------------------------------------------
3248// Value parsing shared by transports
3249
3250/// 0 = transparent, anything else 0xRRGGBBAA.
3251pub fn color_num(hex: u32) -> Color {
3252    if hex == 0 {
3253        Color::TRANSPARENT
3254    } else {
3255        Color::hex(hex)
3256    }
3257}
3258
3259/// `#rgb` / `#rrggbb` / `#rrggbbaa`.
3260pub fn color_hex_str(s: &str) -> Result<Color, String> {
3261    let bad = || format!("bad color {s:?}");
3262    let hex = s.strip_prefix('#').ok_or_else(bad)?;
3263    let expanded = match hex.len() {
3264        3 => hex
3265            .chars()
3266            .flat_map(|c| [c, c])
3267            .chain("ff".chars())
3268            .collect::<String>(),
3269        6 => format!("{hex}ff"),
3270        8 => hex.to_string(),
3271        _ => return Err(bad()),
3272    };
3273    let n = u32::from_str_radix(&expanded, 16).map_err(|_| bad())?;
3274    Ok(Color::hex(n))
3275}
3276
3277/// The mode a sizing's, a min's or a max's first binary slot holds for a
3278/// size expression, whose spelling follows as a strref (v19).
3279pub const SIZE_MODE_CALC: u32 = 4;
3280
3281/// The mode for a size expression as data: a count of slots follows,
3282/// then the expression in prefix code ([`crate::calc::from_code`]) —
3283/// what the Node encoder sends for `{ clamp: [...] }`, so the addon
3284/// reads numbers and parses no text (v19).
3285pub const SIZE_MODE_TREE: u32 = 5;
3286
3287/// The string forms of a min: `"fit"`, or a size expression
3288/// ([`crate::calc`]). A number arrives as a number.
3289pub fn min_str(s: &str) -> Result<Bound, String> {
3290    match s {
3291        "fit" => Ok(Bound::Fit),
3292        _ => crate::calc::bound(s)
3293            .map_err(|e| format!("bad min {s:?} (number | \"fit\" | a size expression): {e}")),
3294    }
3295}
3296
3297/// The string forms of a max: a size expression.
3298pub fn max_str(s: &str) -> Result<Bound, String> {
3299    crate::calc::bound(s).map_err(|e| format!("bad max {s:?} (number | a size expression): {e}"))
3300}
3301
3302/// The string forms of a sizing: "fit" | "grow" | "N%" | a size
3303/// expression ([`crate::calc`]).
3304pub fn sizing_str(s: &str) -> Result<Sizing, String> {
3305    match s {
3306        "fit" => Ok(Sizing::Fit),
3307        "grow" => Ok(Sizing::Grow(1.0)),
3308        _ => crate::calc::sizing(s).map_err(|e| {
3309            format!("bad sizing {s:?} (fit | grow | number | \"N%\" | a size expression): {e}")
3310        }),
3311    }
3312}
3313
3314#[cfg(test)]
3315mod tests {
3316    use super::*;
3317
3318    /// An enum row's name list is the wire order — a binding sends the
3319    /// index — so each list is its enum's `ALL` by `name`, and the index
3320    /// map is a lookup in `ALL` and not a second table (`Easing`, `Repeat`, `Live` and `FontFamily` were hand maps that a
3321    /// variant appended or a list reordered put one off, with nothing to
3322    /// say so). `CURSORS` has the same pin in `cursor.rs`, `ROLES` its
3323    /// own below.
3324    #[test]
3325    fn every_enum_list_is_its_enum_s_all_by_name() {
3326        fn names(it: &[&'static str]) -> Vec<&'static str> {
3327            it.to_vec()
3328        }
3329        assert_eq!(
3330            Easing::ALL.iter().map(|e| e.name()).collect::<Vec<_>>(),
3331            names(EASINGS)
3332        );
3333        assert_eq!(
3334            Repeat::ALL.iter().map(|r| r.name()).collect::<Vec<_>>(),
3335            names(REPEATS)
3336        );
3337        assert_eq!(
3338            crate::access::Live::ALL
3339                .iter()
3340                .map(|l| l.name())
3341                .collect::<Vec<_>>(),
3342            names(LIVE)
3343        );
3344        assert_eq!(
3345            FontFamily::ALL
3346                .iter()
3347                .map(|f| f.name().expect("a stock family has a name"))
3348                .collect::<Vec<_>>(),
3349            names(FAMILIES)
3350        );
3351        // And the index map round-trips through the list, every index.
3352        for (i, e) in Easing::ALL.iter().enumerate() {
3353            assert_eq!(easing_idx(i), *e);
3354        }
3355        for (i, r) in Repeat::ALL.iter().enumerate() {
3356            assert_eq!(repeat_idx(i), *r);
3357        }
3358        for (i, l) in crate::access::Live::ALL.iter().enumerate() {
3359            assert_eq!(crate::access::Live::from_index(i), *l);
3360        }
3361        for (i, f) in FontFamily::ALL.iter().enumerate() {
3362            assert_eq!(FontFamily::from_index(i), *f);
3363        }
3364        // An index this build lacks is the default, not a panic.
3365        assert_eq!(easing_idx(99), Easing::default());
3366        assert_eq!(repeat_idx(99), Repeat::default());
3367        assert_eq!(FontFamily::from_index(99), FontFamily::Sans);
3368    }
3369
3370    #[test]
3371    fn ids_and_names_are_unique() {
3372        let all: Vec<(&str, u32)> = PROPS
3373            .iter()
3374            .map(|d| (d.name, d.id))
3375            .chain(CUSTOM.iter().map(|c| (c.name, c.id)))
3376            .collect();
3377        for (i, (name, id)) in all.iter().enumerate() {
3378            for (other_name, other_id) in &all[i + 1..] {
3379                assert_ne!(name, other_name, "duplicate prop name");
3380                assert_ne!(id, other_id, "duplicate wire id for {name} / {other_name}");
3381            }
3382        }
3383    }
3384
3385    /// `menu_bar_h` → `menuBarH`: what a role's Node spelling is.
3386    fn snake_to_camel(name: &str) -> String {
3387        let mut out = String::new();
3388        let mut up = false;
3389        for ch in name.chars() {
3390            if ch == '_' {
3391                up = true;
3392            } else if up {
3393                out.extend(ch.to_uppercase());
3394                up = false;
3395            } else {
3396                out.push(ch);
3397            }
3398        }
3399        out
3400    }
3401
3402    /// `METRIC_ROLES` restates `Metrics` the way `THEME_ROLES` restates
3403    /// `Theme`, and this is the same pin: an exhaustive pattern on the
3404    /// struct, then the names both ways.
3405    #[test]
3406    fn metric_roles_restate_the_metrics_exactly() {
3407        use crate::metrics::Metrics;
3408        let m = Metrics::compact();
3409        let Metrics {
3410            control_text,
3411            chrome_text,
3412            hint_text,
3413            radius,
3414            radius_inner,
3415            control_pad_x,
3416            control_pad_y,
3417            field_pad_x,
3418            field_pad_y,
3419            hint_pad_x,
3420            hint_pad_y,
3421            menu_pad_x,
3422            menu_pad_y,
3423            menu_width,
3424            menu_bar_h,
3425            titlebar_h,
3426        } = m;
3427        let fields: &[(&str, f32)] = &[
3428            ("control_text", control_text),
3429            ("chrome_text", chrome_text),
3430            ("hint_text", hint_text),
3431            ("radius", radius),
3432            ("radius_inner", radius_inner),
3433            ("control_pad_x", control_pad_x),
3434            ("control_pad_y", control_pad_y),
3435            ("field_pad_x", field_pad_x),
3436            ("field_pad_y", field_pad_y),
3437            ("hint_pad_x", hint_pad_x),
3438            ("hint_pad_y", hint_pad_y),
3439            ("menu_pad_x", menu_pad_x),
3440            ("menu_pad_y", menu_pad_y),
3441            ("menu_width", menu_width),
3442            ("menu_bar_h", menu_bar_h),
3443            ("titlebar_h", titlebar_h),
3444        ];
3445        assert_eq!(METRIC_ROLES.len(), fields.len(), "a metric has no row");
3446        for (name, value) in fields {
3447            let row = METRIC_ROLES
3448                .iter()
3449                .find(|r| r.name == *name)
3450                .unwrap_or_else(|| panic!("no METRIC_ROLES row for {name}"));
3451            assert_eq!((row.get)(&m), *value, "{name}'s row reads another field");
3452            let mut w = m;
3453            (row.set)(&mut w, 1.0);
3454            assert_eq!((row.get)(&w), 1.0, "{name}'s row writes another field");
3455        }
3456        for row in METRIC_ROLES {
3457            assert!(
3458                fields.iter().any(|(n, _)| *n == row.name),
3459                "METRIC_ROLES names a field Metrics does not have: {}",
3460                row.name
3461            );
3462            let camel = snake_to_camel(row.name);
3463            assert_eq!(row.node, camel, "{}'s Node spelling", row.name);
3464            // A platform row's pair is what the struct reads on this
3465            // platform, in both sets: the generator prints the pair for
3466            // both columns on the strength of this.
3467            if let Some(p) = row.platform {
3468                assert_eq!(
3469                    (row.get)(&Metrics::default()),
3470                    p.here(),
3471                    "{}'s stock value",
3472                    row.name
3473                );
3474                assert_eq!(
3475                    (row.get)(&m),
3476                    p.here(),
3477                    "{}: compact leaves a platform row alone",
3478                    row.name
3479                );
3480            }
3481        }
3482        assert!(
3483            METRIC_ROLES.iter().any(|r| r.platform.is_some()),
3484            "titlebar_h is the platform's; its row says so"
3485        );
3486    }
3487
3488    /// `THEME_ROLES` restates `Theme`; this pins the two together the way
3489    /// `ENV_FIELDS` pins `Env`. The exhaustive pattern is the pin on the
3490    /// struct — a role added to `Theme` stops this compiling until it has
3491    /// a row — and the names are then checked in both directions, so a
3492    /// row cannot be forgotten and a row cannot name a field that is not
3493    /// there. `appearance` and `disabled_opacity` are not colours and are
3494    /// carried beside the roles rather than among them.
3495    #[test]
3496    fn theme_roles_restate_the_theme_exactly() {
3497        use crate::theme::Theme;
3498        let t = Theme::dark();
3499        let Theme {
3500            appearance: _,
3501            disabled_opacity: _,
3502            bg,
3503            surface,
3504            raised,
3505            sunken,
3506            border,
3507            border_strong,
3508            fg,
3509            muted,
3510            faint,
3511            accent,
3512            accent_hover,
3513            accent_pressed,
3514            on_accent,
3515            accent_soft,
3516            selection,
3517            focus_ring,
3518            hover,
3519            pressed,
3520            success,
3521            warning,
3522            danger,
3523            scrollbar,
3524            scrollbar_active,
3525        } = t;
3526        let fields: &[(&str, crate::color::Color)] = &[
3527            ("bg", bg),
3528            ("surface", surface),
3529            ("raised", raised),
3530            ("sunken", sunken),
3531            ("border", border),
3532            ("border_strong", border_strong),
3533            ("fg", fg),
3534            ("muted", muted),
3535            ("faint", faint),
3536            ("accent", accent),
3537            ("accent_hover", accent_hover),
3538            ("accent_pressed", accent_pressed),
3539            ("on_accent", on_accent),
3540            ("accent_soft", accent_soft),
3541            ("selection", selection),
3542            ("focus_ring", focus_ring),
3543            ("hover", hover),
3544            ("pressed", pressed),
3545            ("success", success),
3546            ("warning", warning),
3547            ("danger", danger),
3548            ("scrollbar", scrollbar),
3549            ("scrollbar_active", scrollbar_active),
3550        ];
3551        assert_eq!(THEME_ROLES.len(), fields.len(), "a role has no row");
3552        for (name, value) in fields {
3553            let row = THEME_ROLES
3554                .iter()
3555                .find(|r| r.name == *name)
3556                .unwrap_or_else(|| panic!("no THEME_ROLES row for {name}"));
3557            assert_eq!((row.get)(&t), *value, "{name}'s row reads another field");
3558        }
3559        for row in THEME_ROLES {
3560            assert!(
3561                fields.iter().any(|(n, _)| *n == row.name),
3562                "{} names no field",
3563                row.name
3564            );
3565            // Node's spelling is this one in camelCase, always.
3566            let camel = {
3567                let mut out = String::new();
3568                let mut up = false;
3569                for ch in row.name.chars() {
3570                    if ch == '_' {
3571                        up = true;
3572                    } else if up {
3573                        out.extend(ch.to_uppercase());
3574                        up = false;
3575                    } else {
3576                        out.push(ch);
3577                    }
3578                }
3579                out
3580            };
3581            assert_eq!(row.node, camel, "{}'s Node spelling", row.name);
3582        }
3583    }
3584
3585    /// `ENV_FIELDS` restates `Env` and `WindowEnv`; this pins the three
3586    /// together. The exhaustive patterns are the pin on the structs — a
3587    /// field added to either stops this compiling until it is named here
3588    /// — and the list beside them is then checked against the table in
3589    /// both directions, so a row cannot be forgotten and a row cannot
3590    /// claim a field that does not exist.
3591    #[test]
3592    fn env_fields_restate_env_and_window_env_exactly() {
3593        use crate::env::{AudioEnv, Env, SystemEnv};
3594        use crate::window::WindowEnv;
3595        let Env {
3596            refresh_hz: _,
3597            focused: _,
3598            system,
3599            window,
3600            audio,
3601        } = Env::default();
3602        let AudioEnv { device: _, live: _ } = audio;
3603        let SystemEnv {
3604            appearance: _,
3605            accent: _,
3606            motion: _,
3607            locale: _,
3608            assistive: _,
3609        } = system;
3610        let WindowEnv {
3611            id: _,
3612            custom_chrome: _,
3613            maximized: _,
3614            fullscreen: _,
3615            always_on_top: _,
3616            native_controls: _,
3617        } = window;
3618        let stored = [
3619            "refresh_hz",
3620            "focused",
3621            "system.appearance",
3622            "system.accent",
3623            "system.motion",
3624            "system.locale",
3625            "system.assistive",
3626            "window.id",
3627            "window.custom_chrome",
3628            "window.maximized",
3629            "window.fullscreen",
3630            "window.always_on_top",
3631            "window.native_controls",
3632            "audio.device",
3633            "audio.live",
3634        ];
3635        // A stored fact's `from` is the struct and the field, spelled the
3636        // one way; everything else in the column is a call.
3637        let from_structs: Vec<&str> = ENV_FIELDS
3638            .iter()
3639            .filter(|f| !f.from.contains('('))
3640            .map(|f| {
3641                let (strukt, field) = match f.name.split_once('.') {
3642                    Some(("window", field)) => ("WindowEnv", field),
3643                    Some(("system", field)) => ("SystemEnv", field),
3644                    Some(("audio", field)) => ("AudioEnv", field),
3645                    Some((group, _)) => panic!("{}: no struct holds a {group} fact", f.name),
3646                    None => ("Env", f.name),
3647                };
3648                assert_eq!(f.from, format!("`{strukt}::{field}`"), "{}", f.name);
3649                f.name
3650            })
3651            .collect();
3652        assert_eq!(from_structs, stored);
3653        for f in ENV_FIELDS.iter().filter(|f| f.from.contains('(')) {
3654            assert!(
3655                f.from.contains("derived") || f.from.contains("the frame's"),
3656                "{}: a call in `from` is derived or the frame's, and says which",
3657                f.name
3658            );
3659        }
3660    }
3661
3662    /// Every spelling in `ENV_FIELDS` is unique per binding — two rows
3663    /// cannot land on one key — and every row says something in every
3664    /// column, so the generated table has no blank cells to wonder about.
3665    #[test]
3666    fn env_field_spellings_are_unique_and_complete() {
3667        let mut names: Vec<&str> = ENV_FIELDS.iter().map(|f| f.name).collect();
3668        let mut node: Vec<&str> = ENV_FIELDS
3669            .iter()
3670            .flat_map(|f| f.node.iter().copied())
3671            .collect();
3672        let mut lua: Vec<&str> = ENV_FIELDS
3673            .iter()
3674            .flat_map(|f| f.lua.iter().copied())
3675            .collect();
3676        for list in [&mut names, &mut node, &mut lua] {
3677            let before = list.len();
3678            list.sort_unstable();
3679            list.dedup();
3680            assert_eq!(list.len(), before, "a spelling is used twice");
3681        }
3682        for f in ENV_FIELDS {
3683            assert!(!f.c.is_empty() && !f.doc.is_empty(), "{}", f.name);
3684            // A binding that has no key for a fact says where it went
3685            // instead, so the empty cell is explained by the row itself.
3686            if f.node.is_empty() {
3687                assert!(
3688                    f.doc.contains("Node"),
3689                    "{}: where does Node carry it?",
3690                    f.name
3691                );
3692            }
3693            if f.lua.is_empty() {
3694                assert!(
3695                    f.doc.contains("Lua"),
3696                    "{}: where does Lua carry it?",
3697                    f.name
3698                );
3699            }
3700        }
3701    }
3702
3703    /// An element's admitted rows are real rows in each spelling and the
3704    /// same rows in both, so the JSX check and the Lua check admit the
3705    /// same button.
3706    #[test]
3707    fn admitted_rows_are_shared_rows_in_both_spellings() {
3708        for e in ELEMENTS {
3709            let (Some(jsx), Some(lua)) = (e.jsx_rows, e.lua_rows) else {
3710                assert!(
3711                    e.jsx_rows.is_none() && e.lua_rows.is_none(),
3712                    "{}: one spelling only",
3713                    e.name
3714                );
3715                continue;
3716            };
3717            assert_eq!(
3718                jsx.len(),
3719                lua.len(),
3720                "{}: the lists differ in length",
3721                e.name
3722            );
3723            for (j, l) in jsx.iter().zip(lua) {
3724                assert!(
3725                    shared_prop(j, Spelling::Camel),
3726                    "{}: `{j}` is not a row",
3727                    e.name
3728                );
3729                assert!(
3730                    shared_prop(l, Spelling::Snake),
3731                    "{}: `{l}` is not a row",
3732                    e.name
3733                );
3734                assert_eq!(
3735                    snake_case(j),
3736                    *l,
3737                    "{}: `{j}` and `{l}` are not one row",
3738                    e.name
3739                );
3740            }
3741            // The row a reader hears first: a stock button without a name
3742            // is the warning `control-without-name`, so `label` is never
3743            // the row a closed *control* leaves out. A text is its own
3744            // name.
3745            if jsx.contains(&"onClick") {
3746                assert!(jsx.contains(&"label"), "{}: `label` missing", e.name);
3747            }
3748        }
3749        assert!(known_prop("button", "description", Spelling::Camel));
3750        assert!(known_prop("button", "on_click", Spelling::Snake));
3751        assert!(known_prop("button", "text", Spelling::Snake));
3752        assert!(!known_prop("button", "radius", Spelling::Camel));
3753        assert!(!known_prop("button", "text", Spelling::Camel));
3754        assert!(known_prop("box", "radius", Spelling::Camel));
3755        // The other spelling is looked for among the rows it reads: a row
3756        // it would drop is not offered as the fix.
3757        assert_eq!(
3758            suggest("button", "on_click", Spelling::Camel),
3759            Some("onClick")
3760        );
3761        assert_eq!(suggest("button", "hover_bg", Spelling::Camel), None);
3762        assert_eq!(suggest("box", "hover_bg", Spelling::Camel), Some("hoverBg"));
3763    }
3764
3765    /// AR13: a text is content plus a style, so the rows it admits are
3766    /// exactly the rows that land on a `TextStyle`, plus `size`, the
3767    /// composite the style is built from. Every other row — a container's,
3768    /// an access row, `key` — is the `unknown-prop` warning in every
3769    /// binding rather than a silent drop.
3770    #[test]
3771    fn text_admits_exactly_the_style_rows() {
3772        let style: Vec<&str> = PROPS
3773            .iter()
3774            .filter(|d| d.target() == Target::Style)
3775            .map(|d| d.name)
3776            .collect();
3777        let mut expect = vec!["size"];
3778        expect.extend(style);
3779        let mut got = TEXT_ROWS_JSX.to_vec();
3780        expect.sort_unstable();
3781        got.sort_unstable();
3782        assert_eq!(got, expect, "TEXT_ROWS_JSX is not the style rows");
3783        for name in ["lineHeight", "color", "wrap", "size"] {
3784            assert!(known_prop("text", name, Spelling::Camel), "{name}");
3785        }
3786        for name in ["live", "role", "label", "onClick", "key", "pad", "bg"] {
3787            assert_eq!(
3788                known_prop("text", name, Spelling::Camel),
3789                name == "bg",
3790                "{name}: `bg` is the element's own (a span's), the rest are not rows it reads"
3791            );
3792        }
3793        assert!(known_prop("text", "line_height", Spelling::Snake));
3794        assert!(known_prop("text", "value", Spelling::Snake));
3795        assert!(!known_prop("text", "live", Spelling::Snake));
3796        assert!(!known_prop("text", "on_click", Spelling::Snake));
3797        // A misspelling is still steered to a row it reads, and to nothing
3798        // it would drop.
3799        assert_eq!(
3800            suggest("text", "max_lines", Spelling::Camel),
3801            Some("maxLines")
3802        );
3803        assert_eq!(suggest("text", "hover_bg", Spelling::Camel), None);
3804    }
3805
3806    #[test]
3807    fn snake_names_round_trip() {
3808        assert_eq!(by_snake_name("min_width").unwrap().name, "minWidth");
3809        assert_eq!(by_snake_name("on_click").unwrap().name, "onClick");
3810        assert_eq!(by_snake_name("bg").unwrap().name, "bg");
3811        assert!(by_snake_name("minWidth").is_none());
3812        assert_eq!(by_name("lineHeight").unwrap().snake_name(), "line_height");
3813        assert_eq!(by_name("radiusTL").unwrap().snake_name(), "radius_tl");
3814        assert_eq!(by_snake_name("radius_bl").unwrap().name, "radiusBL");
3815    }
3816
3817    /// The allow-list is per spelling, so each binding's own names pass and
3818    /// the other's do not — which is the point: neither binding reads the
3819    /// other's, so `hover_bg` in JSX is as dropped as `hoverBgg` would be.
3820    #[test]
3821    fn the_allow_list_is_per_spelling() {
3822        use Spelling::{Camel, Snake};
3823        assert!(known_prop("box", "hoverBg", Camel));
3824        assert!(known_prop("box", "hover_bg", Snake));
3825        assert!(!known_prop("box", "hover_bg", Camel));
3826        assert!(!known_prop("box", "hoverBg", Snake));
3827        // Composites, each in the spelling its binding takes.
3828        assert!(known_prop("box", "padX", Camel) && !known_prop("box", "padX", Snake));
3829        assert!(known_prop("box", "scroll", Snake) && !known_prop("box", "scroll", Camel));
3830        // `repeat` is a Lua keyword; the alias stands in for the row.
3831        assert!(known_prop("box", "direction", Snake));
3832        assert_eq!(lua_alias("direction"), Some("repeat"));
3833        // An element's own props are its own: `initial` is an editor's.
3834        assert!(known_prop("edit", "initial", Camel));
3835        assert!(!known_prop("box", "initial", Camel));
3836        // A shared text row on an editor is the editor's too: `wrap` is
3837        // what folds a single-line one, and it must not warn.
3838        assert!(known_prop("edit", "wrap", Camel) && known_prop("edit", "wrap", Snake));
3839        assert!(known_prop("image", "src", Camel) && known_prop("image", "id", Snake));
3840        // And nothing claims a typo.
3841        assert!(!known_prop("box", "colour", Camel));
3842    }
3843
3844    #[test]
3845    fn a_suggestion_is_the_same_word_in_the_right_convention() {
3846        use Spelling::{Camel, Snake};
3847        assert_eq!(suggest("box", "hoverBg", Snake), Some("hover_bg"));
3848        assert_eq!(suggest("box", "onclick", Camel), Some("onClick"));
3849        assert_eq!(suggest("box", "SCROLL_X", Camel), Some("scrollX"));
3850        assert_eq!(suggest("edit", "Initial", Camel), Some("initial"));
3851        // Nothing fuzzy: a guess or nothing.
3852        assert_eq!(suggest("box", "colour", Camel), None);
3853    }
3854
3855    /// Every name a binding hand-lowers has to be in one of the tables, or
3856    /// the binding warns about a prop it reads perfectly well.
3857    #[test]
3858    fn every_composite_and_element_prop_is_in_the_allow_list() {
3859        for c in CUSTOM {
3860            for n in c.jsx_names {
3861                assert!(known_prop("box", n, Spelling::Camel), "jsx `{n}`");
3862            }
3863            for n in c.lua_names {
3864                assert!(known_prop("box", n, Spelling::Snake), "lua `{n}`");
3865            }
3866        }
3867        for e in ELEMENTS {
3868            for n in e.jsx_own {
3869                assert!(known_prop(e.name, n, Spelling::Camel), "{}.{n}", e.name);
3870            }
3871            for n in e.lua_own {
3872                assert!(known_prop(e.name, n, Spelling::Snake), "{}.{n}", e.name);
3873            }
3874        }
3875    }
3876
3877    #[test]
3878    fn every_row_applies_a_sample_of_its_kind() {
3879        for def in PROPS {
3880            // `opacity` is a 0..=1 slot whose default is the top of the
3881            // range, so the shared sample would clamp back to it.
3882            let f = if def.name == "opacity" { 0.5 } else { 7.0 };
3883            let sample = match def.kind {
3884                Kind::F32 => Parsed::F32(f),
3885                Kind::Color => Parsed::Color(Color::hex(0x11223344)),
3886                Kind::Flag => Parsed::Flag,
3887                Kind::Enum(_) => Parsed::Enum(1),
3888                Kind::Sizing => Parsed::Sizing(Sizing::Percent(0.5)),
3889                Kind::Min => Parsed::Bound(Bound::Fit),
3890                Kind::Max => Parsed::Bound(Bound::Px(10.0)),
3891                Kind::Msg | Kind::Tag => Parsed::Msg(Value::Int(1)),
3892                // A list of four names, and a string of none of them is
3893                // the default: none.
3894                Kind::Str if def.name == "scrollMods" => Parsed::Str("ctrl".into()),
3895                Kind::Str => Parsed::Str("name".into()),
3896                Kind::Family => Parsed::Family(FontFamily::Mono),
3897                Kind::Resource => Parsed::Resource(7),
3898                Kind::Keyframes => Parsed::Keyframes(vec![Keyframe::default().radius(7.0)]),
3899                Kind::Enter => Parsed::Enter(Enter::from(-7.0, 0.0)),
3900                Kind::Gradient => Parsed::Gradient(crate::gradient::Gradient::to(
3901                    crate::gradient::Side::Right,
3902                    [Color::hex(0x11223344), Color::WHITE],
3903                )),
3904            };
3905            let mut out = PropsOut::new();
3906            apply(def, sample, &mut out).unwrap();
3907            let changed = match def.target() {
3908                Target::Spec => out.spec != NodeSpec::column(),
3909                Target::Style => out.style != TextStyle::new(16.0),
3910            };
3911            assert!(changed, "{} applied a sample but nothing changed", def.name);
3912        }
3913    }
3914
3915    /// A null tag keeps the behaviour and drops the `tag` field; the
3916    /// contract every transport relies on to accept `null` for `Tag` rows.
3917    #[test]
3918    fn a_null_tag_still_declares_the_behaviour() {
3919        let mut out = PropsOut::new();
3920        apply(
3921            by_name("onKey").unwrap(),
3922            Parsed::Msg(Value::Null),
3923            &mut out,
3924        )
3925        .unwrap();
3926        assert_eq!(out.spec.events().on_key, Some(Value::Null));
3927        assert!(out.spec.hover_tracked());
3928        let mut out = PropsOut::new();
3929        apply(
3930            by_name("onLayout").unwrap(),
3931            Parsed::Msg(Value::Null),
3932            &mut out,
3933        )
3934        .unwrap();
3935        assert_eq!(out.spec.events().on_layout, Some(Value::Null));
3936    }
3937
3938    /// `ROLES` is the wire order for the `role` enum — a binding sends the
3939    /// index — so a typo, or a spelling that drifted from `access.rs`, does
3940    /// not fail anywhere: the name simply stops parsing, and every view
3941    /// declaring that role silently gets [`role_idx`]'s fallback instead.
3942    /// Until this test that fallback was `Role::None`, which takes the node
3943    /// *and its whole subtree* out of the access tree — a drifted spelling
3944    /// would have removed part of the app from every screen reader, with
3945    /// nothing failing and nothing warning. Both halves are pinned here:
3946    /// each name is a real role, and index `i` still means `ROLES[i]`.
3947    #[test]
3948    fn every_declarable_role_name_is_a_real_role() {
3949        for (i, name) in ROLES.iter().enumerate() {
3950            let role = Role::parse(name)
3951                .unwrap_or_else(|| panic!("ROLES[{i}] = {name:?} is not a Role::ALL name"));
3952            assert_eq!(role_idx(i), role, "role index {i} lowers to the wrong role");
3953            assert_eq!(role_idx(i).name(), *name);
3954        }
3955    }
3956
3957    /// The C header pins its role enum to `Role::ALL` by construction
3958    /// (`kui-ffi`'s `abi_enum!`), so a new role fails the C build until the
3959    /// header names it. Lua, Node and JSX have no such pin — they read
3960    /// `ROLES` — and a role added to `Role::ALL` and forgotten there is
3961    /// simply undeclarable from all three, silently. This is that pin: a
3962    /// role is declarable or derived, never neither and never both, and an
3963    /// exemption has to be one a frame really does derive, so `DERIVED_ONLY`
3964    /// cannot become somewhere to put a forgotten row.
3965    #[test]
3966    fn every_role_is_declarable_or_derived() {
3967        for role in Role::ALL {
3968            let declarable = ROLES.contains(&role.name());
3969            let derived = DERIVED_ONLY.iter().any(|(n, _)| *n == role.name());
3970            assert!(
3971                declarable || derived,
3972                "Role::{role:?} is in Role::ALL but no view can declare it and \
3973                 DERIVED_ONLY does not say the core derives it — add {:?} to \
3974                 ROLES, or to DERIVED_ONLY with the reason",
3975                role.name()
3976            );
3977            assert!(
3978                !(declarable && derived),
3979                "Role::{role:?} is in ROLES, so it is declarable — drop it from \
3980                 DERIVED_ONLY"
3981            );
3982        }
3983        for (name, why) in DERIVED_ONLY {
3984            assert!(!why.is_empty(), "{name:?} is exempted without a reason");
3985            assert!(
3986                Role::parse(name).is_some(),
3987                "DERIVED_ONLY names {name:?}, which is not a Role::ALL name"
3988            );
3989        }
3990        let derived = roles_one_frame_derives();
3991        for (name, _) in DERIVED_ONLY {
3992            assert!(
3993                derived.contains(&Role::parse(name).unwrap()),
3994                "DERIVED_ONLY keeps {name:?} out of ROLES because the core \
3995                 derives it, but no frame does any more — either it belongs in \
3996                 ROLES now, or the exemption is stale"
3997            );
3998        }
3999    }
4000
4001    /// One frame that derives each of `DERIVED_ONLY`'s roles: the root is
4002    /// the window, a `window_drag` row the title bar, a scrolling box the
4003    /// scroll view, and the text inside it static text.
4004    fn roles_one_frame_derives() -> Vec<Role> {
4005        let mut core = crate::Core::new();
4006        let mut ui = core.frame(crate::Size::new(200.0, 200.0), 1.0);
4007        ui.window_title("Demo");
4008        ui.configure_root(NodeSpec::column().fill());
4009        ui.leaf_keyed("titlebar", NodeSpec::row().window_drag());
4010        ui.text_in_keyed(
4011            "scroll",
4012            NodeSpec::column().height(40.0).scroll_y(),
4013            "hello",
4014            TextStyle::new(12.0),
4015        );
4016        ui.finish();
4017        core.access_tree().nodes.iter().map(|n| n.role).collect()
4018    }
4019
4020    #[test]
4021    fn colors_and_sizings_parse() {
4022        assert_eq!(color_hex_str("#fff").unwrap(), Color::hex(0xffffffff));
4023        assert_eq!(color_hex_str("#11223344").unwrap(), Color::hex(0x11223344));
4024        assert!(color_hex_str("fff").is_err());
4025        assert_eq!(sizing_str("50%").unwrap(), Sizing::Percent(0.5));
4026        assert_eq!(sizing_str("grow").unwrap(), Sizing::Grow(1.0));
4027        assert!(sizing_str("wide").is_err());
4028    }
4029}