Skip to main content

makeover_immediate/
widget.rs

1//! The described things that are not fields, tables or frames.
2//!
3//! A meter, a token, a control, a figure, and a wait. `makeover-tui` has had
4//! most of these since its
5//! own `widget` module and this crate has not, which is the gap that showed up
6//! the moment anything tried to draw a whole `quasi_router::Screen` in egui:
7//! the screen walk had a renderer for the containers and nothing for four of the
8//! nodes inside them, so the drawing would have landed in the consumer, one copy
9//! per app. That is the divergence this suite exists to end, so it lands here.
10//!
11//! # What "in egui" changes, and what it does not
12//!
13//! The semantics are `makeover-tui`'s, deliberately: a meter is a bar and a
14//! reading, a badge is round and a chip is square, a control names its key where
15//! the description gave one, and a figure puts the movement on the value rather
16//! than on the caption. Those are description-level readings and they do not get
17//! a second opinion per host.
18//!
19//! What differs is forced by the target rather than chosen. A terminal spends a
20//! whole cell on a character and returns a `Line` for the caller to place; egui
21//! paints an arbitrary rect and answers a [`Response`], so every function here
22//! draws into the `Ui` it is given and hands back what the user did to it. That
23//! is also why nothing here takes a `focused` flag the way `makeover-tui`'s
24//! `act` does: egui owns focus, which is the rule the crate header states.
25
26use egui::{Align, Layout, Response, RichText, Sense, Ui, Vec2};
27use makeover_layout::{Act, Awaiting, Bar, Chart, Fact, Figure, Meter, State, Token, Tone};
28use makeover_timing::activity_blink;
29use std::time::Duration;
30
31use crate::Palette;
32
33/// The sizes a widget cannot derive from the description.
34///
35/// Every number a caller might reasonably want different, in one place, on the
36/// footing [`FrameStyle`](crate::FrameStyle) and [`FieldStyle`](crate::FieldStyle)
37/// already establish: this crate owns no sizes.
38#[derive(Debug, Clone, Copy, PartialEq)]
39pub struct WidgetStyle {
40    /// How tall a meter's bar is drawn.
41    pub meter_height: f32,
42    /// How wide a meter's bar runs, or `None` to take the width on offer.
43    ///
44    /// `None` is the honest default in immediate mode: a bar in a side panel and
45    /// a bar in a wide pane are the same description, and the available width is
46    /// the only thing either of them knows.
47    pub meter_width: Option<f32>,
48    /// How tall a chart stands, in points.
49    ///
50    /// A chart's own, not [`meter_height`](Self::meter_height): a meter is a
51    /// rule set into a line of text and a chart is a figure with room of its
52    /// own. `makeover-webview` defers the same number to `--chart-height` for
53    /// the same reason, and 200 is the same default.
54    pub chart_height: f32,
55    /// The corner radius on a meter's trough and on a token.
56    pub radius: u8,
57    /// Inside a token, around its label.
58    pub token_padding: Vec2,
59    /// Between a figure's value and its caption.
60    pub figure_gap: f32,
61    /// How much larger a figure's value is drawn than the body text.
62    ///
63    /// A multiplier rather than a size, so a figure scales with whatever text
64    /// style the app has set rather than pinning a point size this crate has no
65    /// business choosing.
66    pub figure_scale: f32,
67    /// The side of the activity mark, square.
68    ///
69    /// Small on purpose. The mark says one thing and a reader should have to
70    /// look at it to read it, which is the difference between an indicator and
71    /// an animation competing with the content it sits beside.
72    pub mark_size: f32,
73}
74
75impl Default for WidgetStyle {
76    /// Bars at 6pt taking the width on offer, a figure at double text size, and
77    /// the activity mark a square a little larger than a bar is tall.
78    fn default() -> Self {
79        Self {
80            meter_height: 6.0,
81            meter_width: None,
82            chart_height: 200.0,
83            radius: 3,
84            token_padding: Vec2::new(6.0, 2.0),
85            figure_gap: 2.0,
86            figure_scale: 2.0,
87            mark_size: 8.0,
88        }
89    }
90}
91
92/// A proportion as a bar and a reading.
93///
94/// The reading is built here from the two numbers and the noun, for the reason
95/// `makeover-tui` states: [`Meter::label`] carries the noun alone, so each
96/// renderer picks its own sentence order rather than the description picking one
97/// for all of them.
98///
99/// **A bar that has run over is drawn full and reads over.** `done` may exceed
100/// `total` and that is the case worth drawing, per `Meter`'s own docs: the fill
101/// is clamped because a rect cannot be longer than itself, and the reading is
102/// not, because "9/6" is the fact the user needs. Clamping both would hide the
103/// overrun entirely, which is the bug goingson's `is_over_estimate` flag exists
104/// to recover from on the other side.
105///
106/// A zero `total` is no set rather than a complete one, so it draws empty.
107pub fn meter(ui: &mut Ui, meter: &Meter<'_>, palette: &Palette, style: &WidgetStyle) -> Response {
108    let width = style
109        .meter_width
110        .unwrap_or_else(|| ui.available_width().max(1.0));
111    ui.horizontal(|ui| {
112        let (rect, response) =
113            ui.allocate_exact_size(Vec2::new(width, style.meter_height), Sense::hover());
114        // The trough is the sunken surface rather than a tint of the tone: a
115        // bar is a thing set into the page with something in it, which is what
116        // `Fill::Sunken` means, and tinting the empty half would read as a
117        // second, paler proportion.
118        ui.painter().rect_filled(rect, style.radius, palette.sunken);
119        let share = if meter.total == 0 {
120            0.0
121        } else {
122            (f64::from(meter.done) / f64::from(meter.total)).min(1.0)
123        };
124        #[expect(
125            clippy::cast_possible_truncation,
126            reason = "a share is 0..=1 and the product is a width in points"
127        )]
128        let filled = (f64::from(rect.width()) * share) as f32;
129        if filled > 0.0 {
130            let mut fill = rect;
131            fill.set_width(filled);
132            ui.painter()
133                .rect_filled(fill, style.radius, palette.tone(meter.tone));
134        }
135        let reading = match meter.label {
136            Some(label) => format!("{}/{} {label}", meter.done, meter.total),
137            None => format!("{}/{}", meter.done, meter.total),
138        };
139        ui.label(RichText::new(reading).color(palette.content_muted));
140        response
141    })
142    .inner
143}
144
145/// A badge or a chip.
146///
147/// A badge is the table model's (wiki `table-model`), as `makeover-webview`
148/// draws it: a fill of its tone surface inside a one-point edge in its tone,
149/// the label in content ink. A neutral badge fills with the raised surface and
150/// takes the border for its edge. The tone is never the ink, which measured
151/// 1.34:1 as text on goingson's warning.
152///
153/// A chip is outlined in its tone, and filled while latched.
154///
155/// **A chip answers a click and a badge does not**, which is
156/// [`Token::interactive`] and is the whole difference between the members. The
157/// `Response` comes back either way, so a caller that presses a badge is
158/// pressing something this function said was not interactive; the sense is what
159/// makes egui agree.
160///
161/// `latched` is a chip that is switched on, and it fills rather than outlines. A
162/// terminal has to collide latched with focus because it has one spare axis for
163/// two facts; egui does not, so it does not.
164///
165/// A chip's removable half is not drawn, on `makeover-tui`'s reasoning: a second
166/// control inside a token is a question for whoever owns the interaction rather
167/// than for a drawing.
168pub fn token(
169    ui: &mut Ui,
170    label: &str,
171    kind: Token,
172    tone: Tone,
173    latched: bool,
174    palette: &Palette,
175    style: &WidgetStyle,
176) -> Response {
177    let painted = palette.tone(tone);
178    let radius = style.radius;
179    let sense = if kind.interactive() {
180        Sense::click()
181    } else {
182        Sense::hover()
183    };
184
185    // Laid out before the rect is allocated, because a token is exactly as wide
186    // as what it says plus its padding: there is no box to fit text into here,
187    // the way a table cell has one.
188    let ink = match kind {
189        Token::Badge => palette.content,
190        Token::Chip { .. } if latched => palette.page,
191        Token::Chip { .. } => painted,
192    };
193    let galley = ui.painter().layout_no_wrap(
194        label.to_owned(),
195        egui::TextStyle::Body.resolve(ui.style()),
196        ink,
197    );
198    let size = galley.size() + style.token_padding * 2.0;
199    let (rect, response) = ui.allocate_exact_size(size, sense);
200
201    if kind == Token::Badge {
202        ui.painter().rect(
203            rect,
204            radius,
205            palette.tone_surface(tone),
206            egui::Stroke::new(1.0, palette.tone_edge(tone)),
207            egui::StrokeKind::Inside,
208        );
209    } else if latched {
210        ui.painter().rect_filled(rect, radius, painted);
211    } else {
212        ui.painter().rect_stroke(
213            rect,
214            radius,
215            egui::Stroke::new(1.0, painted),
216            egui::StrokeKind::Inside,
217        );
218    }
219    ui.painter()
220        .galley(rect.center() - galley.size() / 2.0, galley, ink);
221
222    // Say what was drawn, because painting it says nothing.
223    //
224    // A token allocates its rect and paints the text straight onto it, so
225    // nothing reached the accessibility tree at all until 2026-08-22: an
226    // interactive chip was a control a mouse could press and a screen reader
227    // could not find, and a badge was text nobody could read out. The filter
228    // panel's twenty-four key pills were the site -- a whole way of filtering,
229    // absent.
230    //
231    // A chip that latches says so through `selected`, which is what a screen
232    // reader announces as pressed. That is `latched`'s whole meaning: the key
233    // is held down.
234    let role = if kind.interactive() {
235        egui::WidgetType::Button
236    } else {
237        egui::WidgetType::Label
238    };
239    response.widget_info(|| {
240        let mut info = egui::WidgetInfo::labeled(role, ui.is_enabled(), label);
241        if kind.interactive() {
242            info.selected = Some(latched);
243        }
244        info
245    });
246    response
247}
248
249/// A control.
250///
251/// The key the description named is drawn beside the label where there is one,
252/// which is [`Act::key`] finally being read by a second renderer: it was written
253/// for a terminal, and a desktop app has keys too.
254///
255/// **A disabled control is drawn and does not answer**, through
256/// [`State::suppresses_interaction`] rather than a second reading of what
257/// disabled means, and it takes [`Palette::content_muted`] because that is the
258/// intent `State::Disabled` resolves to. egui is told through `add_enabled`, so
259/// its own focus walk skips it: a control that is drawn and not reachable is
260/// exactly what `disabled` means on every host, and here the host already has
261/// the machinery.
262pub fn act(ui: &mut Ui, act: &Act<'_>, palette: &Palette, _style: &WidgetStyle) -> Response {
263    let disabled = act.state.is_some_and(State::suppresses_interaction);
264    let label = match act.key {
265        Some(key) => format!("{}  ({key})", act.label),
266        None => act.label.to_owned(),
267    };
268    let colour = if disabled {
269        palette.content_muted
270    } else {
271        palette.tone(act.tone)
272    };
273    let mut button = egui::Button::new(RichText::new(label).color(colour));
274    // The control that commits wears a frame, which is this host's spelling of
275    // the webview's default-button ring (`Act::commits`). Muted when disabled,
276    // as the label is, so it keeps its shape without asking for a press.
277    if act.commits {
278        let frame = if disabled {
279            palette.content_muted
280        } else {
281            palette.content
282        };
283        button = button.stroke(egui::Stroke::new(2.0, frame));
284    }
285    let drawn = ui.add_enabled(!disabled, button);
286    // Standing help, as a hover, which is honest on this host in a way it is
287    // not on a terminal: egui has a pointer. `makeover_tui` says the same
288    // sentence as a muted row under the control.
289    //
290    // Drawn here rather than by the caller as of `Act::hint` (0.40.0). quasi's
291    // egui renderer was doing exactly this outside the widget because
292    // `layout::Act` carried no hint, so a host that was not quasi got nothing.
293    match act.hint {
294        Some(hint) => drawn.on_hover_text(hint),
295        None => drawn,
296    }
297}
298
299/// A figure: the value, then what it counts under it.
300///
301/// The tone lands on the value and its change rather than on the caption, which
302/// is what [`Figure::tone`] means: the figure is an ordinary fact and it is the
303/// movement that reads as good or bad. `makeover-tui` says the same thing with a
304/// bold span; here it is a larger one, because egui can size text and a terminal
305/// cannot.
306/// Labelled facts, with their values in one column.
307///
308/// **The alignment is the member**, and `egui::Grid` is how this renderer gets
309/// it: a grid measures its widest cell per column and lays every row to that,
310/// which is the same answer `max-content` gives a webview and padding gives a
311/// terminal. Five goingson panes were drawing a row per fact, and every value
312/// started after its own label.
313///
314/// The grid is not striped. `Grid::striped` is the obvious reach and it is
315/// wrong here: a stripe says "these rows are a series you scan down", which is
316/// a table's claim. A pane of facts is one object read as a whole.
317///
318/// The label reads back and the value takes content, which is `figure`'s rule
319/// for a value against its caption. A fact with nothing to say never arrives:
320/// `Node::facts` drops it as it builds.
321pub fn facts(ui: &mut Ui, facts: &[Fact<'_>], palette: &Palette, id: impl Into<egui::Id>) {
322    egui::Grid::new(id.into())
323        .num_columns(2)
324        .striped(false)
325        .show(ui, |ui| {
326            for fact in facts {
327                ui.label(RichText::new(fact.label).color(palette.content_muted));
328                ui.label(RichText::new(fact.value).color(palette.content));
329                ui.end_row();
330            }
331        });
332}
333
334pub fn figure(
335    ui: &mut Ui,
336    figure: &Figure<'_>,
337    palette: &Palette,
338    style: &WidgetStyle,
339) -> Response {
340    ui.with_layout(Layout::top_down(Align::Min), |ui| {
341        let value = match figure.change {
342            Some(change) => format!("{} {change}", figure.value),
343            None => figure.value.to_owned(),
344        };
345        let size = egui::TextStyle::Body.resolve(ui.style()).size * style.figure_scale;
346        let shown = ui.label(
347            RichText::new(value)
348                .color(palette.tone(figure.tone))
349                .size(size)
350                .strong(),
351        );
352        ui.add_space(style.figure_gap);
353        ui.label(RichText::new(figure.caption).color(palette.content_muted));
354        shown
355    })
356    .inner
357}
358
359/// What a host can see about a wait that is running.
360///
361/// Both halves are optional because both are the host's to observe and neither
362/// is derivable from the description. `makeover_layout::Awaiting` says how big
363/// the payload is; nothing in a description can say how much of it has landed,
364/// because that is a fact about a transfer in flight.
365#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
366pub struct Progress {
367    /// How much has arrived, in whatever unit the description counted.
368    ///
369    /// `None` means nothing is watching the transfer, which is the common case
370    /// and is what keeps the bar from being drawn out of a total alone.
371    pub delivered: Option<u64>,
372    /// How long the wait has lasted so far.
373    ///
374    /// The one time value a wait is allowed to show. Never a remaining time and
375    /// never a rate: see [`awaiting`].
376    pub elapsed: Option<Duration>,
377}
378
379/// The activity mark: one small square, blinking.
380///
381/// Rule 2 of wiki `loading-and-progress-standard`, and the thing that replaced
382/// `Ui::spinner` here. A spinner turns at a rate it invented and reads as
383/// progress; this claims nothing beyond "something is happening", which is the
384/// whole of what an unmeasured wait knows.
385///
386/// **`reduced` stills the mark rather than removing it.** egui has no
387/// `prefers-reduced-motion`, so the preference arrives as a bool from whatever
388/// the host asked its own platform, exactly as `makeover_timing::activity_blink`
389/// is shaped for. A still mark still says something is happening; hiding it
390/// would answer a request nobody made.
391///
392/// The cadence is `makeover_timing::Cadence::Activity` and is not a number this
393/// crate chooses, so a browser, a terminal and an egui window blink together.
394///
395/// Repaint is asked for at the next flip rather than every frame: a blinking
396/// mark should not turn a window that is otherwise idle into one that renders
397/// continuously.
398pub fn activity(ui: &mut Ui, reduced: bool, palette: &Palette, style: &WidgetStyle) -> Response {
399    let (rect, response) = ui.allocate_exact_size(Vec2::splat(style.mark_size), Sense::hover());
400    let lit = match activity_blink(reduced) {
401        // Still, and lit. The state the mark holds when nothing may move.
402        None => true,
403        Some(half) => {
404            let half = half.as_secs_f64();
405            // A cadence of zero would divide by nothing and blink infinitely
406            // fast, which is the one value the token cannot mean.
407            if half <= 0.0 {
408                true
409            } else {
410                let phase = ui.input(|input| input.time).rem_euclid(half * 2.0);
411                let lit = phase < half;
412                let next = if lit { half } else { half * 2.0 } - phase;
413                ui.ctx()
414                    .request_repaint_after(Duration::from_secs_f64(next.max(0.0)));
415                lit
416            }
417        }
418    };
419    // Lit is the accent, dark is the trough it sits in. Not "drawn and not
420    // drawn": a mark that vanishes half the time is a hole in the layout, and
421    // the reader loses where to look between blinks.
422    let colour = if lit { palette.action } else { palette.sunken };
423    ui.painter().rect_filled(rect, style.radius, colour);
424    response
425}
426
427/// A wait, drawn from what is actually known about it.
428///
429/// The branch is `Awaiting::is_determinate` and one more question the
430/// description cannot answer: whether anything is watching the transfer. A bar
431/// needs both a total and a numerator, so a described amount with no
432/// [`Progress::delivered`] beside it draws the mark, not an empty trough that
433/// implies someone is counting.
434///
435/// **What the bar may not do**, from rule 1 of wiki
436/// `loading-and-progress-standard` and from `Awaiting`'s own docs: what is done
437/// over what there is, plus the time it has taken. Never a remaining time, an
438/// arrival time, or a rate extrapolated forward. A prediction is wrong the
439/// moment the transfer stalls, and being confidently wrong is worse than being
440/// honestly indeterminate.
441///
442/// The reading is the two raw numbers, as [`meter`] does it. The unit is the
443/// app's — bytes for an upload, rows for an import — and a renderer that
444/// guessed at one would be formatting a quantity it was deliberately not told
445/// about.
446pub fn awaiting(
447    ui: &mut Ui,
448    awaiting: Awaiting,
449    progress: Progress,
450    reduced: bool,
451    palette: &Palette,
452    style: &WidgetStyle,
453) -> Response {
454    let (Some(total), Some(done)) = (awaiting.amount, progress.delivered) else {
455        return activity(ui, reduced, palette, style);
456    };
457    let width = style
458        .meter_width
459        .unwrap_or_else(|| ui.available_width().max(1.0));
460    ui.horizontal(|ui| {
461        let (rect, response) =
462            ui.allocate_exact_size(Vec2::new(width, style.meter_height), Sense::hover());
463        ui.painter().rect_filled(rect, style.radius, palette.sunken);
464        // A total of zero is no payload rather than a finished one, which is
465        // `meter`'s reading of the same case. Over-delivery clamps for the same
466        // reason it does there: a rect cannot be longer than itself.
467        let share = if total == 0 {
468            0.0
469        } else {
470            #[expect(
471                clippy::cast_precision_loss,
472                reason = "a byte count past 2^53 is not a wait anyone is watching a bar for"
473            )]
474            let share = (done as f64 / total as f64).min(1.0);
475            share
476        };
477        #[expect(
478            clippy::cast_possible_truncation,
479            reason = "a share is 0..=1 and the product is a width in points"
480        )]
481        let filled = (f64::from(rect.width()) * share) as f32;
482        if filled > 0.0 {
483            let mut fill = rect;
484            fill.set_width(filled);
485            ui.painter().rect_filled(fill, style.radius, palette.action);
486        }
487        let reading = match progress.elapsed {
488            Some(elapsed) => format!("{done}/{total}  {}s", elapsed.as_secs()),
489            None => format!("{done}/{total}"),
490        };
491        ui.label(RichText::new(reading).color(palette.content_muted));
492        response
493    })
494    .inner
495}
496
497/// A chart, as bars standing on a shared axis.
498///
499/// The webview's drawing rather than the terminal's: this renderer paints into
500/// a rectangle it asks for, so columns cost it nothing and are what a reader
501/// expects of a chart. `makeover-tui` lays its bars down instead, because a
502/// terminal has rows to spend and cells to draw with; both are honest answers
503/// to the same description and neither is the other's fallback.
504///
505/// # The axis is the caller's height and the description's maximum
506///
507/// [`WidgetStyle::chart_height`] says how tall the figure stands and
508/// [`Chart::most`] says what a full bar means, which is the same split
509/// `--chart-height` and `--most` make in the stylesheet. An axis of zero draws
510/// its bars at nothing rather than dividing by it.
511///
512/// [`Bar::note`] is not painted. There is nowhere to put it without a hover
513/// surface this crate does not own, and the reading is the fact worth the room.
514pub fn chart(
515    ui: &mut Ui,
516    chart: &Chart<'_>,
517    bars: &[Bar<'_>],
518    palette: &Palette,
519    style: &WidgetStyle,
520) -> Response {
521    let width = ui.available_width().max(1.0);
522    let (rect, response) =
523        ui.allocate_exact_size(Vec2::new(width, style.chart_height), Sense::hover());
524
525    // The places on the axis take a band at the bottom, and the bars stand on
526    // top of it. Reserved out of the figure's own height rather than added to
527    // it, so `chart_height` is what a caller laying out a screen can measure
528    // against -- the same promise `--chart-height` makes in the stylesheet.
529    let font = egui::TextStyle::Small.resolve(ui.style());
530    let band = ui.text_style_height(&egui::TextStyle::Small);
531    let floor = (rect.bottom() - band).max(rect.top());
532    let standing = floor - rect.top();
533
534    if bars.is_empty() {
535        return response;
536    }
537
538    #[expect(
539        clippy::cast_precision_loss,
540        reason = "a bar count is small and this is a width in points"
541    )]
542    let each = rect.width() / bars.len() as f32;
543    for (index, bar) in bars.iter().enumerate() {
544        #[expect(
545            clippy::cast_precision_loss,
546            reason = "an index into the bars, which are few"
547        )]
548        let left = rect.left() + each * index as f32;
549        let reached = standing * bar.fraction(chart);
550        let mut column = egui::Rect::from_min_size(
551            egui::Pos2::new(left, floor - reached),
552            Vec2::new(each, reached),
553        );
554        // A bar of nothing still says it is there, which is what the
555        // stylesheet's `min-height` does in the other renderer.
556        if column.height() < 1.0 {
557            column.set_top(floor - 1.0);
558        }
559        ui.painter()
560            .rect_filled(column, style.radius, palette.tone(chart.tone));
561
562        // Centred under the column it belongs to. Drawn by the painter rather
563        // than laid out as a row of labels, because a row lays itself out and
564        // the labels would then sit where the text put them instead of under
565        // their own bars, which is the one thing a place on an axis has to do.
566        ui.painter().text(
567            egui::Pos2::new(left + each / 2.0, floor),
568            egui::Align2::CENTER_TOP,
569            bar.at,
570            font.clone(),
571            palette.content_muted,
572        );
573    }
574
575    response
576}
577
578#[cfg(test)]
579mod tests {
580    use super::*;
581
582    /// What the accessibility tree says a widget drew.
583    fn announced(
584        draw: impl FnMut(&mut Ui),
585    ) -> Vec<(
586        egui::accesskit::Role,
587        String,
588        Option<egui::accesskit::Toggled>,
589    )> {
590        let ctx = egui::Context::default();
591        ctx.enable_accesskit();
592        let mut draw = draw;
593        let input = || egui::RawInput {
594            screen_rect: Some(egui::Rect::from_min_size(
595                egui::Pos2::ZERO,
596                egui::vec2(600.0, 400.0),
597            )),
598            ..Default::default()
599        };
600        let _ = ctx.run_ui(input(), &mut draw);
601        let out = ctx.run_ui(input(), &mut draw);
602        out.platform_output
603            .accesskit_update
604            .expect("accesskit is on")
605            .nodes
606            .iter()
607            .map(|(_, node)| {
608                (
609                    node.role(),
610                    node.label()
611                        .or_else(|| node.value())
612                        .unwrap_or_default()
613                        .to_owned(),
614                    node.toggled(),
615                )
616            })
617            .collect()
618    }
619
620    #[test]
621    fn a_chip_is_announced_as_a_control_and_says_whether_it_is_held() {
622        // A token paints its own text onto its own rect, so before 2026-08-22
623        // it reached the tree as nothing: pressable by a mouse and invisible to
624        // everything else.
625        let p = palette();
626        let style = WidgetStyle::default();
627        let drawn = announced(|ui| {
628            token(
629                ui,
630                "C#",
631                Token::Chip { removable: false },
632                Tone::Neutral,
633                true,
634                &p,
635                &style,
636            );
637        });
638
639        let chip = drawn
640            .iter()
641            .find(|(role, name, _)| *role == egui::accesskit::Role::Button && name == "C#")
642            .unwrap_or_else(|| panic!("the chip is not in the tree: {drawn:?}"));
643        assert_eq!(
644            chip.2,
645            Some(egui::accesskit::Toggled::True),
646            "a latched chip is held down and says so: {drawn:?}"
647        );
648    }
649
650    #[test]
651    fn a_badge_is_announced_as_the_text_it_is() {
652        // Not a control, and not nothing either: a badge is a word on the
653        // screen and painting it is not the same as saying it.
654        let p = palette();
655        let style = WidgetStyle::default();
656        let drawn = announced(|ui| {
657            token(ui, "wav", Token::Badge, Tone::Neutral, false, &p, &style);
658        });
659
660        assert!(
661            drawn
662                .iter()
663                .any(|(role, name, _)| *role == egui::accesskit::Role::Label && name == "wav"),
664            "{drawn:?}"
665        );
666        assert!(
667            !drawn
668                .iter()
669                .any(|(role, _, _)| *role == egui::accesskit::Role::Button),
670            "a badge answers nothing and must not claim to: {drawn:?}"
671        );
672    }
673
674    fn palette() -> Palette {
675        use egui::Color32;
676        Palette {
677            page: Color32::from_rgb(1, 1, 1),
678            raised: Color32::from_rgb(2, 2, 2),
679            overlay: Color32::from_rgb(3, 3, 3),
680            well: Color32::from_rgb(4, 4, 4),
681            sunken: Color32::from_rgb(5, 5, 5),
682            bevel_light: Color32::from_rgb(6, 6, 6),
683            bevel_dark: Color32::from_rgb(7, 7, 7),
684            elevation: Color32::from_black_alpha(40),
685            content: Color32::from_rgb(20, 20, 20),
686            content_secondary: Color32::from_rgb(120, 120, 120),
687            content_muted: Color32::from_rgb(21, 21, 21),
688            action: Color32::from_rgb(22, 22, 22),
689            danger: Color32::from_rgb(23, 23, 23),
690            success: Color32::from_rgb(24, 24, 24),
691            warning: Color32::from_rgb(25, 25, 25),
692            info: Color32::from_rgb(26, 26, 26),
693            border: Color32::from_rgb(200, 200, 200),
694            info_surface: Color32::from_rgb(201, 201, 201),
695            success_surface: Color32::from_rgb(202, 202, 202),
696            warning_surface: Color32::from_rgb(203, 203, 203),
697            danger_surface: Color32::from_rgb(204, 204, 204),
698            row_stripe: Color32::from_rgb(205, 205, 205),
699            row_hover: Color32::from_rgb(206, 206, 206),
700            row_rule: Color32::from_rgb(207, 207, 207),
701            row_selected: Color32::from_rgb(208, 208, 208),
702        }
703    }
704
705    #[test]
706    fn every_tone_resolves_and_no_two_share_a_colour() {
707        // The reason the three status intents arrived together: a resolver
708        // missing one has to invent a colour for it.
709        let p = palette();
710        let all = [
711            p.tone(Tone::Neutral),
712            p.tone(Tone::Info),
713            p.tone(Tone::Success),
714            p.tone(Tone::Warning),
715            p.tone(Tone::Danger),
716        ];
717        for (i, a) in all.iter().enumerate() {
718            for b in &all[i + 1..] {
719                assert_ne!(a, b, "two tones resolved to one colour");
720            }
721        }
722        assert_eq!(p.tone(Tone::Neutral), p.content, "neutral is ordinary text");
723    }
724
725    #[test]
726    fn a_meter_draws_and_an_overrun_does_not_panic() {
727        // `done` may exceed `total`, which is the case Meter's own docs call
728        // the one worth drawing. The fill clamps; the reading does not.
729        let p = palette();
730        let style = WidgetStyle::default();
731        egui::__run_test_ui(|ui| {
732            meter(ui, &Meter::new(3, 6), &p, &style);
733            meter(ui, &Meter::new(9, 6), &p, &style);
734            // No set, rather than a complete one.
735            meter(ui, &Meter::new(0, 0), &p, &style);
736            // The overflow `makeover-layout` pins on its own side.
737            meter(ui, &Meter::new(u32::MAX, u32::MAX), &p, &style);
738        });
739    }
740
741    #[test]
742    fn a_wait_draws_a_bar_only_when_something_is_counting_it() {
743        // The described total is half of what a bar needs. Without a numerator
744        // the honest drawing is the mark, not an empty trough implying that
745        // someone is watching bytes land.
746        let p = palette();
747        let style = WidgetStyle::default();
748        egui::__run_test_ui(|ui| {
749            awaiting(
750                ui,
751                Awaiting::unmeasured(),
752                Progress::default(),
753                false,
754                &p,
755                &style,
756            );
757            awaiting(
758                ui,
759                Awaiting::of(41_943_040),
760                Progress::default(),
761                false,
762                &p,
763                &style,
764            );
765            awaiting(
766                ui,
767                Awaiting::of(41_943_040),
768                Progress {
769                    delivered: Some(10_485_760),
770                    elapsed: Some(Duration::from_secs(3)),
771                },
772                false,
773                &p,
774                &style,
775            );
776            // A zero payload is no payload, and over-delivery clamps.
777            awaiting(
778                ui,
779                Awaiting::of(0),
780                Progress {
781                    delivered: Some(9),
782                    elapsed: None,
783                },
784                false,
785                &p,
786                &style,
787            );
788            awaiting(
789                ui,
790                Awaiting::of(4),
791                Progress {
792                    delivered: Some(9),
793                    elapsed: None,
794                },
795                false,
796                &p,
797                &style,
798            );
799        });
800    }
801
802    #[test]
803    fn reduced_motion_stills_the_mark_and_does_not_remove_it() {
804        // `activity_blink(true)` is None, which means lit and still. A renderer
805        // that drew nothing would have answered a request nobody made.
806        let p = palette();
807        let style = WidgetStyle::default();
808        egui::__run_test_ui(|ui| {
809            let still = activity(ui, true, &p, &style);
810            let blinking = activity(ui, false, &p, &style);
811            assert_eq!(
812                still.rect.size(),
813                blinking.rect.size(),
814                "the mark occupies the same space either way"
815            );
816        });
817    }
818
819    #[test]
820    fn a_chip_answers_a_click_and_a_badge_does_not() {
821        // `Token::interactive` is the whole difference between the members, and
822        // the sense is what makes egui agree with it.
823        let p = palette();
824        let style = WidgetStyle::default();
825        egui::__run_test_ui(|ui| {
826            let badge = token(ui, "beta", Token::Badge, Tone::Info, false, &p, &style);
827            assert!(!badge.sense.senses_click(), "a badge answers no click");
828
829            let chip = token(
830                ui,
831                "drums",
832                Token::Chip { removable: false },
833                Tone::Neutral,
834                false,
835                &p,
836                &style,
837            );
838            assert!(chip.sense.senses_click(), "a chip answers a click");
839        });
840    }
841
842    #[test]
843    fn a_disabled_control_is_drawn_and_does_not_answer() {
844        // Present, visible, and not answering. Through
845        // `State::suppresses_interaction` rather than a second reading here.
846        let p = palette();
847        let style = WidgetStyle::default();
848        egui::__run_test_ui(|ui| {
849            let live = act(ui, &Act::new("Save"), &p, &style);
850            assert!(live.enabled());
851
852            let gone = act(ui, &Act::new("Save").state(State::Disabled), &p, &style);
853            assert!(!gone.enabled(), "a disabled control still answers");
854        });
855    }
856
857    #[test]
858    fn a_control_shows_the_key_the_description_named() {
859        // `Act::key` was written for a terminal before there was one. A desktop
860        // app has keys too, so this is its second reader.
861        let p = palette();
862        let style = WidgetStyle::default();
863        egui::__run_test_ui(|ui| {
864            act(ui, &Act::new("New").key("n"), &p, &style);
865            act(ui, &Act::new("New"), &p, &style);
866        });
867    }
868
869    #[test]
870    fn a_figure_draws_its_movement_beside_its_value() {
871        let p = palette();
872        let style = WidgetStyle::default();
873        egui::__run_test_ui(|ui| {
874            figure(ui, &Figure::new("17", "Current streak"), &p, &style);
875            figure(
876                ui,
877                &Figure::new("17", "Current streak")
878                    .change("+3")
879                    .tone(Tone::Success),
880                &p,
881                &style,
882            );
883        });
884    }
885}