slt/context/runtime.rs
1use super::*;
2
3impl Context {
4 pub(crate) fn new(
5 events: Vec<Event>,
6 width: u32,
7 height: u32,
8 state: &mut FrameState,
9 theme: Theme,
10 ) -> Self {
11 let hook_states = &mut state.hook_states;
12 let named_states = std::mem::take(&mut state.named_states);
13 // Issue #215: hand off the keyed-state map for this frame. Same
14 // lifetime as `named_states`: moved out at frame start, moved back
15 // at frame end (see `run_frame_kernel`).
16 let keyed_states = std::mem::take(&mut state.keyed_states);
17 // Issue #262: hand off the partial-chord buffer for this frame. Same
18 // lifetime as `keyed_states`: moved out at frame start, moved back at
19 // frame end (see `run_frame_kernel`).
20 let chord = std::mem::take(&mut state.chord_states);
21 // Issue #248: hand off the scheduler timer table for this frame. Same
22 // lifetime as `named_states`: moved out at frame start, moved back at
23 // frame end (where untouched slots are GC'd; see `run_frame_kernel`).
24 let scheduler = std::mem::take(&mut state.scheduler);
25 // Issue #234: hand off the async task registry for this frame. Same
26 // lifetime as `scheduler`: moved out at frame start, moved back at
27 // frame end (see `run_frame_kernel`).
28 #[cfg(feature = "async")]
29 let async_tasks = std::mem::take(&mut state.async_tasks);
30 let screen_hook_map = std::mem::take(&mut state.screen_hook_map);
31 let focus = &mut state.focus;
32 // Issue #217: name→index map from the previous frame, used to resolve
33 // `focus_by_name(name)` at frame start. We move it out so the
34 // `register_focusable_named` calls in this frame can rebuild a fresh
35 // `focus_name_map`. The fresh map is swapped back into
36 // `focus_name_map_prev` at frame end.
37 let focus_name_map_prev = std::mem::take(&mut focus.focus_name_map_prev);
38 let pending_focus_name = focus.pending_focus_name.take();
39 let prev_focus_index = focus.prev_focus_index;
40 let layout_feedback = &mut state.layout_feedback;
41 let diagnostics = &mut state.diagnostics;
42 let consumed = vec![false; events.len()];
43
44 // Single wall-clock sample for this frame, reused for double-click
45 // timing below and for `frame_instant` (the timer/scheduler clock).
46 let frame_now = std::time::Instant::now();
47 let mut mouse_pos = layout_feedback.last_mouse_pos;
48 let mut click_pos = None;
49 let mut right_click_pos = None;
50 let mut double_click_pos = None;
51 let mut scroll_pos = None;
52 let mut scroll_delta_frame: i32 = 0;
53 for event in &events {
54 if let Event::Mouse(mouse) = event {
55 mouse_pos = Some((mouse.x, mouse.y));
56 match mouse.kind {
57 MouseKind::Down(MouseButton::Left) => {
58 click_pos = Some((mouse.x, mouse.y));
59 // v0.21.1: a left click on the same cell as the previous
60 // click, within `DOUBLE_CLICK_WINDOW`, is a double-click.
61 // Clear the tracker after firing so a third click starts
62 // a fresh pair (no triple-counting).
63 let pos = (mouse.x, mouse.y);
64 let is_double = layout_feedback.last_click_pos == Some(pos)
65 && layout_feedback.last_click_at.is_some_and(|t| {
66 frame_now.duration_since(t) <= crate::DOUBLE_CLICK_WINDOW
67 });
68 if is_double {
69 double_click_pos = Some(pos);
70 layout_feedback.last_click_at = None;
71 layout_feedback.last_click_pos = None;
72 } else {
73 layout_feedback.last_click_at = Some(frame_now);
74 layout_feedback.last_click_pos = Some(pos);
75 }
76 }
77 MouseKind::Down(MouseButton::Right) => {
78 // Issue #208: capture last right-click position so
79 // `response_for` can hit-test against per-widget rects.
80 right_click_pos = Some((mouse.x, mouse.y));
81 }
82 // v0.21.1: accumulate net vertical wheel delta + the cursor
83 // position, hover-gated per-widget by `response_for`.
84 MouseKind::ScrollUp => {
85 scroll_pos = Some((mouse.x, mouse.y));
86 scroll_delta_frame = scroll_delta_frame.saturating_add(1);
87 }
88 MouseKind::ScrollDown => {
89 scroll_pos = Some((mouse.x, mouse.y));
90 scroll_delta_frame = scroll_delta_frame.saturating_sub(1);
91 }
92 _ => {}
93 }
94 }
95 }
96
97 let mut focus_index = focus.focus_index;
98 if let Some((mx, my)) = click_pos {
99 let mut best: Option<(usize, u64)> = None;
100 for &(fid, rect) in &layout_feedback.prev_focus_rects {
101 if mx >= rect.x && mx < rect.right() && my >= rect.y && my < rect.bottom() {
102 let area = rect.width as u64 * rect.height as u64;
103 if best.map_or(true, |(_, ba)| area < ba) {
104 best = Some((fid, area));
105 }
106 }
107 }
108 if let Some((fid, _)) = best {
109 focus_index = fid;
110 }
111 }
112
113 // Issue #217: resolve a pending `focus_by_name(...)` request against
114 // the previous frame's `name → index` map. If the name wasn't
115 // registered last frame, we keep the request pending for the next
116 // frame so a widget that registers later can still receive focus.
117 // If the request resolves, we consume it.
118 let mut still_pending: Option<String> = None;
119 if let Some(name) = pending_focus_name {
120 if let Some(&resolved) = focus_name_map_prev.get(&name) {
121 focus_index = resolved;
122 } else {
123 still_pending = Some(name);
124 }
125 }
126
127 // Reuse `commands_buf` capacity from the previous frame (issue #150).
128 // `mem::take` swaps an empty Vec into `state.commands_buf`; we then
129 // clear (no-op when reclaimed from a `build_tree` drain, defensive
130 // when reclaimed from the quit path that ran without `build_tree`)
131 // and reuse the allocation. After `build_tree(&mut ctx.commands)`
132 // drains the Vec in place, the empty (but capacity-bearing) Vec is
133 // moved back into `state.commands_buf` at frame end inside
134 // `run_frame_kernel`.
135 let mut commands = std::mem::take(&mut state.commands_buf);
136 commands.clear();
137
138 // Issue #204: reuse the six per-frame `Vec`/`HashSet` allocations
139 // (`context_stack`, `deferred_draws`, `rollback.group_stack`,
140 // `rollback.text_color_stack`, `pending_tooltips`, `hovered_groups`).
141 // Same `mem::take` pattern as `commands_buf` (#150). Each buffer is
142 // empty at frame end (asserted at `run_frame_kernel`) — `mem::take`
143 // hands a `Default::default()` empty back to the state, the Vec/HashSet
144 // we move into `Context` keeps its capacity from the prior frame, and
145 // `clear()` here is a no-op except as a defensive guard against future
146 // refactors that might leak items past the assertions.
147 let mut context_stack = std::mem::take(&mut state.context_stack_buf);
148 context_stack.clear();
149 let mut deferred_draws = std::mem::take(&mut state.deferred_draws_buf);
150 deferred_draws.clear();
151 let mut group_stack = std::mem::take(&mut state.group_stack_buf);
152 group_stack.clear();
153 let mut text_color_stack = std::mem::take(&mut state.text_color_stack_buf);
154 text_color_stack.clear();
155 let mut pending_tooltips = std::mem::take(&mut state.pending_tooltips_buf);
156 pending_tooltips.clear();
157 let hovered_groups = std::mem::take(&mut state.hovered_groups_buf);
158 // `hovered_groups` is `clear()`-ed inside `build_hovered_groups`
159 // immediately below, so we do not pre-clear here — capacity is
160 // preserved across frames.
161
162 // Issue #273: hand off the previous frame's `cached` region keys and a
163 // recycled (cleared) buffer to record this frame's keys into. Both
164 // round-trip back into `FrameState` at frame end. Empty (zero
165 // overhead) for apps that never call `cached`.
166 let region_versions_prev = std::mem::take(&mut state.region_versions);
167 let mut region_versions_cur = std::mem::take(&mut state.region_versions_buf);
168 region_versions_cur.clear();
169
170 let mut ctx = Self {
171 commands,
172 events,
173 consumed,
174 should_quit: false,
175 area_width: width,
176 area_height: height,
177 tick: diagnostics.tick,
178 focus_index,
179 hook_states: std::mem::take(hook_states),
180 named_states,
181 keyed_states,
182 chord,
183 context_stack,
184 prev_focus_count: focus.prev_focus_count,
185 prev_modal_focus_start: focus.prev_modal_focus_start,
186 prev_modal_focus_count: focus.prev_modal_focus_count,
187 prev_scroll_infos: std::mem::take(&mut layout_feedback.prev_scroll_infos),
188 prev_scroll_rects: std::mem::take(&mut layout_feedback.prev_scroll_rects),
189 prev_hit_map: std::mem::take(&mut layout_feedback.prev_hit_map),
190 prev_group_rects: std::mem::take(&mut layout_feedback.prev_group_rects),
191 prev_focus_groups: std::mem::take(&mut layout_feedback.prev_focus_groups),
192 mouse_pos,
193 click_pos,
194 right_click_pos,
195 double_click_pos,
196 scroll_pos,
197 scroll_delta_frame,
198 prev_modal_active: focus.prev_modal_active,
199 clipboard_text: None,
200 debug: diagnostics.debug_mode,
201 debug_layer: diagnostics.debug_layer,
202 inspector_mode: diagnostics.inspector_mode,
203 theme,
204 is_real_terminal: false,
205 // Issue #264: conservative default; overwritten by the probed
206 // snapshot in `run_frame_kernel` on a real terminal.
207 #[cfg(feature = "crossterm")]
208 capabilities: crate::terminal::Capabilities::default(),
209 deferred_draws,
210 rollback: ContextRollbackState {
211 last_text_idx: None,
212 focus_count: 0,
213 last_focusable_id: None,
214 pending_focusable_id: None,
215 interaction_count: 0,
216 scroll_count: 0,
217 group_count: 0,
218 group_stack,
219 overlay_depth: 0,
220 modal_active: false,
221 modal_focus_start: 0,
222 modal_focus_count: 0,
223 hook_cursor: 0,
224 dark_mode: theme.is_dark,
225 notification_queue: std::mem::take(&mut diagnostics.notification_queue),
226 text_color_stack,
227 },
228 pending_tooltips,
229 hovered_groups,
230 region_versions_prev,
231 region_versions_cur,
232 region_cache_hits: 0,
233 region_cache_misses: 0,
234 scroll_lines_per_event: 1,
235 screen_hook_map,
236 widget_theme: WidgetTheme::new(),
237 prev_focus_index,
238 focus_name_map_prev,
239 focus_name_map: std::collections::HashMap::new(),
240 pending_focus_name: still_pending,
241 // Issue #248: sample a single wall-clock "now" for every timer
242 // method called this frame. v0.21.1: reuse the `frame_now` sampled
243 // above (also used for double-click timing) so the frame has one
244 // coherent clock reading.
245 frame_instant: frame_now,
246 scheduler,
247 // Issue #234: async task registry round-tripped like `scheduler`.
248 #[cfg(feature = "async")]
249 async_tasks,
250 };
251 ctx.build_hovered_groups();
252 ctx
253 }
254
255 fn build_hovered_groups(&mut self) {
256 self.hovered_groups.clear();
257 if let Some(pos) = self.mouse_pos {
258 for (name, rect) in &self.prev_group_rects {
259 if pos.0 >= rect.x
260 && pos.0 < rect.x + rect.width
261 && pos.1 >= rect.y
262 && pos.1 < rect.y + rect.height
263 {
264 self.hovered_groups.insert(std::sync::Arc::clone(name));
265 }
266 }
267 }
268 }
269
270 /// Set how many lines each scroll event moves. Default is 1.
271 pub fn set_scroll_speed(&mut self, lines: u32) {
272 self.scroll_lines_per_event = lines.max(1);
273 }
274
275 /// Get the current scroll speed (lines per scroll event).
276 pub fn scroll_speed(&self) -> u32 {
277 self.scroll_lines_per_event
278 }
279
280 /// Get the current focus index.
281 ///
282 /// Widget indices are assigned in the order [`register_focusable()`](Self::register_focusable) is called.
283 /// Indices are 0-based and wrap at [`focus_count()`](Self::focus_count).
284 pub fn focus_index(&self) -> usize {
285 self.focus_index
286 }
287
288 /// Set the focus index to a specific focusable widget.
289 ///
290 /// Widget indices are assigned in the order [`register_focusable()`](Self::register_focusable) is called
291 /// (0-based). If `index` exceeds the number of focusable widgets it will
292 /// be clamped by the modulo in [`register_focusable`](Self::register_focusable).
293 ///
294 /// # Example
295 ///
296 /// ```no_run
297 /// # slt::run(|ui: &mut slt::Context| {
298 /// // Focus the second focusable widget (index 1)
299 /// ui.set_focus_index(1);
300 /// # });
301 /// ```
302 pub fn set_focus_index(&mut self, index: usize) {
303 self.focus_index = index;
304 }
305
306 /// Get the number of focusable widgets registered in the previous frame.
307 ///
308 /// Returns 0 on the very first frame. Useful together with
309 /// [`set_focus_index()`](Self::set_focus_index) for programmatic focus control.
310 ///
311 /// Note: this intentionally reads `prev_focus_count` (the settled count
312 /// from the last completed frame) rather than `focus_count` (the
313 /// still-incrementing counter for the current frame).
314 #[allow(clippy::misnamed_getters)]
315 pub fn focus_count(&self) -> usize {
316 self.prev_focus_count
317 }
318
319 /// Advance keyboard focus one step, honoring an active modal's focus trap.
320 /// `forward` selects next vs previous; both wrap. Shared by
321 /// [`focus_next`](Self::focus_next) / [`focus_prev`](Self::focus_prev) and
322 /// the `Tab`/`Shift+Tab` handler in `process_focus_keys` (v0.21.1).
323 pub(crate) fn advance_focus(&mut self, forward: bool) {
324 if self.prev_modal_active && self.prev_modal_focus_count > 0 {
325 let mut modal_local = self.focus_index.saturating_sub(self.prev_modal_focus_start);
326 modal_local %= self.prev_modal_focus_count;
327 let next = if forward {
328 (modal_local + 1) % self.prev_modal_focus_count
329 } else if modal_local == 0 {
330 self.prev_modal_focus_count - 1
331 } else {
332 modal_local - 1
333 };
334 self.focus_index = self.prev_modal_focus_start + next;
335 } else if self.prev_focus_count > 0 {
336 self.focus_index = if forward {
337 (self.focus_index + 1) % self.prev_focus_count
338 } else if self.focus_index == 0 {
339 self.prev_focus_count - 1
340 } else {
341 self.focus_index - 1
342 };
343 }
344 }
345
346 /// Move keyboard focus to the next focusable widget (wrapping), exactly as
347 /// pressing `Tab` would. Honors an active modal's focus trap. Pairs with
348 /// [`set_focus_index`](Self::set_focus_index) / [`focus_count`](Self::focus_count)
349 /// for programmatic focus control (e.g. an app-level shortcut). Available
350 /// since v0.21.1.
351 ///
352 /// # Example
353 ///
354 /// ```no_run
355 /// # slt::run(|ui: &mut slt::Context| {
356 /// // Advance focus on a custom shortcut (e.g. a vim-style 'j').
357 /// if ui.key('j') {
358 /// ui.focus_next();
359 /// }
360 /// # });
361 /// ```
362 pub fn focus_next(&mut self) {
363 self.advance_focus(true);
364 }
365
366 /// Move keyboard focus to the previous focusable widget (wrapping), exactly
367 /// as `Shift+Tab` would. Honors an active modal's focus trap. Available
368 /// since v0.21.1.
369 pub fn focus_prev(&mut self) {
370 self.advance_focus(false);
371 }
372
373 /// Move focus to the next focusable widget belonging to the named focus
374 /// group, wrapping within the group. If focus is currently outside the
375 /// group it jumps to the group's first member. No-op if the group had no
376 /// focusable widgets on the previous frame.
377 ///
378 /// Focus groups are declared with [`group`](Self::group); this is the
379 /// scoped counterpart to [`focus_next`](Self::focus_next) for building a
380 /// focus trap around a panel or sub-form without a modal. Available since
381 /// v0.21.1.
382 pub fn focus_next_in_group(&mut self, group: &str) {
383 self.advance_focus_in_group(group, true);
384 }
385
386 /// Move focus to the previous focusable widget in the named group
387 /// (wrapping). See [`focus_next_in_group`](Self::focus_next_in_group).
388 /// Available since v0.21.1.
389 pub fn focus_prev_in_group(&mut self, group: &str) {
390 self.advance_focus_in_group(group, false);
391 }
392
393 fn advance_focus_in_group(&mut self, group: &str, forward: bool) {
394 // Membership comes from the previous frame's `index -> group` table,
395 // the same source `is_group_focused` consults. Indices are valid
396 // focus indices (0..prev_focus_count).
397 let members: Vec<usize> = self
398 .prev_focus_groups
399 .iter()
400 .enumerate()
401 .filter_map(|(idx, g)| match g.as_deref() {
402 Some(name) if name == group => Some(idx),
403 _ => None,
404 })
405 .collect();
406 if members.is_empty() {
407 return;
408 }
409 let new_pos = match members.iter().position(|&m| m == self.focus_index) {
410 Some(p) => {
411 if forward {
412 (p + 1) % members.len()
413 } else if p == 0 {
414 members.len() - 1
415 } else {
416 p - 1
417 }
418 }
419 // Focus is outside the group: jump to its first member.
420 None => 0,
421 };
422 self.focus_index = members[new_pos];
423 }
424
425 /// Read-only snapshot of the terminal's negotiated capabilities
426 /// (issue #264).
427 ///
428 /// Populated once at session enter via a DA1/DA2/XTGETTCAP probe. This is
429 /// **diagnostics-only**: image rendering already routes through the
430 /// automatic blitter ladder (Kitty > Sixel > sextant > half-block), so app
431 /// code is never required to branch on the returned value. On a headless
432 /// backend (e.g. [`TestBackend`](crate::TestBackend)) or piped stdout, the
433 /// probe is skipped and every field is a conservative default.
434 ///
435 /// Available since `0.21.0`.
436 ///
437 /// # Example
438 ///
439 /// ```no_run
440 /// # slt::run(|ui: &mut slt::Context| {
441 /// let caps = ui.capabilities();
442 /// // e.g. surface a "truecolor: on" line in a diagnostics panel.
443 /// let _ = caps.truecolor;
444 /// # });
445 /// ```
446 #[cfg(feature = "crossterm")]
447 pub fn capabilities(&self) -> &crate::terminal::Capabilities {
448 &self.capabilities
449 }
450
451 pub(crate) fn process_focus_keys(&mut self) {
452 // Scan for Tab / Shift+Tab / BackTab, recording the direction of each
453 // and consuming the event. The mutation (`advance_focus`) is applied
454 // after the scan: it borrows `&mut self` wholesale, which cannot run
455 // while `self.events` is iterated by reference. Collecting first
456 // preserves the original "each Tab advances once" semantics.
457 let mut actions: Vec<bool> = Vec::new();
458 for (i, event) in self.events.iter().enumerate() {
459 if self.consumed[i] {
460 continue;
461 }
462 if let Event::Key(key) = event {
463 if key.kind != KeyEventKind::Press {
464 continue;
465 }
466 if key.code == KeyCode::Tab && !key.modifiers.contains(KeyModifiers::SHIFT) {
467 actions.push(true);
468 self.consumed[i] = true;
469 } else if (key.code == KeyCode::Tab && key.modifiers.contains(KeyModifiers::SHIFT))
470 || key.code == KeyCode::BackTab
471 {
472 actions.push(false);
473 self.consumed[i] = true;
474 }
475 }
476 }
477 for forward in actions {
478 self.advance_focus(forward);
479 }
480 }
481
482 /// Render a custom [`Widget`].
483 ///
484 /// Calls [`Widget::ui`] with this context and returns the widget's response.
485 pub fn widget<W: Widget>(&mut self, w: &mut W) -> W::Response {
486 w.ui(self)
487 }
488
489 /// Wrap child widgets in a panic boundary.
490 ///
491 /// If the closure panics, the panic is caught and an error message is
492 /// rendered in place of the children. The app continues running.
493 ///
494 /// # Example
495 ///
496 /// ```no_run
497 /// # slt::run(|ui: &mut slt::Context| {
498 /// ui.error_boundary(|ui| {
499 /// ui.text("risky widget");
500 /// });
501 /// # });
502 /// ```
503 pub fn error_boundary(&mut self, f: impl FnOnce(&mut Context)) {
504 self.error_boundary_with(f, |ui, msg| {
505 ui.styled(
506 format!("⚠ Error: {msg}"),
507 Style::new().fg(ui.theme.error).bold(),
508 );
509 });
510 }
511
512 /// Like [`error_boundary`](Self::error_boundary), but renders a custom
513 /// fallback instead of the default error message.
514 ///
515 /// The fallback closure receives the panic message as a [`String`].
516 ///
517 /// # Example
518 ///
519 /// ```no_run
520 /// # slt::run(|ui: &mut slt::Context| {
521 /// ui.error_boundary_with(
522 /// |ui| {
523 /// ui.text("risky widget");
524 /// },
525 /// |ui, msg| {
526 /// ui.text(format!("Recovered from panic: {msg}"));
527 /// },
528 /// );
529 /// # });
530 /// ```
531 pub fn error_boundary_with(
532 &mut self,
533 f: impl FnOnce(&mut Context),
534 fallback: impl FnOnce(&mut Context, String),
535 ) {
536 let snapshot = ContextCheckpoint::capture(self);
537
538 let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| {
539 f(self);
540 }));
541
542 match result {
543 Ok(()) => {}
544 Err(panic_info) => {
545 if self.is_real_terminal {
546 #[cfg(feature = "crossterm")]
547 {
548 let _ = crossterm::terminal::enable_raw_mode();
549 let _ = crossterm::execute!(
550 std::io::stdout(),
551 crossterm::terminal::EnterAlternateScreen
552 );
553 }
554
555 #[cfg(not(feature = "crossterm"))]
556 {}
557 }
558
559 snapshot.restore(self);
560
561 let msg = if let Some(s) = panic_info.downcast_ref::<&str>() {
562 (*s).to_string()
563 } else if let Some(s) = panic_info.downcast_ref::<String>() {
564 s.clone()
565 } else {
566 "widget panicked".to_string()
567 };
568
569 fallback(self, msg);
570 }
571 }
572 }
573
574 /// Reserve the next interaction slot without emitting a marker command.
575 pub(crate) fn reserve_interaction_slot(&mut self) -> usize {
576 let id = self.rollback.interaction_count;
577 self.rollback.interaction_count += 1;
578 id
579 }
580
581 /// Advance the interaction counter for structural commands that still
582 /// participate in hit-map indexing.
583 pub(crate) fn skip_interaction_slot(&mut self) {
584 self.reserve_interaction_slot();
585 }
586
587 /// Issue #273: record a [`ContainerBuilder::cached`] region's version key
588 /// at its (declaration-ordered) call site and classify it as a hit or
589 /// miss versus the previous frame.
590 ///
591 /// Returns `true` if `version_key` matches the value this call site
592 /// recorded last frame (a hit), `false` on a key change, a brand-new slot,
593 /// the first frame, or after a resize (all misses).
594 ///
595 /// This is purely an *author-declared stability signal*: the caller still
596 /// re-runs its closure every frame, so output stays byte-identical and the
597 /// immediate-mode invariant is preserved exactly. The hit/miss result is
598 /// recorded for diagnostics ([`Context::region_cache_hits`] /
599 /// [`Context::region_cache_misses`]) and to give a future cell-level cache
600 /// a sound, principle-preserving gate. See the type-level docs on
601 /// [`ContainerBuilder::cached`] for the full design rationale.
602 pub(crate) fn record_cached_region(&mut self, version_key: u64) -> bool {
603 let idx = self.region_versions_cur.len();
604 let hit = self
605 .region_versions_prev
606 .get(idx)
607 .is_some_and(|&prev| prev == version_key);
608 self.region_versions_cur.push(version_key);
609 if hit {
610 self.region_cache_hits = self.region_cache_hits.saturating_add(1);
611 } else {
612 self.region_cache_misses = self.region_cache_misses.saturating_add(1);
613 }
614 hit
615 }
616
617 /// Number of [`ContainerBuilder::cached`] regions this frame whose version
618 /// key was unchanged from the previous frame (cache hits).
619 ///
620 /// Diagnostics for the opt-in streaming cache (issue #273). A region is a
621 /// hit when its author-supplied `version_key` matches the value the same
622 /// call site recorded last frame; it misses on a key change, a new call
623 /// site, the first frame, or after a terminal resize.
624 ///
625 /// Since 0.21.0.
626 ///
627 /// # Example
628 /// ```no_run
629 /// # slt::run(|ui: &mut slt::Context| {
630 /// ui.container().cached(42, |ui| {
631 /// ui.text("stable chrome");
632 /// });
633 /// let _hits = ui.region_cache_hits();
634 /// # });
635 /// ```
636 pub fn region_cache_hits(&self) -> u32 {
637 self.region_cache_hits
638 }
639
640 /// Number of [`ContainerBuilder::cached`] regions this frame whose version
641 /// key changed (or was new / first-frame / post-resize) — cache misses.
642 ///
643 /// The counterpart to [`Context::region_cache_hits`]. See issue #273.
644 ///
645 /// Since 0.21.0.
646 ///
647 /// # Example
648 /// ```no_run
649 /// # slt::run(|ui: &mut slt::Context| {
650 /// ui.container().cached(7, |ui| {
651 /// ui.text("chrome");
652 /// });
653 /// let _misses = ui.region_cache_misses();
654 /// # });
655 /// ```
656 pub fn region_cache_misses(&self) -> u32 {
657 self.region_cache_misses
658 }
659
660 /// Reserve the next interaction ID and emit a marker command.
661 pub(crate) fn next_interaction_id(&mut self) -> usize {
662 let id = self.reserve_interaction_slot();
663 self.commands.push(Command::InteractionMarker(id));
664 id
665 }
666
667 /// Allocate a click/hover interaction slot and return the [`Response`].
668 ///
669 /// Use this in custom widgets to detect mouse clicks and hovers without
670 /// wrapping content in a container. Call it immediately before the text,
671 /// rich text, link, or container that should own the interaction rect.
672 /// Each call reserves one slot in the hit-test map, so the call order
673 /// must be stable across frames.
674 pub fn interaction(&mut self) -> Response {
675 if (self.rollback.modal_active || self.prev_modal_active)
676 && self.rollback.overlay_depth == 0
677 {
678 return Response::none();
679 }
680 let id = self.next_interaction_id();
681 self.response_for(id)
682 }
683
684 /// Compute and consume the `(gained_focus, lost_focus)` edge flags for the
685 /// widget most recently registered via [`register_focusable`].
686 ///
687 /// If that focusable lined up with the previously-focused widget index from
688 /// the prior frame, the focus change since maps directly to gained/lost.
689 /// Takes (consumes) the `last_focusable_id` marker so a single
690 /// `register_focusable` powers exactly one transition computation.
691 ///
692 /// Shared by [`begin_widget_interaction`](Self::begin_widget_interaction)
693 /// and the widgets that assemble their `Response` by hand rather than
694 /// through it (`text_input`, `slider`, `number_input`) — issue #208 left
695 /// those three reporting `gained_focus`/`lost_focus` as always-false; this
696 /// closes that gap (v0.21.1).
697 pub(crate) fn focus_transitions(&mut self, focused: bool) -> (bool, bool) {
698 if let Some(this_id) = self.rollback.last_focusable_id.take() {
699 let was_focused = self
700 .prev_focus_index
701 .map(|prev| prev == this_id)
702 .unwrap_or(false);
703 (focused && !was_focused, !focused && was_focused)
704 } else {
705 (false, false)
706 }
707 }
708
709 pub(crate) fn begin_widget_interaction(&mut self, focused: bool) -> (usize, Response) {
710 let interaction_id = self.next_interaction_id();
711 let mut response = self.response_for(interaction_id);
712 response.focused = focused;
713 let (gained, lost) = self.focus_transitions(focused);
714 response.gained_focus = gained;
715 response.lost_focus = lost;
716 (interaction_id, response)
717 }
718
719 pub(crate) fn consume_indices<I>(&mut self, indices: I)
720 where
721 I: IntoIterator<Item = usize>,
722 {
723 for index in indices {
724 self.consumed[index] = true;
725 }
726 }
727
728 pub(crate) fn available_key_presses(
729 &self,
730 ) -> impl Iterator<Item = (usize, &crate::event::KeyEvent)> + '_ {
731 self.events.iter().enumerate().filter_map(|(i, event)| {
732 if self.consumed[i] {
733 return None;
734 }
735 match event {
736 Event::Key(key) if key.kind == KeyEventKind::Press => Some((i, key)),
737 _ => None,
738 }
739 })
740 }
741
742 pub(crate) fn available_pastes(&self) -> impl Iterator<Item = (usize, &str)> + '_ {
743 self.events.iter().enumerate().filter_map(|(i, event)| {
744 if self.consumed[i] {
745 return None;
746 }
747 match event {
748 Event::Paste(text) => Some((i, text.as_str())),
749 _ => None,
750 }
751 })
752 }
753
754 pub(crate) fn left_clicks_in_rect(
755 &self,
756 rect: Rect,
757 ) -> impl Iterator<Item = (usize, &crate::event::MouseEvent)> + '_ {
758 self.mouse_events_in_rect(rect).filter_map(|(i, mouse)| {
759 if matches!(mouse.kind, MouseKind::Down(MouseButton::Left)) {
760 Some((i, mouse))
761 } else {
762 None
763 }
764 })
765 }
766
767 pub(crate) fn mouse_events_in_rect(
768 &self,
769 rect: Rect,
770 ) -> impl Iterator<Item = (usize, &crate::event::MouseEvent)> + '_ {
771 self.events
772 .iter()
773 .enumerate()
774 .filter_map(move |(i, event)| {
775 if self.consumed[i] {
776 return None;
777 }
778
779 let Event::Mouse(mouse) = event else {
780 return None;
781 };
782
783 if mouse.x < rect.x
784 || mouse.x >= rect.right()
785 || mouse.y < rect.y
786 || mouse.y >= rect.bottom()
787 {
788 return None;
789 }
790
791 Some((i, mouse))
792 })
793 }
794
795 pub(crate) fn left_clicks_for_interaction(
796 &self,
797 interaction_id: usize,
798 ) -> Option<(Rect, Vec<(usize, &crate::event::MouseEvent)>)> {
799 let rect = self.prev_hit_map.get(interaction_id).copied()?;
800 let clicks = self.left_clicks_in_rect(rect).collect();
801 Some((rect, clicks))
802 }
803
804 pub(crate) fn consume_activation_keys(&mut self, focused: bool) -> bool {
805 if !focused {
806 return false;
807 }
808
809 // Activation keys (Enter / Space) are typically 0–1 per frame and
810 // bounded above by the simultaneous-keypress count from the input
811 // pipeline (well under 8 in practice). A `SmallVec` with an 8-slot
812 // inline capacity eliminates the per-focusable `Vec<usize>` heap
813 // allocation that showed up on every focused widget × every frame.
814 // Spillover beyond 8 falls back to the heap automatically. Closes #135.
815 let consumed: smallvec::SmallVec<[usize; 8]> = self
816 .available_key_presses()
817 .filter_map(|(i, key)| {
818 if matches!(key.code, KeyCode::Enter | KeyCode::Char(' ')) {
819 Some(i)
820 } else {
821 None
822 }
823 })
824 .collect();
825 let activated = !consumed.is_empty();
826 if activated {
827 // `consume_indices` takes `IntoIterator<Item = usize>` — `SmallVec`
828 // satisfies that bound directly, no signature change needed.
829 self.consume_indices(consumed);
830 }
831 activated
832 }
833
834 /// Register a widget as focusable and return whether it currently has focus.
835 ///
836 /// Call this in custom widgets that need keyboard focus. Each call increments
837 /// the internal focus counter, so the call order must be stable across frames.
838 ///
839 /// # Slot reservation by `register_focusable_named`
840 ///
841 /// If [`register_focusable_named`](Self::register_focusable_named) was
842 /// called immediately before this call, it has already allocated a
843 /// slot and bound a name to it; this call **reuses** that slot
844 /// instead of allocating a fresh one. That keeps the name binding
845 /// pointed at the widget the user sees rather than at a dummy slot.
846 pub fn register_focusable(&mut self) -> bool {
847 if (self.rollback.modal_active || self.prev_modal_active)
848 && self.rollback.overlay_depth == 0
849 {
850 self.rollback.last_focusable_id = None;
851 // Drop any pending reservation: the suppressed widget never
852 // attached, so reusing the reserved id from a later widget in
853 // the same frame would silently rebind the name to the wrong
854 // slot.
855 self.rollback.pending_focusable_id = None;
856 return false;
857 }
858 // Issue #217 follow-up: if `register_focusable_named` reserved a
859 // slot for us, reuse it (and skip the FocusMarker push — it was
860 // already emitted when the reservation was made). Otherwise,
861 // allocate a fresh slot the normal way.
862 let (id, freshly_allocated) =
863 if let Some(reserved) = self.rollback.pending_focusable_id.take() {
864 (reserved, false)
865 } else {
866 let id = self.rollback.focus_count;
867 self.rollback.focus_count += 1;
868 (id, true)
869 };
870 // Issue #208: remember this widget's focus id so the immediately
871 // following `begin_widget_interaction` call can compare against
872 // `prev_focus_index` and emit gained/lost focus signals.
873 self.rollback.last_focusable_id = Some(id);
874 if freshly_allocated {
875 self.commands.push(Command::FocusMarker(id));
876 }
877 if self.prev_modal_active
878 && self.prev_modal_focus_count > 0
879 && self.rollback.modal_active
880 && self.rollback.overlay_depth > 0
881 {
882 let mut modal_local_id = id.saturating_sub(self.rollback.modal_focus_start);
883 modal_local_id %= self.prev_modal_focus_count;
884 let mut modal_focus_idx = self.focus_index.saturating_sub(self.prev_modal_focus_start);
885 modal_focus_idx %= self.prev_modal_focus_count;
886 return modal_local_id == modal_focus_idx;
887 }
888 if self.prev_focus_count == 0 {
889 return true;
890 }
891 self.focus_index % self.prev_focus_count == id
892 }
893
894 /// Create persistent state that survives across frames.
895 ///
896 /// Returns a `State<T>` handle. Access with `state.get(ui)` / `state.get_mut(ui)`.
897 ///
898 /// # Rules
899 /// - Must be called in the same order every frame (like React hooks)
900 /// - Do NOT call inside if/else that changes between frames
901 ///
902 /// # Example
903 /// ```ignore
904 /// let count = ui.use_state(|| 0i32);
905 /// let val = count.get(ui);
906 /// ui.text(format!("Count: {val}"));
907 /// if ui.button("+1").clicked {
908 /// *count.get_mut(ui) += 1;
909 /// }
910 /// ```
911 pub fn use_state<T: 'static>(&mut self, init: impl FnOnce() -> T) -> State<T> {
912 let idx = self.rollback.hook_cursor;
913 self.rollback.hook_cursor += 1;
914
915 if idx >= self.hook_states.len() {
916 self.hook_states.push(Box::new(init()));
917 }
918
919 State::from_idx(idx)
920 }
921
922 /// Component-local persistent state keyed by a stable id.
923 ///
924 /// Unlike [`use_state`](Self::use_state), this is **not order-dependent** —
925 /// the value is looked up by `id` instead of call position. Safe to call
926 /// inside conditional branches or reusable component functions.
927 ///
928 /// Returns a `State<T>` handle. Access with `state.get(ui)` /
929 /// `state.get_mut(ui)`. Persists across frames.
930 ///
931 /// # Scoping
932 ///
933 /// Keys are `&'static str` and live in a single global namespace per
934 /// `Context` (no automatic per-component scoping). Two calls with the same
935 /// `id` in the same frame share the same value, regardless of where they
936 /// occur in the tree. Pick unique ids — for example, prefix with a
937 /// component name (`"counter::value"`).
938 ///
939 /// # Naming
940 ///
941 /// The no-suffix form takes an `init` closure, matching
942 /// [`use_state`](Self::use_state)`(init)` and
943 /// [`use_state_keyed`](Self::use_state_keyed)`(id, init)`. Use
944 /// [`use_state_named_default`](Self::use_state_named_default) for the
945 /// `T: Default` shorthand.
946 ///
947 /// # Example
948 ///
949 /// ```no_run
950 /// fn counter(ui: &mut slt::Context) {
951 /// let count = ui.use_state_named("counter::value", || 0i32);
952 /// ui.text(format!("Count: {}", count.get(ui)));
953 /// if ui.button("+1").clicked {
954 /// *count.get_mut(ui) += 1;
955 /// }
956 /// }
957 /// ```
958 pub fn use_state_named<T: 'static>(
959 &mut self,
960 id: &'static str,
961 init: impl FnOnce() -> T,
962 ) -> State<T> {
963 self.named_states
964 .entry(id)
965 .or_insert_with(|| Box::new(init()));
966 State::from_named(id)
967 }
968
969 /// Like [`use_state_named`](Self::use_state_named), but uses
970 /// [`Default::default()`] to initialize the value on first call.
971 ///
972 /// Mirrors [`use_state_keyed_default`](Self::use_state_keyed_default): the
973 /// `_default` suffix means "no init closure, `T: Default` required".
974 ///
975 /// # Example
976 ///
977 /// ```no_run
978 /// # slt::run(|ui: &mut slt::Context| {
979 /// let value = ui.use_state_named_default::<i32>("counter::value");
980 /// ui.text(format!("{}", value.get(ui)));
981 /// # });
982 /// ```
983 pub fn use_state_named_default<T: 'static + Default>(&mut self, id: &'static str) -> State<T> {
984 self.use_state_named(id, T::default)
985 }
986
987 /// Deprecated alias for [`use_state_named`](Self::use_state_named).
988 ///
989 /// **Deprecated since 0.21.0**: the `_named` family now follows the
990 /// "no-suffix = init closure" convention so it matches
991 /// [`use_state`](Self::use_state) and
992 /// [`use_state_keyed`](Self::use_state_keyed). The init-closure form is now
993 /// spelled `use_state_named(id, init)`; the `T: Default` shorthand is
994 /// [`use_state_named_default`](Self::use_state_named_default).
995 ///
996 /// # Example
997 ///
998 /// ```no_run
999 /// # slt::run(|ui: &mut slt::Context| {
1000 /// // Old: ui.use_state_named_with("counter::value", || 0i32)
1001 /// let count = ui.use_state_named("counter::value", || 0i32);
1002 /// ui.text(format!("{}", count.get(ui)));
1003 /// # });
1004 /// ```
1005 #[deprecated(
1006 since = "0.21.0",
1007 note = "Renamed to `use_state_named` — the no-suffix form now takes the init closure, matching `use_state` / `use_state_keyed`."
1008 )]
1009 pub fn use_state_named_with<T: 'static>(
1010 &mut self,
1011 id: &'static str,
1012 init: impl FnOnce() -> T,
1013 ) -> State<T> {
1014 self.use_state_named(id, init)
1015 }
1016
1017 /// Smoothly animate between `0.0` and `1.0` driven by a boolean.
1018 ///
1019 /// Returns the current interpolated value (0.0..=1.0). When `value` is
1020 /// `true` the result tweens toward `1.0`; when `false` it tweens back
1021 /// toward `0.0`. The transition duration defaults to
1022 /// [`DEFAULT_ANIMATE_TICKS`](crate::anim::DEFAULT_ANIMATE_TICKS) (12 ticks
1023 /// ≈ 200 ms at 60 Hz). Use [`Context::animate_value`] for custom duration
1024 /// or non-binary targets.
1025 ///
1026 /// State is stored in the per-context named-state map under `id`. The
1027 /// id is `&'static str` (single global namespace per context), matching
1028 /// [`Context::use_state_named`]. Pick a unique key per call site — two
1029 /// `animate_bool` calls with the same id share state.
1030 ///
1031 /// On the first call, the value snaps to the target with no visible
1032 /// transition (so widgets that mount in their final state don't pop).
1033 ///
1034 /// # Example
1035 /// ```ignore
1036 /// let opacity = ui.animate_bool("sidebar::visible", is_open);
1037 /// // 0.0 ≤ opacity ≤ 1.0; use as alpha or visibility threshold.
1038 /// ```
1039 ///
1040 /// # See also
1041 ///
1042 /// - [`animate_value`](Self::animate_value) — the underlying primitive this
1043 /// delegates to; use it for a custom duration or a non-binary target.
1044 /// - [`Tween`](crate::Tween) — full control over easing and lifecycle.
1045 pub fn animate_bool(&mut self, id: &'static str, value: bool) -> f64 {
1046 let target = if value { 1.0 } else { 0.0 };
1047 self.animate_value(id, target, crate::anim::DEFAULT_ANIMATE_TICKS)
1048 }
1049
1050 /// Smoothly animate a `f64` value toward `target` over `duration_ticks`.
1051 ///
1052 /// Uses a linear-easing [`crate::Tween`] stored implicitly in the
1053 /// per-context named-state map under `id`. Returns the current
1054 /// interpolated value. On the first call the value snaps to `target`
1055 /// with no visible transition; on subsequent calls when `target`
1056 /// changes the tween is rebuilt starting from the current interpolated
1057 /// value, so retargeting mid-flight does not produce a jump.
1058 ///
1059 /// `duration_ticks == 0` snaps immediately to the new target.
1060 ///
1061 /// # Panics
1062 ///
1063 /// Panics if `id` is already bound in the named-state map to a value of a
1064 /// different type (e.g. a [`use_state_named`](Self::use_state_named) call
1065 /// reused the same id), since the stored entry then fails to downcast to
1066 /// the internal animation state:
1067 ///
1068 /// ```text
1069 /// animate_value: id {id} is already used for a different state type
1070 /// ```
1071 ///
1072 /// Pick a unique id per call site to avoid the collision.
1073 ///
1074 /// # Example
1075 /// ```ignore
1076 /// let bar_height = ui.animate_value("loading::bar", target_height, 30);
1077 /// ui.bar(bar_height);
1078 /// ```
1079 ///
1080 /// # Comparison with `Tween`
1081 /// Use this shorthand when you want zero boilerplate and linear easing
1082 /// is acceptable. For custom easing, a non-static key, or
1083 /// non-tick-based control, construct a [`crate::Tween`] explicitly via
1084 /// [`Context::use_state_named`](Self::use_state_named).
1085 ///
1086 /// # See also
1087 ///
1088 /// - [`animate_bool`](Self::animate_bool) — boolean-driven shorthand that
1089 /// tweens between `0.0` and `1.0`.
1090 /// - [`Tween`](crate::Tween) — explicit easing and lifecycle control.
1091 pub fn animate_value(&mut self, id: &'static str, target: f64, duration_ticks: u64) -> f64 {
1092 let tick = self.tick;
1093 let entry = self
1094 .named_states
1095 .entry(id)
1096 .or_insert_with(|| Box::new(crate::anim::AnimState::new(target, tick)));
1097 let state = entry
1098 .downcast_mut::<crate::anim::AnimState>()
1099 .unwrap_or_else(|| {
1100 panic!(
1101 "animate_value: id {:?} is already used for a different state type",
1102 id
1103 )
1104 });
1105 state.sample(target, duration_ticks, tick)
1106 }
1107
1108 /// One-shot frame-clock timer (issue #248).
1109 ///
1110 /// Returns `true` exactly once — on the first frame at or after `dur` has
1111 /// elapsed since the first `schedule` call for `id` — and `false` on every
1112 /// other frame, both before and after. Re-arm by calling
1113 /// [`cancel`](Self::cancel) and then `schedule` again.
1114 ///
1115 /// Wall-clock based ([`std::time::Instant`] sampled once at frame start),
1116 /// so it works with the default feature set and without the `async`
1117 /// feature. Precision is bounded by the run loop's `tick_rate` (the
1118 /// deadline is observed on the next frame after it elapses), so durations
1119 /// well below the frame cadence are not meaningful.
1120 ///
1121 /// The id lives in the same per-context namespace as
1122 /// [`use_state_named`](Self::use_state_named): pick a unique key per call
1123 /// site.
1124 ///
1125 /// # Example
1126 /// ```no_run
1127 /// use std::time::Duration;
1128 ///
1129 /// slt::run(|ui: &mut slt::Context| {
1130 /// if ui.schedule("splash::dismiss", Duration::from_millis(800)) {
1131 /// // Runs once, ~800ms after the first frame that called this.
1132 /// ui.text("Splash dismissed.");
1133 /// }
1134 /// })?;
1135 /// # Ok::<_, std::io::Error>(())
1136 /// ```
1137 pub fn schedule(&mut self, id: &'static str, dur: std::time::Duration) -> bool {
1138 let now = self.frame_instant;
1139 let slot = self
1140 .scheduler
1141 .named
1142 .entry(id)
1143 .or_insert_with(|| SchedulerSlot {
1144 started: now,
1145 kind: SchedKind::Once {
1146 deadline: now + dur,
1147 fired: false,
1148 },
1149 touched_this_frame: false,
1150 });
1151 slot.touched_this_frame = true;
1152 match &mut slot.kind {
1153 SchedKind::Once { deadline, fired } if !*fired && now >= *deadline => {
1154 *fired = true;
1155 true
1156 }
1157 // Not yet due, already fired, or a re-used id bound to a different
1158 // timer kind: do not fire (a typo can't crash the app).
1159 _ => false,
1160 }
1161 }
1162
1163 /// Recurring frame-clock timer (issue #248).
1164 ///
1165 /// Returns the number of whole `dur` intervals that elapsed since the
1166 /// previous frame this `id` was sampled: `0` on most frames, `1` typically,
1167 /// and `> 1` if the frame loop stalled past several intervals — so no ticks
1168 /// are silently dropped. The internal clock advances by exactly the
1169 /// returned number of intervals each frame, so counts never drift.
1170 ///
1171 /// Wall-clock based and `async`-free, like [`schedule`](Self::schedule).
1172 ///
1173 /// # Example
1174 /// ```no_run
1175 /// use std::time::Duration;
1176 ///
1177 /// slt::run(|ui: &mut slt::Context| {
1178 /// let ticks = ui.every("clock::second", Duration::from_secs(1));
1179 /// if ticks > 0 {
1180 /// // Advance a once-per-second animation by `ticks` steps.
1181 /// }
1182 /// })?;
1183 /// # Ok::<_, std::io::Error>(())
1184 /// ```
1185 pub fn every(&mut self, id: &'static str, dur: std::time::Duration) -> u32 {
1186 let now = self.frame_instant;
1187 let interval = dur.max(std::time::Duration::from_nanos(1));
1188 let slot = self
1189 .scheduler
1190 .named
1191 .entry(id)
1192 .or_insert_with(|| SchedulerSlot {
1193 started: now,
1194 kind: SchedKind::Every {
1195 interval,
1196 last: now,
1197 },
1198 touched_this_frame: false,
1199 });
1200 slot.touched_this_frame = true;
1201 match &mut slot.kind {
1202 SchedKind::Every { interval, last } => {
1203 let elapsed = now.saturating_duration_since(*last);
1204 let fired = crate::widgets::intervals_elapsed(elapsed, *interval);
1205 if fired > 0 {
1206 // Advance by exactly the intervals reported so counts never
1207 // drift, even across stalled frames.
1208 *last += *interval * fired;
1209 }
1210 fired
1211 }
1212 _ => 0,
1213 }
1214 }
1215
1216 /// Debounce timer — the typeahead / search-as-you-type primitive (#248).
1217 ///
1218 /// Each frame where `dirty == true` resets the quiet window to `dur`.
1219 /// Returns `true` exactly once on the first frame after `dur` of quiet (no
1220 /// `dirty`), then stays `false` until the next dirty frame re-arms it. This
1221 /// mirrors Textual's `@work(exclusive=True)` debounce: collapse a burst of
1222 /// keystrokes so only the final, settled query runs.
1223 ///
1224 /// Wall-clock based and `async`-free, like [`schedule`](Self::schedule).
1225 ///
1226 /// # Example
1227 /// ```no_run
1228 /// use std::time::Duration;
1229 /// use slt::TextInputState;
1230 ///
1231 /// let mut query = TextInputState::with_placeholder("Search...");
1232 /// slt::run(move |ui: &mut slt::Context| {
1233 /// // `resp.changed` is true on the keystroke frame -> the dirty signal.
1234 /// let resp = ui.text_input(&mut query);
1235 /// // Fire the search only after 250ms of no typing.
1236 /// if ui.debounce("search::run", Duration::from_millis(250), resp.changed) {
1237 /// // run_search(&query.value());
1238 /// }
1239 /// })?;
1240 /// # Ok::<_, std::io::Error>(())
1241 /// ```
1242 pub fn debounce(&mut self, id: &'static str, dur: std::time::Duration, dirty: bool) -> bool {
1243 let now = self.frame_instant;
1244 let slot = self
1245 .scheduler
1246 .named
1247 .entry(id)
1248 .or_insert_with(|| SchedulerSlot {
1249 started: now,
1250 kind: SchedKind::Debounce {
1251 dur,
1252 deadline: now + dur,
1253 fired: false,
1254 },
1255 touched_this_frame: false,
1256 });
1257 slot.touched_this_frame = true;
1258 match &mut slot.kind {
1259 SchedKind::Debounce {
1260 dur: slot_dur,
1261 deadline,
1262 fired,
1263 } => {
1264 *slot_dur = dur;
1265 if dirty {
1266 // Re-arm the quiet window from this frame.
1267 *deadline = now + dur;
1268 *fired = false;
1269 false
1270 } else if !*fired && now >= *deadline {
1271 *fired = true;
1272 true
1273 } else {
1274 false
1275 }
1276 }
1277 _ => false,
1278 }
1279 }
1280
1281 /// Exclusive-group claim — cancel stale work on supersede (issue #248).
1282 ///
1283 /// Within a `group`, only the most-recently-claimed `id` returns `true`;
1284 /// once a newer `id` claims the group, every prior `id` returns `false`
1285 /// from then on. Use it to cancel an in-flight typeahead query when a newer
1286 /// query supersedes it: pair with [`debounce`](Self::debounce) to fire the
1287 /// settled query, then guard the work with `exclusive` so only the latest
1288 /// claim proceeds.
1289 ///
1290 /// # Example
1291 /// ```no_run
1292 /// use std::time::Duration;
1293 ///
1294 /// slt::run(|ui: &mut slt::Context| {
1295 /// let query_id = "q-42"; // e.g. a per-keystroke sequence id
1296 /// if ui.exclusive("search", query_id) {
1297 /// // Only the latest claimed query runs; older ones are cancelled.
1298 /// }
1299 /// })?;
1300 /// # Ok::<_, std::io::Error>(())
1301 /// ```
1302 pub fn exclusive(&mut self, group: &'static str, id: &str) -> bool {
1303 let entry = self
1304 .scheduler
1305 .exclusive
1306 .entry(group.to_string())
1307 .or_default();
1308 if entry.winner == id {
1309 // The reigning claim re-polls itself: still the winner.
1310 return true;
1311 }
1312 if entry.retired.contains(id) {
1313 // A previously-superseded id can never win again: stale work stays
1314 // cancelled even if re-polled.
1315 return false;
1316 }
1317 // A new id supersedes the group: retire the old winner (if any) and
1318 // become the active claim.
1319 if !entry.winner.is_empty() {
1320 let old = std::mem::take(&mut entry.winner);
1321 entry.retired.insert(old);
1322 }
1323 entry.winner = id.to_string();
1324 true
1325 }
1326
1327 /// Drop the scheduler slot for `id`, re-arming it on the next
1328 /// [`schedule`](Self::schedule) / [`every`](Self::every) /
1329 /// [`debounce`](Self::debounce) call (issue #248).
1330 ///
1331 /// Accepts both `&'static str` and runtime-`String` ids: clears the slot
1332 /// from the named map and the dynamic-id map.
1333 ///
1334 /// # Example
1335 /// ```no_run
1336 /// use std::time::Duration;
1337 ///
1338 /// slt::run(|ui: &mut slt::Context| {
1339 /// if ui.schedule("retry", Duration::from_secs(5)) {
1340 /// // ...
1341 /// }
1342 /// if ui.key('r') {
1343 /// ui.cancel("retry"); // next `schedule("retry", ..)` starts fresh
1344 /// }
1345 /// })?;
1346 /// # Ok::<_, std::io::Error>(())
1347 /// ```
1348 pub fn cancel(&mut self, id: &str) {
1349 self.scheduler.named.remove(id);
1350 self.scheduler.keyed.remove(id);
1351 }
1352
1353 /// Wall-clock time elapsed since `id` was first scheduled, or `None` if no
1354 /// live timer slot exists for `id` (issue #248).
1355 ///
1356 /// Useful for progress UIs ("retrying in 3s…") that want the raw elapsed
1357 /// duration rather than a fire/no-fire signal. Measured against the same
1358 /// frame instant the timer methods use.
1359 ///
1360 /// # Example
1361 /// ```no_run
1362 /// use std::time::Duration;
1363 ///
1364 /// slt::run(|ui: &mut slt::Context| {
1365 /// ui.schedule("upload", Duration::from_secs(30));
1366 /// if let Some(elapsed) = ui.elapsed("upload") {
1367 /// ui.text(format!("Uploading for {}s", elapsed.as_secs()));
1368 /// }
1369 /// })?;
1370 /// # Ok::<_, std::io::Error>(())
1371 /// ```
1372 pub fn elapsed(&self, id: &str) -> Option<std::time::Duration> {
1373 let started = self
1374 .scheduler
1375 .named
1376 .get(id)
1377 .or_else(|| self.scheduler.keyed.get(id))
1378 .map(|slot| slot.started)?;
1379 Some(self.frame_instant.saturating_duration_since(started))
1380 }
1381
1382 /// Push a value onto the context stack for the duration of `body`.
1383 ///
1384 /// Inside `body`, child widgets can call
1385 /// [`use_context::<T>()`](Self::use_context) or
1386 /// [`try_use_context::<T>()`](Self::try_use_context) to look up the
1387 /// nearest provided value of type `T`. Provides cascade in LIFO order:
1388 /// nested calls with the same `T` shadow outer ones.
1389 ///
1390 /// The value is automatically popped when `body` returns — including on
1391 /// panic, so the context stack is always restored.
1392 ///
1393 /// # Example
1394 ///
1395 /// ```ignore
1396 /// struct Theme { accent: slt::Color }
1397 /// ui.provide(Theme { accent: slt::Color::Red }, |ui| {
1398 /// // Any widget here can `let theme = ui.use_context::<Theme>();`
1399 /// render_button(ui);
1400 /// });
1401 /// ```
1402 pub fn provide<T: 'static, R>(&mut self, value: T, body: impl FnOnce(&mut Context) -> R) -> R {
1403 self.context_stack
1404 .push(Box::new(value) as Box<dyn std::any::Any>);
1405
1406 // catch_unwind ensures the entry is popped even if `body` panics, so
1407 // the context stack is never left with leaked frames. We re-panic
1408 // afterwards so the panic propagates normally to outer scopes.
1409 let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| body(self)));
1410
1411 // Pop in both success and panic paths.
1412 self.context_stack.pop();
1413
1414 match result {
1415 Ok(value) => value,
1416 Err(panic) => std::panic::resume_unwind(panic),
1417 }
1418 }
1419
1420 /// Spawn a fire-and-forget async task from inside the frame closure.
1421 ///
1422 /// Returns a [`TaskHandle<T>`](crate::TaskHandle) you store and pass to
1423 /// [`poll`](Self::poll) on later frames to retrieve the result. This closes
1424 /// the ergonomics gap of the channel pattern (`run_async` + an external
1425 /// `Sender`) for the common case: "click a button, kick off one async call,
1426 /// show its result next frame" — without wiring a channel yourself.
1427 ///
1428 /// **Dropping the returned handle cancels the in-flight task.** Keep it
1429 /// alive (e.g. in `use_state`) for as long as you care about the result.
1430 /// Each handle carries a unique id, so two `TaskHandle<String>` live at the
1431 /// same time never cross their results.
1432 ///
1433 /// Requires the `async` feature and an active Tokio runtime — call it
1434 /// inside [`run_async`](crate::run_async) /
1435 /// [`run_async_with`](crate::run_async_with), which inject the runtime
1436 /// handle.
1437 ///
1438 /// # Panics
1439 ///
1440 /// Panics if no Tokio runtime was injected (e.g. when called from the sync
1441 /// [`run`](crate::run) loop or `TestBackend` without a runtime).
1442 ///
1443 /// # Example
1444 ///
1445 /// ```no_run
1446 /// # #[cfg(feature = "async")]
1447 /// # async fn run() -> std::io::Result<()> {
1448 /// use slt::{Context, RunConfig, TaskHandle};
1449 ///
1450 /// async fn fetch() -> String {
1451 /// // e.g. an HTTP request
1452 /// "result".to_string()
1453 /// }
1454 ///
1455 /// slt::run_async_with(RunConfig::default(), |ui: &mut Context, _: &mut Vec<()>| {
1456 /// // One handle, stored across frames via `use_state`.
1457 /// let handle = ui.use_state(|| None::<TaskHandle<String>>);
1458 ///
1459 /// if ui.button("Fetch").clicked && handle.get(ui).is_none() {
1460 /// *handle.get_mut(ui) = Some(ui.spawn(async { fetch().await }));
1461 /// }
1462 ///
1463 /// // Take the handle out of state to poll it: `ui.poll` needs `&mut ui`,
1464 /// // which cannot coexist with a `&TaskHandle` borrowed from `ui`'s own
1465 /// // state. Put it back if the task is still pending.
1466 /// if let Some(h) = handle.get_mut(ui).take() {
1467 /// match ui.poll(&h) {
1468 /// Some(result) => {
1469 /// ui.text(format!("Got: {result}"));
1470 /// }
1471 /// None => {
1472 /// *handle.get_mut(ui) = Some(h);
1473 /// ui.text("Loading...");
1474 /// }
1475 /// }
1476 /// }
1477 /// })?;
1478 /// # Ok(())
1479 /// # }
1480 /// ```
1481 #[cfg(feature = "async")]
1482 pub fn spawn<T: Send + 'static>(
1483 &mut self,
1484 fut: impl std::future::Future<Output = T> + Send + 'static,
1485 ) -> TaskHandle<T> {
1486 self.async_tasks.spawn(fut)
1487 }
1488
1489 /// Poll a [`TaskHandle`](crate::TaskHandle) for its result.
1490 ///
1491 /// Returns `Some(result)` exactly once — on the first frame after the task
1492 /// completes — then `None` on every subsequent call. Returns `None` while
1493 /// the task is still in flight.
1494 ///
1495 /// Pairs with [`spawn`](Self::spawn). Requires the `async` feature.
1496 ///
1497 /// # Example
1498 ///
1499 /// ```no_run
1500 /// # #[cfg(feature = "async")]
1501 /// # fn ex(ui: &mut slt::Context, handle: &slt::TaskHandle<u32>) {
1502 /// if let Some(value) = ui.poll(handle) {
1503 /// ui.text(format!("done: {value}"));
1504 /// }
1505 /// # }
1506 /// ```
1507 #[cfg(feature = "async")]
1508 pub fn poll<T: 'static>(&mut self, handle: &TaskHandle<T>) -> Option<T> {
1509 self.async_tasks.poll::<T>(handle.id())
1510 }
1511
1512 /// Look up the nearest provided value of type `T` on the context stack.
1513 ///
1514 /// Searches from the top of the stack (most-recent
1515 /// [`provide`](Self::provide)) downward. Returns the first match.
1516 ///
1517 /// # Panics
1518 ///
1519 /// Panics if no value of type `T` is currently provided. Use
1520 /// [`try_use_context`](Self::try_use_context) for a non-panicking variant.
1521 pub fn use_context<T: 'static>(&self) -> &T {
1522 self.try_use_context::<T>().unwrap_or_else(|| {
1523 panic!(
1524 "no context of type {} was provided; use ui.provide(value, |ui| ...) in a parent scope",
1525 std::any::type_name::<T>()
1526 )
1527 })
1528 }
1529
1530 /// Like [`use_context`](Self::use_context), but returns `None` instead of
1531 /// panicking when no value of type `T` is on the stack.
1532 pub fn try_use_context<T: 'static>(&self) -> Option<&T> {
1533 self.context_stack
1534 .iter()
1535 .rev()
1536 .find_map(|entry| entry.downcast_ref::<T>())
1537 }
1538
1539 /// Memoize a computed value. Recomputes only when `deps` changes.
1540 ///
1541 /// Returns a [`Memo<T>`] *index handle*, mirroring [`use_state`]'s
1542 /// [`State<T>`]. The handle holds **no** borrow of `ui`, so it composes with
1543 /// later `ui.*` calls — read the value on demand with `.get(ui)` /
1544 /// `.copied(ui)`.
1545 ///
1546 /// Before v0.21.0 this returned `&T`, a live borrow of `&mut Context` that
1547 /// could not be held across subsequent `ui.*` mutations. That form is now
1548 /// [`use_memo_ref`](Self::use_memo_ref) (deprecated). Migrate
1549 /// `let x = *ui.use_memo(&d, f);` to `let x = ui.use_memo(&d, f).copied(ui);`.
1550 ///
1551 /// [`use_state`]: Self::use_state
1552 ///
1553 /// # Panics
1554 ///
1555 /// Panics if the hook slot at this call position was previously used for a
1556 /// different hook (a rules-of-hooks / call-order violation), since the
1557 /// type-erased slot then fails to downcast to `MemoSlot<T>`:
1558 ///
1559 /// ```text
1560 /// Hook type mismatch at index {idx}: expected {type}. Hooks must be called in the same order every frame.
1561 /// ```
1562 ///
1563 /// Keep hook calls in the same order every frame — do not call this inside
1564 /// an `if`/`else` whose branch changes between frames.
1565 ///
1566 /// # Example
1567 /// ```no_run
1568 /// # slt::run(|ui: &mut slt::Context| {
1569 /// let count = ui.use_state(|| 0i32);
1570 /// let count_val = *count.get(ui);
1571 /// let doubled = ui.use_memo(&count_val, |c| c * 2);
1572 /// // The handle survives an intervening `ui.*` call (this is the whole point).
1573 /// ui.text("doubled:");
1574 /// ui.text(format!("{}", doubled.copied(ui)));
1575 /// # });
1576 /// ```
1577 pub fn use_memo<T: 'static, D: PartialEq + Clone + 'static>(
1578 &mut self,
1579 deps: &D,
1580 compute: impl FnOnce(&D) -> T,
1581 ) -> Memo<T> {
1582 let idx = self.rollback.hook_cursor;
1583 self.rollback.hook_cursor += 1;
1584
1585 // First call at this slot: allocate fresh state. Deps are stored
1586 // type-erased so the read path (`Memo::get`) can downcast `MemoSlot<T>`
1587 // without restating `D`.
1588 if idx >= self.hook_states.len() {
1589 self.hook_states.push(Box::new(MemoSlot {
1590 deps: Box::new(deps.clone()),
1591 value: compute(deps),
1592 }));
1593 return Memo::from_idx(idx);
1594 }
1595
1596 // Slot already exists: it must be the same `MemoSlot<T>` shape we used
1597 // last frame, or the caller broke the rules-of-hooks contract.
1598 match self.hook_states[idx].downcast_mut::<MemoSlot<T>>() {
1599 Some(slot) => {
1600 // Compare against the previous (type-erased) deps. A failed
1601 // downcast of the stored deps to `&D` is treated as stale so the
1602 // value is recomputed rather than silently kept.
1603 let stale = slot
1604 .deps
1605 .downcast_ref::<D>()
1606 .map(|prev| *prev != *deps)
1607 .unwrap_or(true);
1608 if stale {
1609 slot.deps = Box::new(deps.clone());
1610 slot.value = compute(deps);
1611 }
1612 }
1613 None => panic!(
1614 "Hook type mismatch at index {}: expected {}. Hooks must be called in the same order every frame.",
1615 idx,
1616 std::any::type_name::<MemoSlot<T>>()
1617 ),
1618 }
1619 Memo::from_idx(idx)
1620 }
1621
1622 /// Deprecated `&T`-returning form of [`use_memo`](Self::use_memo).
1623 ///
1624 /// **Deprecated since 0.21.0**: [`use_memo`](Self::use_memo) now returns a
1625 /// [`Memo<T>`] handle that does not borrow `ui`, so it composes with later
1626 /// `ui.*` calls. This alias preserves the original behaviour (returning a
1627 /// `&T` borrow of `ui`) for callers that cannot migrate immediately; the
1628 /// borrow keeps `ui` immutably borrowed until the reference is dropped.
1629 ///
1630 /// Migrate `let x = *ui.use_memo_ref(&d, f);` to
1631 /// `let x = ui.use_memo(&d, f).copied(ui);` (or `.get(ui)` for a reference).
1632 ///
1633 /// # Panics
1634 ///
1635 /// Panics if the hook slot at this call position was previously used for a
1636 /// different hook (a rules-of-hooks / call-order violation), since the
1637 /// type-erased slot then fails to downcast to `(D, T)`:
1638 ///
1639 /// ```text
1640 /// Hook type mismatch at index {idx}: expected {type}. Hooks must be called in the same order every frame.
1641 /// ```
1642 ///
1643 /// # Example
1644 /// ```no_run
1645 /// # slt::run(|ui: &mut slt::Context| {
1646 /// # #[allow(deprecated)]
1647 /// let doubled = *ui.use_memo_ref(&21i32, |c| c * 2);
1648 /// ui.text(format!("{doubled}"));
1649 /// # });
1650 /// ```
1651 #[deprecated(
1652 since = "0.21.0",
1653 note = "use_memo now returns a Memo<T> handle; call `.get(ui)` / `.copied(ui)`"
1654 )]
1655 pub fn use_memo_ref<T: 'static, D: PartialEq + Clone + 'static>(
1656 &mut self,
1657 deps: &D,
1658 compute: impl FnOnce(&D) -> T,
1659 ) -> &T {
1660 let idx = self.rollback.hook_cursor;
1661 self.rollback.hook_cursor += 1;
1662
1663 // First call at this slot: allocate fresh state.
1664 if idx >= self.hook_states.len() {
1665 let value = compute(deps);
1666 self.hook_states.push(Box::new((deps.clone(), value)));
1667 return self.hook_states[idx]
1668 .downcast_ref::<(D, T)>()
1669 .map(|(_, v)| v)
1670 .expect("freshly inserted slot must downcast to its own type");
1671 }
1672
1673 // Slot already exists: it must be the same `(D, T)` shape we used last
1674 // frame, or the caller broke the rules-of-hooks contract.
1675 //
1676 // Single downcast on the cache-hit path (closes #133): use
1677 // `downcast_mut` to update deps/value in place when they change, and
1678 // return `&stored.1` directly — eliminating the redundant second
1679 // `downcast_ref` that ran on every call regardless of cache state.
1680 match self.hook_states[idx].downcast_mut::<(D, T)>() {
1681 Some(stored) => {
1682 if stored.0 != *deps {
1683 stored.0 = deps.clone();
1684 stored.1 = compute(deps);
1685 }
1686 &stored.1
1687 }
1688 None => panic!(
1689 "Hook type mismatch at index {}: expected {}. Hooks must be called in the same order every frame.",
1690 idx,
1691 std::any::type_name::<(D, T)>()
1692 ),
1693 }
1694 }
1695
1696 /// Returns `light` color if current theme is light mode, `dark` color if dark mode.
1697 pub fn light_dark(&self, light: Color, dark: Color) -> Color {
1698 if self.theme.is_dark {
1699 dark
1700 } else {
1701 light
1702 }
1703 }
1704
1705 /// Show a toast notification without managing ToastState.
1706 ///
1707 /// # Examples
1708 /// ```
1709 /// # use slt::*;
1710 /// # TestBackend::new(80, 24).render(|ui| {
1711 /// ui.notify("File saved!", ToastLevel::Success);
1712 /// # });
1713 /// ```
1714 pub fn notify(&mut self, message: &str, level: ToastLevel) {
1715 let tick = self.tick;
1716 self.rollback
1717 .notification_queue
1718 .push((message.to_string(), level, tick));
1719 }
1720
1721 pub(crate) fn render_notifications(&mut self) {
1722 let tick = self.tick;
1723 self.rollback
1724 .notification_queue
1725 .retain(|(_, _, created)| tick.saturating_sub(*created) < 180);
1726 if self.rollback.notification_queue.is_empty() {
1727 return;
1728 }
1729
1730 // The `overlay` closure captures `self` mutably, so we cannot keep an
1731 // immutable borrow of `self.rollback.notification_queue` alive across
1732 // the call. Move the queue out for the render, then move it back —
1733 // no `String::clone` per notification, no intermediate `Vec` alloc.
1734 // Closes the non-empty path of #138.
1735 let queue = std::mem::take(&mut self.rollback.notification_queue);
1736 let theme = self.theme;
1737
1738 let _ = self.overlay(|ui| {
1739 let _ = ui.row(|ui| {
1740 ui.spacer();
1741 let _ = ui.col(|ui| {
1742 for (message, level, _) in queue.iter().rev() {
1743 let color = match level {
1744 ToastLevel::Info => theme.primary,
1745 ToastLevel::Success => theme.success,
1746 ToastLevel::Warning => theme.warning,
1747 ToastLevel::Error => theme.error,
1748 };
1749 let mut line = String::with_capacity(2 + message.len());
1750 line.push_str("● ");
1751 line.push_str(message);
1752 ui.styled(line, Style::new().fg(color));
1753 }
1754 });
1755 });
1756 });
1757
1758 // Restore the queue so subsequent frames can re-render until each
1759 // entry's TTL expires above.
1760 self.rollback.notification_queue = queue;
1761 }
1762
1763 // ----------------------------------------------------------------
1764 // v0.20.0 hooks: keyed state, effects, named focus, key gating
1765 // ----------------------------------------------------------------
1766
1767 /// Component-local persistent state keyed by a runtime string.
1768 ///
1769 /// Unlike [`use_state_named`](Self::use_state_named), `id` can be a
1770 /// runtime value such as `format!("row-{i}")`. The key is converted to
1771 /// `String` once per call. The hot path (key already present) performs
1772 /// **zero string allocations beyond the [`Into<String>`] conversion at
1773 /// the call site** — first looking up by `&str`, only allocating a
1774 /// fresh map key on first insert. Together: at most **one allocation
1775 /// per call, regardless of cache state**.
1776 ///
1777 /// # When to use
1778 /// - Per-item state in a dynamic list where positional [`use_state`]
1779 /// would break if items are reordered or filtered.
1780 /// - Reusable component functions called with a runtime discriminator.
1781 ///
1782 /// # Namespace
1783 /// Keys live in a single global namespace per `Context`. Prefix them
1784 /// to avoid collisions: `format!("my_component::item-{i}")`.
1785 ///
1786 /// # Stale entries
1787 /// Removed items leak their state until the `Context` is dropped (or
1788 /// the program exits). For long-running sessions with churn, manage
1789 /// state externally via a single `Vec<T>` in [`use_state`].
1790 ///
1791 /// # Example
1792 ///
1793 /// ```ignore
1794 /// for (i, item) in items.iter().enumerate() {
1795 /// let row_state = ui.use_state_keyed(format!("row-{i}"), || ItemState::default());
1796 /// // ...
1797 /// }
1798 /// ```
1799 ///
1800 /// [`use_state`]: Self::use_state
1801 pub fn use_state_keyed<T: 'static>(
1802 &mut self,
1803 id: impl Into<String>,
1804 init: impl FnOnce() -> T,
1805 ) -> State<T> {
1806 let key: String = id.into();
1807 // Lookup by `&str` first to avoid cloning on the hot
1808 // (already-populated) path. Only on first insert do we clone the
1809 // key into the map; otherwise the original `key` String is the
1810 // sole allocation and is moved into `State::from_keyed`.
1811 if !self.keyed_states.contains_key(key.as_str()) {
1812 self.keyed_states.insert(key.clone(), Box::new(init()));
1813 }
1814 State::from_keyed(key)
1815 }
1816
1817 /// Like [`use_state_keyed`](Self::use_state_keyed), but uses
1818 /// [`Default::default()`] to initialize the value on first call.
1819 ///
1820 /// # Example
1821 ///
1822 /// ```ignore
1823 /// let counter = ui.use_state_keyed_default::<i32>(format!("c-{i}"));
1824 /// ```
1825 pub fn use_state_keyed_default<T: Default + 'static>(
1826 &mut self,
1827 id: impl Into<String>,
1828 ) -> State<T> {
1829 self.use_state_keyed(id, T::default)
1830 }
1831
1832 /// Run a side-effecting closure when `deps` changes.
1833 ///
1834 /// On the **first frame** the hook slot is encountered, `f` is called
1835 /// unconditionally. On **subsequent frames**, `f` is only called when
1836 /// `*deps != stored_deps`. The hook is **positional** (same ordering
1837 /// rules as [`use_state`](Self::use_state)).
1838 ///
1839 /// # Fire-and-forget semantics
1840 ///
1841 /// There is no cleanup callback. If setup resources need teardown,
1842 /// store a handle in [`use_state`](Self::use_state) and drop it on
1843 /// a later frame.
1844 ///
1845 /// # Caveat: `error_boundary` re-fire
1846 ///
1847 /// Effects placed inside an [`error_boundary`](Self::error_boundary)
1848 /// scope can re-fire when the boundary catches a panic and rolls back
1849 /// the hook slots. For non-idempotent side effects (network requests,
1850 /// payments) put the effect outside the boundary or guard with an
1851 /// idempotency key.
1852 ///
1853 /// # Panics
1854 ///
1855 /// Panics if the hook slot at this call position was previously used for a
1856 /// different hook (a rules-of-hooks / call-order violation), since the
1857 /// type-erased slot then fails to downcast to the deps type `D`:
1858 ///
1859 /// ```text
1860 /// Hook type mismatch at index {idx}: expected {type}. Hooks must be called in the same order every frame.
1861 /// ```
1862 ///
1863 /// # Common patterns
1864 ///
1865 /// ```ignore
1866 /// // Run once on first frame:
1867 /// ui.use_effect(|_| initialize_logger(), &());
1868 ///
1869 /// // Run when `selected_tab` changes:
1870 /// ui.use_effect(|tab| load_tab_data(*tab), &selected_tab);
1871 /// ```
1872 pub fn use_effect<D: PartialEq + Clone + 'static>(&mut self, f: impl FnOnce(&D), deps: &D) {
1873 let idx = self.rollback.hook_cursor;
1874 self.rollback.hook_cursor += 1;
1875
1876 if idx >= self.hook_states.len() {
1877 // First encounter: run the effect, then store the deps so we
1878 // can detect future changes.
1879 f(deps);
1880 self.hook_states.push(Box::new(deps.clone()));
1881 return;
1882 }
1883
1884 match self.hook_states[idx].downcast_mut::<D>() {
1885 Some(stored) => {
1886 if *stored != *deps {
1887 f(deps);
1888 *stored = deps.clone();
1889 }
1890 }
1891 None => panic!(
1892 "Hook type mismatch at index {idx}: expected {}. \
1893 Hooks must be called in the same order every frame.",
1894 std::any::type_name::<D>()
1895 ),
1896 }
1897 }
1898
1899 /// Register a focusable slot bound to a stable string name.
1900 ///
1901 /// Returns `true` if the registered slot currently has focus, exactly
1902 /// like [`register_focusable`](Self::register_focusable) — but also
1903 /// records the `name → slot` mapping so other code can later call
1904 /// [`focus_by_name`](Self::focus_by_name) and
1905 /// [`focused_name`](Self::focused_name).
1906 ///
1907 /// # How the slot is shared with the widget that follows
1908 ///
1909 /// Every SLT widget that takes focus (`button`, `text_input`,
1910 /// `tabs`, …) internally calls `register_focusable()` to claim its
1911 /// own slot. To keep the name pointed at the **widget the user
1912 /// sees**, this call:
1913 ///
1914 /// 1. allocates a slot eagerly (so the name binding works even when
1915 /// no widget follows — useful for tests and for custom focusable
1916 /// regions),
1917 /// 2. records the `name → slot` mapping into the frame's
1918 /// `focus_name_map` (first-write-wins on duplicate names within
1919 /// a frame),
1920 /// 3. **reserves** the slot id so the next `register_focusable()`
1921 /// on the same frame *reuses* it instead of allocating a fresh
1922 /// slot — that's how `text_input(&mut state)` placed right after
1923 /// inherits the name.
1924 ///
1925 /// Names are re-registered each frame; the previous frame's map is
1926 /// kept under `focus_name_map_prev` so [`focus_by_name`] can resolve
1927 /// a name that has already been registered.
1928 ///
1929 /// # Two valid usage shapes
1930 ///
1931 /// **Shape A — name a widget that follows immediately** (the common
1932 /// pattern; the widget reuses the reserved slot):
1933 ///
1934 /// ```ignore
1935 /// let _ = ui.register_focusable_named("search");
1936 /// let _ = ui.text_input(&mut search_state);
1937 /// // later: ui.focus_by_name("search") jumps to the text_input
1938 /// ```
1939 ///
1940 /// **Shape B — register a named focusable region with no inner
1941 /// widget** (e.g. a custom render area that handles its own keys
1942 /// when focused):
1943 ///
1944 /// ```ignore
1945 /// let focused = ui.register_focusable_named("canvas");
1946 /// if focused { /* react to keys via key_presses_when */ }
1947 /// ```
1948 pub fn register_focusable_named(&mut self, name: &str) -> bool {
1949 // Modal/overlay suppression: when a modal is active and we're not
1950 // inside it, focusables outside the modal must be invisible to
1951 // tab/click cycling. Drop the registration entirely (no slot
1952 // allocation, no name binding, no reservation leak).
1953 if (self.rollback.modal_active || self.prev_modal_active)
1954 && self.rollback.overlay_depth == 0
1955 {
1956 self.rollback.pending_focusable_id = None;
1957 return false;
1958 }
1959 // Eagerly allocate the slot — symmetric with `register_focusable`,
1960 // so the slot exists even when no widget follows.
1961 let id = self.rollback.focus_count;
1962 self.rollback.focus_count += 1;
1963 self.rollback.last_focusable_id = Some(id);
1964 self.commands.push(Command::FocusMarker(id));
1965 // First-write-wins on duplicate names within a single frame —
1966 // a second `register_focusable_named("dup")` keeps the first
1967 // slot bound to the name and orphans its own slot's name binding.
1968 self.focus_name_map.entry(name.to_string()).or_insert(id);
1969 // Reserve `id` for the very next `register_focusable()` call to
1970 // reuse, so widgets like `text_input` placed immediately after
1971 // share the named slot rather than allocating a fresh one.
1972 // Last-write-wins on the reservation: stacking two
1973 // `register_focusable_named` calls without an intervening widget
1974 // leaves the second slot reserved (the first slot stays bound to
1975 // its name in `focus_name_map`, just without a widget attached).
1976 self.rollback.pending_focusable_id = Some(id);
1977 // Same focus-index prediction as `register_focusable`.
1978 if self.prev_modal_active
1979 && self.prev_modal_focus_count > 0
1980 && self.rollback.modal_active
1981 && self.rollback.overlay_depth > 0
1982 {
1983 let mut modal_local_id = id.saturating_sub(self.rollback.modal_focus_start);
1984 modal_local_id %= self.prev_modal_focus_count;
1985 let mut modal_focus_idx = self.focus_index.saturating_sub(self.prev_modal_focus_start);
1986 modal_focus_idx %= self.prev_modal_focus_count;
1987 return modal_local_id == modal_focus_idx;
1988 }
1989 if self.prev_focus_count == 0 {
1990 return true;
1991 }
1992 self.focus_index % self.prev_focus_count == id
1993 }
1994
1995 /// Request focus on the named widget.
1996 ///
1997 /// If the named widget was registered last frame the focus change
1998 /// takes effect at the **start of the next frame** (one-frame delay
1999 /// is the deferred-command pattern used throughout SLT). If the name
2000 /// has never been registered, the request stays pending: the next
2001 /// frame to register that name receives focus.
2002 ///
2003 /// Returns `true` if the call **will** resolve — i.e. the name was
2004 /// either registered earlier in this frame (via
2005 /// [`register_focusable_named`](Self::register_focusable_named)) or in
2006 /// the previous frame. Returns `false` only when the name has not been
2007 /// seen by either frame, in which case the request stays pending until
2008 /// some future frame registers the name.
2009 ///
2010 /// # Example
2011 ///
2012 /// ```ignore
2013 /// if ui.button("Find").clicked {
2014 /// ui.focus_by_name("search");
2015 /// }
2016 /// ```
2017 pub fn focus_by_name(&mut self, name: &str) -> bool {
2018 // Resolve against either the previous frame's settled map or the
2019 // in-progress map being built right now. The latter handles the
2020 // common "register, then focus_by_name in the same frame" pattern
2021 // that callers naturally expect to return `true`.
2022 //
2023 // The actual focus change still lands at the start of the next
2024 // frame via `focus_name_map_prev` lookup in `Context::new`. The
2025 // return value is purely about resolvability: "true" means the name
2026 // is known and the focus shift will land next frame; "false" means
2027 // the request is pending a future registration.
2028 let resolved =
2029 self.focus_name_map_prev.contains_key(name) || self.focus_name_map.contains_key(name);
2030 // Always store the request — even if it resolved this frame, the
2031 // next-frame plumbing (`Context::new`) is what actually applies
2032 // the index. We use take/replace so the caller cannot stack two
2033 // pending names; the most recent wins.
2034 self.pending_focus_name = Some(name.to_string());
2035 resolved
2036 }
2037
2038 /// Return the name of the currently focused widget, if it was
2039 /// registered with
2040 /// [`register_focusable_named`](Self::register_focusable_named) this
2041 /// frame.
2042 ///
2043 /// Returns `None` if the focused widget used the unnamed
2044 /// [`register_focusable`](Self::register_focusable) API or if no widget
2045 /// has focus.
2046 pub fn focused_name(&self) -> Option<&str> {
2047 // Search this frame's map for the entry whose index equals
2048 // `focus_index`. The map is small (one entry per named focusable),
2049 // so a linear scan is fine — typical apps register <50 names.
2050 self.focus_name_map
2051 .iter()
2052 .find_map(|(name, &idx)| (idx == self.focus_index).then_some(name.as_str()))
2053 }
2054
2055 /// Iterate unconsumed key-press events, gated on `active`.
2056 ///
2057 /// When `active` is `false`, returns an empty iterator. When `active`
2058 /// is `true`, behaves identically to the internal
2059 /// `available_key_presses`. The returned indices are valid for
2060 /// [`consume_event`](Self::consume_event).
2061 ///
2062 /// This is the **preferred pattern** for focus-gated keyboard handling
2063 /// in custom widgets. Because the iterator borrows `self.events`
2064 /// immutably, collect the indices first and consume them after the
2065 /// loop:
2066 ///
2067 /// ```ignore
2068 /// let focused = ui.register_focusable();
2069 /// let mut hits: Vec<usize> = Vec::new();
2070 /// for (i, key) in ui.key_presses_when(focused) {
2071 /// if key.code == slt::KeyCode::Enter {
2072 /// hits.push(i);
2073 /// // ... handle Enter ...
2074 /// }
2075 /// }
2076 /// for i in hits { ui.consume_event(i); }
2077 /// ```
2078 pub fn key_presses_when(
2079 &self,
2080 active: bool,
2081 ) -> impl Iterator<Item = (usize, &crate::event::KeyEvent)> + '_ {
2082 // The `!active` short-circuit at the head of the predicate yields
2083 // an empty iterator at zero allocation cost when the widget isn't
2084 // focused. Indices are still drawn from `self.events` so callers
2085 // can pass them straight to `consume_event`.
2086 self.events
2087 .iter()
2088 .enumerate()
2089 .filter_map(move |(i, event)| {
2090 if !active {
2091 return None;
2092 }
2093 if self.consumed.get(i).copied().unwrap_or(true) {
2094 return None;
2095 }
2096 match event {
2097 Event::Key(key) if key.kind == KeyEventKind::Press => Some((i, key)),
2098 _ => None,
2099 }
2100 })
2101 }
2102
2103 /// Mark the event at `index` as consumed.
2104 ///
2105 /// Public counterpart to the crate-internal `consume_indices`. Use
2106 /// this in custom widgets after handling an event yielded by
2107 /// [`key_presses_when`](Self::key_presses_when) so subsequent widgets
2108 /// don't react to the same key. Out-of-range indices are silently
2109 /// ignored (matching the iterator-pair semantics).
2110 pub fn consume_event(&mut self, index: usize) {
2111 if let Some(slot) = self.consumed.get_mut(index) {
2112 *slot = true;
2113 }
2114 }
2115
2116 // ── Issue #233: in-frame static-log append ───────────────────────────
2117 //
2118 // The runtime holds the buffer inside `named_states` under a reserved
2119 // sentinel key. `Context::new` (owned by another agent) does not need to
2120 // initialise this field — `or_insert_with` handles first-call creation,
2121 // and `lib::run_frame_kernel` drains the buffer back into `FrameState`
2122 // for the run-loop to consume.
2123
2124 /// Append a line that will be flushed to terminal scrollback **before**
2125 /// the dynamic frame content (issue #233).
2126 ///
2127 /// Lines accumulated this frame are written via the active runtime — for
2128 /// [`crate::run_static`] / [`crate::run_static_with`], they are printed
2129 /// above the inline dynamic area as committed scrollback. For full-screen
2130 /// runtimes ([`crate::run`], [`crate::run_async`]) and inline mode
2131 /// ([`crate::run_inline`]), the buffer is silently dropped after a debug
2132 /// warning is emitted on the first call per frame, since those modes have
2133 /// no scrollback area to write to.
2134 ///
2135 /// The headless [`crate::TestBackend`] accumulates the lines into the
2136 /// frame state where they can be drained by tests via
2137 /// [`Context::take_static_log`] (or by inspecting the buffer when
2138 /// constructing a custom backend).
2139 ///
2140 /// # Order
2141 ///
2142 /// `static_log` may be called any number of times per frame. Lines are
2143 /// flushed in call order, all before the dynamic frame for the same
2144 /// tick.
2145 ///
2146 /// # Example
2147 ///
2148 /// ```
2149 /// # use slt::*;
2150 /// # TestBackend::new(40, 4).render(|ui| {
2151 /// ui.static_log("event 1");
2152 /// ui.static_log(format!("event {}", 2));
2153 /// ui.text("dynamic content");
2154 /// # });
2155 /// ```
2156 pub fn static_log(&mut self, line: impl Into<String>) {
2157 let entry = self
2158 .named_states
2159 .entry(STATIC_LOG_KEY)
2160 .or_insert_with(|| Box::new(Vec::<String>::new()) as Box<dyn std::any::Any>);
2161 if let Some(buf) = entry.downcast_mut::<Vec<String>>() {
2162 buf.push(line.into());
2163 }
2164 }
2165
2166 /// Drain and return the queued static-log lines for the current frame
2167 /// (issue #233). Used by tests / external backends to inspect what
2168 /// `ui.static_log(...)` emitted during a [`crate::TestBackend::render`]
2169 /// call.
2170 pub fn take_static_log(&mut self) -> Vec<String> {
2171 if let Some(boxed) = self.named_states.get_mut(STATIC_LOG_KEY) {
2172 if let Some(buf) = boxed.downcast_mut::<Vec<String>>() {
2173 return std::mem::take(buf);
2174 }
2175 }
2176 Vec::new()
2177 }
2178
2179 // ── Issue #236: widget keymap publishing ─────────────────────────────
2180
2181 /// Publish a widget's keymap so the framework can show it in the help
2182 /// overlay (issue #236).
2183 ///
2184 /// Each call registers `(name, bindings)` for the current frame. Widgets
2185 /// implementing [`crate::keymap::WidgetKeyHelp`] typically forward their
2186 /// `key_help()` slice here:
2187 ///
2188 /// ```
2189 /// # use slt::*;
2190 /// # use slt::keymap::WidgetKeyHelp;
2191 /// struct Counter;
2192 /// impl WidgetKeyHelp for Counter {
2193 /// fn key_help(&self) -> &'static [(&'static str, &'static str)] {
2194 /// const HELP: &[(&str, &str)] = &[("↑", "increment"), ("↓", "decrement")];
2195 /// HELP
2196 /// }
2197 /// }
2198 /// # TestBackend::new(40, 4).render(|ui| {
2199 /// let counter = Counter;
2200 /// ui.publish_keymap("counter", counter.key_help());
2201 /// # });
2202 /// ```
2203 ///
2204 /// The registry is reset at the start of every frame (the first call on a
2205 /// new tick clears stale entries). Both calls in the same frame
2206 /// accumulate; calls across frames do not leak.
2207 pub fn publish_keymap(
2208 &mut self,
2209 name: &'static str,
2210 bindings: &'static [(&'static str, &'static str)],
2211 ) {
2212 // The registry is cleared at frame start by `run_frame_kernel`
2213 // (issue #236) — see `clear_keymap_registry` in `lib.rs`. We just
2214 // need to insert/append here.
2215 let entry = self
2216 .named_states
2217 .entry(KEYMAP_REGISTRY_KEY)
2218 .or_insert_with(|| {
2219 Box::new(Vec::<crate::keymap::PublishedKeymap>::new()) as Box<dyn std::any::Any>
2220 });
2221 if let Some(vec) = entry.downcast_mut::<Vec<crate::keymap::PublishedKeymap>>() {
2222 vec.push(crate::keymap::PublishedKeymap::new(name, bindings));
2223 }
2224 }
2225
2226 /// Return all keymaps published this frame (issue #236).
2227 ///
2228 /// Empty if no widget called [`Context::publish_keymap`] yet on the
2229 /// current frame. The registry is reset at the start of every frame.
2230 pub fn published_keymaps(&self) -> &[crate::keymap::PublishedKeymap] {
2231 if let Some(boxed) = self.named_states.get(KEYMAP_REGISTRY_KEY) {
2232 if let Some(vec) = boxed.downcast_ref::<Vec<crate::keymap::PublishedKeymap>>() {
2233 return vec;
2234 }
2235 }
2236 &[]
2237 }
2238
2239 /// Render an automatic keymap-help overlay listing every widget keymap
2240 /// published this frame (issue #236).
2241 ///
2242 /// Pass `open = true` to render the overlay (typically gated on a
2243 /// `?` / `F1` keypress). When `open` is `false`, this method is a
2244 /// no-op. The overlay groups bindings by widget name and dismisses
2245 /// when the next frame is rendered with `open = false`.
2246 ///
2247 /// # Example
2248 ///
2249 /// ```
2250 /// # use slt::*;
2251 /// # TestBackend::new(40, 12).render(|ui| {
2252 /// const RICHLOG: &[(&str, &str)] = &[("↑/k", "scroll up"), ("↓/j", "scroll down")];
2253 /// ui.publish_keymap("rich_log", RICHLOG);
2254 /// // Show the help overlay when '?' is pressed
2255 /// let show = ui.key('?');
2256 /// ui.keymap_help_overlay(show);
2257 /// # });
2258 /// ```
2259 pub fn keymap_help_overlay(&mut self, open: bool) {
2260 if !open {
2261 return;
2262 }
2263
2264 let entries: Vec<crate::keymap::PublishedKeymap> = self.published_keymaps().to_vec();
2265 if entries.is_empty() {
2266 return;
2267 }
2268
2269 let theme = self.theme;
2270 let _ = self.modal(|ui| {
2271 ui.styled("Keyboard shortcuts", Style::new().bold().fg(theme.primary));
2272 ui.text("");
2273 for entry in &entries {
2274 ui.styled(entry.name, Style::new().bold().fg(theme.text));
2275 for (key, desc) in entry.bindings {
2276 let line = format!(" {key:<14} {desc}");
2277 ui.styled(line, Style::new().fg(theme.text_dim));
2278 }
2279 ui.text("");
2280 }
2281 ui.styled(
2282 "Press Esc / ? to close",
2283 Style::new().fg(theme.text_dim).italic(),
2284 );
2285 });
2286 }
2287}
2288
2289// Sentinel keys reused from `lib.rs` so the two reads/writes can never drift.
2290use crate::{
2291 KEYMAP_REGISTRY_NAMED_STATE_KEY as KEYMAP_REGISTRY_KEY,
2292 STATIC_LOG_NAMED_STATE_KEY as STATIC_LOG_KEY,
2293};