fret-ui 0.1.0

Mechanism-layer UI engine for Fret with tree, layout, focus, routing, and interaction contracts.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
use super::*;

fn clear_all_invalidations(ui: &mut UiTree<crate::test_host::TestHost>) {
    for node in ui.nodes.values_mut() {
        node.invalidation = InvalidationFlags::default();
    }
    ui.layout_invalidations_count = 0;
    ui.invalidated_layout_nodes = 0;
    ui.invalidated_paint_nodes = 0;
    ui.invalidated_hit_test_nodes = 0;
}

fn render_resize_sensitive_root(
    ui: &mut UiTree<crate::test_host::TestHost>,
    app: &mut crate::test_host::TestHost,
    services: &mut FakeUiServices,
    window: AppWindowId,
    bounds: Rect,
    roomy: bool,
) -> NodeId {
    declarative::render_root(
        ui,
        app,
        services,
        window,
        bounds,
        "interactive-resize-flow-rebuild",
        |cx| {
            let mut page = crate::element::FlexProps::default();
            page.layout.size.width = crate::element::Length::Fill;
            page.layout.size.height = crate::element::Length::Fill;
            page.direction = fret_core::Axis::Vertical;
            page.align = crate::element::CrossAlign::Center;
            page.justify = if roomy {
                crate::element::MainAlign::Center
            } else {
                crate::element::MainAlign::Start
            };

            let mut card = crate::element::ContainerProps::default();
            card.layout.size.width = crate::element::Length::Fill;
            card.layout.size.max_width = Some(crate::element::Length::Px(Px(120.0)));
            if !roomy {
                card.layout.size.min_height = Some(crate::element::Length::Px(Px(120.0)));
                card.layout.size.max_height = Some(crate::element::Length::Px(Px(120.0)));
            }

            let mut body = crate::element::FlexProps::default();
            body.layout.size.width = crate::element::Length::Fill;
            body.direction = fret_core::Axis::Vertical;

            vec![cx.flex(page, |cx| {
                vec![cx.container(card, |cx| {
                    vec![cx.flex(body, |cx| vec![cx.text("header"), cx.text("footer")])]
                })]
            })]
        },
    )
}

fn assert_authoritative_compact_flow(
    ui: &mut UiTree<crate::test_host::TestHost>,
    app: &mut crate::test_host::TestHost,
    window: AppWindowId,
    root: NodeId,
    context: &str,
) {
    let page_node = ui.children(root)[0];
    let card_node = ui.children(page_node)[0];
    let page_instance = crate::declarative::frame::element_record_for_node(app, window, page_node)
        .map(|r| r.instance)
        .expect("page instance for compact flow");
    match page_instance {
        crate::declarative::frame::ElementInstance::Flex(props) => {
            assert_eq!(
                props.justify,
                crate::element::MainAlign::Start,
                "{context}: compact flow should author justify-start"
            );
        }
        other => panic!("{context}: expected page node to remain a Flex, got {other:?}"),
    }

    let card_bounds = ui
        .debug_node_bounds(card_node)
        .expect("card bounds for compact flow");
    let engine = ui.take_layout_engine();
    let page_style = engine
        .debug_style_for_node(page_node)
        .cloned()
        .expect("page style for compact flow");
    let card_style = engine
        .debug_style_for_node(card_node)
        .cloned()
        .expect("card style for compact flow");
    ui.put_layout_engine(engine);

    assert_eq!(
        page_style.justify_content,
        Some(taffy::style::JustifyContent::FlexStart),
        "{context}: layout engine should rebuild the compact page style in the same resize frame"
    );
    assert_eq!(
        card_style.min_size.height,
        taffy::style::Dimension::length(120.0),
        "{context}: compact flow should forward min-height constraints immediately"
    );
    assert!(
        card_bounds.origin.y.0 <= 0.5,
        "{context}: compact flow should pin the card to the top immediately; card_bounds={card_bounds:?}"
    );
}

