ui_layout 0.9.8

A minimal Flexbox-inspired layout engine for Rust GUI
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
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
use ui_layout::*;

#[test]
fn inline_basic_flow() {
    let fragment1 = ItemFragment::Fragment(Fragment {
        width: 30.0,
        height: 20.0,
    });

    let fragment2 = ItemFragment::Fragment(Fragment {
        width: 40.0,
        height: 25.0,
    });

    let fragment3 = ItemFragment::Fragment(Fragment {
        width: 35.0,
        height: 15.0,
    });

    let mut inline_node = LayoutNode::new(Style {
        display: Display::Inline,
        ..Default::default()
    });
    inline_node.set_fragments(vec![fragment1, fragment2, fragment3]);

    let mut root = LayoutNode::with_children(
        Style {
            size: SizeStyle {
                width: Length::Px(200.0),
                height: Length::Auto,
                ..Default::default()
            },
            ..Default::default()
        },
        vec![inline_node],
    );

    LayoutEngine::layout(&mut root, 800.0, 600.0);

    // Check fragment placements
    assert_eq!(root.children[0].placements.len(), 3);

    // All fragments should be on the same line
    for placement in &root.children[0].placements {
        assert_eq!(placement.line_index, 0);
    }

    // Check horizontal positions
    assert_eq!(root.children[0].placements[0].offset.0, 0.0); // First fragment at start
    assert_eq!(root.children[0].placements[1].offset.0, 30.0); // Second after first
    assert_eq!(root.children[0].placements[2].offset.0, 70.0); // Third after second

    // Check that inline node has correct layout boxes
    match &root.children[0].layout_boxes {
        LayoutBoxes::Single(box_model) => {
            assert_eq!(box_model.content_box.width, 105.0); // Total width of fragments
            assert_eq!(box_model.content_box.height, 25.0); // Max height of fragments
        }
        _ => panic!("Expected single box model"),
    }
}

#[test]
fn inline_line_wrapping() {
    let fragment1 = ItemFragment::Fragment(Fragment {
        width: 80.0,
        height: 20.0,
    });

    let fragment2 = ItemFragment::Fragment(Fragment {
        width: 70.0,
        height: 25.0,
    });

    let fragment3 = ItemFragment::Fragment(Fragment {
        width: 60.0,
        height: 15.0,
    });

    let mut inline_node = LayoutNode::new(Style {
        display: Display::Inline,
        ..Default::default()
    });
    inline_node.set_fragments(vec![fragment1, fragment2, fragment3]);

    let mut root = LayoutNode::with_children(
        Style {
            size: SizeStyle {
                width: Length::Px(120.0), // Force wrapping
                height: Length::Auto,
                ..Default::default()
            },
            ..Default::default()
        },
        vec![inline_node],
    );

    LayoutEngine::layout(&mut root, 800.0, 600.0);

    // Check fragment placements
    assert_eq!(root.children[0].placements.len(), 3);

    // First fragment on line 0
    assert_eq!(root.children[0].placements[0].line_index, 0);
    assert_eq!(root.children[0].placements[0].offset.0, 0.0);

    // Second fragment should wrap to line 1
    assert_eq!(root.children[0].placements[1].line_index, 1);
    assert_eq!(root.children[0].placements[1].offset.0, 0.0);

    // Third fragment should wrap to line 2
    assert_eq!(root.children[0].placements[2].line_index, 2);
    assert_eq!(root.children[0].placements[2].offset.0, 0.0);

    // Check total height accounts for multiple lines
    match &root.children[0].layout_boxes {
        LayoutBoxes::Single(box_model) => {
            assert_eq!(box_model.content_box.height, 60.0); // 20 + 25 + 15 (line heights)
        }
        _ => panic!("Expected single box model"),
    }
}

