ferroui-diagnostics 0.4.0

The developer tools of FerroUI: the logical and visual trees, the properties and their value sources, routed events, the layout explorer and screenshots of a running application
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

//! Port of `Diagnostics/VisualTreeDebug.cs`.

use ferroui_base::data::core::ValueTypes;
use ferroui_base::data::BindingPriority;
use ferroui_base::diagnostics::FerroObjectDiagnosticExtensions;
use ferroui_base::{BoxedValue, FerroPropertyRegistry, Visual};
use ferroui_controls::Control;
use std::fmt::Write;
use std::rc::Rc;

/// Prints a visual tree as text, for debugging.
pub struct VisualTreeDebug;

impl VisualTreeDebug {
    /// The visual tree of `visual` as text: one line per visual (the name of its type, and the
    /// classes of a control), the properties of a control that have a value, each with the
    /// priority of the value, and the children, indented.
    pub fn print_visual_tree(visual: &Visual) -> String {
        let mut result = String::new();
        Self::print_visual_tree_into(visual, &mut result, 0);
        result
    }

    fn print_visual_tree_into(visual: &Visual, builder: &mut String, indent: i32) {
        let control = visual.to_ref().cast::<Control>();

        builder.push_str(&Self::indent(indent - 1));

        if indent > 0 {
            builder.push_str(" +- ");
        }

        builder.push_str(visual.get_type().name());

        if let Some(control) = &control {
            builder.push(' ');
            // `control.Classes.ToString()`.
            let classes: BoxedValue = Rc::new(control.classes());
            builder.push_str(&ValueTypes::to_display_string(Some(&classes)));
            builder.push('\n');

            for &property in FerroPropertyRegistry::instance().get_registered(control.get_type()).iter() {
                let value = control.get_diagnostic(property);

                if value.priority() != BindingPriority::Unset {
                    builder.push_str(&Self::indent(indent));
                    builder.push_str(" |  ");
                    builder.push_str(value.property().name());
                    builder.push_str(" = ");
                    let shown = ValueTypes::normalize(value.value().clone());
                    builder.push_str(&ValueTypes::to_display_string(shown.as_ref()));
                    builder.push_str(" [");
                    let _ = write!(builder, "{:?}", value.priority());
                    builder.push_str("]\n");
                }
            }
        } else {
            builder.push('\n');
        }

        for child in visual.visual_children().snapshot().iter() {
            Self::print_visual_tree_into(child, builder, indent + 1);
        }
    }

    fn indent(indent: i32) -> String {
        " ".repeat(indent.max(0) as usize * 4)
    }
}