r3bl_tui 0.7.2

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
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

/*
 *   Copyright (c) 2022-2025 R3BL LLC
 *   All rights reserved.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */

#[cfg(test)]
mod tests {
    use crossterm::event::{KeyCode, KeyModifiers};

    use crate::{assert_eq2, crossterm_keyevent, key_press, throws, FunctionKey, Key,
                KeyPress, ModifierKeysMask, SpecialKey};

    #[test]
    fn test_keypress_character_key() {
        // No modifier.
        {
            let macro_syntax = key_press! { @char 'a' };
            let struct_syntax = KeyPress::Plain {
                key: Key::Character('a'),
            };
            assert_eq2!(macro_syntax, struct_syntax);
        }

        // With modifier.
        {
            let macro_syntax = key_press! { @char ModifierKeysMask::new().with_shift().with_ctrl(), 'a' };
            let struct_syntax = KeyPress::WithModifiers {
                key: Key::Character('a'),
                mask: ModifierKeysMask::new().with_shift().with_ctrl(),
            };
            assert_eq2!(macro_syntax, struct_syntax);
        }
    }

    #[test]
    fn test_keypress_special_key() {
        // No modifier.
        {
            let macro_syntax = key_press! { @special SpecialKey::Left };
            let struct_syntax = KeyPress::Plain {
                key: Key::SpecialKey(SpecialKey::Left),
            };
            assert_eq2!(macro_syntax, struct_syntax);
        }
        // With modifier.
        {
            let macro_syntax = key_press! { @special ModifierKeysMask::new().with_alt().with_ctrl(), SpecialKey::Left };
            let struct_syntax = KeyPress::WithModifiers {
                key: Key::SpecialKey(SpecialKey::Left),
                mask: ModifierKeysMask::new().with_alt().with_ctrl(),
            };
            assert_eq2!(macro_syntax, struct_syntax);
        }
    }

    #[test]
    fn test_keypress_function_key() {
        // No modifier.
        {
            let macro_syntax = key_press! { @fn FunctionKey::F1 };
            let struct_syntax = KeyPress::Plain {
                key: Key::FunctionKey(FunctionKey::F1),
            };
            assert_eq2!(macro_syntax, struct_syntax);
        }
        // With modifier.
        {
            let macro_syntax =
                key_press! { @fn ModifierKeysMask::new().with_shift(), FunctionKey::F1 };
            let struct_syntax = KeyPress::WithModifiers {
                key: Key::FunctionKey(FunctionKey::F1),
                mask: ModifierKeysMask::new().with_shift(),
            };
            assert_eq2!(macro_syntax, struct_syntax);
        }
    }

    #[test]
    #[allow(clippy::missing_errors_doc)]
    fn test_keypress() -> Result<(), ()> {
        throws!({
            // "x"
            {
                let key_event = crossterm_keyevent!(code: KeyCode::Char('x'), modifiers: KeyModifiers::NONE);
                let keypress: KeyPress = key_event.try_into()?;
                assert_eq2!(
                    keypress,
                    KeyPress::Plain {
                        key: Key::Character('x'),
                    }
                );
            }

            // "Ctrl + x"
            {
                let key_event = crossterm_keyevent!(code: KeyCode::Char('x'), modifiers: KeyModifiers::CONTROL);
                let converted_keypress: KeyPress = key_event.try_into()?;
                assert_eq2!(
                    converted_keypress,
                    KeyPress::WithModifiers {
                        mask: ModifierKeysMask::new().with_ctrl(),
                        key: Key::Character('x'),
                    }
                );
            }

            // "Ctrl + Alt + x"
            {
                let key_event = crossterm_keyevent!(
                  code: KeyCode::Char('x'),
                  modifiers: KeyModifiers::CONTROL | KeyModifiers::ALT
                );
                let converted_keypress: KeyPress = key_event.try_into()?;
                assert_eq2!(
                    converted_keypress,
                    KeyPress::WithModifiers {
                        mask: ModifierKeysMask::new().with_alt().with_ctrl(),
                        key: Key::Character('x'),
                    }
                );
            }
        });
    }
}