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;
176pub const P_IME_OFF: u32 = 125;
177pub const P_BACKDROP_BLUR: u32 = 126;
178
179/// The `mainAlign` / `crossAlign` rows and a float's attach points, in
180/// `Align`'s order. Append-only: the Lua and Node wires carry the index,
181/// and C's `KUI_ALIGN_*` is it. The spreads mean something on `mainAlign`
182/// and `baseline` on a row's `crossAlign` only.
183pub const ALIGNS: &[&str] = &[
184    "start",
185    "center",
186    "end",
187    "spaceBetween",
188    "spaceAround",
189    "spaceEvenly",
190    "baseline",
191];
192pub const WINDOW_ROLES: &[&str] = &["drag", "close", "minimize", "maximize"];
193/// The `scrollbar` row, in `ScrollbarMode::ALL`'s order: the stock
194/// overlay bar, none, or one that fades out when the scroll state has not
195/// changed. C spells it as the index plus one (`KUI_SCROLLBAR_*`), so a
196/// zeroed field is "unset".
197pub const SCROLLBARS: &[&str] = &["visible", "hidden", "auto"];
198/// The `overscroll` row, in `Overscroll::ALL`'s order: a
199/// scroll gesture starting over a scroller at its limit goes on to the one
200/// around it, or stays. C spells it as the index plus one
201/// (`KUI_OVERSCROLL_*`), a zeroed field being `auto`.
202pub const OVERSCROLLS: &[&str] = &["auto", "contain"];
203/// The `scrollAxes` row, in `ScrollAxes::ALL`'s order: the
204/// axes an `onScroll` node takes. C spells it as the index plus one
205/// (`KUI_SCROLL_AXES_*`), a zeroed field being `both`.
206pub const SCROLL_AXES: &[&str] = &["both", "x", "y"];
207/// The stock families (`FontFamily::name` spellings, in `FontFamily::ALL`
208/// order); a registered font travels as the `font` row's handle instead.
209pub const FAMILIES: &[&str] = &["sans", "serif", "mono"];
210/// The pointer shapes a view can declare (`CursorShape::name` spellings, in
211/// `CursorShape::ALL` order — a `cursor.rs` test pins the two together).
212pub const CURSORS: &[&str] = &[
213    "default",
214    "text",
215    "pointer",
216    "grab",
217    "grabbing",
218    "notAllowed",
219    "ewResize",
220    "nsResize",
221    "nwseResize",
222    "neswResize",
223];
224
225pub fn cursor_idx(i: usize) -> CursorShape {
226    CURSORS
227        .get(i)
228        .and_then(|n| CursorShape::parse(n))
229        .unwrap_or(CursorShape::Default)
230}
231pub const WRAPS: &[&str] = &["word", "glyph", "none", "break-spaces"];
232/// `underlineStyle` / `underline_style`; `UnderlineStyle::NAMES`.
233pub const UNDERLINE_STYLES: &[&str] = UnderlineStyle::NAMES;
234/// `expanded` names its state rather than being a flag: a disclosure that
235/// is shut has to say "collapsed", and an absent flag cannot — absent has
236/// to keep meaning "this node does not expand" (AccessKit's `expanded`,
237/// ARIA's `aria-expanded`, are three-state for the same reason).
238pub const EXPANDED: &[&str] = &["collapsed", "expanded"];
239/// How urgently a reader should read a change it was not asked to read
240/// (`crate::access::Live::name` spellings, in wire order — a binding
241/// sends the index). `off` is the default and means "not a live region".
242pub const LIVE: &[&str] = &["off", "polite", "assertive"];
243/// The roles a view can declare (`crate::access::Role::name` spellings),
244/// in wire order — a binding sends the index. The purely derived roles are
245/// the ones [`DERIVED_ONLY`] names, and every other `Role::ALL` variant is
246/// here; `textInput`, `multilineTextInput` and `line` are, because an app
247/// that draws its own text declares them.
248pub const ROLES: &[&str] = &[
249    "none",
250    "button",
251    "checkbox",
252    "radio",
253    "switch",
254    "slider",
255    "tab",
256    "tabList",
257    "link",
258    "heading",
259    "list",
260    "listItem",
261    "image",
262    "dialog",
263    "group",
264    "textInput",
265    "multilineTextInput",
266    "line",
267    // Appended later. The tail is the only free position,
268    // which is what makes "the first fifteen can be declared" a list rather
269    // than a range.
270    "radioGroup",
271    "menu",
272    "menuItem",
273    // Appended later: a cell grid's derived role.
274    "terminal",
275];
276
277/// How a composite container arranges its items
278/// (`crate::access::Orientation::name` spellings), in wire order. Derived
279/// from the container's `dir` and reported on its access node, never
280/// declared — so unlike [`ROLES`] this is not a prop's enum, only a list
281/// the C header restates.
282pub const ORIENTATIONS: &[&str] = &["horizontal", "vertical"];
283
284/// The OS light/dark setting (`crate::env::Appearance::name` spellings, in
285/// `Appearance::ALL` order — an `env.rs` test pins the two together). Like
286/// [`ORIENTATIONS`] this is not a prop's enum: it is a fact a host pushes
287/// and every binding spells the same way. Index 0 is `unknown`, so a
288/// zeroed C call reports what it actually knows.
289pub const APPEARANCES: &[&str] = &["unknown", "light", "dark"];
290
291/// The OS reduce-motion setting (`crate::env::MotionPref::name` spellings, in
292/// `MotionPref::ALL` order), `unknown` first for the same reason.
293pub const MOTIONS: &[&str] = &["unknown", "full", "reduced"];
294
295/// Whether assistive technology is listening (`crate::env::Assistive::name`
296/// spellings, in `Assistive::ALL` order), `unknown` first for the same
297/// reason: a host with no bridge reports that it cannot tell.
298pub const ASSISTIVE: &[&str] = &["unknown", "none", "listening"];
299
300/// The audio output device's state (`crate::env::AudioDevice::name`
301/// spellings, in `AudioDevice::ALL` order), `closed` first so a zeroed C
302/// call reports the default.
303pub const AUDIO_DEVICES: &[&str] = &["closed", "opening", "open", "failed"];
304
305/// What is behind a window's transparent pixels
306/// (`crate::window::Backdrop::name` spellings, in `Backdrop::ALL` order),
307/// `opaque` first so a zeroed C call reports the default.
308pub const BACKDROPS: &[&str] = &["opaque", "transparent", "blur", "tinted"];
309
310/// The roles no view can declare, because the core derives them itself,
311/// with what derives each one. Every
312/// [`Role::ALL`] variant is on this list or in [`ROLES`], and
313/// `every_role_is_declarable_or_derived` keeps both halves honest: a role
314/// exempted here has to be one a frame really does derive, so the list
315/// cannot absorb a variant that was simply forgotten from `ROLES`.
316pub const DERIVED_ONLY: &[(&str, &str)] = &[
317    (
318        "window",
319        "the root node of a frame, named by the window title",
320    ),
321    ("titleBar", "a `windowDrag` node"),
322    ("staticText", "a text node"),
323    ("scrollView", "a `scrollX` / `scrollY` node"),
324];
325
326/// The role at wire index `i` — `ROLES`' order is the protocol, so this
327/// and [`ROLES`] are pinned to each other by
328/// `every_declarable_role_name_is_a_real_role`.
329///
330/// Neither way of missing can happen today. A name in `ROLES` that no
331/// longer parses is what that test catches, by construction rather than
332/// at run time. Out of range cannot arrive through a transport: Node's
333/// binary reader rejects `i >= names.len()` before it builds a
334/// `Parsed::Enum`, Node's JSON and Lua resolve a *name* through
335/// [`enum_index`], and C carries `Role::ALL` positions that
336/// [`crate::access::Role`] itself bounds.
337///
338/// So the fallback is reachable only from a future transport that forgets
339/// its check, and it is `Role::Group` rather than `Role::None` for that
340/// reader: `None` takes the node *and its whole subtree* out of the access
341/// tree, which is a destructive answer to "an index I do not have", while
342/// a group is what the core already derives for a box that is merely
343/// somewhere focus can land — the node keeps its children, and a wrong
344/// role is recoverable where a missing subtree is not. It stays silent
345/// because this is a pure schema function with no warning sink, and the
346/// transports' own errors name the prop and the index, which is a better
347/// report than a warning here.
348pub fn role_idx(i: usize) -> Role {
349    ROLES
350        .get(i)
351        .and_then(|n| Role::parse(n))
352        .unwrap_or(Role::Group)
353}
354/// The easing curves (`Easing::name` spellings, in `Easing::ALL` order —
355/// the test below pins the two together, as `CURSORS` is pinned).
356pub const EASINGS: &[&str] = &[
357    "easeOut",
358    "linear",
359    "easeIn",
360    "easeInOut",
361    "spring",
362    "bouncy",
363    "smooth",
364    "snappy",
365];
366
367/// CSS's `animation-direction` values, in `Repeat::ALL`'s order.
368pub const REPEATS: &[&str] = &["normal", "reverse", "alternate", "alternateReverse"];
369
370pub fn repeat_idx(i: usize) -> Repeat {
371    Repeat::from_index(i)
372}
373
374pub fn easing_idx(i: usize) -> Easing {
375    Easing::from_index(i)
376}
377
378/// How a prop's value is parsed (per transport) and encoded (binary slots).
379pub enum Kind {
380    /// One number, or a `"$length"` token. Binary: 1 slot.
381    F32,
382    /// One color: `0xRRGGBBAA` number or `#hex` string, or a `"$color"`
383    /// token. Binary: 1 slot (u32).
384    Color,
385    /// Marker, present-or-absent (`false` = absent). Binary: 0 slots.
386    Flag,
387    /// One of a closed name list. Binary: 1 slot (index).
388    Enum(&'static [&'static str]),
389    /// A sizing: number | "fit" | "grow" | "N%" | a size expression
390    /// (`"clamp(400px, 80%, 1000px)"`, [`crate::calc`]) | {grow} |
391    /// {percent}, or a `"$length"` token (a fixed length). Binary: 2 slots
392    /// (mode, value), or with mode [`SIZE_MODE_CALC`] the mode and a
393    /// strref, the expression's spelling (v19); tagged, 1 slot (the index).
394    Sizing,
395    /// A lower clamp: number | "fit" (the node's own fit size on that axis)
396    /// | a size expression, or a `"$length"` token. Binary: 2 slots (mode,
397    /// value), a sizing's first two modes, or [`SIZE_MODE_CALC`] and a
398    /// strref; tagged, 1 slot (the index).
399    Min,
400    /// An upper clamp: number | a size expression, or a `"$length"` token.
401    /// Binary as a `Min` (v19; a plain number before): mode 0 and px, or
402    /// [`SIZE_MODE_CALC`] and a strref; tagged, 1 slot (the index).
403    Max,
404    /// An arbitrary message payload (a `Value`). Binary: strref to JSON.
405    Msg,
406    /// A message merged into the core's own event under `tag` (`onDrag`,
407    /// `onKey`, `onHover`, `onLayout`). Parsed and carried exactly like a
408    /// `Msg`, but null is a legal value: the node still gets the behaviour
409    /// (a key sink, a drag source) and its events simply carry no `tag` —
410    /// so an app whose messages are a typed union needs no inert member
411    /// just to name a sink.
412    Tag,
413    /// A plain string (a name, not a message). Binary: strref.
414    Str,
415    /// A font family: one of the stock names (`FAMILIES`) or an installed
416    /// or loaded family's name, which the parser registers and turns into
417    /// its handle. Binary: strref (v18).
418    Family,
419    /// A registered resource handle (a font or sound id): the integer form
420    /// of the slotmap key. JSON/binary carry it as the 16-hex string the
421    /// addon hands out; Lua as an integer; C as a `uint64_t`.
422    Resource,
423    /// A keyframe stop list (`crate::keyframes::parse` reads the plain-data
424    /// form). JSON/binary/Lua carry it like a `Msg` and parse it in the
425    /// core; C passes a `KuiKeyframe` array.
426    Keyframes,
427    /// An entrance (`crate::enter::parse` reads the plain-data form).
428    /// Carried like a `Msg` and parsed in the core; C fills a `KuiEnter`.
429    Enter,
430    /// A gradient (`crate::gradient::parse` reads the plain-data form).
431    /// Carried like a `Msg` and parsed in the core; C fills a
432    /// `KuiGradient`.
433    Gradient,
434}
435
436/// Where a parsed value lands. `PropDef::target` derives from this.
437pub enum Apply {
438    SpecF32(fn(NodeSpec, f32) -> NodeSpec),
439    SpecColor(fn(NodeSpec, Color) -> NodeSpec),
440    SpecFlag(fn(NodeSpec) -> NodeSpec),
441    SpecEnum(fn(NodeSpec, usize) -> NodeSpec),
442    SpecSizing(fn(NodeSpec, Sizing) -> NodeSpec),
443    SpecBound(fn(NodeSpec, Bound) -> NodeSpec),
444    SpecMsg(fn(NodeSpec, Value) -> NodeSpec),
445    SpecStr(fn(NodeSpec, &str) -> NodeSpec),
446    SpecKeyframes(fn(NodeSpec, Vec<Keyframe>) -> NodeSpec),
447    SpecEnter(fn(NodeSpec, Enter) -> NodeSpec),
448    SpecGradient(fn(NodeSpec, crate::gradient::Gradient) -> NodeSpec),
449    SpecResource(fn(NodeSpec, u64) -> NodeSpec),
450    StyleF32(fn(TextStyle, f32) -> TextStyle),
451    StyleColor(fn(TextStyle, Color) -> TextStyle),
452    StyleEnum(fn(TextStyle, usize) -> TextStyle),
453    StyleFlag(fn(TextStyle) -> TextStyle),
454    StyleResource(fn(TextStyle, u64) -> TextStyle),
455    StyleStr(fn(TextStyle, &str) -> TextStyle),
456    StyleFamily(fn(TextStyle, FontFamily) -> TextStyle),
457}
458
459#[derive(Clone, Copy, Debug, PartialEq, Eq)]
460pub enum Target {
461    /// Lands on the node's `NodeSpec` (containers, edits, images).
462    Spec,
463    /// Lands on a `TextStyle` (text, rich text, edits).
464    Style,
465}
466
467pub struct PropDef {
468    /// Canonical camelCase name (the JSX prop). Lua uses `snake_name()`.
469    pub name: &'static str,
470    pub id: u32,
471    pub kind: Kind,
472    pub apply: Apply,
473    pub doc: &'static str,
474}
475
476impl PropDef {
477    pub fn target(&self) -> Target {
478        match self.apply {
479            Apply::StyleF32(_)
480            | Apply::StyleColor(_)
481            | Apply::StyleEnum(_)
482            | Apply::StyleFlag(_)
483            | Apply::StyleResource(_)
484            | Apply::StyleStr(_)
485            | Apply::StyleFamily(_) => Target::Style,
486            _ => Target::Spec,
487        }
488    }
489
490    /// The Lua-side name: `minWidth` → `min_width`.
491    pub fn snake_name(&self) -> &'static str {
492        SNAKE_NAMES[self.index()]
493    }
494
495    fn index(&self) -> usize {
496        // By name, not by address: `PROPS` is a const, so another crate
497        // iterating it sees its own copy of the rows.
498        PROPS
499            .iter()
500            .position(|d| d.name == self.name)
501            .expect("PropDef not from PROPS")
502    }
503}
504
505pub fn align_idx(i: usize) -> Align {
506    match i {
507        1 => Align::Center,
508        2 => Align::End,
509        3 => Align::SpaceBetween,
510        4 => Align::SpaceAround,
511        5 => Align::SpaceEvenly,
512        6 => Align::Baseline,
513        _ => Align::Start,
514    }
515}
516
517/// Binary min or max decode: (mode, value) → a clamp, the first two
518/// sizing modes ([`SIZE_MODE_CALC`] is read by the transport, which
519/// holds the strref).
520pub fn min_num(mode: u32, value: f64) -> Bound {
521    match mode {
522        1 => Bound::Fit,
523        _ => Bound::Px(value as f32),
524    }
525}
526
527/// Binary sizing decode: (mode, value) → Sizing.
528pub fn sizing_num(mode: u32, value: f64) -> Sizing {
529    match mode {
530        1 => Sizing::Fit,
531        2 => Sizing::Grow(value as f32),
532        3 => Sizing::Percent(value as f32),
533        _ => Sizing::Fixed(value as f32),
534    }
535}
536
537pub const PROPS: &[PropDef] = &[
538    PropDef {
539        name: "width",
540        id: P_WIDTH,
541        kind: Kind::Sizing,
542        apply: Apply::SpecSizing(|s, v| s.width(v)),
543        doc: "Horizontal size: px | \"fit\" | \"grow\" | \"N%\" | a size expression — \
544              `\"clamp(400px, 80%, 1000px)\"`, `\"min(720px, 100%)\"`, `\"max(50%, 300)\"`, \
545              nested — which layout resolves against the parent's content box, the box a \
546              percentage takes its cut of (backlog F109). An expression with no percentage \
547              in it is a length; a calc does not ease under `transition`. A percentage \
548              or an expression gives, with the fit children, when its parent overflows \
549              — two `\"50%\"` children and a gap fit their row (backlog F110) — where a \
550              px size keeps its own. A row holding one gives as CSS's flex items do: \
551              every child that can give gives in proportion to its size, and stops at \
552              its content — the widest thing in it that cannot wrap, a label's longest \
553              word — unless `minWidth` says otherwise (backlog RG92). The process keeps \
554              65 536 distinct expressions and never lets one go: past that a new one leaves \
555              its prop at its default, with a `size-expressions-full` warning, so declare \
556              one per layout — a px size for the part that moves each frame, a splitter's \
557              drag — not one per frame (backlog RG93).",
558    },
559    PropDef {
560        name: "height",
561        id: P_HEIGHT,
562        kind: Kind::Sizing,
563        apply: Apply::SpecSizing(|s, v| s.height(v)),
564        doc: "Vertical size: px | \"fit\" | \"grow\" | \"N%\" | a size expression (see `width`).",
565    },
566    PropDef {
567        name: "minWidth",
568        id: P_MIN_W,
569        kind: Kind::Min,
570        apply: Apply::SpecBound(|s, v| s.min_width(v)),
571        doc: "Lower width clamp: logical px, a size expression (see `width`; a percentage \
572              clamp is none until the parent's width is known, as in CSS), or \"fit\" for \
573              the node's own fit width. \
574              \"fit\" under `width=\"grow\"` is a content floor — CSS's `flex: 1 0 auto` — \
575              which is what an i3-style tab bar is: tabs that split the bar evenly \
576              while they fit and sit at their label's width, scrolling, once they do \
577              not. Opt-in, because a fit width is the unwrapped one: a paragraph in a \
578              grow column would stop wrapping under it. Left out, a child giving in an \
579              overflowing row that holds a percentage or a size expression stops at its \
580              content, CSS's `min-width: auto`; `0` lets it go below, CSS's \
581              `min-width: 0` (backlog RG92). A fit node across a column is no wider \
582              than the column's box — CSS's `fit-content` — down to this floor, 0 left \
583              out, unless the column scrolls x, so a text one wrapper deep in a capped \
584              card wraps there; \"fit\" keeps its content's width and runs past \
585              (backlog F116).",
586    },
587    PropDef {
588        name: "maxWidth",
589        id: P_MAX_W,
590        kind: Kind::Max,
591        apply: Apply::SpecBound(|s, v| s.max_width(v)),
592        doc: "Upper width clamp: logical px or a size expression (see `width`); \
593              grow+maxWidth is the responsive-width pattern.",
594    },
595    PropDef {
596        name: "minHeight",
597        id: P_MIN_H,
598        kind: Kind::Min,
599        apply: Apply::SpecBound(|s, v| s.min_height(v)),
600        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`).",
601    },
602    PropDef {
603        name: "maxHeight",
604        id: P_MAX_H,
605        kind: Kind::Max,
606        apply: Apply::SpecBound(|s, v| s.max_height(v)),
607        doc: "Upper height clamp: logical px or a size expression (see `width`).",
608    },
609    PropDef {
610        name: "gap",
611        id: P_GAP,
612        kind: Kind::F32,
613        apply: Apply::SpecF32(|s, v| s.gap(v)),
614        doc: "Space between children along the main axis.",
615    },
616    // Not `wrap`: that name is taken, by the text prop that picks where a
617    // line breaks inside one paragraph. One name cannot mean both, and the
618    // two meet on `<edit>`, which takes container and text props at once.
619    PropDef {
620        name: "wrapChildren",
621        id: P_WRAP_CHILDREN,
622        kind: Kind::Flag,
623        apply: Apply::SpecFlag(NodeSpec::wrap),
624        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.",
625    },
626    PropDef {
627        name: "crossGap",
628        id: P_CROSS_GAP,
629        kind: Kind::F32,
630        apply: Apply::SpecF32(|s, v| s.cross_gap(v)),
631        doc: "Space between wrap lines, across the main axis (`gap` stays the space along it).",
632    },
633    PropDef {
634        name: "mainAlign",
635        id: P_MAIN_ALIGN,
636        kind: Kind::Enum(ALIGNS),
637        apply: Apply::SpecEnum(|s, i| s.main_align(align_idx(i))),
638        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.",
639    },
640    PropDef {
641        name: "crossAlign",
642        id: P_CROSS_ALIGN,
643        kind: Kind::Enum(ALIGNS),
644        apply: Apply::SpecEnum(|s, i| s.cross_align(align_idx(i))),
645        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.",
646    },
647    PropDef {
648        name: "aspectRatio",
649        id: P_ASPECT_RATIO,
650        kind: Kind::F32,
651        apply: Apply::SpecF32(|s, v| s.aspect_ratio(v)),
652        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.",
653    },
654    PropDef {
655        name: "bg",
656        id: P_BG,
657        kind: Kind::Color,
658        apply: Apply::SpecColor(|s, c| s.bg(c)),
659        doc: "Background fill.",
660    },
661    PropDef {
662        name: "radius",
663        id: P_RADIUS,
664        kind: Kind::F32,
665        apply: Apply::SpecF32(|s, v| s.radius(v)),
666        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.",
667    },
668    PropDef {
669        name: "opacity",
670        id: P_OPACITY,
671        kind: Kind::F32,
672        apply: Apply::SpecF32(|s, v| s.opacity(v)),
673        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.",
674    },
675    PropDef {
676        name: "pixelSnap",
677        id: P_PIXEL_SNAP,
678        kind: Kind::Flag,
679        apply: Apply::SpecFlag(|s| s.pixel_snap()),
680        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.",
681    },
682    PropDef {
683        name: "shadowColor",
684        id: P_SHADOW_COLOR,
685        kind: Kind::Color,
686        apply: Apply::SpecColor(|s, c| s.shadow_color(c)),
687        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.",
688    },
689    PropDef {
690        name: "shadowBlur",
691        id: P_SHADOW_BLUR,
692        kind: Kind::F32,
693        apply: Apply::SpecF32(|s, v| s.shadow_blur(v)),
694        doc: "Drop-shadow blur radius (logical px): the edge ramps over this distance and reaches this far past the shape. 0 = a hard edge.",
695    },
696    PropDef {
697        name: "shadowX",
698        id: P_SHADOW_X,
699        kind: Kind::F32,
700        apply: Apply::SpecF32(|s, v| s.shadow_x(v)),
701        doc: "Drop-shadow horizontal offset (logical px).",
702    },
703    PropDef {
704        name: "shadowY",
705        id: P_SHADOW_Y,
706        kind: Kind::F32,
707        apply: Apply::SpecF32(|s, v| s.shadow_y(v)),
708        doc: "Drop-shadow vertical offset (logical px); positive casts downward.",
709    },
710    PropDef {
711        name: "shadowSpread",
712        id: P_SHADOW_SPREAD,
713        kind: Kind::F32,
714        apply: Apply::SpecF32(|s, v| s.shadow_spread(v)),
715        doc: "Grows (or, negative, shrinks) the drop shadow's shape before blurring (logical px).",
716    },
717    PropDef {
718        name: "radiusTL",
719        id: P_RADIUS_TL,
720        kind: Kind::F32,
721        apply: Apply::SpecF32(|s, v| s.radius_tl(v)),
722        doc: "Top-left corner radius (logical px).",
723    },
724    PropDef {
725        name: "radiusTR",
726        id: P_RADIUS_TR,
727        kind: Kind::F32,
728        apply: Apply::SpecF32(|s, v| s.radius_tr(v)),
729        doc: "Top-right corner radius (logical px).",
730    },
731    PropDef {
732        name: "radiusBR",
733        id: P_RADIUS_BR,
734        kind: Kind::F32,
735        apply: Apply::SpecF32(|s, v| s.radius_br(v)),
736        doc: "Bottom-right corner radius (logical px).",
737    },
738    PropDef {
739        name: "radiusBL",
740        id: P_RADIUS_BL,
741        kind: Kind::F32,
742        apply: Apply::SpecF32(|s, v| s.radius_bl(v)),
743        doc: "Bottom-left corner radius (logical px).",
744    },
745    PropDef {
746        name: "center",
747        id: P_CENTER,
748        kind: Kind::Flag,
749        apply: Apply::SpecFlag(|s| s.center()),
750        doc: "Center children on both axes.",
751    },
752    PropDef {
753        name: "hoverable",
754        id: P_HOVERABLE,
755        kind: Kind::Flag,
756        apply: Apply::SpecFlag(|s| s.hoverable()),
757        doc: "Hover-track without a click payload (for isHovered-driven styling).",
758    },
759    PropDef {
760        name: "animate",
761        id: P_ANIMATE,
762        kind: Kind::Flag,
763        apply: Apply::SpecFlag(|s| s.animate()),
764        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.",
765    },
766    PropDef {
767        name: "accent",
768        id: P_ACCENT,
769        kind: Kind::Flag,
770        apply: Apply::SpecFlag(|s| s.accent()),
771        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.",
772    },
773    PropDef {
774        name: "selectable",
775        id: P_SELECTABLE,
776        kind: Kind::Flag,
777        apply: Apply::SpecFlag(|s| s.selectable()),
778        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.",
779    },
780    PropDef {
781        name: "focusable",
782        id: P_FOCUSABLE,
783        kind: Kind::Flag,
784        apply: Apply::SpecFlag(|s| s.focusable()),
785        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.",
786    },
787    PropDef {
788        name: "keepFocus",
789        id: P_KEEP_FOCUS,
790        kind: Kind::Flag,
791        apply: Apply::SpecFlag(|s| s.keep_focus()),
792        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.",
793    },
794    PropDef {
795        name: "focusRegion",
796        id: P_FOCUS_REGION,
797        kind: Kind::Flag,
798        apply: Apply::SpecFlag(|s| s.focus_region()),
799        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.",
800    },
801    PropDef {
802        name: "scrollbar",
803        id: P_SCROLLBAR,
804        kind: Kind::Enum(SCROLLBARS),
805        apply: Apply::SpecEnum(|s, i| s.scrollbar(crate::spec::ScrollbarMode::ALL[i])),
806        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.",
807    },
808    PropDef {
809        name: "anchor",
810        id: P_ANCHOR,
811        kind: Kind::Flag,
812        apply: Apply::SpecFlag(|s| s.anchor()),
813        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.",
814    },
815    PropDef {
816        name: "scrollbarWidth",
817        id: P_SCROLLBAR_WIDTH,
818        kind: Kind::F32,
819        apply: Apply::SpecF32(|s, v| s.scrollbar_width(v)),
820        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.",
821    },
822    PropDef {
823        name: "scrollbarColor",
824        id: P_SCROLLBAR_COLOR,
825        kind: Kind::Color,
826        apply: Apply::SpecColor(|s, c| s.scrollbar_color(c)),
827        doc: "The thumb at rest; the default is the theme's `scrollbar` role, a translucent wash over whatever it sits on.",
828    },
829    PropDef {
830        name: "scrollbarActiveColor",
831        id: P_SCROLLBAR_ACTIVE_COLOR,
832        kind: Kind::Color,
833        apply: Apply::SpecColor(|s, c| s.scrollbar_active_color(c)),
834        doc: "The thumb under the pointer or while dragged; the default is the theme's `scrollbar_active` role.",
835    },
836    PropDef {
837        name: "overscroll",
838        id: P_OVERSCROLL,
839        kind: Kind::Enum(OVERSCROLLS),
840        apply: Apply::SpecEnum(|s, i| s.overscroll(crate::spec::Overscroll::ALL[i])),
841        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.",
842    },
843    PropDef {
844        name: "disabled",
845        id: P_DISABLED,
846        kind: Kind::Flag,
847        apply: Apply::SpecFlag(|s| s.disabled(true)),
848        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.",
849    },
850    PropDef {
851        name: "hoverBg",
852        id: P_HOVER_BG,
853        kind: Kind::Color,
854        apply: Apply::SpecColor(|s, c| s.hover_bg(c)),
855        doc: "Background while hovered (or while any node in its hoverGroup is); implies hover tracking, eases with `transition`.",
856    },
857    PropDef {
858        name: "gradient",
859        id: P_GRADIENT,
860        kind: Kind::Gradient,
861        apply: Apply::SpecGradient(|s, g| s.gradient(g)),
862        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. A stop whose `$token` misses is not an error: it is raised as `unknown-token` and left out, as a miss leaves any slot unset, and the rest are spaced as if it had not been declared — so a gradient left with fewer than two stops, a two-stop one with a typo, draws nothing over its `bg` (backlog RG118).",
863    },
864    PropDef {
865        name: "backdropBlur",
866        id: P_BACKDROP_BLUR,
867        kind: Kind::F32,
868        apply: Apply::SpecF32(|s, v| s.backdrop_blur(v)),
869        doc: "Blur what was drawn beneath the node, inside its rounded box, by this radius in logical px — CSS's `backdrop-filter: blur()`, the radius its standard deviation (backlog F129). What blurs is everything painted before the node: its ancestors' backgrounds, the siblings under it, content scrolling beneath it, the window's `backdrop` where the window has one. The node's own `bg`, border and children paint over the blur, so a translucent `bg` (`#ffffff40`) makes frosted glass and an opaque one hides it. Clipped as the node is, faded by its `opacity`; 0 is none. The GPU renderer reads back only the box (and a margin of three radii around it) and blurs it at reduced resolution, so it costs a copy and three small passes per blurred node on a frame that has one and nothing on a frame that does not. A renderer that cannot read back what it drew — a host's own, or anything older — leaves the node over an unblurred backdrop; the display list carries it as a `backdrop` quad (`KUI_QUAD_BACKDROP` in C) either way.",
870    },
871    PropDef {
872        name: "rules",
873        id: P_RULES,
874        kind: Kind::Color,
875        apply: Apply::SpecColor(|s, c| s.rules(c)),
876        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.",
877    },
878    PropDef {
879        name: "ruleWidth",
880        id: P_RULE_WIDTH,
881        kind: Kind::F32,
882        apply: Apply::SpecF32(|s, v| s.rule_width(v)),
883        doc: "The width of a table's `rules` in logical px; 1 when unset.",
884    },
885    PropDef {
886        name: "dropBg",
887        id: P_DROP_BG,
888        kind: Kind::Color,
889        apply: Apply::SpecColor(|s, c| s.drop_bg(c)),
890        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`.",
891    },
892    PropDef {
893        name: "pressedBg",
894        id: P_PRESSED_BG,
895        kind: Kind::Color,
896        apply: Apply::SpecColor(|s, c| s.pressed_bg(c)),
897        doc: "Background while pressed (or while its hoverGroup is); implies hover tracking.",
898    },
899    PropDef {
900        name: "focusBg",
901        id: P_FOCUS_BG,
902        kind: Kind::Color,
903        apply: Apply::SpecColor(|s, c| s.focus_bg(c)),
904        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`.",
905    },
906    PropDef {
907        name: "modal",
908        id: P_MODAL,
909        kind: Kind::Tag,
910        apply: Apply::SpecMsg(|s, v| s.modal(v)),
911        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.",
912    },
913    PropDef {
914        name: "initialFocus",
915        id: P_INITIAL_FOCUS,
916        kind: Kind::Flag,
917        apply: Apply::SpecFlag(|s| s.initial_focus()),
918        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.",
919    },
920    PropDef {
921        name: "hoverGroup",
922        id: P_HOVER_GROUP,
923        kind: Kind::Str,
924        apply: Apply::SpecStr(|s, name| s.hover_group(name)),
925        doc: "Nodes sharing a group name show hoverBg/pressedBg together (a split button, a multi-piece shape).",
926    },
927    PropDef {
928        name: "onHover",
929        id: P_ON_HOVER,
930        kind: Kind::Tag,
931        apply: Apply::SpecMsg(|s, v| s.on_hover(v)),
932        doc: "Hover tag: the pointer entering/leaving emits {kind:\"hover\", phase:\"enter\"|\"leave\", tag} events.",
933    },
934    PropDef {
935        name: "onDrop",
936        id: P_ON_DROP,
937        kind: Kind::Tag,
938        apply: Apply::SpecMsg(|s, v| s.on_drop(v)),
939        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.",
940    },
941    PropDef {
942        name: "onLayout",
943        id: P_ON_LAYOUT,
944        kind: Kind::Tag,
945        apply: Apply::SpecMsg(|s, v| s.on_layout(v)),
946        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).",
947    },
948    PropDef {
949        name: "onClick",
950        id: P_ON_CLICK,
951        kind: Kind::Msg,
952        apply: Apply::SpecMsg(|s, v| s.on_click(v)),
953        doc: "Message emitted when clicked (data, not a callback).",
954    },
955    PropDef {
956        name: "onDrag",
957        id: P_ON_DRAG,
958        kind: Kind::Tag,
959        apply: Apply::SpecMsg(|s, v| s.on_drag(v)),
960        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.",
961    },
962    PropDef {
963        name: "onKey",
964        id: P_ON_KEY,
965        kind: Kind::Tag,
966        apply: Apply::SpecMsg(|s, v| s.on_key(v)),
967        doc: "Key-sink tag: with key focus held, presses arrive as {kind:\"key\", phase:\"down\", code, ...} events. Releases only with `keyUp` beside it.",
968    },
969    PropDef {
970        name: "keyUp",
971        id: P_KEY_UP,
972        kind: Kind::Flag,
973        apply: Apply::SpecFlag(|s| s.key_up()),
974        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.",
975    },
976    PropDef {
977        name: "modifierKeys",
978        id: P_MODIFIER_KEYS,
979        kind: Kind::Flag,
980        apply: Apply::SpecFlag(|s| s.modifier_keys()),
981        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.",
982    },
983    PropDef {
984        name: "onContextMenu",
985        id: P_ON_CONTEXT_MENU,
986        kind: Kind::Tag,
987        apply: Apply::SpecMsg(|s, v| s.on_context_menu(v)),
988        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.",
989    },
990    PropDef {
991        name: "onForceClick",
992        id: P_ON_FORCE_CLICK,
993        kind: Kind::Tag,
994        apply: Apply::SpecMsg(|s, v| s.on_force_click(v)),
995        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.",
996    },
997    PropDef {
998        name: "onButton",
999        id: P_ON_BUTTON,
1000        kind: Kind::Tag,
1001        apply: Apply::SpecMsg(|s, v| s.on_button(v)),
1002        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.",
1003    },
1004    PropDef {
1005        name: "buttons",
1006        id: P_BUTTONS,
1007        kind: Kind::Str,
1008        apply: Apply::SpecStr(|s, v| s.buttons(crate::input::Buttons::parse(v))),
1009        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`.",
1010    },
1011    PropDef {
1012        name: "onScroll",
1013        id: P_ON_SCROLL,
1014        kind: Kind::Tag,
1015        apply: Apply::SpecMsg(|s, v| s.on_scroll(v)),
1016        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`).",
1017    },
1018    PropDef {
1019        name: "scrollAxes",
1020        id: P_SCROLL_AXES,
1021        kind: Kind::Enum(SCROLL_AXES),
1022        apply: Apply::SpecEnum(|s, i| s.scroll_axes(crate::spec::ScrollAxes::ALL[i])),
1023        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`.",
1024    },
1025    PropDef {
1026        name: "scrollMods",
1027        id: P_SCROLL_MODS,
1028        kind: Kind::Str,
1029        apply: Apply::SpecStr(|s, v| s.scroll_mods(crate::input::KeyMods::parse(v))),
1030        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`.",
1031    },
1032    PropDef {
1033        name: "window",
1034        id: P_WINDOW,
1035        kind: Kind::Enum(WINDOW_ROLES),
1036        apply: Apply::SpecEnum(|s, i| match i {
1037            0 => s.window_drag(),
1038            1 => s.window_button(WindowButton::Close),
1039            2 => s.window_button(WindowButton::Minimize),
1040            3 => s.window_button(WindowButton::Maximize),
1041            _ => s,
1042        }),
1043        doc: "Window-chrome role: interactions become window commands, not events.",
1044    },
1045    PropDef {
1046        name: "cursor",
1047        id: P_CURSOR,
1048        kind: Kind::Enum(CURSORS),
1049        apply: Apply::SpecEnum(|s, i| s.cursor(cursor_idx(i))),
1050        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.",
1051    },
1052    PropDef {
1053        name: "transition",
1054        id: P_TRANSITION,
1055        kind: Kind::F32,
1056        apply: Apply::SpecF32(|s, v| s.transition(v)),
1057        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).",
1058    },
1059    PropDef {
1060        name: "easing",
1061        id: P_EASING,
1062        kind: Kind::Enum(EASINGS),
1063        apply: Apply::SpecEnum(|s, i| s.easing(easing_idx(i))),
1064        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.",
1065    },
1066    PropDef {
1067        name: "bounce",
1068        id: P_BOUNCE,
1069        kind: Kind::F32,
1070        apply: Apply::SpecF32(|s, v| s.bounce(v)),
1071        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.",
1072    },
1073    PropDef {
1074        name: "slide",
1075        id: P_SLIDE,
1076        kind: Kind::Flag,
1077        apply: Apply::SpecFlag(|s| s.slide()),
1078        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.",
1079    },
1080    PropDef {
1081        name: "keyframes",
1082        id: P_KEYFRAMES,
1083        kind: Kind::Keyframes,
1084        apply: Apply::SpecKeyframes(|s, k| s.keyframes(k)),
1085        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.",
1086    },
1087    PropDef {
1088        name: "enter",
1089        id: P_ENTER,
1090        kind: Kind::Enter,
1091        apply: Apply::SpecEnter(|s, e| s.enter(e)),
1092        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).",
1093    },
1094    PropDef {
1095        name: "exit",
1096        id: P_EXIT,
1097        kind: Kind::Enter,
1098        apply: Apply::SpecEnter(|s, e| s.exit(e)),
1099        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.",
1100    },
1101    PropDef {
1102        name: "repeat",
1103        id: P_REPEAT,
1104        kind: Kind::Enum(REPEATS),
1105        apply: Apply::SpecEnum(|s, i| s.repeat(repeat_idx(i))),
1106        doc: "How `keyframes` cycle (CSS `animation-direction`, default normal). Lua: `direction`, since `repeat` is a keyword.",
1107    },
1108    PropDef {
1109        name: "delay",
1110        id: P_DELAY,
1111        kind: Kind::F32,
1112        apply: Apply::SpecF32(|s, v| s.delay(v)),
1113        doc: "Holds the `keyframes` cycle back by this many ms (CSS `animation-delay`); siblings with different delays run out of phase.",
1114    },
1115    PropDef {
1116        name: "clickSound",
1117        id: P_CLICK_SOUND,
1118        kind: Kind::Resource,
1119        apply: Apply::SpecResource(|s, id| s.click_sound(crate::resources::SoundId::from_ffi(id))),
1120        doc: "A registered sound (addSound) played when the node is clicked; implies hover tracking.",
1121    },
1122    PropDef {
1123        name: "hoverSound",
1124        id: P_HOVER_SOUND,
1125        kind: Kind::Resource,
1126        apply: Apply::SpecResource(|s, id| s.hover_sound(crate::resources::SoundId::from_ffi(id))),
1127        doc: "A registered sound (addSound) played when the pointer enters the node; implies hover tracking.",
1128    },
1129    PropDef {
1130        name: "lineHeight",
1131        id: P_LINE_HEIGHT,
1132        kind: Kind::F32,
1133        apply: Apply::StyleF32(|t, v| t.line_height(v)),
1134        doc: "Line height (logical px); default size * 1.35.",
1135    },
1136    PropDef {
1137        name: "color",
1138        id: P_COLOR,
1139        kind: Kind::Color,
1140        apply: Apply::StyleColor(|t, c| t.color(c)),
1141        doc: "Text color; default foreground when omitted.",
1142    },
1143    PropDef {
1144        name: "family",
1145        id: P_FAMILY,
1146        kind: Kind::Family,
1147        apply: Apply::StyleFamily(|t, f| t.family(f)),
1148        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.",
1149    },
1150    PropDef {
1151        name: "font",
1152        id: P_FONT,
1153        kind: Kind::Resource,
1154        apply: Apply::StyleResource(|t, id| t.font(crate::resources::FontId::from_ffi(id))),
1155        doc: "A registered font handle (addFont / addSystemFont); overrides `family`.",
1156    },
1157    PropDef {
1158        name: "wrap",
1159        id: P_WRAP,
1160        kind: Kind::Enum(WRAPS),
1161        apply: Apply::StyleEnum(|t, i| match i {
1162            1 => t.wrap(TextWrap::Glyph),
1163            2 => t.wrap(TextWrap::None),
1164            3 => t.wrap(TextWrap::BreakSpaces),
1165            _ => t.wrap(TextWrap::Word),
1166        }),
1167        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`).",
1168    },
1169    PropDef {
1170        name: "maxLines",
1171        id: P_MAX_LINES,
1172        kind: Kind::F32,
1173        apply: Apply::StyleF32(|t, v| t.max_lines(v.max(0.0) as u32)),
1174        doc: "Lay out at most this many lines (0 = unlimited); with `ellipsis`, a line clamp.",
1175    },
1176    PropDef {
1177        name: "ellipsis",
1178        id: P_ELLIPSIS,
1179        kind: Kind::Flag,
1180        apply: Apply::StyleFlag(|t| t.ellipsis()),
1181        doc: "End the last line with an ellipsis when the text is cut off: a single line unless `maxLines` says otherwise.",
1182    },
1183    PropDef {
1184        name: "underline",
1185        id: P_UNDERLINE,
1186        kind: Kind::Flag,
1187        apply: Apply::StyleFlag(|t| t.underline()),
1188        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.",
1189    },
1190    PropDef {
1191        name: "underlineColor",
1192        id: P_UNDERLINE_COLOR,
1193        kind: Kind::Color,
1194        apply: Apply::StyleColor(|t, c| t.underline_color(c)),
1195        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.",
1196    },
1197    PropDef {
1198        name: "underlineStyle",
1199        id: P_UNDERLINE_STYLE,
1200        kind: Kind::Enum(UNDERLINE_STYLES),
1201        apply: Apply::StyleEnum(|t, i| t.underline_style(UnderlineStyle::from_index(i as u32))),
1202        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.",
1203    },
1204    PropDef {
1205        name: "strikethrough",
1206        id: P_STRIKETHROUGH,
1207        kind: Kind::Flag,
1208        apply: Apply::StyleFlag(|t| t.strikethrough()),
1209        doc: "A line through the text, where the face puts its strikeout. Paint only; on a `<span>` the span alone, per line.",
1210    },
1211    PropDef {
1212        name: "features",
1213        id: P_FEATURES,
1214        kind: Kind::Str,
1215        apply: Apply::StyleStr(|t, s| t.features(crate::spec::FontFeatures::parse(s))),
1216        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.",
1217    },
1218    PropDef {
1219        name: "role",
1220        id: P_ROLE,
1221        kind: Kind::Enum(ROLES),
1222        apply: Apply::SpecEnum(|s, i| s.role(role_idx(i))),
1223        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.",
1224    },
1225    PropDef {
1226        name: "label",
1227        id: P_LABEL,
1228        kind: Kind::Str,
1229        apply: Apply::SpecStr(|s, v| s.label(v)),
1230        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`).",
1231    },
1232    PropDef {
1233        name: "description",
1234        id: P_DESCRIPTION,
1235        kind: Kind::Str,
1236        apply: Apply::SpecStr(|s, v| s.description(v)),
1237        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.",
1238    },
1239    PropDef {
1240        name: "checked",
1241        id: P_CHECKED,
1242        kind: Kind::Flag,
1243        apply: Apply::SpecFlag(|s| s.checked(true)),
1244        doc: "The on state of a `checkbox` / `radio` / `switch` role.",
1245    },
1246    PropDef {
1247        name: "mixed",
1248        id: P_MIXED,
1249        kind: Kind::Flag,
1250        apply: Apply::SpecFlag(|s| s.mixed(true)),
1251        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.",
1252    },
1253    PropDef {
1254        name: "selected",
1255        id: P_SELECTED,
1256        kind: Kind::Flag,
1257        apply: Apply::SpecFlag(|s| s.selected(true)),
1258        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.",
1259    },
1260    PropDef {
1261        name: "expanded",
1262        id: P_EXPANDED,
1263        kind: Kind::Enum(EXPANDED),
1264        apply: Apply::SpecEnum(|s, i| s.expanded(i == 1)),
1265        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.",
1266    },
1267    PropDef {
1268        name: "live",
1269        id: P_LIVE,
1270        kind: Kind::Enum(LIVE),
1271        apply: Apply::SpecEnum(|s, i| s.live(crate::access::Live::from_index(i))),
1272        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.",
1273    },
1274    PropDef {
1275        name: "valueNow",
1276        id: P_VALUE_NOW,
1277        kind: Kind::F32,
1278        apply: Apply::SpecF32(|s, v| s.value_now(v)),
1279        doc: "A `slider` role's current value (the drawing stays yours; this is what assistive technology reads).",
1280    },
1281    PropDef {
1282        name: "valueMin",
1283        id: P_VALUE_MIN,
1284        kind: Kind::F32,
1285        apply: Apply::SpecF32(|s, v| s.value_min(v)),
1286        doc: "A `slider` role's minimum.",
1287    },
1288    PropDef {
1289        name: "valueMax",
1290        id: P_VALUE_MAX,
1291        kind: Kind::F32,
1292        apply: Apply::SpecF32(|s, v| s.value_max(v)),
1293        doc: "A `slider` role's maximum.",
1294    },
1295    PropDef {
1296        name: "valueText",
1297        id: P_VALUE_TEXT,
1298        kind: Kind::Str,
1299        apply: Apply::SpecStr(|s, v| s.value_text(v)),
1300        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.",
1301    },
1302    PropDef {
1303        name: "valueStep",
1304        id: P_VALUE_STEP,
1305        kind: Kind::F32,
1306        apply: Apply::SpecF32(|s, v| s.value_step(v)),
1307        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.",
1308    },
1309    PropDef {
1310        name: "onFocus",
1311        id: P_ON_FOCUS,
1312        kind: Kind::Tag,
1313        apply: Apply::SpecMsg(|s, v| s.on_focus(v)),
1314        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.",
1315    },
1316    PropDef {
1317        name: "onChange",
1318        id: P_ON_CHANGE,
1319        kind: Kind::Tag,
1320        apply: Apply::SpecMsg(|s, v| s.on_change(v)),
1321        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.",
1322    },
1323    PropDef {
1324        name: "caret",
1325        id: P_CARET,
1326        kind: Kind::F32,
1327        apply: Apply::SpecF32(|s, v| s.caret(v.max(0.0) as u32)),
1328        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.",
1329    },
1330    PropDef {
1331        name: "selectionAnchor",
1332        id: P_SELECTION_ANCHOR,
1333        kind: Kind::F32,
1334        apply: Apply::SpecF32(|s, v| s.selection_anchor(v.max(0.0) as u32)),
1335        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).",
1336    },
1337    PropDef {
1338        name: "caretSolid",
1339        id: P_CARET_SOLID,
1340        kind: Kind::Flag,
1341        apply: Apply::SpecFlag(|s| s.caret_solid()),
1342        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.",
1343    },
1344];
1345
1346/// A prop every binding handles by hand (a composite with real logic, or a
1347/// constructor-order special), with its wire id so transports agree on
1348/// identity and its per-binding spelling so the docs can say so.
1349pub struct CustomProp {
1350    pub name: &'static str,
1351    pub id: u32,
1352    /// Every prop name a JSX view may write for it — the machine-readable
1353    /// half of `jsx`, which is prose for the docs. A composite is spelled
1354    /// differently in each binding (`borderW` here, `border = {…}` there),
1355    /// so the two lists are separate; together with `PROPS` and an element's
1356    /// own props they are the whole allow-list a binding checks a view
1357    /// against (see [`known_prop`]).
1358    pub jsx_names: &'static [&'static str],
1359    /// The same for a Lua node table.
1360    pub lua_names: &'static [&'static str],
1361    /// How JSX spells it.
1362    pub jsx: &'static str,
1363    /// How a Lua table spells it.
1364    pub lua: &'static str,
1365    /// Where it lands in C.
1366    pub c: &'static str,
1367    /// Where it lands in Odin (packages/odin): a `Spec` / `Text_Style`
1368    /// field, or a `kui.` procedure for a window-level row. The Odin
1369    /// generator checks every name here is one its package has.
1370    pub odin: &'static str,
1371    pub doc: &'static str,
1372}
1373
1374pub const CUSTOM: &[CustomProp] = &[
1375    CustomProp {
1376        name: "dir",
1377        id: P_DIR,
1378        jsx_names: &["dir"],
1379        lua_names: &[],
1380        jsx: "`dir=\"row\" | \"column\" | \"table\"`",
1381        lua: "`row { }` / `column { }` / `grid { }`",
1382        c: "`dir` (`KUI_ROW` / `KUI_COLUMN` / `KUI_TABLE`)",
1383        odin: "`Spec.dir` (`.Column` / `.Row` / `.Table`); `kui.row` and `kui.column` set it",
1384        doc: "Main axis; column is the default. `table` is a column whose rows' children line up in columns (the `table` element).",
1385    },
1386    CustomProp {
1387        name: "size",
1388        id: P_SIZE,
1389        jsx_names: &["size"],
1390        lua_names: &["size"],
1391        jsx: "`size` (text)",
1392        lua: "`size`",
1393        c: "`KuiTextStyle.size`",
1394        odin: "`Text_Style.size`",
1395        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.",
1396    },
1397    CustomProp {
1398        name: "pad",
1399        id: P_PAD,
1400        jsx_names: &["pad", "padX", "padY", "padL", "padR", "padT", "padB"],
1401        lua_names: &["pad"],
1402        jsx: "`pad`, `padX`, `padY`, `padL`, `padR`, `padT`, `padB`",
1403        lua: "`pad = n` or `pad = { all=, x=, y=, l=, r=, t=, b= }`",
1404        c: "`pad_l`, `pad_r`, `pad_t`, `pad_b`",
1405        odin: "`Spec.pad`: `kui.pad(16)`, `kui.pad(16, 8)`, or `{l = .., r = .., t = .., b = ..}`",
1406        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.",
1407    },
1408    CustomProp {
1409        name: "border",
1410        id: P_BORDER,
1411        jsx_names: &["borderW", "borderColor"],
1412        lua_names: &["border"],
1413        jsx: "`borderW`, `borderColor`",
1414        lua: "`border = { w=, color= }`",
1415        c: "`border_w`, `border_color`",
1416        odin: "`Spec.border_w`, `Spec.border_color`",
1417        doc: "Border width and color (drawn inside the rect).",
1418    },
1419    CustomProp {
1420        name: "overflow",
1421        id: P_OVERFLOW,
1422        jsx_names: &["clip", "scrollX", "scrollY"],
1423        lua_names: &["clip", "scroll", "scroll_x", "scroll_y"],
1424        jsx: "`clip`, `scrollX`, `scrollY`",
1425        lua: "`clip`, `scroll_x`, `scroll_y` (`scroll` = `scroll_y`)",
1426        c: "`overflow` bits `KUI_CLIP` | `KUI_SCROLL_X` | `KUI_SCROLL_Y`",
1427        odin: "`Spec.overflow`: `{.Clip}`, `{.Scroll_X}`, `{.Scroll_Y}`",
1428        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).",
1429    },
1430    CustomProp {
1431        name: "float",
1432        id: P_FLOAT,
1433        jsx_names: &["float"],
1434        lua_names: &["float"],
1435        jsx: "`float=\"below\" | \"above\" | \"parent\" | \"viewport\"` or `{ anchor, at, self, dx, dy, fit, clip }`",
1436        lua: "`float = \"below\"` or `float = { anchor=, at=, self=, dx=, dy=, fit=, clip= }`",
1437        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",
1438        odin: "`Spec.float`, a `Float` (`mode`, `anchor_x/y`, `self_x/y`, `dx/dy`, `fit`, `clip`); `kui.float_preset` fills one from a preset name",
1439        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`).",
1440    },
1441    CustomProp {
1442        name: "keyFocus",
1443        id: P_KEY_FOCUS,
1444        jsx_names: &["keyFocus"],
1445        lua_names: &["key_focus"],
1446        jsx: "`keyFocus`",
1447        lua: "`key_focus`",
1448        c: "`kui_set_key_focus`",
1449        odin: "`Spec.key_focus`, which calls `kui.set_key_focus` on the node",
1450        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`).",
1451    },
1452    CustomProp {
1453        name: "key",
1454        id: P_KEY,
1455        jsx_names: &["key"],
1456        lua_names: &["key"],
1457        jsx: "`key`",
1458        lua: "`key`",
1459        c: "`kui_open_keyed` label",
1460        odin: "`Spec.key`, which opens the node keyed",
1461        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).",
1462    },
1463    CustomProp {
1464        name: "index",
1465        id: P_INDEX,
1466        jsx_names: &["index"],
1467        lua_names: &["index"],
1468        jsx: "`index`",
1469        lua: "`index`",
1470        c: "`kui_open_indexed`",
1471        odin: "`Spec.index`, a `Maybe(u64)`, which opens the node indexed",
1472        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.",
1473    },
1474    CustomProp {
1475        name: "rowCount",
1476        id: P_ROW_COUNT,
1477        jsx_names: &["rowCount"],
1478        lua_names: &["row_count"],
1479        jsx: "`rowCount`",
1480        lua: "`row_count`",
1481        c: "`kui_row_count`",
1482        odin: "`Spec.row_count`, a `Maybe(u64)`, which calls `kui.row_count` on the node",
1483        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.",
1484    },
1485    CustomProp {
1486        name: "title",
1487        id: P_TITLE,
1488        jsx_names: &["title"],
1489        lua_names: &["window_title"],
1490        jsx: "`title` (root box only)",
1491        lua: "`window_title` (root table)",
1492        c: "`kui_window_title`",
1493        odin: "`kui.window_title`",
1494        doc: "Declares the window title for this frame; the driver diffs and applies.",
1495    },
1496    CustomProp {
1497        name: "alwaysOnTop",
1498        id: P_ALWAYS_ON_TOP,
1499        jsx_names: &["alwaysOnTop"],
1500        lua_names: &["always_on_top"],
1501        jsx: "`alwaysOnTop` (root box only)",
1502        lua: "`always_on_top = true` (root table)",
1503        c: "`kui_set_always_on_top`",
1504        odin: "`kui.set_always_on_top`",
1505        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.",
1506    },
1507    CustomProp {
1508        name: "secureInput",
1509        id: P_SECURE_INPUT,
1510        jsx_names: &["secureInput"],
1511        lua_names: &["secure_input"],
1512        jsx: "`secureInput` (root box only)",
1513        lua: "`secure_input = true` (root table)",
1514        c: "`kui_set_secure_input`",
1515        odin: "`kui.set_secure_input`",
1516        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.",
1517    },
1518    CustomProp {
1519        name: "optionAsAlt",
1520        id: P_OPTION_AS_ALT,
1521        jsx_names: &["optionAsAlt"],
1522        lua_names: &["option_as_alt"],
1523        jsx: "`optionAsAlt=\"left\"` — `\"none\"`, `\"left\"`, `\"right\"`, `\"both\"` (root box only)",
1524        lua: "`option_as_alt = \"left\"` (root table)",
1525        c: "`kui_set_option_as_alt` (`KUI_OPTION_AS_ALT_*`)",
1526        odin: "`kui.set_option_as_alt` (an `Option_As_Alt`)",
1527        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.",
1528    },
1529    CustomProp {
1530        name: "imeOff",
1531        id: P_IME_OFF,
1532        jsx_names: &["imeOff"],
1533        lua_names: &["ime_off"],
1534        jsx: "`imeOff` (root box only)",
1535        lua: "`ime_off = true` (root table)",
1536        c: "`kui_set_ime_off`",
1537        odin: "`kui.set_ime_off`",
1538        doc: "Declares that this window takes the keyboard as keys, with the platform's input method off (backlog F125): no composition and no candidate window, and on a Mac no dead key waiting for the next and no press-and-hold — an input method too, so a held letter repeats instead of opening the accent picker, whatever the user's `ApplePressAndHoldEnabled` says. A `key` event's `text` is still the layout's character; what goes is everything the OS would have composed from it. What a modal editor's normal mode wants — `jjjj` is how one moves, and an IME left on eats the keymap — while its insert mode stops declaring it and gets accents, dead keys and the IME back. Frame state the way `alwaysOnTop` is, default false: declare it on every frame the mode wants it, and the frame that stops gives the input method back; the runner applies it to the window on change, never per frame, and a composition in progress when it turns off ends without a commit, as an empty `preedit`. The window's, not a node's: a stock editor focused under it composes nothing either. A popup's keys arrive through its owner, so the owner's declaration is the one they are read under. On Windows and Linux the window's IME is disabled the same way, and only that: their dead keys are the layout's, and still compose. A C host with its own loop reads the ask with `kui_ime_off_get` and applies it itself.",
1539    },
1540    CustomProp {
1541        name: "windows",
1542        id: P_WINDOWS,
1543        jsx_names: &["windows"],
1544        lua_names: &["windows"],
1545        jsx: "`windows={[{ name, kind?, anchor?, width?, height?, activates? }]}` (root box only; `windows: (model) => [...]` in the loop config)",
1546        lua: "`windows = { { name=, kind=, anchor=, width=, height=, activates= } }` (root table)",
1547        c: "`kui_window_declare`",
1548        odin: "`kui.window_declare`",
1549        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.",
1550    },
1551    CustomProp {
1552        name: "tooltip",
1553        id: P_TOOLTIP,
1554        jsx_names: &["tooltip"],
1555        lua_names: &["tooltip"],
1556        jsx: "`tooltip=\"hint\"`",
1557        lua: "`tooltip = \"hint\"`",
1558        c: "`KuiSpec.tooltip` (`kui_tooltip` / `kui_tooltip_with` draw a hint that is not hover-gated)",
1559        odin: "`Spec.tooltip` (`kui.tooltip` / `kui.tooltip_with` draw a hint that is not hover-gated)",
1560        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. On a box or a `fragment` the float is the node's last child; a leaf holds no children — a `line`, `polygon`, `path`, `cells` grid, `image` or `edit` — and its hint floats beside it instead, anchored to it, and lands below its box the same way, out of every clip and flipping above near the window's bottom (backlog RG113; `PropsOut::for_leaf`). A leaf draws its description, which is the hint unless a `description` applied after it overwrote the slot. A `line`, `polygon` or `path` is hovered by its shape, so its hint shows while the pointer is on the stroke or inside the outline, not anywhere in its box.",
1561    },
1562];
1563
1564/// Where a schema row lands in C when it is not simply the `KuiSpec` /
1565/// `KuiTextStyle` field of the row's snake_case name (`c_field`).
1566pub const C_FIELDS: &[(&str, &str)] = &[
1567    ("width", "`width` (KuiSizing)"),
1568    ("height", "`height` (KuiSizing)"),
1569    ("center", "`main_align` + `cross_align` = `KUI_CENTER`"),
1570    ("window", "`window_role` (`KUI_WINDOW_*`)"),
1571    ("transition", "`transition_ms`"),
1572    ("easing", "`easing` (`KUI_EASE_*`)"),
1573    (
1574        "keyframes",
1575        "`keyframes` + `keyframes_len` (`KuiKeyframe[]`)",
1576    ),
1577    ("gradient", "`gradient` (`const KuiGradient *`)"),
1578    ("repeat", "`repeat` (`KUI_REPEAT_*`)"),
1579    ("delay", "`delay_ms`"),
1580    ("enter", "`enter` (`KuiEnter`, with `set` bits)"),
1581    ("exit", "`exit` (`KuiEnter`, with `set` bits)"),
1582    ("opacity", "`opacity` with `opacity_set`"),
1583    ("radiusTL", "`radius_tl` with `per_corner`"),
1584    ("radiusTR", "`radius_tr` with `per_corner`"),
1585    ("radiusBR", "`radius_br` with `per_corner`"),
1586    ("radiusBL", "`radius_bl` with `per_corner`"),
1587    ("hoverGroup", "`hover_group` (KuiStr)"),
1588    ("role", "`role` (`KUI_ROLE_*`)"),
1589    ("expanded", "`expanded` (`KUI_EXPANDED_*`)"),
1590    ("live", "`live` (`KUI_LIVE_*`)"),
1591    ("cursor", "`cursor` (`KUI_CURSOR_*`)"),
1592    ("label", "`label` (KuiStr)"),
1593    (
1594        "valueNow",
1595        "`value_now` with `KUI_VALUE_NOW` in `value_set`",
1596    ),
1597    (
1598        "valueMin",
1599        "`value_min` with `KUI_VALUE_MIN` in `value_set`",
1600    ),
1601    (
1602        "valueMax",
1603        "`value_max` with `KUI_VALUE_MAX` in `value_set`",
1604    ),
1605    ("valueText", "`value_text` (KuiStr)"),
1606    ("caret", "`caret` with `KUI_VALUE_CARET` in `value_set`"),
1607    (
1608        "selectionAnchor",
1609        "`selection_anchor` with `KUI_VALUE_ANCHOR` in `value_set`",
1610    ),
1611    (
1612        "onClick",
1613        "`on_click` argument of `kui_open` / `kui_open_with`",
1614    ),
1615    (
1616        "onDrag",
1617        "`on_drag` argument of `kui_open_draggable` / `kui_open_with`",
1618    ),
1619    ("onKey", "`on_key` argument of `kui_open_with`"),
1620    (
1621        "onContextMenu",
1622        "`on_context_menu` (a borrowed `KuiValue*`, cloned while the node opens)",
1623    ),
1624    (
1625        "onButton",
1626        "`on_button` (a borrowed `KuiValue*`, cloned while the node opens)",
1627    ),
1628    (
1629        "buttons",
1630        "`buttons` (`KUI_BUTTONS_*` bits; zeroed, all three)",
1631    ),
1632    (
1633        "modal",
1634        "`modal` (a borrowed `KuiValue*`, cloned while the node opens)",
1635    ),
1636    (
1637        "onScroll",
1638        "`on_scroll` (a borrowed `KuiValue*`, cloned while the node opens)",
1639    ),
1640    ("onHover", "`on_hover` argument of `kui_open_with`"),
1641    (
1642        "onFocus",
1643        "`on_focus` (a borrowed `KuiValue*`, cloned while the node opens)",
1644    ),
1645    ("ruleWidth", "`rule_w`"),
1646    (
1647        "overscroll",
1648        "`overscroll` (`KUI_OVERSCROLL_*`; zeroed, auto)",
1649    ),
1650    (
1651        "scrollAxes",
1652        "`scroll_axes` (`KUI_SCROLL_AXES_*`; zeroed, both)",
1653    ),
1654    (
1655        "scrollMods",
1656        "`scroll_mods` (`KUI_KMOD_*` bits; zeroed, none)",
1657    ),
1658    (
1659        "onDrop",
1660        "`on_drop` (a borrowed `KuiValue*`, cloned while the node opens)",
1661    ),
1662    (
1663        "onLayout",
1664        "`on_layout` (a borrowed `KuiValue*`, cloned while the node opens)",
1665    ),
1666    ("family", "`KuiTextStyle.family` (`KUI_FONT_*`)"),
1667    ("font", "`KuiTextStyle.font` (from `kui_font_add*`)"),
1668    ("lineHeight", "`KuiTextStyle.line_height`"),
1669    ("wrap", "`KuiTextStyle.wrap` (`KUI_WRAP_*`)"),
1670    ("maxLines", "`KuiTextStyle.max_lines`"),
1671    ("ellipsis", "`KuiTextStyle.ellipsis`"),
1672    (
1673        "features",
1674        "`KuiTextStyle.features` (a `KuiStr`, the same spelling)",
1675    ),
1676    (
1677        "underline",
1678        "`KuiTextStyle.decoration` (`KUI_DECO_UNDERLINE`); `KuiSpan.flags` (`KUI_SPAN_UNDERLINE`)",
1679    ),
1680    (
1681        "strikethrough",
1682        "`KuiTextStyle.decoration` (`KUI_DECO_STRIKETHROUGH`); `KuiSpan.flags` (`KUI_SPAN_STRIKETHROUGH`)",
1683    ),
1684    (
1685        "underlineColor",
1686        "`KuiTextStyle.underline_color`; `KuiSpan.underline_color`",
1687    ),
1688    (
1689        "underlineStyle",
1690        "`KuiTextStyle.underline_style` (`KUI_UNDERLINE_*`); `KuiSpan.underline_style`",
1691    ),
1692    ("color", "`KuiTextStyle.color`"),
1693];
1694
1695/// The C spelling of a schema row, for docs.
1696pub fn c_field(def: &PropDef) -> String {
1697    C_FIELDS
1698        .iter()
1699        .find(|(n, _)| *n == def.name)
1700        .map(|(_, c)| (*c).to_string())
1701        .unwrap_or_else(|| format!("`{}`", def.snake_name()))
1702}
1703
1704/// The Odin spelling of a schema row: the `Spec` or `Text_Style` field of
1705/// its snake_case name, which is what the Odin generator names every field.
1706pub fn odin_field(def: &PropDef) -> String {
1707    let record = match def.target() {
1708        Target::Spec => "Spec",
1709        Target::Style => "Text_Style",
1710    };
1711    format!("`{record}.{}`", def.snake_name())
1712}
1713
1714/// A C cell in Odin's words, for the rows where Odin's door is C's: the
1715/// binding's procedures are kui.h's functions under `kui.` without their
1716/// `kui_`, and its node and text fields are `Spec.` / `Text_Style.`.
1717/// `RESOURCES` and `ENV_FIELDS` take their Odin column from here, and the
1718/// Odin generator checks each name it produces.
1719pub fn odin_from_c(c: &str) -> String {
1720    c.replace("kui_", "kui.")
1721        .replace("KuiSpec.", "Spec.")
1722        .replace("KuiTextStyle.", "Text_Style.")
1723}
1724
1725/// An element (node type) and its spelling in each binding. Elements are
1726/// hand-lowered per binding (their shapes differ: JSX children, Lua
1727/// tables, C calls with body callbacks), so this table is documentation
1728/// and a checklist, not a code generator's input.
1729pub struct ElementDef {
1730    pub name: &'static str,
1731    /// The props this element lowers itself, which are therefore in neither
1732    /// `PROPS` nor `CUSTOM`: `<edit initial multiline>`, `<image src>`. They
1733    /// ride in the same prop list as the node's, so a binding needs them to
1734    /// tell a legitimate element prop from a misspelling (see
1735    /// [`known_prop`]) — JSX's spellings here, Lua's below.
1736    pub jsx_own: &'static [&'static str],
1737    /// The same for a Lua node table.
1738    pub lua_own: &'static [&'static str],
1739    /// The schema rows this element reads, or `None` for every one. A
1740    /// composite whose look *is* its spec — the stock button, whose
1741    /// padding, colours and radius are `widgets::button_spec` — cannot take
1742    /// the whole prop list: `dir` alone rebuilds the spec from nothing. It
1743    /// names the rows it reads instead, and a binding drops the rest with a
1744    /// warning that says which rows it does take ([`known_prop`],
1745    /// `diag::unknown_prop`). JSX spellings here, Lua's below.
1746    pub jsx_rows: Option<&'static [&'static str]>,
1747    pub lua_rows: Option<&'static [&'static str]>,
1748    pub jsx: &'static str,
1749    pub lua: &'static str,
1750    pub c: &'static str,
1751    /// The Odin procedures (`kui.` and the name); checked by the Odin
1752    /// generator like the composites' column.
1753    pub odin: &'static str,
1754    pub doc: &'static str,
1755}
1756
1757/// The rows a `text` reads (`ElementDef::jsx_rows` / `lua_rows`): the
1758/// `TextStyle` rows and `size`, the composite the style is built from —
1759/// and nothing else, because every door lowers a text as content plus a
1760/// style and no spec (`Core::text_node`), so a container or access row
1761/// on it reaches no tree. Before AR13 the element admitted every shared
1762/// row, and `<text live="polite">`, `<text role="heading">`, `<text
1763/// label>` and `<text onClick>` were dropped silently by all four
1764/// bindings — no `unknown-prop`, and `live-region-without-name` could
1765/// never fire for them. Pinned equal to the `Target::Style` rows by a
1766/// test, so a style row added to `PROPS` is a row here or a red test.
1767pub const TEXT_ROWS_JSX: &[&str] = &[
1768    "size",
1769    "lineHeight",
1770    "color",
1771    "family",
1772    "font",
1773    "wrap",
1774    "maxLines",
1775    "ellipsis",
1776    "underline",
1777    "underlineColor",
1778    "underlineStyle",
1779    "strikethrough",
1780    "features",
1781];
1782pub const TEXT_ROWS_LUA: &[&str] = &[
1783    "size",
1784    "line_height",
1785    "color",
1786    "family",
1787    "font",
1788    "wrap",
1789    "max_lines",
1790    "ellipsis",
1791    "underline",
1792    "underline_color",
1793    "underline_style",
1794    "strikethrough",
1795    "features",
1796];
1797
1798/// The rows the stock button reads (`ElementDef::jsx_rows` / `lua_rows`):
1799/// the click, the identity (`key`, or `index` in a virtual list — declared
1800/// beside `key` the index wins, as on a box), the access
1801/// rows — what a button *is* and what a reader says of it — and the one
1802/// paint row it takes, `accent`, which is not a colour but a question put
1803/// to the OS. The two lists are the same rows in each spelling, index for
1804/// index.
1805pub const BUTTON_ROWS_JSX: &[&str] = &[
1806    "onClick",
1807    "key",
1808    "index",
1809    "label",
1810    "description",
1811    "tooltip",
1812    "disabled",
1813    "accent",
1814];
1815pub const BUTTON_ROWS_LUA: &[&str] = &[
1816    "on_click",
1817    "key",
1818    "index",
1819    "label",
1820    "description",
1821    "tooltip",
1822    "disabled",
1823    "accent",
1824];
1825
1826/// The rows a stock toggle — `checkbox`, `radio`, `switch` — reads
1827/// (`widgets::toggle_with`): the button's access rows, its state
1828/// and no layout or paint row, since its look is its spec. `mixed` means
1829/// something on a checkbox alone.
1830pub const TOGGLE_ROWS_JSX: &[&str] = &[
1831    "onClick",
1832    "key",
1833    "label",
1834    "description",
1835    "tooltip",
1836    "disabled",
1837    "checked",
1838    "mixed",
1839];
1840pub const TOGGLE_ROWS_LUA: &[&str] = &[
1841    "on_click",
1842    "key",
1843    "label",
1844    "description",
1845    "tooltip",
1846    "disabled",
1847    "checked",
1848    "mixed",
1849];
1850/// The rows the stock slider reads (`widgets::slider_with`): the
1851/// value rows, its change tag, the access rows, and its width — the one
1852/// piece of its look an app sizes.
1853pub const SLIDER_ROWS_JSX: &[&str] = &[
1854    "key",
1855    "label",
1856    "description",
1857    "tooltip",
1858    "disabled",
1859    "valueNow",
1860    "valueMin",
1861    "valueMax",
1862    "valueStep",
1863    "valueText",
1864    "onChange",
1865    "width",
1866    "minWidth",
1867    "maxWidth",
1868];
1869pub const SLIDER_ROWS_LUA: &[&str] = &[
1870    "key",
1871    "label",
1872    "description",
1873    "tooltip",
1874    "disabled",
1875    "value_now",
1876    "value_min",
1877    "value_max",
1878    "value_step",
1879    "value_text",
1880    "on_change",
1881    "width",
1882    "min_width",
1883    "max_width",
1884];
1885
1886pub const ELEMENTS: &[ElementDef] = &[
1887    ElementDef {
1888        name: "box",
1889        jsx_own: &[],
1890        lua_own: &[],
1891        jsx_rows: None,
1892        lua_rows: None,
1893        jsx: "`<box>`",
1894        lua: "`row { }`, `column { }`",
1895        c: "`kui_open*` … `kui_close`",
1896        odin: "`kui.box` / `kui.row` / `kui.column` in an `if`, closed at its end; `kui.open` … `kui.close` unscoped",
1897        doc: "A container: every container prop applies.",
1898    },
1899    ElementDef {
1900        name: "table",
1901        jsx_own: &[],
1902        lua_own: &[],
1903        jsx_rows: None,
1904        lua_rows: None,
1905        jsx: "`<box dir=\"table\">`",
1906        lua: "`grid { }`",
1907        c: "`kui_open*` with `dir = KUI_TABLE`",
1908        odin: "`kui.box` with `dir = .Table`",
1909        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.",
1910    },
1911    ElementDef {
1912        name: "text",
1913        jsx_own: &["bold", "italic", "bg", "bgRadius"],
1914        lua_own: &["value", "spans"],
1915        jsx_rows: Some(TEXT_ROWS_JSX),
1916        lua_rows: Some(TEXT_ROWS_LUA),
1917        jsx: "`<text>` with `<span bold italic underline strikethrough bg bgRadius color family font size>` children",
1918        lua: "`text(\"s\", {…})`, `text({ \"a\", { \"b\", bold = true, underline = true, bg = 0x.., bg_radius = 4 }, { \"code\", family = \"mono\", size = 13 } })`",
1919        c: "`kui_text`, `kui_rich_text`",
1920        odin: "`kui.text`, `kui.rich_text`",
1921        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 span takes a face and a size of its own: `family` (a stock name or an installed family's, as the text's) or `font` (a handle, which wins) — inline code in `mono` inside a sans paragraph — and `size` in logical px, its line height scaled at the paragraph's ratio (`Span::family` / `Span::mono` / `Span::size` in Rust, `KuiSpan.family` with `KUI_SPAN_FAMILY`, `.font` and `.size` in C). Its glyphs are shaped in that face, so a caret, a hit, a selection and the measurement read the same glyphs and byte positions stay exact across the change; a line is as tall as its tallest span, and a span's background is its own height around its glyphs. A paragraph with a sized span is shaped whole, never in chunks. 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.",
1922    },
1923    ElementDef {
1924        name: "button",
1925        jsx_own: &[],
1926        lua_own: &["text"],
1927        jsx_rows: Some(BUTTON_ROWS_JSX),
1928        lua_rows: Some(BUTTON_ROWS_LUA),
1929        jsx: "`<button onClick key|index label description tooltip disabled accent>`",
1930        lua: "`button { label=, on_click=, key= | index=, text=, description=, tooltip=, disabled=, accent= }`",
1931        c: "`kui_button`, `kui_button_with`",
1932        odin: "`kui.button`",
1933        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.",
1934    },
1935    ElementDef {
1936        name: "edit",
1937        jsx_own: &["id", "initial", "multiline", "autofocus"],
1938        lua_own: &["initial", "multiline", "autofocus"],
1939        jsx_rows: None,
1940        lua_rows: None,
1941        jsx: "`<edit key initial multiline autofocus>`, `<input label initial>`",
1942        lua: "`edit { key=, initial=, … }`, `input { label=, initial= }`",
1943        c: "`kui_text_edit`, `kui_text_input`",
1944        odin: "`kui.text_edit`, `kui.text_input`",
1945        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.",
1946    },
1947    ElementDef {
1948        name: "select",
1949        jsx_own: &["label", "options", "current"],
1950        lua_own: &["label", "options", "current"],
1951        // Its look is its own, like the button's, and it has no rows of
1952        // the box's to read: the three it takes are all its own.
1953        jsx_rows: Some(&[]),
1954        lua_rows: Some(&[]),
1955        jsx: "`<select label options={[…]} current>`",
1956        lua: "`dropdown { label=, options={…}, current= }`",
1957        c: "`kui_select`",
1958        odin: "`kui.select`",
1959        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.",
1960    },
1961    ElementDef {
1962        name: "checkbox",
1963        jsx_own: &[],
1964        lua_own: &["text"],
1965        jsx_rows: Some(TOGGLE_ROWS_JSX),
1966        lua_rows: Some(TOGGLE_ROWS_LUA),
1967        jsx: "`<checkbox checked mixed onClick key label description tooltip disabled>text</checkbox>`",
1968        lua: "`checkbox { label=, checked=, mixed=, on_click=, key=, text=, description=, tooltip=, disabled= }`",
1969        c: "`kui_checkbox`",
1970        odin: "`kui.checkbox`",
1971        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.",
1972    },
1973    ElementDef {
1974        name: "radio",
1975        jsx_own: &[],
1976        lua_own: &["text"],
1977        jsx_rows: Some(TOGGLE_ROWS_JSX),
1978        lua_rows: Some(TOGGLE_ROWS_LUA),
1979        jsx: "`<radio checked onClick key label description tooltip disabled>text</radio>`",
1980        lua: "`radio { label=, checked=, on_click=, key=, text=, description=, tooltip=, disabled= }`",
1981        c: "`kui_radio`",
1982        odin: "`kui.radio`",
1983        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.",
1984    },
1985    ElementDef {
1986        name: "radioGroup",
1987        jsx_own: &[],
1988        lua_own: &[],
1989        jsx_rows: None,
1990        lua_rows: None,
1991        jsx: "`<radioGroup label>…radios…</radioGroup>`",
1992        lua: "`radio_group { label=, … }`",
1993        c: "`kui_radio_group_open` … `kui_close`",
1994        odin: "`kui.radio_group` in an `if`, closed at its end",
1995        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.",
1996    },
1997    ElementDef {
1998        name: "switch",
1999        jsx_own: &[],
2000        lua_own: &["text"],
2001        jsx_rows: Some(TOGGLE_ROWS_JSX),
2002        lua_rows: Some(TOGGLE_ROWS_LUA),
2003        jsx: "`<switch checked onClick key label description tooltip disabled>text</switch>`",
2004        lua: "`switch { label=, checked=, on_click=, key=, text=, description=, tooltip=, disabled= }`",
2005        c: "`kui_switch`",
2006        odin: "`kui.toggle`",
2007        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.",
2008    },
2009    ElementDef {
2010        name: "slider",
2011        jsx_own: &[],
2012        lua_own: &[],
2013        jsx_rows: Some(SLIDER_ROWS_JSX),
2014        lua_rows: Some(SLIDER_ROWS_LUA),
2015        jsx: "`<slider label valueNow valueMin valueMax valueStep valueText onChange width description tooltip disabled/>`",
2016        lua: "`slider { label=, value_now=, value_min=, value_max=, value_step=, value_text=, on_change=, width=, … }`",
2017        c: "`kui_slider`",
2018        odin: "`kui.slider`",
2019        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.",
2020    },
2021    ElementDef {
2022        name: "image",
2023        jsx_own: &["src", "sampling", "fit"],
2024        lua_own: &["id", "sampling", "fit"],
2025        jsx_rows: None,
2026        lua_rows: None,
2027        jsx: "`<image src={id} sampling fit>`",
2028        lua: "`image { id=, sampling=, fit= }`",
2029        c: "`kui_image`, `kui_image_with`",
2030        odin: "`kui.image`, `kui.image_with`",
2031        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.",
2032    },
2033    ElementDef {
2034        name: "polygon",
2035        // `bg` is a schema row already; on a polygon it is the fill.
2036        jsx_own: &["points"],
2037        lua_own: &["points"],
2038        jsx_rows: None,
2039        lua_rows: None,
2040        jsx: "`<polygon points={[[x,y],…]} bg/>`",
2041        lua: "`polygon { points={{x,y},…}, bg= }`",
2042        c: "`kui_polygon`",
2043        odin: "`kui.polygon`, its points a `[][2]f32`",
2044        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.",
2045    },
2046    ElementDef {
2047        name: "path",
2048        // `bg` is a schema row already; on a path it is the fill. `width`
2049        // and `color` are rows too; on a path they are the stroke's, as on
2050        // a line.
2051        jsx_own: &["d", "fillRule", "rotate", "pivot", "dash", "dashOffset"],
2052        lua_own: &[
2053            "d",
2054            "ops",
2055            "fill_rule",
2056            "rotate",
2057            "pivot",
2058            "dash",
2059            "dash_offset",
2060        ],
2061        jsx_rows: None,
2062        lua_rows: None,
2063        jsx: "`<path d=\"M … Z\" bg width color fillRule rotate pivot dash dashOffset/>`",
2064        lua: "`path { d = \"M … Z\", bg=, width=, color=, fill_rule=, rotate=, pivot=, dash=, dash_offset= }`",
2065        c: "`kui_path`",
2066        odin: "`kui.path`, `kui.path_d`",
2067        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, a gap the dots overlap closed — 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.",
2068    },
2069    ElementDef {
2070        name: "fragment",
2071        jsx_own: &["src", "image", "params", "animate"],
2072        lua_own: &["id", "image", "params", "animate"],
2073        jsx_rows: None,
2074        lua_rows: None,
2075        jsx: "`<fragment src={id} image={id} params={[…]} animate>`",
2076        lua: "`fragment { id=, image=, params={…}, animate= }`",
2077        c: "`kui_fragment`, `kui_fragment_with`",
2078        odin: "`kui.fragment`, `kui.fragment_with`; `kui.fragment_open` in an `if` holds children",
2079        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.",
2080    },
2081    ElementDef {
2082        name: "cells",
2083        jsx_own: &[
2084            "rows",
2085            "cols",
2086            "cells",
2087            "cursorAt",
2088            "cursorShape",
2089            "cursorColor",
2090            "originLine",
2091        ],
2092        lua_own: &[
2093            "rows",
2094            "cols",
2095            "lines",
2096            "runs",
2097            "cursor_at",
2098            "cursor_shape",
2099            "cursor_color",
2100            "origin_line",
2101        ],
2102        jsx_rows: None,
2103        lua_rows: None,
2104        jsx: "`<cells rows cols cells={Uint32Array} cursorAt={[row, col]} cursorShape cursorColor size family lineHeight/>`",
2105        lua: "`cells { rows=, cols=, lines={\"row text\", …}, runs={{row, col, len, fg, bg, flags}, …}, cursor_at={row, col}, cursor_shape=, cursor_color=, size=, family= }`",
2106        c: "`kui_cells`",
2107        odin: "`kui.cells`",
2108        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.",
2109    },
2110    ElementDef {
2111        name: "line",
2112        // `width` and `color` are schema rows already (a sizing and the text
2113        // colour); on a line they are the stroke's width and colour.
2114        jsx_own: &["from", "to", "points", "curve", "dash", "dashOffset"],
2115        lua_own: &["from", "to", "points", "curve", "dash", "dash_offset"],
2116        jsx_rows: None,
2117        lua_rows: None,
2118        jsx: "`<line from={[x,y]} to={[x,y]} width color/>`, `<line points={[[x,y],…]} curve dash={[6, 4]} dashOffset/>`",
2119        lua: "`line { from={x,y}, to={x,y}, width=, color= }`, `line { points={{x,y},…}, curve=true, dash={6, 4}, dash_offset= }`",
2120        c: "`kui_line`, `kui_polyline`",
2121        odin: "`kui.line`, `kui.polyline` (points, `[][2]f32`)",
2122        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 up to 6 (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`). A mark no longer than the stroke is wide is a dot as wide as the stroke, in the same period, so its gap is that much shorter; where a mark and its gap together come to no more than the width the dots meet and the gap closes — the marks either side of it are one, and a pattern with no gap left, `dash` 2, 2 at a width of 8, draws solid (backlog RG118). 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.",
2123    },
2124    ElementDef {
2125        name: "titlebar",
2126        jsx_own: &[],
2127        // The window's own title is `window_title` on the root table; this
2128        // is the string the titlebar draws.
2129        lua_own: &["title"],
2130        jsx_rows: None,
2131        lua_rows: None,
2132        jsx: "`<titlebar title>` or `<titlebar>…</titlebar>`",
2133        lua: "`titlebar { title= }` / `titlebar { … }`",
2134        c: "`kui_titlebar`, `kui_titlebar_with`",
2135        odin: "`kui.titlebar`, `kui.titlebar_with`",
2136        doc: "Adaptive titlebar for custom chrome: drag strip, native-control inset, window buttons.",
2137    },
2138    ElementDef {
2139        name: "menuBar",
2140        jsx_own: &["menu"],
2141        lua_own: &["menu"],
2142        jsx_rows: None,
2143        lua_rows: None,
2144        jsx: "`<menuBar menu={[{ label, items: [{ label, id?, role?, accel?, enabled?, checked?, items? }] }]}/>`",
2145        lua: "`menu_bar { menu = { { label=, items= { { label=, id=, role=, accel=, enabled=, checked=, items= } } } } }`",
2146        c: "`kui_menu_bar`",
2147        odin: "`kui.menu_bar`",
2148        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.",
2149    },
2150    ElementDef {
2151        name: "windowButtons",
2152        jsx_own: &[],
2153        lua_own: &[],
2154        jsx_rows: None,
2155        lua_rows: None,
2156        jsx: "`<windowButtons/>`",
2157        lua: "`window_buttons()`",
2158        c: "`kui_window_buttons`",
2159        odin: "`kui.window_buttons`",
2160        doc: "Just the min/max/close buttons, for fully custom titlebars.",
2161    },
2162    ElementDef {
2163        name: "tooltip",
2164        jsx_own: &["value"],
2165        lua_own: &["value"],
2166        jsx_rows: None,
2167        lua_rows: None,
2168        jsx: "`<tooltip value=\"hint\"/>` / `<tooltip>…</tooltip>` nodes, or the `tooltip=\"hint\"` prop (see composites)",
2169        lua: "`tooltip(\"hint\")` / `tooltip { … }` nodes, or the prop",
2170        c: "`kui_tooltip`, `kui_tooltip_with`",
2171        odin: "`kui.tooltip`, `kui.tooltip_with`",
2172        doc: "A float hanging below the parent; the node form always draws, the prop form is hover-gated.",
2173    },
2174    ElementDef {
2175        name: "latencyGraph",
2176        jsx_own: &["at"],
2177        lua_own: &["at"],
2178        jsx_rows: None,
2179        lua_rows: None,
2180        jsx: "`<latencyGraph/>`, `<latencyHud at/>`",
2181        lua: "`latency_graph()`, `latency_hud { at= }`",
2182        c: "`kui_latency_graph`, `kui_latency_hud`",
2183        odin: "`kui.latency_graph`, `kui.latency_hud`",
2184        doc: "Per-phase frame timing (windowed drivers fill it; headless shows the chrome empty).",
2185    },
2186    ElementDef {
2187        name: "audio",
2188        jsx_own: &["src", "loop", "volume", "paused", "finish", "tag"],
2189        lua_own: &["src", "loop", "volume", "paused", "finish", "tag"],
2190        jsx_rows: None,
2191        lua_rows: None,
2192        jsx: "`<audio src={id} loop volume paused finish tag/>`",
2193        lua: "`audio { src=, loop=, volume=, paused=, finish=, tag= }`",
2194        c: "`kui_audio`",
2195        odin: "`kui.audio`",
2196        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.",
2197    },
2198];
2199
2200/// An event kind hosts receive, with its payload shape.
2201pub struct EventDef {
2202    pub kind: &'static str,
2203    pub payload: &'static str,
2204    pub doc: &'static str,
2205}
2206
2207pub const EVENTS: &[EventDef] = &[
2208    EventDef {
2209        kind: "click",
2210        payload: "the `onClick` payload as-is",
2211        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.",
2212    },
2213    EventDef {
2214        kind: "drag",
2215        payload: "`{ kind: \"drag\", phase: \"start\" | \"move\" | \"end\", x, y, dx, dy, parent: { x, y, w, h }, tag }`",
2216        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.",
2217    },
2218    EventDef {
2219        kind: "key",
2220        payload: "`{ kind: \"key\", phase: \"down\" | \"up\", code, physical, shift, ctrl, alt, super, text, repeat, location, caps_lock, num_lock, tag }`",
2221        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`.",
2222    },
2223    EventDef {
2224        kind: "text",
2225        payload: "`{ kind: \"text\", text, pasted?: true, concealed?: true, transient?: true, tag }`",
2226        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.",
2227    },
2228    EventDef {
2229        kind: "preedit",
2230        payload: "`{ kind: \"preedit\", text, cursor: [start, end] | null, tag }`",
2231        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.",
2232    },
2233    EventDef {
2234        kind: "selectionrange",
2235        payload: "`{ kind: \"selectionrange\", from: { index, byte }, to: { index, byte } }` on the scope",
2236        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.",
2237    },
2238    EventDef {
2239        kind: "contextmenu",
2240        payload: "`{ kind: \"contextmenu\", x, y, tag }`",
2241        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`.",
2242    },
2243    EventDef {
2244        kind: "menu",
2245        payload: "`{ kind: \"menu\", role, item }`",
2246        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).",
2247    },
2248    EventDef {
2249        kind: "forceclick",
2250        payload: "`{ kind: \"forceclick\", x, y, tag }`",
2251        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.",
2252    },
2253    EventDef {
2254        kind: "button",
2255        payload: "`{ kind: \"button\", phase: \"press\" | \"move\" | \"release\", button: \"secondary\" | \"middle\" | number, x, y, clicks, cell?: { row, col }, line?, byte?, tag }`",
2256        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.",
2257    },
2258    EventDef {
2259        kind: "scroll",
2260        payload: "`{ kind: \"scroll\", x, y, dx, dy, lines, mods?: { shift, ctrl, alt, super }, tag }`",
2261        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`).",
2262    },
2263    EventDef {
2264        kind: "focus",
2265        payload: "`{ kind: \"focus\", phase: \"in\" | \"out\", by: \"pointer\" | \"keyboard\" | \"assistive\" | \"program\", tag }`",
2266        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.",
2267    },
2268    EventDef {
2269        kind: "hover",
2270        payload: "`{ kind: \"hover\", phase: \"enter\" | \"leave\", by: \"pointer\" | \"content\", tag }`",
2271        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.",
2272    },
2273    EventDef {
2274        kind: "drop",
2275        payload: "`{ kind: \"drop\", phase: \"enter\" | \"move\" | \"leave\" | \"drop\", paths: string[], x, y, tag }`",
2276        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.",
2277    },
2278    EventDef {
2279        kind: "files",
2280        payload: "`{ kind: \"files\", paths: string[], tag }`",
2281        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.",
2282    },
2283    EventDef {
2284        kind: "open",
2285        payload: "`{ kind: \"open\", paths: string[] }` on the root",
2286        doc: "The OS asked the app to open documents (backlog F124): the Finder's Open With, a file dropped on the Dock icon, `open -a App file`, a double-click on a document of a type the app's `Info.plist` declares under `CFBundleDocumentTypes`. Delivered to the host on the root whether or not anything asked — unlike `files`, which answers an ask. `paths` are file-system paths as strings; a URL of a scheme the app registers is not one, and is not carried (room is left for a `urls` beside `paths`). The macOS runner sends it at launch — held until the main window has opened, since AppKit hands the documents over before it exists and puts none in the arguments — and while the app runs; a host driving its own window sends it as input (`openDocuments`, `kui_input_open`, `InputEvent::Open`). Windows and Linux pass documents in the process's arguments instead, and nothing sends it there.",
2287    },
2288    EventDef {
2289        kind: "layout",
2290        payload: "`{ kind: \"layout\", x, y, w, h, parent: { x, y, w, h }, scale, tag }`",
2291        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).",
2292    },
2293    EventDef {
2294        kind: "resize",
2295        payload: "`{ kind: \"resize\", width, height, scale }`",
2296        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.",
2297    },
2298    EventDef {
2299        kind: "window",
2300        payload: "`{ kind: \"window\", phase: \"opened\" | \"closed\" | \"focused\" | \"blurred\", name, id }`",
2301        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.",
2302    },
2303    EventDef {
2304        kind: "system",
2305        payload: "`{ kind: \"system\", appearance, accent, motion, locale, assistive }`",
2306        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.",
2307    },
2308    EventDef {
2309        kind: "fonts",
2310        payload: "`{ kind: \"fonts\" }`",
2311        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.",
2312    },
2313    EventDef {
2314        kind: "modifiers",
2315        payload: "`{ kind: \"modifiers\", shift, ctrl, alt, super }`",
2316        doc: "The physical modifier state changed (delivered to the host on the root).",
2317    },
2318    EventDef {
2319        kind: "changed",
2320        payload: "`{ kind: \"changed\" }`, with the editor's key on the event",
2321        doc: "An editor's text changed.",
2322    },
2323    EventDef {
2324        kind: "submit",
2325        payload: "`{ kind: \"submit\" }`, with the editor's key on the event",
2326        doc: "Enter in a single-line editor.",
2327    },
2328    EventDef {
2329        kind: "sound",
2330        payload: "`{ kind: \"sound\", phase: \"ended\" | \"refused\", playback, tag }`",
2331        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.",
2332    },
2333    EventDef {
2334        kind: "dismiss",
2335        payload: "`{ kind: \"dismiss\", reason: \"escape\" | \"outside\", tag }` on a node; `{ kind: \"dismiss\", reason, name, id }` on the root for a popup window",
2336        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.",
2337    },
2338    EventDef {
2339        kind: "access",
2340        payload: "`{ kind: \"access\", action, tag, text?, value?, anchor?: { line, offset }, focus?: { line, offset } }`",
2341        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.",
2342    },
2343    EventDef {
2344        kind: "change",
2345        payload: "`{ kind: \"change\", value, phase: \"move\" | \"end\", tag }`",
2346        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.",
2347    },
2348];
2349
2350/// A host-registered resource and how each binding registers it.
2351pub struct ResourceDef {
2352    pub what: &'static str,
2353    pub node: &'static str,
2354    pub lua: &'static str,
2355    pub c: &'static str,
2356}
2357
2358pub const RESOURCES: &[ResourceDef] = &[
2359    ResourceDef {
2360        what: "image",
2361        node: "`ctx.addImage(w, h, rgba)` → id for `<image src>`",
2362        lua: "the host registers; `image { id }`",
2363        c: "`kui_image_add` → `kui_image`",
2364    },
2365    ResourceDef {
2366        what: "fragment (WGSL)",
2367        node: "`ctx.addFragment(src)` → id for `<fragment src>`",
2368        lua: "the host registers; `fragment { id }`",
2369        c: "`kui_fragment_add` → `kui_fragment`",
2370    },
2371    ResourceDef {
2372        what: "font from bytes",
2373        node: "`ctx.addFont(buffer)` → id for `font`",
2374        lua: "the host registers; `font = id`",
2375        c: "`kui_font_add` → `KuiTextStyle.font`",
2376    },
2377    ResourceDef {
2378        what: "font file by path",
2379        node: "`ctx.loadFontFile(\"fonts/Antonio.ttf\")` → id for `font`",
2380        lua: "the host registers; `font = id`",
2381        c: "`kui_font_load_file`",
2382    },
2383    ResourceDef {
2384        what: "a folder of fonts",
2385        node: "`ctx.loadFontsDir(\"fonts\")`, then pick by name",
2386        lua: "the host loads",
2387        c: "`kui_font_load_dir`",
2388    },
2389    ResourceDef {
2390        what: "font by family name (installed or loaded)",
2391        node: "`ctx.addSystemFont(\"Antonio\")` (see `systemFontFamilies()`)",
2392        lua: "the host registers; `font = id`",
2393        c: "`kui_font_add_system` (see `kui_font_families`)",
2394    },
2395    ResourceDef {
2396        what: "sound (wav / ogg / mp3 / flac bytes)",
2397        node: "`ctx.addSound(buffer)` → id for `<audio src>`, `clickSound`, `play(id)`",
2398        lua: "the host registers; `audio { src = id }`, `click_sound = id`",
2399        c: "`kui_sound_add` → `kui_audio`, `KuiSpec.click_sound`, `kui_play`",
2400    },
2401];
2402
2403/// One value in the host-environment reading a view gets — `ui.env()` in
2404/// Rust, `view(env)` in Lua, `ctx.env()` / `win.env()` in Node — and the
2405/// key each binding puts it under. C has no reading: a C host is the frame
2406/// driver, so it is the *writer* (`kui_env_set`, `kui_env_set_window`), and
2407/// its column names the argument that carries the fact in.
2408///
2409/// `Env` and `WindowEnv` are the shape; this table is the cross-binding
2410/// restatement of it, and every restatement is pinned to it rather than
2411/// trusted: `schema`'s tests check the rows against the two structs, the
2412/// Lua and Node key-set tests check each binding's reading against the
2413/// `lua` / `node` columns, and kui-ffi checks the header's two prototypes
2414/// against the `c` column. The frame facts a view wants at the same moment
2415/// (the viewport, the focused node) ride in the same reading and have rows
2416/// here too, marked as the frame's rather than `Env`'s.
2417///
2418/// Two divergences are deliberate and named in their rows: `native_controls`
2419/// is the `Rect` the core holds in Node and a width/height at the window
2420/// origin in Lua and C, and `frame_budget_ms` is derived from `refresh_hz`
2421/// but part of the reading everywhere.
2422pub struct EnvField {
2423    /// The canonical name: the Rust field path (`window.custom_chrome`).
2424    pub name: &'static str,
2425    /// Where it comes from — the Rust struct and field for a stored fact,
2426    /// the call for a derived or frame fact.
2427    pub from: &'static str,
2428    /// The key path(s) it occupies in Node's `ctx.env()`; empty when Node
2429    /// carries the fact as a call on the context instead (the `doc` says
2430    /// which) or not at all.
2431    pub node: &'static [&'static str],
2432    /// The same for Lua's `view(env)` table. Two entries where Lua flattens
2433    /// one fact into two keys.
2434    pub lua: &'static [&'static str],
2435    /// The C spelling: `function(argument)` for the setter argument that
2436    /// writes it — the first thing in the cell, so kui-ffi can parse it —
2437    /// or the call that reads it.
2438    pub c: &'static str,
2439    pub doc: &'static str,
2440    /// The fact's reading, as plain data: `Null` for "the host cannot
2441    /// tell", an enum as its wire name, a key as its integer, a rect as
2442    /// `{x, y, w, h}`. What makes the table a reader and not only a pin —
2443    /// a binding iterates the rows and asks each for its value, then
2444    /// spells the key its own way, so a fact added here reaches every
2445    /// reading with no reader restated beside it (the way
2446    /// [`ThemeRole::get`] does for the palette).
2447    pub get: fn(&EnvFacts) -> Value,
2448}
2449
2450/// Everything an env reading is taken from: the stored [`Env`](crate::env::Env) and the
2451/// frame's own facts beside it (`Core::env_facts`).
2452#[derive(Clone, Copy, Debug)]
2453pub struct EnvFacts {
2454    pub env: crate::env::Env,
2455    pub viewport: crate::geom::Size,
2456    pub scale: f32,
2457    pub focus: Option<crate::key::Key>,
2458    pub focus_visible: bool,
2459    pub region: Option<crate::key::Key>,
2460    pub caret_visible: bool,
2461}
2462
2463fn key_value(k: Option<crate::key::Key>) -> Value {
2464    k.map_or(Value::Null, |k| Value::Int(k.0 as i64))
2465}
2466
2467fn rect_value(r: crate::geom::Rect) -> Value {
2468    Value::map([
2469        ("x", Value::Float(r.x as f64)),
2470        ("y", Value::Float(r.y as f64)),
2471        ("w", Value::Float(r.w as f64)),
2472        ("h", Value::Float(r.h as f64)),
2473    ])
2474}
2475
2476pub const ENV_FIELDS: &[EnvField] = &[
2477    EnvField {
2478        name: "refresh_hz",
2479        get: |f| {
2480            f.env
2481                .refresh_hz
2482                .map_or(Value::Null, |hz| Value::Float(hz as f64))
2483        },
2484        from: "`Env::refresh_hz`",
2485        node: &["refreshHz"],
2486        lua: &["refresh_hz"],
2487        c: "`kui_env_set(refresh_hz)`",
2488        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.",
2489    },
2490    EnvField {
2491        name: "frame_budget_ms",
2492        get: |f| Value::Float(f.env.frame_budget_ms() as f64),
2493        from: "`Env::frame_budget_ms()`, derived",
2494        node: &["frameBudgetMs"],
2495        lua: &["frame_budget_ms"],
2496        c: "—",
2497        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.",
2498    },
2499    EnvField {
2500        name: "focused",
2501        get: |f| Value::Bool(f.env.focused),
2502        from: "`Env::focused`",
2503        node: &["focused"],
2504        lua: &["focused"],
2505        c: "`kui_env_set(focused)`",
2506        doc: "Whether the *window* has the keyboard at all. Not the focused node — that is the `focus` row.",
2507    },
2508    EnvField {
2509        name: "system.appearance",
2510        get: |f| Value::str(f.env.system.appearance.name()),
2511        from: "`SystemEnv::appearance`",
2512        node: &["system.appearance"],
2513        lua: &["system.appearance"],
2514        c: "`kui_env_set_system(appearance)`",
2515        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.",
2516    },
2517    EnvField {
2518        name: "system.accent",
2519        get: |f| {
2520            f.env
2521                .system
2522                .accent
2523                .map_or(Value::Null, |c| Value::Int(c.to_hex() as i64))
2524        },
2525        from: "`SystemEnv::accent`",
2526        node: &["system.accent"],
2527        lua: &["system.accent"],
2528        c: "`kui_env_set_system(accent)`",
2529        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.",
2530    },
2531    EnvField {
2532        name: "system.motion",
2533        get: |f| Value::str(f.env.system.motion.name()),
2534        from: "`SystemEnv::motion`",
2535        node: &["system.motion"],
2536        lua: &["system.motion"],
2537        c: "`kui_env_set_system(motion)`",
2538        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.",
2539    },
2540    EnvField {
2541        name: "system.locale",
2542        get: |f| {
2543            f.env
2544                .system
2545                .locale
2546                .map_or(Value::Null, |l| Value::str(l.as_str()))
2547        },
2548        from: "`SystemEnv::locale`",
2549        node: &["system.locale"],
2550        lua: &["system.locale"],
2551        c: "`kui_env_set_system(locale)`",
2552        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.",
2553    },
2554    EnvField {
2555        name: "system.assistive",
2556        get: |f| Value::str(f.env.system.assistive.name()),
2557        from: "`SystemEnv::assistive`",
2558        node: &["system.assistive"],
2559        lua: &["system.assistive"],
2560        c: "`kui_env_set_assistive(assistive)`",
2561        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.",
2562    },
2563    EnvField {
2564        name: "window.id",
2565        get: |f| Value::Int(f.env.window.id.0 as i64),
2566        from: "`WindowEnv::id`",
2567        node: &["window.id"],
2568        lua: &["window.id"],
2569        c: "`kui_env_set_window(window)`, read back by `kui_ctx_window`",
2570        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.",
2571    },
2572    EnvField {
2573        name: "window.custom_chrome",
2574        get: |f| Value::Bool(f.env.window.custom_chrome),
2575        from: "`WindowEnv::custom_chrome`",
2576        node: &["window.customChrome"],
2577        lua: &["window.custom_chrome"],
2578        c: "`kui_env_set_window(custom_chrome)`",
2579        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.",
2580    },
2581    EnvField {
2582        name: "window.maximized",
2583        get: |f| Value::Bool(f.env.window.maximized),
2584        from: "`WindowEnv::maximized`",
2585        node: &["window.maximized"],
2586        lua: &["window.maximized"],
2587        c: "`kui_env_set_window(maximized)`",
2588        doc: "The window is maximized — what picks the restore glyph over the maximize one.",
2589    },
2590    EnvField {
2591        name: "window.fullscreen",
2592        get: |f| Value::Bool(f.env.window.fullscreen),
2593        from: "`WindowEnv::fullscreen`",
2594        node: &["window.fullscreen"],
2595        lua: &["window.fullscreen"],
2596        c: "`kui_env_set_window(fullscreen)`",
2597        doc: "The window is fullscreen.",
2598    },
2599    EnvField {
2600        name: "window.always_on_top",
2601        get: |f| Value::Bool(f.env.window.always_on_top),
2602        from: "`WindowEnv::always_on_top`",
2603        node: &["window.alwaysOnTop"],
2604        lua: &["window.always_on_top"],
2605        c: "`kui_env_set_always_on_top(always_on_top)`",
2606        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.",
2607    },
2608    EnvField {
2609        name: "window.native_controls",
2610        get: |f| f.env.window.native_controls.map_or(Value::Null, rect_value),
2611        from: "`WindowEnv::native_controls`",
2612        node: &["window.nativeControls"],
2613        lua: &["window.controls_w", "window.controls_h"],
2614        c: "`kui_env_set_window(controls_w, controls_h)`",
2615        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.",
2616    },
2617    EnvField {
2618        name: "window.backdrop",
2619        get: |f| Value::str(f.env.window.backdrop.name()),
2620        from: "`WindowEnv::backdrop`",
2621        node: &["window.backdrop"],
2622        lua: &["window.backdrop"],
2623        c: "`kui_env_set_backdrop(backdrop)`; read back with `kui_ctx_backdrop()`",
2624        doc: "What is behind the window's transparent pixels, as the driver got it (backlog F126): `\"opaque\"` (the default, and every headless core's), `\"transparent\"` (the desktop as it is), `\"blur\"` (a live blur of what is behind the window) or `\"tinted\"` (the desktop's colour, not live) — `KUI_BACKDROP_*` in C, opaque 0. The app asks with `Launcher::backdrop` and decides which regions show it by painting them with alpha; this is the answer, which is less where the platform has less — a blur asked of GNOME reads `\"tinted\"`, the wallpaper kui draws itself, or `\"opaque\"` where none could be read — so a view paints its translucent regions opaque when this says so. A C host reports it through its own setter, as `always_on_top` is; a C app asks with `KuiRunConfig.backdrop` and its view reads the answer with `kui_ctx_backdrop`.",
2625    },
2626    EnvField {
2627        name: "audio.device",
2628        get: |f| Value::str(f.env.audio.device.name()),
2629        from: "`AudioEnv::device`",
2630        node: &["audio.device"],
2631        lua: &["audio.device"],
2632        c: "`kui_env_set_audio(device)`",
2633        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.",
2634    },
2635    EnvField {
2636        name: "audio.live",
2637        get: |f| Value::Int(f.env.audio.live as i64),
2638        from: "`AudioEnv::live`",
2639        node: &["audio.live"],
2640        lua: &["audio.live"],
2641        c: "`kui_env_set_audio(live)`",
2642        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).",
2643    },
2644    EnvField {
2645        name: "viewport.w",
2646        get: |f| Value::Float(f.viewport.w as f64),
2647        from: "`Core::viewport()`, the frame's",
2648        node: &["viewport.width"],
2649        lua: &["viewport_w"],
2650        c: "`kui_frame_begin(w)`",
2651        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.",
2652    },
2653    EnvField {
2654        name: "viewport.h",
2655        get: |f| Value::Float(f.viewport.h as f64),
2656        from: "`Core::viewport()`, the frame's",
2657        node: &["viewport.height"],
2658        lua: &["viewport_h"],
2659        c: "`kui_frame_begin(h)`",
2660        doc: "Its logical height.",
2661    },
2662    EnvField {
2663        name: "scale",
2664        get: |f| Value::Float(f.scale as f64),
2665        from: "`Core::scale()`, the frame's",
2666        node: &["viewport.scale"],
2667        lua: &[],
2668        c: "`kui_frame_begin(scale)`",
2669        doc: "Device pixels per logical px. Lua has no reading: a script sees logical px only.",
2670    },
2671    EnvField {
2672        name: "focus",
2673        get: |f| key_value(f.focus),
2674        from: "`Core::focus()`, the frame's",
2675        node: &[],
2676        lua: &["focus"],
2677        c: "`kui_focused()`",
2678        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`.",
2679    },
2680    EnvField {
2681        name: "focus_visible",
2682        get: |f| Value::Bool(f.focus_visible),
2683        from: "`Core::focus_visible()`, the frame's",
2684        node: &[],
2685        lua: &["focus_visible"],
2686        c: "`kui_focus_visible()`",
2687        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.",
2688    },
2689    EnvField {
2690        name: "caret_visible",
2691        get: |f| Value::Bool(f.caret_visible),
2692        from: "`Core::caret_visible()`, the frame's",
2693        node: &[],
2694        lua: &["caret_visible"],
2695        c: "`kui_caret_visible()`",
2696        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).",
2697    },
2698    EnvField {
2699        name: "region",
2700        get: |f| key_value(f.region),
2701        from: "`Core::region()`, the frame's",
2702        node: &[],
2703        lua: &["region"],
2704        c: "`kui_region()`",
2705        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`.",
2706    },
2707];
2708
2709/// One colour role in a [`crate::theme::Theme`], with the spelling each
2710/// binding reads it under and the reading itself.
2711///
2712/// The same pin `ENV_FIELDS` is: the palette is one contract, so the roles
2713/// are written down once and every binding's reading is generated from
2714/// this table rather than restated beside it. `get` is what makes that
2715/// possible — a binding iterates the rows and asks each one for its
2716/// colour, so adding a token is one row here and nothing anywhere else.
2717/// The test below destructures [`crate::theme::Theme`] exhaustively, so a
2718/// field added to it stops the crate compiling until it has a row.
2719pub struct ThemeRole {
2720    /// The Rust field, and the name used everywhere but Node.
2721    pub name: &'static str,
2722    /// What Node calls it (camelCase).
2723    pub node: &'static str,
2724    pub doc: &'static str,
2725    /// This role's colour out of a theme.
2726    pub get: fn(&crate::theme::Theme) -> crate::color::Color,
2727    /// The same colour written: what a binding's theme setter uses, so
2728    /// writing a palette is the table's business the way reading one is.
2729    pub set: fn(&mut crate::theme::Theme, crate::color::Color),
2730}
2731
2732pub const THEME_ROLES: &[ThemeRole] = &[
2733    ThemeRole {
2734        name: "bg",
2735        node: "bg",
2736        get: |t| t.bg,
2737        set: |t, c| t.bg = c,
2738        doc: "The window behind everything.",
2739    },
2740    ThemeRole {
2741        name: "surface",
2742        node: "surface",
2743        get: |t| t.surface,
2744        set: |t, c| t.surface = c,
2745        doc: "A card, panel or list sitting on `bg`.",
2746    },
2747    ThemeRole {
2748        name: "raised",
2749        node: "raised",
2750        get: |t| t.raised,
2751        set: |t, c| t.raised = c,
2752        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.",
2753    },
2754    ThemeRole {
2755        name: "sunken",
2756        node: "sunken",
2757        get: |t| t.sunken,
2758        set: |t, c| t.sunken = c,
2759        doc: "A well cut into a surface: a text field, a code block, a track.",
2760    },
2761    ThemeRole {
2762        name: "border",
2763        node: "border",
2764        get: |t| t.border,
2765        set: |t, c| t.border = c,
2766        doc: "The hairline between two surfaces.",
2767    },
2768    ThemeRole {
2769        name: "border_strong",
2770        node: "borderStrong",
2771        get: |t| t.border_strong,
2772        set: |t, c| t.border_strong = c,
2773        doc: "A border that has to be seen — a float's edge, a focused field.",
2774    },
2775    ThemeRole {
2776        name: "fg",
2777        node: "fg",
2778        get: |t| t.fg,
2779        set: |t, c| t.fg = c,
2780        doc: "Body text, and what a `color`-less text run resolves to.",
2781    },
2782    ThemeRole {
2783        name: "muted",
2784        node: "muted",
2785        get: |t| t.muted,
2786        set: |t, c| t.muted = c,
2787        doc: "Secondary text: captions, hints, an accelerator beside a label.",
2788    },
2789    ThemeRole {
2790        name: "faint",
2791        node: "faint",
2792        get: |t| t.faint,
2793        set: |t, c| t.faint = c,
2794        doc: "Text that is barely there: a placeholder, a gutter number.",
2795    },
2796    ThemeRole {
2797        name: "accent",
2798        node: "accent",
2799        get: |t| t.accent,
2800        set: |t, c| t.accent = c,
2801        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.",
2802    },
2803    ThemeRole {
2804        name: "accent_hover",
2805        node: "accentHover",
2806        get: |t| t.accent_hover,
2807        set: |t, c| t.accent_hover = c,
2808        doc: "`accent` under a pointer.",
2809    },
2810    ThemeRole {
2811        name: "accent_pressed",
2812        node: "accentPressed",
2813        get: |t| t.accent_pressed,
2814        set: |t, c| t.accent_pressed = c,
2815        doc: "`accent` under a press.",
2816    },
2817    ThemeRole {
2818        name: "on_accent",
2819        node: "onAccent",
2820        get: |t| t.on_accent,
2821        set: |t, c| t.on_accent = c,
2822        doc: "Black or white — whichever a reader can see on `accent`. What a button's label is.",
2823    },
2824    ThemeRole {
2825        name: "accent_soft",
2826        node: "accentSoft",
2827        get: |t| t.accent_soft,
2828        set: |t, c| t.accent_soft = c,
2829        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.",
2830    },
2831    ThemeRole {
2832        name: "selection",
2833        node: "selection",
2834        get: |t| t.selection,
2835        set: |t, c| t.selection = c,
2836        doc: "What a text selection is painted under, in an editor and over a `selectable` scope alike.",
2837    },
2838    ThemeRole {
2839        name: "focus_ring",
2840        node: "focusRing",
2841        get: |t| t.focus_ring,
2842        set: |t, c| t.focus_ring = c,
2843        doc: "The default keyboard focus ring (ADR 0002).",
2844    },
2845    ThemeRole {
2846        name: "hover",
2847        node: "hover",
2848        get: |t| t.hover,
2849        set: |t, c| t.hover = c,
2850        doc: "A translucent wash over a hovered neutral control. An overlay, not a fill, so one value works on every surface.",
2851    },
2852    ThemeRole {
2853        name: "pressed",
2854        node: "pressed",
2855        get: |t| t.pressed,
2856        set: |t, c| t.pressed = c,
2857        doc: "The same over a pressed one, and the firmer of the two on both bases.",
2858    },
2859    ThemeRole {
2860        name: "success",
2861        node: "success",
2862        get: |t| t.success,
2863        set: |t, c| t.success = c,
2864        doc: "A good outcome. Readable on `surface` on both bases, which is why it is not one colour for both.",
2865    },
2866    ThemeRole {
2867        name: "warning",
2868        node: "warning",
2869        get: |t| t.warning,
2870        set: |t, c| t.warning = c,
2871        doc: "Something that wants attention.",
2872    },
2873    ThemeRole {
2874        name: "danger",
2875        node: "danger",
2876        get: |t| t.danger,
2877        set: |t, c| t.danger = c,
2878        doc: "A destructive action or a failure. The close button's hover, too.",
2879    },
2880    ThemeRole {
2881        name: "scrollbar",
2882        node: "scrollbar",
2883        get: |t| t.scrollbar,
2884        set: |t, c| t.scrollbar = c,
2885        doc: "The scrollbar thumb at rest.",
2886    },
2887    ThemeRole {
2888        name: "scrollbar_active",
2889        node: "scrollbarActive",
2890        get: |t| t.scrollbar_active,
2891        set: |t, c| t.scrollbar_active = c,
2892        doc: "The thumb while hovered or dragged.",
2893    },
2894];
2895
2896/// One size the stock widgets are built from (`crate::metrics::Metrics`), pinned the way [`ThemeRole`] pins a colour: a binding
2897/// iterates the rows to read or write a set, so a field added to
2898/// `Metrics` is one row here and nothing anywhere else. The test below
2899/// destructures the struct exhaustively.
2900pub struct MetricRole {
2901    /// The Rust field, and the name used everywhere but Node.
2902    pub name: &'static str,
2903    /// What Node calls it (camelCase).
2904    pub node: &'static str,
2905    pub doc: &'static str,
2906    pub get: fn(&crate::metrics::Metrics) -> f32,
2907    pub set: fn(&mut crate::metrics::Metrics, f32),
2908    /// `Some` for a row whose stock value is the platform's own rather
2909    /// than a density's: the value on Windows, then everywhere else.
2910    /// `get` answers for the running platform; a generator prints the
2911    /// pair, so `docs/props.md` reads the same whichever machine wrote it.
2912    /// Stock and compact share it — the test below pins
2913    /// that `compact()` leaves such a row alone.
2914    pub platform: Option<PlatformValue>,
2915}
2916
2917/// A metric's value per platform (see [`MetricRole::platform`]).
2918#[derive(Clone, Copy, Debug, PartialEq)]
2919pub struct PlatformValue {
2920    pub windows: f32,
2921    pub elsewhere: f32,
2922}
2923
2924impl PlatformValue {
2925    /// The member in force on the platform this was compiled for.
2926    pub const fn here(self) -> f32 {
2927        if cfg!(target_os = "windows") {
2928            self.windows
2929        } else {
2930            self.elsewhere
2931        }
2932    }
2933}
2934
2935macro_rules! metric_role {
2936    ($field:ident, $node:literal, $doc:literal) => {
2937        MetricRole {
2938            name: stringify!($field),
2939            node: $node,
2940            get: |m| m.$field,
2941            set: |m, v| m.$field = v,
2942            doc: $doc,
2943            platform: None,
2944        }
2945    };
2946    ($field:ident, $node:literal, $doc:literal, windows $w:expr, elsewhere $e:expr) => {
2947        MetricRole {
2948            name: stringify!($field),
2949            node: $node,
2950            get: |m| m.$field,
2951            set: |m, v| m.$field = v,
2952            doc: $doc,
2953            platform: Some(PlatformValue {
2954                windows: $w,
2955                elsewhere: $e,
2956            }),
2957        }
2958    };
2959}
2960
2961pub const METRIC_ROLES: &[MetricRole] = &[
2962    metric_role!(
2963        control_text,
2964        "controlText",
2965        "A stock control's label: the button's text size."
2966    ),
2967    metric_role!(
2968        chrome_text,
2969        "chromeText",
2970        "The chrome's text: a menu row, a menu-bar title, the titlebar's title."
2971    ),
2972    metric_role!(hint_text, "hintText", "A tooltip's text."),
2973    metric_role!(
2974        radius,
2975        "radius",
2976        "The corner of every stock surface: a button, a field, a menu, a tooltip."
2977    ),
2978    metric_role!(
2979        radius_inner,
2980        "radiusInner",
2981        "The corner of a row inside one: a menu row, a menu-bar title."
2982    ),
2983    metric_role!(
2984        control_pad_x,
2985        "controlPadX",
2986        "A button's horizontal padding."
2987    ),
2988    metric_role!(control_pad_y, "controlPadY", "A button's vertical padding."),
2989    metric_role!(
2990        field_pad_x,
2991        "fieldPadX",
2992        "A text field's horizontal padding."
2993    ),
2994    metric_role!(field_pad_y, "fieldPadY", "A text field's vertical padding."),
2995    metric_role!(hint_pad_x, "hintPadX", "A tooltip's horizontal padding."),
2996    metric_role!(hint_pad_y, "hintPadY", "A tooltip's vertical padding."),
2997    metric_role!(
2998        menu_pad_x,
2999        "menuPadX",
3000        "A menu row's horizontal padding, and a menu-bar title's."
3001    ),
3002    metric_role!(
3003        menu_pad_y,
3004        "menuPadY",
3005        "A menu row's vertical padding; a menu-bar title's is two px less."
3006    ),
3007    metric_role!(menu_width, "menuWidth", "A menu panel's width."),
3008    metric_role!(menu_bar_h, "menuBarH", "The drawn menu bar's height."),
3009    metric_role!(
3010        titlebar_h,
3011        "titlebarH",
3012        "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`).",
3013        windows crate::metrics::TITLEBAR_H_WINDOWS,
3014        elsewhere crate::metrics::TITLEBAR_H_ELSEWHERE
3015    ),
3016];
3017
3018static SNAKE_NAMES: LazyLock<Vec<&'static str>> = LazyLock::new(|| {
3019    PROPS
3020        .iter()
3021        .map(|d| Box::leak(snake_case(d.name).into_boxed_str()) as &'static str)
3022        .collect()
3023});
3024
3025/// `minWidth` → `min_width`, `radiusTL` → `radius_tl` (a run of capitals
3026/// is one word); names without capitals pass through.
3027pub fn snake_case(name: &str) -> String {
3028    let mut out = String::with_capacity(name.len() + 2);
3029    let mut prev_upper = false;
3030    for c in name.chars() {
3031        if c.is_ascii_uppercase() {
3032            if !prev_upper {
3033                out.push('_');
3034            }
3035            out.push(c.to_ascii_lowercase());
3036            prev_upper = true;
3037        } else {
3038            out.push(c);
3039            prev_upper = false;
3040        }
3041    }
3042    out
3043}
3044
3045pub fn by_name(name: &str) -> Option<&'static PropDef> {
3046    PROPS.iter().find(|d| d.name == name)
3047}
3048
3049pub fn by_snake_name(name: &str) -> Option<&'static PropDef> {
3050    SNAKE_NAMES
3051        .iter()
3052        .position(|n| *n == name)
3053        .map(|i| &PROPS[i])
3054}
3055
3056pub fn by_id(id: u32) -> Option<&'static PropDef> {
3057    PROPS.iter().find(|d| d.id == id)
3058}
3059
3060/// The spelling a binding writes prop names in: JSX's camelCase rows, or the
3061/// snake_case ones a Lua table takes. The allow-list below is per spelling,
3062/// so `hover_bg` in JSX and `hoverBg` in Lua are each as unknown as a typo —
3063/// which is what they are: neither binding reads the other's spelling.
3064#[derive(Clone, Copy, Debug, PartialEq, Eq)]
3065pub enum Spelling {
3066    Camel,
3067    Snake,
3068}
3069
3070/// A name one binding takes for a row it cannot spell the usual way, with
3071/// the row's own snake_case name: `repeat` is a Lua keyword, so that row
3072/// also answers to CSS's own name for it. The Lua binding remaps through
3073/// this table, and the check below accepts both sides of it.
3074pub const LUA_ALIASES: &[(&str, &str)] = &[("direction", "repeat")];
3075
3076/// `direction` → `repeat`: the schema name a Lua table key stands for, when
3077/// it is not the name itself.
3078pub fn lua_alias(name: &str) -> Option<&'static str> {
3079    LUA_ALIASES
3080        .iter()
3081        .find(|(alias, _)| *alias == name)
3082        .map(|(_, real)| *real)
3083}
3084
3085/// Every prop name that is not tied to one element, per spelling: the schema
3086/// rows, every spelling of every composite, and the aliases.
3087static SHARED_NAMES: LazyLock<[FxHashSet<&'static str>; 2]> = LazyLock::new(|| {
3088    let mut camel: FxHashSet<&'static str> = PROPS.iter().map(|d| d.name).collect();
3089    let mut snake: FxHashSet<&'static str> = PROPS.iter().map(|d| d.snake_name()).collect();
3090    for c in CUSTOM {
3091        camel.extend(c.jsx_names);
3092        snake.extend(c.lua_names);
3093    }
3094    snake.extend(LUA_ALIASES.iter().map(|(alias, _)| *alias));
3095    [camel, snake]
3096});
3097
3098fn shared_names(spelling: Spelling) -> &'static FxHashSet<&'static str> {
3099    &SHARED_NAMES[(spelling == Spelling::Snake) as usize]
3100}
3101
3102/// The props only this element takes, in `spelling`. An element the table
3103/// does not know has none.
3104pub fn element_own(element: &str, spelling: Spelling) -> &'static [&'static str] {
3105    match ELEMENTS.iter().find(|e| e.name == element) {
3106        Some(e) if spelling == Spelling::Camel => e.jsx_own,
3107        Some(e) => e.lua_own,
3108        None => &[],
3109    }
3110}
3111
3112/// The schema rows `element` reads, in `spelling`, when it does not read
3113/// them all (`ElementDef::jsx_rows`); `None` for an element that takes
3114/// every row, and for one the table does not know.
3115pub fn element_rows(element: &str, spelling: Spelling) -> Option<&'static [&'static str]> {
3116    let e = ELEMENTS.iter().find(|e| e.name == element)?;
3117    if spelling == Spelling::Camel {
3118        e.jsx_rows
3119    } else {
3120        e.lua_rows
3121    }
3122}
3123
3124/// Is `name` a row every element reads — a schema row, a composite, an
3125/// alias — as opposed to a misspelling? What [`known_prop`] answers for an
3126/// element that admits only some rows still depends on this: a row the
3127/// element does not read is dropped like a misspelling, but the warning
3128/// can say so instead of hunting for a nearer spelling.
3129pub fn shared_prop(name: &str, spelling: Spelling) -> bool {
3130    shared_names(spelling).contains(name)
3131}
3132
3133/// Is `name` a prop `element` reads — a schema row, a composite, an alias,
3134/// or one of the element's own? A binding drops everything else on the
3135/// floor, so everything else is a `diag::UNKNOWN_PROP` warning. An element
3136/// that names its rows reads those and its own, and nothing else.
3137pub fn known_prop(element: &str, name: &str, spelling: Spelling) -> bool {
3138    if element_own(element, spelling).contains(&name) {
3139        return true;
3140    }
3141    match element_rows(element, spelling) {
3142        Some(rows) => rows.contains(&name),
3143        None => shared_names(spelling).contains(name),
3144    }
3145}
3146
3147/// The name an unknown one was probably meant to be: the same word in the
3148/// other convention (`hoverBg` for `hover_bg`, `onClick` for `onclick`),
3149/// which is what a wrong spelling almost always is. Nothing fuzzier — a
3150/// confident suggestion or none.
3151pub fn suggest(element: &str, name: &str, spelling: Spelling) -> Option<&'static str> {
3152    let squash = |s: &str| s.replace('_', "").to_ascii_lowercase();
3153    let want = squash(name);
3154    let near = |c: &&&str| squash(c) == want;
3155    let own = element_own(element, spelling).iter();
3156    // An element that names its rows is not sent to a row it would drop.
3157    match element_rows(element, spelling) {
3158        Some(rows) => rows.iter().chain(own).find(near).copied(),
3159        None => shared_names(spelling).iter().chain(own).find(near).copied(),
3160    }
3161}
3162
3163/// A parsed prop value, transport-independent.
3164pub enum Parsed {
3165    F32(f32),
3166    Color(Color),
3167    Flag,
3168    Enum(usize),
3169    Sizing(Sizing),
3170    /// A `Min` or a `Max` row's clamp.
3171    Bound(Bound),
3172    Msg(Value),
3173    Str(String),
3174    Resource(u64),
3175    Keyframes(Vec<Keyframe>),
3176    Enter(Enter),
3177    Gradient(crate::gradient::Gradient),
3178    /// A family, already resolved by the parser (`NameRefs::family`).
3179    Family(FontFamily),
3180}
3181
3182/// Everything a prop list can carry; elements pick the parts they use.
3183#[derive(Clone, Debug, PartialEq)]
3184pub struct PropsOut {
3185    pub spec: NodeSpec,
3186    pub style: TextStyle,
3187    pub key: Option<String>,
3188    /// `index`: the data index this node is opened under, which beats `key`
3189    /// when a binding is handed both.
3190    pub index: Option<u64>,
3191    /// `rowCount`: how many indexed rows the node's virtual list has
3192    /// (`Core::row_count`).
3193    pub row_count: Option<u64>,
3194    pub title: Option<String>,
3195    /// `alwaysOnTop`: the root asked for the window above every other
3196    /// app's this frame (`Core::set_always_on_top`).
3197    pub always_on_top: bool,
3198    /// `secureInput`: the root asked for secure keyboard entry while the
3199    /// window has the keyboard (`Core::set_secure_input`).
3200    pub secure_input: bool,
3201    /// `optionAsAlt`: which Option keys the root asked to act as Alt this
3202    /// frame (`Core::set_option_as_alt`).
3203    pub option_as_alt: crate::OptionAsAlt,
3204    /// `imeOff`: the root asked for the platform's input method off in
3205    /// its window this frame (`Core::set_ime_off`).
3206    pub ime_off: bool,
3207    pub key_focus: bool,
3208    /// Hover hint: the element lowering floats `widgets::tooltip` below the
3209    /// node while it is hovered (the parser also marks the spec hoverable).
3210    pub tooltip: Option<String>,
3211    /// The windows the root declared (`Core::declare_window`, in order).
3212    pub windows: Vec<(String, WindowConfig)>,
3213    /// Whether the `wrap` row was declared: the mode is in `style.wrap`,
3214    /// whose default is `Word`, so the style alone cannot say. A
3215    /// single-line editor folds to its width when it was
3216    /// (`EditOptions::wrap`); nothing else reads it.
3217    pub wrap: bool,
3218}
3219
3220/// Which key a prop list opens its node under: the next auto key, the
3221/// `key` label, or — beating the label when a binding is handed both — the
3222/// `index` a virtual list opens its rows by.
3223#[derive(Clone, Copy, Debug, PartialEq)]
3224pub enum Identity<'a> {
3225    Auto,
3226    Label(&'a str),
3227    Index(u64),
3228}
3229
3230impl PropsOut {
3231    /// The identity the list gave the node (see [`Identity`]).
3232    pub fn identity(&self) -> Identity<'_> {
3233        match (self.index, &self.key) {
3234            (Some(i), _) => Identity::Index(i),
3235            (None, Some(label)) => Identity::Label(label),
3236            (None, None) => Identity::Auto,
3237        }
3238    }
3239
3240    pub fn new() -> Self {
3241        PropsOut {
3242            spec: NodeSpec::column(),
3243            style: TextStyle::new(16.0),
3244            key: None,
3245            index: None,
3246            row_count: None,
3247            title: None,
3248            always_on_top: false,
3249            secure_input: false,
3250            option_as_alt: crate::OptionAsAlt::None,
3251            ime_off: false,
3252            key_focus: false,
3253            tooltip: None,
3254            windows: Vec::new(),
3255            wrap: false,
3256        }
3257    }
3258
3259    /// Applies a builder step to the spec in place.
3260    pub fn with_spec(&mut self, f: impl FnOnce(NodeSpec) -> NodeSpec) {
3261        self.spec = f(std::mem::take(&mut self.spec));
3262    }
3263
3264    /// All three effects of the `tooltip` prop at once: hover tracking and
3265    /// the accessible description (both [`NodeSpec::apply_tooltip`]), plus
3266    /// the hint the element lowering floats. A parser that only extracted
3267    /// the string cannot end up implementing two of the three.
3268    pub fn apply_tooltip(&mut self, hint: impl Into<String>) {
3269        let hint = hint.into();
3270        self.with_spec(|s| s.apply_tooltip(&hint));
3271        self.tooltip = Some(hint);
3272    }
3273
3274    /// The list for a leaf — a `line`, `polygon`, `path`, `cells` grid,
3275    /// `image` or `edit` — whose `tooltip` the core floats beside it rather
3276    /// than as its last child, since a leaf holds none (backlog RG113): the
3277    /// spec asks for the hint drawn ([`crate::spec::AccessSpec::tooltip`]), and
3278    /// the leaf's door floats it while the leaf is hovered. `Core::open_from`
3279    /// calls it for the leaves it opens; a binding that lowers an `image`
3280    /// or an `edit` through its own door calls it before handing the spec
3281    /// over. A list with no tooltip comes back as it went in.
3282    pub fn for_leaf(mut self) -> Self {
3283        if self.tooltip.is_some() {
3284            self.spec.access_mut().tooltip = true;
3285        }
3286        self
3287    }
3288
3289    /// Resolves the `pad` shorthand family and applies it — a no-op when the
3290    /// frontend saw none of the seven names, so a spec built from another
3291    /// source keeps its padding.
3292    pub fn apply_pad(&mut self, pad: PadShorthand) {
3293        if pad.declared() {
3294            let edges = pad.resolve();
3295            self.with_spec(|s| s.padding(edges));
3296        }
3297    }
3298}
3299
3300impl Default for PropsOut {
3301    fn default() -> Self {
3302        Self::new()
3303    }
3304}
3305
3306/// Applies one parsed value through its row. Errors on a kind mismatch,
3307/// which can only come from a transport bug (each transport parses by the
3308/// same `Kind`).
3309pub fn apply(def: &PropDef, value: Parsed, out: &mut PropsOut) -> Result<(), String> {
3310    let spec = std::mem::take(&mut out.spec);
3311    let style = out.style;
3312    // Declared at all is a fact of its own for one element (see
3313    // `PropsOut::wrap`); the mode still lands in the style below.
3314    out.wrap |= def.id == P_WRAP;
3315    match (&def.apply, value) {
3316        (Apply::SpecF32(f), Parsed::F32(v)) => out.spec = f(spec, v),
3317        (Apply::SpecColor(f), Parsed::Color(v)) => out.spec = f(spec, v),
3318        (Apply::SpecFlag(f), Parsed::Flag) => out.spec = f(spec),
3319        (Apply::SpecEnum(f), Parsed::Enum(v)) => out.spec = f(spec, v),
3320        (Apply::SpecSizing(f), Parsed::Sizing(v)) => out.spec = f(spec, v),
3321        (Apply::SpecBound(f), Parsed::Bound(v)) => out.spec = f(spec, v),
3322        (Apply::SpecMsg(f), Parsed::Msg(v)) => out.spec = f(spec, v),
3323        (Apply::SpecStr(f), Parsed::Str(v)) => out.spec = f(spec, &v),
3324        (Apply::SpecKeyframes(f), Parsed::Keyframes(v)) => out.spec = f(spec, v),
3325        (Apply::SpecEnter(f), Parsed::Enter(v)) => out.spec = f(spec, v),
3326        (Apply::SpecGradient(f), Parsed::Gradient(v)) => out.spec = f(spec, v),
3327        (Apply::SpecResource(f), Parsed::Resource(v)) => out.spec = f(spec, v),
3328        (Apply::StyleF32(f), Parsed::F32(v)) => {
3329            out.spec = spec;
3330            out.style = f(style, v);
3331        }
3332        (Apply::StyleColor(f), Parsed::Color(v)) => {
3333            out.spec = spec;
3334            out.style = f(style, v);
3335        }
3336        (Apply::StyleEnum(f), Parsed::Enum(v)) => {
3337            out.spec = spec;
3338            out.style = f(style, v);
3339        }
3340        (Apply::StyleFlag(f), Parsed::Flag) => {
3341            out.spec = spec;
3342            out.style = f(style);
3343        }
3344        (Apply::StyleResource(f), Parsed::Resource(v)) => {
3345            out.spec = spec;
3346            out.style = f(style, v);
3347        }
3348        (Apply::StyleStr(f), Parsed::Str(v)) => {
3349            out.spec = spec;
3350            out.style = f(style, &v);
3351        }
3352        (Apply::StyleFamily(f), Parsed::Family(v)) => {
3353            out.spec = spec;
3354            out.style = f(style, v);
3355        }
3356        _ => {
3357            out.spec = spec;
3358            return Err(format!("prop {} value/kind mismatch", def.name));
3359        }
3360    }
3361    Ok(())
3362}
3363
3364/// Looks an enum name up in its row's list.
3365pub fn enum_index(names: &[&str], s: &str) -> Result<usize, String> {
3366    names
3367        .iter()
3368        .position(|n| *n == s)
3369        .ok_or_else(|| format!("bad value {s:?} (one of {names:?})"))
3370}
3371
3372// ---------------------------------------------------------------------------
3373// Value parsing shared by transports
3374
3375/// 0 = transparent, anything else 0xRRGGBBAA.
3376pub fn color_num(hex: u32) -> Color {
3377    if hex == 0 {
3378        Color::TRANSPARENT
3379    } else {
3380        Color::hex(hex)
3381    }
3382}
3383
3384/// `#rgb` / `#rrggbb` / `#rrggbbaa`.
3385pub fn color_hex_str(s: &str) -> Result<Color, String> {
3386    let bad = || format!("bad color {s:?}");
3387    let hex = s.strip_prefix('#').ok_or_else(bad)?;
3388    let expanded = match hex.len() {
3389        3 => hex
3390            .chars()
3391            .flat_map(|c| [c, c])
3392            .chain("ff".chars())
3393            .collect::<String>(),
3394        6 => format!("{hex}ff"),
3395        8 => hex.to_string(),
3396        _ => return Err(bad()),
3397    };
3398    let n = u32::from_str_radix(&expanded, 16).map_err(|_| bad())?;
3399    Ok(Color::hex(n))
3400}
3401
3402/// The mode a sizing's, a min's or a max's first binary slot holds for a
3403/// size expression, whose spelling follows as a strref (v19).
3404pub const SIZE_MODE_CALC: u32 = 4;
3405
3406/// The mode for a size expression as data: a count of slots follows,
3407/// then the expression in prefix code ([`crate::calc::from_code`]) —
3408/// what the Node encoder sends for `{ clamp: [...] }`, so the addon
3409/// reads numbers and parses no text (v19).
3410pub const SIZE_MODE_TREE: u32 = 5;
3411
3412/// The string forms of a min: `"fit"`, or a size expression
3413/// ([`crate::calc`]). A number arrives as a number.
3414pub fn min_str(s: &str) -> Result<Bound, String> {
3415    match s {
3416        "fit" => Ok(Bound::Fit),
3417        _ => crate::calc::bound(s)
3418            .map_err(|e| format!("bad min {s:?} (number | \"fit\" | a size expression): {e}")),
3419    }
3420}
3421
3422/// The string forms of a max: a size expression.
3423pub fn max_str(s: &str) -> Result<Bound, String> {
3424    crate::calc::bound(s).map_err(|e| format!("bad max {s:?} (number | a size expression): {e}"))
3425}
3426
3427/// The string forms of a sizing: "fit" | "grow" | "N%" | a size
3428/// expression ([`crate::calc`]).
3429pub fn sizing_str(s: &str) -> Result<Sizing, String> {
3430    match s {
3431        "fit" => Ok(Sizing::Fit),
3432        "grow" => Ok(Sizing::Grow(1.0)),
3433        _ => crate::calc::sizing(s).map_err(|e| {
3434            format!("bad sizing {s:?} (fit | grow | number | \"N%\" | a size expression): {e}")
3435        }),
3436    }
3437}
3438
3439#[cfg(test)]
3440mod tests {
3441    use super::*;
3442
3443    /// An enum row's name list is the wire order — a binding sends the
3444    /// index — so each list is its enum's `ALL` by `name`, and the index
3445    /// map is a lookup in `ALL` and not a second table (`Easing`, `Repeat`, `Live` and `FontFamily` were hand maps that a
3446    /// variant appended or a list reordered put one off, with nothing to
3447    /// say so). `CURSORS` has the same pin in `cursor.rs`, `ROLES` its
3448    /// own below.
3449    #[test]
3450    fn every_enum_list_is_its_enum_s_all_by_name() {
3451        fn names(it: &[&'static str]) -> Vec<&'static str> {
3452            it.to_vec()
3453        }
3454        assert_eq!(
3455            Easing::ALL.iter().map(|e| e.name()).collect::<Vec<_>>(),
3456            names(EASINGS)
3457        );
3458        assert_eq!(
3459            Repeat::ALL.iter().map(|r| r.name()).collect::<Vec<_>>(),
3460            names(REPEATS)
3461        );
3462        assert_eq!(
3463            crate::access::Live::ALL
3464                .iter()
3465                .map(|l| l.name())
3466                .collect::<Vec<_>>(),
3467            names(LIVE)
3468        );
3469        assert_eq!(
3470            FontFamily::ALL
3471                .iter()
3472                .map(|f| f.name().expect("a stock family has a name"))
3473                .collect::<Vec<_>>(),
3474            names(FAMILIES)
3475        );
3476        // And the index map round-trips through the list, every index.
3477        for (i, e) in Easing::ALL.iter().enumerate() {
3478            assert_eq!(easing_idx(i), *e);
3479        }
3480        for (i, r) in Repeat::ALL.iter().enumerate() {
3481            assert_eq!(repeat_idx(i), *r);
3482        }
3483        for (i, l) in crate::access::Live::ALL.iter().enumerate() {
3484            assert_eq!(crate::access::Live::from_index(i), *l);
3485        }
3486        for (i, f) in FontFamily::ALL.iter().enumerate() {
3487            assert_eq!(FontFamily::from_index(i), *f);
3488        }
3489        // An index this build lacks is the default, not a panic.
3490        assert_eq!(easing_idx(99), Easing::default());
3491        assert_eq!(repeat_idx(99), Repeat::default());
3492        assert_eq!(FontFamily::from_index(99), FontFamily::Sans);
3493    }
3494
3495    #[test]
3496    fn ids_and_names_are_unique() {
3497        let all: Vec<(&str, u32)> = PROPS
3498            .iter()
3499            .map(|d| (d.name, d.id))
3500            .chain(CUSTOM.iter().map(|c| (c.name, c.id)))
3501            .collect();
3502        for (i, (name, id)) in all.iter().enumerate() {
3503            for (other_name, other_id) in &all[i + 1..] {
3504                assert_ne!(name, other_name, "duplicate prop name");
3505                assert_ne!(id, other_id, "duplicate wire id for {name} / {other_name}");
3506            }
3507        }
3508    }
3509
3510    /// `menu_bar_h` → `menuBarH`: what a role's Node spelling is.
3511    fn snake_to_camel(name: &str) -> String {
3512        let mut out = String::new();
3513        let mut up = false;
3514        for ch in name.chars() {
3515            if ch == '_' {
3516                up = true;
3517            } else if up {
3518                out.extend(ch.to_uppercase());
3519                up = false;
3520            } else {
3521                out.push(ch);
3522            }
3523        }
3524        out
3525    }
3526
3527    /// `METRIC_ROLES` restates `Metrics` the way `THEME_ROLES` restates
3528    /// `Theme`, and this is the same pin: an exhaustive pattern on the
3529    /// struct, then the names both ways.
3530    #[test]
3531    fn metric_roles_restate_the_metrics_exactly() {
3532        use crate::metrics::Metrics;
3533        let m = Metrics::compact();
3534        let Metrics {
3535            control_text,
3536            chrome_text,
3537            hint_text,
3538            radius,
3539            radius_inner,
3540            control_pad_x,
3541            control_pad_y,
3542            field_pad_x,
3543            field_pad_y,
3544            hint_pad_x,
3545            hint_pad_y,
3546            menu_pad_x,
3547            menu_pad_y,
3548            menu_width,
3549            menu_bar_h,
3550            titlebar_h,
3551        } = m;
3552        let fields: &[(&str, f32)] = &[
3553            ("control_text", control_text),
3554            ("chrome_text", chrome_text),
3555            ("hint_text", hint_text),
3556            ("radius", radius),
3557            ("radius_inner", radius_inner),
3558            ("control_pad_x", control_pad_x),
3559            ("control_pad_y", control_pad_y),
3560            ("field_pad_x", field_pad_x),
3561            ("field_pad_y", field_pad_y),
3562            ("hint_pad_x", hint_pad_x),
3563            ("hint_pad_y", hint_pad_y),
3564            ("menu_pad_x", menu_pad_x),
3565            ("menu_pad_y", menu_pad_y),
3566            ("menu_width", menu_width),
3567            ("menu_bar_h", menu_bar_h),
3568            ("titlebar_h", titlebar_h),
3569        ];
3570        assert_eq!(METRIC_ROLES.len(), fields.len(), "a metric has no row");
3571        for (name, value) in fields {
3572            let row = METRIC_ROLES
3573                .iter()
3574                .find(|r| r.name == *name)
3575                .unwrap_or_else(|| panic!("no METRIC_ROLES row for {name}"));
3576            assert_eq!((row.get)(&m), *value, "{name}'s row reads another field");
3577            let mut w = m;
3578            (row.set)(&mut w, 1.0);
3579            assert_eq!((row.get)(&w), 1.0, "{name}'s row writes another field");
3580        }
3581        for row in METRIC_ROLES {
3582            assert!(
3583                fields.iter().any(|(n, _)| *n == row.name),
3584                "METRIC_ROLES names a field Metrics does not have: {}",
3585                row.name
3586            );
3587            let camel = snake_to_camel(row.name);
3588            assert_eq!(row.node, camel, "{}'s Node spelling", row.name);
3589            // A platform row's pair is what the struct reads on this
3590            // platform, in both sets: the generator prints the pair for
3591            // both columns on the strength of this.
3592            if let Some(p) = row.platform {
3593                assert_eq!(
3594                    (row.get)(&Metrics::default()),
3595                    p.here(),
3596                    "{}'s stock value",
3597                    row.name
3598                );
3599                assert_eq!(
3600                    (row.get)(&m),
3601                    p.here(),
3602                    "{}: compact leaves a platform row alone",
3603                    row.name
3604                );
3605            }
3606        }
3607        assert!(
3608            METRIC_ROLES.iter().any(|r| r.platform.is_some()),
3609            "titlebar_h is the platform's; its row says so"
3610        );
3611    }
3612
3613    /// `THEME_ROLES` restates `Theme`; this pins the two together the way
3614    /// `ENV_FIELDS` pins `Env`. The exhaustive pattern is the pin on the
3615    /// struct — a role added to `Theme` stops this compiling until it has
3616    /// a row — and the names are then checked in both directions, so a
3617    /// row cannot be forgotten and a row cannot name a field that is not
3618    /// there. `appearance` and `disabled_opacity` are not colours and are
3619    /// carried beside the roles rather than among them.
3620    #[test]
3621    fn theme_roles_restate_the_theme_exactly() {
3622        use crate::theme::Theme;
3623        let t = Theme::dark();
3624        let Theme {
3625            appearance: _,
3626            disabled_opacity: _,
3627            bg,
3628            surface,
3629            raised,
3630            sunken,
3631            border,
3632            border_strong,
3633            fg,
3634            muted,
3635            faint,
3636            accent,
3637            accent_hover,
3638            accent_pressed,
3639            on_accent,
3640            accent_soft,
3641            selection,
3642            focus_ring,
3643            hover,
3644            pressed,
3645            success,
3646            warning,
3647            danger,
3648            scrollbar,
3649            scrollbar_active,
3650        } = t;
3651        let fields: &[(&str, crate::color::Color)] = &[
3652            ("bg", bg),
3653            ("surface", surface),
3654            ("raised", raised),
3655            ("sunken", sunken),
3656            ("border", border),
3657            ("border_strong", border_strong),
3658            ("fg", fg),
3659            ("muted", muted),
3660            ("faint", faint),
3661            ("accent", accent),
3662            ("accent_hover", accent_hover),
3663            ("accent_pressed", accent_pressed),
3664            ("on_accent", on_accent),
3665            ("accent_soft", accent_soft),
3666            ("selection", selection),
3667            ("focus_ring", focus_ring),
3668            ("hover", hover),
3669            ("pressed", pressed),
3670            ("success", success),
3671            ("warning", warning),
3672            ("danger", danger),
3673            ("scrollbar", scrollbar),
3674            ("scrollbar_active", scrollbar_active),
3675        ];
3676        assert_eq!(THEME_ROLES.len(), fields.len(), "a role has no row");
3677        for (name, value) in fields {
3678            let row = THEME_ROLES
3679                .iter()
3680                .find(|r| r.name == *name)
3681                .unwrap_or_else(|| panic!("no THEME_ROLES row for {name}"));
3682            assert_eq!((row.get)(&t), *value, "{name}'s row reads another field");
3683        }
3684        for row in THEME_ROLES {
3685            assert!(
3686                fields.iter().any(|(n, _)| *n == row.name),
3687                "{} names no field",
3688                row.name
3689            );
3690            // Node's spelling is this one in camelCase, always.
3691            let camel = {
3692                let mut out = String::new();
3693                let mut up = false;
3694                for ch in row.name.chars() {
3695                    if ch == '_' {
3696                        up = true;
3697                    } else if up {
3698                        out.extend(ch.to_uppercase());
3699                        up = false;
3700                    } else {
3701                        out.push(ch);
3702                    }
3703                }
3704                out
3705            };
3706            assert_eq!(row.node, camel, "{}'s Node spelling", row.name);
3707        }
3708    }
3709
3710    /// `ENV_FIELDS` restates `Env` and `WindowEnv`; this pins the three
3711    /// together. The exhaustive patterns are the pin on the structs — a
3712    /// field added to either stops this compiling until it is named here
3713    /// — and the list beside them is then checked against the table in
3714    /// both directions, so a row cannot be forgotten and a row cannot
3715    /// claim a field that does not exist.
3716    #[test]
3717    fn env_fields_restate_env_and_window_env_exactly() {
3718        use crate::env::{AudioEnv, Env, SystemEnv};
3719        use crate::window::WindowEnv;
3720        let Env {
3721            refresh_hz: _,
3722            focused: _,
3723            system,
3724            window,
3725            audio,
3726        } = Env::default();
3727        let AudioEnv { device: _, live: _ } = audio;
3728        let SystemEnv {
3729            appearance: _,
3730            accent: _,
3731            motion: _,
3732            locale: _,
3733            assistive: _,
3734        } = system;
3735        let WindowEnv {
3736            id: _,
3737            custom_chrome: _,
3738            maximized: _,
3739            fullscreen: _,
3740            always_on_top: _,
3741            native_controls: _,
3742            backdrop: _,
3743        } = window;
3744        let stored = [
3745            "refresh_hz",
3746            "focused",
3747            "system.appearance",
3748            "system.accent",
3749            "system.motion",
3750            "system.locale",
3751            "system.assistive",
3752            "window.id",
3753            "window.custom_chrome",
3754            "window.maximized",
3755            "window.fullscreen",
3756            "window.always_on_top",
3757            "window.native_controls",
3758            "window.backdrop",
3759            "audio.device",
3760            "audio.live",
3761        ];
3762        // A stored fact's `from` is the struct and the field, spelled the
3763        // one way; everything else in the column is a call.
3764        let from_structs: Vec<&str> = ENV_FIELDS
3765            .iter()
3766            .filter(|f| !f.from.contains('('))
3767            .map(|f| {
3768                let (strukt, field) = match f.name.split_once('.') {
3769                    Some(("window", field)) => ("WindowEnv", field),
3770                    Some(("system", field)) => ("SystemEnv", field),
3771                    Some(("audio", field)) => ("AudioEnv", field),
3772                    Some((group, _)) => panic!("{}: no struct holds a {group} fact", f.name),
3773                    None => ("Env", f.name),
3774                };
3775                assert_eq!(f.from, format!("`{strukt}::{field}`"), "{}", f.name);
3776                f.name
3777            })
3778            .collect();
3779        assert_eq!(from_structs, stored);
3780        for f in ENV_FIELDS.iter().filter(|f| f.from.contains('(')) {
3781            assert!(
3782                f.from.contains("derived") || f.from.contains("the frame's"),
3783                "{}: a call in `from` is derived or the frame's, and says which",
3784                f.name
3785            );
3786        }
3787    }
3788
3789    /// Every spelling in `ENV_FIELDS` is unique per binding — two rows
3790    /// cannot land on one key — and every row says something in every
3791    /// column, so the generated table has no blank cells to wonder about.
3792    #[test]
3793    fn env_field_spellings_are_unique_and_complete() {
3794        let mut names: Vec<&str> = ENV_FIELDS.iter().map(|f| f.name).collect();
3795        let mut node: Vec<&str> = ENV_FIELDS
3796            .iter()
3797            .flat_map(|f| f.node.iter().copied())
3798            .collect();
3799        let mut lua: Vec<&str> = ENV_FIELDS
3800            .iter()
3801            .flat_map(|f| f.lua.iter().copied())
3802            .collect();
3803        for list in [&mut names, &mut node, &mut lua] {
3804            let before = list.len();
3805            list.sort_unstable();
3806            list.dedup();
3807            assert_eq!(list.len(), before, "a spelling is used twice");
3808        }
3809        for f in ENV_FIELDS {
3810            assert!(!f.c.is_empty() && !f.doc.is_empty(), "{}", f.name);
3811            // A binding that has no key for a fact says where it went
3812            // instead, so the empty cell is explained by the row itself.
3813            if f.node.is_empty() {
3814                assert!(
3815                    f.doc.contains("Node"),
3816                    "{}: where does Node carry it?",
3817                    f.name
3818                );
3819            }
3820            if f.lua.is_empty() {
3821                assert!(
3822                    f.doc.contains("Lua"),
3823                    "{}: where does Lua carry it?",
3824                    f.name
3825                );
3826            }
3827        }
3828    }
3829
3830    /// An element's admitted rows are real rows in each spelling and the
3831    /// same rows in both, so the JSX check and the Lua check admit the
3832    /// same button.
3833    #[test]
3834    fn admitted_rows_are_shared_rows_in_both_spellings() {
3835        for e in ELEMENTS {
3836            let (Some(jsx), Some(lua)) = (e.jsx_rows, e.lua_rows) else {
3837                assert!(
3838                    e.jsx_rows.is_none() && e.lua_rows.is_none(),
3839                    "{}: one spelling only",
3840                    e.name
3841                );
3842                continue;
3843            };
3844            assert_eq!(
3845                jsx.len(),
3846                lua.len(),
3847                "{}: the lists differ in length",
3848                e.name
3849            );
3850            for (j, l) in jsx.iter().zip(lua) {
3851                assert!(
3852                    shared_prop(j, Spelling::Camel),
3853                    "{}: `{j}` is not a row",
3854                    e.name
3855                );
3856                assert!(
3857                    shared_prop(l, Spelling::Snake),
3858                    "{}: `{l}` is not a row",
3859                    e.name
3860                );
3861                assert_eq!(
3862                    snake_case(j),
3863                    *l,
3864                    "{}: `{j}` and `{l}` are not one row",
3865                    e.name
3866                );
3867            }
3868            // The row a reader hears first: a stock button without a name
3869            // is the warning `control-without-name`, so `label` is never
3870            // the row a closed *control* leaves out. A text is its own
3871            // name.
3872            if jsx.contains(&"onClick") {
3873                assert!(jsx.contains(&"label"), "{}: `label` missing", e.name);
3874            }
3875        }
3876        assert!(known_prop("button", "description", Spelling::Camel));
3877        assert!(known_prop("button", "on_click", Spelling::Snake));
3878        assert!(known_prop("button", "text", Spelling::Snake));
3879        assert!(!known_prop("button", "radius", Spelling::Camel));
3880        assert!(!known_prop("button", "text", Spelling::Camel));
3881        assert!(known_prop("box", "radius", Spelling::Camel));
3882        // The other spelling is looked for among the rows it reads: a row
3883        // it would drop is not offered as the fix.
3884        assert_eq!(
3885            suggest("button", "on_click", Spelling::Camel),
3886            Some("onClick")
3887        );
3888        assert_eq!(suggest("button", "hover_bg", Spelling::Camel), None);
3889        assert_eq!(suggest("box", "hover_bg", Spelling::Camel), Some("hoverBg"));
3890    }
3891
3892    /// AR13: a text is content plus a style, so the rows it admits are
3893    /// exactly the rows that land on a `TextStyle`, plus `size`, the
3894    /// composite the style is built from. Every other row — a container's,
3895    /// an access row, `key` — is the `unknown-prop` warning in every
3896    /// binding rather than a silent drop.
3897    #[test]
3898    fn text_admits_exactly_the_style_rows() {
3899        let style: Vec<&str> = PROPS
3900            .iter()
3901            .filter(|d| d.target() == Target::Style)
3902            .map(|d| d.name)
3903            .collect();
3904        let mut expect = vec!["size"];
3905        expect.extend(style);
3906        let mut got = TEXT_ROWS_JSX.to_vec();
3907        expect.sort_unstable();
3908        got.sort_unstable();
3909        assert_eq!(got, expect, "TEXT_ROWS_JSX is not the style rows");
3910        for name in ["lineHeight", "color", "wrap", "size"] {
3911            assert!(known_prop("text", name, Spelling::Camel), "{name}");
3912        }
3913        for name in ["live", "role", "label", "onClick", "key", "pad", "bg"] {
3914            assert_eq!(
3915                known_prop("text", name, Spelling::Camel),
3916                name == "bg",
3917                "{name}: `bg` is the element's own (a span's), the rest are not rows it reads"
3918            );
3919        }
3920        assert!(known_prop("text", "line_height", Spelling::Snake));
3921        assert!(known_prop("text", "value", Spelling::Snake));
3922        assert!(!known_prop("text", "live", Spelling::Snake));
3923        assert!(!known_prop("text", "on_click", Spelling::Snake));
3924        // A misspelling is still steered to a row it reads, and to nothing
3925        // it would drop.
3926        assert_eq!(
3927            suggest("text", "max_lines", Spelling::Camel),
3928            Some("maxLines")
3929        );
3930        assert_eq!(suggest("text", "hover_bg", Spelling::Camel), None);
3931    }
3932
3933    #[test]
3934    fn snake_names_round_trip() {
3935        assert_eq!(by_snake_name("min_width").unwrap().name, "minWidth");
3936        assert_eq!(by_snake_name("on_click").unwrap().name, "onClick");
3937        assert_eq!(by_snake_name("bg").unwrap().name, "bg");
3938        assert!(by_snake_name("minWidth").is_none());
3939        assert_eq!(by_name("lineHeight").unwrap().snake_name(), "line_height");
3940        assert_eq!(by_name("radiusTL").unwrap().snake_name(), "radius_tl");
3941        assert_eq!(by_snake_name("radius_bl").unwrap().name, "radiusBL");
3942    }
3943
3944    /// The allow-list is per spelling, so each binding's own names pass and
3945    /// the other's do not — which is the point: neither binding reads the
3946    /// other's, so `hover_bg` in JSX is as dropped as `hoverBgg` would be.
3947    #[test]
3948    fn the_allow_list_is_per_spelling() {
3949        use Spelling::{Camel, Snake};
3950        assert!(known_prop("box", "hoverBg", Camel));
3951        assert!(known_prop("box", "hover_bg", Snake));
3952        assert!(!known_prop("box", "hover_bg", Camel));
3953        assert!(!known_prop("box", "hoverBg", Snake));
3954        // Composites, each in the spelling its binding takes.
3955        assert!(known_prop("box", "padX", Camel) && !known_prop("box", "padX", Snake));
3956        assert!(known_prop("box", "scroll", Snake) && !known_prop("box", "scroll", Camel));
3957        // `repeat` is a Lua keyword; the alias stands in for the row.
3958        assert!(known_prop("box", "direction", Snake));
3959        assert_eq!(lua_alias("direction"), Some("repeat"));
3960        // An element's own props are its own: `initial` is an editor's.
3961        assert!(known_prop("edit", "initial", Camel));
3962        assert!(!known_prop("box", "initial", Camel));
3963        // A shared text row on an editor is the editor's too: `wrap` is
3964        // what folds a single-line one, and it must not warn.
3965        assert!(known_prop("edit", "wrap", Camel) && known_prop("edit", "wrap", Snake));
3966        assert!(known_prop("image", "src", Camel) && known_prop("image", "id", Snake));
3967        // And nothing claims a typo.
3968        assert!(!known_prop("box", "colour", Camel));
3969    }
3970
3971    #[test]
3972    fn a_suggestion_is_the_same_word_in_the_right_convention() {
3973        use Spelling::{Camel, Snake};
3974        assert_eq!(suggest("box", "hoverBg", Snake), Some("hover_bg"));
3975        assert_eq!(suggest("box", "onclick", Camel), Some("onClick"));
3976        assert_eq!(suggest("box", "SCROLL_X", Camel), Some("scrollX"));
3977        assert_eq!(suggest("edit", "Initial", Camel), Some("initial"));
3978        // Nothing fuzzy: a guess or nothing.
3979        assert_eq!(suggest("box", "colour", Camel), None);
3980    }
3981
3982    /// Every name a binding hand-lowers has to be in one of the tables, or
3983    /// the binding warns about a prop it reads perfectly well.
3984    #[test]
3985    fn every_composite_and_element_prop_is_in_the_allow_list() {
3986        for c in CUSTOM {
3987            for n in c.jsx_names {
3988                assert!(known_prop("box", n, Spelling::Camel), "jsx `{n}`");
3989            }
3990            for n in c.lua_names {
3991                assert!(known_prop("box", n, Spelling::Snake), "lua `{n}`");
3992            }
3993        }
3994        for e in ELEMENTS {
3995            for n in e.jsx_own {
3996                assert!(known_prop(e.name, n, Spelling::Camel), "{}.{n}", e.name);
3997            }
3998            for n in e.lua_own {
3999                assert!(known_prop(e.name, n, Spelling::Snake), "{}.{n}", e.name);
4000            }
4001        }
4002    }
4003
4004    #[test]
4005    fn every_row_applies_a_sample_of_its_kind() {
4006        for def in PROPS {
4007            // `opacity` is a 0..=1 slot whose default is the top of the
4008            // range, so the shared sample would clamp back to it.
4009            let f = if def.name == "opacity" { 0.5 } else { 7.0 };
4010            let sample = match def.kind {
4011                Kind::F32 => Parsed::F32(f),
4012                Kind::Color => Parsed::Color(Color::hex(0x11223344)),
4013                Kind::Flag => Parsed::Flag,
4014                Kind::Enum(_) => Parsed::Enum(1),
4015                Kind::Sizing => Parsed::Sizing(Sizing::Percent(0.5)),
4016                Kind::Min => Parsed::Bound(Bound::Fit),
4017                Kind::Max => Parsed::Bound(Bound::Px(10.0)),
4018                Kind::Msg | Kind::Tag => Parsed::Msg(Value::Int(1)),
4019                // A list of four names, and a string of none of them is
4020                // the default: none.
4021                Kind::Str if def.name == "scrollMods" => Parsed::Str("ctrl".into()),
4022                Kind::Str => Parsed::Str("name".into()),
4023                Kind::Family => Parsed::Family(FontFamily::Mono),
4024                Kind::Resource => Parsed::Resource(7),
4025                Kind::Keyframes => Parsed::Keyframes(vec![Keyframe::default().radius(7.0)]),
4026                Kind::Enter => Parsed::Enter(Enter::from(-7.0, 0.0)),
4027                Kind::Gradient => Parsed::Gradient(crate::gradient::Gradient::to(
4028                    crate::gradient::Side::Right,
4029                    [Color::hex(0x11223344), Color::WHITE],
4030                )),
4031            };
4032            let mut out = PropsOut::new();
4033            apply(def, sample, &mut out).unwrap();
4034            let changed = match def.target() {
4035                Target::Spec => out.spec != NodeSpec::column(),
4036                Target::Style => out.style != TextStyle::new(16.0),
4037            };
4038            assert!(changed, "{} applied a sample but nothing changed", def.name);
4039        }
4040    }
4041
4042    /// A null tag keeps the behaviour and drops the `tag` field; the
4043    /// contract every transport relies on to accept `null` for `Tag` rows.
4044    #[test]
4045    fn a_null_tag_still_declares_the_behaviour() {
4046        let mut out = PropsOut::new();
4047        apply(
4048            by_name("onKey").unwrap(),
4049            Parsed::Msg(Value::Null),
4050            &mut out,
4051        )
4052        .unwrap();
4053        assert_eq!(out.spec.events().on_key, Some(Value::Null));
4054        assert!(out.spec.hover_tracked());
4055        let mut out = PropsOut::new();
4056        apply(
4057            by_name("onLayout").unwrap(),
4058            Parsed::Msg(Value::Null),
4059            &mut out,
4060        )
4061        .unwrap();
4062        assert_eq!(out.spec.events().on_layout, Some(Value::Null));
4063    }
4064
4065    /// `ROLES` is the wire order for the `role` enum — a binding sends the
4066    /// index — so a typo, or a spelling that drifted from `access.rs`, does
4067    /// not fail anywhere: the name simply stops parsing, and every view
4068    /// declaring that role silently gets [`role_idx`]'s fallback instead.
4069    /// Until this test that fallback was `Role::None`, which takes the node
4070    /// *and its whole subtree* out of the access tree — a drifted spelling
4071    /// would have removed part of the app from every screen reader, with
4072    /// nothing failing and nothing warning. Both halves are pinned here:
4073    /// each name is a real role, and index `i` still means `ROLES[i]`.
4074    #[test]
4075    fn every_declarable_role_name_is_a_real_role() {
4076        for (i, name) in ROLES.iter().enumerate() {
4077            let role = Role::parse(name)
4078                .unwrap_or_else(|| panic!("ROLES[{i}] = {name:?} is not a Role::ALL name"));
4079            assert_eq!(role_idx(i), role, "role index {i} lowers to the wrong role");
4080            assert_eq!(role_idx(i).name(), *name);
4081        }
4082    }
4083
4084    /// The C header pins its role enum to `Role::ALL` by construction
4085    /// (`kui-ffi`'s `abi_enum!`), so a new role fails the C build until the
4086    /// header names it. Lua, Node and JSX have no such pin — they read
4087    /// `ROLES` — and a role added to `Role::ALL` and forgotten there is
4088    /// simply undeclarable from all three, silently. This is that pin: a
4089    /// role is declarable or derived, never neither and never both, and an
4090    /// exemption has to be one a frame really does derive, so `DERIVED_ONLY`
4091    /// cannot become somewhere to put a forgotten row.
4092    #[test]
4093    fn every_role_is_declarable_or_derived() {
4094        for role in Role::ALL {
4095            let declarable = ROLES.contains(&role.name());
4096            let derived = DERIVED_ONLY.iter().any(|(n, _)| *n == role.name());
4097            assert!(
4098                declarable || derived,
4099                "Role::{role:?} is in Role::ALL but no view can declare it and \
4100                 DERIVED_ONLY does not say the core derives it — add {:?} to \
4101                 ROLES, or to DERIVED_ONLY with the reason",
4102                role.name()
4103            );
4104            assert!(
4105                !(declarable && derived),
4106                "Role::{role:?} is in ROLES, so it is declarable — drop it from \
4107                 DERIVED_ONLY"
4108            );
4109        }
4110        for (name, why) in DERIVED_ONLY {
4111            assert!(!why.is_empty(), "{name:?} is exempted without a reason");
4112            assert!(
4113                Role::parse(name).is_some(),
4114                "DERIVED_ONLY names {name:?}, which is not a Role::ALL name"
4115            );
4116        }
4117        let derived = roles_one_frame_derives();
4118        for (name, _) in DERIVED_ONLY {
4119            assert!(
4120                derived.contains(&Role::parse(name).unwrap()),
4121                "DERIVED_ONLY keeps {name:?} out of ROLES because the core \
4122                 derives it, but no frame does any more — either it belongs in \
4123                 ROLES now, or the exemption is stale"
4124            );
4125        }
4126    }
4127
4128    /// One frame that derives each of `DERIVED_ONLY`'s roles: the root is
4129    /// the window, a `window_drag` row the title bar, a scrolling box the
4130    /// scroll view, and the text inside it static text.
4131    fn roles_one_frame_derives() -> Vec<Role> {
4132        let mut core = crate::Core::new();
4133        let mut ui = core.frame(crate::Size::new(200.0, 200.0), 1.0);
4134        ui.window_title("Demo");
4135        ui.configure_root(NodeSpec::column().fill());
4136        ui.leaf_keyed("titlebar", NodeSpec::row().window_drag());
4137        ui.text_in_keyed(
4138            "scroll",
4139            NodeSpec::column().height(40.0).scroll_y(),
4140            "hello",
4141            TextStyle::new(12.0),
4142        );
4143        ui.finish();
4144        core.access_tree().nodes.iter().map(|n| n.role).collect()
4145    }
4146
4147    #[test]
4148    fn colors_and_sizings_parse() {
4149        assert_eq!(color_hex_str("#fff").unwrap(), Color::hex(0xffffffff));
4150        assert_eq!(color_hex_str("#11223344").unwrap(), Color::hex(0x11223344));
4151        assert!(color_hex_str("fff").is_err());
4152        assert_eq!(sizing_str("50%").unwrap(), Sizing::Percent(0.5));
4153        assert_eq!(sizing_str("grow").unwrap(), Sizing::Grow(1.0));
4154        assert!(sizing_str("wide").is_err());
4155    }
4156}