tuigui 0.23.0

An easy-to-use, highly extensible, and speedy TUI library.
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

use crate::preludes::widget_creation::*;

#[derive(Debug, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash)]
/// Column anchor
pub enum ColAnchor {
    Left,
    Center,
    Right,
}

#[derive(Debug, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash)]
/// Row anchor
pub enum RowAnchor {
    Top,
    Center,
    Bottom,
}

#[derive(Debug, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash)]
/// Terminal anchor
pub struct Anchor {
    pub col: ColAnchor,
    pub row: RowAnchor,
}

impl Anchor {
    /// Create new anchor
    pub fn new(col: ColAnchor, row: RowAnchor) -> Self {
        Self {
            col,
            row,
        }
    }

    /// Calculate the position of an area based on the parent (usually a canvas) size and the child (usually a widget) size
    pub fn get_position(&self, parent_size: Size, child_size: Size) -> Position {
        let mut col = match self.col {
            ColAnchor::Left => 0,
            ColAnchor::Center => parent_size.cols.saturating_sub(child_size.cols) >> 1,
            ColAnchor::Right => parent_size.cols.saturating_sub(child_size.cols),
        };

        let mut row = match self.row {
            RowAnchor::Top => 0,
            RowAnchor::Center => parent_size.rows.saturating_sub(child_size.rows) >> 1,
            RowAnchor::Bottom => parent_size.rows.saturating_sub(child_size.rows),
        };

        if child_size.cols > parent_size.cols {
            col = 0;
        }

        if child_size.rows > parent_size.rows {
            row = 0;
        }

        Position::new(col as i16, row as i16)
    }
}

#[derive(Debug, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash)]
/// How to size the child widget of the anchor container widget
pub enum AnchorContainerWidgetSize {
    /// Consistent size that doesn't change when the terminal is resized
    Fixed(Size),
    /// Relative, changes when the terminal is resized
    Ratio(Size),
    /// Use the minimum size configured by the widget
    Min,
    /// Use the maximum size configured by the widget
    Max,
}

#[derive(Debug, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash)]
/// Anchor container, anchor a widget
/// to a certain edge or center of the parent widget
pub struct AnchorContainer<W: Widget> {
    pub anchor: Anchor,
    pub widget: W,
    pub widget_size: AnchorContainerWidgetSize,
    widget_data: WidgetData,
}

impl<W: Widget> AnchorContainer<W> {
    pub fn new(
        anchor: Anchor,
        widget_size: AnchorContainerWidgetSize,
        widget: W,
    ) -> Self {
        Self {
            anchor,
            widget,
            widget_size,
            widget_data: WidgetData::new(),
        }
    }
}

impl<W: Widget> Widget for AnchorContainer<W> {
    fn draw(&mut self, canvas: &mut Canvas, state_frame: Option<&EventStateFrame>) {
        if canvas.is_visible() == false {
            return;
        }

        let child_info = self.widget.widget_info();

        let size = match self.widget_size {
            AnchorContainerWidgetSize::Fixed(size) => size,
            AnchorContainerWidgetSize::Ratio(ratio) => canvas.transform.size / ratio,
            AnchorContainerWidgetSize::Min => child_info.size_info.get_min(),
            AnchorContainerWidgetSize::Max => child_info.size_info.get_max(),
        };

        let mut inner = canvas.new_child(Transform::new(
            self.anchor.get_position(canvas.transform.size, size),
            size,
        ));

        self.widget.draw(&mut inner, state_frame);
    }

    fn widget_info(&self) -> WidgetInfo {
        let child_info = self.widget.widget_info();

        WidgetInfo {
            size_info: match child_info.size_info {
                WidgetSizeInfo::Dynamic { min, .. } => {
                    WidgetSizeInfo::Dynamic {
                        min,
                        max: None,
                    }
                },
                WidgetSizeInfo::Fixed(size) => {
                    WidgetSizeInfo::Dynamic {
                        min: Some(size),
                        max: None,
                    }
                },
            },
        }
    }

    fn widget_data(&mut self) -> &mut WidgetData {
        return &mut self.widget_data;
    }
}