r3bl_tui 0.7.7

TUI library to build modern apps inspired by React, Elm, with Flexbox, CSS, editor component, emoji support, and more
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

// Copyright (c) 2024-2025 R3BL LLC. Licensed under Apache License, Version 2.0.

#[cfg(test)]
pub mod mock_real_objects_for_editor {
    use crate::{DefaultSize, EditorEngine, FlexBox, GlobalData, OffscreenBufferPool,
                OutputDevice, OutputDeviceExt, PartialFlexBox, Size, SpinnerHelper, col,
                core::test_fixtures::StdoutMock, height, row,
                telemetry::telemetry_sizing::TelemetryReportLineStorage, width};
    use std::{collections::HashMap, fmt::Debug};
    use tokio::sync::mpsc;

    #[must_use]
    pub fn make_global_data<S, AS>(
        window_size: Option<Size>,
    ) -> (GlobalData<S, AS>, StdoutMock)
    where
        S: Debug + Default + Clone + Sync + Send,
        AS: Debug + Default + Clone + Sync + Send,
    {
        let (sender, _) =
            mpsc::channel::<_>(DefaultSize::MainThreadSignalChannelBufferSize.into());
        let (output_device, stdout_mock) = OutputDevice::new_mock();
        let offscreen_buffer_pool =
            OffscreenBufferPool::new(window_size.unwrap_or_default());

        let global_data = GlobalData {
            window_size: window_size.unwrap_or_default(),
            maybe_saved_ofs_buf: Option::default(),
            main_thread_channel_sender: sender,
            state: Default::default(),
            output_device,
            offscreen_buffer_pool,
            hud_report: TelemetryReportLineStorage::new(),
            spinner_helper: SpinnerHelper::default(),
            memoized_text_widths: HashMap::new(),
        };

        (global_data, stdout_mock)
    }

    #[must_use]
    pub fn make_editor_engine_with_bounds(size: Size) -> EditorEngine {
        let flex_box = FlexBox {
            style_adjusted_bounds_size: size,
            style_adjusted_origin_pos: col(0) + row(0),
            ..Default::default()
        };
        let current_box: PartialFlexBox = (&flex_box).into();
        EditorEngine {
            current_box,
            ..Default::default()
        }
    }

    #[must_use]
    pub fn make_editor_engine() -> EditorEngine {
        let flex_box = FlexBox {
            style_adjusted_bounds_size: width(10) + height(10),
            style_adjusted_origin_pos: col(0) + row(0),
            ..Default::default()
        };
        let current_box: PartialFlexBox = (&flex_box).into();
        EditorEngine {
            current_box,
            ..Default::default()
        }
    }
}

#[cfg(test)]
pub mod assert {
    use crate::{EditorBuffer, SegStringOwned, assert_eq2,
                editor_engine::engine_internal_api};

    pub fn none_is_at_caret(buffer: &EditorBuffer) {
        assert_eq2!(buffer.string_at_caret(), None);
    }

    /// # Panics
    ///
    /// This test fixture function will panic if the string at the caret
    /// does not match the expected string.
    pub fn str_is_at_caret(buffer: &EditorBuffer, expected: &str) {
        match buffer.string_at_caret() {
            Some(SegStringOwned { string, .. }) => {
                assert_eq2!(&string.string, expected);
            }
            None => panic!("Expected string at caret, but got None."),
        }
    }

    /// # Panics
    ///
    /// This test fixture function will panic if the line at the caret
    /// does not match the expected string.
    pub fn line_at_caret(editor_buffer: &EditorBuffer, expected: &str) {
        assert_eq2!(
            engine_internal_api::line_at_caret_to_string(editor_buffer)
                .unwrap()
                .content(),
            expected
        );
    }
}