Skip to main content

teksilo_core/
build_context.rs

1// SPDX-License-Identifier: MPL-2.0
2// SPDX-FileCopyrightText: 2026 FernTech
3
4//! BuildContext — context available during Widget::build().
5//!
6//! Provides Signal-based APIs for creating reactive state, registering
7//! effects, and adding child widgets during the build lifecycle.
8
9use crate::binding::BindingRegistry;
10use crate::event_source::{SubscriptionHandle, SubscriptionId};
11use crate::signal::{ObserverHandle, Signal};
12use crate::widget_id::WidgetId;
13
14/// Context available during Widget::build().
15pub struct BuildContext<'a> {
16    pub(crate) tree: &'a mut crate::widget_tree::WidgetTree,
17    pub(crate) composite_id: Option<WidgetId>,
18    /// RAII handles for effects registered during this build cycle.
19    /// Transferred to the arena node's `effect_handles` after build returns.
20    pub(crate) effect_handles: Vec<ObserverHandle>,
21    /// Backend-event subscription handles registered during this build
22    /// cycle via `subscribe_event`. Transferred to the arena node's
23    /// `subscription_handles` after build returns.
24    pub(crate) subscription_handles: Vec<(SubscriptionId, SubscriptionHandle)>,
25    /// The `SubscriptionId`s the **previous** build of this same widget used, in the
26    /// order it created them. Empty on a first mount.
27    ///
28    /// A subscription's id is what crosses the thread boundary: the publisher-side
29    /// wrapper captures it by value and posts it, and the UI thread looks it up some
30    /// frames later. Minting a fresh id on every rebuild therefore silently destroys
31    /// every event already in flight, because `rebuild_single_widget` removes the
32    /// previous build's callbacks before `build()` runs and the queued event then names
33    /// an id nothing answers to. Re-using the ids here makes a subscription's identity
34    /// span the rebuilds of one widget, so an event posted before a rebuild is delivered
35    /// to the closure the *new* build installed.
36    ///
37    /// Matched **by position**, which is what makes it cheap and predictable: the Nth
38    /// `subscribe_event`/`subscribe_event_with_ctx` call of this build re-uses the id of
39    /// the Nth call of the last one. A build that subscribes fewer times simply leaves
40    /// the surplus ids unclaimed and they stay torn down; one that subscribes more
41    /// allocates fresh ids for the extras.
42    pub(crate) reusable_sub_ids: Vec<SubscriptionId>,
43}
44
45impl<'a> BuildContext<'a> {
46    /// The WidgetId of the widget being built.
47    pub fn self_id(&self) -> WidgetId {
48        self.composite_id
49            .expect("self_id() called outside of build()")
50    }
51
52    /// Add a widget to the tree.
53    pub fn add(&mut self, widget: impl crate::widget::Widget + 'static) -> WidgetId {
54        self.tree.add(widget)
55    }
56
57    /// Add a pre-boxed widget to the tree.
58    pub fn add_boxed(&mut self, widget: Box<dyn crate::widget::Widget>) -> WidgetId {
59        self.tree.add_boxed(widget)
60    }
61
62    /// Add a **parentless** widget this one owns: pre-built overlay content
63    /// (a dropdown menu, a date picker's calendar, a tooltip's nested cascade
64    /// children) that must not be reached by the child walk.
65    ///
66    /// Use this — never a bare [`add`](Self::add) — for anything built ahead of
67    /// time and parked with [`set_dormant`](Self::set_dormant) to be shown later
68    /// through an overlay. The two differ only in bookkeeping: `add` hands back
69    /// a node nothing owns, so the builder's own teardown cannot reach it and
70    /// every rebuild strands another copy in the arena; this records the
71    /// ownership edge, so the node dies with its owner and the previous
72    /// generation dies with each rebuild.
73    ///
74    /// Content that *can* be a child should be returned from `build()` as one
75    /// instead. This exists for content that cannot: activation and the paint
76    /// walk both descend through `children`, so a dormant popup parked there
77    /// wakes with its host and paints inline at zero size.
78    pub fn add_detached(&mut self, widget: impl crate::widget::Widget + 'static) -> WidgetId {
79        self.add_detached_boxed(Box::new(widget))
80    }
81
82    /// Insert a child whose subtree is **not built until `reveal` first turns
83    /// true**, and is retained from then on. Returns the host's id immediately.
84    ///
85    /// The shape this replaces is `ctx.add(panel)` followed by
86    /// `ctx.set_dormant(id)` — correct, but it builds content the user may never
87    /// open, on every rebuild of the owner. In a virtualized collection the
88    /// owner is a per-row delegate, so that cost is multiplied by the row count:
89    /// on a 40-row table whose cells each carried a four-item menu, the eager
90    /// form cost 325–552 ms per rebuild against 42–46 ms without the column at
91    /// all, and ~85% of it was the `add` rather than constructing the widget
92    /// value. See [`DeferredSubtree`](crate::deferred_subtree::DeferredSubtree)
93    /// for the full contract.
94    ///
95    /// Pass the same signal the content's `visible_when` gate uses. Everything
96    /// downstream of the returned id — `set_dormant` / `activate`,
97    /// `visible_when`, `OverlayRequest::content`, descendant checks,
98    /// dismissal — is unchanged; only when the subtree below it exists moves.
99    pub fn add_deferred(
100        &mut self,
101        reveal: crate::signal::Signal<bool>,
102        widget: impl crate::widget::Widget + 'static,
103    ) -> WidgetId {
104        self.add_deferred_boxed(reveal, Box::new(widget))
105    }
106
107    /// [`add_deferred`](Self::add_deferred) for an already-boxed widget.
108    pub fn add_deferred_boxed(
109        &mut self,
110        reveal: crate::signal::Signal<bool>,
111        widget: Box<dyn crate::widget::Widget>,
112    ) -> WidgetId {
113        self.add(crate::deferred_subtree::DeferredSubtree::new(
114            Some(reveal),
115            widget,
116        ))
117    }
118
119    /// [`add_deferred`](Self::add_deferred) for content the **framework**
120    /// materializes, kept as a child of the builder.
121    ///
122    /// The parented twin of
123    /// [`add_detached_deferred_on_demand`](Self::add_detached_deferred_on_demand),
124    /// for the two rich-tooltip attach paths: they have always parented their
125    /// body on the anchor's owner, and reparenting them to `detached` would move
126    /// which teardown reaps them. Only *when* the body is built changes.
127    ///
128    /// Worth the separate entry point because a rich tooltip is not one widget:
129    /// `RichTooltipWidget::build` eagerly pre-creates a nested tooltip for every
130    /// `:key` link in its body, recursively, so one attached tip expands into a
131    /// cascade. Built eagerly on a data view's row delegate, 29 rows of
132    /// Skribisto's Overview carried 1,305 tooltip widgets inside a 22,737-node
133    /// subtree, and tearing that down cost 5.3 s per arrow-key press — the
134    /// destroy, not the build.
135    pub fn add_deferred_on_demand(
136        &mut self,
137        widget: impl crate::widget::Widget + 'static,
138    ) -> WidgetId {
139        self.add(crate::deferred_subtree::DeferredSubtree::new(
140            None,
141            Box::new(widget),
142        ))
143    }
144
145    /// [`add_deferred`](Self::add_deferred) for content the **framework**
146    /// materializes rather than a widget's own open signal.
147    ///
148    /// The tooltip case: a tooltip body has no open signal a widget could hand
149    /// over — the tree decides, when a dwell matures. `WidgetTree` forces such
150    /// a host just before it consults `Widget::tooltip_has_content`, so the
151    /// body exists by the time anything asks it a question.
152    pub fn add_detached_deferred_on_demand(
153        &mut self,
154        widget: impl crate::widget::Widget + 'static,
155    ) -> WidgetId {
156        self.add_detached(crate::deferred_subtree::DeferredSubtree::new(
157            None,
158            Box::new(widget),
159        ))
160    }
161
162    /// [`add_deferred`](Self::add_deferred), inserted detached — the shape
163    /// overlay content wants, so it is owned by the builder and dies with it
164    /// rather than outliving every menu the user ever opened.
165    pub fn add_detached_deferred_boxed(
166        &mut self,
167        reveal: crate::signal::Signal<bool>,
168        widget: Box<dyn crate::widget::Widget>,
169    ) -> WidgetId {
170        self.add_detached(crate::deferred_subtree::DeferredSubtree::new(
171            Some(reveal),
172            widget,
173        ))
174    }
175
176    /// [`add_detached_deferred_boxed`](Self::add_detached_deferred_boxed) for an
177    /// unboxed widget.
178    pub fn add_detached_deferred(
179        &mut self,
180        reveal: crate::signal::Signal<bool>,
181        widget: impl crate::widget::Widget + 'static,
182    ) -> WidgetId {
183        self.add_detached_deferred_boxed(reveal, Box::new(widget))
184    }
185
186    /// [`add_detached`](Self::add_detached) for an already-boxed widget.
187    pub fn add_detached_boxed(&mut self, widget: Box<dyn crate::widget::Widget>) -> WidgetId {
188        let id = self.tree.add_boxed(widget);
189        let owner = self.self_id();
190        self.tree.record_detached(owner, id);
191        id
192    }
193
194    /// Add a Level 2 widget as a child of another widget.
195    pub fn add_child(
196        &mut self,
197        parent: WidgetId,
198        widget: impl crate::widget::Widget + 'static,
199    ) -> WidgetId {
200        self.tree.add_child(parent, widget)
201    }
202
203    // --- Signal APIs ---
204
205    /// Create a new mutable signal.
206    pub fn signal<T: 'static>(&mut self, value: T) -> Signal<T> {
207        Signal::new(value)
208    }
209
210    /// Create a new `Signal<f32>` that supports `animate_to()`.
211    /// Registered with the animation scheduler automatically. The owning
212    /// widget (`self_id()`) is recorded so that the scheduler can pause
213    /// the animation when the widget is offscreen, dormant, or rebuilt.
214    pub fn animated_signal(&mut self, value: f32) -> Signal<f32> {
215        let signal = Signal::new_animated(value);
216        let owner = self.self_id();
217        self.tree.register_animated_signal(&signal, owner);
218        signal
219    }
220
221    /// Register a pre-existing `Signal<f32>` for animation support.
222    /// Use this when the signal was created outside of `build()` (e.g. in the
223    /// widget constructor) and needs to be registered with the animation scheduler.
224    pub fn register_animated_signal(&mut self, signal: &Signal<f32>) {
225        let owner = self.self_id();
226        self.tree.register_animated_signal(signal, owner);
227    }
228
229    /// Read the OS-level `prefers-reduced-motion` preference. Widgets
230    /// that use looping or decorative animations (spinners, sprite
231    /// icons, marquee text, etc.) should skip starting them when this
232    /// returns `true` so the UI respects accessibility settings and —
233    /// as a bonus — draws no CPU/GPU.
234    pub fn prefers_reduced_motion(&self) -> bool {
235        self.tree.prefers_reduced_motion()
236    }
237
238    /// Build an [`AnimationSpec`](crate::animation_builder::AnimationSpec)
239    /// — the fluent ergonomic façade over `Signal<f32>::animate_to`.
240    /// Captures the theme's `MotionTokens` and the platform
241    /// reduced-motion preference at build time, returns a clonable
242    /// spec that event-handler closures can drive without
243    /// re-threading durations and easing.
244    ///
245    /// ```ignore
246    /// let knob_anim = ctx.animate().fast().standard();
247    /// handlers = handlers.on_tap(move |_, _| {
248    ///     knob_anim.to_or_snap(&knob_position, target);
249    /// });
250    /// ```
251    pub fn animate(&self) -> crate::animation_builder::AnimationSpec {
252        crate::animation_builder::AnimationSpec::from_motion(
253            self.theme().motion.clone(),
254            self.prefers_reduced_motion(),
255        )
256    }
257
258    /// Opt into the shader-driven animated-quad pipeline. The widget
259    /// paint() emits ONE `canvas.draw_animated_quad(bounds, handle.slot(),
260    /// class)` call; the renderer samples per-slot state from its
261    /// uniform buffer each frame and the widget's paint() does not
262    /// re-run for animation ticks — only on layout changes. The
263    /// returned handle is stable for the widget-mount lifetime and
264    /// should be stashed on `self` to thread to `paint()`.
265    ///
266    /// For decorative motion that isn't a quad (scroll-offset tweens,
267    /// sidebar slide, toggle knob), keep using `ctx.animated_signal` +
268    /// `signal.animate_looping` — both paths coexist.
269    pub fn animated_quad(
270        &mut self,
271        kind: crate::animated_quad::AnimatedQuadKind,
272    ) -> crate::animated_quad::AnimatedQuadHandle {
273        let owner = self.self_id();
274        self.tree.register_animated_quad(owner, kind)
275    }
276
277    /// The per-frame delta-seconds signal. Observe it via
278    /// `ctx.effect(&ctx.frame_tick(), |delta| ...)` to run code once per
279    /// frame **the tree was explicitly asked to pump**. Merely observing
280    /// this signal does not keep the event loop awake — widgets must
281    /// call [`request_frame`](Self::request_frame) (typically from an
282    /// event handler or from inside the tick closure itself) to schedule
283    /// the next wake-up. This preserves Teksilo's draw-when-needed model.
284    pub fn frame_tick(&self) -> Signal<f32> {
285        self.tree.frame_tick()
286    }
287
288    /// Ask the tree to pump exactly one more frame. See
289    /// [`frame_tick`](Self::frame_tick) for the observer side.
290    pub fn request_frame(&self) {
291        self.tree.request_frame();
292    }
293
294    /// Request that the AccessKit tree be re-walked after this build pass.
295    /// Use when `build()` restructured its subtree in a way that changes the
296    /// accessibility tree (relayout alone no longer re-walks AT). `SceneView`
297    /// calls this each build, since it may have materialised or destroyed
298    /// scene widgets or applied a11y-only scene mutations.
299    pub fn request_accessibility_update(&self) {
300        self.tree.request_accessibility_update();
301    }
302
303    /// Speak `message` to the screen reader, politely.
304    ///
305    /// The build-time companion to
306    /// [`EventContext::announce`](crate::widget::EventContext::announce), for a
307    /// widget that discovers during `build()` that something needs saying — an
308    /// error surface appearing, a result count changing. Announcing from
309    /// `build()` announces once per *rebuild*, so guard it on a real change
310    /// rather than on the build itself.
311    pub fn announce(&mut self, message: impl Into<String>) {
312        self.tree.announce(message);
313    }
314
315    /// Speak `message` to the screen reader at the given urgency. See
316    /// [`EventContext::announce_with`](crate::widget::EventContext::announce_with).
317    pub fn announce_with(
318        &mut self,
319        message: impl Into<String>,
320        politeness: crate::announcer::Politeness,
321    ) {
322        self.tree.announce_with(message, politeness);
323    }
324
325    /// Clone the shared "frame requested" flag. Stash it on widget
326    /// state and call `.set(true)` from inside a frame-tick effect
327    /// closure to chain-request another frame without needing
328    /// mutable access to the tree. Used by widgets with continuous
329    /// frame needs (caret blink, drag auto-scroll, smooth
330    /// animations driven from a tick closure).
331    ///
332    /// **Prefer [`subscribe_frame_tick`](Self::subscribe_frame_tick)**
333    /// for visual-only continuous animations (Pulse, Cycle, …): the
334    /// scheduler-backed path automatically pauses the chain when the
335    /// owner widget is hidden, while this raw handle keeps the event
336    /// loop pumping at full frame rate regardless of visibility.
337    pub fn frame_request_handle(&self) -> std::rc::Rc<std::cell::Cell<bool>> {
338        self.tree.frame_request_handle()
339    }
340
341    /// Subscribe the widget being built to the per-frame-effect
342    /// scheduler. The returned RAII guard removes the subscription on
343    /// drop — store it on `self` so its lifetime tracks the widget's.
344    ///
345    /// While at least one subscriber's owner is visible, the framework
346    /// re-arms the frame tick after every render. When all
347    /// subscribers are hidden (e.g. parked inside a non-selected
348    /// `Switcher` branch), no re-arm happens and the chain dies, so
349    /// the event loop sleeps. On a hidden→visible transition the
350    /// `visible_when` binding's relayout dirty triggers a repaint that
351    /// paints the subscriber, which the post-render arm then detects
352    /// and resumes the chain.
353    ///
354    /// Replaces the widget-managed `frame_request.set(true)` re-arm
355    /// pattern for visual-only continuous animations. The widget's
356    /// `frame_tick` effect closure no longer needs to call
357    /// `frame_request.set(true)` itself — the scheduler handles it.
358    pub fn subscribe_frame_tick(&self) -> crate::frame_tick_scheduler::FrameTickSubscription {
359        let sub = self.tree.subscribe_frame_tick(self.self_id());
360        // Bootstrap: ensure at least one frame runs after registration
361        // so the first paint happens. The post-render re-arm takes over
362        // from there. This is also the resume nudge for the case where
363        // a widget rebuilds (e.g. due to a state change) while still
364        // hidden — the parent's relayout dirty will trigger paint, and
365        // post-render arm will pick up the chain.
366        self.tree.request_frame();
367        sub
368    }
369
370    /// Like [`subscribe_frame_tick`](Self::subscribe_frame_tick), but the
371    /// widget only needs to wake **at most once per `interval`** while
372    /// visible. Same visibility gate and RAII guard; between wakes the
373    /// event loop sleeps to the interval deadline rather than rendering
374    /// identical 60 fps frames. Use when the widget's visible output
375    /// changes far less often than 60 Hz — e.g. `Cycle`'s once-per-period
376    /// index advance, or a seconds-granular clock.
377    ///
378    /// The interval delays this widget's own wake and nothing else: a frame
379    /// anything else requests still runs at 60 Hz, and the `frame_tick`
380    /// effect fires on it too. Read the clock in the effect rather than
381    /// counting ticks.
382    pub fn subscribe_frame_tick_throttled(
383        &self,
384        interval: std::time::Duration,
385    ) -> crate::frame_tick_scheduler::FrameTickSubscription {
386        let sub = self
387            .tree
388            .subscribe_frame_tick_throttled(self.self_id(), interval);
389        // Bootstrap the first frame after registration (see
390        // `subscribe_frame_tick`).
391        self.tree.request_frame();
392        sub
393    }
394
395    /// Clone the shared wake-at deadline cell. Stash it on widget
396    /// state and set `Some(instant)` from a frame-tick effect to
397    /// schedule a one-shot deadline wake-up without keeping the event
398    /// loop in `Poll` mode. See `WidgetTree::wake_at_handle` for
399    /// the underlying mechanism.
400    pub fn wake_at_handle(&self) -> std::rc::Rc<std::cell::Cell<Option<std::time::Instant>>> {
401        self.tree.wake_at_handle()
402    }
403
404    /// Register a scoped effect tied to this build cycle.
405    /// The effect fires whenever the signal changes. It is automatically
406    /// cleaned up on rebuild or widget destruction.
407    pub fn effect<T: Clone + 'static>(&mut self, signal: &Signal<T>, f: impl Fn(&T) + 'static) {
408        let handle = signal.observe(f);
409        self.effect_handles.push(handle);
410    }
411
412    /// Register a pre-existing observer handle for lifecycle management.
413    /// The handle will be dropped (and the observer removed) on rebuild
414    /// or widget destruction.
415    pub fn own_handle(&mut self, handle: ObserverHandle) {
416        self.effect_handles.push(handle);
417    }
418
419    /// Get the binding registry.
420    pub fn binding_registry(&self) -> &BindingRegistry {
421        self.tree.binding_registry()
422    }
423
424    /// Get the current theme.
425    pub fn theme(&self) -> &crate::styles::Theme {
426        self.tree.theme()
427    }
428
429    /// The active [`TargetDensity`] — the ladder `ctx.theme().input` was
430    /// projected onto.
431    ///
432    /// Read it in `build()` when a dimension must be chosen once per build
433    /// (a `MinSize` wrapper, a recipe's metrics). For the values themselves
434    /// prefer `ctx.theme().input` plus the
435    /// [`density`](crate::styles::density) helpers, which encode the floors.
436    ///
437    /// [`TargetDensity`]: teksilo_tokens::TargetDensity
438    pub fn density(&self) -> teksilo_tokens::TargetDensity {
439        self.tree.input_density()
440    }
441
442    /// Reactive handle on the current theme. Fires observers when
443    /// `tree.set_theme(...)` is called. Build implementations that want
444    /// theme-driven values to update without a rebuild should use this
445    /// instead of cloning tokens from `self.theme()` — for example,
446    /// `ctx.theme_signal().map(|t| t.colors.accent)` or combining with
447    /// interaction state via `zip(...)`.
448    pub fn theme_signal(&self) -> crate::signal::Signal<crate::styles::Theme> {
449        self.tree.theme_signal().clone()
450    }
451
452    /// Current combined text-scale factor (`user × OS`, `1.0` = 100 %). One-shot
453    /// read for build-time sizing; for a value that updates without a rebuild,
454    /// bind [`text_scale_signal`](Self::text_scale_signal) instead.
455    pub fn text_scale(&self) -> f32 {
456        self.tree.effective_text_scale()
457    }
458
459    /// Reactive handle on the combined text-scale factor. Fires when the user
460    /// scale, theme, or OS text-scale preference changes. Build implementations
461    /// that derive a build-time dimension from the scale (e.g. `Calendar`'s
462    /// fixed cell sizes) bind this — typically at `Rebuild` level so the change
463    /// recomputes the constants — since a scale change relayouts but does not
464    /// rebuild on its own.
465    pub fn text_scale_signal(&self) -> crate::signal::Signal<f32> {
466        self.tree.text_scale_signal()
467    }
468
469    /// Whether the host window is currently active (`focused AND not
470    /// occluded`). One-shot read for build-time use; for a value that reacts
471    /// to focus changes, bind [`window_active_signal`](Self::window_active_signal).
472    pub fn window_active(&self) -> bool {
473        self.tree.is_window_active()
474    }
475
476    /// Reactive handle on window-active state. Fires when the host window gains
477    /// or loses active status (`focused AND not occluded`). Build
478    /// implementations that show/hide appearance with window focus — caret
479    /// effects, the selection-colour swap in text fields, `DimWhenInactive` —
480    /// bind this, typically at `RepaintOnly` level (an active-state flip never
481    /// affects geometry). Starts `true`.
482    pub fn window_active_signal(&self) -> crate::signal::Signal<bool> {
483        self.tree.window_active_signal()
484    }
485
486    /// Reactive handle on the current locale. Fires observers when
487    /// `tree.set_locale(...)` is called.
488    pub fn locale_signal(&self) -> crate::signal::Signal<Option<String>> {
489        self.tree.locale_signal().clone()
490    }
491
492    /// The [`WindowState`](crate::window::WindowState) for the window
493    /// hosting this tree. `None` only for trees built outside of an
494    /// app (tests, headless scenarios). Use this to bind widgets to
495    /// window-level signals like `placement`, `size`, `focused`.
496    pub fn window(&self) -> Option<&crate::window::WindowState> {
497        self.tree.window_state()
498    }
499
500    /// Retrieve an application-scoped value of type `T` registered via
501    /// `TeksiloAppBuilder::app_state`. Returns `None` if no value of
502    /// that type was registered. The returned reference borrows from
503    /// the framework for the duration of the build pass.
504    pub fn app_state<T: 'static>(&self) -> Option<&T> {
505        self.tree.app_context().app_state::<T>()
506    }
507
508    /// Borrow the [`AppEventPoster`](crate::AppEventPoster) installed by the
509    /// framework, if any. Mirrors [`EventContext::poster`](crate::widget::EventContext::poster).
510    /// Used by integrations that wire a platform callback (e.g. a native menu
511    /// item) to post a typed payload back to the UI loop. Returns `None` for
512    /// trees built outside an app (tests / headless).
513    pub fn poster(&self) -> Option<&std::sync::Arc<dyn crate::AppEventPoster>> {
514        self.tree.app_context().poster()
515    }
516
517    /// Bind a widget's visibility to a boolean prop.
518    pub fn visible_when(&mut self, id: WidgetId, state: impl Into<crate::signal::Prop<bool>>) {
519        self.tree.visible_when(id, state);
520    }
521
522    /// Enqueue a one-shot action to run shortly after this build, with a real
523    /// [`EventContext`](crate::widget::EventContext) — the only place a widget
524    /// can read the OS parent window handle (`ctx.parent_window_handle()`),
525    /// `app_state`, and `poster` *together*, after it is mounted under its
526    /// window. The action runs at most once per enqueue (the app loop drains
527    /// the queue each iteration); a widget that rebuilds must guard against
528    /// enqueuing twice. Built for widgets owning a native OS resource that
529    /// needs a window handle to initialise (a `WebView`'s engine subview);
530    /// ordinary widgets never need it.
531    pub fn run_after_mount(&mut self, f: impl FnOnce(&mut crate::widget::EventContext) + 'static) {
532        self.tree.queue_mount_action(Box::new(f));
533    }
534
535    /// Observe a node's framework activation as a `Signal<bool>` — `true`
536    /// while active, `false` while parked dormant by a `Switcher` /
537    /// `visible_when` gate. Initialised to the node's current state and
538    /// updated only on an actual Active↔Dormant transition.
539    ///
540    /// Ordinary widgets never need this: dormant subtrees are simply not
541    /// painted, so they vanish for free. It exists for the one case where
542    /// "not painted" ≠ "hidden" — a widget owning a native OS resource
543    /// that renders *outside* the wgpu pass (a `WebView`'s engine subview).
544    /// Such a widget does `ctx.effect(&ctx.activation_signal(id), move |a|
545    /// handle.set_visible(*a))` to hide/show the native surface in lockstep.
546    pub fn activation_signal(&mut self, id: WidgetId) -> Signal<bool> {
547        self.tree.activation_signal(id)
548    }
549
550    /// The framework press signal for the widget being built — `true` while it
551    /// holds a pointer press whose visual should show.
552    ///
553    /// The router owns the state, so this is correct for the four cases a
554    /// widget's own `PointerDown`/`PointerUp` bookkeeping gets wrong: a press
555    /// that slides off its target goes `false` and comes back `true` on
556    /// re-entry (WCAG 2.2 SC 2.5.2), a press a pan claimant or an ancestor drag
557    /// wins goes `false` with no release to hang it on, a cancel clears it, and
558    /// a press inside a scrollable withholds the visual for the profile's
559    /// `press_feedback_delay` so a finger that turns out to be scrolling never
560    /// flashes a highlight. The rules are written out in `docs/touch-and-pen.md`
561    /// §7.
562    ///
563    /// Bind it at [`BindingLevel::RepaintOnly`](crate::binding::BindingLevel) —
564    /// a press changes colour, never size.
565    pub fn pressed_signal(&mut self) -> Signal<bool> {
566        let id = self.self_id();
567        self.tree.pressed_signal(id)
568    }
569
570    /// Reactive `Signal<bool>` that is `true` while the *focus scope* containing
571    /// the widget being built — its nearest focusable ancestor, e.g. the
572    /// enclosing `ListView` / `TreeView` — holds keyboard focus. Items outside
573    /// any focusable scope read a constant `true`.
574    ///
575    /// Drives **focus-aware selection**: a selected row renders with the active
576    /// `Selected` chrome while its view has focus and the muted
577    /// `SelectedInactive` chrome when focus moves elsewhere — the standard
578    /// desktop affordance (Qt `SH_ItemView_...`, macOS inactive selection) that
579    /// shows where the keyboard is. The scope is resolved at build time but the
580    /// signal stays live across focus changes.
581    pub fn view_focus_active(&mut self) -> Signal<bool> {
582        // Prefer the scope a containing data view explicitly established for its
583        // rows (deterministic, parenting-independent); else resolve by walking
584        // to the nearest focusable ancestor.
585        if let Some(scope) = self.tree.current_view_focus() {
586            return scope;
587        }
588        let id = self.self_id();
589        self.tree.view_focus_active_for(id)
590    }
591
592    /// Mark the widget being built as a **focus scope** for the rows/items it
593    /// builds next: any descendant's [`view_focus_active`](Self::view_focus_active)
594    /// (and `StandardItem`'s focus-aware selection / focus ring) reads *this*
595    /// widget's keyboard focus. A data view calls this around its row loop, then
596    /// [`end_view_focus`](Self::end_view_focus). Deterministic — unaffected by
597    /// arena parenting, which may not be wired while docked/virtualized rows build.
598    pub fn begin_view_focus(&mut self) -> Signal<bool> {
599        let id = self.self_id();
600        self.tree.begin_view_focus(id)
601    }
602
603    /// Like [`begin_view_focus`](Self::begin_view_focus) but keys the scope on
604    /// an explicit `node_id` rather than the widget being built. A view whose
605    /// rows are built by a **separate body-pane widget** (ListView / TreeView /
606    /// TableView / TreeTableView / GridView) passes its own focusable root id so
607    /// descendant
608    /// items resolve the *root's* keyboard focus — not the pane's, which is a
609    /// child of the root and so never holds focus itself.
610    pub fn begin_view_focus_for(&mut self, node_id: WidgetId) -> Signal<bool> {
611        self.tree.begin_view_focus(node_id)
612    }
613
614    /// End the focus scope opened by [`begin_view_focus`](Self::begin_view_focus).
615    pub fn end_view_focus(&mut self) {
616        self.tree.end_view_focus();
617    }
618
619    /// Input-modality "focus-visible" signal — `true` after keyboard input,
620    /// `false` after pointer input (the standard `:focus-visible` rule). Pair
621    /// with [`view_focus_active`](Self::view_focus_active) to draw a focus
622    /// ring only during keyboard navigation, not on mouse clicks.
623    pub fn focus_visible(&self) -> Signal<bool> {
624        self.tree.focus_visible_signal()
625    }
626
627    /// Bind an opacity multiplier (0..1) to a widget. The render walker
628    /// emits `SetOpacity(value)` before painting the widget's subtree
629    /// and `RestoreOpacity` afterwards, so the multiplier composes
630    /// correctly with ancestor opacity scopes. Bound at `RepaintOnly`:
631    /// opacity changes never trigger relayout. Used by the `Fade`
632    /// wrapper to animate a child between hidden and fully visible.
633    pub fn set_opacity(&mut self, id: WidgetId, opacity: impl Into<crate::signal::Prop<f32>>) {
634        self.tree.set_opacity(id, opacity);
635    }
636
637    /// Bind a 2D affine transform to a widget. The render walker emits
638    /// `PushTransform(value)` before painting the widget's subtree and
639    /// `PopTransform` afterwards, so the transform composes onto the
640    /// renderer's stack with any ancestor transform scopes and with
641    /// the widget's own canvas-level transforms. Bound at `RepaintOnly`:
642    /// visual-only transforms never trigger relayout. Used by `Scale`
643    /// and `Rotate`; reflow-driving wrappers (e.g. `Scale::reflow(true)`)
644    /// must additionally bind their driver signal to themselves at
645    /// `Relayout` to make layout track the value.
646    pub fn set_transform(
647        &mut self,
648        id: WidgetId,
649        transform: impl Into<crate::signal::Prop<teksilo_canvas::Transform2D>>,
650    ) {
651        self.tree.set_transform(id, transform);
652    }
653
654    /// Bind a 2D affine **content** transform to a widget — the transform
655    /// positions the widget's content within its fixed parent-space viewport
656    /// (its bounds) rather than transforming the widget itself. Renders the
657    /// same `PushTransform` / `PopTransform` scope as
658    /// [`set_transform`](Self::set_transform), but hit-testing treats the
659    /// bounds as a fixed viewport so the whole visible area stays interactive
660    /// at any pan / zoom. Used by `SceneView` for its pan/zoom view transform.
661    pub fn set_content_transform(
662        &mut self,
663        id: WidgetId,
664        transform: impl Into<crate::signal::Prop<teksilo_canvas::Transform2D>>,
665    ) {
666        self.tree.set_content_transform(id, transform);
667    }
668
669    /// Bind a Gaussian-equivalent blur radius to a widget. The render
670    /// walker emits `BeginBlurredSubtree { bounds, radius }` before
671    /// painting the widget's subtree and `EndBlurredSubtree` afterwards;
672    /// the renderer redirects drawing into an intermediate texture, runs
673    /// a dual-Kawase blur chain at the requested radius, and composites
674    /// the blurred result back into the parent pass at the widget's
675    /// bounds. Bound at `RepaintOnly`: blur radius changes never trigger
676    /// relayout. Sub-perceptual radii (< 0.5) skip the Begin/End pair
677    /// entirely so animated enable/disable patterns have zero per-frame
678    /// cost when fully off. Used by the `Blur` wrapper.
679    pub fn set_blur(&mut self, id: WidgetId, radius: impl Into<crate::signal::Prop<f32>>) {
680        self.tree.set_blur(id, radius);
681    }
682
683    /// Bind a widget's enabled state to a boolean prop.
684    pub fn enabled_when(&mut self, id: WidgetId, state: impl Into<crate::signal::Prop<bool>>) {
685        self.tree.enabled_when(id, state);
686    }
687
688    /// Reactive view of "is this widget effectively enabled?" — the AND
689    /// of the widget's own `enabled_state` and every ancestor's. The
690    /// arena's [`crate::arena::WidgetArena::is_enabled`] is the
691    /// non-reactive equivalent; this method gives composite widgets a
692    /// `Signal<bool>` they can `.map(...)` / `.zip(...)` against to
693    /// derive other reactive UI state (cursor, custom paint, helper
694    /// signals).
695    ///
696    /// Leaves like `IconWidget` / `TextWidget` / `RectWidget` do NOT
697    /// need this — they get the bool directly via
698    /// [`crate::widget::PaintContext::effective_enabled`] at paint time.
699    /// This method is for composites that need the value at build time
700    /// or want to chain signals.
701    ///
702    /// The signal is node-resident and framework-refreshed (install-or-reuse,
703    /// like [`Self::activation_signal`]), so it tracks ancestors correctly even
704    /// though a widget's parent is not yet wired while its own `build()` runs.
705    /// It is a *mutable* signal, so — unlike the old derived implementation —
706    /// it can be passed to [`Self::effect`].
707    ///
708    /// Returns a signal reading `true` for any node whose entire ancestor
709    /// chain (including itself) has no `enabled_state` bound.
710    pub fn effective_enabled_signal(&mut self, id: WidgetId) -> Signal<bool> {
711        self.tree.effective_enabled_signal(id)
712    }
713
714    /// Bind a widget's Tab-key participation to a boolean prop.
715    /// When false, the widget is removed
716    /// from Tab / Shift+Tab traversal but remains reachable via
717    /// `request_focus` and arrow-key navigation. Implements the ARIA
718    /// roving-tabindex pattern (HTML `tabindex="-1"` semantics).
719    pub fn set_tab_stop(&mut self, id: WidgetId, state: impl Into<crate::signal::Prop<bool>>) {
720        self.tree.set_tab_stop(id, state);
721    }
722
723    /// Publish what a data view's `Space` should do when the row containing
724    /// `id` holds the keyboard cursor.
725    ///
726    /// A `ListView` / `TreeView` row is not itself focusable and the view keeps
727    /// the row subtree out of the Tab order — a listbox is one Tab stop — so a
728    /// checkbox inside a row has no keyboard route of its own.
729    /// `StandardListItem` / `StandardTreeItem` publish one for the checkbox
730    /// they embed; a hand-written row delegate calls this to get the same
731    /// behaviour. Without it `Space` keeps meaning "toggle the selection".
732    pub fn set_keyboard_toggle(
733        &mut self,
734        id: WidgetId,
735        f: std::rc::Rc<dyn Fn(&mut crate::widget::EventContext)>,
736    ) {
737        self.tree.set_keyboard_toggle(id, f);
738    }
739
740    /// Declare the widget being built as a **traversal-scope boundary** for
741    /// Tab / Shift+Tab navigation. Descendants' `tab_index` values become
742    /// scoped to this node — they never collide with sibling scopes — and the
743    /// `policy` controls what happens at the scope's ends:
744    ///
745    /// - [`TraversalScopePolicy::Continue`](crate::focus::TraversalScopePolicy::Continue)
746    ///   — Tab flows out into the enclosing scope's next member (groups
747    ///   numbering only).
748    /// - [`TraversalScopePolicy::Cycle`](crate::focus::TraversalScopePolicy::Cycle)
749    ///   — Tab wraps within the scope, never exits. For **modal dialogs only**:
750    ///   a popover or menu is non-modal, and the framework closes one the
751    ///   keyboard walks out of rather than containing focus in it. Trapping such
752    ///   an overlay stops that dismissal from ever firing.
753    ///
754    /// This node is automatically excluded from being a Tab stop itself.
755    /// Prefer the `FocusScope` wrapper widget in `teksilo-widgets` over
756    /// calling this directly.
757    pub fn set_traversal_scope(&mut self, policy: crate::focus::TraversalScopePolicy) {
758        let id = self.self_id();
759        self.tree.set_traversal_scope(id, policy);
760    }
761
762    /// Attach a tooltip to a widget.
763    pub fn attach_tooltip(
764        &mut self,
765        anchor_id: WidgetId,
766        content_id: WidgetId,
767        delay: std::time::Duration,
768    ) {
769        self.tree.attach_tooltip(anchor_id, content_id, delay);
770        self.claim_tooltip_description(anchor_id);
771    }
772
773    /// Attach a tooltip with an explicit
774    /// [`TooltipPlacement`](crate::overlay::TooltipPlacement) — use `Side`
775    /// for anchors stacked vertically (menu items, a vertical tab strip,
776    /// list/tree rows) so the tooltip opens beside the anchor instead of
777    /// covering the next sibling.
778    pub fn attach_tooltip_with_placement(
779        &mut self,
780        anchor_id: WidgetId,
781        content_id: WidgetId,
782        delay: std::time::Duration,
783        placement: crate::overlay::TooltipPlacement,
784    ) {
785        self.tree
786            .attach_tooltip_with_placement(anchor_id, content_id, delay, placement);
787        self.claim_tooltip_description(anchor_id);
788    }
789
790    /// Attach a tooltip that auto-promotes to sticky after a dwell
791    /// timer. Non-None `sticky_after` enables the sticky-on-dwell UX:
792    /// once the tooltip has been shown for `sticky_after`, the tree
793    /// flags the entry sticky and swaps the overlay's dismiss
794    /// behavior to `EscapeOrClickOutside`.
795    pub fn attach_tooltip_with_sticky(
796        &mut self,
797        anchor_id: WidgetId,
798        content_id: WidgetId,
799        delay: std::time::Duration,
800        sticky_after: Option<std::time::Duration>,
801    ) {
802        self.tree
803            .attach_tooltip_with_sticky(anchor_id, content_id, delay, sticky_after);
804        self.claim_tooltip_description(anchor_id);
805    }
806
807    /// Variant of [`attach_tooltip_with_sticky`](Self::attach_tooltip_with_sticky)
808    /// that takes a shared `Rc<Cell<Option<Instant>>>` "sink" the
809    /// tree updates whenever the tooltip is shown / dismissed. The
810    /// tooltip widget reads from this sink to compute its own dwell
811    /// progress reliably, without needing a paint-gap heuristic.
812    pub fn attach_tooltip_with_sticky_sink(
813        &mut self,
814        anchor_id: WidgetId,
815        content_id: WidgetId,
816        delay: std::time::Duration,
817        sticky_after: Option<std::time::Duration>,
818        shown_at_sink: std::rc::Rc<std::cell::Cell<Option<std::time::Instant>>>,
819    ) {
820        self.tree.attach_tooltip_with_sticky_sink(
821            anchor_id,
822            content_id,
823            delay,
824            sticky_after,
825            shown_at_sink,
826        );
827        self.claim_tooltip_description(anchor_id);
828    }
829
830    /// Variant of [`attach_tooltip_with_sticky_sink`](Self::attach_tooltip_with_sticky_sink)
831    /// that also carries a [`TooltipPlacement`](crate::overlay::TooltipPlacement).
832    /// The full-featured path used by rich + composite tooltips that want
833    /// `Side` placement in a vertical context (menu items, list/tree rows).
834    pub fn attach_tooltip_with_sticky_sink_placement(
835        &mut self,
836        anchor_id: WidgetId,
837        content_id: WidgetId,
838        delay: std::time::Duration,
839        sticky_after: Option<std::time::Duration>,
840        shown_at_sink: std::rc::Rc<std::cell::Cell<Option<std::time::Instant>>>,
841        placement: crate::overlay::TooltipPlacement,
842    ) {
843        self.tree.attach_tooltip_with_sticky_sink_placement(
844            anchor_id,
845            content_id,
846            delay,
847            sticky_after,
848            shown_at_sink,
849            placement,
850        );
851        self.claim_tooltip_description(anchor_id);
852    }
853
854    /// Name this widget as the one the tooltip just attached describes.
855    ///
856    /// Every `attach_tooltip*` wrapper ends with this, so a composing control
857    /// gets it for free: `Button`, `Toggle` and the two dozen widgets shaped
858    /// like them hang the overlay off an inner chrome node -- the thing with
859    /// the right bounds to open against -- while their role, their name and
860    /// their focusability sit on their own outer node, which is the node an
861    /// assistive technology lands on and therefore the node a description has
862    /// to be on.
863    ///
864    /// A widget anchoring its tooltip on itself claims itself, which is what
865    /// it already had. A widget attaching *many* tooltips in one build -- a
866    /// list body pane, one per visible row -- claims itself for every one of
867    /// them, which is a claim that cannot be granted; the accessibility walk
868    /// is where that is noticed, because it is the only place the whole set
869    /// is visible at once.
870    fn claim_tooltip_description(&mut self, anchor_id: WidgetId) {
871        let owner = self.self_id();
872        self.tree.set_tooltip_description_owner(anchor_id, owner);
873    }
874
875    /// Promote a shown tooltip to "sticky": removes its auto-dismiss
876    /// on pointer-leave and swaps the overlay's dismiss behavior to
877    /// `EscapeOrClickOutside`. Used by rich tooltips that implement a
878    /// dwell timer.
879    pub fn promote_tooltip_to_sticky(&mut self, content_id: WidgetId) {
880        self.tree.promote_tooltip_to_sticky(content_id);
881    }
882
883    /// Set a widget as dormant (inactive). Used to pre-create overlay content
884    /// that will be activated later via `EventContext::activate()`.
885    pub fn set_dormant(&mut self, id: WidgetId) {
886        self.tree.set_dormant(id);
887    }
888
889    /// Destroy a widget and its entire subtree, removing them from the
890    /// arena and dropping any per-widget subscription / effect handles.
891    ///
892    /// Use this to clean up dormant subtrees that the current widget
893    /// created during a prior build and that live outside its regular
894    /// arena children — e.g., a pre-built popup panel inserted via
895    /// `ctx.add(..)` + `ctx.set_dormant(..)` that becomes stale after a
896    /// rebuild. Regular arena children of the composite (i.e. widgets
897    /// whose ids are returned from `build`) are destroyed automatically
898    /// by the framework's rebuild path and do not need this call.
899    ///
900    /// If an overlay currently references `id` as its content, the
901    /// overlay is dismissed first so the manager does not retain a
902    /// stale content reference.
903    pub fn destroy_subtree(&mut self, id: WidgetId) {
904        let overlay_id = self.tree.overlay_manager().find_by_content(id);
905        if let Some(overlay_id) = overlay_id {
906            self.tree.dismiss_overlay(overlay_id);
907        }
908        self.tree.destroy_subtree(id);
909    }
910
911    /// Apply a `HandlerSet` to the composite widget being built (self).
912    /// This transfers attached event handlers, focusable flag, cursor, etc.
913    /// to the widget's arena node, replacing `event()` and `is_focusable()` overrides.
914    pub fn apply_self_handlers(&mut self, handler_set: crate::widget_builder::HandlerSet) {
915        let id = self.self_id();
916        self.tree.apply_self_handler_set(id, handler_set);
917    }
918
919    /// Move keyboard focus to `id`. Mirrors
920    /// `EventContext::request_focus` for use during `build()` — e.g.
921    /// when a composing widget pre-builds an editor and needs focus to
922    /// land on it as soon as the subtree is wired in.
923    pub fn focus(&mut self, id: WidgetId) {
924        self.tree.focus(id);
925    }
926
927    /// Find the first focusable widget within the subtree rooted at
928    /// `root` in depth-first order. Returns `None` when the subtree has
929    /// no focusable descendant or `root` is not in the arena.
930    pub fn first_focusable_descendant(&self, root: WidgetId) -> Option<WidgetId> {
931        self.tree.first_focusable_descendant(root)
932    }
933
934    /// Find the first widget within the subtree rooted at `root`, in
935    /// depth-first order, that is declared focusable, **whether or not it can
936    /// take focus right now**: a disabled control, or one kept out of the Tab
937    /// order, still counts. Dormant subtrees are skipped, as they are by
938    /// [`first_focusable_descendant`](Self::first_focusable_descendant).
939    ///
940    /// For a wrapper asking which control it stands for. A control disabled
941    /// when it is built is still that control, and taking it for absent would
942    /// have the wrapper add a focus stop of its own beside it.
943    pub fn first_focus_capable_descendant(&self, root: WidgetId) -> Option<WidgetId> {
944        self.tree.first_focus_capable_descendant(root)
945    }
946
947    /// Move keyboard focus **into** the subtree rooted at `id`: its first
948    /// focusable descendant in tab order, or `id` itself when it is the only
949    /// focusable thing there. Returns whether focus ended up inside `id`.
950    ///
951    /// The build-time twin of
952    /// [`EventContext::request_focus_into`](crate::widget::EventContext::request_focus_into),
953    /// and safe here for the same reason [`focus`](Self::focus) is: `add` builds
954    /// a child's whole subtree synchronously, so by the time a composing widget
955    /// holds a child's id the focusable descendants of that child already exist.
956    ///
957    /// **Idempotent, and that is the point.** `build` runs again on every
958    /// rebuild, so a bare `focus` here would drag focus back into this subtree
959    /// every time the owner rebuilt for an unrelated reason — a table body pane
960    /// rebuilds on selection, on filtering and on scroll. This is a no-op while
961    /// focus already sits inside `id`, so it expresses "focus belongs in here"
962    /// rather than "focus here now".
963    ///
964    /// A subtree with nothing focusable leaves focus exactly where it was: an
965    /// empty region never traps it.
966    ///
967    /// ⚠ **Ancestor-chain side effects do not run**, and that is a property of
968    /// focusing from `build` at all, not of this method — [`focus`](Self::focus)
969    /// has it too. A node added during `build` is not parented until the build
970    /// that produced it *returns*, so at this moment `id`'s chain stops at
971    /// whatever the caller has already inserted: `focus_within` signals on
972    /// enclosing nodes never flip, and `scroll_focused_into_view` finds no
973    /// scroll container to reveal the target in. Everything **below** `id` is
974    /// linked (children are parented as each is inserted), so the walk that
975    /// picks the focusable descendant, and every later key dispatch — which
976    /// happens after the pass, on a whole tree — are unaffected.
977    ///
978    /// Reach for [`EventContext::request_focus_into`](crate::widget::EventContext::request_focus_into)
979    /// where the difference matters: it is queued and drained after dispatch,
980    /// against a complete tree.
981    pub fn focus_into(&mut self, id: WidgetId) -> bool {
982        if let Some(focused) = self.tree.focused()
983            && (focused == id || self.tree.is_descendant_of(focused, id))
984        {
985            return true;
986        }
987        match self.tree.first_focusable_descendant(id) {
988            Some(target) => {
989                self.tree.focus(target);
990                true
991            }
992            None => false,
993        }
994    }
995
996    // --- Actions & shortcuts ---
997
998    /// Attach an [`Action`](crate::action::Action) to the widget being
999    /// built. Actions are consulted during intent dispatch as the
1000    /// framework walks source-widget → root; the first matching,
1001    /// enabled action wins (subject to the `IntentResponse` returned
1002    /// by its handler).
1003    ///
1004    /// Actions are cleared on rebuild, mirroring event handlers.
1005    pub fn register_action(&mut self, action: crate::action::Action) {
1006        let id = self.self_id();
1007        self.tree.push_action(id, action);
1008    }
1009
1010    /// Declare that the widget being built **edits text**.
1011    ///
1012    /// Every text widget should call this. It is what lets an application take
1013    /// a text chord — `Ctrl+Z`, `Ctrl+C` — for itself without silently breaking
1014    /// the widget it took it from: the host asks
1015    /// [`focused_text_surface`](crate::widget_tree::WidgetTree::focused_text_surface)
1016    /// and either drives this surface or steps aside so the widget keeps its own
1017    /// keys. See [`crate::text_surface`] for the whole argument.
1018    ///
1019    /// Owned by the registering widget and torn down on its rebuild or destroy,
1020    /// like [`register_action_global`](Self::register_action_global). Calling it
1021    /// twice from one widget re-points rather than duplicating, so a rebuild
1022    /// that hands over a fresh handle is correct.
1023    pub fn register_text_surface(
1024        &mut self,
1025        surface: std::rc::Rc<dyn crate::text_surface::TextSurface>,
1026    ) {
1027        let id = self.self_id();
1028        self.tree.push_text_surface(id, surface);
1029    }
1030
1031    /// A cloneable view of this tree's registered text surfaces.
1032    ///
1033    /// Take it once, during `build`, and hold it: a view-model refreshed from a
1034    /// frame tick has no `&WidgetTree` to consult, and that is exactly when it
1035    /// needs to know whether the caret is in a text widget.
1036    pub fn text_surfaces(&self) -> crate::text_surface::TextSurfaces {
1037        self.tree.text_surfaces()
1038    }
1039
1040    /// Register a **window-global** [`Action`](crate::action::Action), owned by
1041    /// the widget being built. Unlike [`register_action`](Self::register_action)
1042    /// — which only fires when this widget is on the intent's source→root walk —
1043    /// a global action is consulted as a dispatch *fallback*, so it is reachable
1044    /// no matter where the intent originated: a menu-bar dropdown (which renders
1045    /// in an overlay, not under the registering widget), deep content, or a
1046    /// global shortcut anchored at the root when nothing is focused.
1047    ///
1048    /// This is the action-side counterpart to
1049    /// [`register_shortcut_global`](Self::register_shortcut_global): use it for
1050    /// app-wide commands (`app.save`, `view.toggle_sidebar`) whose handler lives
1051    /// at the app root but whose triggers (menu, toolbar, shortcut) are scattered
1052    /// across the tree and chrome. Ownership applies: the action is torn down
1053    /// when this widget rebuilds or is destroyed.
1054    pub fn register_action_global(&mut self, action: crate::action::Action) {
1055        let id = self.self_id();
1056        self.tree.push_global_action(id, action);
1057    }
1058
1059    /// Register a [`Shortcut`](crate::shortcut::Shortcut) in the
1060    /// tree's registry, owned by the widget being built.
1061    ///
1062    /// If the shortcut builder left `scope` at the default
1063    /// ([`ShortcutScope::Global`](crate::shortcut::ShortcutScope::Global)),
1064    /// this method rewrites it to `Scoped(self_id)` so the shortcut
1065    /// only fires when focus is inside the registering widget's
1066    /// subtree — the ergonomic default for widget-declared shortcuts.
1067    /// Callers that want an explicit global shortcut should use
1068    /// [`BuildContext::register_shortcut_global`] instead; callers
1069    /// that want to scope to a specific child should set
1070    /// `.scope_to(child_id)` on the builder themselves.
1071    ///
1072    /// Ownership: the shortcut is removed from the registry when the
1073    /// widget is destroyed or rebuilt. User overrides survive across
1074    /// rebuilds (graveyard semantics).
1075    pub fn register_shortcut(&mut self, mut shortcut: crate::shortcut::Shortcut) {
1076        let id = self.self_id();
1077        if shortcut.scope == crate::shortcut::ShortcutScope::Global {
1078            shortcut.scope = crate::shortcut::ShortcutScope::Scoped(id);
1079        }
1080        self.tree
1081            .shortcut_registry_mut()
1082            .register_owned(shortcut, id);
1083    }
1084
1085    /// Register a [`Shortcut`](crate::shortcut::Shortcut) with
1086    /// explicit global scope, owned by the widget being built. Unlike
1087    /// [`BuildContext::register_shortcut`], this does not rewrite the
1088    /// scope — the shortcut fires regardless of focus position.
1089    ///
1090    /// Ownership still applies: the shortcut is torn down when this
1091    /// widget goes away.
1092    pub fn register_shortcut_global(&mut self, mut shortcut: crate::shortcut::Shortcut) {
1093        let id = self.self_id();
1094        shortcut.scope = crate::shortcut::ShortcutScope::Global;
1095        self.tree
1096            .shortcut_registry_mut()
1097            .register_owned(shortcut, id);
1098    }
1099
1100    /// Pre-declare shortcuts on behalf of a not-yet-mounted child
1101    /// (e.g. a `Switcher` walking its `Pending` slots' static
1102    /// declarations before they're inserted). Each shortcut is owned
1103    /// by the *calling* widget and its declared scope is preserved
1104    /// as-is — unlike [`register_shortcut`](Self::register_shortcut),
1105    /// no rewrite from `Global` to `Scoped(self)` happens, because
1106    /// the child intended its own scope.
1107    ///
1108    /// When the child is eventually mounted, the framework's
1109    /// insert-time walk of `Widget::declare_shortcuts` re-registers
1110    /// the same ids owned by the *child*; the registry's idempotent
1111    /// upsert moves ownership cleanly. If the child never mounts, the
1112    /// pre-declared entries stay alive (owned by the parent) so
1113    /// settings UIs still see them, and they get torn down when the
1114    /// parent goes away.
1115    pub fn register_pending_shortcuts(
1116        &mut self,
1117        shortcuts: impl IntoIterator<Item = crate::shortcut::Shortcut>,
1118    ) {
1119        let id = self.self_id();
1120        let registry = self.tree.shortcut_registry_mut();
1121        for shortcut in shortcuts {
1122            registry.register_owned(shortcut, id);
1123        }
1124    }
1125
1126    /// Read-through access to the tree's shortcut registry. Consumers
1127    /// (menus, tooltips) look up the effective keystroke for a given
1128    /// id here, and observe
1129    /// [`ShortcutRegistry::version`](crate::shortcut::ShortcutRegistry::version)
1130    /// to refresh when the user rebinds.
1131    pub fn shortcut_registry(&self) -> &crate::shortcut::ShortcutRegistry {
1132        self.tree.shortcut_registry()
1133    }
1134
1135    /// Effective view of a shortcut by id, merged with any user
1136    /// override. Returns `None` when no default has been registered
1137    /// for `id`. Typical caller pattern: call from `paint()` so
1138    /// late-registered shortcuts are still picked up without a
1139    /// dedicated build-phase query.
1140    pub fn effective_shortcut<'b>(
1141        &'b self,
1142        id: &str,
1143    ) -> Option<crate::shortcut::EffectiveShortcut<'b>> {
1144        self.shortcut_registry().effective(id)
1145    }
1146
1147    /// Convenience accessor for the reactive version signal. Widgets
1148    /// that render shortcut-derived state (menu labels, tooltips)
1149    /// observe this so the UI refreshes when the user rebinds or a
1150    /// new shortcut is registered.
1151    pub fn shortcut_version(&self) -> &Signal<u64> {
1152        self.shortcut_registry().version()
1153    }
1154
1155    /// A reactive, **per-id** handle to a shortcut's effective primary
1156    /// keystroke — the granular alternative to [`Self::shortcut_version`].
1157    /// Bind this to render one shortcut's accelerator as a *leaf* value
1158    /// (a menu item's trailing label, a tooltip) that refreshes in place
1159    /// when the user rebinds *that* id, without observing — and rebuilding
1160    /// on — every unrelated registry mutation. The signal is created on
1161    /// first request, seeded with the current value, and kept live by the
1162    /// registry across register / unregister / rebind of that id.
1163    pub fn effective_shortcut_signal(
1164        &mut self,
1165        id: &'static str,
1166    ) -> Signal<Option<crate::shortcut::KeyStroke>> {
1167        self.tree
1168            .shortcut_registry_mut()
1169            .effective_primary_signal(id)
1170    }
1171
1172    /// Apply a `HandlerSet` to a child widget created during this build.
1173    /// Use this to attach event handlers to children without wrapping them
1174    /// in `WidgetWithHandlers`.
1175    pub fn apply_handlers(
1176        &mut self,
1177        id: crate::widget_id::WidgetId,
1178        handler_set: crate::widget_builder::HandlerSet,
1179    ) {
1180        // A composing parent attaches handlers to a child — from the
1181        // child's perspective these are external and must survive the
1182        // child's own rebuilds.
1183        self.tree.apply_external_handler_set(id, handler_set);
1184    }
1185
1186    /// Wire an accessibility `labelled_by` relation from an already-mounted
1187    /// child (`id`) to its label (`label_id`), so assistive tech announces the
1188    /// field by its visible label (WCAG 3.3.2 / EN 301 549 11.5.2.7). Unlike
1189    /// the `.access_labelled_by(..)` builder method, this operates *after* the
1190    /// child is mounted (so a container like `FormLayout` can pair a label and
1191    /// a boxed field once both ids are resolved) and preserves any
1192    /// accessibility overrides the child already carries.
1193    pub fn access_labelled_by(
1194        &mut self,
1195        id: crate::widget_id::WidgetId,
1196        label_id: crate::widget_id::WidgetId,
1197    ) {
1198        self.tree.push_access_labelled_by(id, label_id);
1199    }
1200
1201    /// The widget that paints `id`'s title, when it has one.
1202    ///
1203    /// A container names itself from its visible title by pointing at that
1204    /// node — see [`Widget::accessible_title_node`](crate::widget::Widget::accessible_title_node).
1205    /// `build()` runs eagerly on insertion, so the answer is already there
1206    /// the moment the content is mounted.
1207    pub fn accessible_title_node(
1208        &self,
1209        id: crate::widget_id::WidgetId,
1210    ) -> Option<crate::widget_id::WidgetId> {
1211        self.tree.widget_accessible_title_node(id)
1212    }
1213
1214    /// Wire an accessibility `described_by` relation from an already-mounted
1215    /// child (`id`) to a description/error node (`target_id`) — the
1216    /// post-mount, override-preserving counterpart of the
1217    /// `.access_described_by(..)` builder method (WCAG 3.3.1), whose docs say
1218    /// how the target's text reaches a screen reader: as `id`'s description,
1219    /// which the tree writes, since no AccessKit adapter reads the relation.
1220    pub fn access_described_by(
1221        &mut self,
1222        id: crate::widget_id::WidgetId,
1223        target_id: crate::widget_id::WidgetId,
1224    ) {
1225        self.tree.push_access_described_by(id, target_id);
1226    }
1227
1228    /// The id this subscription should carry: the one the previous build used at this
1229    /// same position, or a fresh one.
1230    ///
1231    /// ⚠ **Position is the whole matching rule**, and it is deliberate. The alternative
1232    /// — matching on the origin — cannot be written here: `origin` reaches the adapter
1233    /// as `Box<dyn Any>`, with no `Eq` and no `Hash` to compare it by, and requiring
1234    /// either would change every `EventSource` in existence. Position is stable for the
1235    /// shape widgets actually have, where `build()` runs the same subscribe calls in the
1236    /// same order every time.
1237    ///
1238    /// What a widget that subscribes *conditionally* gets: if the origin at position N
1239    /// differs between two builds, an event still in flight from the old origin is
1240    /// delivered to the new build's callback rather than being dropped. That is safe by
1241    /// construction rather than by luck — an app registers exactly one `EventSource`, so
1242    /// every subscription in the tree shares one origin type and one event type, and the
1243    /// payload downcast cannot mismatch. The callback receives the whole event and can
1244    /// read its origin, which is what `Origin::LongOperation(..)` handlers already do.
1245    fn next_subscription_id(
1246        &self,
1247        app_context: &crate::event_source::TreeAppContext,
1248    ) -> SubscriptionId {
1249        // `subscription_handles` is pushed to once per subscribe call and starts empty
1250        // for each build, so its length *is* this call's position within the build.
1251        self.reusable_sub_ids
1252            .get(self.subscription_handles.len())
1253            .copied()
1254            .unwrap_or_else(|| app_context.allocate_subscription_id())
1255    }
1256
1257    /// Subscribe to events from the registered application event source.
1258    /// The callback runs on the UI thread when the source publishes an
1259    /// event with a matching origin.
1260    ///
1261    /// The subscription is scoped to the current widget's lifetime: when
1262    /// the widget is rebuilt or destroyed, the framework drops the source
1263    /// handle (unregistering from the source) and removes the UI-side
1264    /// callback.
1265    ///
1266    /// It is scoped to the window it was registered from as well. A closing window's
1267    /// tree is dropped wholesale, with no per-widget destroy pass, so teksilo-app calls
1268    /// [`TreeAppContext::purge_subscriptions_for_window`](crate::event_source::TreeAppContext::purge_subscriptions_for_window)
1269    /// to drop the callbacks that window installed. A registration from a windowless
1270    /// tree (headless / tests) records no window, and only the per-widget path above
1271    /// removes such a callback.
1272    ///
1273    /// # Panics
1274    ///
1275    /// Panics if no event source has been registered on the
1276    /// `TeksiloAppBuilder`. In debug builds, also asserts that the `Origin`
1277    /// and `Event` types match the registered source.
1278    pub fn subscribe_event<O, E, F>(&mut self, origin: O, callback: F)
1279    where
1280        O: 'static,
1281        E: 'static,
1282        F: Fn(&E) + 'static,
1283    {
1284        use std::any::{Any, TypeId};
1285        use std::rc::Rc;
1286        use std::sync::Arc;
1287
1288        // Recorded so `TreeAppContext::purge_subscriptions_for_window` can drop this
1289        // entry when the window closes. A closing window's tree is dropped wholesale,
1290        // with no per-widget destroy pass, so nothing else ever reaches the entry and
1291        // the callback (plus everything it captured) would stay live for the rest of
1292        // the process. `None` from a windowless tree (headless / tests), which no
1293        // window purge touches. Mirrors `subscribe_event_with_ctx` below.
1294        let window_id = self.window().map(|w| w.id());
1295
1296        let app_context = self.tree.app_context.clone();
1297
1298        let adapter = app_context.event_source.as_ref().expect(
1299            "BuildContext::subscribe_event called but no event source was registered \
1300             on TeksiloAppBuilder. Call .event_source(source) on the builder first.",
1301        );
1302
1303        debug_assert_eq!(
1304            adapter.origin_type,
1305            TypeId::of::<O>(),
1306            "subscribe_event origin type mismatch: source uses {}, subscribe call used {}",
1307            adapter.origin_type_name,
1308            std::any::type_name::<O>(),
1309        );
1310        debug_assert_eq!(
1311            adapter.event_type,
1312            TypeId::of::<E>(),
1313            "subscribe_event event type mismatch: source uses {}, subscribe call used {}",
1314            adapter.event_type_name,
1315            std::any::type_name::<E>(),
1316        );
1317
1318        let sub_id = self.next_subscription_id(&app_context);
1319
1320        // The UI-side callback that runs after an event posted from the
1321        // source thread is delivered back to the UI thread. It downcasts
1322        // the type-erased payload back to `&E` and invokes the user's `F`.
1323        let stored_callback: Rc<dyn Fn(&dyn Any)> = Rc::new(move |event_any| {
1324            let event = event_any
1325                .downcast_ref::<E>()
1326                .expect("subscription event downcast failed — framework bug");
1327            callback(event);
1328        });
1329        app_context
1330            .subscription_callbacks
1331            .borrow_mut()
1332            .insert(sub_id, (window_id, stored_callback));
1333
1334        // Build the wrapper that the source will invoke from its
1335        // publisher thread. It carries only the sub_id (Copy) and an
1336        // Arc-clone of the poster (Send + Sync), boxes the typed event
1337        // as Any+Send, and posts an AppEvent::SubscriptionEvent through
1338        // the proxy. Tests that run without a registered poster post
1339        // events into a test queue and dispatch them back into the tree
1340        // via `tree.app_context().dispatch_subscription_event`.
1341        let poster = app_context
1342            .poster
1343            .as_ref()
1344            .expect(
1345                "BuildContext::subscribe_event called but no AppEventPoster \
1346                 is installed on the tree. teksilo-app installs one when an \
1347                 event source is registered on the builder; tests must \
1348                 supply a TestPoster via TreeAppContext::with_source_and_poster.",
1349            )
1350            .clone();
1351        let wrapper: Arc<dyn Fn(Box<dyn Any + Send>) + Send + Sync> =
1352            Arc::new(move |erased_event| {
1353                poster.post_subscription_event(sub_id, erased_event);
1354            });
1355
1356        let handle = (adapter.subscribe_fn)(Box::new(origin), wrapper);
1357        self.subscription_handles.push((sub_id, handle));
1358    }
1359
1360    /// Like [`subscribe_event`](Self::subscribe_event), but the UI-side
1361    /// callback additionally receives a fresh
1362    /// [`EventContext`](crate::widget::EventContext) bound to this widget's
1363    /// window. That lets it react to a backend event *imperatively* — update /
1364    /// replace / dismiss a toast, present a modal, `send_intent`, navigate —
1365    /// none of which a plain (context-free) `subscribe_event` callback can do
1366    /// (it can only poke `Signal`s).
1367    ///
1368    /// This is the supported bridge for **long-operation progress**: a data
1369    /// layer's `Progress | Completed | Cancelled | Failed` event
1370    /// crosses from the operation's background thread to the UI thread and the
1371    /// callback drives an evolving progress toast (percentage in the body, a
1372    /// Cancel action, a success/error replacement on completion) — see the
1373    /// `toast_demo` example.
1374    ///
1375    /// The event is delivered on the UI thread through the same
1376    /// `AppEvent::SubscriptionEvent` path as `subscribe_event`; teksilo-app
1377    /// mints the `EventContext` from this widget's window tree just before the
1378    /// call (mirroring `teksilo-async`'s `spawn_local_with` completion path).
1379    /// The subscription is torn down with the widget, exactly like
1380    /// `subscribe_event`.
1381    ///
1382    /// The `<O, E>` type match against the registered event source is a
1383    /// `debug_assert` (as in [`subscribe_event`](Self::subscribe_event)); a
1384    /// mismatched call site in a release build is not caught here but panics
1385    /// later at the payload downcast.
1386    ///
1387    /// Registering from a windowless tree (headless / tests) is allowed but
1388    /// records `None` for the window — the app-side router then has no tree to
1389    /// mint an `EventContext` from and cannot deliver it, so such a subscription
1390    /// never fires in a running app. Ordinary application widgets always have a
1391    /// window; headless code that wants to observe events should use
1392    /// [`subscribe_event`](Self::subscribe_event) and drive `Signal`s instead.
1393    pub fn subscribe_event_with_ctx<O, E, F>(&mut self, origin: O, callback: F)
1394    where
1395        O: 'static,
1396        E: 'static,
1397        F: Fn(&E, &mut crate::widget::EventContext) + 'static,
1398    {
1399        use std::any::{Any, TypeId};
1400        use std::rc::Rc;
1401        use std::sync::Arc;
1402
1403        let window_id = self.window().map(|w| w.id());
1404
1405        let app_context = self.tree.app_context.clone();
1406
1407        let adapter = app_context.event_source.as_ref().expect(
1408            "BuildContext::subscribe_event_with_ctx called but no event source was registered \
1409             on TeksiloAppBuilder. Call .event_source(source) on the builder first.",
1410        );
1411
1412        debug_assert_eq!(
1413            adapter.origin_type,
1414            TypeId::of::<O>(),
1415            "subscribe_event_with_ctx origin type mismatch: source uses {}, subscribe call used {}",
1416            adapter.origin_type_name,
1417            std::any::type_name::<O>(),
1418        );
1419        debug_assert_eq!(
1420            adapter.event_type,
1421            TypeId::of::<E>(),
1422            "subscribe_event_with_ctx event type mismatch: source uses {}, subscribe call used {}",
1423            adapter.event_type_name,
1424            std::any::type_name::<E>(),
1425        );
1426
1427        // Re-used across this widget's rebuilds exactly as in `subscribe_event` — the
1428        // context-bearing path keeps its callbacks in a second map but crosses the very
1429        // same queue, so it loses in-flight events the very same way. See
1430        // [`Self::next_subscription_id`].
1431        let sub_id = self.next_subscription_id(&app_context);
1432
1433        // The UI-side callback, invoked after an event posted from the source
1434        // thread is delivered back to the UI thread and a fresh `EventContext`
1435        // has been minted. Downcasts the type-erased payload back to `&E` and
1436        // forwards it plus the context to the user's `F`. Stored behind `Rc` so
1437        // dispatch can drop the map borrow before invoking it (re-entrancy).
1438        let stored_callback: Rc<dyn Fn(&dyn Any, &mut crate::widget::EventContext)> =
1439            Rc::new(move |event_any, ctx| {
1440                let event = event_any
1441                    .downcast_ref::<E>()
1442                    .expect("subscription event downcast failed — framework bug");
1443                callback(event, ctx);
1444            });
1445        app_context
1446            .subscription_ctx_callbacks
1447            .borrow_mut()
1448            .insert(sub_id, (window_id, stored_callback));
1449
1450        // Same publisher-thread wrapper as `subscribe_event`: carry only the
1451        // sub_id (Copy) + an Arc-clone of the poster, box the typed event, and
1452        // post an `AppEvent::SubscriptionEvent`. The dispatch side (teksilo-app)
1453        // routes context-bearing sub_ids through the fresh-`EventContext` path.
1454        let poster = app_context
1455            .poster
1456            .as_ref()
1457            .expect(
1458                "BuildContext::subscribe_event_with_ctx called but no AppEventPoster \
1459                 is installed on the tree. teksilo-app installs one when an \
1460                 event source is registered on the builder.",
1461            )
1462            .clone();
1463        let wrapper: Arc<dyn Fn(Box<dyn Any + Send>) + Send + Sync> =
1464            Arc::new(move |erased_event| {
1465                poster.post_subscription_event(sub_id, erased_event);
1466            });
1467
1468        let handle = (adapter.subscribe_fn)(Box::new(origin), wrapper);
1469        self.subscription_handles.push((sub_id, handle));
1470    }
1471}
1472
1473#[cfg(test)]
1474mod effect_tests {
1475    use super::*;
1476    use crate::widget::{LayoutContext, Widget};
1477    use crate::widget_id::WidgetId;
1478    use crate::widget_tree::WidgetTree;
1479    use teksilo_canvas::SizeProposal;
1480
1481    /// A leaf widget that registers an effect on one signal to mirror its
1482    /// value into another. Produces no children.
1483    #[derive(Debug)]
1484    struct LeafWithEffect {
1485        source: Signal<i32>,
1486        mirror: Signal<i32>,
1487    }
1488
1489    impl Widget for LeafWithEffect {
1490        fn build(&mut self, ctx: &mut BuildContext) -> Vec<WidgetId> {
1491            let mirror = self.mirror.clone();
1492            ctx.effect(&self.source, move |v| mirror.set(*v));
1493            Vec::new()
1494        }
1495
1496        fn layout_response(
1497            &self,
1498            proposal: SizeProposal,
1499            _ctx: &LayoutContext,
1500        ) -> crate::widget::LayoutResponse {
1501            proposal.resolve(0.0, 0.0).into()
1502        }
1503    }
1504
1505    /// A widget that observes the per-frame tick signal and accumulates the
1506    /// deltas it receives into a shared counter, so a test can verify both
1507    /// that the tick fires at all and that the delta value is non-zero.
1508    #[derive(Debug)]
1509    struct FrameTickListener {
1510        ticks: Signal<u32>,
1511        last_delta: Signal<f32>,
1512    }
1513
1514    impl Widget for FrameTickListener {
1515        fn build(&mut self, ctx: &mut BuildContext) -> Vec<WidgetId> {
1516            let ticks = self.ticks.clone();
1517            let last_delta = self.last_delta.clone();
1518            let tick = ctx.frame_tick();
1519            ctx.effect(&tick, move |delta| {
1520                ticks.set(ticks.get() + 1);
1521                last_delta.set(*delta);
1522            });
1523            Vec::new()
1524        }
1525
1526        fn layout_response(
1527            &self,
1528            proposal: SizeProposal,
1529            _ctx: &LayoutContext,
1530        ) -> crate::widget::LayoutResponse {
1531            proposal.resolve(0.0, 0.0).into()
1532        }
1533    }
1534
1535    #[test]
1536    fn frame_tick_stays_silent_until_explicit_request() {
1537        // The draw-when-needed contract: a widget that merely observes
1538        // frame_tick must NOT keep the tree awake. Only an explicit
1539        // `request_frame()` call pumps a tick.
1540        let mut tree = WidgetTree::new();
1541        let ticks = Signal::new(0_u32);
1542        let last_delta = Signal::new(-1.0_f32);
1543        tree.add(FrameTickListener {
1544            ticks: ticks.clone(),
1545            last_delta: last_delta.clone(),
1546        });
1547
1548        // Flush the initial layout-dirty flag from widget insertion.
1549        tree.layout(teksilo_canvas::SizeProposal::exact(400.0, 300.0));
1550        assert!(
1551            !tree.frame_requested(),
1552            "observing frame_tick does not set the request flag"
1553        );
1554
1555        tree.tick_animations(std::time::Duration::from_millis(16));
1556        assert_eq!(
1557            ticks.get(),
1558            0,
1559            "an un-requested tick_animations must not fire frame_tick observers"
1560        );
1561        assert_eq!(last_delta.get(), -1.0);
1562    }
1563
1564    #[test]
1565    fn frame_tick_fires_once_per_request() {
1566        let mut tree = WidgetTree::new();
1567        let ticks = Signal::new(0_u32);
1568        let last_delta = Signal::new(-1.0_f32);
1569        let id = tree.add(FrameTickListener {
1570            ticks: ticks.clone(),
1571            last_delta: last_delta.clone(),
1572        });
1573
1574        // Flush initial layout-dirty flag so assertions reflect only
1575        // the frame-tick contract.
1576        tree.layout(teksilo_canvas::SizeProposal::exact(400.0, 300.0));
1577
1578        tree.request_frame();
1579        assert!(tree.needs_redraw(), "explicit request marks the tree dirty");
1580        assert!(tree.frame_requested());
1581
1582        tree.tick_animations(std::time::Duration::from_millis(16));
1583        assert_eq!(ticks.get(), 1);
1584        assert!((last_delta.get() - 0.016).abs() < 0.001);
1585        assert!(
1586            !tree.frame_requested(),
1587            "request flag must be cleared after the tick fired"
1588        );
1589
1590        // Second request fires exactly one more tick.
1591        tree.request_frame();
1592        tree.tick_animations(std::time::Duration::from_millis(16));
1593        assert_eq!(ticks.get(), 2);
1594
1595        // Without a request, further ticks silently advance time.
1596        tree.tick_animations(std::time::Duration::from_millis(16));
1597        assert_eq!(ticks.get(), 2);
1598
1599        tree.destroy_subtree(id);
1600        tree.request_frame();
1601        tree.tick_animations(std::time::Duration::from_millis(16));
1602        assert_eq!(
1603            ticks.get(),
1604            2,
1605            "destroyed widget's observer must not resurrect"
1606        );
1607    }
1608
1609    #[test]
1610    fn frame_tick_delta_clamped_against_huge_pauses() {
1611        let mut tree = WidgetTree::new();
1612        let ticks = Signal::new(0_u32);
1613        let last_delta = Signal::new(-1.0_f32);
1614        tree.add(FrameTickListener {
1615            ticks: ticks.clone(),
1616            last_delta: last_delta.clone(),
1617        });
1618
1619        tree.request_frame();
1620        tree.tick_animations(std::time::Duration::from_secs(5));
1621        assert_eq!(ticks.get(), 1);
1622        assert!(
1623            (last_delta.get() - 0.1).abs() < 1e-4,
1624            "frame delta must clamp at 0.1s even after a multi-second pause"
1625        );
1626    }
1627
1628    #[test]
1629    fn leaf_widget_effect_fires_and_is_cleaned_up_on_destroy() {
1630        // Regression guard: before the insert_widget / add_child fix,
1631        // effect_handles for a leaf widget (Vec::new() from build()) were
1632        // dropped the moment BuildContext went out of scope, silently
1633        // unregistering the observer. After the fix, the handle is
1634        // transferred to the arena node and the effect fires on signal
1635        // changes until the widget is destroyed.
1636        let mut tree = WidgetTree::new();
1637        let source = Signal::new(0_i32);
1638        let mirror = Signal::new(0_i32);
1639
1640        let id = tree.add(LeafWithEffect {
1641            source: source.clone(),
1642            mirror: mirror.clone(),
1643        });
1644
1645        // The effect should be live after insertion.
1646        source.set(42);
1647        assert_eq!(
1648            mirror.get(),
1649            42,
1650            "leaf widget effect must survive build() and fire on signal change"
1651        );
1652
1653        source.set(7);
1654        assert_eq!(mirror.get(), 7);
1655
1656        // Destroying the widget drops its effect_handles, which in turn
1657        // drops each ObserverHandle and unregisters the observer.
1658        tree.destroy_subtree(id);
1659        source.set(100);
1660        assert_eq!(
1661            mirror.get(),
1662            7,
1663            "effect must be unregistered after widget destruction"
1664        );
1665    }
1666}
1667
1668#[cfg(test)]
1669mod focus_into_tests {
1670    use super::*;
1671    use crate::widget::{LayoutContext, Widget};
1672    use crate::widget_builder::HandlerSet;
1673    use crate::widget_id::WidgetId;
1674    use crate::widget_tree::WidgetTree;
1675    use teksilo_canvas::SizeProposal;
1676
1677    /// A leaf that is focusable when asked, so the walk has something real to
1678    /// find — or nothing at all.
1679    #[derive(Debug)]
1680    struct Leaf {
1681        focusable: bool,
1682    }
1683
1684    impl Widget for Leaf {
1685        fn build(&mut self, ctx: &mut BuildContext) -> Vec<WidgetId> {
1686            if self.focusable {
1687                ctx.apply_self_handlers(HandlerSet::new().focusable(true));
1688            }
1689            Vec::new()
1690        }
1691        fn layout_response(
1692            &self,
1693            proposal: SizeProposal,
1694            _ctx: &LayoutContext,
1695        ) -> crate::widget::LayoutResponse {
1696            proposal.resolve(10.0, 10.0).into()
1697        }
1698    }
1699
1700    /// Holds `focusable` focusable leaves and publishes their ids.
1701    #[derive(Debug)]
1702    struct Panel {
1703        focusable: usize,
1704        leaves: Signal<Vec<WidgetId>>,
1705    }
1706
1707    impl Widget for Panel {
1708        fn build(&mut self, ctx: &mut BuildContext) -> Vec<WidgetId> {
1709            let kids: Vec<WidgetId> = (0..2)
1710                .map(|i| {
1711                    ctx.add(Leaf {
1712                        focusable: i < self.focusable,
1713                    })
1714                })
1715                .collect();
1716            self.leaves.set(kids.clone());
1717            kids
1718        }
1719        fn layout_response(
1720            &self,
1721            proposal: SizeProposal,
1722            _ctx: &LayoutContext,
1723        ) -> crate::widget::LayoutResponse {
1724            proposal.resolve(10.0, 10.0).into()
1725        }
1726    }
1727
1728    /// Calls `focus_into(panel)` on every one of *its own* builds, which is how
1729    /// a composing widget uses it. Rebuilt on demand through `tick` — and
1730    /// rebuilding it leaves the panel and its leaves alive, which is the whole
1731    /// point: that is the situation the idempotence has to survive.
1732    #[derive(Debug)]
1733    struct Driver {
1734        panel: Signal<Option<WidgetId>>,
1735        tick: Signal<u64>,
1736        moved: Signal<bool>,
1737    }
1738
1739    impl Widget for Driver {
1740        fn build(&mut self, ctx: &mut BuildContext) -> Vec<WidgetId> {
1741            self.tick.bind_to(
1742                ctx.self_id(),
1743                ctx.binding_registry(),
1744                crate::binding::BindingLevel::Rebuild,
1745            );
1746            if let Some(panel) = self.panel.get() {
1747                let moved = ctx.focus_into(panel);
1748                self.moved.set(moved);
1749            }
1750            Vec::new()
1751        }
1752        fn layout_response(
1753            &self,
1754            proposal: SizeProposal,
1755            _ctx: &LayoutContext,
1756        ) -> crate::widget::LayoutResponse {
1757            proposal.resolve(0.0, 0.0).into()
1758        }
1759    }
1760
1761    struct Probe {
1762        tree: WidgetTree,
1763        leaves: Vec<WidgetId>,
1764        tick: Signal<u64>,
1765        moved: Signal<bool>,
1766    }
1767
1768    impl Probe {
1769        fn rebuild_driver(&mut self) {
1770            self.tick.set(self.tick.get() + 1);
1771            self.tree.layout(SizeProposal::exact(100.0, 100.0));
1772        }
1773    }
1774
1775    /// A panel with `focusable` focusable leaves, plus a sibling driver that
1776    /// calls `focus_into` on it from `build`. `outside` is focusable and lives
1777    /// outside the panel, so "focus did not move" is observable.
1778    fn probe(focusable: usize) -> (Probe, WidgetId) {
1779        let leaves = Signal::new(Vec::new());
1780        let panel_id = Signal::new(None);
1781        let tick = Signal::new(0_u64);
1782        let moved = Signal::new(false);
1783
1784        let mut tree = WidgetTree::new();
1785        let outside = tree.add(Leaf { focusable: true });
1786        let panel = tree.add(Panel {
1787            focusable,
1788            leaves: leaves.clone(),
1789        });
1790        panel_id.set(Some(panel));
1791        tree.add(Driver {
1792            panel: panel_id,
1793            tick: tick.clone(),
1794            moved: moved.clone(),
1795        });
1796        tree.layout(SizeProposal::exact(100.0, 100.0));
1797        (
1798            Probe {
1799                tree,
1800                leaves: leaves.get(),
1801                tick,
1802                moved,
1803            },
1804            outside,
1805        )
1806    }
1807
1808    /// It lands on the first focusable descendant, not on the container.
1809    #[test]
1810    fn focus_into_lands_on_the_first_focusable_descendant() {
1811        let (p, _) = probe(2);
1812        assert!(p.moved.get());
1813        assert_eq!(p.tree.focused(), Some(p.leaves[0]));
1814    }
1815
1816    /// **It is a no-op while focus is already inside** — the property that lets
1817    /// it be called from `build`, which re-runs on every rebuild. A bare
1818    /// `focus` on the first focusable descendant would drag focus back to the
1819    /// first field every time the caller rebuilt for an unrelated reason, which
1820    /// mid-edit is the caret jumping to the start of the line.
1821    #[test]
1822    fn focus_into_leaves_focus_alone_when_it_is_already_inside() {
1823        let (mut p, _) = probe(2);
1824        p.tree.focus(p.leaves[1]);
1825        p.rebuild_driver();
1826        assert!(p.moved.get(), "focus is inside, so the answer is still yes");
1827        assert_eq!(
1828            p.tree.focused(),
1829            Some(p.leaves[1]),
1830            "focus was dragged back to the first focusable child"
1831        );
1832    }
1833
1834    /// A subtree with nothing focusable leaves focus exactly where it was: an
1835    /// empty region never traps it, and the caller is told so.
1836    #[test]
1837    fn focus_into_an_unfocusable_subtree_moves_nothing() {
1838        let (mut p, outside) = probe(0);
1839        p.tree.focus(outside);
1840        p.rebuild_driver();
1841        assert!(!p.moved.get());
1842        assert_eq!(p.tree.focused(), Some(outside));
1843    }
1844}