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    max_height: Option<f32>,
513    direction: Direction,
514    rounding: bool,
515    structure_version: u64,
516    needs_build: bool,
517    restyle_all: bool,
518    style_dirty: BTreeSet<u32>,
519    visuals_dirty: HashSet<u32>,
520    /// The LIFTED templates of the last reduce (`ReduceResult::templates`,
521    /// round 2), by component id.
522    template_cache: HashMap<String, Option<UiNode>>,
523    /// VAPP-103: `components` changed since the last reduce (a streamed
524    /// `updateComponents` reduces on the next read, never per message).
525    reduce_pending: bool,
526    /// `components` positions by id (an update replaces BY ID in O(1)).
527    component_index: HashMap<String, usize>,
528    /// Last placements by slot, so an event can find anchor frames.
529    last_frames: Vec<Frame>,
530    /// Measurements by node id that outlive a slot (a windowed list's rows
531    /// scrolled out and back in cost nothing twice).
532    archive: HashMap<String, Carried>,
533    responsive: bool,
534    breakpoint: Option<String>,
535    delta_added: BTreeSet<u32>,
536    delta_removed: BTreeSet<u32>,
537    delta_changed: BTreeSet<u32>,
538    renumbered: bool,
539    pending: Vec<OutEvent>,
540    scrolls: Vec<ScrollOutput>,
541    /// Counters for the current pass (`LayoutOutput::restyled`/`rebuilt`).
542    restyled: u32,
543    rebuilt: bool,
544    built_nodes: u32,
545    /// A stepped layout pass in progress (`layout_begin`).
546    step_state: Option<pass::PassState>,
547    /// Nodes whose subtree alone rebuilds next pass (a moved window, local
548    /// tab/accordion/carousel/toggle state).
549    subtree_pending: BTreeSet<String>,
550    /// Hover overlays waiting for their close timer.
551    hover_closing: HashSet<String>,
552    /// What the last build knew that events and subtree rebuilds need: the
553    /// literal Table rows (data scopes) and the Forms' disabled/busy flags.
554    seed: crate::layout_tree::BuildSeed,
555    /// Round 2: the surface formatter (default: the English fallback).
556    formatter: Arc<dyn crate::format::Formatter>,
557    /// A fixed clock for relative times (`None` = the wall clock).
558    clock: Option<f64>,
559    /// Bumped on every write to `data` (template key caches).
560    data_version: u64,
561}
562
563// SAFETY: taffy's `CompactLength` carries a `*const ()` slot for `calc()`
564// expressions, which makes `Style` `!Send`. This crate never builds a calc
565// value (every length is a number/percent/auto), so the slot is always the
566// tag variant and the tree is plain owned data. The FFI keeps the surface
567// behind a `Mutex`.
568unsafe impl Send for Surface {}
569
570impl Surface {
571    pub fn new(id: &str, options: SurfaceOptions) -> Surface {
572        let view = CatalogView::with(&options.extensions);
573        let recipes = if options.extensions.is_empty() { RecipeIndex::core() } else { Arc::new(RecipeIndex::new(&view)) };
574        let mut engine = Engine::new();
575        engine.set_rounding(options.rounding);
576        let settings = SurfaceSettings { mode: if options.mode == Mode::Dark { ModeSetting::Dark } else { ModeSetting::Light }, ..SurfaceSettings::default() };
577        let mut s = Surface {
578            id: id.to_string(),
579            catalog_id: options.catalog_id,
580            view,
581            recipes,
582            extensions: options.extensions,
583            theme: options.theme,
584            effective: None,
585            strings: crate::strings::DEFAULT_STRINGS.clone(),
586            settings,
587            mode: options.mode,
588            expand_controls: options.expand_controls,
589            components: Vec::new(),
590            nested: None,
591            data: Value::Object(Map::new()),
592            root: None,
593            issues: Vec::new(),
594            reduce_issues: Vec::new(),
595            build_issues: Vec::new(),
596            style_issues: Vec::new(),
597            local: LocalState::default(),
598            states: HashMap::new(),
599            nodes: Vec::new(),
600            live: Vec::new(),
601            slot_of: HashMap::new(),
602            free: Vec::new(),
603            main_root: None,
604            layers: Vec::new(),
605            lists: Vec::new(),
606            toasts: Vec::new(),
607            node_state: Vec::new(),
608            engine,
609            memo: MeasureMemo::default(),
610            memo_versions: HashMap::new(),
611            last_measurer: None,
612            viewport: (0.0, 0.0),
613            max_height: None,
614            direction: Direction::Ltr,
615            rounding: options.rounding,
616            structure_version: 0,
617            needs_build: true,
618            restyle_all: true,
619            style_dirty: BTreeSet::new(),
620            visuals_dirty: HashSet::new(),
621            template_cache: HashMap::new(),
622            reduce_pending: false,
623            component_index: HashMap::new(),
624            last_frames: Vec::new(),
625            archive: HashMap::new(),
626            responsive: false,
627            breakpoint: None,
628            delta_added: BTreeSet::new(),
629            delta_removed: BTreeSet::new(),
630            delta_changed: BTreeSet::new(),
631            renumbered: false,
632            pending: Vec::new(),
633            scrolls: Vec::new(),
634            restyled: 0,
635            rebuilt: false,
636            built_nodes: 0,
637            step_state: None,
638            subtree_pending: BTreeSet::new(),
639            hover_closing: HashSet::new(),
640            seed: Default::default(),
641            formatter: Arc::new(crate::format::EnglishFormatter),
642            clock: None,
643            data_version: 0,
644        };
645        s.refresh_theme();
646        s
647    }
648
649    // ------------------------------------------------------------------
650    // Configuration
651    // ------------------------------------------------------------------
652
653    /// Round 2: format numbers, currencies, percents, dates and relative
654    /// times through `formatter` (the host's, built in the surface's locale
655    /// and the host's time zone; or [`crate::format::ZonedEnglishFormatter`]
656    /// at the host's UTC offset). The core has no zone database: the zone
657    /// reaches it only through the formatter. The tree re-binds.
658    pub fn set_formatter(&mut self, formatter: Arc<dyn crate::format::Formatter>) {
659        self.formatter = formatter;
660        self.needs_build = true;
661    }
662
663    /// The formatter in effect.
664    pub fn formatter(&self) -> &Arc<dyn crate::format::Formatter> {
665        &self.formatter
666    }
667
668    /// Pin the clock relative times read (epoch ms; `None` = the wall
669    /// clock). A host re-binds a surface showing `formatRelativeTime`
670    /// without `now` at least once a minute ([`Surface::tick`]).
671    pub fn set_clock(&mut self, now_ms: Option<f64>) {
672        self.clock = now_ms;
673        self.needs_build = true;
674    }
675
676    /// Re-bind (relative times move): the next layout rebuilds.
677    pub fn tick(&mut self) {
678        self.needs_build = true;
679    }
680
681    /// Round 2 (§3): whether the surface shows a time that moves with the
682    /// clock — a `formatRelativeTime` call without `now` in the tree or a
683    /// template, or a Table `relativeTime` column — so the host calls
684    /// [`Surface::tick`] at least once a minute. `false` with a pinned clock
685    /// ([`Surface::set_clock`]). O(nodes): ask after a reduce or layout.
686    pub fn uses_clock(&self) -> bool {
687        fn relative_call(v: &Value) -> bool {
688            match v {
689                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),
690                Value::Array(a) => a.iter().any(relative_call),
691                _ => false,
692            }
693        }
694        if self.clock.is_some() {
695            return false;
696        }
697        let mut found = false;
698        for tree in self.root.iter().chain(self.template_cache.values().flatten()) {
699            tree.walk(&mut |n| found = found || n.props.values().any(relative_call));
700        }
701        found
702            || self.nodes.iter().zip(&self.live).any(|(n, live)| {
703                *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")))
704            })
705    }
706
707    /// Register an extension catalog (validated). The tree is re-reduced.
708    pub fn register_extension(&mut self, ext: ExtensionDef) -> Result<(), String> {
709        let ext = crate::extension::define_extension(ext)?;
710        let mut all = self.extensions.clone();
711        all.retain(|e| e.id != ext.id);
712        all.push(ext);
713        self.view = CatalogView::with(&all);
714        self.recipes = Arc::new(RecipeIndex::new(&self.view));
715        self.extensions = all;
716        self.template_cache.clear();
717        self.reduce();
718        Ok(())
719    }
720
721    /// The theme in effect: the set theme with the surface's density and
722    /// contrast applied (once per change, so every resolver stays agnostic).
723    fn refresh_theme(&mut self) {
724        let contrast = match self.settings.contrast {
725            ContrastSetting::High => true,
726            ContrastSetting::Normal => false,
727            ContrastSetting::System => self.settings.system_high_contrast,
728        };
729        self.effective = self.theme.as_ref().map(|t| {
730            if self.settings.density == Density::Default && !contrast {
731                return t.clone();
732            }
733            let mut out = apply_density(t, self.settings.density);
734            if contrast {
735                out = apply_contrast(&out);
736            }
737            Arc::new(out)
738        });
739        self.restyle_all = true;
740    }
741
742    pub fn set_theme(&mut self, theme: Option<Arc<ResolvedTheme>>) {
743        self.theme = theme;
744        self.refresh_theme();
745        // Gap tokens feed List gaps; expansion depends on a theme.
746        self.needs_build = true;
747        self.invalidate_measures();
748    }
749
750    pub fn theme(&self) -> Option<&Arc<ResolvedTheme>> {
751        self.theme.as_ref()
752    }
753
754    /// The theme with density and contrast applied (what the core resolves
755    /// against; painters reading tokens should use this one).
756    pub fn effective_theme(&self) -> Option<&Arc<ResolvedTheme>> {
757        self.effective.as_ref()
758    }
759
760    pub fn set_mode(&mut self, mode: Mode) {
761        self.settings.mode = if mode == Mode::Dark { ModeSetting::Dark } else { ModeSetting::Light };
762        if self.mode != mode {
763            self.mode = mode;
764            self.restyle_all = true;
765        }
766    }
767
768    pub fn mode(&self) -> Mode {
769        self.mode
770    }
771
772    pub fn settings(&self) -> &SurfaceSettings {
773        &self.settings
774    }
775
776    /// Replace every setting at once; the parts that changed take effect on
777    /// the next layout (a type-size change re-measures).
778    pub fn set_settings(&mut self, settings: SurfaceSettings) {
779        let old = std::mem::replace(&mut self.settings, settings);
780        let s = self.settings.clone();
781        if old.strings != s.strings {
782            self.strings = crate::strings::string_table(&s.strings);
783            self.needs_build = true;
784        }
785        if old.read_only != s.read_only {
786            self.needs_build = true;
787            self.restyle_all = true;
788        }
789        if old.locale != s.locale || old.today != s.today {
790            self.needs_build = true;
791            self.restyle_all = true;
792        }
793        if old.density != s.density || old.contrast != s.contrast || old.system_high_contrast != s.system_high_contrast {
794            self.refresh_theme();
795        }
796        let mode = resolve_mode(s.mode, s.system_dark);
797        if mode != self.mode {
798            self.mode = mode;
799            self.restyle_all = true;
800        }
801        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 {
802            self.restyle_all = true;
803        }
804        if old.insets != s.insets {
805            self.engine.mark_all_dirty();
806        }
807    }
808
809    /// VAPP-200: a read-only surface (every writing control disabled).
810    pub fn set_read_only(&mut self, on: bool) {
811        let mut s = self.settings.clone();
812        s.read_only = on;
813        self.set_settings(s);
814    }
815
816    pub fn set_locale(&mut self, locale: &str) {
817        let mut s = self.settings.clone();
818        s.locale = locale.to_string();
819        self.set_settings(s);
820    }
821
822    pub fn set_strings(&mut self, overrides: IndexMap<String, String>) {
823        let mut s = self.settings.clone();
824        s.strings = overrides;
825        self.set_settings(s);
826    }
827
828    /// `light | dark | system`, with the platform's current preference.
829    pub fn set_mode_setting(&mut self, mode: ModeSetting, system_dark: bool) {
830        let mut s = self.settings.clone();
831        s.mode = mode;
832        s.system_dark = system_dark;
833        self.set_settings(s);
834    }
835
836    pub fn set_density(&mut self, density: Density) {
837        let mut s = self.settings.clone();
838        s.density = density;
839        self.set_settings(s);
840    }
841
842    pub fn set_contrast(&mut self, contrast: ContrastSetting, system_high: bool) {
843        let mut s = self.settings.clone();
844        s.contrast = contrast;
845        s.system_high_contrast = system_high;
846        self.set_settings(s);
847    }
848
849    /// Dynamic Type / font scale (1 = the theme's sizes).
850    pub fn set_font_scale(&mut self, scale: f32) {
851        let mut s = self.settings.clone();
852        s.font_scale = scale.max(0.1);
853        self.set_settings(s);
854    }
855
856    pub fn set_insets(&mut self, insets: Insets) {
857        let mut s = self.settings.clone();
858        s.insets = insets;
859        self.set_settings(s);
860    }
861
862    /// VAPP-218: the host's form factor (`None` = derived from the width).
863    pub fn set_form_factor(&mut self, form_factor: Option<crate::conditions::FormFactor>) {
864        let mut s = self.settings.clone();
865        s.form_factor = form_factor;
866        self.set_settings(s);
867    }
868
869    /// A hover-capable pointer and the reduced-motion preference.
870    pub fn set_pointer(&mut self, hover: bool, reduced_motion: bool) {
871        let mut s = self.settings.clone();
872        s.hover = hover;
873        s.reduced_motion = reduced_motion;
874        self.set_settings(s);
875    }
876
877    /// Android accumulates in dp and rounds once itself; the browser never
878    /// rounds. Off = fractional frames.
879    pub fn set_rounding(&mut self, on: bool) {
880        self.rounding = on;
881        self.engine.set_rounding(on);
882        self.engine.mark_all_dirty();
883    }
884
885    /// Surface size. Height ≤ 0 = as tall as the content (a scrolling host).
886    /// `max_height` bounds a transcript card; `LayoutOutput::overflow` says
887    /// when the content is taller. Returns whether anything changed.
888    pub fn set_viewport(&mut self, width: f32, height: f32, max_height: Option<f32>) -> bool {
889        if self.viewport == (width, height) && self.max_height == max_height {
890            return false;
891        }
892        let height_changed = self.viewport.1 != height || self.max_height != max_height;
893        self.viewport = (width, height);
894        self.max_height = max_height;
895        for (i, s) in self.node_state.iter().enumerate() {
896            if s.conditional && self.live.get(i).copied().unwrap_or(false) {
897                self.style_dirty.insert(i as u32);
898            }
899        }
900        // Windowed lists size their range off the viewport height; a
901        // responsive native follows the breakpoint.
902        if (height_changed && !self.lists.is_empty()) || (self.responsive && self.active_breakpoint() != self.breakpoint) {
903            self.needs_build = true;
904        }
905        true
906    }
907
908    pub fn viewport(&self) -> (f32, f32) {
909        self.viewport
910    }
911
912    /// The breakpoint of the current width (theme tokens, else the defaults).
913    fn active_breakpoint(&self) -> Option<String> {
914        crate::conditions::active_breakpoint(self.viewport.0, &self.breakpoints())
915    }
916
917    fn breakpoints(&self) -> IndexMap<String, f32> {
918        match &self.effective {
919            Some(t) if !t.tokens.breakpoint.is_empty() => t.tokens.breakpoint.iter().map(|(k, v)| (k.clone(), *v as f32)).collect(),
920            _ => crate::conditions::default_breakpoints(),
921        }
922    }
923
924    /// Replace a node's interaction states (hover/pressed/focus/
925    /// focus-visible/disabled…). Restyles THAT node only. A hover or a
926    /// keyboard focus on a Tooltip's or a hover Popover's TRIGGER opens it
927    /// at once (the host owns the open delay); it STAYS open while the
928    /// pointer (or focus) is on the trigger or on ANY node of its layer.
929    /// When both are left it closes at once, or — with
930    /// `settings.hover_close_ms > 0` — raises [`OutEvent::HoverTimer`] and
931    /// closes on [`Self::hover_timeout`] unless the pointer came back
932    /// (crossing the gap from trigger to content). The change events are in
933    /// `take_events`.
934    pub fn set_states(&mut self, id: &str, states: Vec<String>) -> bool {
935        let current = self.states.get(id);
936        if current.is_some_and(|c| *c == states) || (current.is_none() && states.is_empty()) {
937            return false;
938        }
939        if states.is_empty() {
940            self.states.remove(id);
941        } else {
942            self.states.insert(id.to_string(), states);
943        }
944        if let Some(&slot) = self.slot_of.get(id) {
945            self.style_dirty.insert(slot);
946            self.lend_states(slot);
947            for target in self.hover_targets(slot) {
948                let open = self.local.open.get(&target).copied().unwrap_or(false);
949                let active = self.hover_active(&target);
950                if active && !open {
951                    self.hover_closing.remove(&target);
952                    let events = self.set_open(&target, true);
953                    self.pending.extend(events.into_iter().filter(|e| !matches!(e, OutEvent::Relayout)));
954                } else if active {
955                    self.hover_closing.remove(&target);
956                } else if open && self.settings.hover_close_ms == 0 {
957                    let events = self.set_open(&target, false);
958                    self.pending.extend(events.into_iter().filter(|e| !matches!(e, OutEvent::Relayout)));
959                } else if open && self.hover_closing.insert(target.clone()) {
960                    self.pending.push(OutEvent::HoverTimer { owner: target, delay_ms: self.settings.hover_close_ms });
961                }
962            }
963        }
964        true
965    }
966
967    /// A [`OutEvent::HoverTimer`] fired: close the hover overlay `owner`
968    /// unless its trigger or its layer is hovered (or keyboard-focused)
969    /// again. Returns the change events (`Relayout` when it closed).
970    pub fn hover_timeout(&mut self, owner: &str) -> Vec<OutEvent> {
971        if !self.hover_closing.remove(owner) || !self.opens_on_hover(owner) || self.hover_active(owner) {
972            return vec![];
973        }
974        if !self.local.open.get(owner).copied().unwrap_or(false) {
975            return vec![];
976        }
977        self.set_open(owner, false)
978    }
979
980    /// The hover overlays a node keeps open: the one it is the TRIGGER of
981    /// (the node itself, so a host's open delay on the trigger holds), and
982    /// every hover overlay whose LAYER it is in (then on from that overlay's
983    /// own node: a hover card inside a hover card keeps both).
984    fn hover_targets(&self, slot: u32) -> Vec<String> {
985        let mut out = Vec::new();
986        let mut cur = Some(slot);
987        let mut guard = 0;
988        while let Some(c) = cur {
989            guard += 1;
990            if guard > 4096 || !self.live.get(c as usize).copied().unwrap_or(false) {
991                break;
992            }
993            let n = &self.nodes[c as usize];
994            if let Some(t) = n.trigger_for.as_ref().filter(|_| c == slot) {
995                if self.opens_on_hover(t) && !out.contains(t) {
996                    out.push(t.clone());
997                }
998            }
999            cur = match n.parent {
1000                Some(p) => Some(p),
1001                None => match self.layers.iter().find(|l| l.root == c) {
1002                    Some(l) => {
1003                        if self.opens_on_hover(&l.owner) && !out.contains(&l.owner) {
1004                            out.push(l.owner.clone());
1005                        }
1006                        self.slot_of.get(&l.owner).copied()
1007                    }
1008                    None => None,
1009                },
1010            };
1011        }
1012        out
1013    }
1014
1015    /// Is any live node that keeps `target` open hovered or focused?
1016    fn hover_active(&self, target: &str) -> bool {
1017        self.states.iter().any(|(id, st)| {
1018            st.iter().any(|s| s == "hover" || s == "focus-visible" || s == "focus")
1019                && self.slot_of.get(id).is_some_and(|&slot| self.live[slot as usize] && self.hover_targets(slot).iter().any(|t| t == target))
1020                // A plain `focus` keeps it open only inside its layer (focus
1021                // moved into the card); on the trigger it takes focus-visible.
1022                && (st.iter().any(|s| s == "hover" || s == "focus-visible") || self.in_layer_of(self.slot_of[id], target))
1023        })
1024    }
1025
1026    /// Is `slot` inside the layer `owner` opened?
1027    fn in_layer_of(&self, slot: u32, owner: &str) -> bool {
1028        let Some(layer) = self.layers.iter().find(|l| l.owner == owner) else { return false };
1029        let mut cur = Some(slot);
1030        while let Some(c) = cur {
1031            if c == layer.root {
1032                return true;
1033            }
1034            cur = self.nodes[c as usize].parent;
1035        }
1036        false
1037    }
1038
1039    fn opens_on_hover(&self, target: &str) -> bool {
1040        let Some(&slot) = self.slot_of.get(target) else { return false };
1041        let n = &self.nodes[slot as usize];
1042        n.component == "Tooltip" || (n.component == "Popover" && n.props.get("openOn").and_then(Value::as_str) == Some("hover"))
1043    }
1044
1045    /// The pressed set as a whole (the spike's `set_pressed`).
1046    pub fn set_pressed(&mut self, ids: &[String]) -> bool {
1047        self.set_flagged("pressed", ids)
1048    }
1049
1050    /// The hovered set as a whole: `ids` carry the `hover` state (recipes'
1051    /// `hover` / style `:hover` resolve through it), every other node loses
1052    /// it. Same effects as [`Self::set_states`] (a hover overlay opens).
1053    pub fn set_hovered(&mut self, ids: &[String]) -> bool {
1054        self.set_flagged("hover", ids)
1055    }
1056
1057    /// One node's `hover` on or off, its other states kept (a host's pointer
1058    /// enter / leave).
1059    pub fn set_hover(&mut self, id: &str, hovered: bool) -> bool {
1060        let mut s = self.states.get(id).cloned().unwrap_or_default();
1061        let has = s.iter().any(|x| x == "hover");
1062        if has == hovered {
1063            return false;
1064        }
1065        if hovered {
1066            s.push("hover".into());
1067        } else {
1068            s.retain(|x| x != "hover");
1069        }
1070        self.set_states(id, s)
1071    }
1072
1073    /// The interaction states the HOST set on a node (`hover`, `pressed`,
1074    /// `focus`…; [`Self::set_states`]), empty when none.
1075    pub fn host_states(&self, id: &str) -> &[String] {
1076        self.states.get(id).map(Vec::as_slice).unwrap_or(&[])
1077    }
1078
1079    /// Exactly `ids` carry `flag`; the rest of each node's states are kept.
1080    fn set_flagged(&mut self, flag: &str, ids: &[String]) -> bool {
1081        let mut changed = false;
1082        let keep: HashSet<&String> = ids.iter().collect();
1083        let had: Vec<String> = self.states.iter().filter(|(_, s)| s.iter().any(|x| x == flag)).map(|(k, _)| k.clone()).collect();
1084        for id in had {
1085            if !keep.contains(&id) {
1086                let mut s = self.states.get(&id).cloned().unwrap_or_default();
1087                s.retain(|x| x != flag);
1088                changed |= self.set_states(&id, s);
1089            }
1090        }
1091        for id in ids {
1092            let mut s = self.states.get(id).cloned().unwrap_or_default();
1093            if !s.iter().any(|x| x == flag) {
1094                s.push(flag.into());
1095                changed |= self.set_states(id, s);
1096            }
1097        }
1098        changed
1099    }
1100
1101    /// Events the core raised outside a call that returns them (a hover
1102    /// opening a tooltip, a live region announcing).
1103    pub fn take_events(&mut self) -> Vec<OutEvent> {
1104        std::mem::take(&mut self.pending)
1105    }
1106
1107    /// Forget every cached measurement (a font load, Dynamic Type).
1108    pub fn invalidate_measures(&mut self) {
1109        self.memo.clear();
1110        self.memo_versions.clear();
1111        self.archive.clear();
1112        self.engine.mark_all_dirty();
1113    }
1114
1115    /// Forget one node's cached measurement.
1116    pub fn mark_dirty(&mut self, index: u32) -> bool {
1117        if !self.live.get(index as usize).copied().unwrap_or(false) {
1118            return false;
1119        }
1120        self.memo.forget(index);
1121        self.memo_versions.remove(&index);
1122        self.engine.mark_dirty(index);
1123        true
1124    }
1125
1126    // ------------------------------------------------------------------
1127    // Content
1128    // ------------------------------------------------------------------
1129
1130    /// Apply one A2UI server→client message (`createSurface`,
1131    /// `updateComponents`, `updateDataModel`, `deleteSurface`).
1132    pub fn apply(&mut self, message: &Value) -> Result<ApplyOutcome, String> {
1133        let obj = message.as_object().ok_or("message must be an object")?;
1134        if let Some(create) = obj.get("createSurface") {
1135            if let Some(cid) = create.get("catalogId").and_then(Value::as_str) {
1136                self.catalog_id = cid.to_string();
1137            }
1138            if let Some(sid) = create.get("surfaceId").and_then(Value::as_str) {
1139                self.id = sid.to_string();
1140            }
1141            self.set_component_list(Vec::new());
1142            self.nested = None;
1143            self.data = Value::Object(Map::new());
1144            self.data_version += 1;
1145            self.local = LocalState::default();
1146            self.template_cache.clear();
1147            self.reduce();
1148            return Ok(ApplyOutcome { structure_changed: true, issues: self.issues.clone() });
1149        }
1150        if let Some(update) = obj.get("updateComponents") {
1151            let components = update.get("components").ok_or("updateComponents.components is required")?;
1152            let list: Vec<FlatComponent> = serde_json::from_value(components.clone()).map_err(|e| format!("components: {e}"))?;
1153            return Ok(self.update_components(list));
1154        }
1155        self.ensure_reduced();
1156        if let Some(update) = obj.get("updateDataModel") {
1157            let path = update.get("path").and_then(Value::as_str).unwrap_or("");
1158            let value = update.get("value").cloned();
1159            let issues = match self.set_data(path, value) {
1160                Ok(()) => Vec::new(),
1161                Err(message) => vec![ReduceIssue { id: path.to_string(), message }],
1162            };
1163            return Ok(ApplyOutcome { structure_changed: self.needs_build, issues });
1164        }
1165        if obj.get("deleteSurface").is_some() {
1166            self.set_component_list(Vec::new());
1167            self.nested = None;
1168            self.root = None;
1169            self.data = Value::Object(Map::new());
1170            self.data_version += 1;
1171            self.local = LocalState::default();
1172            self.needs_build = true;
1173            return Ok(ApplyOutcome { structure_changed: true, issues: Vec::new() });
1174        }
1175        Err("unknown message: expected createSurface | updateComponents | updateDataModel | deleteSurface".into())
1176    }
1177
1178    /// An `updateComponents` payload. A2UI: a later update replaces
1179    /// components BY ID and keeps the rest (the TS reference's SurfaceStore
1180    /// does the same). VAPP-103: O(update) here, the tree reduces LAZILY on
1181    /// the next read (layout, an event, [`Self::issues`]), so a surface
1182    /// streamed one component per message costs linear, not quadratic.
1183    pub fn update_components(&mut self, list: Vec<FlatComponent>) -> ApplyOutcome {
1184        if self.nested.is_some() {
1185            self.set_component_list(Vec::new());
1186        }
1187        // The previous version of every id this update touches (`None` =
1188        // new), for the local field values.
1189        let mut replaced: HashMap<String, Option<FlatComponent>> = HashMap::new();
1190        let mut order: Vec<String> = Vec::new();
1191        for c in list {
1192            if !replaced.contains_key(&c.id) {
1193                order.push(c.id.clone());
1194            }
1195            match self.component_index.get(&c.id) {
1196                Some(&i) => {
1197                    let old = std::mem::replace(&mut self.components[i], c);
1198                    replaced.entry(old.id.clone()).or_insert(Some(old));
1199                }
1200                None => {
1201                    replaced.entry(c.id.clone()).or_insert(None);
1202                    self.component_index.insert(c.id.clone(), self.components.len());
1203                    self.components.push(c);
1204                }
1205            }
1206        }
1207        self.nested = None;
1208        self.retain_updated_field_values(&replaced);
1209        self.reduce_pending = true;
1210        self.needs_build = true;
1211        // The message's own components' issues now (O(message)); the tree's
1212        // with the next read ([`Self::issues`]).
1213        let options = ReduceOptions::new(&self.catalog_id).with_view(self.view.clone());
1214        let (components, index) = (&self.components, &self.component_index);
1215        let lookup = |id: &str| index.get(id).map(|&i| components[i].clone());
1216        let mut issues = Vec::new();
1217        for id in &order {
1218            if let Some(&i) = index.get(id.as_str()) {
1219                issues.extend(crate::reducer::component_issues(&components[i], &options, &lookup));
1220            }
1221        }
1222        ApplyOutcome { structure_changed: true, issues }
1223    }
1224
1225    /// The nested authoring form (fixtures, MCP templates) instead of a flat
1226    /// component list.
1227    pub fn set_nested(&mut self, tree: NestedNode) -> ApplyOutcome {
1228        self.nested = Some(tree);
1229        self.set_component_list(Vec::new());
1230        self.template_cache.clear();
1231        self.local.field_values.clear();
1232        self.reduce();
1233        ApplyOutcome { structure_changed: true, issues: self.issues.clone() }
1234    }
1235
1236    /// A flat component list (what `updateComponents` carries).
1237    pub fn set_components(&mut self, components: Vec<FlatComponent>) -> ApplyOutcome {
1238        let before = if self.nested.is_some() { Vec::new() } else { std::mem::take(&mut self.components) };
1239        self.set_component_list(components);
1240        self.nested = None;
1241        self.template_cache.clear();
1242        self.retain_field_values(&before);
1243        self.reduce();
1244        ApplyOutcome { structure_changed: true, issues: self.issues.clone() }
1245    }
1246
1247    /// Replace the whole component list (the id index follows).
1248    fn set_component_list(&mut self, components: Vec<FlatComponent>) {
1249        self.component_index = components.iter().enumerate().map(|(i, c)| (c.id.clone(), i)).collect();
1250        self.components = components;
1251    }
1252
1253    /// [`Self::retain_field_values`] after a by-id update: `replaced` = the
1254    /// previous version of each id it touched (`None` = new); every other
1255    /// component is unchanged. O(field values), never O(components).
1256    fn retain_updated_field_values(&mut self, replaced: &HashMap<String, Option<FlatComponent>>) {
1257        if self.local.field_values.is_empty() {
1258            return;
1259        }
1260        let (components, index) = (&self.components, &self.component_index);
1261        self.local.field_values.retain(|key, _| {
1262            let mut candidate = key.as_str();
1263            loop {
1264                if let Some(old) = replaced.get(candidate) {
1265                    let new = index.get(candidate).map(|&i| &components[i]);
1266                    return matches!((old.as_ref(), new), (Some(a), Some(b)) if a == b);
1267                }
1268                if index.contains_key(candidate) {
1269                    return true;
1270                }
1271                match candidate.rfind('.') {
1272                    Some(i) => candidate = &candidate[..i],
1273                    None => return false,
1274                }
1275            }
1276        });
1277    }
1278
1279    /// After a component update, keep an unbound control's local value
1280    /// while the component that owns it is unchanged (React keeps the state
1281    /// of a still-mounted node the same way); drop it when that component
1282    /// was removed or re-sent different. A value's owner = the longest
1283    /// component id equal to the key or prefixing it at a `.` (parts and
1284    /// template instances).
1285    fn retain_field_values(&mut self, before: &[FlatComponent]) {
1286        if self.local.field_values.is_empty() {
1287            return;
1288        }
1289        let old: HashMap<&str, &FlatComponent> = before.iter().map(|c| (c.id.as_str(), c)).collect();
1290        let new: HashMap<&str, &FlatComponent> = self.components.iter().map(|c| (c.id.as_str(), c)).collect();
1291        self.local.field_values.retain(|key, _| {
1292            let mut candidate = key.as_str();
1293            loop {
1294                if old.contains_key(candidate) || new.contains_key(candidate) {
1295                    return matches!((old.get(candidate), new.get(candidate)), (Some(a), Some(b)) if a == b);
1296                }
1297                match candidate.rfind('.') {
1298                    Some(i) => candidate = &candidate[..i],
1299                    None => return false,
1300                }
1301            }
1302        });
1303    }
1304
1305    /// Write `value` at `path` (`None` removes). Templates and bindings
1306    /// re-resolve on the next layout.
1307    /// VAPP-103: a refused write (a pointer past the limits, a non-index
1308    /// token or an index past the end of an array) changes nothing and
1309    /// returns the reason.
1310    pub fn set_data(&mut self, path: &str, value: Option<Value>) -> Result<(), String> {
1311        set_pointer(&mut self.data, path, value)?;
1312        self.data_version += 1;
1313        self.needs_build = true;
1314        Ok(())
1315    }
1316
1317    pub fn data(&self) -> &Value {
1318        &self.data
1319    }
1320
1321    /// The flat component list as set (empty for a nested surface); a host
1322    /// reads its components' raw props (a `{path}` binding) from it.
1323    pub fn components(&self) -> &[FlatComponent] {
1324        &self.components
1325    }
1326
1327    pub fn root(&mut self) -> Option<&UiNode> {
1328        self.ensure_reduced();
1329        self.root.as_ref()
1330    }
1331
1332    /// The reduce issues (plus the build's: styles, template items), after
1333    /// any streamed update is reduced.
1334    pub fn issues(&mut self) -> &[ReduceIssue] {
1335        self.ensure_reduced();
1336        &self.issues
1337    }
1338
1339    /// Reduce a streamed update now (every reader of the tree calls it).
1340    pub(crate) fn ensure_reduced(&mut self) {
1341        if self.reduce_pending {
1342            self.reduce();
1343        }
1344    }
1345
1346    fn reduce(&mut self) {
1347        crate::roomy(|| self.reduce_now())
1348    }
1349
1350    fn reduce_now(&mut self) {
1351        self.template_cache.clear();
1352        self.local.static_keys.clear();
1353        self.local.key_cache.clear();
1354        let options = ReduceOptions::new(&self.catalog_id).with_view(self.view.clone());
1355        let result: Option<ReduceResult> = if let Some(nested) = &self.nested {
1356            Some(crate::reducer::reduce_nested(nested, &options))
1357        } else if !self.components.is_empty() {
1358            Some(reduce_surface(&self.components, &options))
1359        } else {
1360            None
1361        };
1362        match result {
1363            Some(r) => {
1364                self.root = Some(r.root);
1365                self.reduce_issues = r.issues;
1366                // Round 2: template nodes are lifted out of the tree; items
1367                // instantiate them from this table.
1368                self.template_cache = r.templates.unwrap_or_default().into_iter().map(|(id, n)| (id, Some(n))).collect();
1369            }
1370            None => {
1371                self.root = None;
1372                self.reduce_issues.clear();
1373            }
1374        }
1375        self.build_issues.clear();
1376        self.style_issues.clear();
1377        self.refresh_issues();
1378        // Only a reduce that RAN clears the flag (a panic above leaves it
1379        // pending: the next read reduces again, never a stale root).
1380        self.reduce_pending = false;
1381        self.needs_build = true;
1382    }
1383
1384    /// `issues` = the reduce's + the build's + the styles' (once each).
1385    pub(crate) fn refresh_issues(&mut self) {
1386        let mut all: Vec<ReduceIssue> = Vec::with_capacity(self.reduce_issues.len() + self.build_issues.len() + self.style_issues.len());
1387        for issue in self.reduce_issues.iter().chain(&self.build_issues).chain(&self.style_issues) {
1388            if !all.contains(issue) {
1389                all.push(issue.clone());
1390            }
1391        }
1392        self.issues = all;
1393    }
1394
1395    fn gap_px(&self, name: &str) -> f32 {
1396        match &self.effective {
1397            Some(t) => t.tokens.spacing.get(name).copied().unwrap_or(0.0) as f32,
1398            None => match name {
1399                "xxs" => 2.0,
1400                "xs" => 4.0,
1401                "sm" => 8.0,
1402                "md" => 12.0,
1403                "lg" => 16.0,
1404                "xl" => 24.0,
1405                _ => 0.0,
1406            },
1407        }
1408    }
1409
1410    // ------------------------------------------------------------------
1411    // Snapshots
1412    // ------------------------------------------------------------------
1413
1414    pub fn structure_version(&self) -> u64 {
1415        self.structure_version
1416    }
1417
1418    fn placed(&self, i: usize) -> PlacedNode {
1419        let n = &self.nodes[i];
1420        let removed = !self.live[i];
1421        let mut states: Vec<String> = Vec::new();
1422        for q in [&n.part_query, &n.own_query].into_iter().flatten() {
1423            for s in &q.states {
1424                if !states.contains(s) {
1425                    states.push(s.clone());
1426                }
1427            }
1428        }
1429        PlacedNode {
1430            index: i as u32,
1431            id: n.id.clone(),
1432            component: n.component.clone(),
1433            part: n.part.clone(),
1434            owner: n.owner.clone(),
1435            owner_component: n.owner_component.clone(),
1436            catalog_id: n.catalog_id.clone(),
1437            extension_kind: n.extension_kind.clone(),
1438            depth: n.depth,
1439            parent: if removed { None } else { n.parent },
1440            children: if removed { Vec::new() } else { n.children.clone() },
1441            layer: n.layer,
1442            kind: n.kind,
1443            props: if removed { Map::new() } else { n.props.clone() },
1444            lines: n.lines,
1445            pressable: n.pressable && !removed,
1446            hidden: n.hidden || removed,
1447            accessibility: n.accessibility.clone(),
1448            trigger_for: n.trigger_for.clone(),
1449            states,
1450            form: n.form.clone(),
1451            live: n.live.clone(),
1452            removed,
1453        }
1454    }
1455
1456    /// Every slot (removed ones as tombstones, so `nodes()[i].index == i`).
1457    pub fn nodes(&mut self) -> Vec<PlacedNode> {
1458        self.settle();
1459        (0..self.nodes.len()).map(|i| self.placed(i)).collect()
1460    }
1461
1462    /// The given slots only (a delta's `added` + `changed`).
1463    pub fn nodes_at(&mut self, indices: &[u32]) -> Vec<PlacedNode> {
1464        self.settle();
1465        indices.iter().filter(|i| (**i as usize) < self.nodes.len()).map(|i| self.placed(*i as usize)).collect()
1466    }
1467
1468    /// Live nodes.
1469    pub fn node_count(&mut self) -> usize {
1470        self.settle();
1471        self.live.iter().filter(|l| **l).count()
1472    }
1473
1474    /// The resolved visual of one node (after a layout pass).
1475    pub fn visual(&self, index: u32) -> Option<&Visual> {
1476        self.node_state.get(index as usize).map(|s| &s.visual)
1477    }
1478
1479    pub fn visuals(&self) -> Vec<Visual> {
1480        self.node_state.iter().map(|s| s.visual.clone()).collect()
1481    }
1482
1483    pub fn text_style(&self, index: u32) -> Option<&TextStyle> {
1484        self.node_state.get(index as usize).map(|s| &s.text)
1485    }
1486
1487    pub fn layout_node(&self, index: u32) -> Option<&LNode> {
1488        self.nodes.get(index as usize).filter(|_| self.live.get(index as usize).copied().unwrap_or(false))
1489    }
1490
1491    pub fn index_of(&self, id: &str) -> Option<u32> {
1492        self.slot_of.get(id).copied()
1493    }
1494
1495    /// Round 2 (VAPP-100): does the node restyle under the pointer? True
1496    /// when its style has a `:hover` block or its recipe (the native's own
1497    /// root recipe, its part or macro recipe) has a rule on `state: hover`
1498    /// that its props match ([`crate::theme::recipe_reacts_to`]), in the
1499    /// effective theme. A painter tracks the pointer over these nodes (as
1500    /// over pressables, triggers and fields) and reports `hover`. Ask again
1501    /// after a theme switch.
1502    pub fn hover_styled(&self, index: u32) -> bool {
1503        let Some(n) = self.layout_node(index) else { return false };
1504        if n.base_style.contains_key(":hover") {
1505            return true;
1506        }
1507        let Some(theme) = &self.effective else { return false };
1508        [&n.own_query, &n.part_query].into_iter().flatten().any(|q| crate::theme::recipe_reacts_to(theme, q, "hover"))
1509    }
1510
1511    pub fn last_frame(&self, index: u32) -> Option<Frame> {
1512        self.last_frames.get(index as usize).copied()
1513    }
1514
1515    pub fn direction(&self) -> Direction {
1516        self.direction
1517    }
1518
1519    /// Is this surface a basic-catalog one?
1520    pub fn is_basic(&self) -> bool {
1521        self.catalog_id == A2UI_BASIC_CATALOG_ID
1522    }
1523
1524    pub fn get_data(&self, path: &str) -> Option<&Value> {
1525        get_pointer(&self.data, path)
1526    }
1527
1528    /// The built-in string table in effect (defaults + the host's).
1529    pub fn strings(&self) -> &StringTable {
1530        &self.strings
1531    }
1532
1533    /// Apply a pending rebuild / re-window before a snapshot. Not while a
1534    /// stepped pass is running (the FFI measures between the steps without
1535    /// the lock): the pass finishes on the nodes it styled and measured, and
1536    /// the rebuild waits for the next pass.
1537    fn settle(&mut self) {
1538        if self.step_state.is_some() {
1539            return;
1540        }
1541        self.ensure_reduced();
1542        if self.needs_build {
1543            self.subtree_pending.clear();
1544            self.rebuild();
1545        } else {
1546            for id in std::mem::take(&mut self.subtree_pending) {
1547                if !self.rebuild_subtree(&id) {
1548                    self.rebuild();
1549                    self.subtree_pending.clear();
1550                    break;
1551                }
1552            }
1553        }
1554    }
1555
1556    /// EXP-1259: the node whose hover/focus a part borrows: a Tabs `close`
1557    /// glyph shows while its TAB is hovered or focused.
1558    fn state_lender(n: &LNode) -> Option<String> {
1559        let owner = n.owner.as_deref()?;
1560        match (n.owner_component.as_deref(), n.part.as_deref()) {
1561            (Some("Tabs"), Some("close")) => n.id.strip_prefix(&format!("{owner}.close")).map(|i| format!("{owner}.tab{i}")),
1562            _ => None,
1563        }
1564    }
1565
1566    /// A node's states changed: restyle the parts that borrow them, and a
1567    /// hovered search row becomes the highlighted one (a hover selects).
1568    fn lend_states(&mut self, slot: u32) {
1569        let n = &self.nodes[slot as usize];
1570        if let (Some(owner), Some("Tabs"), Some("tab")) = (n.owner.clone(), n.owner_component.as_deref(), n.part.as_deref()) {
1571            if let Some(&close) = n.id.strip_prefix(&format!("{owner}.tab")).and_then(|i| self.slot_of.get(&format!("{owner}.close{i}"))) {
1572                self.style_dirty.insert(close);
1573            }
1574        }
1575        let n = &self.nodes[slot as usize];
1576        let hovered = self.states.get(&n.id).is_some_and(|s| s.iter().any(|x| x == "hover"));
1577        // EXP-1259: a pointer over a top-level Menu row opens ITS submenu
1578        // (or closes another row's), like the web's; keys and presses still
1579        // open one too.
1580        if let (true, Some(owner), Some("Menu"), Some("item")) = (hovered, n.owner.clone(), n.owner_component.as_deref(), n.part.as_deref()) {
1581            let top = n.id.strip_prefix(&format!("{owner}.item.")).filter(|rest| !rest.contains('.')).and_then(|i| i.parse::<usize>().ok());
1582            if let Some(i) = top {
1583                let submenu = n.props.get("kind").and_then(Value::as_str) == Some("submenu");
1584                let open = self.local.submenu.get(&owner).copied();
1585                let next = if submenu { Some(i) } else { None };
1586                if open != next && (submenu || open.is_some()) {
1587                    match next {
1588                        Some(i) => self.local.submenu.insert(owner.clone(), i),
1589                        None => self.local.submenu.remove(&owner),
1590                    };
1591                    self.needs_build = true;
1592                    if !self.pending.iter().any(|e| matches!(e, OutEvent::Relayout)) {
1593                        self.pending.push(OutEvent::Relayout);
1594                    }
1595                }
1596            }
1597        }
1598        let n = &self.nodes[slot as usize];
1599        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()) {
1600            let key = match n.owner_component.as_deref() {
1601                Some("SearchList") => Some(owner.clone()),
1602                // `<menu>.item.<sub>.<i>` → `<menu>.search.<sub>`
1603                Some("Menu") => n.id.strip_prefix(&format!("{owner}.item")).and_then(|rest| rest.rsplit_once('.')).map(|(sub, _)| format!("{owner}.search{sub}")),
1604                _ => None,
1605            };
1606            if let Some(key) = key {
1607                if self.local.active.get(&key).copied().unwrap_or(0) != position as usize {
1608                    self.local.active.insert(key, position as usize);
1609                    self.needs_build = true;
1610                    if !self.pending.iter().any(|e| matches!(e, OutEvent::Relayout)) {
1611                        self.pending.push(OutEvent::Relayout);
1612                    }
1613                }
1614            }
1615        }
1616    }
1617
1618    fn states_of(&self, n: &LNode) -> Vec<String> {
1619        let mut states = self.states.get(&n.id).cloned().unwrap_or_default();
1620        if let Some(lender) = Self::state_lender(n) {
1621            for s in self.states.get(&lender).into_iter().flatten() {
1622                if matches!(s.as_str(), "hover" | "focus" | "focus-visible") && !states.contains(s) {
1623                    states.push(s.clone());
1624                }
1625            }
1626        }
1627        if n.props.get("disabled").and_then(Value::as_bool) == Some(true) && !states.iter().any(|s| s == "disabled") {
1628            states.push("disabled".into());
1629        }
1630        for q in [&n.part_query, &n.own_query].into_iter().flatten() {
1631            for s in &q.states {
1632                if !states.contains(s) {
1633                    states.push(s.clone());
1634                }
1635            }
1636        }
1637        states
1638    }
1639}