Compare commits

...
Author SHA1 Message Date
iris-ai 4cb6f6882a Hold a bound's length where it is decided, and say each thing once
A quality sweep over the deferred request system, which no earlier round
has reviewed.

`Bound::outside` said which end a length fell outside and left the caller
to look that end up through `Bound::at`, which `expect`s an end the value
it is given does not promise: only the pairing of the two calls kept
`at(Shorter)` off a bound with no floor. It already had the length in
hand, so it returns that, and `Outside` and `at` go with the state that
could panic.

`measured_request` pinned the rel base for any bound at all, so a measured
share under a cap in pixels was invalidated by a change to a base its
answer cannot depend on. That question is `Bound::has_fraction` now, which
is also the one `Placing::ask` and `SizeRule::has_fraction` were each
writing out over a bare array.

The rest is one name where there were several spellings: `Span::gaps`,
`Padding::along`, `Plan::drop_bounds` behind one `IRIS_UNBOUNDED` in both
rigs that had grown their own, and `Stack::size_request` resolving its
sizing child the way its draw already does. `Span`'s placement loop asked
three times whether the row was allocated, twice to decide one child's
length; one match answers all three, so the allocated and plain rules are
read side by side.

The buffers `draw_at` now reuses for their capacity are empty only because
every path to it drains them in `remove`; a `debug_assert` says so, since
a drawing over primitives left in one would record them twice.

