kui_core/runtime/emit.rs
1//! The frame's back half: layout, then emission into the display list.
2//!
3//! `finish_frame` runs the passes; the rest are the passes — one node's
4//! quads, the departed subtrees replayed as ghosts, position easing, the
5//! `layout` events, the default focus ring — and the quad helpers they
6//! share. Everything here reads the tree `builder` built and writes
7//! `display`; the input side of the same frame is `dispatch`.
8
9use super::*;
10
11const SCROLLBAR_W: f32 = 4.0;
12/// Thumb width while hovered or dragged.
13const SCROLLBAR_ACTIVE_W: f32 = 6.0;
14/// Grabbable gutter width (wider than the drawn thumb).
15const SCROLLBAR_HIT_W: f32 = 10.0;
16const SCROLLBAR_INSET: f32 = 2.0;
17const SCROLLBAR_MIN: f32 = 24.0;
18/// An `auto` bar (`ScrollbarMode::Auto`): how long it stays after the
19/// scroll state last changed, then how long it takes to fade. Seconds of
20/// the driver's clock.
21const SCROLLBAR_HOLD: f64 = 1.0;
22const SCROLLBAR_FADE: f64 = 0.25;
23/// The default focus ring:
24/// drawn this far outside the focused node, this thick, when focus is
25/// keyboard-visible and the node styles nothing itself.
26///
27/// The *colour* is `theme.focus_ring`: the geometry is
28/// still not a prop and still not negotiable, but a ring that cannot be
29/// seen is not a focus indicator, and the pale blue that reads on a dark
30/// page is invisible on a light one.
31const FOCUS_RING_GAP: f32 = 2.0;
32const FOCUS_RING_W: f32 = 2.0;
33
34/// The disjoint borrows one box's paint needs, split off the core field by
35/// field — a macro rather than a method so the tree, the stroke list and a
36/// ghost's points can stay borrowed beside them.
37macro_rules! painter {
38 ($core:expr) => {
39 Painter {
40 display: &mut $core.display,
41 text: &mut $core.text,
42 edit: &mut $core.edit,
43 cells: &mut $core.cells,
44 atlas: &mut $core.atlas,
45 session: &$core.session,
46 path_tex: &mut $core.path_textures,
47 frame_no: $core.frame_no,
48 }
49 };
50}
51
52impl Core {
53 /// The scrollbar thumb's colour at rest and while hovered or dragged:
54 /// the node's own where it declared one, else the theme's. A wash over
55 /// whatever it sits on rather than a fill, which is why the theme's
56 /// are two translucent colours and not one with an alpha applied.
57 fn thumb_color(&self, bar: &crate::spec::Scrollbar, active: bool) -> Color {
58 let t = self.theme();
59 if active {
60 bar.active_color.unwrap_or(t.scrollbar_active)
61 } else {
62 bar.color.unwrap_or(t.scrollbar)
63 }
64 }
65
66 /// Node `i`'s hit region, for a node that tracks the pointer. Out of
67 /// line: a box that takes no input — most of a frame — does not carry
68 /// the context-menu walk, the slider's track or the shape in
69 /// `emit_node`'s saved registers and stack frame.
70 #[inline(never)]
71 fn push_hit(
72 &mut self,
73 i: usize,
74 rect: Rect,
75 clip: Rect,
76 drop: Option<crate::input::DropOwner>,
77 hits: &mut Vec<HitRegion>,
78 ) {
79 let spec = &self.tree.specs[i];
80 let parent = self.tree.parent[i];
81 let parent_rect = if parent == NIL {
82 Rect::new(0.0, 0.0, self.viewport.w, self.viewport.h)
83 } else {
84 let p = parent as usize;
85 Rect::from_pos_size(self.tree.pos[p], self.tree.size[p])
86 };
87 // A disabled node keeps hover (a tooltip can say why) and loses
88 // every interaction: it emits nothing and takes no focus.
89 let live = !spec.disabled;
90 // The menu this region opens is its own or an ancestor's; the
91 // walk is skipped on a frame where no node offers one (T1).
92 let context_menu = if self.tree.any_context_menu {
93 self.enclosing_menu(i).map(|j| crate::input::MenuOwner {
94 key: self.tree.keys[j],
95 origin: self.tree.origins[j],
96 tag: self.tree.specs[j]
97 .events()
98 .on_context_menu
99 .clone()
100 .expect("enclosing_menu returns a node that offers one"),
101 })
102 } else {
103 None
104 };
105 // A slider that asked for its changes reads the pointer along
106 // its content box (ADR 0034, decision 4); a disabled one, or a
107 // range that is not one, reads nothing.
108 let slider = match spec.events().on_change.as_ref() {
109 Some(tag) if live && spec.access().role == Some(crate::access::Role::Slider) => {
110 crate::slider::SliderRange::of(spec.access()).map(|range| {
111 Box::new(crate::slider::SliderTrack::new(
112 rect,
113 spec.layout.padding,
114 spec.layout.dir == crate::spec::Dir::Column,
115 range,
116 tag.clone(),
117 ))
118 })
119 }
120 _ => None,
121 };
122 // The shape past the rect (ADR 0026): a stroke's pieces, a
123 // fill's outline, a rounded box's corners; a plain box none.
124 let shape = match self.tree.content[i] {
125 NodeContent::Line(id) => {
126 let (run, points) = self.lines.run(id);
127 self.hit_shapes.segments(points, run.width)
128 }
129 NodeContent::Polygon(id) => {
130 let draw = self.fragments.get(id);
131 let mut pts = [Vec2::ZERO; crate::fragment::POLYGON_MAX_POINTS];
132 for (k, p) in pts.iter_mut().enumerate() {
133 *p = Vec2::new(draw.params[k * 2] * rect.w, draw.params[k * 2 + 1] * rect.h);
134 }
135 self.hit_shapes.polygon(&pts)
136 }
137 NodeContent::Path(id) => {
138 let (run, ops) = self.paths.run(id);
139 let mut outline = Vec::new();
140 // Hit by its fill when it may paint one: a `bg`, or one a
141 // hover, a press or the focus brings (the shape is
142 // decided before the pointer is, so by what is declared).
143 // With a stroke too, by the stroke's own pieces as well,
144 // or the outer half of a thick one is painted and not
145 // hit (RG112).
146 let s = &spec.style;
147 let fill = run.stroke_w <= 0.0
148 || s.bg.is_visible()
149 || spec.interact.as_deref().is_some_and(|i| {
150 [i.hover_bg, i.pressed_bg, i.focus_bg]
151 .iter()
152 .any(|c| c.is_some_and(|c| c.is_visible()))
153 });
154 if fill && run.stroke_w <= 0.0 {
155 crate::path::flatten(ops, &mut outline);
156 } else {
157 crate::path::flatten_stroke(ops, &mut outline);
158 }
159 // A turned path is hit where it is drawn: the outline
160 // turned about the box's centre, which is its pivot (ADR
161 // 0041). The contour breaks are not points and stay.
162 if let Some(angle) = run.angle.filter(|a| *a != 0.0) {
163 let c = Vec2::new(rect.w * 0.5, rect.h * 0.5);
164 for p in outline.iter_mut().filter(|p| !p.x.is_nan()) {
165 *p = crate::path::turned(*p, c, angle);
166 }
167 }
168 if fill {
169 self.hit_shapes.path(&outline, run.rule, run.stroke_w)
170 } else {
171 // A stroke with no fill is hit as a line is, by the
172 // pieces it paints: a contour its `Z` closed runs
173 // back to its start, an open one does not, and the
174 // breaks are kept so no piece runs from one contour
175 // to the next.
176 self.hit_shapes.segments(&outline, run.stroke_w)
177 }
178 }
179 _ if spec.style.radius != crate::display::SQUARE => {
180 crate::input::HitShape::Rounded(spec.style.radius)
181 }
182 _ => crate::input::HitShape::Rect,
183 };
184 hits.push(HitRegion {
185 key: self.tree.keys[i],
186 origin: self.tree.origins[i],
187 rect,
188 clip,
189 shape,
190 payload: spec.events().on_click.clone().filter(|_| live),
191 drag: spec.events().on_drag.clone().filter(|_| live),
192 parent_rect,
193 key_sink: spec.events().on_key.clone().filter(|_| live),
194 key_up: spec.events().key_up,
195 context_menu,
196 drop,
197 focusable: crate::access::focusable(&self.tree, i),
198 edit_origin: None,
199 select_scope: self.scope_of(i).filter(|_| live),
200 window: spec.window,
201 hover: spec.events().on_hover.clone(),
202 group: spec.interact().hover_group,
203 click_sound: spec.interact().click_sound.filter(|_| live),
204 hover_sound: spec.interact().hover_sound,
205 cursor: spec.cursor,
206 slider,
207 });
208 }
209
210 /// An editor's own hit region, whose origin is where its glyphs sit
211 /// (shifted by what a field is scrolled). Out of line for the reason
212 /// `push_hit` is.
213 #[inline(never)]
214 #[allow(clippy::too_many_arguments)]
215 fn push_edit_hit(
216 &mut self,
217 i: usize,
218 key: Key,
219 rect: Rect,
220 clip: Rect,
221 scale: f32,
222 drop: Option<crate::input::DropOwner>,
223 hits: &mut Vec<HitRegion>,
224 ) {
225 let spec = &self.tree.specs[i];
226 let pad = spec.layout.padding;
227 let content_origin = Vec2::new(rect.x + pad.l, rect.y + pad.t);
228 let inner_w = (rect.w - pad.x()).max(0.0);
229 // A single-line field scrolls its own text (F41). Resolved
230 // here, where the box is known, and read back by the hit
231 // region and the access runs so all three agree on where the
232 // glyphs are; the painter reads the same stored offset.
233 let offset = {
234 let sess = &mut *self.session.state();
235 self.edit.line_offset(key, inner_w * scale, &mut sess.fonts)
236 };
237 hits.push(HitRegion {
238 key,
239 origin: self.tree.origins[i],
240 rect,
241 clip,
242 // A field's corners round its hit too (ADR 0026).
243 shape: if spec.style.radius != crate::display::SQUARE {
244 crate::input::HitShape::Rounded(spec.style.radius)
245 } else {
246 crate::input::HitShape::Rect
247 },
248 payload: None,
249 drag: None,
250 parent_rect: rect,
251 // Shifted by what the field is scrolled: a click lands on
252 // the character under the pointer.
253 edit_origin: Some(Vec2::new(
254 content_origin.x - offset / scale,
255 content_origin.y,
256 )),
257 // An editor is its own selection scope: a press in it
258 // places a caret and drags a selection through the
259 // editor's own path, not the scope's.
260 select_scope: None,
261 key_sink: None,
262 key_up: false,
263 context_menu: None,
264 // A field inside a zone is the zone's: files dropped on
265 // it land there.
266 drop,
267 focusable: !spec.disabled,
268 window: None,
269 hover: None,
270 group: None,
271 click_sound: None,
272 hover_sound: None,
273 // The editor's own node carries any override.
274 cursor: spec.cursor,
275 slider: None,
276 });
277 }
278
279 /// The index in `regions` of the nearest scroll region around node
280 /// `i` in the tree, [`NIL`] for none. Ancestors are emitted before
281 /// their descendants — a float's layer comes after the one its
282 /// declaring node is in — so the one around is already in the list.
283 /// Off `emit_node`'s straight path: only a scroller pays for it.
284 #[inline(never)]
285 fn enclosing_scroll_region(&self, i: usize, regions: &[ScrollRegion]) -> u32 {
286 let mut a = self.tree.parent[i];
287 while a != NIL {
288 if let Some(r) = regions.iter().rposition(|r| r.node == a) {
289 return r as u32;
290 }
291 a = self.tree.parent[a as usize];
292 }
293 NIL
294 }
295
296 /// Emits one node's quads and registers its hit/scroll regions.
297 fn emit_node(
298 &mut self,
299 i: usize,
300 rect: Rect,
301 paint: Paint,
302 hits: &mut Vec<HitRegion>,
303 scroll_regions: &mut Vec<ScrollRegion>,
304 ) {
305 let Paint { clip, scale, .. } = paint;
306 // Behind a modal a node still draws, and stops taking input.
307 let interactive = self.interactive(i);
308 let spec = &self.tree.specs[i];
309 let style = spec.style;
310 // The zone this node's regions belong to — its own `on_drop` or
311 // an ancestor's — by the context menu's walk (ADR 0031, decision
312 // 2); skipped wholesale on a frame with no zone.
313 let drop = if self.tree.any_drop && interactive {
314 self.enclosing_drop(i).map(|j| crate::input::DropOwner {
315 key: self.tree.keys[j],
316 origin: self.tree.origins[j],
317 tag: self.tree.specs[j]
318 .events()
319 .on_drop
320 .clone()
321 .expect("enclosing_drop returns a node that declares one"),
322 })
323 } else {
324 None
325 };
326 // A stroke emits no hit region: it takes no input (ADR 0010,
327 // decision 7).
328 if spec.hover_tracked() && interactive {
329 self.push_hit(i, rect, clip.rect, drop.clone(), hits);
330 }
331 let spec = &self.tree.specs[i];
332 // An `on_scroll` node takes the wheel the way a container does —
333 // one list, one paint-order rule (ADR 0029, decision 4).
334 let handler = self.tree.any_scroll_handler && spec.events().on_scroll.is_some();
335 if spec.layout.scroll_x || spec.layout.scroll_y || handler {
336 // A container behind a modal keeps its scrollbar drawn and
337 // refuses the wheel and the thumb.
338 let (takes_x, takes_y) = if handler {
339 let axes = spec.events().scroll_axes;
340 (axes.takes(true), axes.takes(false))
341 } else {
342 (spec.layout.scroll_x, spec.layout.scroll_y)
343 };
344 scroll_regions.push(ScrollRegion {
345 key: self.tree.keys[i],
346 node: i as u32,
347 rect,
348 clip: clip.rect,
349 inert: !interactive,
350 handler,
351 takes_x,
352 takes_y,
353 scrolls_x: spec.layout.scroll_x,
354 scrolls_y: spec.layout.scroll_y,
355 contain: spec.interact().overscroll == crate::spec::Overscroll::Contain,
356 mods: if handler {
357 spec.events().scroll_mods.bits()
358 } else {
359 0
360 },
361 parent: self.enclosing_scroll_region(i, scroll_regions),
362 });
363 }
364 if let NodeContent::Edit(key) = self.tree.content[i]
365 && interactive
366 {
367 self.push_edit_hit(i, key, rect, clip.rect, scale, drop, hits);
368 }
369 // The content, resolved to what the painter needs — a text node's
370 // selection and its place, an editor's focus — then painted by the
371 // one step a ghost also paints through.
372 let leaf = match self.tree.content[i] {
373 NodeContent::Text(tid) => {
374 // The keys above it, nearest first, so a query by the
375 // `line` row (or a wrapper) finds the runs inside it.
376 let ancestry = self.text_ancestors(i);
377 self.text.place(
378 self.tree.keys[i],
379 &ancestry,
380 tid,
381 self.tree.pos[i],
382 self.scope_of(i),
383 true,
384 );
385 Leaf::Text {
386 tid,
387 sel: self.sel_range(i, tid),
388 }
389 }
390 NodeContent::Cells(cid) => Leaf::Cells {
391 cid,
392 at: self.cells_origin(i),
393 // The window's selection, when it is in this very grid.
394 sel: self
395 .cell_selection
396 .as_ref()
397 .filter(|s| s.node == self.tree.keys[i] && !s.is_empty()),
398 tint: self.theme.selection,
399 },
400 NodeContent::Edit(key) => Leaf::Edit {
401 key,
402 focused: self.edit.focused() == Some(key),
403 pad: self.tree.specs[i].layout.padding,
404 },
405 NodeContent::Image(id, opts) => Leaf::Image(id, opts),
406 NodeContent::Fragment(id) => Leaf::Fragment(self.fragments.get(id)),
407 NodeContent::Polygon(id) => Leaf::Polygon(self.fragments.get(id)),
408 NodeContent::Line(id) => {
409 let (run, points) = self.lines.run(id);
410 Leaf::Line {
411 points,
412 width: run.width,
413 dash: run.dash,
414 }
415 }
416 NodeContent::Path(id) => {
417 let (run, ops) = self.paths.run(id);
418 Leaf::Path {
419 ops,
420 rule: run.rule,
421 stroke_w: run.stroke_w,
422 dash: run.dash,
423 hash: run.hash,
424 angle: run.angle,
425 animating: run.animating,
426 }
427 }
428 NodeContent::Container => Leaf::Container,
429 };
430 let first_quad = self.display.quads.len();
431 painter!(self).paint_box(rect, &style, &paint, leaf);
432 // A gradient over the background the box just painted. Out of
433 // `emit_node` as the rules below are, and for the same reason.
434 if self.tree.any_gradient
435 && let Some(g) = &self.tree.specs[i].interact().gradient
436 // A stroke and a fill paint no box for it to lie over.
437 && !matches!(
438 self.tree.content[i],
439 NodeContent::Line(_) | NodeContent::Polygon(_) | NodeContent::Path(_)
440 )
441 {
442 painter!(self).paint_gradient(g, rect, &style, &paint, first_quad);
443 }
444 // A table's grid rules, with its box and under its cells. Out of
445 // `emit_node`: a rare path kept off its codegen (C48).
446 if self.tree.any_table
447 && let Some(c) = self.tree.specs[i].interact().rules
448 && self.tree.specs[i].layout.is_table()
449 {
450 self.emit_rules(i, rect, c, &paint);
451 }
452 }
453
454 /// The `rules` of table `i`, laid out by [`rule_lines`]
455 /// from its in-flow children as layout reads them — a row is what
456 /// `layout::is_table_row` says is one, so the grid is drawn over the
457 /// rows its columns were laid across and not through a heading or a
458 /// section beside them.
459 #[cold]
460 #[inline(never)]
461 fn emit_rules(&mut self, i: usize, rect: Rect, color: Color, paint: &Paint) {
462 let tree = &self.tree;
463 let at = |j: u32| Rect::from_pos_size(tree.pos[j as usize], tree.size[j as usize]);
464 let in_flow = |j: &u32| tree.specs[*j as usize].layout.float.is_none();
465 let children: Vec<RuledChild> = tree
466 .children(i as u32)
467 .filter(in_flow)
468 .map(|c| RuledChild {
469 rect: at(c),
470 cells: crate::layout::is_table_row(tree, c)
471 .then(|| tree.children(c).filter(in_flow).map(at).collect()),
472 })
473 .collect();
474 let spec = &tree.specs[i];
475 let lines = rule_lines(rect, spec.layout.padding, spec.interact().rule_w, &children);
476 // The clip the table's children get: its own box when it clips or
477 // scrolls, since the rows' places carry its scroll offset and the
478 // rules drawn from them go wherever the rows do.
479 let clip_id = if spec.layout.clips() {
480 let radius = if tree.any_rounded_clip {
481 spec.style.radius
482 } else {
483 crate::display::SQUARE
484 };
485 let clip = paint.clip.intersect(rect, radius);
486 self.display.intern_clip(clip.scaled(paint.scale))
487 } else {
488 paint.clip_id
489 };
490 push_rules(&mut self.display, &lines, color, paint, clip_id);
491 }
492
493 /// [`Core::emit_rules`] for a departing table's ghost, node `i` of
494 /// `g` drawn at `rect`, its children `offset` from where they were:
495 /// the same rules from the children the ghost copied, under the same
496 /// clip its children get, faded with it by `paint`.
497 #[cold]
498 #[inline(never)]
499 fn emit_ghost_rules(
500 &mut self,
501 g: &Ghost,
502 i: usize,
503 rect: Rect,
504 offset: Vec2,
505 color: Color,
506 paint: &Paint,
507 ) {
508 let at = |node: &crate::depart::GhostNode| {
509 Rect::new(
510 node.rect.x + offset.x,
511 node.rect.y + offset.y,
512 node.rect.w,
513 node.rect.h,
514 )
515 };
516 // The nodes are in preorder, so a grandchild's parent is the most
517 // recent child. A departing `cells` grid, or a fragment whose draw
518 // was gone, is a `Container` here — a `row` one straight under a
519 // table would read as a row of no cells, where layout read it as
520 // no row.
521 let mut children: Vec<RuledChild> = Vec::new();
522 let mut last = NIL;
523 for (j, node) in g.nodes.iter().enumerate().skip(i + 1) {
524 // Past the table's subtree: a node whose parent precedes it.
525 if node.parent == NIL || (node.parent as usize) < i {
526 break;
527 }
528 if node.spec.layout.float.is_some() {
529 continue;
530 }
531 if node.parent as usize == i {
532 let row = crate::layout::row_shaped(
533 &node.spec.layout,
534 matches!(node.content, GhostContent::Container),
535 );
536 children.push(RuledChild {
537 rect: at(node),
538 cells: row.then(Vec::new),
539 });
540 last = j as u32;
541 } else if node.parent == last
542 && let Some(cells) = children.last_mut().and_then(|c| c.cells.as_mut())
543 {
544 cells.push(at(node));
545 }
546 }
547 let spec = &g.nodes[i].spec;
548 let lines = rule_lines(rect, spec.layout.padding, spec.interact().rule_w, &children);
549 let clip_id = if spec.layout.clips() {
550 let clip = paint.clip.intersect(rect, spec.style.radius);
551 self.display.intern_clip(clip.scaled(paint.scale))
552 } else {
553 paint.clip_id
554 };
555 push_rules(&mut self.display, &lines, color, paint, clip_id);
556 }
557
558 /// Runs layout and emission into `output()`, and installs this frame's
559 /// hit and scroll regions for input handling. The last step of
560 /// `Ui::finish`, which runs the extension fills, the devtools panel
561 /// and the open menu first — and crate-private for that reason:
562 /// a host that called this directly got a frame where
563 /// `open_menu` drew nothing and `KUI_DEVTOOLS` did nothing, with no
564 /// warning. A driver with a bare `Core` finishes through
565 /// `Ui::wrap(core).finish()`.
566 pub(crate) fn finish_frame(&mut self) {
567 self.layout_frame();
568 self.emit_frame();
569 self.building = false;
570 // A focus the view moved, or a focused node the frame declared
571 // `on_focus` on or dropped (backlog DX18).
572 let mut out = std::mem::take(&mut self.pending);
573 self.report_focus("program", &mut out);
574 self.pending = out;
575 self.snapshot_nodes();
576 self.devtools_after_frame();
577 self.trace_finish_frame();
578 // Between frames the host is who talks to the core: a driver that
579 // tagged the last nodes with an extension's origin by hand (rather
580 // than through `fill`, which restores it) must not leave its
581 // `set_tokens` landing in that extension's table (ADR 0027).
582 self.origin = crate::tree::OriginId::HOST;
583 }
584
585 /// The frame's first half: layout, then everything that resolves
586 /// against it before a quad is emitted — the caret and reveal nudges,
587 /// the `layout` events and the diagnostics, the declared window set,
588 /// the modal scope and the Tab step a view asked for.
589 fn layout_frame(&mut self) {
590 // Tolerate unclosed containers (an FFI caller may have bailed early).
591 self.stack.truncate(1);
592 self.counters.truncate(1);
593
594 self.tree.host_area = self.dt_area;
595 if !self.pending_scroll_labels.is_empty() {
596 self.resolve_scroll_labels();
597 }
598 {
599 let sess = &mut *self.session.state();
600 let mut measure = Measure {
601 text: &mut self.text,
602 cells: &mut self.cells,
603 fonts: &mut sess.fonts,
604 edit: &mut self.edit,
605 resources: &sess.resources,
606 };
607 layout::compute(
608 &mut self.tree,
609 &mut measure,
610 &mut self.scroll,
611 self.viewport,
612 self.scale,
613 );
614 }
615 self.scroll_caret_into_view();
616 // An explicit `reveal` after the caret nudge: the app asked for
617 // this one, so it wins the offset if both want to move it.
618 self.apply_pending_reveal();
619 // A container a view sliced its rows by (`scroll_geometry`) that
620 // came out otherwise — taller, scrolled elsewhere — owes a frame
621 // built against this layout, or the slice stays a frame behind
622 // until the next event (`ScrollStore::resliced`).
623 if self.scroll.take_resliced() {
624 self.owe_frame("resliced");
625 }
626 if self.tree.any_slide {
627 self.ease_positions();
628 }
629 // Positions are final: report the rects views asked about, and
630 // look for the misconfigurations that would otherwise fail silently.
631 if self.tree.any_layout {
632 self.emit_layout_events();
633 }
634 self.diag
635 .check(&self.tree, &self.text, &self.edit, self.frame_no);
636 // Text set for a key nothing had declared yet was held for this
637 // frame (backlog F25). What it declared has taken its seed; what
638 // is left named an editor no view draws, so drop it and say so.
639 // Drained whatever `diag.enabled` says, so the gate changes what
640 // is reported and never what is retained.
641 for seed in self.edit.take_unclaimed_seeds() {
642 self.diag.raise(match seed {
643 crate::edit::Unclaimed::Key(key) => crate::diag::edit_text_without_editor(key),
644 crate::edit::Unclaimed::Label(label) => {
645 crate::diag::edit_text_without_editor_label(&label)
646 }
647 });
648 }
649 // The declared window set, diffed against the session's: a frame
650 // that declared a new name queues its `Open` here.
651 self.sync_windows();
652 // The frame's modal scope, and the focus it moves: emission reads
653 // it (everything outside is inert) and so does the Tab ring.
654 self.modal = if self.tree.any_modal {
655 self.modal_scope()
656 } else {
657 None
658 };
659 self.resolve_modal_focus();
660 // Then the regions: a `focus_region` asked for during the build,
661 // the region following a focus the build declared, and a region
662 // that went away handing focus back (`docs/adr/0022`).
663 self.resolve_regions();
664 // The ring exists now: laid out, and scoped to the modal if there
665 // is one, else to the region in effect. A step asked for during
666 // the build lands here, so it wins over both the modal's own focus
667 // move and a same-frame `set_focus`. Like a real Tab press, the
668 // scroll it triggers shows on the next frame.
669 if let Some(forward) = self.pending_focus_step.take() {
670 self.focus_next(forward);
671 }
672 }
673
674 /// Numbers the text nodes of the selection's scope in tree order and
675 /// resolves the two ends against those ordinals. Run once per frame,
676 /// after the scope map and before emission, because a run's range has
677 /// to be known when the run is drawn and its *offset* cannot be —
678 /// the runs after it have not been placed yet, and an end may be one
679 /// of them.
680 fn resolve_selection(&mut self) {
681 self.sel_ords.clear();
682 self.sel_ends = None;
683 let Some(sel) = self.selection else { return };
684 self.sel_ords.resize(self.tree.len(), u32::MAX);
685 let (mut anchor, mut focus) = (None, None);
686 // The built runs, in order, with the virtualised row each is in:
687 // what an end whose own node is *not* built is placed against.
688 let mut built: Vec<(u32, Option<u64>, usize)> = Vec::new();
689 let mut ord = 0u32;
690 for i in 0..self.tree.len() {
691 if self.scopes.get(i).copied().flatten() != Some(sel.scope)
692 || !matches!(self.tree.content[i], NodeContent::Text(_))
693 {
694 continue;
695 }
696 self.sel_ords[i] = ord;
697 let key = self.tree.keys[i];
698 let len = match self.tree.content[i] {
699 NodeContent::Text(tid) => self.text.content_len(tid),
700 _ => 0,
701 };
702 built.push((ord, self.rows.get(i).copied().flatten(), len));
703 if key == sel.anchor.node {
704 anchor = Some((ord, sel.anchor.byte));
705 }
706 if key == sel.focus.node {
707 focus = Some((ord, sel.focus.byte));
708 }
709 ord += 1;
710 }
711 // An end this frame did not build is placed by its row's index in
712 // the data: before everything built, after it, or at the boundary
713 // it falls on. That is what lets the built middle paint while a
714 // virtual list scrolls under a selection (ADR 0017, tier 3).
715 let place = |end: &crate::select::Endpoint| -> Option<(u32, usize)> {
716 let row = end.row?;
717 let (start, last) = (built.first()?, built.last()?);
718 // The row itself is built, on runs no end's key names: a Select
719 // All's placeholder end (`select_all_in` puts it on the scope
720 // with the row's index and `ROW_END`) after the list scrolled
721 // that row into the built window. It lands in that row's own
722 // runs — the end of its last one, or the byte into its first —
723 // rather than at the boundary an unbuilt row would take.
724 let mut in_row = built.iter().filter(|(_, r, _)| *r == Some(row));
725 if let Some(first_run) = in_row.next() {
726 return Some(if end.byte >= crate::select::ROW_END {
727 let last_run = in_row.next_back().unwrap_or(first_run);
728 (last_run.0, last_run.2)
729 } else {
730 (first_run.0, end.byte.min(first_run.2))
731 });
732 }
733 // Against the built runs that *carry* a row, not the first and
734 // last of everything built: a scope can hold plain labels
735 // beside virtual rows — a header, a footer — and a label says
736 // nothing about where a row sits in the data. Comparing
737 // against one puts an end below the list at the top of it.
738 let hi = built.iter().rev().find_map(|(_, r, _)| *r)?;
739 if crate::select::unbuilt_row_is_after(row, Some(hi)) {
740 return Some((last.0, last.2));
741 }
742 // Below the first row, or inside the built range without being
743 // built — a hole, which a contiguous virtual window does not
744 // have. Either way the start is the nearest honest boundary.
745 Some((start.0, 0))
746 };
747 let anchor = anchor.or_else(|| place(&sel.anchor));
748 let focus = focus.or_else(|| place(&sel.focus));
749 if let (Some(a), Some(f)) = (anchor, focus) {
750 self.sel_ends = Some(crate::select::Ends::ordered(a, f));
751 }
752 }
753
754 /// The bytes of node `i`'s text the selection covers, with the colour
755 /// to paint under them. `None` on every node of every frame that has
756 /// no selection.
757 fn sel_range(&self, i: usize, tid: crate::tree::TextId) -> Option<((usize, usize), Color)> {
758 let ends = self.sel_ends?;
759 let ord = self.sel_ords.get(i).copied()?;
760 if ord == u32::MAX {
761 return None;
762 }
763 let range = ends.range_in(ord, self.text.content_len(tid))?;
764 Some((range, self.theme().selection))
765 }
766
767 /// The innermost selection scope node `i` is inside, if any. Empty on
768 /// every frame that declares no `selectable` at all, where the map is
769 /// not even sized.
770 #[inline]
771 fn scope_of(&self, i: usize) -> Option<Key> {
772 self.scopes.get(i).copied().flatten()
773 }
774
775 /// The keys above node `i`, nearest first, as many as a `TextPlace`
776 /// remembers — what lets a query by a `line` row or a wrapper find
777 /// the runs inside it.
778 /// The keys above text node `i`, nearest first, as many as a place
779 /// remembers; how many there are; and the depth of the nearest
780 /// `role="none"` ancestor among them, which a query from above it
781 /// does not reach. A `line` row further up than the
782 /// place can remember raises `text-beyond-line`, once per text.
783 fn text_ancestors(&mut self, i: usize) -> crate::text::Ancestry {
784 use crate::access::Role;
785 let mut ancestors = [Key::ROOT; crate::text::PLACE_ANCESTORS];
786 let mut depth = 0;
787 let mut none_at = None;
788 let mut p = self.tree.parent[i];
789 while p != NIL && depth < ancestors.len() {
790 let j = p as usize;
791 ancestors[depth] = self.tree.keys[j];
792 if none_at.is_none() && self.tree.specs[j].access().role == Some(Role::None) {
793 none_at = Some(depth);
794 }
795 depth += 1;
796 p = self.tree.parent[j];
797 }
798 // Past the reach: a `line` row still above is one the text cannot
799 // be found from, and the app should hear it.
800 if p != NIL && self.tree.any_line {
801 let mut q = p;
802 while q != NIL {
803 let j = q as usize;
804 if self.tree.specs[j].access().role == Some(Role::Line) {
805 self.diag.raise(crate::diag::text_beyond_line(
806 self.tree.keys[i],
807 self.tree.keys[j],
808 crate::text::PLACE_ANCESTORS,
809 ));
810 break;
811 }
812 q = self.tree.parent[j];
813 }
814 }
815 crate::text::Ancestry {
816 keys: ancestors,
817 depth,
818 none_at,
819 }
820 }
821
822 /// The frame's second half: the laid-out tree into the display list,
823 /// in paint order — the in-flow layer, then one layer per floating
824 /// subtree in the order they opened, each with the departed subtrees
825 /// that were painted among it and its own chrome (scrollbars, the
826 /// ring) at its end — and the hit and scroll regions the
827 /// next input is tested against, in the same order.
828 fn emit_frame(&mut self) {
829 let scale = self.scale;
830 let mut hits: Vec<HitRegion> = self.interaction.take_hit_buffer();
831 self.hit_shapes = self.interaction.take_shape_buffer();
832 let mut scroll_regions: Vec<ScrollRegion> = Vec::new();
833 self.display.viewport = Size::new(self.viewport.w * scale, self.viewport.h * scale);
834 self.display.scale = scale;
835 self.display.time = self.anim.time().unwrap_or(0.0) as f32;
836
837 // Read once each: what the frame declared, noted by `Tree::push`
838 // (and by `configure_root`, whose spec replaces the root's).
839 let any_clip = self.tree.any_clip;
840 let any_rounded_clip = self.tree.any_rounded_clip;
841 let any_opacity = self.tree.any_opacity;
842 let any_float = self.tree.any_float;
843 // Read once: every per-node selection check below is behind it.
844 let any_selectable = self.tree.any_selectable;
845
846 // inherited clip per node (logical): ancestors only, not the node
847 // itself. Only materialized when something actually clips.
848 // Index 0 is the clip that clips nothing, so an unclipped frame
849 // interns once and every quad on it names entry zero. Seeded
850 // rather than found, so `clip_of` has something to answer with
851 // even on a frame that emitted no quad at all.
852 let no_clip = self.display.intern_clip(Clip::NONE.scaled(scale));
853 self.clips.clear();
854 self.clip_ids.clear();
855 if any_clip {
856 self.clips.resize(self.tree.len(), Clip::NONE);
857 self.clip_ids.resize(self.tree.len(), no_clip);
858 }
859 self.opacity.clear();
860 if any_opacity {
861 self.opacity.resize(self.tree.len(), 1.0);
862 }
863 self.float_root.clear();
864 if any_float {
865 self.float_root.resize(self.tree.len(), NIL);
866 }
867 // The innermost `selectable` above each node (ADR 0017). Parents
868 // precede their children in the tree array, so one forward pass
869 // inherits it; a node declaring `selectable` inside another scope
870 // takes the text under it and is warned about, because two scopes
871 // over one run would each think they own it.
872 self.scopes.clear();
873 self.rows.clear();
874 if any_selectable {
875 self.scopes.resize(self.tree.len(), None);
876 self.rows.resize(self.tree.len(), None);
877 // The rows a virtual list built, by node, so the walk below
878 // can carry each one down to the text inside it.
879 for &(node, index) in &self.tree.indexed {
880 if let Some(slot) = self.rows.get_mut(node as usize) {
881 *slot = Some(index);
882 }
883 }
884 for i in 0..self.tree.len() {
885 let parent = self.tree.parent[i];
886 // A floating subtree escapes the scope it floats out of,
887 // the way it escapes the clip: a popover over a card is
888 // not part of the card's paragraph, and a float is
889 // emitted in a later pass than its tree position, which
890 // would put its runs out of reading order anyway.
891 let outer = if parent == NIL || self.tree.specs[i].layout.float.is_some() {
892 None
893 } else {
894 self.scopes[parent as usize]
895 };
896 // An inner scope takes the text under it; the nesting
897 // itself is reported by `diag`, over the finished tree.
898 //
899 // A `cells` grid is its own scope and never joins the one
900 // around it: it selects in cells, and a selection that ran
901 // from a paragraph into a terminal screen would be two
902 // kinds of selection at once (ADR 0017, decision 4).
903 let grid = matches!(self.tree.content[i], NodeContent::Cells(_));
904 self.scopes[i] = if self.tree.specs[i].interact().selectable {
905 Some(self.tree.keys[i])
906 } else if grid {
907 None
908 } else {
909 outer
910 };
911 // A row's index reaches the text inside it: the node that
912 // declared it keeps its own, everything under it inherits.
913 if self.rows[i].is_none() && parent != NIL {
914 self.rows[i] = self.rows[parent as usize];
915 }
916 }
917 }
918 self.resolve_selection();
919
920 // Exits: what the previous frame declared and this one does not is
921 // copied out of the tree the previous frame left behind, and every
922 // departing subtree still in flight is taken out for the passes,
923 // which paint each one where its node was (see `depart`).
924 if !self.prev_tree.is_empty() || !self.depart.is_empty() {
925 self.collect_departures();
926 }
927 let mut replay = Replay::default();
928 let mut took_ghosts = false;
929 if !self.depart.is_empty()
930 && let Some(now) = self.anim.time()
931 {
932 replay = self.depart.begin_replay(now);
933 took_ghosts = true;
934 }
935 let any_ghost = !replay.is_empty();
936
937 // Pass 1: clip/float propagation + in-flow emission (preorder =
938 // paint order; parents precede children). `float_root[i]` is the
939 // nearest floating ancestor-or-self, `NIL` in flow: the layer a
940 // node paints in (ADR 0023, decision 1). Every float root goes into
941 // `roots`, in tree order, for the stack to sort.
942 let mut roots: Vec<u32> = Vec::new();
943 for i in 0..self.tree.len() {
944 let parent = self.tree.parent[i];
945 let floats_here = any_float && self.tree.specs[i].layout.float.is_some();
946 if any_float {
947 self.float_root[i] = if floats_here {
948 roots.push(i as u32);
949 i as u32
950 } else if parent != NIL {
951 self.float_root[parent as usize]
952 } else {
953 NIL
954 };
955 }
956 let rect = Rect::from_pos_size(self.tree.pos[i], self.tree.size[i]);
957 // Opacity multiplies down the tree, floats included: a tooltip
958 // inside a fading panel fades with it.
959 let opacity = if !any_opacity {
960 1.0
961 } else {
962 let inherited = if parent == NIL {
963 1.0
964 } else {
965 self.opacity[parent as usize]
966 };
967 let o = inherited * self.tree.specs[i].style.opacity;
968 self.opacity[i] = o;
969 o
970 };
971 // A parent-anchored float that declared `clip` belongs to the
972 // parent's content as a child does, so the parent's clip holds
973 // it: a node on a `clip` canvas panned past the canvas's edge
974 // is cut there (F90), and a graph beside a scrolled list at
975 // the list's edge like the rows it draws over, since the core
976 // sets the bit on every stroke and polygon (F78, ADR 0010
977 // decision 5). Any other float (a tooltip, a menu, a stroke
978 // anchored to the viewport) escapes. Only the clip is the
979 // parent's: the node still paints in its float layer.
980 let drawn_in_parent = floats_here
981 && parent != NIL
982 && self.tree.specs[i]
983 .layout
984 .float
985 .is_some_and(|f| f.clipped_by_parent());
986 let (clip, clip_id) = if !any_clip {
987 (Clip::NONE, no_clip)
988 } else {
989 // Floating nodes escape ancestor clips.
990 let (clip, id) = if parent == NIL || (floats_here && !drawn_in_parent) {
991 (Clip::NONE, no_clip)
992 } else {
993 let p = parent as usize;
994 if self.tree.specs[p].layout.clips() {
995 // A clipper with a radius rounds what it clips, so
996 // the children of a rounded card stay inside its
997 // corners (see `display::Clip`).
998 let box_rect = Rect::from_pos_size(self.tree.pos[p], self.tree.size[p]);
999 let box_radius = if any_rounded_clip {
1000 self.tree.specs[p].style.radius
1001 } else {
1002 crate::display::SQUARE
1003 };
1004 let clip = self.clips[p].intersect(box_rect, box_radius);
1005 (clip, self.display.intern_clip(clip.scaled(scale)))
1006 } else {
1007 // The overwhelming case: the clip is the parent's,
1008 // so the entry is too, and nothing is compared.
1009 (self.clips[p], self.clip_ids[p])
1010 }
1011 };
1012 self.clips[i] = clip;
1013 self.clip_ids[i] = id;
1014 (clip, id)
1015 };
1016 if any_float && self.float_root[i] != NIL {
1017 continue; // deferred to its layer, in the float pass
1018 }
1019 // A departing subtree painted just under this node last time
1020 // goes first, so it stays under it.
1021 if any_ghost && replay.may_precede(self.tree.keys[i]) {
1022 let key = self.tree.keys[i];
1023 replay.paint(At::UnderInFlow(key), |g, play| {
1024 self.emit_ghost(g, play, scale)
1025 });
1026 }
1027 // Entirely clipped away: skip drawing and hit-testing.
1028 // Rect, not rounded: a node that survives only in a corner's
1029 // arc is drawn and clipped rather than culled.
1030 let visible = rect.intersect(&clip.rect);
1031 if visible.w <= 0.0 || visible.h <= 0.0 {
1032 // Culled — but a text run inside a selection scope keeps
1033 // its place in the order and its content reachable, so a
1034 // selection can run past the edge of a scroller (ADR
1035 // 0017, tier 2). Marked undrawn: no hit region, no
1036 // `text_hit`, nothing a pointer can find.
1037 //
1038 // Behind the frame's own flag, hoisted out of the loop:
1039 // a frame that declares no scope does not pay a lookup
1040 // per culled node to find that out (C15).
1041 if any_selectable
1042 && let Some(scope) = self.scope_of(i)
1043 && let NodeContent::Text(tid) = self.tree.content[i]
1044 {
1045 let ancestry = self.text_ancestors(i);
1046 self.text.place(
1047 self.tree.keys[i],
1048 &ancestry,
1049 tid,
1050 self.tree.pos[i],
1051 Some(scope),
1052 false,
1053 );
1054 }
1055 continue;
1056 }
1057 let paint = Paint {
1058 clip,
1059 clip_id,
1060 scale,
1061 opacity,
1062 };
1063 self.emit_node(i, rect, paint, &mut hits, &mut scroll_regions);
1064 }
1065
1066 if any_ghost {
1067 // The in-flow ghosts whose place is gone: the end of their
1068 // layer, still under its chrome and under every float.
1069 replay.paint(At::InFlowEnd, |g, play| self.emit_ghost(g, play, scale));
1070 }
1071
1072 // The in-flow layer's chrome — its scrollers' bars and, if the
1073 // focused node is in flow, the ring — above its content and under
1074 // every float (ADR 0023, decision 2).
1075 let mut scrollbars: Vec<ScrollbarRegion> = Vec::new();
1076 let mut chrome_from = 0usize;
1077 self.emit_layer_chrome(
1078 NIL,
1079 &scroll_regions[chrome_from..],
1080 &mut scrollbars,
1081 hits.len(),
1082 scale,
1083 );
1084 chrome_from = scroll_regions.len();
1085
1086 // Pass 2: the float layers, bottom to top in the order they opened
1087 // (ADR 0023, decision 3); each one's chrome at its end. Their hit
1088 // regions land in the same order, so `hit_at` reads the stack.
1089 if any_float {
1090 let order = self.stack_floats(&roots);
1091 for &r in &order {
1092 let root = r as usize;
1093 let root_key = self.tree.keys[root];
1094 if any_ghost && replay.may_precede(root_key) {
1095 // A departed float that was under this one stays under
1096 // it: a whole layer, painted before this layer starts.
1097 replay.paint(At::UnderLayer(root_key), |g, play| {
1098 self.emit_ghost(g, play, scale)
1099 });
1100 }
1101 let end = self.tree.subtree_end(root);
1102 for i in root..end {
1103 if self.float_root[i] != r {
1104 continue; // a nested float: its own layer, later
1105 }
1106 if any_ghost && replay.may_precede(self.tree.keys[i]) {
1107 let key = self.tree.keys[i];
1108 replay.paint(At::UnderInLayer(key), |g, play| {
1109 self.emit_ghost(g, play, scale)
1110 });
1111 }
1112 let rect = Rect::from_pos_size(self.tree.pos[i], self.tree.size[i]);
1113 let clip = if any_clip { self.clips[i] } else { Clip::NONE };
1114 let clip_id = if any_clip { self.clip_ids[i] } else { no_clip };
1115 let opacity = if any_opacity { self.opacity[i] } else { 1.0 };
1116 let visible = rect.intersect(&clip.rect);
1117 if visible.w <= 0.0 || visible.h <= 0.0 {
1118 continue;
1119 }
1120 let paint = Paint {
1121 clip,
1122 clip_id,
1123 scale,
1124 opacity,
1125 };
1126 self.emit_node(i, rect, paint, &mut hits, &mut scroll_regions);
1127 }
1128 if any_ghost {
1129 replay.paint(At::LayerEnd(root_key), |g, play| {
1130 self.emit_ghost(g, play, scale)
1131 });
1132 }
1133 // A layer with no scroller and no ring to draw has no
1134 // chrome: the common float is a leaf, and ten thousand of
1135 // them (a `line` each) pay a call apiece otherwise (C29).
1136 if scroll_regions.len() > chrome_from || self.focus_visible {
1137 self.emit_layer_chrome(
1138 r,
1139 &scroll_regions[chrome_from..],
1140 &mut scrollbars,
1141 hits.len(),
1142 scale,
1143 );
1144 chrome_from = scroll_regions.len();
1145 }
1146 }
1147 self.check_layers_over_modal(&order);
1148 } else if !self.float_stack.is_empty() {
1149 // No floats this frame: every layer closed.
1150 self.float_stack.clear();
1151 }
1152
1153 if any_ghost {
1154 // A ghost whose whole layer is gone: on top, the only place
1155 // left that is under nothing it was under.
1156 replay.paint(At::Top, |g, play| self.emit_ghost(g, play, scale));
1157 }
1158 if took_ghosts {
1159 self.depart.end_replay(replay);
1160 }
1161
1162 // Rounded span backgrounds, joined into one shape with the ones
1163 // they meet now that every text is painted (backlog F101).
1164 let joins = self.text.take_joins();
1165 if !joins.is_empty() {
1166 let sess = &mut *self.session.state();
1167 let id = sess.resources.add_fragment(crate::fragment::JOIN);
1168 if let Some(source) = sess.resources.fragment(id).cloned() {
1169 crate::join::shape(&mut self.display, &joins, id, &source, scale);
1170 }
1171 }
1172
1173 let shapes = std::mem::take(&mut self.hit_shapes);
1174 self.interaction.set_hits_shaped(hits, shapes);
1175 // A button held on a node this frame no longer declares has no one
1176 // to hear its release (backlog F105).
1177 let tree = &self.tree;
1178 self.interaction
1179 .drop_gone_buttons(|key| tree.index_of(key).is_some());
1180 // A new frame can move a hover-sound node under a still cursor.
1181 self.flush_sound_requests();
1182 // Against this window's mounts only (AR7): a popup or a second
1183 // window finishing a frame with no `<audio>` in it says nothing
1184 // about the main window's loop.
1185 let window = self.env.window.id;
1186 self.session.state().audio.reconcile(window);
1187 self.interaction.scroll_regions = scroll_regions;
1188 self.interaction.scrollbars = scrollbars;
1189 self.ime_rect = self.focused_caret_rect();
1190 self.note_sink_caret();
1191 self.atlas.end_frame();
1192 // The atlas refused a glyph for room this frame rather than drop
1193 // a slot the frame had already used (F99): the next frame starts
1194 // on an empty page and draws it, and has to come — an
1195 // input-driven app would keep the short frame until the next
1196 // event. A page that only grew is right as it is presented.
1197 if self.atlas.short() {
1198 self.owe_frame("atlas full");
1199 }
1200 // A long line's rows came out other than layout's once emission
1201 // shaped what shows (backlog RG70): the frame laid out on them is
1202 // owed, or an idle view keeps the estimate's box.
1203 if self.text.take_owed() {
1204 self.owe_frame("long line rows");
1205 }
1206 }
1207
1208 /// The exit diff: every key the previous frame declared an `exit` on
1209 /// and this frame does not becomes a departing subtree, copied out of
1210 /// `prev_tree` — the frame that still had it — and handed to the store
1211 /// with the place it painted in, so its ghost keeps it.
1212 /// A ghost whose key came back is retired here too: the live node wins.
1213 ///
1214 /// Only two kinds of key are interesting (the previous frame's
1215 /// exit-declaring roots, and the roots already departing), and both are
1216 /// few, so the walk over *this* frame's keys — the part that scales
1217 /// with the frame — is one AND against a 64-bit membership mask per
1218 /// node, and a hash lookup only for the handful that collide with it.
1219 fn collect_departures(&mut self) {
1220 let Some(now) = self.anim.time() else {
1221 // No clock: every transition snaps, and an exit that snaps is
1222 // the plain disappearance it has always been.
1223 self.depart.clear();
1224 return;
1225 };
1226 // The steady state: the view declared the same nodes in the same
1227 // order, so nothing left and nothing came back. Two flat arrays of
1228 // u64 compared is cheaper than anything that looks at the keys one
1229 // at a time, and it is the case almost every frame is.
1230 if self.prev_tree.keys == self.tree.keys {
1231 return;
1232 }
1233 let mut watch: FxHashSet<Key> = FxHashSet::default();
1234 let mut mask = 0u64;
1235 for k in self.depart.keys() {
1236 watch.insert(k);
1237 mask |= 1u64 << (k.0 & 63);
1238 }
1239 let mut candidates: Vec<usize> = Vec::new();
1240 for i in 0..self.prev_tree.len() {
1241 if crate::depart::can_depart(&self.prev_tree.specs[i]) {
1242 candidates.push(i);
1243 // The node, and its parent: an exit plays only where the
1244 // parent is still declared (backlog DX19), so the diff has
1245 // to know about that key too.
1246 let p = self.prev_tree.parent[i];
1247 let keys = [
1248 Some(self.prev_tree.keys[i]),
1249 (p != NIL).then(|| self.prev_tree.keys[p as usize]),
1250 ];
1251 for k in keys.into_iter().flatten() {
1252 watch.insert(k);
1253 mask |= 1u64 << (k.0 & 63);
1254 }
1255 }
1256 }
1257 if watch.is_empty() {
1258 return;
1259 }
1260 let mut live: FxHashSet<Key> = FxHashSet::default();
1261 for &k in &self.tree.keys {
1262 if mask & (1u64 << (k.0 & 63)) != 0 && watch.contains(&k) {
1263 live.insert(k);
1264 }
1265 }
1266 self.depart.retire_returned(&live);
1267 // The frame's removal, whole, before any of it is copied: the roots
1268 // that actually left, in tree order so a departing subtree swallows
1269 // the exits nested inside it rather than drawing them a second time
1270 // on top, and how many nodes they come to together.
1271 let mut roots: Vec<usize> = Vec::new();
1272 let mut wanted = 0usize;
1273 let mut swallowed_until = 0usize;
1274 for i in candidates {
1275 if i < swallowed_until || live.contains(&self.prev_tree.keys[i]) {
1276 continue;
1277 }
1278 // Its parent went too, and the parent declared no exit that
1279 // would have carried it (it would have swallowed it above): the
1280 // node went with its ancestor, not on its own, and plays nothing
1281 // — a tab switched away does not fade out every column that
1282 // fades when it closes (backlog DX19). CSS removes the subtree;
1283 // React's `AnimatePresence` plays the exits of its direct
1284 // children only. This is that rule.
1285 let p = self.prev_tree.parent[i];
1286 if p != NIL && !live.contains(&self.prev_tree.keys[p as usize]) {
1287 continue;
1288 }
1289 swallowed_until = self.prev_tree.subtree_end(i);
1290 wanted += swallowed_until - i;
1291 roots.push(i);
1292 }
1293 if roots.is_empty() {
1294 return;
1295 }
1296 // ADR 0012, decisions 2 and 3: the removal animates whole or not at
1297 // all, and takes the room it needs from the oldest ghosts in flight
1298 // before it is refused. Refused means every node of it vanishes at
1299 // once — what a node with no `exit` does — and one warning for the
1300 // frame, keyed by its first departing root, says how much did.
1301 if !self.depart.admit(wanted) {
1302 self.diag.raise(Warning {
1303 code: crate::diag::EXIT_BUDGET,
1304 key: self.prev_tree.keys[roots[0]],
1305 message: format!(
1306 "this frame removed {wanted} nodes declaring `exit` and the exit store \
1307 holds {}, so none of that removal animated: every departing node \
1308 vanished at once, as a node with no `exit` does; `exit` is per node, \
1309 and a list that drops many rows at once wants it on the list, not on \
1310 every row",
1311 crate::depart::MAX_NODES
1312 ),
1313 });
1314 return;
1315 }
1316 // The previous frame's paint order, built on the first departure:
1317 // a frame with one is a frame that changed shape and paid for a
1318 // layout, and the frames that did not never get here.
1319 let mut order: Option<PaintOrder> = None;
1320 for &i in &roots {
1321 let place = order
1322 .get_or_insert_with(|| PaintOrder::of(&self.prev_tree, &self.tree))
1323 .place(&self.prev_tree, i, &self.float_stack);
1324 // The group opacity the root inherited from ancestors that are
1325 // now gone: a subtree already half-faded departs from there.
1326 let mut base = 1.0;
1327 let mut a = self.prev_tree.parent[i];
1328 while a != NIL {
1329 base *= self.prev_tree.specs[a as usize].style.opacity;
1330 a = self.prev_tree.parent[a as usize];
1331 }
1332 self.depart.depart(
1333 &self.prev_tree,
1334 i,
1335 now,
1336 base,
1337 place,
1338 &self.text,
1339 &self.lines,
1340 &self.fragments,
1341 &self.paths,
1342 );
1343 }
1344 // Named now, while a tree still has them (backlog F111).
1345 self.trace_departures(&roots);
1346 }
1347
1348 /// One departing subtree's quads: frozen rects moved by however far
1349 /// its `exit` has got, outside every clip (its ancestors may be gone).
1350 /// A smaller `emit_node`: the parts a picture has (shadow, background,
1351 /// border, its content) and none of the parts a node has — no hit
1352 /// region, no scroll region, no access row.
1353 fn emit_ghost(&mut self, g: &Ghost, play: &Playback, scale: f32) {
1354 // Whole physical pixels, for the reason a slide's is: a ghost is
1355 // mostly text, and it moves for its whole life.
1356 let offset = play.offset.snapped(scale);
1357 self.ghost_opacity.clear();
1358 self.ghost_opacity.resize(g.nodes.len(), 1.0);
1359 self.ghost_clip.clear();
1360 self.ghost_clip.resize(g.nodes.len(), Clip::NONE);
1361 self.ghost_clip_ids.clear();
1362 self.ghost_clip_ids.resize(g.nodes.len(), NO_CLIP_ID);
1363 self.ghost_rect.clear();
1364 self.ghost_rect
1365 .resize(g.nodes.len(), Rect::new(0.0, 0.0, 0.0, 0.0));
1366 for (i, node) in g.nodes.iter().enumerate() {
1367 let mut rect = Rect::new(
1368 node.rect.x + offset.x,
1369 node.rect.y + offset.y,
1370 node.rect.w,
1371 node.rect.h,
1372 );
1373 let mut style = node.spec.style;
1374 let inherited = if node.parent == NIL {
1375 // The root carries the eased slots; an `exit` says nothing
1376 // about the subtree under it, which fades and moves with
1377 // its root and no more.
1378 if let Some(bg) = play.bg {
1379 style.bg = bg;
1380 }
1381 if let Some(radius) = play.radius {
1382 style.radius = radius;
1383 }
1384 if let Some((w, h)) = play.size {
1385 // The root's own box only: the subtree inside it is a
1386 // picture, and re-laying it out is the one thing a
1387 // frozen ghost must not do.
1388 rect.w = w.unwrap_or(rect.w);
1389 rect.h = h.unwrap_or(rect.h);
1390 }
1391 style.opacity = play.opacity;
1392 play.base_opacity
1393 } else {
1394 self.ghost_opacity[node.parent as usize]
1395 };
1396 let opacity = (inherited * style.opacity).clamp(0.0, 1.0);
1397 self.ghost_opacity[i] = opacity;
1398 // The clip is the subtree's own: a scroll box or `clip` node
1399 // inside the picture still bounds what it held (the rows a
1400 // virtual list built past its edge stay past it), while the
1401 // ancestors outside the picture, which may be gone, clip
1402 // nothing. Same rule as the live pass, from the root down —
1403 // a parent-anchored float with `clip`, a stroke or polygon
1404 // included, is held by the parent's clip as a child is (F78,
1405 // F90; the ghost pass kept the old escape, RG26).
1406 let escapes = node
1407 .spec
1408 .layout
1409 .float
1410 .is_some_and(|f| !f.clipped_by_parent());
1411 let (clip, clip_id) = if node.parent == NIL || escapes {
1412 (Clip::NONE, NO_CLIP_ID)
1413 } else {
1414 let p = node.parent as usize;
1415 let inherited = self.ghost_clip[p];
1416 if g.nodes[p].spec.layout.clips() {
1417 let clip =
1418 inherited.intersect(self.ghost_rect[p], g.nodes[p].spec.style.radius);
1419 (clip, self.display.intern_clip(clip.scaled(scale)))
1420 } else {
1421 (inherited, self.ghost_clip_ids[p])
1422 }
1423 };
1424 self.ghost_clip[i] = clip;
1425 self.ghost_clip_ids[i] = clip_id;
1426 self.ghost_rect[i] = rect;
1427 let visible = rect.intersect(&clip.rect);
1428 if visible.w <= 0.0 || visible.h <= 0.0 {
1429 continue;
1430 }
1431 let leaf = match node.content {
1432 GhostContent::Container => Leaf::Container,
1433 // None once the shaped buffer has been evicted: a ghost
1434 // older than the text cache draws no text rather than
1435 // somebody else's. A departing subtree takes no input and
1436 // holds no selection; it records no place either.
1437 GhostContent::Text { cache_key, color } => {
1438 match self.text.readd(cache_key, color) {
1439 Some(tid) => Leaf::Text { tid, sel: None },
1440 None => Leaf::Container,
1441 }
1442 }
1443 // Never focused: the departing subtree gave the keyboard
1444 // up the frame it stopped being declared.
1445 GhostContent::Edit(key) => Leaf::Edit {
1446 key,
1447 focused: false,
1448 pad: node.spec.layout.padding,
1449 },
1450 GhostContent::Image(id, opts) => Leaf::Image(id, opts),
1451 // The picture is frozen at departure — the parameters are
1452 // the ones the node last declared — while the box eases
1453 // and the group opacity fades it.
1454 GhostContent::Fragment(draw) => Leaf::Fragment(draw),
1455 GhostContent::Polygon(draw) => Leaf::Polygon(draw),
1456 // The points are the ghost's own copy; the colour is the
1457 // `bg` slot, which `play.bg` eases on the root.
1458 GhostContent::Line {
1459 first,
1460 len,
1461 width,
1462 dash,
1463 } => Leaf::Line {
1464 points: &g.points[first as usize..(first + len) as usize],
1465 width,
1466 dash,
1467 },
1468 // The ops are the ghost's own copy, the hash the live
1469 // node's, so the masks are the slots it already had.
1470 GhostContent::Path {
1471 first,
1472 len,
1473 rule,
1474 stroke_w,
1475 dash,
1476 hash,
1477 angle,
1478 } => Leaf::Path {
1479 ops: &g.ops[first as usize..(first + len) as usize],
1480 rule,
1481 stroke_w,
1482 dash,
1483 hash,
1484 angle,
1485 animating: false,
1486 },
1487 };
1488 let paint = Paint {
1489 clip,
1490 clip_id,
1491 scale,
1492 opacity,
1493 };
1494 let first_quad = self.display.quads.len();
1495 painter!(self).paint_box(rect, &style, &paint, leaf);
1496 // A departing box keeps its gradient, from the slot it had.
1497 if let Some(grad) = &node.spec.interact().gradient
1498 && !matches!(
1499 node.content,
1500 GhostContent::Line { .. }
1501 | GhostContent::Polygon(_)
1502 | GhostContent::Path { .. }
1503 )
1504 {
1505 painter!(self).paint_gradient(grad, rect, &style, &paint, first_quad);
1506 }
1507 // A departing table keeps its grid for as long as it fades.
1508 if let Some(c) = node.spec.interact().rules
1509 && node.spec.layout.is_table()
1510 {
1511 self.emit_ghost_rules(g, i, rect, offset, c, &paint);
1512 }
1513 }
1514 }
1515
1516 /// After layout: nodes that `slide` ease from last frame's position
1517 /// toward where layout put them, carrying their subtree along (hit
1518 /// regions come from the same positions, so input follows the motion).
1519 /// Nodes whose `enter` has an offset start that far away on first
1520 /// sight and ease in the same way; without `slide` that entrance is
1521 /// all their position ever eases. Preorder means a parent shifts before
1522 /// its children are visited, so nested sliders ease relative to an
1523 /// already-eased parent.
1524 fn ease_positions(&mut self) {
1525 for i in 0..self.tree.len() {
1526 let spec = &self.tree.specs[i];
1527 let Some(t) = spec.transition else {
1528 continue;
1529 };
1530 let enter = spec.anim().enter.filter(|e| e.offsets());
1531 if !spec.slide && enter.is_none() {
1532 continue;
1533 }
1534 let key = self.tree.keys[i];
1535 let target = self.tree.pos[i];
1536 let from = enter.map(|e| [target.x + e.dx, target.y + e.dy, 0.0, 0.0]);
1537 let v = self.anim.drive(
1538 key,
1539 Slot::Pos,
1540 from,
1541 [target.x, target.y, 0.0, 0.0],
1542 t,
1543 spec.slide,
1544 );
1545 // Whole physical pixels, so the text inside moves with its box
1546 // rather than wobbling in it (`Vec2::snapped`). Rounding here
1547 // and not at the end means the last frame lands exactly on the
1548 // layout position, as it did before.
1549 let d = Vec2::new(v[0] - target.x, v[1] - target.y).snapped(self.scale);
1550 if d.x == 0.0 && d.y == 0.0 {
1551 continue;
1552 }
1553 let end = self.tree.subtree_end(i);
1554 for p in &mut self.tree.pos[i..end] {
1555 p.x += d.x;
1556 p.y += d.y;
1557 }
1558 }
1559 }
1560
1561 /// After layout: every `on_layout` node whose rect differs from the one
1562 /// last reported for its key — or that was not seen last frame — posts
1563 /// `{kind="layout", x, y, w, h, parent, scale, tag}`, pending like a
1564 /// `resize`.
1565 /// A frame that leaves a node where it was posts nothing, so a view
1566 /// that stores the rect in its model and redraws does not loop.
1567 fn emit_layout_events(&mut self) {
1568 let frame_no = self.frame_no;
1569 for i in 0..self.tree.len() {
1570 let Some(tag) = &self.tree.specs[i].events().on_layout else {
1571 continue;
1572 };
1573 let key = self.tree.keys[i];
1574 let rect = Rect::from_pos_size(self.tree.pos[i], self.tree.size[i]);
1575 let changed = match self.layouts.get(&key) {
1576 Some((last, seen)) if *seen + 1 == frame_no => *last != rect,
1577 _ => true,
1578 };
1579 self.layouts.insert(key, (rect, frame_no));
1580 if !changed {
1581 continue;
1582 }
1583 let parent = self.tree.parent[i];
1584 let parent_rect = if parent == NIL {
1585 Rect::new(0.0, 0.0, self.viewport.w, self.viewport.h)
1586 } else {
1587 let p = parent as usize;
1588 Rect::from_pos_size(self.tree.pos[p], self.tree.size[p])
1589 };
1590 let rect_value = |r: Rect| {
1591 Value::map([
1592 ("x", Value::Float(r.x as f64)),
1593 ("y", Value::Float(r.y as f64)),
1594 ("w", Value::Float(r.w as f64)),
1595 ("h", Value::Float(r.h as f64)),
1596 ])
1597 };
1598 let payload = Value::map([
1599 ("kind", Value::str("layout")),
1600 ("x", Value::Float(rect.x as f64)),
1601 ("y", Value::Float(rect.y as f64)),
1602 ("w", Value::Float(rect.w as f64)),
1603 ("h", Value::Float(rect.h as f64)),
1604 ("parent", rect_value(parent_rect)),
1605 // Physical px per logical px at this node — the number a
1606 // view multiplies `w`/`h` by to know how many pixels to
1607 // render before `update_image` (ADR 0025, decision 5).
1608 // The frame's today; where a zoom would compose in.
1609 ("scale", Value::Float(self.scale as f64)),
1610 ]);
1611 self.pending
1612 .push(UiEvent::on(self.tree.origins[i], key, payload).tagged(Some(tag)));
1613 }
1614 }
1615
1616 /// The chrome of one layer, after its content: the bars of every
1617 /// scroller the layer emitted (`regions`), then the ring if the focused
1618 /// node is in this layer. `layer` is the float
1619 /// root's index, or `NIL` for the in-flow layer; `above` is the hit
1620 /// list's length now, which is what a bar records so a press can tell
1621 /// a region under it from one in a layer over it.
1622 fn emit_layer_chrome(
1623 &mut self,
1624 layer: u32,
1625 regions: &[ScrollRegion],
1626 scrollbars: &mut Vec<ScrollbarRegion>,
1627 above: usize,
1628 scale: f32,
1629 ) {
1630 let cursor = self.interaction.cursor();
1631 let above = above as u32;
1632 for r in regions {
1633 let i = r.node as usize;
1634 // The node's own bar style, if it declared one: hidden means
1635 // no thumb and no track, and the wheel still works because the
1636 // scroll region is already pushed. A handler has no offset to
1637 // draw a bar for.
1638 let style = self.tree.specs[i].interact().scrollbar;
1639 if r.handler || style.mode == crate::spec::ScrollbarMode::Hidden {
1640 continue;
1641 }
1642 let rest_w = style.width.unwrap_or(SCROLLBAR_W);
1643 let active_w = rest_w + (SCROLLBAR_ACTIVE_W - SCROLLBAR_W);
1644 // The grabbable gutter: the stock one, or enough for a wide
1645 // thumb and its inset.
1646 let hit_w = SCROLLBAR_HIT_W.max(active_w + 2.0 * SCROLLBAR_INSET);
1647 let max = self.tree.scroll_max[i];
1648 let offset = self.scroll.drawn(r.key);
1649 let clip_id = self.clip_ids.get(i).copied().unwrap_or(NO_CLIP_ID);
1650 let mut opacity = self.opacity.get(i).copied().unwrap_or(1.0);
1651 // The tracks, before either bar: an `auto` bar is held while
1652 // the pointer is on either track, and the two tracks share the
1653 // one quiet clock.
1654 let track_y = Rect::new(
1655 r.rect.x + r.rect.w - hit_w,
1656 r.rect.y + SCROLLBAR_INSET,
1657 hit_w,
1658 r.rect.h - 2.0 * SCROLLBAR_INSET,
1659 );
1660 let track_x = Rect::new(
1661 r.rect.x + SCROLLBAR_INSET,
1662 r.rect.y + r.rect.h - hit_w,
1663 r.rect.w - 2.0 * SCROLLBAR_INSET,
1664 hit_w,
1665 );
1666 if style.mode == crate::spec::ScrollbarMode::Auto
1667 && let Some(now) = self.anim.time()
1668 {
1669 let held = self.interaction.is_scrollbar_dragging(r.key, ScrollAxis::Y)
1670 || self.interaction.is_scrollbar_dragging(r.key, ScrollAxis::X)
1671 || cursor.is_some_and(|p| {
1672 (max.y > 0.0 && track_y.contains(p)) || (max.x > 0.0 && track_x.contains(p))
1673 });
1674 let idle = self.scroll.bar_idle(r.key, now, held);
1675 let shown = if idle < SCROLLBAR_HOLD {
1676 1.0
1677 } else {
1678 (1.0 - (idle - SCROLLBAR_HOLD) / SCROLLBAR_FADE).max(0.0)
1679 };
1680 if shown <= 0.0 {
1681 continue; // faded out: no thumb, and no track to press
1682 }
1683 // Something to settle: the hold running out, or the fade.
1684 // Not while held — that is input's to end, and a frame a
1685 // hover would ask for every 8 ms is the idle CPU C27 fought.
1686 if !held {
1687 self.owe_frame("scrollbar fade");
1688 }
1689 opacity *= shown as f32;
1690 }
1691 for (axis, track) in [(ScrollAxis::Y, track_y), (ScrollAxis::X, track_x)] {
1692 let (max_a, offset_a) = match axis {
1693 ScrollAxis::Y => (max.y, offset.y),
1694 ScrollAxis::X => (max.x, offset.x),
1695 };
1696 if max_a <= 0.0 {
1697 continue;
1698 }
1699 let active = self.interaction.is_scrollbar_dragging(r.key, axis)
1700 || cursor.is_some_and(|p| track.contains(p));
1701 let w = if active { active_w } else { rest_w };
1702 let (thumb, bar_len) = thumb_along(axis, r.rect, track, max_a, offset_a, w);
1703 let mut bar =
1704 scrollbar_quad(thumb, scale, clip_id, self.thumb_color(&style, active));
1705 bar.color.a *= opacity;
1706 self.display.quads.push(bar);
1707 scrollbars.push(ScrollbarRegion {
1708 key: r.key,
1709 axis,
1710 thumb,
1711 track,
1712 bar_len,
1713 max: max_a,
1714 inert: r.inert,
1715 above,
1716 });
1717 }
1718 }
1719 self.emit_focus_ring(layer, scale);
1720 }
1721
1722 /// The layer node `i` paints in: its float root's index, `NIL` in flow
1723 /// — and `NIL` for every node of a frame that floats nothing, where the
1724 /// map is not even sized.
1725 #[inline]
1726 fn layer_of(&self, i: usize) -> u32 {
1727 self.float_root.get(i).copied().unwrap_or(NIL)
1728 }
1729
1730 /// This frame's float layers in paint order, from `roots` (the float
1731 /// roots in tree order) and the stack the last frame left: a root the
1732 /// stack knows keeps its place, one it does not is appended, in tree
1733 /// order, and a root the frame no longer declares is dropped. Writes
1734 /// the stack back for the next frame.
1735 ///
1736 /// The steady state — the same roots as last frame — is one pass over
1737 /// the stack and no allocation beyond the order itself: each entry
1738 /// remembers its root's rank in tree order, so the check and the
1739 /// answer are the same read.
1740 fn stack_floats(&mut self, roots: &[u32]) -> Vec<u32> {
1741 let keys = &self.tree.keys;
1742 let stack = &mut self.float_stack;
1743 let steady = stack.len() == roots.len()
1744 && stack
1745 .iter()
1746 .all(|&(k, rank)| keys[roots[rank as usize] as usize] == k);
1747 let order: Vec<u32> = if steady {
1748 stack
1749 .iter()
1750 .map(|&(_, rank)| roots[rank as usize])
1751 .collect()
1752 } else {
1753 // A float opened or closed: the ranks are found again, by key.
1754 let rank_of: FxHashMap<Key, u32> = roots
1755 .iter()
1756 .enumerate()
1757 .map(|(rank, &r)| (keys[r as usize], rank as u32))
1758 .collect();
1759 let mut placed = vec![false; roots.len()];
1760 let mut next: Vec<(Key, u32)> = Vec::with_capacity(roots.len());
1761 for &(k, _) in stack.iter() {
1762 if let Some(&rank) = rank_of.get(&k) {
1763 placed[rank as usize] = true;
1764 next.push((k, rank));
1765 }
1766 }
1767 for (rank, &r) in roots.iter().enumerate() {
1768 if !placed[rank] {
1769 next.push((keys[r as usize], rank as u32));
1770 }
1771 }
1772 *stack = next;
1773 stack
1774 .iter()
1775 .map(|&(_, rank)| roots[rank as usize])
1776 .collect()
1777 };
1778 // A nested float is above the float it is in — by construction,
1779 // since its key derives from its parent's and so cannot have been
1780 // opened first; said here so the construction cannot drift.
1781 debug_assert!(order.iter().enumerate().all(|(pos, &r)| {
1782 let parent = self.tree.parent[r as usize];
1783 parent == NIL || {
1784 let outer = self.float_root[parent as usize];
1785 outer == NIL || order[..pos].contains(&outer)
1786 }
1787 }));
1788 order
1789 }
1790
1791 /// The `modal-behind-content` check, for the stack: a float layer
1792 /// above the modal's whose root is outside the modal's scope is inert
1793 /// and drawn over the one surface that takes input, which is the same
1794 /// defect the in-flow check names. Only a layer
1795 /// with something in it that *would* take input is the defect — a
1796 /// control the user sees and cannot press. A picture over the dialog
1797 /// (a HUD, the devtools' inspector outline) is not, and is not named.
1798 fn check_layers_over_modal(&mut self, order: &[u32]) {
1799 let Some((start, end, modal_key)) = self.modal else {
1800 return;
1801 };
1802 let modal_layer = self.layer_of(start);
1803 if modal_layer == NIL {
1804 return; // `diag::check_modal` has this case
1805 }
1806 let Some(at) = order.iter().position(|&r| r == modal_layer) else {
1807 return;
1808 };
1809 let over = order[at + 1..].iter().any(|&r| {
1810 let root = r as usize;
1811 !(start..end).contains(&root)
1812 && (root..self.tree.subtree_end(root)).any(|i| {
1813 self.float_root[i] == r
1814 && (self.tree.specs[i].hover_tracked()
1815 || crate::access::focusable(&self.tree, i))
1816 })
1817 });
1818 if over {
1819 self.diag.raise(crate::diag::modal_under_layer(modal_key));
1820 }
1821 }
1822
1823 /// The default focus ring around the keyboard-visibly focused node, at
1824 /// the end of the layer the node is in — above every sibling that could
1825 /// touch it, under every layer over it — in the same display list
1826 /// every binding draws. Not for editors (the caret shows focus), key
1827 /// sinks (an app surface styles itself, through `is_focused` /
1828 /// `focus_visible`) or nodes declaring `focus_bg`.
1829 fn emit_focus_ring(&mut self, layer: u32, scale: f32) {
1830 if !self.focus_visible {
1831 return;
1832 }
1833 let Some(i) = self.focus_index() else {
1834 return;
1835 };
1836 if self.layer_of(i) != layer {
1837 return;
1838 }
1839 let spec = &self.tree.specs[i];
1840 let editor = matches!(self.tree.content[i], NodeContent::Edit(_))
1841 || spec
1842 .access()
1843 .role
1844 .is_some_and(crate::access::Role::is_editor);
1845 if editor
1846 || spec.events().on_key.is_some()
1847 || spec.interact().focus_bg.is_some()
1848 || spec.disabled
1849 {
1850 return;
1851 }
1852 let node = Rect::from_pos_size(self.tree.pos[i], self.tree.size[i]);
1853 let rect = Rect::new(
1854 node.x - FOCUS_RING_GAP,
1855 node.y - FOCUS_RING_GAP,
1856 node.w + 2.0 * FOCUS_RING_GAP,
1857 node.h + 2.0 * FOCUS_RING_GAP,
1858 );
1859 let clip = self.clips.get(i).copied().unwrap_or(Clip::NONE);
1860 // No entry means nothing clipped this frame, which is entry zero.
1861 let clip_id = self.clip_ids.get(i).copied().unwrap_or(NO_CLIP_ID);
1862 let visible = rect.intersect(&clip.rect);
1863 if visible.w <= 0.0 || visible.h <= 0.0 {
1864 return;
1865 }
1866 let mut ring = self.theme().focus_ring;
1867 ring.a *= self.opacity.get(i).copied().unwrap_or(1.0);
1868 self.display.quads.push(Quad {
1869 rect: rect.scaled(scale),
1870 color: Color::TRANSPARENT,
1871 border_color: ring,
1872 radius: spec.style.radius.map(|r| (r + FOCUS_RING_GAP) * scale),
1873 border_w: FOCUS_RING_W * scale,
1874 blur: 0.0,
1875 kind: QuadKind::Solid,
1876 clip: clip_id,
1877 uv: [0; 4],
1878 });
1879 }
1880
1881 /// See the `ime_rect` field. None when nothing with a caret is
1882 /// focused: neither a stock editor nor a sink holding a `line` that
1883 /// declares one.
1884 pub fn ime_rect(&self) -> Option<Rect> {
1885 self.ime_rect
1886 }
1887
1888 /// The stock editor `key`'s node and its caret rect in viewport
1889 /// coordinates, from the frame laid out: the editor's own caret
1890 /// (physical px inside its text box) placed at the node's content
1891 /// origin. The one place this arithmetic lives — the
1892 /// IME anchor and the scroll-into-view both read it. None when no
1893 /// node of this frame is that editor, or it has no caret.
1894 pub(crate) fn stock_caret_viewport_rect(&mut self, key: Key) -> Option<(usize, Rect)> {
1895 let i = (0..self.tree.len()).find(|&i| self.tree.content[i] == NodeContent::Edit(key))?;
1896 let caret = self.edit_with_fonts(|edit, fs| edit.caret_rect(key, fs))?;
1897 let pad = self.tree.specs[i].layout.padding;
1898 Some((
1899 i,
1900 Rect::new(
1901 self.tree.pos[i].x + pad.l + caret.x / self.scale,
1902 self.tree.pos[i].y + pad.t + caret.y / self.scale,
1903 caret.w / self.scale,
1904 caret.h / self.scale,
1905 ),
1906 ))
1907 }
1908
1909 fn focused_caret_rect(&mut self) -> Option<Rect> {
1910 if let Some(key) = self.edit.focused() {
1911 return self.stock_caret_viewport_rect(key).map(|(_, r)| r);
1912 }
1913 // A custom editor (backlog C17): the focused node's subtree holds
1914 // the `line` rows it draws, and the one carrying `caret` says
1915 // where the caret is — a byte offset into that line's runs, which
1916 // is the question `caret_rect` answers. This runs after the text
1917 // pass, so the places it reads are this frame's.
1918 let (l, caret, _) = self.sink_caret_line()?;
1919 self.text.caret_at(self.tree.keys[l], caret as usize, false)
1920 }
1921
1922 /// The `line` under the focused node that declares `caret`, the
1923 /// offset it declares, and whether it declares the caret
1924 /// `caret_solid` — a custom editor's caret, in the frame just built.
1925 /// None with a stock editor focused, or nothing declaring one.
1926 fn sink_caret_line(&self) -> Option<(usize, u32, bool)> {
1927 if !self.tree.any_line {
1928 return None;
1929 }
1930 // The editor whose caret this is: the focused sink, or the sink
1931 // enclosing a focused control inside it — the node keys and
1932 // commits already go to (`key_target`, `sink_event`). Read from
1933 // the focused node alone, focus on a pane button inside a custom
1934 // editor un-armed the blink clock and lost the IME its anchor
1935 // while the keys kept arriving (backlog AR29).
1936 let i = self.focus_index()?;
1937 let i = if self.tree.specs[i].events().on_key.is_some() {
1938 i
1939 } else {
1940 self.enclosing_sink(i)?
1941 };
1942 // The candidates are the editor's lines as the access tree reads
1943 // them — `role="none"` subtrees (a gutter) skipped, a line's own
1944 // subtree not descended into — and the *last* one declaring a
1945 // caret is the caret, as `custom_editor` reads it.
1946 let l = crate::access::lines_under(&self.tree, i)
1947 .into_iter()
1948 .rev()
1949 .find(|&l| self.tree.specs[l].access().caret.is_some())?;
1950 let access = self.tree.specs[l].access();
1951 Some((l, access.caret?, access.caret_solid))
1952 }
1953
1954 /// Remembers this frame's custom-editor caret and bumps the stamp when
1955 /// it is not last frame's: the blink clock reads both.
1956 /// Whether it is solid is kept beside it, not in it: a caret going
1957 /// from bar to block has not moved, and the clock re-arms on the
1958 /// way back from `has_caret` alone.
1959 fn note_sink_caret(&mut self) {
1960 let (now, solid) = if self.edit.focused().is_some() {
1961 (None, false)
1962 } else {
1963 match self.sink_caret_line() {
1964 Some((l, offset, solid)) => (Some((self.tree.keys[l], offset)), solid),
1965 None => (None, false),
1966 }
1967 };
1968 if now != self.sink_caret {
1969 self.sink_caret = now;
1970 self.sink_caret_stamp += 1;
1971 }
1972 self.sink_caret_solid = solid;
1973 }
1974
1975 // -- The caret's blink --------------------------------------------
1976 // The clock is the driver's (a frame twice a second is a decision
1977 // about the window, not the tree); what the core keeps is whether
1978 // there is a caret to blink, when it moved, and the phase the driver
1979 // last set — for the stock editor, which paints its own caret on the
1980 // phase, and for a custom one, which reads it (backlog C35).
1981
1982 /// Whether there is a caret to blink: a focused stock editor's, or the
1983 /// `caret` a `line` under the focused custom editor declares — unless
1984 /// that line declares it `caret_solid`, which is a caret to anchor
1985 /// the IME and read to assistive technology but not one to blink. A
1986 /// driver arms its blink clock while this is true and leaves the
1987 /// caret solid otherwise.
1988 pub fn has_caret(&self) -> bool {
1989 self.edit.focused().is_some() || (self.sink_caret.is_some() && !self.sink_caret_solid)
1990 }
1991
1992 /// Changes whenever the caret moved or focus changed — the stock
1993 /// editor's caret through typing or a click, a custom editor's
1994 /// through the `caret` row it declares — so a driver comparing it
1995 /// across frames re-arms the blink with the caret solid, the way a
1996 /// caret that just moved is never mid-blink.
1997 pub fn caret_stamp(&self) -> u64 {
1998 self.edit.caret_stamp().wrapping_add(self.sink_caret_stamp)
1999 }
2000
2001 /// The blink phase, as the driver last set it: `true` draws the
2002 /// caret. The stock editor reads it itself; a custom editor reads it
2003 /// in `view` (`Ui::caret_visible`) and skips its caret node on the
2004 /// off phase, so the two blink in step — and a window without the
2005 /// keyboard, where the driver parks it hidden, shows neither.
2006 /// Headless it stays `true`.
2007 pub fn caret_visible(&self) -> bool {
2008 self.edit.blink_visible()
2009 }
2010
2011 /// Sets the blink phase; the driver's, on its clock. A frame is the
2012 /// caller's to ask for.
2013 pub fn set_caret_visible(&mut self, visible: bool) {
2014 self.edit.set_blink_visible(visible);
2015 }
2016}
2017
2018/// Combined measurer handed to the layout pass: static text through the
2019/// shape cache, editors through the edit store (sharing one FontSystem),
2020/// images through the resource registry.
2021struct Measure<'a> {
2022 text: &'a mut TextSystem,
2023 cells: &'a mut crate::cells::CellStore,
2024 fonts: &'a mut cosmic_text::FontSystem,
2025 edit: &'a mut EditStore,
2026 resources: &'a Resources,
2027}
2028
2029impl TextMeasure for Measure<'_> {
2030 fn intrinsic(&mut self, id: crate::tree::TextId) -> Size {
2031 self.text.intrinsic(id)
2032 }
2033
2034 fn wrapped(&mut self, id: crate::tree::TextId, max_w: f32) -> Size {
2035 self.text.wrapped(id, max_w, self.fonts)
2036 }
2037
2038 fn min_content(&mut self, id: crate::tree::TextId) -> f32 {
2039 self.text.min_content(id)
2040 }
2041
2042 fn edit_intrinsic(&mut self, key: Key) -> Size {
2043 self.edit.intrinsic(key, self.fonts)
2044 }
2045
2046 fn edit_wrapped(&mut self, key: Key, max_w: f32) -> Size {
2047 self.edit.wrapped(key, max_w, self.fonts)
2048 }
2049
2050 fn baseline(&mut self, id: crate::tree::TextId) -> f32 {
2051 self.text.baseline(id)
2052 }
2053
2054 fn edit_baseline(&mut self, key: Key) -> f32 {
2055 self.edit.baseline(key)
2056 }
2057
2058 fn cells_size(&mut self, id: crate::cells::CellsId) -> Size {
2059 self.cells.size(id, self.resources, self.fonts)
2060 }
2061
2062 fn image_size(&mut self, id: crate::resources::ImageId) -> Size {
2063 self.resources
2064 .image(id)
2065 .map_or(Size::ZERO, |e| Size::new(e.width as f32, e.height as f32))
2066 }
2067}
2068
2069/// What a node inherits at emission time: the frame's scale, the clip its
2070/// ancestors imposed (logical px), and the group opacity its own `opacity`
2071/// and every ancestor's multiply out to.
2072#[derive(Clone, Copy)]
2073/// What a box holds, resolved to what painting it needs: the live pass
2074/// resolves a text node's selection and an editor's focus from the frame,
2075/// a ghost resolves nothing (no selection, never focused, its text re-added
2076/// from the cache) — and both hand the result here.
2077enum Leaf<'a> {
2078 Container,
2079 Text {
2080 tid: crate::tree::TextId,
2081 sel: Option<((usize, usize), Color)>,
2082 },
2083 Cells {
2084 cid: crate::cells::CellsId,
2085 at: Vec2,
2086 sel: Option<&'a crate::select::CellSelection>,
2087 tint: Color,
2088 },
2089 Edit {
2090 key: Key,
2091 focused: bool,
2092 /// The box's padding: the text starts inside it.
2093 pad: crate::geom::Edges,
2094 },
2095 Image(crate::resources::ImageId, crate::resources::ImageOpts),
2096 Fragment(crate::fragment::Draw),
2097 /// A polygon's draw; the fill is the node's `bg`, put through the
2098 /// fragment quad's colour rather than a box under it.
2099 Polygon(crate::fragment::Draw),
2100 Line {
2101 points: &'a [Vec2],
2102 width: f32,
2103 /// What cuts the stroke into marks (backlog V2); None for solid.
2104 dash: Option<crate::line::Cut>,
2105 },
2106 /// A path's run; the fill is the node's `bg`, the stroke its border
2107 /// colour and width, each a mask quad from the atlas (ADR 0040).
2108 Path {
2109 ops: &'a [crate::path::PathOp],
2110 rule: crate::path::FillRule,
2111 stroke_w: f32,
2112 /// What cuts the stroke into marks, as a line's (backlog V2).
2113 dash: Option<crate::line::Cut>,
2114 hash: u64,
2115 /// The turn in radians of a path that declared one (ADR 0041).
2116 angle: Option<f32>,
2117 animating: bool,
2118 },
2119}
2120
2121/// One box's paint: its shadow, its fill and border, its content, faded by
2122/// the group opacity — written once for the live node and the ghost, which
2123/// differ in what they *record* (hit regions, scroll regions, a text's
2124/// place) and not in what they draw. The two were the same hundred and
2125/// twenty lines until F41 had to be fixed in both.
2126struct Painter<'a> {
2127 display: &'a mut DisplayList,
2128 text: &'a mut TextSystem,
2129 edit: &'a mut EditStore,
2130 cells: &'a mut crate::cells::CellStore,
2131 atlas: &'a mut GlyphAtlas,
2132 session: &'a Session,
2133 /// The masks drawn from textures of their own (ADR 0040).
2134 path_tex: &'a mut crate::path::PathTextures,
2135 frame_no: u64,
2136}
2137
2138impl Painter<'_> {
2139 /// Inlined into its two callers: a call per node with the borrows
2140 /// packed into a struct measured +2.5% on `frame_10k_rects`.
2141 /// What a leaf draws, and a shadow, are calls (`paint_leaf`,
2142 /// `shadow_quad`): inlined as well, they made every box pay for them.
2143 #[inline(always)]
2144 fn paint_box(
2145 &mut self,
2146 rect: Rect,
2147 style: &crate::spec::VisualStyle,
2148 paint: &Paint,
2149 leaf: Leaf<'_>,
2150 ) {
2151 let Paint {
2152 clip,
2153 clip_id,
2154 scale,
2155 opacity,
2156 } = *paint;
2157 let clip_px = clip.scaled(scale);
2158 let first_quad = self.display.quads.len();
2159 if style.shadow.is_visible() {
2160 self.display
2161 .quads
2162 .push(shadow_quad(style, rect, clip_id, scale));
2163 }
2164 // A stroke's `bg` is its colour, not a box to fill (ADR 0010,
2165 // decision 7), and a polygon's is its fill (ADR 0025, decision 6)
2166 // — for the ghost of one as much as for the live one.
2167 let is_line = matches!(
2168 leaf,
2169 Leaf::Line { .. } | Leaf::Polygon(_) | Leaf::Path { .. }
2170 );
2171 if !is_line
2172 && (style.bg.is_visible() || (style.border_w > 0.0 && style.border_color.is_visible()))
2173 {
2174 // Where layout put it, or on whole pixels when it asked
2175 // (`pixelSnap`), from the same numbers a text's backgrounds are.
2176 let px = rect.scaled(scale);
2177 self.display.quads.push(Quad {
2178 rect: if style.pixel_snap { px.on_pixels() } else { px },
2179 color: style.bg,
2180 border_color: style.border_color,
2181 radius: style.radius.map(|r| r * scale),
2182 border_w: style.border_w * scale,
2183 blur: 0.0,
2184 kind: QuadKind::Solid,
2185 clip: clip_id,
2186 uv: [0; 4],
2187 });
2188 }
2189 if !matches!(leaf, Leaf::Container) {
2190 self.paint_leaf(rect, style, paint, clip_px, leaf);
2191 }
2192 if opacity < 1.0 {
2193 fade(&mut self.display.quads[first_quad..], opacity);
2194 }
2195 }
2196
2197 /// A box's `gradient` (ADR 0042): one `Image` quad over the box's
2198 /// rect from the gradient's slot in the atlas, put where it paints
2199 /// over the background and under everything else the box drew — its
2200 /// content, and its border, which moves to a ring of its own on top
2201 /// so the gradient does not cover the inside of it. `first_quad` is
2202 /// where the box's quads start. A gradient no page can hold draws
2203 /// nothing.
2204 #[cold]
2205 #[inline(never)]
2206 fn paint_gradient(
2207 &mut self,
2208 g: &crate::gradient::Gradient,
2209 rect: Rect,
2210 style: &crate::spec::VisualStyle,
2211 paint: &Paint,
2212 first_quad: usize,
2213 ) {
2214 if !g.is_drawable() {
2215 return;
2216 }
2217 let (w, h) = g.slot_size();
2218 let Some(slot) = self
2219 .atlas
2220 .get_or_insert_gradient(g.key(), w, h, || g.rasterize())
2221 else {
2222 return;
2223 };
2224 let quads = &mut self.display.quads;
2225 let px = rect.scaled(paint.scale);
2226 let image = Quad {
2227 rect: if style.pixel_snap { px.on_pixels() } else { px },
2228 // White is untinted; the group opacity rides its alpha.
2229 color: Color {
2230 a: paint.opacity.min(1.0),
2231 ..Color::WHITE
2232 },
2233 border_color: Color::TRANSPARENT,
2234 radius: style.radius.map(|r| r * paint.scale),
2235 border_w: 0.0,
2236 blur: 0.0,
2237 kind: QuadKind::Image,
2238 clip: paint.clip_id,
2239 // The raster inside its gutter (`Gradient::rasterize`).
2240 uv: [slot.x + 1, slot.y + 1, slot.w - 2, slot.h - 2],
2241 };
2242 // Where `paint_box` put the box's own solid, when it painted
2243 // one: after the shadow, before the content.
2244 let at = first_quad + usize::from(style.shadow.is_visible());
2245 let bordered = style.border_w > 0.0 && style.border_color.is_visible();
2246 if !style.bg.is_visible() && !bordered {
2247 // No background and no border: the gradient is the box.
2248 quads.insert(at, image);
2249 return;
2250 }
2251 // The border as a ring of its own, above the gradient; what is
2252 // left under it is the background alone.
2253 let ring = bordered.then(|| Quad {
2254 color: Color::TRANSPARENT,
2255 ..quads[at]
2256 });
2257 if style.bg.is_visible() {
2258 quads[at].border_w = 0.0;
2259 quads[at].border_color = Color::TRANSPARENT;
2260 quads.insert(at + 1, image);
2261 } else {
2262 quads[at] = image;
2263 }
2264 let over = at + 1 + usize::from(style.bg.is_visible());
2265 if let Some(ring) = ring {
2266 quads.insert(over, ring);
2267 }
2268 }
2269
2270 /// What a leaf draws inside its box: text, cells, an editor, an
2271 /// image, a fragment, a polygon's fill or a stroke. Out of line, so the
2272 /// kinds a plain box never takes do not weigh on every node's
2273 /// `emit_node` — its saved registers and its stack frame.
2274 #[inline(never)]
2275 fn paint_leaf(
2276 &mut self,
2277 rect: Rect,
2278 style: &crate::spec::VisualStyle,
2279 paint: &Paint,
2280 clip_px: crate::display::Clip,
2281 leaf: Leaf<'_>,
2282 ) {
2283 let Paint { clip_id, scale, .. } = *paint;
2284 match leaf {
2285 Leaf::Container => {}
2286 Leaf::Text { tid, sel } => {
2287 let sess = &mut *self.session.state();
2288 self.text.emit(
2289 tid,
2290 Vec2::new(rect.x, rect.y),
2291 Size::new(rect.w, rect.h),
2292 clip_px,
2293 clip_id,
2294 &mut self.display.clips,
2295 &sess.resources,
2296 &mut sess.fonts,
2297 self.atlas,
2298 &mut self.display.quads,
2299 sel,
2300 );
2301 }
2302 Leaf::Cells { cid, at, sel, tint } => {
2303 let sess = &mut *self.session.state();
2304 self.cells.emit(
2305 cid,
2306 at,
2307 clip_px,
2308 clip_id,
2309 &sess.resources,
2310 &mut sess.fonts,
2311 self.text.raster_mut(),
2312 self.atlas,
2313 &mut self.display.quads,
2314 sel.map(|s| (s, tint)),
2315 );
2316 }
2317 Leaf::Edit { key, focused, pad } => {
2318 let origin = Vec2::new(
2319 crate::geom::snap_px((rect.x + pad.l) * scale),
2320 crate::geom::snap_px((rect.y + pad.t) * scale),
2321 );
2322 // A field bounds its own text horizontally — it is what
2323 // makes scrolling one legible rather than a line running
2324 // out over its neighbours (F41). Horizontally only: the
2325 // ancestors own the vertical clip, and a descender or a
2326 // caret is not what a field is trying to cut off.
2327 // Narrowing the clip makes a new one, so it needs an entry
2328 // of its own; an editor that folds to its width — a
2329 // document, or a field with `wrap` (F44) — keeps the node's.
2330 let (edit_clip, edit_clip_id) = if self.edit.folds(key) {
2331 (clip_px, clip_id)
2332 } else {
2333 let narrowed = clip_px.intersect(
2334 Rect::new(
2335 origin.x,
2336 clip_px.rect.y,
2337 (rect.w - pad.x()).max(0.0) * scale,
2338 clip_px.rect.h,
2339 ),
2340 crate::display::SQUARE,
2341 );
2342 (narrowed, self.display.intern_clip(narrowed))
2343 };
2344 let sess = &mut *self.session.state();
2345 self.edit.emit(
2346 key,
2347 origin,
2348 focused,
2349 edit_clip,
2350 edit_clip_id,
2351 &mut sess.fonts,
2352 self.text,
2353 self.atlas,
2354 &mut self.display.quads,
2355 );
2356 }
2357 Leaf::Image(id, opts) => {
2358 let sess = self.session.state();
2359 if let Some(entry) = sess.resources.image(id) {
2360 // Atlas-backed unless the entry says otherwise — or
2361 // unless the atlas cannot take it after all, which
2362 // used to draw nothing (ADR 0025, decision 2).
2363 let slot =
2364 match entry.backing {
2365 crate::resources::ImageBacking::Atlas => self
2366 .atlas
2367 .get_or_insert_image(id, entry.width, entry.height, &entry.rgba),
2368 crate::resources::ImageBacking::Texture => None,
2369 };
2370 let (kind, uv) = match slot {
2371 Some(slot) => (QuadKind::Image, [slot.x, slot.y, slot.w, slot.h]),
2372 None => (
2373 QuadKind::Texture,
2374 [self.display.textures.len() as u32, 0, 0, 0],
2375 ),
2376 };
2377 let mut uv = uv;
2378 let (rect, tex_uv) = fit_image(
2379 opts.fit,
2380 rect,
2381 Size::new(entry.width as f32, entry.height as f32),
2382 [0, 0, entry.width, entry.height],
2383 );
2384 if kind == QuadKind::Image {
2385 // The crop, if any, applied inside the atlas slot.
2386 uv = [uv[0] + tex_uv[0], uv[1] + tex_uv[1], tex_uv[2], tex_uv[3]];
2387 } else {
2388 self.display
2389 .textures
2390 .push(crate::display::TextureDraw { id, uv: tex_uv });
2391 self.display
2392 .texture_pixels
2393 .push(crate::display::TexturePixels {
2394 width: entry.width,
2395 height: entry.height,
2396 rev: entry.rev,
2397 rgba: entry.rgba.clone(),
2398 });
2399 }
2400 self.display.quads.push(Quad {
2401 rect: rect.scaled(scale),
2402 // White = untinted; radius rounds like a solid.
2403 color: Color::WHITE,
2404 border_color: Color::TRANSPARENT,
2405 radius: style.radius.map(|r| r * scale),
2406 // The sampling flag rides the slot an image never
2407 // had a border in (decision 4).
2408 border_w: match opts.sampling {
2409 crate::resources::Sampling::Linear => 0.0,
2410 crate::resources::Sampling::Nearest => 1.0,
2411 },
2412 blur: 0.0,
2413 kind,
2414 clip: clip_id,
2415 uv,
2416 });
2417 }
2418 }
2419 Leaf::Fragment(draw) => {
2420 // On whole pixels when the node asked (`pixelSnap`), as its
2421 // background is, so a stack of fragments meets seamlessly.
2422 let px = rect.scaled(scale);
2423 push_fragment(
2424 self.display,
2425 self.atlas,
2426 &self.session.state().resources,
2427 draw,
2428 if style.pixel_snap { px.on_pixels() } else { px },
2429 style.radius.map(|r| r * scale),
2430 clip_id,
2431 Color::WHITE,
2432 );
2433 }
2434 Leaf::Polygon(draw) => {
2435 if style.bg.is_visible() {
2436 push_fragment(
2437 self.display,
2438 self.atlas,
2439 &self.session.state().resources,
2440 draw,
2441 rect.scaled(scale),
2442 crate::display::SQUARE,
2443 clip_id,
2444 style.bg,
2445 );
2446 }
2447 }
2448 Leaf::Line {
2449 points,
2450 width,
2451 dash,
2452 } => {
2453 let origin = Vec2::new(rect.x, rect.y);
2454 let quads = &mut self.display.quads;
2455 // A pattern too fine to be one draws solid.
2456 let cut = dash.is_some_and(|d| {
2457 push_marks(quads, origin, points, width, d, style.bg, clip_id, scale)
2458 });
2459 if !cut {
2460 push_segments(quads, origin, points, width, style.bg, clip_id, scale);
2461 }
2462 }
2463 Leaf::Path {
2464 ops,
2465 rule,
2466 stroke_w,
2467 dash,
2468 hash,
2469 angle,
2470 animating,
2471 } => {
2472 let px = rect.scaled(scale);
2473 let mask = match angle {
2474 // The mask covers the node's box at physical scale, a
2475 // pixel over for the ramp, and is drawn on whole
2476 // pixels with the box's fractional offset baked in at
2477 // the nearest quarter — the bins a glyph is keyed on
2478 // — so the quad never resamples it.
2479 None => {
2480 let bin_of = |f: f32| -> (f32, u8) {
2481 let b = (f * 4.0).round() as u8;
2482 if b >= 4 { (1.0, 0) } else { (0.0, b) }
2483 };
2484 let (fx, fy) = (px.x.floor(), px.y.floor());
2485 let (cx, bx) = bin_of(px.x - fx);
2486 let (cy, by) = bin_of(px.y - fy);
2487 MaskAt {
2488 at: Rect::new(
2489 fx + cx,
2490 fy + cy,
2491 (px.w.ceil() + 1.0).max(1.0),
2492 (px.h.ceil() + 1.0).max(1.0),
2493 ),
2494 bin: (bx, by),
2495 off: Vec2::new(f32::from(bx) * 0.25, f32::from(by) * 0.25),
2496 angle: 0.0,
2497 }
2498 }
2499 // A turning path's box is the square about its pivot
2500 // (ADR 0041): the mask is that square on an even
2501 // number of pixels with the pivot at its centre, the
2502 // centre on a whole pixel, so the quad turns about
2503 // its own middle and, at no angle, is texel for texel.
2504 Some(angle) => {
2505 let side = 2.0 * (px.w * 0.5).ceil() + 2.0;
2506 let (cx, cy) = ((px.x + px.w * 0.5).round(), (px.y + px.h * 0.5).round());
2507 MaskAt {
2508 at: Rect::new(cx - side * 0.5, cy - side * 0.5, side, side),
2509 bin: crate::path::TURNED_BIN,
2510 off: Vec2::new((side - px.w) * 0.5, (side - px.h) * 0.5),
2511 angle,
2512 }
2513 }
2514 };
2515 if style.bg.is_visible() {
2516 self.paint_mask(
2517 ops,
2518 hash,
2519 scale,
2520 mask,
2521 crate::path::MaskPaint::Fill(rule),
2522 style.bg,
2523 clip_id,
2524 animating,
2525 );
2526 }
2527 if stroke_w > 0.0 && style.border_color.is_visible() {
2528 self.paint_mask(
2529 ops,
2530 hash,
2531 scale,
2532 mask,
2533 match dash {
2534 Some(cut) => crate::path::MaskPaint::Dashed(
2535 stroke_w * scale,
2536 crate::line::Cut {
2537 lens: cut.lens.map(|l| l * scale),
2538 offset: cut.offset * scale,
2539 },
2540 ),
2541 None => crate::path::MaskPaint::Stroke(stroke_w * scale),
2542 },
2543 style.border_color,
2544 clip_id,
2545 animating,
2546 );
2547 }
2548 }
2549 }
2550 }
2551
2552 /// One mask quad of a path: from the atlas when the mask fits it and
2553 /// the path is still, from a texture of its own otherwise (ADR 0040,
2554 /// decisions 6–8), turned by the quad when the path turns (ADR 0041).
2555 #[allow(clippy::too_many_arguments)]
2556 fn paint_mask(
2557 &mut self,
2558 ops: &[crate::path::PathOp],
2559 hash: u64,
2560 scale: f32,
2561 mask: MaskAt,
2562 paint: crate::path::MaskPaint,
2563 color: Color,
2564 clip_id: ClipId,
2565 animating: bool,
2566 ) {
2567 let MaskAt {
2568 at,
2569 bin,
2570 off,
2571 angle,
2572 } = mask;
2573 let (w, h) = (at.w as u32, at.h as u32);
2574 let key = crate::path::mask_key(hash, scale, bin, paint);
2575 let texels = u64::from(w) * u64::from(h);
2576 let slot = if animating || texels >= crate::path::MAX_ATLAS_MASK_TEXELS {
2577 None
2578 } else {
2579 self.atlas.get_or_insert_path(key, w, h, || {
2580 crate::path::rasterize_at(ops, scale, off, w, h, paint)
2581 })
2582 };
2583 let (kind, uv) = match slot {
2584 Some(slot) => (QuadKind::GlyphMask, [slot.x, slot.y, slot.w, slot.h]),
2585 None => {
2586 let tex =
2587 self.path_tex
2588 .get_or_make(key, w, h, self.frame_no, self.session.id(), || {
2589 crate::path::rasterize_at(ops, scale, off, w, h, paint)
2590 });
2591 let index = self.display.textures.len() as u32;
2592 self.display.textures.push(crate::display::TextureDraw {
2593 id: tex.id,
2594 uv: [0, 0, w, h],
2595 });
2596 self.display
2597 .texture_pixels
2598 .push(crate::display::TexturePixels {
2599 width: w,
2600 height: h,
2601 rev: 0,
2602 rgba: tex.rgba.clone(),
2603 });
2604 (QuadKind::Texture, [index, 0, 0, 0])
2605 }
2606 };
2607 self.display.quads.push(Quad {
2608 rect: at,
2609 color,
2610 border_color: Color::TRANSPARENT,
2611 radius: crate::display::SQUARE,
2612 border_w: 0.0,
2613 // A mask has no blur; the slot carries its turn, in radians
2614 // about the quad's centre, 0 for none (ADR 0041, decision 4).
2615 blur: angle,
2616 kind,
2617 clip: clip_id,
2618 uv,
2619 });
2620 }
2621}
2622
2623/// Where one path's masks go: the quad in physical px, on whole pixels;
2624/// the bin its masks are keyed under; where the node's box begins inside
2625/// the mask; and the quad's turn in radians.
2626#[derive(Clone, Copy)]
2627struct MaskAt {
2628 at: Rect,
2629 bin: (u8, u8),
2630 off: Vec2,
2631 angle: f32,
2632}
2633
2634#[derive(Clone, Copy)]
2635struct Paint {
2636 clip: Clip,
2637 /// `clip`, scaled and interned: what the node's quads name.
2638 clip_id: ClipId,
2639 scale: f32,
2640 /// Multiplied into the alpha of every quad the node emits.
2641 opacity: f32,
2642}
2643
2644/// As much of the previous frame's paint order as a departure needs to
2645/// keep its place (see `depart::Place`): the layer each node painted in,
2646/// and for the in-flow layer the next node at or after each index that
2647/// this frame still declares. Built once per frame that has a departure,
2648/// from the previous tree and the stack as that frame left it.
2649struct PaintOrder {
2650 /// The previous tree's float roots, by node: `NIL` in flow.
2651 float_root: Vec<u32>,
2652 /// By previous-tree index: the next live in-flow node at or after it;
2653 /// one past the end reads `NIL`.
2654 next_live: Vec<u32>,
2655 /// This frame's keys.
2656 live: FxHashSet<Key>,
2657 /// This frame's float roots, by key.
2658 roots: FxHashSet<Key>,
2659}
2660
2661impl PaintOrder {
2662 fn of(prev: &Tree, tree: &Tree) -> Self {
2663 let n = prev.len();
2664 let live: FxHashSet<Key> = tree.keys.iter().copied().collect();
2665 let roots: FxHashSet<Key> = (0..tree.len())
2666 .filter(|&i| tree.specs[i].layout.float.is_some())
2667 .map(|i| tree.keys[i])
2668 .collect();
2669 let mut float_root = vec![NIL; n];
2670 for i in 0..n {
2671 let parent = prev.parent[i];
2672 float_root[i] = if prev.specs[i].layout.float.is_some() {
2673 i as u32
2674 } else if parent != NIL {
2675 float_root[parent as usize]
2676 } else {
2677 NIL
2678 };
2679 }
2680 let mut next_live = vec![NIL; n + 1];
2681 for j in (0..n).rev() {
2682 next_live[j] = next_live[j + 1];
2683 if float_root[j] == NIL && live.contains(&prev.keys[j]) {
2684 next_live[j] = j as u32;
2685 }
2686 }
2687 Self {
2688 float_root,
2689 next_live,
2690 live,
2691 roots,
2692 }
2693 }
2694
2695 /// The place the subtree rooted at `root` of the previous frame painted
2696 /// in: its layer, and what was painted right after it there that is
2697 /// still here. `stack` is the previous frame's float stack, bottom to
2698 /// top — where a departing float finds the layer that was over it.
2699 fn place(&self, prev: &Tree, root: usize, stack: &[(Key, u32)]) -> Place {
2700 let end = prev.subtree_end(root);
2701 let layer = self.float_root[root];
2702 if layer == NIL {
2703 let after = self.next_live[end];
2704 return Place::InFlow {
2705 before: (after != NIL).then(|| prev.keys[after as usize]),
2706 };
2707 }
2708 if layer as usize != root {
2709 // Inside a float: the next live node of the same layer, found
2710 // by a scan bounded by that layer's subtree — a departure is
2711 // rare and a float is small.
2712 let layer_end = prev.subtree_end(layer as usize);
2713 let before = (end..layer_end)
2714 .find(|&j| self.float_root[j] == layer && self.live.contains(&prev.keys[j]))
2715 .map(|j| prev.keys[j]);
2716 return Place::InLayer {
2717 layer: prev.keys[layer as usize],
2718 before,
2719 };
2720 }
2721 // A float root: under the first layer above it in the stack that
2722 // is still a float this frame.
2723 let key = prev.keys[root];
2724 let at = stack.iter().position(|&(k, _)| k == key);
2725 let before = at.and_then(|at| {
2726 stack[at + 1..]
2727 .iter()
2728 .map(|&(k, _)| k)
2729 .find(|k| self.roots.contains(k))
2730 });
2731 Place::Layer { before }
2732 }
2733}
2734
2735/// One [`QuadKind::Segment`] per straight piece of a stroke: `points` are
2736/// relative to `origin` (the node's box, logical px) and `width` is
2737/// logical; everything on the quad is physical. The rect is the piece's
2738/// bounding box padded by half the width plus two logical px, so the
2739/// backend's edge ramp is never cut by the quad's own edge, and the
2740/// endpoints ride in `uv` (see [`Quad::segment_ends`]).
2741///
2742/// Kept out of line on purpose: inlined into `emit_node`,
2743/// whose size moves with every prop a hit region grows, the loop's carried
2744/// point lost its register to the stack once the drop-zone commit tipped
2745/// the allocator — a store and a reload on every segment, +10% on
2746/// `frame_1k_curves`. On its own the loop keeps every value in a register.
2747#[inline(never)]
2748fn push_segments(
2749 quads: &mut Vec<Quad>,
2750 origin: Vec2,
2751 points: &[Vec2],
2752 width: f32,
2753 color: Color,
2754 clip_id: ClipId,
2755 scale: f32,
2756) {
2757 let pad = crate::line::pad(width) * scale;
2758 let w = width.max(0.0) * scale;
2759 for pair in points.windows(2) {
2760 let a = Vec2::new(
2761 (origin.x + pair[0].x) * scale,
2762 (origin.y + pair[0].y) * scale,
2763 );
2764 let b = Vec2::new(
2765 (origin.x + pair[1].x) * scale,
2766 (origin.y + pair[1].y) * scale,
2767 );
2768 let (x0, x1) = (a.x.min(b.x) - pad, a.x.max(b.x) + pad);
2769 let (y0, y1) = (a.y.min(b.y) - pad, a.y.max(b.y) + pad);
2770 quads.push(Quad {
2771 rect: Rect::new(x0, y0, x1 - x0, y1 - y0),
2772 color,
2773 border_color: Color::TRANSPARENT,
2774 radius: crate::display::SQUARE,
2775 border_w: w,
2776 blur: 0.0,
2777 kind: QuadKind::Segment,
2778 clip: clip_id,
2779 uv: Quad::segment_uv([a.x, a.y, b.x, b.y]),
2780 });
2781 }
2782}
2783
2784/// A dashed stroke's quads: one [`QuadKind::Segment`] per mark per
2785/// piece it lies on, as [`push_segments`] makes one per piece — a mark is
2786/// a short stroke, round caps and all, so a backend that draws a line
2787/// draws a dashed one (backlog V2). False, with nothing pushed, for a
2788/// pattern the caller draws solid: a mark and its gap under a physical
2789/// pixel together, or
2790/// more marks than [`crate::line::MAX_MARKS`].
2791///
2792/// Its own function, and never inlined, for the reason `push_segments`
2793/// is: nothing of the rare path belongs in `emit_node`.
2794#[inline(never)]
2795#[allow(clippy::too_many_arguments)]
2796fn push_marks(
2797 quads: &mut Vec<Quad>,
2798 origin: Vec2,
2799 points: &[Vec2],
2800 width: f32,
2801 cut: crate::line::Cut,
2802 color: Color,
2803 clip_id: ClipId,
2804 scale: f32,
2805) -> bool {
2806 let pad = crate::line::pad(width) * scale;
2807 let w = width.max(0.0) * scale;
2808 cut.marks(points, 1.0 / scale, |from, to| {
2809 let a = Vec2::new((origin.x + from.x) * scale, (origin.y + from.y) * scale);
2810 let b = Vec2::new((origin.x + to.x) * scale, (origin.y + to.y) * scale);
2811 let (x0, x1) = (a.x.min(b.x) - pad, a.x.max(b.x) + pad);
2812 let (y0, y1) = (a.y.min(b.y) - pad, a.y.max(b.y) + pad);
2813 quads.push(Quad {
2814 rect: Rect::new(x0, y0, x1 - x0, y1 - y0),
2815 color,
2816 border_color: Color::TRANSPARENT,
2817 radius: crate::display::SQUARE,
2818 border_w: w,
2819 blur: 0.0,
2820 kind: QuadKind::Segment,
2821 clip: clip_id,
2822 uv: Quad::segment_uv([a.x, a.y, b.x, b.y]),
2823 });
2824 })
2825}
2826
2827/// The drop shadow behind one node, in physical pixels. The quad is the
2828/// shadow's own shape — the node's rect moved by `dx`/`dy` and grown by
2829/// `spread` — inflated by `blur` on every side, because that is how far
2830/// the blurred edge reaches; the backend insets by `blur` again to find
2831/// the shape. Radii grow with the spread so a rounded box keeps its
2832/// silhouette instead of sprouting corners. Never inlined: in
2833/// `emit_node` its arithmetic took two more saved float registers for
2834/// every node, shadow or not.
2835#[inline(never)]
2836fn shadow_quad(style: &crate::spec::VisualStyle, rect: Rect, clip_id: ClipId, scale: f32) -> Quad {
2837 let sh = style.shadow;
2838 let blur = sh.blur.max(0.0);
2839 let shape = Rect::new(
2840 rect.x + sh.dx - sh.spread,
2841 rect.y + sh.dy - sh.spread,
2842 (rect.w + 2.0 * sh.spread).max(0.0),
2843 (rect.h + 2.0 * sh.spread).max(0.0),
2844 );
2845 let rect = if style.pixel_snap {
2846 // Snapped with its box, so it stays under it; the blur around it.
2847 let s = shape.scaled(scale).on_pixels();
2848 let b = blur * scale;
2849 Rect::new(s.x - b, s.y - b, s.w + 2.0 * b, s.h + 2.0 * b)
2850 } else {
2851 Rect::new(
2852 (shape.x - blur) * scale,
2853 (shape.y - blur) * scale,
2854 (shape.w + 2.0 * blur) * scale,
2855 (shape.h + 2.0 * blur) * scale,
2856 )
2857 };
2858 Quad {
2859 rect,
2860 color: sh.color,
2861 border_color: Color::TRANSPARENT,
2862 radius: style.radius.map(|r| (r + sh.spread).max(0.0) * scale),
2863 border_w: 0.0,
2864 blur: blur * scale,
2865 kind: QuadKind::Shadow,
2866 clip: clip_id,
2867 uv: [0; 4],
2868 }
2869}
2870
2871/// Multiplies a group opacity into a run of quads. Alpha only: every quad
2872/// kind reads `color.a` as its coverage, so one multiply fades a
2873/// background, a border, a glyph and an image alike.
2874fn fade(quads: &mut [Quad], opacity: f32) {
2875 for q in quads {
2876 q.color.a *= opacity;
2877 q.border_color.a *= opacity;
2878 }
2879}
2880
2881/// The thumb of a scrollbar along `axis`, inset from the far edge of the
2882/// scroller's `rect`, `w` thick, and its length along the track: the
2883/// track's share of the content that is visible, never shorter than
2884/// `SCROLLBAR_MIN`, placed by how far the content has scrolled. One
2885/// geometry for both bars — the Y bar and the X bar were the same thirty
2886/// lines with the axes swapped.
2887fn thumb_along(
2888 axis: ScrollAxis,
2889 rect: Rect,
2890 track: Rect,
2891 max: f32,
2892 offset: f32,
2893 w: f32,
2894) -> (Rect, f32) {
2895 let t = (offset / max).clamp(0.0, 1.0);
2896 match axis {
2897 ScrollAxis::Y => {
2898 let bar = (track.h * rect.h / (rect.h + max)).max(SCROLLBAR_MIN);
2899 let thumb = Rect::new(
2900 rect.x + rect.w - w - SCROLLBAR_INSET,
2901 track.y + t * (track.h - bar),
2902 w,
2903 bar,
2904 );
2905 (thumb, bar)
2906 }
2907 ScrollAxis::X => {
2908 let bar = (track.w * rect.w / (rect.w + max)).max(SCROLLBAR_MIN);
2909 let thumb = Rect::new(
2910 track.x + t * (track.w - bar),
2911 rect.y + rect.h - w - SCROLLBAR_INSET,
2912 bar,
2913 w,
2914 );
2915 (thumb, bar)
2916 }
2917 }
2918}
2919
2920/// One in-flow child of a table as its rules read it: its box, and for a
2921/// row (`layout::is_table_row`) its in-flow cells' boxes.
2922struct RuledChild {
2923 rect: Rect,
2924 cells: Option<Vec<Rect>>,
2925}
2926
2927/// The rules of a table at `rect` over its in-flow `children`, `rule_w` thick
2928/// (1 when not positive):
2929///
2930/// - across, one down the middle of each gap between two in-flow
2931/// children, the content box wide;
2932/// - down, one down the middle of each gap between the columns of the
2933/// row with the most cells, over each run of consecutive rows — from
2934/// the run's first row's top to its last row's bottom.
2935///
2936/// A child that is no row — a heading text beside the rows, a `column`
2937/// section wrapping a heading over a row — is laid out across the
2938/// table and has no cells, and is ruled as a row spanning every column,
2939/// the way a `colspan` cell of a ruled HTML table is: a rule above and
2940/// below it as between rows, and the column rules stop at its edges
2941/// instead of crossing it. A table with no row has no grid to rule.
2942fn rule_lines(
2943 rect: Rect,
2944 pad: crate::geom::Edges,
2945 rule_w: f32,
2946 children: &[RuledChild],
2947) -> Vec<Rect> {
2948 let w = if rule_w > 0.0 { rule_w } else { 1.0 };
2949 let Some(widest) = children
2950 .iter()
2951 .filter_map(|c| c.cells.as_ref())
2952 .max_by_key(|cells| cells.len())
2953 else {
2954 return Vec::new();
2955 };
2956 let mut lines: Vec<Rect> = Vec::new();
2957 for pair in children.windows(2) {
2958 let (a, b) = (pair[0].rect, pair[1].rect);
2959 let y = (a.y + a.h + b.y) / 2.0;
2960 let x = rect.x + pad.l;
2961 lines.push(Rect::new(x, y - w / 2.0, rect.w - pad.l - pad.r, w));
2962 }
2963 let mut run = 0usize;
2964 while run < children.len() {
2965 if children[run].cells.is_none() {
2966 run += 1;
2967 continue;
2968 }
2969 let mut end = run;
2970 while end + 1 < children.len() && children[end + 1].cells.is_some() {
2971 end += 1;
2972 }
2973 let (top, last) = (children[run].rect.y, children[end].rect);
2974 let bottom = last.y + last.h;
2975 for pair in widest.windows(2) {
2976 let x = (pair[0].x + pair[0].w + pair[1].x) / 2.0;
2977 lines.push(Rect::new(x - w / 2.0, top, w, bottom - top));
2978 }
2979 run = end + 1;
2980 }
2981 lines
2982}
2983
2984/// Pushes a table's `lines` in `color`, faded by `paint`'s opacity, under
2985/// `clip_id`. On whole pixels, so a 1 px rule is one crisp pixel line at
2986/// any scale.
2987fn push_rules(
2988 display: &mut DisplayList,
2989 lines: &[Rect],
2990 color: Color,
2991 paint: &Paint,
2992 clip_id: ClipId,
2993) {
2994 let color = Color {
2995 a: color.a * paint.opacity,
2996 ..color
2997 };
2998 for line in lines {
2999 display.quads.push(Quad {
3000 rect: line.scaled(paint.scale).on_pixels(),
3001 color,
3002 border_color: Color::TRANSPARENT,
3003 radius: [0.0; 4],
3004 border_w: 0.0,
3005 blur: 0.0,
3006 kind: QuadKind::Solid,
3007 clip: clip_id,
3008 uv: [0; 4],
3009 });
3010 }
3011}
3012
3013fn scrollbar_quad(bar: Rect, scale: f32, clip_id: ClipId, color: Color) -> Quad {
3014 Quad {
3015 rect: bar.scaled(scale),
3016 color,
3017 border_color: Color::TRANSPARENT,
3018 radius: [bar.w.min(bar.h) / 2.0 * scale; 4],
3019 border_w: 0.0,
3020 blur: 0.0,
3021 kind: QuadKind::Solid,
3022 clip: clip_id,
3023 uv: [0; 4],
3024 }
3025}
3026
3027/// One `fragment` node's quad, live or ghost.
3028///
3029/// The handle is resolved first: a removed or foreign one draws nothing,
3030/// which is the documented fallback for every resource kind, and the
3031/// lookup is what records the `foreign-resource` warning. The quad carries
3032/// the node's own rect, radii and clip — a fragment rounds and clips like
3033/// a solid — and an opaque white `color`, whose alpha the group-opacity
3034/// pass then multiplies into; the shader reads that alpha and nothing else
3035/// of the colour, because a fragment returns its own.
3036#[allow(clippy::too_many_arguments)]
3037/// Resolves the `fit` row: the rect the pixels paint into (logical px)
3038/// and the texel rect of the image they come from. `fill` stretches the
3039/// whole image to the box; `contain` shrinks the painted rect to the
3040/// image's aspect, centred; `cover` keeps the box and crops the texels,
3041/// centred. A zero-sized image or box falls back to
3042/// `fill`, which paints nothing visible either way.
3043pub(crate) fn fit_image(
3044 fit: crate::resources::ImageFit,
3045 rect: Rect,
3046 image: Size,
3047 texels: [u32; 4],
3048) -> (Rect, [u32; 4]) {
3049 use crate::resources::ImageFit;
3050 if image.w <= 0.0 || image.h <= 0.0 || rect.w <= 0.0 || rect.h <= 0.0 {
3051 return (rect, texels);
3052 }
3053 let box_aspect = rect.w / rect.h;
3054 let image_aspect = image.w / image.h;
3055 match fit {
3056 ImageFit::Fill => (rect, texels),
3057 ImageFit::Contain => {
3058 let (w, h) = if image_aspect > box_aspect {
3059 (rect.w, rect.w / image_aspect)
3060 } else {
3061 (rect.h * image_aspect, rect.h)
3062 };
3063 (
3064 Rect::new(
3065 rect.x + (rect.w - w) * 0.5,
3066 rect.y + (rect.h - h) * 0.5,
3067 w,
3068 h,
3069 ),
3070 texels,
3071 )
3072 }
3073 ImageFit::Cover => {
3074 // Whole texels: a crop is a rect on the texture, and a
3075 // half-texel edge would sample the neighbour.
3076 let (w, h) = if image_aspect > box_aspect {
3077 ((image.h * box_aspect).round().max(1.0), image.h)
3078 } else {
3079 (image.w, (image.w / box_aspect).round().max(1.0))
3080 };
3081 let x = ((image.w - w) * 0.5).floor();
3082 let y = ((image.h - h) * 0.5).floor();
3083 (
3084 rect,
3085 [
3086 texels[0] + x as u32,
3087 texels[1] + y as u32,
3088 w as u32,
3089 h as u32,
3090 ],
3091 )
3092 }
3093 }
3094}
3095
3096/// One fragment quad and its side entry: the draw, the source a backend
3097/// compiles, and the colour the function reads as `in.color` — white for
3098/// a `fragment`, the fill for a `polygon`.
3099///
3100/// A draw naming an `image` resolves it here, where the window's atlas
3101/// is: an atlas-backed image goes into the atlas as an `image` node's
3102/// would and the draw carries its slot; a texture-backed one takes an
3103/// entry of the texture side list — the same entry an `image` node of it
3104/// would — and the draw carries the index, so the backend binds that
3105/// texture for this one quad as it does for a texture quad. An image
3106/// handle that is not live draws nothing, the fallback every resource
3107/// kind has, and the lookup is what records a foreign one.
3108#[allow(clippy::too_many_arguments)]
3109fn push_fragment(
3110 display: &mut DisplayList,
3111 atlas: &mut GlyphAtlas,
3112 resources: &crate::resources::Resources,
3113 draw: crate::fragment::Draw,
3114 rect: Rect,
3115 radius: [f32; 4],
3116 clip_id: ClipId,
3117 color: Color,
3118) {
3119 let Some(source) = resources.fragment(draw.id) else {
3120 return;
3121 };
3122 let image = match draw.image {
3123 None => crate::display::FragmentImage::None,
3124 Some(id) => {
3125 let Some(entry) = resources.image(id) else {
3126 return;
3127 };
3128 let slot = match entry.backing {
3129 crate::resources::ImageBacking::Atlas => {
3130 atlas.get_or_insert_image(id, entry.width, entry.height, &entry.rgba)
3131 }
3132 crate::resources::ImageBacking::Texture => None,
3133 };
3134 match slot {
3135 Some(slot) => {
3136 crate::display::FragmentImage::Atlas([slot.x, slot.y, slot.w, slot.h])
3137 }
3138 None => {
3139 let index = display.textures.len() as u32;
3140 let uv = [0, 0, entry.width, entry.height];
3141 display
3142 .textures
3143 .push(crate::display::TextureDraw { id, uv });
3144 display.texture_pixels.push(crate::display::TexturePixels {
3145 width: entry.width,
3146 height: entry.height,
3147 rev: entry.rev,
3148 rgba: entry.rgba.clone(),
3149 });
3150 crate::display::FragmentImage::Texture { index, uv }
3151 }
3152 }
3153 }
3154 };
3155 let index = display.fragments.len() as u32;
3156 display.fragments.push(crate::display::FragmentDraw {
3157 id: draw.id,
3158 params: draw.params,
3159 image,
3160 });
3161 display.fragment_sources.push(source.clone());
3162 display.quads.push(Quad {
3163 rect,
3164 // White on a `fragment` — the function returns its own colour and
3165 // reads this as `in.color` if it wants one — and the fill on a
3166 // `polygon`; `a` is the fill's alpha times the group opacity, which
3167 // the fade pass multiplies in after the node's quads are pushed.
3168 color,
3169 border_color: Color::TRANSPARENT,
3170 radius,
3171 border_w: 0.0,
3172 blur: 0.0,
3173 kind: QuadKind::Fragment,
3174 clip: clip_id,
3175 uv: [index, 0, 0, 0],
3176 });
3177}