1#![forbid(unsafe_code)]
2
3use crate::Widget;
24use crate::layout_debugger::{LayoutDebugger, LayoutRecord};
25use ftui_core::geometry::Rect;
26use ftui_render::buffer::Buffer;
27use ftui_render::cell::{Cell, PackedRgba};
28use ftui_render::drawing::{BorderChars, Draw};
29use ftui_render::frame::Frame;
30
31#[derive(Debug, Clone)]
33pub struct ConstraintOverlayStyle {
34 pub normal_color: PackedRgba,
36 pub overflow_color: PackedRgba,
38 pub underflow_color: PackedRgba,
40 pub requested_color: PackedRgba,
42 pub label_fg: PackedRgba,
44 pub label_bg: PackedRgba,
46 pub show_size_diff: bool,
48 pub show_constraint_bounds: bool,
50 pub show_borders: bool,
52 pub show_labels: bool,
54 pub border_chars: BorderChars,
56}
57
58impl Default for ConstraintOverlayStyle {
59 fn default() -> Self {
60 Self {
61 normal_color: PackedRgba::rgb(100, 200, 100),
62 overflow_color: PackedRgba::rgb(240, 80, 80),
63 underflow_color: PackedRgba::rgb(240, 200, 80),
64 requested_color: PackedRgba::rgb(80, 150, 240),
65 label_fg: PackedRgba::rgb(255, 255, 255),
66 label_bg: PackedRgba::rgb(0, 0, 0),
67 show_size_diff: true,
68 show_constraint_bounds: true,
69 show_borders: true,
70 show_labels: true,
71 border_chars: BorderChars::ASCII,
72 }
73 }
74}
75
76pub struct ConstraintOverlay<'a> {
85 debugger: &'a LayoutDebugger,
86 style: ConstraintOverlayStyle,
87}
88
89impl<'a> ConstraintOverlay<'a> {
90 pub fn new(debugger: &'a LayoutDebugger) -> Self {
92 Self {
93 debugger,
94 style: ConstraintOverlayStyle::default(),
95 }
96 }
97
98 #[must_use]
100 pub fn style(mut self, style: ConstraintOverlayStyle) -> Self {
101 self.style = style;
102 self
103 }
104
105 fn render_record(&self, record: &LayoutRecord, area: Rect, buf: &mut Buffer) {
106 let Some(clipped) = record.area_received.intersection_opt(&area) else {
108 return;
109 };
110 if clipped.is_empty() {
111 return;
112 }
113
114 let constraints = &record.constraints;
116 let received = &record.area_received;
117
118 let is_overflow = (constraints.max_width != 0 && received.width > constraints.max_width)
119 || (constraints.max_height != 0 && received.height > constraints.max_height);
120 let is_underflow =
121 received.width < constraints.min_width || received.height < constraints.min_height;
122
123 let border_color = if is_overflow {
124 self.style.overflow_color
125 } else if is_underflow {
126 self.style.underflow_color
127 } else {
128 self.style.normal_color
129 };
130
131 if self.style.show_borders {
133 let border_cell = Cell::from_char('+').with_fg(border_color);
134 buf.draw_border(clipped, self.style.border_chars, border_cell);
135 }
136
137 if self.style.show_size_diff {
139 let requested = &record.area_requested;
140 if requested != received
141 && let Some(req_clipped) = requested.intersection_opt(&area)
142 && !req_clipped.is_empty()
143 {
144 let req_cell = Cell::from_char('.').with_fg(self.style.requested_color);
146 self.draw_requested_outline(req_clipped, buf, req_cell);
147 }
148 }
149
150 if self.style.show_labels {
152 let label = self.format_label(record, is_overflow, is_underflow);
153 let label_x = clipped.x.saturating_add(1);
154 let label_y = clipped.y;
155 let max_x = clipped.right();
156
157 if label_x < max_x {
158 let label_cell = Cell::from_char(' ')
159 .with_fg(self.style.label_fg)
160 .with_bg(self.style.label_bg);
161 let _ = buf.print_text_clipped(label_x, label_y, &label, label_cell, max_x);
162 }
163 }
164
165 for child in &record.children {
167 self.render_record(child, area, buf);
168 }
169 }
170
171 fn draw_requested_outline(&self, area: Rect, buf: &mut Buffer, cell: Cell) {
172 if area.width >= 1 && area.height >= 1 {
174 buf.set_fast(area.x, area.y, cell);
175 }
176 if area.width >= 2 && area.height >= 1 {
177 buf.set_fast(area.right().saturating_sub(1), area.y, cell);
178 }
179 if area.width >= 1 && area.height >= 2 {
180 buf.set_fast(area.x, area.bottom().saturating_sub(1), cell);
181 }
182 if area.width >= 2 && area.height >= 2 {
183 buf.set_fast(
184 area.right().saturating_sub(1),
185 area.bottom().saturating_sub(1),
186 cell,
187 );
188 }
189 }
190
191 fn format_label(&self, record: &LayoutRecord, is_overflow: bool, is_underflow: bool) -> String {
192 let status = if is_overflow {
193 "!"
194 } else if is_underflow {
195 "?"
196 } else {
197 ""
198 };
199
200 let mut label = format!("{}{}", record.widget_name, status);
201
202 let req = &record.area_requested;
204 let got = &record.area_received;
205 if req.width != got.width || req.height != got.height {
206 label.push_str(&format!(
207 " {}x{}\u{2192}{}x{}",
208 req.width, req.height, got.width, got.height
209 ));
210 } else {
211 label.push_str(&format!(" {}x{}", got.width, got.height));
212 }
213
214 if self.style.show_constraint_bounds {
216 let c = &record.constraints;
217 if c.min_width != 0 || c.min_height != 0 || c.max_width != 0 || c.max_height != 0 {
218 label.push_str(&format!(
219 " [{}..{} x {}..{}]",
220 c.min_width,
221 if c.max_width == 0 {
222 "\u{221E}".to_string()
223 } else {
224 c.max_width.to_string()
225 },
226 c.min_height,
227 if c.max_height == 0 {
228 "\u{221E}".to_string()
229 } else {
230 c.max_height.to_string()
231 }
232 ));
233 }
234 }
235
236 label
237 }
238}
239
240impl Widget for ConstraintOverlay<'_> {
241 fn render(&self, area: Rect, frame: &mut Frame) {
242 if !self.debugger.enabled() {
243 return;
244 }
245
246 for record in self.debugger.records() {
247 self.render_record(record, area, &mut frame.buffer);
248 }
249 }
250}
251
252#[cfg(test)]
253mod tests {
254 use super::*;
255 use crate::layout_debugger::LayoutConstraints;
256 use ftui_render::grapheme_pool::GraphemePool;
257
258 #[test]
259 fn overlay_renders_nothing_when_disabled() {
260 let mut debugger = LayoutDebugger::new();
261 debugger.record(LayoutRecord::new(
263 "Root",
264 Rect::new(0, 0, 10, 4),
265 Rect::new(0, 0, 10, 4),
266 LayoutConstraints::unconstrained(),
267 ));
268
269 let overlay = ConstraintOverlay::new(&debugger);
270 let mut pool = GraphemePool::new();
271 let mut frame = Frame::new(20, 10, &mut pool);
272 overlay.render(Rect::new(0, 0, 20, 10), &mut frame);
273
274 assert!(frame.buffer.get(0, 0).unwrap().is_empty());
276 }
277
278 #[test]
279 fn overlay_renders_border_for_valid_constraint() {
280 let mut debugger = LayoutDebugger::new();
281 debugger.set_enabled(true);
282 debugger.record(LayoutRecord::new(
283 "Root",
284 Rect::new(1, 1, 6, 4),
285 Rect::new(1, 1, 6, 4),
286 LayoutConstraints::new(4, 10, 2, 6),
287 ));
288
289 let overlay = ConstraintOverlay::new(&debugger);
290 let mut pool = GraphemePool::new();
291 let mut frame = Frame::new(20, 10, &mut pool);
292 overlay.render(Rect::new(0, 0, 20, 10), &mut frame);
293
294 let cell = frame.buffer.get(1, 1).unwrap();
296 assert_eq!(cell.content.as_char(), Some('+'));
297 }
298
299 #[test]
300 fn overlay_uses_overflow_color_when_exceeds_max() {
301 let mut debugger = LayoutDebugger::new();
302 debugger.set_enabled(true);
303 debugger.record(LayoutRecord::new(
305 "Overflow",
306 Rect::new(0, 0, 10, 4),
307 Rect::new(0, 0, 10, 4),
308 LayoutConstraints::new(0, 8, 0, 3),
309 ));
310
311 let style = ConstraintOverlayStyle {
312 overflow_color: PackedRgba::rgb(255, 0, 0),
313 ..Default::default()
314 };
315
316 let overlay = ConstraintOverlay::new(&debugger).style(style);
317 let mut pool = GraphemePool::new();
318 let mut frame = Frame::new(20, 10, &mut pool);
319 overlay.render(Rect::new(0, 0, 20, 10), &mut frame);
320
321 let cell = frame.buffer.get(0, 0).unwrap();
322 assert_eq!(cell.fg, PackedRgba::rgb(255, 0, 0));
323 }
324
325 #[test]
326 fn overlay_uses_underflow_color_when_below_min() {
327 let mut debugger = LayoutDebugger::new();
328 debugger.set_enabled(true);
329 debugger.record(LayoutRecord::new(
331 "Underflow",
332 Rect::new(0, 0, 4, 2),
333 Rect::new(0, 0, 4, 2),
334 LayoutConstraints::new(6, 0, 3, 0),
335 ));
336
337 let style = ConstraintOverlayStyle {
338 underflow_color: PackedRgba::rgb(255, 255, 0),
339 ..Default::default()
340 };
341
342 let overlay = ConstraintOverlay::new(&debugger).style(style);
343 let mut pool = GraphemePool::new();
344 let mut frame = Frame::new(20, 10, &mut pool);
345 overlay.render(Rect::new(0, 0, 20, 10), &mut frame);
346
347 let cell = frame.buffer.get(0, 0).unwrap();
348 assert_eq!(cell.fg, PackedRgba::rgb(255, 255, 0));
349 }
350
351 #[test]
352 fn overlay_shows_requested_vs_received_diff() {
353 let mut debugger = LayoutDebugger::new();
354 debugger.set_enabled(true);
355 debugger.record(LayoutRecord::new(
357 "Diff",
358 Rect::new(0, 0, 10, 5),
359 Rect::new(0, 0, 8, 4),
360 LayoutConstraints::unconstrained(),
361 ));
362
363 let style = ConstraintOverlayStyle {
364 requested_color: PackedRgba::rgb(0, 0, 255),
365 ..Default::default()
366 };
367
368 let overlay = ConstraintOverlay::new(&debugger).style(style);
369 let mut pool = GraphemePool::new();
370 let mut frame = Frame::new(20, 10, &mut pool);
371 overlay.render(Rect::new(0, 0, 20, 10), &mut frame);
372
373 let cell = frame.buffer.get(9, 0).unwrap();
375 assert_eq!(cell.content.as_char(), Some('.'));
376 assert_eq!(cell.fg, PackedRgba::rgb(0, 0, 255));
377 }
378
379 #[test]
380 fn overlay_renders_children() {
381 let mut debugger = LayoutDebugger::new();
382 debugger.set_enabled(true);
383
384 let child = LayoutRecord::new(
385 "Child",
386 Rect::new(2, 2, 4, 2),
387 Rect::new(2, 2, 4, 2),
388 LayoutConstraints::unconstrained(),
389 );
390 let parent = LayoutRecord::new(
391 "Parent",
392 Rect::new(0, 0, 10, 6),
393 Rect::new(0, 0, 10, 6),
394 LayoutConstraints::unconstrained(),
395 )
396 .with_child(child);
397 debugger.record(parent);
398
399 let overlay = ConstraintOverlay::new(&debugger);
400 let mut pool = GraphemePool::new();
401 let mut frame = Frame::new(20, 10, &mut pool);
402 overlay.render(Rect::new(0, 0, 20, 10), &mut frame);
403
404 let parent_cell = frame.buffer.get(0, 0).unwrap();
406 assert_eq!(parent_cell.content.as_char(), Some('+'));
407
408 let child_cell = frame.buffer.get(2, 2).unwrap();
409 assert_eq!(child_cell.content.as_char(), Some('+'));
410 }
411
412 #[test]
413 fn overlay_clips_to_render_area() {
414 let mut debugger = LayoutDebugger::new();
415 debugger.set_enabled(true);
416 debugger.record(LayoutRecord::new(
417 "PartiallyVisible",
418 Rect::new(5, 5, 10, 10),
419 Rect::new(5, 5, 10, 10),
420 LayoutConstraints::unconstrained(),
421 ));
422
423 let overlay = ConstraintOverlay::new(&debugger);
424 let mut pool = GraphemePool::new();
425 let mut frame = Frame::new(10, 10, &mut pool);
426 overlay.render(Rect::new(0, 0, 10, 10), &mut frame);
428
429 let cell = frame.buffer.get(5, 5).unwrap();
431 assert_eq!(cell.content.as_char(), Some('+'));
432
433 let outside = frame.buffer.get(0, 0).unwrap();
435 assert!(outside.is_empty());
436 }
437
438 #[test]
439 fn format_label_includes_status_marker() {
440 let debugger = LayoutDebugger::new();
441 let overlay = ConstraintOverlay::new(&debugger);
442
443 let record = LayoutRecord::new(
445 "Widget",
446 Rect::new(0, 0, 10, 4),
447 Rect::new(0, 0, 10, 4),
448 LayoutConstraints::new(0, 8, 0, 0),
449 );
450 let label = overlay.format_label(&record, true, false);
451 assert!(label.starts_with("Widget!"));
452
453 let label = overlay.format_label(&record, false, true);
455 assert!(label.starts_with("Widget?"));
456
457 let label = overlay.format_label(&record, false, false);
459 assert!(label.starts_with("Widget "));
460 }
461
462 #[test]
463 fn style_can_be_customized() {
464 let debugger = LayoutDebugger::new();
465 let style = ConstraintOverlayStyle {
466 show_borders: false,
467 show_labels: false,
468 show_size_diff: false,
469 ..Default::default()
470 };
471
472 let overlay = ConstraintOverlay::new(&debugger).style(style);
473 assert!(!overlay.style.show_borders);
474 assert!(!overlay.style.show_labels);
475 }
476
477 #[test]
478 fn default_style_values() {
479 let s = ConstraintOverlayStyle::default();
480 assert_eq!(s.normal_color, PackedRgba::rgb(100, 200, 100));
481 assert_eq!(s.overflow_color, PackedRgba::rgb(240, 80, 80));
482 assert_eq!(s.underflow_color, PackedRgba::rgb(240, 200, 80));
483 assert_eq!(s.requested_color, PackedRgba::rgb(80, 150, 240));
484 assert!(s.show_size_diff);
485 assert!(s.show_constraint_bounds);
486 assert!(s.show_borders);
487 assert!(s.show_labels);
488 }
489
490 #[test]
491 fn format_label_same_requested_and_received() {
492 let debugger = LayoutDebugger::new();
493 let overlay = ConstraintOverlay::new(&debugger);
494 let record = LayoutRecord::new(
495 "Box",
496 Rect::new(0, 0, 8, 4),
497 Rect::new(0, 0, 8, 4),
498 LayoutConstraints::unconstrained(),
499 );
500 let label = overlay.format_label(&record, false, false);
501 assert!(label.contains("8x4"));
502 assert!(!label.contains('\u{2192}'));
504 }
505
506 #[test]
507 fn format_label_different_sizes_shows_arrow() {
508 let debugger = LayoutDebugger::new();
509 let overlay = ConstraintOverlay::new(&debugger);
510 let record = LayoutRecord::new(
511 "Box",
512 Rect::new(0, 0, 10, 5),
513 Rect::new(0, 0, 8, 4),
514 LayoutConstraints::unconstrained(),
515 );
516 let label = overlay.format_label(&record, false, false);
517 assert!(label.contains("10x5"));
519 assert!(label.contains('\u{2192}'));
520 assert!(label.contains("8x4"));
521 }
522
523 #[test]
524 fn format_label_constraint_bounds_infinity() {
525 let debugger = LayoutDebugger::new();
526 let overlay = ConstraintOverlay::new(&debugger);
527 let record = LayoutRecord::new(
529 "W",
530 Rect::new(0, 0, 8, 4),
531 Rect::new(0, 0, 8, 4),
532 LayoutConstraints::new(5, 0, 0, 10),
533 );
534 let label = overlay.format_label(&record, false, false);
535 assert!(label.contains('\u{221E}'));
537 assert!(label.contains("5.."));
538 }
539
540 #[test]
541 fn format_label_no_bounds_when_all_zero() {
542 let debugger = LayoutDebugger::new();
543 let overlay = ConstraintOverlay::new(&debugger);
544 let record = LayoutRecord::new(
545 "W",
546 Rect::new(0, 0, 8, 4),
547 Rect::new(0, 0, 8, 4),
548 LayoutConstraints::new(0, 0, 0, 0),
549 );
550 let label = overlay.format_label(&record, false, false);
551 assert!(!label.contains('['));
553 }
554
555 #[test]
556 fn format_label_no_bounds_when_disabled() {
557 let debugger = LayoutDebugger::new();
558 let style = ConstraintOverlayStyle {
559 show_constraint_bounds: false,
560 ..Default::default()
561 };
562 let overlay = ConstraintOverlay::new(&debugger).style(style);
563 let record = LayoutRecord::new(
564 "W",
565 Rect::new(0, 0, 8, 4),
566 Rect::new(0, 0, 8, 4),
567 LayoutConstraints::new(5, 10, 3, 8),
568 );
569 let label = overlay.format_label(&record, false, false);
570 assert!(!label.contains('['));
571 }
572
573 #[test]
574 fn enabled_debugger_with_no_records_renders_nothing() {
575 let mut debugger = LayoutDebugger::new();
576 debugger.set_enabled(true);
577 let overlay = ConstraintOverlay::new(&debugger);
579 let mut pool = GraphemePool::new();
580 let mut frame = Frame::new(20, 10, &mut pool);
581 overlay.render(Rect::new(0, 0, 20, 10), &mut frame);
582 assert!(frame.buffer.get(0, 0).unwrap().is_empty());
583 }
584
585 #[test]
586 fn record_fully_outside_render_area_is_skipped() {
587 let mut debugger = LayoutDebugger::new();
588 debugger.set_enabled(true);
589 debugger.record(LayoutRecord::new(
590 "Offscreen",
591 Rect::new(50, 50, 10, 10),
592 Rect::new(50, 50, 10, 10),
593 LayoutConstraints::unconstrained(),
594 ));
595
596 let overlay = ConstraintOverlay::new(&debugger);
597 let mut pool = GraphemePool::new();
598 let mut frame = Frame::new(20, 10, &mut pool);
599 overlay.render(Rect::new(0, 0, 20, 10), &mut frame);
600
601 assert!(frame.buffer.get(0, 0).unwrap().is_empty());
603 }
604
605 #[test]
608 fn zero_size_record_is_skipped() {
609 let mut debugger = LayoutDebugger::new();
610 debugger.set_enabled(true);
611 debugger.record(LayoutRecord::new(
612 "Empty",
613 Rect::new(0, 0, 0, 0),
614 Rect::new(0, 0, 0, 0),
615 LayoutConstraints::unconstrained(),
616 ));
617
618 let overlay = ConstraintOverlay::new(&debugger);
619 let mut pool = GraphemePool::new();
620 let mut frame = Frame::new(20, 10, &mut pool);
621 overlay.render(Rect::new(0, 0, 20, 10), &mut frame);
622 assert!(frame.buffer.get(0, 0).unwrap().is_empty());
623 }
624
625 #[test]
626 fn one_by_one_record_renders_border() {
627 let mut debugger = LayoutDebugger::new();
628 debugger.set_enabled(true);
629 debugger.record(LayoutRecord::new(
630 "Tiny",
631 Rect::new(2, 2, 1, 1),
632 Rect::new(2, 2, 1, 1),
633 LayoutConstraints::unconstrained(),
634 ));
635
636 let overlay = ConstraintOverlay::new(&debugger);
637 let mut pool = GraphemePool::new();
638 let mut frame = Frame::new(20, 10, &mut pool);
639 overlay.render(Rect::new(0, 0, 20, 10), &mut frame);
640 let cell = frame.buffer.get(2, 2).unwrap();
642 assert!(!cell.is_empty());
643 }
644
645 #[test]
646 fn overflow_only_height() {
647 let mut debugger = LayoutDebugger::new();
648 debugger.set_enabled(true);
649 debugger.record(LayoutRecord::new(
651 "HOverflow",
652 Rect::new(0, 0, 5, 8),
653 Rect::new(0, 0, 5, 8),
654 LayoutConstraints::new(0, 10, 0, 6),
655 ));
656
657 let style = ConstraintOverlayStyle {
658 overflow_color: PackedRgba::rgb(255, 0, 0),
659 ..Default::default()
660 };
661 let overlay = ConstraintOverlay::new(&debugger).style(style);
662 let mut pool = GraphemePool::new();
663 let mut frame = Frame::new(20, 10, &mut pool);
664 overlay.render(Rect::new(0, 0, 20, 10), &mut frame);
665
666 let cell = frame.buffer.get(0, 0).unwrap();
667 assert_eq!(cell.fg, PackedRgba::rgb(255, 0, 0), "height overflow color");
668 }
669
670 #[test]
671 fn underflow_only_height() {
672 let mut debugger = LayoutDebugger::new();
673 debugger.set_enabled(true);
674 debugger.record(LayoutRecord::new(
676 "HUnderflow",
677 Rect::new(0, 0, 6, 2),
678 Rect::new(0, 0, 6, 2),
679 LayoutConstraints::new(4, 0, 3, 0),
680 ));
681
682 let style = ConstraintOverlayStyle {
683 underflow_color: PackedRgba::rgb(255, 255, 0),
684 ..Default::default()
685 };
686 let overlay = ConstraintOverlay::new(&debugger).style(style);
687 let mut pool = GraphemePool::new();
688 let mut frame = Frame::new(20, 10, &mut pool);
689 overlay.render(Rect::new(0, 0, 20, 10), &mut frame);
690
691 let cell = frame.buffer.get(0, 0).unwrap();
692 assert_eq!(
693 cell.fg,
694 PackedRgba::rgb(255, 255, 0),
695 "height underflow color"
696 );
697 }
698
699 #[test]
700 fn overflow_takes_priority_over_underflow() {
701 let mut debugger = LayoutDebugger::new();
702 debugger.set_enabled(true);
703 debugger.record(LayoutRecord::new(
705 "Both",
706 Rect::new(0, 0, 10, 2),
707 Rect::new(0, 0, 10, 2),
708 LayoutConstraints::new(0, 8, 3, 0),
709 ));
710
711 let style = ConstraintOverlayStyle {
712 overflow_color: PackedRgba::rgb(255, 0, 0),
713 underflow_color: PackedRgba::rgb(255, 255, 0),
714 ..Default::default()
715 };
716 let overlay = ConstraintOverlay::new(&debugger).style(style);
717 let mut pool = GraphemePool::new();
718 let mut frame = Frame::new(20, 10, &mut pool);
719 overlay.render(Rect::new(0, 0, 20, 10), &mut frame);
720
721 let cell = frame.buffer.get(0, 0).unwrap();
722 assert_eq!(
723 cell.fg,
724 PackedRgba::rgb(255, 0, 0),
725 "overflow wins over underflow"
726 );
727 }
728
729 #[test]
730 fn multiple_records_all_render() {
731 let mut debugger = LayoutDebugger::new();
732 debugger.set_enabled(true);
733 debugger.record(LayoutRecord::new(
734 "A",
735 Rect::new(0, 0, 5, 3),
736 Rect::new(0, 0, 5, 3),
737 LayoutConstraints::unconstrained(),
738 ));
739 debugger.record(LayoutRecord::new(
740 "B",
741 Rect::new(6, 0, 5, 3),
742 Rect::new(6, 0, 5, 3),
743 LayoutConstraints::unconstrained(),
744 ));
745
746 let overlay = ConstraintOverlay::new(&debugger);
747 let mut pool = GraphemePool::new();
748 let mut frame = Frame::new(20, 10, &mut pool);
749 overlay.render(Rect::new(0, 0, 20, 10), &mut frame);
750
751 assert_eq!(frame.buffer.get(0, 0).unwrap().content.as_char(), Some('+'));
752 assert_eq!(frame.buffer.get(6, 0).unwrap().content.as_char(), Some('+'));
753 }
754
755 #[test]
756 fn deeply_nested_children_render() {
757 let mut debugger = LayoutDebugger::new();
758 debugger.set_enabled(true);
759
760 let grandchild = LayoutRecord::new(
761 "GC",
762 Rect::new(4, 4, 3, 2),
763 Rect::new(4, 4, 3, 2),
764 LayoutConstraints::unconstrained(),
765 );
766 let child = LayoutRecord::new(
767 "Child",
768 Rect::new(2, 2, 8, 6),
769 Rect::new(2, 2, 8, 6),
770 LayoutConstraints::unconstrained(),
771 )
772 .with_child(grandchild);
773 let parent = LayoutRecord::new(
774 "Parent",
775 Rect::new(0, 0, 12, 10),
776 Rect::new(0, 0, 12, 10),
777 LayoutConstraints::unconstrained(),
778 )
779 .with_child(child);
780 debugger.record(parent);
781
782 let overlay = ConstraintOverlay::new(&debugger);
783 let mut pool = GraphemePool::new();
784 let mut frame = Frame::new(20, 12, &mut pool);
785 overlay.render(Rect::new(0, 0, 20, 12), &mut frame);
786
787 assert_eq!(frame.buffer.get(0, 0).unwrap().content.as_char(), Some('+'));
789 assert_eq!(frame.buffer.get(2, 2).unwrap().content.as_char(), Some('+'));
790 assert_eq!(frame.buffer.get(4, 4).unwrap().content.as_char(), Some('+'));
791 }
792
793 #[test]
794 fn format_label_empty_widget_name() {
795 let debugger = LayoutDebugger::new();
796 let overlay = ConstraintOverlay::new(&debugger);
797 let record = LayoutRecord::new(
798 "",
799 Rect::new(0, 0, 5, 3),
800 Rect::new(0, 0, 5, 3),
801 LayoutConstraints::unconstrained(),
802 );
803 let label = overlay.format_label(&record, false, false);
804 assert!(label.contains("5x3"), "size should still appear: {label}");
805 }
806
807 #[test]
808 fn format_label_both_bounds_finite() {
809 let debugger = LayoutDebugger::new();
810 let overlay = ConstraintOverlay::new(&debugger);
811 let record = LayoutRecord::new(
812 "W",
813 Rect::new(0, 0, 8, 4),
814 Rect::new(0, 0, 8, 4),
815 LayoutConstraints::new(4, 12, 2, 8),
816 );
817 let label = overlay.format_label(&record, false, false);
818 assert!(label.contains("[4..12 x 2..8]"), "label={label}");
820 }
821
822 #[test]
823 fn requested_outline_not_drawn_when_same_as_received() {
824 let mut debugger = LayoutDebugger::new();
825 debugger.set_enabled(true);
826 debugger.record(LayoutRecord::new(
827 "Same",
828 Rect::new(0, 0, 6, 4),
829 Rect::new(0, 0, 6, 4),
830 LayoutConstraints::unconstrained(),
831 ));
832
833 let style = ConstraintOverlayStyle {
834 requested_color: PackedRgba::rgb(0, 0, 255),
835 ..Default::default()
836 };
837 let overlay = ConstraintOverlay::new(&debugger).style(style);
838 let mut pool = GraphemePool::new();
839 let mut frame = Frame::new(20, 10, &mut pool);
840 overlay.render(Rect::new(0, 0, 20, 10), &mut frame);
841
842 let cell = frame.buffer.get(5, 3).unwrap(); assert_ne!(
846 cell.content.as_char(),
847 Some('.'),
848 "dot should not appear when same size"
849 );
850 }
851
852 #[test]
853 fn style_clone_and_debug() {
854 let style = ConstraintOverlayStyle::default();
855 let cloned = style.clone();
856 let _ = format!("{cloned:?}");
857 assert_eq!(cloned.normal_color, style.normal_color);
858 }
859
860 #[test]
861 fn max_width_zero_means_unconstrained_no_overflow() {
862 let debugger = LayoutDebugger::new();
863 let overlay = ConstraintOverlay::new(&debugger);
864 let record = LayoutRecord::new(
866 "W",
867 Rect::new(0, 0, 100, 4),
868 Rect::new(0, 0, 100, 4),
869 LayoutConstraints::new(0, 0, 0, 0),
870 );
871 let label = overlay.format_label(&record, false, false);
874 assert!(!label.contains('!'), "should not be overflow: {label}");
875 }
876
877 #[test]
880 fn no_borders_when_show_borders_disabled() {
881 let mut debugger = LayoutDebugger::new();
882 debugger.set_enabled(true);
883 debugger.record(LayoutRecord::new(
884 "NoBorder",
885 Rect::new(0, 0, 6, 4),
886 Rect::new(0, 0, 6, 4),
887 LayoutConstraints::unconstrained(),
888 ));
889
890 let style = ConstraintOverlayStyle {
891 show_borders: false,
892 show_labels: false,
893 show_size_diff: false,
894 ..Default::default()
895 };
896 let overlay = ConstraintOverlay::new(&debugger).style(style);
897 let mut pool = GraphemePool::new();
898 let mut frame = Frame::new(20, 10, &mut pool);
899 overlay.render(Rect::new(0, 0, 20, 10), &mut frame);
900
901 assert!(frame.buffer.get(0, 0).unwrap().is_empty());
903 }
904}