Skip to main content

kui_core/
spec.rs

1//! [`NodeSpec`] and [`TextStyle`]: everything a node and a text declare,
2//! as plain data with a builder.
3//!
4//! A `NodeSpec` is the contract every frontend lowers into, whether a Rust
5//! builder chain, a Lua table or a JSX element. It groups the layout
6//! ([`LayoutSpec`]: sizing, direction, padding, gap, alignment, overflow),
7//! the look ([`VisualStyle`]: background, border, radius, shadow, opacity)
8//! and, boxed because most nodes declare none of it, the events, animation,
9//! accessibility and interaction styling. Every builder method sets one of
10//! those fields; the field docs below say what each means.
11//!
12//! ```rust
13//! use kui_core::{Align, Color, NodeSpec, Sizing, TextStyle, TextWrap};
14//!
15//! // A card: grows across its parent, fits its content down, 12 px padding
16//! // and gap, rounded, with a hover background and a click payload.
17//! let card = NodeSpec::column()
18//!     .width(Sizing::GROW)
19//!     .pad(12.0)
20//!     .gap(8.0)
21//!     .bg(Color::hex(0x1e2230ff))
22//!     .hover_bg(Color::hex(0x262b3aff))
23//!     .radius(8.0)
24//!     .on_click("open-card");
25//!
26//! // A toolbar row: fixed height, children centred across it.
27//! let toolbar = NodeSpec::row().size(Sizing::GROW, 36.0).cross_align(Align::Center);
28//!
29//! // A one-line title, cut with an ellipsis when it does not fit.
30//! let title = TextStyle::new(16.0).ellipsis().color(Color::WHITE);
31//! let code = TextStyle::new(13.0).mono().wrap(TextWrap::Glyph);
32//!
33//! assert_eq!(card.layout.padding.l, 12.0);
34//! assert!(card.events().on_click.is_some());
35//! assert_eq!(toolbar.layout.height, Sizing::Fixed(36.0));
36//! assert_eq!(title.max_lines, 0); // `ellipsis` alone means one line
37//! assert!(title.ellipsis && code.wrap == TextWrap::Glyph);
38//! ```
39
40use crate::anim::{Easing, Repeat, Transition};
41use crate::color::Color;
42use crate::cursor::CursorShape;
43use crate::enter::Enter;
44use crate::geom::Edges;
45use crate::input::Buttons;
46use crate::keyframes::Keyframe;
47use crate::value::Value;
48use crate::window::{WindowButton, WindowRole};
49
50pub use crate::access::{Label, Live, Role};
51
52/// How a node sizes one axis. A plain number converts to `Fixed`, so
53/// `.width(120.0)` and `.width(Sizing::Fixed(120.0))` are the same.
54#[derive(Clone, Copy, Debug, Default, PartialEq)]
55pub enum Sizing {
56    /// Size to content.
57    #[default]
58    Fit,
59    /// Share leftover space, weighted by factor.
60    Grow(f32),
61    /// Absolute logical pixels.
62    Fixed(f32),
63    /// Fraction of the parent's content box (0.0..=1.0).
64    Percent(f32),
65    /// A size expression resolved against the parent's content box, the
66    /// box a `Percent` takes its cut of: `"clamp(400px, 80%, 1000px)"`
67    /// (see [`crate::calc`]). Layout treats it as it treats a `Percent`:
68    /// nothing in the fit pass, its size once the parent's is known, and
69    /// a parent that overflows shrinks it as it would one.
70    Calc(crate::calc::Calc),
71}
72
73/// What a `min_width` / `max_width` / `min_height` / `max_height`
74/// declares: px, the node's own fit size (a min only), or a size
75/// expression that layout resolves against the parent's content box when
76/// it sizes the node. Until then a calc bound clamps like none, as a
77/// percentage clamp does in CSS's intrinsic sizing.
78///
79/// A calc clamp rides in the clamp's own `f32` as a negative, the way
80/// [`Min::FIT`] does (`min_w` below -1, [`Min::calc`]; `max_w` below 0,
81/// [`max_calc`]), and layout writes the resolved px over it. A reader
82/// after layout reads a number; one before it goes through
83/// [`LayoutSpec::max_w_px`].
84#[derive(Clone, Copy, Debug, PartialEq)]
85pub enum Bound {
86    Px(f32),
87    Fit,
88    Calc(crate::calc::Calc),
89}
90
91/// A ceiling that is a size expression, as `max_w` / `max_h` hold it
92/// until layout resolves it: -1 minus its number.
93pub fn max_of_calc(c: crate::calc::Calc) -> f32 {
94    -1.0 - c.id() as f32
95}
96
97/// A px ceiling as `max_w` / `max_h` hold it: never below zero, so a
98/// negative there is only ever [`max_of_calc`]'s. A negative or `NaN`
99/// ceiling is a ceiling of 0. Every binding's max clamp reaches the field
100/// through [`NodeSpec::max_width`] / [`NodeSpec::max_height`], which call
101/// this.
102pub fn px_ceiling(px: f32) -> f32 {
103    // `f32::max` takes the other operand over a `NaN`.
104    px.max(0.0)
105}
106
107/// The size expression a `max_w` / `max_h` waits on, if it is one.
108pub fn max_calc(v: f32) -> Option<crate::calc::Calc> {
109    (v < 0.0)
110        .then(|| crate::calc::Calc::from_id((-v - 1.0) as u32))
111        .flatten()
112}
113
114impl From<f32> for Bound {
115    fn from(px: f32) -> Self {
116        Bound::Px(px)
117    }
118}
119
120impl From<Min> for Bound {
121    fn from(m: Min) -> Self {
122        if m.is_fit() {
123            Bound::Fit
124        } else if let Some(c) = m.as_calc() {
125            Bound::Calc(c)
126        } else if m.is_auto() {
127            // Undeclared stays undeclared through `min_width`.
128            Bound::Px(-0.0)
129        } else {
130            Bound::Px(m.resolved())
131        }
132    }
133}
134
135/// A lower clamp on one axis: a number of logical px, or the node's own
136/// fit size on that axis ([`Min::FIT`], `minWidth: "fit"` in the
137/// bindings). `FIT` is what lets a `Grow` child keep a content floor, like
138/// CSS's `flex: 1 0 auto`: tabs split a bar evenly while they fit and sit
139/// at their label's width, scrolling, once they do not. Layout resolves it
140/// to a number in the fit pass of its axis, so every later clamp reads
141/// one; until then it clamps like no floor at all.
142///
143/// Undeclared is [`Min::AUTO`], which clamps as 0 everywhere but one
144/// place: a child giving in an overflowing row that holds a share of the
145/// room, where it is CSS's `min-width: auto`, the child's min-content. A
146/// declared 0 (`Min::px(0.0)`) is no floor there either, as CSS's
147/// `min-width: 0` is how a flex item is let go below its content.
148///
149/// Stored as one `f32` with `FIT` and a calc as negatives (the form the
150/// C struct's `min_w` takes too), because `LayoutSpec` is copied per node
151/// per frame.
152#[derive(Clone, Copy, Debug, PartialEq)]
153pub struct Min(f32);
154
155impl Default for Min {
156    fn default() -> Self {
157        Min::AUTO
158    }
159}
160
161impl Min {
162    /// The node's own fit size on this axis.
163    pub const FIT: Min = Min(-1.0);
164
165    /// No floor declared: the node's min-content where a share of the room
166    /// gives in CSS's way and down a column of fit children; 0 across a
167    /// run of fit children alone, across a column, where a fit node is
168    /// held to the column's box, and for a node that scrolls or clips.
169    /// Negative zero, so it is 0 to every clamp and to `==`, and told
170    /// apart from a declared 0 by its sign alone ([`Min::is_auto`]).
171    pub const AUTO: Min = Min(-0.0);
172
173    /// A floor of `v` logical px; a negative (or `NaN`) is a floor of 0,
174    /// declared — no automatic one either.
175    pub fn px(v: f32) -> Min {
176        Min(if v > 0.0 { v } else { 0.0 })
177    }
178
179    /// Whether no floor was declared ([`Min::AUTO`]).
180    pub fn is_auto(self) -> bool {
181        self.0 == 0.0 && self.0.is_sign_negative()
182    }
183
184    /// Whether this is the unresolved fit floor.
185    pub fn is_fit(self) -> bool {
186        self.0 == Min::FIT.0
187    }
188
189    /// A floor that is a size expression, until layout resolves it: -2
190    /// minus its number, below `FIT`'s -1.
191    pub fn calc(c: crate::calc::Calc) -> Min {
192        Min(-2.0 - c.id() as f32)
193    }
194
195    /// The size expression this floor waits on, if it is one.
196    pub fn as_calc(self) -> Option<crate::calc::Calc> {
197        (self.0 <= -2.0)
198            .then(|| crate::calc::Calc::from_id((-self.0 - 2.0) as u32))
199            .flatten()
200    }
201
202    /// Whether layout has yet to resolve this floor — a `FIT` or a calc,
203    /// the negatives — without asking the table which calc it is.
204    pub(crate) fn deferred(self) -> bool {
205        self.0 < 0.0
206    }
207
208    /// The clamp as a number: the px it holds, or 0 for a `FIT` or a calc
209    /// layout has not resolved yet (nothing to floor at).
210    pub fn resolved(self) -> f32 {
211        if self.0 > 0.0 { self.0 } else { 0.0 }
212    }
213}
214
215impl From<f32> for Min {
216    fn from(v: f32) -> Self {
217        Min::px(v)
218    }
219}
220
221/// A number is that many logical px, so `.width(120.0)` is
222/// `.width(Sizing::Fixed(120.0))`, the way `min_width(120.0)` already read.
223impl From<f32> for Sizing {
224    fn from(px: f32) -> Self {
225        Sizing::Fixed(px)
226    }
227}
228
229impl Sizing {
230    /// `Grow(1.0)`: an equal share of the leftover space, the weight
231    /// nearly every grow declares.
232    pub const GROW: Sizing = Sizing::Grow(1.0);
233}
234
235impl Sizing {
236    /// The sizing the way a spec spells it — `fit`, `grow(1)`, `120px`,
237    /// `50%` — for a reader: the devtools' inspector and a `nodes()` row.
238    pub fn describe(self) -> String {
239        match self {
240            Sizing::Fit => "fit".into(),
241            Sizing::Grow(w) => format!("grow({w})"),
242            Sizing::Fixed(px) => format!("{px}px"),
243            Sizing::Percent(p) => format!("{}%", p * 100.0),
244            Sizing::Calc(c) => c.describe(),
245        }
246    }
247
248    /// The animatable number inside: a grow factor, a px size, a fraction.
249    /// None for `Fit` and a `Calc`, which have nothing to ease.
250    pub fn amount(self) -> Option<f32> {
251        match self {
252            Sizing::Fit | Sizing::Calc(_) => None,
253            Sizing::Grow(v) | Sizing::Fixed(v) | Sizing::Percent(v) => Some(v),
254        }
255    }
256
257    /// The same form with a different amount (`Fit` and a `Calc` stay).
258    pub fn with_amount(self, v: f32) -> Self {
259        match self {
260            Sizing::Fit => Sizing::Fit,
261            Sizing::Calc(c) => Sizing::Calc(c),
262            Sizing::Grow(_) => Sizing::Grow(v),
263            Sizing::Fixed(_) => Sizing::Fixed(v),
264            Sizing::Percent(_) => Sizing::Percent(v),
265        }
266    }
267}
268
269/// Which way a container stacks its children.
270#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
271pub enum Dir {
272    Row,
273    #[default]
274    Column,
275}
276
277impl Dir {
278    /// The `dir` row's spelling.
279    pub fn name(self) -> &'static str {
280        match self {
281            Dir::Row => "row",
282            Dir::Column => "column",
283        }
284    }
285}
286
287/// Where children sit along an axis, and where a float attaches.
288///
289/// The first three apply to every axis. The rest each mean something on
290/// one axis only: the three spreads on `main_align`, `Baseline` on a row's
291/// `cross_align`. Anywhere else one lays out as `Start`
292/// (`SpaceAround`/`SpaceEvenly` as `Center`), with an `align-ignored`
293/// warning.
294#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
295pub enum Align {
296    #[default]
297    Start,
298    Center,
299    End,
300    /// Main axis: the free space goes between the children, none at the
301    /// ends — CSS's `space-between`. One child sits at the start.
302    SpaceBetween,
303    /// Main axis: each child gets an equal share of the free space, half
304    /// on either side, so the ends get half what a gap does — CSS's
305    /// `space-around`. One child is centred.
306    SpaceAround,
307    /// Main axis: the free space splits into equal gaps between the
308    /// children and at both ends — CSS's `space-evenly`. One child is
309    /// centred.
310    SpaceEvenly,
311    /// A row's cross axis: the first baselines of the children's text line
312    /// up, so a label and a larger value on one row read as one line. A
313    /// child with no text inside it aligns by its bottom edge; a `grow` or
314    /// percent height fills the line and sits at its top.
315    Baseline,
316}
317
318impl Align {
319    /// The `align` rows' spelling (`schema::ALIGNS`).
320    pub fn name(self) -> &'static str {
321        crate::schema::ALIGNS[self as usize]
322    }
323}
324
325/// What a floating node is positioned against.
326#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
327pub enum FloatAnchor {
328    /// The parent node's border box.
329    #[default]
330    Parent,
331    /// The whole viewport.
332    Viewport,
333    /// The border box of the node `Key` names, wherever it is in the
334    /// tree, even after this one in preorder: such a float is laid out
335    /// again in a sixth pass once its anchor is placed. What a devtools
336    /// tab's content is: built in the app's part of the tree, shown over
337    /// the panel's tab body. No binding spells it; the core builds it.
338    Node(crate::key::Key),
339}
340
341/// Takes a node out of flex flow: it does not consume space in its parent,
342/// sizes Grow/Percent against its anchor, is positioned by attach points,
343/// and escapes ancestor clips unless [`FloatConfig::clip`] keeps it in its
344/// parent's. It paints as a layer of its own, above the in-flow tree and
345/// every float that opened before it and under every one that opened
346/// after, and takes input in the same order.
347///
348/// ```rust
349/// use kui_core::{Align, FloatConfig, NodeSpec};
350///
351/// let tooltip = NodeSpec::column().float(FloatConfig::below().fit());
352/// let toast = NodeSpec::row().float(FloatConfig::viewport().inside(Align::End, Align::End).offset(-16.0, -16.0));
353/// assert!(tooltip.layout.float.unwrap().fit);
354/// assert_eq!(toast.layout.float.unwrap().offset.x, -16.0);
355/// ```
356#[derive(Clone, Copy, Debug, PartialEq)]
357pub struct FloatConfig {
358    pub anchor: FloatAnchor,
359    /// Attach point on the anchor rect (horizontal, vertical).
360    pub anchor_point: (Align, Align),
361    /// Attach point on the floating node itself.
362    pub self_point: (Align, Align),
363    /// Extra offset applied after attaching, logical px.
364    pub offset: Vec2Offset,
365    /// Keep the float on screen: if the attached placement leaves the
366    /// viewport on an axis, mirror the attachment across the anchor on that
367    /// axis (below ↔ above, after ↔ before) when that fits better, then
368    /// clamp whatever still overflows. Tooltips/menus want this.
369    ///
370    /// This is the in-window approximation of an OS popup: a float costs
371    /// one tree, one hit list and one draw call. What it cannot do is leave
372    /// the window, so a dropdown taller than the viewport, or a menu with
373    /// nowhere in-window to go, is clamped rather than placed.
374    pub fit: bool,
375    /// Take the parent's clip, as a child does, instead of escaping every
376    /// ancestor's: a node on a `clip` canvas panned past the canvas's edge
377    /// is cut there, and its hit region with it, rather than drawn over
378    /// and clicked through the toolbar beside it. Only a
379    /// [`FloatAnchor::Parent`] float reads it; a viewport or node anchor is
380    /// placed against something other than the parent, and escapes with it
381    /// set or not. A declared float's paint order is unchanged: it is a
382    /// layer of its own still. A `line`, `polygon` or `path` anchored in
383    /// its parent's box has it set by the core, and with it paints in the
384    /// parent's layer at its place in the tree, as a child does — it opens
385    /// no layer (backlog F123; `Tree::opens_layer`).
386    pub clip: bool,
387}
388
389/// Plain offset pair (kept separate from geometry to stay `Copy` + FFI-flat).
390#[derive(Clone, Copy, Debug, Default, PartialEq)]
391pub struct Vec2Offset {
392    pub x: f32,
393    pub y: f32,
394}
395
396impl Default for FloatConfig {
397    fn default() -> Self {
398        Self {
399            anchor: FloatAnchor::Parent,
400            anchor_point: (Align::Start, Align::Start),
401            self_point: (Align::Start, Align::Start),
402            offset: Vec2Offset::default(),
403            fit: false,
404            clip: false,
405        }
406    }
407}
408
409impl FloatConfig {
410    /// Anchored to the parent's top-left corner.
411    pub fn parent() -> Self {
412        Self::default()
413    }
414
415    /// Anchored to the viewport's top-left corner.
416    pub fn viewport() -> Self {
417        Self {
418            anchor: FloatAnchor::Viewport,
419            ..Self::default()
420        }
421    }
422
423    /// Tooltip-style: hang below the parent, centered.
424    pub fn below() -> Self {
425        Self {
426            anchor: FloatAnchor::Parent,
427            anchor_point: (Align::Center, Align::End),
428            self_point: (Align::Center, Align::Start),
429            offset: Vec2Offset { x: 0.0, y: 6.0 },
430            ..Self::default()
431        }
432    }
433
434    /// Tooltip-style: hover above the parent, centered.
435    pub fn above() -> Self {
436        Self {
437            anchor: FloatAnchor::Parent,
438            anchor_point: (Align::Center, Align::Start),
439            self_point: (Align::Center, Align::End),
440            offset: Vec2Offset { x: 0.0, y: -6.0 },
441            ..Self::default()
442        }
443    }
444
445    /// The attach point on the anchor.
446    pub fn at(mut self, x: Align, y: Align) -> Self {
447        self.anchor_point = (x, y);
448        self
449    }
450
451    /// The attach point on the float itself.
452    pub fn self_at(mut self, x: Align, y: Align) -> Self {
453        self.self_point = (x, y);
454        self
455    }
456
457    /// [`Self::at`] and [`Self::self_at`] at the same point: the float sits
458    /// inside the anchor against that edge or corner — `(End, End)` is a
459    /// toast in the viewport's bottom-right, `(Center, Center)` a dialog.
460    #[inline]
461    pub fn inside(self, x: Align, y: Align) -> Self {
462        self.at(x, y).self_at(x, y)
463    }
464
465    /// An extra offset after attaching, logical px.
466    pub fn offset(mut self, x: f32, y: f32) -> Self {
467        self.offset = Vec2Offset { x, y };
468        self
469    }
470
471    /// Flip across the anchor / clamp as needed to stay in the viewport;
472    /// see [`FloatConfig::fit`] for where that stops being enough.
473    pub fn fit(mut self) -> Self {
474        self.fit = true;
475        self
476    }
477
478    /// Cut by the parent's clip instead of escaping it; see
479    /// [`FloatConfig::clip`] for which anchors read it.
480    pub fn clipped(mut self) -> Self {
481        self.clip = true;
482        self
483    }
484
485    /// Whether this float takes its parent's clip: [`FloatConfig::clip`]
486    /// declared on a parent-anchored float. The one reading both paint
487    /// passes and the hit regions share.
488    pub fn clipped_by_parent(&self) -> bool {
489        self.clip && self.anchor == FloatAnchor::Parent
490    }
491
492    /// A preset by its wire index — its position in [`FLOAT_PRESETS`], which
493    /// is what the binary protocol carries and what `KUI_FLOAT_*` counts
494    /// from. `None` for an index no preset claims.
495    pub fn preset_at(i: usize) -> Option<Self> {
496        Some(match i {
497            0 => Self::parent(),
498            1 => Self::viewport(),
499            2 => Self::below(),
500            3 => Self::above(),
501            _ => return None,
502        })
503    }
504
505    /// A preset by name. Every binding that spells a float as a word —
506    /// `float="below"`, `float = "above"`, `kui_spec_float_preset` — resolves
507    /// it here, so "below" cannot mean one thing in JS and another in Lua.
508    pub fn preset(name: &str) -> Option<Self> {
509        Self::preset_at(FLOAT_PRESETS.iter().position(|p| *p == name)?)
510    }
511
512    /// One config from the pieces a binding can extract without deciding
513    /// anything: a `base` preset (from [`FloatConfig::preset`] or
514    /// [`FloatConfig::preset_at`]) and the overrides that were actually
515    /// declared. `None` leaves the base's own value — that is what lets
516    /// `float="below"` keep its 6px gap while `{ anchor: "below", dx: 2 }`
517    /// moves it sideways without flattening the gap to zero. `fit` and
518    /// `clip` are ORed in: no preset sets either.
519    pub fn build(
520        base: FloatConfig,
521        anchor_at: Option<(Align, Align)>,
522        self_at: Option<(Align, Align)>,
523        dx: Option<f32>,
524        dy: Option<f32>,
525        fit: bool,
526        clip: bool,
527    ) -> Self {
528        let mut cfg = base;
529        if let Some((x, y)) = anchor_at {
530            cfg.anchor_point = (x, y);
531        }
532        if let Some((x, y)) = self_at {
533            cfg.self_point = (x, y);
534        }
535        if let Some(x) = dx {
536            cfg.offset.x = x;
537        }
538        if let Some(y) = dy {
539            cfg.offset.y = y;
540        }
541        cfg.fit |= fit;
542        cfg.clip |= clip;
543        cfg
544    }
545}
546
547/// The float preset names, in wire order: the index of a name here is what
548/// the binary protocol writes for it and what `KUI_FLOAT_*` counts from.
549pub const FLOAT_PRESETS: &[&str] = &["parent", "viewport", "below", "above"];
550
551/// `overflow` as bits: the C struct's field, the binary wire's payload and
552/// what the `clip` / `scrollX` / `scrollY` booleans OR together. One set of
553/// values so a binding cannot invent its own numbering.
554pub const OVERFLOW_CLIP: u32 = 1 << 0;
555pub const OVERFLOW_SCROLL_X: u32 = 1 << 1;
556pub const OVERFLOW_SCROLL_Y: u32 = 1 << 2;
557
558/// The `pad` shorthand family as declared — any subset of the seven names,
559/// each `None` when the frontend did not see it. [`PadShorthand::resolve`]
560/// decides what a missing edge falls back to; a binding only reports what
561/// it found.
562#[derive(Clone, Copy, Debug, Default, PartialEq)]
563pub struct PadShorthand {
564    /// `pad`: all four edges.
565    pub all: Option<f32>,
566    /// `padX`: left and right.
567    pub x: Option<f32>,
568    /// `padY`: top and bottom.
569    pub y: Option<f32>,
570    pub l: Option<f32>,
571    pub r: Option<f32>,
572    pub t: Option<f32>,
573    pub b: Option<f32>,
574}
575
576impl PadShorthand {
577    /// True when the frontend saw any of the seven names.
578    pub fn declared(self) -> bool {
579        [self.all, self.x, self.y, self.l, self.r, self.t, self.b]
580            .iter()
581            .any(Option::is_some)
582    }
583
584    /// Four edges: an edge falls back to its axis, an axis to the all-round
585    /// `pad`, and `pad` to zero. The specific value always wins.
586    pub fn resolve(self) -> Edges {
587        let all = self.all.unwrap_or(0.0);
588        let (x, y) = (self.x.unwrap_or(all), self.y.unwrap_or(all));
589        Edges {
590            l: self.l.unwrap_or(x),
591            r: self.r.unwrap_or(x),
592            t: self.t.unwrap_or(y),
593            b: self.b.unwrap_or(y),
594        }
595    }
596}
597
598/// The layout half of a [`NodeSpec`]: sizing, clamps, direction, padding,
599/// gap, alignment, overflow and floating. Set through the `NodeSpec`
600/// builders; read by the solver.
601#[derive(Clone, Copy, Debug, PartialEq)]
602pub struct LayoutSpec {
603    pub width: Sizing,
604    pub height: Sizing,
605    /// Clamps applied after `width`/`height` resolve (Fit, Grow, Percent and
606    /// Fixed alike), so "grow but at most N" and "fit but at least N" work.
607    /// A min may also be [`Min::FIT`]: "grow but never below my content".
608    pub min_w: Min,
609    /// A ceiling in px, or, as a negative, a size expression layout has
610    /// yet to resolve ([`max_of_calc`]); set it through
611    /// [`NodeSpec::max_width`], which keeps a px one at or above zero
612    /// ([`px_ceiling`]). `max_h` is the same.
613    pub max_w: f32,
614    pub min_h: Min,
615    pub max_h: f32,
616    pub dir: Dir,
617    pub padding: Edges,
618    pub gap: f32,
619    /// Row children that don't fit the main-axis content box start a new
620    /// line instead of overflowing (or shrinking). Rows only: breaking
621    /// needs a definite main size, and the pass order gives a row one —
622    /// its width is final before its height is measured — where a column
623    /// would need its height first. Ignored on a column and on a
624    /// `scroll_x` row, both with a warning (`diag::WRAP_IGNORED`).
625    pub wrap: bool,
626    /// A column whose rows' children line up in columns: the nth in-flow
627    /// child of every in-flow row is a cell of column n, and
628    /// a column is as wide as its widest cell — its cells' own `width`s
629    /// say how the column sizes (a `Fixed` or `Fit` cell is content that
630    /// sets the column's fit width, a `Grow` cell makes the column grow,
631    /// a `Percent` one takes its cut of the row) and their `minWidth` /
632    /// `maxWidth` clamp it. The rows are ordinary rows — a row's `gap` is
633    /// the space between its cells, its `padding` its own, and it takes
634    /// its background, its click and its hover as any row does — except
635    /// that a row of a table never wraps (`diag::WRAP_IGNORED`). Set by
636    /// [`NodeSpec::table`], which is a column; `dir` stays `Column`, and
637    /// the flag is read on a column only ([`LayoutSpec::is_table`]): a
638    /// `Row` carrying it — a shape only these public fields can build —
639    /// is the row it says it is. The rows are the in-flow `Row` children;
640    /// a column, a table or a leaf straight under the table is a child
641    /// with its own width and no cells.
642    pub table: bool,
643    /// Space between wrap lines, across the main axis. `gap` is still the
644    /// space between children along it.
645    pub cross_gap: f32,
646    /// Alignment of children along the main axis, the spreads
647    /// (`SpaceBetween` / `SpaceAround` / `SpaceEvenly`) included.
648    pub main_align: Align,
649    /// Alignment of children across the main axis; `Baseline` on a row.
650    pub cross_align: Align,
651    /// Width over height (CSS's `aspect-ratio`); 0 = none.
652    /// It sizes the axis whose sizing is `Fit`: a fit height is the final
653    /// width over the ratio, and a fit width under a `Fixed` height is
654    /// that height times it. With both axes declared it has nothing to set.
655    /// The derived axis is neither shrunk nor fitted to the children,
656    /// which overflow it — `min_h: Min::FIT` floors it at them.
657    pub aspect: f32,
658    /// Clip children to this node's rect.
659    pub clip: bool,
660    /// Overflowing content scrolls (implies clipping). Offsets are retained
661    /// across frames in the core, keyed by this node's `Key`.
662    pub scroll_x: bool,
663    pub scroll_y: bool,
664    /// Scroll anchoring (CSS's `overflow-anchor`): the
665    /// first child in view keeps its place on screen when the content
666    /// before it changes size — a chat that prepends history, a log that
667    /// inserts above the viewport, a row whose estimate was corrected.
668    /// On the scroll axis that is the container's main axis only.
669    pub anchor: bool,
670    /// Out-of-flow positioning; see [`FloatConfig`].
671    pub float: Option<FloatConfig>,
672}
673
674impl Default for LayoutSpec {
675    fn default() -> Self {
676        Self {
677            width: Sizing::Fit,
678            height: Sizing::Fit,
679            min_w: Min::AUTO,
680            max_w: f32::INFINITY,
681            min_h: Min::AUTO,
682            max_h: f32::INFINITY,
683            dir: Dir::Column,
684            padding: Edges::default(),
685            gap: 0.0,
686            wrap: false,
687            table: false,
688            cross_gap: 0.0,
689            main_align: Align::Start,
690            cross_align: Align::Start,
691            aspect: 0.0,
692            clip: false,
693            scroll_x: false,
694            scroll_y: false,
695            anchor: false,
696            float: None,
697        }
698    }
699}
700
701impl LayoutSpec {
702    /// Whether this node clips its children.
703    pub fn clips(&self) -> bool {
704        self.clip || self.scroll_x || self.scroll_y
705    }
706
707    /// Whether this node is a table: the flag, on a column. Every reader
708    /// asks this and not the field, so a `Row` with the field set is a row
709    /// everywhere.
710    pub fn is_table(&self) -> bool {
711        self.table && self.dir == Dir::Column
712    }
713}
714
715impl LayoutSpec {
716    /// The width a declared aspect ratio gives a `Fit` width: its `Fixed`
717    /// height times the ratio. `None` when the ratio has no say over the
718    /// width.
719    pub(crate) fn aspect_width(&self) -> Option<f32> {
720        match (self.width, self.height) {
721            (Sizing::Fit, Sizing::Fixed(h)) if self.aspect > 0.0 => {
722                Some(self.clamp_h(h) * self.aspect)
723            }
724            _ => None,
725        }
726    }
727
728    /// Whether a declared aspect ratio sizes the height: a `Fit` height,
729    /// read off the final width. `aspect_width`'s pair.
730    pub(crate) fn aspect_height(&self) -> bool {
731        self.aspect > 0.0 && self.height == Sizing::Fit
732    }
733
734    pub(crate) fn clamp_w(&self, w: f32) -> f32 {
735        let min = self.min_w.resolved();
736        w.clamp(min, self.max_w_px().max(min))
737    }
738
739    pub(crate) fn clamp_h(&self, h: f32) -> f32 {
740        let min = self.min_h.resolved();
741        h.clamp(min, self.max_h_px().max(min))
742    }
743
744    /// `max_w` as px: a calc layout has not resolved yet is no ceiling.
745    pub fn max_w_px(&self) -> f32 {
746        if self.max_w < 0.0 {
747            f32::INFINITY
748        } else {
749            self.max_w
750        }
751    }
752
753    /// `max_h` as px, as [`Self::max_w_px`].
754    pub fn max_h_px(&self) -> f32 {
755        if self.max_h < 0.0 {
756            f32::INFINITY
757        } else {
758            self.max_h
759        }
760    }
761}
762
763/// The paint half of a [`NodeSpec`]: background, border, corner radii,
764/// opacity, shadow and pixel snapping.
765#[derive(Clone, Copy, Debug, PartialEq)]
766pub struct VisualStyle {
767    pub bg: Color,
768    pub border_color: Color,
769    pub border_w: f32,
770    /// Corner radii (logical px), clockwise from the top-left:
771    /// `[tl, tr, br, bl]`. `NodeSpec::radius` sets all four; the per-corner
772    /// builders (`radius_tl`, ...) override one — later calls win, like CSS
773    /// `border-radius` followed by `border-top-left-radius`.
774    pub radius: [f32; 4],
775    /// Group opacity, 0..=1 and 1 by default: multiplied into the alpha of
776    /// every quad this node and its subtree emit, and into every
777    /// descendant's own opacity. This is the *cheap* group opacity — a
778    /// per-quad alpha multiply, not an offscreen composite — so a subtree
779    /// whose own pieces overlap shows its seams through the fade where a
780    /// compositing implementation would not. Nothing else changes: an
781    /// invisible subtree still lays out, still takes clicks and is still
782    /// read by assistive technology, exactly like CSS `opacity: 0`.
783    pub opacity: f32,
784    /// The drop shadow cast behind this node (see [`Shadow`]).
785    pub shadow: Shadow,
786    /// Paint the background, border, shadow and fragment with each edge on
787    /// a whole physical pixel (`pixelSnap`). Off by default: a box is drawn where
788    /// layout put it, so a gap between two boxes is there at any scale.
789    /// On, its edges land where a text's backgrounds' do and where every
790    /// other snapped box's do, so snapped boxes that share an edge in
791    /// layout, and a snapped box beside a text's background, meet without
792    /// a seam. Layout, hit-testing and the children are untouched.
793    pub pixel_snap: bool,
794}
795
796impl Default for VisualStyle {
797    fn default() -> Self {
798        Self {
799            bg: Color::TRANSPARENT,
800            border_color: Color::TRANSPARENT,
801            border_w: 0.0,
802            radius: [0.0; 4],
803            opacity: 1.0,
804            shadow: Shadow::default(),
805            pixel_snap: false,
806        }
807    }
808}
809
810/// One outer drop shadow: the node's rounded rect, moved by `dx`/`dy`,
811/// grown by `spread` and its edge blurred over `blur`, painted in `color`
812/// behind the node. CSS's `box-shadow` without the inset and multi-shadow
813/// forms.
814///
815/// It draws whenever `color` is visible, so `shadowColor` alone is a hard
816/// shadow sitting exactly behind the node. The shape is not knocked out of
817/// the middle the way CSS knocks it out, so a translucent background shows
818/// the shadow through itself.
819#[derive(Clone, Copy, Debug, Default, PartialEq)]
820pub struct Shadow {
821    pub color: Color,
822    /// Offset (logical px); positive `dy` casts downward.
823    pub dx: f32,
824    pub dy: f32,
825    /// Blur radius (logical px): the edge ramps over this distance and the
826    /// shadow reaches this far past its shape. 0 = a hard edge.
827    pub blur: f32,
828    /// Grows (or, negative, shrinks) the shape before blurring.
829    pub spread: f32,
830}
831
832impl Shadow {
833    /// Whether anything would be painted.
834    pub fn is_visible(&self) -> bool {
835        self.color.is_visible()
836    }
837}
838
839/// Corner indices into `VisualStyle::radius` / `Quad::radius`.
840pub mod corner {
841    pub const TL: usize = 0;
842    pub const TR: usize = 1;
843    pub const BR: usize = 2;
844    pub const BL: usize = 3;
845}
846
847/// Everything one node declares. This, not any Rust trait, is the contract
848/// every frontend (Rust builders, Lua, JSX, C) lowers into. Start from
849/// [`NodeSpec::row`], [`NodeSpec::column`] or [`NodeSpec::table`] and
850/// chain builders; see the [module docs](self) for an example.
851#[derive(Clone, Debug, Default)]
852pub struct NodeSpec {
853    pub layout: LayoutSpec,
854    pub style: VisualStyle,
855    /// Track pointer hover for this node (`Ui::is_hovered`) without making
856    /// it clickable — tooltips on passive badges. Nodes with `on_click` /
857    /// `on_key` / `window` are always hover-tracked; clicks on a merely
858    /// hoverable node emit nothing.
859    pub hoverable: bool,
860    /// Ask the driver for another frame after this one, every frame this
861    /// node is declared (`animate`). What a `fragment` reading `time`
862    /// needs; opt-in, because it takes the loop off input-driven.
863    pub animate: bool,
864    /// Paint this node's background in the theme's accent: the OS's where
865    /// the host reported one, the app's where it pinned one, kui's blue
866    /// otherwise. A view says *that* this node is the accented one and the
867    /// palette says which colour that is. The stock button also repaints
868    /// its hover, pressed shade and label from the same accent.
869    pub accent: bool,
870    /// Window-chrome role (drag handle / window button). A chrome node's
871    /// interactions become `WindowCommand`s for the frame driver instead of
872    /// `UiEvent`s; `on_click` is ignored on such nodes.
873    pub window: Option<WindowRole>,
874    /// Eases this node's sizing amounts, colors and radius toward what the
875    /// view declares instead of snapping (see [`crate::anim`]). Keyed by
876    /// node identity, so the node needs a stable key across frames.
877    pub transition: Option<Transition>,
878    /// With `transition`: also ease this node's laid-out *position*, moving
879    /// its whole subtree — reordered siblings slide into their new slots.
880    /// Opt-in because a node whose position follows an already-easing
881    /// sibling (a split's second half) would lag twice.
882    pub slide: bool,
883    /// Reachable by Tab, and focused by a click or an assistive-technology
884    /// request, without a click payload or a control role — a list row
885    /// that opens on Enter, a card. Controls (editors, key sinks,
886    /// `on_click` boxes, the control roles) are focusable already.
887    pub focusable: bool,
888    /// Where focus lands when the `modal` scope containing this node is
889    /// entered: the first node in the modal's Tab ring declaring it,
890    /// instead of simply the ring's first — a destructive confirm opening
891    /// on its Cancel rather than on whichever control is declared first.
892    /// Read on entry only, so a Tab press afterwards stands; a node the
893    /// ring skips (disabled, decoration, not focusable) is not a
894    /// candidate, and with no candidate the entry is the ring's first
895    /// node as before.
896    pub initial_focus: bool,
897    /// Inert: keeps its hit region (so a tooltip can say why) and loses
898    /// everything else — no click, drag or key sink, no hover / pressed /
899    /// focus background, no place in the Tab ring; the access tree
900    /// reports it disabled.
901    pub disabled: bool,
902    /// The pointer shape over this node (see [`crate::cursor`]). Unset,
903    /// the pointer is the I-beam over an editor or a selection scope and
904    /// the plain arrow over everything else — a clickable or draggable
905    /// node included — so a hand over a button, a grab over a handle
906    /// (`grabbing` while its drag runs), a splitter's resize arrows and a
907    /// disabled control's `notAllowed` are all the view's to declare. The
908    /// stock button declares `Pointer` itself.
909    pub cursor: Option<CursorShape>,
910
911    /// See [`EventSpec`]. `None` when the node declares none of it.
912    pub events: Option<Box<EventSpec>>,
913
914    /// See [`AnimSpec`]. `None` when the node declares none of it.
915    pub anim: Option<Box<AnimSpec>>,
916
917    /// See [`AccessSpec`]. `None` when the node declares none of it.
918    pub access: Option<Box<AccessSpec>>,
919
920    /// See [`InteractSpec`]. `None` when the node declares none of it.
921    pub interact: Option<Box<InteractSpec>>,
922}
923
924/// Event payloads a node declares. Boxed on `NodeSpec` because most
925/// nodes declare none.
926#[derive(Clone, Debug, Default, PartialEq)]
927pub struct EventSpec {
928    /// Payload emitted as a `UiEvent` when this node is clicked.
929    pub on_click: Option<Value>,
930    /// Makes this node draggable: pressing it starts a pointer-captured
931    /// drag, and cursor motion until release emits `UiEvent`s of the form
932    /// `{kind="drag", phase="start"|"move"|"end", x, y, dx, dy, tag}` with
933    /// this payload merged in under `tag`. A drag past the click slop
934    /// suppresses the node's `on_click`, so both can coexist.
935    pub on_drag: Option<Value>,
936    /// Marks this node as a key sink: while it holds key focus, key
937    /// presses arrive as `UiEvent`s on it as `{kind="key", phase="down",
938    /// code, ...}`, with this payload merged in under `tag`. Clicking the
939    /// node takes key focus. Releases are not delivered unless the sink
940    /// also declares [`key_up`](Self::key_up): a keymap is the common
941    /// case, and a keymap that heard both halves would run every binding
942    /// twice.
943    pub on_key: Option<Value>,
944    /// With `on_key`: the sink hears releases too, as the same payload
945    /// with `phase="up"` (`text` null, `repeat` false). For a held-key
946    /// interaction — WASD, press-and-hold to preview, a key that arms a
947    /// mode while it is down. A key only comes up where it went down: a
948    /// release whose press the sink never got is dropped, and focus
949    /// leaving while a key is held delivers the `up` first, so nothing is
950    /// left stuck down. Without it a sink hears presses only, which is
951    /// what a keymap wants.
952    pub key_up: bool,
953    /// With `on_key`: the modifier and lock keys themselves arrive too
954    /// (Shift, Ctrl, Alt, Super, Caps Lock, Num Lock, Scroll Lock), as
955    /// codes of their own with their side in `location`.
956    /// Without it a modifier is only ever held — in the next key's
957    /// `shift` / `ctrl` / … and the `modifiers` event — so a keymap
958    /// mid-sequence does not read Shift as a key between two others. A
959    /// terminal speaking kitty's keyboard protocol asks, and so does a
960    /// game that binds a lone Shift.
961    pub modifier_keys: bool,
962    /// Asks for a context menu: a secondary-button press over this node
963    /// emits `{kind="contextmenu", x, y, tag}` on it with this payload
964    /// under `tag`, and does nothing else — the press moves no focus,
965    /// places no caret and produces no click, so right-clicking a
966    /// selection leaves it selected. `x`/`y` are the press in logical
967    /// viewport coordinates, which is where the menu goes. Asked of the
968    /// topmost node under the pointer; when that node offers no menu the
969    /// press reaches the nearest enclosing node that does, the way an
970    /// unclaimed key reaches the enclosing sink:
971    /// the event carries the owner's key and tag, a nested declaration
972    /// wins over its ancestor's, a disabled node's own is skipped, and
973    /// the walk stops at the modal boundary. Null = the behaviour without
974    /// a tag.
975    pub on_context_menu: Option<Value>,
976    /// Force-click events: a press that deepened past the second stage of
977    /// a Force Touch trackpad over this node emits `{kind="forceclick",
978    /// x, y, tag}` with this payload under `tag`. Routed as a secondary
979    /// press is — no focus moved, no caret, no click — but asked of the
980    /// topmost node only, with no walk to an enclosing declaration — and
981    /// the ordinary click the press produces still follows,
982    /// which is what macOS does.
983    ///
984    /// Text does not need this: a force click over an editor or a
985    /// `selectable` scope selects the word and asks the host to look it
986    /// up, which is what the gesture means on that platform. This is for
987    /// what the core cannot guess — a force click on a chart, a map, a
988    /// timeline.
989    pub on_force_click: Option<Value>,
990    /// The non-primary buttons as events: a press of a
991    /// button in [`buttons`](Self::buttons) over this node emits
992    /// `{kind="button", phase="press", button, x, y, clicks, tag}` on it
993    /// with this payload under `tag`, and the button is then captured by
994    /// the node — every pointer move while it is held arrives as
995    /// `phase="move"` and its release as `phase="release"`, on this node
996    /// wherever the pointer is. `button` is `"secondary"`, `"middle"` or,
997    /// for a button past those, its [`crate::MouseButton::code`]; `x`/`y`
998    /// are logical viewport coordinates, and on a `cells` grid the events
999    /// carry `cell: {row, col}` as a click does. Several buttons may be
1000    /// held at once, each its own capture; a primary drag is untouched.
1001    ///
1002    /// Asked of the topmost node under the pointer, and when that node
1003    /// claims no such button the press reaches the nearest enclosing node
1004    /// that does, as a context menu's does: a disabled node's own is
1005    /// skipped and the walk stops at the modal boundary. A claimed
1006    /// secondary press is this event *instead of* a `contextmenu` event
1007    /// and the stock menu — a nearer `on_context_menu` still wins, being
1008    /// the nested declaration. Like every non-primary press it moves no
1009    /// focus, places no caret and touches no selection or scrollbar. What
1010    /// it is for: a terminal's middle-click paste, and the mouse reports a
1011    /// program in it asked for. Null = the behaviour without a tag.
1012    pub on_button: Option<Value>,
1013    /// Which non-primary buttons [`on_button`](Self::on_button) claims:
1014    /// all three kinds unless the node says otherwise. A pane that wants
1015    /// the middle button and leaves the secondary one to its context menu
1016    /// says [`Buttons::MIDDLE`].
1017    pub buttons: Buttons,
1018    /// Scroll events: the wheel over this node emits `{kind="scroll", x,
1019    /// y, dx, dy, lines, tag}` with this payload under `tag` — the delta
1020    /// in logical px as the driver reported it (positive `dy` is the wheel
1021    /// rolling up, toward earlier content), the pointer's position, and
1022    /// on a `cells` grid the whole lines the delta covers (`null` on any
1023    /// other node), the fraction carried to the next notch. The node
1024    /// *takes* the wheel on the axes [`scroll_axes`](Self::scroll_axes)
1025    /// names: a scroll gesture that starts over it is its own, and stays
1026    /// its own until it ends wherever the pointer goes, except on an axis
1027    /// it also scrolls as a container (`scroll_x`, `scroll_y`, the offset
1028    /// the app sets from what it hears), where it is answered by its room
1029    /// as a container is: at its edge, a gesture that way passes to the
1030    /// scroller around it; it
1031    /// reaches no scroll container above it, and a container inside it
1032    /// still takes the axes it scrolls while it can move that way,
1033    /// passing this node the rest: the other axis, and a gesture that
1034    /// begins with the container at its limit (unless it says
1035    /// [`Overscroll::Contain`]). The core moves nothing — a grid's
1036    /// `origin_line` and a canvas's zoom are the app's to change. A
1037    /// drag-select held past a grid's top or bottom edge arrives here
1038    /// too, as the lines the frame scrolled by.
1039    pub on_scroll: Option<Value>,
1040    /// Which axes [`on_scroll`](Self::on_scroll) takes: both unless the
1041    /// node says otherwise. A scroll gesture on an axis
1042    /// the node does not take passes it by, to the scroller around it —
1043    /// a terminal that scrolls its history on `y` says
1044    /// [`ScrollAxes::Y`], and a sideways swipe that meets it goes on
1045    /// moving the strip it sits in. Meaningless without `on_scroll`.
1046    pub scroll_axes: ScrollAxes,
1047    /// The modifiers [`on_scroll`](Self::on_scroll) is for (backlog
1048    /// F122): with any named, the node hears only a scroll gesture that
1049    /// began with one of them held — and hears it *first*, wherever in
1050    /// the tree under the pointer the gesture began: ahead of every
1051    /// scroll container and every handler that names none, the innermost
1052    /// such node winning. A wheel with none of them held passes it by as
1053    /// if it declared no `on_scroll` — a node that is a scroll container
1054    /// too scrolls for it as any other does. What a Ctrl-wheel zoom is declared
1055    /// with, on the window's root or on the one canvas it zooms: a
1056    /// modified wheel is the more specific ask, and no list under the
1057    /// pointer scrolls for it. Its events carry `mods`, the modifiers
1058    /// held when the gesture began — the gesture stays this node's to
1059    /// its end, glide included, whatever is let go meanwhile. None named
1060    /// (the default): a handler like any other. Meaningless without
1061    /// `on_scroll`.
1062    pub scroll_mods: crate::input::KeyMods,
1063    /// Hover events: the pointer entering or leaving this node emits
1064    /// `{kind="hover", phase="enter"|"leave", tag}` with this payload under
1065    /// `tag` — for hover-dependent *layout* (a close button that appears)
1066    /// where a color swap isn't enough. Implies hover tracking.
1067    pub on_hover: Option<Value>,
1068    /// Drop-zone events: files dragged in from the OS over this node emit
1069    /// `{kind="drop", phase="enter"|"move"|"leave"|"drop", paths, x, y,
1070    /// tag}` with this payload under `tag` — `paths` the OS paths as
1071    /// strings, `x`/`y` the pointer in viewport coordinates (absent on
1072    /// `leave`). The zone under the files is the topmost *zone* by paint
1073    /// order: a node inside a zone resolves to it, and a node that is no
1074    /// zone and has none enclosing it is looked past, so an overlay shown
1075    /// on `enter` cannot make the zone lose the files. No `leave` follows
1076    /// a `drop`. Implies hover tracking.
1077    pub on_drop: Option<Value>,
1078    /// Layout events: the rect layout gave this node arrives as
1079    /// `{kind="layout", x, y, w, h, parent: {x, y, w, h}, tag}` (logical px,
1080    /// viewport coordinates, after scrolling and position easing) — on the
1081    /// node's first frame and again whenever the rect changes, never on a
1082    /// frame that left it alone. The view reads the numbers layout already
1083    /// produced instead of re-deriving them; a transition that moves the
1084    /// node reports every frame it moves. Needs a stable key across frames.
1085    pub on_layout: Option<Value>,
1086    /// Slider changes: on a node whose role is `Slider`, the core turns a
1087    /// press into the value under the pointer, a drag into the value under
1088    /// it, the arrows and assistive technology's Increment / Decrement
1089    /// into one `value_step`, PageUp / PageDown into ten, Home / End into
1090    /// the range's ends — clamped to `value_min..value_max`, snapped to the
1091    /// step — and emits `{kind="change", value, phase="move"|"end", tag}`
1092    /// with this payload under `tag`. The value is proposed, never
1093    /// applied: nothing moves until the view declares it as `value_now`.
1094    /// Without it a slider's keys reach the app as the `access` nudge.
1095    /// Ignored on any other role.
1096    pub on_change: Option<Value>,
1097    /// Modal: while this node is declared, the Tab ring is its subtree,
1098    /// everything outside it is inert to the pointer, the wheel and
1099    /// assistive technology, and Escape or a press outside emits
1100    /// `{kind="dismiss", reason, tag}` on it with this payload under
1101    /// `tag`. The last node declaring it in tree order is the one in
1102    /// effect (a confirm inside a dialog). Null = modal without a tag.
1103    pub modal: Option<Value>,
1104    /// A press on this node, or anywhere inside it, leaves keyboard focus
1105    /// where it was (`keepFocus`): a toolbar button, a tab, a divider
1106    /// that acts without taking the keyboard from the editor beside it.
1107    /// Its click, drag and hover are unchanged, and Tab
1108    /// and assistive technology still reach a focusable node in it — it
1109    /// is the pointer's press alone that stops moving focus.
1110    pub keep_focus: bool,
1111    /// Keyboard focus entering or leaving this node's subtree — the node
1112    /// itself or anything focused inside it — emits `{kind="focus",
1113    /// phase="in"|"out", by, tag}` with this payload under `tag`, where
1114    /// `by` is `"pointer"`, `"keyboard"`, `"assistive"` or `"program"`:
1115    /// what moved it. Reported once the move has settled —
1116    /// after the input that made it, or at the end of the frame that
1117    /// declared it — so a view reads a change instead of diffing
1118    /// `key_focus` every frame. Declares nothing interactive.
1119    pub on_focus: Option<Value>,
1120}
1121
1122impl EventSpec {
1123    /// The group as a node that declares none of it — what
1124    /// `NodeSpec`'s accessor hands back when the box is `None`.
1125    pub const EMPTY: Self = Self {
1126        on_click: None,
1127        on_drag: None,
1128        on_key: None,
1129        key_up: false,
1130        modifier_keys: false,
1131        on_context_menu: None,
1132        on_force_click: None,
1133        on_button: None,
1134        buttons: Buttons::ALL,
1135        on_scroll: None,
1136        scroll_axes: ScrollAxes::Both,
1137        scroll_mods: crate::input::KeyMods::NONE,
1138        on_hover: None,
1139        on_drop: None,
1140        on_layout: None,
1141        on_change: None,
1142        modal: None,
1143        keep_focus: false,
1144        on_focus: None,
1145    };
1146}
1147
1148/// Per-node animation declarations. Boxed on `NodeSpec`: `enter` and
1149/// `exit` are 60 bytes each and almost every node has neither.
1150#[derive(Clone, Debug, Default, PartialEq)]
1151pub struct AnimSpec {
1152    /// CSS-style stops for the animatable slots (see [`crate::keyframes`]):
1153    /// with a `transition`, the slots a stop names cycle through the stops
1154    /// over the transition's duration, in its `repeat` direction, offset by
1155    /// its `delay_ms` — forever, and without the view redrawing. Slots no
1156    /// stop names still tween toward what the view declares. Empty = none.
1157    pub keyframes: Vec<Keyframe>,
1158    /// Where this node's slots start the first frame it is seen (see
1159    /// [`crate::enter`]): with a `transition`, the slots it names ease in
1160    /// from there instead of snapping — `dx`/`dy` slide the node in from
1161    /// that far away, `bg` fades it in. A node that vanishes and returns
1162    /// enters again. None = first sight snaps.
1163    pub enter: Option<Enter>,
1164    /// Where this node's slots *end* the frame after the view stops
1165    /// declaring it (see [`crate::depart`]). An exit is an [`Enter`] read
1166    /// the other way: with a `transition`, the departing subtree is copied
1167    /// out of the last frame that had it and replayed — frozen where
1168    /// layout left it, on top, inert — while the slots this names ease
1169    /// from where they were toward what it declares. Needs a stable key
1170    /// across frames, and a `transition` with a duration; without both, a
1171    /// removed node vanishes at once as it always did.
1172    pub exit: Option<Enter>,
1173}
1174
1175impl AnimSpec {
1176    /// The group as a node that declares none of it — what
1177    /// `NodeSpec`'s accessor hands back when the box is `None`.
1178    pub const EMPTY: Self = Self {
1179        keyframes: Vec::new(),
1180        enter: None,
1181        exit: None,
1182    };
1183}
1184
1185/// Accessibility properties a view states outright, as opposed to the
1186/// ones the core derives (see [`crate::access`]). Boxed on `NodeSpec`:
1187/// read only while an access tree is being built, and unset on nearly
1188/// every node.
1189#[derive(Clone, Debug, Default, PartialEq)]
1190pub struct AccessSpec {
1191    /// What this node is to assistive technology (see [`crate::access`]).
1192    /// Unset, the core derives one: a node with `on_click` is a button,
1193    /// an editor a text input, a scrolling container a scroll view, and
1194    /// a plain box is structure that leaves no trace. `Role::None` hides
1195    /// the node and its subtree from the access tree (decoration).
1196    pub role: Option<Role>,
1197    /// The accessible name. Without one a button, link, tab or heading is
1198    /// named by the text inside it; an image or an icon button has no
1199    /// name at all, and the core says so (`control-without-name`,
1200    /// `image-without-label` warnings).
1201    pub label: Option<Label>,
1202    /// The accessible description, read after the name — what the
1203    /// `description` prop sets, and what the `tooltip` prop sets on the way
1204    /// to drawing the same string.
1205    pub description: Option<Label>,
1206    /// For checkbox / radio / switch roles: the on state.
1207    pub checked: bool,
1208    /// For a checkbox: neither on nor off, like the select-all box over a
1209    /// list some of whose rows are selected. Wins over `checked`, which it
1210    /// leaves as it was.
1211    pub mixed: bool,
1212    /// The current one of a set: a `Role::Tab`, a picked `Role::ListItem`,
1213    /// the `Role::Link` for the page you are on. A tab reports the state
1214    /// either way; a row or a link reports it only where it is set (see
1215    /// [`crate::access`]).
1216    pub selected: bool,
1217    /// For a node that shows and hides something: expanded, or collapsed.
1218    /// None = it does not expand, and says nothing about it.
1219    pub expanded: Option<bool>,
1220    /// For a slider role: the current value and its range, so assistive
1221    /// technology can read the position (the drawing stays the view's).
1222    pub value_now: Option<f32>,
1223    pub value_min: Option<f32>,
1224    pub value_max: Option<f32>,
1225    /// For a slider role: what the position *reads as* (ARIA's
1226    /// `aria-valuetext`). Without one a reader has only the three numbers
1227    /// above and says a percentage — 25 in [5..60] is "36 percent" — so a
1228    /// value whose unit matters says it here: "25 minutes". It replaces
1229    /// the number rather than joining it (see [`crate::access`]), and a
1230    /// nudge announces the new text, not the new number.
1231    pub value_text: Option<Label>,
1232    /// For a slider role: how far one arrow key moves it, and the grid a
1233    /// value set by the pointer snaps to. None = a hundredth of the range.
1234    pub value_step: Option<f32>,
1235    /// On a `Role::Line` of a custom editor: the caret's byte offset into
1236    /// the line's text, and the byte offset of the selection's other end
1237    /// (see [`crate::access`]).
1238    pub caret: Option<u32>,
1239    pub selection_anchor: Option<u32>,
1240    /// With `caret`: the caret this line declares does not blink — a
1241    /// block caret in a modal editor's normal mode — so a driver's blink
1242    /// clock is not armed on it (`Core::has_caret` leaves it out) while
1243    /// the offset still anchors the IME and reads to assistive
1244    /// technology. Without it a declared caret is a caret to blink.
1245    pub caret_solid: bool,
1246    /// Float `description` below the node while it is hovered — the
1247    /// `tooltip` prop's third effect, set by [`NodeSpec::tooltip`]. The core
1248    /// reads it as the node opens (`Core::hint`); a binding that lowers the
1249    /// prop onto a box floats the hint itself and leaves this off. A leaf
1250    /// reads it as it is pushed and floats the hint beside itself, anchored
1251    /// to it, since it holds no children for the hint to be the last of —
1252    /// which is how a binding asks it of a leaf (`PropsOut::for_leaf`,
1253    /// backlog RG113).
1254    pub tooltip: bool,
1255    /// When the text inside this node changes, a reader reads the change
1256    /// without being asked (ARIA's `aria-live`). Off by default; a node
1257    /// that declares it is semantic, so a plain box marked live is not
1258    /// elided.
1259    pub live: Live,
1260}
1261
1262impl AccessSpec {
1263    /// The group as a node that declares none of it — what
1264    /// `NodeSpec`'s accessor hands back when the box is `None`.
1265    pub const EMPTY: Self = Self {
1266        role: None,
1267        label: None,
1268        description: None,
1269        checked: false,
1270        mixed: false,
1271        selected: false,
1272        expanded: None,
1273        value_now: None,
1274        value_min: None,
1275        value_max: None,
1276        value_text: None,
1277        value_step: None,
1278        caret: None,
1279        selection_anchor: None,
1280        caret_solid: false,
1281        tooltip: false,
1282        live: Live::Off,
1283    };
1284}
1285
1286/// Hover / pressed / focus styling and the sounds that go with them.
1287/// Boxed on `NodeSpec` so the common node — which declares none of it —
1288/// costs one null check in `resolve_hover_style` instead of reading
1289/// several `Option`s spread across the struct.
1290#[derive(Clone, Debug, Default, PartialEq)]
1291pub struct InteractSpec {
1292    /// Background while the pointer hovers this node (or any node sharing
1293    /// its `hover_group`). Resolved by the core when the node opens, so a
1294    /// data-only view gets hover styling without querying `is_hovered` —
1295    /// and with `transition` the swap eases. Implies hover tracking.
1296    pub hover_bg: Option<Color>,
1297    /// Background while this node (or its group) is pressed. Implies hover
1298    /// tracking. Without a `hover_bg`, hover keeps the plain `bg`. An
1299    /// `on_drag` node holds this state for the whole captured drag, even
1300    /// while the cursor is off it.
1301    pub pressed_bg: Option<Color>,
1302    /// Hover group: nodes sharing an id count as one for `hover_bg` /
1303    /// `pressed_bg` — a two-piece elbow, a split button, a row whose cells
1304    /// highlight together. The id is a hash of a name (`hover_group`).
1305    /// Implies hover tracking.
1306    pub hover_group: Option<u64>,
1307    /// A registered sound played when this node is clicked (see
1308    /// [`crate::audio`]); the click itself still emits `on_click` if one is
1309    /// declared. Implies hover tracking.
1310    pub click_sound: Option<crate::resources::SoundId>,
1311    /// A registered sound played when the pointer enters this node.
1312    /// Implies hover tracking.
1313    pub hover_sound: Option<crate::resources::SoundId>,
1314    /// Background while this node holds keyboard-visible focus (focus
1315    /// moved by Tab or by assistive technology, not by a click).
1316    /// Declaring one replaces the ring the core draws by default. Pressed
1317    /// wins over focus wins over hover; eases with `transition`.
1318    pub focus_bg: Option<Color>,
1319    /// Background while files dragged in from the OS are over this node.
1320    /// Wins over pressed, focus and hover — a press
1321    /// cannot be held while the OS holds a drag — and eases with
1322    /// `transition`; clears when the files leave, land or the drag is
1323    /// cancelled. Implies hover tracking.
1324    pub drop_bg: Option<Color>,
1325    /// Makes this node a *selection scope*: the text of every node inside
1326    /// it is one selectable run of text, in tree order, and a press-drag
1327    /// inside it selects across all of them. Declared on the container
1328    /// rather than on each label, because what a reader selects is a
1329    /// paragraph or a card, not one run of it.
1330    ///
1331    /// Scopes do not nest: the innermost one containing a run owns it, and
1332    /// an outer one is warned about (`nested-selection-scope`). An `edit`
1333    /// is already its own scope and ignores this.
1334    pub selectable: bool,
1335    /// Makes this node's subtree a *focus region*: a Tab ring of its own
1336    /// that the ring outside never enters, and that never leaves — a
1337    /// devtools dock, an inspector beside the app. Entered on purpose:
1338    /// `Ui::focus_region`, a press inside it, or an explicit focus on a
1339    /// node in it. Nothing else about the node changes — it lays out,
1340    /// paints, takes the pointer and appears in the access tree as before,
1341    /// and keys bubble through it to the sink above.
1342    pub focus_region: bool,
1343    /// How this node's scrollbars look, when it scrolls (see
1344    /// [`Scrollbar`]). Cold: read once per scroller when its layer's
1345    /// chrome is emitted, which is why it lives in this box rather than
1346    /// beside `scroll_y` on every node.
1347    pub scrollbar: Scrollbar,
1348    /// Whether a scroll gesture that starts over this scroller while it
1349    /// is at its limit that way goes on to the scroller around it (see
1350    /// [`Overscroll`]). Cold like `scrollbar`: read once
1351    /// per scroller a gesture starts over.
1352    pub overscroll: Overscroll,
1353    /// On a table: lines of this colour between its columns and between
1354    /// its rows, drawn with the table's own box, under its cells, down the
1355    /// middle of each gap, so a table with a `gap` of at least `rule_w`
1356    /// gets a grid with no rule cells. The
1357    /// columns come from the row with the most cells; the lines run the
1358    /// table's content box. Ignored on anything that is not a table.
1359    pub rules: Option<Color>,
1360    /// The rules' width in logical px; 0 is 1.
1361    pub rule_w: f32,
1362    /// A gradient painted over the node's `bg` and under its border and
1363    /// its children (`docs/adr/0042-a-gradient-is-an-image-the-core-paints.md`):
1364    /// one image quad from the atlas, rounded by the node's radius. It
1365    /// does not tween, and the state backgrounds replace `bg`, not it.
1366    pub gradient: Option<crate::gradient::Gradient>,
1367}
1368
1369/// A scrolling node's bars, per node. Every field's default is the stock
1370/// bar — the theme's `scrollbar` / `scrollbar_active` colours, 4 px at
1371/// rest and 6 px under the pointer, always drawn while the content
1372/// overflows — so a binding that sets none of the four rows gets exactly
1373/// what it always had. The bars are overlays and take no layout space
1374/// whatever their width; the grabbable track is at least as wide as the
1375/// active thumb plus its inset.
1376#[derive(Clone, Copy, Debug, Default, PartialEq)]
1377pub struct Scrollbar {
1378    /// Whether the bars are drawn at all, and when (see [`ScrollbarMode`]).
1379    pub mode: ScrollbarMode,
1380    /// The thumb's width at rest, logical px; under the pointer or dragged
1381    /// it is 2 px wider. `None` is the stock 4.
1382    pub width: Option<f32>,
1383    /// The thumb at rest; `None` is `theme.scrollbar`.
1384    pub color: Option<Color>,
1385    /// The thumb under the pointer or dragged; `None` is
1386    /// `theme.scrollbar_active`.
1387    pub active_color: Option<Color>,
1388}
1389
1390impl Scrollbar {
1391    /// The stock bar: visible, 4 px, in the theme's colours.
1392    pub const DEFAULT: Self = Self {
1393        mode: ScrollbarMode::Visible,
1394        width: None,
1395        color: None,
1396        active_color: None,
1397    };
1398}
1399
1400/// When a scrolling node's bars are drawn. Spelled by the `scrollbar` row
1401/// (`crate::schema::SCROLLBARS`, in this order).
1402#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
1403pub enum ScrollbarMode {
1404    /// The stock bar: drawn whenever the content overflows.
1405    #[default]
1406    Visible,
1407    /// No thumb is drawn and no track takes the press. The wheel, the
1408    /// keyboard, `reveal` and the caret still scroll the node — a list
1409    /// drawing its own indicator, or one whose bar would sit on a border.
1410    Hidden,
1411    /// The bar shows while the scroll state is changing — the offset or
1412    /// the content's extent moved since the last frame, the pointer is on
1413    /// its track, or a thumb is being dragged — and for a second after,
1414    /// then fades out over a quarter of one. A node first seen shows its
1415    /// bar the same second. What an overlay bar does on macOS. Needs the
1416    /// driver's clock (`Core::set_time`); without one it is `Visible`,
1417    /// since a fade with no clock could never end.
1418    Auto,
1419}
1420
1421impl ScrollbarMode {
1422    /// Every mode, in the `scrollbar` row's order: what a binding that
1423    /// spells modes as numbers indexes (C's `KUI_SCROLLBAR_*` are these
1424    /// plus one).
1425    pub const ALL: [ScrollbarMode; 3] = [
1426        ScrollbarMode::Visible,
1427        ScrollbarMode::Hidden,
1428        ScrollbarMode::Auto,
1429    ];
1430}
1431
1432/// What a scroll gesture that starts over a scroller already at its limit
1433/// does: CSS's `overscroll-behavior`, spelled by the `overscroll` row.
1434///
1435/// A gesture picks its target when it starts: the innermost scroller
1436/// under the pointer that can still move the way it goes. One at its
1437/// limit is passed by, to the scroller around it — *chaining* — and
1438/// `Contain` stops that: the gesture is this scroller's, and moves
1439/// nothing until it turns back. Only on the axes the node scrolls, so a
1440/// `scroll_y` list that contains still passes a sideways swipe to the
1441/// strip it sits in, where CSS would stop that too. Decided at
1442/// the start only: a gesture that reaches a limit midway stops there
1443/// whatever this says, as a browser's does.
1444#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
1445pub enum Overscroll {
1446    /// The gesture goes on to the scroller around this one when this one
1447    /// is at its limit that way.
1448    #[default]
1449    Auto,
1450    /// A gesture that starts here stays here: a panel, a popup's list or
1451    /// a sheet whose scrolling must never move the page behind it.
1452    Contain,
1453}
1454
1455impl Overscroll {
1456    /// Every value, in the `overscroll` row's order (C's
1457    /// `KUI_OVERSCROLL_*` are these plus one).
1458    pub const ALL: [Overscroll; 2] = [Overscroll::Auto, Overscroll::Contain];
1459}
1460
1461/// Which axes an `on_scroll` node takes, spelled by the `scrollAxes` row.
1462#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
1463pub enum ScrollAxes {
1464    /// Both: the node hears every scroll gesture that starts over it.
1465    #[default]
1466    Both,
1467    /// Only sideways; a vertical gesture passes it by.
1468    X,
1469    /// Only vertical; a sideways gesture passes it by — a terminal's
1470    /// history, a log.
1471    Y,
1472}
1473
1474impl ScrollAxes {
1475    /// Every value, in the `scrollAxes` row's order (C's
1476    /// `KUI_SCROLL_AXES_*` are these plus one).
1477    pub const ALL: [ScrollAxes; 3] = [ScrollAxes::Both, ScrollAxes::X, ScrollAxes::Y];
1478
1479    /// Whether the node takes `x` (true) or `y` (false).
1480    pub fn takes(self, x: bool) -> bool {
1481        match self {
1482            ScrollAxes::Both => true,
1483            ScrollAxes::X => x,
1484            ScrollAxes::Y => !x,
1485        }
1486    }
1487}
1488
1489impl InteractSpec {
1490    /// The group as a node that declares none of it — what
1491    /// `NodeSpec`'s accessor hands back when the box is `None`.
1492    pub const EMPTY: Self = Self {
1493        hover_bg: None,
1494        pressed_bg: None,
1495        hover_group: None,
1496        click_sound: None,
1497        hover_sound: None,
1498        focus_bg: None,
1499        drop_bg: None,
1500        selectable: false,
1501        focus_region: false,
1502        scrollbar: Scrollbar::DEFAULT,
1503        overscroll: Overscroll::Auto,
1504        rules: None,
1505        rule_w: 0.0,
1506        gradient: None,
1507    };
1508}
1509
1510impl NodeSpec {
1511    // -- Boxed groups ------------------------------------------------------
1512    // The four cold groups are behind a pointer each: a node that
1513    // declares none of a group pays 8 bytes for it rather than its full
1514    // width. Reads go through the `&` accessor, which hands back a shared
1515    // empty group instead of allocating, so a caller reads
1516    // `spec.events().on_click` exactly as it used to read `spec.on_click`.
1517    // Writes go through the `_mut` accessor, which allocates on first use.
1518
1519    /// Event payloads this node declares, empty if it declares none.
1520    #[inline]
1521    pub fn events(&self) -> &EventSpec {
1522        static EMPTY: EventSpec = EventSpec::EMPTY;
1523        self.events.as_deref().unwrap_or(&EMPTY)
1524    }
1525
1526    /// Allocates the group on first write.
1527    #[inline]
1528    pub fn events_mut(&mut self) -> &mut EventSpec {
1529        self.events.get_or_insert_with(Box::default)
1530    }
1531
1532    /// Animation declarations, empty if this node has none.
1533    #[inline]
1534    pub fn anim(&self) -> &AnimSpec {
1535        static EMPTY: AnimSpec = AnimSpec::EMPTY;
1536        self.anim.as_deref().unwrap_or(&EMPTY)
1537    }
1538
1539    /// Allocates the group on first write.
1540    #[inline]
1541    pub fn anim_mut(&mut self) -> &mut AnimSpec {
1542        self.anim.get_or_insert_with(Box::default)
1543    }
1544
1545    /// Declared accessibility properties, empty if this node declares none.
1546    #[inline]
1547    pub fn access(&self) -> &AccessSpec {
1548        static EMPTY: AccessSpec = AccessSpec::EMPTY;
1549        self.access.as_deref().unwrap_or(&EMPTY)
1550    }
1551
1552    /// Allocates the group on first write.
1553    #[inline]
1554    pub fn access_mut(&mut self) -> &mut AccessSpec {
1555        self.access.get_or_insert_with(Box::default)
1556    }
1557
1558    /// Hover / pressed / focus styling, empty if this node declares none.
1559    #[inline]
1560    pub fn interact(&self) -> &InteractSpec {
1561        static EMPTY: InteractSpec = InteractSpec::EMPTY;
1562        self.interact.as_deref().unwrap_or(&EMPTY)
1563    }
1564
1565    /// Allocates the group on first write.
1566    #[inline]
1567    pub fn interact_mut(&mut self) -> &mut InteractSpec {
1568        self.interact.get_or_insert_with(Box::default)
1569    }
1570
1571    /// Whether the core registers a hit region for this node (any of the
1572    /// interaction props, or an explicit `hoverable`).
1573    pub fn hover_tracked(&self) -> bool {
1574        // Asked of every node at emission; the inline flags first, then
1575        // each boxed group once — a node that declares neither group is
1576        // answered by two null checks rather than a read per field.
1577        self.hoverable
1578            || self.focusable
1579            || self.window.is_some()
1580            // A `cursor` override has to be found under the pointer to be
1581            // read, even on an otherwise inert box.
1582            || self.cursor.is_some()
1583            || self.events.as_deref().is_some_and(|e| {
1584                // A modal's own background is not "outside" it: a press
1585                // there must find a region.
1586                e.modal.is_some()
1587                    || e.on_click.is_some()
1588                    || e.on_drag.is_some()
1589                    || e.on_key.is_some()
1590                    || e.on_context_menu.is_some()
1591                    || e.on_force_click.is_some()
1592                    || e.on_button.is_some()
1593                    || e.on_hover.is_some()
1594                    || e.on_drop.is_some()
1595                    || e.on_change.is_some()
1596            })
1597            || self.interact.as_deref().is_some_and(|i| {
1598                i.hover_bg.is_some()
1599                    || i.pressed_bg.is_some()
1600                    || i.drop_bg.is_some()
1601                    || i.hover_group.is_some()
1602                    || i.click_sound.is_some()
1603                    || i.hover_sound.is_some()
1604                    // A selection scope has to be found under the pointer:
1605                    // the press that starts a drag-select lands on it.
1606                    || i.selectable
1607                    // So does a focus region: a press on its dead space
1608                    // settles the ring there.
1609                    || i.focus_region
1610            })
1611    }
1612
1613    /// The group id `hover_group(name)` assigns — reproducible from any
1614    /// binding (the same FNV mix as `Key`).
1615    pub fn hover_group_id(name: &str) -> u64 {
1616        crate::key::Key::ROOT.str(name).0
1617    }
1618
1619    /// A container that lays its children out left to right.
1620    pub fn row() -> Self {
1621        Self {
1622            layout: LayoutSpec {
1623                dir: Dir::Row,
1624                ..Default::default()
1625            },
1626            ..Default::default()
1627        }
1628    }
1629
1630    /// A container that lays its children out top to bottom (the default).
1631    pub fn column() -> Self {
1632        Self {
1633            layout: LayoutSpec {
1634                dir: Dir::Column,
1635                ..Default::default()
1636            },
1637            ..Default::default()
1638        }
1639    }
1640
1641    /// A table: a column whose rows' children line up in columns. Its
1642    /// in-flow `Row` children are the rows and each row's in-flow children
1643    /// its cells; the nth cell of every row is column n, and a column is
1644    /// as wide as its widest cell, so a label column sits at its longest
1645    /// label with no width picked by hand.
1646    ///
1647    /// A cell's `width` says how its column sizes: `Fit` (the default) and
1648    /// `Fixed` are content the column's fit width is the max of, `Grow`
1649    /// makes the whole column grow with the table, and a column's
1650    /// `min_width` / `max_width` are the strictest its cells declared.
1651    /// Give the rows `width: grow` for the columns to grow into; a `Fit`
1652    /// row sits at the columns' fit width. Rows keep their own `gap`,
1653    /// padding, background, click and hover, and never wrap. A bare text
1654    /// or image straight inside a row is a cell too. A text, a column or a
1655    /// table straight under the table is a child with its own width and no
1656    /// cells. Everything else is a column's: `gap` is the space between
1657    /// rows, `scroll_y` scrolls them.
1658    ///
1659    /// ```rust
1660    /// use kui_core::{NodeSpec, Sizing};
1661    /// let table = NodeSpec::table().gap(4.0).rules(kui_core::Color::hex(0x80808080));
1662    /// let row = NodeSpec::row().width(Sizing::GROW).gap(12.0);
1663    /// assert!(table.layout.is_table() && !row.layout.is_table());
1664    /// ```
1665    pub fn table() -> Self {
1666        Self {
1667            layout: LayoutSpec {
1668                dir: Dir::Column,
1669                table: true,
1670                ..Default::default()
1671            },
1672            ..Default::default()
1673        }
1674    }
1675
1676    /// A [`Sizing`], or a number of px (`.width(120.0)`).
1677    #[inline]
1678    pub fn width(mut self, s: impl Into<Sizing>) -> Self {
1679        self.layout.width = s.into();
1680        self
1681    }
1682
1683    /// A [`Sizing`], or a number of px (`.height(24.0)`).
1684    #[inline]
1685    pub fn height(mut self, s: impl Into<Sizing>) -> Self {
1686        self.layout.height = s.into();
1687        self
1688    }
1689
1690    /// Both axes at once: `.size(20.0, 20.0)` for a fixed box,
1691    /// `.size(Sizing::GROW, 24.0)` for a strip.
1692    #[inline]
1693    pub fn size(self, w: impl Into<Sizing>, h: impl Into<Sizing>) -> Self {
1694        self.width(w).height(h)
1695    }
1696
1697    /// An equal share of the leftover width: `.width(Sizing::GROW)`.
1698    #[inline]
1699    pub fn grow_width(self) -> Self {
1700        self.width(Sizing::GROW)
1701    }
1702
1703    /// An equal share of the leftover height: `.height(Sizing::GROW)`.
1704    #[inline]
1705    pub fn grow_height(self) -> Self {
1706        self.height(Sizing::GROW)
1707    }
1708
1709    /// Grow along both axes.
1710    #[inline]
1711    pub fn fill(self) -> Self {
1712        self.grow_width().grow_height()
1713    }
1714
1715    /// A number of px, [`Min::FIT`] for the node's own fit width, or a
1716    /// [`Bound::Calc`].
1717    pub fn min_width(mut self, v: impl Into<Bound>) -> Self {
1718        self.layout.min_w = match v.into() {
1719            Bound::Px(px) if px == 0.0 && px.is_sign_negative() => Min::AUTO,
1720            Bound::Px(px) => Min::px(px),
1721            Bound::Fit => Min::FIT,
1722            Bound::Calc(c) => Min::calc(c),
1723        };
1724        self
1725    }
1726
1727    /// A number of px, or a [`Bound::Calc`]; a max has no fit size, so
1728    /// [`Bound::Fit`] is no clamp. A px ceiling below zero, or `NaN`, is
1729    /// a ceiling of 0 ([`px_ceiling`]).
1730    pub fn max_width(mut self, v: impl Into<Bound>) -> Self {
1731        self.layout.max_w = match v.into() {
1732            Bound::Px(px) => px_ceiling(px),
1733            Bound::Fit => f32::INFINITY,
1734            Bound::Calc(c) => max_of_calc(c),
1735        };
1736        self
1737    }
1738
1739    /// A number of px, [`Min::FIT`] for the node's own fit height, or a
1740    /// [`Bound::Calc`].
1741    pub fn min_height(mut self, v: impl Into<Bound>) -> Self {
1742        self.layout.min_h = match v.into() {
1743            Bound::Px(px) if px == 0.0 && px.is_sign_negative() => Min::AUTO,
1744            Bound::Px(px) => Min::px(px),
1745            Bound::Fit => Min::FIT,
1746            Bound::Calc(c) => Min::calc(c),
1747        };
1748        self
1749    }
1750
1751    /// The four clamps where each is given, a transport's shape (C's
1752    /// `*_size` fields): `None` leaves that clamp as it is.
1753    pub fn with_bounds(
1754        self,
1755        min_w: Option<Bound>,
1756        max_w: Option<Bound>,
1757        min_h: Option<Bound>,
1758        max_h: Option<Bound>,
1759    ) -> Self {
1760        let mut s = self;
1761        if let Some(b) = min_w {
1762            s = s.min_width(b);
1763        }
1764        if let Some(b) = max_w {
1765            s = s.max_width(b);
1766        }
1767        if let Some(b) = min_h {
1768            s = s.min_height(b);
1769        }
1770        if let Some(b) = max_h {
1771            s = s.max_height(b);
1772        }
1773        s
1774    }
1775
1776    /// Clip children to this node's rect without scrolling. A `radius` on
1777    /// the same node rounds the clip, so children stay inside its corners
1778    /// (see `display::Clip`).
1779    pub fn clip(mut self) -> Self {
1780        self.layout.clip = true;
1781        self
1782    }
1783
1784    /// Vertical scrolling (and clipping) for overflowing content.
1785    pub fn scroll_y(mut self) -> Self {
1786        self.layout.scroll_y = true;
1787        self
1788    }
1789
1790    /// Horizontal scrolling (and clipping) for overflowing content.
1791    pub fn scroll_x(mut self) -> Self {
1792        self.layout.scroll_x = true;
1793        self
1794    }
1795
1796    /// Scroll anchoring on this container (see [`LayoutSpec::anchor`]):
1797    /// the first child in view stays where it is on screen when the
1798    /// content before it changes size. Needs `scroll_y` on a column or
1799    /// `scroll_x` on a row.
1800    pub fn anchor(mut self) -> Self {
1801        self.layout.anchor = true;
1802        self
1803    }
1804
1805    /// Take this node out of flex flow; see [`FloatConfig`].
1806    pub fn float(mut self, cfg: FloatConfig) -> Self {
1807        self.layout.float = Some(cfg);
1808        self
1809    }
1810
1811    /// Apply the overflow bits ([`OVERFLOW_CLIP`] and friends). What a bit
1812    /// means is decided here: a binding ORs together whatever its own
1813    /// surface spells (`clip`, `scrollX`, `overflow`) and hands the number
1814    /// over, rather than each one re-deciding that scrolling clips too.
1815    pub fn overflow_bits(mut self, bits: u32) -> Self {
1816        if bits & OVERFLOW_CLIP != 0 {
1817            self = self.clip();
1818        }
1819        if bits & OVERFLOW_SCROLL_X != 0 {
1820            self = self.scroll_x();
1821        }
1822        if bits & OVERFLOW_SCROLL_Y != 0 {
1823            self = self.scroll_y();
1824        }
1825        self
1826    }
1827
1828    /// A tooltip: the node tracks hover, `hint` is its accessible
1829    /// description, and the core floats the hint below it while it is
1830    /// hovered. On a box or a fragment the float is the node's last child;
1831    /// on a leaf — an image, an editor, a cells grid, a line, a polygon, a
1832    /// path — which holds no children, it floats beside the leaf, anchored
1833    /// to it ([`FloatAnchor::Node`]), and lands below the leaf's box all
1834    /// the same (backlog RG113).
1835    #[inline]
1836    pub fn tooltip(self, hint: &str) -> Self {
1837        let mut spec = self.apply_tooltip(hint);
1838        spec.access_mut().tooltip = true;
1839        spec
1840    }
1841
1842    /// The spec half of the `tooltip` prop: the hint is hover-gated, so the
1843    /// node tracks hover, and it is what assistive technology should say, so
1844    /// it is the accessible description too — and nothing floats. For a
1845    /// caller that floats the hint itself: [`crate::schema::PropsOut::apply_tooltip`]
1846    /// for the parsers, `kui_close` for C, a widget that draws its own. A
1847    /// Rust view wants [`Self::tooltip`], which is all three.
1848    pub fn apply_tooltip(self, hint: &str) -> Self {
1849        self.hoverable().description(hint)
1850    }
1851
1852    /// A number of px, or a [`Bound::Calc`]; [`Bound::Fit`] is no clamp.
1853    /// A px ceiling below zero, or `NaN`, is a ceiling of 0.
1854    pub fn max_height(mut self, v: impl Into<Bound>) -> Self {
1855        self.layout.max_h = match v.into() {
1856            Bound::Px(px) => px_ceiling(px),
1857            Bound::Fit => f32::INFINITY,
1858            Bound::Calc(c) => max_of_calc(c),
1859        };
1860        self
1861    }
1862
1863    /// The same padding on all four edges, logical px.
1864    pub fn pad(mut self, v: f32) -> Self {
1865        self.layout.padding = Edges::all(v);
1866        self
1867    }
1868
1869    /// Padding `x` on the left and right, `y` on the top and bottom.
1870    pub fn pad_xy(mut self, x: f32, y: f32) -> Self {
1871        self.layout.padding = Edges::xy(x, y);
1872        self
1873    }
1874
1875    /// Padding per edge.
1876    pub fn padding(mut self, e: Edges) -> Self {
1877        self.layout.padding = e;
1878        self
1879    }
1880
1881    /// Space between children along the main axis, logical px.
1882    pub fn gap(mut self, v: f32) -> Self {
1883        self.layout.gap = v;
1884        self
1885    }
1886
1887    /// Wrap overflowing children onto more lines; see [`LayoutSpec::wrap`].
1888    pub fn wrap(mut self) -> Self {
1889        self.layout.wrap = true;
1890        self
1891    }
1892
1893    /// Space between wrap lines (across the main axis).
1894    pub fn cross_gap(mut self, v: f32) -> Self {
1895        self.layout.cross_gap = v;
1896        self
1897    }
1898
1899    /// Where children sit along the main axis; the spreads are allowed.
1900    pub fn main_align(mut self, a: Align) -> Self {
1901        self.layout.main_align = a;
1902        self
1903    }
1904
1905    /// Where children sit across the main axis; `Baseline` on a row.
1906    pub fn cross_align(mut self, a: Align) -> Self {
1907        self.layout.cross_align = a;
1908        self
1909    }
1910
1911    /// Width over height (CSS's `aspect-ratio`): see
1912    /// [`LayoutSpec::aspect`]. `16.0 / 9.0` for a video, `1.0` for a
1913    /// square. A ratio that is not positive and finite clears it.
1914    pub fn aspect_ratio(mut self, ratio: f32) -> Self {
1915        self.layout.aspect = if ratio.is_finite() && ratio > 0.0 {
1916            ratio
1917        } else {
1918            0.0
1919        };
1920        self
1921    }
1922
1923    /// Center children on both axes.
1924    pub fn center(self) -> Self {
1925        self.main_align(Align::Center).cross_align(Align::Center)
1926    }
1927
1928    /// The background colour.
1929    pub fn bg(mut self, c: Color) -> Self {
1930        self.style.bg = c;
1931        self
1932    }
1933
1934    /// Rounds all four corners by `r`. On a node that also clips or
1935    /// scrolls it rounds the clip too, so its children are cut to the same
1936    /// corners rather than poking square out of them.
1937    pub fn radius(mut self, r: f32) -> Self {
1938        self.style.radius = [r; 4];
1939        self
1940    }
1941
1942    /// Per-corner radii, clockwise from the top-left.
1943    pub fn radii(mut self, tl: f32, tr: f32, br: f32, bl: f32) -> Self {
1944        self.style.radius = [tl, tr, br, bl];
1945        self
1946    }
1947
1948    pub fn radius_tl(mut self, r: f32) -> Self {
1949        self.style.radius[corner::TL] = r;
1950        self
1951    }
1952
1953    pub fn radius_tr(mut self, r: f32) -> Self {
1954        self.style.radius[corner::TR] = r;
1955        self
1956    }
1957
1958    pub fn radius_br(mut self, r: f32) -> Self {
1959        self.style.radius[corner::BR] = r;
1960        self
1961    }
1962
1963    pub fn radius_bl(mut self, r: f32) -> Self {
1964        self.style.radius[corner::BL] = r;
1965        self
1966    }
1967
1968    /// Rounds the two top corners (tabs, headers).
1969    pub fn radius_top(self, r: f32) -> Self {
1970        self.radius_tl(r).radius_tr(r)
1971    }
1972
1973    /// Rounds the two bottom corners.
1974    pub fn radius_bottom(self, r: f32) -> Self {
1975        self.radius_br(r).radius_bl(r)
1976    }
1977
1978    /// A border `w` px wide in `c`, inside the node's box.
1979    pub fn border(mut self, w: f32, c: Color) -> Self {
1980        self.style.border_w = w;
1981        self.style.border_color = c;
1982        self
1983    }
1984
1985    /// Paints this node's background, border, shadow and fragment on whole pixels
1986    /// (see `VisualStyle::pixel_snap`).
1987    pub fn pixel_snap(mut self) -> Self {
1988        self.style.pixel_snap = true;
1989        self
1990    }
1991
1992    /// Fades this node and everything under it (see `VisualStyle::opacity`);
1993    /// clamped to 0..=1.
1994    pub fn opacity(mut self, o: f32) -> Self {
1995        self.style.opacity = o.clamp(0.0, 1.0);
1996        self
1997    }
1998
1999    /// The whole drop shadow at once: color, offset, blur, spread.
2000    pub fn shadow(mut self, shadow: Shadow) -> Self {
2001        self.style.shadow = shadow;
2002        self
2003    }
2004
2005    /// The shadow's color — on its own, a hard shadow exactly behind the
2006    /// node. Nothing else about a shadow draws without it.
2007    pub fn shadow_color(mut self, c: Color) -> Self {
2008        self.style.shadow.color = c;
2009        self
2010    }
2011
2012    pub fn shadow_blur(mut self, blur: f32) -> Self {
2013        self.style.shadow.blur = blur;
2014        self
2015    }
2016
2017    pub fn shadow_offset(mut self, dx: f32, dy: f32) -> Self {
2018        self.style.shadow.dx = dx;
2019        self.style.shadow.dy = dy;
2020        self
2021    }
2022
2023    pub fn shadow_x(mut self, dx: f32) -> Self {
2024        self.style.shadow.dx = dx;
2025        self
2026    }
2027
2028    pub fn shadow_y(mut self, dy: f32) -> Self {
2029        self.style.shadow.dy = dy;
2030        self
2031    }
2032
2033    pub fn shadow_spread(mut self, spread: f32) -> Self {
2034        self.style.shadow.spread = spread;
2035        self
2036    }
2037
2038    /// Hover-track this node without making it clickable; see the
2039    /// `hoverable` field.
2040    pub fn hoverable(mut self) -> Self {
2041        self.hoverable = true;
2042        self
2043    }
2044
2045    /// Ask for another frame after this one, for as long as this node is
2046    /// declared. See the `animate` prop.
2047    pub fn animate(mut self) -> Self {
2048        self.animate = true;
2049        self
2050    }
2051
2052    /// Background from the OS accent colour where the host knows it; see
2053    /// the field.
2054    pub fn accent(mut self) -> Self {
2055        self.accent = true;
2056        self
2057    }
2058
2059    /// Makes this node clickable: a click emits `payload` as a
2060    /// [`UiEvent`](crate::input::UiEvent), and the node joins the Tab ring
2061    /// and reads as a button to assistive technology.
2062    pub fn on_click(mut self, payload: impl Into<Value>) -> Self {
2063        self.events_mut().on_click = Some(payload.into());
2064        self
2065    }
2066
2067    /// Background while hovered (see the `hover_bg` field).
2068    pub fn hover_bg(mut self, c: Color) -> Self {
2069        self.interact_mut().hover_bg = Some(c);
2070        self
2071    }
2072
2073    /// Background while dragged files are over this node (see the
2074    /// `drop_bg` field).
2075    pub fn drop_bg(mut self, c: Color) -> Self {
2076        self.interact_mut().drop_bg = Some(c);
2077        self
2078    }
2079
2080    /// Paints `gradient` over this node's `bg`, under its border and
2081    /// its children (see the `gradient` field).
2082    pub fn gradient(mut self, gradient: crate::gradient::Gradient) -> Self {
2083        self.interact_mut().gradient = Some(gradient);
2084        self
2085    }
2086
2087    /// A table's grid rules in `c` (see the `rules` field).
2088    pub fn rules(mut self, c: Color) -> Self {
2089        self.interact_mut().rules = Some(c);
2090        self
2091    }
2092
2093    /// The rules' width in logical px; 1 when unset (see `rules`).
2094    pub fn rule_width(mut self, w: f32) -> Self {
2095        self.interact_mut().rule_w = w;
2096        self
2097    }
2098
2099    /// Makes this node a selection scope (see the `selectable` field):
2100    /// the text inside it becomes one selectable run.
2101    pub fn selectable(mut self) -> Self {
2102        self.interact_mut().selectable = true;
2103        self
2104    }
2105
2106    /// Makes this node's subtree a focus region (see the `focus_region`
2107    /// field): a Tab ring of its own, entered on purpose.
2108    pub fn focus_region(mut self) -> Self {
2109        self.interact_mut().focus_region = true;
2110        self
2111    }
2112
2113    /// Whether a scroll gesture starting over this scroller at its limit
2114    /// goes on to the one around it (see [`Overscroll`]):
2115    /// `Overscroll::Contain` keeps it here.
2116    pub fn overscroll(mut self, o: Overscroll) -> Self {
2117        self.interact_mut().overscroll = o;
2118        self
2119    }
2120
2121    /// When this node's scrollbars are drawn (see [`ScrollbarMode`]).
2122    /// Scrolling itself is unchanged whatever the mode.
2123    pub fn scrollbar(mut self, mode: ScrollbarMode) -> Self {
2124        self.interact_mut().scrollbar.mode = mode;
2125        self
2126    }
2127
2128    /// The thumb's width at rest, logical px (see [`Scrollbar::width`]).
2129    pub fn scrollbar_width(mut self, w: f32) -> Self {
2130        self.interact_mut().scrollbar.width = Some(w);
2131        self
2132    }
2133
2134    /// The thumb's colour at rest (see [`Scrollbar::color`]).
2135    pub fn scrollbar_color(mut self, c: Color) -> Self {
2136        self.interact_mut().scrollbar.color = Some(c);
2137        self
2138    }
2139
2140    /// The thumb's colour under the pointer or dragged (see
2141    /// [`Scrollbar::active_color`]).
2142    pub fn scrollbar_active_color(mut self, c: Color) -> Self {
2143        self.interact_mut().scrollbar.active_color = Some(c);
2144        self
2145    }
2146
2147    /// Background while pressed (see the `pressed_bg` field).
2148    pub fn pressed_bg(mut self, c: Color) -> Self {
2149        self.interact_mut().pressed_bg = Some(c);
2150        self
2151    }
2152
2153    /// Background while keyboard-visibly focused (see the `focus_bg`
2154    /// field); replaces the default focus ring.
2155    pub fn focus_bg(mut self, c: Color) -> Self {
2156        self.interact_mut().focus_bg = Some(c);
2157        self
2158    }
2159
2160    /// Puts this node in the Tab ring (see the `focusable` field).
2161    pub fn focusable(mut self) -> Self {
2162        self.focusable = true;
2163        self
2164    }
2165
2166    /// Hears focus entering and leaving this subtree (see the `on_focus`
2167    /// field).
2168    pub fn on_focus(mut self, tag: impl Into<Value>) -> Self {
2169        self.events_mut().on_focus = Some(tag.into());
2170        self
2171    }
2172
2173    /// A press here leaves keyboard focus where it was (see the
2174    /// `keep_focus` field).
2175    pub fn keep_focus(mut self) -> Self {
2176        self.events_mut().keep_focus = true;
2177        self
2178    }
2179
2180    /// Makes this node the modal scope's entry focus (see the
2181    /// `initial_focus` field).
2182    pub fn initial_focus(mut self) -> Self {
2183        self.initial_focus = true;
2184        self
2185    }
2186
2187    /// Makes this node inert (see the `disabled` field).
2188    pub fn disabled(mut self, disabled: bool) -> Self {
2189        self.disabled = disabled;
2190        self
2191    }
2192
2193    /// Makes this node the frame's modal surface (see the `modal` field).
2194    #[inline]
2195    pub fn modal(mut self, tag: impl Into<Value>) -> Self {
2196        self.events_mut().modal = Some(tag.into());
2197        self
2198    }
2199
2200    /// Joins the hover group `name` (see the `hover_group` field).
2201    pub fn hover_group(mut self, name: &str) -> Self {
2202        self.interact_mut().hover_group = Some(Self::hover_group_id(name));
2203        self
2204    }
2205
2206    /// Emits enter/leave events for this node (see the `on_hover` field).
2207    /// Pass a tag the handler can match on; `Value::Null` if the node key
2208    /// is identification enough.
2209    pub fn on_hover(mut self, tag: impl Into<Value>) -> Self {
2210        self.events_mut().on_hover = Some(tag.into());
2211        self
2212    }
2213
2214    /// Makes this node a drop zone for files dragged in from the OS (see
2215    /// the `on_drop` field).
2216    pub fn on_drop(mut self, tag: impl Into<Value>) -> Self {
2217        self.events_mut().on_drop = Some(tag.into());
2218        self
2219    }
2220
2221    /// Plays a registered sound when this node is clicked (see the
2222    /// `click_sound` field).
2223    pub fn click_sound(mut self, sound: crate::resources::SoundId) -> Self {
2224        self.interact_mut().click_sound = Some(sound);
2225        self
2226    }
2227
2228    /// Plays a registered sound when the pointer enters this node (see the
2229    /// `hover_sound` field).
2230    pub fn hover_sound(mut self, sound: crate::resources::SoundId) -> Self {
2231        self.interact_mut().hover_sound = Some(sound);
2232        self
2233    }
2234
2235    /// Makes this node draggable (see the `on_drag` field). Pass a tag the
2236    /// handler can match on; `Value::Null` if the node key is enough.
2237    pub fn on_drag(mut self, tag: impl Into<Value>) -> Self {
2238        self.events_mut().on_drag = Some(tag.into());
2239        self
2240    }
2241
2242    /// Reports this node's laid-out rect as an event whenever it changes
2243    /// (see the `on_layout` field). Pass a tag the handler can match on;
2244    /// `Value::Null` if the node key is identification enough.
2245    pub fn on_layout(mut self, tag: impl Into<Value>) -> Self {
2246        self.events_mut().on_layout = Some(tag.into());
2247        self
2248    }
2249
2250    /// What this node is to assistive technology (see the `role` field).
2251    pub fn role(mut self, role: Role) -> Self {
2252        self.access_mut().role = Some(role);
2253        self
2254    }
2255
2256    /// The accessible name (see the `label` field). Takes an `Arc<str>`
2257    /// as well as a `&str`, so a view can keep one and hand it out every
2258    /// frame without allocating.
2259    pub fn label(mut self, label: impl Into<Label>) -> Self {
2260        self.access_mut().label = Some(label.into());
2261        self
2262    }
2263
2264    /// The accessible description (see the `description` field).
2265    pub fn description(mut self, description: impl Into<Label>) -> Self {
2266        self.access_mut().description = Some(description.into());
2267        self
2268    }
2269
2270    /// The on state for a checkbox / radio / switch role.
2271    pub fn checked(mut self, checked: bool) -> Self {
2272        self.access_mut().checked = checked;
2273        self
2274    }
2275
2276    /// A checkbox that is neither on nor off (see the `mixed` field).
2277    pub fn mixed(mut self, mixed: bool) -> Self {
2278        self.access_mut().mixed = mixed;
2279        self
2280    }
2281
2282    /// The current one of a set (see the `selected` field).
2283    pub fn selected(mut self, selected: bool) -> Self {
2284        self.access_mut().selected = selected;
2285        self
2286    }
2287
2288    /// A disclosure's state (see the `expanded` field).
2289    pub fn expanded(mut self, expanded: bool) -> Self {
2290        self.access_mut().expanded = Some(expanded);
2291        self
2292    }
2293
2294    /// Marks this node a live region (see the `live` field).
2295    pub fn live(mut self, live: Live) -> Self {
2296        self.access_mut().live = live;
2297        self
2298    }
2299
2300    /// A slider role's current value.
2301    pub fn value_now(mut self, v: f32) -> Self {
2302        self.access_mut().value_now = Some(v);
2303        self
2304    }
2305
2306    pub fn value_min(mut self, v: f32) -> Self {
2307        self.access_mut().value_min = Some(v);
2308        self
2309    }
2310
2311    pub fn value_max(mut self, v: f32) -> Self {
2312        self.access_mut().value_max = Some(v);
2313        self
2314    }
2315
2316    /// How far one arrow key moves a slider (see the `value_step` field).
2317    /// A step that is not positive and finite clears it.
2318    pub fn value_step(mut self, v: f32) -> Self {
2319        self.access_mut().value_step = (v.is_finite() && v > 0.0).then_some(v);
2320        self
2321    }
2322
2323    /// Asks the core for a slider's changes (see the `on_change` field).
2324    pub fn on_change(mut self, tag: impl Into<Value>) -> Self {
2325        self.events_mut().on_change = Some(tag.into());
2326        self
2327    }
2328
2329    /// What a slider's position reads as (see the `value_text` field).
2330    pub fn value_text(mut self, text: impl Into<Label>) -> Self {
2331        self.access_mut().value_text = Some(text.into());
2332        self
2333    }
2334
2335    /// On a `Role::Line` of a custom editor: the caret's byte offset into
2336    /// this line's text (see the `caret` field).
2337    pub fn caret(mut self, offset: u32) -> Self {
2338        self.access_mut().caret = Some(offset);
2339        self
2340    }
2341
2342    /// On a `Role::Line` of a custom editor: the byte offset where the
2343    /// selection's other end sits (see the `selection_anchor` field).
2344    pub fn selection_anchor(mut self, offset: u32) -> Self {
2345        self.access_mut().selection_anchor = Some(offset);
2346        self
2347    }
2348
2349    /// On a `Role::Line` declaring `caret`: the caret is solid, not a
2350    /// caret to blink (see the `caret_solid` field). A block caret in a
2351    /// modal editor's normal mode — the one thing that otherwise asks an
2352    /// idle app for a frame twice a second.
2353    pub fn caret_solid(mut self) -> Self {
2354        self.access_mut().caret_solid = true;
2355        self
2356    }
2357
2358    /// Makes this node a key sink (see `NodeSpec::on_key` field). Pass a
2359    /// tag the handler can match on; `Value::Null` if the node key is
2360    /// identification enough.
2361    pub fn on_key(mut self, tag: impl Into<Value>) -> Self {
2362        self.events_mut().on_key = Some(tag.into());
2363        self
2364    }
2365
2366    /// A key sink with no tag — `on_key(Value::Null)`, for a handler that
2367    /// knows the node by its key.
2368    #[inline]
2369    pub fn key_sink(self) -> Self {
2370        self.on_key(Value::Null)
2371    }
2372
2373    /// Delivers releases to this key sink as well as presses (see the
2374    /// `key_up` field). Meaningless without `on_key`.
2375    pub fn key_up(mut self) -> Self {
2376        self.events_mut().key_up = true;
2377        self
2378    }
2379
2380    /// Delivers the modifier and lock keys to this key sink as keys of
2381    /// their own (see the `modifier_keys` field). Meaningless without
2382    /// `on_key`.
2383    pub fn modifier_keys(mut self) -> Self {
2384        self.events_mut().modifier_keys = true;
2385        self
2386    }
2387
2388    /// Asks for force-click events on this node (see the
2389    /// `on_force_click` field).
2390    pub fn on_force_click(mut self, tag: impl Into<Value>) -> Self {
2391        self.events_mut().on_force_click = Some(tag.into());
2392        self
2393    }
2394
2395    /// Asks for the non-primary buttons pressed over this node as events,
2396    /// each captured by it until its release (see the `on_button` field):
2397    /// `{kind="button", phase, button, x, y, tag}`. Every such button
2398    /// unless [`NodeSpec::buttons`] narrows it.
2399    pub fn on_button(mut self, tag: impl Into<Value>) -> Self {
2400        self.events_mut().on_button = Some(tag.into());
2401        self
2402    }
2403
2404    /// Which non-primary buttons `on_button` claims (see the `buttons`
2405    /// field): `Buttons::MIDDLE`, `Buttons::SECONDARY | Buttons::MIDDLE`.
2406    /// Meaningless without `on_button`.
2407    pub fn buttons(mut self, buttons: Buttons) -> Self {
2408        self.events_mut().buttons = buttons;
2409        self
2410    }
2411
2412    /// Asks for the wheel over this node as events (see the `on_scroll`
2413    /// field): `{kind="scroll", x, y, dx, dy, lines, tag}`.
2414    pub fn on_scroll(mut self, tag: impl Into<Value>) -> Self {
2415        self.events_mut().on_scroll = Some(tag.into());
2416        self
2417    }
2418
2419    /// Which axes `on_scroll` takes (see the `scroll_axes` field):
2420    /// `ScrollAxes::Y` for a terminal's history, so a sideways gesture
2421    /// passes it by. Meaningless without `on_scroll`.
2422    pub fn scroll_axes(mut self, axes: ScrollAxes) -> Self {
2423        self.events_mut().scroll_axes = axes;
2424        self
2425    }
2426
2427    /// The modifiers `on_scroll` is for (see the `scroll_mods` field):
2428    /// `KeyMods::NONE.with_ctrl().with_super()` hears a wheel turned with
2429    /// Ctrl or ⌘ held, ahead of every scroller under the pointer, and no
2430    /// other wheel. Meaningless without `on_scroll`.
2431    pub fn scroll_mods(mut self, mods: crate::input::KeyMods) -> Self {
2432        self.events_mut().scroll_mods = mods;
2433        self
2434    }
2435
2436    /// Asks for a context menu on this node (see the `on_context_menu`
2437    /// field). Pass a tag the handler can match on; `Value::Null` if the
2438    /// node key is identification enough.
2439    pub fn on_context_menu(mut self, tag: impl Into<Value>) -> Self {
2440        self.events_mut().on_context_menu = Some(tag.into());
2441        self
2442    }
2443
2444    /// Animates changes to this node's sizing amounts, colors and radius
2445    /// over `duration_ms` (cubic ease-out); see [`crate::anim`]. Only the
2446    /// duration: an easing or repeat already declared survives, so the
2447    /// transition props compose in any order.
2448    ///
2449    /// On a scroll container it also eases the offset a `reveal` or a
2450    /// `set_scroll` moves it to; the wheel, the thumb and a drag past the
2451    /// edge still land whole.
2452    ///
2453    /// ```rust
2454    /// use kui_core::{Easing, NodeSpec, Sizing};
2455    /// // Eases toward whatever width the view declares next frame.
2456    /// let pane = NodeSpec::column().width(Sizing::Fixed(240.0)).transition(180.0).easing(Easing::Smooth);
2457    /// assert_eq!(pane.transition.unwrap().duration_ms, 180.0);
2458    /// ```
2459    pub fn transition(mut self, duration_ms: f32) -> Self {
2460        let t = self.transition.get_or_insert(Transition::ms(duration_ms));
2461        t.duration_ms = duration_ms;
2462        self
2463    }
2464
2465    /// The whole [`Transition`] at once, replacing any declared so far.
2466    pub fn transition_with(mut self, t: Transition) -> Self {
2467        self.transition = Some(t);
2468        self
2469    }
2470
2471    /// Also ease this node's position (see the `slide` field); sets a
2472    /// default 200ms transition if none was declared yet.
2473    pub fn slide(mut self) -> Self {
2474        self.transition.get_or_insert(Transition::ms(200.0));
2475        self.slide = true;
2476        self
2477    }
2478
2479    /// Easing for the node's transition (sets a default 200ms one if none
2480    /// was declared yet).
2481    pub fn easing(mut self, easing: Easing) -> Self {
2482        let t = self.transition.get_or_insert(Transition::ms(200.0));
2483        t.easing = easing;
2484        self
2485    }
2486
2487    /// How far the node's spring overshoots, 0 (glides in) to
2488    /// [`crate::anim::MAX_BOUNCE`] — in place of the spring easing's own
2489    /// bounce, and on a timed easing in place of the curve, making it a
2490    /// spring (see [`Transition::bounce`]). Sets a default 200ms
2491    /// transition if none was declared yet.
2492    pub fn bounce(mut self, bounce: f32) -> Self {
2493        let t = self.transition.get_or_insert(Transition::ms(200.0));
2494        *t = t.bounce(bounce);
2495        self
2496    }
2497
2498    /// How this node's `keyframes` cycle (CSS's `animation-direction`);
2499    /// sets a default 200ms transition if none was declared yet.
2500    pub fn repeat(mut self, repeat: Repeat) -> Self {
2501        let t = self.transition.get_or_insert(Transition::ms(200.0));
2502        t.repeat = repeat;
2503        self
2504    }
2505
2506    /// Holds this node's keyframe cycle back by `delay_ms` (CSS's
2507    /// `animation-delay`), so siblings given different delays run out of
2508    /// phase — a cascade, a chase light. Sets a default 200ms transition if
2509    /// none was declared yet.
2510    pub fn delay(mut self, delay_ms: f32) -> Self {
2511        let t = self.transition.get_or_insert(Transition::ms(200.0));
2512        t.delay_ms = delay_ms;
2513        self
2514    }
2515
2516    /// Cycles the slots these stops name (see the `keyframes` field); sets
2517    /// a default 200ms transition if none was declared yet.
2518    pub fn keyframes(mut self, stops: Vec<Keyframe>) -> Self {
2519        self.transition.get_or_insert(Transition::ms(200.0));
2520        self.anim_mut().keyframes = stops;
2521        self
2522    }
2523
2524    /// Eases this node in from `enter` on its first sight (see the `enter`
2525    /// field); sets a default 200ms transition if none was declared yet.
2526    pub fn enter(mut self, enter: Enter) -> Self {
2527        self.transition.get_or_insert(Transition::ms(200.0));
2528        self.anim_mut().enter = Some(enter);
2529        self
2530    }
2531
2532    /// Eases this node out to `exit` after the view stops declaring it
2533    /// (see the `exit` field); sets a default 200ms transition if none was
2534    /// declared yet.
2535    pub fn exit(mut self, exit: Enter) -> Self {
2536        self.transition.get_or_insert(Transition::ms(200.0));
2537        self.anim_mut().exit = Some(exit);
2538        self
2539    }
2540
2541    /// Pressing this node starts an OS window drag (drivers promote a quick
2542    /// second press to a maximize toggle).
2543    pub fn window_drag(mut self) -> Self {
2544        self.window = Some(WindowRole::Drag);
2545        self
2546    }
2547
2548    /// Clicking this node emits the button's `WindowCommand`.
2549    pub fn window_button(mut self, button: WindowButton) -> Self {
2550        self.window = Some(WindowRole::Button(button));
2551        self
2552    }
2553
2554    /// The pointer shape over this node (see the `cursor` field).
2555    pub fn cursor(mut self, shape: CursorShape) -> Self {
2556        self.cursor = Some(shape);
2557        self
2558    }
2559}
2560
2561/// Which face a text shapes with: one of the three stock families, or a
2562/// font registered with the core.
2563#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
2564pub enum FontFamily {
2565    #[default]
2566    Sans,
2567    Serif,
2568    Mono,
2569    /// A font registered with the core (`Core::add_font_data` from file
2570    /// bytes, or `Core::add_system_font` by installed family name). A
2571    /// stale handle shapes as sans-serif. Not on the wire as a family:
2572    /// the `font` row carries the handle.
2573    Custom(crate::resources::FontId),
2574}
2575
2576impl FontFamily {
2577    /// The three stock families, in wire order: a binding sends the index.
2578    /// `Custom` is not a family on the wire; the `font` row is.
2579    pub const ALL: &'static [FontFamily] = &[FontFamily::Sans, FontFamily::Serif, FontFamily::Mono];
2580
2581    /// The spelling every binding uses; a registered font has none.
2582    pub fn name(self) -> Option<&'static str> {
2583        match self {
2584            FontFamily::Sans => Some("sans"),
2585            FontFamily::Serif => Some("serif"),
2586            FontFamily::Mono => Some("mono"),
2587            FontFamily::Custom(_) => None,
2588        }
2589    }
2590
2591    /// The variant `schema::FAMILIES` index `i` names; `Sans` for an
2592    /// index this build lacks.
2593    pub fn from_index(i: usize) -> FontFamily {
2594        Self::ALL.get(i).copied().unwrap_or_default()
2595    }
2596}
2597
2598/// How a text node breaks lines at its width.
2599#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
2600pub enum TextWrap {
2601    /// Break between words; a word wider than the line breaks by glyph.
2602    #[default]
2603    Word,
2604    /// Break anywhere (URLs, hashes, code).
2605    Glyph,
2606    /// Never break at the width: one line per paragraph, clipped to the
2607    /// node's box (explicit newlines still break).
2608    None,
2609    /// `Word`, but whitespace takes its room like any glyph — CSS's
2610    /// `white-space: break-spaces`: a space that does not fit starts the
2611    /// next row instead of hanging past the edge or vanishing at the
2612    /// break, so every byte has a place inside the box. An editor's
2613    /// wrapped line, whose caret stands on each space. A text with line
2614    /// breaks of its own, a `max_lines` or an `ellipsis` wraps as `Word`.
2615    BreakSpaces,
2616}
2617
2618/// The OpenType features a style asks the shaper for: up to
2619/// [`FontFeatures::MAX`] four-letter tags with a value each. `liga` 0
2620/// keeps a coding font from joining `->`, `tnum` 1 gives tabular figures,
2621/// `ss01` 1 turns on a stylistic set. Plain data and `Copy`, since a
2622/// `TextStyle` is; the spelling every binding shares is
2623/// [`FontFeatures::parse`]'s.
2624///
2625/// ```rust
2626/// use kui_core::{FontFeatures, TextStyle};
2627/// let code = TextStyle::new(13.0).mono().features(FontFeatures::parse("-liga -calt tnum"));
2628/// assert_eq!(code.features.len(), 3);
2629/// assert_eq!(code.features.to_string_spelling(), "liga=0 calt=0 tnum=1");
2630/// ```
2631#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
2632pub struct FontFeatures {
2633    tags: [[u8; 4]; FontFeatures::MAX],
2634    values: [u32; FontFeatures::MAX],
2635    len: u8,
2636}
2637
2638impl FontFeatures {
2639    /// How many features a style can carry. Eight is more than any one
2640    /// text asks for and keeps the style small.
2641    pub const MAX: usize = 8;
2642
2643    /// No features: the font's own defaults.
2644    pub const fn new() -> Self {
2645        Self {
2646            tags: [[b' '; 4]; Self::MAX],
2647            values: [0; Self::MAX],
2648            len: 0,
2649        }
2650    }
2651
2652    /// Adds or replaces `tag` (four ASCII characters; shorter is padded
2653    /// with spaces, longer is cut) with `value`. Past `MAX` the feature is
2654    /// dropped rather than the style refused.
2655    pub fn set(mut self, tag: &str, value: u32) -> Self {
2656        let mut t = [b' '; 4];
2657        for (i, b) in tag.bytes().take(4).enumerate() {
2658            t[i] = b;
2659        }
2660        let n = self.len as usize;
2661        if let Some(i) = self.tags[..n].iter().position(|x| *x == t) {
2662            self.values[i] = value;
2663        } else if n < Self::MAX {
2664            self.tags[n] = t;
2665            self.values[n] = value;
2666            self.len += 1;
2667        }
2668        self
2669    }
2670
2671    /// The spelling every binding shares: tags separated by whitespace or
2672    /// commas, each `tag=value`, a bare `tag` meaning 1 and `-tag` meaning
2673    /// 0 — `"liga=0 calt=0 tnum"`, `"-liga,-calt"`. Anything else in the
2674    /// string is skipped.
2675    pub fn parse(s: &str) -> Self {
2676        let mut out = Self::new();
2677        for item in s.split(|c: char| c.is_whitespace() || c == ',') {
2678            if item.is_empty() {
2679                continue;
2680            }
2681            let (tag, value) = if let Some((t, v)) = item.split_once('=') {
2682                (t, v.trim().parse::<u32>().unwrap_or(0))
2683            } else if let Some(t) = item.strip_prefix('-') {
2684                (t, 0)
2685            } else if let Some(t) = item.strip_prefix('+') {
2686                (t, 1)
2687            } else {
2688                (item, 1)
2689            };
2690            let tag = tag.trim();
2691            if !tag.is_empty() {
2692                out = out.set(tag, value);
2693            }
2694        }
2695        out
2696    }
2697
2698    pub fn is_empty(&self) -> bool {
2699        self.len == 0
2700    }
2701
2702    pub fn len(&self) -> usize {
2703        self.len as usize
2704    }
2705
2706    /// Every feature, in the order set, as `(tag, value)`.
2707    pub fn iter(&self) -> impl Iterator<Item = (&[u8; 4], u32)> + '_ {
2708        let n = self.len as usize;
2709        self.tags[..n].iter().zip(self.values[..n].iter().copied())
2710    }
2711
2712    /// What `parse` reads: `tag=value` pairs joined by spaces.
2713    pub fn to_string_spelling(&self) -> String {
2714        self.iter()
2715            .map(|(t, v)| format!("{}={}", String::from_utf8_lossy(t).trim_end(), v))
2716            .collect::<Vec<_>>()
2717            .join(" ")
2718    }
2719}
2720
2721/// How a run of text is shaped and painted: size, line height, colour,
2722/// family, wrapping, line limits, OpenType features and decorations.
2723///
2724/// [`TextStyle::new`] takes the font size and derives a line height; the
2725/// rest are builders. A style with no colour paints in the theme's
2726/// foreground, so plain text is legible on both the light and dark base.
2727///
2728/// ```rust
2729/// use kui_core::{Color, FontFamily, TextStyle, TextWrap};
2730///
2731/// let body = TextStyle::new(15.0).line_height(22.0);
2732/// let caption = TextStyle::new(12.0).color(Color::hex(0x8a8fa3ff)).max_lines(2).ellipsis();
2733/// let code = TextStyle::new(13.0).family(FontFamily::Mono).wrap(TextWrap::None);
2734/// let link = TextStyle::new(15.0).underline().color(Color::hex(0x3b5bd4ff));
2735///
2736/// assert_eq!(body.color, None); // the theme's foreground
2737/// assert_eq!(caption.max_lines, 2);
2738/// assert!(code.wrap == TextWrap::None && link.underline);
2739/// ```
2740#[derive(Clone, Copy, Debug, PartialEq)]
2741pub struct TextStyle {
2742    pub size: f32,
2743    pub line_height: f32,
2744    /// `None` is the theme's foreground, filled in as the text enters the
2745    /// tree so nothing downstream of that ever sees a `None`.
2746    pub color: Option<Color>,
2747    pub family: FontFamily,
2748    pub wrap: TextWrap,
2749    /// At most this many lines are laid out; 0 = unlimited.
2750    pub max_lines: u32,
2751    /// End the last line with "…" when the text was cut off. Alone it
2752    /// means a single line (`max_lines` 1); with `max_lines` it clamps.
2753    pub ellipsis: bool,
2754    /// OpenType features for the shaper; none by default, which is the
2755    /// font's own defaults (ligatures on, where it has them).
2756    pub features: FontFeatures,
2757    /// A line under every glyph, where the face puts its underline. Paint
2758    /// only: not part of what the text is shaped as.
2759    pub underline: bool,
2760    /// The underline's own colour; `None` is the text's.
2761    pub underline_color: Option<Color>,
2762    /// The underline's shape: a line, a wave, dots.
2763    pub underline_style: UnderlineStyle,
2764    /// A line through every glyph, where the face puts its strikeout.
2765    pub strikethrough: bool,
2766}
2767
2768/// The shape of an underline: the face's line, a wave under a diagnostic,
2769/// dots. Where it goes and how thick it is are the face's
2770/// recommendation either way; a wave is three strokes tall around the
2771/// line's centre with a six-stroke period, dots two strokes across and
2772/// four apart (`crate::deco`).
2773#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
2774pub enum UnderlineStyle {
2775    #[default]
2776    Solid,
2777    Wavy,
2778    Dotted,
2779}
2780
2781impl UnderlineStyle {
2782    /// The spellings, in discriminant order (`underlineStyle` /
2783    /// `underline_style`; C's `KUI_UNDERLINE_*`).
2784    pub const NAMES: &[&str] = &["solid", "wavy", "dotted"];
2785
2786    pub fn from_index(i: u32) -> Self {
2787        match i {
2788            1 => Self::Wavy,
2789            2 => Self::Dotted,
2790            _ => Self::Solid,
2791        }
2792    }
2793
2794    pub fn name(self) -> &'static str {
2795        Self::NAMES[self as usize]
2796    }
2797}
2798
2799impl Default for TextStyle {
2800    fn default() -> Self {
2801        Self::new(16.0)
2802    }
2803}
2804
2805impl TextStyle {
2806    /// A style at `size` logical px, sans, in the theme's foreground, with
2807    /// a line height of 1.35 times the size, rounded.
2808    pub fn new(size: f32) -> Self {
2809        Self {
2810            size,
2811            line_height: (size * 1.35).round(),
2812            color: None,
2813            family: FontFamily::Sans,
2814            wrap: TextWrap::Word,
2815            max_lines: 0,
2816            ellipsis: false,
2817            features: FontFeatures::new(),
2818            underline: false,
2819            underline_color: None,
2820            underline_style: UnderlineStyle::Solid,
2821            strikethrough: false,
2822        }
2823    }
2824
2825    /// Underlines the text in its own colour.
2826    pub fn underline(mut self) -> Self {
2827        self.underline = true;
2828        self
2829    }
2830
2831    /// An underline in its own colour rather than the text's (a
2832    /// diagnostic's red under keyword-coloured text). Turns the underline
2833    /// on.
2834    pub fn underline_color(mut self, c: Color) -> Self {
2835        self.underline = true;
2836        self.underline_color = Some(c);
2837        self
2838    }
2839
2840    /// An underline of this shape. Turns the underline on.
2841    pub fn underline_style(mut self, s: UnderlineStyle) -> Self {
2842        self.underline = true;
2843        self.underline_style = s;
2844        self
2845    }
2846
2847    /// A line through the text.
2848    pub fn strikethrough(mut self) -> Self {
2849        self.strikethrough = true;
2850        self
2851    }
2852
2853    /// OpenType features for the shaper; see [`FontFeatures`].
2854    pub fn features(mut self, f: FontFeatures) -> Self {
2855        self.features = f;
2856        self
2857    }
2858
2859    /// The face to shape with.
2860    pub fn family(mut self, f: FontFamily) -> Self {
2861        self.family = f;
2862        self
2863    }
2864
2865    /// The stock monospace family.
2866    pub fn mono(self) -> Self {
2867        self.family(FontFamily::Mono)
2868    }
2869
2870    /// Shape with a registered font (see `FontFamily::Custom`).
2871    pub fn font(self, id: crate::resources::FontId) -> Self {
2872        self.family(FontFamily::Custom(id))
2873    }
2874
2875    /// The line height in logical px, replacing the derived one.
2876    pub fn line_height(mut self, lh: f32) -> Self {
2877        self.line_height = lh;
2878        self
2879    }
2880
2881    /// How lines break at the node's width.
2882    pub fn wrap(mut self, wrap: TextWrap) -> Self {
2883        self.wrap = wrap;
2884        self
2885    }
2886
2887    /// One line per paragraph, clipped to the node (`TextWrap::None`).
2888    pub fn nowrap(self) -> Self {
2889        self.wrap(TextWrap::None)
2890    }
2891
2892    /// Lay out at most `n` lines (0 = unlimited).
2893    pub fn max_lines(mut self, n: u32) -> Self {
2894        self.max_lines = n;
2895        self
2896    }
2897
2898    /// Truncate with "…" instead of overflowing: a single line unless
2899    /// `max_lines` says otherwise.
2900    pub fn ellipsis(mut self) -> Self {
2901        self.ellipsis = true;
2902        self
2903    }
2904
2905    /// The text colour, instead of the theme's foreground.
2906    pub fn color(mut self, c: Color) -> Self {
2907        self.color = Some(c);
2908        self
2909    }
2910
2911    /// This style with `fg` where it named no colour of its own: what the
2912    /// core stamps on as the text enters the tree, so the shaping caches,
2913    /// the display list and every binding see a resolved colour.
2914    pub fn or_fg(mut self, fg: Color) -> Self {
2915        self.color = Some(self.color.unwrap_or(fg));
2916        self
2917    }
2918
2919    /// The colour this style paints in, falling back to what kui painted
2920    /// before there were themes. For the handful of places that hold a
2921    /// style the core never stamped.
2922    pub fn color_or_default(&self) -> Color {
2923        self.color.unwrap_or(crate::theme::Theme::DEFAULT_FG)
2924    }
2925}
2926
2927/// Hand-written so that a group whose box was allocated but left at its
2928/// defaults — `.checked(false)` on a fresh spec — equals one whose box was
2929/// never allocated at all. The derived version compared `None` against
2930/// `Some(EMPTY)` and called them different, which is a difference the boxing
2931/// introduced rather than one a caller declared.
2932impl PartialEq for NodeSpec {
2933    fn eq(&self, other: &Self) -> bool {
2934        self.layout == other.layout
2935            && self.style == other.style
2936            && self.hoverable == other.hoverable
2937            && self.animate == other.animate
2938            && self.accent == other.accent
2939            && self.window == other.window
2940            && self.transition == other.transition
2941            && self.slide == other.slide
2942            && self.focusable == other.focusable
2943            && self.initial_focus == other.initial_focus
2944            && self.disabled == other.disabled
2945            && self.cursor == other.cursor
2946            && self.events() == other.events()
2947            && self.anim() == other.anim()
2948            && self.access() == other.access()
2949            && self.interact() == other.interact()
2950    }
2951}
2952
2953#[cfg(test)]
2954mod size_tests {
2955    use super::*;
2956
2957    /// `NodeSpec` is moved by value for every node a frame builds — through
2958    /// the builder chain, `Core::open`, `open_with_key` and into
2959    /// `Vec<NodeSpec>` in `Tree::push` — so its size is a per-node cost that
2960    /// every app pays whether or not it declares the fields. It reached 728
2961    /// bytes one feature at a time and cost ~2.5x on the frame benches before
2962    /// anyone measured it.
2963    ///
2964    /// This is the number a review can fail. Adding a prop is fine; adding it
2965    /// *inline* past this bound is the thing to notice. Put cold fields in one
2966    /// of the boxed groups instead, and only raise this if the field is read
2967    /// on every node of every frame.
2968    #[test]
2969    fn node_spec_stays_small() {
2970        const BOUND: usize = 256;
2971        let size = std::mem::size_of::<NodeSpec>();
2972        assert!(
2973            size <= BOUND,
2974            "NodeSpec is {size} bytes, over the {BOUND}-byte bound. It is copied \
2975             per node per frame; put cold fields in EventSpec / AnimSpec / \
2976             AccessSpec / InteractSpec rather than inline. See C15."
2977        );
2978    }
2979
2980    /// The groups exist to be absent: a node declaring none of them carries
2981    /// four null pointers, not four structs.
2982    #[test]
2983    fn an_undeclared_group_costs_a_pointer() {
2984        let spec = NodeSpec::default();
2985        assert!(spec.events.is_none() && spec.anim.is_none());
2986        assert!(spec.access.is_none() && spec.interact.is_none());
2987        // and reads still work, without allocating
2988        assert!(spec.events().on_click.is_none());
2989        assert_eq!(spec.access().role, None);
2990    }
2991
2992    /// An allocated-but-default group is still equal to no group at all.
2993    #[test]
2994    fn an_empty_group_equals_no_group() {
2995        assert_eq!(NodeSpec::default().checked(false), NodeSpec::default());
2996    }
2997}