kui_core/runtime/dispatch.rs
1//! Input dispatch: one event in, the UI events it resolved to out.
2//!
3//! `handle_input` routes pointer, wheel, key, text and access events
4//! against the last finished frame — its hit regions, edit buffers and
5//! focus — and stamps each result with this window. Focus motion itself
6//! lives in `focus`, the arrow-key patterns in `composites`.
7
8use super::*;
9use crate::input::Target;
10
11impl Core {
12 /// Feeds one input event; returns any UI events it resolved to,
13 /// hit-tested against the previous frame's layout.
14 pub fn handle_input(&mut self, ev: InputEvent) -> Vec<UiEvent> {
15 // The next frame's reason (backlog F111).
16 self.trace_input(&ev);
17 // What a focus move this input makes is reported as (DX18).
18 let by = match &ev {
19 InputEvent::CursorMoved(_)
20 | InputEvent::CursorLeft
21 | InputEvent::MouseDown { .. }
22 | InputEvent::MouseUp { .. }
23 | InputEvent::Scroll(_)
24 | InputEvent::ScrollGesture { .. } => "pointer",
25 InputEvent::Access(_) => "assistive",
26 InputEvent::Key(..)
27 | InputEvent::KeyDown(_)
28 | InputEvent::KeyUp(_)
29 | InputEvent::Text(_)
30 | InputEvent::Commit(_)
31 | InputEvent::Preedit(..) => "keyboard",
32 _ => "program",
33 };
34 // A move the app made since the last report — `set_focus`,
35 // `set_key_focus`, a handler's verb (ADR 0036) — with no frame
36 // finished since to report it: the program's, and before this
37 // input's own, which would otherwise carry this input's `by`
38 // (DX18, the alpha.22 regression pass).
39 let mut moved = Vec::new();
40 self.report_focus("program", &mut moved);
41 // The devtools' chords are acted on before anything is routed
42 // (ADR 0024, decision 4): the press goes no further, and what
43 // was pending still goes out.
44 let mut out = if self.devtools_intercept(&ev) {
45 std::mem::take(&mut self.pending)
46 } else {
47 self.route_input(ev)
48 };
49 if !moved.is_empty() {
50 moved.append(&mut out);
51 out = moved;
52 }
53 // Whatever the event itself made pending — the synthetic key
54 // releases a focus move forces — belongs to this batch, not to the
55 // next frame's drain.
56 out.append(&mut self.pending);
57 self.report_focus(by, &mut out);
58 // A click on a select field opens its menu and is nobody's
59 // (`widgets::select`); before the menu's own consumer, since the
60 // menu it opens is that one's from here on.
61 self.consume_select_events(&mut out);
62 // A row of the core's own context menu is not the app's click, and
63 // neither is that menu's dismissal: taken back here, acted on, and
64 // reported as one `menu` event on the node the menu was about (ADR
65 // 0017, decision 5). Here rather than inside `route_input` because
66 // several of its arms return early — the modal press among them,
67 // which is exactly the one that dismisses a menu.
68 self.consume_menu_events(&mut out);
69 // And the drawn menu bar's own nodes, on the same terms: its
70 // titles and rows post ordinary clicks, and none of them is the
71 // app's (`docs/adr/0018-a-menu-bar-the-app-declares.md`).
72 self.consume_menu_bar_events(&mut out);
73 self.outbound(&mut out);
74 out
75 }
76
77 /// The way out for every batch of events the app is about to hear,
78 /// whichever door made them — an input, or a host's own menu
79 /// answering (`activate_menu_item`), which is not an input and used
80 /// to skip this: a devtools select chosen from a native menu posted
81 /// its action to the app instead of the panel. The devtools panel's
82 /// own controls are taken back (nobody's but the core's); what is
83 /// left is translated, stamped with its window and logged on its way
84 /// out.
85 pub(crate) fn outbound(&mut self, out: &mut Vec<UiEvent>) {
86 self.devtools_consume(out);
87 self.devtools_translate(out);
88 self.stamp(out);
89 self.devtools_log(out);
90 // An event the app was handed is "the user did something": what
91 // separates a message repeated on purpose from a view announcing
92 // every frame (`announce`).
93 if !out.is_empty() {
94 self.events_answered += 1;
95 }
96 }
97
98 /// A click or drag says where it landed, in the terms of the node it
99 /// landed on — the one pass both shapes go through, run on
100 /// the `n` events at the end of `out` that `Interaction::handle` just
101 /// made from a press, and on nothing else: a click Enter, Space or a
102 /// screen reader made has no point and no count, and the cursor is
103 /// wherever the mouse happens to rest. Only a map payload can carry
104 /// the fields.
105 ///
106 /// On a `cells` grid, `cell: {row, col}` — the same arithmetic a
107 /// selection uses (`cell_row_col`), so the app never divides by a
108 /// cell size it did not choose. Inside a key sink that
109 /// draws `role="line"` rows, `line` — the ordinal among the sink's
110 /// lines, the numbering its `access` events use — `byte` — where the
111 /// point falls in that line's text, what `text_hit` would answer —
112 /// and `clicks` — the press's count, so a double click is a word
113 /// without a timer the app keeps; a point above the
114 /// first line is the first, below the last the last, and one in a
115 /// gutter is the line beside it. The point is the event's own for a
116 /// drag and the cursor's for a click. Not opt-in, like `cell`: the
117 /// fields appear wherever the shape they describe is drawn, and a
118 /// handler that does not read them is not slower for their being
119 /// there.
120 fn attach_pointer(&mut self, out: &mut [UiEvent], n: usize) {
121 if n == 0 || self.tree.is_empty() || !(self.tree.any_text || self.tree.any_line) {
122 return;
123 }
124 let clicks = self.interaction.press_clicks();
125 let from = out.len() - n;
126 for ev in &mut out[from..] {
127 let Some(point) = self.pointer_point(ev) else {
128 continue;
129 };
130 let Some(i) = self.tree.index_of(ev.key) else {
131 continue;
132 };
133 if let Some((row, col)) = self.cell_row_col(ev.key, point)
134 && let Value::Map(entries) = &mut ev.payload
135 {
136 entries.push((
137 "cell".to_string(),
138 Value::map([
139 ("row", Value::Int(row as i64)),
140 ("col", Value::Int(col as i64)),
141 ]),
142 ));
143 }
144 if !self.tree.any_line {
145 continue;
146 }
147 // The sink: this node, or the nearest above it.
148 let mut sink = i;
149 while self.tree.specs[sink].events().on_key.is_none() {
150 let p = self.tree.parent[sink];
151 if p == crate::tree::NIL {
152 break;
153 }
154 sink = p as usize;
155 }
156 if self.tree.specs[sink].events().on_key.is_none() {
157 continue;
158 }
159 let lines = crate::access::lines_under(&self.tree, sink);
160 // Each line is read on its own upright layout: the point is
161 // pulled back through the turns that line is drawn under (ADR
162 // 0043) — the sink's, or a column's between it and its lines;
163 // `x` / `y` stay as drawn.
164 let at = |l: usize| self.unturned_at(l, point);
165 // Nearest vertically — inside one is a gap of zero — ties to
166 // the earlier line.
167 let gap = |l: usize| {
168 let (top, h) = (self.tree.pos[l].y, self.tree.size[l].h);
169 let y = at(l).y;
170 (top - y).max(y - (top + h)).max(0.0)
171 };
172 let Some((line, l)) = lines
173 .iter()
174 .enumerate()
175 .map(|(n, &l)| (n, l))
176 .min_by(|a, b| {
177 gap(a.1)
178 .partial_cmp(&gap(b.1))
179 .unwrap_or(std::cmp::Ordering::Equal)
180 })
181 else {
182 continue;
183 };
184 let byte = self
185 .text
186 .hit_at(self.tree.keys[l], at(l), self.building)
187 .map_or(0, |h| h.byte);
188 // A `button` event's press carries its own count and its move
189 // and release none (backlog F105): `clicks` here is the last
190 // primary press's. The core's is told by its `phase` and
191 // `button` fields, not its kind alone, which an app's click
192 // payload may spell too (backlog RG75).
193 let own_count = ev.kind() == Some("button")
194 && ev.payload.get("phase").is_some()
195 && ev.payload.get("button").is_some();
196 if let Value::Map(entries) = &mut ev.payload {
197 entries.push(("line".to_string(), Value::Int(line as i64)));
198 entries.push(("byte".to_string(), Value::Int(byte as i64)));
199 if !own_count {
200 entries.push(("clicks".to_string(), Value::Int(clicks as i64)));
201 }
202 }
203 }
204 }
205
206 /// Where a pointer-made event happened: the `x` / `y` its payload
207 /// carries (a drag's), else the cursor (a click's), else nowhere —
208 /// and nowhere for a payload that is not a map, which can carry no
209 /// field anyway.
210 fn pointer_point(&self, ev: &UiEvent) -> Option<Vec2> {
211 let Value::Map(entries) = &ev.payload else {
212 return None;
213 };
214 let field = |name: &str| {
215 entries
216 .iter()
217 .find(|(k, _)| k == name)
218 .and_then(|(_, v)| match v {
219 Value::Float(f) => Some(*f as f32),
220 Value::Int(n) => Some(*n as f32),
221 _ => None,
222 })
223 };
224 match (field("x"), field("y")) {
225 (Some(x), Some(y)) => Some(Vec2::new(x, y)),
226 _ => self.interaction.cursor(),
227 }
228 }
229
230 /// One whole key going down: both channels, in the order a window
231 /// drives them. The press reaches whatever holds key
232 /// focus, and then [`KeyPress::edit_event`] asks the core for what
233 /// that key *means* — Escape dismisses a modal, Tab walks the ring,
234 /// an arrow nudges a focused slider, a printable character reaches
235 /// the focused editor.
236 ///
237 /// This is what a driver with a real keyboard does, so it is what a
238 /// headless test should do too. [`Core::handle_input`] with a bare
239 /// `KeyDown` is still the way to drive one channel on purpose.
240 pub fn press(&mut self, key: KeyPress) -> Vec<UiEvent> {
241 // Read before the move, and before the press: the key's meaning is
242 // a property of the key, not of what the first channel did with it.
243 let edit = key.edit_event();
244 let mut out = self.handle_input(InputEvent::KeyDown(key));
245 if let Some(ev) = edit {
246 out.extend(self.handle_input(ev));
247 }
248 out
249 }
250
251 /// The same key coming up. One channel, because only one has a second
252 /// half: the editing keys act on the way down. Paired with
253 /// [`Core::press`] so a held key is a press and a release, and a sink
254 /// that asked for `key_up` hears both.
255 pub fn release(&mut self, key: KeyPress) -> Vec<UiEvent> {
256 self.handle_input(InputEvent::KeyUp(key.released()))
257 }
258
259 /// Whether this core delivered `key`'s press and has not delivered
260 /// its release — the one core a `KeyUp` for it resolves in. What a
261 /// driver with more than one core asks before routing a release: a
262 /// key pressed in a window and let go while a popup borrowed its
263 /// keyboard was released in the popup, which never saw the press, and
264 /// the owner held it until it lost focus.
265 pub fn holds_key(&self, key: &KeyPress) -> bool {
266 self.keys_held.iter().any(|h| h.same_key(key))
267 }
268
269 /// Says which window every event on its way out came from.
270 ///
271 /// Most producers cannot: hit-testing and the edit buffer are below
272 /// the level at which a window exists. A `Core` is one window, though,
273 /// and the driver already told it which one (`env.window.id`, beside
274 /// `maximized` and the rest of the window facts) — so one assignment
275 /// at each of the two exits covers every event every binding will
276 /// ever see, and a multi-window driver has only to hand each core its id.
277 ///
278 /// The one producer that does know is the audio store, whose mounts
279 /// are per window and whose `ended` / `refused` events are folded
280 /// back through whichever core the driver holds — the main one, in the
281 /// runner. An event it stamped with another window keeps that stamp; a
282 /// `MAIN` one is indistinguishable from an unstamped one and takes the
283 /// draining core's, which is right wherever the draining core is the
284 /// main window, as every driver's is.
285 pub(crate) fn stamp(&self, out: &mut [UiEvent]) {
286 let id = self.env.window.id;
287 // The slot a node was filled into, from the last frame's fill
288 // ranges (`Tree::fills`): a frame with no extension recorded none,
289 // and pays one emptiness check per batch.
290 if !self.tree.fills.is_empty() {
291 for ev in out.iter_mut() {
292 if ev.slot.is_none()
293 && let Some(i) = self.tree.index_of(ev.key)
294 {
295 ev.slot = self.tree.slot_of(i);
296 }
297 }
298 }
299 if id == WindowId::MAIN {
300 // What producers already wrote. Skipped rather than written so
301 // the single-window case stays free.
302 return;
303 }
304 for ev in out {
305 if ev.window == WindowId::MAIN {
306 ev.window = id;
307 }
308 }
309 }
310
311 fn route_input(&mut self, ev: InputEvent) -> Vec<UiEvent> {
312 let mut out = std::mem::take(&mut self.pending);
313 // Chrome commands say which window they are about, and a hit
314 // region does not know: the interaction store reads it from here.
315 self.interaction.window = self.env.window.id;
316 // The press this event is the second channel of, if it is one:
317 // a `KeyDown` leaves its modifiers for the `Key` or `Text` that
318 // follows it, and anything else is not that (AR10).
319 let pressed = self.pressed_mods.take();
320 // Whether a modifier other than Shift was down on that press — the
321 // question `route_key` asked, asked again here so the two channels
322 // agree about a chord (`docs/adr/0011`, decision 3). Without a
323 // press, the editing `Mods` are what there is.
324 let chord = |mods: Option<crate::input::Mods>| match pressed {
325 Some(m) => m.ctrl || m.alt || m.super_key,
326 None => mods.is_some_and(|m| m.word || m.doc),
327 };
328 // A paste's answer is a commit with the pasteboard's markers beside
329 // it (backlog F84), and a bare commit is one whose pasteboard marked
330 // nothing — the answer an older driver sends — so the two are one
331 // arm below.
332 let (ev, marks, paste) = match ev {
333 InputEvent::Paste { text, marks } => (InputEvent::Commit(text), marks, true),
334 ev => (ev, crate::input::ClipboardMarks::default(), false),
335 };
336 match ev {
337 // Wheel up (positive y) reveals earlier content: offset
338 // decreases. An `on_scroll` node takes it instead — the whole
339 // lines it covers on a grid, the fraction carried to the next
340 // notch on the same node (ADR 0029, decision 4). A scroller
341 // takes the axes it scrolls on and passes the rest to the
342 // region under it (backlog DX13), and a gesture keeps the
343 // targets it started with (backlog F107, `mod gesture`): a
344 // bare `Scroll` is a gesture of its own.
345 InputEvent::Scroll(delta) => self.route_scroll(delta, true, &mut out),
346 InputEvent::ScrollGesture { delta, begins } => {
347 self.route_scroll(delta, begins, &mut out)
348 }
349 InputEvent::Text(s) => {
350 if let Some(key) = self.edit.focused() {
351 if self.edit_with_fonts(|edit, fs| edit.apply_text(key, &s, fs)) {
352 self.push_edit_event(key, "changed", &mut out);
353 }
354 } else if let Some(i) = self.focused_control() {
355 // Inside a composite, printable characters search the
356 // items by name; Space extends a search already under
357 // way rather than pressing (`docs/adr/0007`, decision
358 // 9). Otherwise Space presses the focused control (a
359 // sink would have taken the press as data; an editor
360 // took the text).
361 //
362 // Unless the control claims neither and a sink above it
363 // does: the raw press already bubbled there, and the
364 // two channels have to agree about who owns the key
365 // (`docs/adr/0011`, decision 3).
366 let code = match s.chars().next() {
367 Some(c) => KeyCode::Char(c),
368 None => KeyCode::Unknown,
369 };
370 if !self.bubbles(i, code, chord(None))
371 && !self.type_ahead(i, &s, &mut out)
372 && s == " "
373 {
374 // The press shows the focus, as Enter's does
375 // (`docs/adr/0002`, decision 4a).
376 self.focus_visible = true;
377 self.click_node(self.tree.keys[i], &mut out);
378 }
379 }
380 }
381 InputEvent::Files(paths) => {
382 if let Some(ev) = self.file_ask.answer(&paths) {
383 out.push(ev);
384 }
385 }
386 // Documents the OS handed the app (backlog F124): nobody's ask,
387 // so the host's, on the root, as `system` and `fonts` are.
388 InputEvent::Open(paths) => {
389 if !paths.is_empty() {
390 out.push(UiEvent {
391 origin: OriginId::HOST,
392 window: WindowId::MAIN,
393 key: Key::ROOT,
394 payload: Value::map([
395 ("kind", Value::str("open")),
396 (
397 "paths",
398 Value::List(paths.into_iter().map(Value::Str).collect()),
399 ),
400 ]),
401 slot: None,
402 });
403 }
404 }
405 InputEvent::Commit(s) => {
406 // The paste's answer, when one was asked — a driver answers
407 // every ask, with an empty commit for an empty clipboard,
408 // which is what lets the next ask through (AR34). The same
409 // rule says whether this *is* the answer: a `Paste`, or any
410 // commit while an ask is out (backlog DX14).
411 let pasted = std::mem::replace(&mut self.awaiting_paste, false) || paste;
412 if let Some(key) = self.edit.focused() {
413 if self.edit_with_fonts(|edit, fs| edit.apply_text(key, &s, fs)) {
414 self.push_edit_event(key, "changed", &mut out);
415 }
416 } else {
417 // A custom editor: the composition's result as data,
418 // on the sink the focused node reports to (backlog
419 // C17). Never reaches the `Text` arm above, so a
420 // sink hears a commit once and a keystroke once. A
421 // marker rides along only when it is set, so a sink
422 // that never heard of them sees the payload it always
423 // did.
424 let mut fields = vec![("kind", Value::str("text")), ("text", Value::Str(s))];
425 if pasted {
426 fields.push(("pasted", Value::Bool(true)));
427 }
428 if marks.concealed {
429 fields.push(("concealed", Value::Bool(true)));
430 }
431 if marks.transient {
432 fields.push(("transient", Value::Bool(true)));
433 }
434 self.sink_event(Value::map(fields), &mut out);
435 }
436 }
437 InputEvent::Preedit(s, cursor) => {
438 if let Some(key) = self.edit.focused() {
439 self.edit_with_fonts(|edit, fs| edit.set_preedit(key, &s, cursor, fs));
440 } else {
441 let cursor = match cursor {
442 Some((a, b)) => {
443 Value::List(vec![Value::Int(a as i64), Value::Int(b as i64)])
444 }
445 None => Value::Null,
446 };
447 self.sink_event(
448 Value::map([
449 ("kind", Value::str("preedit")),
450 ("text", Value::Str(s)),
451 ("cursor", cursor),
452 ]),
453 &mut out,
454 );
455 }
456 }
457 InputEvent::Key(ek, mods) => {
458 // Inside one of the core's menus a submenu comes first: the
459 // arrows open and close one, and Escape closes the innermost
460 // before it would close the menu (backlog F128).
461 if self.submenu_key(ek) {
462 return out;
463 }
464 // A modal owns Escape: it asks to go away, and nothing
465 // else happens (see `docs/adr/0003-modal-surfaces.md`).
466 // The core closes nothing — the app stops declaring it.
467 if ek == EditKey::Escape
468 && let Some(key) = self.modal()
469 {
470 self.dismiss(key, "escape", &mut out);
471 return out;
472 }
473 // Tab walks the focus ring (Shift-Tab backwards) unless a
474 // multiline editor holds focus — there Tab stays
475 // indentation — or a key sink does: a sink is an app that
476 // owns its keyboard, Tab included (it hands focus on with
477 // `focus_next`). With nothing focused Tab enters the ring.
478 let sink = self.focused_sink();
479 let traverse = ek == EditKey::Tab
480 && match self.edit.focused() {
481 Some(k) => !self.edit.is_multiline(k),
482 None => !sink,
483 };
484 if traverse {
485 self.focus_next(!mods.shift);
486 } else if let Some(key) = self.edit.focused() {
487 let (changed, submit) =
488 self.edit_with_fonts(|edit, fs| edit.apply_key(key, ek, mods, fs));
489 self.editor_took_selection(key);
490 if changed {
491 self.push_edit_event(key, "changed", &mut out);
492 }
493 if submit {
494 self.push_edit_event(key, "submit", &mut out);
495 }
496 if ek == EditKey::Escape {
497 self.move_focus(None);
498 }
499 } else if let Some(i) = self.focused_control()
500 // A key this control does not claim has already gone to
501 // the sink above it as a raw press, so it must not act
502 // here as well (`docs/adr/0011`, decision 3). With no
503 // sink above, nothing bubbled and every arm below runs
504 // as it always did — including Escape, which is how a
505 // control with no shortcut layer over it is let go of.
506 && !edit_key_code(ek).is_some_and(|c| self.bubbles(i, c, chord(Some(mods))))
507 {
508 // A control that is neither an editor nor a sink:
509 // Enter presses it, the arrows nudge a slider (the
510 // same events assistive technology produces), Escape
511 // lets go.
512 use crate::slider::SliderMove;
513 let slider =
514 self.tree.specs[i].access().role == Some(crate::access::Role::Slider);
515 let changes = slider && self.tree.specs[i].events().on_change.is_some();
516 // Each key the core acts with shows the focus first
517 // (`docs/adr/0002`, decision 4a): pointer focus is
518 // unshown, but the moment the keyboard uses it the
519 // user is owed the answer to "which node did that?" —
520 // a button pressed with Space after a click otherwise
521 // emits its event with nothing on screen naming it.
522 // Escape acts by letting go, and a ring around nothing
523 // is not a ring; a key the control does not claim went
524 // to the sink above and never arrives here at all.
525 // Shift with a horizontal motion on a node inside a
526 // `selectable` scope moves the scope's selection
527 // (backlog AR28) — the keyboard's half of what a
528 // drag does, and the one way a keyboard user selects
529 // a label. Under a sink the press already bubbled and
530 // never arrives here, like every other motion.
531 let scope = self.scopes.get(i).copied().flatten();
532 match ek {
533 EditKey::Left | EditKey::Right | EditKey::Home | EditKey::End
534 if mods.shift && scope.is_some() =>
535 {
536 self.focus_visible = true;
537 self.keyboard_select(scope.unwrap_or(Key::ROOT), ek, mods);
538 }
539 EditKey::Enter => {
540 self.focus_visible = true;
541 self.click_node(self.tree.keys[i], &mut out);
542 }
543 EditKey::Escape => self.move_focus(None),
544 EditKey::Right | EditKey::Up if slider => {
545 self.focus_visible = true;
546 self.nudge(i, SliderMove::Step(1), &mut out);
547 }
548 EditKey::Left | EditKey::Down if slider => {
549 self.focus_visible = true;
550 self.nudge(i, SliderMove::Step(-1), &mut out);
551 }
552 // A slider that asked for its changes takes the
553 // rest of the keys a range has (ADR 0034,
554 // decision 4); one that did not leaves them be.
555 EditKey::PageUp | EditKey::PageDown | EditKey::Home | EditKey::End
556 if changes =>
557 {
558 self.focus_visible = true;
559 let mv = match ek {
560 EditKey::PageUp => SliderMove::Page(1),
561 EditKey::PageDown => SliderMove::Page(-1),
562 EditKey::Home => SliderMove::Home,
563 _ => SliderMove::End,
564 };
565 self.nudge(i, mv, &mut out);
566 }
567 // Inside a composite the arrows, Home and End move
568 // focus among the items instead (see
569 // `docs/adr/0007-composite-keyboard-patterns.md`),
570 // showing the focus where they land; on anything
571 // else they do nothing, as before.
572 EditKey::Left
573 | EditKey::Right
574 | EditKey::Up
575 | EditKey::Down
576 | EditKey::Home
577 | EditKey::End => self.composite_step(i, ek, &mut out),
578 _ => {}
579 }
580 }
581 }
582 InputEvent::KeyDown(kp) => {
583 self.pressed_mods = Some(kp.mods);
584 if self.route_key(&kp, KeyPhase::Down, &mut out) {
585 // Held from here until its release, focus moving, or
586 // the window losing the keyboard. A repeat of a key
587 // already down is the same key, not a second one —
588 // matched by position, since Shift moving mid-hold
589 // changes the repeat's `code` (`KeyPress::same_key`).
590 if !self.keys_held.iter().any(|h| h.same_key(&kp)) {
591 self.keys_held.push(kp.released());
592 }
593 }
594 }
595 InputEvent::KeyUp(kp) => {
596 // Only a key whose press was delivered has a release to
597 // deliver: one pressed while an editor held focus, or
598 // already let go of synthetically, resolves nothing.
599 if let Some(i) = self.keys_held.iter().position(|h| h.same_key(&kp)) {
600 self.keys_held.remove(i);
601 self.route_key(&kp.released(), KeyPhase::Up, &mut out);
602 }
603 }
604 InputEvent::MouseDown { button, clicks } => {
605 // Only the primary button moves anything: a secondary
606 // press asks for a context menu where it landed and leaves
607 // focus, the caret and the scrollbars exactly as they were
608 // (a right-click on a selection has to keep it). Any
609 // non-primary press an `on_button` node claims is that
610 // node's instead, and captured by it (backlog F105).
611 let primary = button == MouseButton::Primary;
612 let mut owner = None;
613 // A scrollbar wins what it was painted over — its own
614 // scroller's content, not a float over it (ADR 0023): a
615 // thumb press starts a drag, a track press jumps there
616 // first. Neither blurs the focused edit.
617 if primary
618 && let Some(p) = self.interaction.cursor()
619 && let Some(Target::Bar(bar)) = self.interaction.target_at(p)
620 {
621 let (pos, thumb_start) = match bar.axis {
622 ScrollAxis::X => (p.x, bar.thumb.x),
623 ScrollAxis::Y => (p.y, bar.thumb.y),
624 };
625 let grab = if pos >= thumb_start && pos <= thumb_start + bar.bar_len {
626 pos - thumb_start
627 } else {
628 let center = bar.bar_len / 2.0;
629 let off = bar.offset_for(p, center);
630 self.set_scroll_axis(bar.key, bar.axis, off);
631 center
632 };
633 self.interaction.scrollbar_drag = Some((bar.key, bar.axis, grab));
634 return out;
635 }
636 // Click-to-focus / caret placement / start drag-selection,
637 // against the previous frame's layout.
638 if let Some(p) = self.interaction.cursor() {
639 let hit = self.interaction.hit_at(p).map(|h| {
640 // A region that does something with a press
641 // claims it: a button inside a selectable
642 // card is a button first (ADR 0017).
643 let claimed = h.payload.is_some()
644 || h.drag.is_some()
645 || h.key_sink.is_some()
646 || h.window.is_some();
647 let scope = h.select_scope.filter(|_| !claimed);
648 (h.key, h.edit_origin, h.focusable, scope, h.origin)
649 });
650 // While a modal is up, a press outside it never
651 // touches focus: one that finds no region asks the
652 // modal to go away (a modal is hit-tracked, so its own
653 // background is not "outside"), and one that finds the
654 // only live thing out there — window chrome — is the
655 // platform's business, not the app's.
656 if let Some(key) = self.modal()
657 && !hit.as_ref().is_some_and(|(k, ..)| self.within_modal(*k))
658 {
659 if hit.is_none() {
660 self.dismiss(key, "outside", &mut out);
661 }
662 let n = self
663 .interaction
664 .handle(InputEvent::MouseDown { button, clicks }, &mut out);
665 self.attach_pointer(&mut out, n);
666 return out;
667 }
668 // A press moves focus (to a focusable node, or to the
669 // key sink the press landed inside) or drops it; either
670 // way it is pointer focus, not shown.
671 if primary {
672 // A press anywhere ends the last selection; the
673 // arms below start whichever new one it begins.
674 // One selection per window (ADR 0017) — except a
675 // press inside the core's own context menu, which
676 // is *about* that selection: a Copy row that
677 // cleared what it was going to copy would be a
678 // menu that never works.
679 // The menu bar's Edit menu is about the selection
680 // for the same reason, so a press in it is spared
681 // the same way.
682 let origin = hit.as_ref().map(|(.., o)| *o);
683 let in_bar = origin == Some(OriginId::MENU_BAR);
684 // A Shift-press inside the scope the selection is
685 // in keeps its anchor and moves the live end: it
686 // extends, so it clears nothing (ADR 0029,
687 // decision 3). Anywhere else Shift is a press.
688 let shift = self.interaction.modifiers().shift;
689 let extends = shift
690 && hit.as_ref().is_some_and(|(_, _, _, scope, _)| {
691 scope.is_some()
692 && (self.selection.map(|s| s.scope) == *scope
693 || self.cell_selection.map(|c| c.node) == *scope)
694 });
695 // A press on a `keepFocus` node — a toolbar's Copy
696 // or Bold, acting on what the sink or editor has —
697 // is spared on the same terms as the menus (backlog
698 // DX10): it leaves the selection, the focus and the
699 // ring as they are. An editor inside one is its own
700 // keyboard owner and takes its caret as ever.
701 let keep = match hit {
702 Some((_, Some(_), true, _, _)) | None => false,
703 Some((key, ..)) => self.keeps_focus(key),
704 };
705 if origin != Some(OriginId::MENU) && !in_bar && !extends && !keep {
706 self.clear_selection();
707 }
708 // And the field a menu-bar menu will be about: this
709 // press is about to move focus onto the title, so
710 // the answer has to be taken before it does. Only
711 // on the way *in* — a press with a menu already
712 // open is a row or a second title, and focus is
713 // inside the bar by then, so asking again would
714 // record "no field" over the real answer.
715 if in_bar && self.menu_bar_open().is_none() {
716 self.note_menu_bar_editor();
717 }
718 match hit {
719 Some((key, Some(origin), true, _, _)) => {
720 // A Shift-press in the focused editor
721 // extends from its caret: cosmic-text's
722 // `Drag` is the action that moves the
723 // cursor and keeps (or seeds) the
724 // selection, which is the whole gesture.
725 let extend = shift && self.edit.focused() == Some(key);
726 self.move_focus(Some(key));
727 // The caret lands where the pointer is on
728 // the editor's upright layout, through any
729 // turn it is drawn under (ADR 0043).
730 let q = self.unturned(key, p);
731 let local = Vec2::new(q.x - origin.x, q.y - origin.y);
732 self.edit_with_fonts(|edit, fs| {
733 edit.click(key, local, clicks, extend, fs)
734 });
735 self.edit.dragging = Some((key, origin));
736 self.arm_follow(key, p);
737 }
738 // The press acts (its click is resolved on the
739 // release, as any) and moves nothing: not the
740 // focus, not the region Tab walks next — the
741 // keyboard's ring is still the one it is in —
742 // and no drag-select of its own.
743 Some(_) if keep => {}
744 // Inside a selection scope, with nothing else
745 // claiming the press: start a drag-select.
746 // One click places both ends together, two
747 // take the word, three the whole run.
748 Some((key, _, focusable, Some(scope), _)) => {
749 let target = self.press_focus(key, focusable);
750 self.move_focus(target);
751 self.settle_region(Some(key));
752 // The press arms the drag with what the
753 // click count says it moves by: a second
754 // click held and dragged selects word by
755 // word, a third run by run — in bytes or,
756 // for a grid, in cells; the arming knows.
757 // A Shift-press keeps the anchor instead
758 // and goes on by characters.
759 if self.arm_select_drag(scope, p, clicks, extends) {
760 self.arm_follow(scope, p);
761 }
762 }
763 // Everything else: a plain node, and a
764 // disabled editor (no caret to place).
765 Some((key, _, focusable, None, _)) => {
766 let target = self.press_focus(key, focusable);
767 self.move_focus(target);
768 // Whatever the press did to focus, Tab
769 // afterwards enters the ring under the
770 // pointer (`docs/adr/0022`, decision 3).
771 self.settle_region(Some(key));
772 }
773 None => {
774 self.move_focus(None);
775 self.settle_region(None);
776 }
777 }
778 self.focus_visible = false;
779 } else if let Some((key, ..)) = hit {
780 owner = self.button_owner(key, button);
781 }
782 }
783 let claimed_button = owner.is_some();
784 let n = match owner {
785 Some(owner) => self
786 .interaction
787 .press_button(button, clicks, owner, &mut out),
788 None => self
789 .interaction
790 .handle(InputEvent::MouseDown { button, clicks }, &mut out),
791 };
792 self.attach_pointer(&mut out, n);
793 // A right-click the app did not claim with `onContextMenu`
794 // or `onButton` gets the stock menu, where there is
795 // anything standard to put in one (ADR 0017, decision 5).
796 if button == MouseButton::Secondary
797 && let Some(p) = self.interaction.cursor()
798 {
799 let claimed =
800 claimed_button || out.iter().any(|e| e.kind() == Some("contextmenu"));
801 self.auto_menu(p, claimed);
802 }
803 }
804 InputEvent::CursorMoved(p) => {
805 if let Some((key, axis, grab)) = self.interaction.scrollbar_drag
806 && let Some(bar) = self
807 .interaction
808 .scrollbars
809 .iter()
810 .rev()
811 .find(|b| b.key == key && b.axis == axis)
812 .copied()
813 {
814 // Thumb drag: geometry is last frame's, which is fine —
815 // track length only changes with the container.
816 let off = bar.offset_for(p, grab);
817 self.set_scroll_axis(key, axis, off);
818 }
819 self.rehit(p);
820 self.follow_point(p);
821 let n = self
822 .interaction
823 .handle(InputEvent::CursorMoved(p), &mut out);
824 self.attach_pointer(&mut out, n);
825 }
826 InputEvent::MouseUp { button } => {
827 if button == MouseButton::Primary {
828 self.end_follow();
829 self.edit.dragging = None;
830 self.select_dragging = None;
831 self.interaction.scrollbar_drag = None;
832 }
833 let n = self
834 .interaction
835 .handle(InputEvent::MouseUp { button }, &mut out);
836 self.attach_pointer(&mut out, n);
837 }
838 InputEvent::ForceClick(p) => self.force_click(p, &mut out),
839 InputEvent::Access(req) => self.handle_access(req, &mut out),
840 other => {
841 self.interaction.handle(other, &mut out);
842 }
843 }
844 self.flush_sound_requests();
845 // Input moves focus, carets and scroll offsets: an access tree
846 // derived earlier this frame no longer describes it.
847 self.access_built = 0;
848 out
849 }
850
851 /// The node a non-primary press on region `key` goes to, with the tag
852 /// its event carries: see `enclosing_button`. Read off
853 /// the tree at the press, as a force click's tag is.
854 fn button_owner(&self, key: Key, button: MouseButton) -> Option<crate::input::ButtonOwner> {
855 let i = self.tree.index_of(key)?;
856 let j = self.enclosing_button(i, button)?;
857 Some(crate::input::ButtonOwner {
858 key: self.tree.keys[j],
859 origin: self.tree.origins[j],
860 tag: self.tree.specs[j].events().on_button.clone()?,
861 })
862 }
863
864 /// A force click. Over text — an editor or a
865 /// `selectable` scope — it selects the word under it and asks the host
866 /// for its definition panel, which is what the gesture means on the
867 /// one platform that has it. Anywhere else it reaches a node
868 /// declaring `on_force_click`, and over anything else it does
869 /// nothing at all.
870 ///
871 /// It moves no focus and places no caret: it happens *during* a press
872 /// that is still running, and stealing the caret out from under a
873 /// drag would be a gesture fighting itself.
874 fn force_click(&mut self, p: Vec2, out: &mut Vec<UiEvent>) {
875 let Some(region) = self.interaction.hit_at(p) else {
876 return;
877 };
878 let (key, origin) = (region.key, region.origin);
879 // Read off the tree rather than carried on the region: a force
880 // click is one event in a session, and a tag on `HitRegion` is a
881 // clone on every region of every frame (C15's rule — a node pays
882 // for props it does not declare).
883 let tag = self
884 .tree
885 .keys
886 .iter()
887 .position(|k| *k == key)
888 .and_then(|i| self.tree.specs[i].events().on_force_click.clone());
889 let editor = region.edit_origin.map(|origin| (key, origin));
890 let scope = region.select_scope;
891 // Text first: the word under the pointer, selected, and looked up.
892 // The press that deepened into this force click is still running,
893 // and its drag would overwrite the word the moment the finger
894 // moved a pixel — which is what "the panel says one word and the
895 // highlight is one character" looks like. The gesture takes the
896 // press over: no caret drag, no selection drag.
897 self.select_dragging = None;
898 self.edit.dragging = None;
899 self.drag_follow = None;
900 if let Some((key, content_origin)) = editor {
901 let q = self.unturned(key, p);
902 let local = Vec2::new(q.x - content_origin.x, q.y - content_origin.y);
903 self.move_focus(Some(key));
904 self.edit_with_fonts(|edit, fs| edit.click(key, local, 2, false, fs));
905 self.menu_editor = Some(key);
906 if let Some(action) = self.lookup_action() {
907 self.menu_actions.push(action);
908 }
909 return;
910 }
911 if let Some(scope) = scope {
912 // A force click is a double click that also asks for a
913 // definition, so it takes the same word the second click
914 // would have.
915 if !self.select_word_under(scope, p) {
916 return;
917 }
918 // A force click between words is a force click on nothing:
919 // looking up a space would put a dictionary panel over the
920 // page for no reason, which is not what the gesture does
921 // anywhere else on the platform.
922 if self.copy_selection().is_none_or(|t| t.trim().is_empty()) {
923 self.clear_selection();
924 return;
925 }
926 if let Some(action) = self.lookup_action() {
927 self.menu_actions.push(action);
928 }
929 return;
930 }
931 // Not text: the node's own event, if it asked for one.
932 let Some(tag) = tag else { return };
933 let payload = Value::map([
934 ("kind", Value::str("forceclick")),
935 ("x", Value::Float(p.x as f64)),
936 ("y", Value::Float(p.y as f64)),
937 ]);
938 out.push(UiEvent::on(origin, key, payload).tagged(Some(&tag)));
939 }
940
941 /// Resolves a request from assistive technology against the last
942 /// frame the way the pointer or keyboard equivalent would be (see
943 /// [`crate::access::AccessAction`]).
944 fn handle_access(&mut self, req: crate::access::AccessRequest, out: &mut Vec<UiEvent>) {
945 use crate::access::AccessAction;
946 let key = req.key;
947 let idx = self.tree.index_of(key);
948 // The gates every other channel obeys (AR18): a node outside the
949 // modal is inert (ADR 0003 decision 5) and a disabled one takes no
950 // action. Only `Click` resolved against the hit list before; a
951 // reader edited, nudged and scrolled the page behind a dialog,
952 // and `Focus` on an editor there routed typing to it until the
953 // next frame's containment.
954 if let Some(i) = idx
955 && !self.interactive(i)
956 {
957 // The access tree is not pruned (ADR 0003 decision 7), so a
958 // reader can name a node behind the modal, and its click is
959 // the press outside: the modal is asked to go away, and the
960 // node hears nothing (decision 6). Dropped on the floor, a
961 // select's field clicked a second time left its own menu
962 // open where the pointer closes it (backlog RG13). Every
963 // other request behind a modal does nothing — nothing a
964 // pointer does to the page behind a dialog moves its text.
965 if req.action == AccessAction::Click
966 && let Some(modal) = self.modal()
967 {
968 self.dismiss(modal, "outside", out);
969 }
970 return;
971 }
972 // Disabled: what the access tree refuses to advertise, so a
973 // request naming one is a reader working from a stale tree, or a
974 // headless test.
975 if let Some(i) = idx
976 && self.tree.specs[i].disabled
977 {
978 return;
979 }
980 match req.action {
981 AccessAction::Click => self.click_node(key, out),
982 AccessAction::Focus => {
983 // The reader's cursor lands where Tab would — on a node it
984 // can see (decoration is not in its tree); show it.
985 let exposed = self.access_tree().get(key).is_some();
986 if exposed && idx.is_some_and(|i| crate::access::focusable(&self.tree, i)) {
987 self.move_focus(Some(key));
988 self.focus_visible = true;
989 }
990 }
991 AccessAction::Blur => {
992 if self.focus == Some(key) {
993 self.move_focus(None);
994 }
995 }
996 AccessAction::SetValue => {
997 if self.edit.contains(key) {
998 let value = req.value.unwrap_or_default();
999 if self.edit.text(key).as_deref() != Some(value.as_str()) {
1000 self.set_edit_text(key, &value);
1001 self.push_edit_event(key, "changed", out);
1002 }
1003 } else if let Some(i) = idx
1004 && crate::access::is_custom_editor(&self.tree, i)
1005 {
1006 // The app owns the text: hand the request over as data.
1007 let payload = Value::map([
1008 ("kind", Value::str("access")),
1009 ("action", Value::str(req.action.name())),
1010 ("text", Value::str(req.value.unwrap_or_default())),
1011 ]);
1012 out.push(
1013 UiEvent::on(self.tree.origins[i], key, payload)
1014 .tagged(self.access_tag(i).as_ref()),
1015 );
1016 } else if let Some(i) = idx {
1017 self.set_slider(i, req.value.as_deref().unwrap_or_default(), out);
1018 }
1019 }
1020 AccessAction::Increment | AccessAction::Decrement => {
1021 let Some(i) = idx else { return };
1022 let n = if req.action == AccessAction::Increment {
1023 1
1024 } else {
1025 -1
1026 };
1027 self.nudge(i, crate::slider::SliderMove::Step(n), out);
1028 }
1029 AccessAction::SetTextSelection | AccessAction::ReplaceSelectedText => {
1030 let Some(i) = idx else { return };
1031 if self.edit.contains(key) {
1032 match req.action {
1033 AccessAction::SetTextSelection => {
1034 let (Some(anchor), Some(focus)) = (req.anchor, req.focus) else {
1035 return;
1036 };
1037 // Run positions resolve against the tree of
1038 // the last frame, which is what the request
1039 // was made from.
1040 let tree = self.access_tree();
1041 let Some(node) = tree.get(key) else { return };
1042 let (Some(a), Some(f)) =
1043 (node.line_offset(anchor), node.line_offset(focus))
1044 else {
1045 return;
1046 };
1047 self.edit.set_selection(key, a, f);
1048 self.editor_took_selection(key);
1049 }
1050 _ => {
1051 let text = req.value.unwrap_or_default();
1052 if self
1053 .edit_with_fonts(|edit, fs| edit.replace_selection(key, &text, fs))
1054 {
1055 self.push_edit_event(key, "changed", out);
1056 }
1057 }
1058 }
1059 } else if crate::access::is_custom_editor(&self.tree, i) {
1060 // The app owns the text: hand the request over as data.
1061 let mut entries = vec![
1062 ("kind".to_string(), Value::str("access")),
1063 ("action".to_string(), Value::str(req.action.name())),
1064 ];
1065 if let Some(text) = req.value {
1066 entries.push(("text".to_string(), Value::str(text)));
1067 }
1068 if let (Some(anchor), Some(focus)) = (req.anchor, req.focus) {
1069 let tree = self.access_tree();
1070 let Some(node) = tree.get(key) else { return };
1071 let (Some(a), Some(f)) =
1072 (node.line_offset(anchor), node.line_offset(focus))
1073 else {
1074 return;
1075 };
1076 let pos = |(line, offset): (usize, usize)| {
1077 Value::map([
1078 ("line", Value::Int(line as i64)),
1079 ("offset", Value::Int(offset as i64)),
1080 ])
1081 };
1082 entries.push(("anchor".to_string(), pos(a)));
1083 entries.push(("focus".to_string(), pos(f)));
1084 }
1085 let ev = self.tree.specs[i].events();
1086 let tag = ev
1087 .on_click
1088 .clone()
1089 .or_else(|| ev.on_drag.clone())
1090 .or_else(|| ev.on_key.clone());
1091 out.push(
1092 UiEvent::on(self.tree.origins[i], key, Value::Map(entries))
1093 .tagged(tag.as_ref()),
1094 );
1095 }
1096 }
1097 AccessAction::ScrollIntoView => {
1098 let Some(i) = idx else { return };
1099 let rect = Rect::from_pos_size(self.tree.pos[i], self.tree.size[i]);
1100 self.scroll_rect_into_view(i, rect, false);
1101 }
1102 AccessAction::ScrollUp
1103 | AccessAction::ScrollDown
1104 | AccessAction::ScrollLeft
1105 | AccessAction::ScrollRight => {
1106 let Some(i) = idx else { return };
1107 let size = self.tree.size[i];
1108 let delta = match req.action {
1109 AccessAction::ScrollUp => Vec2::new(0.0, -size.h * 0.8),
1110 AccessAction::ScrollDown => Vec2::new(0.0, size.h * 0.8),
1111 AccessAction::ScrollLeft => Vec2::new(-size.w * 0.8, 0.0),
1112 _ => Vec2::new(size.w * 0.8, 0.0),
1113 };
1114 self.scroll.scroll_by(key, delta);
1115 }
1116 }
1117 }
1118
1119 /// The `tag` an `access` event on node `i` carries: its click payload,
1120 /// else its drag or key tag; None when there is none (or it is null).
1121 pub(crate) fn access_tag(&self, i: usize) -> Option<Value> {
1122 let ev = self.tree.specs[i].events();
1123 ev.on_click
1124 .clone()
1125 .or_else(|| ev.on_drag.clone())
1126 .or_else(|| ev.on_key.clone())
1127 .filter(|t| *t != Value::Null)
1128 }
1129
1130 /// The key of the first node in tree order, in the last finished
1131 /// frame, whose accessible name is `name` — what a screen reader reads
1132 /// it as: its `label` row, else its own text, else a control's derived
1133 /// name (a button's text inside it). Not the key label `key_of` reads,
1134 /// which is the name the view opened the node under and a reader never
1135 /// hears. The window itself is not matched. More than one node with
1136 /// the name raises `ambiguous-name`; None when none has it. From
1137 /// inside a view, the tree is the last one derived ([`Self::access_tree`]).
1138 pub fn key_named(&mut self, name: &str) -> Option<Key> {
1139 use crate::access::Role;
1140 let (first, count, caption) = {
1141 let mut hits = self
1142 .access_tree()
1143 .nodes
1144 .iter()
1145 .skip(1)
1146 .filter(|n| n.name.as_deref() == Some(name));
1147 let head = hits.next()?;
1148 // A caption beside the control it repeats is text and a
1149 // control under one name (backlog F140).
1150 let (mut count, mut text, mut other) = (0, false, false);
1151 for n in std::iter::once(head).chain(hits) {
1152 count += 1;
1153 if n.role == Role::StaticText {
1154 text = true;
1155 } else {
1156 other = true;
1157 }
1158 }
1159 (head.key, count, text && other)
1160 };
1161 if count > 1 {
1162 self.diag.raise(if caption {
1163 crate::diag::ambiguous_caption(name, first, count)
1164 } else {
1165 crate::diag::ambiguous_name(name, first, count)
1166 });
1167 }
1168 Some(first)
1169 }
1170
1171 /// The access tree of the last finished frame (see [`crate::access`]):
1172 /// derived on the first call after a frame, then reused. A driver that
1173 /// never asks pays nothing. Asked while a frame is being built, it is
1174 /// the last tree derived, unchanged: the frame in progress is half a
1175 /// tree, and caching it would serve that half for the whole frame.
1176 pub fn access_tree(&mut self) -> &crate::access::AccessTree {
1177 if self.access_built != self.frame_no && !self.building {
1178 let src = crate::access::Sources {
1179 text: &self.text,
1180 cells: &self.cells,
1181 edit: &self.edit,
1182 scroll: &self.scroll,
1183 title: self.window_title.as_deref(),
1184 focus: self.focus,
1185 modal: self.modal(),
1186 viewport: self.viewport,
1187 scale: self.scale,
1188 clips: &self.clips,
1189 };
1190 // Deriving the tree is about 480 µs on a 10,000-node frame and
1191 // is paid on every frame a screen reader is attached; hashing
1192 // what it reads is about 105 µs, because three quarters of the
1193 // work is making the nodes rather than walking to them. So a
1194 // frame that changed nothing this tree can see — a pointer
1195 // moving across hover backgrounds, a colour transition — keeps
1196 // the one it had. See `access::inputs_hash` for the invariant
1197 // that makes it safe, and ADR 0016 decision 3 for why this is
1198 // the one thing in the frame that gets cached.
1199 let hash = crate::access::inputs_hash(&self.tree, &src);
1200 if hash.is_none() || self.access_inputs != hash {
1201 self.access = crate::access::build(&self.tree, &src);
1202 self.access_rebuilds += 1;
1203 }
1204 self.access_inputs = hash;
1205 self.access_built = self.frame_no;
1206 }
1207 &self.access
1208 }
1209
1210 /// Delivers one key event to the sink it resolves to, tagged with that
1211 /// sink's `on_key` payload; returns whether anything took it. The
1212 /// focused edit widget owns the keyboard (it takes the Text/EditKey
1213 /// path), so a sink only hears while no editor is focused and it is
1214 /// still in the last frame's hit list. *Which* sink is
1215 /// [`Self::key_target`]'s answer: the focused one, or — when a control
1216 /// holds focus and does not claim this key — the nearest one above it.
1217 fn route_key(&mut self, kp: &KeyPress, phase: KeyPhase, out: &mut Vec<UiEvent>) -> bool {
1218 if self.edit.focused().is_some() {
1219 return false;
1220 }
1221 let Some(target) =
1222 self.key_target(kp.code, kp.mods.ctrl || kp.mods.alt || kp.mods.super_key)
1223 else {
1224 return false;
1225 };
1226 // A sink hears releases only by asking (`key_up`): press-only is
1227 // the keymap case, and a keymap handed both halves runs every
1228 // binding twice. The key is still tracked as held either way, so
1229 // a sink that opts in mid-hold hears the release it is owed.
1230 if phase == KeyPhase::Up
1231 && !self
1232 .sink_node(target)
1233 .is_some_and(|i| self.tree.specs[i].events().key_up)
1234 {
1235 return false;
1236 }
1237 // A modifier or lock key reaches only a sink that asked for them
1238 // (`modifier_keys`, backlog F108): to any other it is held, not
1239 // pressed, and never held as a key either — so its release has
1240 // nothing to find.
1241 if kp.code.is_modifier()
1242 && !self
1243 .sink_node(target)
1244 .is_some_and(|i| self.tree.specs[i].events().modifier_keys)
1245 {
1246 return false;
1247 }
1248 self.deliver_to_sink(target, kp.to_value(phase), out)
1249 }
1250
1251 /// The node the sink `key` names, in the last frame's tree: one that
1252 /// declares `on_key`, is not disabled, and is not shut out by a
1253 /// modal.
1254 ///
1255 /// Asked of the tree and not of the hit list, because a key is not
1256 /// pointer input. The hit list is where a *point* finds a node, and
1257 /// a node outside its scroller's clip is not under any point, so it
1258 /// has no region there (`emit_node` is never reached for it) — while
1259 /// the keyboard reaches a node by having focus, which a node keeps
1260 /// wherever it is drawn. Before F79 the delivery read the hit list
1261 /// like a click, so a focused sink scrolled out of view, or drawn
1262 /// part-way to its place by `slide` or an `enter` offset, dropped
1263 /// every key typed at it until it came back.
1264 fn sink_node(&self, key: Key) -> Option<usize> {
1265 let i = (0..self.tree.len())
1266 .rev()
1267 .find(|&i| self.tree.keys[i] == key)?;
1268 let spec = &self.tree.specs[i];
1269 (spec.events().on_key.is_some() && !spec.disabled && self.interactive(i)).then_some(i)
1270 }
1271
1272 /// Hands `payload` to the sink `target` names with the sink's tag
1273 /// merged in — the one delivery both key channels end in. False when
1274 /// the last frame declared no such sink.
1275 fn deliver_to_sink(&self, target: Key, payload: Value, out: &mut Vec<UiEvent>) -> bool {
1276 let Some(i) = self.sink_node(target) else {
1277 return false;
1278 };
1279 out.push(
1280 UiEvent::on(self.tree.origins[i], self.tree.keys[i], payload)
1281 .tagged(self.tree.specs[i].events().on_key.as_ref()),
1282 );
1283 true
1284 }
1285
1286 /// Delivers `payload` to the sink the focused node reports to — the
1287 /// focused sink itself, or the nearest one above a focused control —
1288 /// with the sink's tag merged in, the way a `key` event is. A
1289 /// composition is never a control's to claim, so unlike `route_key`
1290 /// nothing is asked about the key. False with no sink to hear it.
1291 fn sink_event(&mut self, payload: Value, out: &mut Vec<UiEvent>) -> bool {
1292 let Some(i) = self.focus_index() else {
1293 // With nothing focused, the root sink that hears every
1294 // unclaimed key (`key_target`) hears this too — a paste a
1295 // shell asked for with nothing focused would otherwise
1296 // vanish (backlog C33). Not under a modal.
1297 if self.tree.is_empty() || self.modal.is_some() {
1298 return false;
1299 }
1300 let root = &self.tree.specs[0];
1301 if root.events().on_key.is_none() || root.disabled {
1302 return false;
1303 }
1304 return self.deliver_to_sink(self.tree.keys[0], payload, out);
1305 };
1306 let target = if self.tree.specs[i].events().on_key.is_some() {
1307 self.tree.keys[i]
1308 } else {
1309 match self.enclosing_sink(i) {
1310 Some(j) => self.tree.keys[j],
1311 None => return false,
1312 }
1313 };
1314 self.deliver_to_sink(target, payload, out)
1315 }
1316
1317 /// Lets go of every key the focused sink is holding, as if the user
1318 /// had released them: each becomes a `{kind="key", phase="up"}` on the
1319 /// sink that took the press. Called when focus moves — a keymap that
1320 /// armed a mode on the way down has to hear the way up, and the node
1321 /// it moved to never saw the press — and by drivers when the window
1322 /// loses the keyboard (Cmd-Tab while a key is down otherwise leaves it
1323 /// stuck down forever).
1324 pub fn release_held_keys(&mut self) {
1325 if self.keys_held.is_empty() {
1326 return;
1327 }
1328 let mut out = Vec::new();
1329 let mut held = std::mem::take(&mut self.keys_held);
1330 while !held.is_empty() {
1331 let mut kp = held.remove(0);
1332 // A modifier key's release reports the state after it, as a
1333 // real one does (ADR 0002, decision 15): its own bit off
1334 // unless its twin is still down to be let go of next. The
1335 // press stored it on (backlog RG85).
1336 let on = held.iter().any(|h| h.code == kp.code);
1337 match kp.code {
1338 KeyCode::Shift => kp.mods.shift = on,
1339 KeyCode::Ctrl => kp.mods.ctrl = on,
1340 KeyCode::Alt => kp.mods.alt = on,
1341 KeyCode::Super => kp.mods.super_key = on,
1342 _ => {}
1343 }
1344 self.route_key(&kp, KeyPhase::Up, &mut out);
1345 }
1346 // Pending rather than returned: the writers are `set_focus` and the
1347 // driver's window-focus report, neither of which is answering an
1348 // input event. `handle_input` appends it before returning, so a
1349 // click that moved focus and the release it forced arrive together.
1350 self.pending.append(&mut out);
1351 }
1352
1353 /// The driver's report that this window gained or lost the keyboard:
1354 /// `env.focused`, plus the one rule that rides on it — a window that
1355 /// lost the keyboard lets go of every key its sink was holding, since
1356 /// the OS stops delivering key events to it and the release would
1357 /// never arrive. The rule lives here rather than in each driver so a
1358 /// Node test's `setEnv({focused: false})` and a C host's `kui_env_set`
1359 /// do what the windowed runner does, instead of each remembering to.
1360 /// The synthetic `up`s are pending, like `release_held_keys`'s, and so
1361 /// are the `release`s of the buttons `onButton` nodes held.
1362 pub fn set_focused(&mut self, focused: bool) {
1363 if self.env.focused == focused {
1364 return;
1365 }
1366 self.env.focused = focused;
1367 // The app hears it as a window event rather than diffing
1368 // `env.focused` every frame (backlog DX18).
1369 let (name, id) = (self.window_name(), self.env.window.id);
1370 self.push_window_event(if focused { "focused" } else { "blurred" }, &name, id);
1371 if !focused {
1372 self.release_held_keys();
1373 // The modifiers go with the keys: a Shift released in another
1374 // window never reaches this one, and a host that does not
1375 // resend the state on the way back (winit does; a C loop may
1376 // not) would otherwise leave every later press an extending
1377 // one. The app hears it as the `modifiers` event it is.
1378 let mut out = Vec::new();
1379 self.interaction.handle(
1380 InputEvent::Modifiers(crate::input::KeyMods::default()),
1381 &mut out,
1382 );
1383 // And the buttons an `onButton` node holds captured (backlog
1384 // F105): each owner hears its release now, with the cell it
1385 // lands in, rather than every later move as a drag.
1386 let n = self.interaction.release_buttons(&mut out);
1387 self.attach_pointer(&mut out, n);
1388 // And the primary button's hold (backlog RG75): a drag or a
1389 // slide ends where the pointer was, a caret drag, a
1390 // selection drag and a scrollbar drag stop, and the press
1391 // clicks nothing — the release, like the buttons', is not
1392 // coming here, and every move after the window came back
1393 // went on dragging with no button down.
1394 self.edit.dragging = None;
1395 self.select_dragging = None;
1396 self.interaction.scrollbar_drag = None;
1397 let n = self.interaction.release_primary(&mut out);
1398 self.attach_pointer(&mut out, n);
1399 self.pending.append(&mut out);
1400 // And a held drag's follow: the release will not come here,
1401 // and a scroller stepping toward a pointer nobody holds any
1402 // more is a window asking for frames until one does.
1403 self.drag_follow = None;
1404 }
1405 }
1406
1407 /// The sink a chord pressed now would reach, if any: the focused sink,
1408 /// the nearest one above the focused control, or the root's with
1409 /// nothing focused. What a
1410 /// driver asks before greying a menu row that spells a chord — a sink
1411 /// that would hear ⌘C may do anything with it, so the row stays lit.
1412 pub fn chord_sink(&self) -> Option<Key> {
1413 if self.edit.focused().is_some() {
1414 return None;
1415 }
1416 self.key_target(KeyCode::Char('c'), true)
1417 }
1418
1419 /// Which node hears a raw press: the focused sink, the nearest sink
1420 /// above a focused control that does not claim the key, or nothing.
1421 ///
1422 /// `chord` is whether a modifier other than Shift is down. A chord is
1423 /// never a control's key — it is what a shortcut layer is made of — so
1424 /// it bubbles whatever the focused control would have done with the
1425 /// bare key.
1426 fn key_target(&self, code: KeyCode, chord: bool) -> Option<Key> {
1427 // With nothing focused there is nothing to claim, and the sink
1428 // that hears every unclaimed key in the tree — one on the root —
1429 // hears this one too (`docs/adr/0022`, decision 8). Not under a
1430 // modal, where the root is inert like everything outside it. A
1431 // shell used to take focus on the root to get this.
1432 let Some(i) = self.focus_index() else {
1433 // Tab is still the ring's: it enters, and the sink does not
1434 // hear it — a chord on it bubbles as any chord does.
1435 if self.tree.is_empty() || self.modal.is_some() || (!chord && code == KeyCode::Tab) {
1436 return None;
1437 }
1438 let root = &self.tree.specs[0];
1439 return (root.events().on_key.is_some() && !root.disabled).then_some(self.tree.keys[0]);
1440 };
1441 // A sink that holds focus keeps everything, as it always has
1442 // (`docs/adr/0002`, decision 3).
1443 if self.tree.specs[i].events().on_key.is_some() {
1444 return Some(self.tree.keys[i]);
1445 }
1446 if !chord && self.claims(i, code) {
1447 return None;
1448 }
1449 self.enclosing_sink(i).map(|j| self.tree.keys[j])
1450 }
1451
1452 /// Whether the key `code` pressed on the focused node `i` reaches a
1453 /// sink above it instead of the node itself — the question the
1454 /// `EditKey` and `Text` channels ask, so that both agree with the raw
1455 /// press channel about who owns the key. False with no sink above, so
1456 /// a key nothing claims does exactly what it did before.
1457 fn bubbles(&self, i: usize, code: KeyCode, chord: bool) -> bool {
1458 (chord || !self.claims(i, code)) && self.enclosing_sink(i).is_some()
1459 }
1460
1461 /// Whether the focused node `i` takes `code` for itself: the keys the
1462 /// core acts on *for that node*, which are exactly the keys that never
1463 /// bubble. Static — a press is resolved
1464 /// on its way down, before the channel that would act on it arrives,
1465 /// so the question has to be answerable from the node and the key
1466 /// alone rather than from what a handler did.
1467 fn claims(&self, i: usize, code: KeyCode) -> bool {
1468 use crate::access::Role;
1469 // A space bar reported as a character is still the space bar.
1470 let code = match code {
1471 KeyCode::Char(' ') => KeyCode::Space,
1472 c => c,
1473 };
1474 // Tab belongs to the ring wherever focus is: a shell sink that
1475 // heard every Tab would be this ADR's own bug in reverse.
1476 if code == KeyCode::Tab {
1477 return true;
1478 }
1479 // Only a control the core presses itself claims anything else; a
1480 // plain box someone focused by hand claims nothing.
1481 if self.focused_control() != Some(i) {
1482 return false;
1483 }
1484 let key = self.tree.keys[i];
1485 // Enter and Space activate what there is to activate: a node with
1486 // no click payload has nothing, so its Space is free to bubble.
1487 let activates = self
1488 .interaction
1489 .hits
1490 .iter()
1491 .rev()
1492 .find(|h| h.key == key)
1493 .is_some_and(|h| h.payload.is_some() || h.window.is_some());
1494 let item = crate::composite::owner(&self.tree, i, &mut Vec::new()).is_some();
1495 let slider = self.tree.specs[i].access().role == Some(Role::Slider);
1496 let changes = slider && self.tree.specs[i].events().on_change.is_some();
1497 match code {
1498 KeyCode::Enter => activates,
1499 // Inside a composite, Space either extends a type-ahead search
1500 // or presses the item (`docs/adr/0007`, decision 9).
1501 KeyCode::Space => activates || item,
1502 KeyCode::Left | KeyCode::Right | KeyCode::Up | KeyCode::Down => slider || item,
1503 KeyCode::Home | KeyCode::End => item || changes,
1504 KeyCode::PageUp | KeyCode::PageDown => changes,
1505 // Type-ahead inside a composite; nothing anywhere else.
1506 KeyCode::Char(_) => item,
1507 _ => false,
1508 }
1509 }
1510
1511 /// Whether the focused node is a key sink (it owns its keys).
1512 fn focused_sink(&self) -> bool {
1513 self.focus_index()
1514 .is_some_and(|i| self.tree.specs[i].events().on_key.is_some())
1515 }
1516
1517 /// The focused node when it is a control the core presses itself:
1518 /// not an editor, not a key sink, and still focusable.
1519 fn focused_control(&self) -> Option<usize> {
1520 let i = self.focus_index()?;
1521 let spec = &self.tree.specs[i];
1522 let editor = matches!(self.tree.content[i], NodeContent::Edit(_));
1523 (!editor && spec.events().on_key.is_none() && crate::access::focusable(&self.tree, i))
1524 .then_some(i)
1525 }
1526
1527 /// Activates node `key` the way a pointer click would — against the
1528 /// last frame's hit regions, so a disabled node emits nothing — for
1529 /// Enter, Space and an assistive-technology `click`. Focus follows
1530 /// into an editor or a sink, as a click's would.
1531 pub(crate) fn click_node(&mut self, key: Key, out: &mut Vec<UiEvent>) {
1532 let Some(h) = self.interaction.hits.iter().rev().find(|h| h.key == key) else {
1533 return;
1534 };
1535 let (origin, payload, window, sound) =
1536 (h.origin, h.payload.clone(), h.window, h.click_sound);
1537 let takes_focus = h.focusable && (h.edit_origin.is_some() || h.key_sink.is_some());
1538 // Not a press: the payload gains no `cell` and no `line` /
1539 // `byte` / `clicks` from wherever the pointer rests — only what
1540 // `Interaction::handle` made from a press does (`attach_pointer`)
1541 // — and the count the last press carried describes nothing now.
1542 self.interaction.note_synthetic_click();
1543 if let Some(sound) = sound {
1544 self.interaction.sound_requests.push(sound);
1545 }
1546 match (window, payload) {
1547 (Some(crate::window::WindowRole::Button(b)), _) => self
1548 .interaction
1549 .window_commands
1550 .push(b.command(self.env.window.id)),
1551 (None, Some(payload)) => out.push(UiEvent {
1552 origin,
1553 window: WindowId::MAIN,
1554 key,
1555 payload,
1556 slot: None,
1557 }),
1558 _ => {}
1559 }
1560 if takes_focus {
1561 self.move_focus(Some(key));
1562 }
1563 }
1564
1565 /// The modal `key` was asked to go away — Escape, or a press outside
1566 /// it. Reaches the app as `{kind="dismiss", reason, tag}` on the modal
1567 /// node; what happens next is the app's, since only it can stop
1568 /// declaring the node.
1569 fn dismiss(&mut self, key: Key, reason: &str, out: &mut Vec<UiEvent>) {
1570 let Some(i) = self.tree.index_of(key) else {
1571 return;
1572 };
1573 let payload = Value::map([
1574 ("kind", Value::str("dismiss")),
1575 ("reason", Value::str(reason)),
1576 ]);
1577 out.push(
1578 UiEvent::on(self.tree.origins[i], key, payload)
1579 .tagged(self.tree.specs[i].events().modal.as_ref()),
1580 );
1581 }
1582
1583 pub(crate) fn push_edit_event(&self, key: Key, kind: &str, out: &mut Vec<UiEvent>) {
1584 out.push(UiEvent {
1585 origin: self.edit.origin_of(key).unwrap_or(OriginId::HOST),
1586 window: WindowId::MAIN,
1587 key,
1588 payload: Value::map([("kind", kind.into())]),
1589 slot: None,
1590 });
1591 }
1592
1593 /// The window's selected text, for clipboard integration: the
1594 /// selection in a `selectable` scope when there is one, else the
1595 /// focused editor's. Only one of the two exists at a time — starting
1596 /// either clears the other
1597 /// — so this asks in that order rather than merging them.
1598 pub fn copy_selection(&self) -> Option<String> {
1599 self.note_read(|| replay::Read::Opaque);
1600 if self.selection.is_some() {
1601 return self.selection_text();
1602 }
1603 if self.cell_selection.is_some() {
1604 return self.cell_selection_text();
1605 }
1606 self.edit.copy_selection(self.edit.focused()?)
1607 }
1608
1609 /// One selection per window, in the direction
1610 /// `set_selection` does not cover: an editor's selection started by
1611 /// the keyboard — Select All, Shift+arrows, a reader's
1612 /// `setTextSelection` — takes the window's one selection with it, so
1613 /// a scope's or a grid's highlight goes and Cmd-A / Cmd-C read the
1614 /// editor and not the label dragged over before Tab.
1615 fn editor_took_selection(&mut self, key: Key) {
1616 if self.edit.has_selection(key) {
1617 self.selection = None;
1618 self.cell_selection = None;
1619 }
1620 }
1621
1622 /// Cuts the focused editor's selection, returning the removed text.
1623 /// A cut is an edit like any other, so the editor's `changed` is
1624 /// pending for the caller to route — like a `resize`, since the
1625 /// caller is not answering an input event.
1626 pub fn cut_selection(&mut self) -> Option<String> {
1627 let key = self.edit.focused()?;
1628 let text = self.cut_editor(key)?;
1629 let mut out = Vec::new();
1630 self.push_edit_event(key, "changed", &mut out);
1631 self.pending.append(&mut out);
1632 Some(text)
1633 }
1634
1635 /// Deletes editor `key`'s selection, returning what was there — the
1636 /// one mutation both cuts share; the `changed` is the caller's to
1637 /// post where its batch goes.
1638 pub(crate) fn cut_editor(&mut self, key: Key) -> Option<String> {
1639 let text = self.edit.copy_selection(key)?;
1640 self.edit_with_fonts(|edit, fs| edit.delete_selection(key, fs));
1641 Some(text)
1642 }
1643
1644 /// Current text of an editor by key.
1645 pub fn edit_text(&self, key: Key) -> Option<String> {
1646 let t = self.edit.text(key);
1647 self.note_read(|| replay::Read::EditText(key, t.clone()));
1648 t
1649 }
1650
1651 /// Replaces an editor's text, leaving the caret at the end.
1652 ///
1653 /// The key need not have an editor behind it yet: an `update` that
1654 /// opens a rename field runs a frame ahead of the view that declares
1655 /// it, so the text is held and seeds the editor the next frame
1656 /// declares under this key, over its `initial`. Held for that one
1657 /// frame — a key nothing declares on it drops its text and raises
1658 /// [`crate::diag::EDIT_TEXT_WITHOUT_EDITOR`].
1659 ///
1660 /// Returns whether the text reached an editor now. `false` is the
1661 /// held case: nothing on screen changed, and a driver that redraws on
1662 /// it re-lowers the tree that declares no editor, which is the frame
1663 /// the hold expires on — so a binding asks for a redraw
1664 /// only on `true`.
1665 pub fn set_edit_text(&mut self, key: Key, text: &str) -> bool {
1666 let sess = &mut *self.session.state();
1667 self.edit
1668 .set_text(key, text, &mut sess.fonts, &sess.resources)
1669 }
1670
1671 /// The same call by the name the view declares — an editor's `key`
1672 /// prop / `label` — for the app that has no key to give: the hex key
1673 /// comes from an event the node fired, and an editor a rename opens
1674 /// for the first time has fired none.
1675 ///
1676 /// A label some frame declared resolves now ([`Core::key_of`]) and
1677 /// this is [`Core::set_edit_text`] on that key. One nothing has
1678 /// declared — a first open, or a second one, since an editor closed
1679 /// in between was in no recent frame — is held for the next frame
1680 /// that declares an editor under it, and seeds it there. An editor
1681 /// retained while its key was off screen takes the text over its
1682 /// draft, which is what a `set_edit_text` by key cannot say.
1683 ///
1684 /// Held for that one frame: a label nothing declares on it drops its
1685 /// text and raises [`crate::diag::EDIT_TEXT_WITHOUT_EDITOR`].
1686 ///
1687 /// Returns whether the text reached an editor now, as
1688 /// [`Core::set_edit_text`] does; a label held is `false`.
1689 pub fn set_edit_text_by_label(&mut self, label: &str, text: &str) -> bool {
1690 match self.key_of(label) {
1691 Some(key) => self.set_edit_text(key, text),
1692 None => {
1693 self.edit.hold_label(label, text);
1694 false
1695 }
1696 }
1697 }
1698
1699 /// The pointer shape for wherever the pointer is now, derived from the
1700 /// frame's hit regions (see [`crate::cursor`]). Per-frame output like
1701 /// the window commands, but a query rather than a drain: it is a state,
1702 /// not a queue, so a driver reads it after each input and each frame and
1703 /// only touches the window when the answer changes. Headless drivers
1704 /// never read it, and the core stays device-free.
1705 pub fn cursor_shape(&self) -> crate::cursor::CursorShape {
1706 self.interaction.cursor_shape()
1707 }
1708}
1709
1710/// The raw key an editing key came from, for the keys a focused control
1711/// acts on — the one place the two input channels have to name the same
1712/// press. `None` for the editing vocabulary
1713/// with no control behaviour behind it (Backspace, PageUp, Undo): those
1714/// arms do nothing on a control either way.
1715fn edit_key_code(ek: EditKey) -> Option<KeyCode> {
1716 Some(match ek {
1717 EditKey::Enter => KeyCode::Enter,
1718 EditKey::Escape => KeyCode::Escape,
1719 EditKey::Tab => KeyCode::Tab,
1720 EditKey::Left => KeyCode::Left,
1721 EditKey::Right => KeyCode::Right,
1722 EditKey::Up => KeyCode::Up,
1723 EditKey::Down => KeyCode::Down,
1724 EditKey::Home => KeyCode::Home,
1725 EditKey::End => KeyCode::End,
1726 _ => return None,
1727 })
1728}
1729
1730/// The access tree is cached on a hash of what
1731/// derives it, so every input that hash misses is a frame that serves a
1732/// stale reading. One case per input `access::build` reads, each mutating
1733/// only that input and asserting the tree was derived again *and* came out
1734/// different; plus the case the cache exists for, where a frame changes
1735/// something the tree cannot see and keeps the one it had.
1736#[cfg(test)]
1737mod access_cache {
1738 use crate::access::{Live, Role};
1739 use crate::*;
1740
1741 /// Builds a frame from `spec` on a keyed node with a text child, reads
1742 /// the access tree, and reports (how many derivations have happened,
1743 /// the tree's own hash).
1744 fn frame(core: &mut Core, spec: NodeSpec) -> (u64, u64) {
1745 let mut ui = core.frame(Size::new(200.0, 100.0), 1.0);
1746 ui.configure_root(NodeSpec::column());
1747 ui.text_in_keyed("node", spec, "hello", TextStyle::new(12.0));
1748 ui.finish();
1749 let hash = core.access_tree().hash;
1750 (core.access_rebuilds, hash)
1751 }
1752
1753 /// The base node: a button, so it is a semantic node with a name.
1754 fn base() -> NodeSpec {
1755 NodeSpec::column()
1756 .size(40.0, 20.0)
1757 .on_click(Value::from(1.0))
1758 .label("Save")
1759 }
1760
1761 /// Draws `first`, then `second`, and says whether the second frame
1762 /// derived the tree again and whether the tree changed.
1763 fn change(first: NodeSpec, second: NodeSpec) -> (bool, bool) {
1764 let mut core = Core::new();
1765 let (b0, h0) = frame(&mut core, first.clone());
1766 let (b1, h1) = frame(&mut core, second);
1767 (b1 > b0, h1 != h0)
1768 }
1769
1770 /// The case the cache is for: a pointer moving over a hover background
1771 /// changes `style.bg` before the node is pushed, and the access tree
1772 /// cannot see a background. The tree is kept, not rebuilt.
1773 #[test]
1774 fn a_change_the_tree_cannot_see_keeps_the_tree() {
1775 let (rebuilt, moved) = change(base().bg(Color::WHITE), base().bg(Color::BLACK));
1776 assert!(!rebuilt, "a colour the access tree never reads rebuilt it");
1777 assert!(!moved, "and the tree would have been the same anyway");
1778 }
1779
1780 /// And the same frame twice: no input moved at all.
1781 #[test]
1782 fn an_identical_frame_keeps_the_tree() {
1783 assert_eq!(change(base(), base()), (false, false));
1784 }
1785
1786 macro_rules! moves_the_tree {
1787 ($($name:ident: $first:expr => $second:expr;)*) => {$(
1788 #[test]
1789 fn $name() {
1790 let (rebuilt, moved) = change($first, $second);
1791 assert!(rebuilt, "the tree was served from the cache");
1792 assert!(moved, "it was derived again but came out the same");
1793 }
1794 )*};
1795 }
1796
1797 moves_the_tree! {
1798 label: base().label("Save") => base().label("Open");
1799 description: base() => base().description("Writes the file");
1800 role: base() => base().role(Role::Checkbox);
1801 clickable: NodeSpec::column().label("x") => NodeSpec::column().label("x").on_click(Value::from(1.0));
1802 disabled: base() => base().disabled(true);
1803 live: base() => base().live(Live::Polite);
1804 checked: base().role(Role::Checkbox) => base().role(Role::Checkbox).checked(true);
1805 selected: base().role(Role::Tab) => base().role(Role::Tab).selected(true);
1806 expanded: base() => base().expanded(true);
1807 value_now: base().role(Role::Slider) => base().role(Role::Slider).value_now(3.0);
1808 value_min: base().role(Role::Slider).value_now(3.0) => base().role(Role::Slider).value_now(3.0).value_min(1.0);
1809 value_text: base().role(Role::Slider) => base().role(Role::Slider).value_text("three");
1810 focusable: NodeSpec::column().role(Role::Group).label("g")
1811 => NodeSpec::column().role(Role::Group).label("g").focusable();
1812 rect: base() => base().width(80.0);
1813 }
1814
1815 /// The text a node is named by is not in its spec at all — it is the
1816 /// child text node's content, reached through the text system.
1817 #[test]
1818 fn the_text_a_node_reads_moves_the_tree() {
1819 let mut core = Core::new();
1820 let mut draw = |s: &str| {
1821 let mut ui = core.frame(Size::new(200.0, 100.0), 1.0);
1822 ui.configure_root(NodeSpec::column());
1823 ui.text(s, TextStyle::new(12.0));
1824 ui.finish();
1825 let h = core.access_tree().hash;
1826 (core.access_rebuilds, h)
1827 };
1828 let (b0, h0) = draw("hello");
1829 let (b1, h1) = draw("goodbye");
1830 assert!(b1 > b0 && h1 != h0, "a changed string kept its old node");
1831 }
1832
1833 /// The clip a node was emitted under is not in its spec either: a
1834 /// clipping parent narrowing cuts the rect of a node whose own box
1835 /// stayed where it was.
1836 #[test]
1837 fn a_parents_clip_moves_the_tree() {
1838 let mut core = Core::new();
1839 let mut draw = |w: f32| {
1840 let mut ui = core.frame(Size::new(200.0, 100.0), 1.0);
1841 ui.configure_root(NodeSpec::column());
1842 let clipper = NodeSpec::column().size(w, 40.0).clip();
1843 ui.with(clipper, |ui| {
1844 ui.leaf_keyed("node", base());
1845 });
1846 ui.finish();
1847 let hash = core.access_tree().hash;
1848 (core.access_rebuilds, hash)
1849 };
1850 let (b0, h0) = draw(100.0);
1851 let (b1, h1) = draw(30.0);
1852 assert!(b1 > b0 && h1 != h0, "the clip moved and the tree did not");
1853 }
1854
1855 /// Focus is the core's, not any node's spec.
1856 #[test]
1857 fn focus_moves_the_tree() {
1858 let mut core = Core::new();
1859 let (b0, h0) = frame(&mut core, base().focusable());
1860 core.set_key_focus(Some(Key::ROOT.str("node")));
1861 let (b1, h1) = frame(&mut core, base().focusable());
1862 assert!(b1 > b0 && h1 != h0, "focus moved and the tree did not");
1863 }
1864
1865 /// So is the scroll offset, which is retained across frames and only
1866 /// ever reaches the tree through the store.
1867 #[test]
1868 fn a_scroll_offset_moves_the_tree() {
1869 let mut core = Core::new();
1870 // Tall content, or the offset clamps to zero and nothing moved.
1871 let scroller = || NodeSpec::column().size(40.0, 20.0).scroll_y().label("list");
1872 let draw = |core: &mut Core| {
1873 let mut ui = core.frame(Size::new(200.0, 100.0), 1.0);
1874 ui.configure_root(NodeSpec::column());
1875 ui.with_keyed("node", scroller(), |ui| {
1876 ui.leaf_keyed("tall", NodeSpec::column().height(400.0));
1877 });
1878 ui.finish();
1879 let h = core.access_tree().hash;
1880 (core.access_rebuilds, h)
1881 };
1882 let (b0, h0) = draw(&mut core);
1883 core.set_scroll(Key::ROOT.str("node"), Vec2::new(0.0, 7.0));
1884 let (b1, h1) = draw(&mut core);
1885 assert!(b1 > b0 && h1 != h0, "the offset moved and the tree did not");
1886 }
1887
1888 /// An editor's text reaches the tree through the store, and its shaped
1889 /// runs through a version that stands in for them.
1890 #[test]
1891 fn editor_text_moves_the_tree() {
1892 let mut core = Core::new();
1893 let draw = |core: &mut Core, text: &str| {
1894 let mut ui = core.frame(Size::new(200.0, 100.0), 1.0);
1895 ui.configure_root(NodeSpec::column());
1896 let key = ui.text_edit(
1897 "name",
1898 text,
1899 &Default::default(),
1900 NodeSpec::column().size(120.0, 20.0),
1901 );
1902 ui.finish();
1903 let h = core.access_tree().hash;
1904 (core.access_rebuilds, h, key)
1905 };
1906 let (b0, h0, key) = draw(&mut core, "one");
1907 core.frame(Size::new(200.0, 100.0), 1.0).finish();
1908 core.set_edit_text(key, "typed");
1909 let (b1, h1, _) = draw(&mut core, "one");
1910 assert!(
1911 b1 > b0 && h1 != h0,
1912 "the editor's text moved and the tree did not"
1913 );
1914 }
1915
1916 /// And the viewport, which is the root node's whole rect.
1917 #[test]
1918 fn the_viewport_moves_the_tree() {
1919 let mut core = Core::new();
1920 let mut draw = |w: f32| {
1921 let mut ui = core.frame(Size::new(w, 100.0), 1.0);
1922 ui.configure_root(NodeSpec::column());
1923 ui.leaf_keyed("node", base());
1924 ui.finish();
1925 let h = core.access_tree().hash;
1926 (core.access_rebuilds, h)
1927 };
1928 let (b0, h0) = draw(200.0);
1929 let (b1, h1) = draw(300.0);
1930 assert!(
1931 b1 > b0 && h1 != h0,
1932 "the viewport moved and the tree did not"
1933 );
1934 }
1935}