#[test]
fn inline_with_line_breaks() {
    let fragment1 = ItemFragment::Fragment(Fragment {
        width: 30.0,
        height: 20.0,
    });

    let line_break = ItemFragment::LineBreak;

    let fragment2 = ItemFragment::Fragment(Fragment {
        width: 40.0,
        height: 25.0,
    });

    let mut inline_node = LayoutNode::new(Style {
        display: Display::Inline,
        ..Default::default()
    });
    inline_node.set_fragments(vec![fragment1, line_break, fragment2]);

    let mut root = LayoutNode::with_children(
        Style {
            size: SizeStyle {
                width: Length::Px(200.0),
                height: Length::Auto,
                ..Default::default()
            },
            ..Default::default()
        },
        vec![inline_node],
    );

    LayoutEngine::layout(&mut root, 800.0, 600.0);

    // Check fragment placements (line break creates a placement too)
    assert_eq!(root.children[0].placements.len(), 3);

    // First fragment on line 0
    assert_eq!(root.children[0].placements[0].line_index, 0);
    assert_eq!(root.children[0].placements[0].offset.0, 0.0);

    // Line break on line 0 -> 1 transition
    assert_eq!(root.children[0].placements[1].line_index, 1);

    // Second fragment on line 1
    assert_eq!(root.children[0].placements[2].line_index, 1);
    assert_eq!(root.children[0].placements[2].offset.0, 0.0);

    // Check total height
    match &root.children[0].layout_boxes {
        LayoutBoxes::Single(box_model) => {
            assert_eq!(box_model.content_box.height, 45.0); // 20 + 25 (two line heights)
        }
        _ => panic!("Expected single box model"),
    }
}

#[test]
fn inline_with_margins() {
    let fragment1 = ItemFragment::Fragment(Fragment {
        width: 50.0,
        height: 20.0,
    });

    let mut inline_node = LayoutNode::new(Style {
        display: Display::Inline,
        spacing: Spacing {
            margin_left: Length::Px(10.0),
            margin_right: Length::Px(15.0),
            margin_top: Length::Px(5.0),    // ignored
            margin_bottom: Length::Px(8.0), // ignored
            ..Default::default()
        },
        ..Default::default()
    });
    inline_node.set_fragments(vec![fragment1]);

    let inner = LayoutNode::with_children(
        Style {
            size: SizeStyle {
                width: Length::Px(200.0),
                height: Length::Auto,
                ..Default::default()
            },
            ..Default::default()
        },
        vec![inline_node],
    );

    let mut root = LayoutNode::with_children(Style::default(), vec![inner]);

    LayoutEngine::layout(&mut root, 800.0, 600.0);

    // Inline element layout
    match &root.children[0].children[0].layout_boxes {
        LayoutBoxes::Single(box_model) => {
            // Horizontal margins affect x-position
            assert_eq!(box_model.border_box.x, 10.0);

            // Vertical margins do NOT affect inline positioning
            assert_eq!(box_model.border_box.y, 0.0);

            assert_eq!(box_model.content_box.width, 50.0);
            assert_eq!(box_model.content_box.height, 20.0);
        }
        _ => panic!("Expected single box model"),
    }

    // Parent height calculation
    match &root.children[0].layout_boxes {
        LayoutBoxes::Single(box_model) => {
            // Inline margins (top/bottom) do not contribute
            assert_eq!(box_model.content_box.height, 20.0);
        }
        _ => panic!("Expected single box model"),
    }
}

#[test]
fn inline_with_padding() {
    let fragment1 = ItemFragment::Fragment(Fragment {
        width: 40.0,
        height: 18.0,
    });

    let mut inline_node = LayoutNode::new(Style {
        display: Display::Inline,
        spacing: Spacing {
            padding_left: Length::Px(12.0),
            padding_right: Length::Px(8.0),
            padding_top: Length::Px(6.0),
            padding_bottom: Length::Px(4.0),
            ..Default::default()
        },
        ..Default::default()
    });
    inline_node.set_fragments(vec![fragment1]);

    let mut root = LayoutNode::with_children(
        Style {
            size: SizeStyle {
                width: Length::Px(200.0),
                height: Length::Auto,
                ..Default::default()
            },
            ..Default::default()
        },
        vec![inline_node],
    );

    LayoutEngine::layout(&mut root, 800.0, 600.0);

    match &root.children[0].layout_boxes {
        LayoutBoxes::Single(box_model) => {
            // Content box should be the fragment size
            assert_eq!(box_model.content_box.width, 40.0);
            assert_eq!(box_model.content_box.height, 18.0);

            // Padding box should include padding
            assert_eq!(box_model.padding_box.width, 60.0); // 40 + 12 + 8
            assert_eq!(box_model.padding_box.height, 28.0); // 18 + 6 + 4

            // Border box same as padding box (no border)
            assert_eq!(box_model.border_box.width, 60.0);
            assert_eq!(box_model.border_box.height, 28.0);
        }
        _ => panic!("Expected single box model"),
    }

    // Fragment should be positioned within padding
    assert_eq!(root.children[0].placements.len(), 1);
    assert_eq!(root.children[0].placements[0].offset.0, 0.0); // Fragment offset relative to content box
}

