Skip to main content

eui_core/surface/
mod.rs

1//! A `Surface` = one A2UI surface: its catalog, its normalized tree, its
2//! data model, its theme and settings, the local UI state the core owns,
3//! and one layout engine (main root + one root per open layer) kept across
4//! passes.
5//!
6//! Round 1 (renderer hardening):
7//! - nodes live in STABLE SLOTS keyed by id: a rebuild (a data write, a tab
8//!   switch, an opened overlay, a scrolled window) reconciles by id, keeps
9//!   every unchanged node's style, visual and measurement, and reports the
10//!   difference as a [`NodeDelta`] (`added` / `removed` / `changed`);
11//! - restyle is PER NODE: a state change restyles that node, a viewport
12//!   change only the nodes with conditions, a theme/mode/settings change
13//!   every node;
14//! - settings: locale + strings, mode `light|dark|system`, density,
15//!   contrast, font scale, safe-area insets, pointer hover, reduced motion
16//!   ([`SurfaceSettings`]).
17//!
18//! The API is COARSE by design (the FFI facade mirrors it one to one):
19//! messages in (`apply`), viewport/state setters, `layout(measure)` out —
20//! never a call per node or per keystroke.
21
22mod events;
23mod pass;
24mod reconcile;
25mod restyle;
26
27pub use pass::{LayoutStep, LeafData};
28
29use std::collections::{BTreeSet, HashMap, HashSet};
30use std::sync::Arc;
31
32use indexmap::IndexMap;
33use serde::{Deserialize, Serialize};
34use serde_json::{Map, Value};
35use taffy::style::Direction;
36
37use crate::catalog::{CatalogView, A2UI_BASIC_CATALOG_ID};
38use crate::data::{get_pointer, set_pointer};
39use crate::engine::Engine;
40use crate::layout_tree::{LNode, LayerClass, LayerSpec, ListSpec, LocalState, NodeKind, ToastSpec};
41use crate::measure::{ControlBox, MeasureMemo, TextStyle};
42use crate::overlay::OverlayPlacement;
43use crate::recipes::RecipeIndex;
44use crate::reducer::{reduce_surface, ReduceOptions, ReduceResult};
45use crate::strings::StringTable;
46use crate::style::Visual;
47use crate::theme::{apply_contrast, apply_density, resolve_mode, Density, Mode, ModeSetting, ResolvedTheme};
48use crate::types::{ExtensionDef, FlatComponent, NestedNode, ReduceIssue, UiNode};
49
50pub use crate::layout_tree::ToastSpec as Toast;
51
52/// How long a hover overlay (Tooltip, `openOn: hover` Popover) waits after
53/// the pointer left its trigger and content before it closes (the
54/// reference's `HOVER_CLOSE_MS`): time to cross the gap into the content.
55pub const HOVER_CLOSE_MS: u32 = 150;
56
57/// Absolute frame in surface coordinates (points/dp; fractional unless
58/// rounding is on).
59#[derive(Debug, Clone, Copy, PartialEq, Default, Serialize, Deserialize)]
60pub struct Frame {
61    pub x: f32,
62    pub y: f32,
63    pub w: f32,
64    pub h: f32,
65}
66
67/// The static description of one layout node (`Surface::nodes`): fetched
68/// once, then patched with [`NodeDelta`]. Indices are STABLE slots; paint
69/// order = accessibility order = the order of `LayoutOutput.frames`.
70#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
71pub struct PlacedNode {
72    pub index: u32,
73    pub id: String,
74    pub component: String,
75    #[serde(skip_serializing_if = "Option::is_none")]
76    pub part: Option<String>,
77    #[serde(skip_serializing_if = "Option::is_none")]
78    pub owner: Option<String>,
79    #[serde(skip_serializing_if = "Option::is_none")]
80    pub owner_component: Option<String>,
81    #[serde(skip_serializing_if = "Option::is_none")]
82    pub catalog_id: Option<String>,
83    #[serde(skip_serializing_if = "Option::is_none")]
84    pub extension_kind: Option<String>,
85    pub depth: u32,
86    #[serde(skip_serializing_if = "Option::is_none")]
87    pub parent: Option<u32>,
88    /// Children in paint order.
89    #[serde(default, skip_serializing_if = "Vec::is_empty")]
90    pub children: Vec<u32>,
91    pub layer: u32,
92    pub kind: NodeKind,
93    pub props: Map<String, Value>,
94    #[serde(skip_serializing_if = "Option::is_none")]
95    pub lines: Option<u32>,
96    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
97    pub pressable: bool,
98    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
99    pub hidden: bool,
100    #[serde(skip_serializing_if = "Option::is_none")]
101    pub accessibility: Option<Value>,
102    /// The overlay this node opens when pressed (a trigger slot's root).
103    #[serde(skip_serializing_if = "Option::is_none")]
104    pub trigger_for: Option<String>,
105    /// The part states the core decided (`selected`, `open`, `checked`,
106    /// `invalid`, `disabled`); the host adds `hover`/`pressed`/`focus`.
107    #[serde(default, skip_serializing_if = "Vec::is_empty")]
108    pub states: Vec<String>,
109    /// The enclosing Form's id.
110    #[serde(skip_serializing_if = "Option::is_none")]
111    pub form: Option<String>,
112    /// A live region: `polite | assertive`.
113    #[serde(skip_serializing_if = "Option::is_none")]
114    pub live: Option<String>,
115    /// A freed slot (the node left the tree; a later node may reuse it).
116    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
117    pub removed: bool,
118}
119
120#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
121pub struct PlacedFrame {
122    pub index: u32,
123    pub x: f32,
124    pub y: f32,
125    pub w: f32,
126    pub h: f32,
127}
128
129/// One overlay layer in paint order, frames in SURFACE coordinates.
130#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
131pub struct Layer {
132    pub layer: u32,
133    pub kind: String,
134    pub owner: String,
135    pub root: u32,
136    #[serde(skip_serializing_if = "Option::is_none")]
137    pub anchor_frame: Option<Frame>,
138    #[serde(skip_serializing_if = "Option::is_none")]
139    pub placement: Option<OverlayPlacement>,
140    /// Drawer: the viewport edge; Dialog: `centered`; anchored: the side it
141    /// landed on; a context menu: `point`; a toast: `toast`.
142    pub position: String,
143    /// `overlay` or `toast` (base < overlay < toast; no z-index).
144    pub class: LayerClass,
145    /// A scrim under it and the focus trapped inside (Dialog, Drawer).
146    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
147    pub modal: bool,
148    /// Escape, a scrim press or a drag closes it (`event(root, "dismiss")`).
149    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
150    pub dismissible: bool,
151    pub frames: Vec<PlacedFrame>,
152}
153
154#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
155pub struct ListOutput {
156    pub id: String,
157    pub node: u32,
158    pub content_height: f32,
159    pub start: u32,
160    pub end: u32,
161    pub count: u32,
162    pub windowed: bool,
163    /// Round 2: windows on x (`content_height` is then the content width).
164    #[serde(default, skip_serializing_if = "std::ops::Not::not")]
165    pub horizontal: bool,
166}
167
168/// Round 2 (§2, §5): a node pinned by `position: sticky` (or a List's
169/// pinned section header): paint it (and its subtree) translated by
170/// `(dx, dy)` on top of its frame, inside the same scroll translation as
171/// its siblings. Only nodes that move are listed.
172#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
173pub struct StickyOutput {
174    pub index: u32,
175    pub dx: f32,
176    pub dy: f32,
177}
178
179/// One scroll container (any `overflow: scroll|auto` node, windowed lists,
180/// a Dialog body): its offset (clamped), its viewport (the node's frame) and
181/// its scrollable content size. Frames are reported UNSCROLLED: a painter
182/// translates every descendant by `-offset` and clips to the frame.
183#[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]
184pub struct ScrollOutput {
185    pub index: u32,
186    pub offset_x: f32,
187    pub offset_y: f32,
188    pub content_width: f32,
189    pub content_height: f32,
190    pub scroll_x: bool,
191    pub scroll_y: bool,
192}
193
194/// What changed in `nodes()` since the previous `layout()`: `added` and
195/// `changed` slots to fetch again (`nodes_at`), `removed` slots to drop.
196/// `renumbered` = every index moved (compaction, a new surface): fetch all.
197#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
198pub struct NodeDelta {
199    pub added: Vec<u32>,
200    pub removed: Vec<u32>,
201    pub changed: Vec<u32>,
202    pub renumbered: bool,
203}
204
205impl NodeDelta {
206    pub fn is_empty(&self) -> bool {
207        self.added.is_empty() && self.removed.is_empty() && self.changed.is_empty() && !self.renumbered
208    }
209}
210
211#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
212pub struct LayoutOutput {
213    /// Main-tree frames, pre-order (= paint order).
214    pub frames: Vec<PlacedFrame>,
215    pub layers: Vec<Layer>,
216    pub lists: Vec<ListOutput>,
217    pub scrolls: Vec<ScrollOutput>,
218    /// Round 2: sticky nodes and pinned section headers at their pinned
219    /// paint offsets this pass.
220    #[serde(default, skip_serializing_if = "Vec::is_empty")]
221    pub sticky: Vec<StickyOutput>,
222    /// Open toasts the host times (`duration_ms` 0 = sticky); a timeout is
223    /// `event(<toast root>, "dismiss")` / `dismiss_toast(id)`.
224    pub toasts: Vec<ToastSpec>,
225    /// Slots whose resolved visual changed since the last pass.
226    pub visual_changes: Vec<u32>,
227    /// The node changes since the last pass (see [`NodeDelta`]).
228    pub delta: NodeDelta,
229    /// Bumps whenever the node set changed (added/removed/renumbered).
230    pub structure_version: u64,
231    pub surface_width: f32,
232    pub surface_height: f32,
233    /// Content taller than the bounded height (a transcript card may scroll).
234    pub overflow: bool,
235    /// `ltr` | `rtl` (the root's `direction`, else the locale's).
236    pub direction: String,
237    /// The active breakpoint (`None` = base).
238    pub breakpoint: Option<String>,
239    pub measure_rounds: u32,
240    pub upcalls: u32,
241    /// Nodes restyled this pass (a hover = 1; a theme switch = all).
242    pub restyled: u32,
243    /// The layout tree was rebuilt (and reconciled) this pass.
244    pub rebuilt: bool,
245    /// Layout nodes the builder produced this pass: the whole tree on a
246    /// rebuild, only a re-windowed list's subtree on a scroll.
247    pub built_nodes: u32,
248    pub layout_ns: u64,
249}
250
251/// What the host must do after an interaction (`non_exhaustive`: match with
252/// a wildcard arm; new kinds are additive). The wire form is camelCase
253/// throughout, kinds AND fields (`{kind: "action", componentId, …}`,
254/// `{kind: "hoverTimer", owner, delayMs}`), as the host API's.
255#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
256#[serde(tag = "kind", rename_all = "camelCase", rename_all_fields = "camelCase")]
257#[non_exhaustive]
258pub enum OutEvent {
259    /// A server event (A2UI `action`): forward it. `context` = the author's
260    /// context with the event payload merged over it.
261    Action { name: String, component_id: String, event: String, context: Value, #[serde(skip_serializing_if = "Option::is_none")] payload: Option<Value> },
262    /// `openUrl` or a `Link`.
263    OpenUrl { url: String },
264    /// An `on.<event>` `functionCall` naming a HOST function (not one of
265    /// the catalog's built-ins, `FUNCTION_NAMES`): the host looks it up in
266    /// its registry and runs it through the policy gate
267    /// (`host::decide_function`, VAPP-91). `args` = the call's args resolved
268    /// against the data model and scope. Serialized `{kind: "functionCall",
269    /// componentId, name, args}`.
270    FunctionCall { component_id: String, name: String, args: Value },
271    /// A bound value was written through to the data model.
272    DataChanged { path: String, value: Value },
273    /// A host-owned input edit (the host forwards with its revision).
274    Input { component_id: String, name: String, #[serde(skip_serializing_if = "Option::is_none")] path: Option<String>, value: Value, commit: bool },
275    /// Move keyboard focus (a Form's first invalid field, `focus` command).
276    Focus { id: String, index: u32 },
277    /// Speak through the platform's live region.
278    Announce { text: String, live: String },
279    /// Put text on the clipboard (CodeBlock copy).
280    Copy { text: String },
281    /// Open the platform file picker for a FileUpload; the picked files come
282    /// back as `event(<dropzone>, "upload", {files})` (bytes via the host).
283    PickFiles { component_id: String, #[serde(skip_serializing_if = "Option::is_none")] accept: Option<String>, multiple: bool },
284    /// Local UI state changed: lay out again.
285    Relayout,
286    /// Call [`Surface::hover_timeout`]`(owner)` after `delay_ms` (a hover
287    /// overlay whose trigger and content were left; it closes then unless
288    /// the pointer came back). Keep ONE timer per owner: a new `HoverTimer`
289    /// for the same owner restarts it.
290    HoverTimer { owner: String, delay_ms: u32 },
291    /// Round 2: scroll the host viewport of the whole surface to `(x, y)`
292    /// (a `scrollToIndex` on a list the page scrolls), then report it with
293    /// [`Surface::set_surface_scroll`].
294    ScrollSurface { x: f32, y: f32 },
295}
296
297/// What a host may ask of a live surface (`catalog/a11y.json` `commands`).
298#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
299#[serde(rename_all = "camelCase")]
300pub enum SurfaceCommand {
301    Focus { id: String },
302    Announce { text: String, #[serde(default)] live: Option<String> },
303    ScrollIntoView { id: String },
304    /// Round 2: `scrollToIndex {id, index, align?}` (`start | center | end |
305    /// nearest`, default nearest).
306    ScrollToIndex {
307        id: String,
308        index: u32,
309        #[serde(default, skip_serializing_if = "Option::is_none")]
310        align: Option<String>,
311    },
312}
313
314/// Safe-area insets (status bar, notch, home indicator) layers keep clear of.
315#[derive(Debug, Clone, Copy, PartialEq, Default, Serialize, Deserialize)]
316pub struct Insets {
317    pub top: f32,
318    pub right: f32,
319    pub bottom: f32,
320    pub left: f32,
321}
322
323/// `normal | high | system` (system = the platform's high-contrast flag).
324#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
325#[serde(rename_all = "lowercase")]
326pub enum ContrastSetting {
327    Normal,
328    High,
329    #[default]
330    System,
331}
332
333/// What a host sets per surface (docs/round-1-contract.md §4–6).
334#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
335#[serde(rename_all = "camelCase", default)]
336pub struct SurfaceSettings {
337    /// BCP 47; the week start and the text direction. Default `en-US`.
338    pub locale: String,
339    /// Built-in string overrides by id.
340    pub strings: IndexMap<String, String>,
341    pub mode: ModeSetting,
342    /// The platform prefers dark (`mode: system`).
343    pub system_dark: bool,
344    pub density: Density,
345    pub contrast: ContrastSetting,
346    /// The platform asks for more contrast (`contrast: system`).
347    pub system_high_contrast: bool,
348    /// Dynamic Type / font scale, applied to every resolved type size.
349    pub font_scale: f32,
350    /// A hover-capable pointer (`@media (hover: hover)`, hover popovers).
351    pub hover: bool,
352    /// `@media (prefers-reduced-motion: reduce)`; transitions become 0 ms.
353    pub reduced_motion: bool,
354    pub insets: Insets,
355    /// Today as `yyyy-mm-dd` (calendars open on it and mark it).
356    pub today: Option<String>,
357    /// How a hover overlay (Tooltip, `openOn: hover` Popover) closes when
358    /// the pointer left its trigger and its content. `0` (default) = at
359    /// once: the HOST delays forwarding the trigger's un-hover (gpui's
360    /// grace). `> 0` (natives: [`HOVER_CLOSE_MS`]) = the core holds it open
361    /// and raises [`OutEvent::HoverTimer`]; the host calls
362    /// [`Surface::hover_timeout`] when it fires.
363    pub hover_close_ms: u32,
364    /// VAPP-200: the viewer may read, not write (an app at app access
365    /// `read`): every writing control builds as `disabled: true`
366    /// ([`crate::read_only`], `fixtures/read-only.json`).
367    pub read_only: bool,
368    /// VAPP-218: the HOST's form factor, what `@media (form-factor: …)`
369    /// matches (an editor preview's phone frame, a phone). `None` (default)
370    /// = derived from the surface width against the theme's `$breakpoint.md`.
371    pub form_factor: Option<crate::conditions::FormFactor>,
372}
373
374impl Default for SurfaceSettings {
375    fn default() -> Self {
376        SurfaceSettings {
377            locale: crate::locale::DEFAULT_LOCALE.to_string(),
378            strings: IndexMap::new(),
379            mode: ModeSetting::Light,
380            system_dark: false,
381            density: Density::Default,
382            contrast: ContrastSetting::Normal,
383            system_high_contrast: false,
384            font_scale: 1.0,
385            hover: true,
386            reduced_motion: false,
387            insets: Insets::default(),
388            today: None,
389            hover_close_ms: 0,
390            read_only: false,
391            form_factor: None,
392        }
393    }
394}
395
396#[derive(Debug, Clone)]
397pub struct SurfaceOptions {
398    pub catalog_id: String,
399    /// `None` = no theme: geometry mode (no recipes, styles verbatim).
400    pub theme: Option<Arc<ResolvedTheme>>,
401    pub mode: Mode,
402    pub extensions: Vec<ExtensionDef>,
403    pub rounding: bool,
404    /// Expand form controls into their parts (default: when themed). Off =
405    /// geometry mode: every native is ONE measured leaf.
406    pub expand_controls: Option<bool>,
407}
408
409impl Default for SurfaceOptions {
410    fn default() -> Self {
411        SurfaceOptions {
412            catalog_id: crate::catalog::CORE_CATALOG_ID.to_string(),
413            theme: Some(crate::themes::default_theme()),
414            mode: Mode::Light,
415            extensions: Vec::new(),
416            rounding: false,
417            expand_controls: None,
418        }
419    }
420}
421
422#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Default)]
423pub struct ApplyOutcome {
424    pub structure_changed: bool,
425    /// The reduce issues of a whole tree (`set_nested`, `set_components`,
426    /// `createSurface`) or this message's own refusal (a data write).
427    /// VAPP-103: a streamed `updateComponents` reduces LAZILY (a surface
428    /// sent one component per message costs linear, not quadratic): it
429    /// reports the issues its OWN components raise (unknown component,
430    /// props, `visible`, children, slots); the tree's (missing ids, cycles,
431    /// limits) are [`Surface::issues`] after it.
432    pub issues: Vec<ReduceIssue>,
433}
434
435/// `%` radii a node asked for (resolved against its laid-out box).
436#[derive(Debug, Clone, Copy, PartialEq, Default)]
437struct RadiusPercent {
438    all: Option<f32>,
439    corners: [Option<f32>; 4],
440}
441
442/// Per-slot layout state kept across passes.
443#[derive(Debug, Clone, Default)]
444struct NodeState {
445    flat: Map<String, Value>,
446    visual: Visual,
447    text: TextStyle,
448    control: ControlBox,
449    /// Bumped when props change: the memo entry is stale.
450    content_version: u32,
451    /// The themed style has `@media` blocks: a viewport change restyles it.
452    conditional: bool,
453    radius_pct: Option<RadiusPercent>,
454    /// The px radii last resolved from `radius_pct` (a box change re-resolves).
455    styled: bool,
456    /// The node's resolved (inherited) direction.
457    direction: Direction,
458    /// Its line height is a px value set here or inherited (else `normal`).
459    line_height_set: bool,
460}
461
462#[derive(Debug, Clone)]
463struct Carried {
464    intrinsics: crate::measure::Intrinsics,
465    heights: Vec<(i64, f32)>,
466    props: Map<String, Value>,
467    lines: Option<u32>,
468}
469
470pub struct Surface {
471    pub id: String,
472    pub catalog_id: String,
473    view: Arc<CatalogView>,
474    recipes: Arc<RecipeIndex>,
475    extensions: Vec<ExtensionDef>,
476    /// The theme as set; `effective` = density + contrast applied.
477    theme: Option<Arc<ResolvedTheme>>,
478    effective: Option<Arc<ResolvedTheme>>,
479    settings: SurfaceSettings,
480    strings: StringTable,
481    mode: Mode,
482    expand_controls: Option<bool>,
483    components: Vec<FlatComponent>,
484    nested: Option<NestedNode>,
485    data: Value,
486    root: Option<UiNode>,
487    /// Every issue: the reduce's, then the last build's (template limits),
488    /// then the styles' (each source kept apart so a rebuild replaces its
489    /// own: an overflow clears when the data shrinks).
490    pub(crate) issues: Vec<ReduceIssue>,
491    reduce_issues: Vec<ReduceIssue>,
492    pub(crate) build_issues: Vec<ReduceIssue>,
493    pub(crate) style_issues: Vec<ReduceIssue>,
494    local: LocalState,
495    states: HashMap<String, Vec<String>>,
496
497    /// Slots (dead ones have `live[i] == false`).
498    nodes: Vec<LNode>,
499    live: Vec<bool>,
500    slot_of: HashMap<String, u32>,
501    free: Vec<u32>,
502    main_root: Option<u32>,
503    layers: Vec<LayerSpec>,
504    lists: Vec<ListSpec>,
505    toasts: Vec<ToastSpec>,
506    node_state: Vec<NodeState>,
507    engine: Engine,
508    memo: MeasureMemo,
509    memo_versions: HashMap<u32, u32>,
510    last_measurer: Option<u64>,
511    viewport: (f32, f32),
512    /// #VAPP-253: [`Surface::set_layer_viewport`].
513    layer_viewport: Option<(f32, f32)>,
514    max_height: Option<f32>,
515    direction: Direction,
516    rounding: bool,
517    structure_version: u64,
518    needs_build: bool,
519    restyle_all: bool,
520    style_dirty: BTreeSet<u32>,
521    visuals_dirty: HashSet<u32>,
522    /// The LIFTED templates of the last reduce (`ReduceResult::templates`,
523    /// round 2), by component id.
524    template_cache: HashMap<String, Option<UiNode>>,
525    /// VAPP-103: `components` changed since the last reduce (a streamed
526    /// `updateComponents` reduces on the next read, never per message).
527    reduce_pending: bool,
528    /// `components` positions by id (an update replaces BY ID in O(1)).
529    component_index: HashMap<String, usize>,
530    /// Last placements by slot, so an event can find anchor frames.
531    last_frames: Vec<Frame>,
532    /// Measurements by node id that outlive a slot (a windowed list's rows
533    /// scrolled out and back in cost nothing twice).
534    archive: HashMap<String, Carried>,
535    responsive: bool,
536    breakpoint: Option<String>,
537    delta_added: BTreeSet<u32>,
538    delta_removed: BTreeSet<u32>,
539    delta_changed: BTreeSet<u32>,
540    renumbered: bool,
541    pending: Vec<OutEvent>,
542    scrolls: Vec<ScrollOutput>,
543    /// Counters for the current pass (`LayoutOutput::restyled`/`rebuilt`).
544    restyled: u32,
545    rebuilt: bool,
546    built_nodes: u32,
547    /// A stepped layout pass in progress (`layout_begin`).
548    step_state: Option<pass::PassState>,
549    /// Nodes whose subtree alone rebuilds next pass (a moved window, local
550    /// tab/accordion/carousel/toggle state).
551    subtree_pending: BTreeSet<String>,
552    /// Hover overlays waiting for their close timer.
553    hover_closing: HashSet<String>,
554    /// What the last build knew that events and subtree rebuilds need: the
555    /// literal Table rows (data scopes) and the Forms' disabled/busy flags.
556    seed: crate::layout_tree::BuildSeed,
557    /// Round 2: the surface formatter (default: the English fallback).
558    formatter: Arc<dyn crate::format::Formatter>,
559    /// A fixed clock for relative times (`None` = the wall clock).
560    clock: Option<f64>,
561    /// Bumped on every write to `data` (template key caches).
562    data_version: u64,
563}
564
565// SAFETY: taffy's `CompactLength` carries a `*const ()` slot for `calc()`
566// expressions, which makes `Style` `!Send`. This crate never builds a calc
567// value (every length is a number/percent/auto), so the slot is always the
568// tag variant and the tree is plain owned data. The FFI keeps the surface
569// behind a `Mutex`.
570unsafe impl Send for Surface {}
571
572impl Surface {
573    pub fn new(id: &str, options: SurfaceOptions) -> Surface {
574        let view = CatalogView::with(&options.extensions);
575        let recipes = if options.extensions.is_empty() { RecipeIndex::core() } else { Arc::new(RecipeIndex::new(&view)) };
576        let mut engine = Engine::new();
577        engine.set_rounding(options.rounding);
578        let settings = SurfaceSettings { mode: if options.mode == Mode::Dark { ModeSetting::Dark } else { ModeSetting::Light }, ..SurfaceSettings::default() };
579        let mut s = Surface {
580            id: id.to_string(),
581            catalog_id: options.catalog_id,
582            view,
583            recipes,
584            extensions: options.extensions,
585            theme: options.theme,
586            effective: None,
587            strings: crate::strings::DEFAULT_STRINGS.clone(),
588            settings,
589            mode: options.mode,
590            expand_controls: options.expand_controls,
591            components: Vec::new(),
592            nested: None,
593            data: Value::Object(Map::new()),
594            root: None,
595            issues: Vec::new(),
596            reduce_issues: Vec::new(),
597            build_issues: Vec::new(),
598            style_issues: Vec::new(),
599            local: LocalState::default(),
600            states: HashMap::new(),
601            nodes: Vec::new(),
602            live: Vec::new(),
603            slot_of: HashMap::new(),
604            free: Vec::new(),
605            main_root: None,
606            layers: Vec::new(),
607            lists: Vec::new(),
608            toasts: Vec::new(),
609            node_state: Vec::new(),
610            engine,
611            memo: MeasureMemo::default(),
612            memo_versions: HashMap::new(),
613            last_measurer: None,
614            viewport: (0.0, 0.0),
615            layer_viewport: None,
616            max_height: None,
617            direction: Direction::Ltr,
618            rounding: options.rounding,
619            structure_version: 0,
620            needs_build: true,
621            restyle_all: true,
622            style_dirty: BTreeSet::new(),
623            visuals_dirty: HashSet::new(),
624            template_cache: HashMap::new(),
625            reduce_pending: false,
626            component_index: HashMap::new(),
627            last_frames: Vec::new(),
628            archive: HashMap::new(),
629            responsive: false,
630            breakpoint: None,
631            delta_added: BTreeSet::new(),
632            delta_removed: BTreeSet::new(),
633            delta_changed: BTreeSet::new(),
634            renumbered: false,
635            pending: Vec::new(),
636            scrolls: Vec::new(),
637            restyled: 0,
638            rebuilt: false,
639            built_nodes: 0,
640            step_state: None,
641            subtree_pending: BTreeSet::new(),
642            hover_closing: HashSet::new(),
643            seed: Default::default(),
644            formatter: Arc::new(crate::format::EnglishFormatter),
645            clock: None,
646            data_version: 0,
647        };
648        s.refresh_theme();
649        s
650    }
651
652    // ------------------------------------------------------------------
653    // Configuration
654    // ------------------------------------------------------------------
655
656    /// Round 2: format numbers, currencies, percents, dates and relative
657    /// times through `formatter` (the host's, built in the surface's locale
658    /// and the host's time zone; or [`crate::format::ZonedEnglishFormatter`]
659    /// at the host's UTC offset). The core has no zone database: the zone
660    /// reaches it only through the formatter. The tree re-binds.
661    pub fn set_formatter(&mut self, formatter: Arc<dyn crate::format::Formatter>) {
662        self.formatter = formatter;
663        self.needs_build = true;
664    }
665
666    /// The formatter in effect.
667    pub fn formatter(&self) -> &Arc<dyn crate::format::Formatter> {
668        &self.formatter
669    }
670
671    /// Pin the clock relative times read (epoch ms; `None` = the wall
672    /// clock). A host re-binds a surface showing `formatRelativeTime`
673    /// without `now` at least once a minute ([`Surface::tick`]).
674    pub fn set_clock(&mut self, now_ms: Option<f64>) {
675        self.clock = now_ms;
676        self.needs_build = true;
677    }
678
679    /// Re-bind (relative times move): the next layout rebuilds.
680    pub fn tick(&mut self) {
681        self.needs_build = true;
682    }
683
684    /// Round 2 (§3): whether the surface shows a time that moves with the
685    /// clock — a `formatRelativeTime` call without `now` in the tree or a
686    /// template, or a Table `relativeTime` column — so the host calls
687    /// [`Surface::tick`] at least once a minute. `false` with a pinned clock
688    /// ([`Surface::set_clock`]). O(nodes): ask after a reduce or layout.
689    pub fn uses_clock(&self) -> bool {
690        fn relative_call(v: &Value) -> bool {
691            match v {
692                Value::Object(o) => (o.get("call").and_then(Value::as_str) == Some("formatRelativeTime") && o.get("args").and_then(|a| a.get("now")).is_none()) || o.values().any(relative_call),
693                Value::Array(a) => a.iter().any(relative_call),
694                _ => false,
695            }
696        }
697        if self.clock.is_some() {
698            return false;
699        }
700        let mut found = false;
701        for tree in self.root.iter().chain(self.template_cache.values().flatten()) {
702            tree.walk(&mut |n| found = found || n.props.values().any(relative_call));
703        }
704        found
705            || self.nodes.iter().zip(&self.live).any(|(n, live)| {
706                *live && n.component == "Table" && n.props.get("columns").and_then(Value::as_array).is_some_and(|cols| cols.iter().any(|c| c.get("type").and_then(Value::as_str) == Some("relativeTime")))
707            })
708    }
709
710    /// Register an extension catalog (validated). The tree is re-reduced.
711    pub fn register_extension(&mut self, ext: ExtensionDef) -> Result<(), String> {
712        let ext = crate::extension::define_extension(ext)?;
713        let mut all = self.extensions.clone();
714        all.retain(|e| e.id != ext.id);
715        all.push(ext);
716        self.view = CatalogView::with(&all);
717        self.recipes = Arc::new(RecipeIndex::new(&self.view));
718        self.extensions = all;
719        self.template_cache.clear();
720        self.reduce();
721        Ok(())
722    }
723
724    /// The theme in effect: the set theme with the surface's density and
725    /// contrast applied (once per change, so every resolver stays agnostic).
726    fn refresh_theme(&mut self) {
727        let contrast = match self.settings.contrast {
728            ContrastSetting::High => true,
729            ContrastSetting::Normal => false,
730            ContrastSetting::System => self.settings.system_high_contrast,
731        };
732        self.effective = self.theme.as_ref().map(|t| {
733            if self.settings.density == Density::Default && !contrast {
734                return t.clone();
735            }
736            let mut out = apply_density(t, self.settings.density);
737            if contrast {
738                out = apply_contrast(&out);
739            }
740            Arc::new(out)
741        });
742        self.restyle_all = true;
743    }
744
745    pub fn set_theme(&mut self, theme: Option<Arc<ResolvedTheme>>) {
746        self.theme = theme;
747        self.refresh_theme();
748        // Gap tokens feed List gaps; expansion depends on a theme.
749        self.needs_build = true;
750        self.invalidate_measures();
751    }
752
753    pub fn theme(&self) -> Option<&Arc<ResolvedTheme>> {
754        self.theme.as_ref()
755    }
756
757    /// The theme with density and contrast applied (what the core resolves
758    /// against; painters reading tokens should use this one).
759    pub fn effective_theme(&self) -> Option<&Arc<ResolvedTheme>> {
760        self.effective.as_ref()
761    }
762
763    pub fn set_mode(&mut self, mode: Mode) {
764        self.settings.mode = if mode == Mode::Dark { ModeSetting::Dark } else { ModeSetting::Light };
765        if self.mode != mode {
766            self.mode = mode;
767            self.restyle_all = true;
768        }
769    }
770
771    pub fn mode(&self) -> Mode {
772        self.mode
773    }
774
775    pub fn settings(&self) -> &SurfaceSettings {
776        &self.settings
777    }
778
779    /// Replace every setting at once; the parts that changed take effect on
780    /// the next layout (a type-size change re-measures).
781    pub fn set_settings(&mut self, settings: SurfaceSettings) {
782        let old = std::mem::replace(&mut self.settings, settings);
783        let s = self.settings.clone();
784        if old.strings != s.strings {
785            self.strings = crate::strings::string_table(&s.strings);
786            self.needs_build = true;
787        }
788        if old.read_only != s.read_only {
789            self.needs_build = true;
790            self.restyle_all = true;
791        }
792        if old.locale != s.locale || old.today != s.today {
793            self.needs_build = true;
794            self.restyle_all = true;
795        }
796        if old.density != s.density || old.contrast != s.contrast || old.system_high_contrast != s.system_high_contrast {
797            self.refresh_theme();
798        }
799        let mode = resolve_mode(s.mode, s.system_dark);
800        if mode != self.mode {
801            self.mode = mode;
802            self.restyle_all = true;
803        }
804        if (old.font_scale - s.font_scale).abs() > f32::EPSILON || old.hover != s.hover || old.reduced_motion != s.reduced_motion || old.form_factor != s.form_factor {
805            self.restyle_all = true;
806        }
807        if old.insets != s.insets {
808            self.engine.mark_all_dirty();
809        }
810    }
811
812    /// VAPP-200: a read-only surface (every writing control disabled).
813    pub fn set_read_only(&mut self, on: bool) {
814        let mut s = self.settings.clone();
815        s.read_only = on;
816        self.set_settings(s);
817    }
818
819    pub fn set_locale(&mut self, locale: &str) {
820        let mut s = self.settings.clone();
821        s.locale = locale.to_string();
822        self.set_settings(s);
823    }
824
825    pub fn set_strings(&mut self, overrides: IndexMap<String, String>) {
826        let mut s = self.settings.clone();
827        s.strings = overrides;
828        self.set_settings(s);
829    }
830
831    /// `light | dark | system`, with the platform's current preference.
832    pub fn set_mode_setting(&mut self, mode: ModeSetting, system_dark: bool) {
833        let mut s = self.settings.clone();
834        s.mode = mode;
835        s.system_dark = system_dark;
836        self.set_settings(s);
837    }
838
839    pub fn set_density(&mut self, density: Density) {
840        let mut s = self.settings.clone();
841        s.density = density;
842        self.set_settings(s);
843    }
844
845    pub fn set_contrast(&mut self, contrast: ContrastSetting, system_high: bool) {
846        let mut s = self.settings.clone();
847        s.contrast = contrast;
848        s.system_high_contrast = system_high;
849        self.set_settings(s);
850    }
851
852    /// Dynamic Type / font scale (1 = the theme's sizes).
853    pub fn set_font_scale(&mut self, scale: f32) {
854        let mut s = self.settings.clone();
855        s.font_scale = scale.max(0.1);
856        self.set_settings(s);
857    }
858
859    pub fn set_insets(&mut self, insets: Insets) {
860        let mut s = self.settings.clone();
861        s.insets = insets;
862        self.set_settings(s);
863    }
864
865    /// VAPP-218: the host's form factor (`None` = derived from the width).
866    pub fn set_form_factor(&mut self, form_factor: Option<crate::conditions::FormFactor>) {
867        let mut s = self.settings.clone();
868        s.form_factor = form_factor;
869        self.set_settings(s);
870    }
871
872    /// A hover-capable pointer and the reduced-motion preference.
873    pub fn set_pointer(&mut self, hover: bool, reduced_motion: bool) {
874        let mut s = self.settings.clone();
875        s.hover = hover;
876        s.reduced_motion = reduced_motion;
877        self.set_settings(s);
878    }
879
880    /// Android accumulates in dp and rounds once itself; the browser never
881    /// rounds. Off = fractional frames.
882    pub fn set_rounding(&mut self, on: bool) {
883        self.rounding = on;
884        self.engine.set_rounding(on);
885        self.engine.mark_all_dirty();
886    }
887
888    /// Surface size. Height ≤ 0 = as tall as the content (a scrolling host).
889    /// `max_height` bounds a transcript card; `LayoutOutput::overflow` says
890    /// when the content is taller. Returns whether anything changed.
891    pub fn set_viewport(&mut self, width: f32, height: f32, max_height: Option<f32>) -> bool {
892        if self.viewport == (width, height) && self.max_height == max_height {
893            return false;
894        }
895        let height_changed = self.viewport.1 != height || self.max_height != max_height;
896        self.viewport = (width, height);
897        self.max_height = max_height;
898        for (i, s) in self.node_state.iter().enumerate() {
899            if s.conditional && self.live.get(i).copied().unwrap_or(false) {
900                self.style_dirty.insert(i as u32);
901            }
902        }
903        // Windowed lists size their range off the viewport height; a
904        // responsive native follows the breakpoint.
905        if (height_changed && !self.lists.is_empty()) || (self.responsive && self.active_breakpoint() != self.breakpoint) {
906            self.needs_build = true;
907        }
908        true
909    }
910
911    pub fn viewport(&self) -> (f32, f32) {
912        self.viewport
913    }
914
915    /// #VAPP-253: the window a host hangs this surface's modal layers from
916    /// (the surface may be narrower: a sidebar, a padded pane). A top or
917    /// bottom Drawer lays out at its width, at `x = 0`, and on its height
918    /// (height <= 0 = the surface's); a popup opened above that sheet lands in
919    /// it too. Those frames are relative to the window's origin, the host
920    /// paints them there. Width <= 0 (or not finite) = unset, the default: a
921    /// sheet takes the surface's size. Returns whether anything changed.
922    pub fn set_layer_viewport(&mut self, width: f32, height: f32) -> bool {
923        let next = (width.is_finite() && width > 0.0).then_some((width, if height.is_finite() { height.max(0.0) } else { 0.0 }));
924        if self.layer_viewport == next {
925            return false;
926        }
927        self.layer_viewport = next;
928        true
929    }
930
931    pub fn layer_viewport(&self) -> Option<(f32, f32)> {
932        self.layer_viewport
933    }
934
935    /// The breakpoint of the current width (theme tokens, else the defaults).
936    fn active_breakpoint(&self) -> Option<String> {
937        crate::conditions::active_breakpoint(self.viewport.0, &self.breakpoints())
938    }
939
940    fn breakpoints(&self) -> IndexMap<String, f32> {
941        match &self.effective {
942            Some(t) if !t.tokens.breakpoint.is_empty() => t.tokens.breakpoint.iter().map(|(k, v)| (k.clone(), *v as f32)).collect(),
943            _ => crate::conditions::default_breakpoints(),
944        }
945    }
946
947    /// Replace a node's interaction states (hover/pressed/focus/
948    /// focus-visible/disabled…). Restyles THAT node only. A hover or a
949    /// keyboard focus on a Tooltip's or a hover Popover's TRIGGER opens it
950    /// at once (the host owns the open delay); it STAYS open while the
951    /// pointer (or focus) is on the trigger or on ANY node of its layer.
952    /// When both are left it closes at once, or — with
953    /// `settings.hover_close_ms > 0` — raises [`OutEvent::HoverTimer`] and
954    /// closes on [`Self::hover_timeout`] unless the pointer came back
955    /// (crossing the gap from trigger to content). The change events are in
956    /// `take_events`.
957    pub fn set_states(&mut self, id: &str, states: Vec<String>) -> bool {
958        let current = self.states.get(id);
959        if current.is_some_and(|c| *c == states) || (current.is_none() && states.is_empty()) {
960            return false;
961        }
962        if states.is_empty() {
963            self.states.remove(id);
964        } else {
965            self.states.insert(id.to_string(), states);
966        }
967        if let Some(&slot) = self.slot_of.get(id) {
968            self.style_dirty.insert(slot);
969            self.lend_states(slot);
970            for target in self.hover_targets(slot) {
971                let open = self.local.open.get(&target).copied().unwrap_or(false);
972                let active = self.hover_active(&target);
973                if active && !open {
974                    self.hover_closing.remove(&target);
975                    let events = self.set_open(&target, true);
976                    self.pending.extend(events.into_iter().filter(|e| !matches!(e, OutEvent::Relayout)));
977                } else if active {
978                    self.hover_closing.remove(&target);
979                } else if open && self.settings.hover_close_ms == 0 {
980                    let events = self.set_open(&target, false);
981                    self.pending.extend(events.into_iter().filter(|e| !matches!(e, OutEvent::Relayout)));
982                } else if open && self.hover_closing.insert(target.clone()) {
983                    self.pending.push(OutEvent::HoverTimer { owner: target, delay_ms: self.settings.hover_close_ms });
984                }
985            }
986        }
987        true
988    }
989
990    /// A [`OutEvent::HoverTimer`] fired: close the hover overlay `owner`
991    /// unless its trigger or its layer is hovered (or keyboard-focused)
992    /// again. Returns the change events (`Relayout` when it closed).
993    pub fn hover_timeout(&mut self, owner: &str) -> Vec<OutEvent> {
994        if !self.hover_closing.remove(owner) || !self.opens_on_hover(owner) || self.hover_active(owner) {
995            return vec![];
996        }
997        if !self.local.open.get(owner).copied().unwrap_or(false) {
998            return vec![];
999        }
1000        self.set_open(owner, false)
1001    }
1002
1003    /// The hover overlays a node keeps open: the one it is the TRIGGER of
1004    /// (the node itself, so a host's open delay on the trigger holds), and
1005    /// every hover overlay whose LAYER it is in (then on from that overlay's
1006    /// own node: a hover card inside a hover card keeps both).
1007    fn hover_targets(&self, slot: u32) -> Vec<String> {
1008        let mut out = Vec::new();
1009        let mut cur = Some(slot);
1010        let mut guard = 0;
1011        while let Some(c) = cur {
1012            guard += 1;
1013            if guard > 4096 || !self.live.get(c as usize).copied().unwrap_or(false) {
1014                break;
1015            }
1016            let n = &self.nodes[c as usize];
1017            if let Some(t) = n.trigger_for.as_ref().filter(|_| c == slot) {
1018                if self.opens_on_hover(t) && !out.contains(t) {
1019                    out.push(t.clone());
1020                }
1021            }
1022            cur = match n.parent {
1023                Some(p) => Some(p),
1024                None => match self.layers.iter().find(|l| l.root == c) {
1025                    Some(l) => {
1026                        if self.opens_on_hover(&l.owner) && !out.contains(&l.owner) {
1027                            out.push(l.owner.clone());
1028                        }
1029                        self.slot_of.get(&l.owner).copied()
1030                    }
1031                    None => None,
1032                },
1033            };
1034        }
1035        out
1036    }
1037
1038    /// Is any live node that keeps `target` open hovered or focused?
1039    fn hover_active(&self, target: &str) -> bool {
1040        self.states.iter().any(|(id, st)| {
1041            st.iter().any(|s| s == "hover" || s == "focus-visible" || s == "focus")
1042                && self.slot_of.get(id).is_some_and(|&slot| self.live[slot as usize] && self.hover_targets(slot).iter().any(|t| t == target))
1043                // A plain `focus` keeps it open only inside its layer (focus
1044                // moved into the card); on the trigger it takes focus-visible.
1045                && (st.iter().any(|s| s == "hover" || s == "focus-visible") || self.in_layer_of(self.slot_of[id], target))
1046        })
1047    }
1048
1049    /// Is `slot` inside the layer `owner` opened?
1050    fn in_layer_of(&self, slot: u32, owner: &str) -> bool {
1051        let Some(layer) = self.layers.iter().find(|l| l.owner == owner) else { return false };
1052        let mut cur = Some(slot);
1053        while let Some(c) = cur {
1054            if c == layer.root {
1055                return true;
1056            }
1057            cur = self.nodes[c as usize].parent;
1058        }
1059        false
1060    }
1061
1062    fn opens_on_hover(&self, target: &str) -> bool {
1063        let Some(&slot) = self.slot_of.get(target) else { return false };
1064        let n = &self.nodes[slot as usize];
1065        n.component == "Tooltip" || (n.component == "Popover" && n.props.get("openOn").and_then(Value::as_str) == Some("hover"))
1066    }
1067
1068    /// The pressed set as a whole (the spike's `set_pressed`).
1069    pub fn set_pressed(&mut self, ids: &[String]) -> bool {
1070        self.set_flagged("pressed", ids)
1071    }
1072
1073    /// The hovered set as a whole: `ids` carry the `hover` state (recipes'
1074    /// `hover` / style `:hover` resolve through it), every other node loses
1075    /// it. Same effects as [`Self::set_states`] (a hover overlay opens).
1076    pub fn set_hovered(&mut self, ids: &[String]) -> bool {
1077        self.set_flagged("hover", ids)
1078    }
1079
1080    /// One node's `hover` on or off, its other states kept (a host's pointer
1081    /// enter / leave).
1082    pub fn set_hover(&mut self, id: &str, hovered: bool) -> bool {
1083        let mut s = self.states.get(id).cloned().unwrap_or_default();
1084        let has = s.iter().any(|x| x == "hover");
1085        if has == hovered {
1086            return false;
1087        }
1088        if hovered {
1089            s.push("hover".into());
1090        } else {
1091            s.retain(|x| x != "hover");
1092        }
1093        self.set_states(id, s)
1094    }
1095
1096    /// The interaction states the HOST set on a node (`hover`, `pressed`,
1097    /// `focus`…; [`Self::set_states`]), empty when none.
1098    pub fn host_states(&self, id: &str) -> &[String] {
1099        self.states.get(id).map(Vec::as_slice).unwrap_or(&[])
1100    }
1101
1102    /// Exactly `ids` carry `flag`; the rest of each node's states are kept.
1103    fn set_flagged(&mut self, flag: &str, ids: &[String]) -> bool {
1104        let mut changed = false;
1105        let keep: HashSet<&String> = ids.iter().collect();
1106        let had: Vec<String> = self.states.iter().filter(|(_, s)| s.iter().any(|x| x == flag)).map(|(k, _)| k.clone()).collect();
1107        for id in had {
1108            if !keep.contains(&id) {
1109                let mut s = self.states.get(&id).cloned().unwrap_or_default();
1110                s.retain(|x| x != flag);
1111                changed |= self.set_states(&id, s);
1112            }
1113        }
1114        for id in ids {
1115            let mut s = self.states.get(id).cloned().unwrap_or_default();
1116            if !s.iter().any(|x| x == flag) {
1117                s.push(flag.into());
1118                changed |= self.set_states(id, s);
1119            }
1120        }
1121        changed
1122    }
1123
1124    /// Events the core raised outside a call that returns them (a hover
1125    /// opening a tooltip, a live region announcing).
1126    pub fn take_events(&mut self) -> Vec<OutEvent> {
1127        std::mem::take(&mut self.pending)
1128    }
1129
1130    /// Forget every cached measurement (a font load, Dynamic Type).
1131    pub fn invalidate_measures(&mut self) {
1132        self.memo.clear();
1133        self.memo_versions.clear();
1134        self.archive.clear();
1135        self.engine.mark_all_dirty();
1136    }
1137
1138    /// Forget one node's cached measurement.
1139    pub fn mark_dirty(&mut self, index: u32) -> bool {
1140        if !self.live.get(index as usize).copied().unwrap_or(false) {
1141            return false;
1142        }
1143        self.memo.forget(index);
1144        self.memo_versions.remove(&index);
1145        self.engine.mark_dirty(index);
1146        true
1147    }
1148
1149    // ------------------------------------------------------------------
1150    // Content
1151    // ------------------------------------------------------------------
1152
1153    /// Apply one A2UI server→client message (`createSurface`,
1154    /// `updateComponents`, `updateDataModel`, `deleteSurface`).
1155    pub fn apply(&mut self, message: &Value) -> Result<ApplyOutcome, String> {
1156        let obj = message.as_object().ok_or("message must be an object")?;
1157        if let Some(create) = obj.get("createSurface") {
1158            if let Some(cid) = create.get("catalogId").and_then(Value::as_str) {
1159                self.catalog_id = cid.to_string();
1160            }
1161            if let Some(sid) = create.get("surfaceId").and_then(Value::as_str) {
1162                self.id = sid.to_string();
1163            }
1164            self.set_component_list(Vec::new());
1165            self.nested = None;
1166            self.data = Value::Object(Map::new());
1167            self.data_version += 1;
1168            self.local = LocalState::default();
1169            self.template_cache.clear();
1170            self.reduce();
1171            return Ok(ApplyOutcome { structure_changed: true, issues: self.issues.clone() });
1172        }
1173        if let Some(update) = obj.get("updateComponents") {
1174            let components = update.get("components").ok_or("updateComponents.components is required")?;
1175            let list: Vec<FlatComponent> = serde_json::from_value(components.clone()).map_err(|e| format!("components: {e}"))?;
1176            return Ok(self.update_components(list));
1177        }
1178        self.ensure_reduced();
1179        if let Some(update) = obj.get("updateDataModel") {
1180            let path = update.get("path").and_then(Value::as_str).unwrap_or("");
1181            let value = update.get("value").cloned();
1182            let issues = match self.set_data(path, value) {
1183                Ok(()) => Vec::new(),
1184                Err(message) => vec![ReduceIssue { id: path.to_string(), message }],
1185            };
1186            return Ok(ApplyOutcome { structure_changed: self.needs_build, issues });
1187        }
1188        if obj.get("deleteSurface").is_some() {
1189            self.set_component_list(Vec::new());
1190            self.nested = None;
1191            self.root = None;
1192            self.data = Value::Object(Map::new());
1193            self.data_version += 1;
1194            self.local = LocalState::default();
1195            self.needs_build = true;
1196            return Ok(ApplyOutcome { structure_changed: true, issues: Vec::new() });
1197        }
1198        Err("unknown message: expected createSurface | updateComponents | updateDataModel | deleteSurface".into())
1199    }
1200
1201    /// An `updateComponents` payload. A2UI: a later update replaces
1202    /// components BY ID and keeps the rest (the TS reference's SurfaceStore
1203    /// does the same). VAPP-103: O(update) here, the tree reduces LAZILY on
1204    /// the next read (layout, an event, [`Self::issues`]), so a surface
1205    /// streamed one component per message costs linear, not quadratic.
1206    pub fn update_components(&mut self, list: Vec<FlatComponent>) -> ApplyOutcome {
1207        if self.nested.is_some() {
1208            self.set_component_list(Vec::new());
1209        }
1210        // The previous version of every id this update touches (`None` =
1211        // new), for the local field values.
1212        let mut replaced: HashMap<String, Option<FlatComponent>> = HashMap::new();
1213        let mut order: Vec<String> = Vec::new();
1214        for c in list {
1215            if !replaced.contains_key(&c.id) {
1216                order.push(c.id.clone());
1217            }
1218            match self.component_index.get(&c.id) {
1219                Some(&i) => {
1220                    let old = std::mem::replace(&mut self.components[i], c);
1221                    replaced.entry(old.id.clone()).or_insert(Some(old));
1222                }
1223                None => {
1224                    replaced.entry(c.id.clone()).or_insert(None);
1225                    self.component_index.insert(c.id.clone(), self.components.len());
1226                    self.components.push(c);
1227                }
1228            }
1229        }
1230        self.nested = None;
1231        self.retain_updated_field_values(&replaced);
1232        self.reduce_pending = true;
1233        self.needs_build = true;
1234        // The message's own components' issues now (O(message)); the tree's
1235        // with the next read ([`Self::issues`]).
1236        let options = ReduceOptions::new(&self.catalog_id).with_view(self.view.clone());
1237        let (components, index) = (&self.components, &self.component_index);
1238        let lookup = |id: &str| index.get(id).map(|&i| components[i].clone());
1239        let mut issues = Vec::new();
1240        for id in &order {
1241            if let Some(&i) = index.get(id.as_str()) {
1242                issues.extend(crate::reducer::component_issues(&components[i], &options, &lookup));
1243            }
1244        }
1245        ApplyOutcome { structure_changed: true, issues }
1246    }
1247
1248    /// The nested authoring form (fixtures, MCP templates) instead of a flat
1249    /// component list.
1250    pub fn set_nested(&mut self, tree: NestedNode) -> ApplyOutcome {
1251        self.nested = Some(tree);
1252        self.set_component_list(Vec::new());
1253        self.template_cache.clear();
1254        self.local.field_values.clear();
1255        self.reduce();
1256        ApplyOutcome { structure_changed: true, issues: self.issues.clone() }
1257    }
1258
1259    /// A flat component list (what `updateComponents` carries).
1260    pub fn set_components(&mut self, components: Vec<FlatComponent>) -> ApplyOutcome {
1261        let before = if self.nested.is_some() { Vec::new() } else { std::mem::take(&mut self.components) };
1262        self.set_component_list(components);
1263        self.nested = None;
1264        self.template_cache.clear();
1265        self.retain_field_values(&before);
1266        self.reduce();
1267        ApplyOutcome { structure_changed: true, issues: self.issues.clone() }
1268    }
1269
1270    /// Replace the whole component list (the id index follows).
1271    fn set_component_list(&mut self, components: Vec<FlatComponent>) {
1272        self.component_index = components.iter().enumerate().map(|(i, c)| (c.id.clone(), i)).collect();
1273        self.components = components;
1274    }
1275
1276    /// [`Self::retain_field_values`] after a by-id update: `replaced` = the
1277    /// previous version of each id it touched (`None` = new); every other
1278    /// component is unchanged. O(field values), never O(components).
1279    fn retain_updated_field_values(&mut self, replaced: &HashMap<String, Option<FlatComponent>>) {
1280        if self.local.field_values.is_empty() {
1281            return;
1282        }
1283        let (components, index) = (&self.components, &self.component_index);
1284        self.local.field_values.retain(|key, _| {
1285            let mut candidate = key.as_str();
1286            loop {
1287                if let Some(old) = replaced.get(candidate) {
1288                    let new = index.get(candidate).map(|&i| &components[i]);
1289                    return matches!((old.as_ref(), new), (Some(a), Some(b)) if a == b);
1290                }
1291                if index.contains_key(candidate) {
1292                    return true;
1293                }
1294                match candidate.rfind('.') {
1295                    Some(i) => candidate = &candidate[..i],
1296                    None => return false,
1297                }
1298            }
1299        });
1300    }
1301
1302    /// After a component update, keep an unbound control's local value
1303    /// while the component that owns it is unchanged (React keeps the state
1304    /// of a still-mounted node the same way); drop it when that component
1305    /// was removed or re-sent different. A value's owner = the longest
1306    /// component id equal to the key or prefixing it at a `.` (parts and
1307    /// template instances).
1308    fn retain_field_values(&mut self, before: &[FlatComponent]) {
1309        if self.local.field_values.is_empty() {
1310            return;
1311        }
1312        let old: HashMap<&str, &FlatComponent> = before.iter().map(|c| (c.id.as_str(), c)).collect();
1313        let new: HashMap<&str, &FlatComponent> = self.components.iter().map(|c| (c.id.as_str(), c)).collect();
1314        self.local.field_values.retain(|key, _| {
1315            let mut candidate = key.as_str();
1316            loop {
1317                if old.contains_key(candidate) || new.contains_key(candidate) {
1318                    return matches!((old.get(candidate), new.get(candidate)), (Some(a), Some(b)) if a == b);
1319                }
1320                match candidate.rfind('.') {
1321                    Some(i) => candidate = &candidate[..i],
1322                    None => return false,
1323                }
1324            }
1325        });
1326    }
1327
1328    /// Write `value` at `path` (`None` removes). Templates and bindings
1329    /// re-resolve on the next layout.
1330    /// VAPP-103: a refused write (a pointer past the limits, a non-index
1331    /// token or an index past the end of an array) changes nothing and
1332    /// returns the reason.
1333    pub fn set_data(&mut self, path: &str, value: Option<Value>) -> Result<(), String> {
1334        set_pointer(&mut self.data, path, value)?;
1335        self.data_version += 1;
1336        self.needs_build = true;
1337        Ok(())
1338    }
1339
1340    pub fn data(&self) -> &Value {
1341        &self.data
1342    }
1343
1344    /// The flat component list as set (empty for a nested surface); a host
1345    /// reads its components' raw props (a `{path}` binding) from it.
1346    pub fn components(&self) -> &[FlatComponent] {
1347        &self.components
1348    }
1349
1350    pub fn root(&mut self) -> Option<&UiNode> {
1351        self.ensure_reduced();
1352        self.root.as_ref()
1353    }
1354
1355    /// The reduce issues (plus the build's: styles, template items), after
1356    /// any streamed update is reduced.
1357    pub fn issues(&mut self) -> &[ReduceIssue] {
1358        self.ensure_reduced();
1359        &self.issues
1360    }
1361
1362    /// Reduce a streamed update now (every reader of the tree calls it).
1363    pub(crate) fn ensure_reduced(&mut self) {
1364        if self.reduce_pending {
1365            self.reduce();
1366        }
1367    }
1368
1369    fn reduce(&mut self) {
1370        crate::roomy(|| self.reduce_now())
1371    }
1372
1373    fn reduce_now(&mut self) {
1374        self.template_cache.clear();
1375        self.local.static_keys.clear();
1376        self.local.key_cache.clear();
1377        let options = ReduceOptions::new(&self.catalog_id).with_view(self.view.clone());
1378        let result: Option<ReduceResult> = if let Some(nested) = &self.nested {
1379            Some(crate::reducer::reduce_nested(nested, &options))
1380        } else if !self.components.is_empty() {
1381            Some(reduce_surface(&self.components, &options))
1382        } else {
1383            None
1384        };
1385        match result {
1386            Some(r) => {
1387                self.root = Some(r.root);
1388                self.reduce_issues = r.issues;
1389                // Round 2: template nodes are lifted out of the tree; items
1390                // instantiate them from this table.
1391                self.template_cache = r.templates.unwrap_or_default().into_iter().map(|(id, n)| (id, Some(n))).collect();
1392            }
1393            None => {
1394                self.root = None;
1395                self.reduce_issues.clear();
1396            }
1397        }
1398        self.build_issues.clear();
1399        self.style_issues.clear();
1400        self.refresh_issues();
1401        // Only a reduce that RAN clears the flag (a panic above leaves it
1402        // pending: the next read reduces again, never a stale root).
1403        self.reduce_pending = false;
1404        self.needs_build = true;
1405    }
1406
1407    /// `issues` = the reduce's + the build's + the styles' (once each).
1408    pub(crate) fn refresh_issues(&mut self) {
1409        let mut all: Vec<ReduceIssue> = Vec::with_capacity(self.reduce_issues.len() + self.build_issues.len() + self.style_issues.len());
1410        for issue in self.reduce_issues.iter().chain(&self.build_issues).chain(&self.style_issues) {
1411            if !all.contains(issue) {
1412                all.push(issue.clone());
1413            }
1414        }
1415        self.issues = all;
1416    }
1417
1418    fn gap_px(&self, name: &str) -> f32 {
1419        match &self.effective {
1420            Some(t) => t.tokens.spacing.get(name).copied().unwrap_or(0.0) as f32,
1421            None => match name {
1422                "xxs" => 2.0,
1423                "xs" => 4.0,
1424                "sm" => 8.0,
1425                "md" => 12.0,
1426                "lg" => 16.0,
1427                "xl" => 24.0,
1428                _ => 0.0,
1429            },
1430        }
1431    }
1432
1433    // ------------------------------------------------------------------
1434    // Snapshots
1435    // ------------------------------------------------------------------
1436
1437    pub fn structure_version(&self) -> u64 {
1438        self.structure_version
1439    }
1440
1441    fn placed(&self, i: usize) -> PlacedNode {
1442        let n = &self.nodes[i];
1443        let removed = !self.live[i];
1444        let mut states: Vec<String> = Vec::new();
1445        for q in [&n.part_query, &n.own_query].into_iter().flatten() {
1446            for s in &q.states {
1447                if !states.contains(s) {
1448                    states.push(s.clone());
1449                }
1450            }
1451        }
1452        PlacedNode {
1453            index: i as u32,
1454            id: n.id.clone(),
1455            component: n.component.clone(),
1456            part: n.part.clone(),
1457            owner: n.owner.clone(),
1458            owner_component: n.owner_component.clone(),
1459            catalog_id: n.catalog_id.clone(),
1460            extension_kind: n.extension_kind.clone(),
1461            depth: n.depth,
1462            parent: if removed { None } else { n.parent },
1463            children: if removed { Vec::new() } else { n.children.clone() },
1464            layer: n.layer,
1465            kind: n.kind,
1466            props: if removed { Map::new() } else { n.props.clone() },
1467            lines: n.lines,
1468            pressable: n.pressable && !removed,
1469            hidden: n.hidden || removed,
1470            accessibility: n.accessibility.clone(),
1471            trigger_for: n.trigger_for.clone(),
1472            states,
1473            form: n.form.clone(),
1474            live: n.live.clone(),
1475            removed,
1476        }
1477    }
1478
1479    /// Every slot (removed ones as tombstones, so `nodes()[i].index == i`).
1480    pub fn nodes(&mut self) -> Vec<PlacedNode> {
1481        self.settle();
1482        (0..self.nodes.len()).map(|i| self.placed(i)).collect()
1483    }
1484
1485    /// The given slots only (a delta's `added` + `changed`).
1486    pub fn nodes_at(&mut self, indices: &[u32]) -> Vec<PlacedNode> {
1487        self.settle();
1488        indices.iter().filter(|i| (**i as usize) < self.nodes.len()).map(|i| self.placed(*i as usize)).collect()
1489    }
1490
1491    /// Live nodes.
1492    pub fn node_count(&mut self) -> usize {
1493        self.settle();
1494        self.live.iter().filter(|l| **l).count()
1495    }
1496
1497    /// The resolved visual of one node (after a layout pass).
1498    pub fn visual(&self, index: u32) -> Option<&Visual> {
1499        self.node_state.get(index as usize).map(|s| &s.visual)
1500    }
1501
1502    pub fn visuals(&self) -> Vec<Visual> {
1503        self.node_state.iter().map(|s| s.visual.clone()).collect()
1504    }
1505
1506    pub fn text_style(&self, index: u32) -> Option<&TextStyle> {
1507        self.node_state.get(index as usize).map(|s| &s.text)
1508    }
1509
1510    pub fn layout_node(&self, index: u32) -> Option<&LNode> {
1511        self.nodes.get(index as usize).filter(|_| self.live.get(index as usize).copied().unwrap_or(false))
1512    }
1513
1514    pub fn index_of(&self, id: &str) -> Option<u32> {
1515        self.slot_of.get(id).copied()
1516    }
1517
1518    /// Round 2 (VAPP-100): does the node restyle under the pointer? True
1519    /// when its style has a `:hover` block or its recipe (the native's own
1520    /// root recipe, its part or macro recipe) has a rule on `state: hover`
1521    /// that its props match ([`crate::theme::recipe_reacts_to`]), in the
1522    /// effective theme. A painter tracks the pointer over these nodes (as
1523    /// over pressables, triggers and fields) and reports `hover`. Ask again
1524    /// after a theme switch.
1525    pub fn hover_styled(&self, index: u32) -> bool {
1526        let Some(n) = self.layout_node(index) else { return false };
1527        if n.base_style.contains_key(":hover") {
1528            return true;
1529        }
1530        let Some(theme) = &self.effective else { return false };
1531        [&n.own_query, &n.part_query].into_iter().flatten().any(|q| crate::theme::recipe_reacts_to(theme, q, "hover"))
1532    }
1533
1534    pub fn last_frame(&self, index: u32) -> Option<Frame> {
1535        self.last_frames.get(index as usize).copied()
1536    }
1537
1538    pub fn direction(&self) -> Direction {
1539        self.direction
1540    }
1541
1542    /// Is this surface a basic-catalog one?
1543    pub fn is_basic(&self) -> bool {
1544        self.catalog_id == A2UI_BASIC_CATALOG_ID
1545    }
1546
1547    pub fn get_data(&self, path: &str) -> Option<&Value> {
1548        get_pointer(&self.data, path)
1549    }
1550
1551    /// The built-in string table in effect (defaults + the host's).
1552    pub fn strings(&self) -> &StringTable {
1553        &self.strings
1554    }
1555
1556    /// Apply a pending rebuild / re-window before a snapshot. Not while a
1557    /// stepped pass is running (the FFI measures between the steps without
1558    /// the lock): the pass finishes on the nodes it styled and measured, and
1559    /// the rebuild waits for the next pass.
1560    fn settle(&mut self) {
1561        if self.step_state.is_some() {
1562            return;
1563        }
1564        self.ensure_reduced();
1565        if self.needs_build {
1566            self.subtree_pending.clear();
1567            self.rebuild();
1568        } else {
1569            for id in std::mem::take(&mut self.subtree_pending) {
1570                if !self.rebuild_subtree(&id) {
1571                    self.rebuild();
1572                    self.subtree_pending.clear();
1573                    break;
1574                }
1575            }
1576        }
1577    }
1578
1579    /// EXP-1259: the node whose hover/focus a part borrows: a Tabs `close`
1580    /// glyph shows while its TAB is hovered or focused.
1581    fn state_lender(n: &LNode) -> Option<String> {
1582        let owner = n.owner.as_deref()?;
1583        match (n.owner_component.as_deref(), n.part.as_deref()) {
1584            (Some("Tabs"), Some("close")) => n.id.strip_prefix(&format!("{owner}.close")).map(|i| format!("{owner}.tab{i}")),
1585            _ => None,
1586        }
1587    }
1588
1589    /// A node's states changed: restyle the parts that borrow them, and a
1590    /// hovered search row becomes the highlighted one (a hover selects).
1591    fn lend_states(&mut self, slot: u32) {
1592        let n = &self.nodes[slot as usize];
1593        if let (Some(owner), Some("Tabs"), Some("tab")) = (n.owner.clone(), n.owner_component.as_deref(), n.part.as_deref()) {
1594            if let Some(&close) = n.id.strip_prefix(&format!("{owner}.tab")).and_then(|i| self.slot_of.get(&format!("{owner}.close{i}"))) {
1595                self.style_dirty.insert(close);
1596            }
1597        }
1598        let n = &self.nodes[slot as usize];
1599        let hovered = self.states.get(&n.id).is_some_and(|s| s.iter().any(|x| x == "hover"));
1600        // EXP-1259: a pointer over a top-level Menu row opens ITS submenu
1601        // (or closes another row's), like the web's; keys and presses still
1602        // open one too.
1603        if let (true, Some(owner), Some("Menu"), Some("item")) = (hovered, n.owner.clone(), n.owner_component.as_deref(), n.part.as_deref()) {
1604            let top = n.id.strip_prefix(&format!("{owner}.item.")).filter(|rest| !rest.contains('.')).and_then(|i| i.parse::<usize>().ok());
1605            if let Some(i) = top {
1606                let submenu = n.props.get("kind").and_then(Value::as_str) == Some("submenu");
1607                let open = self.local.submenu.get(&owner).copied();
1608                let next = if submenu { Some(i) } else { None };
1609                if open != next && (submenu || open.is_some()) {
1610                    match next {
1611                        Some(i) => self.local.submenu.insert(owner.clone(), i),
1612                        None => self.local.submenu.remove(&owner),
1613                    };
1614                    self.needs_build = true;
1615                    if !self.pending.iter().any(|e| matches!(e, OutEvent::Relayout)) {
1616                        self.pending.push(OutEvent::Relayout);
1617                    }
1618                }
1619            }
1620        }
1621        let n = &self.nodes[slot as usize];
1622        if let (true, Some(owner), Some(position), Some("item")) = (hovered, n.owner.clone(), n.props.get("position").and_then(Value::as_u64), n.part.as_deref()) {
1623            let key = match n.owner_component.as_deref() {
1624                Some("SearchList") => Some(owner.clone()),
1625                // `<menu>.item.<sub>.<i>` → `<menu>.search.<sub>`
1626                Some("Menu") => n.id.strip_prefix(&format!("{owner}.item")).and_then(|rest| rest.rsplit_once('.')).map(|(sub, _)| format!("{owner}.search{sub}")),
1627                _ => None,
1628            };
1629            if let Some(key) = key {
1630                if self.local.active.get(&key).copied().unwrap_or(0) != position as usize {
1631                    self.local.active.insert(key, position as usize);
1632                    self.needs_build = true;
1633                    if !self.pending.iter().any(|e| matches!(e, OutEvent::Relayout)) {
1634                        self.pending.push(OutEvent::Relayout);
1635                    }
1636                }
1637            }
1638        }
1639    }
1640
1641    fn states_of(&self, n: &LNode) -> Vec<String> {
1642        let mut states = self.states.get(&n.id).cloned().unwrap_or_default();
1643        if let Some(lender) = Self::state_lender(n) {
1644            for s in self.states.get(&lender).into_iter().flatten() {
1645                if matches!(s.as_str(), "hover" | "focus" | "focus-visible") && !states.contains(s) {
1646                    states.push(s.clone());
1647                }
1648            }
1649        }
1650        if n.props.get("disabled").and_then(Value::as_bool) == Some(true) && !states.iter().any(|s| s == "disabled") {
1651            states.push("disabled".into());
1652        }
1653        for q in [&n.part_query, &n.own_query].into_iter().flatten() {
1654            for s in &q.states {
1655                if !states.contains(s) {
1656                    states.push(s.clone());
1657                }
1658            }
1659        }
1660        states
1661    }
1662}