struct DynamicViewportRoot {
    child: NodeId,
    viewport: std::sync::Arc<std::sync::Mutex<Rect>>,
}

impl<H: UiHost> Widget<H> for DynamicViewportRoot {
    fn layout(&mut self, cx: &mut LayoutCx<'_, H>) -> Size {
        let viewport = *self.viewport.lock().expect("viewport lock");
        let _ = cx.layout_viewport_root(self.child, viewport);
        cx.available
    }
}

#[test]
fn interactive_resize_cached_flow_rebuilds_authoritatively_when_descendants_turn_layout_dirty() {
    let mut app = crate::test_host::TestHost::new();
    let window = AppWindowId::default();
    let mut ui: UiTree<crate::test_host::TestHost> = UiTree::new();
    ui.set_window(window);

    let roomy_bounds = Rect::new(
        Point::new(Px(0.0), Px(0.0)),
        Size::new(Px(680.0), Px(760.0)),
    );
    let compact_bounds = Rect::new(
        Point::new(Px(0.0), Px(0.0)),
        Size::new(Px(420.0), Px(560.0)),
    );
    let mut services = FakeUiServices;

    let roomy_root =
        render_resize_sensitive_root(&mut ui, &mut app, &mut services, window, roomy_bounds, true);
    ui.set_root(roomy_root);
    ui.layout_all(&mut app, &mut services, roomy_bounds, 1.0);

    let page_node = ui.children(roomy_root)[0];
    let engine = ui.take_layout_engine();
    let page_style = engine
        .debug_style_for_node(page_node)
        .cloned()
        .expect("page style after roomy layout");
    ui.put_layout_engine(engine);
    assert_eq!(
        page_style.justify_content,
        Some(taffy::style::JustifyContent::Center)
    );

    app.advance_frame();

    let compact_root = render_resize_sensitive_root(
        &mut ui,
        &mut app,
        &mut services,
        window,
        compact_bounds,
        false,
    );
    assert_eq!(compact_root, roomy_root, "expected stable root identity");
    ui.set_root(roomy_root);
    clear_all_invalidations(&mut ui);
    ui.layout_all(&mut app, &mut services, compact_bounds, 1.0);

    assert!(
        !ui.interactive_resize_needs_full_rebuild,
        "layout-dirty descendant changes should not defer the flow rebuild until resize settles"
    );
    assert_authoritative_compact_flow(
        &mut ui,
        &mut app,
        window,
        roomy_root,
        "cached-flow resize frame",
    );

    app.advance_frame();
    ui.layout_all(&mut app, &mut services, compact_bounds, 1.0);
    assert!(
        ui.interactive_resize_active(),
        "first stable frame should still count as interactive resize"
    );
    assert_authoritative_compact_flow(
        &mut ui,
        &mut app,
        window,
        roomy_root,
        "first stable frame after cached-flow resize",
    );

    app.advance_frame();
    ui.layout_all(&mut app, &mut services, compact_bounds, 1.0);
    assert!(
        !ui.interactive_resize_active(),
        "second stable frame should settle interactive resize state"
    );
    assert!(
        !ui.interactive_resize_needs_full_rebuild,
        "authoritative same-frame rebuild should not leave a deferred rebuild armed"
    );
    assert_authoritative_compact_flow(
        &mut ui,
        &mut app,
        window,
        roomy_root,
        "settled frame after cached-flow resize",
    );
}