#[test]
fn inline_with_borders() {
    let fragment1 = ItemFragment::Fragment(Fragment {
        width: 35.0,
        height: 22.0,
    });

    let mut inline_node = LayoutNode::new(Style {
        display: Display::Inline,
        spacing: Spacing {
            padding_left: Length::Px(8.0),
            padding_right: Length::Px(6.0),
            padding_top: Length::Px(4.0),
            padding_bottom: Length::Px(3.0),

            border_left: Length::Px(3.0),
            border_right: Length::Px(2.0),
            border_top: Length::Px(1.0),
            border_bottom: Length::Px(2.0),
            ..Default::default()
        },
        ..Default::default()
    });
    inline_node.set_fragments(vec![fragment1]);

    let mut root = LayoutNode::with_children(
        Style {
            size: SizeStyle {
                width: Length::Px(200.0),
                height: Length::Auto,
                ..Default::default()
            },
            ..Default::default()
        },
        vec![inline_node],
    );

    LayoutEngine::layout(&mut root, 800.0, 600.0);

    match &root.children[0].layout_boxes {
        LayoutBoxes::Single(box_model) => {
            // Content box should be fragment size
            assert_eq!(box_model.content_box.width, 35.0);
            assert_eq!(box_model.content_box.height, 22.0);

            // Padding box should include padding
            assert_eq!(box_model.padding_box.width, 49.0); // 35 + 8 + 6
            assert_eq!(box_model.padding_box.height, 29.0); // 22 + 4 + 3

            // Border box should include borders
            assert_eq!(box_model.border_box.width, 54.0); // 49 + 3 + 2
            assert_eq!(box_model.border_box.height, 32.0); // 29 + 1 + 2
        }
        _ => panic!("Expected single box model"),
    }
}

#[test]
fn inline_percentage_spacing() {
    let fragment1 = ItemFragment::Fragment(Fragment {
        width: 30.0,
        height: 20.0,
    });

    let mut inline_node = LayoutNode::new(Style {
        display: Display::Inline,
        spacing: Spacing {
            padding_left: Length::Percent(5.0),   // 5% of 200px = 10px
            padding_right: Length::Percent(2.5),  // 2.5% of 200px = 5px
            padding_top: Length::Percent(7.5), // 7.5% of 200px = 15px (CSS: all padding % relative to width)
            padding_bottom: Length::Percent(1.0), // 1% of 200px = 2px

            margin_left: Length::Percent(2.0), // 2% of 200px = 4px
            margin_top: Length::Percent(0.0), // 0% - CSS spec: margin % relative to width, using 0 for simplicity
            ..Default::default()
        },
        ..Default::default()
    });
    inline_node.set_fragments(vec![fragment1]);

    let mut root = LayoutNode::with_children(
        Style {
            size: SizeStyle {
                width: Length::Px(200.0),
                height: Length::Auto,
                ..Default::default()
            },
            ..Default::default()
        },
        vec![inline_node],
    );

    LayoutEngine::layout(&mut root, 800.0, 600.0);

    match &root.children[0].layout_boxes {
        LayoutBoxes::Single(box_model) => {
            // Content box should be fragment size
            assert_eq!(box_model.content_box.width, 30.0);
            assert_eq!(box_model.content_box.height, 20.0);

            // Padding box with percentage padding
            assert_eq!(box_model.padding_box.width, 45.0); // 30 + 10 + 5
            assert_eq!(box_model.padding_box.height, 37.0); // 20 + 15 + 2

            // Position should account for percentage margins
            assert_eq!(box_model.border_box.x, 4.0); // 2% of 200px
            assert_eq!(box_model.border_box.y, 0.0); // 0% margin_top
        }
        _ => panic!("Expected single box model"),
    }
}

