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    /// How many times the `keyframes` cycle runs (CSS's
1174    /// `animation-iteration-count`, backlog F133); `None`, the default, is
1175    /// for ever. A finite cycle plays from the first frame its node is
1176    /// declared with it, holds its first stop through its `delay`, and
1177    /// rests where its last iteration ended once it is over, owing no
1178    /// frame (CSS's `animation-fill-mode: both`). A fraction of an
1179    /// iteration ends partway through one.
1180    pub iterations: Option<f32>,
1181}
1182
1183impl AnimSpec {
1184    /// The group as a node that declares none of it — what
1185    /// `NodeSpec`'s accessor hands back when the box is `None`.
1186    pub const EMPTY: Self = Self {
1187        keyframes: Vec::new(),
1188        enter: None,
1189        exit: None,
1190        iterations: None,
1191    };
1192}
1193
1194/// Accessibility properties a view states outright, as opposed to the
1195/// ones the core derives (see [`crate::access`]). Boxed on `NodeSpec`:
1196/// read only while an access tree is being built, and unset on nearly
1197/// every node.
1198#[derive(Clone, Debug, Default, PartialEq)]
1199pub struct AccessSpec {
1200    /// What this node is to assistive technology (see [`crate::access`]).
1201    /// Unset, the core derives one: a node with `on_click` is a button,
1202    /// an editor a text input, a scrolling container a scroll view, and
1203    /// a plain box is structure that leaves no trace. `Role::None` hides
1204    /// the node and its subtree from the access tree (decoration).
1205    pub role: Option<Role>,
1206    /// The accessible name. Without one a button, link, tab or heading is
1207    /// named by the text inside it; an image or an icon button has no
1208    /// name at all, and the core says so (`control-without-name`,
1209    /// `image-without-label` warnings).
1210    pub label: Option<Label>,
1211    /// The accessible description, read after the name — what the
1212    /// `description` prop sets, and what the `tooltip` prop sets on the way
1213    /// to drawing the same string.
1214    pub description: Option<Label>,
1215    /// For checkbox / radio / switch roles: the on state.
1216    pub checked: bool,
1217    /// For a checkbox: neither on nor off, like the select-all box over a
1218    /// list some of whose rows are selected. Wins over `checked`, which it
1219    /// leaves as it was.
1220    pub mixed: bool,
1221    /// The current one of a set: a `Role::Tab`, a picked `Role::ListItem`,
1222    /// the `Role::Link` for the page you are on. A tab reports the state
1223    /// either way; a row or a link reports it only where it is set (see
1224    /// [`crate::access`]).
1225    pub selected: bool,
1226    /// For a node that shows and hides something: expanded, or collapsed.
1227    /// None = it does not expand, and says nothing about it.
1228    pub expanded: Option<bool>,
1229    /// For a slider role: the current value and its range, so assistive
1230    /// technology can read the position (the drawing stays the view's).
1231    pub value_now: Option<f32>,
1232    pub value_min: Option<f32>,
1233    pub value_max: Option<f32>,
1234    /// For a slider role: what the position *reads as* (ARIA's
1235    /// `aria-valuetext`). Without one a reader has only the three numbers
1236    /// above and says a percentage — 25 in [5..60] is "36 percent" — so a
1237    /// value whose unit matters says it here: "25 minutes". It replaces
1238    /// the number rather than joining it (see [`crate::access`]), and a
1239    /// nudge announces the new text, not the new number.
1240    pub value_text: Option<Label>,
1241    /// For a slider role: how far one arrow key moves it, and the grid a
1242    /// value set by the pointer snaps to. None = a hundredth of the range.
1243    pub value_step: Option<f32>,
1244    /// On a `Role::Line` of a custom editor: the caret's byte offset into
1245    /// the line's text, and the byte offset of the selection's other end
1246    /// (see [`crate::access`]).
1247    pub caret: Option<u32>,
1248    pub selection_anchor: Option<u32>,
1249    /// With `caret`: the caret this line declares does not blink — a
1250    /// block caret in a modal editor's normal mode — so a driver's blink
1251    /// clock is not armed on it (`Core::has_caret` leaves it out) while
1252    /// the offset still anchors the IME and reads to assistive
1253    /// technology. Without it a declared caret is a caret to blink.
1254    pub caret_solid: bool,
1255    /// Float `description` below the node while it is hovered — the
1256    /// `tooltip` prop's third effect, set by [`NodeSpec::tooltip`]. The core
1257    /// reads it as the node opens (`Core::hint`); a binding that lowers the
1258    /// prop onto a box floats the hint itself and leaves this off. A leaf
1259    /// reads it as it is pushed and floats the hint beside itself, anchored
1260    /// to it, since it holds no children for the hint to be the last of —
1261    /// which is how a binding asks it of a leaf (`PropsOut::for_leaf`,
1262    /// backlog RG113).
1263    pub tooltip: bool,
1264    /// When the text inside this node changes, a reader reads the change
1265    /// without being asked (ARIA's `aria-live`). Off by default; a node
1266    /// that declares it is semantic, so a plain box marked live is not
1267    /// elided.
1268    pub live: Live,
1269}
1270
1271impl AccessSpec {
1272    /// The group as a node that declares none of it — what
1273    /// `NodeSpec`'s accessor hands back when the box is `None`.
1274    pub const EMPTY: Self = Self {
1275        role: None,
1276        label: None,
1277        description: None,
1278        checked: false,
1279        mixed: false,
1280        selected: false,
1281        expanded: None,
1282        value_now: None,
1283        value_min: None,
1284        value_max: None,
1285        value_text: None,
1286        value_step: None,
1287        caret: None,
1288        selection_anchor: None,
1289        caret_solid: false,
1290        tooltip: false,
1291        live: Live::Off,
1292    };
1293}
1294
1295/// Hover / pressed / focus styling and the sounds that go with them.
1296/// Boxed on `NodeSpec` so the common node — which declares none of it —
1297/// costs one null check in `resolve_hover_style` instead of reading
1298/// several `Option`s spread across the struct.
1299#[derive(Clone, Debug, Default, PartialEq)]
1300pub struct InteractSpec {
1301    /// Background while the pointer hovers this node (or any node sharing
1302    /// its `hover_group`). Resolved by the core when the node opens, so a
1303    /// data-only view gets hover styling without querying `is_hovered` —
1304    /// and with `transition` the swap eases. Implies hover tracking.
1305    pub hover_bg: Option<Color>,
1306    /// Background while this node (or its group) is pressed. Implies hover
1307    /// tracking. Without a `hover_bg`, hover keeps the plain `bg`. An
1308    /// `on_drag` node holds this state for the whole captured drag, even
1309    /// while the cursor is off it.
1310    pub pressed_bg: Option<Color>,
1311    /// Hover group: nodes sharing an id count as one for `hover_bg` /
1312    /// `pressed_bg` — a two-piece elbow, a split button, a row whose cells
1313    /// highlight together. The id is a hash of a name (`hover_group`).
1314    /// Implies hover tracking.
1315    pub hover_group: Option<u64>,
1316    /// A registered sound played when this node is clicked (see
1317    /// [`crate::audio`]); the click itself still emits `on_click` if one is
1318    /// declared. Implies hover tracking.
1319    pub click_sound: Option<crate::resources::SoundId>,
1320    /// A registered sound played when the pointer enters this node.
1321    /// Implies hover tracking.
1322    pub hover_sound: Option<crate::resources::SoundId>,
1323    /// Background while this node holds keyboard-visible focus (focus
1324    /// moved by Tab or by assistive technology, not by a click).
1325    /// Declaring one replaces the ring the core draws by default. Pressed
1326    /// wins over focus wins over hover; eases with `transition`.
1327    pub focus_bg: Option<Color>,
1328    /// Background while files dragged in from the OS are over this node.
1329    /// Wins over pressed, focus and hover — a press
1330    /// cannot be held while the OS holds a drag — and eases with
1331    /// `transition`; clears when the files leave, land or the drag is
1332    /// cancelled. Implies hover tracking.
1333    pub drop_bg: Option<Color>,
1334    /// Makes this node a *selection scope*: the text of every node inside
1335    /// it is one selectable run of text, in tree order, and a press-drag
1336    /// inside it selects across all of them. Declared on the container
1337    /// rather than on each label, because what a reader selects is a
1338    /// paragraph or a card, not one run of it.
1339    ///
1340    /// Scopes do not nest: the innermost one containing a run owns it, and
1341    /// an outer one is warned about (`nested-selection-scope`). An `edit`
1342    /// is already its own scope and ignores this.
1343    pub selectable: bool,
1344    /// Makes this node's subtree a *focus region*: a Tab ring of its own
1345    /// that the ring outside never enters, and that never leaves — a
1346    /// devtools dock, an inspector beside the app. Entered on purpose:
1347    /// `Ui::focus_region`, a press inside it, or an explicit focus on a
1348    /// node in it. Nothing else about the node changes — it lays out,
1349    /// paints, takes the pointer and appears in the access tree as before,
1350    /// and keys bubble through it to the sink above.
1351    pub focus_region: bool,
1352    /// How this node's scrollbars look, when it scrolls (see
1353    /// [`Scrollbar`]). Cold: read once per scroller when its layer's
1354    /// chrome is emitted, which is why it lives in this box rather than
1355    /// beside `scroll_y` on every node.
1356    pub scrollbar: Scrollbar,
1357    /// Whether a scroll gesture that starts over this scroller while it
1358    /// is at its limit that way goes on to the scroller around it (see
1359    /// [`Overscroll`]). Cold like `scrollbar`: read once
1360    /// per scroller a gesture starts over.
1361    pub overscroll: Overscroll,
1362    /// On a table: lines of this colour between its columns and between
1363    /// its rows, drawn with the table's own box, under its cells, down the
1364    /// middle of each gap, so a table with a `gap` of at least `rule_w`
1365    /// gets a grid with no rule cells. The
1366    /// columns come from the row with the most cells; the lines run the
1367    /// table's content box. Ignored on anything that is not a table.
1368    pub rules: Option<Color>,
1369    /// The rules' width in logical px; 0 is 1.
1370    pub rule_w: f32,
1371    /// A gradient painted over the node's `bg` and under its border and
1372    /// its children (`docs/adr/0042-a-gradient-is-an-image-the-core-paints.md`):
1373    /// one image quad from the atlas, rounded by the node's radius. It
1374    /// does not tween, and the state backgrounds replace `bg`, not it.
1375    pub gradient: Option<crate::gradient::Gradient>,
1376    /// Blur what the app drew beneath this node, inside its rounded rect,
1377    /// by this radius in logical px — CSS's `backdrop-filter: blur()`
1378    /// (backlog F129). The blurred pixels are what was painted before the
1379    /// node (earlier siblings, ancestors, the window's backdrop), never
1380    /// the node's own `bg` or children, which paint over them; give it a
1381    /// translucent `bg` for frosted glass. Clipped as the node is; faded
1382    /// by its group opacity. 0 is none. A renderer with no way to read
1383    /// back its frame (the CPU raster) draws the node unblurred.
1384    pub backdrop_blur: f32,
1385    /// A turn and a uniform scale about a pivot, applied to everything
1386    /// the node and its subtree draw, after layout (ADR 0043): `None`
1387    /// when the node declares none of `rotate`, `scale` and `pivot`.
1388    /// Boxed, as the group is: inline, its twenty bytes moved every node
1389    /// that declares any interaction — a gradient, a hover — into a larger
1390    /// allocation class (`frame_10k_rects_with_gradient` +2%).
1391    pub transform: Option<Box<TransformSpec>>,
1392}
1393
1394/// A node's `rotate`, `scale` and `pivot` (ADR 0043): paint-only, so the
1395/// node takes the room its upright self takes and everything after layout
1396/// — its quads, its clip, its hit region, its access rect — is drawn, cut,
1397/// hit and read through the turn. Nests by composition; tweens with
1398/// `transition` as one slot; an entrance, an exit and a keyframe stop name
1399/// `rotate` and `scale`.
1400#[derive(Clone, Copy, Debug, PartialEq)]
1401pub struct TransformSpec {
1402    /// Turns, clockwise with y down; 0 is none.
1403    pub rotate: f32,
1404    /// The uniform factor; 1 is none.
1405    pub scale: f32,
1406    /// The point the turn and the scale are about, as fractions of the
1407    /// node's box: `(0.5, 0.5)` is the centre.
1408    pub pivot: crate::geom::Vec2,
1409}
1410
1411impl Default for TransformSpec {
1412    fn default() -> Self {
1413        Self::NONE
1414    }
1415}
1416
1417impl TransformSpec {
1418    /// No turn and no scale, about the centre.
1419    pub const NONE: Self = Self {
1420        rotate: 0.0,
1421        scale: 1.0,
1422        pivot: crate::geom::Vec2 { x: 0.5, y: 0.5 },
1423    };
1424
1425    /// Whether this moves anything: a turn, or a scale that is not 1. A
1426    /// turn or a scale that is not a finite number is none.
1427    #[inline]
1428    pub fn active(&self) -> bool {
1429        (self.rotate != 0.0 && self.rotate.is_finite())
1430            || (self.scale != 1.0 && self.scale.is_finite())
1431    }
1432
1433    /// The transform for a node laid out at `rect` (logical px, in the
1434    /// space its parent paints in).
1435    pub fn at(&self, rect: crate::geom::Rect) -> crate::geom::Transform {
1436        let pivot = crate::geom::Vec2::new(
1437            rect.x + rect.w * self.pivot.x,
1438            rect.y + rect.h * self.pivot.y,
1439        );
1440        crate::geom::Transform::about(
1441            pivot,
1442            crate::geom::finite_or(self.rotate, 0.0),
1443            crate::geom::finite_or(self.scale, 1.0),
1444        )
1445    }
1446}
1447
1448/// A scrolling node's bars, per node. Every field's default is the stock
1449/// bar — the theme's `scrollbar` / `scrollbar_active` colours, 4 px at
1450/// rest and 6 px under the pointer, always drawn while the content
1451/// overflows — so a binding that sets none of the four rows gets exactly
1452/// what it always had. The bars are overlays and take no layout space
1453/// whatever their width; the grabbable track is at least as wide as the
1454/// active thumb plus its inset.
1455#[derive(Clone, Copy, Debug, Default, PartialEq)]
1456pub struct Scrollbar {
1457    /// Whether the bars are drawn at all, and when (see [`ScrollbarMode`]).
1458    pub mode: ScrollbarMode,
1459    /// The thumb's width at rest, logical px; under the pointer or dragged
1460    /// it is 2 px wider. `None` is the stock 4.
1461    pub width: Option<f32>,
1462    /// The thumb at rest; `None` is `theme.scrollbar`.
1463    pub color: Option<Color>,
1464    /// The thumb under the pointer or dragged; `None` is
1465    /// `theme.scrollbar_active`.
1466    pub active_color: Option<Color>,
1467}
1468
1469impl Scrollbar {
1470    /// The stock bar: visible, 4 px, in the theme's colours.
1471    pub const DEFAULT: Self = Self {
1472        mode: ScrollbarMode::Visible,
1473        width: None,
1474        color: None,
1475        active_color: None,
1476    };
1477}
1478
1479/// When a scrolling node's bars are drawn. Spelled by the `scrollbar` row
1480/// (`crate::schema::SCROLLBARS`, in this order).
1481#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
1482pub enum ScrollbarMode {
1483    /// The stock bar: drawn whenever the content overflows.
1484    #[default]
1485    Visible,
1486    /// No thumb is drawn and no track takes the press. The wheel, the
1487    /// keyboard, `reveal` and the caret still scroll the node — a list
1488    /// drawing its own indicator, or one whose bar would sit on a border.
1489    Hidden,
1490    /// The bar shows while the scroll state is changing — the offset or
1491    /// the content's extent moved since the last frame, the pointer is on
1492    /// its track, or a thumb is being dragged — and for a second after,
1493    /// then fades out over a quarter of one. A node first seen shows its
1494    /// bar the same second. What an overlay bar does on macOS. Needs the
1495    /// driver's clock (`Core::set_time`); without one it is `Visible`,
1496    /// since a fade with no clock could never end.
1497    Auto,
1498}
1499
1500impl ScrollbarMode {
1501    /// Every mode, in the `scrollbar` row's order: what a binding that
1502    /// spells modes as numbers indexes (C's `KUI_SCROLLBAR_*` are these
1503    /// plus one).
1504    pub const ALL: [ScrollbarMode; 3] = [
1505        ScrollbarMode::Visible,
1506        ScrollbarMode::Hidden,
1507        ScrollbarMode::Auto,
1508    ];
1509}
1510
1511/// What a scroll gesture that starts over a scroller already at its limit
1512/// does: CSS's `overscroll-behavior`, spelled by the `overscroll` row.
1513///
1514/// A gesture picks its target when it starts: the innermost scroller
1515/// under the pointer that can still move the way it goes. One at its
1516/// limit is passed by, to the scroller around it — *chaining* — and
1517/// `Contain` stops that: the gesture is this scroller's, and moves
1518/// nothing until it turns back. Only on the axes the node scrolls, so a
1519/// `scroll_y` list that contains still passes a sideways swipe to the
1520/// strip it sits in, where CSS would stop that too. Decided at
1521/// the start only: a gesture that reaches a limit midway stops there
1522/// whatever this says, as a browser's does.
1523#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
1524pub enum Overscroll {
1525    /// The gesture goes on to the scroller around this one when this one
1526    /// is at its limit that way.
1527    #[default]
1528    Auto,
1529    /// A gesture that starts here stays here: a panel, a popup's list or
1530    /// a sheet whose scrolling must never move the page behind it.
1531    Contain,
1532}
1533
1534impl Overscroll {
1535    /// Every value, in the `overscroll` row's order (C's
1536    /// `KUI_OVERSCROLL_*` are these plus one).
1537    pub const ALL: [Overscroll; 2] = [Overscroll::Auto, Overscroll::Contain];
1538}
1539
1540/// Which axes an `on_scroll` node takes, spelled by the `scrollAxes` row.
1541#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
1542pub enum ScrollAxes {
1543    /// Both: the node hears every scroll gesture that starts over it.
1544    #[default]
1545    Both,
1546    /// Only sideways; a vertical gesture passes it by.
1547    X,
1548    /// Only vertical; a sideways gesture passes it by — a terminal's
1549    /// history, a log.
1550    Y,
1551}
1552
1553impl ScrollAxes {
1554    /// Every value, in the `scrollAxes` row's order (C's
1555    /// `KUI_SCROLL_AXES_*` are these plus one).
1556    pub const ALL: [ScrollAxes; 3] = [ScrollAxes::Both, ScrollAxes::X, ScrollAxes::Y];
1557
1558    /// Whether the node takes `x` (true) or `y` (false).
1559    pub fn takes(self, x: bool) -> bool {
1560        match self {
1561            ScrollAxes::Both => true,
1562            ScrollAxes::X => x,
1563            ScrollAxes::Y => !x,
1564        }
1565    }
1566}
1567
1568impl InteractSpec {
1569    /// The group as a node that declares none of it — what
1570    /// `NodeSpec`'s accessor hands back when the box is `None`.
1571    pub const EMPTY: Self = Self {
1572        hover_bg: None,
1573        pressed_bg: None,
1574        hover_group: None,
1575        click_sound: None,
1576        hover_sound: None,
1577        focus_bg: None,
1578        drop_bg: None,
1579        selectable: false,
1580        focus_region: false,
1581        scrollbar: Scrollbar::DEFAULT,
1582        overscroll: Overscroll::Auto,
1583        rules: None,
1584        rule_w: 0.0,
1585        gradient: None,
1586        backdrop_blur: 0.0,
1587        transform: None,
1588    };
1589}
1590
1591impl NodeSpec {
1592    // -- Boxed groups ------------------------------------------------------
1593    // The four cold groups are behind a pointer each: a node that
1594    // declares none of a group pays 8 bytes for it rather than its full
1595    // width. Reads go through the `&` accessor, which hands back a shared
1596    // empty group instead of allocating, so a caller reads
1597    // `spec.events().on_click` exactly as it used to read `spec.on_click`.
1598    // Writes go through the `_mut` accessor, which allocates on first use.
1599
1600    /// Event payloads this node declares, empty if it declares none.
1601    #[inline]
1602    pub fn events(&self) -> &EventSpec {
1603        static EMPTY: EventSpec = EventSpec::EMPTY;
1604        self.events.as_deref().unwrap_or(&EMPTY)
1605    }
1606
1607    /// Allocates the group on first write.
1608    #[inline]
1609    pub fn events_mut(&mut self) -> &mut EventSpec {
1610        self.events.get_or_insert_with(Box::default)
1611    }
1612
1613    /// Animation declarations, empty if this node has none.
1614    #[inline]
1615    pub fn anim(&self) -> &AnimSpec {
1616        static EMPTY: AnimSpec = AnimSpec::EMPTY;
1617        self.anim.as_deref().unwrap_or(&EMPTY)
1618    }
1619
1620    /// Allocates the group on first write.
1621    #[inline]
1622    pub fn anim_mut(&mut self) -> &mut AnimSpec {
1623        self.anim.get_or_insert_with(Box::default)
1624    }
1625
1626    /// Declared accessibility properties, empty if this node declares none.
1627    #[inline]
1628    pub fn access(&self) -> &AccessSpec {
1629        static EMPTY: AccessSpec = AccessSpec::EMPTY;
1630        self.access.as_deref().unwrap_or(&EMPTY)
1631    }
1632
1633    /// Allocates the group on first write.
1634    #[inline]
1635    pub fn access_mut(&mut self) -> &mut AccessSpec {
1636        self.access.get_or_insert_with(Box::default)
1637    }
1638
1639    /// Hover / pressed / focus styling, empty if this node declares none.
1640    #[inline]
1641    pub fn interact(&self) -> &InteractSpec {
1642        static EMPTY: InteractSpec = InteractSpec::EMPTY;
1643        self.interact.as_deref().unwrap_or(&EMPTY)
1644    }
1645
1646    /// Allocates the group on first write.
1647    #[inline]
1648    pub fn interact_mut(&mut self) -> &mut InteractSpec {
1649        self.interact.get_or_insert_with(Box::default)
1650    }
1651
1652    /// Whether the core registers a hit region for this node (any of the
1653    /// interaction props, or an explicit `hoverable`).
1654    pub fn hover_tracked(&self) -> bool {
1655        // Asked of every node at emission; the inline flags first, then
1656        // each boxed group once — a node that declares neither group is
1657        // answered by two null checks rather than a read per field.
1658        self.hoverable
1659            || self.focusable
1660            || self.window.is_some()
1661            // A `cursor` override has to be found under the pointer to be
1662            // read, even on an otherwise inert box.
1663            || self.cursor.is_some()
1664            || self.events.as_deref().is_some_and(|e| {
1665                // A modal's own background is not "outside" it: a press
1666                // there must find a region.
1667                e.modal.is_some()
1668                    || e.on_click.is_some()
1669                    || e.on_drag.is_some()
1670                    || e.on_key.is_some()
1671                    || e.on_context_menu.is_some()
1672                    || e.on_force_click.is_some()
1673                    || e.on_button.is_some()
1674                    || e.on_hover.is_some()
1675                    || e.on_drop.is_some()
1676                    || e.on_change.is_some()
1677            })
1678            || self.interact.as_deref().is_some_and(|i| {
1679                i.hover_bg.is_some()
1680                    || i.pressed_bg.is_some()
1681                    || i.drop_bg.is_some()
1682                    || i.hover_group.is_some()
1683                    || i.click_sound.is_some()
1684                    || i.hover_sound.is_some()
1685                    // A selection scope has to be found under the pointer:
1686                    // the press that starts a drag-select lands on it.
1687                    || i.selectable
1688                    // So does a focus region: a press on its dead space
1689                    // settles the ring there.
1690                    || i.focus_region
1691            })
1692    }
1693
1694    /// The group id `hover_group(name)` assigns — reproducible from any
1695    /// binding (the same FNV mix as `Key`).
1696    pub fn hover_group_id(name: &str) -> u64 {
1697        crate::key::Key::ROOT.str(name).0
1698    }
1699
1700    /// A container that lays its children out left to right.
1701    pub fn row() -> Self {
1702        Self {
1703            layout: LayoutSpec {
1704                dir: Dir::Row,
1705                ..Default::default()
1706            },
1707            ..Default::default()
1708        }
1709    }
1710
1711    /// A container that lays its children out top to bottom (the default).
1712    pub fn column() -> Self {
1713        Self {
1714            layout: LayoutSpec {
1715                dir: Dir::Column,
1716                ..Default::default()
1717            },
1718            ..Default::default()
1719        }
1720    }
1721
1722    /// A table: a column whose rows' children line up in columns. Its
1723    /// in-flow `Row` children are the rows and each row's in-flow children
1724    /// its cells; the nth cell of every row is column n, and a column is
1725    /// as wide as its widest cell, so a label column sits at its longest
1726    /// label with no width picked by hand.
1727    ///
1728    /// A cell's `width` says how its column sizes: `Fit` (the default) and
1729    /// `Fixed` are content the column's fit width is the max of, `Grow`
1730    /// makes the whole column grow with the table, and a column's
1731    /// `min_width` / `max_width` are the strictest its cells declared.
1732    /// Give the rows `width: grow` for the columns to grow into; a `Fit`
1733    /// row sits at the columns' fit width. Rows keep their own `gap`,
1734    /// padding, background, click and hover, and never wrap. A bare text
1735    /// or image straight inside a row is a cell too. A text, a column or a
1736    /// table straight under the table is a child with its own width and no
1737    /// cells. Everything else is a column's: `gap` is the space between
1738    /// rows, `scroll_y` scrolls them.
1739    ///
1740    /// ```rust
1741    /// use kui_core::{NodeSpec, Sizing};
1742    /// let table = NodeSpec::table().gap(4.0).rules(kui_core::Color::hex(0x80808080));
1743    /// let row = NodeSpec::row().width(Sizing::GROW).gap(12.0);
1744    /// assert!(table.layout.is_table() && !row.layout.is_table());
1745    /// ```
1746    pub fn table() -> Self {
1747        Self {
1748            layout: LayoutSpec {
1749                dir: Dir::Column,
1750                table: true,
1751                ..Default::default()
1752            },
1753            ..Default::default()
1754        }
1755    }
1756
1757    /// A [`Sizing`], or a number of px (`.width(120.0)`).
1758    #[inline]
1759    pub fn width(mut self, s: impl Into<Sizing>) -> Self {
1760        self.layout.width = s.into();
1761        self
1762    }
1763
1764    /// A [`Sizing`], or a number of px (`.height(24.0)`).
1765    #[inline]
1766    pub fn height(mut self, s: impl Into<Sizing>) -> Self {
1767        self.layout.height = s.into();
1768        self
1769    }
1770
1771    /// Both axes at once: `.size(20.0, 20.0)` for a fixed box,
1772    /// `.size(Sizing::GROW, 24.0)` for a strip.
1773    #[inline]
1774    pub fn size(self, w: impl Into<Sizing>, h: impl Into<Sizing>) -> Self {
1775        self.width(w).height(h)
1776    }
1777
1778    /// An equal share of the leftover width: `.width(Sizing::GROW)`.
1779    #[inline]
1780    pub fn grow_width(self) -> Self {
1781        self.width(Sizing::GROW)
1782    }
1783
1784    /// An equal share of the leftover height: `.height(Sizing::GROW)`.
1785    #[inline]
1786    pub fn grow_height(self) -> Self {
1787        self.height(Sizing::GROW)
1788    }
1789
1790    /// Grow along both axes.
1791    #[inline]
1792    pub fn fill(self) -> Self {
1793        self.grow_width().grow_height()
1794    }
1795
1796    /// A number of px, [`Min::FIT`] for the node's own fit width, or a
1797    /// [`Bound::Calc`].
1798    pub fn min_width(mut self, v: impl Into<Bound>) -> Self {
1799        self.layout.min_w = match v.into() {
1800            Bound::Px(px) if px == 0.0 && px.is_sign_negative() => Min::AUTO,
1801            Bound::Px(px) => Min::px(px),
1802            Bound::Fit => Min::FIT,
1803            Bound::Calc(c) => Min::calc(c),
1804        };
1805        self
1806    }
1807
1808    /// A number of px, or a [`Bound::Calc`]; a max has no fit size, so
1809    /// [`Bound::Fit`] is no clamp. A px ceiling below zero, or `NaN`, is
1810    /// a ceiling of 0 ([`px_ceiling`]).
1811    pub fn max_width(mut self, v: impl Into<Bound>) -> Self {
1812        self.layout.max_w = match v.into() {
1813            Bound::Px(px) => px_ceiling(px),
1814            Bound::Fit => f32::INFINITY,
1815            Bound::Calc(c) => max_of_calc(c),
1816        };
1817        self
1818    }
1819
1820    /// A number of px, [`Min::FIT`] for the node's own fit height, or a
1821    /// [`Bound::Calc`].
1822    pub fn min_height(mut self, v: impl Into<Bound>) -> Self {
1823        self.layout.min_h = match v.into() {
1824            Bound::Px(px) if px == 0.0 && px.is_sign_negative() => Min::AUTO,
1825            Bound::Px(px) => Min::px(px),
1826            Bound::Fit => Min::FIT,
1827            Bound::Calc(c) => Min::calc(c),
1828        };
1829        self
1830    }
1831
1832    /// The four clamps where each is given, a transport's shape (C's
1833    /// `*_size` fields): `None` leaves that clamp as it is.
1834    pub fn with_bounds(
1835        self,
1836        min_w: Option<Bound>,
1837        max_w: Option<Bound>,
1838        min_h: Option<Bound>,
1839        max_h: Option<Bound>,
1840    ) -> Self {
1841        let mut s = self;
1842        if let Some(b) = min_w {
1843            s = s.min_width(b);
1844        }
1845        if let Some(b) = max_w {
1846            s = s.max_width(b);
1847        }
1848        if let Some(b) = min_h {
1849            s = s.min_height(b);
1850        }
1851        if let Some(b) = max_h {
1852            s = s.max_height(b);
1853        }
1854        s
1855    }
1856
1857    /// Clip children to this node's rect without scrolling. A `radius` on
1858    /// the same node rounds the clip, so children stay inside its corners
1859    /// (see `display::Clip`).
1860    pub fn clip(mut self) -> Self {
1861        self.layout.clip = true;
1862        self
1863    }
1864
1865    /// Vertical scrolling (and clipping) for overflowing content.
1866    pub fn scroll_y(mut self) -> Self {
1867        self.layout.scroll_y = true;
1868        self
1869    }
1870
1871    /// Horizontal scrolling (and clipping) for overflowing content.
1872    pub fn scroll_x(mut self) -> Self {
1873        self.layout.scroll_x = true;
1874        self
1875    }
1876
1877    /// Scroll anchoring on this container (see [`LayoutSpec::anchor`]):
1878    /// the first child in view stays where it is on screen when the
1879    /// content before it changes size. Needs `scroll_y` on a column or
1880    /// `scroll_x` on a row.
1881    pub fn anchor(mut self) -> Self {
1882        self.layout.anchor = true;
1883        self
1884    }
1885
1886    /// Take this node out of flex flow; see [`FloatConfig`].
1887    pub fn float(mut self, cfg: FloatConfig) -> Self {
1888        self.layout.float = Some(cfg);
1889        self
1890    }
1891
1892    /// Apply the overflow bits ([`OVERFLOW_CLIP`] and friends). What a bit
1893    /// means is decided here: a binding ORs together whatever its own
1894    /// surface spells (`clip`, `scrollX`, `overflow`) and hands the number
1895    /// over, rather than each one re-deciding that scrolling clips too.
1896    pub fn overflow_bits(mut self, bits: u32) -> Self {
1897        if bits & OVERFLOW_CLIP != 0 {
1898            self = self.clip();
1899        }
1900        if bits & OVERFLOW_SCROLL_X != 0 {
1901            self = self.scroll_x();
1902        }
1903        if bits & OVERFLOW_SCROLL_Y != 0 {
1904            self = self.scroll_y();
1905        }
1906        self
1907    }
1908
1909    /// A tooltip: the node tracks hover, `hint` is its accessible
1910    /// description, and the core floats the hint below it while it is
1911    /// hovered. On a box or a fragment the float is the node's last child;
1912    /// on a leaf — an image, an editor, a cells grid, a line, a polygon, a
1913    /// path — which holds no children, it floats beside the leaf, anchored
1914    /// to it ([`FloatAnchor::Node`]), and lands below the leaf's box all
1915    /// the same (backlog RG113).
1916    #[inline]
1917    pub fn tooltip(self, hint: &str) -> Self {
1918        let mut spec = self.apply_tooltip(hint);
1919        spec.access_mut().tooltip = true;
1920        spec
1921    }
1922
1923    /// The spec half of the `tooltip` prop: the hint is hover-gated, so the
1924    /// node tracks hover, and it is what assistive technology should say, so
1925    /// it is the accessible description too — and nothing floats. For a
1926    /// caller that floats the hint itself: [`crate::schema::PropsOut::apply_tooltip`]
1927    /// for the parsers, `kui_close` for C, a widget that draws its own. A
1928    /// Rust view wants [`Self::tooltip`], which is all three.
1929    pub fn apply_tooltip(self, hint: &str) -> Self {
1930        self.hoverable().description(hint)
1931    }
1932
1933    /// A number of px, or a [`Bound::Calc`]; [`Bound::Fit`] is no clamp.
1934    /// A px ceiling below zero, or `NaN`, is a ceiling of 0.
1935    pub fn max_height(mut self, v: impl Into<Bound>) -> Self {
1936        self.layout.max_h = match v.into() {
1937            Bound::Px(px) => px_ceiling(px),
1938            Bound::Fit => f32::INFINITY,
1939            Bound::Calc(c) => max_of_calc(c),
1940        };
1941        self
1942    }
1943
1944    /// The same padding on all four edges, logical px.
1945    pub fn pad(mut self, v: f32) -> Self {
1946        self.layout.padding = Edges::all(v);
1947        self
1948    }
1949
1950    /// Padding `x` on the left and right, `y` on the top and bottom.
1951    pub fn pad_xy(mut self, x: f32, y: f32) -> Self {
1952        self.layout.padding = Edges::xy(x, y);
1953        self
1954    }
1955
1956    /// Padding per edge.
1957    pub fn padding(mut self, e: Edges) -> Self {
1958        self.layout.padding = e;
1959        self
1960    }
1961
1962    /// Space between children along the main axis, logical px.
1963    pub fn gap(mut self, v: f32) -> Self {
1964        self.layout.gap = v;
1965        self
1966    }
1967
1968    /// Wrap overflowing children onto more lines; see [`LayoutSpec::wrap`].
1969    pub fn wrap(mut self) -> Self {
1970        self.layout.wrap = true;
1971        self
1972    }
1973
1974    /// Space between wrap lines (across the main axis).
1975    pub fn cross_gap(mut self, v: f32) -> Self {
1976        self.layout.cross_gap = v;
1977        self
1978    }
1979
1980    /// Where children sit along the main axis; the spreads are allowed.
1981    pub fn main_align(mut self, a: Align) -> Self {
1982        self.layout.main_align = a;
1983        self
1984    }
1985
1986    /// Where children sit across the main axis; `Baseline` on a row.
1987    pub fn cross_align(mut self, a: Align) -> Self {
1988        self.layout.cross_align = a;
1989        self
1990    }
1991
1992    /// Width over height (CSS's `aspect-ratio`): see
1993    /// [`LayoutSpec::aspect`]. `16.0 / 9.0` for a video, `1.0` for a
1994    /// square. A ratio that is not positive and finite clears it.
1995    pub fn aspect_ratio(mut self, ratio: f32) -> Self {
1996        self.layout.aspect = if ratio.is_finite() && ratio > 0.0 {
1997            ratio
1998        } else {
1999            0.0
2000        };
2001        self
2002    }
2003
2004    /// Center children on both axes.
2005    pub fn center(self) -> Self {
2006        self.main_align(Align::Center).cross_align(Align::Center)
2007    }
2008
2009    /// The background colour.
2010    pub fn bg(mut self, c: Color) -> Self {
2011        self.style.bg = c;
2012        self
2013    }
2014
2015    /// Rounds all four corners by `r`. On a node that also clips or
2016    /// scrolls it rounds the clip too, so its children are cut to the same
2017    /// corners rather than poking square out of them.
2018    pub fn radius(mut self, r: f32) -> Self {
2019        self.style.radius = [r; 4];
2020        self
2021    }
2022
2023    /// Per-corner radii, clockwise from the top-left.
2024    pub fn radii(mut self, tl: f32, tr: f32, br: f32, bl: f32) -> Self {
2025        self.style.radius = [tl, tr, br, bl];
2026        self
2027    }
2028
2029    pub fn radius_tl(mut self, r: f32) -> Self {
2030        self.style.radius[corner::TL] = r;
2031        self
2032    }
2033
2034    pub fn radius_tr(mut self, r: f32) -> Self {
2035        self.style.radius[corner::TR] = r;
2036        self
2037    }
2038
2039    pub fn radius_br(mut self, r: f32) -> Self {
2040        self.style.radius[corner::BR] = r;
2041        self
2042    }
2043
2044    pub fn radius_bl(mut self, r: f32) -> Self {
2045        self.style.radius[corner::BL] = r;
2046        self
2047    }
2048
2049    /// Rounds the two top corners (tabs, headers).
2050    pub fn radius_top(self, r: f32) -> Self {
2051        self.radius_tl(r).radius_tr(r)
2052    }
2053
2054    /// Rounds the two bottom corners.
2055    pub fn radius_bottom(self, r: f32) -> Self {
2056        self.radius_br(r).radius_bl(r)
2057    }
2058
2059    /// A border `w` px wide in `c`, inside the node's box.
2060    pub fn border(mut self, w: f32, c: Color) -> Self {
2061        self.style.border_w = w;
2062        self.style.border_color = c;
2063        self
2064    }
2065
2066    /// Paints this node's background, border, shadow and fragment on whole pixels
2067    /// (see `VisualStyle::pixel_snap`).
2068    pub fn pixel_snap(mut self) -> Self {
2069        self.style.pixel_snap = true;
2070        self
2071    }
2072
2073    /// Fades this node and everything under it (see `VisualStyle::opacity`);
2074    /// clamped to 0..=1.
2075    pub fn opacity(mut self, o: f32) -> Self {
2076        self.style.opacity = o.clamp(0.0, 1.0);
2077        self
2078    }
2079
2080    /// The whole drop shadow at once: color, offset, blur, spread.
2081    pub fn shadow(mut self, shadow: Shadow) -> Self {
2082        self.style.shadow = shadow;
2083        self
2084    }
2085
2086    /// The shadow's color — on its own, a hard shadow exactly behind the
2087    /// node. Nothing else about a shadow draws without it.
2088    pub fn shadow_color(mut self, c: Color) -> Self {
2089        self.style.shadow.color = c;
2090        self
2091    }
2092
2093    pub fn shadow_blur(mut self, blur: f32) -> Self {
2094        self.style.shadow.blur = blur;
2095        self
2096    }
2097
2098    pub fn shadow_offset(mut self, dx: f32, dy: f32) -> Self {
2099        self.style.shadow.dx = dx;
2100        self.style.shadow.dy = dy;
2101        self
2102    }
2103
2104    pub fn shadow_x(mut self, dx: f32) -> Self {
2105        self.style.shadow.dx = dx;
2106        self
2107    }
2108
2109    pub fn shadow_y(mut self, dy: f32) -> Self {
2110        self.style.shadow.dy = dy;
2111        self
2112    }
2113
2114    pub fn shadow_spread(mut self, spread: f32) -> Self {
2115        self.style.shadow.spread = spread;
2116        self
2117    }
2118
2119    /// Hover-track this node without making it clickable; see the
2120    /// `hoverable` field.
2121    pub fn hoverable(mut self) -> Self {
2122        self.hoverable = true;
2123        self
2124    }
2125
2126    /// Ask for another frame after this one, for as long as this node is
2127    /// declared. See the `animate` prop.
2128    pub fn animate(mut self) -> Self {
2129        self.animate = true;
2130        self
2131    }
2132
2133    /// Background from the OS accent colour where the host knows it; see
2134    /// the field.
2135    pub fn accent(mut self) -> Self {
2136        self.accent = true;
2137        self
2138    }
2139
2140    /// Makes this node clickable: a click emits `payload` as a
2141    /// [`UiEvent`](crate::input::UiEvent), and the node joins the Tab ring
2142    /// and reads as a button to assistive technology.
2143    pub fn on_click(mut self, payload: impl Into<Value>) -> Self {
2144        self.events_mut().on_click = Some(payload.into());
2145        self
2146    }
2147
2148    /// Background while hovered (see the `hover_bg` field).
2149    pub fn hover_bg(mut self, c: Color) -> Self {
2150        self.interact_mut().hover_bg = Some(c);
2151        self
2152    }
2153
2154    /// Background while dragged files are over this node (see the
2155    /// `drop_bg` field).
2156    pub fn drop_bg(mut self, c: Color) -> Self {
2157        self.interact_mut().drop_bg = Some(c);
2158        self
2159    }
2160
2161    /// Paints `gradient` over this node's `bg`, under its border and
2162    /// its children (see the `gradient` field).
2163    pub fn gradient(mut self, gradient: crate::gradient::Gradient) -> Self {
2164        self.interact_mut().gradient = Some(gradient);
2165        self
2166    }
2167
2168    /// Blurs what was drawn beneath this node, inside its rounded rect,
2169    /// by `radius` logical px (see the `backdrop_blur` field). A
2170    /// translucent `bg` over it makes frosted glass:
2171    ///
2172    /// ```
2173    /// # use kui_core::{Color, NodeSpec};
2174    /// let bar = NodeSpec::row().backdrop_blur(16.0).bg(Color::hex(0xffffff40));
2175    /// assert_eq!(bar.interact().backdrop_blur, 16.0);
2176    /// ```
2177    pub fn backdrop_blur(mut self, radius: f32) -> Self {
2178        self.interact_mut().backdrop_blur = radius.max(0.0);
2179        self
2180    }
2181
2182    /// Turns this node and everything under it by `turns`, clockwise,
2183    /// about its pivot (the centre unless `pivot` says), after layout
2184    /// (see [`TransformSpec`], ADR 0043). Tweens with `transition`:
2185    ///
2186    /// ```
2187    /// # use kui_core::NodeSpec;
2188    /// let card = NodeSpec::column().rotate(0.02).transition(300.0);
2189    /// assert_eq!(card.transform_spec().unwrap().rotate, 0.02);
2190    /// ```
2191    pub fn rotate(mut self, turns: f32) -> Self {
2192        self.transform_mut().rotate = turns;
2193        self
2194    }
2195
2196    /// Scales this node and everything under it by `scale` about its
2197    /// pivot, after layout (see [`TransformSpec`]); 1 is none.
2198    pub fn scale(mut self, scale: f32) -> Self {
2199        self.transform_mut().scale = scale;
2200        self
2201    }
2202
2203    /// The point `rotate` and `scale` are about, as fractions of the box:
2204    /// `(0.5, 0.5)` — the default — is the centre, `(0.0, 1.0)` the
2205    /// bottom-left corner.
2206    pub fn pivot(mut self, fx: f32, fy: f32) -> Self {
2207        self.transform_mut().pivot = crate::geom::Vec2::new(fx, fy);
2208        self
2209    }
2210
2211    /// The node's transform, allocated on first write.
2212    #[inline]
2213    pub(crate) fn transform_mut(&mut self) -> &mut TransformSpec {
2214        self.interact_mut()
2215            .transform
2216            .get_or_insert_with(|| Box::new(TransformSpec::NONE))
2217    }
2218
2219    /// The node's `rotate`, `scale` and `pivot` (ADR 0043), when it
2220    /// declares any.
2221    #[inline]
2222    pub fn transform_spec(&self) -> Option<TransformSpec> {
2223        self.interact
2224            .as_deref()
2225            .and_then(|i| i.transform.as_deref().copied())
2226    }
2227
2228    /// A table's grid rules in `c` (see the `rules` field).
2229    pub fn rules(mut self, c: Color) -> Self {
2230        self.interact_mut().rules = Some(c);
2231        self
2232    }
2233
2234    /// The rules' width in logical px; 1 when unset (see `rules`).
2235    pub fn rule_width(mut self, w: f32) -> Self {
2236        self.interact_mut().rule_w = w;
2237        self
2238    }
2239
2240    /// Makes this node a selection scope (see the `selectable` field):
2241    /// the text inside it becomes one selectable run.
2242    pub fn selectable(mut self) -> Self {
2243        self.interact_mut().selectable = true;
2244        self
2245    }
2246
2247    /// Makes this node's subtree a focus region (see the `focus_region`
2248    /// field): a Tab ring of its own, entered on purpose.
2249    pub fn focus_region(mut self) -> Self {
2250        self.interact_mut().focus_region = true;
2251        self
2252    }
2253
2254    /// Whether a scroll gesture starting over this scroller at its limit
2255    /// goes on to the one around it (see [`Overscroll`]):
2256    /// `Overscroll::Contain` keeps it here.
2257    pub fn overscroll(mut self, o: Overscroll) -> Self {
2258        self.interact_mut().overscroll = o;
2259        self
2260    }
2261
2262    /// When this node's scrollbars are drawn (see [`ScrollbarMode`]).
2263    /// Scrolling itself is unchanged whatever the mode.
2264    pub fn scrollbar(mut self, mode: ScrollbarMode) -> Self {
2265        self.interact_mut().scrollbar.mode = mode;
2266        self
2267    }
2268
2269    /// The thumb's width at rest, logical px (see [`Scrollbar::width`]).
2270    pub fn scrollbar_width(mut self, w: f32) -> Self {
2271        self.interact_mut().scrollbar.width = Some(w);
2272        self
2273    }
2274
2275    /// The thumb's colour at rest (see [`Scrollbar::color`]).
2276    pub fn scrollbar_color(mut self, c: Color) -> Self {
2277        self.interact_mut().scrollbar.color = Some(c);
2278        self
2279    }
2280
2281    /// The thumb's colour under the pointer or dragged (see
2282    /// [`Scrollbar::active_color`]).
2283    pub fn scrollbar_active_color(mut self, c: Color) -> Self {
2284        self.interact_mut().scrollbar.active_color = Some(c);
2285        self
2286    }
2287
2288    /// Background while pressed (see the `pressed_bg` field).
2289    pub fn pressed_bg(mut self, c: Color) -> Self {
2290        self.interact_mut().pressed_bg = Some(c);
2291        self
2292    }
2293
2294    /// Background while keyboard-visibly focused (see the `focus_bg`
2295    /// field); replaces the default focus ring.
2296    pub fn focus_bg(mut self, c: Color) -> Self {
2297        self.interact_mut().focus_bg = Some(c);
2298        self
2299    }
2300
2301    /// Puts this node in the Tab ring (see the `focusable` field).
2302    pub fn focusable(mut self) -> Self {
2303        self.focusable = true;
2304        self
2305    }
2306
2307    /// Hears focus entering and leaving this subtree (see the `on_focus`
2308    /// field).
2309    pub fn on_focus(mut self, tag: impl Into<Value>) -> Self {
2310        self.events_mut().on_focus = Some(tag.into());
2311        self
2312    }
2313
2314    /// A press here leaves keyboard focus where it was (see the
2315    /// `keep_focus` field).
2316    pub fn keep_focus(mut self) -> Self {
2317        self.events_mut().keep_focus = true;
2318        self
2319    }
2320
2321    /// Makes this node the modal scope's entry focus (see the
2322    /// `initial_focus` field).
2323    pub fn initial_focus(mut self) -> Self {
2324        self.initial_focus = true;
2325        self
2326    }
2327
2328    /// Makes this node inert (see the `disabled` field).
2329    pub fn disabled(mut self, disabled: bool) -> Self {
2330        self.disabled = disabled;
2331        self
2332    }
2333
2334    /// Makes this node the frame's modal surface (see the `modal` field).
2335    #[inline]
2336    pub fn modal(mut self, tag: impl Into<Value>) -> Self {
2337        self.events_mut().modal = Some(tag.into());
2338        self
2339    }
2340
2341    /// Joins the hover group `name` (see the `hover_group` field).
2342    pub fn hover_group(mut self, name: &str) -> Self {
2343        self.interact_mut().hover_group = Some(Self::hover_group_id(name));
2344        self
2345    }
2346
2347    /// Emits enter/leave events for this node (see the `on_hover` field).
2348    /// Pass a tag the handler can match on; `Value::Null` if the node key
2349    /// is identification enough.
2350    pub fn on_hover(mut self, tag: impl Into<Value>) -> Self {
2351        self.events_mut().on_hover = Some(tag.into());
2352        self
2353    }
2354
2355    /// Makes this node a drop zone for files dragged in from the OS (see
2356    /// the `on_drop` field).
2357    pub fn on_drop(mut self, tag: impl Into<Value>) -> Self {
2358        self.events_mut().on_drop = Some(tag.into());
2359        self
2360    }
2361
2362    /// Plays a registered sound when this node is clicked (see the
2363    /// `click_sound` field).
2364    pub fn click_sound(mut self, sound: crate::resources::SoundId) -> Self {
2365        self.interact_mut().click_sound = Some(sound);
2366        self
2367    }
2368
2369    /// Plays a registered sound when the pointer enters this node (see the
2370    /// `hover_sound` field).
2371    pub fn hover_sound(mut self, sound: crate::resources::SoundId) -> Self {
2372        self.interact_mut().hover_sound = Some(sound);
2373        self
2374    }
2375
2376    /// Makes this node draggable (see the `on_drag` field). Pass a tag the
2377    /// handler can match on; `Value::Null` if the node key is enough.
2378    pub fn on_drag(mut self, tag: impl Into<Value>) -> Self {
2379        self.events_mut().on_drag = Some(tag.into());
2380        self
2381    }
2382
2383    /// Reports this node's laid-out rect as an event whenever it changes
2384    /// (see the `on_layout` field). Pass a tag the handler can match on;
2385    /// `Value::Null` if the node key is identification enough.
2386    pub fn on_layout(mut self, tag: impl Into<Value>) -> Self {
2387        self.events_mut().on_layout = Some(tag.into());
2388        self
2389    }
2390
2391    /// What this node is to assistive technology (see the `role` field).
2392    pub fn role(mut self, role: Role) -> Self {
2393        self.access_mut().role = Some(role);
2394        self
2395    }
2396
2397    /// The accessible name (see the `label` field). Takes an `Arc<str>`
2398    /// as well as a `&str`, so a view can keep one and hand it out every
2399    /// frame without allocating.
2400    pub fn label(mut self, label: impl Into<Label>) -> Self {
2401        self.access_mut().label = Some(label.into());
2402        self
2403    }
2404
2405    /// The accessible description (see the `description` field).
2406    pub fn description(mut self, description: impl Into<Label>) -> Self {
2407        self.access_mut().description = Some(description.into());
2408        self
2409    }
2410
2411    /// The on state for a checkbox / radio / switch role.
2412    pub fn checked(mut self, checked: bool) -> Self {
2413        self.access_mut().checked = checked;
2414        self
2415    }
2416
2417    /// A checkbox that is neither on nor off (see the `mixed` field).
2418    pub fn mixed(mut self, mixed: bool) -> Self {
2419        self.access_mut().mixed = mixed;
2420        self
2421    }
2422
2423    /// The current one of a set (see the `selected` field).
2424    pub fn selected(mut self, selected: bool) -> Self {
2425        self.access_mut().selected = selected;
2426        self
2427    }
2428
2429    /// A disclosure's state (see the `expanded` field).
2430    pub fn expanded(mut self, expanded: bool) -> Self {
2431        self.access_mut().expanded = Some(expanded);
2432        self
2433    }
2434
2435    /// Marks this node a live region (see the `live` field).
2436    pub fn live(mut self, live: Live) -> Self {
2437        self.access_mut().live = live;
2438        self
2439    }
2440
2441    /// A slider role's current value.
2442    pub fn value_now(mut self, v: f32) -> Self {
2443        self.access_mut().value_now = Some(v);
2444        self
2445    }
2446
2447    pub fn value_min(mut self, v: f32) -> Self {
2448        self.access_mut().value_min = Some(v);
2449        self
2450    }
2451
2452    pub fn value_max(mut self, v: f32) -> Self {
2453        self.access_mut().value_max = Some(v);
2454        self
2455    }
2456
2457    /// How far one arrow key moves a slider (see the `value_step` field).
2458    /// A step that is not positive and finite clears it.
2459    pub fn value_step(mut self, v: f32) -> Self {
2460        self.access_mut().value_step = (v.is_finite() && v > 0.0).then_some(v);
2461        self
2462    }
2463
2464    /// Asks the core for a slider's changes (see the `on_change` field).
2465    pub fn on_change(mut self, tag: impl Into<Value>) -> Self {
2466        self.events_mut().on_change = Some(tag.into());
2467        self
2468    }
2469
2470    /// What a slider's position reads as (see the `value_text` field).
2471    pub fn value_text(mut self, text: impl Into<Label>) -> Self {
2472        self.access_mut().value_text = Some(text.into());
2473        self
2474    }
2475
2476    /// On a `Role::Line` of a custom editor: the caret's byte offset into
2477    /// this line's text (see the `caret` field).
2478    pub fn caret(mut self, offset: u32) -> Self {
2479        self.access_mut().caret = Some(offset);
2480        self
2481    }
2482
2483    /// On a `Role::Line` of a custom editor: the byte offset where the
2484    /// selection's other end sits (see the `selection_anchor` field).
2485    pub fn selection_anchor(mut self, offset: u32) -> Self {
2486        self.access_mut().selection_anchor = Some(offset);
2487        self
2488    }
2489
2490    /// On a `Role::Line` declaring `caret`: the caret is solid, not a
2491    /// caret to blink (see the `caret_solid` field). A block caret in a
2492    /// modal editor's normal mode — the one thing that otherwise asks an
2493    /// idle app for a frame twice a second.
2494    pub fn caret_solid(mut self) -> Self {
2495        self.access_mut().caret_solid = true;
2496        self
2497    }
2498
2499    /// Makes this node a key sink (see `NodeSpec::on_key` field). Pass a
2500    /// tag the handler can match on; `Value::Null` if the node key is
2501    /// identification enough.
2502    pub fn on_key(mut self, tag: impl Into<Value>) -> Self {
2503        self.events_mut().on_key = Some(tag.into());
2504        self
2505    }
2506
2507    /// A key sink with no tag — `on_key(Value::Null)`, for a handler that
2508    /// knows the node by its key.
2509    #[inline]
2510    pub fn key_sink(self) -> Self {
2511        self.on_key(Value::Null)
2512    }
2513
2514    /// Delivers releases to this key sink as well as presses (see the
2515    /// `key_up` field). Meaningless without `on_key`.
2516    pub fn key_up(mut self) -> Self {
2517        self.events_mut().key_up = true;
2518        self
2519    }
2520
2521    /// Delivers the modifier and lock keys to this key sink as keys of
2522    /// their own (see the `modifier_keys` field). Meaningless without
2523    /// `on_key`.
2524    pub fn modifier_keys(mut self) -> Self {
2525        self.events_mut().modifier_keys = true;
2526        self
2527    }
2528
2529    /// Asks for force-click events on this node (see the
2530    /// `on_force_click` field).
2531    pub fn on_force_click(mut self, tag: impl Into<Value>) -> Self {
2532        self.events_mut().on_force_click = Some(tag.into());
2533        self
2534    }
2535
2536    /// Asks for the non-primary buttons pressed over this node as events,
2537    /// each captured by it until its release (see the `on_button` field):
2538    /// `{kind="button", phase, button, x, y, tag}`. Every such button
2539    /// unless [`NodeSpec::buttons`] narrows it.
2540    pub fn on_button(mut self, tag: impl Into<Value>) -> Self {
2541        self.events_mut().on_button = Some(tag.into());
2542        self
2543    }
2544
2545    /// Which non-primary buttons `on_button` claims (see the `buttons`
2546    /// field): `Buttons::MIDDLE`, `Buttons::SECONDARY | Buttons::MIDDLE`.
2547    /// Meaningless without `on_button`.
2548    pub fn buttons(mut self, buttons: Buttons) -> Self {
2549        self.events_mut().buttons = buttons;
2550        self
2551    }
2552
2553    /// Asks for the wheel over this node as events (see the `on_scroll`
2554    /// field): `{kind="scroll", x, y, dx, dy, lines, tag}`.
2555    pub fn on_scroll(mut self, tag: impl Into<Value>) -> Self {
2556        self.events_mut().on_scroll = Some(tag.into());
2557        self
2558    }
2559
2560    /// Which axes `on_scroll` takes (see the `scroll_axes` field):
2561    /// `ScrollAxes::Y` for a terminal's history, so a sideways gesture
2562    /// passes it by. Meaningless without `on_scroll`.
2563    pub fn scroll_axes(mut self, axes: ScrollAxes) -> Self {
2564        self.events_mut().scroll_axes = axes;
2565        self
2566    }
2567
2568    /// The modifiers `on_scroll` is for (see the `scroll_mods` field):
2569    /// `KeyMods::NONE.with_ctrl().with_super()` hears a wheel turned with
2570    /// Ctrl or ⌘ held, ahead of every scroller under the pointer, and no
2571    /// other wheel. Meaningless without `on_scroll`.
2572    pub fn scroll_mods(mut self, mods: crate::input::KeyMods) -> Self {
2573        self.events_mut().scroll_mods = mods;
2574        self
2575    }
2576
2577    /// Asks for a context menu on this node (see the `on_context_menu`
2578    /// field). Pass a tag the handler can match on; `Value::Null` if the
2579    /// node key is identification enough.
2580    pub fn on_context_menu(mut self, tag: impl Into<Value>) -> Self {
2581        self.events_mut().on_context_menu = Some(tag.into());
2582        self
2583    }
2584
2585    /// Animates changes to this node's sizing amounts, colors and radius
2586    /// over `duration_ms` (cubic ease-out); see [`crate::anim`]. Only the
2587    /// duration: an easing or repeat already declared survives, so the
2588    /// transition props compose in any order.
2589    ///
2590    /// On a scroll container it also eases the offset a `reveal` or a
2591    /// `set_scroll` moves it to; the wheel, the thumb and a drag past the
2592    /// edge still land whole.
2593    ///
2594    /// ```rust
2595    /// use kui_core::{Easing, NodeSpec, Sizing};
2596    /// // Eases toward whatever width the view declares next frame.
2597    /// let pane = NodeSpec::column().width(Sizing::Fixed(240.0)).transition(180.0).easing(Easing::Smooth);
2598    /// assert_eq!(pane.transition.unwrap().duration_ms, 180.0);
2599    /// ```
2600    pub fn transition(mut self, duration_ms: f32) -> Self {
2601        let t = self.transition.get_or_insert(Transition::ms(duration_ms));
2602        t.duration_ms = duration_ms;
2603        self
2604    }
2605
2606    /// The whole [`Transition`] at once, replacing any declared so far.
2607    pub fn transition_with(mut self, t: Transition) -> Self {
2608        self.transition = Some(t);
2609        self
2610    }
2611
2612    /// Also ease this node's position (see the `slide` field); sets a
2613    /// default 200ms transition if none was declared yet.
2614    pub fn slide(mut self) -> Self {
2615        self.transition.get_or_insert(Transition::ms(200.0));
2616        self.slide = true;
2617        self
2618    }
2619
2620    /// Easing for the node's transition (sets a default 200ms one if none
2621    /// was declared yet).
2622    pub fn easing(mut self, easing: Easing) -> Self {
2623        let t = self.transition.get_or_insert(Transition::ms(200.0));
2624        t.easing = easing;
2625        self
2626    }
2627
2628    /// How far the node's spring overshoots, 0 (glides in) to
2629    /// [`crate::anim::MAX_BOUNCE`] — in place of the spring easing's own
2630    /// bounce, and on a timed easing in place of the curve, making it a
2631    /// spring (see [`Transition::bounce`]). Sets a default 200ms
2632    /// transition if none was declared yet.
2633    pub fn bounce(mut self, bounce: f32) -> Self {
2634        let t = self.transition.get_or_insert(Transition::ms(200.0));
2635        *t = t.bounce(bounce);
2636        self
2637    }
2638
2639    /// How this node's `keyframes` cycle (CSS's `animation-direction`);
2640    /// sets a default 200ms transition if none was declared yet.
2641    pub fn repeat(mut self, repeat: Repeat) -> Self {
2642        let t = self.transition.get_or_insert(Transition::ms(200.0));
2643        t.repeat = repeat;
2644        self
2645    }
2646
2647    /// Holds this node's keyframe cycle back by `delay_ms` (CSS's
2648    /// `animation-delay`), so siblings given different delays run out of
2649    /// phase — a cascade, a chase light. Sets a default 200ms transition if
2650    /// none was declared yet.
2651    pub fn delay(mut self, delay_ms: f32) -> Self {
2652        let t = self.transition.get_or_insert(Transition::ms(200.0));
2653        t.delay_ms = delay_ms;
2654        self
2655    }
2656
2657    /// Cycles the slots these stops name (see the `keyframes` field); sets
2658    /// a default 200ms transition if none was declared yet.
2659    pub fn keyframes(mut self, stops: Vec<Keyframe>) -> Self {
2660        self.transition.get_or_insert(Transition::ms(200.0));
2661        self.anim_mut().keyframes = stops;
2662        self
2663    }
2664
2665    /// Runs this node's keyframe cycle `n` times and then rests where the
2666    /// last one ended (see the `iterations` field, backlog F133): a burst,
2667    /// a shake, a bounce that plays once. A count that is not a positive
2668    /// number is the default, for ever.
2669    ///
2670    /// ```
2671    /// # use kui_core::{Keyframe, NodeSpec};
2672    /// let pop = NodeSpec::column()
2673    ///     .transition(300.0)
2674    ///     .keyframes(vec![Keyframe::default().scale(1.0), Keyframe::default().scale(1.2)])
2675    ///     .iterations(1.0);
2676    /// assert_eq!(pop.anim().iterations, Some(1.0));
2677    /// ```
2678    pub fn iterations(mut self, n: f32) -> Self {
2679        self.anim_mut().iterations = (n.is_finite() && n > 0.0).then_some(n);
2680        self
2681    }
2682
2683    /// Eases this node in from `enter` on its first sight (see the `enter`
2684    /// field); sets a default 200ms transition if none was declared yet.
2685    pub fn enter(mut self, enter: Enter) -> Self {
2686        self.transition.get_or_insert(Transition::ms(200.0));
2687        self.anim_mut().enter = Some(enter);
2688        self
2689    }
2690
2691    /// Eases this node out to `exit` after the view stops declaring it
2692    /// (see the `exit` field); sets a default 200ms transition if none was
2693    /// declared yet.
2694    pub fn exit(mut self, exit: Enter) -> Self {
2695        self.transition.get_or_insert(Transition::ms(200.0));
2696        self.anim_mut().exit = Some(exit);
2697        self
2698    }
2699
2700    /// Pressing this node starts an OS window drag (drivers promote a quick
2701    /// second press to a maximize toggle).
2702    pub fn window_drag(mut self) -> Self {
2703        self.window = Some(WindowRole::Drag);
2704        self
2705    }
2706
2707    /// Clicking this node emits the button's `WindowCommand`.
2708    pub fn window_button(mut self, button: WindowButton) -> Self {
2709        self.window = Some(WindowRole::Button(button));
2710        self
2711    }
2712
2713    /// The pointer shape over this node (see the `cursor` field).
2714    pub fn cursor(mut self, shape: CursorShape) -> Self {
2715        self.cursor = Some(shape);
2716        self
2717    }
2718}
2719
2720/// Which face a text shapes with: one of the three stock families, or a
2721/// font registered with the core.
2722#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
2723pub enum FontFamily {
2724    #[default]
2725    Sans,
2726    Serif,
2727    Mono,
2728    /// A font registered with the core (`Core::add_font_data` from file
2729    /// bytes, or `Core::add_system_font` by installed family name). A
2730    /// stale handle shapes as sans-serif. Not on the wire as a family:
2731    /// the `font` row carries the handle.
2732    Custom(crate::resources::FontId),
2733}
2734
2735impl FontFamily {
2736    /// The three stock families, in wire order: a binding sends the index.
2737    /// `Custom` is not a family on the wire; the `font` row is.
2738    pub const ALL: &'static [FontFamily] = &[FontFamily::Sans, FontFamily::Serif, FontFamily::Mono];
2739
2740    /// The spelling every binding uses; a registered font has none.
2741    pub fn name(self) -> Option<&'static str> {
2742        match self {
2743            FontFamily::Sans => Some("sans"),
2744            FontFamily::Serif => Some("serif"),
2745            FontFamily::Mono => Some("mono"),
2746            FontFamily::Custom(_) => None,
2747        }
2748    }
2749
2750    /// The variant `schema::FAMILIES` index `i` names; `Sans` for an
2751    /// index this build lacks.
2752    pub fn from_index(i: usize) -> FontFamily {
2753        Self::ALL.get(i).copied().unwrap_or_default()
2754    }
2755}
2756
2757/// How a text node breaks lines at its width.
2758#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
2759pub enum TextWrap {
2760    /// Break between words; a word wider than the line breaks by glyph.
2761    #[default]
2762    Word,
2763    /// Break anywhere (URLs, hashes, code).
2764    Glyph,
2765    /// Never break at the width: one line per paragraph, clipped to the
2766    /// node's box (explicit newlines still break).
2767    None,
2768    /// `Word`, but whitespace takes its room like any glyph — CSS's
2769    /// `white-space: break-spaces`: a space that does not fit starts the
2770    /// next row instead of hanging past the edge or vanishing at the
2771    /// break, so every byte has a place inside the box. An editor's
2772    /// wrapped line, whose caret stands on each space. A text with line
2773    /// breaks of its own, a `max_lines` or an `ellipsis` wraps as `Word`.
2774    BreakSpaces,
2775}
2776
2777/// The OpenType features a style asks the shaper for: up to
2778/// [`FontFeatures::MAX`] four-letter tags with a value each. `liga` 0
2779/// keeps a coding font from joining `->`, `tnum` 1 gives tabular figures,
2780/// `ss01` 1 turns on a stylistic set. Plain data and `Copy`, since a
2781/// `TextStyle` is; the spelling every binding shares is
2782/// [`FontFeatures::parse`]'s.
2783///
2784/// ```rust
2785/// use kui_core::{FontFeatures, TextStyle};
2786/// let code = TextStyle::new(13.0).mono().features(FontFeatures::parse("-liga -calt tnum"));
2787/// assert_eq!(code.features.len(), 3);
2788/// assert_eq!(code.features.to_string_spelling(), "liga=0 calt=0 tnum=1");
2789/// ```
2790#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
2791pub struct FontFeatures {
2792    tags: [[u8; 4]; FontFeatures::MAX],
2793    values: [u32; FontFeatures::MAX],
2794    len: u8,
2795}
2796
2797impl FontFeatures {
2798    /// How many features a style can carry. Eight is more than any one
2799    /// text asks for and keeps the style small.
2800    pub const MAX: usize = 8;
2801
2802    /// No features: the font's own defaults.
2803    pub const fn new() -> Self {
2804        Self {
2805            tags: [[b' '; 4]; Self::MAX],
2806            values: [0; Self::MAX],
2807            len: 0,
2808        }
2809    }
2810
2811    /// Adds or replaces `tag` (four ASCII characters; shorter is padded
2812    /// with spaces, longer is cut) with `value`. Past `MAX` the feature is
2813    /// dropped rather than the style refused.
2814    pub fn set(mut self, tag: &str, value: u32) -> Self {
2815        let mut t = [b' '; 4];
2816        for (i, b) in tag.bytes().take(4).enumerate() {
2817            t[i] = b;
2818        }
2819        let n = self.len as usize;
2820        if let Some(i) = self.tags[..n].iter().position(|x| *x == t) {
2821            self.values[i] = value;
2822        } else if n < Self::MAX {
2823            self.tags[n] = t;
2824            self.values[n] = value;
2825            self.len += 1;
2826        }
2827        self
2828    }
2829
2830    /// The spelling every binding shares: tags separated by whitespace or
2831    /// commas, each `tag=value`, a bare `tag` meaning 1 and `-tag` meaning
2832    /// 0 — `"liga=0 calt=0 tnum"`, `"-liga,-calt"`. Anything else in the
2833    /// string is skipped.
2834    pub fn parse(s: &str) -> Self {
2835        let mut out = Self::new();
2836        for item in s.split(|c: char| c.is_whitespace() || c == ',') {
2837            if item.is_empty() {
2838                continue;
2839            }
2840            let (tag, value) = if let Some((t, v)) = item.split_once('=') {
2841                (t, v.trim().parse::<u32>().unwrap_or(0))
2842            } else if let Some(t) = item.strip_prefix('-') {
2843                (t, 0)
2844            } else if let Some(t) = item.strip_prefix('+') {
2845                (t, 1)
2846            } else {
2847                (item, 1)
2848            };
2849            let tag = tag.trim();
2850            if !tag.is_empty() {
2851                out = out.set(tag, value);
2852            }
2853        }
2854        out
2855    }
2856
2857    pub fn is_empty(&self) -> bool {
2858        self.len == 0
2859    }
2860
2861    pub fn len(&self) -> usize {
2862        self.len as usize
2863    }
2864
2865    /// Every feature, in the order set, as `(tag, value)`.
2866    pub fn iter(&self) -> impl Iterator<Item = (&[u8; 4], u32)> + '_ {
2867        let n = self.len as usize;
2868        self.tags[..n].iter().zip(self.values[..n].iter().copied())
2869    }
2870
2871    /// What `parse` reads: `tag=value` pairs joined by spaces.
2872    pub fn to_string_spelling(&self) -> String {
2873        self.iter()
2874            .map(|(t, v)| format!("{}={}", String::from_utf8_lossy(t).trim_end(), v))
2875            .collect::<Vec<_>>()
2876            .join(" ")
2877    }
2878}
2879
2880/// How a run of text is shaped and painted: size, line height, colour,
2881/// family, wrapping, line limits, OpenType features and decorations.
2882///
2883/// [`TextStyle::new`] takes the font size and derives a line height; the
2884/// rest are builders. A style with no colour paints in the theme's
2885/// foreground, so plain text is legible on both the light and dark base.
2886///
2887/// ```rust
2888/// use kui_core::{Color, FontFamily, TextStyle, TextWrap};
2889///
2890/// let body = TextStyle::new(15.0).line_height(22.0);
2891/// let caption = TextStyle::new(12.0).color(Color::hex(0x8a8fa3ff)).max_lines(2).ellipsis();
2892/// let code = TextStyle::new(13.0).family(FontFamily::Mono).wrap(TextWrap::None);
2893/// let link = TextStyle::new(15.0).underline().color(Color::hex(0x3b5bd4ff));
2894///
2895/// assert_eq!(body.color, None); // the theme's foreground
2896/// assert_eq!(caption.max_lines, 2);
2897/// assert!(code.wrap == TextWrap::None && link.underline);
2898/// ```
2899#[derive(Clone, Copy, Debug, PartialEq)]
2900pub struct TextStyle {
2901    pub size: f32,
2902    pub line_height: f32,
2903    /// `None` is the theme's foreground, filled in as the text enters the
2904    /// tree so nothing downstream of that ever sees a `None`.
2905    pub color: Option<Color>,
2906    pub family: FontFamily,
2907    pub wrap: TextWrap,
2908    /// At most this many lines are laid out; 0 = unlimited.
2909    pub max_lines: u32,
2910    /// End the last line with "…" when the text was cut off. Alone it
2911    /// means a single line (`max_lines` 1); with `max_lines` it clamps.
2912    pub ellipsis: bool,
2913    /// OpenType features for the shaper; none by default, which is the
2914    /// font's own defaults (ligatures on, where it has them).
2915    pub features: FontFeatures,
2916    /// A line under every glyph, where the face puts its underline. Paint
2917    /// only: not part of what the text is shaped as.
2918    pub underline: bool,
2919    /// The underline's own colour; `None` is the text's.
2920    pub underline_color: Option<Color>,
2921    /// The underline's shape: a line, a wave, dots.
2922    pub underline_style: UnderlineStyle,
2923    /// A line through every glyph, where the face puts its strikeout.
2924    pub strikethrough: bool,
2925}
2926
2927/// The shape of an underline: the face's line, a wave under a diagnostic,
2928/// dots. Where it goes and how thick it is are the face's
2929/// recommendation either way; a wave is three strokes tall around the
2930/// line's centre with a six-stroke period, dots two strokes across and
2931/// four apart (`crate::deco`).
2932#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
2933pub enum UnderlineStyle {
2934    #[default]
2935    Solid,
2936    Wavy,
2937    Dotted,
2938}
2939
2940impl UnderlineStyle {
2941    /// The spellings, in discriminant order (`underlineStyle` /
2942    /// `underline_style`; C's `KUI_UNDERLINE_*`).
2943    pub const NAMES: &[&str] = &["solid", "wavy", "dotted"];
2944
2945    pub fn from_index(i: u32) -> Self {
2946        match i {
2947            1 => Self::Wavy,
2948            2 => Self::Dotted,
2949            _ => Self::Solid,
2950        }
2951    }
2952
2953    pub fn name(self) -> &'static str {
2954        Self::NAMES[self as usize]
2955    }
2956}
2957
2958impl Default for TextStyle {
2959    fn default() -> Self {
2960        Self::new(16.0)
2961    }
2962}
2963
2964impl TextStyle {
2965    /// A style at `size` logical px, sans, in the theme's foreground, with
2966    /// a line height of 1.35 times the size, rounded.
2967    pub fn new(size: f32) -> Self {
2968        Self {
2969            size,
2970            line_height: (size * 1.35).round(),
2971            color: None,
2972            family: FontFamily::Sans,
2973            wrap: TextWrap::Word,
2974            max_lines: 0,
2975            ellipsis: false,
2976            features: FontFeatures::new(),
2977            underline: false,
2978            underline_color: None,
2979            underline_style: UnderlineStyle::Solid,
2980            strikethrough: false,
2981        }
2982    }
2983
2984    /// Underlines the text in its own colour.
2985    pub fn underline(mut self) -> Self {
2986        self.underline = true;
2987        self
2988    }
2989
2990    /// An underline in its own colour rather than the text's (a
2991    /// diagnostic's red under keyword-coloured text). Turns the underline
2992    /// on.
2993    pub fn underline_color(mut self, c: Color) -> Self {
2994        self.underline = true;
2995        self.underline_color = Some(c);
2996        self
2997    }
2998
2999    /// An underline of this shape. Turns the underline on.
3000    pub fn underline_style(mut self, s: UnderlineStyle) -> Self {
3001        self.underline = true;
3002        self.underline_style = s;
3003        self
3004    }
3005
3006    /// A line through the text.
3007    pub fn strikethrough(mut self) -> Self {
3008        self.strikethrough = true;
3009        self
3010    }
3011
3012    /// OpenType features for the shaper; see [`FontFeatures`].
3013    pub fn features(mut self, f: FontFeatures) -> Self {
3014        self.features = f;
3015        self
3016    }
3017
3018    /// The face to shape with.
3019    pub fn family(mut self, f: FontFamily) -> Self {
3020        self.family = f;
3021        self
3022    }
3023
3024    /// The stock monospace family.
3025    pub fn mono(self) -> Self {
3026        self.family(FontFamily::Mono)
3027    }
3028
3029    /// Shape with a registered font (see `FontFamily::Custom`).
3030    pub fn font(self, id: crate::resources::FontId) -> Self {
3031        self.family(FontFamily::Custom(id))
3032    }
3033
3034    /// The line height in logical px, replacing the derived one.
3035    pub fn line_height(mut self, lh: f32) -> Self {
3036        self.line_height = lh;
3037        self
3038    }
3039
3040    /// How lines break at the node's width.
3041    pub fn wrap(mut self, wrap: TextWrap) -> Self {
3042        self.wrap = wrap;
3043        self
3044    }
3045
3046    /// One line per paragraph, clipped to the node (`TextWrap::None`).
3047    pub fn nowrap(self) -> Self {
3048        self.wrap(TextWrap::None)
3049    }
3050
3051    /// Lay out at most `n` lines (0 = unlimited).
3052    pub fn max_lines(mut self, n: u32) -> Self {
3053        self.max_lines = n;
3054        self
3055    }
3056
3057    /// Truncate with "…" instead of overflowing: a single line unless
3058    /// `max_lines` says otherwise.
3059    pub fn ellipsis(mut self) -> Self {
3060        self.ellipsis = true;
3061        self
3062    }
3063
3064    /// The text colour, instead of the theme's foreground.
3065    pub fn color(mut self, c: Color) -> Self {
3066        self.color = Some(c);
3067        self
3068    }
3069
3070    /// This style with `fg` where it named no colour of its own: what the
3071    /// core stamps on as the text enters the tree, so the shaping caches,
3072    /// the display list and every binding see a resolved colour.
3073    pub fn or_fg(mut self, fg: Color) -> Self {
3074        self.color = Some(self.color.unwrap_or(fg));
3075        self
3076    }
3077
3078    /// The colour this style paints in, falling back to what kui painted
3079    /// before there were themes. For the handful of places that hold a
3080    /// style the core never stamped.
3081    pub fn color_or_default(&self) -> Color {
3082        self.color.unwrap_or(crate::theme::Theme::DEFAULT_FG)
3083    }
3084}
3085
3086/// Hand-written so that a group whose box was allocated but left at its
3087/// defaults — `.checked(false)` on a fresh spec — equals one whose box was
3088/// never allocated at all. The derived version compared `None` against
3089/// `Some(EMPTY)` and called them different, which is a difference the boxing
3090/// introduced rather than one a caller declared.
3091impl PartialEq for NodeSpec {
3092    fn eq(&self, other: &Self) -> bool {
3093        self.layout == other.layout
3094            && self.style == other.style
3095            && self.hoverable == other.hoverable
3096            && self.animate == other.animate
3097            && self.accent == other.accent
3098            && self.window == other.window
3099            && self.transition == other.transition
3100            && self.slide == other.slide
3101            && self.focusable == other.focusable
3102            && self.initial_focus == other.initial_focus
3103            && self.disabled == other.disabled
3104            && self.cursor == other.cursor
3105            && self.events() == other.events()
3106            && self.anim() == other.anim()
3107            && self.access() == other.access()
3108            && self.interact() == other.interact()
3109    }
3110}
3111
3112#[cfg(test)]
3113mod size_tests {
3114    use super::*;
3115
3116    /// `NodeSpec` is moved by value for every node a frame builds — through
3117    /// the builder chain, `Core::open`, `open_with_key` and into
3118    /// `Vec<NodeSpec>` in `Tree::push` — so its size is a per-node cost that
3119    /// every app pays whether or not it declares the fields. It reached 728
3120    /// bytes one feature at a time and cost ~2.5x on the frame benches before
3121    /// anyone measured it.
3122    ///
3123    /// This is the number a review can fail. Adding a prop is fine; adding it
3124    /// *inline* past this bound is the thing to notice. Put cold fields in one
3125    /// of the boxed groups instead, and only raise this if the field is read
3126    /// on every node of every frame.
3127    #[test]
3128    fn node_spec_stays_small() {
3129        const BOUND: usize = 256;
3130        let size = std::mem::size_of::<NodeSpec>();
3131        assert!(
3132            size <= BOUND,
3133            "NodeSpec is {size} bytes, over the {BOUND}-byte bound. It is copied \
3134             per node per frame; put cold fields in EventSpec / AnimSpec / \
3135             AccessSpec / InteractSpec rather than inline. See C15."
3136        );
3137    }
3138
3139    /// The groups exist to be absent: a node declaring none of them carries
3140    /// four null pointers, not four structs.
3141    #[test]
3142    fn an_undeclared_group_costs_a_pointer() {
3143        let spec = NodeSpec::default();
3144        assert!(spec.events.is_none() && spec.anim.is_none());
3145        assert!(spec.access.is_none() && spec.interact.is_none());
3146        // and reads still work, without allocating
3147        assert!(spec.events().on_click.is_none());
3148        assert_eq!(spec.access().role, None);
3149    }
3150
3151    /// An allocated-but-default group is still equal to no group at all.
3152    #[test]
3153    fn an_empty_group_equals_no_group() {
3154        assert_eq!(NodeSpec::default().checked(false), NodeSpec::default());
3155    }
3156}