Comments: `with_requests` named discovery as the hazard where it is a
child drawn mid-row, `Painter::allocate` documented the window it holds
for rather than what it does, `minimum_request` had none, and the note
saying a span carries its children's weight whole -- which is still what
the unallocated path does, and still the surprising part -- had been
replaced by one about the other path.
2026-09-20 18:24:37 -04:00
iris-ai 0e838e9dd1 Retain request dependencies only when discovery supplies the answer 2026-09-20 17:31:53 -04:00
iris-ai 8780b40bb7 Resolve deferred size comparisons before allocating span slots 2026-09-20 16:50:18 -04:00
iris-aiandClaude Opus 5 de1eb7e406 Hold what a widget answers with a rule, and its box with a widget
Bryan's call, given the measurements in `76aaf06`: `SizeRule::{Min, Max,
Clamp}` holds the length a widget answers and never touches the box it draws
in, and `MaxSize` is the box version.

The split is the difference between a rule and a widget here. A box is
whoever asked's to decide, and the retained machinery hands a widget one by
paths that never ask it anything -- a parent re-placing a child, a subtree
repositioned after its parent's box moved. A rule that read the box was
therefore decided again by whichever path arrived last, which is what the
oracle was refusing. A widget has no such trouble: it is drawn again whenever
its own box changes, so `MaxSize` asks `longer_than` where the answer can be
kept, and `region_len` pins the box lengths its drawing holds for.

What that costs is nothing the app wanted: `a_capped_scroll_takes_its_
viewport_from_the_cap` puts 400 px of content under `.max_height(100)` and
gets a 100 px viewport with 300 to scroll, which is what `MaxSize` gave on the
app's pin, and `.max_width`/`.max_height` are that widget rather than a rule.
A cap narrows the offer and not a declared length, so a child that declares
500 px still draws 500 and the cap holds what `MaxSize` itself answers; a
child that asked for a share takes the box the cap allows and the share passes
up, since whoever divides one is `MaxSize`'s parent.

`.min_width`/`.min_height` stay a rule: answering at least so much is a claim
about the length, and a row honours it without anyone narrowing anything.

Bounds in the generated trees are pixels for now, with the reason written
where the next tree is grown: a fraction in a bound is resolved against the
rel base the widget was asked with, and `place_at` hands a parent a retained
answer without checking that it still holds for the rel base this place
gives. Seeds 4 and 196 at depth 5 are where that showed. The hole is older
than bounds -- an `Exact` rule that is a fraction can reach it too -- and
closing it is a check at the re-place site rather than anything about bounds.
A fraction through `MaxSize` is fine and tested, since the widget compares
against its own box.

Format, clippy with and without layout-diagnostics, and the suite (142 + 19 +
13 + 4) are clean. All three seed scans pass: 400 at depth 5 (62s), 1,000 at
depth 6 (162s), 2,000 at depth 4 (299s). The cold dump is 34,986 boxes and
moves wholesale against `2dba90b`, which is the generator growing rules it
did not grow before rather than a layout change; it is the new baseline.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-09-20 15:13:46 -04:00
iris-aiandClaude Opus 5 76aaf06c0b Add SizeRule::{Min, Max, Clamp}, which the oracle refuses
`MaxSize` on the app's pin narrows the box it asks its child in and cuts the
answer to the cap; nothing on this branch does either, so the capability is
missing rather than merely unported. This is that capability as a rule beside
the widget, the way `Exact` already is: `Min(Len)`, `Max(Len)` and
`Clamp { min, max }`, resolved against the rel base a declared length is a
fraction of, and never carrying `leftover` -- a cap containing a share admits
several self-sizing fixed points (`docs/LAYOUT.md`, failed hypotheses).

Where it stands: every hand-written test passes, including the capability the
app actually used -- `a_capped_scroll_takes_its_viewport_from_the_cap` puts
400 px of content under a 100 px cap and gets a 100 px viewport with 300 to
scroll, which is what `MaxSize` gave. The 400-seed depth-5 scan does not
pass, and the reason is a design question rather than a slip, so this sits on
its own branch instead of in #19.

What the scan finds: a bound is the first rule whose effect depends on the
box its parent gives it, and the retained machinery hands a widget a box by
paths that never ask it again -- `place_in` from a re-placing parent, and
`reposition` after a parent's box moved. A decision made when the box was one
length therefore survives into a box of another, so warm and cold disagree
about a tree they agree on structurally. Four readings were measured over 400
seeds at depth 5:

- deciding at every ask and keeping it: seeds 291, 1, 120, 178, 64 differ.
- the same, re-decided at `place_in` too: seeds 1, 362, 188, 254, 156 differ,
  because that path's box is the one the answer chose rather than the one the
  widget was asked in.
- skipping a place its parent decided outright, which is the rule the share
  follows: worse -- the same widget then gets two decisions by two paths.
- the bound as an answer rule only, leaving the box alone: seeds 4 and 196,
  and those are the closest to passing by a wide margin.

The share is the one existing rule of this kind and it is stable because
`place_at` re-asks a child whose rel base it narrows, and because its
decision is baked into the retained place as a `Sized` length. Neither
protection generalises: a bound that binds is a length of the rel base, and
`Sized` cannot say "this slot, narrowed" for a `Within` place.

Also here, because a bound needed them: `Len::longer_than` and
`Bound::outside` share one comparison with the span; a rule that is a
fraction now pins its rel base whether the fraction is a length or a bound,
which was a real gap for `Exact` too; `widget_trait!` passes attributes
through, so the methods it defines can carry doc comments (none could);
`From<N> for Len`, so a bound reads `max_width(300)`; and `random.rs` grows
all three variants, with `describe` printing them so a failure can be written
out by hand.

Format, clippy with and without layout-diagnostics, and the suite (142 + 19 +
13 + 4) are clean. The fast ten-seed oracle passes; the long scans do not.
Neutering the bounds in the generator while leaving its draws in place puts
the same shapes back to green, so the divergence is the bounds and not the
new trees.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-09-20 14:34:34 -04:00
iris-aiandClaude Opus 5 0d0326769c Ask the root the way every other widget is asked
The root had a layout path of its own: `root_layout` read its declared
lengths against the window, while every other widget's box came of
`Painter::widget_at`, where a rule of the widget's own -- a share with pixels
or a fraction beside it -- is compared against the offer and can take the box
past it. So a share on the root was the window whatever it asked for, which
`docs/LAYOUT_LOG.md` recorded as a gap rather than fixing, and any later rule
that reads the offer would have had to be written twice.

There is one box nobody drew, and that is the whole of what the root is
asked in. `Placing::WINDOW` says it -- the full output, fractions of the full
output, no move entry and no mask -- and `Placing::ask` is then the one place
a box is decided, called by the painter, by a local redraw, and by the root's
first draw. The root's own path is what is left of it: a widget with no
parent keeps different bookkeeping, not a different layout.

Measured in a 400 px window, a probe under each of three parents, which now
agree on every row where two of them agreed before:

    rule                      as root   wrapped   in a span
    leftover(1)                   400       400         400
    px(50) + leftover(1)          400       400         400
    px(500) + leftover(1)         500       500         500   (was 400 as root)
    rel(0.5) + leftover(1)        400       400         400
    rel(2.0) + leftover(1)        800       800         800   (was 400 as root)
    px(500)                       500       500         500
    rel(0.5)                      200       200         200

The comparison is kept on the widget asked about rather than on the asker,
which is what makes the root need nothing of its own: a window range means
the same thing at either end of an ask, `in_parent` passes one up unchanged,
and the asker ends up holding it through the child's drawing exactly as it
did when `longer_than` narrowed the asker directly. The root has no asker, so
its own record is the only place that range can live -- and `resize` already
checks that record, so a share crossing its length is caught with no new
code. `a_share_past_the_box_is_decided_again_on_either_side_of_the_crossing`
now runs at the root too: 500 at a 400 window, 900 at 900, 500 again at 400.

Two things this changes beyond the share. `DrawInfo::asked` is now the place
the parent offered rather than the place the ask came to, so a local redraw
re-decides the rule instead of re-reading the decision -- the two were the
same until a rule could move the box. And the root's `is_region_node` is
read, where the old path passed `false`: a region-node root now gets its
entry, whose translation is the identity, pinned by
`a_region_node_root_is_a_region_node`.

Format, clippy with and without layout-diagnostics, and the suite (136 + 19 +
13 + 4) are clean. The cold dump over 400 depth-5 trees is byte-identical to
`2dba90b` across all 34,571 boxes, and the three seed scans pass: 400 at
depth 5 (61s), 1,000 at depth 6 (155s), 2,000 at depth 4 (291s).

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-09-20 13:51:19 -04:00
32 changed files with 2529 additions and 331 deletions

No files matched your search

+8
View File
@@ -23,6 +23,14 @@ pub struct LayoutLen {
pub leftover: Weight,
}
/// A bare number is pixels, which is the one length that needs no box to be
/// read in.
impl<N: UiNum> From<N> for Len {
fn from(value: N) -> Self {
Len::px(value.to_f32())
}
}
impl<N: UiNum> From<N> for LayoutLen {
fn from(value: N) -> Self {
LayoutLen::px(value.to_f32())
+17 -2
View File
@@ -1,6 +1,6 @@
use crate::{
Declared, LayerId, LayoutHolds, MaskIdx, MoveIdx, PlaceDesc, RegionAlign, RetainedPrimitive,
Size, TextureHandle, UiRegion, UiVec2, WidgetId,
Bounds, Declared, LayerId, LayoutHolds, MaskIdx, MoveIdx, PlaceDesc, RegionAlign,
RetainedPrimitive, Size, TextureHandle, UiRegion, UiVec2, WidgetId,
};
/// What is kept of a widget its parent has asked about. `drawn` says whether
@@ -51,6 +51,8 @@ pub struct ActiveData {
/// An owned mask holds one reference independently of its primitives.
pub mask_region: Option<UiRegion>,
pub children: Vec<WidgetId>,
pub request_deps: Vec<WidgetId>,
pub(crate) scratch: DrawScratch,
/// The movable region its primitives are positioned through: its own when
/// opted in, otherwise the nearest ancestor's.
pub move_idx: MoveIdx,
@@ -58,6 +60,10 @@ pub struct ActiveData {
/// A change to one moves a box this widget cannot fix by drawing again,
/// and comparing them is what says so.
pub declared: Declared,
/// Its bounds, resolved the same way. The answer is held to these where
/// the box was not, so a change to one changes what it answers even
/// where its declared lengths stand.
pub bounds: Bounds,
/// Its alignment when it was last drawn, which a change to the property
/// is found against.
pub own_align: RegionAlign,
@@ -97,3 +103,12 @@ pub struct Answer {
pub size: Size,
pub holds: LayoutHolds,
}
#[derive(Debug, Default)]
pub(crate) struct DrawScratch {
pub children: Vec<WidgetId>,
pub size_deps: Vec<WidgetId>,
pub under: Vec<(WidgetId, LayoutHolds)>,
pub requests: Vec<crate::RequestedLen>,
pub lengths: Vec<crate::Px>,
}
+58 -1
View File
@@ -1,4 +1,4 @@
use crate::{Len, Px, REL_SHIFT, fixed::div_toward, fixed::narrow};
use crate::{Bound, Len, Px, REL_SHIFT, fixed::div_toward, fixed::narrow};
use std::ops::RangeInclusive;
/// The lengths of a box, in pixels, that one drawing of a widget holds for:
@@ -19,6 +19,63 @@ pub struct Holds {
pub hi: Px,
}
impl Len {
/// Whether this is longer than `than` in a window this wide, and the
/// windows that answer holds for.
///
/// Which is longer is a question in pixels -- `rel(0.5)` is longer than
/// 300 px at a box of 600 and shorter at 400 -- and it is asked of the
/// difference and answered back through that same difference, so the
/// boundary is the comparison's own rather than a second way of finding
/// it.
pub fn longer_than(&self, than: Len, window: Px) -> (bool, Holds) {
let over = *self - than;
let longer = over.to_px(window) > Px::ZERO;
let side = match longer {
true => Px::STEP..=Px::MAX,
false => Px::MIN..=Px::ZERO,
};
(longer, Holds::from(side).through(over))
}
}
impl Bound {
/// The end of this bound `len` falls outside, which is the length it
/// gets instead of its own, and the windows that answer holds for.
/// Nothing where it is inside, which is the answer wherever there is no
/// bound at all.
///
/// `len` and this bound are lengths of the same thing, whichever that
/// is: a box in window lengths wants the bound resolved, and a length a
/// widget declares of its rel base wants it as the rule wrote it. Both
/// comparisons are in pixels, so each is a question about this window,
/// and the box is decided again on the other side of a crossing.
pub fn outside(&self, len: Len, window: Px) -> (Option<Len>, Holds) {
let mut held = None;
let mut holds = Holds::ANY;
if let Some(min) = self.min {
let (shorter, kept) = min.longer_than(len, window);
holds = holds.and(kept);
if shorter {
held = Some(min);
}
}
if let Some(max) = self.max {
let (longer, kept) = held.unwrap_or(len).longer_than(max, window);
holds = holds.and(kept);
if longer {
debug_assert!(
held.is_none(),
"a floor of {:?} over a cap of {max:?} bounds nothing",
self.min,
);
held = Some(max);
}
}
(held, holds)
}
}
impl Holds {
pub const ANY: Self = Self {
lo: Px::MIN,
+1 -1
View File
@@ -20,7 +20,7 @@ pub use active::*;
pub use holds::*;
pub use layout_holds::*;
pub use painter::{Painter, PrimitiveLike};
pub use place::{PlaceDesc, PlaceDescAxis, RetainedPrimitive};
pub use place::{PlaceDesc, PlaceDescAxis, PlaceFit, RetainedPrimitive};
pub use render_state::*;
#[derive(Default)]
+325 -90
View File
@@ -1,9 +1,10 @@
#[cfg(feature = "layout-diagnostics")]
use crate::layout_diagnostics::{self as diag, Counter};
use crate::{
Axis, Declared, Holds, LayoutHolds, LayoutLen, Len, PlaceDesc, Px, PxVec2, RegionAlign, Rel,
RenderedText, RetainedPrimitive, Size, StrongWidget, TextAttrs, TextBuffer, TextureHandle,
UiRegion, UiRenderState, UiRsc, UiVec2, Weight, WidgetId, Widgets,
Axis, Bound, Bounds, Declared, DrawScratch, Holds, LayoutHolds, LayoutLen, Len, PlaceDesc,
PlaceFit, Px, PxVec2, RegionAlign, Rel, RenderedText, RequestArena, RequestedLen,
RetainedPrimitive, Size, SizeRequests, SizeRule, StrongWidget, TextAttrs, TextBuffer,
TextureHandle, UiRegion, UiRenderState, UiRsc, UiVec2, Weight, WidgetId, Widgets,
render::{
GlyphPrimitive, Mask, MaskIdx, MoveIdx, Primitive, PrimitiveInst, PrimitiveKind,
TexturePrimitive,
@@ -41,6 +42,8 @@ pub struct Painter<'a> {
pub(super) children: Vec<WidgetId>,
/// The children whose size this widget read while drawing.
pub(super) size_deps: Vec<WidgetId>,
pub(super) request_deps: Vec<WidgetId>,
pub(super) scratch: DrawScratch,
/// What this draw itself reads, as against what its children's drawings
/// hold for: every window and every length of its own region until it
/// reads one, then that one unless it says otherwise, and the rel base or
@@ -62,6 +65,134 @@ pub struct Painter<'a> {
}
impl<'a> Painter<'a> {
/// Reuses this widget's allocation buffers across draws. A child drawn
/// part way through gets a painter of its own, with buffers of its own,
/// so nothing it does while this one is mid-row can reach these.
pub fn with_requests<T>(
&mut self,
f: impl FnOnce(&mut Self, &mut Vec<RequestedLen>, &mut Vec<Px>) -> T,
) -> T {
let mut requests = std::mem::take(&mut self.scratch.requests);
let mut lengths = std::mem::take(&mut self.scratch.lengths);
requests.clear();
lengths.clear();
let result = f(self, &mut requests, &mut lengths);
self.scratch.requests = requests;
self.scratch.lengths = lengths;
result
}
/// Discovers a composable request without painting a provisional box.
pub fn size_request<W: ?Sized>(
&mut self,
child: &StrongWidget<W>,
axis: Axis,
) -> Option<RequestedLen> {
if self.rsc.widgets().size_rules(child.id())[axis].bound() == Bound::ANY
&& let Some(len) = self.size_hint(child, axis)
{
self.request_deps.push(child.id());
return Some(len.into());
}
let start = self.request_deps.len();
let mut requests = SizeRequests {
arena: &mut self.state.requests,
measured: None,
widgets: self.rsc.widgets(),
dependencies: &mut self.request_deps,
rel_base: self.rel_base[axis],
};
// Intrinsic fixed content must keep its offered box for wrapping;
// only a declaration or a share chooses the box it is drawn in.
let request = requests.widget(child, axis).filter(|request| {
request.has_leftover()
|| matches!(
self.rsc.widgets().size_rules(child.id())[axis],
SizeRule::Request(_)
)
});
if request.is_some() {
self.rel_base(axis);
} else {
// A discarded request contributes no dependency: the measured
// draw below records the size and box it actually used instead.
self.request_deps.truncate(start);
}
request
}
/// Completes discovery after a child was measured. Only this call may use
/// drawn answers: before the ask they could belong to an obsolete box.
pub fn measured_request<W: ?Sized>(
&mut self,
child: &StrongWidget<W>,
axis: Axis,
len: LayoutLen,
) -> RequestedLen {
let start = self.request_deps.len();
let bound = self.rsc.widgets().size_rules(child.id())[axis].bound();
let mut requests = SizeRequests {
arena: &mut self.state.requests,
measured: Some(&self.state.active),
widgets: self.rsc.widgets(),
dependencies: &mut self.request_deps,
rel_base: self.rel_base[axis],
};
if let Some(request) = requests.widget(child, axis)
&& request.linear().is_none()
&& request.has_leftover()
{
self.rel_base(axis);
return request;
}
let shares = len.leftover > Weight::ZERO;
let request = match shares {
true => requests.bounded(len.into(), bound),
false => len.into(),
};
self.request_deps.truncate(start);
// Only a bound that is a fraction was read against the rel base; one
// in pixels binds at the same length under any of them.
if shares && bound.has_fraction() {
self.rel_base(axis);
}
request
}
/// Divides `room` between `requests`, one length per request in
/// `output`. A deferred comparison is decided here, against this window:
/// which side of a crossing the solution falls is a question in pixels,
/// so the drawing holds only for the window that answered it.
pub fn allocate(
&mut self,
requests: &[RequestedLen],
room: Len,
axis: Axis,
output: &mut Vec<Px>,
) {
let window = self.window[axis];
self.own[axis].window = self.own[axis].window.and(Holds::at(window));
output.clear();
output.extend(
self.state
.requests
.allocate(requests, room.to_px(window), window),
)
}
/// The least a request can come to, which is what it takes of the row
/// before anything is divided. A comparison is read at no share at all.
pub fn minimum_request(&mut self, request: &RequestedLen, axis: Axis) -> Len {
match request.linear() {
Some(len) => len.without_leftover(),
None => {
let window = self.window[axis];
self.own[axis].window = self.own[axis].window.and(Holds::at(window));
Len::from_parts(Rel::ZERO, self.state.requests.minimum(*request, window))
}
}
}
fn primitive_at<P: Primitive>(&mut self, primitive: P, region: UiRegion) {
let kind = self.rsc.ui_mut().primitives.kind::<P>();
self.write(kind, primitive, region);
@@ -187,22 +318,24 @@ impl<'a> Painter<'a> {
id: &'s StrongWidget<W>,
place: impl Into<PlaceDesc>,
) -> DrawResult<'s, 'a, W> {
let mut place = self.resolve_rel_base(place.into());
let offer = self.resolve_rel_base(place.into());
let Ask {
rel_base,
region,
place,
declared,
bounds,
holds: ask_holds,
inputs,
} = self.placing().ask(
self.rsc.widgets(),
&mut self.state.requests,
self.window,
id.id(),
offer,
);
self.own = self.own.and(inputs);
let region_node = self.rsc.widgets().is_region_node(id.id());
let align = self.rsc.widgets().alignment(id.id());
// A share fills what the pixels and fraction beside it leave of the
// box and overflows where they are longer, which is the rule a span
// follows with one child. Only the overflow is a box of the child's
// own: a share that fits is the box it was given, which is what this
// place already says.
for axis in Axis::BOTH {
if let Some(len) = self.share_past_the_offer(id.id(), place, align, axis) {
place[axis] = len.as_desc().fills();
}
}
let declared = self.declared_lens(id);
let (rel_base, region) =
place.rel_base_and_region(self.region, self.rel_base, declared, align);
#[cfg(feature = "layout-diagnostics")]
if region_node {
diag::bump(Counter::RegionNodeDraws);
@@ -225,7 +358,10 @@ impl<'a> Painter<'a> {
rel_base,
region,
placed: place,
asked: place,
asked: offer,
declared,
bounds,
ask_holds,
re_asked,
},
None,
@@ -292,7 +428,7 @@ impl<'a> Painter<'a> {
/// This widget as the thing its children are placed within.
fn placing(&self) -> Placing {
Placing {
id: self.id,
id: Some(self.id),
region: self.region,
rel_base: self.rel_base,
depth: self.depth,
@@ -301,53 +437,6 @@ impl<'a> Painter<'a> {
}
}
/// What a rule or a hint declares a widget's lengths to be, which whoever
/// draws it resolves into its rel base. Reading them depends on nothing -- the box
/// that comes of them is kept on the child, and `redraw` compares it
/// there.
fn declared_lens<W: ?Sized>(&self, id: &StrongWidget<W>) -> Declared {
self.rsc.widgets().declared_lens(id.id())
}
/// The box a child's own share asks for where that is longer than the box
/// `place` gives it, and nothing where the share fits.
///
/// A share is a length only to whoever divides one, and nothing divides a
/// box handed to one child: what is left of it after the pixels and the
/// fraction beside the share is what the share takes, so the length comes
/// to the whole box until those are longer than it and to them once they
/// are. Only that second case is a box this widget did not give, and the
/// crossing between them is a question in pixels, so this widget's drawing
/// holds for the windows on one side of it. Narrowed rather than stated,
/// because this widget may have read its own box as well, and a range it
/// pinned for that still holds.
fn share_past_the_offer(
&mut self,
id: WidgetId,
place: PlaceDesc,
align: RegionAlign,
axis: Axis,
) -> Option<Len> {
// A place that is the child's placement outright is a box its parent
// decided, and a parent that divides one has already given the share
// whatever it was owed. Only an offer -- a box with the answer still
// to be placed inside it -- is a box a share reads.
if place[axis].fills {
return None;
}
// A share with nothing beside it is the box whatever the box is, so
// there is no comparison to make and no range to keep for one.
let stated = self.rsc.widgets().exact_len(id, axis)?;
if stated.leftover == Weight::ZERO || stated.is_only_leftover() {
return None;
}
let fixed = stated
.without_leftover()
.within_len(place.base(axis, self.rel_base));
let offer = place.of(self.region, align)[axis].len();
self.longer_than(fixed, offer, axis).then_some(fixed)
}
/// What a child says its length is without being drawn, if it can say,
/// as the length its draw would report: a fraction in it is resolved
/// against this widget's rel base, which is the rel base a child asked with
@@ -470,9 +559,10 @@ impl<'a> Painter<'a> {
/// worth anything, since reading one is also what makes its own size
/// depend on it.
pub fn has_exact_size(&self, axis: Axis) -> bool {
self.rsc.widgets().size_rules(self.id)[axis]
.exact()
.is_some()
matches!(
self.rsc.widgets().size_rules(self.id)[axis],
SizeRule::Exact(_) | SizeRule::Request(_)
)
}
/// This widget's own box in pixels. Reading it makes the drawing one
@@ -524,30 +614,16 @@ impl<'a> Painter<'a> {
len.to_px(window)
}
/// Whether `len` is longer than `than`, kept as the windows that comparison
/// comes out the same way on: a drawing that took one of two lengths holds
/// where the same one is the longer, and nowhere else.
/// [`Len::longer_than`], asked on this widget's behalf: the windows the
/// comparison comes out the same way on are windows its drawing holds
/// for, and nowhere else does it. What a container has left for the
/// shares it divides is the one thing that asks.
///
/// Which is longer is a question in pixels -- `rel(0.5)` is longer than 300
/// px at a box of 600 and shorter at 400 -- and it is asked of the
/// difference and answered back through that same difference, so the
/// boundary is the drawing's own rather than a second way of finding it.
/// Narrowed rather than stated, because whatever else this widget read
/// about the window is a reason its drawing holds where it does too.
///
/// This is the one operation a length that is the longer of two needs: the
/// room a container has left for the shares it divides, and a share that
/// overflows the box it was given because the pixels beside it are longer
/// than the box.
pub fn longer_than(&mut self, len: Len, than: Len, axis: Axis) -> bool {
let over = len - than;
let window = self.window[axis];
let longer = over.to_px(window) > Px::ZERO;
let side = match longer {
true => Px::STEP..=Px::MAX,
false => Px::MIN..=Px::ZERO,
};
let holds = Holds::from(side).through(over);
let (longer, holds) = len.longer_than(than, window);
debug_assert!(
holds.contains(window),
"'{}' ({:?}) compared two lengths and kept a range without this window",
@@ -729,6 +805,13 @@ impl Widgets {
/// share included, since a share is a length only to whoever divides one,
/// and that is the parent rather than this widget.
fn exact_len(&self, id: WidgetId, axis: Axis) -> Option<LayoutLen> {
// A request is a length the rule gives, and the hint below must not
// narrow the box in its place: what the request comes to is not known
// until the parent allocates, and it is the parent's answer, not this
// widget's.
if matches!(self.size_rules(id)[axis], SizeRule::Request(_)) {
return None;
}
self.size_rules(id)[axis].exact().or_else(|| {
// A hint still narrows the box where no rule does, which is how a
// widget with a natural pixel size -- an image, a gap -- gets that
@@ -746,6 +829,158 @@ impl Widgets {
}
}
/// One ask of a widget: the box it draws in, what its fractions are of, and
/// what deciding those read.
pub(super) struct Ask {
pub rel_base: UiVec2,
pub region: UiRegion,
/// The place the ask came to, which a rule of the widget's own can take
/// past the box its parent offered.
pub place: PlaceDesc,
/// What the widget's box is on each axis where something says so
/// outright: its rule or its hint, or a bound of its own that the box it
/// was offered falls outside -- a bound that binds is a declaration, and
/// the same one the widget answers with.
pub declared: Declared,
/// Its bounds, resolved against the rel base its rules were resolved
/// against, for the answer to be held to where the box was not.
pub bounds: Bounds,
/// What the ask itself holds for, kept on the widget asked about: a rule
/// compared against the offer in pixels holds only for the windows on its
/// side of the crossing, and that range reaches whoever asked through the
/// drawing it is part of. Kept on the widget asked about rather than on
/// the asker because the root has no asker.
pub holds: LayoutHolds,
/// Inputs read against the parent before declarations choose a new base.
/// These belong to the asker; the widget's own holds describe its output box.
pub inputs: LayoutHolds,
}
impl Placing {
/// Asks about a widget at `place` of this box, with the widget's own
/// rules applied to what the place offers it. `place` is resolved: what
/// a rel base of the asker's is a fraction of, the asker worked out.
///
/// Every ask is this one, the root's included -- there the box is the
/// window and nothing above narrowed it, which is what [`Self::WINDOW`]
/// says.
pub(super) fn ask(
&self,
widgets: &Widgets,
requests: &mut RequestArena,
window: PxVec2,
id: WidgetId,
mut place: PlaceDesc,
) -> Ask {
let align = widgets.alignment(id);
let rules = widgets.size_rules(id);
let mut holds = LayoutHolds::ANY;
let mut inputs = LayoutHolds::ANY;
let mut declared = widgets.declared_lens(id);
let mut bounds = Bounds::ANY;
for axis in Axis::BOTH {
let base = place.base(axis, self.rel_base);
if let SizeRule::Request(request) = &rules[axis] {
inputs[axis].rel_base = Some(self.rel_base[axis]);
inputs[axis].region_len = Some(self.region[axis].len());
inputs[axis].window = Holds::at(window[axis]);
let offer = place.of(self.region, align)[axis].len();
let px = if place[axis].fit == PlaceFit::Allocated {
offer.to_px(window[axis])
} else {
let request = requests.import(request, base);
holds[axis].window = Holds::at(window[axis]);
requests
.allocate(&[request], offer.to_px(window[axis]), window[axis])
.next()
.unwrap()
};
let len = Len::from_parts(Rel::ZERO, px);
place[axis].rel_base = RelBase::Len(len);
declared[axis] = Some(len);
holds[axis].rel_base = Some(len);
continue;
}
// A share fills what the pixels and fraction beside it leave of
// the box and overflows where they are longer, which is the rule
// a span follows with one child. Only the overflow is a box of
// the widget's own: a share that fits is the box it was given,
// which is what this place already says.
let (share, kept) =
self.share_past_the_offer(widgets, window[axis], id, place, align, axis);
holds[axis].window = holds[axis].window.and(kept);
if let Some(len) = share {
place[axis] = len.as_desc().fills();
}
// A bound holds what the widget answers, not the box it is asked
// in: the box it is given is whoever asked's to decide, and a
// rule that read it would be decided again by every path that
// hands the widget a box -- including the ones that never ask it
// anything. Resolved here because only the ask knows the rel base
// a fraction in it is of. `MaxSize` is the box version, and it is
// a widget because a widget is drawn again when its box changes.
let bound = rules[axis].bound();
if bound.has_fraction() {
inputs[axis].rel_base = Some(self.rel_base[axis]);
}
bounds[axis] = bound.within_len(base);
}
let (rel_base, region) =
place.rel_base_and_region(self.region, self.rel_base, declared, align);
Ask {
rel_base,
region,
place,
declared,
bounds,
holds,
inputs,
}
}
/// The box a widget's own share asks for where that is longer than the
/// box `place` gives it, and nothing where the share fits -- with the
/// windows that answer holds for, which is a range either way.
///
/// A share is a length only to whoever divides one, and nothing divides a
/// box handed to one child: what is left of it after the pixels and the
/// fraction beside the share is what the share takes, so the length comes
/// to the whole box until those are longer than it and to them once they
/// are. Only that second case is a box its parent did not give, and the
/// crossing between them is a question in pixels.
fn share_past_the_offer(
&self,
widgets: &Widgets,
window: Px,
id: WidgetId,
place: PlaceDesc,
align: RegionAlign,
axis: Axis,
) -> (Option<Len>, Holds) {
// A place that is the widget's placement outright is a box its parent
// decided, and a parent that divides one has already given the share
// whatever it was owed. Only an offer -- a box with the answer still
// to be placed inside it -- is a box a share reads.
if place[axis].fit.fills() {
return (None, Holds::ANY);
}
// A share with nothing beside it is the box whatever the box is, so
// there is no comparison to make and no range to keep for one.
let Some(stated) = widgets.exact_len(id, axis) else {
return (None, Holds::ANY);
};
if stated.leftover == Weight::ZERO || stated.is_only_leftover() {
return (None, Holds::ANY);
}
let fixed = stated
.without_leftover()
.within_len(place.base(axis, self.rel_base));
let offer = place.of(self.region, align)[axis].len();
let (longer, holds) = fixed.longer_than(offer, window);
(longer.then_some(fixed), holds)
}
}
impl LayoutLen {
/// Whether what a widget reported along an axis is the whole of the box
/// it is in rather than a part to be placed inside it. A share fills,
@@ -779,7 +1014,7 @@ impl PlaceDesc {
let mut placed = region;
for axis in Axis::BOTH {
let reported = size[axis];
if reported.fills(declared[axis], self[axis].fills) {
if reported.fills(declared[axis], self[axis].fit.fills()) {
continue;
}
placed[axis] = placed[axis].place(reported.without_leftover(), align[axis]);
+25 -5
View File
@@ -12,10 +12,24 @@ use crate::{Axis, AxisAlign, Len, PrimitiveHandle, RegionAlign, UiRegion, UiSpan
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct PlaceDescAxis {
pub span: PlaceSpan,
pub fills: bool,
pub fit: PlaceFit,
pub rel_base: RelBase,
}
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum PlaceFit {
Align,
Fill,
/// The parent has already evaluated the child's size request.
Allocated,
}
impl PlaceFit {
pub fn fills(&self) -> bool {
!matches!(self, Self::Align)
}
}
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum PlaceSpan {
Within(UiSpan),
@@ -44,7 +58,13 @@ impl PlaceDescAxis {
/// it again. A container uses it where it hands back exactly what the
/// child asked for -- a row placing a child at the length it reported.
pub const fn fills(mut self) -> Self {
self.fills = true;
self.fit = PlaceFit::Fill;
self
}
/// A final allocation, including any comparisons in the child's request.
pub const fn allocated(mut self) -> Self {
self.fit = PlaceFit::Allocated;
self
}
@@ -153,7 +173,7 @@ impl UiSpan {
pub const fn within_desc(self) -> PlaceDescAxis {
PlaceDescAxis {
span: PlaceSpan::Within(self),
fills: false,
fit: PlaceFit::Align,
rel_base: RelBase::WithRegion,
}
}
@@ -171,7 +191,7 @@ impl UiSpan {
pub const fn shifted_desc(self) -> PlaceDescAxis {
PlaceDescAxis {
span: PlaceSpan::Shifted(self),
fills: false,
fit: PlaceFit::Align,
rel_base: RelBase::Inherit,
}
}
@@ -185,7 +205,7 @@ impl Len {
pub const fn as_desc(self) -> PlaceDescAxis {
PlaceDescAxis {
span: PlaceSpan::Sized(self),
fills: false,
fit: PlaceFit::Align,
rel_base: RelBase::Len(self),
}
}
+242 -97
View File
@@ -1,9 +1,10 @@
#[cfg(feature = "layout-diagnostics")]
use crate::layout_diagnostics::{self as diag, Counter, ReuseOutcome, TimerKind};
use crate::{
ActiveData, Answer, Axis, Declared, DrawLayers, IdLike, LayoutHolds, LayoutLen, Len, MaskIdx,
MoveIdx, Moves, Painter, PixelRegion, PlaceDesc, PxVec2, Rel, Size, StrongWidget, UiRegion,
ActiveData, Answer, Axis, Bounds, Declared, DrawLayers, IdLike, LayoutHolds, LayoutLen, Len,
MaskIdx, MoveIdx, Moves, Painter, PixelRegion, PlaceDesc, PxVec2, Size, StrongWidget, UiRegion,
UiRsc, UiSpan, UiVec2, Weight, WidgetId, Widgets,
ui::painter::Ask,
util::{HashMap, Vec2},
};
@@ -23,11 +24,18 @@ pub(super) struct DrawInfo {
/// The box the widget is asked in, in its parent region node's
/// coordinates.
pub region: UiRegion,
/// Where the widget is put, and where it was asked, as parts of the
/// parent's box. See [`PlaceDesc`]. The two are one ask's place until the
/// parent puts the answer somewhere else.
/// Where the widget is put, and what its parent offered it, as parts of
/// the parent's box. See [`PlaceDesc`]. The two are one place until a
/// rule of the widget's own takes it past the offer, or the parent puts
/// the answer somewhere else.
pub placed: PlaceDesc,
pub asked: PlaceDesc,
/// What the ask made of the widget's own rules. See [`Ask::declared`]
/// and [`Ask::bounds`].
pub declared: Declared,
pub bounds: Bounds,
/// What the ask that gave it those two holds for. See [`Ask::holds`].
pub ask_holds: LayoutHolds,
/// Whether the parent already asked about this widget in this draw.
pub re_asked: bool,
}
@@ -43,7 +51,8 @@ pub(super) struct Drawn {
/// What a widget's children are placed in: its own box, the coordinates its
/// drawing is in, and what else one ask of a child is decided from.
pub(super) struct Placing {
pub id: WidgetId,
/// The widget whose box this is, and nothing for the window.
pub id: Option<WidgetId>,
pub region: UiRegion,
pub rel_base: UiVec2,
pub depth: usize,
@@ -51,6 +60,21 @@ pub(super) struct Placing {
pub mask: MaskIdx,
}
impl Placing {
/// The window, which is what the root is placed within. Nothing above the
/// root narrowed a box or chose where it goes, so it is asked in the whole
/// output and its fractions are of the whole output -- an ordinary ask,
/// from the one box nobody drew.
pub const WINDOW: Self = Self {
id: None,
region: UiRegion::FULL,
rel_base: UiVec2::FULL_SIZE,
depth: 0,
move_idx: MoveIdx::NONE,
mask: MaskIdx::NONE,
};
}
pub struct UiRenderState {
pub active: HashMap<WidgetId, ActiveData>,
pub layers: DrawLayers,
@@ -70,7 +94,10 @@ pub struct UiRenderState {
deferred: crate::util::HashSet<WidgetId>,
/// What the walk has left to settle, deepest last. Ordered rather than
/// searched for, so finding the next one is not a pass over the marks.
pending: std::collections::BTreeSet<(usize, WidgetId)>,
pending: std::collections::BinaryHeap<(usize, WidgetId)>,
pub(super) requests: crate::RequestArena,
changed: Vec<WidgetId>,
request_readers: HashMap<WidgetId, crate::util::HashSet<WidgetId>>,
pub moves: Moves,
}
@@ -84,6 +111,9 @@ impl UiRenderState {
slots: Default::default(),
deferred: Default::default(),
pending: Default::default(),
requests: Default::default(),
changed: Vec::new(),
request_readers: Default::default(),
moves: Default::default(),
resized: false,
}
@@ -124,20 +154,23 @@ impl UiRenderState {
}
}
/// The root is asked about in the output. Its own rules narrow both its
/// rel base and box; nothing above it chose a different one.
fn root_info(&self, rel_base: UiVec2, region: UiRegion) -> DrawInfo {
/// The root's first draw: the ask [`Placing::WINDOW`] answered, with the
/// bookkeeping a widget with no parent carries.
fn root_info(&self, ask: &Ask, region_node: bool) -> DrawInfo {
DrawInfo {
layer: 0,
parent: None,
depth: 1,
depth: Placing::WINDOW.depth + 1,
parent_move: MoveIdx::NONE,
region_node: false,
region_node,
mask: MaskIdx::NONE,
rel_base,
region,
placed: PlaceDesc::WHOLE,
rel_base: ask.rel_base,
region: ask.region,
placed: ask.place,
asked: PlaceDesc::WHOLE,
declared: ask.declared,
bounds: ask.bounds,
ask_holds: ask.holds,
re_asked: false,
}
}
@@ -167,6 +200,7 @@ impl UiRenderState {
weak widgets: {all:#?}"
);
}
self.requests.reset();
let root = root.into();
if self.root_changed(root) {
self.redraw_all(root, rsc);
@@ -184,24 +218,18 @@ impl UiRenderState {
let _layout = diag::timer(TimerKind::FullLayout);
self.clear(rsc);
if let Some(id) = root {
let (rel_base, region) = Self::root_layout(id.id(), rsc.widgets());
let info = self.root_info(rel_base, region);
let ask = Placing::WINDOW.ask(
rsc.widgets(),
&mut self.requests,
self.output_size,
id.id(),
PlaceDesc::WHOLE,
);
let info = self.root_info(&ask, rsc.widgets().is_region_node(id.id()));
self.draw_inner(id.id(), info, None, rsc);
}
}
/// The root's rel base and box: the window, taken in by the root's own
/// rules. Nothing above it narrowed anything or chose where it goes, so
/// its declaration is the whole of what decides either.
fn root_layout(id: WidgetId, widgets: &Widgets) -> (UiVec2, UiRegion) {
PlaceDesc::WHOLE.rel_base_and_region(
UiRegion::FULL,
UiVec2::FULL_SIZE,
widgets.declared_lens(id),
widgets.alignment(id),
)
}
pub(super) fn draw_inner(
&mut self,
id: WidgetId,
@@ -226,7 +254,7 @@ impl UiRenderState {
);
}
let align = rsc.widgets().alignment(id);
let declared = rsc.widgets().declared_lens(id);
let declared = info.declared;
// Nothing this widget measured can be dirty while it draws: layout is
// one bottom-up walk, so anything deeper has settled or deferred to
// its own parent, and a deferred one leaves that parent marked.
@@ -311,7 +339,27 @@ impl UiRenderState {
let mask_slot = old
.as_ref()
.and_then(|old| old.mask_region.map(|_| old.mask));
let old_children = old.map_or_else(Vec::new, |old| old.children);
let (mut old_children, textures, primitives, request_deps, mut scratch) = match old {
Some(old) => (
old.children,
old.textures,
old.primitives,
old.request_deps,
old.scratch,
),
None => Default::default(),
};
// Every one of these is a buffer this widget's last draw filled and
// `remove` emptied, kept for its capacity alone. A drawing whose
// primitives were still in it would record them twice.
debug_assert!(
textures.is_empty() && primitives.is_empty() && request_deps.is_empty(),
"'{}' ({id:?}) was drawn again over what its last draw left",
rsc.widgets().label(id)
);
let children = std::mem::take(&mut scratch.children);
let size_deps = std::mem::take(&mut scratch.size_deps);
let under = std::mem::take(&mut scratch.under);
rsc.widgets_mut().needs_redraw.remove(&id);
let window = self.output_size;
let mut painter = Painter {
@@ -323,14 +371,19 @@ impl UiRenderState {
layer: info.layer,
own_layer: info.layer,
id,
textures: Vec::new(),
primitives: Vec::new(),
textures,
primitives,
mask_region: None,
mask_slot,
children: Vec::new(),
size_deps: Vec::new(),
own: LayoutHolds::ANY,
under: Vec::new(),
children,
size_deps,
request_deps,
scratch,
// What the ask holds for is part of what the drawing holds for:
// a box the widget's own rule took past the offer was decided in
// this window, and at the root nobody else keeps that range.
own: info.ask_holds,
under,
answer_under: LayoutHolds::ANY,
depth: info.depth,
move_idx,
@@ -362,8 +415,10 @@ impl UiRenderState {
own,
answer_under,
children,
size_deps,
under,
mut size_deps,
request_deps,
mut scratch,
mut under,
move_idx,
layer,
own_layer: _,
@@ -379,11 +434,15 @@ impl UiRenderState {
// A rule wins on the axis it names, and the draw answers the rest.
// Applied here so it is one place rather than every widget that could
// carry one, and so the widget under a rule never learns of it. The
// rel base is the answer where the rule gave a length outright: it was
// resolved into the rel base when the child was asked, and resolving it
// again here would take the fraction of a fraction.
let rules = rsc.widgets().size_rules(id);
let ruled = |axis: Axis, reported: LayoutLen| match rules[axis].exact() {
// rel base is the answer wherever the ask declared a length: it was
// resolved into the rel base when the widget was asked, and resolving
// it again here would take the fraction of a fraction.
let rules = rsc.widgets().size_rules(id).clone();
let ruled = |axis: Axis, reported: LayoutLen| {
if matches!(rules[axis], crate::SizeRule::Request(_)) {
return info.rel_base[axis].into();
}
match rules[axis].exact() {
None => reported,
Some(len) if len.leftover == Weight::ZERO => LayoutLen {
rel: info.rel_base[axis].rel,
@@ -391,11 +450,38 @@ impl UiRenderState {
leftover: Weight::ZERO,
},
Some(len) => len.within_len(info.rel_base[axis]),
}
};
let size = Size {
let mut size = Size {
x: ruled(Axis::X, size.x),
y: ruled(Axis::Y, size.y),
};
// A bound is a promise about the length as well as about the box: a
// widget that drew past the box it was given -- a text too tall for
// it, an image at its own size under a cap -- is still held to what
// its rule allows.
//
// Held here rather than taken from the box, even where the bound
// decided that box. What a widget answers is its own, and a bound
// that replaced the answer would make a share into a fixed length
// the moment a box was long enough -- which is a length the span
// dividing that box decided from this answer, so the two would
// choose each other. A share is left alone here for the same reason:
// it is a length only to whoever divides one, and the box that
// divider gives is a box this widget is asked in, where the bound is
// applied to it.
let mut bounded = LayoutHolds::ANY;
for axis in Axis::BOTH {
let answer = size[axis];
if answer.leftover != Weight::ZERO {
continue;
}
let (held, kept) = info.bounds[axis].outside(answer.without_leftover(), window[axis]);
bounded[axis].window = kept;
if let Some(held) = held {
size[axis] = held.into();
}
}
// A widget that clipped its contents to its box drew nothing outside
// it, so reporting more than the box asks to be placed at a length it
// does not occupy -- and its parent would place the part it cut off.
@@ -426,18 +512,19 @@ impl UiRenderState {
// A rule that is a fraction of the rel base is answered with the
// rel base's own length, so the answer is that rel base's and not just
// that many pixels of this window -- the same pin a widget that read
// its rel base took for its drawing.
let mut own_holds = own;
// its rel base took for its drawing. A bound counts: which side of it
// the box fell was decided against this rel base, and the same box of
// a different one can fall on the other.
let mut own_holds = own.and(bounded);
for axis in Axis::BOTH {
let fraction = rules[axis].exact().is_some_and(|len| len.rel != Rel::ZERO);
if fraction {
if rules[axis].has_fraction() {
own_holds[axis].rel_base = Some(info.rel_base[axis]);
}
}
let answer_holds = own_holds.and(answer_under);
let holds = under
.into_iter()
.fold(answer_holds, |holds, (_, child)| holds.and(child));
.iter()
.fold(answer_holds, |holds, (_, child)| holds.and(*child));
debug_assert!(
holds.contains(self.output_size, info.rel_base, region),
"'{}' ({id:?}) drew in {}, outside the ranges it reported: {holds:?}",
@@ -462,6 +549,9 @@ impl UiRenderState {
region: UiRegion::FULL,
placed: PlaceDesc::WHOLE,
asked: PlaceDesc::WHOLE,
declared: Declared::NONE,
bounds: Bounds::ANY,
ask_holds: LayoutHolds::ANY,
re_asked: false,
},
rsc,
@@ -470,6 +560,15 @@ impl UiRenderState {
}
}
for &dep in &request_deps {
self.request_readers.entry(dep).or_default().insert(id);
}
old_children.clear();
size_deps.clear();
under.clear();
scratch.children = old_children;
scratch.size_deps = size_deps;
scratch.under = under;
let active = ActiveData {
id,
placement: region,
@@ -489,7 +588,10 @@ impl UiRenderState {
primitives,
mask_region,
children,
declared: rsc.widgets().declared_lens(id),
request_deps,
scratch,
declared: info.declared,
bounds: info.bounds,
own_align: rsc.widgets().alignment(id),
move_idx,
parent_move: info.parent_move,
@@ -534,6 +636,7 @@ impl UiRenderState {
if !active.drawn
|| active.is_region_node() != info.region_node
|| active.parent_move != info.parent_move
|| active.bounds != info.bounds
{
return None;
}
@@ -659,6 +762,9 @@ impl UiRenderState {
let active = self.active.get_mut(&id).unwrap();
active.rel_base = info.rel_base;
active.placed = info.placed;
// What the ask made of its rules, which a re-place decides again.
active.declared = info.declared;
active.bounds = info.bounds;
#[cfg(feature = "layout-diagnostics")]
{
let (counter, outcome) = match (moved, is_region_node) {
@@ -697,7 +803,7 @@ impl UiRenderState {
);
let info = DrawInfo {
layer: active.layer,
parent: Some(at.id),
parent: at.id,
depth: at.depth + 1,
parent_move: at.move_idx,
region_node: active.is_region_node(),
@@ -706,6 +812,10 @@ impl UiRenderState {
region,
placed: place,
asked: active.asked,
declared: active.declared,
bounds: active.bounds,
// Placing decides no box: this is the one the ask already gave.
ask_holds: LayoutHolds::ANY,
re_asked: active.re_asked,
};
self.relocate(child, placed, info, rsc);
@@ -734,7 +844,7 @@ impl UiRenderState {
rsc.ui_mut().masks.get_mut(active.mask).region = mask_region.within(&placed);
}
let at = Placing {
id,
id: Some(id),
region: placed,
rel_base: info.rel_base,
depth: info.depth,
@@ -783,6 +893,11 @@ impl UiRenderState {
fn remove(&mut self, id: WidgetId, undraw: bool, rsc: &mut dyn UiRsc) -> Option<ActiveData> {
let mut active = self.active.remove(&id);
if let Some(active) = &mut active {
for dep in active.request_deps.drain(..) {
if let Some(readers) = self.request_readers.get_mut(&dep) {
readers.remove(&id);
}
}
for primitive in &active.primitives {
let mask = self.layers.free(&primitive.handle);
if mask != MaskIdx::NONE {
@@ -856,8 +971,11 @@ impl UiRenderState {
primitives: Vec::new(),
mask_region: None,
children: Vec::new(),
request_deps: Vec::new(),
scratch: Default::default(),
move_idx: info.parent_move,
declared: Declared::NONE,
bounds: Bounds::ANY,
own_align: rsc.widgets().alignment(id),
parent_move: info.parent_move,
mask: info.mask,
@@ -868,6 +986,7 @@ impl UiRenderState {
}
fn clear(&mut self, rsc: &mut dyn UiRsc) {
self.request_readers.clear();
for (_, active) in self.active.drain() {
if active.drawn {
rsc.on_undraw(&active);
@@ -888,6 +1007,7 @@ impl UiRenderState {
rsc.on_remove(id);
self.remove(id, true, rsc);
self.drop_slot(id);
self.request_readers.remove(&id);
}
rsc.ui_mut().textures.free();
}
@@ -895,6 +1015,18 @@ impl UiRenderState {
pub fn redraw_updates(&mut self, rsc: &mut dyn UiRsc) {
#[cfg(feature = "layout-diagnostics")]
let _layout = diag::timer(TimerKind::IncrementalLayout);
self.changed.clear();
self.changed
.extend(rsc.widgets().needs_redraw.iter().copied());
while let Some(id) = self.changed.pop() {
if let Some(readers) = self.request_readers.get(&id) {
for &reader in readers {
if rsc.widgets_mut().needs_redraw.insert(reader) {
self.changed.push(reader);
}
}
}
}
// Deepest first, and strictly: a widget that cannot settle where it
// is defers to its parent rather than drawing the parent from
// inside itself. It marks the parent, stays marked, and waits here
@@ -906,21 +1038,21 @@ impl UiRenderState {
// something below is about to change it -- which is the whole class
// of defect where a widget settles inside its parent's draw, clears
// its mark there, and tells nobody its answer moved.
// The queue is that set, ordered: a mark made while the walk runs
// queues itself through `mark`. What ends the walk is still the set
// being spent, not the queue, so a mark that reached it another way
// cannot be left for the next frame.
// A mark made while the walk runs queues itself through `mark`. What
// ends the walk is the marks being spent rather than the queue being
// empty, so a mark that reached the queue twice, or that was settled
// another way, costs a pop and nothing else.
loop {
for &id in rsc.widgets().needs_redraw.iter() {
if !self.deferred.contains(&id) {
let depth = self.depth(id);
self.pending.insert((depth, id));
self.pending.push((depth, id));
}
}
if self.pending.is_empty() {
break;
}
while let Some((depth, id)) = self.pending.pop_last() {
while let Some((depth, id)) = self.pending.pop() {
// Settled inside an ancestor's draw, or deferred to one,
// since the mark that queued it.
if self.deferred.contains(&id) || !rsc.widgets().needs_redraw.contains(&id) {
@@ -931,7 +1063,7 @@ impl UiRenderState {
// depth it had under the parent it left.
let now = self.depth(id);
if now != depth {
self.pending.insert((now, id));
self.pending.push((now, id));
continue;
}
#[cfg(feature = "layout-diagnostics")]
@@ -948,7 +1080,7 @@ impl UiRenderState {
fn mark(&mut self, id: WidgetId, widgets: &mut Widgets) {
if widgets.needs_redraw.insert(id) && !self.deferred.contains(&id) {
let depth = self.depth(id);
self.pending.insert((depth, id));
self.pending.push((depth, id));
}
}
@@ -1042,12 +1174,28 @@ impl UiRenderState {
let Some(active) = self.active.get(&id) else {
return true;
};
// Its parent resolved its declared lengths into its box and decided
// whether to draw it at all, so a change to either is the parent's
// to draw -- with the mark left on, so the parent draws it rather
// than keeping it. So is a widget the parent asked twice: its
// layout rests on an answer this widget cannot give again alone.
let declared_changed = rsc.widgets().declared_lens(id) != active.declared;
// Asked where its parent asked it, which is what says whether the
// question is still this widget's own: its parent resolved its
// declared lengths into its box -- a bound of its own that the box
// falls outside is one of them -- and decided whether to draw it at
// all, so a change to either is the parent's to draw, with the mark
// left on so the parent draws it rather than keeping it. So is a
// widget the parent asked twice: its layout rests on an answer this
// widget cannot give again alone. The root's parent is the window,
// which no draw made and no answer can move.
let at = match active.parent {
Some(parent) => self.placing_of(parent, self.active[&parent].region),
None => Placing::WINDOW,
};
let ask = at.ask(
rsc.widgets(),
&mut self.requests,
self.output_size,
id,
active.asked,
);
let active = &self.active[&id];
let declared_changed = ask.declared != active.declared;
let alignment_changed = rsc.widgets().alignment(id) != active.own_align;
if let Some(parent) = active.parent
&& (declared_changed
@@ -1066,29 +1214,13 @@ impl UiRenderState {
if !active.drawn {
return true;
}
// Nothing above the root resolved its rules or its alignment, so its
// box is its own to work out again against the output. Every other
// widget was given one.
let Some(parent) = active.parent else {
let (rel_base, region) = Self::root_layout(id, rsc.widgets());
let info = DrawInfo {
mask: active.parent_mask,
..self.root_info(rel_base, region)
};
#[cfg(feature = "layout-diagnostics")]
diag::bump(Counter::LocalRedraws);
let old = self.remove(id, false, rsc);
self.draw_inner(id, info, old, rsc);
return true;
};
let (was_answer, was_holds, was_place) = (active.answer, active.holds, active.placed);
// The question its parent asked, asked again: the same place of the
// box the parent was asked in, which is the box the parent's own
// draw ran in and what its children's parts are of. Where the
// parent's answer put its own drawing is not a question anybody
// asked, and nothing is asked in it here either.
let parent_at = self.placing_of(parent, self.active[&parent].region);
let (rel_base, region) = Self::ask_again(active, &parent_at, active.asked);
// The place the ask above came to: the same place of the box the
// parent was asked in, which is the box the parent's own draw ran in
// and what its children's parts are of. Where the parent's answer put
// its own drawing is not a question anybody asked, and nothing is
// asked in it here either.
let (rel_base, region) = (ask.rel_base, ask.region);
let info = DrawInfo {
layer: active.layer,
parent: active.parent,
@@ -1098,8 +1230,11 @@ impl UiRenderState {
mask: active.parent_mask,
rel_base,
region,
placed: active.asked,
placed: ask.place,
asked: active.asked,
declared: ask.declared,
bounds: ask.bounds,
ask_holds: ask.holds,
re_asked: false,
};
#[cfg(feature = "layout-diagnostics")]
@@ -1127,22 +1262,32 @@ impl UiRenderState {
if active.holds.covers(was_holds) && was_holds.contains(window, rel_base, region) {
active.holds = was_holds;
}
if active.answer != was_answer || active.holds != was_holds {
// The parent retains both the answer and the drawing's validity;
// even an unchanged size can narrow the range safe for a resize.
let changed = active.answer != was_answer || active.holds != was_holds;
// Nothing above the root retained either, so there is nobody to tell
// and nowhere else the drawing has to go back to.
if let Some(parent) = active.parent {
match changed {
// The parent retains both the answer and the drawing's
// validity; even an unchanged size can narrow the range safe
// for a resize.
true => {
#[cfg(feature = "layout-diagnostics")]
{
diag::bump(Counter::SizeChanges);
diag::bump(Counter::ReaderEdges);
}
self.mark(parent, rsc.widgets_mut());
} else {
}
// The answer stands, so where the parent put it stands: the
// fresh drawing goes back there -- the same place, of the box
// the parent's answer chose rather than the one it was asked in.
// the parent's answer chose rather than the one it was asked
// in.
false => {
let at = self.placing_of(parent, self.active[&parent].placement);
self.place_in(id, &at, was_place, rsc);
}
}
}
true
}
@@ -1152,7 +1297,7 @@ impl UiRenderState {
fn placing_of(&self, id: WidgetId, region: UiRegion) -> Placing {
let active = &self.active[&id];
Placing {
id,
id: Some(id),
region,
rel_base: active.rel_base,
depth: active.depth,
+8
View File
@@ -4,6 +4,7 @@ use std::any::Any;
mod data;
mod handle;
mod like;
mod request;
mod size_rule;
mod tag;
mod view;
@@ -12,6 +13,7 @@ mod widgets;
pub use data::*;
pub use handle::*;
pub use like::*;
pub use request::*;
pub use size_rule::*;
pub use tag::*;
pub use view::*;
@@ -21,6 +23,12 @@ pub trait Widget: Any {
/// Draws the widget, and returns what it used of the box it was given.
fn draw(&mut self, painter: &mut Painter) -> Size;
/// Describes an axis before painting. Return `None` when discovering it
/// needs a concrete box or work performed by `draw`.
fn size_request(&self, requests: &mut SizeRequests, axis: Axis) -> Option<RequestedLen> {
self.size_hint(axis).map(|len| requests.length(len))
}
/// An exact length the widget can give without a painter or its children.
/// Optional, and saves a draw rather than changing one: a hint that
/// disagrees with the eventual draw fails a debug assertion.
+449
View File
@@ -0,0 +1,449 @@
use crate::{
ActiveData, Axis, Bound, LayoutLen, Len, Px, Rel, SizeRule, StrongWidget, UiNum, Weight,
WidgetId, Widgets, util::HashMap,
};
use std::{cmp::Ordering, sync::Arc};
impl<N: UiNum> From<N> for SizeRequest {
fn from(value: N) -> Self {
LayoutLen::px(value).into()
}
}
impl LayoutLen {
pub fn min(self, other: impl Into<SizeRequest>) -> SizeRequest {
SizeRequest::from(self).min(other)
}
pub fn max(self, other: impl Into<SizeRequest>) -> SizeRequest {
SizeRequest::from(self).max(other)
}
pub fn clamp(self, min: impl Into<SizeRequest>, max: impl Into<SizeRequest>) -> SizeRequest {
SizeRequest::from(self).clamp(min, max)
}
}
/// A size request before a container has divided its leftover space.
/// Comparisons keep both operands until the share is known.
#[derive(Clone, Debug, PartialEq)]
pub enum SizeRequest {
Linear(LayoutLen),
Sum(Arc<(Self, Self)>),
Min(Arc<(Self, Self)>),
Max(Arc<(Self, Self)>),
}
impl From<LayoutLen> for SizeRequest {
fn from(len: LayoutLen) -> Self {
Self::Linear(len)
}
}
impl From<Len> for SizeRequest {
fn from(len: Len) -> Self {
LayoutLen::from(len).into()
}
}
impl SizeRequest {
pub fn min(self, other: impl Into<Self>) -> Self {
let other = other.into();
if let (Self::Linear(a), Self::Linear(b)) = (&self, &other)
&& let Some(order) = independent_order(*a, *b)
{
return if !order.is_gt() { self } else { other };
}
if self == other {
self
} else {
Self::Min(Arc::new((self, other)))
}
}
pub fn max(self, other: impl Into<Self>) -> Self {
let other = other.into();
if let (Self::Linear(a), Self::Linear(b)) = (&self, &other)
&& let Some(order) = independent_order(*a, *b)
{
return if !order.is_lt() { self } else { other };
}
if self == other {
self
} else {
Self::Max(Arc::new((self, other)))
}
}
pub fn clamp(self, min: impl Into<Self>, max: impl Into<Self>) -> Self {
self.max(min).min(max)
}
}
impl std::ops::Add for SizeRequest {
type Output = Self;
fn add(self, other: Self) -> Self {
match (self, other) {
(Self::Linear(a), Self::Linear(b)) => Self::Linear(a + b),
(a, b) => Self::Sum(Arc::new((a, b))),
}
}
}
/// A discovered length. Deferred values belong to the current layout pass;
/// widgets must not retain them. Ordinary requests remain inline lengths.
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct RequestedLen(RequestValue);
#[derive(Clone, Copy, Debug, PartialEq)]
enum RequestValue {
Linear(LayoutLen),
Deferred {
index: usize,
epoch: u64,
leftover: bool,
},
}
impl From<LayoutLen> for RequestedLen {
fn from(len: LayoutLen) -> Self {
Self(RequestValue::Linear(len))
}
}
impl From<Len> for RequestedLen {
fn from(len: Len) -> Self {
LayoutLen::from(len).into()
}
}
impl RequestedLen {
/// The length itself, where no comparison is waiting on an allocation.
pub fn linear(&self) -> Option<LayoutLen> {
match self.0 {
RequestValue::Linear(len) => Some(len),
_ => None,
}
}
pub fn has_leftover(&self) -> bool {
match self.0 {
RequestValue::Linear(len) => len.leftover > Weight::ZERO,
RequestValue::Deferred { leftover, .. } => leftover,
}
}
}
#[derive(Clone, Copy)]
enum Op {
Sum,
Min,
Max,
}
struct Node {
op: Op,
a: RequestedLen,
b: RequestedLen,
}
#[derive(Default)]
pub(crate) struct RequestArena {
nodes: Vec<Node>,
epoch: u64,
}
impl RequestArena {
pub(crate) fn reset(&mut self) {
self.nodes.clear();
self.epoch = self
.epoch
.checked_add(1)
.expect("layout generation exhausted");
}
pub(crate) fn import(&mut self, request: &SizeRequest, base: Len) -> RequestedLen {
let (op, pair) = match request {
SizeRequest::Linear(len) => return len.within_len(base).into(),
SizeRequest::Sum(pair) => (Op::Sum, pair),
SizeRequest::Min(pair) => (Op::Min, pair),
SizeRequest::Max(pair) => (Op::Max, pair),
};
let a = self.import(&pair.0, base);
let b = self.import(&pair.1, base);
self.combine(op, a, b)
}
fn combine(&mut self, op: Op, a: RequestedLen, b: RequestedLen) -> RequestedLen {
if let (Some(x), Some(y)) = (a.linear(), b.linear()) {
if matches!(op, Op::Sum) {
return (x + y).into();
}
let order = independent_order(x, y);
if let Some(order) = order {
let take_a = match op {
Op::Min => !order.is_gt(),
_ => !order.is_lt(),
};
return if take_a { a } else { b };
}
}
if a == b && !matches!(op, Op::Sum) {
return a;
}
let index = self.nodes.len();
self.nodes.push(Node { op, a, b });
RequestedLen(RequestValue::Deferred {
index,
epoch: self.epoch,
leftover: a.has_leftover() || b.has_leftover(),
})
}
pub(crate) fn minimum(&self, request: RequestedLen, window: Px) -> Px {
Px::from_raw(self.segment(request, Ratio::ZERO, window).fixed as i32)
}
fn segment(&self, request: RequestedLen, at: Ratio, window: Px) -> Segment {
match request.0 {
RequestValue::Linear(len) => {
debug_assert!(
len.leftover >= Weight::ZERO,
"a leftover weight cannot be negative"
);
Segment {
fixed: i64::from(len.without_leftover().to_px(window).raw()),
weight: i64::from(len.leftover.raw()),
end: None,
}
}
RequestValue::Deferred { index, epoch, .. } => {
assert_eq!(epoch, self.epoch, "request retained beyond its layout pass");
let Node { op, a, b } = self.nodes[index];
let a = self.segment(a, at, window);
let b = self.segment(b, at, window);
if matches!(op, Op::Sum) {
return a + b;
}
// At a crossing choose the branch to its right, so the next
// iteration advances rather than selecting that crossing again.
let order = a.value(at).cmp(&b.value(at)).then(a.weight.cmp(&b.weight));
let take_a = match op {
Op::Min => !order.is_gt(),
_ => !order.is_lt(),
};
let mut selected = if take_a { a } else { b };
selected.end = first(a.end, b.end);
if a.weight != b.weight {
let crossing = Ratio::new(b.fixed - a.fixed, a.weight - b.weight);
if crossing > at {
selected.end = first(selected.end, Some(crossing));
}
}
selected
}
}
}
/// Divides `room` between requests whose weights are nonnegative, one
/// length per request. A floor can overflow the room and a cap can leave
/// part of it unused, so the lengths need not come to `room`. Each edge
/// is rounded from the running total rather than from the length before
/// it, so two neighbouring slots meet exactly.
pub(crate) fn allocate<'a>(
&'a self,
requests: &'a [RequestedLen],
room: Px,
window: Px,
) -> impl Iterator<Item = Px> + 'a {
let mut at = Ratio::ZERO;
loop {
let total = requests.iter().fold(Segment::ZERO, |total, request| {
total + self.segment(*request, at, window)
});
if total.value(at) >= i128::from(room.raw()) * i128::from(at.den) {
break;
}
if total.weight != 0 {
let solution = Ratio::new(i64::from(room.raw()) - total.fixed, total.weight);
if total.end.is_none_or(|end| solution <= end) {
at = solution;
break;
}
}
match total.end {
Some(end) => at = end,
None => break,
}
}
let mut prefix = 0_i128;
let mut previous = 0_i128;
requests.iter().map(move |request| {
prefix += self.segment(*request, at, window).value(at);
let den = i128::from(at.den);
// Half away from zero, which is what `Fixed` rounds a division
// to: the two decide the same edge, and a change to one of them
// is a change to the other.
let edge = prefix.signum() * ((prefix.abs() + den / 2) / den);
let len = Px::from_raw((edge - previous) as i32);
previous = edge;
len
})
}
}
#[derive(Clone, Copy, Debug, Eq)]
struct Ratio {
num: i64,
den: i64,
}
impl PartialEq for Ratio {
fn eq(&self, other: &Self) -> bool {
self.cmp(other).is_eq()
}
}
impl Ratio {
const ZERO: Self = Self { num: 0, den: 1 };
fn new(num: i64, den: i64) -> Self {
debug_assert_ne!(den, 0, "a ratio of nothing");
if den < 0 {
Self {
num: -num,
den: -den,
}
} else {
Self { num, den }
}
}
}
impl Ord for Ratio {
fn cmp(&self, other: &Self) -> Ordering {
(i128::from(self.num) * i128::from(other.den))
.cmp(&(i128::from(other.num) * i128::from(self.den)))
}
}
impl PartialOrd for Ratio {
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
Some(self.cmp(other))
}
}
#[derive(Clone, Copy)]
struct Segment {
fixed: i64,
weight: i64,
end: Option<Ratio>,
}
impl Segment {
const ZERO: Self = Self {
fixed: 0,
weight: 0,
end: None,
};
fn value(self, at: Ratio) -> i128 {
i128::from(self.fixed) * i128::from(at.den) + i128::from(self.weight) * i128::from(at.num)
}
}
impl std::ops::Add for Segment {
type Output = Self;
fn add(self, other: Self) -> Self {
Self {
fixed: self.fixed + other.fixed,
weight: self.weight + other.weight,
end: first(self.end, other.end),
}
}
}
fn first(a: Option<Ratio>, b: Option<Ratio>) -> Option<Ratio> {
match (a, b) {
(Some(a), Some(b)) => Some(a.min(b)),
(a, b) => a.or(b),
}
}
/// Read-only discovery of requests through a widget's children. A request is
/// expressed in window lengths; `rel_base` supplies the base for declarations.
pub struct SizeRequests<'a> {
pub(crate) arena: &'a mut RequestArena,
pub(crate) measured: Option<&'a HashMap<WidgetId, ActiveData>>,
pub(crate) widgets: &'a Widgets,
pub(crate) dependencies: &'a mut Vec<WidgetId>,
pub(crate) rel_base: Len,
}
impl SizeRequests<'_> {
pub fn sum(&mut self, a: RequestedLen, b: RequestedLen) -> RequestedLen {
self.arena.combine(Op::Sum, a, b)
}
pub fn min(&mut self, a: RequestedLen, b: RequestedLen) -> RequestedLen {
self.arena.combine(Op::Min, a, b)
}
pub fn max(&mut self, a: RequestedLen, b: RequestedLen) -> RequestedLen {
self.arena.combine(Op::Max, a, b)
}
pub fn widget<W: ?Sized>(
&mut self,
child: &StrongWidget<W>,
axis: Axis,
) -> Option<RequestedLen> {
self.dependencies.push(child.id());
let rules = self.widgets.size_rules(child.id());
let rule = &rules[axis];
if let SizeRule::Request(request) = rule {
return Some(self.arena.import(request, self.rel_base));
}
if let Some(exact) = rule.exact() {
return Some(exact.within_len(self.rel_base).into());
}
let widget = self.widgets.get_dyn(child.id())?;
let request = widget.size_request(self, axis).or_else(|| {
self.measured?
.get(&child.id())?
.measured()
.map(|size| size[axis].into())
})?;
Some(self.bounded(request, rule.bound()))
}
pub(crate) fn bounded(&mut self, request: RequestedLen, bound: Bound) -> RequestedLen {
let bound = bound.within_len(self.rel_base);
let request = match bound.min {
Some(min) => self.max(request, min.into()),
None => request,
};
match bound.max {
Some(max) => self.min(request, max.into()),
None => request,
}
}
pub fn length(&self, len: LayoutLen) -> RequestedLen {
len.within_len(self.rel_base).into()
}
pub fn inset<W: ?Sized>(
&mut self,
child: &StrongWidget<W>,
axis: Axis,
padding: Px,
) -> Option<RequestedLen> {
let base = self.rel_base;
self.rel_base.px -= padding;
let request = self.widget(child, axis);
self.rel_base = base;
request.map(|request| self.sum(request, Len::from_parts(Rel::ZERO, padding).into()))
}
}
// Equal fractions keep this valid even when padding makes a rel base negative.
fn independent_order(a: LayoutLen, b: LayoutLen) -> Option<Ordering> {
if a.rel == b.rel && a.leftover == b.leftover {
Some(a.px.cmp(&b.px))
} else if a.px == b.px && a.rel == b.rel {
Some(a.leftover.cmp(&b.leftover))
} else {
None
}
}
+135 -4
View File
@@ -1,5 +1,6 @@
use crate::util::impl_axis_index;
use crate::{Axis, LayoutLen, Len};
use crate::{Axis, LayoutLen, Len, Rel, SizeRequest};
use std::sync::Arc;
/// What a widget's length on one axis is, as a rule its parent applies where
/// it draws it rather than an answer the widget gives about itself.
@@ -9,16 +10,75 @@ use crate::{Axis, LayoutLen, Len};
/// with no rule. That is what lets a span divide its space around a length
/// nobody has drawn yet, and it is why a rule lives beside the widget rather
/// than inside it -- the widget under the rule never has to know about it.
#[derive(Debug, Clone, Copy, PartialEq, Default)]
///
/// Exact expressions can bound a share before allocation. Bounds on an
/// intrinsic answer are applied after that answer becomes known.
#[derive(Debug, Clone, PartialEq, Default)]
pub enum SizeRule {
/// Whatever the widget reports from drawing.
#[default]
Free,
/// This length, whatever the widget reports.
Exact(LayoutLen),
/// An exact request whose comparisons await the parent's allocation.
Request(Arc<SizeRequest>),
/// At least this long, and otherwise whatever the box gives it.
Min(Len),
/// At most this long.
Max(Len),
/// Between the two.
Clamp { min: Len, max: Len },
}
impl SizeRule {
/// What this rule allows the length to be where it does not give one
/// outright.
pub fn bound(&self) -> Bound {
match *self {
Self::Free | Self::Exact(_) | Self::Request(_) => Bound::ANY,
Self::Min(min) => Bound {
min: Some(min),
max: None,
},
Self::Max(max) => Bound {
min: None,
max: Some(max),
},
Self::Clamp { min, max } => Bound {
min: Some(min),
max: Some(max),
},
}
}
/// Whether what this rule says is a fraction of the rel base, so that
/// the same rule against a different one is a different length.
pub fn has_fraction(&self) -> bool {
self.exact().is_some_and(|len| len.rel != Rel::ZERO) || self.bound().has_fraction()
}
/// This rule with a floor under it, which is the whole of it where there
/// was no rule.
pub fn at_least(&self, min: Len) -> Self {
match *self {
Self::Free | Self::Min(_) => Self::Min(min),
Self::Max(max) | Self::Clamp { max, .. } => Self::Clamp { min, max },
Self::Request(ref request) => request.as_ref().clone().max(min).into(),
Self::Exact(len) => len.max(min).into(),
}
}
/// This rule with a cap over it, which is the whole of it where there was
/// no rule.
pub fn at_most(&self, max: Len) -> Self {
match *self {
Self::Free | Self::Max(_) => Self::Max(max),
Self::Min(min) | Self::Clamp { min, .. } => Self::Clamp { min, max },
Self::Request(ref request) => request.as_ref().clone().min(max).into(),
Self::Exact(len) => len.min(max).into(),
}
}
/// The length this rule gives without the widget being drawn, if it can
/// give one.
pub fn declared(&self) -> Option<Len> {
@@ -32,18 +92,89 @@ impl SizeRule {
/// that give a box directly.
pub fn exact(&self) -> Option<LayoutLen> {
match self {
Self::Free => None,
Self::Exact(len) => Some(*len),
Self::Free | Self::Request(_) | Self::Min(_) | Self::Max(_) | Self::Clamp { .. } => {
None
}
}
}
}
/// What a rule allows a length to be where it does not give one outright: a
/// floor, a cap, or both. Each is a length of the rel base the widget is
/// asked with, which is the base a declared length is a fraction of too.
///
/// A bound is a [`Len`]. Comparisons involving shares are [`SizeRequest`]s.
#[derive(Debug, Clone, Copy, PartialEq, Default)]
pub struct Bound {
pub min: Option<Len>,
pub max: Option<Len>,
}
impl Bound {
/// Every length.
pub const ANY: Self = Self {
min: None,
max: None,
};
/// Whether either end is a fraction of the rel base, so that the same
/// bound against a different one binds at a different length.
pub fn has_fraction(&self) -> bool {
[self.min, self.max]
.into_iter()
.flatten()
.any(|len| len.rel != Rel::ZERO)
}
/// This bound as lengths of the window, from lengths of a rel base that
/// long.
pub fn within_len(&self, len: Len) -> Self {
Self {
min: self.min.map(|min| min.within_len(len)),
max: self.max.map(|max| max.within_len(len)),
}
}
}
/// One bound per axis, as [`SizeRules`] is one rule per axis.
#[derive(Debug, Clone, Copy, PartialEq, Default)]
pub struct Bounds {
pub x: Bound,
pub y: Bound,
}
impl Bounds {
pub const ANY: Self = Self {
x: Bound::ANY,
y: Bound::ANY,
};
pub fn from_axes(f: impl Fn(Axis) -> Bound) -> Self {
Self {
x: f(Axis::X),
y: f(Axis::Y),
}
}
}
impl_axis_index!(Bounds => Bound);
impl From<LayoutLen> for SizeRule {
fn from(len: LayoutLen) -> Self {
Self::Exact(len)
}
}
impl From<SizeRequest> for SizeRule {
fn from(request: SizeRequest) -> Self {
match request {
SizeRequest::Linear(len) => Self::Exact(len),
request => Self::Request(Arc::new(request)),
}
}
}
impl From<Option<LayoutLen>> for SizeRule {
fn from(len: Option<LayoutLen>) -> Self {
len.map_or(Self::Free, Self::Exact)
@@ -52,7 +183,7 @@ impl From<Option<LayoutLen>> for SizeRule {
/// One rule per axis, which is how a widget carries a length on one axis and
/// leaves the other to whatever it draws.
#[derive(Debug, Clone, Copy, PartialEq, Default)]
#[derive(Debug, Clone, PartialEq, Default)]
pub struct SizeRules {
pub x: SizeRule,
pub y: SizeRule,
+20 -4
View File
@@ -1,8 +1,8 @@
use std::sync::mpsc::{Receiver, Sender, channel};
use crate::{
Axis, AxisAlign, IdLike, RegionAlign, SizeRule, SizeRules, StrongWidget, WeakWidget, Widget,
WidgetData, WidgetId,
Axis, AxisAlign, IdLike, Len, RegionAlign, SizeRule, SizeRules, StrongWidget, WeakWidget,
Widget, WidgetData, WidgetId,
util::{DynBorrower, HashSet, SlotVec, forget_mut, to_mut},
};
@@ -128,8 +128,8 @@ impl Widgets {
}
/// The length rules whoever draws this widget applies to its box.
pub fn size_rules(&self, id: impl IdLike) -> SizeRules {
self.data(id).unwrap().size
pub fn size_rules(&self, id: impl IdLike) -> &SizeRules {
&self.data(id).unwrap().size
}
/// Sets one axis's rule. The widget is marked rather than its parent
@@ -145,6 +145,22 @@ impl Widgets {
self.needs_redraw.insert(id);
}
/// Puts a floor under this widget's length on one axis, keeping a cap it
/// already had. See [`SizeRule::at_least`].
pub fn set_min_len(&mut self, id: impl IdLike, axis: Axis, min: Len) {
let id = id.id();
let rule = self.size_rules(id)[axis].at_least(min);
self.set_size_rule(id, axis, rule);
}
/// Puts a cap over it, keeping a floor it already had. See
/// [`SizeRule::at_most`].
pub fn set_max_len(&mut self, id: impl IdLike, axis: Axis, max: Len) {
let id = id.id();
let rule = self.size_rules(id)[axis].at_most(max);
self.set_size_rule(id, axis, rule);
}
/// Where this widget sits in a box longer than the length it takes.
pub fn alignment(&self, id: impl IdLike) -> RegionAlign {
self.data(id).unwrap().align
+10 -3
View File
@@ -18,6 +18,7 @@ struct Input {
}
struct InputFn {
attrs: Vec<Attribute>,
sig: Signature,
body: Block,
}
@@ -32,9 +33,10 @@ impl Parse for Input {
input.parse::<Token![;]>()?;
let mut fns = Vec::new();
while !input.is_empty() {
let attrs = input.call(Attribute::parse_outer)?;
let sig = input.parse()?;
let body = input.parse()?;
fns.push(InputFn { sig, body })
fns.push(InputFn { attrs, sig, body })
}
if !input.is_empty() {
input.error("function expected");
@@ -59,10 +61,15 @@ pub fn widget_trait(input: TokenStream) -> TokenStream {
fns,
} = parse_macro_input!(input as Input);
let sigs: Vec<_> = fns.iter().map(|f| f.sig.clone()).collect();
// What a method says about itself belongs on the trait, where a reader
// looks it up; the implementation is the same text and says it again.
let sigs: Vec<_> = fns
.iter()
.map(|InputFn { attrs, sig, .. }| quote! { #(#attrs)* #sig })
.collect();
let impls: Vec<_> = fns
.iter()
.map(|InputFn { sig, body }| quote! { #sig #body })
.map(|InputFn { attrs, sig, body }| quote! { #(#attrs)* #sig #body })
.collect();
let Some(GenericParam::Type(state)) = generics.params.first() else {
+60 -11
View File
@@ -292,7 +292,7 @@ impl Plan {
align: None,
..self.clone()
}),
self.size.map(|_| Plan {
self.size.as_ref().map(|_| Plan {
size: None,
..self.clone()
}),
@@ -342,6 +342,21 @@ impl Plan {
at(self);
}
/// Drops every intrinsic bound from this tree, leaving the rest of it
/// -- and the generator's draws -- exactly as they were. That isolates
/// the ordinary path from the deferred one over the same shapes, which
/// is what says whether a difference is the bounds or the trees.
pub fn drop_bounds(&mut self) {
self.walk_mut(&mut |node| {
let Some(rules) = &mut node.size else { return };
for axis in Axis::BOTH {
if rules[axis].bound() != Bound::ANY {
rules[axis] = SizeRule::Free;
}
}
});
}
/// The same tree with `edits` applied, by the indices the generator would
/// have used for them.
///
@@ -373,7 +388,7 @@ impl Plan {
}
if plan.size.is_some() {
if let Some(lens) = edits.sizes.get(&sized) {
plan.size = Some(*lens);
plan.size = Some(lens.clone());
}
sized += 1;
}
@@ -644,11 +659,45 @@ impl Sow<'_> {
})
}
fn len(&mut self) -> Option<LayoutLen> {
match self.rng.below(4) {
0 => Some(LayoutLen::px(20.0 + self.rng.below(180) as f32)),
1 => Some(LayoutLen::LEFTOVER),
_ => None,
fn len(&mut self) -> LayoutLen {
LayoutLen::px(20.0 + self.rng.below(180) as f32)
}
/// A length of a box rather than a length of the window, which is what a
/// bound is.
///
/// Pixels only, for now. A fraction in a bound is resolved against the rel
/// base the widget was asked with, and `place_at` hands a parent a
/// retained answer without checking that the answer still holds for the
/// rel base this place gives -- so a fraction resolved against one rel
/// base survives into another. Seeds 4 (shuffle-all-but-first) and 196
/// (resize-size) at depth 5 are where that showed; both pass with pixels.
/// The hole is older than bounds -- an `Exact` rule that is a fraction
/// can reach it too -- and closing it is a check at the re-place site.
fn bound(&mut self) -> Len {
Len::px(20.0 + self.rng.below(180) as f32)
}
fn rule(&mut self) -> SizeRule {
match self.rng.below(8) {
0 | 1 => self.len().into(),
2 => LayoutLen::LEFTOVER.into(),
3 => SizeRule::Min(self.bound()),
4 => SizeRule::Max(self.bound()),
// Both in pixels, so one can be put under the other: a floor and
// a cap that change sides with the window bound nothing, which
// is a caller's bug rather than a tree to grow.
5 => {
let (a, b) = (
Px::from_f32(20.0 + self.rng.below(180) as f32),
Px::from_f32(20.0 + self.rng.below(180) as f32),
);
SizeRule::Clamp {
min: Len::px(a.min(b).to_f32()),
max: Len::px(a.max(b).to_f32()),
}
}
_ => SizeRule::Free,
}
}
@@ -674,15 +723,15 @@ impl Sow<'_> {
fn sized(&mut self, inner: &mut Plan) {
let take = self.rng.chance();
let lens = SizeRules {
x: self.len().into(),
y: self.len().into(),
x: self.rule(),
y: self.rule(),
};
if !take || inner.size.is_some() {
return;
}
let idx = self.sized;
self.sized += 1;
inner.size = Some(self.edits.sizes.get(&idx).copied().unwrap_or(lens));
inner.size = Some(self.edits.sizes.get(&idx).cloned().unwrap_or(lens));
}
/// An alignment over some of the tree, kept where a test can change it.
@@ -818,7 +867,7 @@ impl<Rsc: UiRsc + 'static> Build<'_, Rsc> {
fn node(&mut self, plan: &Plan) -> StrongWidget {
let built = self.kind(&plan.kind);
let id = built.id();
if let Some(lens) = plan.size {
if let Some(lens) = plan.size.clone() {
self.rsc.ui_mut().widgets.set_size_rules(id, lens.x, lens.y);
self.tree.sized.push(id);
}
+1 -1
View File
@@ -17,7 +17,7 @@ impl Widget for Image {
}
impl Image {
/// One texture already uploaded, for a caller holding its handle: [`image`]
/// One texture already uploaded, for a caller holding its handle: [`image()`]
/// uploads what it is given, and several widgets showing one picture want
/// one upload and one slot between them.
pub fn new(handle: TextureHandle) -> Self {
+4
View File
@@ -6,6 +6,10 @@ pub struct LayerOffset {
}
impl Widget for LayerOffset {
fn size_request(&self, requests: &mut SizeRequests, axis: Axis) -> Option<RequestedLen> {
requests.widget(&self.inner, axis)
}
fn draw(&mut self, painter: &mut Painter) -> Size {
for _ in 0..self.offset {
painter.next_layer();
+68
View File
@@ -0,0 +1,68 @@
use crate::prelude::*;
/// Asks its child in the shorter of a cap and the box this widget was given,
/// and answers what the child used, held to the same cap.
///
/// A cap on the box is a widget rather than a [`SizeRule`] because a box is
/// whoever asked's to decide: a rule that read the box it was given would be
/// decided again by every path that hands a widget one, including the ones
/// that re-place a drawing without asking it anything, and the decision would
/// then depend on which path arrived last. A widget is drawn again whenever
/// its own box changes, so the comparison is made where the answer can be
/// kept -- `longer_than` narrows the windows this drawing holds for, and
/// `holds` says the box lengths.
///
/// The box is what a text wraps at and what a scroll takes its viewport from,
/// which is why capping the answer alone is not the same thing.
pub struct MaxSize {
pub inner: StrongWidget,
pub x: Option<Len>,
pub y: Option<Len>,
}
impl MaxSize {
fn max(&self, axis: Axis) -> Option<Len> {
match axis {
Axis::X => self.x,
Axis::Y => self.y,
}
}
}
impl Widget for MaxSize {
fn size_request(&self, requests: &mut SizeRequests, axis: Axis) -> Option<RequestedLen> {
let inner = requests.widget(&self.inner, axis)?;
Some(match self.max(axis) {
Some(max) => requests.min(inner, max.into()),
None => inner,
})
}
fn draw(&mut self, painter: &mut Painter) -> Size {
let align = painter.alignment();
let mut region = UiRegion::FULL;
for axis in Axis::BOTH {
let Some(max) = self.max(axis) else {
continue;
};
let own = painter.region_len(axis);
if painter.longer_than(own, max, axis) {
region[axis] = max.align(align[axis]);
}
}
let mut size = painter.widget_at(&self.inner, region).size();
for axis in Axis::BOTH {
// The child may draw past the box it was given -- a text too tall
// for it -- and the cap is a promise about the length as well. A
// share passes through: it is a length only to whoever divides
// one, and that is this widget's parent rather than this widget,
// which has already given the share the box the cap allows.
if let Some(max) = self.max(axis)
&& painter.longer_than(size[axis].without_leftover(), max, axis)
{
size[axis] = max.into();
}
}
size
}
}
+2
View File
@@ -1,4 +1,5 @@
mod layer;
mod max_size;
mod offset;
mod pad;
mod scroll;
@@ -6,6 +7,7 @@ mod span;
mod stack;
pub use layer::*;
pub use max_size::*;
pub use offset::*;
pub use pad::*;
pub use scroll::*;
+4
View File
@@ -6,6 +6,10 @@ pub struct Offset {
}
impl Widget for Offset {
fn size_request(&self, requests: &mut SizeRequests, axis: Axis) -> Option<RequestedLen> {
requests.widget(&self.inner, axis)
}
fn draw(&mut self, painter: &mut Painter) -> Size {
painter
.widget_at(&self.inner, UiRegion::FULL.offset(self.amt))
+16 -2
View File
@@ -6,6 +6,10 @@ pub struct Pad {
}
impl Widget for Pad {
fn size_request(&self, requests: &mut SizeRequests, axis: Axis) -> Option<RequestedLen> {
requests.inset(&self.inner, axis, self.padding.along(axis))
}
fn draw(&mut self, painter: &mut Painter) -> Size {
// The inner's own alignment, not the near edge. This reports the
// inner's size plus the padding, so where the box is that answer the
@@ -22,11 +26,11 @@ impl Widget for Pad {
let inner = painter.widget_at(&self.inner, self.padding.region()).size();
Size {
x: LayoutLen {
px: inner.x.px + self.padding.left + self.padding.right,
px: inner.x.px + self.padding.along(Axis::X),
..inner.x
},
y: LayoutLen {
px: inner.y.px + self.padding.top + self.padding.bottom,
px: inner.y.px + self.padding.along(Axis::Y),
..inner.y
},
}
@@ -57,6 +61,16 @@ impl Padding {
bottom: amt,
}
}
/// Both sides of one axis together, which is what this padding takes
/// of a length along it.
pub fn along(&self, axis: Axis) -> Px {
match axis {
Axis::X => self.left + self.right,
Axis::Y => self.top + self.bottom,
}
}
/// `region` less this padding on each side.
pub fn region_of(&self, mut region: UiRegion) -> UiRegion {
region.x.start.px += self.left;
+123 -51
View File
@@ -8,57 +8,73 @@ pub struct Span {
}
impl Widget for Span {
fn size_request(&self, requests: &mut SizeRequests, axis: Axis) -> Option<RequestedLen> {
if axis != self.dir.axis {
// A share can be hidden when the other axis has no room. Its
// cross-axis length then contributes nothing to the drawn answer.
return None;
}
let mut total = RequestedLen::from(Len::from_parts(Rel::ZERO, self.gaps()));
for child in &self.children {
let child = requests.widget(child, axis)?;
total = requests.sum(total, child);
}
Some(total)
}
fn draw(&mut self, painter: &mut Painter) -> Size {
painter.with_requests(|painter, lens, values| self.layout(painter, lens, values))
}
}
impl Span {
fn layout(
&self,
painter: &mut Painter,
lens: &mut Vec<RequestedLen>,
values: &mut Vec<Px>,
) -> Size {
let axis = self.dir.axis;
// The row this span lays its children out along, as a length of the
// rel base they are laid out against. Where it starts is nothing's
// business -- a slot is a length from there -- so what this reads is
// the length alone.
let row = painter.region_len(axis);
// A length for every child before their final slots are chosen: from
// a hint where one says, and from drawing otherwise. The rel base passes
// through unchanged, so `rel(0.5)` is half the area this span was
// given whatever else is in it and wherever this child sits among
// them; what a drawn child is asked in is the room left from the
// cursor, because a text has to wrap at the width actually there.
let mut cursor = Len::ZERO;
let mut lens = Vec::with_capacity(self.children.len());
for child in &self.children {
let len = match painter.size_hint(child, axis) {
Some(len) => len,
None => {
// Across itself the child sits where its own alignment
// says, in the whole of the row: a span is what contains
// its children there, and nothing divides that axis.
let room = self.slot(row, cursor, row).shifted_desc().on_axis(axis);
painter.widget_at(child, room).len(axis)
self.collect(painter, row, lens, true);
let gaps = self.gaps();
let fixed = lens
.iter()
.try_fold(Len::from_parts(Rel::ZERO, gaps), |sum, len| {
Some(sum + len.linear()?.without_leftover())
});
if let Some(fixed) = fixed
&& lens.iter().any(|len| len.has_leftover())
&& !painter.longer_than(row, fixed, axis)
{
// With no share to assign, intrinsic drawings keep the remaining
// offer, including overflow. Their answer is only moved into a slot.
self.collect(painter, row, lens, false);
}
};
cursor += len.without_leftover();
cursor.px += self.gap;
lens.push(len);
let nonlinear = lens.iter().any(|len| len.linear().is_none());
if nonlinear {
painter.allocate(lens, row - Len::from_parts(Rel::ZERO, gaps), axis, values);
}
let gaps = self
.gap
.mul_int(self.children.len().saturating_sub(1) as i32);
let total = lens.iter().fold(
let allocated = nonlinear.then(|| &values[..]);
let total = match allocated {
Some(allocated) => LayoutLen {
px: allocated.iter().fold(gaps, |sum, len| sum + *len),
..LayoutLen::ZERO
},
None => lens.iter().fold(
LayoutLen {
px: gaps,
..LayoutLen::ZERO
},
|sum, len| sum + *len,
);
// What is left for the shares to divide: the row less everything
// fixed, as a length of the rel base rather than a number of pixels.
|sum, len| sum + len.linear().unwrap(),
),
};
let all_fixed = total.without_leftover();
let room = row - all_fixed;
// The three cases a rounded division needed -- the fixed parts
// growing slower than the box, faster, or exactly with it -- are the
// sign of `room.rel`, which the range `longer_than` keeps already
// reads. What the generated oracle checks is the consequence, since
// which children exist at all turns on this.
let any_leftover = total.leftover > Weight::ZERO;
let has_room = any_leftover && painter.longer_than(row, all_fixed, axis);
@@ -83,17 +99,34 @@ impl Widget for Span {
false => fixed,
true => fixed + room.scale(Rel::ratio(taken, total.leftover)),
};
for (child, &len) in self.children.iter().zip(&lens) {
// A child asking for nothing but a part of what is left over,
// when nothing is, is not drawn at all. One that also asked for
// pixels or a fraction keeps those and overflows.
if len.is_only_leftover() && !has_room {
for (index, (child, request)) in self.children.iter().zip(lens.iter()).enumerate() {
// An allocated row already has a length for every child; without
// one the request is the length and the room is divided here.
// Either way a child asking for nothing but a part of what is
// left over, when nothing is, is not drawn at all -- one that
// also asked for pixels or a fraction keeps those and overflows.
let (len, shares, nothing_left) = match allocated {
Some(allocated) => {
let len = LayoutLen {
px: allocated[index],
..LayoutLen::ZERO
};
let shares = request.has_leftover();
(len, shares, shares && len.px == Px::ZERO)
}
None => {
let len = request.linear().unwrap();
let shares = len.leftover > Weight::ZERO && has_room;
(len, shares, len.is_only_leftover() && !has_room)
}
};
if nothing_left {
painter.undraw(child);
fixed.px += self.gap;
continue;
}
let from = reached(fixed, taken);
if len.leftover > Weight::ZERO && has_room {
if shares {
taken += len.leftover;
}
fixed += len.without_leftover();
@@ -106,8 +139,8 @@ impl Widget for Span {
// fixed child's slot is its own answer, so a drawing made in the
// room is put there as it is, and one not made yet is made here.
let slot = self.slot(row, from, to);
let mut place = slot.shifted_desc().fills().on_axis(axis);
if len.leftover > Weight::ZERO && has_room {
let mut place = slot.shifted_desc().allocated().on_axis(axis);
if shares {
place = place.rel_base(axis, slot.len());
}
let used = painter.place_at(child, place).len(!axis);
@@ -125,13 +158,15 @@ impl Widget for Span {
fixed.px += self.gap;
}
// Carried whole rather than collapsed to one share: a span that sizes
// from its children does not resolve `leftover`, it passes the weight up,
// so nesting spans divides the same space rather than re-dividing a
// share of it. Four `leftover(1)` children under two spans under one span
// get a quarter each, which collapsing to `leftover(1)` per level does
// not give. Resolution happens at the nearest ancestor with a length,
// and the root always has one.
// Where nothing was allocated the weight is carried whole rather
// than collapsed to one share, so nesting spans divides the same
// space rather than re-dividing a share of it: four `leftover(1)`
// children under two spans under one span get a quarter each, which
// one share per level does not give. Resolution happens at the
// nearest ancestor with a length, and the root always has one --
// or, where a comparison deferred the row, at the ancestor whose
// allocation discovery carried these requests to, and `total` is
// pixels by the time it gets here.
let ortho = match shrinks {
true => ortho,
false => LayoutLen::rel(1.0),
@@ -141,6 +176,43 @@ impl Widget for Span {
}
impl Span {
/// What the gaps between this span's children take, which is a length of
/// the row before anything is divided.
fn gaps(&self) -> Px {
self.gap
.mul_int(self.children.len().saturating_sub(1) as i32)
}
fn collect(
&self,
painter: &mut Painter,
row: Len,
lens: &mut Vec<RequestedLen>,
discover: bool,
) {
let axis = self.dir.axis;
let mut cursor = Len::ZERO;
lens.clear();
for child in &self.children {
let request = if discover {
painter.size_request(child, axis)
} else {
painter.size_hint(child, axis).map(Into::into)
};
let len = match request {
Some(len) => len,
None => {
let room = self.slot(row, cursor, row).shifted_desc().on_axis(axis);
let len = painter.widget_at(child, room).len(axis);
painter.measured_request(child, axis, len)
}
};
cursor += painter.minimum_request(&len, axis);
cursor.px += self.gap;
lens.push(len);
}
}
/// The stretch of the row between two distances from where this span
/// starts laying children out, as a span of its own box. A negative
/// direction lays out from the far end, so the same two distances mirror
+13
View File
@@ -8,6 +8,19 @@ pub struct Stack {
}
impl Widget for Stack {
fn size_request(&self, requests: &mut SizeRequests, axis: Axis) -> Option<RequestedLen> {
let sizing = match self.size {
StackSize::Default => None,
StackSize::Child(i) => self.children.get(i),
};
// With nothing sizing it a stack is a share of the box it is given,
// which is what its draw answers too.
match sizing {
Some(child) => requests.widget(child, axis),
None => Some(LayoutLen::LEFTOVER.into()),
}
}
fn draw(&mut self, painter: &mut Painter) -> Size {
let sizing = match self.size {
StackSize::Default => None,
+48 -4
View File
@@ -59,26 +59,70 @@ widget_trait! {
}
}
fn width(self, len: impl Into<LayoutLen>) -> impl WidgetIdFn<Rsc, WL::Widget> {
fn width(self, len: impl Into<SizeRequest>) -> impl WidgetIdFn<Rsc, WL::Widget> {
let len = len.into();
move |state| {
let id = self.add(state);
state
.ui_mut()
.widgets
.set_size_rule(id, Axis::X, SizeRule::Exact(len));
.set_size_rule(id, Axis::X, SizeRule::from(len));
id
}
}
fn height(self, len: impl Into<LayoutLen>) -> impl WidgetIdFn<Rsc, WL::Widget> {
/// Answers at least this wide, whatever it drew: a rule beside the
/// widget, so what a row gives it is at least this even where the widget
/// itself wanted less. The box it draws in is untouched -- for that, see
/// [`MaxSize`].
fn min_width(self, len: impl Into<Len>) -> impl WidgetIdFn<Rsc, WL::Widget> {
let len = len.into();
move |state| {
let id = self.add(state);
state.ui_mut().widgets.set_min_len(id, Axis::X, len);
id
}
}
fn min_height(self, len: impl Into<Len>) -> impl WidgetIdFn<Rsc, WL::Widget> {
let len = len.into();
move |state| {
let id = self.add(state);
state.ui_mut().widgets.set_min_len(id, Axis::Y, len);
id
}
}
/// Puts this in a [`MaxSize`]: it is asked in the shorter of the cap and
/// the box that widget was given, and is as long as it used, held to the
/// cap. A widget rather than a rule because the box is whoever asked's to
/// decide -- see [`MaxSize`].
fn max_width(self, len: impl Into<Len>) -> impl WidgetFn<Rsc, MaxSize> {
let len = len.into();
move |state| MaxSize {
inner: self.add_strong(state),
x: Some(len),
y: None,
}
}
fn max_height(self, len: impl Into<Len>) -> impl WidgetFn<Rsc, MaxSize> {
let len = len.into();
move |state| MaxSize {
inner: self.add_strong(state),
x: None,
y: Some(len),
}
}
fn height(self, len: impl Into<SizeRequest>) -> impl WidgetIdFn<Rsc, WL::Widget> {
let len = len.into();
move |state| {
let id = self.add(state);
state
.ui_mut()
.widgets
.set_size_rule(id, Axis::Y, SizeRule::Exact(len));
.set_size_rule(id, Axis::Y, SizeRule::from(len));
id
}
}
+80
View File
@@ -0,0 +1,80 @@
use iris::{harness::Harness, prelude::*};
use std::{
alloc::{GlobalAlloc, Layout, System},
cell::Cell,
};
struct Counting;
thread_local! {
static COUNT: Cell<Option<usize>> = const { Cell::new(None) };
}
fn count() {
COUNT.with(|count| {
if let Some(n) = count.get() {
count.set(Some(n + 1));
}
});
}
// The wrapper preserves System's allocation and deallocation contracts;
// observing calls here also counts allocations hidden inside layout helpers.
unsafe impl GlobalAlloc for Counting {
unsafe fn alloc(&self, layout: Layout) -> *mut u8 {
count();
unsafe { System.alloc(layout) }
}
unsafe fn dealloc(&self, ptr: *mut u8, layout: Layout) {
unsafe { System.dealloc(ptr, layout) }
}
unsafe fn realloc(&self, ptr: *mut u8, layout: Layout, size: usize) -> *mut u8 {
count();
unsafe { System.realloc(ptr, layout, size) }
}
}
#[global_allocator]
static ALLOCATOR: Counting = Counting;
#[test]
fn unchanged_tree_reuses_layout_storage() {
for deferred in [false, true] {
let mut h = Harness::new((600, 200));
let mut children: Vec<StrongWidget> = Vec::new();
for _ in 0..8 {
let a = rect(Color::RED).add(&mut h.rsc);
if deferred {
h.rsc
.widgets_mut()
.set_size_rule(a, Axis::X, leftover(1).clamp(20, 80).into());
}
let row = (a, rect(Color::BLUE))
.span(Dir::RIGHT)
.add_strong(&mut h.rsc);
children.push(row);
}
let root = h.rsc.widgets_mut().add_strong(Span {
children,
dir: Dir::DOWN,
gap: Px::ZERO,
});
h.state.root = Some(root);
h.frame();
let ids: Vec<_> = h.render.active.keys().copied().collect();
for frame in 0..8 {
for &id in &ids {
h.rsc.widgets_mut().mark_for_redraw(id);
}
h.resize((600 + frame % 2, 200));
h.frame();
}
COUNT.set(Some(0));
for frame in 0..100 {
for &id in &ids {
h.rsc.widgets_mut().mark_for_redraw(id);
}
h.resize((600 + frame % 2, 200));
h.frame();
}
let allocations = COUNT.replace(None).unwrap();
println!("deferred={deferred}: {allocations} allocations over 100 resize frames");
assert_eq!(allocations, 0);
}
}
+391
View File
@@ -0,0 +1,391 @@
use std::{cell::Cell, rc::Rc};
use iris::harness::{Harness, assert_corners};
use iris::prelude::*;
struct Counted {
draws: Rc<Cell<usize>>,
}
impl Widget for Counted {
fn draw(&mut self, painter: &mut Painter) -> Size {
self.draws.set(self.draws.get() + 1);
painter.px_size();
painter.primitive(RectPrimitive::color(Color::RED));
Size::LEFTOVER
}
fn size_hint(&self, _: Axis) -> Option<LayoutLen> {
Some(LayoutLen::LEFTOVER)
}
}
#[test]
fn a_capped_share_returns_room_to_its_sibling() {
let mut h = Harness::new((300, 100));
let first = rect(Color::RED).max_width(80).add(&mut h.rsc);
let second = rect(Color::BLUE).add(&mut h.rsc);
h.set_root((first, second).span(Dir::RIGHT));
assert_corners!(h, first, (0, 0), (80, 100));
assert_corners!(h, second, (80, 0), (300, 100));
h.resize((100, 100));
h.frame();
assert_corners!(h, first, (0, 0), (50, 100));
assert_corners!(h, second, (50, 0), (100, 100));
h.resize((300, 100));
h.frame();
assert_corners!(h, first, (0, 0), (80, 100));
assert_corners!(h, second, (80, 0), (300, 100));
}
#[test]
fn nested_shares_are_discovered_without_provisional_paint() {
let mut h = Harness::new((400, 100));
let draws = Rc::new(Cell::new(0));
let leaf = h.rsc.ui_mut().widgets.add_strong(Counted {
draws: draws.clone(),
});
let leaf_id = leaf.id();
let mut inner: StrongWidget = leaf;
for _ in 0..8 {
let sibling = rect(Color::BLUE).add_strong(&mut h.rsc);
inner = h.rsc.ui_mut().widgets.add_strong(Span {
children: vec![inner, sibling],
dir: Dir::RIGHT,
gap: Px::ZERO,
});
}
h.state.root = Some(inner);
h.frame();
assert_eq!(draws.get(), 1);
assert!(h.region(&leaf_id).is_some());
h.resize((800, 100));
h.frame();
assert_eq!(draws.get(), 2);
}
#[test]
fn nested_bounds_are_resolved_in_the_outer_allocation() {
let mut h = Harness::new((300, 100));
let a = rect(Color::RED).max_width(40).add(&mut h.rsc);
let b = rect(Color::GREEN).max_width(60).add(&mut h.rsc);
let inner = (a, b).span(Dir::RIGHT).add(&mut h.rsc);
let tail = rect(Color::BLUE).add(&mut h.rsc);
h.set_root((inner, tail).span(Dir::RIGHT));
assert_corners!(h, a, (0, 0), (40, 100));
assert_corners!(h, b, (40, 0), (100, 100));
assert_corners!(h, tail, (100, 0), (300, 100));
}
#[test]
fn request_edits_in_a_nested_child_reach_the_allocator() {
let mut h = Harness::new((300, 100));
let a = rect(Color::RED).max_width(80).add(&mut h.rsc);
let inner = (a,).span(Dir::RIGHT).add(&mut h.rsc);
let tail = rect(Color::BLUE).add(&mut h.rsc);
h.set_root((inner, tail).span(Dir::RIGHT));
h.rsc.ui_mut().widgets.get_mut(&a).unwrap().x = Some(Len::px(40.0));
h.frame();
assert_corners!(h, a, (0, 0), (40, 100));
assert_corners!(h, tail, (40, 0), (300, 100));
}
#[test]
fn adding_a_bound_to_a_previously_unbounded_share_reallocates_the_row() {
for hinted in [true, false] {
let mut h = Harness::new((300, 100));
let a = if hinted {
rect(Color::RED).add_strong(&mut h.rsc).any()
} else {
h.rsc.widgets_mut().add_strong(Unhinted).any()
};
let id = a.id();
let b = rect(Color::BLUE).add(&mut h.rsc);
let mut row = Span::empty(Dir::RIGHT);
row.push(a);
row.push(b.add_strong(&mut h.rsc));
h.set_root(row);
h.resize((400, 100));
h.frame();
h.rsc
.widgets_mut()
.set_size_rule(id, Axis::X, SizeRule::Max(Len::px(80.0)));
h.frame();
assert_corners!(h, id, (0, 0), (80, 100));
assert_corners!(h, b, (80, 0), (400, 100));
}
}
#[test]
fn a_deferred_comparison_can_compare_two_different_weights() {
let a = SizeRequest::from(leftover(1.0) + px(30.0)).min(leftover(2.0));
let b = SizeRequest::from(leftover(1.0)).clamp(px(20.0), px(100.0));
let mut h = Harness::new((60, 100));
let a = rect(Color::RED).width(a).add(&mut h.rsc);
let b = rect(Color::BLUE).width(b).add(&mut h.rsc);
h.set_root((a, b).span(Dir::RIGHT));
assert_corners!(h, a, (0, 0), (40, 100));
assert_corners!(h, b, (40, 0), (60, 100));
h.resize((300, 100));
h.frame();
assert_corners!(h, a, (0, 0), (200, 100));
assert_corners!(h, b, (200, 0), (300, 100));
}
#[test]
fn a_length_expression_is_resolved_before_wrapping_text() {
let mut h = Harness::new((300, 500));
let text = wtext("one two three four five six seven eight nine ten")
.size(16)
.wrap(true)
.width(leftover(1).clamp(40, 80))
.add(&mut h.rsc);
let other = rect(Color::BLUE).add(&mut h.rsc);
h.set_root((text, other).span(Dir::RIGHT));
let box_ = h.region(&text).unwrap();
assert_eq!(box_.top_left.x, Px::ZERO);
assert_eq!(box_.bot_right.x, Px::from_int(80));
assert!(box_.bot_right.y - box_.top_left.y > Px::from_int(30));
assert_corners!(h, other, (80, 0), (300, 500));
}
#[test]
fn relative_bounds_keep_the_allocators_base() {
let mut h = Harness::new((300, 100));
let head = rect(Color::BLUE).width(30).add(&mut h.rsc);
let bounded = rect(Color::RED)
.width(leftover(1).min(rel(0.25)))
.add(&mut h.rsc);
let tail = rect(Color::GREEN).add(&mut h.rsc);
h.set_root((head, bounded, tail).span(Dir::RIGHT));
assert_corners!(h, bounded, (30, 0), (105, 100));
assert_corners!(h, tail, (105, 0), (300, 100));
h.resize((400, 100));
h.frame();
assert_corners!(h, bounded, (30, 0), (130, 100));
assert_corners!(h, tail, (130, 0), (400, 100));
}
#[test]
fn the_root_resolves_a_deferred_request_again_after_resize() {
let mut h = Harness::new((300, 100));
let bounded = rect(Color::RED)
.width(leftover(1).min(rel(0.25)))
.add(&mut h.rsc);
h.set_root(bounded);
assert_corners!(h, bounded, (112.5, 0), (187.5, 100));
h.resize((400, 100));
h.frame();
assert_corners!(h, bounded, (150, 0), (250, 100));
}
#[test]
fn filling_a_stack_does_not_mean_its_sizing_child_was_already_allocated() {
let mut h = Harness::new((300, 100));
let child = rect(Color::RED).width(leftover(1).min(80)).add(&mut h.rsc);
let overlay = rect(Color::BLUE).add(&mut h.rsc);
let children: Vec<StrongWidget> =
vec![child.add_strong(&mut h.rsc), overlay.add_strong(&mut h.rsc)];
h.set_root(Stack {
children,
size: StackSize::Child(0),
});
assert_corners!(h, child, (110, 0), (190, 100));
assert_corners!(h, overlay, (110, 0), (190, 100));
}
struct Unhinted;
impl Widget for Unhinted {
fn draw(&mut self, painter: &mut Painter) -> Size {
painter.px_size();
painter.primitive(RectPrimitive::color(Color::RED));
Size::LEFTOVER
}
}
#[test]
fn bounds_also_apply_to_shares_discovered_by_drawing() {
let mut h = Harness::new((300, 100));
let a = h.rsc.widgets_mut().add_strong(Unhinted);
h.rsc
.widgets_mut()
.set_size_rule(a.id(), Axis::X, SizeRule::Max(Len::px(80.0)));
let id = a.id();
let b = rect(Color::BLUE).add_strong(&mut h.rsc);
let b_id = b.id();
h.state.root = Some(h.rsc.widgets_mut().add_strong(Span {
children: vec![a, b],
dir: Dir::RIGHT,
gap: Px::ZERO,
}));
h.frame();
assert_corners!(h, id, (0, 0), (80, 100));
assert_corners!(h, b_id, (80, 0), (300, 100));
h.resize((100, 100));
h.frame();
assert_corners!(h, id, (0, 0), (50, 100));
assert_corners!(h, b_id, (50, 0), (100, 100));
}
#[test]
fn comparisons_with_a_known_order_remain_plain_lengths() {
assert_eq!(leftover(2).max(leftover(5)), SizeRequest::from(leftover(5)));
assert_eq!(leftover(2).min(leftover(5)), SizeRequest::from(leftover(2)));
assert_eq!(
(px(10) + rel(0.5)).max(px(30) + rel(0.5)),
SizeRequest::from(px(30) + rel(0.5))
);
assert_eq!(LayoutLen::px(10).clamp(20, 80), SizeRequest::from(20));
}
#[test]
fn a_measured_nested_share_keeps_its_comparison_for_the_outer_span() {
let mut h = Harness::new((300, 100));
let a = h.rsc.widgets_mut().add_strong(Unhinted);
let a_id = a.id();
h.rsc
.widgets_mut()
.set_size_rule(a_id, Axis::X, SizeRule::Max(Len::px(80.0)));
let b = rect(Color::BLUE).add_strong(&mut h.rsc);
let b_id = b.id();
let inner = h.rsc.widgets_mut().add_strong(Span {
children: vec![a, b],
dir: Dir::RIGHT,
gap: Px::ZERO,
});
let c = rect(Color::GREEN).add_strong(&mut h.rsc);
let c_id = c.id();
h.state.root = Some(h.rsc.widgets_mut().add_strong(Span {
children: vec![inner, c],
dir: Dir::RIGHT,
gap: Px::ZERO,
}));
h.frame();
assert_corners!(h, a_id, (0, 0), (80, 100));
assert_corners!(h, b_id, (80, 0), (190, 100));
assert_corners!(h, c_id, (190, 0), (300, 100));
h.rsc
.widgets_mut()
.mark_for_redraw(h.state.root.as_ref().unwrap().id());
h.frame();
assert_corners!(h, c_id, (190, 0), (300, 100));
}
struct Natural;
impl Widget for Natural {
fn draw(&mut self, painter: &mut Painter) -> Size {
painter.primitive(RectPrimitive::color(Color::RED));
Size::from_axis(Axis::X, LayoutLen::px(64), LayoutLen::px(64))
}
fn size_hint(&self, _: Axis) -> Option<LayoutLen> {
Some(LayoutLen::px(64))
}
}
#[test]
fn relative_bounds_on_a_hinted_child_track_the_offer_before_its_declared_size() {
fn tree(h: &mut Harness) -> WidgetId {
let natural = h.rsc.widgets_mut().add_strong(Natural);
let id = natural.id();
h.rsc
.widgets_mut()
.set_size_rule(id, Axis::X, SizeRule::Max(Len::rel(0.75)));
h.rsc.widgets_mut().set_size_rule(
id,
Axis::Y,
SizeRule::Clamp {
min: Len::rel(0.25),
max: Len::rel(0.75),
},
);
let inner = h.rsc.widgets_mut().add_strong(Stack {
children: vec![natural],
size: StackSize::Child(0),
});
let inner_id = inner.id();
let fill = rect(Color::BLUE).add_strong(&mut h.rsc);
let overlay = h.rsc.widgets_mut().add_strong(Stack {
children: vec![fill, inner],
size: StackSize::Child(0),
});
let share = rect(Color::GREEN).add_strong(&mut h.rsc);
let bounded = rect(Color::GREEN).add_strong(&mut h.rsc);
h.rsc.widgets_mut().set_size_rule(
bounded.id(),
Axis::X,
SizeRule::Clamp {
min: Len::rel(0.25),
max: Len::rel(0.75),
},
);
let fixed = wtext("one line, overflowing whatever it is given")
.size(16)
.wrap(false)
.add_strong(&mut h.rsc);
h.state.root = Some(h.rsc.widgets_mut().add_strong(Span {
children: vec![share, bounded, fixed, overlay],
dir: Dir::LEFT,
gap: Px::from_int(8),
}));
h.rsc.widgets_mut().set_size_rule(
h.state.root.as_ref().unwrap().id(),
Axis::Y,
LayoutLen::rel(1).into(),
);
h.frame();
inner_id
}
let mut warm = Harness::new((1920, 1200));
let a = tree(&mut warm);
warm.resize((640, 900));
warm.frame();
let mut cold = Harness::new((640, 900));
let b = tree(&mut cold);
assert_eq!(warm.region(&a), cold.region(&b));
}
#[test]
fn a_bound_can_extend_an_explicit_share_request() {
let mut h = Harness::new((300, 100));
let a = rect(Color::RED)
.width(leftover(1))
.min_width(100)
.add(&mut h.rsc);
let b = rect(Color::BLUE).add(&mut h.rsc);
h.set_root((a, b).span(Dir::RIGHT));
assert_corners!(h, a, (0, 0), (150, 100));
h.resize((120, 100));
h.frame();
assert_corners!(h, a, (0, 0), (100, 100));
assert_corners!(h, b, (100, 0), (120, 100));
}
#[test]
fn moving_scroll_content_preserves_its_resolved_expression_size() {
let mut h = Harness::new((300, 300));
let leaf = rect(Color::BLUE).add_strong(&mut h.rsc);
let leaf_id = leaf.id();
let content = h.rsc.widgets_mut().add_strong(Stack {
children: vec![leaf],
size: StackSize::Child(0),
});
let content_id = content.id();
h.rsc
.widgets_mut()
.set_size_rule(content_id, Axis::Y, leftover(1).min(120).into());
let scroll = h
.rsc
.widgets_mut()
.add_strong(Scroll::new(content, Axis::Y));
let scroll_id = scroll.id();
h.state.root = Some(scroll);
for _ in 0..3 {
h.rsc.widgets_mut().mark_for_redraw(scroll_id);
h.frame();
assert_corners!(h, content_id, (0, 90), (300, 210));
assert_corners!(h, leaf_id, (0, 90), (300, 210));
}
h.resize((300, 600));
h.frame();
assert_corners!(h, leaf_id, (0, 240), (300, 360));
}
+183 -26
View File
@@ -260,32 +260,52 @@ fn a_share_rule_beats_the_widgets_own_pixel_size() {
assert_eq!(asked.get(), 400.0, "the share is all of the box");
}
/// A share with pixels or a fraction beside it is the longer of the two: it
/// fills what they leave of the box and overflows the box where they are
/// longer than it. A parent that divides nothing gives the same length as a
/// span with one child, because in both there is nobody else to divide with.
#[test]
fn a_share_is_a_minimum_wherever_nothing_divides_it() {
let asked = |rule: LayoutLen, in_a_span: bool| {
/// Every box a widget is given comes of one ask, and the window is one of
/// them: the root is asked in it exactly as a child is asked in its parent's
/// box, so a rule of its own reads the same way at either place.
#[derive(Clone, Copy, Debug)]
enum Asked {
Root,
Wrapped,
InASpan,
}
impl Asked {
const ALL: [Self; 3] = [Self::Root, Self::Wrapped, Self::InASpan];
/// The width the probe is given under this parent, in a 400 px window.
fn width(&self, rule: LayoutLen) -> Px {
let mut h = Harness::new((400, 200));
let probe = rect(Color::RED).add(&mut h.rsc);
h.set_len(probe, Axis::X, rule);
match in_a_span {
true => h.set_root((probe,).span(Dir::RIGHT)),
false => h.set_root(probe.wrapper()),
match self {
Self::Root => h.set_root(probe),
Self::Wrapped => h.set_root(probe.wrapper()),
Self::InASpan => h.set_root((probe,).span(Dir::RIGHT)),
}
h.region(&probe).unwrap().size().x
};
}
}
/// A share with pixels or a fraction beside it is the longer of the two: it
/// fills what they leave of the box and overflows the box where they are
/// longer than it. A parent that divides nothing gives the same length as a
/// span with one child, because in both there is nobody else to divide with --
/// and so does the window, which divides nothing either.
#[test]
fn a_share_is_a_minimum_wherever_nothing_divides_it() {
for (rule, want) in [
(LayoutLen::LEFTOVER, 400),
(LayoutLen::px(50) + LayoutLen::LEFTOVER, 400),
(LayoutLen::px(500) + LayoutLen::LEFTOVER, 500),
(LayoutLen::px(50.0) + LayoutLen::LEFTOVER, 400),
(LayoutLen::px(500.0) + LayoutLen::LEFTOVER, 500),
(LayoutLen::rel(0.5) + LayoutLen::LEFTOVER, 400),
(LayoutLen::px(500), 500),
(LayoutLen::rel(2.0) + LayoutLen::LEFTOVER, 800),
(LayoutLen::px(500.0), 500),
] {
let want = Px::from_int(want);
assert_eq!(asked(rule, false), want, "{rule:?} where nothing divides");
assert_eq!(asked(rule, true), want, "{rule:?} in a span");
for asked in Asked::ALL {
assert_eq!(asked.width(rule), want, "{rule:?} asked {asked:?}");
}
}
}
@@ -297,27 +317,36 @@ fn a_share_is_a_minimum_wherever_nothing_divides_it() {
/// way, so it reaches the parent as a length only the parent can resolve.
#[test]
fn a_share_past_the_box_is_decided_again_on_either_side_of_the_crossing() {
// At the root as well as under a parent: the comparison is the same one,
// and nothing above the root will make it again on its behalf, so the
// range it holds for is the root's own.
for wrapped in [false, true] {
let mut h = Harness::new((400, 200));
let probe = rect(Color::RED).add(&mut h.rsc);
h.set_len(probe, Axis::X, LayoutLen::px(500) + LayoutLen::LEFTOVER);
h.set_root(probe.wrapper());
assert_eq!(h.region(&probe).unwrap().size().x, Px::from_int(500));
h.set_len(probe, Axis::X, LayoutLen::px(500.0) + LayoutLen::LEFTOVER);
match wrapped {
true => h.set_root(probe.wrapper()),
false => h.set_root(probe),
}
let width = |h: &Harness| h.region(&probe).unwrap().size().x;
assert_eq!(width(&h), Px::from_int(500), "wrapped: {wrapped}");
h.resize((900, 200));
h.frame();
assert_eq!(h.region(&probe).unwrap().size().x, Px::from_int(900));
assert_eq!(width(&h), Px::from_int(900), "wrapped: {wrapped}");
h.resize((400, 200));
h.frame();
assert_eq!(h.region(&probe).unwrap().size().x, Px::from_int(500));
assert_eq!(width(&h), Px::from_int(500), "wrapped: {wrapped}");
h.set_len(probe, Axis::X, LayoutLen::px(50) + LayoutLen::LEFTOVER);
h.set_len(probe, Axis::X, LayoutLen::px(50.0) + LayoutLen::LEFTOVER);
h.frame();
assert_eq!(h.region(&probe).unwrap().size().x, Px::from_int(400));
assert_eq!(width(&h), Px::from_int(400), "wrapped: {wrapped}");
h.set_len(probe, Axis::X, LayoutLen::px(500) + LayoutLen::LEFTOVER);
h.set_len(probe, Axis::X, LayoutLen::px(500.0) + LayoutLen::LEFTOVER);
h.frame();
assert_eq!(h.region(&probe).unwrap().size().x, Px::from_int(500));
assert_eq!(width(&h), Px::from_int(500), "wrapped: {wrapped}");
}
}
#[test]
@@ -727,7 +756,7 @@ fn only_a_pure_leftover_child_disappears_when_nothing_is_left() {
let mut h = Harness::new((100, 20));
let fixed = rect(Color::RED).width(100).add(&mut h.rsc);
let mixed = rect(Color::BLUE)
.width(LayoutLen::px(20) + LayoutLen::LEFTOVER)
.width(LayoutLen::px(20.0) + LayoutLen::LEFTOVER)
.add(&mut h.rsc);
h.set_root((fixed, mixed).span(Dir::RIGHT));
@@ -959,3 +988,131 @@ fn a_collapsed_share_keeps_the_gaps_before_the_next_slot() {
}
}
}
/// The root is asked the way any child is, so what it says about itself is
/// read there too: a root that opted into a region node gets one, where the
/// path it used to have ignored the flag.
#[test]
fn a_region_node_root_is_a_region_node() {
let mut h = Harness::new((400, 200));
let probe = rect(Color::RED).add(&mut h.rsc);
let root = (probe,).span(Dir::RIGHT).region_node().add(&mut h.rsc);
h.set_root(root);
assert_eq!(h.region(&probe).unwrap().size().x, Px::from_int(400));
h.resize((900, 200));
h.frame();
assert_eq!(h.region(&probe).unwrap().size().x, Px::from_int(900));
}
/// A bound is a rule about what a widget answers: it holds the length that
/// reaches whoever asked and leaves the box alone. Here the content is 400
/// wide in a 250 window, so a cap cuts what the row reports and a floor
/// raises it, while the rects inside stay where the 250 box put them.
#[test]
fn a_bound_holds_what_a_widget_answers() {
let row = |rule: SizeRule| {
let mut h = Harness::new((250, 200));
let left = rect(Color::RED).width(200).add(&mut h.rsc);
let right = rect(Color::BLUE).width(200).add(&mut h.rsc);
let row = (left, right).span(Dir::RIGHT).add(&mut h.rsc);
h.rsc.widgets_mut().set_size_rule(row, Axis::X, rule);
h.set_root(row);
(
h.region(&row).unwrap().size().x,
h.region(&left).unwrap().size().x,
)
};
let (capped, left) = row(SizeRule::Max(Len::px(300.0)));
assert_eq!(capped, Px::from_int(300), "the cap, not the 400 drawn");
assert_eq!(left, Px::from_int(200), "the box the children were given");
let (floored, _) = row(SizeRule::Min(Len::px(600.0)));
assert_eq!(floored, Px::from_int(600), "the floor, not the 400 drawn");
let (free, _) = row(SizeRule::Free);
assert_eq!(free, Px::from_int(400), "what it drew");
}
/// A cap on the box is `MaxSize`, which asks its child in the shorter of the
/// cap and its own box. That is the box a text wraps at and a scroll takes
/// its viewport from, so it cannot be had by holding the answer.
#[test]
fn a_cap_widget_asks_its_child_in_the_shorter_box() {
let mut h = Harness::new((400, 200));
// A fraction of its box, so it says what box it was asked in.
let fills = rect(Color::RED).width(rel(1.0)).add(&mut h.rsc);
let capped = fills.max_width(300).add(&mut h.rsc);
h.set_root(capped);
assert_eq!(h.region(&fills).unwrap().size().x, Px::from_int(300));
assert_eq!(
h.region(&capped).unwrap().size().x,
Px::from_int(300),
"as long as its child used"
);
// A child that asked for a share takes the box the cap allows, and the
// share itself passes up: whoever divides one is this widget's parent.
let mut h = Harness::new((400, 200));
let share = rect(Color::RED).add(&mut h.rsc);
let capped = share.max_width(300).add(&mut h.rsc);
h.set_root(capped);
assert_eq!(h.region(&share).unwrap().size().x, Px::from_int(300));
assert_eq!(h.region(&capped).unwrap().size().x, Px::from_int(400));
}
/// Which of the cap and the box is shorter is a question in pixels, so it is
/// asked again wherever the answer can change -- and the widget asking it is
/// drawn again whenever its own box is, which is what keeps the two in step.
#[test]
fn a_cap_widget_is_decided_again_on_either_side_of_the_crossing() {
let mut h = Harness::new((400, 200));
let probe = rect(Color::RED).add(&mut h.rsc);
h.set_root(probe.max_width(300));
let width = |h: &Harness| h.region(&probe).unwrap().size().x;
assert_eq!(width(&h), Px::from_int(300));
h.resize((250, 200));
h.frame();
assert_eq!(
width(&h),
Px::from_int(250),
"its box, which is under the cap"
);
h.resize((400, 200));
h.frame();
assert_eq!(width(&h), Px::from_int(300));
}
/// A fraction in a cap is a fraction of the box the widget capping it was
/// given, which is the box a declared length of its own would be a fraction
/// of -- not of the window, and not of what the cap itself decided.
#[test]
fn a_cap_is_a_fraction_of_the_box_it_was_given() {
let mut h = Harness::new((400, 200));
let probe = rect(Color::RED).add(&mut h.rsc);
h.set_root(probe.max_width(Len::rel(0.5)).pad(Padding::uniform(50)));
// Half of the 300 left by the padding, not half of the window.
assert_eq!(h.region(&probe).unwrap().size().x, Px::from_int(150));
}
/// A cap is a promise about the length as well as the box: a widget whose
/// content is longer than the box it was given reports what it drew, and the
/// cap holds that down even though it never decided the box.
#[test]
fn a_cap_holds_an_answer_that_overflowed_its_box() {
let mut h = Harness::new((250, 200));
let left = rect(Color::RED).width(200).add(&mut h.rsc);
let right = rect(Color::BLUE).width(200).add(&mut h.rsc);
let row = (left, right).span(Dir::RIGHT).add(&mut h.rsc);
h.rsc.widgets_mut().set_max_len(row, Axis::X, 300.into());
h.set_root(row);
// The box is the 250 window, which the cap of 300 leaves alone, and the
// row draws 400 of it. Its answer is the cap, and the window centres it.
assert_corners!(h, row, (-25, 0), (275, 200));
}
+23
View File
@@ -161,3 +161,26 @@ fn content_that_fits_is_placed_in_the_viewport_and_not_in_the_window() {
assert_corners!(h, scroll, (0, 100), (400, 400));
assert_corners!(h, inner, (0, 225), (400, 275));
}
/// A cap narrows the box the widget is asked in, which is what a scroll
/// measures its viewport from: the content scrolls within the cap rather than
/// within the room the cap was cut from.
#[test]
fn a_capped_scroll_takes_its_viewport_from_the_cap() {
let mut h = Harness::new((400, 200));
let top = rect(Color::RED).height(200).add(&mut h.rsc);
let bottom = rect(Color::BLUE).height(200).add(&mut h.rsc);
let scroll = (top, bottom).span(Dir::DOWN).scrollable().add(&mut h.rsc);
let capped = scroll.max_height(100).add(&mut h.rsc);
h.set_root(capped);
h.move_to((200, 50));
// 400 of content in a viewport of 100, so 300 to scroll and the end
// showing: the top is 300 above the box, which the window centres.
assert_eq!(h.region(&scroll).unwrap().size().y, Px::from_int(100));
assert_corners!(h, top, (0, -250), (400, -50));
h.scroll((0, 1));
h.frame();
assert_corners!(h, top, (0, -200), (400, 0));
}
+67
View File
@@ -0,0 +1,67 @@
#[path = "scenario/mod.rs"]
mod scenario;
use iris::prelude::*;
use iris::random::{Edits, Plan, plan};
fn check_requests(edit: impl Fn(&mut Plan) + Sync) {
let count = scenario::env("IRIS_DEFERRED_SEEDS", 20_u64);
let depth = scenario::env("IRIS_DEFERRED_DEPTH", 4_usize);
let seeds = std::env::var("IRIS_DEFERRED_SEED")
.ok()
.and_then(|seed| seed.parse().ok())
.map_or_else(|| (1..=count).collect(), |seed| vec![seed]);
scenario::over_seeds(seeds, |seed| {
let mut grown = plan(seed, depth, &Edits::default());
edit(&mut grown);
for case in scenario::ALL {
if let Some(how) = scenario::diverges(&grown, case, seed) {
panic!(
"request seed {seed} depth {depth} after {}: {how}",
case.name()
);
}
}
});
}
#[test]
fn deferred_requests_agree_warm_and_cold() {
check_requests(|grown| {
let mut index = 0;
grown.walk_mut(&mut |node| {
if let Some(rules) = &mut node.size {
for axis in Axis::BOTH {
index += 1;
rules[axis] = match index % 7 {
0 => leftover(1).clamp(20, 120).into(),
1 => leftover(1).min(rel(0.5)).into(),
2 => (leftover(1) + px(30)).min(leftover(2)).into(),
_ => rules[axis].clone(),
};
}
}
});
});
}
#[test]
fn relative_intrinsic_bounds_agree_warm_and_cold() {
check_requests(|grown| {
grown.walk_mut(&mut |node| {
if let Some(rules) = &mut node.size {
for axis in Axis::BOTH {
rules[axis] = match rules[axis] {
SizeRule::Min(_) => SizeRule::Min(Len::rel(0.25)),
SizeRule::Max(_) => SizeRule::Max(Len::rel(0.75)),
SizeRule::Clamp { .. } => SizeRule::Clamp {
min: Len::rel(0.25),
max: Len::rel(0.75),
},
ref rule => rule.clone(),
};
}
}
});
});
}
+29 -4
View File
@@ -13,11 +13,12 @@
//!
//! `IRIS_PHASE` is `cold`, `repaint`, `many`, `size`, `scroll`, `resize`, or
//! `all`. `IRIS_SEED`, `IRIS_DEPTH`, and `IRIS_FRAMES` select the load, and
//! `IRIS_DIRTY` how many widgets `many` marks at once.
//! `IRIS_DIRTY` how many widgets `many` marks at once. `IRIS_UNBOUNDED=1`
//! removes intrinsic bounds while preserving the rest of the generated tree.
use iris::harness::Harness;
use iris::prelude::*;
use iris::random::{Edits, Tree, grow};
use iris::random::{Edits, Tree, build, plan};
use std::time::Instant;
const OUTPUT: (f32, f32) = (1920.0, 1200.0);
@@ -125,9 +126,17 @@ fn rig_edits() -> Edits {
}
}
fn fixture(harness: &mut Harness, seed: u64, depth: usize) -> (StrongWidget, Tree) {
let mut plan = plan(seed, depth, &rig_edits());
if env("IRIS_UNBOUNDED", 0_u8) != 0 {
plan.drop_bounds();
}
build(&mut harness.rsc, &plan)
}
fn warm(seed: u64, depth: usize) -> (Harness, Tree) {
let mut harness = Harness::new(OUTPUT);
let (root, tree) = grow(&mut harness.rsc, seed, depth, &rig_edits());
let (root, tree) = fixture(&mut harness, seed, depth);
harness.state.root = Some(root);
harness.frame();
println!(
@@ -209,7 +218,7 @@ fn layout_cost() {
if selected("cold") {
let mut harness = Harness::new(OUTPUT);
let (root, tree) = grow(&mut harness.rsc, seed, depth, &rig_edits());
let (root, tree) = fixture(&mut harness, seed, depth);
harness.state.root = Some(root);
println!(
"fixture: seed {seed}, depth {depth}, {} widgets",
@@ -276,3 +285,19 @@ fn layout_cost() {
});
}
}
#[cfg(feature = "layout-diagnostics")]
#[test]
fn repainting_measured_text_does_not_invalidate_its_span() {
use iris::core::layout_diagnostics as diag;
let mut h = Harness::new((400, 200));
let text = wtext("a paragraph that fits").wrap(true).add(&mut h.rsc);
h.set_root((text, wtext("another paragraph")).span(Dir::DOWN));
let _ = diag::take();
h.rsc.widgets_mut().mark_for_redraw(text);
h.frame();
let report = diag::take();
assert_eq!(report.distinct_widgets(), 1);
assert_eq!(report.hot_widgets()[0].id, text.id());
}
+8 -3
View File
@@ -8,10 +8,11 @@
//!
//! then the same after, and `diff` the two. A line is one widget: the seed,
//! its index in creation order, and its box in window pixels, or `-` where
//! it is not drawn.
//! it is not drawn. `IRIS_UNBOUNDED=1` drops the trees' intrinsic bounds, as
//! in the diagnostics rig, which compares the two paths over the same shapes.
use iris::harness::Harness;
use iris::random::{Edits, grow};
use iris::random::{Edits, build, plan};
fn env<T: std::str::FromStr>(name: &str, fallback: T) -> T {
std::env::var(name)
@@ -28,7 +29,11 @@ fn every_cold_layout_is_printed() {
let mut out = String::new();
for seed in 1..=seeds {
let mut harness = Harness::new((1920.0, 1200.0));
let (root, tree) = grow(&mut harness.rsc, seed, depth, &Edits::default());
let mut plan = plan(seed, depth, &Edits::default());
if env("IRIS_UNBOUNDED", 0_u8) != 0 {
plan.drop_bounds();
}
let (root, tree) = build(&mut harness.rsc, &plan);
harness.state.root = Some(root);
harness.frame();
for (index, id) in tree.ids.iter().enumerate() {
+82 -12
View File
@@ -1,19 +1,22 @@
//! What a resize frame costs and what it holds, on a tree the revision before
//! #16 also builds.
//!
//! Deliberately written in the API subset `43ce8c7` and this branch share, so
//! the same source can be dropped into an old worktree and measured there:
//! that is the only like-for-like comparison with the code the retained
//! layout replaced. The random tree cannot carry one, because the generator
//! itself changed with the work.
//! Text-layout workloads with stable paragraphs for comparisons across revisions.
//! PR #19's base uses the older spelling of the fixed 40-pixel width and has
//! no diagnostics. The random generator changed with layout, so it cannot
//! provide the same workload across the full PR.
//!
//! ROWS=40 FRAMES=500 cargo test --release --test revision_cost \
//! -- --ignored --nocapture resize_cost
//! PHASE=edit ROWS=40 FRAMES=2000 cargo test --release --test revision_cost \
//! -- --ignored --nocapture text_updates_cost
//! ROWS=2000 cargo test --release --test revision_cost \
//! -- --ignored --nocapture text_memory
//!
//! Wall time on this machine varies with CPU frequency; take the number from
//! `perf stat -e instructions:u` on the test binary directly.
//! `text_updates_cost` selects idle, repaint, edit, or scroll with `PHASE`.
//! It alternates a short suffix for edits so later frames do not get a longer
//! paragraph than earlier ones. These are CPU fixtures, with no GPU submission.
//!
//! Use repeated `perf stat -e instructions:u` runs on the executable directly;
//! process totals include font loading and the cold frame, so compare identical
//! row and frame counts. Wall time on this machine is not a stable comparison.
use iris::harness::Harness;
use iris::prelude::*;
@@ -137,9 +140,10 @@ fn resize_cost() {
println!("paragraph {at}: {:?}", h.region(id));
}
// Two widths in turn is the friendly case for anything that remembers an
// answer, so `SWEEP=1` never repeats one -- a drag rather than a toggle.
// The sweep cycles 256 widths, avoiding the two-width cache-friendly case.
let sweep = env("SWEEP", 0_usize) != 0;
#[cfg(feature = "layout-diagnostics")]
let _ = iris::core::layout_diagnostics::take();
let mut elapsed = Vec::with_capacity(frames);
for frame in 0..frames {
let narrower = match sweep {
@@ -151,6 +155,11 @@ fn resize_cost() {
h.frame();
elapsed.push(start.elapsed().as_secs_f64() * 1000.0);
}
#[cfg(feature = "layout-diagnostics")]
print!(
"{}",
iris::core::layout_diagnostics::take().per_frame(frames)
);
elapsed.sort_by(|a, b| a.partial_cmp(b).unwrap());
println!(
"resize: {frames} frames, min {:.3} ms, median {:.3} ms, p99 {:.3} ms, \
@@ -203,3 +212,64 @@ fn text_memory() {
}
report("after settling");
}
#[test]
#[ignore = "measurement, not a check"]
fn text_updates_cost() {
let rows = env("ROWS", 40_usize);
let frames = env("FRAMES", 1000_usize);
let phase = env("PHASE", String::from("edit"));
assert!(rows > 0 && frames > 0);
assert!(["idle", "repaint", "edit", "scroll"].contains(&phase.as_str()));
let mut h = Harness::new(OUTPUT);
let mut rng = Rng(1);
let mut col = Span::empty(Dir::DOWN);
let first = wtext(words(&mut rng, 12, 52))
.size(16)
.wrap(true)
.add(&mut h.rsc);
col.push(first.add_strong(&mut h.rsc));
for _ in 1..rows {
col.push(
wtext(words(&mut rng, 12, 52))
.size(16)
.wrap(true)
.add_strong(&mut h.rsc),
);
}
let root = col.scrollable().add(&mut h.rsc);
h.set_root(root);
#[cfg(feature = "layout-diagnostics")]
let _ = iris::core::layout_diagnostics::take();
let original = h.rsc[first].content.to_string();
let alternate = format!("{original} another word");
let start = Instant::now();
for frame in 0..frames {
match phase.as_str() {
"idle" => {}
"repaint" => {
let _ = h.rsc.widgets_mut().get_dyn_mut(first.id());
}
"edit" => {
h.rsc[first].content.clear();
h.rsc[first].content.push_str(if frame % 2 == 0 {
&alternate
} else {
&original
});
}
"scroll" => h.rsc[root].scroll(if frame % 2 == 0 { -12.0 } else { 12.0 }),
_ => unreachable!(),
}
h.frame();
}
println!(
"{phase}: {rows} rows, {frames} frames, {:.1} ms",
start.elapsed().as_secs_f64() * 1000.0
);
#[cfg(feature = "layout-diagnostics")]
print!(
"{}",
iris::core::layout_diagnostics::take().per_frame(frames)
);
}
+26 -10
View File
@@ -194,18 +194,26 @@ fn mark(warm: &mut Harness, tree: &Tree, step: usize) {
}
}
fn a_len(rng: &mut Rng) -> Option<LayoutLen> {
Some(LayoutLen::px(20.0 + rng.below(180) as f32))
/// A length in pixels, or a cap over one: a rule that reads the box it is
/// given is the one a resize can change the effect of without changing the
/// rule, so a tree that never grows one leaves that unexercised.
fn a_rule(rng: &mut Rng) -> SizeRule {
let len = Len::px(20.0 + rng.below(180) as f32);
match rng.below(4) {
0 => SizeRule::Max(len),
1 => SizeRule::Min(len),
_ => LayoutLen::from(len).into(),
}
}
fn resize_one(warm: &mut Harness, tree: &Tree, idx: usize, rng: &mut Rng) -> SizeRules {
let lens = SizeRules {
x: a_len(rng).into(),
y: a_len(rng).into(),
x: a_rule(rng),
y: a_rule(rng),
};
warm.rsc
.widgets_mut()
.set_size_rules(tree.sized[idx], lens.x, lens.y);
.set_size_rules(tree.sized[idx], lens.x.clone(), lens.y.clone());
lens
}
@@ -348,10 +356,18 @@ fn change(case: Case, warm: &mut Harness, tree: &mut Tree, plan: &Plan, rng: &mu
/// out by hand. A failure is a lead; the fast test that replaces it has to be
/// buildable from what the failure printed.
fn describe(id: WidgetId, h: &Harness) -> String {
let rules = h.rsc.widgets().size_rules(id);
let rule = |r: SizeRule| match r.exact() {
Some(len) => format!("{len}"),
None => "-".into(),
let rules = h.rsc.widgets().size_rules(id).clone();
// A bound prints as itself: a failure is reproduced from what it printed,
// and a rule shown as "no rule" cannot be written out again.
let rule = |r: SizeRule| match r {
SizeRule::Free => "-".into(),
SizeRule::Exact(len) => format!("{len}"),
SizeRule::Request(request) => format!("{request:?}"),
SizeRule::Min(min) => format!(">{}", LayoutLen::from(min)),
SizeRule::Max(max) => format!("<{}", LayoutLen::from(max)),
SizeRule::Clamp { min, max } => {
format!(">{}<{}", LayoutLen::from(min), LayoutLen::from(max))
}
};
let align = h.rsc.widgets().alignment(id);
let side = |a: AxisAlign| {
@@ -368,7 +384,7 @@ fn describe(id: WidgetId, h: &Harness) -> String {
// A rule and an alignment are properties of whatever carries them, so
// they print with that widget rather than as widgets of their own.
let mut out = describe_widget(id, h);
if (rules.x, rules.y) != (SizeRule::Free, SizeRule::Free) {
if rules != SizeRules::default() {
out += &format!("[x:{},y:{}]", rule(rules.x), rule(rules.y));
}
if align != RegionAlign::default() {
+3
View File
@@ -32,3 +32,6 @@ mod tasks;
mod text_edit;
#[path = "cases/unsettled.rs"]
mod unsettled;
#[path = "cases/deferred.rs"]
mod deferred;