max / makeover-immediate
| 1 | //! The immediate-mode renderer for [`makeover_layout`]. |
| 2 | //! |
| 3 | //! <!-- wiki: makeover-immediate --> |
| 4 | //! |
| 5 | //! Named for the mode, not the library, the way `makeover-tui` is named for |
| 6 | //! the target and not for ratatui. Immediate mode is the constraint that |
| 7 | //! actually separates this renderer from the other two, and egui is the |
| 8 | //! backend it is written against. |
| 9 | //! |
| 10 | //! It is the harshest renderer the description has to survive: no |
| 11 | //! `box-shadow`, no `inset`, no cascade, no retained tree to mutate, and |
| 12 | //! `Visuals.widgets.*.bg_stroke` is a single stroke with no per-side control. |
| 13 | //! A two-tone lit edge is not something egui can be configured into producing, |
| 14 | //! so it gets painted by hand here, once, instead of in every consuming app. |
| 15 | //! |
| 16 | //! # What this crate does and does not own |
| 17 | //! |
| 18 | //! It owns the *expression*: two mitred polylines for a bevel and a `Frame` |
| 19 | //! for a filled region. It owns no colours and no sizes, and no longer owns a |
| 20 | //! substitution: it briefly supplied the page for a well, which was a stand-in |
| 21 | //! for `surface-well` before makeover derived it, and every consumer reads the |
| 22 | //! real token now. [`Palette`] is supplied by the caller, |
| 23 | //! already resolved, and every radius, margin and stroke width arrives in |
| 24 | //! [`FrameStyle`]. |
| 25 | //! |
| 26 | //! That split is why the crate has no dependency on `makeover` itself: the app |
| 27 | //! already resolves a theme, and coupling a renderer to a colour crate's |
| 28 | //! version would buy nothing. |
| 29 | //! |
| 30 | //! # The cascade is the real difference |
| 31 | //! |
| 32 | //! A stylesheet can say "a pressed button inverts its bevel" once and let the |
| 33 | //! cascade carry it. An immediate-mode renderer has nowhere to put that, so |
| 34 | //! every call site decides. [`makeover_layout::Depth::pressed`] is what keeps |
| 35 | //! the decision from being re-derived per widget. |
| 36 | //! |
| 37 | //! # 0.11.0: the overlay becomes reachable |
| 38 | //! |
| 39 | //! 0.10.0 answered what overlaying means in immediate mode with |
| 40 | //! [`Palette::cast`], and nothing could ask: the description had no |
| 41 | //! `Depth::Overlay` until `makeover-layout` 0.14.0, so the answer sat beside a |
| 42 | //! question that could not be posed. [`frame`] now hands the cast shadow to the |
| 43 | //! `egui::Frame` for any depth whose fill is [`Fill::Overlay`], keyed off the |
| 44 | //! fill rather than the variant. |
| 45 | //! |
| 46 | //! The same release brings `makeover_layout::CellPart`, which 0.11.0 carried |
| 47 | //! and did not draw. [`table`] draws it, below. |
| 48 | //! |
| 49 | //! # 0.12.0: the table |
| 50 | //! |
| 51 | //! [`table`] is the vocabulary 0.11.0 took without using. The consumer is |
| 52 | //! audiofiles, whose file list is the only table in the tree exercising all four |
| 53 | //! of what the description says about one at once: sortable headings with |
| 54 | //! carets, fixed and remainder tracks, and buttons inside cells. |
| 55 | //! |
| 56 | //! Two things it forces, both named where they land: |
| 57 | //! |
| 58 | //! - **`egui_extras`**, this crate's first dependency past egui. egui has no |
| 59 | //! table, and `Grid` gives no per-column sizing, no sticky header and no |
| 60 | //! scroll sync, which is why audiofiles reached for `egui_extras` rather than |
| 61 | //! building on `Grid`. A third answer here would reimplement that crate worse. |
| 62 | //! - **[`Palette::action`]**, on the footing [`Palette::content`] arrived on: a |
| 63 | //! link in a cell is the first thing here needing the action intent. |
| 64 | //! |
| 65 | //! Narrowing works differently from the terminal's and the module header says |
| 66 | //! why: a content column cannot be measured before the app's closure has drawn |
| 67 | //! it, so `egui_extras` sizes it and the declared floor budgets it. |
| 68 | //! |
| 69 | //! # 0.13.0: what the adoption found missing |
| 70 | //! |
| 71 | //! 0.12.0 shipped [`table`] before audiofiles had taken it, and taking it found |
| 72 | //! three things the file list already did that the function could not say. All |
| 73 | //! three are host idiom rather than description, which is why they land here and |
| 74 | //! not in `makeover-layout`, and all three are answered on a handle the app |
| 75 | //! never sees: the `egui_extras` row and builder this crate owns. That is |
| 76 | //! [`table::cell`]'s reasoning again: what the app cannot reach, the renderer |
| 77 | //! owes it. |
| 78 | //! |
| 79 | //! - **A selected row.** [`table::Body::selected`], a predicate asked per row, |
| 80 | //! because `set_selected` is a method on the row. Without it a file list has |
| 81 | //! no way to show what is selected, which is most of what a file list does. |
| 82 | //! - **Scrolling a row into view.** [`table::Body::scroll_to`], because |
| 83 | //! `scroll_to_row` is a method on the builder. A keyboard cursor that moves |
| 84 | //! off-screen and stays there is the bug this prevents. |
| 85 | //! - **Dragging a divider.** [`table::TableStyle::resizable`], which passes the |
| 86 | //! test `sticky_header` failed in 0.12.0: egui_extras offers two settings here |
| 87 | //! and a renderer can honestly make either choice. |
| 88 | //! |
| 89 | //! A fourth was found and is not a knob. Cells are centred on the row's centre |
| 90 | //! line, always, because there is no second honest answer and egui's own default |
| 91 | //! (top-aligned) is the one thing it cannot be. |
| 92 | //! |
| 93 | //! [`table::Body`] is also what splits a table's per-frame facts from its |
| 94 | //! description and from its style. A row count, a selection and a scroll request |
| 95 | //! are none of them style, and none of them survive the frame. |
| 96 | //! |
| 97 | //! # 0.18.0: the nodes that were not fields, tables or frames |
| 98 | //! |
| 99 | //! [`widget`] draws a meter, a token, a control and a figure. `makeover-tui` has |
| 100 | //! had all four for releases and this crate had none of them, which stayed |
| 101 | //! invisible while the only consumer was an app calling [`field`] and [`table`] |
| 102 | //! directly. It stopped being invisible the moment anything tried to draw a |
| 103 | //! whole `quasi_router::Screen` in egui: the four are ordinary nodes, so a |
| 104 | //! screen walk would have had to draw them itself, one copy per consumer. |
| 105 | //! |
| 106 | //! [`Palette`] grows the three status intents with it. They arrive together |
| 107 | //! rather than one per widget for the reason [`Palette::fill`] is an `Option`: |
| 108 | //! `Tone` is five members wide, and a resolver missing one has to invent a |
| 109 | //! colour, which is the substitution 0.2.0 spent a release removing. |
| 110 | //! |
| 111 | //! # Forms |
| 112 | //! |
| 113 | //! 0.5.0 adds the field vocabulary on top of the depth vocabulary: |
| 114 | //! [`makeover_layout::Field`] rendered to egui widgets, in [`field`], and a set |
| 115 | //! of them laid down a column in [`group`]. Before it, a description saying |
| 116 | //! "text field, labelled, required, with this hint" had no way to become a |
| 117 | //! widget here, and audiofiles' forms stayed hand-rolled. |
| 118 | //! |
| 119 | //! `makeover-webview` got there first and its form emitter is the precedent |
| 120 | //! followed rather than re-derived, including the parts that are bug fixes: a |
| 121 | //! select handed a value none of its options carries keeps that value visible |
| 122 | //! instead of silently reading as the first option, which is a save-the-wrong- |
| 123 | //! thing bug goingson hit for real. |
| 124 | //! |
| 125 | //! What differs is forced by the mode and not chosen: |
| 126 | //! |
| 127 | //! - **The value arrives as a `&mut`.** [`Filling`] borrows the app's own field |
| 128 | //! and the widget writes through it. There is no DOM to read back out of, |
| 129 | //! which is also why the description deliberately does not carry the value. |
| 130 | //! - **A text control is drawn as a well and a select is not.** The description |
| 131 | //! holds that a well is for anything the user looks *into*, and a text field |
| 132 | //! is its own example; a select and a checkbox are pressed rather than looked |
| 133 | //! into, so they keep egui's own control painting. |
| 134 | //! - **Focus is not describable, and egui owns all of it here.** **Reach**, |
| 135 | //! **focus** and the **focus ring** are this renderer's three answers and |
| 136 | //! egui already has all three: its own id stack decides what is reachable, |
| 137 | //! its own state decides what holds the keyboard, and it paints exactly one |
| 138 | //! ring. A description states none of them — `makeover_layout` removed the |
| 139 | //! member that used to try in 0.19.0 — and drawing a second ring on top of |
| 140 | //! egui's would break the one-ring rule it would have come from. The terms |
| 141 | //! are defined once in `makeover_layout`'s crate header, "Reach, focus and |
| 142 | //! the focus ring". [`makeover_layout::State::Disabled`] *is* drawn, because |
| 143 | //! egui has no opinion about it until told. |
| 144 | //! - **App-level chrome is not drawn here, and it is not this crate's to |
| 145 | //! draw.** `quasi-router` names the affordances that outlive one screen: a |
| 146 | //! `Chrome` of key bindings, and an `Outcome::Over` for a screen drawn over |
| 147 | //! another. Both are answered by `quasi-webview` and `quasi-tui`, and neither |
| 148 | //! is answerable here, because this crate depends on `makeover-layout` and |
| 149 | //! not on `quasi-router` — it is the peer of `makeover-webview` and |
| 150 | //! `makeover-tui`, one layer below the renderers that consume a `Screen`. |
| 151 | //! What is missing is the egui crate at *that* layer, which does not exist: |
| 152 | //! nothing renders a quasi `Screen` in egui at all, and chrome is one item on |
| 153 | //! the list such a crate would owe. Said here because this is where a reader |
| 154 | //! looks for it, and because the silent version reads as "egui does not need |
| 155 | //! a palette" rather than "nobody has built the renderer yet". |
| 156 | |
| 157 | //! # 0.32.0: a number draws its unit |
| 158 | //! |
| 159 | //! `makeover-layout` 0.33.0's [`Field::unit`], and this host is the one the |
| 160 | //! member was argued from: egui's `Slider` already draws a suffix beside its |
| 161 | //! readout, which is where these controls put the unit before they were |
| 162 | //! described and is somewhere a label cannot reach. |
| 163 | //! |
| 164 | //! So a slider takes it as a suffix, inside the control. A typed number has no |
| 165 | //! readout of its own and takes it as a muted label after the box. Every other |
| 166 | //! kind ignores it, and the description says which those are -- |
| 167 | //! `FieldKind::measurable`, rather than a `matches!` kept here. |
| 168 | //! |
| 169 | //! # 0.31.0: the slider's track is a curve |
| 170 | //! |
| 171 | //! `makeover-layout` 0.32.0 says what a slider is: a fraction and a function |
| 172 | //! taking numbers to numbers, with `min` and `max` being `f(0)` and `f(1)` |
| 173 | //! rather than the control's extent. This host has the easiest job of the |
| 174 | //! three, because egui already has the control -- `Slider::logarithmic` is a |
| 175 | //! constant-ratio track, so the mapping is a builder call rather than an |
| 176 | //! arithmetic of its own. |
| 177 | //! |
| 178 | //! Two things worth knowing. The granularity moved onto the curve, so a range |
| 179 | //! reads `Field::curve.step()` and every other kind still reads `Field::step`; |
| 180 | //! the step is in the value's own units under either curve, so the display |
| 181 | //! precision is derived exactly as before. And the fallback for a ratio curve |
| 182 | //! across zero is asked of `Curve::is_ratio` rather than matched on the |
| 183 | //! variant, so this renderer and a terminal cannot disagree about when a |
| 184 | //! logarithmic request is honoured. |
| 185 | //! |
| 186 | //! # 0.28.0: the slider, the unanswered chooser, and the option that is not |
| 187 | //! offered yet |
| 188 | //! |
| 189 | //! Three things `makeover-layout` 0.28.0 lets a description say, all three |
| 190 | //! found by audiofiles' forms port hitting a wall it could not describe its way |
| 191 | //! past. |
| 192 | //! |
| 193 | //! - **[`FieldKind::Range`] is a fifth control shape**, `Control::Slid`, and |
| 194 | //! the first one added since 0.5.0. egui has `Slider` and this crate had no |
| 195 | //! way to be asked for one, so four sliders in the only consuming app stayed |
| 196 | //! hand-rolled against a vocabulary that could not name them. A range missing |
| 197 | //! an end falls back to a well rather than to invented bounds, which is what |
| 198 | //! `makeover_layout::Field::bounded` is for. |
| 199 | //! - **`Field::placeholder` finally reads on a chooser.** It was sayable and |
| 200 | //! this renderer ignored it, so a select with nothing chosen showed an empty |
| 201 | //! box. Nothing new is described; the renderer caught up. |
| 202 | //! - **`Choice::unavailable` is drawn rather than dropped.** The option stays |
| 203 | //! in the list, inert, with its precondition beside it instead of behind a |
| 204 | //! hover — a greyed row with no reason reads as a dead end, which is the |
| 205 | //! whole finding. |
| 206 | //! |
| 207 | //! The value still arrives as a `&mut String` and a slider is a number, so the |
| 208 | //! parse and the write-back are this renderer's, and the write happens only on |
| 209 | //! a real drag: a value the app put there that this host cannot read survives |
| 210 | //! being looked at. |
| 211 | |
| 212 | |
| 213 | |
| 214 | use |
| 215 | Color32, ComboBox, CornerRadius, Margin, Painter, Rect, Response, RichText, Shape, Slider, |
| 216 | Stroke, TextEdit, Ui, |
| 217 | ; |
| 218 | use ; |
| 219 | use RangeInclusive; |
| 220 | |
| 221 | /// Columns, narrowing, cell parts and the sort caret, over `egui_extras`. |
| 222 | |
| 223 | |
| 224 | |
| 225 | /// The resolved colours this renderer needs, as flat values. |
| 226 | /// |
| 227 | /// Built by the app from whatever it already uses to resolve a theme, then |
| 228 | /// held and reused. Deliberately not a trait and not string-keyed: a bevel is |
| 229 | /// painted per widget per frame, and a map lookup per edge is a cost with |
| 230 | /// nothing to show for it. |
| 231 | |
| 232 | |
| 233 | /// `surface-page`. |
| 234 | pub page: Color32, |
| 235 | /// `surface-raised`. |
| 236 | pub raised: Color32, |
| 237 | /// `surface-overlay`. |
| 238 | pub overlay: Color32, |
| 239 | /// `surface-well`. |
| 240 | /// |
| 241 | /// Required, not optional. makeover derives it for every theme from 2.3.0, |
| 242 | /// so a resolved palette without a well is not a thing that exists here. |
| 243 | /// It was an `Option` while that was untrue, and this renderer substituted |
| 244 | /// the page; `makeover-tui` keeps its own `Option` for a different reason, |
| 245 | /// since a terminal can have the colour and still be unable to show it. |
| 246 | pub well: Color32, |
| 247 | /// `surface-sunken`. |
| 248 | /// |
| 249 | /// A surface set back from the one it sits on, by colour and nothing else. |
| 250 | /// Not a well: a well is a hole with an edge, and this has no edge. An |
| 251 | /// immediate-mode renderer paints an arbitrary rect, so unlike |
| 252 | /// `makeover-tui` it has no excuse for declining this one. |
| 253 | /// |
| 254 | /// Required rather than optional, on the same footing as `well`: all 31 |
| 255 | /// themes makeover embeds author it. |
| 256 | pub sunken: Color32, |
| 257 | /// `bevel-light`. |
| 258 | pub bevel_light: Color32, |
| 259 | /// `bevel-dark`. |
| 260 | pub bevel_dark: Color32, |
| 261 | /// `elevation`. |
| 262 | /// |
| 263 | /// What a surface that floats OVER the page is cast onto it with. The one |
| 264 | /// intent here that is about a surface's relationship to the page rather |
| 265 | /// than about the surface, which is why it is a translucent near-black on |
| 266 | /// every theme rather than something read off the palette's own ramp. |
| 267 | /// |
| 268 | /// **Only for a surface that overlays.** A menu, a tooltip, a modal. A |
| 269 | /// surface *in* the layout takes a bevel, and reaching for this on a panel |
| 270 | /// or a card is how a pre-Platinum look survives a conversion under a new |
| 271 | /// name. |
| 272 | /// |
| 273 | /// egui has a real answer for this where a terminal does not: see |
| 274 | /// [`Palette::cast`], which is the shadow to hand an |
| 275 | /// [`egui::Frame`](egui::Frame). |
| 276 | pub elevation: Color32, |
| 277 | /// `content`. |
| 278 | /// |
| 279 | /// Ordinary text. Added 0.5.0 with the field renderer, which is the first |
| 280 | /// thing here that draws any: until then this crate painted surfaces and |
| 281 | /// edges and let the caller's own egui visuals answer for text. |
| 282 | pub content: Color32, |
| 283 | /// `content-secondary`. |
| 284 | /// |
| 285 | /// Inactive but usable: it still answers a press. The middle tone of the |
| 286 | /// three (wiki `three-tone-convention`), and the one an unchosen option in |
| 287 | /// a choice field takes. Added 0.26.0 for that widget, which drew every |
| 288 | /// option at full `content` and so said nothing about which one was |
| 289 | /// chosen beyond the dot egui paints. |
| 290 | /// |
| 291 | /// Not [`content_muted`](Self::content_muted), which carries a claim: |
| 292 | /// `State::Disabled` resolves to it, so a live control wearing it tells the |
| 293 | /// user it will not answer. `makeover-tui` draws the same widget the same |
| 294 | /// way from `makeover-tui@230bf63`. |
| 295 | /// |
| 296 | /// A step of `content` toward the page, derived at load by `makeover` |
| 297 | /// rather than authored, so it is read off the resolved theme here like |
| 298 | /// any other token and never re-derived. |
| 299 | pub content_secondary: Color32, |
| 300 | /// `content-muted`. |
| 301 | /// |
| 302 | /// A field's hint, and what |
| 303 | /// [`makeover_layout::State::Disabled`](makeover_layout::State::Disabled) |
| 304 | /// resolves to. Both readings come from the description rather than from |
| 305 | /// here: `State::Disabled` names this intent by token. |
| 306 | pub content_muted: Color32, |
| 307 | /// `action-primary`. |
| 308 | /// |
| 309 | /// What a control is drawn in. Added 0.12.0 with the table renderer, for the |
| 310 | /// reason `content` was added 0.5.0 with the field renderer: a link in a |
| 311 | /// cell is the first thing here that needs the action intent, and a palette |
| 312 | /// should carry what is used. |
| 313 | /// |
| 314 | /// This is the intent [`CellPart`](makeover_layout::CellPart) exists to |
| 315 | /// separate. A cell holding a control took the cell's text colour until the |
| 316 | /// description could say otherwise, which is the drift `makeover-layout` |
| 317 | /// 0.14.0 named and `makeover-webview` 0.25.0 fixed on its own side. |
| 318 | pub action: Color32, |
| 319 | /// `danger`. |
| 320 | /// |
| 321 | /// A field's error message, a destructive control, a bar that has run over. |
| 322 | pub danger: Color32, |
| 323 | /// `success`. |
| 324 | /// |
| 325 | /// Added 0.18.0 with [`widget`], which is the first thing here that draws a |
| 326 | /// [`Tone`]. The three status intents arrive together and not one at a |
| 327 | /// time: [`Tone`] is five members wide and a resolver missing one has to |
| 328 | /// invent a colour for it, which is the substitution this crate spent |
| 329 | /// 0.2.0 removing from [`Palette::fill`]. |
| 330 | pub success: Color32, |
| 331 | /// `warning`. |
| 332 | pub warning: Color32, |
| 333 | /// `info`. |
| 334 | pub info: Color32, |
| 335 | |
| 336 | |
| 337 | |
| 338 | /// Resolve a surface intent, or `None` for one this renderer does not know. |
| 339 | /// |
| 340 | /// A plain lookup. There is still no substitution: the old one existed only |
| 341 | /// while `surface-well` was underived, and every consumer reads the real |
| 342 | /// token now. |
| 343 | /// |
| 344 | /// `Option` since 0.3.0, because [`Fill`] became `#[non_exhaustive]` in |
| 345 | /// `makeover-layout` 0.4.0 and a total function over an open enum can only |
| 346 | /// stay total by inventing a colour for a member it has never heard of. |
| 347 | /// That is the substitution this crate spent 0.2.0 removing, so the return |
| 348 | /// type moved instead. Every member the description has today is answered |
| 349 | /// with `Some`. |
| 350 | |
| 351 | pub const |
| 352 | match fill |
| 353 | Page => Some, |
| 354 | Raised => Some, |
| 355 | Overlay => Some, |
| 356 | Well => Some, |
| 357 | Sunken => Some, |
| 358 | _ => None, |
| 359 | |
| 360 | |
| 361 | |
| 362 | /// The colour a [`Tone`] reads as. |
| 363 | /// |
| 364 | /// Total, unlike [`fill`](Self::fill), and the difference is not an |
| 365 | /// inconsistency. `Fill` is `#[non_exhaustive]` and `Tone` is not: the |
| 366 | /// description layer settled tone at five members and grows surfaces, so a |
| 367 | /// total function here cannot be made to invent a colour by an upstream |
| 368 | /// release the way a total `fill` could. |
| 369 | /// |
| 370 | /// [`Tone::Neutral`] is [`content`](Self::content) rather than a colour of |
| 371 | /// its own, which is what "an ordinary fact" means: a neutral badge is text |
| 372 | /// in a box, not a fifth status. |
| 373 | |
| 374 | pub const |
| 375 | match tone |
| 376 | Neutral => self.content, |
| 377 | Info => self.info, |
| 378 | Success => self.success, |
| 379 | Warning => self.warning, |
| 380 | Danger => self.danger, |
| 381 | |
| 382 | |
| 383 | |
| 384 | /// The cast shadow for a surface that overlays the page. |
| 385 | /// |
| 386 | /// What "overlaying" means in immediate mode, answered rather than skipped. |
| 387 | /// egui already paints shadows for its menus and windows through |
| 388 | /// [`egui::Frame::shadow`], so the honest port is to hand that machinery the |
| 389 | /// theme's tone instead of egui's own default, not to invent a painter here |
| 390 | /// the way [`paint_bevel`] had to. |
| 391 | /// |
| 392 | /// The geometry matches what `makeover-webview` composes, in points rather |
| 393 | /// than pixels: a small downward offset and a wide soft blur. A Platinum-era |
| 394 | /// menu sits just off the page rather than hovering above it. |
| 395 | /// |
| 396 | /// ```no_run |
| 397 | /// # let palette: makeover_immediate::Palette = unimplemented!(); |
| 398 | /// # let ui: &mut egui::Ui = unimplemented!(); |
| 399 | /// egui::Frame::popup(ui.style()) |
| 400 | /// .shadow(palette.cast()) |
| 401 | /// .show(ui, |ui| { ui.label("over the page"); }); |
| 402 | /// ``` |
| 403 | |
| 404 | pub const |
| 405 | Shadow |
| 406 | offset: , |
| 407 | blur: 24, |
| 408 | spread: 0, |
| 409 | color: self.elevation, |
| 410 | |
| 411 | |
| 412 | |
| 413 | /// Resolve a bevel edge intent. |
| 414 | |
| 415 | pub const |
| 416 | match edge |
| 417 | Light => self.bevel_light, |
| 418 | Dark => self.bevel_dark, |
| 419 | |
| 420 | |
| 421 | |
| 422 | |
| 423 | /// The geometry a framed region is drawn with. |
| 424 | /// |
| 425 | /// Every field is a value, which is why they all arrive from the caller: |
| 426 | /// radius and border width belong to `makeover-geometry`, and margins come |
| 427 | /// from its relational gaps. |
| 428 | |
| 429 | |
| 430 | /// Corner radius. Square under the Platinum default. |
| 431 | pub radius: CornerRadius, |
| 432 | /// Inner margin between the frame and its contents. |
| 433 | pub margin: Margin, |
| 434 | /// Bevel stroke width, in points. |
| 435 | pub stroke: f32, |
| 436 | |
| 437 | |
| 438 | |
| 439 | /// A one-point square frame with no inner margin. |
| 440 | |
| 441 | Self |
| 442 | radius: ZERO, |
| 443 | margin: ZERO, |
| 444 | stroke: 1.0, |
| 445 | |
| 446 | |
| 447 | |
| 448 | |
| 449 | /// Paint a two-tone edge just inside `rect`. |
| 450 | /// |
| 451 | /// Fill first, bevel after: this adds two polylines and nothing else, so it |
| 452 | /// composes over whatever is already there. That is what lets it go over an |
| 453 | /// [`egui::TextEdit`] after `ui.add`, where the widget's own fill has landed. |
| 454 | /// |
| 455 | /// Two three-point polylines meeting at opposite corners, rather than four |
| 456 | /// segments, so egui mitres the corner joins instead of leaving a notch. |
| 457 | /// |
| 458 | /// The dark polyline is drawn second, so the two corners where the runs meet |
| 459 | /// take its tone. That is the right answer here rather than a concession. |
| 460 | /// [`makeover_layout::Bevel`] holds those corners to belong to both edges, and |
| 461 | /// a renderer with room to divide one should; at the default one-point stroke |
| 462 | /// the corner is a one-point square, so the division is sub-pixel and |
| 463 | /// antialiasing resolves it to the same blend the mitre already gives. Splitting |
| 464 | /// it would add a seam and no information. `makeover-tui` does split, because a |
| 465 | /// terminal cell is large enough that not splitting costs a visible cell of edge |
| 466 | /// weight — the same rule, at a resolution where it has something to say. |
| 467 | |
| 468 | let = bevel.edges; |
| 469 | |
| 470 | // Inset by half a stroke so the line lands inside `rect` rather than |
| 471 | // straddling its edge, which on a fractional-scale display is the |
| 472 | // difference between one crisp pixel and two dim ones. |
| 473 | let r = rect.shrink; |
| 474 | |
| 475 | painter.add |
| 476 | vec!, |
| 477 | new, |
| 478 | ; |
| 479 | painter.add |
| 480 | vec!, |
| 481 | new, |
| 482 | ; |
| 483 | |
| 484 | |
| 485 | /// Draw a region at a given [`Depth`]: its fill and its edge, together. |
| 486 | /// |
| 487 | /// [`Depth::Flat`] gets neither, and inherits whatever it sits on. That is the |
| 488 | /// difference between level-with and painted-the-same-colour, and it is the |
| 489 | /// reason `Depth::fill` returns an [`Option`] rather than defaulting to the |
| 490 | /// page. |
| 491 | |
| 492 | ui: &mut Ui, |
| 493 | depth: Depth, |
| 494 | palette: &Palette, |
| 495 | style: FrameStyle, |
| 496 | add_contents: impl FnOnce -> R, |
| 497 | |
| 498 | let mut f = new |
| 499 | .corner_radius |
| 500 | .inner_margin; |
| 501 | // Two ways there is no fill to paint, and they collapse to the same |
| 502 | // outcome: the depth names none (Depth::Flat), or it names one this |
| 503 | // renderer cannot resolve. Either way the frame goes unfilled and the |
| 504 | // bevel below carries the depth on its own, which is the rule this |
| 505 | // module already documents for Flat. |
| 506 | if let Some = depth.fill.and_then |
| 507 | f = f.fill; |
| 508 | |
| 509 | // A surface that overlays the page is cast onto it. [`Palette::cast`] has |
| 510 | // answered what that means here since 0.10.0 and nothing could reach it: a |
| 511 | // description had no way to say Overlay until makeover-layout 0.14.0, so |
| 512 | // the answer sat beside the question. Keyed off the fill rather than the |
| 513 | // variant, so it stays right for whatever else the description calls an |
| 514 | // overlay later. |
| 515 | if depth.fill == Some |
| 516 | f = f.shadow; |
| 517 | |
| 518 | let framed = f.show; |
| 519 | if let Some = depth.bevel |
| 520 | paint_bevel |
| 521 | ui.painter, |
| 522 | framed.response.rect, |
| 523 | bevel, |
| 524 | palette, |
| 525 | style.stroke, |
| 526 | ; |
| 527 | |
| 528 | framed.inner |
| 529 | |
| 530 | |
| 531 | /// The geometry a field group is drawn with. |
| 532 | /// |
| 533 | /// Values again, for the reason [`FrameStyle`] is: every number here belongs to |
| 534 | /// `makeover-geometry` and arrives already resolved. |
| 535 | |
| 536 | |
| 537 | /// The well a text control sits in. |
| 538 | pub frame: FrameStyle, |
| 539 | /// Between a field's own parts: its label, its control, its hint and its |
| 540 | /// error. |
| 541 | pub gap: f32, |
| 542 | /// Between one field and the next. |
| 543 | pub group_gap: f32, |
| 544 | /// What marks a required field, appended to its label. |
| 545 | /// |
| 546 | /// A knob rather than a constant, because it is the one piece of *copy* in |
| 547 | /// this crate and copy is not a renderer's call. A webview does not need it |
| 548 | /// at all — it emits the `required` attribute and the browser answers — so |
| 549 | /// this renderer is the first place where a compulsory field either shows |
| 550 | /// that it is or silently does not. |
| 551 | pub required_marker: &'static str, |
| 552 | |
| 553 | |
| 554 | |
| 555 | /// The default frame, no gaps, and an asterisk. |
| 556 | |
| 557 | Self |
| 558 | frame: default, |
| 559 | gap: 0.0, |
| 560 | group_gap: 0.0, |
| 561 | required_marker: "*", |
| 562 | |
| 563 | |
| 564 | |
| 565 | |
| 566 | /// What the field currently holds, borrowed from wherever the app keeps it. |
| 567 | /// |
| 568 | /// The immediate-mode counterpart of `makeover_webview::form::Value`, and the |
| 569 | /// place the two renderers are forced apart: there the value is read back out |
| 570 | /// of the DOM after the fact, and here the widget writes through this borrow as |
| 571 | /// it is edited. Same reason the description carries neither. |
| 572 | /// |
| 573 | /// An enum rather than a bag of options, on the reasoning |
| 574 | /// `makeover_webview::form::Value` records: a checkbox holding a string is |
| 575 | /// unsayable here, where a struct would let it be said and then have to cope. |
| 576 | |
| 577 | |
| 578 | /// Nothing to edit. The control is drawn and does not answer. |
| 579 | |
| 580 | Absent, |
| 581 | /// The buffer behind anything that takes typed text, a select included: |
| 582 | /// what a select holds is the `value` of one of its [`Choice`]s. |
| 583 | /// |
| 584 | /// [`Choice`]: makeover_layout::Choice |
| 585 | Text, |
| 586 | /// A checkbox, on or off. |
| 587 | On, |
| 588 | |
| 589 | |
| 590 | /// The label, marked if the field is compulsory. |
| 591 | |
| 592 | if field.required |
| 593 | format! |
| 594 | else |
| 595 | field.label.to_owned |
| 596 | |
| 597 | |
| 598 | |
| 599 | /// The four shapes a control comes in here, which is fewer than there are |
| 600 | /// kinds. |
| 601 | /// |
| 602 | /// [`FieldKind`] is `#[non_exhaustive]` and grows; this does not, because the |
| 603 | /// ways egui has of asking for a value do not. Reducing the open set to this |
| 604 | /// closed one in one total function is what keeps a new kind from needing a new |
| 605 | /// arm at every match below. |
| 606 | |
| 607 | |
| 608 | /// Typed into, so it is drawn as a well: the user looks into it. |
| 609 | Typed, |
| 610 | /// Picked from a control that shows one option at a time. Pressed rather |
| 611 | /// than looked into, so egui's own control painting stands. |
| 612 | Chosen, |
| 613 | /// Picked from options that are all on screen at once. |
| 614 | /// |
| 615 | /// Apart from [`Chosen`](Self::Chosen) because the description holds them |
| 616 | /// apart, and holding them apart is the whole content of |
| 617 | /// [`FieldKind::Radio`]: same question, and an answer the user can read |
| 618 | /// without opening anything. |
| 619 | Listed, |
| 620 | /// Held on or off. |
| 621 | Toggled, |
| 622 | /// Dragged across an extent that is on screen the whole time. |
| 623 | /// |
| 624 | /// Apart from [`Typed`](Self::Typed) for the reason |
| 625 | /// [`FieldKind::Range`] is apart from `Number`: the two ends are what the |
| 626 | /// question means, so a well with a figure in it is not a quieter version |
| 627 | /// of this control, it is a different one. |
| 628 | Slid, |
| 629 | |
| 630 | |
| 631 | /// Which shape a kind takes. |
| 632 | /// |
| 633 | /// The wildcard falls to [`Control::Typed`] on purpose: a kind added to the |
| 634 | /// description since this renderer was built degrades to a text box, which |
| 635 | /// accepts any value the others would, rather than to nothing drawn at all. |
| 636 | /// |
| 637 | /// `FieldKind::File` lands there as of makeover-layout 0.11.0, and it is left |
| 638 | /// there rather than grown a shape of its own. egui's honest answer is a button |
| 639 | /// that opens a native picker, which is a fifth control and a file-dialog |
| 640 | /// dependency; no consumer of this crate asks for a file field yet. Same |
| 641 | /// position this crate took on `Meter` at 0.10.0: the membership test is that |
| 642 | /// every renderer *could* answer honestly, not that each one does on the day. |
| 643 | /// A path in a text box is not nothing, and it is what an app that needs this |
| 644 | /// tomorrow gets today. |
| 645 | /// |
| 646 | /// makeover-layout 0.31.0 added `Field::accept` and `Field::multiple`, and this |
| 647 | /// position is what they land on: both are the picker's arguments, and this |
| 648 | /// renderer has no picker to give them to. They are not lost — the description |
| 649 | /// still carries them, and the day the native dialog arrives here it is opened |
| 650 | /// with them rather than with a filter written twice. |
| 651 | /// |
| 652 | /// `FieldKind::Date` and `FieldKind::DateTime` land there too, as of |
| 653 | /// makeover-layout 0.15.0, on the same footing and with one thing owed. A |
| 654 | /// calendar is a sixth control and bare `egui` has none, so a typed value is |
| 655 | /// the honest answer here; what the app gets is the format the description |
| 656 | /// names, `makeover_layout::DATE_FORMAT` and `DATETIME_FORMAT`, which is why |
| 657 | /// those are constants rather than a sentence. audiofiles is the only consumer |
| 658 | /// of this crate and asks for neither today. A calendar popup is the upgrade |
| 659 | /// whenever one does. |
| 660 | const |
| 661 | match kind |
| 662 | Select => Chosen, |
| 663 | Radio => Listed, |
| 664 | Checkbox => Toggled, |
| 665 | Range => Slid, |
| 666 | _ => Typed, |
| 667 | |
| 668 | |
| 669 | |
| 670 | /// The shape the field actually gets, which is the kind's unless the field is |
| 671 | /// missing what that shape needs. |
| 672 | /// |
| 673 | /// One case, and `makeover-layout` names it: a [`FieldKind::Range`] carries its |
| 674 | /// extent in [`Field::min`] and [`Field::max`], and a range missing an end has |
| 675 | /// nothing to slide across. egui's `Slider` demands a `RangeInclusive`, so |
| 676 | /// inventing one would be this renderer picking bounds the app never stated and |
| 677 | /// the user then dragging against them. |
| 678 | /// |
| 679 | /// It falls back to [`Control::Typed`], which is where every kind this renderer |
| 680 | /// cannot draw natively already lands: a number in a well is a true report of |
| 681 | /// the value and takes any answer the slider would. |
| 682 | |
| 683 | match control_shape |
| 684 | Slid if !field.bounded => Typed, |
| 685 | shape => shape, |
| 686 | |
| 687 | |
| 688 | |
| 689 | /// The unit to draw beside this field's value, if there is one to draw. |
| 690 | /// |
| 691 | /// Two conditions rather than one: the field has to carry a unit and its kind |
| 692 | /// has to be one that means anything by it. `FieldKind::measurable` is the |
| 693 | /// description answering the second, so this renderer does not keep its own |
| 694 | /// list of which kinds are quantities -- which is the drift that predicate |
| 695 | /// exists to stop. |
| 696 | |
| 697 | field.unit.filter |
| 698 | |
| 699 | |
| 700 | /// The two ends of a range, as egui wants them. |
| 701 | /// |
| 702 | /// `None` when either end is missing or is not a number this host can read. |
| 703 | /// The description carries the bounds as text on purpose — the bound of a date |
| 704 | /// is a date — so parsing them is the renderer's job and failing to is a real |
| 705 | /// outcome rather than an assertion. |
| 706 | |
| 707 | let min = field.min?..ok?; |
| 708 | let max = field.max?..ok?; |
| 709 | Some |
| 710 | |
| 711 | |
| 712 | /// How many decimals to write a dragged value back with. |
| 713 | /// |
| 714 | /// Read off [`Field::step`], which is the only thing that says what |
| 715 | /// granularity the question has: a step of `0.01` is a two-decimal question and |
| 716 | /// a step of `1` is a whole-number one. Without a step the host's own |
| 717 | /// granularity stands, and egui's is continuous, so the value is written back |
| 718 | /// at whatever precision it round-trips at. |
| 719 | |
| 720 | let step = step?; |
| 721 | Some |
| 722 | Some => fraction.trim_end_matches.len, |
| 723 | None => 0, |
| 724 | |
| 725 | |
| 726 | |
| 727 | /// What a select shows for the value it currently holds. |
| 728 | /// |
| 729 | /// A value no option carries stays on screen as itself rather than reading as |
| 730 | /// whichever option happens to be first. goingson saved a backup retention of |
| 731 | /// 10 against a 1/3/7/14/0 list and the browser silently showed it as 1, so the |
| 732 | /// next save wrote a value nobody chose; `makeover-webview` grew the fix as a |
| 733 | /// stray `<option>` and this is the same fix in the shape egui allows. |
| 734 | /// |
| 735 | /// The empty value is the one case that reads as unanswered rather than as an |
| 736 | /// answer, and [`chosen_text`] is what puts the field's ghost text there. |
| 737 | |
| 738 | options |
| 739 | .iter |
| 740 | .find |
| 741 | .map_or |
| 742 | |
| 743 | |
| 744 | /// What a select's closed control reads, and in which tone. |
| 745 | /// |
| 746 | /// A chooser with nothing chosen showed an empty box: `shown_label` falls back |
| 747 | /// to the value, and the unanswered value is the empty string. So an app with |
| 748 | /// an instruction to give — audiofiles' "Select device..." — had nowhere to put |
| 749 | /// it but a disabled button elsewhere on the screen, which is the affordance |
| 750 | /// this vocabulary keeps moving messages *off*. |
| 751 | /// |
| 752 | /// [`Field::placeholder`] is already the description's word for "what the field |
| 753 | /// reads while it is empty" and was honoured by the typed kinds alone, so |
| 754 | /// nothing new is said here; the renderer is what had not caught up. Muted |
| 755 | /// because it is not an answer, the same tone the typed kinds' ghost text takes |
| 756 | /// three lines up. |
| 757 | /// |
| 758 | /// A value no option carries but that is *not* empty stays as itself, in |
| 759 | /// `content`: that is the goingson retention bug and it is a wrong answer |
| 760 | /// rather than an absent one. |
| 761 | /// |
| 762 | /// Returns the words and the tone rather than a built [`RichText`], because |
| 763 | /// what it decides is both of them and only one of them is readable back off a |
| 764 | /// `RichText`. |
| 765 | /// |
| 766 | /// [`Field::placeholder`]: makeover_layout::Field::placeholder |
| 767 | |
| 768 | match field.placeholder |
| 769 | Some if value.is_empty => , |
| 770 | _ => , |
| 771 | |
| 772 | |
| 773 | |
| 774 | /// What one option in a choice field is drawn in. |
| 775 | /// |
| 776 | /// The chosen one is the emphasised thing and takes `content`; the rest take |
| 777 | /// [`content_secondary`](Palette::content_secondary), because an option that is |
| 778 | /// not chosen is still an option and pressing it chooses it. Muted would be the |
| 779 | /// lie: [`State::Disabled`] resolves to it, so a five-option field read as one |
| 780 | /// live row and four dead ones. `makeover-tui` draws it the same way |
| 781 | /// (`makeover-tui@230bf63`); wiki `three-tone-convention` is the table. |
| 782 | |
| 783 | if value == option |
| 784 | palette.content |
| 785 | else |
| 786 | palette.content_secondary |
| 787 | |
| 788 | |
| 789 | |
| 790 | /// The control alone, without its label, hint or error. |
| 791 | |
| 792 | ui: &mut Ui, |
| 793 | field: &, |
| 794 | filling: , |
| 795 | palette: &Palette, |
| 796 | style: &FieldStyle, |
| 797 | |
| 798 | // The mismatch path: described as one thing and filled as another. Nothing |
| 799 | // here can fix it, so it is drawn as the empty, inert version of what was |
| 800 | // described — visible on screen, in the way an empty select is at the |
| 801 | // webview renderer, rather than reported in a log nobody reads. |
| 802 | let mut discard = Stringnew; |
| 803 | let mut off = false; |
| 804 | |
| 805 | match shape_of |
| 806 | Slid => |
| 807 | let value = match filling |
| 808 | Text => text, |
| 809 | _ => &mut discard, |
| 810 | ; |
| 811 | // `shape_of` has already refused an unbounded range, so the extent |
| 812 | // is only missing here if a bound is not a number — a date range, |
| 813 | // say, which this control cannot draw either. |
| 814 | let Some = extent else |
| 815 | return ui.label; |
| 816 | ; |
| 817 | |
| 818 | // A value the host cannot read starts at the low end rather than at |
| 819 | // zero, which may be outside the extent entirely. Nothing is |
| 820 | // written back until the user drags, so an unreadable value the app |
| 821 | // put there survives being looked at. |
| 822 | let mut number = value..unwrap_or; |
| 823 | // The granularity is the curve's as of makeover-layout 0.32.0. It |
| 824 | // is still in the value's own units, so the display precision is |
| 825 | // read off it exactly as before. |
| 826 | let step = field.curve.step; |
| 827 | let mut slider = new.text; |
| 828 | if let Some = decimals |
| 829 | slider = slider.max_decimals; |
| 830 | |
| 831 | if let Some = step.and_then |
| 832 | slider = slider.step_by; |
| 833 | |
| 834 | // egui's own constant-ratio track, which is this host's answer to |
| 835 | // `Curve::Logarithmic`. `is_ratio` rather than a match on the |
| 836 | // variant, because a ratio across zero is not one: makeover-layout |
| 837 | // decides the fallback so that four renderers cannot disagree about |
| 838 | // when it applies. |
| 839 | if field.curve.is_ratio |
| 840 | slider = slider.logarithmic; |
| 841 | |
| 842 | // The unit goes inside the control, beside the readout egui already |
| 843 | // draws. That placement is the argument `Field::unit` was decided |
| 844 | // on: it is where these controls put it before they were described, |
| 845 | // and it is the one a label could never reach. |
| 846 | if let Some = unit_of |
| 847 | slider = slider.suffix; |
| 848 | |
| 849 | let response = ui.add; |
| 850 | if response.changed |
| 851 | *value = match decimals |
| 852 | Some => format!, |
| 853 | None => number.to_string, |
| 854 | ; |
| 855 | |
| 856 | response |
| 857 | |
| 858 | Typed => |
| 859 | let text = match filling |
| 860 | Text => text, |
| 861 | _ => &mut discard, |
| 862 | ; |
| 863 | // An empty frame and no margin: the well is this crate's, and egui's |
| 864 | // own control background and padding would sit underneath it saying |
| 865 | // something different about both. |
| 866 | // Keyed on the description's own `multiline` and not on the |
| 867 | // member: a markdown field is several lines by definition, and a |
| 868 | // single-line edit would be a control the value cannot fit in. egui |
| 869 | // does nothing else with the markdown, which is the honest answer |
| 870 | // rather than a gap -- the source is text, and editing it as text |
| 871 | // loses none of it. |
| 872 | let mut edit = if field.kind.multiline |
| 873 | multiline |
| 874 | else |
| 875 | singleline |
| 876 | |
| 877 | .frame |
| 878 | .margin |
| 879 | .text_color |
| 880 | .password; |
| 881 | if let Some = field.placeholder |
| 882 | edit = edit.hint_text; |
| 883 | |
| 884 | let response = frame; |
| 885 | // A typed number has no readout of its own to sit beside, so the |
| 886 | // unit follows the box. Muted, because it is a fact about the value |
| 887 | // rather than a second thing to read. |
| 888 | match unit_of |
| 889 | Some => |
| 890 | ui.label; |
| 891 | response |
| 892 | |
| 893 | None => response, |
| 894 | |
| 895 | |
| 896 | Toggled => |
| 897 | let on = match filling |
| 898 | On => on, |
| 899 | _ => &mut off, |
| 900 | ; |
| 901 | ui.checkbox |
| 902 | |
| 903 | Listed => |
| 904 | let value = match filling |
| 905 | Text => text, |
| 906 | _ => &mut discard, |
| 907 | ; |
| 908 | // No `shown_label` counterpart, and none is needed: a value no |
| 909 | // option carries leaves every button unfilled, which is already |
| 910 | // the honest report on screen. The select needs the fix because it |
| 911 | // has one slot and must put *something* in it. |
| 912 | let group = ui.vertical |
| 913 | let mut answered: = None; |
| 914 | for opt in field.options |
| 915 | // An option that cannot be picked yet is drawn and does not |
| 916 | // answer, with the precondition beside it rather than |
| 917 | // behind a hover: a greyed row with no reason reads as a |
| 918 | // dead end, which is the state `Choice::unavailable` exists |
| 919 | // to stop being sayable. |
| 920 | let picked = if let Some = opt.unavailable |
| 921 | ui.horizontal |
| 922 | let picked = ui |
| 923 | .add_enabled_ui |
| 924 | ui.radio_value |
| 925 | value, |
| 926 | opt.value.to_owned, |
| 927 | new.color, |
| 928 | |
| 929 | |
| 930 | .inner; |
| 931 | ui.label; |
| 932 | picked |
| 933 | |
| 934 | .inner |
| 935 | else |
| 936 | ui.radio_value |
| 937 | value, |
| 938 | opt.value.to_owned, |
| 939 | new.color, |
| 940 | |
| 941 | ; |
| 942 | answered = Some |
| 943 | Some => prev.union, |
| 944 | None => picked, |
| 945 | ; |
| 946 | |
| 947 | answered |
| 948 | ; |
| 949 | // A group described with no options answers as its own empty area |
| 950 | // rather than as no response at all, which keeps the caller's |
| 951 | // `.changed()` chain working on a field whose option list has not |
| 952 | // loaded yet. |
| 953 | group.inner.unwrap_or |
| 954 | |
| 955 | Chosen => |
| 956 | let value = match filling |
| 957 | Text => text, |
| 958 | _ => &mut discard, |
| 959 | ; |
| 960 | let = chosen_text; |
| 961 | from_id_salt |
| 962 | .selected_text |
| 963 | .show_ui |
| 964 | for opt in field.options |
| 965 | // Same rule as the radio group: shown, inert, and |
| 966 | // saying why. A closed control hides its list, so the |
| 967 | // reason has to travel with the row it belongs to. |
| 968 | if let Some = opt.unavailable |
| 969 | ui.add_enabled_ui |
| 970 | ui.selectable_value |
| 971 | value, |
| 972 | opt.value.to_owned, |
| 973 | new |
| 974 | .color, |
| 975 | ; |
| 976 | ; |
| 977 | continue; |
| 978 | |
| 979 | ui.selectable_value |
| 980 | value, |
| 981 | opt.value.to_owned, |
| 982 | new.color, |
| 983 | ; |
| 984 | |
| 985 | |
| 986 | .response |
| 987 | |
| 988 | |
| 989 | |
| 990 | |
| 991 | /// One field, as the column the app drops into its form. |
| 992 | /// |
| 993 | /// The anatomy is `makeover-webview`'s, so the two renderers put a form |
| 994 | /// together the same way: label, control, hint, error, top to bottom, with a |
| 995 | /// checkbox labelling itself instead of taking a label above. |
| 996 | /// |
| 997 | /// Returns [`None`] for a [`FieldKind::Hidden`] field, which is what |
| 998 | /// [`FieldKind::visible`] means and is the honest answer here: a webview still |
| 999 | /// emits an input for it because the form submits, and an immediate-mode |
| 1000 | /// renderer has no form and no submission, so a hidden field is a value the app |
| 1001 | /// already holds and there is nothing to draw or to respond to. |
| 1002 | /// |
| 1003 | /// `state` is the description's interaction axis. |
| 1004 | /// [`State::Disabled`] greys the field and stops it answering, through |
| 1005 | /// [`State::suppresses_interaction`] rather than through a second reading of |
| 1006 | /// what disabled means. Focus is not on that axis and never reaches here: egui |
| 1007 | /// owns reach, focus and the ring for this renderer, and one ring means not a |
| 1008 | /// second one per renderer that happens to have opinions. |
| 1009 | |
| 1010 | ui: &mut Ui, |
| 1011 | field: &, |
| 1012 | filling: , |
| 1013 | state: , |
| 1014 | palette: &Palette, |
| 1015 | style: &FieldStyle, |
| 1016 | |
| 1017 | if !field.kind.visible |
| 1018 | return None; |
| 1019 | |
| 1020 | let enabled = !state.is_some_and; |
| 1021 | let text = if enabled |
| 1022 | palette.content |
| 1023 | else |
| 1024 | palette.content_muted |
| 1025 | ; |
| 1026 | |
| 1027 | let response = ui |
| 1028 | .vertical |
| 1029 | ui.spacing_mut.item_spacing.y = style.gap; |
| 1030 | |
| 1031 | // A checkbox labels itself, on the right of the box. |
| 1032 | // `FieldKind::labels_itself` is the description saying so, and both |
| 1033 | // webview apps special-cased it inline before it did. |
| 1034 | if !field.kind.labels_itself |
| 1035 | ui.label; |
| 1036 | |
| 1037 | |
| 1038 | let response = ui |
| 1039 | .add_enabled_ui |
| 1040 | .inner; |
| 1041 | |
| 1042 | // Standing help first, then what is wrong now. Both, in that order, |
| 1043 | // for the reason the webview renderer names both in |
| 1044 | // `aria-describedby`: an error appearing must not take the hint |
| 1045 | // away with it. |
| 1046 | if let Some = field.hint |
| 1047 | ui.label; |
| 1048 | |
| 1049 | if let Some = field.error |
| 1050 | ui.label; |
| 1051 | |
| 1052 | response |
| 1053 | |
| 1054 | .inner; |
| 1055 | |
| 1056 | Some |
| 1057 | |
| 1058 | |
| 1059 | /// A set of fields, laid down a column. |
| 1060 | /// |
| 1061 | /// `show_extended` is the disclosure, and it is a parameter rather than state |
| 1062 | /// held here because the disclosure belongs to the *form* and not to any field: |
| 1063 | /// [`Field::extended`] marks which fields are behind one, and the app owns |
| 1064 | /// whether it is open. That is the same division `makeover-webview` draws when |
| 1065 | /// it marks the group `data-extended` and emits no control to toggle it. |
| 1066 | /// |
| 1067 | /// `draw` is called once per field that should be visible, in order. Taking a |
| 1068 | /// callback rather than a slice of [`Filling`]s is what keeps the app's own |
| 1069 | /// values borrowed one at a time: a form's fields usually live in different |
| 1070 | /// structs, and a parallel array would have to be built each frame and kept in |
| 1071 | /// step with the description by hand. |
| 1072 | |
| 1073 | ui: &mut Ui, |
| 1074 | fields: &'a [], |
| 1075 | show_extended: bool, |
| 1076 | style: &FieldStyle, |
| 1077 | mut draw: impl FnMut, |
| 1078 | |
| 1079 | ui.vertical |
| 1080 | ui.spacing_mut.item_spacing.y = style.group_gap; |
| 1081 | for f in fields |
| 1082 | if f.extended && !show_extended |
| 1083 | continue; |
| 1084 | |
| 1085 | draw; |
| 1086 | |
| 1087 | ; |
| 1088 | |
| 1089 | |
| 1090 | |
| 1091 | |
| 1092 | use *; |
| 1093 | |
| 1094 | |
| 1095 | Palette |
| 1096 | page: from_rgb, |
| 1097 | raised: from_rgb, |
| 1098 | overlay: from_rgb, |
| 1099 | well, |
| 1100 | sunken: from_rgb, |
| 1101 | bevel_light: WHITE, |
| 1102 | bevel_dark: BLACK, |
| 1103 | elevation: from_black_alpha, |
| 1104 | content: from_rgb, |
| 1105 | content_secondary: from_rgb, |
| 1106 | content_muted: from_rgb, |
| 1107 | action: from_rgb, |
| 1108 | danger: from_rgb, |
| 1109 | success: from_rgb, |
| 1110 | warning: from_rgb, |
| 1111 | info: from_rgb, |
| 1112 | |
| 1113 | |
| 1114 | |
| 1115 | /// The cast is egui's own shadow type carrying the theme's tone, which is |
| 1116 | /// the whole of what this crate had to decide for it: unlike a bevel, egui |
| 1117 | /// already knows how to paint one. |
| 1118 | |
| 1119 | |
| 1120 | // egui-drawing has no harness here, so what is tested is the decision |
| 1121 | // that precedes it: which fields have a unit to draw at all. The kind |
| 1122 | // half comes from the description rather than from a `matches!` in this |
| 1123 | // crate, which is the drift `FieldKind::measurable` exists to stop. |
| 1124 | let ranged = Field |
| 1125 | unit: Some, |
| 1126 | ..range |
| 1127 | ; |
| 1128 | assert_eq!; |
| 1129 | |
| 1130 | let typed = Field |
| 1131 | unit: Some, |
| 1132 | ..new |
| 1133 | ; |
| 1134 | assert_eq!; |
| 1135 | |
| 1136 | let worded = Field |
| 1137 | unit: Some, |
| 1138 | ..new |
| 1139 | ; |
| 1140 | assert_eq!; |
| 1141 | |
| 1142 | let bare = range; |
| 1143 | assert_eq!; |
| 1144 | |
| 1145 | |
| 1146 | |
| 1147 | |
| 1148 | let p = palette; |
| 1149 | let cast = p.cast; |
| 1150 | assert_eq!; |
| 1151 | assert!; |
| 1152 | assert_eq!; |
| 1153 | |
| 1154 | |
| 1155 | |
| 1156 | |
| 1157 | // No substitution left. The page-filled well was a stand-in for a |
| 1158 | // token that did not exist yet; it exists now. |
| 1159 | let w = from_rgb; |
| 1160 | let p = palette; |
| 1161 | assert_eq!; |
| 1162 | assert_ne!; |
| 1163 | |
| 1164 | |
| 1165 | |
| 1166 | |
| 1167 | let p = palette; |
| 1168 | assert_eq!; |
| 1169 | assert_eq!; |
| 1170 | assert_eq!; |
| 1171 | |
| 1172 | |
| 1173 | /// Sunken is its own colour, not the well's and not the page's. The two |
| 1174 | /// are authored in opposite directions and an earlier cut of the |
| 1175 | /// description conflated them. |
| 1176 | |
| 1177 | |
| 1178 | let p = palette; |
| 1179 | assert_eq!; |
| 1180 | assert_ne!; |
| 1181 | assert_ne!; |
| 1182 | |
| 1183 | |
| 1184 | |
| 1185 | |
| 1186 | // The cross-app bug, asserted at the renderer boundary this time. |
| 1187 | let p = palette; |
| 1188 | let raised = Raised.fill.and_then; |
| 1189 | let well = Well.fill.and_then; |
| 1190 | assert_eq!; |
| 1191 | assert_ne!; |
| 1192 | |
| 1193 | |
| 1194 | |
| 1195 | |
| 1196 | // makeover-layout 0.14.0 is what made this reachable. The answer was |
| 1197 | // already here at 0.10.0 and the question could not be asked. |
| 1198 | let p = palette; |
| 1199 | assert_eq! |
| 1200 | Overlay.fill.and_then, |
| 1201 | Some |
| 1202 | ; |
| 1203 | assert_eq!; |
| 1204 | // The shadow `frame` reaches for is the theme's tone rather than |
| 1205 | // egui's default, which is the whole reason `cast` exists. |
| 1206 | assert_eq!; |
| 1207 | |
| 1208 | |
| 1209 | |
| 1210 | |
| 1211 | let p = palette; |
| 1212 | let = Raised.bevel.unwrap.edges; |
| 1213 | let = Raised.pressed.bevel.unwrap.edges; |
| 1214 | assert_eq!; |
| 1215 | assert_eq!; |
| 1216 | |
| 1217 | |
| 1218 | |
| 1219 | |
| 1220 | assert!; |
| 1221 | assert!; |
| 1222 | |
| 1223 | |
| 1224 | |
| 1225 | |
| 1226 | // The save-the-wrong-thing bug, asserted at the second renderer so it |
| 1227 | // is not re-found there. goingson's own numbers. |
| 1228 | let options = |
| 1229 | plain, |
| 1230 | plain, |
| 1231 | plain, |
| 1232 | plain, |
| 1233 | ]; |
| 1234 | assert_eq!; |
| 1235 | // And a value that does match reads as its label, not as itself. |
| 1236 | let spelled = ; |
| 1237 | assert_eq!; |
| 1238 | |
| 1239 | |
| 1240 | |
| 1241 | |
| 1242 | let p = palette; |
| 1243 | let options = ; |
| 1244 | let field = Field |
| 1245 | placeholder: Some, |
| 1246 | ..select |
| 1247 | ; |
| 1248 | |
| 1249 | assert_eq! |
| 1250 | chosen_text, |
| 1251 | , |
| 1252 | "ghost text is not an answer, so it takes the tone the typed kinds' ghost text does" |
| 1253 | ; |
| 1254 | |
| 1255 | // Answered, and it is the label that reads rather than the value. |
| 1256 | assert_eq!; |
| 1257 | |
| 1258 | |
| 1259 | |
| 1260 | |
| 1261 | // The retention-10 bug and the ghost text meet here: a value no option |
| 1262 | // carries still reads as itself, because the field IS answered and the |
| 1263 | // answer is wrong. Only the empty value is unanswered. |
| 1264 | let p = palette; |
| 1265 | let options = ; |
| 1266 | let field = Field |
| 1267 | placeholder: Some, |
| 1268 | ..select |
| 1269 | ; |
| 1270 | |
| 1271 | assert_eq!; |
| 1272 | |
| 1273 | |
| 1274 | |
| 1275 | |
| 1276 | // The whole change is opt-in from the description. A field that says |
| 1277 | // nothing about its empty state still shows an empty box. |
| 1278 | let p = palette; |
| 1279 | let options = ; |
| 1280 | let field = select; |
| 1281 | assert_eq!; |
| 1282 | |
| 1283 | |
| 1284 | |
| 1285 | |
| 1286 | // The distinction the kind was added for, at the renderer that has to |
| 1287 | // act on it. A well with a figure in it is not a quiet slider. |
| 1288 | assert_eq!; |
| 1289 | assert_eq!; |
| 1290 | |
| 1291 | |
| 1292 | |
| 1293 | |
| 1294 | // egui's `Slider` demands both ends, so inventing one would be this |
| 1295 | // renderer picking bounds the app never stated and the user then |
| 1296 | // dragging against them. A typed number takes every answer the slider |
| 1297 | // would. |
| 1298 | let whole = range; |
| 1299 | assert_eq!; |
| 1300 | |
| 1301 | let half = Field |
| 1302 | max: Some, |
| 1303 | ..new |
| 1304 | ; |
| 1305 | assert_eq!; |
| 1306 | assert_eq!; |
| 1307 | |
| 1308 | // A bound this host cannot read is the same outcome by a different |
| 1309 | // route: the description carries bounds as text because the bound of a |
| 1310 | // date is a date. |
| 1311 | let dated = range; |
| 1312 | assert_eq!; |
| 1313 | |
| 1314 | |
| 1315 | |
| 1316 | |
| 1317 | // Without it a 0-to-1 threshold writes back whatever float the drag |
| 1318 | // landed on, which is the host's granularity and is what the |
| 1319 | // description says an absent step means. |
| 1320 | assert_eq!; |
| 1321 | assert_eq!; |
| 1322 | assert_eq!; |
| 1323 | // Trailing zeros are not precision: 0.10 is a one-decimal question. |
| 1324 | assert_eq!; |
| 1325 | |
| 1326 | |
| 1327 | |
| 1328 | |
| 1329 | // The tone rule, at the one place it is a claim rather than a |
| 1330 | // preference: this option genuinely will not answer, so muted is the |
| 1331 | // truth. The available ones beside it keep the secondary intent. |
| 1332 | let p = palette; |
| 1333 | let options = |
| 1334 | new, |
| 1335 | new.unless, |
| 1336 | ]; |
| 1337 | assert!; |
| 1338 | assert!; |
| 1339 | assert_eq! |
| 1340 | option_color, |
| 1341 | p.content, |
| 1342 | "the chosen option is the emphasised thing" |
| 1343 | ; |
| 1344 | assert_eq! |
| 1345 | option_color, |
| 1346 | p.content_secondary, |
| 1347 | "and `option_color` never mutes: the unavailable path is what does" |
| 1348 | ; |
| 1349 | |
| 1350 | |
| 1351 | |
| 1352 | |
| 1353 | let style = default; |
| 1354 | let plain = new; |
| 1355 | assert_eq!; |
| 1356 | |
| 1357 | let required = Field |
| 1358 | required: true, |
| 1359 | ..plain |
| 1360 | ; |
| 1361 | assert_eq!; |
| 1362 | |
| 1363 | // The marker is copy and the app owns it, which is why it is a knob. |
| 1364 | let house = FieldStyle |
| 1365 | required_marker: "(required)", |
| 1366 | ..style |
| 1367 | ; |
| 1368 | assert_eq!; |
| 1369 | |
| 1370 | |
| 1371 | |
| 1372 | |
| 1373 | // What decides whether the control gets a well. A well is for what the |
| 1374 | // user looks into, and only one of these is. |
| 1375 | assert_eq!; |
| 1376 | assert_eq!; |
| 1377 | assert_eq!; |
| 1378 | for k in |
| 1379 | Text, |
| 1380 | Secret, |
| 1381 | Number, |
| 1382 | Email, |
| 1383 | Url, |
| 1384 | Tel, |
| 1385 | Textarea, |
| 1386 | Rich, |
| 1387 | ] |
| 1388 | assert_eq!; |
| 1389 | |
| 1390 | // And the two multi-line ones get a multi-line edit, which is the half |
| 1391 | // `control_shape` alone does not say: both are typed into, and only one |
| 1392 | // of the two edit shapes can hold a markdown document. |
| 1393 | assert!; |
| 1394 | assert!; |
| 1395 | assert!; |
| 1396 | |
| 1397 | |
| 1398 | |
| 1399 | |
| 1400 | // The description holds Select and Radio apart, and a renderer that |
| 1401 | // collapsed them would silently answer a question the app did not ask: |
| 1402 | // audiofiles' storage style is irreversible and its alternatives have |
| 1403 | // to be readable without opening anything. Asserting the two shapes |
| 1404 | // differ is asserting that distinction survives the trip. |
| 1405 | assert!; |
| 1406 | assert!; |
| 1407 | assert_ne! |
| 1408 | control_shape, |
| 1409 | control_shape |
| 1410 | ; |
| 1411 | |
| 1412 | |
| 1413 | |
| 1414 | |
| 1415 | let p = palette; |
| 1416 | assert_eq!; |
| 1417 | assert_eq!; |
| 1418 | // The whole point of the distinction: muted is what Disabled resolves |
| 1419 | // to, so an option wearing it would claim it does not answer a press. |
| 1420 | assert_ne!; |
| 1421 | |
| 1422 | |
| 1423 | |
| 1424 | |
| 1425 | // Where the two renderers legitimately part: a webview still emits an |
| 1426 | // input because the form submits, and there is no form here. |
| 1427 | let f = new; |
| 1428 | let p = palette; |
| 1429 | __run_test_ui |
| 1430 | let drawn = field; |
| 1431 | assert!; |
| 1432 | ; |
| 1433 | |
| 1434 | |
| 1435 | |
| 1436 | |
| 1437 | let f = new; |
| 1438 | let p = palette; |
| 1439 | let style = default; |
| 1440 | __run_test_ui |
| 1441 | let mut text = Stringfrom; |
| 1442 | let disabled = field |
| 1443 | ui, |
| 1444 | &f, |
| 1445 | Text, |
| 1446 | Some, |
| 1447 | &p, |
| 1448 | &style, |
| 1449 | |
| 1450 | .unwrap; |
| 1451 | assert!; |
| 1452 | |
| 1453 | // Stating no state is the ordinary case and answers. Focus used to |
| 1454 | // be the counter-example here; it is egui's now and a description |
| 1455 | // cannot state it at all. |
| 1456 | let mut text = Stringfrom; |
| 1457 | let plain = field.unwrap; |
| 1458 | assert!; |
| 1459 | ; |
| 1460 | |
| 1461 | |
| 1462 | |
| 1463 | |
| 1464 | // No panic and no write-through. A checkbox handed a string cannot be |
| 1465 | // filled, so it is drawn off and left alone. |
| 1466 | let f = new; |
| 1467 | let p = palette; |
| 1468 | let mut text = Stringfrom; |
| 1469 | __run_test_ui |
| 1470 | let drawn = field |
| 1471 | ui, |
| 1472 | &f, |
| 1473 | Text, |
| 1474 | None, |
| 1475 | &p, |
| 1476 | &default, |
| 1477 | ; |
| 1478 | assert!; |
| 1479 | ; |
| 1480 | assert_eq!; |
| 1481 | |
| 1482 | |
| 1483 | |
| 1484 | |
| 1485 | let fields = |
| 1486 | new, |
| 1487 | Field |
| 1488 | extended: true, |
| 1489 | ..new |
| 1490 | , |
| 1491 | ]; |
| 1492 | let style = default; |
| 1493 | |
| 1494 | let mut closed = Vecnew; |
| 1495 | __run_test_ui |
| 1496 | group; |
| 1497 | ; |
| 1498 | assert_eq!; |
| 1499 | |
| 1500 | let mut open = Vecnew; |
| 1501 | __run_test_ui |
| 1502 | group; |
| 1503 | ; |
| 1504 | assert_eq!; |
| 1505 | |
| 1506 | |
| 1507 | |
| 1508 | |
| 1509 | let d = default; |
| 1510 | assert_eq!; |
| 1511 | assert_eq!; |
| 1512 | assert!; |
| 1513 | |
| 1514 | |
| 1515 |