superconsole 0.2.0

A simple but powerful Text-based User Interface (TUI) framework
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

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under both the MIT license found in the
 * LICENSE-MIT file in the root directory of this source tree and the Apache
 * License, Version 2.0 found in the LICENSE-APACHE file in the root directory
 * of this source tree.
 */

use crate::Component;
use crate::Dimensions;
use crate::DrawMode;
use crate::Lines;

/// Draw components horizontally, each next component is stacked on the right.
pub struct DrawHorizontal {
    /// Original dimensions.
    dim: Dimensions,
    /// Remaining dimensions.
    rem_width: usize,
    /// What we have drawn so far.
    blocks: Vec<Lines>,
}

impl DrawHorizontal {
    /// Construct rendered with given dimensions.
    pub fn new(dimensions: Dimensions) -> DrawHorizontal {
        DrawHorizontal {
            dim: dimensions,
            rem_width: dimensions.width,
            blocks: Vec::new(),
        }
    }

    /// Add another component.
    /// New component `draw` is called with remaining dimensions.
    pub fn draw(&mut self, component: &dyn Component, mode: DrawMode) -> anyhow::Result<()> {
        // We call `draw` even if no space is left, but maybe we should not.
        let output = component.draw(
            Dimensions {
                width: self.rem_width,
                height: self.dim.height,
            },
            mode,
        )?;
        self.rem_width = self.rem_width.saturating_sub(output.max_line_length());
        self.blocks.push(output);
        Ok(())
    }

    /// Finish rendering, return the result.
    pub fn finish(self) -> Lines {
        let mut lines = Lines::join_horizontally(self.blocks);
        // This should be no-op, but just in case.
        lines.shrink_lines_to_dimensions(self.dim);
        lines
    }
}

#[cfg(test)]
mod tests {

    use crate::components::draw_horizontal::DrawHorizontal;
    use crate::Component;
    use crate::Dimensions;
    use crate::DrawMode;
    use crate::Line;
    use crate::Lines;

    #[test]
    fn test_draw_horizontal() {
        #[derive(Debug)]
        struct C0;
        #[derive(Debug)]
        struct C1;

        impl Component for C0 {
            fn draw_unchecked(
                &self,

                dimensions: Dimensions,
                _mode: DrawMode,
            ) -> anyhow::Result<Lines> {
                assert_eq!(
                    Dimensions {
                        width: 50,
                        height: 10,
                    },
                    dimensions
                );
                Ok(Lines(vec![
                    Line::sanitized("quick"),
                    Line::sanitized("fox"),
                    Line::sanitized("over"),
                ]))
            }
        }

        impl Component for C1 {
            fn draw_unchecked(
                &self,

                dimensions: Dimensions,
                _mode: DrawMode,
            ) -> anyhow::Result<Lines> {
                assert_eq!(
                    Dimensions {
                        width: 45,
                        height: 10,
                    },
                    dimensions
                );
                Ok(Lines(vec![
                    Line::sanitized("brown"),
                    Line::sanitized("jumped"),
                ]))
            }
        }

        let mut draw = DrawHorizontal::new(Dimensions {
            width: 50,
            height: 10,
        });
        draw.draw(&C0, DrawMode::Normal).unwrap();
        draw.draw(&C1, DrawMode::Normal).unwrap();
        assert_eq!(
            Lines(vec![
                Line::sanitized("quickbrown "),
                Line::sanitized("fox  jumped"),
                Line::sanitized("over       "),
            ]),
            draw.finish(),
        );
    }
}