makeover_layout/lib.rs
1//! The renderer-agnostic half of the make-family design system.
2//!
3//! <!-- wiki: makeover-layout -->
4//!
5//! `makeover` answers *what colour*, and varies by theme. `makeover-geometry`
6//! answers *how much space*, and varies by density and surface. This crate
7//! answers *what the thing is*, and varies by nothing.
8//!
9//! # The deferral rule
10//!
11//! A description names intents and relationships, never values. Say
12//! [`Fill::Raised`], never `#D9DDF4`. Say `Gap::Peer`, never `6px`. What is
13//! left once colour and spacing are deferred is **composition**: which edges
14//! are lit, what inverts on press, what nests in what.
15//!
16//! The constraint that shapes all of it: a renderer that can only paint
17//! rectangles has to be able to express the result. egui has no
18//! `box-shadow: inset` and one stroke per widget with no per-side control; a
19//! terminal has box-drawing characters and one cell of resolution, and cannot
20//! draw a two-tone lit edge at all. A description that assumes per-side edges
21//! is a CSS description wearing a neutral name. So this crate names the
22//! *intent* — this region is a well — and each renderer chooses an expression
23//! it can actually produce, including dropping half of one.
24//!
25//! # Scope
26//!
27//! Depth came first: the bevel and the surfaces it shapes. That much was
28//! settled the hard way — the vocabulary here was read off audiofiles'
29//! `ui::theme` and `ui::widgets`, which are the only implementation written
30//! by a consumer with no CSS, then checked against both webview apps. All
31//! three agreed once Balanced Breakfast's fills were corrected.
32//!
33//! 0.2.0 adds the rest of the description, each member drawn the same way,
34//! from what the three apps already hand-write rather than from a taxonomy:
35//!
36//! - Components. [`Token`] (badge against chip), [`Notice`] (toast against
37//! banner), [`RowPart`], [`Heading`], [`Selector`], [`Readiness`], and
38//! [`Tone`], which is the one intent family they share.
39//! - Schemas. [`Field`] for forms and [`Column`] for lists and tables.
40//! - Structure. [`Region`] for the parts of a screen, [`Arrangement`] for how
41//! a screen is put together.
42//!
43//! **Validation** was absent on purpose here, on the grounds that neither app
44//! had a shared story. That reasoning is retired — see 0.11.0 below, which is
45//! where the constraints arrived and why the argument did not survive contact
46//! with what the apps were measured to do.
47//!
48//! 0.3.0 closes a gap the first real adoption found, which is what adopting
49//! against goingson first was for. [`Selector`] described only the *chosen*
50//! option, so an unchosen one fell through to [`Depth::Flat`] and no renderer
51//! drew it; goingson's tab strip recesses its unchosen tabs by hand and could
52//! not delete the line, because being recessed is *why* the chosen tab reads as
53//! coming forward. So [`Selector::unchosen`] joins `chosen`, and saying it
54//! needed [`Fill::Sunken`] and [`Depth::Sunken`]: a surface set back by colour
55//! with no edge, which is neither a well nor level-with.
56//!
57//! 0.7.0 adds [`State`], the interaction axis, closing the gap that adopting
58//! against three apps rather than one made visible. The description named
59//! rest and, through [`Depth::pressed`], pressed. It named neither focus nor
60//! disabled, so `makeover-webview` emitted a hover rule and stopped, and each
61//! consumer completed the primitive from outside by out-specifying a rule it
62//! did not own: 19 such rules in goingson, 21 in the MNW server, a further set
63//! in Balanced Breakfast, and three focus rings that do not match. The axis is
64//! deliberately two members wide, because hover and pressed belong where they
65//! already are. [`State`]'s own docs carry that argument.
66//!
67//! 0.8.0 finishes [`Field`], which described a field well enough to label it and
68//! not well enough to draw it. Writing `makeover-webview`'s form emitter found
69//! three things missing and the renderer supplied all three from outside: the
70//! current value, a select's options, and the placeholder. Two of those move
71//! here and one does not.
72//!
73//! - [`Field::placeholder`] is user-facing text sitting beside `label` and
74//! `hint`. There was never a reading on which it was renderer state; it was
75//! outside only because adding a field to a published struct is breaking.
76//! - [`Field::options`] moves because every renderer needs them and each was
77//! going to invent its own shape. [`Choice`] is the shape `makeover-webview`
78//! already arrived at, taken as-is rather than redesigned.
79//! - The current value stays renderer-side and is not coming here. It is the
80//! one of the three that is genuinely state: a webview reads it out of the
81//! DOM, an immediate-mode renderer holds a `&mut` to the app's own field, and
82//! a description that carried it would be a form model.
83//!
84//! 0.9.0 opens [`RowPart`], which was the last closed enum in the vocabulary,
85//! and adds [`RowPart::Tokens`]. Both halves come from the same finding, made
86//! by the first two real screens described through the router rather than by
87//! reading a stylesheet.
88//!
89//! A goingson project card carries two trailing badges, a type and a toned
90//! status; a contact card carries a primary email *and* a strip of tags. `Meta`
91//! is one slot and one string, so both ports joined their facts with a
92//! separator and lost what the second one was: a status reads as text where it
93//! used to read as colour. [`Token`] already says exactly the right thing — a
94//! small labelled thing with a kind, a tone and an optional action — and could
95//! only ever be a node in its own right, never inside a row.
96//!
97//! So the missing thing was permission rather than a concept. `Tokens` is that
98//! permission, and `#[non_exhaustive]` arrives with it so the next member is not
99//! a lockstep event across three renderers. The pairing is the point: this
100//! enum's own consumer in `makeover-webview` carried a comment predicting it
101//! would stop compiling one day, which is a lockstep break written down and
102//! waited for rather than prevented.
103//!
104//! Balanced Breakfast was checked before the member was added, because one
105//! consumer wanting something is not evidence. It packs a count and two icon
106//! buttons into the same single `Meta` slot while leaving `Actions` empty, so
107//! the slot was already straining under a second consumer for a different
108//! reason.
109//!
110//! 0.10.0 adds [`Meter`], a proportion carried as a pair rather than as a
111//! percentage. Its own docs carry the argument; the short form is that the
112//! percentage shape had already been tried in goingson and had already needed a
113//! companion flag to recover what rounding and clamping threw away.
114//!
115//! 0.11.0 is four members from the quasi proving ground, batched into one
116//! release because pre-1.0 a minor is breaking and a cascade is nine repos.
117//! Three findings that arrived with them turned out not to belong here at all:
118//! this crate has no notion of an action, a route or a destination, so anything
119//! asking what a control *calls* was never the vocabulary's to say.
120//!
121//! - [`Figure`], a value with a caption. goingson had five of them across five
122//! screens with five class vocabularies for the one shape, which is the
123//! divergence this crate exists to end, sitting in plain sight and counted for
124//! the first time.
125//! - [`RowPart::Proportion`], so a [`Meter`] can sit in a row. `Meter` reached
126//! two of its seven sites at 0.10.0 and the other five are row-shaped. Exactly
127//! [`RowPart::Tokens`]'s problem with a different payload, and it takes
128//! `Tokens`' answer: the part carries the description of a bar, not a node.
129//! - [`Field::max_length`], [`Field::min`] and [`Field::max`], joining
130//! [`Field::required`], which had been sitting here as the sole constraint
131//! while the header above claimed there were none. The set stops before
132//! `pattern`, which fails the renderer test and is one site in one app.
133//! - [`FieldKind::File`]. Every host has an honest answer — a native picker, an
134//! `<input type="file">`, a path prompt, an argument — and it carries no
135//! accepted-types list because `accept` appears at zero sites in either app.
136//!
137//! The evidence rule changed under these, and it is worth recording because four
138//! earlier decisions were made under the old one. The two-app test said a shape
139//! earns a word once a second app wants it. It is backwards: a rule that
140//! withholds a word until a second app has duplicated the code guarantees the
141//! duplication, and app three writes it a third time. The bar is now generic
142//! against bespoke — is this furniture any app would have, or is it this app's
143//! own? Bespoke keeps [`Region::Bespoke`], which already carries a completion
144//! heatmap and is the right answer for a calendar nobody will build twice.
145//!
146//! 0.12.0 is two more from the same proving ground, and the same sorting
147//! happened first: six findings came out of a measurement of goingson's whole
148//! frontend, and four of them turned out to be asking what a control *calls*,
149//! which this crate cannot say. The two that were really here:
150//!
151//! - [`Readiness`] grows from two states to four. It named `Ready` and
152//! `Pending` and stopped, so a screen whose list came back empty had nothing
153//! to say about it; goingson draws an empty state at 27 sites and Balanced
154//! Breakfast at 9. `Empty` and `Failed` are the same axis rather than a new
155//! member beside it, because a region shows one of the four and never two.
156//! `#[non_exhaustive]` arrives with them, the pairing [`RowPart`] made at
157//! 0.9.0 and for the same reason.
158//! - [`Column::sortable`], [`Column::sorted`] and [`Sort`]. The one finding in
159//! the set that completes a member rather than adding one: `Column` shipped
160//! with a width and a priority and could not say that a table is ordered by a
161//! column, so a described table could draw no caret and offer no reordering.
162//!
163//! 0.14.0 is two additive members on two `#[non_exhaustive]` enums, released
164//! together because publishing twice for that is waste and the cascade below
165//! this crate is nine repos.
166//!
167//! - [`Depth::Overlay`]. The enum could say raised, well, sunken and flat, and
168//! could not say that a surface sits *over* the page. Every renderer already
169//! had the surface — `makeover-tui`'s `Palette::overlay`,
170//! `makeover-immediate`'s `Palette::elevation`, `makeover-webview`'s
171//! `--elevation-overlay` — and none of them could be reached from a
172//! description. buckets_of_money has 16 modals waiting on it.
173//! - [`CellPart`], which is [`RowPart`] for tables. A row's parts have carried
174//! their own content intent since 0.2.0, so `.row-actions` inherits rather
175//! than taking a text colour; a table cell had no such vocabulary and
176//! `makeover-webview` emitted one undifferentiated `.cell`, so a button in a
177//! cell was painted as text. The four members are the four things quasi's
178//! `Cell` was measured to hold, and the count is in that crate's history
179//! rather than assumed here.
180//!
181//! 0.15.0 adds [`FieldKind::Date`] and [`FieldKind::DateTime`], on the argument
182//! [`FieldKind::Email`] was admitted on: a webview emits a different `type=`,
183//! which is a native picker, the platform's validation and a different keyboard
184//! on a touch device. Described as text with a "YYYY-MM-DD" hint, all three are
185//! lost.
186//!
187//! Two members and not one or five, from a count rather than from symmetry: 13
188//! sites of `date` and 13 of `datetime-local` across the MNW server and
189//! goingson, and zero of `time`, `month` or `week`. The wire format each takes
190//! is named here as [`DATE_FORMAT`] and [`DATETIME_FORMAT`], because a host
191//! left to pick its own would disagree with a server silently, and
192//! [`FieldKind::temporal`] is the pair asked about once rather than at each
193//! renderer. `FieldKind`'s own comment claiming `radio` was the last HTML input
194//! type missing was already false when 0.8.1 wrote it; these are what it was
195//! missing.
196//!
197//! What each of the 0.12.0 findings deliberately leaves out is the address — what pressing a
198//! header calls, and where an empty state's "Add your first project" button
199//! goes. That is the boundary this crate is defined by, and four findings moved
200//! across it rather than being answered here.
201//!
202//! 0.19.0 narrows [`State`] to [`State::Disabled`] alone. `State::Focus` is
203//! gone: a description never states what has focus, because what focus *is*
204//! differs per host and every renderer had already decided for itself — the
205//! webview draws it from `:focus-visible`, egui refused the variant outright,
206//! and quasi-tui honoured it once at startup and overrode it thereafter.
207//!
208//! 0.20.0 adds [`Region::Widget`], the third tier, and `#[non_exhaustive]` to
209//! [`Region`] with it. Every vocabulary finding until now had two answers
210//! available — grow the primitive set, or [`Region::Bespoke`] — and a whole
211//! class of thing is wrong for both. A carousel is not a primitive, because a
212//! terminal has none and that is the test `Node::Html` failed. It is not
213//! bespoke either, because bespoke is what one app owns and every part of a
214//! carousel is furniture plus members this crate already has.
215//!
216//! The cost of the binary was that refusing a primitive was expensive: the app
217//! hand-rolls the thing forever, so the pressure always ran toward growing the
218//! primitive set with one host's idioms. A named assembly changes what "no"
219//! costs without changing what the vocabulary can say.
220//!
221//! MNW's carousel is the first consumer and was the finding that started it: one
222//! partial, three pages, an ordered set of frames with a position, prev/next and
223//! a dot strip, all of it sayable already and none of it nameable. See wiki
224//! `widget-tier` for the ownership model, which is why this member carries a
225//! name a renderer may decline to know.
226//!
227//! 0.21.0 adds [`Image`] and [`Fit`], found by trying to describe MNW's
228//! carousel under 0.20.0's widget tier and getting one step in. Nothing named a
229//! picture. The vocabulary could say a number with a caption, a badge, a meter
230//! and a table, and could not say the thing three of MNW's public pages are
231//! mostly made of.
232//!
233//! It reads as an oversight and is a measurement: 24 `<img>` sites across 22
234//! MNW templates, against one in goingson and none in Balanced Breakfast or
235//! audiofiles. A picture is furniture a *content platform* has, and MNW is the
236//! only one in the tree, so the evidence never arrived from the two-app
237//! direction the earlier rule looked in. Under the generic-against-bespoke bar
238//! it is not close: a picture is not one app's own.
239//!
240//! A primitive rather than a widget, which is worth stating now that the tier
241//! makes it a real question. A widget is an assembly of things already sayable
242//! and a picture is a leaf, assembled from nothing. It also passes the test
243//! `Node::Html` failed — every host has an honest answer, including a terminal,
244//! which has a graphics protocol or has [`Image::alt`].
245//!
246//! [`Image`] carries no source, the split [`Act`] already makes: an address is
247//! not this crate's to hold. See its own docs, which is where the argument is.
248//!
249//! 0.22.0 finishes [`Image`], which 0.21.0 shipped unable to say how much room
250//! a picture needs. Without that a renderer cannot reserve space, so a picture
251//! occupies nothing until its bytes arrive and then takes its full height at
252//! once. Measured on MNW's landing page: a 478px jump per frame and a
253//! cumulative layout shift of 0.087 for the page.
254//!
255//! - [`Image::intrinsic`], the picture's own dimensions, carried as [`Extent`].
256//! A fact about the asset rather than a display size, which is what keeps it
257//! on this side of the deferral rule: 5120x3412 is what the file *is*, and no
258//! renderer can learn it without fetching the bytes.
259//! - [`Loading`], and the default flips to [`Loading::Eager`]. 0.21.0 emitted
260//! the webview's `loading="lazy"` for every picture, which read one
261//! consumer's habit as a rule. Deferring a picture that is on screen at first
262//! paint saves nothing and makes its shift land later. The carousel is the
263//! case that proves this cannot be one renderer-wide setting: its first frame
264//! is on screen and its others are not, in one widget, at one moment.
265//!
266//! 0.23.0 adds [`Showing`], which is three open findings collapsing into one
267//! member. A tab group could not say which tab was open, a carousel could not
268//! say which frame was up, and a disclosure could not say whether its child was
269//! showing. All three are the same missing sentence, and while it was missing a
270//! renderer had two moves: match on a widget name, or draw every child.
271//!
272//! So the widget tier was taking the blame for a gap one level below it. With
273//! this a renderer derives its chrome from the description — labels get a strip,
274//! no labels get previous/position/next — once, for every widget there will ever
275//! be, and [`Region::Widget`]'s name goes back to being app vocabulary a
276//! renderer may decline to know.
277//!
278//! Only the kind lives here. Which child is up, and what each child is called,
279//! sit with whatever holds the regions, the same split [`Selector`] already made
280//! against `Node::Select`.
281//!
282//! 0.27.0 adds [`Region::Group`], which closes a gap this crate had carried
283//! since 0.2.0 without noticing: [`Heading::Section`] is documented as naming a
284//! block within the screen, and there was no block. A section heading is a leaf
285//! beside the things it names, so the description could say a section had
286//! *started* and never that one had ended.
287//!
288//! Found by asking how a screen distinguishes groups of settings by colour, and
289//! the answer turned out to be two findings rather than one. This is the first
290//! and it is the precondition: there is nothing to tint until there is a
291//! container. The second — every renderer already resolves `category.one`
292//! through `category.six` and no description can reach any of them — is filed
293//! and not shipped here.
294//!
295//! What the colour question settled anyway, because it shapes this member: the
296//! group carries no colour and no ordinal. A renderer distinguishing sibling
297//! groups derives the assignment from their order, which is
298//! [`Region::Columns`]' reasoning about counts applied to colour — the children
299//! say, and a value here would be a second source for something the description
300//! already states by containing them.
301//!
302//! 0.28.0 is what audiofiles' forms port found it could not say, three findings
303//! filed against a working conversion rather than guessed at in advance. All
304//! three are about a *question* rather than about a control, which is the line
305//! this crate keeps having to redraw.
306//!
307//! - [`FieldKind::Range`] and [`Field::step`]. A bounded number the user drags
308//! across, where both ends being on screen is what the question means. The
309//! reading to resist is that this is [`FieldKind::Number`] with bounds, and it
310//! is [`FieldKind::Radio`]'s argument again: a validated number can be out of
311//! range and a slider cannot, so the bounds stop being a rule and become the
312//! control's extent. [`Field::bounded`] is the check a renderer asks, since a
313//! range missing an end has nothing to draw.
314//! - [`Choice::unavailable`]. An option that is real, worth showing, and cannot
315//! be picked yet. Without it an app either drops the option — and the user
316//! never learns it is there — or hand-rolls the control outside the
317//! description, which is what audiofiles' instrument panel did: a permanently
318//! disabled radio plus a hand-written line saying what would enable it.
319//! `#[non_exhaustive]` arrives on [`Choice`] in the same release, so this is
320//! the last breaking addition to it.
321//! - Not a member at all: [`Field::placeholder`] on a chooser. It was sayable
322//! already and no renderer read it, so a select with nothing chosen showed an
323//! empty box and the instruction lived on a disabled button elsewhere. The
324//! renderers moved, not the description.
325//!
326//! 0.29.1 adds [`Awaiting`], which is the sentence [`Readiness`] could say about
327//! a region and could not say about a control. A described screen could state
328//! that a list was on its way and could not state that the button just pressed
329//! is doing the thing it was pressed for, so every renderer's in-flight
330//! treatment was the app's to hand-write. The MNW server hand-writes it 57 times
331//! and hand-writes the guard against a second press twice, which is the half
332//! that matters going missing on a codebase that sells things.
333//!
334//! The mark is the fact that something outstanding will complete, once, in
335//! expected finite time. Deliberately not remoteness, since a heavy local query
336//! waits too, and deliberately not slowness, which is a judgement rather than a
337//! property. It carries an optional amount, stated only when the amount is
338//! measured, and it carries no duration at all: a renderer draws what is done
339//! over what there is plus the time so far, and never an estimate of what is
340//! left.
341//!
342//! One mark and two readings, which is what keeps a slow region from being
343//! hand-split into its own route the way MNW's payout summary is: a pressed
344//! control goes busy and locks, a region fed by an awaiting call stands in as
345//! [`Readiness::Pending`] and fills when it lands.
346//!
347//! A patch release for a new member, which is the 0.27.5 precedent rather than a
348//! new rule: nothing existing changed shape, so every consumer already asking
349//! for 0.29 keeps resolving and the suite below this crate does not have to move
350//! for a type only quasi reads. The minor releases above were minor because they
351//! also narrowed something.
352//!
353//! 0.30.0 is two members batched into one release, which is 0.11.0's precedent
354//! and its reasoning: pre-1.0 a minor is breaking, the cascade below this crate
355//! is seven repos, and paying that twice in a week for two unrelated words is
356//! the tax the batching exists to avoid.
357//!
358//! - [`FieldKind::Rich`], a field whose value is markdown source. The editing
359//! counterpart of prose already carried as markdown, and it is renderable
360//! everywhere for the reason the carrying is: editing markdown is editing
361//! text. It buys a renderer permission to offer a preview or a syntax pass and
362//! buys a host reading the value back the knowledge of what it holds; a
363//! renderer with neither draws a textarea. It says nothing about when the
364//! value is saved, because autosave is a clock. Measured against four MNW
365//! section editors that are one shape written four times.
366//! [`FieldKind::multiline`] arrives with it, since the pair is now two members
367//! every renderer has to ask about.
368//! - [`Facet`], [`Selecting`], [`FacetValue`] and [`Standing`]: a named
369//! dimension a set is narrowed by. MNW's discover page filters six ways
370//! through six mechanisms, and its filter rows carry a tick box *and* a
371//! chevron only because a tag's selection and a tag's browse position were
372//! held separately. One word covers all six, and [`Selecting::Subtree`] is the
373//! member that made it an enum rather than a bool: a tree's selection is
374//! branches taken and branches pruned, which no flat mode can express, and
375//! making one gesture do browsing and filtering together is what lets the
376//! second mechanism go. [`Standing`] has four members rather than a bool for
377//! the tree's sake — a value in force because an ancestor is, is not a value
378//! somebody picked. [`FacetValue`] splits an identifier from a label for
379//! [`Choice`]'s reason and one of its own: two leaves under different parents
380//! are legitimately both called "Ambient", and the path is what tells them
381//! apart and what nearest-ancestor-wins resolves over. Deliberately wider than
382//! that one page: audiofiles' library browser and goingson's filters are the
383//! same shape.
384//!
385//! 0.35.0 gives a suggestion its second line. [`Candidate`] is the entry in a
386//! field's suggestion list: a value, a label, and the [`detail`] that orients
387//! it. Ruled by Max 2026-08-21 (`1fcf2e9b`) after the combobox member shipped
388//! and was then held against the two sites it was designed from, which is an
389//! order worth not repeating.
390//!
391//! - **A candidate is not a [`Choice`], and the difference is in the reading
392//! rather than the writing.** Both submit one string and read as another. An
393//! option is picked out of a set the user can see whole; a candidate is
394//! offered out of a set nobody can see, so it has to say what tells it from
395//! its neighbours. Both measured sites draw that second string today, by
396//! hand, in a second span.
397//! - **It is its own type rather than a member on [`Choice`].** `Choice` is the
398//! most-consumed struct in the vocabulary and the member would have landed on
399//! every option list in the tree the day it shipped, including the ones with
400//! nowhere to draw it.
401//! - **[`Candidate`] is `#[non_exhaustive]` from birth**, which is the whole of
402//! what 0.28.0 cost and is not being paid twice.
403//! - No `unavailable`. A suggestion that cannot be picked is a row a route
404//! should not have offered.
405//!
406//! [`detail`]: Candidate::detail
407//!
408//! 0.34.0 gives an interval a description. [`FieldKind::Interval`] and
409//! [`Field::upper_name`] say that two values are one question with two ends.
410//! Ruled by Max 2026-08-21 against audiofiles' six filter axes and the MNW
411//! server's price pair, which is HTML saying the grouping in an ARIA
412//! `role="group"` and nowhere else.
413//!
414//! - **The ends constrain each other, and nothing else in the vocabulary could
415//! say so.** Two [`FieldKind::Number`] fields are two questions: a renderer
416//! draws two labels with no relationship, and [`Field::error`] attaches to one
417//! side of a fault that belongs to both.
418//! - **It is not [`FieldKind::Range`]**, which is the reading to resist and the
419//! same resistance `Range` needed against `Number`. A range is one value
420//! inside an extent; this is two, and the extent is a bound on each rather
421//! than the question's meaning.
422//! - **Both names are stated rather than derived.** Measured the same day, the
423//! two sites disagree about affix order -- `bpm_min`/`bpm_max` against
424//! `min_price`/`max_price` -- so any rule renames one of them. One member
425//! instead of a naming convention this crate would own forever, and which
426//! member a name sits in is what says which end it is.
427//! - The crossing rule is not enforced, exactly as [`Field::min`] is not. What
428//! the description buys is one place to report the fault rather than two.
429//!
430//! [`Field::upper_name`] is a member on a struct that is not
431//! `#[non_exhaustive]`, so this is a formal break for crates.io and zero
432//! call-site edits in the tree: every literal builds on a constructor.
433//!
434//! 0.33.0 gives a number its unit. [`Field::unit`] carries what the value is
435//! measured in, and [`FieldKind::measurable`] says which kinds read it. Decided
436//! by Max 2026-08-21 (`32215e21`) against eight sites across four audiofiles
437//! files that had each independently put the unit in parentheses at the end of
438//! the label -- three of them written while the gap was a known open question.
439//!
440//! - **A unit is a fact about the value, not part of the question's name.** The
441//! two readings come apart the moment anything reads a field back rather than
442//! drawing it, which is the argument that decided it.
443//! - **The convention it replaces froze the worst placement.** A label is the
444//! sentence above the control, so unit-in-label was the same answer on every
445//! host -- including the host that had somewhere better, since egui's slider
446//! already draws a suffix beside the readout, which is what these controls did
447//! before they were described.
448//! - A string rather than a closed family, which is [`Curve`]'s argument
449//! inverted and correctly so: a curve is a mapping this crate computes, and a
450//! unit is a symbol it only carries. The measured set is `GiB`, `dBFS`, `s`
451//! and `ms`, and this crate does not know what the next consumer measures in.
452//!
453//! Additive: absent is what every field meant before.
454//!
455//! 0.32.0 is the slider's real shape. **The data of a slider is a fraction and
456//! a function taking numbers to numbers** (Max, 2026-08-21), so [`Curve`]
457//! arrives and [`Field::curve`] with it. [`Field::min`] and [`Field::max`] were
458//! never the control's extent: a slider's extent is always 0 to 1, and the
459//! bounds are `f(0)` and `f(1)`. Linear is the constant-slope case, which is
460//! why the mapping was invisible — under it the extent and the bounds coincide
461//! numerically — and why four renderers each hard-coded it without anyone
462//! deciding to.
463//!
464//! - It is not a scale flag on a range. The question this replaced asked
465//! whether to name a decoration; what was unnamed is half of what a slider
466//! *is*, which is why the member is a mapping and not an adjective.
467//! - **The step spacing rides on the curve.** Max, in the same breath: if the
468//! family is prescriptive anyway, the granularity belongs in it. On a slider
469//! the two are one decision, and holding them apart is what let a 0-to-1
470//! threshold ship as a two-position control. [`Field::step`] narrows to the
471//! *typed* kinds, where there is no mapping to decide with.
472//! - A closed family rather than `fn(f64) -> f64`, which is the literal reading
473//! and does not cross the description boundary: a fn pointer cannot be
474//! emitted into a browser and cannot be compared or hashed meaningfully,
475//! which [`Field`] needs. Nothing measured wants an arbitrary function — one
476//! non-linear shape across five controls, and no second shape.
477//! - The mapping computes here rather than in each renderer
478//! ([`Curve::value_at`], [`Curve::position_of`]), so a terminal's bar, an
479//! egui slider and a browser's input cannot disagree about where a value
480//! sits. This crate otherwise describes rather than computes; four copies of
481//! two formulas is the cost of holding that line here.
482//!
483//! Additive: [`Curve::Linear`] with no step is what every range meant before,
484//! so no existing site changes meaning. Consumers: audiofiles' ADSR envelope
485//! (three logarithmic times) and its storage cap picker.
486//!
487//! 0.31.0 finishes the file field. [`FieldKind::File`] arrived at 0.11.0
488//! carrying neither an accepted-types list nor a multiplicity flag, and said so
489//! in its own doc: `accept` appeared at zero sites in either app, and a member
490//! added for a case nobody has is a member designed against nothing. That count
491//! was taken over goingson and Balanced Breakfast, and the MNW server is a third
492//! consumer with 14 `accept` lists across 10 templates and 4 of its 16 file
493//! inputs marked `multiple`. The reasoning was right and the measurement went
494//! stale, so [`Field::accept`] and [`Field::multiple`] arrive now.
495//!
496//! - [`Accepted`] is an enum rather than the comma-joined string the templates
497//! hold, because the list is read twice and only one of the readings is
498//! filtering. The other is which disclosure to offer — a preview, a duration,
499//! a waveform — and a renderer deciding that from raw strings is three
500//! renderers each writing a media-type parser. [`Accepted::family`] answers it
501//! once. All three shapes are in the measured sites and none can be dropped:
502//! `image/*` is a [`Family`], `image/jpeg` and `text/csv` are a
503//! [`Type`](Accepted::Type), and `.zip`, `.tar.gz` and `.clap` are a
504//! [`Suffix`](Accepted::Suffix). One site carries `.csv,text/csv`, which is
505//! both in one list.
506//! - A suffix carries no family and this crate will not infer one. `.mp3` is
507//! audio in fact, and a table here saying so is a mapping that rots in a
508//! published crate and is wrong for the first container format someone hands
509//! it. A call site that wants the disclosure writes the family or the media
510//! type, which is what the sites offering previews already do.
511//! - There is one upload shape, not one per type. What a media upload shows
512//! beyond a plain one is disclosure layered on this shape, which is why the
513//! accept list is load-bearing beyond validation and why nothing here names a
514//! media upload as its own kind.
515//! - Progress is not a member and needs none. An upload in flight is a control
516//! in flight with a number attached, so it is [`Awaiting`] with the file's
517//! length as its [`amount`](Awaiting::amount) — the case that type's own doc
518//! names. Where the bytes go is an address, and this crate holds none; that is
519//! the router's [`Action`], which the field already points at when it writes
520//! on its own.
521//!
522//! # Reach, focus and the focus ring
523//!
524//! Three terms, and no others, for what 0.19.0 moved out of the description.
525//! **Reach** is which things can take focus and in what order; a browser reads
526//! it off the document, a TUI derives it from draw order, egui from its own id
527//! stack. **Focus** is which reached thing has the keyboard right now: the
528//! renderer's, live, never described and never round-tripped through a
529//! description. The **focus ring** is the visible cue; the token (`focus-ring`,
530//! derived by `makeover` from the action colour) is the one shared artifact and
531//! the drawing is the renderer's. Retired as names for any of this: "focus
532//! stroke", "focus cue", "wants focus". "Caret" is a different thing — the text
533//! cursor inside a field — and keeps its name.
534//!
535//! # The three tones, and what a colour claims
536//!
537//! One rule, settled 2026-08-16, for how colour says whether a thing can be
538//! used. Every renderer answers to it, and it is stated here because the
539//! description is what names the intents.
540//!
541//! | the thing | intent |
542//! |-----------|--------|
543//! | active, emphasised, the thing itself | `content` |
544//! | inactive but usable: it still answers a press | `content-secondary` |
545//! | inert: disabled, or not a control at all | `content-muted` |
546//!
547//! `content-muted` is the one with a claim in it. [`State::Disabled`] resolves
548//! to it, so a live control wearing it is telling the user it will not answer —
549//! and being wrong about that is worse than being quiet, because the user's
550//! response is to stop trying. A sortable column heading that was never sorted,
551//! and every unchosen option in a radio group, both read as dead lists that way;
552//! those are the two this rule was written out of. What is legitimately muted is
553//! a caption, a hint, a placeholder, a meter's reading, an axis label: text that
554//! was never going to answer anything.
555//!
556//! The three are one ramp and not three colours. `makeover`'s `Emphasis` derives
557//! the quieter two from the ink, so "one step back" means the same distance in
558//! every theme and a renderer cannot land between them by picking its own.
559//!
560//! # First paint is final paint
561//!
562//! One rule, settled 2026-08-16. Nothing may change size or position after it is
563//! first drawn, and nothing may stand in for content that has not arrived yet.
564//! Both halves are absolute.
565//!
566//! It is stated here, rather than left to each renderer, because a renderer can
567//! only reserve space the description gave it enough to size. A member whose
568//! size depends on its content therefore owes whatever makes it sizeable while
569//! the content is still absent, and that is the second admission test for a new
570//! member: not only does it compose something this crate already names, it can
571//! be laid out before it is filled.
572//!
573//! The mechanism is a reservation, and [`Sort`]'s caret is the worked example.
574//! The caret is drawn into a box its own width whether or not the column is
575//! sorted, so pressing a heading cannot reflow the row it sits in. The box names
576//! no magnitude, which is what keeps it out of `makeover-geometry`'s territory.
577//! Reserve from what is known; never discover geometry from what has not
578//! arrived.
579//!
580//! The trap is an `Option` that means "not yet". [`Readiness::Pending`] is the
581//! honest way to say a region is still waiting. An optional *measurement* is
582//! not: a count that shows up later widens the text that prints it and moves
583//! everything beside it, which is the reflow this rule exists to forbid. So an
584//! `Option` on a measurement means the host will never know it — a property of
585//! the query, fixed for the life of the screen — and a renderer sizes for the
586//! answer it was handed rather than for the one it hopes is coming.
587//!
588//! # Any width, one answer
589//!
590//! The sibling of the rule above, and settled the same day. That one is
591//! independence from *when*; this one is independence from *how you got here*.
592//!
593//! A rendering is a pure function of the description and the viewport. The same
594//! description at the same width is the same output, whatever widths came
595//! before it. No renderer may carry geometry across frames, and none may narrow
596//! by counting.
597//!
598//! The failure this forbids is ordinary enough to be the default everywhere
599//! else: a page that hides its sidebar below some width, remembers that it hid
600//! it, and does not bring it back the same way. Layout there is a function of
601//! `(width, history)`, so dragging a window to 900 wide is a different screen
602//! depending on whether you came from 1400 or from 600. Nobody chose that; it
603//! is what measuring and remembering produce.
604//!
605//! The mechanism is [`Width`] for what grows and [`Priority`] for what drops.
606//! Both are declared, both are read off the description, and neither needs a
607//! measurement. A renderer narrows by raising a cutoff over a total order,
608//! never by counting what fits and stopping — `makeover-tui`'s table states
609//! that as its own rule and tests it, and `makeover-webview` reaches the same
610//! place with `@media` and `display: none`, which is path-independent by
611//! construction because CSS has nowhere to keep the previous width.
612//!
613//! Two things follow for anything new. A member that would need last frame's
614//! size to lay out this frame is refused, the same way a member that cannot be
615//! sized before it is filled is refused. And a fact about what disappears
616//! belongs in the description, because a host that has to infer it can only
617//! infer it from a measurement.
618//!
619//! # Where the description stops
620//!
621//! The rule is that a member is added when an app needs a fact the vocabulary
622//! cannot state, and refused when what it wants is presentation it should be
623//! asking a renderer for. That is the whole test. It is not a quota, and the
624//! goal is every screen described.
625//!
626//! ## What the timeline refusal got wrong, 2026-08-15
627//!
628//! This section used to read "a day-plan timeline, a kanban board and a
629//! calendar are not describable here and will not become describable", and it
630//! propagated: 12 files across three apps, three libraries and the design wiki
631//! cited it, including audiofiles and the MNW server, neither of which has a
632//! timeline. It is withdrawn, and [`Track`] is the member it was refusing.
633//!
634//! The error was pricing. The argument assumed a timeline needs a component
635//! library's worth of vocabulary, and nobody measured it. Held against
636//! goingson's `day-planning-render.js`, the members it actually needed and
637//! could not get were two integers: where a thing starts, and how long it
638//! lasts. Labels, gridlines, item bodies and tones were all furniture this
639//! crate already named. A refusal that expensive should have carried a
640//! measurement, and did not.
641//!
642//! The reasoning underneath it survives and is still the test: slot heights,
643//! gridline colour, how overlapping things stack, which hour scrolls into view.
644//! Those are presentation, they stay the renderer's, and [`Track`] carries none
645//! of them. What changed is the conclusion, not the principle.
646//!
647//! ## The other two, measured 2026-08-15
648//!
649//! The same sentence refused a kanban board and a calendar. Both were counted
650//! the way the timeline should have been, and neither came out where the
651//! refusal put it.
652//!
653//! **Kanban: one member, and it is [`Region::Columns`].** Held against
654//! goingson's `tasks-kanban.js`, every card fact was already sayable — title,
655//! project, due date, the blocked and unblocks badges, subtask progress, the
656//! open action and the context menu are `Row`'s existing parts. A column is a
657//! heading, a count and a list. What nothing could say was that the columns are
658//! *peers*: [`Arrangement`] offers list-detail and sidebar-content, and a board
659//! described as either is a lie about the screen. Dragging a card between
660//! columns never entered into it — a drop's effect is "set status", a discrete
661//! action `Row`'s menu already carries, and the drag itself is affordance.
662//!
663//! **Calendar: no members, no consumer, and a sharper reason (Max,
664//! 2026-08-15).** The month grid's primacy in calendar apps is an artifact of
665//! paper: paper cannot be queried, so it has to show every day at once as a
666//! fallback index. Routes, search and ranking do that job better, which is the
667//! argument `events-calendar.js` already lost to a segmented list on
668//! 2026-08-11.
669//!
670//! Three jobs survive that reasoning, and only one of them needs a grid:
671//!
672//! 1. **Spans across days** — a stretch of leave, a trip, a sprint. You cannot
673//! see "away the 3rd to the 17th" in a list without diffing dates. This is
674//! [`Track`] with [`Unit::Days`], not a calendar, and
675//! [`Track::days`] is it.
676//! 2. **Density at a glance** — which weeks were heavy. That is a heatmap, and
677//! goingson describes both of its heatmaps as lists already.
678//! 3. **Weekday periodicity** — "every other Tuesday", "the 15th is a
679//! Saturday". This is the only job that needs the seven-column wrap, because
680//! alignment is the whole of what makes it visible.
681//!
682//! So the open question is not "is a calendar describable" but "is job 3 worth
683//! a member", and nothing in the tree asks for job 3 yet. GoingsOn
684//! quasicoherent `4a1237b6`.
685//!
686//! A month grid renders today as a
687//! [`Table`](crate::Column): seven weekday columns, weeks as rows, blanks for
688//! the offset. goingson's monthly review reached this conclusion before this
689//! note did and describes its month as a list of days that had something on
690//! them, marking today with an ordinary badge. What the tree actually contains
691//! is two completion heatmaps — one scalar per day — and no calendar at all:
692//! `events-calendar.js` was deleted 2026-08-11 in favour of a segmented list,
693//! and no MNW template mentions one. So the refusal was defending a screen
694//! nobody has. If one is built, measure again; the facts already fit and only
695//! the grid's shape would be in question.
696//!
697//! The pattern worth keeping from all three: one sentence refused three things
698//! for one reason, and the reason was wrong three different ways. Count the
699//! members.
700//!
701//! [`Region::Bespoke`] remains for the genuinely app-owned, and its
702//! justification does not depend on the withdrawn claim. The
703//! description names the *place* and the app owns the contents, so a screen
704//! containing a timeline is still a whole screen and still routable. Without
705//! it, the four goingson screens that make the app worth using would need a
706//! second, undescribed path beside the router, and two paths is how a
707//! vocabulary starts drifting from its app again.
708//!
709//! [`Region::Widget`] sits between that limit and the primitives, and it does
710//! not move the limit. A widget is an assembly of members this crate *already*
711//! has, under a name a renderer may or may not recognise. Anything that needs a
712//! member the vocabulary does not have is still a finding about the vocabulary
713//! or still bespoke; naming an assembly buys no new expressive power, which is
714//! exactly why it is safe to let the set grow outside this crate.
715
716#![forbid(unsafe_code)]
717
718/// A colour intent this crate refers to but never resolves.
719///
720/// The string is the token name `makeover` publishes, so a renderer can look
721/// it up without this crate knowing what colour came back.
722pub trait Intent {
723 /// The `makeover` intent token this resolves against.
724 fn token(self) -> &'static str;
725}
726
727/// Which way the light falls across a two-tone edge.
728///
729/// The whole content of a bevel, once colour and thickness are deferred. The
730/// light is always assumed to come from the top left: every consumer measured
731/// agreed on that and none of them ever varied it, so it is an invariant here
732/// rather than a parameter.
733///
734/// # The two corners that belong to both edges
735///
736/// Top-right and bottom-left are where the lit run meets the shaded one, and
737/// the description's claim is that they belong to *both*. How a renderer says
738/// that is its own business, because the answer is bounded by resolution and
739/// not by taste:
740///
741/// - A terminal cell is roughly 8x17 device pixels, so giving the whole corner
742/// to one tone thickens that edge by a cell and reads as one run overrunning
743/// the other. A half-cell glyph divides the cell already, so `makeover-tui`
744/// splits it and recovers real information. Its box-drawing fallback cannot:
745/// a single stroke has no half to give, so there both corners go to dark.
746/// - A pixel bevel is a one-point stroke by default, which makes the corner a
747/// one-point square. There is nothing to divide — a diagonal seam across one
748/// point is sub-pixel, and antialiasing renders it as the blend a mitred join
749/// already produces. So `makeover-immediate` mitres and is *not* diverging;
750/// it is the same rule at a resolution where the split degenerates.
751///
752/// Stated here so the difference reads as a decision rather than as drift. A
753/// renderer with room to divide the corner should; one without should mitre or
754/// pick the shaded tone, and neither is a bug.
755#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
756pub enum Bevel {
757 /// Lit from the top left: light on top and left, dark on bottom and right.
758 Raised,
759 /// The same edge inverted, which is also the pressed state of anything
760 /// that draws itself [`Bevel::Raised`].
761 Inset,
762}
763
764impl Bevel {
765 /// The edge intents, as `(top_left, bottom_right)`.
766 ///
767 /// Split out from any painting because the inversion *is* the idea, and
768 /// it is the one part every renderer implements identically.
769 #[must_use]
770 pub const fn edges(self) -> (Edge, Edge) {
771 match self {
772 Self::Raised => (Edge::Light, Edge::Dark),
773 Self::Inset => (Edge::Dark, Edge::Light),
774 }
775 }
776
777 /// Pressing inverts. A raised control reads as inset while held.
778 ///
779 /// Stated here rather than left to each consumer because a cascade can
780 /// carry a pressed state and an immediate-mode renderer cannot: audiofiles
781 /// resolves this per call site, eighteen times.
782 #[must_use]
783 pub const fn pressed(self) -> Self {
784 match self {
785 Self::Raised => Self::Inset,
786 Self::Inset => Self::Raised,
787 }
788 }
789}
790
791/// One side of a bevel, named by the intent it takes.
792#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
793pub enum Edge {
794 /// The lit side.
795 Light,
796 /// The shadowed side.
797 Dark,
798}
799
800impl Intent for Edge {
801 fn token(self) -> &'static str {
802 match self {
803 Self::Light => "bevel-light",
804 Self::Dark => "bevel-dark",
805 }
806 }
807}
808
809/// A surface intent a region is filled with.
810///
811/// `#[non_exhaustive]`, so a renderer must carry a wildcard arm and a new
812/// member is additive rather than breaking. Added 0.4.0, after [`Sunken`]
813/// (an additive member, 0.3.0) hard-broke `makeover-tui` and
814/// `makeover-immediate` at compile time and left neither able to move until
815/// both published. The vocabulary exists to grow and the renderers exist to
816/// disagree about how much of it they answer, so growth must not be a
817/// lockstep event. The renderer's wildcard is not a hole: [`Fill`] is
818/// resolved through a fallible lookup, and a missing intent is answered with
819/// structure rather than with a substituted colour.
820///
821/// [`Sunken`]: Fill::Sunken
822#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
823#[non_exhaustive]
824pub enum Fill {
825 /// The page behind everything.
826 Page,
827 /// A surface lifted off the page: cards, controls, menus, toasts.
828 Raised,
829 /// A surface floating above the page rather than resting on it.
830 Overlay,
831 /// The inside of a well.
832 Well,
833 /// A surface set back from the one it sits on, by colour and nothing else.
834 ///
835 /// Not a well. A well is a hole with an edge, and the two are authored in
836 /// opposite directions: `makeover` derives `surface-well` by inverting
837 /// against the theme's own content colour, while `surface-sunken` is
838 /// authored and free to sit darker than raised (goingson's does). Naming
839 /// only the well left the recessed-with-no-edge surface unsayable, which is
840 /// what an unchosen tab is: it recedes so the chosen one can come forward,
841 /// and it carries no bevel of its own.
842 ///
843 /// Added 0.3.0, from goingson's tab strip, which hand-writes exactly this
844 /// and could not delete the line because no member described it.
845 Sunken,
846}
847
848// No `fallback` here, deliberately. An earlier cut had `Fill::Well` fall back
849// to `Fill::Page` so a consumer on makeover 2.2.0, which has no `surface-well`,
850// had something to paint. makeover-tui found that wrong within a day: page is
851// the surface a well is usually cut into, so on a terminal that substitution
852// produces exactly the invisibility it was meant to prevent, and the right
853// answer there is a drawn edge rather than a different colour.
854//
855// Substituting one intent for another is renderer policy. The description says
856// what the region is and stops.
857
858impl Intent for Fill {
859 fn token(self) -> &'static str {
860 match self {
861 Self::Page => "surface-page",
862 Self::Raised => "surface-raised",
863 Self::Overlay => "surface-overlay",
864 Self::Well => "surface-well",
865 Self::Sunken => "surface-sunken",
866 }
867 }
868}
869
870/// How a region sits relative to the surface behind it.
871///
872/// Fill and bevel are named together because naming them apart is what let
873/// them disagree. Every consumer measured had at least one region carrying a
874/// raised bevel over a recessed fill: audiofiles fixed it in `raised_frame`
875/// and recorded the bug in its doc comment, and Balanced Breakfast still had
876/// twelve of them a year later. A single name for the pair makes that
877/// unrepresentable.
878/// `#[non_exhaustive]` for the same reason as [`Fill`], and in the same
879/// release: a depth this renderer has no drawing for should cost it a
880/// wildcard arm, not a compile error and a wait on someone else's publish.
881#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
882#[non_exhaustive]
883pub enum Depth {
884 /// Level with its surroundings. No edge.
885 Flat,
886 /// A card laid on the panel it sits in.
887 Raised,
888 /// A hole in the panel, with content down inside it. For anything the
889 /// user looks *into*: a table body, a tag tree, a text field.
890 Well,
891 /// Set back from what it sits on, by colour alone. No edge.
892 ///
893 /// The one member carrying a fill without a bevel, so a renderer cannot
894 /// assume the two arrive together. That is deliberate and it is still the
895 /// pairing rule: both halves come off the same `Depth`, so they cannot
896 /// disagree, and here one half is legitimately absent.
897 ///
898 /// Distinct from [`Depth::Flat`], which has no fill either and inherits.
899 /// Recessed and level-with are different claims, and only one of them
900 /// needs a colour.
901 Sunken,
902 /// A surface sitting *over* the page rather than in it. A modal, a popover,
903 /// a menu.
904 ///
905 /// Takes elevation and no bevel: a surface overlaying the page is lifted
906 /// off it, and a surface in the page is cut into it. That is the same
907 /// pairing rule the rest of the enum holds, applied to the one case where
908 /// the separation is not an edge at all — the lift and the scrim behind it
909 /// are already saying where the surface is.
910 ///
911 /// Every renderer had the surface before it had this variant.
912 /// `makeover-tui` carries `Palette::overlay`, `makeover-immediate` gained
913 /// `Palette::elevation` at 0.10.0, and `makeover-webview` emits
914 /// `--elevation-overlay`. What was missing was the route from a description
915 /// to any of them, which is why this is one variant rather than a feature.
916 Overlay,
917}
918
919impl Depth {
920 /// The edge this depth is drawn with, if it has one.
921 #[must_use]
922 pub const fn bevel(self) -> Option<Bevel> {
923 match self {
924 // Sunken joins Flat here, for the opposite reason: Flat has no edge
925 // because nothing separates it from its surroundings, and Sunken has
926 // none because its colour is already doing the separating.
927 Self::Flat | Self::Sunken => None,
928 // A third reason to have no edge, which is why it gets its own arm
929 // rather than joining the two above: an overlay is separated by the
930 // lift and by the scrim behind it, so an edge would be a second
931 // answer to a question already answered.
932 Self::Overlay => None,
933 Self::Raised => Some(Bevel::Raised),
934 Self::Well => Some(Bevel::Inset),
935 }
936 }
937
938 /// The surface this depth is filled with.
939 ///
940 /// [`Depth::Flat`] has no fill of its own: it inherits whatever it sits on,
941 /// which is the difference between level-with and painted-the-same-colour.
942 #[must_use]
943 pub const fn fill(self) -> Option<Fill> {
944 match self {
945 Self::Flat => None,
946 Self::Raised => Some(Fill::Raised),
947 Self::Well => Some(Fill::Well),
948 Self::Sunken => Some(Fill::Sunken),
949 Self::Overlay => Some(Fill::Overlay),
950 }
951 }
952
953 /// Pressing a raised region reads as a well, and nothing else moves.
954 ///
955 /// [`Depth::Overlay`] is untouched along with the rest: an overlay is a
956 /// surface, not a control, so there is nothing there to press.
957 #[must_use]
958 pub const fn pressed(self) -> Self {
959 match self {
960 Self::Raised => Self::Well,
961 other => other,
962 }
963 }
964}
965
966/// An interaction state a region can be in, beside whatever [`Depth`] it is.
967///
968/// Orthogonal to depth on purpose. A disabled button is still [`Depth::Raised`]
969/// and a disabled field is still a [`Depth::Well`], so folding either member
970/// into `Depth` would make [`Depth::bevel`] and [`Depth::fill`] answer for
971/// something that is not a depth, and would leave disabled-button and
972/// disabled-field sharing one variant that cannot tell them apart.
973///
974/// # Why hover and pressed are not members
975///
976/// The line is whether every renderer has the state to express, not whether CSS
977/// does. Hover is renderer policy and `makeover-webview` says so in its own
978/// header: a terminal and an immediate-mode painter have no pointer hovering
979/// over anything, and pressed already arrives through [`Bevel::pressed`] and
980/// [`Depth::pressed`], where it belongs, because pressing is a depth inversion
981/// rather than a separate condition.
982///
983/// Focus and disabled are different in kind. A TUI has a focused widget and a
984/// greyed-out one; so does egui. Both were unsayable here, so all three webview
985/// consumers supplied them from outside the primitive by out-specifying rules
986/// they did not own: goingson alone carries 19 of them, and the MNW server
987/// another 21. That is the divergence this crate exists to end, arriving one
988/// layer down.
989///
990/// # The principle this encodes
991///
992/// A primitive owns every state it implies. A renderer that emits a hover rule
993/// for a thing owes disabled and the capability answer for that same thing,
994/// because anything less exports the completion work to N consumers who will
995/// each do it differently.
996///
997/// Focus is not on that list and was removed from this axis in 0.19.0. It is
998/// the renderer's, decided after the description; see the crate header, "Reach,
999/// focus and the focus ring", for the three terms and who owns each.
1000///
1001/// `#[non_exhaustive]` for the reason [`Fill`] and [`Depth`] carry it: growth
1002/// must not be a lockstep event across the three renderers.
1003#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1004#[non_exhaustive]
1005pub enum State {
1006 /// Present, visible, and not answering.
1007 ///
1008 /// Not the same as absent, and deliberately not a [`Fill`]: a disabled
1009 /// control keeps the surface it always had and stops responding, so what
1010 /// changes is its content and its interactivity rather than what it is.
1011 Disabled,
1012}
1013
1014impl State {
1015 /// Whether a region in this state stops answering the pointer.
1016 ///
1017 /// Stated in the description rather than left to each renderer, on the same
1018 /// reasoning as [`Bevel::pressed`]: a cascade carries it for free and an
1019 /// immediate-mode renderer resolves it per call site, so leaving it unsaid
1020 /// means resolving it once per consumer and disagreeing.
1021 #[must_use]
1022 pub const fn suppresses_interaction(self) -> bool {
1023 // A match rather than a bare `true`, so a member added to this
1024 // `#[non_exhaustive]` axis has to answer the question rather than
1025 // inheriting an answer.
1026 match self {
1027 Self::Disabled => true,
1028 }
1029 }
1030}
1031
1032impl Intent for State {
1033 fn token(self) -> &'static str {
1034 match self {
1035 // Reusing the muted content intent rather than minting a
1036 // `disabled` colour. Disabled is a reduction and not a status, and
1037 // `makeover-webview`'s progress rules already record the reading
1038 // that `content-muted` is what disabled looks like.
1039 Self::Disabled => "content-muted",
1040 }
1041 }
1042}
1043
1044/// What a region is saying, when it is saying something.
1045///
1046/// The one intent family shared by badges, notices and nothing else. Kept
1047/// separate from [`Fill`] because a surface is where a thing sits and a tone is
1048/// what it means, and the three apps agree on the four statuses:
1049/// `info_banner` / `warning_banner` in audiofiles, `.toast-info` /
1050/// `.toast-success` / `.toast-error` in goingson, `.toast.success` /
1051/// `.toast.error` in Balanced Breakfast.
1052///
1053/// The per-tag palette (`category-one` through `category-six`) is deliberately
1054/// not here. Which colour a *particular* tag takes is app domain, and both
1055/// webview apps already carry it as a `data-color` attribute.
1056#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1057pub enum Tone {
1058 /// No status. Reads as ordinary de-emphasised content.
1059 Neutral,
1060 /// Something worth knowing and nothing to do about it.
1061 Info,
1062 /// Something finished and it worked.
1063 Success,
1064 /// Something the user should look at before continuing.
1065 Warning,
1066 /// Something broken, or something about to be destroyed.
1067 Danger,
1068}
1069
1070impl Intent for Tone {
1071 fn token(self) -> &'static str {
1072 match self {
1073 // Neutral has no status token of its own. It takes the muted
1074 // content intent, which is what both webview apps already spell as
1075 // `data-color="muted"`.
1076 Self::Neutral => "content-muted",
1077 Self::Info => "info",
1078 Self::Success => "success",
1079 Self::Warning => "warning",
1080 Self::Danger => "danger",
1081 }
1082 }
1083}
1084
1085/// A small labelled thing that sits inside something else.
1086///
1087/// Two members, because the three apps drew three taxonomies and only one line
1088/// runs through all of them: does it answer a click. audiofiles has
1089/// `classification_badge` (a label) against `tag_chip`, `tag_chip_removable`
1090/// and `selectable_tag` (all of which do). Balanced Breakfast has `.tag` and
1091/// `.badge` against `.tag-chip`. goingson is the one that has to move: its
1092/// `.tag` and `.badge` are a single CSS rule, so every call site has to be read
1093/// to decide which of the two it always was.
1094///
1095/// The evidence that a chip is a real concept rather than a badge with a
1096/// cursor: audiofiles inverts its bevel on press and Balanced Breakfast latches
1097/// `.tag-chip.active` with the inset bevel. Two independent arrivals at "a chip
1098/// holds itself down", which is exactly what [`Depth::pressed`] already says.
1099#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1100pub enum Token {
1101 /// Non-interactive status or count. Answers no click.
1102 Badge,
1103 /// An interactive or removable token. Answers a click, and latches if it
1104 /// stands for a filter that is either on or off.
1105 Chip {
1106 /// Whether it carries its own remove affordance.
1107 removable: bool,
1108 },
1109}
1110
1111impl Token {
1112 /// Whether this answers a click.
1113 ///
1114 /// The whole difference between the two members, and the reason a renderer
1115 /// with no hover (a touch surface, a terminal) can still tell them apart.
1116 #[must_use]
1117 pub const fn interactive(self) -> bool {
1118 matches!(self, Self::Chip { .. })
1119 }
1120
1121 /// How it sits, given whether it is currently latched down.
1122 ///
1123 /// A badge is flat: it is a label, and giving it an edge would say it can
1124 /// be pressed. A chip is raised, and inset while latched.
1125 #[must_use]
1126 pub const fn depth(self, latched: bool) -> Depth {
1127 match self {
1128 Self::Badge => Depth::Flat,
1129 Self::Chip { .. } if latched => Depth::Well,
1130 Self::Chip { .. } => Depth::Raised,
1131 }
1132 }
1133}
1134
1135/// Something the app is telling the user, unprompted.
1136///
1137/// Two concepts, not one with a placement. They differ in more than where they
1138/// sit: a toast is transient, stacked and self-dismissing, and a banner is
1139/// persistent, in flow, one per region, and dismissed by fixing the condition
1140/// it reports. Folding them into one member with a placement parameter would
1141/// make lifetime, stacking and dismissal all placement-dependent, which is the
1142/// description leaking renderer policy.
1143///
1144/// All three apps have banners: `info_banner` and `warning_banner` in
1145/// audiofiles, five of them in goingson (sync, sync-result, vacation-day,
1146/// timer-active, past-review), `.update-banner` in Balanced Breakfast. The two
1147/// webview apps also have toasts. So neither member is speculative, and no app
1148/// gains a concept it lacks except audiofiles, whose renderer may legitimately
1149/// decline to draw a toast at all.
1150#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1151pub enum Notice {
1152 /// Transient, stacked, dismisses itself.
1153 Toast,
1154 /// Persistent, in flow, one per region, dismissed by fixing the cause.
1155 Banner,
1156}
1157
1158impl Notice {
1159 /// Whether it goes away on its own.
1160 #[must_use]
1161 pub const fn transient(self) -> bool {
1162 matches!(self, Self::Toast)
1163 }
1164
1165 /// How it sits.
1166 ///
1167 /// A toast floats above the page rather than resting on it, which is
1168 /// [`Fill::Overlay`]'s whole reason to exist. A banner is a card in the
1169 /// flow. Both are raised, and they are raised off different things.
1170 #[must_use]
1171 pub const fn fill(self) -> Fill {
1172 match self {
1173 Self::Toast => Fill::Overlay,
1174 Self::Banner => Fill::Raised,
1175 }
1176 }
1177}
1178
1179/// The parts of a list row.
1180///
1181/// Four to begin with, taken from Balanced Breakfast, which was the only
1182/// consumer that had all of them (`row-primary`, `row-secondary`, `row-meta`,
1183/// `row-actions`). audiofiles has two and no slot structure at all, so it gains
1184/// meta and actions as real work rather than a rename; goingson moves off
1185/// `task-row` / `task-cell`.
1186///
1187/// [`Tokens`](Self::Tokens) joined at 0.9.0, and `#[non_exhaustive]` with it.
1188/// See the crate header for why the two arrived together.
1189///
1190/// # Meta against Tokens
1191///
1192/// The line is whether the thing has its own standing. `Meta` is one short
1193/// trailing fact about the row, written as text: a count, a size, a date.
1194/// `Tokens` is a set of small labelled things, each of which can be toned and
1195/// can answer a click. "3 files" is meta. A status badge that is amber, and a
1196/// tag you can click to filter by, are tokens.
1197///
1198/// Keeping them apart is what a single widened slot would have foreclosed. A
1199/// renderer can right-align one string and cannot usefully do the same to a
1200/// strip of chips, and a fact that is not clickable should not be drawn as
1201/// though it were.
1202/// How much vertical room a part's text may take.
1203///
1204/// A row is an inline run and every part in it is a leaf, so a part's text has
1205/// always been drawn on one line and no description could say otherwise. Two
1206/// apps say otherwise in their own stylesheets, both to the same number and
1207/// both with a comment explaining it: Balanced Breakfast clamps a feed row's
1208/// title to two lines (`.row--article .row-primary`, whose comment reads
1209/// "overrides .row-primary's single flex line"), and goingson clamps a
1210/// problem's body to two ("two lines is enough to recognize one, and the full
1211/// text is in the task once promoted").
1212///
1213/// Two named tiers rather than a line count, and the count is what the measured
1214/// demand argues against. Both sites want exactly one tier past the default,
1215/// and a number invites a row whose primary is a paragraph, which is a block
1216/// and has no business in a run. A third tier is a decision, made here, rather
1217/// than something a call site can reach for.
1218///
1219/// What a renderer owes it: `Tight` is what a run already does and needs no
1220/// answer. `Relaxed` is at most two lines and then truncation, however that
1221/// renderer truncates -- a webview clamps, a terminal wraps into two rows of
1222/// cells, an immediate-mode renderer caps the galley. A renderer that cannot
1223/// give two lines may draw one; what it may not do is grow without bound,
1224/// because the run is a line and the row's neighbours are relying on that.
1225#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
1226#[non_exhaustive]
1227pub enum Flow {
1228 /// One line. What every part did before this type existed.
1229 #[default]
1230 Tight,
1231 /// Up to two lines, then truncated.
1232 Relaxed,
1233}
1234
1235impl Flow {
1236 /// How many lines the part may take.
1237 ///
1238 /// A number here rather than in the enum, because a renderer needs one and
1239 /// a call site does not. That asymmetry is the whole argument for the
1240 /// tiers: the description says how much room the thing deserves and this
1241 /// says what that costs, so a third tier changes one line rather than every
1242 /// consumer's arithmetic.
1243 #[must_use]
1244 pub const fn lines(self) -> u8 {
1245 match self {
1246 Self::Relaxed => 2,
1247 // Including any tier added later: one line is the safe reading of
1248 // an unknown flow, since it is what the run guaranteed before flows
1249 // existed.
1250 _ => 1,
1251 }
1252 }
1253}
1254
1255#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1256#[non_exhaustive]
1257pub enum RowPart {
1258 /// The thing itself. What the row is called.
1259 Primary,
1260 /// Supporting text under the primary.
1261 Secondary,
1262 /// A short trailing fact: a count, a size, a date.
1263 Meta,
1264 /// Controls that act on this row.
1265 Actions,
1266 /// Small labelled things belonging to the row: badges, chips, tags.
1267 ///
1268 /// Each carries its own [`Token`] kind and [`Tone`], so a renderer with no
1269 /// colour still has the kind to work with, and one with no chips still has
1270 /// the label. That is the constrained-consumer test this vocabulary exists
1271 /// to pass, and it is why the tone lives on the token rather than on the
1272 /// part.
1273 Tokens,
1274 /// How much of a set the row's thing has done: a [`Meter`] in the row.
1275 ///
1276 /// Added 0.11.0, `da5666ae`, and it is [`Tokens`](Self::Tokens)'s problem
1277 /// again with a different payload. [`Meter`] arrived at 0.10.0 and closed
1278 /// two of the seven sites that asked for it; the other five sit in rows, and
1279 /// a row holds no nodes by the ruling that a row part may not carry an
1280 /// arbitrary node — the door through which a description becomes a
1281 /// templating language. So the part carries the *description of a bar*
1282 /// rather than a node, exactly as `Tokens` carries tags rather than nodes.
1283 ///
1284 /// Without it a row flattens the proportion into [`Meta`](Self::Meta) as
1285 /// "3/7 subtasks", which keeps both numbers and loses the reading, the same
1286 /// way a toned status badge read as prose before `Tokens`.
1287 Proportion,
1288}
1289
1290impl RowPart {
1291 /// What the part is worth when the run does not fit.
1292 ///
1293 /// The default only. A part may say otherwise, and a renderer reads the
1294 /// part rather than the role; this is what a description that has never
1295 /// heard of [`Priority`] means, which is every description written before
1296 /// the field existed.
1297 ///
1298 /// Deriving it from the role is the thing this vocabulary has otherwise
1299 /// been moving away from, and it is right here for one reason: the roles
1300 /// already encode this ranking and every consumer already assumes it.
1301 /// [`Primary`](Self::Primary) is what the row is called, and
1302 /// [`Priority::Essential`]'s own doc was written about exactly that --
1303 /// "without it the row does not identify itself".
1304 ///
1305 /// [`Actions`](Self::Actions) is `Essential` and it is the interesting one.
1306 /// A control is not a fact, so dropping it does not cost the reader a
1307 /// detail; it costs them the only way to act on the row, and in a terminal
1308 /// it silently removes something focus had already been claimed for. A
1309 /// renderer that needs room takes it from what the row *says*, never from
1310 /// what it *offers*.
1311 ///
1312 /// An unknown member reads as [`Priority::Secondary`]: droppable, but not
1313 /// first, since guessing `Optional` for something this crate has not been
1314 /// taught would make a new member the first thing to vanish.
1315 #[must_use]
1316 pub const fn priority(self) -> Priority {
1317 match self {
1318 Self::Primary | Self::Actions => Priority::Essential,
1319 Self::Meta | Self::Proportion => Priority::Optional,
1320 _ => Priority::Secondary,
1321 }
1322 }
1323
1324 /// The content intent the part takes.
1325 #[must_use]
1326 pub const fn intent(self) -> &'static str {
1327 match self {
1328 Self::Primary => "content",
1329 Self::Secondary => "content-secondary",
1330 Self::Meta => "content-muted",
1331 // Actions carry controls rather than text, so they inherit.
1332 Self::Actions => "content",
1333 // So do tokens: each one carries its own tone, and a part-level
1334 // intent underneath it would fight the token that sits on it.
1335 Self::Tokens => "content",
1336 // And so does a proportion, for the same reason: the meter carries
1337 // the tone, and it is about the ratio rather than about the row.
1338 Self::Proportion => "content",
1339 }
1340 }
1341}
1342
1343/// How far down the heading tree a title sits.
1344///
1345/// Three, and only the three that are actually headings. The bands those used
1346/// to be filed with (goingson's `.page-header`, Balanced Breakfast's `.header`
1347/// and `.detail-header`) are arrangement, not type, and live at
1348/// [`Region::Band`]. One of them contains no text at all.
1349#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1350pub enum Heading {
1351 /// Names the whole screen. One per screen.
1352 Page,
1353 /// Names a block within the screen.
1354 Section,
1355 /// Names a sub-block inside an already-named section.
1356 Subsection,
1357}
1358
1359impl Heading {
1360 /// Whether a rule follows the heading.
1361 ///
1362 /// audiofiles' `section_header` draws a separator and its
1363 /// `subsection_label` deliberately does not, which is the only thing
1364 /// distinguishing the two once weight and colour are deferred.
1365 #[must_use]
1366 pub const fn separated(self) -> bool {
1367 matches!(self, Self::Section)
1368 }
1369}
1370
1371/// A control that picks between things.
1372///
1373/// Three, because three distinct behaviours are in play and collapsing any two
1374/// loses something. A segmented control picks a value; a tab picks a pane; a
1375/// toggle picks nothing and simply holds itself on or off.
1376#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1377pub enum Selector {
1378 /// Exactly one of N, and the options abut.
1379 Segmented,
1380 /// Independent on or off, on its own.
1381 Toggle,
1382 /// Navigation between panes. The folder semantic.
1383 Tabs,
1384}
1385
1386impl Selector {
1387 /// How the chosen option sits.
1388 ///
1389 /// Held in for a segmented control and a toggle, which is the same shape
1390 /// pressing produces and the whole economy of the idiom: one appearance,
1391 /// two reasons to wear it. A tab is the exception, because the selected
1392 /// folder tab comes *forward* to join the pane it opens.
1393 #[must_use]
1394 pub const fn chosen(self) -> Depth {
1395 match self {
1396 Self::Segmented | Self::Toggle => Depth::Well,
1397 Self::Tabs => Depth::Raised,
1398 }
1399 }
1400
1401 /// How the options that were *not* picked sit.
1402 ///
1403 /// Added 0.3.0. Describing only [`Selector::chosen`] left the unchosen
1404 /// option falling through to [`Depth::Flat`], which says it is level with
1405 /// the strip it sits in, and no renderer emitted anything for it. That is
1406 /// wrong in both directions and goingson proved it: its unchosen tabs are
1407 /// recessed by hand, and being recessed is *why* the chosen one reads as
1408 /// coming forward. Against a flat strip, a raised chosen tab is a bevel
1409 /// drawn on the strip's own colour, which is a much weaker folder effect
1410 /// than the contrast the idiom is named after.
1411 ///
1412 /// Each member is the inverse of its chosen state, which is the whole
1413 /// content of "picked" once colour is deferred:
1414 ///
1415 /// - Tabs recede, so the chosen one comes forward.
1416 /// - A segment and a toggle stand up, so the chosen one is held in.
1417 #[must_use]
1418 pub const fn unchosen(self) -> Depth {
1419 match self {
1420 Self::Tabs => Depth::Sunken,
1421 Self::Segmented | Self::Toggle => Depth::Raised,
1422 }
1423 }
1424
1425 /// Whether the options touch.
1426 ///
1427 /// The gap is the entire difference between a segmented control and a row
1428 /// of buttons that happen to sit near each other, which is what audiofiles'
1429 /// `segmented_control` says in its own comment and why it zeroes the
1430 /// spacing by hand.
1431 #[must_use]
1432 pub const fn abutting(self) -> bool {
1433 matches!(self, Self::Segmented | Self::Tabs)
1434 }
1435}
1436
1437/// What is in a region right now.
1438///
1439/// The state, not the shimmer. Whether pending paints a skeleton, a spinner or
1440/// nothing at all is renderer policy, the same class of decision that got
1441/// `Fill::fallback` deleted from this crate. goingson and Balanced Breakfast
1442/// each grew a skeleton with differently-named parts; both keep them, as the
1443/// webview renderer's expression of [`Readiness::Pending`]. audiofiles has none
1444/// and needs none, because an immediate-mode renderer simply repaints.
1445///
1446/// # Four states and not two, as of 0.12.0
1447///
1448/// `703f4cd2`. It named `Ready` and `Pending` and stopped, so a described screen
1449/// whose list came back empty had to render an empty region or invent its own
1450/// placeholder text, and neither says what it is. goingson draws one at 27 sites
1451/// across 12 files and Balanced Breakfast at 9, with a class family that had
1452/// already drifted into `empty-state`, `empty-state--error`, `error-state` and
1453/// six more.
1454///
1455/// The four are one axis because they are mutually exclusive: a region shows its
1456/// content, or a sign that it is coming, or a sign that there is none, or a sign
1457/// that it broke. Never two. That is the test for one enum against several
1458/// fields, and it is why this grew rather than a new member arriving beside it.
1459///
1460/// # What is not here
1461///
1462/// **The message.** "No projects yet" is content, and this names a state. It
1463/// lives with whatever holds the region — in quasi's case a `Slot` — alongside
1464/// the action that leads out of the emptiness, since an address is the one thing
1465/// this crate never names.
1466///
1467/// **How much room it gets.** goingson's `--compact`, `--dashboard` and
1468/// `--padded` are the same state at three sizes, and a size is
1469/// `makeover-geometry`'s question. Naming them here would be this crate stating
1470/// values again.
1471///
1472/// **The icon.** Presentation, and each host has its own answer or none.
1473#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1474#[non_exhaustive]
1475pub enum Readiness {
1476 /// The content is here.
1477 Ready,
1478 /// The content is on its way.
1479 ///
1480 /// For a region that changes *after* the first paint, and never for the
1481 /// first paint itself: see "First paint is final paint" in the crate header.
1482 /// A host that renders once, with its data already in hand, has nothing to
1483 /// say this about, and a screen arriving in this state is describing a
1484 /// moment its host should not have been in.
1485 ///
1486 /// What stands in occupies the geometry the content will occupy. A stand-in
1487 /// sized to itself rather than to what replaces it is the reflow the rule
1488 /// forbids, arriving one repaint later.
1489 Pending,
1490 /// The content arrived and there is none of it.
1491 ///
1492 /// Not a failure. An empty list is the normal state of a new install, and a
1493 /// renderer that drew it in a danger tone would be reporting a fault where
1494 /// there is none.
1495 Empty,
1496 /// The content did not arrive.
1497 Failed,
1498}
1499
1500impl Readiness {
1501 /// Whether the region draws its own content, or something standing in for
1502 /// it.
1503 ///
1504 /// The question every renderer asks first, so it is answered once here
1505 /// rather than by a `matches!` in each. A state added later is a stand-in
1506 /// until proven otherwise: falling back to drawing content that may not be
1507 /// there is the worse of the two mistakes.
1508 #[must_use]
1509 pub const fn shows_content(self) -> bool {
1510 matches!(self, Self::Ready)
1511 }
1512
1513 /// What the state means, for a renderer choosing a colour.
1514 ///
1515 /// Derived rather than carried, which is the opposite of [`Meter`] and
1516 /// [`Figure`], and the difference is worth stating: a proportion's meaning
1517 /// depends on what is being counted and only the app knows it, while
1518 /// "nothing here yet" and "this broke" mean the same thing in every app that
1519 /// will ever have them.
1520 #[must_use]
1521 pub const fn tone(self) -> Tone {
1522 match self {
1523 Self::Failed => Tone::Danger,
1524 _ => Tone::Neutral,
1525 }
1526 }
1527}
1528
1529/// An action is waiting on something that resolves once, in expected finite
1530/// time.
1531///
1532/// The control-side sibling of [`Readiness`]. That enum names four states for a
1533/// region and named nothing at all for the button that is currently doing what
1534/// it was clicked for, so the in-flight treatment is hand-written wherever it
1535/// exists: the MNW server carries 57 in-flight indicators against 2 guards
1536/// against a second press, which is the spinner mostly present and the guard
1537/// mostly absent, on a codebase whose money path is a purchase button.
1538///
1539/// # What is described here, and what is not
1540///
1541/// The fact is that there is an outstanding thing which will complete. Not that
1542/// the address is remote: a heavy local query waits too, and a server calling a
1543/// payment provider is not the browser leaving the app. Not that the call is
1544/// slow either, which is a judgement about a call rather than a property of one.
1545///
1546/// Resolving **once** is the boundary, and it is what separates this from a
1547/// screen that keeps changing. A live screen never resolves and has no name in
1548/// this crate yet.
1549///
1550/// # One mark, two renderings
1551///
1552/// | what reads it | what it does |
1553/// |---|---|
1554/// | a control that was pressed | goes busy and refuses a second press until it resolves |
1555/// | a region fed by it | stands in as [`Readiness::Pending`], then fills |
1556///
1557/// The two were on the table separately and both were taken. Controls alone
1558/// leaves a slow region hand-split into its own route, which is what MNW's user
1559/// dashboard does with its payout summary; regions alone leaves the purchase
1560/// button unguarded.
1561///
1562/// # A quantity when it is measured, never a duration
1563///
1564/// [`amount`](Self::amount) is stated only when it is a measured fact about the
1565/// payload. An upload's file length, yes; a round trip to a payment provider,
1566/// [`None`]. A duration is described nowhere, and a renderer may not manufacture
1567/// one from the amount either: a determinate bar shows what is done over what
1568/// there is, plus the time it has taken so far, and never a remaining time, an
1569/// arrival time or a rate extrapolated forwards. A prediction is wrong the
1570/// moment the transfer stalls, and being confidently wrong is worse than being
1571/// honestly indeterminate.
1572///
1573/// This is why the crate refuses to say how long an undo stays offered and
1574/// accepts a byte count here. The refusal is about naming a decision that
1575/// belongs to the renderer; a file's length is not a decision, nobody chose it.
1576///
1577/// # Not [`Meter`]
1578///
1579/// [`Meter`] is how much of a set is done, and its own docs refuse the progress
1580/// of an operation on the grounds that a description is built once and dropped
1581/// while an operation runs between renders. That refusal stands. This names the
1582/// operation and its size, which is all that is known before it starts; how much
1583/// of it has gone through is the renderer's to observe live, and nothing round
1584/// trips through a description to say so.
1585#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
1586#[non_exhaustive]
1587pub struct Awaiting {
1588 /// Total work to get through, when it is a measured fact about the payload.
1589 ///
1590 /// `None` when the wait has no countable size, which is the common case and
1591 /// the default.
1592 ///
1593 /// Unit-agnostic on purpose. Bytes for an upload, rows for an import; what
1594 /// is being counted is the app's business and a renderer draws a proportion
1595 /// either way.
1596 pub amount: Option<u64>,
1597}
1598
1599impl Awaiting {
1600 /// A wait with no countable size.
1601 #[must_use]
1602 pub const fn unmeasured() -> Self {
1603 Self { amount: None }
1604 }
1605
1606 /// A wait whose size is known.
1607 ///
1608 /// Reach for it only with a measured figure. An estimate written in here is
1609 /// a prediction wearing a fact's clothes, and the renderer has no way to
1610 /// tell the two apart.
1611 #[must_use]
1612 pub const fn of(amount: u64) -> Self {
1613 Self {
1614 amount: Some(amount),
1615 }
1616 }
1617
1618 /// Whether there is a proportion to draw.
1619 ///
1620 /// The question every renderer asks first, answered once here rather than by
1621 /// a `matches!` in each. False means indeterminate, which is the honest
1622 /// drawing when nothing countable was measured.
1623 #[must_use]
1624 pub const fn is_determinate(self) -> bool {
1625 self.amount.is_some()
1626 }
1627}
1628
1629/// How much of a set is done.
1630///
1631/// Added 0.10.0. Nine sites across the two webview apps drew a bar and nothing
1632/// here named one, so every described screen concatenated the two numbers into
1633/// its heading text instead: "Subtasks 3/7", "Time Tracking 45m tracked / 30m
1634/// est, over". Every fact survives that and the reading does not, which is the
1635/// same loss `RowPart::Tokens` closed when a toned status badge became prose.
1636///
1637/// # Why a pair and not a percentage
1638///
1639/// Both numbers, not the percentage the apps compute from them. The percentage
1640/// was the obvious shape and it had already been tried: goingson's
1641/// `Task::time_progress` divides, rounds, and then clamps to 100, which throws
1642/// away the one case the bar exists to show — 45 minutes tracked against a
1643/// 30-minute estimate. It carries a separate `is_over_estimate` boolean beside
1644/// it to recover the fact the clamp dropped. A pair keeps the over-run without a
1645/// companion flag, and [`percent`](Meter::percent) is still one call away for a
1646/// renderer that wants it.
1647///
1648/// The pair is also what the apps already have at every site. All seven
1649/// determinate bars write the ratio into the accessible layer and never the
1650/// percentage: `title="3/7 subtasks"`, `aria-label="3 of 7 subtasks completed"`,
1651/// a milestone's own `3/7` span. Given 43 nothing can recover "3 of 7", so a
1652/// percentage member would have made [`label`](Meter::label) mandatory at every
1653/// call site, which is the concatenated text this member removes, moved one
1654/// layer down.
1655///
1656/// # What this is not
1657///
1658/// The progress of an *operation*. Two of the nine sites are that — goingson's
1659/// focus timer, Balanced Breakfast's feed fetch — and they get nothing here, on
1660/// purpose. Both are imperative controllers over a live handle, driven by a tick
1661/// or an event stream, and a description is built once and dropped. Holding one
1662/// would mean growing a way to update a description between renders, which is a
1663/// different feature. [`Readiness::Pending`] and a [`Notice::Toast`] carry the
1664/// honest part.
1665///
1666/// The two cases are distinguishable in the markup rather than by taste: every
1667/// determinate bar in both apps carries a tone, and neither operation bar
1668/// carries one. Two codebases drew that line the same way without coordinating.
1669#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1670pub struct Meter<'a> {
1671 /// How much is done. May exceed [`total`](Self::total), and that is the
1672 /// case worth drawing.
1673 pub done: u32,
1674 /// How much there is to do. Zero means there is no set, not that the set is
1675 /// complete.
1676 pub total: u32,
1677 /// What the proportion means right now.
1678 ///
1679 /// Carried rather than derived, because no renderer can work it out. The
1680 /// same 90% is [`Tone::Success`] on a subtask rollup and [`Tone::Danger`] on
1681 /// a time estimate, and goingson picks between them from `is_over_estimate`,
1682 /// a fact about the data and not about the number.
1683 pub tone: Tone,
1684 /// What is being counted, if the bar says so: "subtasks", "tasks".
1685 ///
1686 /// The noun, not the ratio. A renderer builds "3 of 7 subtasks" from this
1687 /// and the two numbers; handing it the assembled string would put the
1688 /// sentence order in the description, where a terminal at one line and a
1689 /// tooltip want different ones.
1690 pub label: Option<&'a str>,
1691}
1692
1693impl<'a> Meter<'a> {
1694 /// A proportion with no tone and no label.
1695 #[must_use]
1696 pub const fn new(done: u32, total: u32) -> Self {
1697 Self {
1698 done,
1699 total,
1700 tone: Tone::Neutral,
1701 label: None,
1702 }
1703 }
1704
1705 /// What the proportion means.
1706 #[must_use]
1707 pub const fn tone(mut self, tone: Tone) -> Self {
1708 self.tone = tone;
1709 self
1710 }
1711
1712 /// What is being counted.
1713 #[must_use]
1714 pub const fn label(mut self, label: &'a str) -> Self {
1715 self.label = Some(label);
1716 self
1717 }
1718
1719 /// How full the bar is, 0 to 100, clamped.
1720 ///
1721 /// For drawing, which is the only thing a clamped number is good for. Ask
1722 /// [`overflowing`](Self::overflowing) before reporting it as a fact, or this
1723 /// is `time_progress`'s bug again with the clamp moved.
1724 ///
1725 /// An empty set reads as 0. Nothing is done, because there is nothing to do
1726 /// and no bar to fill; the apps guard on the count before drawing at all.
1727 #[must_use]
1728 pub const fn percent(&self) -> u8 {
1729 if self.total == 0 {
1730 return 0;
1731 }
1732 let scaled = (self.done as u64 * 100) / self.total as u64;
1733 if scaled > 100 { 100 } else { scaled as u8 }
1734 }
1735
1736 /// Whether more is done than there was to do.
1737 ///
1738 /// The fact [`percent`](Self::percent) destroys, kept reachable so a
1739 /// renderer can mark the over-run rather than drawing a full bar and
1740 /// implying it landed exactly.
1741 #[must_use]
1742 pub const fn overflowing(&self) -> bool {
1743 self.done > self.total
1744 }
1745
1746 /// Whether there is a set at all.
1747 ///
1748 /// A meter over nothing is sayable on purpose, for the same reason a field
1749 /// with no options is: it is what an app with an unloaded count actually
1750 /// has, and a renderer that shows an empty bar says so on screen rather than
1751 /// dividing by zero.
1752 #[must_use]
1753 pub const fn is_empty(&self) -> bool {
1754 self.total == 0
1755 }
1756}
1757
1758/// One figure with a caption: a number and what it counts.
1759///
1760/// The dashboard shape. A large value over a small caption, several of them in a
1761/// strip: a current streak, a completion rate, a total. Added 0.11.0,
1762/// `93c6a174`, after goingson turned out to have five of them across five
1763/// screens with five class vocabularies for the one shape — `task-overview-stat`,
1764/// `stat-box`, `month-stat-item`, `contact-summary-stat`, `sync-stat`. Four put
1765/// the value above the caption and one inverts it, which is drift inside the
1766/// shape rather than a second shape.
1767///
1768/// # Why the value is text
1769///
1770/// "17", "84%", "12/30", "3d". A figure is whatever the app computed, already
1771/// formatted, and the formatting is the app's because only it knows whether the
1772/// number is a percentage, a duration or a ratio. This carries none of the
1773/// arithmetic [`Meter`] carries, and that is the difference between them: a
1774/// meter is a proportion a renderer draws, and a figure is a fact a renderer
1775/// sets in type.
1776///
1777/// # Tone is carried, for [`Meter`]'s reason
1778///
1779/// Three of the five sites tone the figure by their own means — `red`/`blue` on
1780/// the weekly review, a `${type}` class on the monthly one, `sync-stat-warn` on
1781/// sync. So tone is carried at every site that needs it and derived at none, and
1782/// no renderer can work out that a streak of zero is worth colouring.
1783///
1784/// # What is not here
1785///
1786/// Whether the figure answers a click. One of the five is a control — sync's
1787/// "Not Applied: 3" opens the list — and an action is not something this crate
1788/// can name: nothing here knows what a route is. That belongs beside the figure
1789/// in whatever layer holds the actions, the same way a row's activation sits
1790/// beside its parts rather than inside them.
1791///
1792/// The arrangement is not here either. Several figures in a strip is a set, and
1793/// a renderer given them one at a time cannot tell it is looking at one; the
1794/// layer that holds the tree is where the set gets said.
1795#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1796pub struct Figure<'a> {
1797 /// The number, formatted the way the app means it to read.
1798 pub value: &'a str,
1799 /// What it counts. The caption under the value.
1800 pub caption: &'a str,
1801 /// How the value has moved, if the app is tracking that.
1802 ///
1803 /// Added 0.13.0. Text, for [`value`](Self::value)'s reason: only the app
1804 /// knows whether a move reads as `+12.5%`, `+3` or `2x`, and a renderer
1805 /// handed a number would have to guess.
1806 ///
1807 /// This is what [`tone`](Self::tone) was for and had no consumer of. The MNW
1808 /// server has four screens whose stat card is a label, a value and a delta,
1809 /// and the delta is the toned part: the figure itself is an ordinary fact
1810 /// and it is the movement that reads as good or bad. Without this the delta
1811 /// has to be folded into the caption, which loses the tone and reads as a
1812 /// longer caption rather than as a second, smaller line.
1813 pub change: Option<&'a str>,
1814 /// What the figure means right now. [`Tone::Neutral`] is an ordinary fact.
1815 ///
1816 /// Applies to [`change`](Self::change) where there is one, since that is the
1817 /// part that carries the judgement, and to the value where there is not.
1818 pub tone: Tone,
1819}
1820
1821impl<'a> Figure<'a> {
1822 /// A figure that is an ordinary fact.
1823 #[must_use]
1824 pub const fn new(value: &'a str, caption: &'a str) -> Self {
1825 Self {
1826 value,
1827 caption,
1828 change: None,
1829 tone: Tone::Neutral,
1830 }
1831 }
1832
1833 /// How the value has moved.
1834 #[must_use]
1835 pub const fn change(mut self, change: &'a str) -> Self {
1836 self.change = Some(change);
1837 self
1838 }
1839
1840 /// What the figure means.
1841 #[must_use]
1842 pub const fn tone(mut self, tone: Tone) -> Self {
1843 self.tone = tone;
1844 self
1845 }
1846}
1847
1848/// Something the user can do, and what it costs to say so.
1849///
1850/// Added 0.17.0, out of `quasi-tui`: the terminal renderer had drawn one of
1851/// these for months and every other consumer that wanted a button had written
1852/// its own, because this layer named [`RowPart::Actions`] as a *slot* and never
1853/// named the thing that goes in it. Beside [`Meter`] and [`Figure`] for the
1854/// reason those are here: a renderer that is handed the parts has to decide how
1855/// to say them, and a renderer that is handed a finished string has already had
1856/// the decision made for it.
1857///
1858/// No address. Where a control goes is the app's business and every host
1859/// follows it differently — an `hx-get`, a protocol URL, a function call — so
1860/// the description says what the control *is* and the caller keeps what it
1861/// does. That is the same split [`Choice`] makes.
1862///
1863/// No confirmation flag either, and that one is a finding rather than an
1864/// omission: a question asked *after* a control is pressed belongs to whatever
1865/// is holding the interaction, and a renderer that drew it would be asking
1866/// before there was anything to answer.
1867/// How a picture sits in the box it is given.
1868///
1869/// An intent rather than a value, so a renderer picks the expression it has:
1870/// `object-fit` in a webview, a texture's UV rect in egui, and in a terminal a
1871/// choice about how many cells the blit gets. Named because MNW already makes
1872/// the distinction deliberately at 17 sites and makes it three different ways,
1873/// which is a policy the app decided rather than one a shared crate would be
1874/// picking by accident.
1875#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
1876#[non_exhaustive]
1877pub enum Fit {
1878 /// The picture's own proportions, and the box takes the height they imply.
1879 ///
1880 /// The default because it is the only one that shows the whole picture at
1881 /// its own shape, so a renderer that ignores this enum entirely is still
1882 /// right about the common case. A screenshot wants this; the shipped MNW
1883 /// carousel sets no `object-fit` at all, which is this.
1884 #[default]
1885 Natural,
1886 /// Fill the box and crop whatever does not fit.
1887 ///
1888 /// For a picture in a slot whose shape the layout fixed: a thumbnail, an
1889 /// avatar, cover art. 15 of MNW's 17 sites.
1890 Cover,
1891 /// Fit inside the box whole, leaving space on two sides.
1892 ///
1893 /// The letterbox. For when the whole picture matters more than filling the
1894 /// space, and the space is not the picture's shape.
1895 Contain,
1896}
1897
1898/// A picture, and what it says to someone who is not looking at it.
1899///
1900/// # No source
1901///
1902/// [`Act`]'s split, for [`Act`]'s reason. A source is an address, and this
1903/// crate has no notion of an address: it says what a thing *is* and the caller
1904/// keeps what it points at. The three findings dropped from 0.11.0 were all
1905/// this same shape.
1906///
1907/// It matters more here than it does for a control, because a picture is the
1908/// one member where the address is most of what a webview needs and *none* of
1909/// what the description knows. `quasi_router::Node::Image` carries the URL, the
1910/// way it carries an `Action` for a control.
1911///
1912/// # Why [`alt`](Self::alt) is not optional
1913///
1914/// Every other host has to draw something, and for two of the three the alt
1915/// text is not a fallback but the whole rendering: a terminal without a
1916/// graphics protocol has the words and nothing else. Making it optional would
1917/// make "this picture is invisible on a terminal" the default, and the
1918/// description would be carrying a webview assumption in its shape.
1919///
1920/// An image that genuinely says nothing — a rule, a spacer, a decoration
1921/// repeating what the text beside it already said — is an empty `alt`, which is
1922/// the same thing HTML means by it and is a claim rather than an oversight.
1923#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1924pub struct Image<'a> {
1925 /// What the picture says, for anything not showing it.
1926 ///
1927 /// Empty means the picture is decorative and adds nothing to the text
1928 /// around it. See the type's own docs on why this is not an `Option`.
1929 pub alt: &'a str,
1930 /// A visible line under the picture, where the app wants one.
1931 ///
1932 /// Distinct from [`alt`](Self::alt) and the difference is who it is for: a
1933 /// caption is content everybody reads, alt text is what stands in for the
1934 /// picture. A screenshot captioned "The library view" still needs alt text
1935 /// describing what is in the shot.
1936 pub caption: Option<&'a str>,
1937 /// How it sits in the box it is given.
1938 pub fit: Fit,
1939 /// The picture's own dimensions, where the app knows them.
1940 ///
1941 /// **Not a display size**, and that distinction is what makes this belong
1942 /// here rather than fall foul of the deferral rule. Saying a picture should
1943 /// be 320 points wide is a layout value and is not the description's to
1944 /// give. Saying the file is 5120x3412 is a fact *about the picture*, the
1945 /// same kind of fact [`alt`](Self::alt) is, and no renderer can find it out
1946 /// without fetching the bytes.
1947 ///
1948 /// # What it is for, and it is not decoration
1949 ///
1950 /// Without it a renderer cannot reserve room, so the picture occupies
1951 /// nothing until it arrives and then takes its full height at once,
1952 /// shoving everything below it down the screen. Measured on MNW's landing
1953 /// page 2026-08-14: a 478px jump per frame, and a cumulative layout shift
1954 /// of 0.087 for the page, which is most of the way to the 0.1 that counts
1955 /// as bad.
1956 ///
1957 /// Every host wants it and none can derive it. A webview writes `width` and
1958 /// `height` so the browser holds the space; egui sizes a texture; a
1959 /// terminal with a graphics protocol scales a blit into cells. This was
1960 /// missing from 0.21.0, which is the release that added [`Image`], and its
1961 /// absence is the defect rather than an omission.
1962 ///
1963 /// `None` is honest and common: a creator-uploaded image whose dimensions
1964 /// the app never recorded genuinely does not know. It means the renderer
1965 /// cannot reserve, not that the picture has no size.
1966 pub intrinsic: Option<Extent>,
1967 /// Whether the picture is needed with the screen, or can arrive later.
1968 pub loading: Loading,
1969}
1970
1971/// A picture's own pixel dimensions.
1972///
1973/// Deliberately not [`makeover_geometry`]'s business. Geometry answers *how
1974/// much space a thing should get*, which is a scale question with the same
1975/// answer on every screen. This is the intrinsic size of one asset, which is a
1976/// fact about that asset and varies per picture.
1977///
1978/// [`makeover_geometry`]: https://docs.rs/makeover-geometry
1979#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1980pub struct Extent {
1981 /// Width in the picture's own pixels.
1982 pub width: u32,
1983 /// Height in the picture's own pixels.
1984 pub height: u32,
1985}
1986
1987impl Extent {
1988 /// A picture's dimensions.
1989 #[must_use]
1990 pub const fn new(width: u32, height: u32) -> Self {
1991 Self { width, height }
1992 }
1993
1994 /// Width over height, or `None` if either side is zero.
1995 ///
1996 /// The form a renderer actually reserves space with: a box that knows its
1997 /// proportion holds the right height at any width, which is what a
1998 /// responsive picture needs and what a fixed pixel height cannot give.
1999 #[must_use]
2000 pub fn ratio(self) -> Option<f32> {
2001 (self.width > 0 && self.height > 0).then(|| self.width as f32 / self.height as f32)
2002 }
2003}
2004
2005/// When a picture is needed.
2006///
2007/// A claim about *importance and position* rather than a fetch mechanism, which
2008/// is why it is the description's to make: only the app knows whether a picture
2009/// is the first thing on the screen or the fortieth thing down a list.
2010///
2011/// # Eager is the default, and that is a correctness choice
2012///
2013/// 0.21.0 emitted the webview's `loading="lazy"` for every picture, on the
2014/// evidence that the one consumer measured wrote it. That was reading a habit
2015/// as a rule. Deferring a picture that is on screen at first paint does not
2016/// save anything -- it is needed immediately either way -- and it delays the
2017/// arrival, so the space it eventually takes is claimed later and the shift is
2018/// more visible, not less.
2019///
2020/// So the safe answer is the default and the optimisation is opted into. A
2021/// carousel is the case that proves the two cannot be one setting for the
2022/// renderer to choose: its first frame is on screen and its other frames are
2023/// not, in the same widget, at the same moment.
2024#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
2025#[non_exhaustive]
2026pub enum Loading {
2027 /// Needed with the screen. Fetch it now.
2028 #[default]
2029 Eager,
2030 /// Not on screen yet. It can wait until it is near.
2031 Lazy,
2032}
2033
2034impl<'a> Image<'a> {
2035 /// A picture that carries its own proportions.
2036 #[must_use]
2037 pub const fn new(alt: &'a str) -> Self {
2038 Self {
2039 alt,
2040 caption: None,
2041 fit: Fit::Natural,
2042 intrinsic: None,
2043 loading: Loading::Eager,
2044 }
2045 }
2046
2047 /// The picture's own dimensions, so a renderer can hold its place.
2048 #[must_use]
2049 pub const fn intrinsic(mut self, width: u32, height: u32) -> Self {
2050 self.intrinsic = Some(Extent::new(width, height));
2051 self
2052 }
2053
2054 /// This picture is not on screen yet; it can arrive when it is near.
2055 #[must_use]
2056 pub const fn lazy(mut self) -> Self {
2057 self.loading = Loading::Lazy;
2058 self
2059 }
2060
2061 /// A visible line under it.
2062 #[must_use]
2063 pub const fn caption(mut self, caption: &'a str) -> Self {
2064 self.caption = Some(caption);
2065 self
2066 }
2067
2068 /// How it sits in its box.
2069 #[must_use]
2070 pub const fn fit(mut self, fit: Fit) -> Self {
2071 self.fit = fit;
2072 self
2073 }
2074
2075 /// Whether the picture adds anything for someone not looking at it.
2076 ///
2077 /// A renderer with no way to show a picture uses this to decide between
2078 /// drawing the alt text and drawing nothing at all. Both are correct and
2079 /// the difference is this flag: standing in for a decorative rule with the
2080 /// word "decoration" is worse than leaving the space empty.
2081 #[must_use]
2082 pub const fn speaks(self) -> bool {
2083 !self.alt.is_empty()
2084 }
2085}
2086
2087/// What a [`Track`]'s integers count.
2088///
2089/// `Track::fraction` never needed this -- the arithmetic is the same whatever
2090/// the numbers mean -- which is exactly how the ruler came to assume minutes
2091/// and print `00:00` over a month. A renderer drawing an axis has to write a
2092/// label, and it cannot derive the unit from the numbers.
2093///
2094/// Added 2026-08-15, after a probe put a fifteen-day span on a
2095/// thirty-one-slot track and got correct geometry under a wall clock.
2096#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
2097#[non_exhaustive]
2098pub enum Unit {
2099 /// Minutes from the start of a day. A day view.
2100 #[default]
2101 Minutes,
2102 /// Whole days. A month strip, a sprint, a stretch of leave.
2103 ///
2104 /// A day-granularity axis is a *strip*, not a calendar: one line with
2105 /// spans laid along it. What it deliberately does not do is wrap into
2106 /// weeks, which is the shape that makes weekday periodicity visible and
2107 /// the one job of a month grid that a strip cannot take over. See the
2108 /// crate header.
2109 Days,
2110}
2111
2112/// A window on an axis, in whatever [`Unit`] its [`Track`] counts.
2113///
2114/// The axis a [`Track`] draws. Offsets rather than instants, because a
2115/// description carrying a `DateTime` would carry a timezone with it and the
2116/// vocabulary has no business holding one. The app knows which day or month
2117/// this is; the description says how far along it a thing sits.
2118///
2119/// `to` is exclusive and may exceed the natural period, which is how a span
2120/// running past the end is said without a second date: under
2121/// [`Unit::Minutes`], `Span::new(1320, 1560)` is 22:00 to 02:00.
2122#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
2123pub struct Span {
2124 from: u16,
2125 to: u16,
2126}
2127
2128impl Span {
2129 /// Midnight to midnight, the ordinary day.
2130 pub const DAY: Self = Self { from: 0, to: 1440 };
2131
2132 /// A span, clamped to a sane one.
2133 ///
2134 /// An empty or backwards span is a caller bug that should not cost a
2135 /// renderer a division by zero, so `to` is forced at least one minute past
2136 /// `from` rather than returning an error nobody can act on. Same reasoning
2137 /// as [`Share::percent`], which clamps rather than refuses.
2138 #[must_use]
2139 pub const fn new(from: u16, to: u16) -> Self {
2140 Self {
2141 from,
2142 to: if to > from { to } else { from + 1 },
2143 }
2144 }
2145
2146 /// The first minute on the axis.
2147 #[must_use]
2148 pub const fn from(self) -> u16 {
2149 self.from
2150 }
2151
2152 /// One past the last minute on the axis.
2153 #[must_use]
2154 pub const fn to(self) -> u16 {
2155 self.to
2156 }
2157
2158 /// How much the axis covers, in its track's unit. Never zero.
2159 #[must_use]
2160 pub const fn length(self) -> u16 {
2161 self.to - self.from
2162 }
2163
2164 /// Whether an offset falls on this axis.
2165 #[must_use]
2166 pub const fn holds(self, minute: u16) -> bool {
2167 minute >= self.from && minute < self.to
2168 }
2169}
2170
2171impl Default for Span {
2172 fn default() -> Self {
2173 Self::DAY
2174 }
2175}
2176
2177/// Where a thing sits on a [`Track`], and for how long.
2178///
2179/// The one fact a list cannot carry and the whole reason this primitive exists.
2180/// A list says what order things come in; a track says a thing starts 135
2181/// minutes along and lasts 45, which is a different claim and not derivable
2182/// from the first.
2183#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
2184pub struct Placement {
2185 at: u16,
2186 length: u16,
2187}
2188
2189impl Placement {
2190 /// A placement, clamped to a drawable one.
2191 ///
2192 /// Zero length becomes one for the same reason [`Span::new`] clamps: a
2193 /// zero-height thing is invisible rather than expressive, and every
2194 /// renderer would need its own guard.
2195 #[must_use]
2196 pub const fn new(at: u16, length: u16) -> Self {
2197 Self {
2198 at,
2199 length: if length == 0 { 1 } else { length },
2200 }
2201 }
2202
2203 /// Offset from the axis origin, matching [`Span`]'s.
2204 #[must_use]
2205 pub const fn at(self) -> u16 {
2206 self.at
2207 }
2208
2209 /// How long it lasts, in its track's unit. Never zero.
2210 #[must_use]
2211 pub const fn length(self) -> u16 {
2212 self.length
2213 }
2214
2215 /// One past its last minute.
2216 #[must_use]
2217 pub const fn end(self) -> u16 {
2218 self.at + self.length
2219 }
2220
2221 /// Whether two placements cover any of the same time.
2222 ///
2223 /// Geometry, and deliberately not a described field. Whether an overlap is
2224 /// a *conflict* is the app's judgment -- a meeting inside a block of free
2225 /// time overlaps and is fine -- and that judgment travels the way every
2226 /// other judgment does, as a [`Tone`] on the thing itself. What a renderer
2227 /// needs in order to lay two things side by side instead of on top of each
2228 /// other is this, and it can compute it.
2229 ///
2230 /// The alternative was a `conflicts: bool` on each entry, which is state
2231 /// that can disagree with the times beside it. Two sources for one fact is
2232 /// how a screen starts rendering a conflict badge on a thing that no longer
2233 /// conflicts.
2234 #[must_use]
2235 pub const fn overlaps(self, other: Self) -> bool {
2236 self.at < other.end() && other.at < self.end()
2237 }
2238}
2239
2240/// A time axis: things placed by when they happen, rather than flowed.
2241///
2242/// # Why this is a primitive
2243///
2244/// This crate refused to name it until 2026-08-15, on the argument that a
2245/// description expressive enough to draw a timeline is a component library
2246/// wearing a description's name. The refusal is withdrawn, and it is worth
2247/// being precise about what was wrong with it, because the reasoning it used
2248/// applies to real cases and should not be discarded with it.
2249///
2250/// What a timeline needs that a [`List`](Region::Pane) does not is **one**
2251/// thing: placement. Where a thing sits is a fact about the thing, the way a
2252/// row's primary text is, and it is not derivable from order. Everything else a
2253/// day view draws -- the labels, the gridlines, the item bodies, the tones --
2254/// is furniture this vocabulary already names. Measured against goingson's
2255/// `day-planning-render.js`, the only members it needed and could not get were
2256/// `at` and `minutes`.
2257///
2258/// So the timeline was never a component library's worth of vocabulary. It was
2259/// two integers, and the refusal was priced as though it were the whole widget.
2260/// The test that matters is not "does this shape look complicated" but "how
2261/// many members does it actually add, and are they facts or presentation".
2262/// Slot heights, gridline colour, how overlaps stack and which hour scrolls
2263/// into view on open are all presentation and all stay the renderer's, which is
2264/// why they are absent here.
2265///
2266/// # What it does not carry
2267///
2268/// No pixel measure, no scroll offset, no drag affordance. A renderer draws the
2269/// span at whatever density its host uses; `makeover-geometry` owns that the
2270/// way it owns everything else measured in pixels.
2271#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
2272pub struct Track {
2273 /// The window the axis covers.
2274 pub span: Span,
2275 /// The granularity a thing can be placed on, in minutes.
2276 ///
2277 /// goingson's day view is 15, giving 96 slots across a day. A renderer uses
2278 /// it to decide where gridlines fall and what a drop lands on; it does not
2279 /// constrain [`Placement`], because data arriving from a calendar does not
2280 /// respect anyone's grid.
2281 pub slot: u16,
2282 /// How often the axis labels itself, in its own unit.
2283 ///
2284 /// 60 gives an hourly ruler over a 15-minute grid, which is the common
2285 /// shape and the reason this is separate from `slot`. Zero means an
2286 /// unlabelled axis.
2287 pub tick: u16,
2288 /// What `span`, `slot`, `tick` and every [`Placement`] on it count.
2289 ///
2290 /// The one field here a renderer cannot derive, and the reason it exists:
2291 /// [`fraction`](Self::fraction) is unit-agnostic, so a day-granularity
2292 /// track produced correct geometry under an hours-and-minutes ruler until
2293 /// this was added. Geometry never needed it; a label always did.
2294 pub unit: Unit,
2295}
2296
2297impl Track {
2298 /// An ordinary day: midnight to midnight, quarter-hour slots, hourly ticks.
2299 pub const DAY: Self = Self {
2300 span: Span::DAY,
2301 slot: 15,
2302 tick: 60,
2303 unit: Unit::Minutes,
2304 };
2305
2306 /// A track over `span`, with the day's usual granularity.
2307 #[must_use]
2308 pub const fn over(span: Span) -> Self {
2309 Self {
2310 span,
2311 slot: 15,
2312 tick: 60,
2313 unit: Unit::Minutes,
2314 }
2315 }
2316
2317 /// A strip of whole days: one slot a day, a label a week.
2318 ///
2319 /// The shape a stretch of leave or a sprint is drawn on. Not a calendar --
2320 /// it does not wrap into weeks, and the crate header says why that
2321 /// distinction is the whole of what a month grid still has over this.
2322 #[must_use]
2323 pub const fn days(span: Span) -> Self {
2324 Self {
2325 span,
2326 slot: 1,
2327 tick: 7,
2328 unit: Unit::Days,
2329 }
2330 }
2331
2332 /// How many slots the axis holds.
2333 ///
2334 /// Rounded up, so a span that does not divide evenly by `slot` still has a
2335 /// slot covering its tail rather than dropping it. Never zero: `slot` of 0
2336 /// reads as one slot spanning the whole axis rather than a division by
2337 /// zero, since a renderer asking this question has already committed to
2338 /// drawing something.
2339 #[must_use]
2340 pub const fn slots(self) -> u16 {
2341 if self.slot == 0 {
2342 1
2343 } else {
2344 self.span.length().div_ceil(self.slot)
2345 }
2346 }
2347
2348 /// Where a placement sits on the axis, as a fraction from 0.0 to 1.0.
2349 ///
2350 /// The one calculation every renderer would otherwise write itself, and the
2351 /// place the three would drift apart. Clamped, so a placement outside the
2352 /// span draws at the edge rather than off it -- an event running past
2353 /// midnight is a real thing and truncating it is better than either
2354 /// panicking or drawing it somewhere impossible.
2355 #[must_use]
2356 pub fn fraction(self, minute: u16) -> f32 {
2357 let span = f32::from(self.span.length());
2358 let offset = f32::from(minute.saturating_sub(self.span.from()));
2359 (offset / span).clamp(0.0, 1.0)
2360 }
2361}
2362
2363impl Default for Track {
2364 fn default() -> Self {
2365 Self::DAY
2366 }
2367}
2368
2369#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
2370pub struct Act<'a> {
2371 /// What the control says.
2372 pub label: &'a str,
2373 /// The key that reaches it where a host has keys.
2374 ///
2375 /// The one member written for a terminal before there was one. A webview
2376 /// hangs it off `accesskey` or ignores it; a terminal has nothing else to
2377 /// offer, so this is the whole of how a control is reached there.
2378 pub key: Option<&'a str>,
2379 /// What pressing it means. [`Tone::Danger`] is the destructive one.
2380 pub tone: Tone,
2381 /// Disabled, or nothing said.
2382 ///
2383 /// [`State::Disabled`] is what changes what a renderer may do: see
2384 /// [`State::suppresses_interaction`], which is what says a disabled control
2385 /// is drawn and not reachable. It has been the only member since 0.19.0,
2386 /// and a control's focus is not sayable here at all — see the crate header,
2387 /// "Reach, focus and the focus ring".
2388 pub state: Option<State>,
2389}
2390
2391impl<'a> Act<'a> {
2392 /// An ordinary control, reachable, with no key.
2393 #[must_use]
2394 pub const fn new(label: &'a str) -> Self {
2395 Self {
2396 label,
2397 key: None,
2398 tone: Tone::Neutral,
2399 state: None,
2400 }
2401 }
2402
2403 /// The key that reaches it.
2404 #[must_use]
2405 pub const fn key(mut self, key: &'a str) -> Self {
2406 self.key = Some(key);
2407 self
2408 }
2409
2410 /// What pressing it means.
2411 #[must_use]
2412 pub const fn tone(mut self, tone: Tone) -> Self {
2413 self.tone = tone;
2414 self
2415 }
2416
2417 /// Focus, or disabled.
2418 #[must_use]
2419 pub const fn state(mut self, state: State) -> Self {
2420 self.state = Some(state);
2421 self
2422 }
2423
2424 /// Whether the control is drawn and does not answer.
2425 #[must_use]
2426 pub fn disabled(&self) -> bool {
2427 self.state.is_some_and(State::suppresses_interaction)
2428 }
2429}
2430
2431/// A named part of a screen.
2432///
2433/// The thing `makeover-geometry` deliberately does not name: it names the space
2434/// *between* things by relationship, and nothing named the things. Six named
2435/// members, taken from what the two webview apps actually use, plus
2436/// [`Region::Bespoke`] for the parts no description should reach. Both apps'
2437/// `layout.css` currently names exactly two things, `.raised` and `.well`, so
2438/// this layer is absent rather than divergent, which makes it the cheapest of
2439/// the schemas to add and the easiest to over-build.
2440///
2441/// `#[non_exhaustive]` arrives with [`Region::Widget`], the pairing [`RowPart`]
2442/// made at 0.9.0 and [`Readiness`] at 0.12.0, and for the same reason: the
2443/// member after this one should not be a lockstep event across three renderers.
2444#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
2445#[non_exhaustive]
2446pub enum Region<'a> {
2447 /// A full-width strip with a title slot and an actions cluster, either of
2448 /// which may be empty. goingson's `.page-header`, Balanced Breakfast's
2449 /// `.header` and `.detail-header` are all this, differing only in which
2450 /// slots they fill.
2451 Band,
2452 /// A persistent column beside the content, holding navigation.
2453 Sidebar,
2454 /// A region of content with its own scroll.
2455 Pane,
2456 /// Things that belong together, and nothing else.
2457 ///
2458 /// The block [`Heading::Section`] has been naming since 0.2.0 without the
2459 /// vocabulary being able to contain it. A section heading is a leaf sitting
2460 /// *beside* the things it names, so nothing said where a section started or
2461 /// ended and a renderer learned one had ended only because the next heading
2462 /// arrived.
2463 ///
2464 /// # The measurement
2465 ///
2466 /// 41 [`Heading::Section`] sites across the ten screens described through
2467 /// the router, not one of them contained. audiofiles' settings screen is the
2468 /// clearest: one pane holding a heading, a field, a heading, two toggles, a
2469 /// heading, a toggle and a heading, which is four sections and no
2470 /// containers. Under the hand-written CSS the ports are replacing the same
2471 /// block is spelled `.settings-section` in goingson, `.form-section` and
2472 /// `.content-section` in the MNW server, `.help-section` in Balanced
2473 /// Breakfast: three apps, four names, one shape.
2474 ///
2475 /// # Why the existing members were the wrong answer
2476 ///
2477 /// [`Pane`](Self::Pane) is what apps reached for, and it is 28 of the 45
2478 /// regions in the described screens. It claims a scroll of its own and
2479 /// [`Depth::Well`], so four settings groups inside a pane are four wells
2480 /// inside a well and four scroll contexts. Neither claim is true of a group.
2481 ///
2482 /// [`Widget`](Self::Widget) is wrong from the other side. Its own docs say a
2483 /// widget is never how a primitive gets added by the back door, and a run of
2484 /// related controls under a heading is furniture any app would have, which
2485 /// is the generic-against-bespoke bar a primitive has to clear.
2486 ///
2487 /// # What it does not carry
2488 ///
2489 /// **A heading.** A group usually has one and it is an ordinary node in the
2490 /// body, the way it already was. A group of related toggles with no heading
2491 /// is a real thing and a mandatory slot would forbid it.
2492 ///
2493 /// **A depth.** [`Depth::Flat`], on [`Bespoke`](Self::Bespoke)'s reasoning:
2494 /// it inherits, and an app that wants its group in a well puts it in a
2495 /// [`Pane`](Self::Pane), which composes rather than adding a knob here.
2496 ///
2497 /// **A colour.** Distinguishing sibling groups by colour is the thing this
2498 /// member was asked for and it is deliberately not stated here. The
2499 /// description says these things belong together; which of the theme's
2500 /// categorical colours a renderer reaches for, and whether it reaches for
2501 /// one at all, is derived from sibling order at the renderer. A terminal
2502 /// that tints nothing and separates with a rule is honouring this.
2503 Group,
2504 /// Two panes side by side, where the left chooses what the right shows.
2505 Split,
2506 /// Peer regions across, all of them equals.
2507 ///
2508 /// A kanban board's columns, and the shape [`Split`](Self::Split) is not:
2509 /// a split's two panes stand in a master-detail relationship, where the
2510 /// left chooses what the right shows. These choose nothing about each
2511 /// other. Each is a whole region and the set is the arrangement.
2512 ///
2513 /// # What it does not carry
2514 ///
2515 /// **How many.** The children say, and a count here would be a second
2516 /// source for something the description already states by containing them.
2517 ///
2518 /// **How wide.** Peers are equal by definition, so there is no [`Share`] to
2519 /// state. A board whose columns wanted different widths would be a
2520 /// different member, and no app has one.
2521 ///
2522 /// **What happens when there is no room.** Scroll across, wrap, or collapse
2523 /// to one column at a time: all three are right on some host, none is
2524 /// derivable from the description, and every one of them is presentation.
2525 /// A terminal that stacks them vertically is honouring this, not degrading
2526 /// it.
2527 ///
2528 /// # Why it is not an `Arrangement`
2529 ///
2530 /// [`Arrangement`] is the page's shape, and a board is usually a region
2531 /// *inside* a page that also has a band over it. Naming it here composes;
2532 /// naming it there would make a screen either a board or a list-detail and
2533 /// never a band above a board. It also keeps [`Arrangement::share`]
2534 /// meaningful, which a peer arrangement has no answer for.
2535 Columns,
2536 /// A set of panes, one visible at a time, and a [`Selector::Tabs`] that
2537 /// chooses between them.
2538 ///
2539 /// Says nothing about where the strip sits. A row over the panes, a column
2540 /// beside them, a wrapped run of links under them: all three are the same
2541 /// member drawn by a renderer that knows its host, the way the strip's
2542 /// overflow is.
2543 TabGroup,
2544 /// Content over a scrim, taking input until dismissed.
2545 Modal,
2546 /// A region this crate names the *place* of and nothing else. The app owns
2547 /// what goes in it.
2548 ///
2549 /// The escape hatch, and the thing that keeps the description honest about
2550 /// its own limits. A day-plan timeline, a kanban board, a calendar and the
2551 /// paint interaction over the timeline are not describable here and are not
2552 /// going to become describable: a description expressive enough to produce
2553 /// a timeline is a widget library wearing a description's name.
2554 ///
2555 /// But a screen containing one still has to be a screen. Without this
2556 /// member the description covers only the boring screens, and the four that
2557 /// make goingson worth using would need a second, undescribed path beside
2558 /// the router. Two paths is how the vocabulary starts drifting from the app
2559 /// again, which is the exact failure this crate exists to end.
2560 ///
2561 /// So the description says "a thing called `day-plan` goes here" and stops.
2562 /// The name is opaque: this crate never interprets it, and no renderer is
2563 /// expected to know what it means beyond handing the space over.
2564 Bespoke {
2565 /// What the app calls it. Never interpreted here.
2566 name: &'a str,
2567 },
2568 /// A named assembly of things the vocabulary already says.
2569 ///
2570 /// The third tier, between a primitive and [`Bespoke`](Self::Bespoke).
2571 /// Stated by Max 2026-08-12 answering the carousel: "something in between a
2572 /// primitive and a bespoke interface, like a widget, which is just an
2573 /// assembly of primitives." Full note: wiki `widget-tier`.
2574 ///
2575 /// # What separates it from the two members either side
2576 ///
2577 /// A primitive is a thing every renderer draws from scratch, and the test
2578 /// it has to pass is that every host has an honest answer. A carousel fails
2579 /// that test — a terminal has no carousel — which is the same refusal
2580 /// `Node::Html` got and is why the carousel sat unsayable for months.
2581 ///
2582 /// [`Bespoke`](Self::Bespoke) fails it from the other side. Bespoke is for
2583 /// what one app owns and nobody will build twice, and it carries *no*
2584 /// contents: the description names the place and stops. A carousel is
2585 /// furniture any app would have, and every part of it — an ordered set of
2586 /// frames, a position, prev and next, a strip of position indicators — is
2587 /// already sayable. Only the assembly had no name.
2588 ///
2589 /// So this member is the pair the other two are not: a name **and**
2590 /// contents. The contents are the assembly, in the region's own body, said
2591 /// in members that already exist.
2592 ///
2593 /// # Why the name does not have to be understood
2594 ///
2595 /// A renderer that recognises the name draws it the way its host does it: a
2596 /// carousel in a webview, a pager with a count in a terminal, a selector in
2597 /// egui. A renderer that does not recognise it walks the body, which is
2598 /// primitives all the way down and which it can already draw.
2599 ///
2600 /// That is what lets the widget set be **open** without every renderer
2601 /// knowing every widget. An unrecognised widget degrades to its assembly
2602 /// instead of failing, so a second or third party can name one without
2603 /// three renderers releasing in lockstep to accept it. Contrast
2604 /// [`Bespoke`](Self::Bespoke), which no renderer can degrade: there is
2605 /// nothing under it to fall back to.
2606 ///
2607 /// # What it does not do
2608 ///
2609 /// A widget is an assembly of things the vocabulary *already* says, so it
2610 /// buys no expressive power. Anything needing a member the vocabulary does
2611 /// not have is a finding about the vocabulary, and the answer to a finding
2612 /// is to add the member. A widget is never the way a primitive gets added
2613 /// by the back door.
2614 ///
2615 /// This used to say "it does not make a timeline describable, and the
2616 /// refusal in the crate header stands unchanged". The timeline is
2617 /// describable as of 2026-08-15 -- see [`Track`] -- and it got there the
2618 /// way the paragraph above says it should have: by adding the two members
2619 /// that were missing, not by dressing the screen up as an assembly.
2620 Widget {
2621 /// What the assembly is called. This crate never interprets it, and a
2622 /// renderer is free not to know it.
2623 name: &'a str,
2624 },
2625}
2626
2627impl<'a> Region<'a> {
2628 /// How the region sits on what is behind it.
2629 #[must_use]
2630 pub const fn depth(self) -> Depth {
2631 match self {
2632 Self::Band | Self::Sidebar | Self::Split | Self::TabGroup => Depth::Flat,
2633 // Flat, and it inherits. A group says its contents belong together
2634 // and says nothing about the surface they sit on, so a group in a
2635 // pane is in a well and a group on the page is on the page. An app
2636 // wanting one lifted puts it in a `Pane`.
2637 Self::Group => Depth::Flat,
2638 // Flat, and it is the container rather than the columns. Each
2639 // column is its own region and brings its own depth; a well here
2640 // would put a second edge around a row of wells.
2641 Self::Columns => Depth::Flat,
2642 // A pane is looked into, the same as a table body or a tag tree.
2643 Self::Pane => Depth::Well,
2644 Self::Modal => Depth::Raised,
2645 // Flat because it inherits: a bespoke region takes the depth of
2646 // whatever frames it. An app that wants its timeline in a well puts
2647 // it in a `Pane`, which composes rather than adding a knob here.
2648 //
2649 // A widget inherits for the same reason and it matters more here,
2650 // because a widget is drawn by whichever renderer recognises it. A
2651 // depth set here would be this crate deciding that a carousel is
2652 // raised on every host, which is the kind of value the deferral
2653 // rule exists to refuse.
2654 Self::Bespoke { .. } | Self::Widget { .. } => Depth::Flat,
2655 }
2656 }
2657
2658 /// Whether this crate can say anything about the region's contents.
2659 ///
2660 /// A renderer walks the description and hands every region it understands
2661 /// to the right drawing code. This is how it tells the two apart, and the
2662 /// reason it is a method rather than a `matches!` at each renderer: there
2663 /// is exactly one opaque member and there should stay exactly one.
2664 ///
2665 /// [`Widget`](Self::Widget) is described, and that is the whole of what
2666 /// separates it from [`Bespoke`](Self::Bespoke) here. Both carry a name
2667 /// this crate never interprets; only one of them carries contents under it.
2668 /// A renderer that does not recognise a widget's name still walks its body,
2669 /// so there is nothing for it to hand over and nothing it cannot draw.
2670 #[must_use]
2671 pub const fn described(self) -> bool {
2672 !matches!(self, Self::Bespoke { .. })
2673 }
2674
2675 /// The name an app gave this region, if it gave one.
2676 ///
2677 /// [`Bespoke`](Self::Bespoke) and [`Widget`](Self::Widget) are the two
2678 /// members that carry a name, for two different purposes: one says what the
2679 /// app will fill the space with, the other says what the assembly under it
2680 /// is called. A renderer dispatching on either wants the string without
2681 /// caring which member it came from, and writing that `matches!` at each
2682 /// renderer is how the two drift apart.
2683 #[must_use]
2684 pub const fn name(self) -> Option<&'a str> {
2685 match self {
2686 Self::Bespoke { name } | Self::Widget { name } => Some(name),
2687 // Spelled out rather than a wildcard, so a member added later has
2688 // to answer whether it carries a name instead of inheriting `None`
2689 // by sitting under a `_`.
2690 Self::Band
2691 | Self::Sidebar
2692 | Self::Pane
2693 | Self::Group
2694 | Self::Split
2695 | Self::Columns
2696 | Self::TabGroup
2697 | Self::Modal => None,
2698 }
2699 }
2700}
2701
2702/// How many of a region's children are visible at once.
2703///
2704/// `4dcd241b`. Three findings turned out to be one sentence the vocabulary
2705/// could not say: *this region holds several children and shows some of them,
2706/// and the reader can change which.* [`Region::TabGroup`] existed with nothing
2707/// saying which tab was open, a carousel had nothing saying which frame was up,
2708/// and a disclosure had nothing saying whether its one child was showing at all.
2709///
2710/// Because the fact lived nowhere, a renderer had two moves: hardcode a widget
2711/// name, or draw every child. That is what put per-widget code in renderers, and
2712/// it was the missing member rather than the widget tier that put it there.
2713///
2714/// # What is here and what is not
2715///
2716/// The *kind*, and only the kind. Which child is currently up is the current
2717/// answer, and a layer that defers every address does not hold the current
2718/// answer either — the split [`Selector`] already makes, where this crate says
2719/// what kind of chooser a thing is and the router says which option is picked.
2720/// So a holder of regions carries the index and the per-child label beside this.
2721///
2722/// # What a renderer does with it
2723///
2724/// Derives its chrome, once, for every widget rather than per name:
2725///
2726/// - Children carrying labels get a strip of the labels, the current one marked.
2727/// - Children carrying none get previous, position, next.
2728/// - [`AtMostOne`](Self::AtMostOne) over one child gets a summary line that
2729/// opens.
2730///
2731/// The name on [`Region::Widget`] survives as app vocabulary, for a renderer
2732/// that wants to do something *special* with one, which is what it should have
2733/// been from the start.
2734///
2735/// Degradation runs the way it already did: a renderer ignoring this draws every
2736/// child, which is more content rather than less.
2737#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
2738#[non_exhaustive]
2739pub enum Showing {
2740 /// Every child, in order. What every region did before this existed.
2741 #[default]
2742 All,
2743 /// Exactly one. A carousel, a tab group.
2744 One,
2745 /// One, or none. A disclosure, which is closed until it is opened.
2746 AtMostOne,
2747}
2748
2749impl Showing {
2750 /// Whether the reader can change which child is up.
2751 ///
2752 /// The question every renderer's region arm asks before deriving any
2753 /// chrome, and a method rather than a `matches!` at each renderer for
2754 /// [`Region::name`]'s reason: three renderers writing the same comparison is
2755 /// how they come to disagree about a member added later.
2756 #[must_use]
2757 pub const fn selective(self) -> bool {
2758 !matches!(self, Self::All)
2759 }
2760
2761 /// Whether showing nothing is a legal state.
2762 ///
2763 /// True only for [`AtMostOne`](Self::AtMostOne). A renderer needs this to
2764 /// know whether its control closes as well as moves: a carousel's row moves
2765 /// between frames and never reaches empty, and a disclosure's summary line
2766 /// is the same control wearing its closed state.
2767 #[must_use]
2768 pub const fn dismissible(self) -> bool {
2769 matches!(self, Self::AtMostOne)
2770 }
2771}
2772
2773/// A window onto a sequence: where it starts, how much it covers, and how long
2774/// the sequence is when that is known.
2775///
2776/// The mechanism under two things the vocabulary deliberately keeps apart. A
2777/// carousel is a window of one frame over children that are all present; a
2778/// paged list is a window of a page over rows most of which were never fetched.
2779/// Those are different facts and they stay different types — [`Showing`] says
2780/// which child is up, [`Paging`] says where a reader is in a query — but the
2781/// arithmetic underneath is one piece of code, so a terminal and a browser
2782/// cannot come to disagree about which frame is last.
2783///
2784/// # Why `of` is optional and `count` is not
2785///
2786/// `count` is what is on screen and is therefore always known. `of` is the
2787/// length of the thing being windowed, and a host that cannot count says so by
2788/// leaving it empty **for the life of the screen**. It is never "not counted
2789/// yet": see "First paint is final paint" in the crate header. A total that
2790/// turns up on a later pass widens the text that prints it.
2791///
2792/// # Clamping
2793///
2794/// Every derivation clamps rather than refusing, and a zero `count` answers
2795/// `None` rather than dividing. A window past the end is a bug in the host, and
2796/// a renderer that answered it by drawing nothing would report a region that
2797/// vanished, which is the hardest kind of bug to find from what is on screen.
2798/// [`Share::percent`] clamps for the same reason.
2799#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
2800pub struct Window {
2801 /// The index into the sequence where the window starts.
2802 pub from: usize,
2803 /// How many the window covers. One, for a carousel.
2804 pub count: usize,
2805 /// How long the sequence is, when the host can say.
2806 pub of: Option<usize>,
2807}
2808
2809impl Window {
2810 /// A window of `count`, starting at `from`, over a sequence of unknown
2811 /// length.
2812 #[must_use]
2813 pub const fn new(from: usize, count: usize) -> Self {
2814 Self {
2815 from,
2816 count,
2817 of: None,
2818 }
2819 }
2820
2821 /// How long the sequence is.
2822 #[must_use]
2823 pub const fn of(mut self, of: usize) -> Self {
2824 self.of = Some(of);
2825 self
2826 }
2827
2828 /// One item of a sequence whose length is known. A carousel frame.
2829 #[must_use]
2830 pub const fn frame(at: usize, of: usize) -> Self {
2831 Self {
2832 from: at,
2833 count: 1,
2834 of: Some(of),
2835 }
2836 }
2837
2838 /// Which window this is, counting from zero.
2839 ///
2840 /// `None` when `count` is zero, which is the only input with no answer
2841 /// rather than a clamped one.
2842 #[must_use]
2843 pub const fn index(self) -> Option<usize> {
2844 if self.count == 0 {
2845 return None;
2846 }
2847 Some(self.from / self.count)
2848 }
2849
2850 /// How many windows the sequence holds.
2851 ///
2852 /// `None` unless both the length and a non-zero `count` are known. A
2853 /// partial answer here would be a renderer drawing "of 0".
2854 #[must_use]
2855 pub const fn windows(self) -> Option<usize> {
2856 match self.of {
2857 Some(of) if self.count > 0 => Some(of.div_ceil(self.count)),
2858 _ => None,
2859 }
2860 }
2861
2862 /// Whether anything sits before this window.
2863 #[must_use]
2864 pub const fn has_before(self) -> bool {
2865 self.from > 0
2866 }
2867
2868 /// How many sit after this window, when the length is known.
2869 ///
2870 /// Here rather than in each renderer for [`Showing::selective`]'s reason:
2871 /// three of them writing the same subtraction is how they come to disagree,
2872 /// and this one has an underflow in it for whoever writes it fourth.
2873 #[must_use]
2874 pub const fn after(self) -> Option<usize> {
2875 match self.of {
2876 Some(of) => Some(of.saturating_sub(self.from.saturating_add(self.count))),
2877 None => None,
2878 }
2879 }
2880
2881 /// Whether anything sits after it.
2882 ///
2883 /// `true` when the length is unknown: a host that cannot count cannot rule
2884 /// out more, and offering a way forward that turns out to be empty is the
2885 /// cheaper of the two mistakes.
2886 #[must_use]
2887 pub const fn has_after(self) -> bool {
2888 match self.of {
2889 Some(of) => self.from.saturating_add(self.count) < of,
2890 None => true,
2891 }
2892 }
2893
2894 /// The window with `from` brought inside the sequence.
2895 ///
2896 /// A no-op when the length is unknown, since there is nothing to clamp
2897 /// against.
2898 #[must_use]
2899 pub const fn clamped(mut self) -> Self {
2900 if let Some(of) = self.of
2901 && self.from >= of
2902 {
2903 // `max(1)` by hand: `Ord::max` is not const yet, and a zero-count
2904 // window would otherwise clamp onto the end rather than inside it.
2905 let step = if self.count == 0 { 1 } else { self.count };
2906 self.from = of.saturating_sub(step);
2907 }
2908 self
2909 }
2910}
2911
2912/// Where a reader is in a set that arrived in parts.
2913///
2914/// A [`Window`] wearing the paged reading of itself. Distinct from a carousel's
2915/// window at the top level on purpose, because the intent differs and a call
2916/// site should say which one it means, while the arithmetic below is shared so
2917/// the two cannot drift apart.
2918///
2919/// # The two idioms, and which one a renderer may draw
2920///
2921/// Load-more and numbered pages are both this type. Which is honest is
2922/// [`paged`](Self::paged): a set whose page size is known can be drawn as
2923/// "Page 3 of 8", and one without can only be drawn as "150 of 400" and a way
2924/// forward. Saying it here rather than letting each renderer guess is the point
2925/// — three renderers inferring it from the numbers is how they come to disagree.
2926///
2927/// # What it does not carry
2928///
2929/// No addresses. `makeover-layout` cannot name an action, and the way to ask for
2930/// the next part is the host's: `quasi_router` pairs this with the addresses the
2931/// same way `Row` pairs its parts with `Row::activate`. That split is the reason
2932/// this type is reusable by a carousel, which has nothing to ask.
2933#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
2934pub struct Paging {
2935 /// The window onto the set.
2936 pub window: Window,
2937 /// Whether the parts are a fixed size, and so whether pages are countable.
2938 ///
2939 /// `false` for load-more, where the window simply grew and "page 2" would
2940 /// name nothing.
2941 pub paged: bool,
2942}
2943
2944impl Paging {
2945 /// A page of `per`, starting at `from`.
2946 #[must_use]
2947 pub const fn pages(from: usize, per: usize) -> Self {
2948 Self {
2949 window: Window::new(from, per),
2950 paged: true,
2951 }
2952 }
2953
2954 /// The first `shown`, with more behind them.
2955 ///
2956 /// The load-more shape: the window starts at the beginning and grows, so
2957 /// there is no page to number.
2958 #[must_use]
2959 pub const fn more(shown: usize) -> Self {
2960 Self {
2961 window: Window::new(0, shown),
2962 paged: false,
2963 }
2964 }
2965
2966 /// How many there are altogether.
2967 ///
2968 /// Left unsaid by a host that cannot count, and left unsaid **for good**:
2969 /// a total arriving later widens whatever prints it. See "First paint is
2970 /// final paint" in the crate header.
2971 #[must_use]
2972 pub const fn of(mut self, of: usize) -> Self {
2973 self.window = self.window.of(of);
2974 self
2975 }
2976
2977 /// Which page this is, counting from one, when pages are countable.
2978 ///
2979 /// One-based because it is read aloud. [`Window::index`] is the zero-based
2980 /// form for anyone indexing with it.
2981 #[must_use]
2982 pub const fn page(self) -> Option<usize> {
2983 if !self.paged {
2984 return None;
2985 }
2986 match self.window.index() {
2987 Some(index) => Some(index + 1),
2988 None => None,
2989 }
2990 }
2991
2992 /// How many pages there are, when that is countable.
2993 #[must_use]
2994 pub const fn pages_total(self) -> Option<usize> {
2995 if !self.paged {
2996 return None;
2997 }
2998 self.window.windows()
2999 }
3000
3001 /// How many are on screen.
3002 #[must_use]
3003 pub const fn shown(self) -> usize {
3004 self.window.count
3005 }
3006
3007 /// How many there are, when the host counted.
3008 #[must_use]
3009 pub const fn total(self) -> Option<usize> {
3010 self.window.of
3011 }
3012
3013 /// How many are not shown yet, when the host counted.
3014 ///
3015 /// The figure a load-more control puts in its label. `None` is the honest
3016 /// and common case: a set that cannot say how many more there are still has
3017 /// a way to ask for them.
3018 #[must_use]
3019 pub const fn remaining(self) -> Option<usize> {
3020 self.window.after()
3021 }
3022
3023 /// Whether there is anything further on.
3024 #[must_use]
3025 pub const fn has_more(self) -> bool {
3026 self.window.has_after()
3027 }
3028
3029 /// Whether there is anything back the other way.
3030 #[must_use]
3031 pub const fn has_previous(self) -> bool {
3032 self.window.has_before()
3033 }
3034}
3035
3036/// How much of the width an arrangement's first region takes.
3037///
3038/// `e0fd485e`. Nothing said how much room a region got, so every renderer
3039/// invented its own number and two hosts showing one screen disagreed about
3040/// its proportions. A webview never noticed, because the stylesheet answered
3041/// once for every consumer; a terminal has no stylesheet to inherit from, so
3042/// `quasi-tui` picked 24 columns for a sidebar and 40% for a list pane and
3043/// neither had anything behind it.
3044///
3045/// # A proportion, never a unit
3046///
3047/// Held as a percentage, and that is the only form it comes in. A description
3048/// carrying columns would be describing a terminal and one carrying pixels a
3049/// webview, and the whole point is that both honour the same fact: a terminal
3050/// resolves it against a column count, a webview writes it into a grid, and
3051/// neither has to know what the other did.
3052///
3053/// It is not [`makeover_geometry::Ratio`]'s job either, which was the first
3054/// guess. Geometry is scales that answer the same for every screen and takes
3055/// no input that would let a sidebar screen differ from a list-detail one.
3056///
3057/// [`makeover_geometry::Ratio`]: https://docs.rs/makeover-geometry
3058#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord)]
3059pub struct Share(u8);
3060
3061impl Share {
3062 /// What a sidebar takes, when nobody says otherwise.
3063 ///
3064 /// A quarter. `quasi-tui` drew 24 columns, which is a quarter of a
3065 /// 96-column terminal and about a fifth of a wide one; a quarter is that
3066 /// number said in the form a webview can honour too.
3067 pub const SIDEBAR: Self = Self(25);
3068
3069 /// What the list side of a list-detail takes, when nobody says otherwise.
3070 ///
3071 /// `quasi-tui`'s 40%, which was already a proportion and is the one number
3072 /// this member did not have to invent.
3073 pub const LIST: Self = Self(40);
3074
3075 /// A share of the width, as a percentage.
3076 ///
3077 /// Clamped to 5..=95 rather than refused. A description that asked for a
3078 /// region of nothing is a bug in the app, and a renderer drawing a region
3079 /// zero cells wide reports it as a region that vanished, which is the
3080 /// hardest kind of bug to find from what is on the screen.
3081 #[must_use]
3082 pub const fn percent(percent: u8) -> Self {
3083 Self(if percent < 5 {
3084 5
3085 } else if percent > 95 {
3086 95
3087 } else {
3088 percent
3089 })
3090 }
3091
3092 /// The share as a percentage.
3093 #[must_use]
3094 pub const fn as_percent(self) -> u8 {
3095 self.0
3096 }
3097
3098 /// This share of a width, rounded to the nearest whole unit.
3099 ///
3100 /// What a terminal calls to turn the proportion into columns. At least one,
3101 /// because a region the description named should be visible: a screen
3102 /// 3 columns wide is unusable either way, and a sidebar that is there is a
3103 /// truer picture of the description than a sidebar that is not.
3104 #[must_use]
3105 pub const fn of(self, whole: u16) -> u16 {
3106 let taken = (whole as u32 * self.0 as u32).div_ceil(100);
3107 if taken == 0 { 1 } else { taken as u16 }
3108 }
3109}
3110
3111/// How a screen is laid out.
3112///
3113/// Two, and the second is not a variant of the first. goingson is list-detail,
3114/// Balanced Breakfast is sidebar plus content, and neither app has a third.
3115/// The tab group is a modifier rather than a member, because goingson uses it
3116/// *inside* the same content region rather than instead of one.
3117///
3118/// This exists at all because the router has to be able to express a screen
3119/// rather than only a control. Discovering the arrangement layer missing after
3120/// the renderers exist is a redesign; naming two now is a morning.
3121///
3122/// # Why the share rides here
3123///
3124/// `e0fd485e`. A share is per-arrangement: how much a sidebar takes and how
3125/// much a list side takes are different questions, and this enum is the only
3126/// thing that knows which one is being asked. Geometry would have had to invent
3127/// a channel to be told.
3128///
3129/// [`list_detail`](Self::list_detail) and
3130/// [`sidebar_content`](Self::sidebar_content) build these with the default
3131/// shares, so a screen that has no opinion does not have to have one.
3132#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
3133pub enum Arrangement {
3134 /// A list that chooses what the detail beside it shows.
3135 ListDetail {
3136 /// Whether the detail side is a [`Region::TabGroup`].
3137 tabbed: bool,
3138 /// How much of the width the list side takes.
3139 share: Share,
3140 },
3141 /// Navigation down the side, content filling the rest.
3142 SidebarContent {
3143 /// How much of the width the sidebar takes.
3144 share: Share,
3145 },
3146}
3147
3148impl Arrangement {
3149 /// A list and a detail beside it, at the default share.
3150 #[must_use]
3151 pub const fn list_detail(tabbed: bool) -> Self {
3152 Self::ListDetail {
3153 tabbed,
3154 share: Share::LIST,
3155 }
3156 }
3157
3158 /// A sidebar and content beside it, at the default share.
3159 #[must_use]
3160 pub const fn sidebar_content() -> Self {
3161 Self::SidebarContent {
3162 share: Share::SIDEBAR,
3163 }
3164 }
3165
3166 /// How much of the width the first region takes.
3167 #[must_use]
3168 pub const fn share(self) -> Share {
3169 match self {
3170 Self::ListDetail { share, .. } | Self::SidebarContent { share } => share,
3171 }
3172 }
3173
3174 /// The same arrangement, at this share.
3175 #[must_use]
3176 pub const fn with_share(self, share: Share) -> Self {
3177 match self {
3178 Self::ListDetail { tabbed, .. } => Self::ListDetail { tabbed, share },
3179 Self::SidebarContent { .. } => Self::SidebarContent { share },
3180 }
3181 }
3182}
3183
3184/// How wide the content of a whole screen runs.
3185///
3186/// `0eccff0d`, and [`Share`]'s sibling one level up: that one says how a
3187/// screen's width is divided between regions, this says how much of the window
3188/// the screen uses in the first place. Both are the description's, which is
3189/// what answering the two together settled.
3190///
3191/// Measured in the MNW server, where 69 of 72 templates carry exactly one of
3192/// three mutually exclusive classes and the choice is per screen. GoingsOn
3193/// reaches for `max-width` 56 times and Balanced Breakfast 12, neither with a
3194/// token for it, so three apps were solving one thing by hand.
3195///
3196/// # Named for the measure, not for MNW's classes
3197///
3198/// A renderer that is not a browser has to answer this too, and `padded-page`
3199/// tells a terminal nothing. The three say how wide the text runs, which is a
3200/// question every renderer can answer: a webview with a `max-width`, a terminal
3201/// with gutters, an immediate-mode frame with its own width.
3202///
3203/// `#[non_exhaustive]` for [`Fill`]'s reason. The set is closed today because
3204/// the measurement found three, and a fourth arriving should not be a lockstep
3205/// release across nine repos.
3206#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
3207#[non_exhaustive]
3208pub enum Measure {
3209 /// The whole width, with gutters. The default, and 53 of the 69.
3210 ///
3211 /// What a dashboard, a table and a settings screen want: the content is
3212 /// wide because the content *is* wide, and constraining it would waste the
3213 /// window.
3214 #[default]
3215 Wide,
3216 /// Capped at a comfortable page width, centred. 13 of the 69.
3217 ///
3218 /// A form, a sign-in, a purchase. Content that does not get better by
3219 /// getting wider, but is not prose either.
3220 Contained,
3221 /// Capped at a line length that reads well. 3 of the 69.
3222 ///
3223 /// Prose. The narrowest of the three, and the one with a reason outside
3224 /// taste: a line of text past roughly 75 characters costs the reader the
3225 /// return sweep.
3226 Reading,
3227}
3228
3229impl Measure {
3230 /// A stable name, for a renderer that needs to spell it.
3231 ///
3232 /// Here rather than in each renderer for [`Sort::as_str`]'s reason: three
3233 /// renderers spelling one enum is three chances to spell it differently.
3234 #[must_use]
3235 pub const fn as_str(self) -> &'static str {
3236 match self {
3237 Self::Wide => "wide",
3238 Self::Contained => "contained",
3239 Self::Reading => "reading",
3240 }
3241 }
3242}
3243
3244/// What kind of value a form field takes.
3245///
3246/// The union of the two vocabularies that diverged, which is what triggered
3247/// this crate. They have since converged on their own: both apps now have a
3248/// `renderFormField` emitting the same anatomy, and what is left differing is
3249/// the kind set, the error shape, and whether the return is a string or a node.
3250///
3251/// Validation is deliberately absent. Neither app has a shared story (goingson
3252/// validates after collecting the form data, with per-field transform hooks;
3253/// Balanced Breakfast has `required` and nothing else), and a schema that
3254/// describes fields but not constraints acquires a constraint layer per app,
3255/// which is exactly how the current divergence started. Naming it absent is a
3256/// decision; leaving it unmentioned would not be.
3257/// `#[non_exhaustive]` for the reason [`Fill`] is: renderers match on this and
3258/// the set keeps growing, so growth must not be a lockstep event. Email, Url
3259/// and Tel arriving in 0.5.0 is the second growth in two releases.
3260#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
3261#[non_exhaustive]
3262pub enum FieldKind {
3263 /// A single line of text.
3264 Text,
3265 /// A single line of text that must never be echoed, logged or round-tripped
3266 /// through anything that might persist it.
3267 Secret,
3268 /// A number.
3269 Number,
3270 /// A number inside bounds the user drags across, where the range being
3271 /// visible is the point.
3272 ///
3273 /// Not [`Number`](Self::Number) with [`min`](Field::min) and
3274 /// [`max`](Field::max), which is the reading to resist and is the same
3275 /// resistance [`Radio`](Self::Radio) needed against `Select`. A bounded
3276 /// number and a validated number are different *questions*. A validated
3277 /// number is typed and can be wrong: the bounds are a rule the answer is
3278 /// checked against, and being told "must be at least 1" afterwards is the
3279 /// normal course of it. A range cannot be out of range at all, because the
3280 /// bounds are the control's extent rather than a rule, and the two ends are
3281 /// what the question means — audiofiles asks for a classifier threshold
3282 /// between 0 and 1, where 0 is never and 1 is only-on-certainty, and a typed
3283 /// 0.72 says nothing without both ends on screen beside it.
3284 ///
3285 /// A renderer cannot infer which one is meant from `min`/`max` alone, which
3286 /// is why this is a kind and not an inference: goingson's `min="1"` duration
3287 /// is a validated number and would become a slider.
3288 ///
3289 /// The membership test passes without stretching: a webview emits
3290 /// `<input type="range">`, egui has `Slider`, a terminal draws a bar and
3291 /// takes arrow keys, a CLI takes a bounded argument.
3292 ///
3293 /// # It owes its bounds
3294 ///
3295 /// [`min`](Field::min) and [`max`](Field::max) are `Option` for every other
3296 /// kind and are **required** here, in the sense the description can require
3297 /// anything: [`Field::bounded`] is the check, and a range missing one has no
3298 /// extent for a renderer to draw. What a renderer does with an unbounded
3299 /// range is its own call and both answers are honest — fall back to a typed
3300 /// number, or pick a host default — so this is stated rather than enforced,
3301 /// the way every other constraint here is.
3302 ///
3303 /// [`Field::step`] is the third fact and is genuinely optional: absent, the
3304 /// host's own granularity stands.
3305 ///
3306 /// Added 0.28.0, from audiofiles' classifier thresholds and storage cap
3307 /// picker (`fb93426b`), where four sliders were hand-rolled against a
3308 /// vocabulary that could not say what they were.
3309 Range,
3310 /// One question with two ends: a lower value and an upper one, submitted
3311 /// under two names.
3312 ///
3313 /// "Show me samples between 90 and 130 BPM" has a single answer with two
3314 /// ends, and the ends constrain each other: a minimum above the maximum is
3315 /// not a wrong value, it is an empty result nobody asked for. Described as
3316 /// two [`Number`](Self::Number) fields that is unsayable — nothing says they
3317 /// are one question, so a renderer draws two controls with two labels and no
3318 /// relationship, and [`Field::error`] can only be attached to one side of a
3319 /// fault that belongs to both.
3320 ///
3321 /// Not [`Range`](Self::Range), which was the reading to resist and the
3322 /// resistance is the same one `Range` itself needed against `Number`. A
3323 /// range describes *one* value inside an extent; this describes two, and the
3324 /// extent is a bound on each rather than the question's meaning. The two
3325 /// come apart in the answer: a range has a value, an interval has a pair,
3326 /// and either end may be absent while the other stands.
3327 ///
3328 /// # It states both names
3329 ///
3330 /// [`Field::name`] is the lower end and [`Field::upper_name`] is the upper
3331 /// one, stated rather than derived. Measured 2026-08-21, the two sites in
3332 /// this tree disagree about affix order — audiofiles submits `bpm_min` /
3333 /// `bpm_max` and the MNW server submits `min_price` / `max_price` — so any
3334 /// derived rule picks one and renames the other's parameters. One member
3335 /// instead of a naming convention this crate would then own forever.
3336 ///
3337 /// Direction is carried by which member the name sits in, so nothing
3338 /// separate says which end is which.
3339 ///
3340 /// # What it does not enforce
3341 ///
3342 /// The crossing rule. A lower end above the upper one is describable here
3343 /// and always was, exactly as an out-of-[`min`](Field::min) number is: this
3344 /// crate carries constraints and never checks them, and deciding a value is
3345 /// wrong stays with whoever validated. What the description buys is that the
3346 /// fault now has one place to be reported rather than two.
3347 ///
3348 /// # Both ends take the same facts
3349 ///
3350 /// [`min`](Field::min), [`max`](Field::max), [`step`](Field::step) and
3351 /// [`unit`](Field::unit) describe the axis rather than one end of it, so
3352 /// they are read once and applied to both. Six of audiofiles' filter axes
3353 /// are exactly this: one extent, one unit, one granularity, two ends.
3354 ///
3355 /// The bounds are optional here, unlike `Range`. They are a rule the answer
3356 /// is checked against rather than the control's extent, which is
3357 /// [`Number`](Self::Number)'s arrangement and not a slider's.
3358 ///
3359 /// Added 0.34.0, ruled by Max 2026-08-21, from audiofiles' six filter axes
3360 /// and the MNW server's price pair.
3361 Interval,
3362 /// An email address.
3363 ///
3364 /// Distinct from [`Text`](Self::Text) because the distinction is not
3365 /// decoration: a webview renderer emits `type="email"`, which on a touch
3366 /// device changes the keyboard that appears and turns on the platform's own
3367 /// validation. goingson ships to iOS, so collapsing this into text costs a
3368 /// keyboard with no `@` on it.
3369 ///
3370 /// Added 0.5.0, from goingson's contact form.
3371 Email,
3372 /// A URL. Same reasoning as [`Email`](Self::Email).
3373 ///
3374 /// Added 0.5.0, from goingson's contact-social and contact-feed forms.
3375 Url,
3376 /// A telephone number. Same reasoning as [`Email`](Self::Email), and the
3377 /// clearest case of it: the keyboard is a numeric pad rather than letters.
3378 ///
3379 /// Added 0.5.0, from goingson's contact-phone form.
3380 Tel,
3381 /// A calendar day, with no time of day in it.
3382 ///
3383 /// [`Email`](Self::Email)'s argument, and it carries further: a webview
3384 /// emits `type="date"`, which is a native picker, the platform's own
3385 /// validation, and on a touch device the date keyboard. Described as
3386 /// [`Text`](Self::Text) with a hint reading "YYYY-MM-DD", all three are
3387 /// lost and the hint is doing the platform's job in prose.
3388 ///
3389 /// The membership test passes on every host without stretching: a webview
3390 /// and a Tauri app emit the input, egui has a date picker, a terminal
3391 /// prompts for a day and can validate it, a CLI takes an argument.
3392 ///
3393 /// # The value is ISO 8601, `YYYY-MM-DD`
3394 ///
3395 /// Named here rather than left to each host, because a host that picks
3396 /// differently sends a server something it parses differently, and the
3397 /// failure is silent and per-host. It is `<input type="date">`'s own wire
3398 /// format, so the webview renderer owes nothing to honour it and the other
3399 /// hosts have one spelling to meet. [`DATE_FORMAT`] is the constant, and a
3400 /// test asserts this doc and that constant agree.
3401 ///
3402 /// Added 0.15.0, from the MNW server's git access-token expiry
3403 /// (`user_ssh_keys_tab.html`) and six further sites across the server and
3404 /// goingson.
3405 Date,
3406 /// A calendar day and a time of day together.
3407 ///
3408 /// Apart from [`Date`](Self::Date) because the question is different rather
3409 /// than more precise: "which day does this expire" and "at what moment does
3410 /// this publish" are asked by different screens and answered by different
3411 /// controls. A webview emits `type="datetime-local"` for one and
3412 /// `type="date"` for the other, and a host that collapsed them would ask
3413 /// half the tree for a precision it does not want.
3414 ///
3415 /// Both arrived together on measurement rather than on symmetry: 13 sites
3416 /// of each across the MNW server and goingson, and **zero** of `time`,
3417 /// `month` or `week`, which is why those are not here. A member added for a
3418 /// case nobody has is a member designed against nothing, which is
3419 /// [`File`](Self::File)'s reasoning about `accept` applied to a whole
3420 /// member.
3421 ///
3422 /// # The value is `YYYY-MM-DDTHH:MM`, local, with no zone
3423 ///
3424 /// `<input type="datetime-local">`'s own format, and the "local" is the
3425 /// load-bearing half: the value carries no offset and no `Z`, so the moment
3426 /// it names is only fixed once something supplies a zone. That is the app's
3427 /// business and not the description's. Seconds are absent, which is the
3428 /// browser's own default and is left as the rule rather than restated as a
3429 /// constraint. [`DATETIME_FORMAT`] is the constant.
3430 ///
3431 /// [`Field::min`] and [`Field::max`] already take "the host's own spelling
3432 /// of a bound", so a floor of *not in the past* needs nothing new here: it
3433 /// is a string in this same format.
3434 ///
3435 /// Added 0.15.0, from goingson's snooze picker and day planner and the MNW
3436 /// server's publish-at fields.
3437 DateTime,
3438 /// Several lines of text.
3439 Textarea,
3440 /// Several lines of text the user writes markdown in.
3441 ///
3442 /// The editing counterpart of prose a description carries as markdown
3443 /// source, and the reason it can exist at all is the same one that lets the
3444 /// source be carried: editing markdown is editing text, so a terminal, an
3445 /// immediate-mode host and a webview all have an honest answer, and none of
3446 /// them has to refuse. A kind that meant "rich text" in the WYSIWYG sense
3447 /// would have been a document model, and two of the three hosts would have
3448 /// had to draw something they cannot.
3449 ///
3450 /// What the mark buys over [`Textarea`](Self::Textarea) is that a renderer
3451 /// may offer the affordances markdown has and plain text does not — a
3452 /// preview, a syntax pass, a monospaced face for the source — and that a
3453 /// host reading the value back knows what it is holding. A renderer with
3454 /// none of that draws a textarea, which is why this is additive rather than
3455 /// a second control.
3456 ///
3457 /// It says nothing about **when** the value is saved. Autosave is a clock,
3458 /// clocks are not described here, and the four MNW editors this was measured
3459 /// against each keep their own.
3460 ///
3461 /// Sanitising stays where it already is for markdown that is only displayed:
3462 /// with the renderer, at the point markup is produced. Being described is
3463 /// not a safety property, and a host with its own sanitiser and its own
3464 /// content-security posture still owns both.
3465 ///
3466 /// Added 0.30.0, `f8ad0b32`, from four hand-written MNW section editors —
3467 /// `project-sections.js`, `blog-editor.js`, `partial-item-text-editor.js`
3468 /// and `wizard-item-sections.js` — which are one shape written four times.
3469 Rich,
3470 /// One of a fixed set, offered behind a control that shows one at a time.
3471 Select,
3472 /// One of a fixed set, with every option on screen at once.
3473 ///
3474 /// Not a presentation of [`Select`](Self::Select), which is the reading to
3475 /// resist: what differs is a property of the *question*. A choice that is
3476 /// consequential or irreversible has to be readable without opening
3477 /// anything, because a closed control shows one option and hides the rest,
3478 /// and the one it shows is whichever was current before the user had read
3479 /// the alternatives. audiofiles asks whether a library copies samples into
3480 /// its store or references them where they lie — which cannot be changed
3481 /// afterwards — and had already promoted that out of a checkbox by hand,
3482 /// with a comment giving this reason, before the description could say it.
3483 ///
3484 /// It was described here at 0.8.1 as "the one HTML input type this enum was
3485 /// missing", which was not true then and is not true now: `file` arrived at
3486 /// 0.11.0 and `date` and `datetime-local` at 0.15.0. Everything here is
3487 /// still an `<input type=...>`, a `<select>` or a `<textarea>`, and the way
3488 /// this enum grows is by a site being measured rather than by a list being
3489 /// completed, so "the last one" is not a claim it should make again.
3490 ///
3491 /// Added 0.8.1, from audiofiles' Add Library form.
3492 Radio,
3493 /// On or off.
3494 Checkbox,
3495 /// A file the user picks from wherever the host keeps files.
3496 ///
3497 /// Added 0.11.0, `844b5ae0`, from goingson's project-dashboard attachments
3498 /// column. It was filed as a router finding — a control whose destination is
3499 /// a host capability rather than an address — and splitting it is what made
3500 /// it two answers instead of one member satisfying neither. *Opening* a file
3501 /// is a one-way handoff and needs no new API. *Picking* one returns a value
3502 /// into a write, which is a form concern, which is this.
3503 ///
3504 /// The membership test passes on every host and not by a stretch: a Tauri
3505 /// app opens a native picker, a server renders `<input type="file">`, a
3506 /// terminal prompts for a path, a CLI takes an argument. That is closer to
3507 /// [`Email`](Self::Email), which exists because it changes the keyboard,
3508 /// than to anything bespoke.
3509 ///
3510 /// # The four things an upload says, and where each of them lives
3511 ///
3512 /// | axis | where |
3513 /// |---|---|
3514 /// | what it accepts | [`Field::accept`] |
3515 /// | one file or several | [`Field::multiple`] |
3516 /// | where the bytes go | the router's action, not here |
3517 /// | how far along it is | [`Awaiting`] on that action |
3518 ///
3519 /// Only the first two are this crate's, and that split is the answer to
3520 /// "describe an upload in full" rather than a gap in it. A destination is an
3521 /// address and this crate holds no addresses; progress is a live number and
3522 /// a description is built once, so the number is the renderer's to observe
3523 /// against the size [`Awaiting::amount`] carried before the transfer began.
3524 ///
3525 /// # How the file is handed over is the host's
3526 ///
3527 /// A drop area, a button opening a native picker, a path typed at a prompt:
3528 /// all three are the same field, and every measured site has the first. It
3529 /// is not described for the reason no gesture is — this crate owns no
3530 /// coordinates and no pointer, and a terminal that cannot be dropped on
3531 /// would be refusing a description it can otherwise honour completely.
3532 ///
3533 /// The first two were absent until 0.31.0, and the doc here said why: they
3534 /// were measured rather than deferred, `accept` appearing at zero sites in
3535 /// either app. The count was taken over goingson and Balanced Breakfast, and
3536 /// the MNW server is a third consumer with 14 of them. A member designed
3537 /// against nothing is still the rule; the measurement is what changed.
3538 File,
3539 /// Carried through the form and never shown.
3540 Hidden,
3541}
3542
3543/// The wire format a [`FieldKind::Date`] value takes: ISO 8601, `YYYY-MM-DD`.
3544///
3545/// A constant rather than a sentence in a doc comment, because the reason to
3546/// name the format at all is that a host picking its own would fail silently
3547/// against a server parsing another. A host that cannot emit the native control
3548/// still has one spelling to meet, and can say which one it meant.
3549pub const DATE_FORMAT: &str = "%Y-%m-%d";
3550
3551/// The wire format a [`FieldKind::DateTime`] value takes: `YYYY-MM-DDTHH:MM`,
3552/// local, carrying no zone and no seconds.
3553///
3554/// [`DATE_FORMAT`]'s sibling and there for its reason. The absent zone is a
3555/// property of the value rather than an omission: the moment is not fixed until
3556/// something outside the description supplies one.
3557pub const DATETIME_FORMAT: &str = "%Y-%m-%dT%H:%M";
3558
3559impl FieldKind {
3560 /// Whether the value the kind takes is a moment rather than a string.
3561 ///
3562 /// Named once here for the reason [`offers_options`](Self::offers_options)
3563 /// is: two kinds answer yes, and a host that has to parse or format a value
3564 /// needs to ask without spelling the pair out at each renderer. A third
3565 /// temporal kind should land here and nowhere else.
3566 ///
3567 /// The format each one takes is [`DATE_FORMAT`] and [`DATETIME_FORMAT`].
3568 #[must_use]
3569 pub const fn temporal(self) -> bool {
3570 matches!(self, Self::Date | Self::DateTime)
3571 }
3572
3573 /// Whether the field is drawn at all.
3574 #[must_use]
3575 pub const fn visible(self) -> bool {
3576 !matches!(self, Self::Hidden)
3577 }
3578
3579 /// Whether the value must be kept out of logs and diagnostics.
3580 #[must_use]
3581 pub const fn confidential(self) -> bool {
3582 matches!(self, Self::Secret)
3583 }
3584
3585 /// Where the field's own label sits.
3586 ///
3587 /// A checkbox labels itself on the right of the box; everything else takes
3588 /// a label above. Both webview apps already do this and both special-case
3589 /// it inline, which is the tell that it belongs in the description.
3590 ///
3591 /// A [`Radio`](Self::Radio) is not one of them, and the near-miss is worth
3592 /// naming: its *options* each label themselves, but the field still asks a
3593 /// question above them, so the group takes a label like everything else.
3594 #[must_use]
3595 pub const fn labels_itself(self) -> bool {
3596 matches!(self, Self::Checkbox)
3597 }
3598
3599 /// Whether the kind reads [`Field::options`].
3600 ///
3601 /// Two kinds do, so the pair is named once here rather than spelled out at
3602 /// each renderer and again in [`Field::options`]' own doc, where "every
3603 /// kind but `Select`" was true for exactly one release. A third
3604 /// option-taking kind should land here and nowhere else.
3605 #[must_use]
3606 pub const fn offers_options(self) -> bool {
3607 matches!(self, Self::Select | Self::Radio)
3608 }
3609
3610 /// Whether the value runs to more than one line.
3611 ///
3612 /// Named once here for [`temporal`](Self::temporal)'s reason: two kinds
3613 /// answer yes, every renderer has to ask it before it can size anything,
3614 /// and a `matches!` per renderer is the pair drifting apart one member at a
3615 /// time. What a host does with the markdown, if anything, it reads from the
3616 /// kind itself; this is only whether one line is enough.
3617 #[must_use]
3618 pub const fn multiline(self) -> bool {
3619 matches!(self, Self::Textarea | Self::Rich)
3620 }
3621
3622 /// Whether the value is a file the host picks rather than a string typed
3623 /// into a box.
3624 ///
3625 /// One member answers yes, which is [`visible`](Self::visible)'s and
3626 /// [`confidential`](Self::confidential)'s footing rather than a departure
3627 /// from it: the question gets a name because three renderers ask it before
3628 /// they can read [`Field::accept`] or [`Field::multiple`], and a `matches!`
3629 /// per renderer is where a second file-taking kind would go missing.
3630 #[must_use]
3631 pub const fn takes_files(self) -> bool {
3632 matches!(self, Self::File)
3633 }
3634
3635 /// Whether the value is a quantity, so [`Field::unit`] means something.
3636 ///
3637 /// The numeric kinds and nothing else. A date is a quantity in the sense
3638 /// that it is ordered, and it is not one in the sense that matters here:
3639 /// its unit is fixed by the kind, so `Date` carrying `days` would be the
3640 /// description restating what [`kind`](Field::kind) already said.
3641 ///
3642 /// [`takes_files`](Self::takes_files)'s footing, and for its reason: the
3643 /// renderers ask this before they decide where a unit goes, and a
3644 /// `matches!` per renderer is where the next measurable kind goes missing.
3645 ///
3646 /// Added 0.33.0 with [`Field::unit`]. [`Interval`](Self::Interval) joined at
3647 /// 0.34.0: an axis is measured in something and both its ends are in it.
3648 #[must_use]
3649 pub const fn measurable(self) -> bool {
3650 matches!(self, Self::Number | Self::Range | Self::Interval)
3651 }
3652}
3653
3654/// A family of media a file can belong to.
3655///
3656/// Three members, because three is what a media type's own first segment offers
3657/// that a renderer can do anything with. `text` and `application` are families
3658/// too and neither buys a disclosure — there is no preview of an
3659/// `application/octet-stream` — so naming them would be a member added for a
3660/// case nobody has.
3661///
3662/// It is the answer to "which disclosure", not a validation rule.
3663/// [`Field::accept`] is what a host filters on.
3664#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
3665#[non_exhaustive]
3666pub enum Family {
3667 /// A still picture.
3668 Image,
3669 /// Sound.
3670 Audio,
3671 /// Moving pictures, with or without sound.
3672 Video,
3673}
3674
3675impl Family {
3676 /// The wildcard media type that means the whole family.
3677 ///
3678 /// `image/*` and its two siblings, which is what the measured sites write
3679 /// and what a webview puts in an `accept` attribute. Named here so the three
3680 /// renderers do not each spell the star.
3681 #[must_use]
3682 pub const fn wildcard(self) -> &'static str {
3683 match self {
3684 Self::Image => "image/*",
3685 Self::Audio => "audio/*",
3686 Self::Video => "video/*",
3687 }
3688 }
3689
3690 /// The family a media type's first segment names, if it is one of these.
3691 ///
3692 /// Case-insensitive on the segment, because a media type is
3693 /// case-insensitive and half the tree writes them lowercase by habit rather
3694 /// than by rule.
3695 #[must_use]
3696 pub fn of_type(media_type: &str) -> Option<Self> {
3697 let (top, _) = media_type.split_once('/')?;
3698 if top.eq_ignore_ascii_case("image") {
3699 Some(Self::Image)
3700 } else if top.eq_ignore_ascii_case("audio") {
3701 Some(Self::Audio)
3702 } else if top.eq_ignore_ascii_case("video") {
3703 Some(Self::Video)
3704 } else {
3705 None
3706 }
3707 }
3708}
3709
3710/// One entry in a file field's accept list.
3711///
3712/// Three shapes rather than a string, and all three are in the measured sites:
3713/// the MNW server writes `image/*`, `image/jpeg,image/png,image/webp`,
3714/// `.zip,.dmg,.exe,.appimage,.deb,.tar.gz,.clap,.vst3` and, in one place,
3715/// `.csv,text/csv`. A single string would carry all of them and answer nothing
3716/// about any of them.
3717///
3718/// # Why the list is not just a filter
3719///
3720/// It is read twice. Once to decide what the picker offers, which any of the
3721/// three shapes serves, and once to decide **which disclosure** the field gets:
3722/// a preview for a picture, a duration or a waveform for a sound. There is one
3723/// upload shape and a media upload is that shape with more of it shown, so the
3724/// accept list is what says which more. [`family`](Self::family) is that
3725/// question answered once here instead of a media-type parser in each renderer.
3726///
3727/// # A suffix names no family, on purpose
3728///
3729/// `.mp3` is audio in fact, and nothing here says so. A suffix-to-family table
3730/// in a published crate is a mapping that goes stale, disagrees with the host's
3731/// own idea of what a file is, and is wrong the first time somebody hands it a
3732/// container. A call site that wants a picture's preview writes
3733/// [`Family::Image`] or `image/jpeg`; a call site listing installer suffixes
3734/// wants no disclosure anyway, which is the measured case.
3735///
3736/// Added 0.31.0, `f7261a5a`.
3737#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
3738#[non_exhaustive]
3739pub enum Accepted<'a> {
3740 /// Every file of a family: `image/*` and its siblings.
3741 Family(Family),
3742 /// One media type, written the way a media type is written:
3743 /// `image/jpeg`, `text/csv`.
3744 Type(&'a str),
3745 /// One file-name suffix, written with its leading dot: `.zip`, `.tar.gz`.
3746 ///
3747 /// A suffix and not an extension, because `.tar.gz` is a measured site and
3748 /// is two dots.
3749 Suffix(&'a str),
3750}
3751
3752impl<'a> Accepted<'a> {
3753 /// The family this entry belongs to, when it names one.
3754 ///
3755 /// [`None`] for a [`Suffix`](Self::Suffix) and for any media type outside
3756 /// the three families, which is the honest answer rather than a missing
3757 /// one: the description did not say.
3758 #[must_use]
3759 pub fn family(self) -> Option<Family> {
3760 match self {
3761 Self::Family(family) => Some(family),
3762 Self::Type(media_type) => Family::of_type(media_type),
3763 Self::Suffix(_) => None,
3764 }
3765 }
3766
3767 /// How a host that wants one string writes this entry.
3768 ///
3769 /// A webview's `accept` attribute takes exactly these spellings, and a
3770 /// terminal listing what it will take reads the same words.
3771 #[must_use]
3772 pub const fn as_str(self) -> &'a str {
3773 match self {
3774 Self::Family(family) => family.wildcard(),
3775 Self::Type(text) | Self::Suffix(text) => text,
3776 }
3777 }
3778}
3779
3780/// One option offered by a field [`FieldKind::offers_options`] accepts.
3781///
3782/// Two strings, because the submitted value and the read label are different
3783/// facts and every renderer that has tried to collapse them has had to
3784/// un-collapse them later. `makeover-webview` invented this shape writing its
3785/// form emitter and it is taken here unchanged; moving it down rather than
3786/// re-deriving it is the point, since the second and third renderers were each
3787/// going to arrive at a near-miss of it.
3788/// `#[non_exhaustive]` as of 0.28.0, which every other type here that a
3789/// renderer matches or builds has carried for releases. It was the omission
3790/// that made [`unavailable`](Self::unavailable) a breaking change across 40
3791/// literal sites in six repos, and it arrives with that member so the price is
3792/// paid once and never again.
3793#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
3794#[non_exhaustive]
3795pub struct Choice<'a> {
3796 /// What is submitted.
3797 pub value: &'a str,
3798 /// What is read.
3799 pub label: &'a str,
3800 /// Why it cannot be picked right now, when it cannot.
3801 ///
3802 /// One member rather than an `available: bool` beside a reason, and the
3803 /// conflation is the point: an option greyed out with no explanation is a
3804 /// dead end the user cannot act on, and it is exactly the state the app
3805 /// that found this gap had to patch by hand with a line of prose under the
3806 /// control. Making the reason mandatory means the description cannot say
3807 /// the useless half.
3808 ///
3809 /// The option stays in the list. Dropping it is what an app does today, and
3810 /// it costs the user the knowledge that the thing exists at all —
3811 /// audiofiles' multi-sample mode appears on its own once a second sample is
3812 /// dropped, so a user who never sees it never learns what to drop.
3813 ///
3814 /// **Not [`Field::error`], and not [`Field::hint`].** An error is about the
3815 /// answer and a hint is standing help for the whole question; this is about
3816 /// one option among several, which is the level neither of those reaches.
3817 ///
3818 /// **Not disabled-the-state.** `State::Disabled` is about a whole field
3819 /// refusing to answer. This says the field is live and one of its answers
3820 /// is not available yet, which is a different sentence and the reason the
3821 /// tone rule matters here: the *other* options are still usable.
3822 ///
3823 /// Added 0.28.0, from audiofiles' instrument mode selector (`e761833e`).
3824 pub unavailable: Option<&'a str>,
3825}
3826
3827impl<'a> Choice<'a> {
3828 /// An option whose submitted value is also its label.
3829 #[must_use]
3830 pub const fn plain(value: &'a str) -> Self {
3831 Self::new(value, value)
3832 }
3833
3834 /// An option that submits one string and reads as another.
3835 ///
3836 /// A constructor rather than a literal, which is what `#[non_exhaustive]`
3837 /// costs and buys: outside this crate the struct cannot be built by naming
3838 /// its members, so every call site goes through here and the next member
3839 /// added breaks none of them.
3840 #[must_use]
3841 pub const fn new(value: &'a str, label: &'a str) -> Self {
3842 Self {
3843 value,
3844 label,
3845 unavailable: None,
3846 }
3847 }
3848
3849 /// The same option, not pickable yet, and why.
3850 ///
3851 /// Builder-shaped because the reason is the rare case: 39 of the 40 option
3852 /// sites measured across the tree do not have one.
3853 #[must_use]
3854 pub const fn unless(mut self, reason: &'a str) -> Self {
3855 self.unavailable = Some(reason);
3856 self
3857 }
3858
3859 /// Whether the option can be picked right now.
3860 ///
3861 /// The predicate a renderer branches on, so that "unavailable" is read as
3862 /// one condition in one place rather than as `unavailable.is_some()` at
3863 /// three renderers, one of which will invert it.
3864 #[must_use]
3865 pub const fn available(&self) -> bool {
3866 self.unavailable.is_none()
3867 }
3868}
3869
3870/// One entry in a field's suggestion list.
3871///
3872/// A suggestion-only type rather than a fourth member on [`Choice`], ruled by
3873/// Max 2026-08-21 (`1fcf2e9b`). The two are near-identical and that is the
3874/// drift risk the ruling accepted, so the mitigation is written here: **an
3875/// option and a candidate are submitted the same way and read differently.**
3876/// An option is a thing you pick from a known set, and the set is the whole of
3877/// what there is. A candidate is a thing you are being *oriented* toward out of
3878/// a set nobody can see, which is why it carries [`detail`](Self::detail) and
3879/// an option does not.
3880///
3881/// This reverses a position quasi-router stated in its own doc, that a
3882/// candidate is [`Choice`] "because a candidate is submitted under one string
3883/// and read under another, which is what an option is". True and not
3884/// sufficient: how a thing is submitted was never the half that differed.
3885///
3886/// # Why the second string is not folded into the label
3887///
3888/// Because every renderer wants it separately, and the two measured sites both
3889/// draw it by hand today. The MNW server's tag box computes its context as the
3890/// parent path -- "the parent path orients an otherwise ambiguous leaf:
3891/// 'Format' appears under audio, software, writing, and video" -- and a list of
3892/// four identical rows reading "Format" is not a usable list. In a webview the
3893/// second string is styled differently, in a terminal it wants the remaining
3894/// columns rather than a dash, and in neither is it part of what the typed
3895/// value matches against. `Choice::new(slug, format!("{label} - {context}"))`
3896/// loses all three of those facts, which is the condition this type exists to
3897/// end.
3898///
3899/// # No `unavailable`
3900///
3901/// [`Choice::unavailable`] has no counterpart here, and the omission is the
3902/// implementer's call recorded rather than an oversight. A suggestion that
3903/// cannot be picked is arguably not a suggestion: an option list is a fixed set
3904/// a user is owed an explanation about, and a candidate list is whatever a
3905/// route decided to offer, so a route with nothing to say simply does not offer
3906/// the row. Add it if a measured site ever wants it.
3907///
3908/// # What it does not carry, and where that lives
3909///
3910/// What *happens* when a candidate is picked. Picking is local by default -- it
3911/// writes [`value`](Self::value) into the field that owns the list -- and a
3912/// candidate that does something else says so with an action. An action is not
3913/// a word this crate has, exactly as [`Field`] here has no `suggests` member,
3914/// so both live on the router's owned mirror of this type. Ruled the same day
3915/// (`ed1fa86f`).
3916///
3917/// `#[non_exhaustive]` from birth. Non-negotiable and the reason is on the
3918/// sibling: [`Choice`] took it at 0.28.0 only after `unavailable` broke 40
3919/// literal sites in six repos, and a new type repeating that would be the third
3920/// time the tree learned it.
3921///
3922/// Added 0.35.0.
3923#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
3924#[non_exhaustive]
3925pub struct Candidate<'a> {
3926 /// What is submitted, and what picking writes into the field.
3927 pub value: &'a str,
3928 /// What is read.
3929 pub label: &'a str,
3930 /// The second line: what orients this candidate among rows that read alike.
3931 ///
3932 /// Optional because a candidate list whose labels are already distinct
3933 /// wants nothing here, and a renderer given [`None`] draws one line rather
3934 /// than an empty second one.
3935 pub detail: Option<&'a str>,
3936}
3937
3938impl<'a> Candidate<'a> {
3939 /// A candidate whose submitted value is also its label.
3940 #[must_use]
3941 pub const fn plain(value: &'a str) -> Self {
3942 Self::new(value, value)
3943 }
3944
3945 /// A candidate that submits one string and reads as another.
3946 ///
3947 /// A constructor rather than a literal, which is what `#[non_exhaustive]`
3948 /// costs and buys: outside this crate the struct cannot be built by naming
3949 /// its members, so every call site goes through here and the next member
3950 /// added breaks none of them.
3951 #[must_use]
3952 pub const fn new(value: &'a str, label: &'a str) -> Self {
3953 Self {
3954 value,
3955 label,
3956 detail: None,
3957 }
3958 }
3959
3960 /// The same candidate, with the line that tells it from its neighbours.
3961 #[must_use]
3962 pub const fn detailed(mut self, detail: &'a str) -> Self {
3963 self.detail = Some(detail);
3964 self
3965 }
3966}
3967
3968/// One field of a form.
3969///
3970/// Borrowed rather than owned: a description is built, read once by a renderer,
3971/// and dropped. Nothing here outlives the screen it describes.
3972///
3973/// # What it carries, and what it does not
3974///
3975/// Stated here so the next renderer does not re-ask, which is what the first
3976/// two both did. It carries everything a renderer needs to *draw* the field:
3977/// its kind, what it is called, what it is asked for, its standing help, what
3978/// is wrong with it now, whether it is compulsory, whether it hides behind a
3979/// disclosure, its ghost text, and the options it offers.
3980///
3981/// It does not carry the **current value**, and it is not going to. That is the
3982/// one thing here that is genuinely renderer state: a webview reads it back out
3983/// of the DOM, an immediate-mode renderer holds a `&mut` to the app's own field
3984/// and writes through it, and a terminal keeps an edit buffer. A description
3985/// that carried the value would have to carry a way to write it back, at which
3986/// point it is a form model and no longer a description.
3987///
3988/// **Constraints** are here and enforcement is not, which is one line rather
3989/// than two. [`required`], [`max_length`], [`min`] and [`max`] are facts about
3990/// the *question*, so a renderer can emit its host's idiom for each — an HTML
3991/// attribute, a marked label, a clamped spinner — and the platform helps the
3992/// user before anything is submitted. Deciding that a value is wrong stays with
3993/// whoever validated, and [`error`] is that decision arriving back.
3994///
3995/// The set stops before `pattern`, and stops there on both tests at once. A
3996/// regex has an honest answer in a webview and none anywhere else: egui would
3997/// have to run it per keystroke and decide what a half-typed value means, which
3998/// is enforcement wearing description's clothes. And it is one site in goingson
3999/// and none in Balanced Breakfast, against 8 and 1 for `maxlength`. Measured
4000/// 2026-08-09, `2cbad3e2`.
4001///
4002/// [`error`]: Field::error
4003/// [`required`]: Field::required
4004/// [`max_length`]: Field::max_length
4005/// [`min`]: Field::min
4006/// [`max`]: Field::max
4007/// How a slider's position becomes its value, and how finely it moves.
4008///
4009/// **The data of a slider is a fraction and a function taking numbers to
4010/// numbers.** Stated by Max 2026-08-21, and it corrects a reading this crate
4011/// had carried since [`FieldKind::Range`] arrived at 0.28.0:
4012/// [`min`](Field::min) and [`max`](Field::max) were never the control's extent.
4013/// A slider's extent is always 0 to 1 — a thumb at 40% of a track — and the
4014/// bounds are `f(0)` and `f(1)`. Linear is the constant-slope case, which is
4015/// exactly why nobody noticed the function was there: when `f` is
4016/// `min + t * (max - min)` the extent and the bounds coincide numerically and
4017/// the mapping is invisible.
4018///
4019/// So this is not a scale flag bolted onto a range. Every range described
4020/// before it had a mapping, and four renderers each hard-coded the same one.
4021///
4022/// # Why a closed family and not a function
4023///
4024/// `fn(f64) -> f64` is the literal reading and it does not survive the
4025/// description boundary. A fn pointer cannot be emitted into a browser, and it
4026/// cannot be compared or hashed in a way that means anything, which this struct
4027/// needs. A named family is the same semantics with arbitrary closures given
4028/// up, and nothing measured wants one: the tree has a single non-linear shape
4029/// across five controls and no second shape at all.
4030///
4031/// # Why the step is here
4032///
4033/// Max, in the same breath: if the family is prescriptive anyway, the step
4034/// spacing belongs in it. On a slider the granularity and the mapping are one
4035/// decision — a curve chosen without saying how finely it moves is half an
4036/// answer — and holding them apart is what let a 0-to-1 threshold ship as a
4037/// two-position control, since the host default of 1 was applied to a mapping
4038/// nobody had named. It also un-overloads [`Field::step`], which stays as it
4039/// was for a *typed* value, where there is no mapping and the granularity is a
4040/// plain fact about the number.
4041///
4042/// A future curve carrying a fact of its own — an exponent, an inflection —
4043/// puts it in its own variant rather than on the struct, which is the second
4044/// reason this shape is right.
4045///
4046/// **The step is in the value's own units under every curve.** What a curve
4047/// changes is the mapping, not the units the granularity is measured in: a step
4048/// of `0.001` on an envelope time is three decimals whether the track is
4049/// logarithmic or not, and a renderer that reads the step for display precision
4050/// keeps reading it the same way.
4051///
4052/// Added 0.32.0, from audiofiles' ADSR envelope and its storage cap picker.
4053#[non_exhaustive]
4054#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
4055pub enum Curve<'a> {
4056 /// Constant slope: `f(t) = min + t * (max - min)`.
4057 ///
4058 /// What every described range meant before this enum existed, and the
4059 /// default, so a site that says nothing is correct unchanged.
4060 Linear {
4061 /// The granularity, in the value's own units. `None` is the host's own.
4062 step: Option<&'a str>,
4063 },
4064 /// Constant ratio: `f(t) = min * (max / min).powf(t)`.
4065 ///
4066 /// The mapping for a question whose extent spans orders of magnitude and
4067 /// whose interesting half is the small end. audiofiles' envelope times run
4068 /// 0.001 to 5 seconds, where a 5 ms attack and a 50 ms attack are audibly
4069 /// different instruments and a linear track puts both inside its first one
4070 /// percent.
4071 ///
4072 /// # It needs positive bounds
4073 ///
4074 /// A constant ratio is undefined across zero, so this asks for `min > 0`.
4075 /// A range that does not have that is mapped [`Linear`](Self::Linear)ly
4076 /// instead — see [`value_at`](Self::value_at). Stated rather than enforced,
4077 /// the way every other constraint in this crate is, and it is not a
4078 /// hypothetical: an envelope's sustain is a 0-to-1 level and is linear for
4079 /// this reason rather than by oversight.
4080 Logarithmic {
4081 /// The granularity, in the value's own units. `None` is the host's own.
4082 step: Option<&'a str>,
4083 },
4084}
4085
4086impl Default for Curve<'_> {
4087 fn default() -> Self {
4088 Self::Linear { step: None }
4089 }
4090}
4091
4092impl<'a> Curve<'a> {
4093 /// The granularity this curve moves in, whichever curve it is.
4094 ///
4095 /// Every variant carries one, so reading it does not need a match at each
4096 /// of the four renderers.
4097 #[must_use]
4098 pub const fn step(self) -> Option<&'a str> {
4099 // No wildcard: `#[non_exhaustive]` binds downstream, not here, so a
4100 // curve added later has to answer this rather than fall through to a
4101 // granularity nobody chose.
4102 match self {
4103 Self::Linear { step } | Self::Logarithmic { step } => step,
4104 }
4105 }
4106
4107 /// Whether this curve maps as a constant ratio *given these bounds*.
4108 ///
4109 /// The bounds are the argument because [`Logarithmic`](Self::Logarithmic)
4110 /// is a request rather than a guarantee: it needs `0 < min < max`, and a
4111 /// range that does not have that is drawn linearly. A renderer asks this
4112 /// instead of matching on the variant, so the fallback is decided in one
4113 /// place rather than four.
4114 #[must_use]
4115 pub fn is_ratio(self, min: f64, max: f64) -> bool {
4116 matches!(self, Self::Logarithmic { .. }) && min > 0.0 && max > min
4117 }
4118
4119 /// The value at a position along the track, where `position` is 0 to 1.
4120 ///
4121 /// `f`. The whole point of the type, and it lives here rather than in each
4122 /// renderer so that a terminal's bar, an egui slider and a browser's input
4123 /// cannot disagree about where a value sits.
4124 ///
4125 /// A position outside 0 to 1 is clamped, and bounds that are equal or
4126 /// inverted give `min` back: a track with no extent has one value on it.
4127 #[must_use]
4128 pub fn value_at(self, position: f64, min: f64, max: f64) -> f64 {
4129 let position = position.clamp(0.0, 1.0);
4130 // NaN named rather than fallen through: `max <= min` is false for a NaN
4131 // bound, so without it a track with no numbers on it would be mapped as
4132 // if it had two.
4133 if max <= min || min.is_nan() || max.is_nan() {
4134 return min;
4135 }
4136 if self.is_ratio(min, max) {
4137 min * (max / min).powf(position)
4138 } else {
4139 position.mul_add(max - min, min)
4140 }
4141 }
4142
4143 /// The position a value sits at, where the answer is 0 to 1.
4144 ///
4145 /// `f` inverted, which is what a renderer needs to *draw* a value it was
4146 /// handed. Same clamping and the same degenerate answer as
4147 /// [`value_at`](Self::value_at).
4148 #[must_use]
4149 pub fn position_of(self, value: f64, min: f64, max: f64) -> f64 {
4150 if max <= min || min.is_nan() || max.is_nan() {
4151 return 0.0;
4152 }
4153 let value = value.clamp(min, max);
4154 let position = if self.is_ratio(min, max) {
4155 (value / min).ln() / (max / min).ln()
4156 } else {
4157 (value - min) / (max - min)
4158 };
4159 position.clamp(0.0, 1.0)
4160 }
4161}
4162
4163#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
4164pub struct Field<'a> {
4165 /// What kind of value it takes.
4166 pub kind: FieldKind,
4167 /// The name the value is submitted under.
4168 ///
4169 /// The *lower* end's name for a [`FieldKind::Interval`], whose upper end is
4170 /// [`upper_name`](Self::upper_name). Every other kind submits one value and
4171 /// this is the whole of it.
4172 pub name: &'a str,
4173 /// The name a [`FieldKind::Interval`]'s upper end is submitted under.
4174 ///
4175 /// [`None`] for every other kind, and sayable-and-ignored there the way
4176 /// [`options`](Self::options) is on a kind that offers none.
4177 ///
4178 /// Stated rather than derived from [`name`](Self::name), and
4179 /// [`FieldKind::Interval`] carries the measurement that decided it: the two
4180 /// sites in this tree disagree about affix order, so a derived rule would
4181 /// rename one of them. Which member a name sits in is also what says which
4182 /// end it is, so nothing separate carries the direction.
4183 ///
4184 /// An interval missing it is an interval with one end that can be submitted,
4185 /// which is a description a renderer may draw honestly and no better than
4186 /// that. [`Field::interval`] is what makes forgetting it unsayable, on the
4187 /// same footing as [`Field::range`] and its bounds.
4188 ///
4189 /// Added 0.34.0.
4190 pub upper_name: Option<&'a str>,
4191 /// What the user is asked for.
4192 pub label: &'a str,
4193 /// Standing help, shown whether or not anything is wrong.
4194 pub hint: Option<&'a str>,
4195 /// What is currently wrong with the value.
4196 pub error: Option<&'a str>,
4197 /// Ghost text shown while the field is empty.
4198 ///
4199 /// User-facing text, and it sits with `label` and `hint` rather than with
4200 /// the value because it is a property of the *question* and not of the
4201 /// answer. It lived renderer-side in `makeover-webview` until 0.8.0 for one
4202 /// reason and it was not a reading on where it belonged: adding a field to
4203 /// a published struct is a breaking change.
4204 ///
4205 /// Not a substitute for a label. A field labelled only by its placeholder
4206 /// loses its label the moment anything is typed, and no renderer here can
4207 /// make that not happen, so the description keeps both.
4208 pub placeholder: Option<&'a str>,
4209 /// The options offered, in the order they are offered.
4210 ///
4211 /// Empty for every kind [`FieldKind::offers_options`] rejects. A field
4212 /// described with no options is sayable on purpose: it is what an app with
4213 /// an unfinished-loading option list actually has, and a renderer showing
4214 /// an empty control says so on screen rather than in a log.
4215 ///
4216 /// Which option is *current* is not here. That is the value, and the value
4217 /// is renderer state.
4218 pub options: &'a [Choice<'a>],
4219 /// What a file field takes, in the order a host offering the list shows it.
4220 ///
4221 /// Empty for every kind [`FieldKind::takes_files`] rejects, and empty is
4222 /// also a real answer for one that accepts it: a field that takes any file
4223 /// says so by listing nothing, which is what an `<input type="file">` with
4224 /// no `accept` does and what most of the measured sites are.
4225 ///
4226 /// It is a filter and it is the disclosure cue, and [`Accepted`]'s doc
4227 /// carries which reading is which. Nothing here validates: a host may hand
4228 /// back a file the list does not cover, exactly as a browser does when the
4229 /// user switches the picker to "All Files", and deciding a value is wrong
4230 /// stays with whoever validated.
4231 ///
4232 /// Added 0.31.0, `f7261a5a`.
4233 pub accept: &'a [Accepted<'a>],
4234 /// Whether more than one file may be picked at once.
4235 ///
4236 /// Only [`FieldKind::takes_files`] reads it. A multi-valued answer to any
4237 /// other question is a different shape — a set of options, a repeated
4238 /// group — and neither is this flag with a different kind beside it.
4239 ///
4240 /// False is the common case: 4 of the MNW server's 16 file inputs carry it.
4241 ///
4242 /// Added 0.31.0, `f7261a5a`.
4243 pub multiple: bool,
4244 /// Whether the form refuses to submit without it.
4245 pub required: bool,
4246 /// The longest the value may be, in characters.
4247 ///
4248 /// Added 0.11.0 with [`min`](Self::min) and [`max`](Self::max), joining
4249 /// [`required`](Self::required), which had been the only constraint here
4250 /// since before the crate wrote down that it carried none.
4251 pub max_length: Option<u32>,
4252 /// The lowest value accepted, as the host would write it.
4253 ///
4254 /// Text rather than a number, because the bound is only a number for some
4255 /// of the kinds that take one. goingson's own sites are `min="1"` on a
4256 /// duration and `min="2026-08-09T14:30"` on a datetime, and a numeric member
4257 /// could say the first and not the second. The [`kind`](Self::kind) already
4258 /// says how to read it, the same way it does for the value.
4259 pub min: Option<&'a str>,
4260 /// The highest value accepted, as the host would write it. See
4261 /// [`min`](Self::min).
4262 pub max: Option<&'a str>,
4263 /// The granularity the value moves in, as the host would write it.
4264 ///
4265 /// Text for [`min`](Self::min)'s reason, and it earns it twice over: the
4266 /// step of a date is a day and the step of a threshold is 0.01, and a
4267 /// numeric member could say one of them.
4268 ///
4269 /// Absent means the host's own granularity, which is the honest default
4270 /// rather than a missing value: a webview's `<input>` steps by 1 unless told
4271 /// otherwise, and that is the browser's rule and not this crate's to
4272 /// restate.
4273 ///
4274 /// # It is the granularity of a *typed* value
4275 ///
4276 /// [`FieldKind::Range`] reads its own from [`curve`](Self::curve) and
4277 /// ignores this, as of 0.32.0. Until then this member served both, and
4278 /// serving both is what the split fixes: on a slider the granularity and
4279 /// the mapping are one decision, and on a typed number there is no mapping
4280 /// to decide with. See [`Curve`], "Why the step is here".
4281 ///
4282 /// Added 0.28.0 with [`FieldKind::Range`], and narrowed away from it at
4283 /// 0.32.0.
4284 pub step: Option<&'a str>,
4285 /// How a slider's position becomes its value, and how finely it moves.
4286 ///
4287 /// [`FieldKind::Range`]'s, and nothing else reads it: a typed number has a
4288 /// granularity but no mapping, and takes [`step`](Self::step) instead.
4289 ///
4290 /// Defaults to [`Curve::Linear`] with no step, which is what every range
4291 /// described before 0.32.0 meant, so this member is additive and no
4292 /// existing site changes meaning.
4293 ///
4294 /// Added 0.32.0.
4295 pub curve: Curve<'a>,
4296 /// What the number is measured in: `s`, `ms`, `dB`, `GiB`.
4297 ///
4298 /// A fact about the value, not part of the question's name, and that
4299 /// distinction is the whole reason it is a member. The two readings come
4300 /// apart the moment anything reads a field back rather than drawing it: a
4301 /// [`max`](Self::max) of `-96` and a bound of `-96 dBFS` are the same number
4302 /// and not the same answer, and under the convention this replaces the unit
4303 /// could only be recovered by parsing it back out of a label.
4304 ///
4305 /// # Where a renderer draws it
4306 ///
4307 /// Beside the value, wherever that host puts a value. Not in the label: the
4308 /// label is the sentence above the control and that is the one place the
4309 /// convention could put it, which is why it read the same on every host and
4310 /// was wrong on the one host that had somewhere better. egui puts it inside
4311 /// the slider where the readout already is, a terminal appends it to the
4312 /// value in the edit line, a webview sets it adjacent to the input.
4313 ///
4314 /// # Which kinds read it
4315 ///
4316 /// [`FieldKind::measurable`] answers, and it is
4317 /// [`takes_files`](FieldKind::takes_files)'s footing: three renderers ask
4318 /// before they can decide whether to draw this, and a `matches!` per
4319 /// renderer is where the next measurable kind goes missing. A unit on a kind
4320 /// that rejects it is sayable and ignored, the same way
4321 /// [`options`](Self::options) is on a kind that offers none.
4322 ///
4323 /// # Why a string
4324 ///
4325 /// The measured sites are `GiB`, `dBFS`, `s` and `ms`. An enum would have to
4326 /// grow a member for every unit any consumer ever wants, and this crate does
4327 /// not know them; it knows that a number has one.
4328 ///
4329 /// Written as the symbol alone, with no brackets and no leading space. The
4330 /// spacing is the renderer's, because a slider's readout and a sentence want
4331 /// different answers.
4332 ///
4333 /// Added 0.33.0, `32215e21`, on eight sites across four files that had each
4334 /// arrived at "Attack (s)" separately.
4335 pub unit: Option<&'a str>,
4336 /// Whether the field lives behind a "more options" disclosure.
4337 pub extended: bool,
4338}
4339
4340impl<'a> Field<'a> {
4341 /// A plain required-nothing field of the given kind.
4342 #[must_use]
4343 pub const fn new(kind: FieldKind, name: &'a str, label: &'a str) -> Self {
4344 Self {
4345 kind,
4346 name,
4347 upper_name: None,
4348 label,
4349 hint: None,
4350 error: None,
4351 placeholder: None,
4352 options: &[],
4353 accept: &[],
4354 multiple: false,
4355 required: false,
4356 max_length: None,
4357 min: None,
4358 max: None,
4359 step: None,
4360 curve: Curve::Linear { step: None },
4361 unit: None,
4362 extended: false,
4363 }
4364 }
4365
4366 /// A bounded number the user drags across its whole extent.
4367 ///
4368 /// The third under-described kind, and it gets a constructor for
4369 /// [`select`](Self::select)'s reason: a range is the one kind whose bounds
4370 /// are not a rule but the control itself, so a call site that forgot them
4371 /// has a slider with nothing to slide across. Taking them as arguments is
4372 /// what makes that unsayable.
4373 ///
4374 /// The granularity stays a field rather than a fourth argument, and since
4375 /// 0.32.0 it is [`curve`](Self::curve)'s: it is genuinely optional — the
4376 /// host's own is a real answer — and the two bounds are not.
4377 #[must_use]
4378 pub const fn range(name: &'a str, label: &'a str, min: &'a str, max: &'a str) -> Self {
4379 Self {
4380 min: Some(min),
4381 max: Some(max),
4382 ..Self::new(FieldKind::Range, name, label)
4383 }
4384 }
4385
4386 /// One question with two ends, taking the name each end submits under.
4387 ///
4388 /// A constructor for [`range`](Self::range)'s reason inverted: a range's
4389 /// bounds are what a call site cannot forget, and an interval's second name
4390 /// is. An interval built through [`new`](Self::new) has an upper end with
4391 /// nowhere to be submitted, and nothing downstream can invent one, so taking
4392 /// it as an argument is what makes that unsayable.
4393 ///
4394 /// The extent, the granularity and the unit stay members. They describe the
4395 /// axis rather than either end and they are genuinely optional, which is
4396 /// [`FieldKind::Number`]'s arrangement and the one an interval takes.
4397 #[must_use]
4398 pub const fn interval(name: &'a str, upper_name: &'a str, label: &'a str) -> Self {
4399 Self {
4400 upper_name: Some(upper_name),
4401 ..Self::new(FieldKind::Interval, name, label)
4402 }
4403 }
4404
4405 /// A file field, taking the given accept list.
4406 ///
4407 /// The fourth under-described kind and it gets a constructor for
4408 /// [`range`](Self::range)'s reason rather than [`select`](Self::select)'s:
4409 /// a file field with no accept list is not broken, it is a field that takes
4410 /// anything, and the hazard is the opposite one. A call site that meant to
4411 /// restrict and forgot has a picker offering every file on the machine and
4412 /// a server refusing the upload afterwards, which is the failure the list
4413 /// exists to move forward. Taking it as an argument is what makes an
4414 /// accidental omission a deliberate `&[]`.
4415 ///
4416 /// [`multiple`](Self::multiple) stays a field. One file is the common case
4417 /// and the honest default; several is the thing worth saying.
4418 #[must_use]
4419 pub const fn upload(name: &'a str, label: &'a str, accept: &'a [Accepted<'a>]) -> Self {
4420 Self {
4421 accept,
4422 ..Self::new(FieldKind::File, name, label)
4423 }
4424 }
4425
4426 /// A select offering the given options.
4427 ///
4428 /// One of the two kinds under-described by [`Field::new`], so it gets a
4429 /// constructor rather than leaving every call site to remember that a
4430 /// select with an empty `options` renders as an empty select.
4431 #[must_use]
4432 pub const fn select(name: &'a str, label: &'a str, options: &'a [Choice<'a>]) -> Self {
4433 Self::offering(FieldKind::Select, name, label, options)
4434 }
4435
4436 /// A radio group offering the given options.
4437 ///
4438 /// The other. Same hazard as [`select`](Self::select) and a worse one: a
4439 /// radio group with no options draws nothing at all, so a call site that
4440 /// forgot them has an empty rectangle rather than a visibly empty control.
4441 #[must_use]
4442 pub const fn radio(name: &'a str, label: &'a str, options: &'a [Choice<'a>]) -> Self {
4443 Self::offering(FieldKind::Radio, name, label, options)
4444 }
4445
4446 /// The shared body of the two constructors that take options.
4447 ///
4448 /// Private, and keyed on the kind rather than exposed, because the two
4449 /// public names are the point: a call site says which question it is
4450 /// asking, not which flag it is setting.
4451 const fn offering(
4452 kind: FieldKind,
4453 name: &'a str,
4454 label: &'a str,
4455 options: &'a [Choice<'a>],
4456 ) -> Self {
4457 Self {
4458 options,
4459 ..Self::new(kind, name, label)
4460 }
4461 }
4462
4463 /// Whether the field is currently reporting a problem.
4464 ///
4465 /// Read this rather than testing `error.is_some()` at each renderer: the
4466 /// error state has to mark the field's whole group and not only the
4467 /// message, because a renderer with no descendant selectors (egui, a
4468 /// terminal) cannot find the group from the message. goingson already marks
4469 /// the group and Balanced Breakfast does not, so goingson's shape is the
4470 /// one taken here.
4471 #[must_use]
4472 pub const fn invalid(&self) -> bool {
4473 self.error.is_some()
4474 }
4475
4476 /// Whether the field carries both ends of its extent.
4477 ///
4478 /// Only [`FieldKind::Range`] owes them, and it owes them absolutely: a
4479 /// slider with one end missing has no extent to draw. Named here rather
4480 /// than left to each renderer to test `min.is_some() && max.is_some()`,
4481 /// which is three renderers arriving at the same condition and one of them
4482 /// getting it wrong, and named as a question about the *field* rather than
4483 /// about the kind because the kind cannot see the bounds.
4484 ///
4485 /// It is a check and not a guarantee. Nothing here refuses to build an
4486 /// unbounded range — [`Field::range`] is what makes the bounded one easy —
4487 /// so a renderer asks this and falls back to whatever its host does
4488 /// honestly with a number.
4489 #[must_use]
4490 pub const fn bounded(&self) -> bool {
4491 self.min.is_some() && self.max.is_some()
4492 }
4493
4494 /// Whether anything in [`accept`](Self::accept) names a media family.
4495 ///
4496 /// The question a renderer asks before it decides to keep room for a
4497 /// preview, and it is deliberately the *whole list* rather than one entry:
4498 /// the media dropzone this was measured against takes `image/*,video/*`, so
4499 /// there is no single family to return and there is still a disclosure to
4500 /// offer. Which one it turns out to be is known once a file is picked, which
4501 /// is renderer-side and after the description is gone.
4502 ///
4503 /// False for an empty list, for a list of suffixes, and for `text/csv`. A
4504 /// renderer that wants the family of a particular entry reads
4505 /// [`Accepted::family`].
4506 #[must_use]
4507 pub fn accepts_media(&self) -> bool {
4508 self.accept.iter().any(|one| one.family().is_some())
4509 }
4510}
4511
4512/// How much room a placement asks for.
4513///
4514/// A column says it, and so does a [`Field`]. An intent, so the actual floor
4515/// stays with `makeover-geometry`. goingson's task table spells these as
4516/// `minmax(200px, 1fr)`, `140px` and content-sized; only the first three words
4517/// of that survive deferral.
4518/// `#[non_exhaustive]`, for the reason [`Fill`] and [`FieldKind`] are: a
4519/// renderer matches on this and a vocabulary that grows must not break every
4520/// renderer when it does.
4521#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
4522#[non_exhaustive]
4523pub enum Width {
4524 /// Takes what it needs and no more.
4525 Content,
4526 /// A fixed share, the same at every width.
4527 Fixed,
4528 /// Absorbs whatever is left over.
4529 ///
4530 /// **Several fills divide what is left equally.** Stated because it would
4531 /// otherwise be undefined and each renderer would invent something, and
4532 /// stated this way because equal division is the only sharing rule that
4533 /// answers to "Any width, one answer" without a tiebreak: allocating in
4534 /// declaration order makes the result depend on the order the description
4535 /// was written in, which is a fact about the source file and not about the
4536 /// screen. It documents what both renderers already do — CSS grid gives
4537 /// `1fr 1fr`, ratatui gives each a `Constraint::Fill(1)` — rather than
4538 /// changing anything.
4539 ///
4540 /// So a row of fills is a legal thing to describe, and there is no rule
4541 /// against it. Measured 2026-08-16, every table in the tree uses exactly
4542 /// one, which is the discipline this would otherwise have had to forbid.
4543 Fill,
4544}
4545
4546/// What a member is worth when there is not room for all of them.
4547///
4548/// Written for table columns and no longer only theirs. Three shapes ask the
4549/// same question and this answers all three: a table too narrow for its
4550/// columns, a row too narrow for its parts (see [`RowPart::priority`]), and a
4551/// group of regions sharing one run of room -- goingson's tab strip and the
4552/// [`Region::Band`] beside it, which is the case wiki `layout-room-and-fallback`
4553/// was ruled on. It is what any member of a group is worth, not a table
4554/// concept, and [`Fallback::Shed`] is what reads it.
4555///
4556/// The doc below is the column argument, which is where the type was measured;
4557/// the sentence that gave it away is [`Priority::Essential`]'s, which was
4558/// already written about a row.
4559///
4560/// Ordered: [`Priority::Optional`] drops first, [`Priority::Essential`] never
4561/// drops. This replaces addressing columns by position, which is what both
4562/// webview apps do today and is a live bug rather than only verbosity. goingson
4563/// hides mobile columns with `nth-child(n+5)` against a seven-column table, so
4564/// inserting a column silently hides the wrong one.
4565/// `#[non_exhaustive]`, same reasoning as [`Width`]. Note the ordering is the
4566/// whole point of the type, so a new tier has to be declared in its place in
4567/// the sequence rather than appended.
4568#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
4569#[non_exhaustive]
4570pub enum Priority {
4571 /// Dropped first.
4572 Optional,
4573 /// Dropped once the optional members are gone.
4574 Secondary,
4575 /// Never dropped. Without it the group does not identify itself.
4576 Essential,
4577}
4578
4579/// How much room a group has, measured against its own allocation.
4580///
4581/// Never authored. A renderer computes it from what the group was given and
4582/// what the group's own contents ask for, in that renderer's units: a webview
4583/// from `min-content` under a container query, a terminal from cell widths,
4584/// egui from the galley. Nothing in the description says a number, which is the
4585/// point -- an authored breakpoint rots and this cannot.
4586///
4587/// # Why not [`Depth`]-style two members and no more
4588///
4589/// Two is what the measurement supports. The goingson case that produced this
4590/// type is a window 913px wide -- makeover-geometry's `SizeClass::Expanded` --
4591/// holding a group that has run out of room. A third tier would be a guess
4592/// about a shape nothing in the tree has yet.
4593///
4594/// # Why it is not `SizeClass`
4595///
4596/// Because 913 is exactly the case that proves they are different facts. The
4597/// window is roomy and the group is not, so a type that answered for both would
4598/// have to be wrong about one of them. Sharing the name would also invite
4599/// `@media` thinking straight back in, which is what put a `position: absolute`
4600/// in goingson's stylesheet in the first place. Container semantics instead: a
4601/// group narrowed by a sidebar behaves the same as one narrowed by the window,
4602/// and there is one code path rather than two.
4603///
4604/// Ordered least room first, [`Priority`]'s convention, so a group nesting
4605/// another takes the minimum of the two and relief still resolves inside-out.
4606#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
4607#[non_exhaustive]
4608pub enum Room {
4609 /// Not everything the group contains fits, and the group's [`Fallback`]
4610 /// decides what happens.
4611 Tight,
4612 /// Everything fits as described.
4613 Ample,
4614}
4615
4616/// What a group does when it is [`Room::Tight`].
4617///
4618/// Authored, and required: the field carrying this has no `Default` and a group
4619/// cannot be described without saying what it does when it runs out of room.
4620/// Max ruled on that 2026-08-18 -- more intentionality from layout designers is
4621/// acceptable so long as the constraints are solvable, because the goal is
4622/// enabling good layouts rather than rescuing bad ones. A default here would be
4623/// the crate guessing, and the guess would be silently wrong on the screens
4624/// that matter.
4625///
4626/// Relief resolves inside-out. A group asks its children to fall back before
4627/// falling back itself, or an outer group collapses while an inner one still
4628/// had slack.
4629///
4630/// # No `Swap`
4631///
4632/// An authored alternate group for the tight case is deliberately out of the
4633/// first cut. It doubles the description for that group and the two halves can
4634/// drift, which is the failure this vocabulary exists to end. Add it when a
4635/// site proves it needs one.
4636///
4637/// `#[non_exhaustive]`, [`Width`]'s reasoning. Unlike [`Priority`] there is no
4638/// order to preserve, so a member can be appended.
4639#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
4640#[non_exhaustive]
4641pub enum Fallback {
4642 /// One row becomes two. Every member stays, in the order described.
4643 Wrap,
4644 /// A row becomes a column. Every member stays, full width.
4645 Stack,
4646 /// Members drop by [`Priority`], down to [`Priority::Essential`].
4647 ///
4648 /// What a narrow table already does with its columns, applied to a group.
4649 /// What drops is gone from the screen, so this is right when the dropped
4650 /// members are facts the reader can do without and wrong when they are the
4651 /// only way to act.
4652 Shed,
4653 /// The members [`Shed`](Self::Shed) would drop move into one overflow
4654 /// control instead.
4655 ///
4656 /// The answer when a group holds actions. A control is not a fact: dropping
4657 /// it does not cost the reader a detail, it costs them the only way to act,
4658 /// which is [`RowPart::priority`]'s argument one level up.
4659 Menu,
4660}
4661
4662/// One column of a table.
4663///
4664/// Described once. The grid track, the cell order and the drop behaviour are
4665/// all derived from this, rather than being three hand-written encodings that
4666/// must agree and are never checked against each other.
4667#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
4668pub struct Column<'a> {
4669 /// The heading, and the name the cell is addressed by.
4670 pub name: &'a str,
4671 /// How much room it asks for.
4672 pub width: Width,
4673 /// What it is worth when room runs out.
4674 pub priority: Priority,
4675 /// Whether the user can reorder the table by this column.
4676 ///
4677 /// `ce620871`. What reordering *calls* is not here — that is an address, and
4678 /// this crate names none — so a host pairs this with the route the way it
4679 /// pairs a row's parts with the row's activation. This says the affordance
4680 /// exists, which is what a renderer needs to draw a header a user can press
4681 /// rather than a heading they cannot.
4682 pub sortable: bool,
4683 /// Which way the table is ordered by this column, if it is.
4684 ///
4685 /// `None` on every column but the one in force. A renderer draws the caret
4686 /// from this and a webview sets `aria-sort`, which is why it is per column
4687 /// rather than a single fact on the table: the host idiom is a property of
4688 /// the header cell.
4689 ///
4690 /// Independent of [`sortable`](Self::sortable) rather than implied by it,
4691 /// because both combinations mean something. A column sorted and not
4692 /// sortable is a list ordered by a key the user cannot change, which is a
4693 /// real thing to describe and a caret worth drawing.
4694 pub sorted: Option<Sort>,
4695}
4696
4697/// Which way a column is ordered.
4698///
4699/// Two, because there is no third. "Unsorted" is [`Column::sorted`] being
4700/// `None`, and folding it in here would be the same absence said twice.
4701#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
4702pub enum Sort {
4703 /// Smallest, earliest or first alphabetically at the top.
4704 Ascending,
4705 /// The other way.
4706 Descending,
4707}
4708
4709impl Sort {
4710 /// The other direction, for a header that flips when pressed.
4711 #[must_use]
4712 pub const fn reversed(self) -> Self {
4713 match self {
4714 Self::Ascending => Self::Descending,
4715 Self::Descending => Self::Ascending,
4716 }
4717 }
4718
4719 /// What a webview writes into `aria-sort`.
4720 ///
4721 /// Named here rather than in the webview renderer because a terminal and an
4722 /// immediate-mode painter both want the same two words for a caret's label,
4723 /// and three renderers picking their own is the drift this crate ends.
4724 #[must_use]
4725 pub const fn as_str(self) -> &'static str {
4726 match self {
4727 Self::Ascending => "ascending",
4728 Self::Descending => "descending",
4729 }
4730 }
4731
4732 /// The caret a renderer draws for this direction.
4733 ///
4734 /// Here for [`as_str`](Self::as_str)'s reason, said about a glyph rather
4735 /// than a word: three renderers picking their own is the drift this crate
4736 /// ends. They had picked their own — two on the solid triangles and
4737 /// `makeover-webview` on the arrows U+2191/U+2193 — and agreeing by
4738 /// coincidence in three files is not agreement.
4739 ///
4740 /// Settled 2026-08-16 (Max): the solid triangles, U+25B2 and U+25BC. The
4741 /// reason generalizes past this pair and is the house rule now — prefer the
4742 /// bolder, simpler glyph over the thinner or more complicated one. A third
4743 /// spelling is not open for re-argument.
4744 ///
4745 /// **Bare, with no spacing.** Where the gap goes is each renderer's
4746 /// business: `makeover-tui` and `makeover-immediate` carry a leading space
4747 /// inside their `TableStyle` string and a webview emits its own in
4748 /// `content`, so folding a space in here would make one of the two wrong.
4749 ///
4750 /// Neither face the web apps self-host carries these — IBM Plex Mono has one
4751 /// glyph in the whole geometric-shapes block and Lato has none — so a
4752 /// browser falls back per glyph until the in-house face ships with them
4753 /// drawn in (makeover `6d6d9146`, wiki `typography-standard`). Cosmetic
4754 /// drift in one renderer, not a reason to spell it three ways.
4755 #[must_use]
4756 pub const fn glyph(self) -> &'static str {
4757 match self {
4758 Self::Ascending => "\u{25B2}",
4759 Self::Descending => "\u{25BC}",
4760 }
4761 }
4762}
4763
4764impl<'a> Column<'a> {
4765 /// A column that absorbs slack and drops after the optional ones.
4766 #[must_use]
4767 pub const fn new(name: &'a str) -> Self {
4768 Self {
4769 name,
4770 width: Width::Fill,
4771 priority: Priority::Secondary,
4772 sortable: false,
4773 sorted: None,
4774 }
4775 }
4776
4777 /// Whether this column survives at the given cutoff.
4778 ///
4779 /// A renderer narrows by raising the cutoff, and never by counting
4780 /// positions.
4781 #[must_use]
4782 pub const fn kept_at(&self, cutoff: Priority) -> bool {
4783 (self.priority as u8) >= (cutoff as u8)
4784 }
4785}
4786
4787/// What a table cell holds.
4788///
4789/// [`RowPart`] for tables, and it exists for the same reason: a part that
4790/// carries a control is not text, and a renderer with one class for the whole
4791/// cell paints it as though it were. `makeover-webview` emitted a single
4792/// `.cell` until 0.25.0, so a button in a cell inherited the cell's content
4793/// colour, which is the exact drift [`RowPart::intent`] prevents for rows and
4794/// prevented for nothing here.
4795///
4796/// Four members, and the count is what quasi's `Cell` was measured to carry:
4797/// a value, tokens (33 cells across 22 server templates), actions (30 rows
4798/// carrying a control, 5 beside a value) and a link (35 cells across 18
4799/// templates). Nothing was added past what something holds.
4800///
4801/// `#[non_exhaustive]` for [`RowPart`]'s reason: growth here must not be a
4802/// lockstep event across three renderers.
4803///
4804/// # No hover-reveal
4805///
4806/// [`RowPart`] carried a `revealed_on_hover` until 0.13.0 retired it, and this
4807/// enum never gets one. A cell's actions are shown at rest in every consumer
4808/// measured, and a member nothing uses is one three renderers owe an answer
4809/// for.
4810#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
4811#[non_exhaustive]
4812pub enum CellPart {
4813 /// The cell's own text.
4814 Value,
4815 /// Small labelled things in the cell: a status badge, a chip.
4816 Tokens,
4817 /// Controls that act on what the row is about.
4818 Actions,
4819 /// The cell's value, where the value is itself a link.
4820 Link,
4821}
4822
4823impl CellPart {
4824 /// The content intent the part takes.
4825 ///
4826 /// One part is text and three are not, so three answer with the intent
4827 /// inheriting already gives. That is [`RowPart::intent`]'s shape with the
4828 /// text side narrower: a cell's secondary and muted readings are the
4829 /// column's business, not the cell's.
4830 #[must_use]
4831 pub const fn intent(self) -> &'static str {
4832 match self {
4833 Self::Value => "content",
4834 // A token carries its own tone, and a part-level intent underneath
4835 // it would fight the token sitting on it.
4836 Self::Tokens => "content",
4837 // Actions carry controls rather than text.
4838 Self::Actions => "content",
4839 // A link takes the action colour from the control it is, rather
4840 // than the cell's text colour from the cell it sits in.
4841 Self::Link => "content",
4842 }
4843 }
4844}
4845
4846/// A named dimension a set can be narrowed by.
4847///
4848/// One word for six things that were six mechanisms. MNW's discover page filters
4849/// by free text, a flat any-of over item types, a tree of tags, a numeric range
4850/// over price, a nested one-of over AI tier, and a browse position in the tag
4851/// tree held separately from the tag selection — and the last two being separate
4852/// is the whole reason a filter row there needs a tick box *and* a chevron. The
4853/// panel is a mixed bag of hand-written controls because nothing named the thing
4854/// they all are.
4855///
4856/// Deliberately wider than that one page. audiofiles' library browser and
4857/// goingson's filters are the same shape, and a word that only fitted discover
4858/// would be discover's markup with a neutral name on it.
4859///
4860/// # What it does not say
4861///
4862/// **What picking a value calls.** This crate names no address, so a facet is
4863/// paired with routes the way a column's [`sortable`](Column::sortable) flag is
4864/// paired with what reordering calls.
4865///
4866/// **How a tree is drawn.** Indented rows, a column of panes, a breadcrumb and a
4867/// list: all four are honest renderings of the same described facet, and a
4868/// terminal will not pick the same one a browser does. [`FacetValue::depth`] is
4869/// what a renderer needs to draw any of them; the choice is not described.
4870///
4871/// **Which values to show.** A tag tree has thousands of nodes and a panel shows
4872/// a handful. Deciding which handful is the app's — it is the same question as
4873/// which rows go in a table, and no table member answers it either.
4874#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
4875#[non_exhaustive]
4876pub struct Facet<'a> {
4877 /// What the dimension is called, as the user reads it.
4878 pub name: &'a str,
4879 /// How many of its values may be in force, and in what shape.
4880 pub mode: Selecting,
4881 /// The values on offer, in the order they are drawn.
4882 ///
4883 /// A [`Selecting::Text`] facet has none: the value is whatever was typed,
4884 /// and a description that listed the possible strings would be listing the
4885 /// corpus. A [`Selecting::Range`] facet has none either, for the reason
4886 /// [`FieldKind::Range`] takes bounds rather than options — the ends are the
4887 /// question and the values between them are not enumerable.
4888 pub values: &'a [FacetValue<'a>],
4889}
4890
4891impl<'a> Facet<'a> {
4892 /// A dimension with values to pick from.
4893 #[must_use]
4894 pub const fn new(name: &'a str, mode: Selecting, values: &'a [FacetValue<'a>]) -> Self {
4895 Self { name, mode, values }
4896 }
4897
4898 /// Whether the facet is narrowing the set right now.
4899 ///
4900 /// The question a renderer asks to decide whether to offer a way out of it,
4901 /// and the reason it is derived rather than carried: a facet with nothing
4902 /// standing is unengaged by construction, so a member saying so could
4903 /// disagree with the values beside it. [`Standing::Inherited`] does not
4904 /// count — something further up is what is doing the narrowing, and clearing
4905 /// a child that was never picked clears nothing.
4906 ///
4907 /// Always false for [`Selecting::Text`] and [`Selecting::Range`], which
4908 /// carry no values. A host that wants a clear affordance on those knows
4909 /// whether its own box is empty; the description does not hold the typed
4910 /// string.
4911 #[must_use]
4912 pub fn engaged(&self) -> bool {
4913 self.values.iter().any(|value| value.standing.is_picked())
4914 }
4915
4916 /// The deepest value in the facet, or zero when it is flat.
4917 ///
4918 /// What an indenting renderer needs to reserve a gutter before it draws the
4919 /// first row, which is "First paint is final paint" applied to a tree: a
4920 /// gutter widened as deeper values arrive is the reflow that rule forbids.
4921 #[must_use]
4922 pub fn reach(&self) -> u8 {
4923 self.values
4924 .iter()
4925 .map(|value| value.depth)
4926 .max()
4927 .unwrap_or(0)
4928 }
4929}
4930
4931/// How many of a [`Facet`]'s values may be in force, and in what shape.
4932///
4933/// Five, and the fifth is what made this an enum rather than a bool. `one-of`,
4934/// `any-of`, a range and free text are the four a form vocabulary already has in
4935/// [`FieldKind`]; a tree's selection is none of them, and describing tags as
4936/// any-of was what forced browsing to be a second mechanism beside filtering.
4937#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
4938#[non_exhaustive]
4939pub enum Selecting {
4940 /// Exactly one value, and picking another replaces it.
4941 ///
4942 /// MNW's AI tier, whose three options are nested ranges rather than
4943 /// independent values, so two of them at once means nothing.
4944 OneOf,
4945 /// Any number of values, each independent of the others.
4946 AnyOf,
4947 /// A low end, a high end, or both.
4948 ///
4949 /// Carries no values for [`FieldKind::Range`]'s reason: the ends are the
4950 /// question.
4951 Range,
4952 /// Whatever the user types.
4953 Text,
4954 /// A position in a tree, edited by taking branches in and pruning branches
4955 /// out.
4956 ///
4957 /// The one mode that is not reducible to the others, and the one gesture
4958 /// that replaced two. Picking a value narrows the set to it *and* reveals
4959 /// its children, so browsing a tree and filtering by it stop being separate
4960 /// mechanisms with separate state. What a selection then is: a set of
4961 /// branches taken and a set pruned, resolved nearest-ancestor-first, so
4962 /// `music` in and `music/synths` out is sayable and no flat mode can say it.
4963 ///
4964 /// Resolution happens in the app, and what reaches a renderer is the
4965 /// [`Standing`] each drawn value ended up with. A renderer walking ancestors
4966 /// itself would be a renderer that can disagree with the results beside it.
4967 Subtree,
4968}
4969
4970impl Selecting {
4971 /// Whether the mode picks from values the description lists.
4972 ///
4973 /// False for [`Text`](Self::Text) and [`Range`](Self::Range), which are the
4974 /// two whose answer is not one of a set. A renderer asks this before it
4975 /// looks at [`Facet::values`], the way it asks
4976 /// [`FieldKind::offers_options`] before it looks at [`Field::options`].
4977 #[must_use]
4978 pub const fn offers_values(self) -> bool {
4979 matches!(self, Self::OneOf | Self::AnyOf | Self::Subtree)
4980 }
4981
4982 /// Whether a value can be pruned as well as picked.
4983 ///
4984 /// [`Subtree`](Self::Subtree) alone. Excluding a value from a flat facet is
4985 /// the same fact as not picking it, so an exclude affordance there would be
4986 /// a second control for a state the first one already holds.
4987 #[must_use]
4988 pub const fn prunes(self) -> bool {
4989 matches!(self, Self::Subtree)
4990 }
4991
4992 /// Whether picking a second value keeps the first.
4993 #[must_use]
4994 pub const fn accumulates(self) -> bool {
4995 matches!(self, Self::AnyOf | Self::Subtree)
4996 }
4997}
4998
4999/// One value a [`Facet`] offers, as it currently stands.
5000#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
5001#[non_exhaustive]
5002pub struct FacetValue<'a> {
5003 /// What identifies it, and what a host keys its route on.
5004 ///
5005 /// [`Choice::value`]'s split, and a tree is why it is not optional: two
5006 /// leaves under different parents are legitimately both called "Ambient",
5007 /// and the path is the only thing telling them apart. It is also what
5008 /// nearest-ancestor-wins resolves over, so an app that carried only labels
5009 /// could not compute the [`standing`](Self::standing) it hands back here.
5010 pub value: &'a str,
5011 /// What it is called, as the user reads it.
5012 ///
5013 /// The leaf's own name rather than its path: a facet drawn as an indented
5014 /// tree repeats every ancestor on every line otherwise, and one drawn as a
5015 /// breadcrumb has the ancestors already.
5016 pub label: &'a str,
5017 /// How many members of the set carry it.
5018 ///
5019 /// Optional, and settled that way rather than made mandatory: a count is a
5020 /// measured fact the app may not have. Counting a tag subtree under an
5021 /// active text search is a second query, and an app that will not pay for it
5022 /// should be able to describe the facet anyway rather than write a zero that
5023 /// reads as "none of them". That is [`Awaiting::amount`]'s rule in a second
5024 /// place — state a number when it was measured, and nothing when it was not.
5025 pub count: Option<u64>,
5026 /// Whether it is narrowing the set, and how it came to be.
5027 pub standing: Standing,
5028 /// How far down the tree it sits, counting from zero at the root.
5029 ///
5030 /// Always zero for a flat facet, which is what makes an indenting renderer
5031 /// one code path rather than two. A renderer that draws no tree at all still
5032 /// reads this, since a value's depth is what distinguishes two same-named
5033 /// leaves under different parents.
5034 pub depth: u8,
5035 /// Whether taking it reveals values under it.
5036 ///
5037 /// Distinct from having a nonzero [`depth`](Self::depth): a leaf deep in the
5038 /// tree branches no further, and a root with children does. Both facts are
5039 /// needed and neither implies the other, which is why the pair is two
5040 /// members rather than one count.
5041 pub branching: bool,
5042}
5043
5044impl<'a> FacetValue<'a> {
5045 /// An unpicked value at the root of the facet.
5046 #[must_use]
5047 pub const fn new(value: &'a str, label: &'a str) -> Self {
5048 Self {
5049 value,
5050 label,
5051 count: None,
5052 standing: Standing::Open,
5053 depth: 0,
5054 branching: false,
5055 }
5056 }
5057
5058 /// A value whose identifier is also what the user reads.
5059 ///
5060 /// [`Choice::of`]'s convenience, and it is the flat case: a type or a tier
5061 /// is its own name, and only a tree needs a path that is not one.
5062 #[must_use]
5063 pub const fn of(value: &'a str) -> Self {
5064 Self::new(value, value)
5065 }
5066
5067 /// How many members carry it, when that was measured.
5068 #[must_use]
5069 pub const fn counted(mut self, count: u64) -> Self {
5070 self.count = Some(count);
5071 self
5072 }
5073
5074 /// How it stands in the current selection.
5075 #[must_use]
5076 pub const fn standing(mut self, standing: Standing) -> Self {
5077 self.standing = standing;
5078 self
5079 }
5080
5081 /// Where it sits in the tree, and whether anything hangs off it.
5082 #[must_use]
5083 pub const fn at(mut self, depth: u8, branching: bool) -> Self {
5084 self.depth = depth;
5085 self.branching = branching;
5086 self
5087 }
5088}
5089
5090/// Whether a [`FacetValue`] is narrowing the set, and how it came to be.
5091///
5092/// Four rather than a bool, and the two extra members are what a tree costs. A
5093/// pruned branch and an untaken one are not the same state — one was decided
5094/// against and the other was never reached — and a child under a taken parent is
5095/// in force without anybody having picked it. A renderer given a bool either
5096/// marks every descendant of a taken branch, which reads as forty deliberate
5097/// choices, or marks none of them, which reads as unfiltered.
5098#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
5099#[non_exhaustive]
5100pub enum Standing {
5101 /// Not picked, and nothing above it is either.
5102 #[default]
5103 Open,
5104 /// Picked here. The set is narrowed to it and whatever hangs off it.
5105 Taken,
5106 /// In force because something above it was taken.
5107 Inherited,
5108 /// Pruned out, though something above it was taken.
5109 ///
5110 /// The state that only [`Selecting::Subtree`] can reach, and the reason
5111 /// exclusion is drawn as a visible affordance beside each label rather than
5112 /// as a modifier on the ordinary one: a gesture a terminal cannot express is
5113 /// a gesture half the renderers would have to leave out, and an affordance
5114 /// nothing teaches is one users do not find.
5115 Pruned,
5116}
5117
5118impl Standing {
5119 /// Whether the user decided this value, either way.
5120 ///
5121 /// True for [`Taken`](Self::Taken) and [`Pruned`](Self::Pruned) — both are
5122 /// choices, and both are things a "clear this" affordance has to clear.
5123 /// [`Inherited`](Self::Inherited) is not: clearing it clears nothing,
5124 /// because the decision is further up.
5125 #[must_use]
5126 pub const fn is_picked(self) -> bool {
5127 matches!(self, Self::Taken | Self::Pruned)
5128 }
5129
5130 /// Whether the value narrows the set in.
5131 ///
5132 /// [`Taken`](Self::Taken) and [`Inherited`](Self::Inherited): one was picked
5133 /// and one came down from above, and to the set they mean the same thing.
5134 /// The pair is named here so a renderer colouring in-force values does not
5135 /// have to know which is which.
5136 #[must_use]
5137 pub const fn in_force(self) -> bool {
5138 matches!(self, Self::Taken | Self::Inherited)
5139 }
5140
5141 /// The content intent the value takes.
5142 ///
5143 /// [`Pruned`](Self::Pruned) reads back a step, which is the three-tone rule
5144 /// above rather than a new decision: a pruned branch is still a live control
5145 /// — pressing it takes the prune off — so it may not wear `content-muted`,
5146 /// and it is not the thing itself either.
5147 #[must_use]
5148 pub const fn intent(self) -> &'static str {
5149 match self {
5150 Self::Taken | Self::Inherited | Self::Open => "content",
5151 Self::Pruned => "content-secondary",
5152 }
5153 }
5154}
5155
5156#[cfg(test)]
5157mod tests {
5158 use super::*;
5159
5160 #[test]
5161 fn a_markdown_field_is_multiline_and_offers_nothing() {
5162 // The editing counterpart of markdown prose is still text: every host
5163 // can draw it, which is the whole reason the kind was addable.
5164 assert!(FieldKind::Rich.multiline());
5165 assert!(FieldKind::Textarea.multiline());
5166 assert!(!FieldKind::Text.multiline());
5167 // It is not a chooser and not a moment.
5168 assert!(!FieldKind::Rich.offers_options());
5169 assert!(!FieldKind::Rich.temporal());
5170 assert!(FieldKind::Rich.visible());
5171 }
5172
5173 #[test]
5174 fn only_the_numeric_kinds_are_measurable() {
5175 assert!(FieldKind::Number.measurable());
5176 assert!(FieldKind::Range.measurable());
5177 // An axis is measured in something and both its ends are in it, so the
5178 // unit is read once for the pair rather than per end.
5179 assert!(FieldKind::Interval.measurable());
5180 // A date is ordered and is not a quantity with a unit to choose: its
5181 // unit is fixed by the kind, so saying one would restate `kind`.
5182 for kind in [
5183 FieldKind::Text,
5184 FieldKind::Date,
5185 FieldKind::DateTime,
5186 FieldKind::Select,
5187 FieldKind::Checkbox,
5188 FieldKind::File,
5189 ] {
5190 assert!(!kind.measurable(), "{kind:?}");
5191 }
5192 }
5193
5194 #[test]
5195 fn a_field_carries_no_unit_until_one_is_given() {
5196 // Additive: absent is what every field described before 0.33.0 meant.
5197 let plain = Field::new(FieldKind::Number, "attack", "Attack");
5198 assert_eq!(plain.unit, None);
5199 let measured = Field {
5200 unit: Some("s"),
5201 ..Field::range("attack", "Attack", "0.001", "5")
5202 };
5203 assert_eq!(measured.unit, Some("s"));
5204 assert!(measured.kind.measurable());
5205 }
5206
5207 #[test]
5208 fn an_interval_states_both_ends_names() {
5209 // Stated rather than derived: the two measured sites disagree about
5210 // affix order, so a rule here would rename one of them.
5211 let suffixed = Field::interval("bpm_min", "bpm_max", "BPM");
5212 assert_eq!(suffixed.name, "bpm_min");
5213 assert_eq!(suffixed.upper_name, Some("bpm_max"));
5214 let prefixed = Field::interval("min_price", "max_price", "Price");
5215 assert_eq!(prefixed.name, "min_price");
5216 assert_eq!(prefixed.upper_name, Some("max_price"));
5217 assert_eq!(suffixed.kind, FieldKind::Interval);
5218 }
5219
5220 #[test]
5221 fn every_other_kind_has_no_upper_end() {
5222 // Additive: absent is what every field described before 0.34.0 meant.
5223 for kind in [FieldKind::Text, FieldKind::Number, FieldKind::Range] {
5224 assert_eq!(Field::new(kind, "n", "N").upper_name, None, "{kind:?}");
5225 }
5226 assert_eq!(Field::range("t", "T", "0", "1").upper_name, None);
5227 }
5228
5229 #[test]
5230 fn an_interval_owes_no_bounds_and_takes_the_axis_facts_once() {
5231 // A range's bounds are the control's extent and are owed; an interval's
5232 // are a rule on each end, which is Number's arrangement.
5233 let plain = Field::interval("bpm_min", "bpm_max", "BPM");
5234 assert!(!plain.bounded());
5235 let axis = Field {
5236 min: Some("0"),
5237 max: Some("300"),
5238 step: Some("1"),
5239 unit: Some("BPM"),
5240 ..Field::interval("bpm_min", "bpm_max", "BPM")
5241 };
5242 assert!(axis.bounded());
5243 assert_eq!(axis.unit, Some("BPM"));
5244 // Nothing here checks the crossing rule, exactly as nothing checks
5245 // `min` for a number: the description carries constraints and whoever
5246 // validated decides a value is wrong.
5247 assert!(axis.error.is_none());
5248 }
5249
5250 #[test]
5251 fn only_a_subtree_prunes_and_only_the_listing_modes_offer_values() {
5252 // Excluding a value from a flat facet is the same fact as not picking
5253 // it, so the affordance exists in exactly one mode.
5254 assert!(Selecting::Subtree.prunes());
5255 for mode in [
5256 Selecting::OneOf,
5257 Selecting::AnyOf,
5258 Selecting::Range,
5259 Selecting::Text,
5260 ] {
5261 assert!(!mode.prunes(), "{mode:?}");
5262 }
5263 // Text and Range answer with something that is not one of a set.
5264 assert!(!Selecting::Text.offers_values());
5265 assert!(!Selecting::Range.offers_values());
5266 assert!(Selecting::OneOf.offers_values());
5267 assert!(Selecting::AnyOf.accumulates());
5268 assert!(!Selecting::OneOf.accumulates());
5269 }
5270
5271 #[test]
5272 fn an_inherited_value_is_in_force_without_having_been_picked() {
5273 // The distinction a bool cannot hold, and the reason Standing has four
5274 // members: a child under a taken parent narrows the set, and clearing
5275 // it clears nothing.
5276 assert!(Standing::Inherited.in_force());
5277 assert!(!Standing::Inherited.is_picked());
5278 assert!(Standing::Taken.in_force());
5279 assert!(Standing::Taken.is_picked());
5280 // A prune is a decision that takes the value out.
5281 assert!(Standing::Pruned.is_picked());
5282 assert!(!Standing::Pruned.in_force());
5283 assert!(!Standing::Open.is_picked());
5284 assert!(!Standing::Open.in_force());
5285 // A pruned branch still answers a press, so it may not read as inert.
5286 assert_ne!(Standing::Pruned.intent(), "content-muted");
5287 }
5288
5289 #[test]
5290 fn a_facet_is_engaged_by_a_decision_and_not_by_an_inherited_value() {
5291 let inherited = [
5292 FacetValue::of("music")
5293 .standing(Standing::Taken)
5294 .at(0, true),
5295 FacetValue::new("music/synths", "synths")
5296 .standing(Standing::Inherited)
5297 .at(1, false),
5298 ];
5299 let facet = Facet::new("Tag", Selecting::Subtree, &inherited);
5300 assert!(facet.engaged());
5301 // The gutter an indenting renderer reserves before its first paint.
5302 assert_eq!(facet.reach(), 1);
5303
5304 let untouched = [
5305 FacetValue::of("music").at(0, true),
5306 FacetValue::new("music/synths", "synths")
5307 .standing(Standing::Inherited)
5308 .at(1, false),
5309 ];
5310 // Inherited alone is something further up doing the narrowing, and
5311 // there is nothing further up here.
5312 assert!(!Facet::new("Tag", Selecting::Subtree, &untouched).engaged());
5313
5314 // A text facet lists nothing, so it is flat and never reads as engaged
5315 // from its values: the typed string is not held here.
5316 let typed = Facet::new("Search", Selecting::Text, &[]);
5317 assert!(!typed.engaged());
5318 assert_eq!(typed.reach(), 0);
5319 }
5320
5321 #[test]
5322 fn a_count_is_absent_rather_than_zero_when_it_was_not_measured() {
5323 // Awaiting::amount's rule in a second place: a written zero reads as
5324 // "none of them", which is a different claim from "not counted".
5325 assert_eq!(FacetValue::of("Ambient").count, None);
5326 assert_eq!(FacetValue::of("Ambient").counted(0).count, Some(0));
5327 }
5328
5329 #[test]
5330 fn one_kind_takes_files_and_the_two_file_members_are_its_alone() {
5331 assert!(FieldKind::File.takes_files());
5332 for kind in [
5333 FieldKind::Text,
5334 FieldKind::Textarea,
5335 FieldKind::Rich,
5336 FieldKind::Select,
5337 FieldKind::Checkbox,
5338 FieldKind::Hidden,
5339 ] {
5340 assert!(!kind.takes_files());
5341 }
5342 // The default is a field that takes any one file, which is what an
5343 // input with no accept and no multiple already is.
5344 let plain = Field::new(FieldKind::File, "cover", "Cover");
5345 assert!(plain.accept.is_empty());
5346 assert!(!plain.multiple);
5347 }
5348
5349 #[test]
5350 fn an_accept_list_says_which_disclosure_and_a_suffix_says_none() {
5351 // The three shapes are the MNW server's own three, and the family is
5352 // the question a renderer asks before it keeps room for a preview.
5353 assert_eq!(
5354 Accepted::Family(Family::Image).family(),
5355 Some(Family::Image)
5356 );
5357 assert_eq!(Accepted::Type("image/jpeg").family(), Some(Family::Image));
5358 assert_eq!(Accepted::Type("audio/flac").family(), Some(Family::Audio));
5359 assert_eq!(
5360 Accepted::Type("video/quicktime").family(),
5361 Some(Family::Video)
5362 );
5363 // A media type outside the three families names none, and neither does
5364 // a suffix. `.mp3` is audio in fact and this crate will not infer it:
5365 // the table that said so would rot.
5366 assert_eq!(Accepted::Type("text/csv").family(), None);
5367 assert_eq!(Accepted::Suffix(".mp3").family(), None);
5368 assert_eq!(Accepted::Suffix(".tar.gz").family(), None);
5369 // Media types are case-insensitive and half the tree writes them
5370 // lowercase by habit rather than by rule.
5371 assert_eq!(Accepted::Type("IMAGE/PNG").family(), Some(Family::Image));
5372 }
5373
5374 #[test]
5375 fn every_accepted_entry_has_one_spelling_a_host_can_write() {
5376 assert_eq!(Accepted::Family(Family::Image).as_str(), "image/*");
5377 assert_eq!(Accepted::Family(Family::Audio).as_str(), "audio/*");
5378 assert_eq!(Accepted::Family(Family::Video).as_str(), "video/*");
5379 assert_eq!(Accepted::Type("text/csv").as_str(), "text/csv");
5380 assert_eq!(Accepted::Suffix(".tar.gz").as_str(), ".tar.gz");
5381 }
5382
5383 #[test]
5384 fn a_list_accepting_two_families_still_has_a_disclosure_to_offer() {
5385 // The measured dropzone: `accept="image/*,video/*"`. There is no single
5386 // family to return and there is still a preview to keep room for, which
5387 // is why the question is asked of the list rather than of one entry.
5388 const MEDIA: &[Accepted<'_>] = &[
5389 Accepted::Family(Family::Image),
5390 Accepted::Family(Family::Video),
5391 ];
5392 assert!(Field::upload("media", "Media", MEDIA).accepts_media());
5393 // An installer's suffix list wants no disclosure, which is the measured
5394 // case rather than a hypothetical one.
5395 const BUILDS: &[Accepted<'_>] = &[Accepted::Suffix(".zip"), Accepted::Suffix(".dmg")];
5396 assert!(!Field::upload("build", "Build", BUILDS).accepts_media());
5397 // And a field that takes anything says so by listing nothing.
5398 assert!(!Field::upload("any", "File", &[]).accepts_media());
5399 }
5400
5401 #[test]
5402 fn an_upload_carries_its_list_and_takes_one_file_until_it_says_otherwise() {
5403 const IMAGES: &[Accepted<'_>] = &[
5404 Accepted::Type("image/jpeg"),
5405 Accepted::Type("image/png"),
5406 Accepted::Type("image/webp"),
5407 ];
5408 let avatar = Field::upload("avatar", "Avatar", IMAGES);
5409 assert_eq!(avatar.kind, FieldKind::File);
5410 assert_eq!(avatar.accept, IMAGES);
5411 assert!(!avatar.multiple);
5412 let several = Field {
5413 multiple: true,
5414 ..avatar
5415 };
5416 assert!(several.multiple);
5417 }
5418
5419 #[test]
5420 fn the_four_readiness_states_are_one_axis_and_only_one_shows_content() {
5421 // Mutually exclusive is the test for one enum against several fields: a
5422 // region shows its content, or that it is coming, or that there is none,
5423 // or that it broke. Never two.
5424 assert!(Readiness::Ready.shows_content());
5425 for state in [Readiness::Pending, Readiness::Empty, Readiness::Failed] {
5426 assert!(!state.shows_content());
5427 }
5428 }
5429
5430 #[test]
5431 fn a_region_shows_all_of_its_children_unless_it_says_otherwise() {
5432 // The default is the behaviour every region had before this member
5433 // existed, which is what keeps it additive: a description written
5434 // against 0.22.0 says the same thing under 0.23.0.
5435 assert_eq!(Showing::default(), Showing::All);
5436 assert!(!Showing::All.selective());
5437 }
5438
5439 #[test]
5440 fn only_a_disclosure_can_show_nothing() {
5441 // The two derived idioms differ in one respect and this is it. A
5442 // carousel's row moves between frames and never reaches empty; a
5443 // disclosure's summary line is the same control wearing its closed
5444 // state, so a renderer has to know which it is drawing.
5445 assert!(Showing::AtMostOne.dismissible());
5446 assert!(!Showing::One.dismissible());
5447 assert!(!Showing::All.dismissible());
5448
5449 // Both are selective, though. Deriving chrome is one question and
5450 // whether that chrome closes is another.
5451 assert!(Showing::One.selective());
5452 assert!(Showing::AtMostOne.selective());
5453 }
5454
5455 #[test]
5456 fn an_empty_region_is_not_a_broken_one() {
5457 // An empty list is the normal state of a new install. Drawing it in a
5458 // danger tone reports a fault where there is none, and this is the one
5459 // place the distinction is carried.
5460 assert_eq!(Readiness::Empty.tone(), Tone::Neutral);
5461 assert_eq!(Readiness::Failed.tone(), Tone::Danger);
5462 assert_eq!(Readiness::Pending.tone(), Tone::Neutral);
5463 }
5464
5465 #[test]
5466 fn a_column_can_be_sorted_without_being_sortable() {
5467 // Both combinations mean something, which is why the two fields are
5468 // independent rather than one implying the other. A list ordered by a
5469 // key the user cannot change is a real thing with a caret worth drawing.
5470 let fixed = Column {
5471 sorted: Some(Sort::Descending),
5472 ..Column::new("Created")
5473 };
5474
5475 assert!(!fixed.sortable);
5476 assert_eq!(fixed.sorted.map(Sort::as_str), Some("descending"));
5477
5478 let offered = Column {
5479 sortable: true,
5480 ..Column::new("Name")
5481 };
5482 assert_eq!(offered.sorted, None);
5483 }
5484
5485 #[test]
5486 fn a_direction_flips_and_says_what_it_is() {
5487 assert_eq!(Sort::Ascending.reversed(), Sort::Descending);
5488 assert_eq!(Sort::Descending.reversed().reversed(), Sort::Descending);
5489 assert_eq!(Sort::Ascending.as_str(), "ascending");
5490 }
5491
5492 #[test]
5493 fn a_direction_carries_its_caret_and_the_two_are_not_the_same_glyph() {
5494 // The spelling every renderer reads, so that agreeing is composition
5495 // rather than three files happening to hold the same literal.
5496 assert_eq!(Sort::Ascending.glyph(), "\u{25B2}");
5497 assert_eq!(Sort::Descending.glyph(), "\u{25BC}");
5498 assert_ne!(Sort::Ascending.glyph(), Sort::Descending.glyph());
5499 // Bare. The gap is the renderer's, and a space here would be a second
5500 // one wherever a renderer already carries its own.
5501 for d in [Sort::Ascending, Sort::Descending] {
5502 assert_eq!(d.glyph().trim(), d.glyph());
5503 }
5504 }
5505
5506 #[test]
5507 fn a_figure_carries_its_tone_because_no_renderer_can_derive_it() {
5508 // Three of goingson's five sites tone the figure by their own means, so
5509 // tone is carried at every site that needs it and derived at none. The
5510 // same reasoning `Meter` reached, from a different direction.
5511 let streak = Figure::new("0", "Current Streak").tone(Tone::Warning);
5512 assert_eq!(streak.tone, Tone::Warning);
5513 assert_eq!(Figure::new("17", "Total").tone, Tone::Neutral);
5514 }
5515
5516 #[test]
5517 fn a_figures_change_is_the_toned_part_and_is_absent_by_default() {
5518 // 0.13.0. The MNW server's stat card is a label, a value and a delta,
5519 // across four screens, and the delta is what reads as good or bad. Tone
5520 // had no consumer before this: the figure itself is an ordinary fact.
5521 let views = Figure::new("1,204", "Views")
5522 .change("+12.5%")
5523 .tone(Tone::Success);
5524 assert_eq!(views.change, Some("+12.5%"));
5525 assert_eq!(views.tone, Tone::Success);
5526
5527 // A figure with nothing to compare against says so by having no change,
5528 // rather than by carrying an empty string a renderer has to test for.
5529 assert_eq!(Figure::new("3.1%", "Conversion").change, None);
5530 }
5531
5532 #[test]
5533 fn a_figures_value_is_text_because_only_the_app_knows_what_it_is() {
5534 // "84%", "12/30", "3d". A figure is whatever the app computed, already
5535 // formatted, and that is the line between this and `Meter`: a meter is
5536 // a proportion a renderer draws, a figure is a fact it sets in type.
5537 for value in ["84%", "12/30", "3d"] {
5538 assert_eq!(Figure::new(value, "Rate").value, value);
5539 }
5540 }
5541
5542 #[test]
5543 fn a_proportion_is_a_row_part_and_takes_no_intent_of_its_own() {
5544 // The meter carries the tone, so a part-level intent underneath would
5545 // fight it. Same answer `Tokens` needed, for the same reason.
5546 assert_eq!(RowPart::Proportion.intent(), RowPart::Tokens.intent());
5547 }
5548
5549 #[test]
5550 fn a_file_field_is_drawn_and_offers_no_options() {
5551 // It is a control the user operates, unlike `Hidden`, and it does not
5552 // pick from a list the description carries, unlike `Select`.
5553 assert!(FieldKind::File.visible());
5554 assert!(!FieldKind::File.offers_options());
5555 assert!(!FieldKind::File.confidential());
5556 }
5557
5558 #[test]
5559 fn a_constraint_is_a_fact_about_the_question_and_not_a_verdict() {
5560 // The whole model: the description carries the rule, the renderer emits
5561 // its host's idiom, and `error` is what arrives back when someone
5562 // validated. Nothing here decides a value is wrong.
5563 let field = Field {
5564 max_length: Some(100),
5565 min: Some("1"),
5566 max: Some("240"),
5567 required: true,
5568 ..Field::new(FieldKind::Number, "minutes", "Minutes")
5569 };
5570 assert!(!field.invalid());
5571
5572 // A bound is text because it is only a number for some of the kinds
5573 // that take one. goingson has both shapes live.
5574 let when = Field {
5575 min: Some("2026-08-09T14:30"),
5576 ..Field::new(FieldKind::Text, "starts", "Starts")
5577 };
5578 assert_eq!(when.min, Some("2026-08-09T14:30"));
5579 }
5580
5581 #[test]
5582 fn a_meter_keeps_the_over_run_the_percentage_throws_away() {
5583 // The whole reason this is a pair. goingson's `Task::time_progress`
5584 // clamps to 100 and then carries `is_over_estimate` beside it to say
5585 // what the clamp dropped; a meter says both from one fact.
5586 let over = Meter::new(45, 30);
5587 assert_eq!(over.percent(), 100);
5588 assert!(over.overflowing());
5589
5590 let exact = Meter::new(30, 30);
5591 assert_eq!(exact.percent(), over.percent());
5592 assert!(!exact.overflowing());
5593 }
5594
5595 #[test]
5596 fn an_empty_set_does_not_divide_by_zero() {
5597 // Sayable on purpose, so it has to be answerable. A meter over an
5598 // unloaded count is what an app actually has for a frame.
5599 let none = Meter::new(0, 0);
5600 assert_eq!(none.percent(), 0);
5601 assert!(none.is_empty());
5602 assert!(!none.overflowing());
5603 }
5604
5605 #[test]
5606 fn the_ratio_survives_where_a_percentage_would_not() {
5607 // Given 43 nothing can recover "3 of 7", which is why the numbers are
5608 // carried and the label names only the noun.
5609 let m = Meter::new(3, 7).label("subtasks");
5610 assert_eq!(m.percent(), 42);
5611 assert_eq!((m.done, m.total), (3, 7));
5612 assert_eq!(m.label, Some("subtasks"));
5613 }
5614
5615 #[test]
5616 fn tone_is_carried_because_no_renderer_can_derive_it() {
5617 // The same fullness means opposite things on two of goingson's bars,
5618 // and only the app knows which.
5619 let subtasks = Meter::new(9, 10).tone(Tone::Success);
5620 let estimate = Meter::new(9, 10).tone(Tone::Danger);
5621 assert_eq!(subtasks.percent(), estimate.percent());
5622 assert_ne!(subtasks.tone, estimate.tone);
5623 // Untoned by default: a bar says nothing about status until something
5624 // says so, the same way a row is not selectable until told.
5625 assert_eq!(Meter::new(9, 10).tone, Tone::Neutral);
5626 }
5627
5628 #[test]
5629 fn an_act_is_reachable_until_it_is_disabled() {
5630 // The one member a renderer must branch on, and since 0.19.0 the only
5631 // member there is. A stated state is not by itself a reason to stop
5632 // answering, which is the distinction `State` makes and every
5633 // hand-rolled button in the tree had to remember.
5634 assert!(!Act::new("Save").disabled());
5635 assert!(Act::new("Save").state(State::Disabled).disabled());
5636 }
5637
5638 #[test]
5639 fn an_act_carries_its_key_because_a_terminal_has_nothing_else() {
5640 // No key is the ordinary case, and the webview hosts that ignore it
5641 // are why it stayed optional.
5642 assert_eq!(Act::new("Delete").key, None);
5643 let quit = Act::new("Quit").key("q").tone(Tone::Danger);
5644 assert_eq!(quit.key, Some("q"));
5645 assert_eq!(quit.tone, Tone::Danger);
5646 }
5647
5648 #[test]
5649 fn a_meter_does_not_overflow_on_large_counts() {
5650 // done * 100 in u32 would wrap somewhere past 42 million. Counts that
5651 // size are not tasks, but a description layer that silently reports 3%
5652 // for a full bar is worse than one that is slow.
5653 let big = Meter::new(u32::MAX, u32::MAX);
5654 assert_eq!(big.percent(), 100);
5655 assert!(!big.overflowing());
5656 }
5657
5658 #[test]
5659 fn inset_is_raised_with_the_light_moved() {
5660 let (rl, rd) = Bevel::Raised.edges();
5661 let (il, id) = Bevel::Inset.edges();
5662 assert_eq!((rl, rd), (Edge::Light, Edge::Dark));
5663 assert_eq!((il, id), (rd, rl));
5664 }
5665
5666 #[test]
5667 fn pressing_twice_is_a_no_op() {
5668 for b in [Bevel::Raised, Bevel::Inset] {
5669 assert_eq!(b.pressed().pressed(), b);
5670 }
5671 }
5672
5673 #[test]
5674 fn a_raised_region_is_never_filled_with_a_recessed_surface() {
5675 // The bug this vocabulary exists to make unrepresentable.
5676 assert_eq!(Depth::Raised.fill(), Some(Fill::Raised));
5677 assert_eq!(Depth::Raised.bevel(), Some(Bevel::Raised));
5678 assert_eq!(Depth::Well.bevel(), Some(Bevel::Inset));
5679 assert_ne!(Depth::Well.fill(), Depth::Raised.fill());
5680 }
5681
5682 #[test]
5683 fn state_is_orthogonal_to_depth() {
5684 // The reason State is its own axis and not a Depth member: a disabled
5685 // button and a disabled field are both disabled and are not the same
5686 // shape, which one shared variant could not have said.
5687 assert_eq!(Depth::Raised.fill(), Some(Fill::Raised));
5688 assert_eq!(Depth::Well.fill(), Some(Fill::Well));
5689 assert!(State::Disabled.suppresses_interaction());
5690 }
5691
5692 #[test]
5693 fn only_disabled_stops_answering() {
5694 // Kept in spirit from the version where `Focus` was the counter-example:
5695 // suppressing interaction is `Disabled`'s alone, so a member added here
5696 // later does not get to inherit it by being a state.
5697 assert!(State::Disabled.suppresses_interaction());
5698 }
5699
5700 #[test]
5701 fn disabled_resolves_against_an_intent_makeover_already_derives() {
5702 // No new token, so this costs no `makeover` release.
5703 assert_eq!(State::Disabled.token(), "content-muted");
5704 }
5705
5706 #[test]
5707 fn flat_has_neither_edge_nor_fill() {
5708 assert_eq!(Depth::Flat.bevel(), None);
5709 assert_eq!(Depth::Flat.fill(), None);
5710 }
5711
5712 #[test]
5713 fn sunken_is_recessed_by_colour_with_no_edge() {
5714 // The one member carrying a fill without a bevel. A renderer that
5715 // assumes the two arrive together drops the fill silently, which is
5716 // exactly what makeover-webview did before 0.3.0.
5717 assert_eq!(Depth::Sunken.fill(), Some(Fill::Sunken));
5718 assert_eq!(Depth::Sunken.bevel(), None);
5719 }
5720
5721 #[test]
5722 fn sunken_and_flat_are_different_claims() {
5723 // Both edgeless, and only one of them needs a colour. Collapsing them
5724 // is what left an unchosen tab unsayable.
5725 assert_eq!(Depth::Flat.bevel(), Depth::Sunken.bevel());
5726 assert_ne!(Depth::Flat.fill(), Depth::Sunken.fill());
5727 }
5728
5729 #[test]
5730 fn a_sunken_surface_is_not_a_well() {
5731 // Authored in opposite directions: makeover derives surface-well by
5732 // inverting against the theme's content colour, while surface-sunken is
5733 // authored and may sit darker than raised.
5734 assert_ne!(Fill::Sunken, Fill::Well);
5735 assert_eq!(Fill::Sunken.token(), "surface-sunken");
5736 assert_eq!(Fill::Well.token(), "surface-well");
5737 }
5738
5739 #[test]
5740 fn every_selector_describes_both_of_its_states() {
5741 // The gap 0.3.0 closed. Before it, only `chosen` existed and the
5742 // unchosen option fell through to Flat at every renderer.
5743 for s in [Selector::Tabs, Selector::Segmented, Selector::Toggle] {
5744 assert_ne!(
5745 s.chosen(),
5746 s.unchosen(),
5747 "{s:?} cannot tell picked from unpicked"
5748 );
5749 }
5750 }
5751
5752 #[test]
5753 fn only_a_tab_inverts_the_other_way() {
5754 // Tabs recede so the chosen one comes forward; a segment and a toggle
5755 // stand up so the chosen one is held in. That inversion is the whole
5756 // content of "picked" once colour is deferred, and it is why the three
5757 // are not one member with a flag.
5758 assert_eq!(Selector::Tabs.unchosen(), Depth::Sunken);
5759 assert_eq!(Selector::Tabs.chosen(), Depth::Raised);
5760
5761 for s in [Selector::Segmented, Selector::Toggle] {
5762 assert_eq!(s.unchosen(), Depth::Raised);
5763 assert_eq!(s.chosen(), Depth::Well);
5764 // Held in is what pressing produces: one appearance, two reasons.
5765 assert_eq!(s.unchosen().pressed(), s.chosen());
5766 }
5767 }
5768
5769 #[test]
5770 fn pressing_a_card_makes_a_well() {
5771 assert_eq!(Depth::Raised.pressed(), Depth::Well);
5772 assert_eq!(
5773 Depth::Raised.pressed().bevel(),
5774 Depth::Raised.bevel().map(Bevel::pressed)
5775 );
5776 // Only raised regions respond to being pressed.
5777 assert_eq!(Depth::Flat.pressed(), Depth::Flat);
5778 assert_eq!(Depth::Well.pressed(), Depth::Well);
5779 // An overlay is a surface, not a control.
5780 assert_eq!(Depth::Overlay.pressed(), Depth::Overlay);
5781 }
5782
5783 #[test]
5784 fn an_overlay_is_lifted_rather_than_edged() {
5785 // The wave-2 rule: a surface over the page takes elevation, a surface
5786 // in the page takes a bevel. Both halves come off the one Depth, so
5787 // they cannot disagree.
5788 assert_eq!(Depth::Overlay.fill(), Some(Fill::Overlay));
5789 assert_eq!(Depth::Overlay.bevel(), None);
5790
5791 // Three depths have no bevel and they are not the same claim. Flat has
5792 // nothing to separate from, Sunken's colour is doing the separating,
5793 // and an overlay is separated by the lift.
5794 assert_ne!(Depth::Overlay.fill(), Depth::Sunken.fill());
5795 assert_ne!(Depth::Overlay.fill(), Depth::Flat.fill());
5796 }
5797
5798 #[test]
5799 fn intents_name_makeover_tokens_and_nothing_else() {
5800 assert_eq!(Edge::Light.token(), "bevel-light");
5801 assert_eq!(Edge::Dark.token(), "bevel-dark");
5802 assert_eq!(Fill::Raised.token(), "surface-raised");
5803 assert_eq!(Fill::Well.token(), "surface-well");
5804 // No value ever leaves this crate.
5805 for t in [
5806 Edge::Light.token(),
5807 Edge::Dark.token(),
5808 Tone::Danger.token(),
5809 Tone::Neutral.token(),
5810 State::Disabled.token(),
5811 ] {
5812 assert!(!t.starts_with('#'), "{t} looks like a value");
5813 assert!(
5814 !t.chars().next().unwrap().is_ascii_digit(),
5815 "{t} is a value"
5816 );
5817 }
5818 }
5819
5820 #[test]
5821 fn a_badge_cannot_be_pressed_and_a_chip_latches() {
5822 // The one line that runs through all three apps' taxonomies.
5823 assert!(!Token::Badge.interactive());
5824 assert!(Token::Chip { removable: false }.interactive());
5825 assert!(Token::Chip { removable: true }.interactive());
5826
5827 // A badge is a label, so giving it an edge would lie about it.
5828 assert_eq!(Token::Badge.depth(false), Depth::Flat);
5829 assert_eq!(Token::Badge.depth(true), Depth::Flat);
5830
5831 // A latched chip wears the same shape a pressed one does.
5832 let chip = Token::Chip { removable: false };
5833 assert_eq!(chip.depth(false), Depth::Raised);
5834 assert_eq!(chip.depth(true), Depth::Raised.pressed());
5835 }
5836
5837 #[test]
5838 fn a_toast_and_a_banner_differ_in_more_than_placement() {
5839 assert!(Notice::Toast.transient());
5840 assert!(!Notice::Banner.transient());
5841 // A toast floats above the page; a banner rests in the flow.
5842 assert_eq!(Notice::Toast.fill(), Fill::Overlay);
5843 assert_eq!(Notice::Banner.fill(), Fill::Raised);
5844 }
5845
5846 #[test]
5847 fn emphasis_falls_off_down_the_row() {
5848 // `revealed_on_hover` was asserted here until 0.13.0 retired it. It said
5849 // a row's actions stay hidden until hover, which stopped being true when
5850 // makeover-webview 0.23.0 showed them at rest, and nothing had consumed
5851 // it for a release either way.
5852 assert_eq!(RowPart::Primary.intent(), "content");
5853 assert_eq!(RowPart::Secondary.intent(), "content-secondary");
5854 assert_eq!(RowPart::Meta.intent(), "content-muted");
5855 }
5856
5857 #[test]
5858 fn a_token_part_carries_no_intent_of_its_own() {
5859 // Each token carries its own tone, so a part-level intent underneath
5860 // would fight the thing sitting on it. Same reasoning as actions, which
5861 // is why they answer alike.
5862 assert_eq!(RowPart::Tokens.intent(), RowPart::Actions.intent());
5863 assert_eq!(RowPart::Tokens.intent(), "content");
5864 }
5865
5866 #[test]
5867 fn the_two_temporal_kinds_are_the_two_that_name_a_moment() {
5868 // The pair is named once so a host with parsing to do asks here rather
5869 // than spelling it out, which is `offers_options`' reason.
5870 assert!(FieldKind::Date.temporal());
5871 assert!(FieldKind::DateTime.temporal());
5872
5873 for kind in [
5874 FieldKind::Text,
5875 FieldKind::Secret,
5876 FieldKind::Number,
5877 FieldKind::Email,
5878 FieldKind::Url,
5879 FieldKind::Tel,
5880 FieldKind::Range,
5881 FieldKind::Textarea,
5882 FieldKind::Rich,
5883 FieldKind::Select,
5884 FieldKind::Radio,
5885 FieldKind::Checkbox,
5886 FieldKind::File,
5887 FieldKind::Hidden,
5888 ] {
5889 assert!(!kind.temporal(), "{kind:?}");
5890 }
5891 }
5892
5893 #[test]
5894 fn a_date_carries_no_time_and_a_datetime_carries_no_zone() {
5895 // The formats are the whole reason the members are worth naming apart
5896 // from text, so the doc comments and the constants have to agree. A
5897 // host reading one and meeting the other is the silent failure.
5898 assert_eq!(DATE_FORMAT, "%Y-%m-%d");
5899 assert!(!DATE_FORMAT.contains("%H"), "a day carries no hour");
5900
5901 assert_eq!(DATETIME_FORMAT, "%Y-%m-%dT%H:%M");
5902 assert!(
5903 DATETIME_FORMAT.starts_with(DATE_FORMAT),
5904 "a moment starts with the day it is on"
5905 );
5906 // Local, and that is a property of the value rather than an omission.
5907 assert!(!DATETIME_FORMAT.contains("%Z"), "no zone name");
5908 assert!(!DATETIME_FORMAT.ends_with('Z'), "not UTC-stamped");
5909 assert!(!DATETIME_FORMAT.contains("%S"), "no seconds by default");
5910 }
5911
5912 #[test]
5913 fn a_temporal_kind_takes_a_label_above_it_and_offers_no_options() {
5914 // Neither is a checkbox and neither is a fixed set, so both fall where
5915 // text does. Asserted because a new kind lands in three predicates and
5916 // only one of them is the interesting one.
5917 for kind in [FieldKind::Date, FieldKind::DateTime] {
5918 assert!(kind.visible(), "{kind:?}");
5919 assert!(!kind.confidential(), "{kind:?}");
5920 assert!(!kind.labels_itself(), "{kind:?}");
5921 assert!(!kind.offers_options(), "{kind:?}");
5922 }
5923 }
5924
5925 #[test]
5926 fn a_cell_part_names_an_intent_and_only_the_value_is_text() {
5927 // The table half of what RowPart::intent does for rows. A cell holding
5928 // a control and a cell holding text answered alike until 0.14.0, and a
5929 // control in a cell took the cell's text colour.
5930 assert_eq!(CellPart::Value.intent(), "content");
5931
5932 for part in [CellPart::Tokens, CellPart::Actions, CellPart::Link] {
5933 // Each for its own reason -- a token carries its tone, an action is
5934 // a control, a link takes the action colour -- and all three reach
5935 // the intent inheriting already gives.
5936 assert_eq!(part.intent(), CellPart::Value.intent(), "{part:?}");
5937 }
5938 }
5939
5940 #[test]
5941 fn every_cell_part_answers_with_a_token_and_never_a_value() {
5942 for part in [
5943 CellPart::Value,
5944 CellPart::Tokens,
5945 CellPart::Actions,
5946 CellPart::Link,
5947 ] {
5948 let intent = part.intent();
5949 assert!(!intent.is_empty(), "{part:?} names nothing");
5950 assert!(!intent.starts_with('#'), "{part:?} looks like a value");
5951 }
5952 }
5953
5954 #[test]
5955 fn a_separator_is_what_tells_a_section_from_a_subsection() {
5956 assert!(Heading::Section.separated());
5957 assert!(!Heading::Subsection.separated());
5958 assert!(!Heading::Page.separated());
5959 }
5960
5961 #[test]
5962 fn a_chosen_segment_is_held_in_and_a_chosen_tab_comes_forward() {
5963 assert_eq!(Selector::Segmented.chosen(), Depth::Well);
5964 assert_eq!(Selector::Toggle.chosen(), Depth::Well);
5965 // The exception, and the whole folder semantic: the open tab joins its
5966 // pane rather than sinking away from it.
5967 assert_eq!(Selector::Tabs.chosen(), Depth::Raised);
5968
5969 // A held-in segment is indistinguishable from a pressed raised one,
5970 // which is the economy the light model buys over a colour swap.
5971 assert_eq!(Selector::Segmented.chosen(), Depth::Raised.pressed());
5972
5973 // A toggle stands alone; the other two are built out of parts that
5974 // touch.
5975 assert!(Selector::Segmented.abutting());
5976 assert!(Selector::Tabs.abutting());
5977 assert!(!Selector::Toggle.abutting());
5978 }
5979
5980 #[test]
5981 fn columns_are_peers_and_a_split_is_not() {
5982 // The distinction the member exists for. A split's two panes stand in a
5983 // master-detail relationship; columns choose nothing about each other.
5984 // Both are flat, so depth cannot tell them apart and the doc has to.
5985 assert_eq!(Region::Columns.depth(), Depth::Flat);
5986 assert_eq!(Region::Split.depth(), Depth::Flat);
5987 assert_ne!(Region::Columns, Region::Split);
5988 }
5989
5990 #[test]
5991 fn columns_carry_no_count_and_no_share() {
5992 // The two things a board is always asked to carry and must not. How
5993 // many is what the children say; how wide is settled by "peers are
5994 // equal".
5995 //
5996 // The guard is the binding itself and it is a compile-time one: adding
5997 // a field to `Columns` stops this line compiling, which is a better
5998 // failure than any assertion about it. Written out rather than inlined
5999 // for exactly that reason.
6000 let columns: Region<'_> = Region::Columns;
6001 assert_eq!(columns.name(), None);
6002 }
6003
6004 #[test]
6005 fn columns_are_described_and_the_escape_hatch_is_still_one_member() {
6006 // A board's contents are ordinary description all the way down, so a
6007 // renderer that does not lay them across still draws every column.
6008 // Stacking them vertically is honouring this member, not degrading it.
6009 assert!(Region::Columns.described());
6010 assert!(!Region::Bespoke { name: "timeline" }.described());
6011 }
6012
6013 #[test]
6014 fn a_span_never_has_zero_minutes_however_it_is_asked_for() {
6015 // Every renderer divides by this. A caller passing a backwards or empty
6016 // span is a bug, but it is not a bug worth a panic three renderers deep.
6017 assert_eq!(Span::new(600, 600).length(), 1);
6018 assert_eq!(Span::new(600, 300).length(), 1);
6019 assert_eq!(Span::DAY.length(), 1440);
6020 }
6021
6022 #[test]
6023 fn a_span_can_run_past_midnight_without_a_second_date() {
6024 // 22:00 to 02:00. The alternative was carrying a date, which drags a
6025 // timezone into the vocabulary for the sake of one night shift.
6026 let overnight = Span::new(1320, 1560);
6027 assert_eq!(overnight.length(), 240);
6028 assert!(overnight.holds(1500));
6029 assert!(!overnight.holds(1200));
6030 }
6031
6032 #[test]
6033 fn overlap_is_computed_rather_than_declared() {
6034 // The reason Placement carries no `conflicts` flag: the times already
6035 // say it, and a second source for one fact is how a stale conflict
6036 // badge outlives the conflict.
6037 let morning = Placement::new(540, 60); // 09:00-10:00
6038 let overlapping = Placement::new(570, 60); // 09:30-10:30
6039 let after = Placement::new(600, 60); // 10:00-11:00
6040
6041 assert!(morning.overlaps(overlapping));
6042 assert!(overlapping.overlaps(morning), "overlap is symmetric");
6043 // Touching end to end is not overlapping: `to` is exclusive, so a
6044 // 10:00 start does not collide with a 10:00 end.
6045 assert!(!morning.overlaps(after));
6046 assert!(!after.overlaps(morning));
6047 }
6048
6049 #[test]
6050 fn a_placement_is_always_drawable() {
6051 assert_eq!(Placement::new(540, 0).length(), 1);
6052 assert_eq!(Placement::new(540, 30).end(), 570);
6053 }
6054
6055 #[test]
6056 fn a_track_places_the_fraction_every_renderer_would_otherwise_compute() {
6057 let day = Track::DAY;
6058 assert!((day.fraction(0) - 0.0).abs() < f32::EPSILON);
6059 assert!((day.fraction(720) - 0.5).abs() < f32::EPSILON);
6060 // Clamped rather than off the end: an event running past the span's
6061 // close draws at the edge, which beats panicking or drawing nowhere.
6062 assert!((day.fraction(2000) - 1.0).abs() < f32::EPSILON);
6063 }
6064
6065 #[test]
6066 fn a_track_counts_its_slots_and_never_divides_by_zero() {
6067 assert_eq!(Track::DAY.slots(), 96);
6068 assert_eq!(Track::over(Span::new(540, 1020)).slots(), 32);
6069 // A span that does not divide evenly keeps a slot for its tail.
6070 assert_eq!(Track::over(Span::new(0, 50)).slots(), 4);
6071 // slot: 0 is a caller bug that reads as one slot, not a panic.
6072 let degenerate = Track {
6073 span: Span::DAY,
6074 slot: 0,
6075 tick: 60,
6076 unit: Unit::Minutes,
6077 };
6078 assert_eq!(degenerate.slots(), 1);
6079 }
6080
6081 #[test]
6082 fn a_track_carries_facts_and_no_presentation() {
6083 // The guard on the thing the withdrawn refusal was right about. If a
6084 // pixel measure, a scroll offset or a colour ever lands on Track, the
6085 // member has stopped being a fact about the data and the timeline
6086 // really has become a component library wearing a description's name.
6087 let day = Track::DAY;
6088 assert_eq!(day.span, Span::DAY);
6089 assert_eq!(day.slot, 15);
6090 assert_eq!(day.tick, 60);
6091 assert_eq!(day.unit, Unit::Minutes);
6092
6093 // Three fields when this was written, and the fourth came here to say
6094 // why, which is the whole point of the assertion. `unit` is what the
6095 // integers COUNT -- a fact about the data, unavailable from the numbers
6096 // themselves, and the absence of it is what let a month strip render
6097 // under a wall clock. A fifth field still has to argue, and "the
6098 // renderer would find it handy" is still not the argument.
6099 // Destructured rather than rebuilt: this is the form that names every
6100 // field and stops compiling when a fifth arrives, without binding
6101 // anything a lint has to forgive.
6102 let Track {
6103 span: _,
6104 slot: _,
6105 tick: _,
6106 unit: _,
6107 } = day;
6108 }
6109
6110 #[test]
6111 fn a_day_strip_is_the_same_arithmetic_under_a_different_unit() {
6112 // The probe that found the defect, kept as a test. Fifteen days from
6113 // day three, on a thirty-one day month: the geometry was always right
6114 // and only the label was wrong, which is why `unit` is a fact and not
6115 // presentation.
6116 let march = Track::days(Span::new(0, 31));
6117 assert_eq!(march.slots(), 31);
6118 assert_eq!(march.unit, Unit::Days);
6119
6120 let leave = Placement::new(2, 15);
6121 assert!((march.fraction(leave.at()) - 2.0 / 31.0).abs() < 0.0001);
6122 assert!((march.fraction(leave.end()) - 17.0 / 31.0).abs() < 0.0001);
6123 }
6124
6125 #[test]
6126 fn a_pane_is_looked_into_and_a_band_is_not() {
6127 assert_eq!(Region::Pane.depth(), Depth::Well);
6128 assert_eq!(Region::Modal.depth(), Depth::Raised);
6129 for r in [
6130 Region::Band,
6131 Region::Sidebar,
6132 Region::Group,
6133 Region::Split,
6134 Region::TabGroup,
6135 ] {
6136 assert_eq!(r.depth(), Depth::Flat, "{r:?} should carry no edge");
6137 }
6138 }
6139
6140 #[test]
6141 fn exactly_one_region_is_opaque() {
6142 // The escape hatch is one member and stays one member. If a second
6143 // undescribed region ever appears, the description has started
6144 // conceding rather than deferring.
6145 for r in [
6146 Region::Band,
6147 Region::Sidebar,
6148 Region::Pane,
6149 Region::Group,
6150 Region::Split,
6151 Region::TabGroup,
6152 Region::Modal,
6153 // A widget is described, and that is the whole of what separates it
6154 // from a bespoke here. Both carry a name this crate never reads;
6155 // only one of them has contents under it that a renderer which does
6156 // not know the name can still walk.
6157 Region::Widget { name: "carousel" },
6158 ] {
6159 assert!(r.described(), "{r:?} should be describable");
6160 }
6161 assert!(!Region::Bespoke { name: "day-plan" }.described());
6162 }
6163
6164 #[test]
6165 fn a_picture_that_says_nothing_is_a_claim_and_not_an_oversight() {
6166 // The distinction a renderer with no graphics protocol runs on: draw
6167 // the words, or draw nothing. Standing in for a decorative rule with
6168 // the word "decoration" is worse than leaving the space empty.
6169 assert!(Image::new("The library view, mid-import").speaks());
6170 assert!(!Image::new("").speaks());
6171 }
6172
6173 #[test]
6174 fn a_caption_and_alt_text_are_not_the_same_line() {
6175 // A caption is content everybody reads; alt text stands in for the
6176 // picture. A screenshot with a caption still needs alt text.
6177 let shot = Image::new("A file list with three rows selected").caption("The library view");
6178 assert_eq!(shot.caption, Some("The library view"));
6179 assert!(shot.speaks());
6180 assert_ne!(shot.alt, shot.caption.unwrap());
6181 }
6182
6183 #[test]
6184 fn a_picture_can_say_how_much_room_to_hold() {
6185 // The whole point: a renderer reserves from the ratio, so the space is
6186 // right at any width. A fixed height would only be right at one.
6187 let shot = Image::new("a screenshot").intrinsic(5120, 3412);
6188 let e = shot.intrinsic.expect("carried");
6189 assert_eq!((e.width, e.height), (5120, 3412));
6190 assert!((e.ratio().unwrap() - 1.5006).abs() < 0.001);
6191 }
6192
6193 #[test]
6194 fn a_picture_with_no_dimensions_reserves_nothing_rather_than_guessing() {
6195 // `None` is honest: a creator upload whose size was never recorded does
6196 // not know it. A renderer must not invent one.
6197 assert_eq!(Image::new("unknown upload").intrinsic, None);
6198 assert_eq!(Extent::new(0, 10).ratio(), None);
6199 assert_eq!(Extent::new(10, 0).ratio(), None);
6200 }
6201
6202 #[test]
6203 fn a_picture_is_wanted_now_unless_the_app_says_otherwise() {
6204 // Eager is the safe default and lazy is the opt-in, because deferring
6205 // something already on screen saves nothing and moves its shift later.
6206 assert_eq!(Image::new("hero").loading, Loading::Eager);
6207 assert_eq!(Loading::default(), Loading::Eager);
6208 assert_eq!(Image::new("frame 2").lazy().loading, Loading::Lazy);
6209 }
6210
6211 #[test]
6212 fn a_picture_keeps_its_own_proportions_unless_told_otherwise() {
6213 // The default is the one that shows the whole picture at its own shape,
6214 // so a renderer ignoring Fit entirely is still right about the common
6215 // case. The shipped MNW carousel sets no object-fit at all, which is
6216 // this.
6217 assert_eq!(Image::new("a").fit, Fit::Natural);
6218 assert_eq!(Fit::default(), Fit::Natural);
6219 assert_eq!(Image::new("a").fit(Fit::Cover).fit, Fit::Cover);
6220 }
6221
6222 #[test]
6223 fn a_group_contains_a_section_without_claiming_to_be_a_pane() {
6224 // The whole of why this is a member rather than a `Pane`. A pane is
6225 // looked into and scrolls; a group is neither, and four groups inside a
6226 // settings pane described as panes are four wells inside a well.
6227 assert_eq!(Region::Pane.depth(), Depth::Well);
6228 assert_eq!(Region::Group.depth(), Depth::Flat);
6229 assert_ne!(Region::Group, Region::Pane);
6230
6231 // Described, and it carries no name: a group is a primitive every
6232 // renderer draws from scratch, which is what separates it from the two
6233 // members that do carry one.
6234 assert!(Region::Group.described());
6235 assert_eq!(Region::Group.name(), None);
6236 }
6237
6238 #[test]
6239 fn a_section_heading_names_a_block_that_now_exists() {
6240 // `Heading::Section` has said "names a block within the screen" since
6241 // 0.2.0 and there was no block. The pairing is the point, and it is the
6242 // reason a group carries no heading of its own: the heading is an
6243 // ordinary node in the body, and a group without one is legal.
6244 assert!(Heading::Section.separated());
6245 assert_eq!(Region::Group.depth(), Depth::Flat);
6246 }
6247
6248 #[test]
6249 fn a_widget_inherits_its_depth_the_way_a_bespoke_does() {
6250 // Stronger than the bespoke case: a widget is drawn by whichever
6251 // renderer recognises the name, so a depth chosen here would be this
6252 // crate deciding a carousel is raised on every host.
6253 assert_eq!(Region::Widget { name: "carousel" }.depth(), Depth::Flat);
6254 assert_eq!(Region::Widget { name: "pager" }.depth(), Depth::Flat);
6255 }
6256
6257 #[test]
6258 fn a_name_is_readable_without_asking_which_member_carried_it() {
6259 // A renderer dispatching on a name wants the string, not the member.
6260 // Writing that `matches!` at each renderer is how the two drift apart.
6261 assert_eq!(Region::Widget { name: "carousel" }.name(), Some("carousel"));
6262 assert_eq!(
6263 Region::Bespoke { name: "day-plan" }.name(),
6264 Some("day-plan")
6265 );
6266
6267 for r in [
6268 Region::Band,
6269 Region::Sidebar,
6270 Region::Pane,
6271 Region::Group,
6272 Region::Split,
6273 Region::TabGroup,
6274 Region::Modal,
6275 ] {
6276 assert_eq!(r.name(), None, "{r:?} names nothing an app chose");
6277 }
6278 }
6279
6280 #[test]
6281 fn a_bespoke_region_inherits_its_depth_rather_than_choosing_one() {
6282 // The app owns the contents, not the placement. An app that wants its
6283 // timeline in a well frames it in a Pane.
6284 assert_eq!(Region::Bespoke { name: "day-plan" }.depth(), Depth::Flat);
6285 assert_eq!(Region::Bespoke { name: "kanban" }.depth(), Depth::Flat);
6286 }
6287
6288 #[test]
6289 fn a_screen_with_a_bespoke_region_is_still_a_whole_screen() {
6290 // The argument the member exists for: goingson's day-plan has to be
6291 // routable, or the description covers only the boring screens and the
6292 // interesting four need a second path beside the router.
6293 let day_plan = [
6294 Region::Band,
6295 Region::Bespoke { name: "day-plan" },
6296 Region::Sidebar,
6297 ];
6298 assert_eq!(day_plan.iter().filter(|r| r.described()).count(), 2);
6299 assert_eq!(day_plan.iter().filter(|r| !r.described()).count(), 1);
6300 }
6301
6302 #[test]
6303 fn a_secret_field_is_marked_as_one_and_a_hidden_field_is_not_drawn() {
6304 let secret = Field::new(FieldKind::Secret, "password", "Password");
6305 assert!(secret.kind.confidential());
6306 assert!(secret.kind.visible());
6307
6308 assert!(!FieldKind::Hidden.visible());
6309 // Nothing else is confidential, or the marker means nothing.
6310 for k in [
6311 FieldKind::Text,
6312 FieldKind::Number,
6313 FieldKind::Textarea,
6314 FieldKind::Rich,
6315 FieldKind::Select,
6316 FieldKind::Checkbox,
6317 FieldKind::Hidden,
6318 ] {
6319 assert!(!k.confidential(), "{k:?} should not be confidential");
6320 }
6321
6322 // Only a checkbox carries its own label.
6323 assert!(FieldKind::Checkbox.labels_itself());
6324 assert!(!FieldKind::Text.labels_itself());
6325 }
6326
6327 #[test]
6328 fn a_plain_field_offers_nothing_and_a_select_offers_its_options() {
6329 let text = Field::new(FieldKind::Text, "title", "Title");
6330 assert!(text.options.is_empty());
6331 assert_eq!(text.placeholder, None);
6332
6333 let sizes = [Choice::plain("small"), Choice::plain("large")];
6334 let select = Field::select("size", "Size", &sizes);
6335 assert_eq!(select.kind, FieldKind::Select);
6336 assert_eq!(select.options.len(), 2);
6337 }
6338
6339 #[test]
6340 fn a_choice_says_what_submits_and_what_is_read_apart() {
6341 // The whole reason it is two strings. `plain` is the case where they
6342 // coincide, and it is a shorthand rather than the general shape.
6343 let plain = Choice::plain("7");
6344 assert_eq!((plain.value, plain.label), ("7", "7"));
6345
6346 let spelled = Choice::new("7", "One week");
6347 assert_ne!(spelled.value, spelled.label);
6348 assert!(
6349 spelled.available(),
6350 "an option is pickable until it says not"
6351 );
6352 }
6353
6354 #[test]
6355 fn a_candidate_carries_the_line_that_tells_it_from_its_neighbours() {
6356 // The gap this type was born for: two candidates whose labels read
6357 // alike, told apart by the second string and by nothing else. The
6358 // measured site is the MNW tag box, where "Format" is a leaf under
6359 // audio, software, writing and video.
6360 let audio = Candidate::new("audio/format", "Format").detailed("Audio");
6361 let writing = Candidate::new("writing/format", "Format").detailed("Writing");
6362
6363 assert_eq!(audio.label, writing.label);
6364 assert_ne!(audio.detail, writing.detail);
6365 assert_ne!(
6366 audio, writing,
6367 "two rows a user cannot tell apart are two rows the type can"
6368 );
6369 }
6370
6371 #[test]
6372 fn a_candidate_is_read_differently_from_an_option_and_written_the_same() {
6373 // The ruling's own distinction, held as a test so the two types do not
6374 // drift back together. Submitting is identical; the second line is the
6375 // whole of what differs, and it is absent by default because a list of
6376 // distinct labels wants nothing there.
6377 let candidate = Candidate::plain("rust");
6378 assert_eq!((candidate.value, candidate.label), ("rust", "rust"));
6379 assert_eq!(
6380 candidate.detail, None,
6381 "one line unless the route says otherwise"
6382 );
6383
6384 let option = Choice::plain("rust");
6385 assert_eq!(
6386 (candidate.value, candidate.label),
6387 (option.value, option.label)
6388 );
6389 }
6390
6391 #[test]
6392 fn a_radio_asks_the_same_question_as_a_select_and_is_not_the_same_kind() {
6393 // Both offer a fixed set and both read `options`, so the two
6394 // constructors differ in exactly one thing. That one thing is the
6395 // point: a renderer decides whether the alternatives are readable
6396 // without opening anything, and it can only decide that if the
6397 // description said which question was asked.
6398 let styles = [
6399 Choice::new("copy", "Copy samples in"),
6400 Choice::new("reference", "Reference in place"),
6401 ];
6402 let radio = Field::radio("storage", "Storage style", &styles);
6403 let select = Field::select("storage", "Storage style", &styles);
6404
6405 assert_eq!(radio.kind, FieldKind::Radio);
6406 assert_ne!(radio.kind, select.kind);
6407 assert_eq!(radio.options, select.options);
6408 assert_eq!(
6409 Field {
6410 kind: select.kind,
6411 ..radio
6412 },
6413 select
6414 );
6415 }
6416
6417 #[test]
6418 fn an_unavailable_option_cannot_be_silent_about_it() {
6419 // The whole content of the one-member shape: saying an option is not
6420 // pickable and saying why are the same act, so the greyed-out-with-no-
6421 // reason state is unsayable rather than merely discouraged.
6422 let multi =
6423 Choice::new("multi", "Multi-sample").unless("Drop a second sample onto the keyboard.");
6424 assert!(!multi.available());
6425 assert_eq!(
6426 multi.unavailable,
6427 Some("Drop a second sample onto the keyboard.")
6428 );
6429
6430 // And the option is still in the list, carrying what it submits, so a
6431 // renderer draws it rather than the app dropping it.
6432 assert_eq!(multi.value, "multi");
6433 assert_eq!(multi.label, "Multi-sample");
6434 }
6435
6436 #[test]
6437 fn a_range_carries_both_ends_and_a_validated_number_need_not() {
6438 // The distinction the kind exists for, asserted rather than only
6439 // written down: bounds are a rule for one and the control itself for
6440 // the other.
6441 let threshold = Field::range("review", "Review above", "0", "1");
6442 assert_eq!(threshold.kind, FieldKind::Range);
6443 assert!(threshold.bounded());
6444 assert_eq!(threshold.min, Some("0"));
6445 assert_eq!(threshold.max, Some("1"));
6446 // Granularity is the host's until an app says otherwise.
6447 assert_eq!(threshold.step, None);
6448
6449 // goingson's duration: a typed number with a floor, and it must not
6450 // read as a slider.
6451 let minutes = Field {
6452 min: Some("1"),
6453 ..Field::new(FieldKind::Number, "minutes", "Minutes")
6454 };
6455 assert_ne!(minutes.kind, FieldKind::Range);
6456 assert!(!minutes.bounded(), "one end is a rule, not an extent");
6457 }
6458
6459 #[test]
6460 fn a_range_described_with_one_end_says_so_rather_than_being_refused() {
6461 // Nothing here enforces the pair, for the reason nothing here enforces
6462 // `required`: the description states the constraint and the renderer
6463 // asks. What it must not do is look bounded.
6464 let half = Field {
6465 max: Some("1"),
6466 ..Field::new(FieldKind::Range, "review", "Review above")
6467 };
6468 assert!(!half.bounded());
6469 }
6470
6471 #[test]
6472 fn exactly_the_option_taking_kinds_say_so() {
6473 // The renderers branch on this rather than on a list of their own, so
6474 // a kind added without a decision here renders its options nowhere.
6475 assert!(FieldKind::Select.offers_options());
6476 assert!(FieldKind::Radio.offers_options());
6477 for kind in [
6478 FieldKind::Text,
6479 FieldKind::Secret,
6480 FieldKind::Number,
6481 FieldKind::Email,
6482 FieldKind::Url,
6483 FieldKind::Tel,
6484 FieldKind::Range,
6485 FieldKind::Textarea,
6486 FieldKind::Rich,
6487 FieldKind::Checkbox,
6488 FieldKind::Hidden,
6489 ] {
6490 assert!(!kind.offers_options(), "{kind:?} does not offer options");
6491 }
6492 }
6493
6494 #[test]
6495 fn a_radio_group_takes_a_label_even_though_its_options_carry_their_own() {
6496 // The near-miss: each option is labelled beside its own button, so a
6497 // renderer could plausibly read the group as self-labelling and drop
6498 // the question. Checkbox is the only kind that does that.
6499 assert!(!FieldKind::Radio.labels_itself());
6500 assert!(FieldKind::Checkbox.labels_itself());
6501 }
6502
6503 #[test]
6504 fn a_select_with_no_options_is_sayable() {
6505 // An app whose option list has not loaded has exactly this. Making it
6506 // unrepresentable would push the state somewhere less visible, and a
6507 // renderer drawing an empty select reports it on screen.
6508 let loading = Field::select("project", "Project", &[]);
6509 assert!(loading.options.is_empty());
6510 }
6511
6512 #[test]
6513 fn the_description_carries_the_question_and_never_the_answer() {
6514 // The line 0.8.0 drew. Placeholder and options are properties of what
6515 // is being asked; the current value is what came back, and no field
6516 // here holds one.
6517 let f = Field {
6518 placeholder: Some("yyyy-mm-dd"),
6519 ..Field::new(FieldKind::Text, "due", "Due")
6520 };
6521 assert_eq!(f.placeholder, Some("yyyy-mm-dd"));
6522 // A placeholder is not a label, and having one does not excuse the
6523 // field from carrying the other.
6524 assert_eq!(f.label, "Due");
6525 }
6526
6527 #[test]
6528 fn a_field_reports_its_own_error_state() {
6529 let mut f = Field::new(FieldKind::Text, "title", "Title");
6530 assert!(!f.invalid());
6531 f.error = Some("Required");
6532 assert!(f.invalid());
6533 }
6534
6535 #[test]
6536 fn columns_drop_by_priority_and_never_by_position() {
6537 let cols = [
6538 Column {
6539 width: Width::Fill,
6540 priority: Priority::Essential,
6541 ..Column::new("Title")
6542 },
6543 Column {
6544 width: Width::Fixed,
6545 priority: Priority::Secondary,
6546 ..Column::new("Due")
6547 },
6548 Column {
6549 width: Width::Fixed,
6550 priority: Priority::Optional,
6551 ..Column::new("Estimate")
6552 },
6553 ];
6554
6555 // Widest: everything survives.
6556 assert_eq!(
6557 cols.iter()
6558 .filter(|c| c.kept_at(Priority::Optional))
6559 .count(),
6560 3
6561 );
6562 // Narrower: the optional column goes first.
6563 let kept: Vec<_> = cols
6564 .iter()
6565 .filter(|c| c.kept_at(Priority::Secondary))
6566 .map(|c| c.name)
6567 .collect();
6568 assert_eq!(kept, ["Title", "Due"]);
6569 // Narrowest: only what identifies the row.
6570 let kept: Vec<_> = cols
6571 .iter()
6572 .filter(|c| c.kept_at(Priority::Essential))
6573 .map(|c| c.name)
6574 .collect();
6575 assert_eq!(kept, ["Title"]);
6576 }
6577
6578 #[test]
6579 fn inserting_a_column_does_not_move_what_gets_dropped() {
6580 // The bug the ordinal form has and this form cannot: goingson hides
6581 // `nth-child(n+5)` against a seven-column table, so a column inserted
6582 // anywhere to the left silently hides a different one.
6583 let before = [
6584 Column::new("Title"),
6585 Column {
6586 width: Width::Fixed,
6587 priority: Priority::Optional,
6588 ..Column::new("Estimate")
6589 },
6590 ];
6591 let after = [
6592 Column::new("Title"),
6593 Column::new("Project"), // inserted
6594 Column {
6595 width: Width::Fixed,
6596 priority: Priority::Optional,
6597 ..Column::new("Estimate")
6598 },
6599 ];
6600
6601 fn dropped<'a>(cols: &[Column<'a>]) -> Vec<&'a str> {
6602 cols.iter()
6603 .filter(|c| !c.kept_at(Priority::Secondary))
6604 .map(|c| c.name)
6605 .collect()
6606 }
6607 assert_eq!(dropped(&before), ["Estimate"]);
6608 assert_eq!(dropped(&after), ["Estimate"]);
6609 }
6610
6611 #[test]
6612 fn an_arrangement_carries_the_tab_group_as_a_modifier() {
6613 // goingson uses the tab group inside the content region rather than
6614 // instead of one, so it is not a third arrangement.
6615 let go = Arrangement::list_detail(true);
6616 let plain = Arrangement::list_detail(false);
6617 assert_ne!(go, plain);
6618 assert_ne!(go, Arrangement::sidebar_content());
6619 }
6620
6621 #[test]
6622 fn a_share_is_a_proportion_and_resolves_the_same_way_everywhere() {
6623 // The point of the member: a terminal reading columns and a webview
6624 // reading a grid honour one fact, so two hosts showing one screen agree
6625 // about its proportions.
6626 assert_eq!(Share::LIST.as_percent(), 40);
6627 assert_eq!(Share::LIST.of(100), 40);
6628 assert_eq!(
6629 Share::SIDEBAR.of(96),
6630 24,
6631 "quasi-tui's 24 columns, said as a quarter"
6632 );
6633 }
6634
6635 #[test]
6636 fn a_region_never_resolves_to_nothing() {
6637 // A region the description named should be visible. A zero-width one
6638 // reads on screen as a region that vanished, which is the hardest kind
6639 // of bug to find from what is drawn.
6640 assert_eq!(Share::percent(5).of(1), 1);
6641 assert_eq!(Share::percent(5).of(0), 1);
6642 }
6643
6644 #[test]
6645 fn a_share_outside_the_range_is_clamped_rather_than_refused() {
6646 assert_eq!(Share::percent(0), Share::percent(5));
6647 assert_eq!(Share::percent(200), Share::percent(95));
6648 }
6649
6650 #[test]
6651 fn the_share_rides_on_the_arrangement_that_knows_which_question_it_is() {
6652 // How much a sidebar takes and how much a list side takes are different
6653 // questions, and this enum is the only thing that knows which is being
6654 // asked.
6655 assert_eq!(Arrangement::sidebar_content().share(), Share::SIDEBAR);
6656 assert_eq!(Arrangement::list_detail(false).share(), Share::LIST);
6657
6658 let narrow = Arrangement::sidebar_content().with_share(Share::percent(20));
6659 assert_eq!(narrow.share(), Share::percent(20));
6660 assert!(matches!(narrow, Arrangement::SidebarContent { .. }));
6661 }
6662
6663 #[test]
6664 fn a_measure_defaults_to_the_one_53_of_69_templates_asked_for() {
6665 // The default is meaningful: a screen nobody said anything about uses
6666 // the window it was given.
6667 assert_eq!(Measure::default(), Measure::Wide);
6668 assert_eq!(Measure::Reading.as_str(), "reading");
6669 }
6670
6671 #[test]
6672 fn readiness_names_the_state_and_not_the_shimmer() {
6673 // Two members and no third. If a skeleton ever appears in this enum,
6674 // the deferral rule has been broken.
6675 assert_ne!(Readiness::Ready, Readiness::Pending);
6676 }
6677
6678 #[test]
6679 fn a_window_with_no_length_still_answers_what_it_can() {
6680 // The uncounted case is the common one, not the degenerate one: a query
6681 // that asked for 51 to learn there were more than 50 knows there are,
6682 // and not how many.
6683 let uncounted = Window::new(100, 50);
6684 assert_eq!(uncounted.index(), Some(2));
6685 assert_eq!(uncounted.windows(), None);
6686 assert!(uncounted.has_before());
6687 // Unknown length cannot rule out more, and offering a way forward that
6688 // turns out empty is the cheaper mistake.
6689 assert!(uncounted.has_after());
6690 }
6691
6692 #[test]
6693 fn a_counted_window_knows_where_it_ends() {
6694 let last = Window::new(350, 50).of(400);
6695 assert_eq!(last.index(), Some(7));
6696 assert_eq!(last.windows(), Some(8));
6697 assert!(last.has_before());
6698 assert!(!last.has_after());
6699
6700 let first = Window::new(0, 50).of(400);
6701 assert!(!first.has_before());
6702 assert!(first.has_after());
6703 }
6704
6705 #[test]
6706 fn a_window_that_does_not_divide_evenly_rounds_up() {
6707 // 401 rows in pages of 50 is eight pages and a straggler, which is nine
6708 // pages. Rounding down would make the last one unreachable.
6709 assert_eq!(Window::new(0, 50).of(401).windows(), Some(9));
6710 }
6711
6712 #[test]
6713 fn a_zero_count_answers_none_rather_than_dividing() {
6714 let empty = Window::new(0, 0).of(400);
6715 assert_eq!(empty.index(), None);
6716 assert_eq!(empty.windows(), None);
6717 // And it still clamps rather than panicking.
6718 assert_eq!(Window::new(900, 0).of(400).clamped().from, 399);
6719 }
6720
6721 #[test]
6722 fn a_window_past_the_end_clamps_inside_rather_than_vanishing() {
6723 // `Slot::current`'s reasoning, one layer down: a description pointing
6724 // past the end is a host bug, and answering it by drawing nothing
6725 // reports a region that vanished.
6726 assert_eq!(Window::new(900, 50).of(400).clamped().from, 350);
6727 // Nothing to clamp against when the length is unknown.
6728 assert_eq!(Window::new(900, 50).clamped().from, 900);
6729 }
6730
6731 #[test]
6732 fn a_carousel_frame_is_a_window_of_one() {
6733 // The shape a carousel instantiates. Same code as a paged list, which is
6734 // the whole reason `Window` exists rather than two copies of it.
6735 let third = Window::frame(2, 5);
6736 assert_eq!(third.index(), Some(2));
6737 assert_eq!(third.windows(), Some(5));
6738 assert!(third.has_before());
6739 assert!(third.has_after());
6740
6741 let last = Window::frame(4, 5);
6742 assert!(!last.has_after());
6743 }
6744
6745 #[test]
6746 fn numbered_pages_read_from_one_and_load_more_has_no_page() {
6747 // The page number is read aloud, so it is one-based; `Window::index` is
6748 // the zero-based form for indexing.
6749 let third = Paging::pages(100, 50).of(400);
6750 assert_eq!(third.page(), Some(3));
6751 assert_eq!(third.pages_total(), Some(8));
6752 assert_eq!(third.total(), Some(400));
6753 assert!(third.has_previous());
6754 assert!(third.has_more());
6755
6756 // Load-more grew a window from the start, so "page 2" would name
6757 // nothing and the type says so rather than inventing one.
6758 let grown = Paging::more(150).of(400);
6759 assert_eq!(grown.page(), None);
6760 assert_eq!(grown.pages_total(), None);
6761 assert_eq!(grown.shown(), 150);
6762 assert!(!grown.has_previous());
6763 assert!(grown.has_more());
6764 }
6765
6766 #[test]
6767 fn an_uncounted_paging_offers_forward_and_admits_no_total() {
6768 // What a host that will not pay for a COUNT describes. `None` here is
6769 // permanent: a total arriving later would widen the text that prints it,
6770 // which is the reflow "first paint is final paint" forbids.
6771 let feed = Paging::more(50);
6772 assert_eq!(feed.total(), None);
6773 assert_eq!(feed.pages_total(), None);
6774 assert_eq!(feed.remaining(), None);
6775 assert!(feed.has_more());
6776 }
6777
6778 #[test]
6779 fn what_is_left_is_derived_and_never_underflows() {
6780 assert_eq!(Paging::more(150).of(400).remaining(), Some(250));
6781 assert_eq!(Paging::pages(350, 50).of(400).remaining(), Some(0));
6782 // A host that overshot its own total gets zero rather than a wrapped
6783 // usize, which would print as "18446744073709551516 remaining".
6784 assert_eq!(Paging::more(500).of(400).remaining(), Some(0));
6785 }
6786
6787 #[test]
6788 fn a_group_out_of_room_is_not_the_same_fact_as_a_narrow_window() {
6789 // The case the type exists for: 913px is a roomy window holding a group
6790 // that has run out of room, so room is measured against the group's own
6791 // allocation and never against the viewport.
6792 assert!(Room::Tight < Room::Ample);
6793 // A group nesting another has whichever room is scarcer, which is what
6794 // makes relief resolve inside-out rather than by declaration order.
6795 assert_eq!(Room::Ample.min(Room::Tight), Room::Tight);
6796 }
6797
6798 #[test]
6799 fn a_fallback_is_authored_and_a_group_cannot_omit_it() {
6800 // No `Default`. The compiler is what enforces rule 2, so the assertion
6801 // that matters is one this file cannot write; what it can say is that
6802 // the four authored answers are distinct and none is privileged.
6803 let all = [
6804 Fallback::Wrap,
6805 Fallback::Stack,
6806 Fallback::Shed,
6807 Fallback::Menu,
6808 ];
6809 for (i, a) in all.iter().enumerate() {
6810 for b in &all[i + 1..] {
6811 assert_ne!(a, b);
6812 }
6813 }
6814 }
6815
6816 #[test]
6817 fn shedding_stops_at_essential_whatever_the_group_holds() {
6818 // Priority is read the same way for a group member as for a column,
6819 // which is the whole claim of generalising it off `Column`.
6820 let members = [
6821 ("tabs", Priority::Essential),
6822 ("search", Priority::Secondary),
6823 ("count", Priority::Optional),
6824 ];
6825 let kept: Vec<_> = members
6826 .iter()
6827 .filter(|(_, p)| *p >= Priority::Essential)
6828 .map(|(n, _)| *n)
6829 .collect();
6830 assert_eq!(kept, ["tabs"]);
6831 }
6832
6833 #[test]
6834 fn a_role_says_what_a_part_is_worth_when_the_run_does_not_fit() {
6835 // The row still identifies itself after everything droppable has gone,
6836 // which is the property the ladder exists for.
6837 assert_eq!(RowPart::Primary.priority(), Priority::Essential);
6838 // A control is not a fact. Room comes out of what the row says, never
6839 // out of what it offers.
6840 assert_eq!(RowPart::Actions.priority(), Priority::Essential);
6841 assert_eq!(RowPart::Meta.priority(), Priority::Optional);
6842 assert_eq!(RowPart::Proportion.priority(), Priority::Optional);
6843 assert_eq!(RowPart::Secondary.priority(), Priority::Secondary);
6844 // Tokens sit in the middle deliberately: a toned badge is often the
6845 // most scannable thing in a row, so it does not go first.
6846 assert_eq!(RowPart::Tokens.priority(), Priority::Secondary);
6847 }
6848
6849 #[test]
6850 fn a_run_is_one_line_unless_the_description_says_two() {
6851 // The default is what every part did before flows existed, so a
6852 // description written against the old vocabulary keeps its rendering.
6853 assert_eq!(Flow::default(), Flow::Tight);
6854 assert_eq!(Flow::Tight.lines(), 1);
6855 assert_eq!(Flow::Relaxed.lines(), 2);
6856 }
6857
6858 #[test]
6859 fn an_unknown_flow_reads_as_one_line() {
6860 // `#[non_exhaustive]`'s cost, taken deliberately. A tier added upstream
6861 // reaches an old renderer as one line rather than as a build break, and
6862 // one line is the reading that cannot break a neighbour's layout. The
6863 // match in `lines` is what this holds; it fails if a new tier is given
6864 // an arm that returns something unbounded.
6865 for flow in [Flow::Tight, Flow::Relaxed] {
6866 assert!((1..=2).contains(&flow.lines()));
6867 }
6868 }
6869
6870 #[test]
6871 fn an_awaiting_mark_is_indeterminate_until_something_is_measured() {
6872 // The default is the common case: a call waits, and nothing about it is
6873 // countable. A determinate bar is the exception and says so.
6874 assert_eq!(Awaiting::default(), Awaiting::unmeasured());
6875 assert!(!Awaiting::unmeasured().is_determinate());
6876 assert!(Awaiting::of(40 * 1024 * 1024).is_determinate());
6877 assert_eq!(Awaiting::of(7).amount, Some(7));
6878 }
6879
6880 // A slider is a fraction and a mapping
6881 //
6882 // `Curve` is the one thing in this crate that computes rather than
6883 // describes, and it does so because four renderers would otherwise each
6884 // write these two formulas and drift. So the formulas are pinned here.
6885
6886 /// The bounds of audiofiles' envelope attack, the curve's first consumer.
6887 const ATTACK: (f64, f64) = (0.001, 5.0);
6888
6889 #[test]
6890 fn a_curve_is_linear_with_no_step_until_a_field_says_otherwise() {
6891 assert_eq!(Curve::default(), Curve::Linear { step: None });
6892 let plain = Field::range("t", "T", "0", "1");
6893 assert_eq!(plain.curve, Curve::Linear { step: None });
6894 assert_eq!(plain.curve.step(), None);
6895 }
6896
6897 #[test]
6898 fn every_curve_carries_its_own_granularity() {
6899 assert_eq!(Curve::Linear { step: Some("0.01") }.step(), Some("0.01"));
6900 assert_eq!(
6901 Curve::Logarithmic {
6902 step: Some("0.001")
6903 }
6904 .step(),
6905 Some("0.001")
6906 );
6907 }
6908
6909 #[test]
6910 fn both_ends_of_the_track_are_the_bounds_under_either_curve() {
6911 // `min` and `max` are `f(0)` and `f(1)`. That is the whole reframe, and
6912 // it has to hold for a mapping that is not the identity or the bounds
6913 // have stopped meaning what the field says they mean.
6914 let (min, max) = ATTACK;
6915 for curve in [
6916 Curve::Linear { step: None },
6917 Curve::Logarithmic { step: None },
6918 ] {
6919 assert!((curve.value_at(0.0, min, max) - min).abs() < 1e-12);
6920 assert!((curve.value_at(1.0, min, max) - max).abs() < 1e-12);
6921 }
6922 }
6923
6924 #[test]
6925 fn a_linear_midpoint_is_the_average_and_a_ratio_midpoint_is_the_geometric_mean() {
6926 let (min, max) = ATTACK;
6927 let linear = Curve::Linear { step: None }.value_at(0.5, min, max);
6928 assert!((linear - 2.5005).abs() < 1e-9);
6929
6930 // The reason the envelope is not linear: half way along a log track is
6931 // 70 ms, and half way along a linear one is 2.5 seconds. Every attack a
6932 // sampler is actually played with lives below the first.
6933 let ratio = Curve::Logarithmic { step: None }.value_at(0.5, min, max);
6934 assert!((ratio - (min * max).sqrt()).abs() < 1e-12);
6935 assert!(ratio < 0.08);
6936 }
6937
6938 #[test]
6939 fn a_position_and_a_value_round_trip_under_either_curve() {
6940 let (min, max) = ATTACK;
6941 for curve in [
6942 Curve::Linear { step: None },
6943 Curve::Logarithmic { step: None },
6944 ] {
6945 for position in [0.0, 0.1, 0.25, 0.5, 0.75, 0.99, 1.0] {
6946 let back = curve.position_of(curve.value_at(position, min, max), min, max);
6947 assert!(
6948 (back - position).abs() < 1e-9,
6949 "{curve:?} lost {position} (got {back})"
6950 );
6951 }
6952 }
6953 }
6954
6955 #[test]
6956 fn a_ratio_curve_across_zero_is_drawn_linearly_rather_than_refused() {
6957 // An envelope's sustain is a 0-to-1 level. A constant ratio is
6958 // undefined there, and the answer is the linear mapping rather than a
6959 // NaN reaching a renderer that would paint it.
6960 let curve = Curve::Logarithmic { step: None };
6961 assert!(!curve.is_ratio(0.0, 1.0));
6962 assert!((curve.value_at(0.5, 0.0, 1.0) - 0.5).abs() < 1e-12);
6963 assert!(curve.value_at(0.5, -96.0, -20.0).is_finite());
6964 assert!(curve.is_ratio(ATTACK.0, ATTACK.1));
6965 }
6966
6967 #[test]
6968 fn a_track_with_no_extent_has_one_value_on_it() {
6969 for curve in [
6970 Curve::Linear { step: None },
6971 Curve::Logarithmic { step: None },
6972 ] {
6973 assert!((curve.value_at(0.7, 4.0, 4.0) - 4.0).abs() < f64::EPSILON);
6974 assert!(curve.position_of(4.0, 4.0, 4.0).abs() < f64::EPSILON);
6975 // Inverted bounds are the same degenerate answer, not a negative
6976 // extent a renderer would draw backwards.
6977 assert!((curve.value_at(0.7, 9.0, 2.0) - 9.0).abs() < f64::EPSILON);
6978 }
6979 }
6980
6981 #[test]
6982 fn a_position_or_a_value_outside_the_track_is_clamped_to_it() {
6983 let (min, max) = ATTACK;
6984 let curve = Curve::Logarithmic { step: None };
6985 assert!((curve.value_at(-3.0, min, max) - min).abs() < 1e-12);
6986 assert!((curve.value_at(4.0, min, max) - max).abs() < 1e-12);
6987 assert!(curve.position_of(0.0, min, max).abs() < 1e-12);
6988 assert!((curve.position_of(500.0, min, max) - 1.0).abs() < 1e-12);
6989 }
6990
6991 #[test]
6992 fn a_typed_number_keeps_its_own_step_and_a_range_reads_its_curve() {
6993 // The split the 0.32.0 narrowing is: two granularities that were one
6994 // member, and the kinds that take them do not overlap.
6995 let typed = Field {
6996 step: Some("5"),
6997 ..Field::new(FieldKind::Number, "port", "Port")
6998 };
6999 assert_eq!(typed.step, Some("5"));
7000
7001 let slid = Field {
7002 curve: Curve::Logarithmic {
7003 step: Some("0.001"),
7004 },
7005 ..Field::range("attack", "Attack", "0.001", "5")
7006 };
7007 assert_eq!(slid.step, None);
7008 assert_eq!(slid.curve.step(), Some("0.001"));
7009 }
7010}