#[test]
fn interactive_resize_viewport_root_rebuilds_authoritatively_when_descendants_turn_layout_dirty() {
    use std::sync::{Arc, Mutex};

    let mut app = crate::test_host::TestHost::new();
    let window = AppWindowId::default();
    let mut ui: UiTree<crate::test_host::TestHost> = UiTree::new();
    ui.set_window(window);

    let roomy_bounds = Rect::new(
        Point::new(Px(0.0), Px(0.0)),
        Size::new(Px(680.0), Px(760.0)),
    );
    let compact_bounds = Rect::new(
        Point::new(Px(0.0), Px(0.0)),
        Size::new(Px(420.0), Px(560.0)),
    );
    let viewport = Arc::new(Mutex::new(roomy_bounds));
    let mut services = FakeUiServices;

    let viewport_root =
        render_resize_sensitive_root(&mut ui, &mut app, &mut services, window, roomy_bounds, true);
    let root = ui.create_node(DynamicViewportRoot {
        child: viewport_root,
        viewport: viewport.clone(),
    });
    ui.set_children(root, vec![viewport_root]);
    ui.set_root(root);
    ui.layout_all(&mut app, &mut services, roomy_bounds, 1.0);

    let page_node = ui.children(viewport_root)[0];
    let engine = ui.take_layout_engine();
    let page_style = engine
        .debug_style_for_node(page_node)
        .cloned()
        .expect("page style after roomy viewport layout");
    ui.put_layout_engine(engine);
    assert_eq!(
        page_style.justify_content,
        Some(taffy::style::JustifyContent::Center)
    );

    app.advance_frame();
    *viewport.lock().expect("viewport lock") = compact_bounds;
    let compact_root = render_resize_sensitive_root(
        &mut ui,
        &mut app,
        &mut services,
        window,
        compact_bounds,
        false,
    );
    assert_eq!(
        compact_root, viewport_root,
        "expected stable viewport root identity"
    );
    clear_all_invalidations(&mut ui);
    ui.layout_all(&mut app, &mut services, compact_bounds, 1.0);

    assert!(
        !ui.interactive_resize_needs_full_rebuild,
        "viewport-root resize should not defer rebuild when descendant authoring changed"
    );
    assert_authoritative_compact_flow(
        &mut ui,
        &mut app,
        window,
        viewport_root,
        "viewport-root resize frame",
    );

    app.advance_frame();
    ui.layout_all(&mut app, &mut services, compact_bounds, 1.0);
    assert!(
        ui.interactive_resize_active(),
        "first stable viewport frame should still count as interactive resize"
    );
    assert_authoritative_compact_flow(
        &mut ui,
        &mut app,
        window,
        viewport_root,
        "first stable viewport frame",
    );

    app.advance_frame();
    ui.layout_all(&mut app, &mut services, compact_bounds, 1.0);
    assert!(
        !ui.interactive_resize_active(),
        "second stable viewport frame should settle interactive resize state"
    );
    assert!(
        !ui.interactive_resize_needs_full_rebuild,
        "viewport-root resize should not leave a deferred rebuild armed"
    );
    assert_authoritative_compact_flow(
        &mut ui,
        &mut app,
        window,
        viewport_root,
        "settled viewport frame",
    );
}

#[test]
fn interactive_resize_layout_in_keeps_authoritative_flow_without_deferred_rebuild() {
    let mut app = crate::test_host::TestHost::new();
    let window = AppWindowId::default();
    let mut ui: UiTree<crate::test_host::TestHost> = UiTree::new();
    ui.set_window(window);

    let roomy_bounds = Rect::new(
        Point::new(Px(0.0), Px(0.0)),
        Size::new(Px(680.0), Px(760.0)),
    );
    let compact_bounds = Rect::new(
        Point::new(Px(0.0), Px(0.0)),
        Size::new(Px(420.0), Px(560.0)),
    );
    let mut services = FakeUiServices;

    let roomy_root =
        render_resize_sensitive_root(&mut ui, &mut app, &mut services, window, roomy_bounds, true);
    ui.set_root(roomy_root);
    ui.layout_all(&mut app, &mut services, roomy_bounds, 1.0);

    app.advance_frame();
    let compact_root = render_resize_sensitive_root(
        &mut ui,
        &mut app,
        &mut services,
        window,
        compact_bounds,
        false,
    );
    assert_eq!(compact_root, roomy_root, "expected stable root identity");
    ui.set_root(roomy_root);
    clear_all_invalidations(&mut ui);
    ui.layout_all(&mut app, &mut services, compact_bounds, 1.0);
    assert!(
        !ui.interactive_resize_needs_full_rebuild,
        "layout_in path should start from an authoritative compact flow without a deferred rebuild"
    );
    assert_authoritative_compact_flow(
        &mut ui,
        &mut app,
        window,
        roomy_root,
        "layout_in compact resize frame",
    );

    app.advance_frame();
    let steady_size = ui.layout_in(&mut app, &mut services, roomy_root, compact_bounds, 1.0);
    assert_eq!(
        steady_size, compact_bounds.size,
        "first stable layout_in should preserve the compact root size while resize is still active"
    );
    assert!(
        ui.interactive_resize_active(),
        "first stable layout_in should still count as interactive resize"
    );

    app.advance_frame();
    let rebuilt_size = ui.layout_in(&mut app, &mut services, roomy_root, compact_bounds, 1.0);
    assert_eq!(
        rebuilt_size, compact_bounds.size,
        "layout_in should still return the compact root size after resize settles"
    );
    assert!(
        !ui.interactive_resize_needs_full_rebuild,
        "layout_in should keep the deferred rebuild flag clear"
    );
    assert!(
        !ui.interactive_resize_active(),
        "second stable layout_in should settle interactive resize state"
    );
    assert_authoritative_compact_flow(
        &mut ui,
        &mut app,
        window,
        roomy_root,
        "settled layout_in frame",
    );
}

