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