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