#[test]
fn mixed_inline_and_block_children() {
    let fragment1 = ItemFragment::Fragment(Fragment {
        width: 40.0,
        height: 15.0,
    });

    let fragment2 = ItemFragment::Fragment(Fragment {
        width: 35.0,
        height: 20.0,
    });

    let mut inline_node1 = LayoutNode::new(Style {
        display: Display::Inline,
        ..Default::default()
    });
    inline_node1.set_fragments(vec![fragment1]);

    let block_node = LayoutNode::new(Style {
        display: Display::Block,
        size: SizeStyle {
            width: Length::Px(100.0),
            height: Length::Px(25.0),
            ..Default::default()
        },
        ..Default::default()
    });

    let mut inline_node2 = LayoutNode::new(Style {
        display: Display::Inline,
        ..Default::default()
    });
    inline_node2.set_fragments(vec![fragment2]);

    let mut root = LayoutNode::with_children(
        Style {
            size: SizeStyle {
                width: Length::Px(200.0),
                height: Length::Auto,
                ..Default::default()
            },
            ..Default::default()
        },
        vec![inline_node1, block_node, inline_node2],
    );

    LayoutEngine::layout(&mut root, 800.0, 600.0);

    // First inline: first line
    match &root.children[0].layout_boxes {
        LayoutBoxes::Single(box_model) => {
            assert_eq!(box_model.border_box.x, 0.0);
            assert_eq!(box_model.border_box.y, 0.0);
        }
        _ => panic!("Expected single box model"),
    }

    // Block: new line after first inline line (height = 15)
    match &root.children[1].layout_boxes {
        LayoutBoxes::Single(box_model) => {
            assert_eq!(box_model.border_box.x, 0.0);
            assert_eq!(box_model.border_box.y, 15.0);
        }
        _ => panic!("Expected single box model"),
    }

    // Second inline: new line after block (15 + 25 = 40)
    match &root.children[2].layout_boxes {
        LayoutBoxes::Single(box_model) => {
            assert_eq!(box_model.border_box.x, 0.0);
            assert_eq!(box_model.border_box.y, 40.0);
        }
        _ => panic!("Expected single box model"),
    }
}

#[test]
fn inline_empty_fragments() {
    let inline_node = LayoutNode::new(Style {
        display: Display::Inline,
        spacing: Spacing {
            padding_left: Length::Px(10.0),
            padding_right: Length::Px(10.0),
            padding_top: Length::Px(5.0),
            padding_bottom: Length::Px(5.0),
            ..Default::default()
        },
        ..Default::default()
    });
    // No fragments set - empty inline element

    let mut root = LayoutNode::with_children(
        Style {
            size: SizeStyle {
                width: Length::Px(200.0),
                height: Length::Auto,
                ..Default::default()
            },
            ..Default::default()
        },
        vec![inline_node],
    );

    LayoutEngine::layout(&mut root, 800.0, 600.0);

    // Empty inline element should still have padding
    match &root.children[0].layout_boxes {
        LayoutBoxes::Single(box_model) => {
            assert_eq!(box_model.content_box.width, 0.0); // No content
            assert_eq!(box_model.content_box.height, 0.0); // No content
            assert_eq!(box_model.padding_box.width, 20.0); // Still has padding
            assert_eq!(box_model.padding_box.height, 10.0); // Still has padding
        }
        _ => panic!("Expected single box model"),
    }

    // Should have no fragment placements
    assert_eq!(root.children[0].placements.len(), 0);
}

#[test]
fn inline_viewport_relative_spacing() {
    let fragment1 = ItemFragment::Fragment(Fragment {
        width: 25.0,
        height: 18.0,
    });

    let mut inline_node = LayoutNode::new(Style {
        display: Display::Inline,
        spacing: Spacing {
            margin_left: Length::Vw(2.0),   // 2% of 800px = 16px
            margin_top: Length::Vh(1.5),    // 1.5% of 600px = 9px
            padding_left: Length::Vw(1.25), // 1.25% of 800px = 10px
            padding_top: Length::Vw(0.625), // 0.625% of 800px = 5px (CSS: all padding % relative to width)
            border_left: Length::Px(2.0),
            border_top: Length::Px(1.0),
            ..Default::default()
        },
        ..Default::default()
    });
    inline_node.set_fragments(vec![fragment1]);

    let mut root = LayoutNode::with_children(
        Style {
            size: SizeStyle {
                width: Length::Px(200.0),
                height: Length::Auto,
                ..Default::default()
            },
            ..Default::default()
        },
        vec![inline_node],
    );

    LayoutEngine::layout(&mut root, 800.0, 600.0); // Viewport: 800x600

    match &root.children[0].layout_boxes {
        LayoutBoxes::Single(box_model) => {
            // Position should use viewport-relative margins
            assert_eq!(box_model.border_box.x, 16.0); // 2% of 800px
            assert_eq!(box_model.border_box.y, 0.0); // 1.5% of 600px is **ignored** for vertical margin on inline

            // Content size should be fragment size
            assert_eq!(box_model.content_box.width, 25.0);
            assert_eq!(box_model.content_box.height, 18.0);

            // Padding should use viewport-relative values
            assert_eq!(box_model.padding_box.width, 35.0); // 25 + 10 + 0
            assert_eq!(box_model.padding_box.height, 23.0); // 18 + 5 + 0

            // Border should be added
            assert_eq!(box_model.border_box.width, 37.0); // 35 + 2 + 0
            assert_eq!(box_model.border_box.height, 24.0); // 23 + 1 + 0
        }
        _ => panic!("Expected single box model"),
    }
}