#[test]
fn interactive_resize_layout_advances_resize_state_without_deferred_rebuild() {
    let mut app = crate::test_host::TestHost::new();
    let window = AppWindowId::default();
    let mut ui: UiTree<crate::test_host::TestHost> = UiTree::new();
    ui.set_window(window);

    let roomy_bounds = Rect::new(
        Point::new(Px(0.0), Px(0.0)),
        Size::new(Px(680.0), Px(760.0)),
    );
    let compact_bounds = Rect::new(
        Point::new(Px(0.0), Px(0.0)),
        Size::new(Px(420.0), Px(560.0)),
    );
    let mut services = FakeUiServices;

    let roomy_root =
        render_resize_sensitive_root(&mut ui, &mut app, &mut services, window, roomy_bounds, true);
    ui.set_root(roomy_root);
    ui.layout_all(&mut app, &mut services, roomy_bounds, 1.0);

    app.advance_frame();
    let compact_root = render_resize_sensitive_root(
        &mut ui,
        &mut app,
        &mut services,
        window,
        compact_bounds,
        false,
    );
    assert_eq!(compact_root, roomy_root, "expected stable root identity");
    ui.set_root(roomy_root);
    clear_all_invalidations(&mut ui);
    ui.layout_all(&mut app, &mut services, compact_bounds, 1.0);
    assert!(
        !ui.interactive_resize_needs_full_rebuild,
        "layout path should start from an authoritative compact flow without a deferred rebuild"
    );
    assert_authoritative_compact_flow(
        &mut ui,
        &mut app,
        window,
        roomy_root,
        "layout compact resize frame",
    );

    app.advance_frame();
    let steady_size = ui.layout(
        &mut app,
        &mut services,
        roomy_root,
        compact_bounds.size,
        1.0,
    );
    assert_eq!(
        steady_size, compact_bounds.size,
        "first stable layout should preserve the compact root size while resize is still active"
    );
    assert!(
        ui.interactive_resize_active(),
        "first stable layout should still count as interactive resize"
    );

    app.advance_frame();
    let rebuilt_size = ui.layout(
        &mut app,
        &mut services,
        roomy_root,
        compact_bounds.size,
        1.0,
    );
    assert_eq!(
        rebuilt_size, compact_bounds.size,
        "settled layout should still return the compact root size after the forced rebuild"
    );
    assert!(
        !ui.interactive_resize_active(),
        "second stable layout should settle interactive resize state"
    );
    assert!(
        !ui.interactive_resize_needs_full_rebuild,
        "layout path should keep the deferred rebuild flag clear"
    );
    assert_authoritative_compact_flow(
        &mut ui,
        &mut app,
        window,
        roomy_root,
        "settled layout frame",
    );
}