shpool-vterm 0.2.1

An in-memory terminal to support session restore in shpool.
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269

#[macro_use]
#[path = "support/mod.rs"]
mod support;

use shpool_vterm::{term, ContentRegion};
use smallvec::smallvec;

frag! {
    title_only { scrollback_lines: 10, width: 10, height: 10 }
    <= term::ControlCodes::set_title(smallvec![b't', b'i', b't', b'l', b'e'])
    => ContentRegion::All =>
            term::control_codes().clear_attrs,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_screen,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_attrs,
            term::ControlCodes::set_title(smallvec![b't', b'i', b't', b'l', b'e'])
}

frag! {
    icon_only { scrollback_lines: 10, width: 10, height: 10 }
    <= term::ControlCodes::set_icon_name(smallvec![b'i', b'c', b'o', b'n'])
    => ContentRegion::All =>
            term::control_codes().clear_attrs,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_screen,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_attrs,
            term::ControlCodes::set_icon_name(smallvec![b'i', b'c', b'o', b'n'])
}

frag! {
    title_and_icon_same { scrollback_lines: 10, width: 10, height: 10 }
    <= term::ControlCodes::set_title_and_icon_name(smallvec![b's', b'a', b'm', b'e'])
    => ContentRegion::All =>
            term::control_codes().clear_attrs,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_screen,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_attrs,
            term::ControlCodes::set_title_and_icon_name(smallvec![b's', b'a', b'm', b'e'])
}

frag! {
    title_and_icon_diff { scrollback_lines: 10, width: 10, height: 10 }
    <= term::ControlCodes::set_title_and_icon_name(smallvec![b'A']),
       term::ControlCodes::set_title(smallvec![b'B'])
    => ContentRegion::All =>
            term::control_codes().clear_attrs,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_screen,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_attrs,
            term::ControlCodes::set_title(smallvec![b'B']),
            term::ControlCodes::set_icon_name(smallvec![b'A'])
}

frag! {
    title_push_pop_basic { scrollback_lines: 10, width: 10, height: 10 }
    <= term::ControlCodes::set_title(smallvec![b'A']),
       term::ControlCodes::save_title(Some(2)),
       term::ControlCodes::set_title(smallvec![b'B']),
       term::ControlCodes::restore_title(Some(2))
    => ContentRegion::All =>
            term::control_codes().clear_attrs,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_screen,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_attrs,
            term::ControlCodes::set_title(smallvec![b'A'])
}

frag! {
    icon_push_pop_basic { scrollback_lines: 10, width: 10, height: 10 }
    <= term::ControlCodes::set_icon_name(smallvec![b'A']),
       term::ControlCodes::save_title(Some(1)),
       term::ControlCodes::set_icon_name(smallvec![b'B']),
       term::ControlCodes::restore_title(Some(1))
    => ContentRegion::All =>
            term::control_codes().clear_attrs,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_screen,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_attrs,
            term::ControlCodes::set_icon_name(smallvec![b'A'])
}

frag! {
    title_and_icon_push_pop { scrollback_lines: 10, width: 10, height: 10 }
    <= term::ControlCodes::set_title_and_icon_name(smallvec![b'A']),
       term::ControlCodes::save_title(Some(0)),
       term::ControlCodes::set_title_and_icon_name(smallvec![b'B']),
       term::ControlCodes::restore_title(Some(0))
    => ContentRegion::All =>
            term::control_codes().clear_attrs,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_screen,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_attrs,
            term::ControlCodes::set_title_and_icon_name(smallvec![b'A'])
}

frag! {
    title_and_icon_push_pop_default_param { scrollback_lines: 10, width: 10, height: 10 }
    <= term::ControlCodes::set_title_and_icon_name(smallvec![b'A']),
       term::ControlCodes::save_title(None),
       term::ControlCodes::set_title_and_icon_name(smallvec![b'B']),
       term::ControlCodes::restore_title(None)
    => ContentRegion::All =>
            term::control_codes().clear_attrs,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_screen,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_attrs,
            term::ControlCodes::set_title_and_icon_name(smallvec![b'A'])
}

frag! {
    title_push_pop_multiple_levels { scrollback_lines: 10, width: 10, height: 10 }
    <= term::ControlCodes::set_title(smallvec![b'A']),
       term::ControlCodes::save_title(Some(2)),
       term::ControlCodes::set_title(smallvec![b'B']),
       term::ControlCodes::save_title(Some(2)),
       term::ControlCodes::set_title(smallvec![b'C']),
       term::ControlCodes::restore_title(Some(2))
    => ContentRegion::All =>
            term::control_codes().clear_attrs,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_screen,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_attrs,
            term::ControlCodes::set_title(smallvec![b'B'])
}

frag! {
    title_push_pop_stack_isolation { scrollback_lines: 10, width: 10, height: 10 }
    <= term::ControlCodes::set_title(smallvec![b'A']),
       term::ControlCodes::set_icon_name(smallvec![b'1']),
       term::ControlCodes::save_title(Some(2)),
       term::ControlCodes::set_title(smallvec![b'B']),
       term::ControlCodes::set_icon_name(smallvec![b'2']),
       term::ControlCodes::restore_title(Some(2))
    => ContentRegion::All =>
            term::control_codes().clear_attrs,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_screen,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_attrs,
            term::ControlCodes::set_title(smallvec![b'A']),
            term::ControlCodes::set_icon_name(smallvec![b'2'])
}

frag! {
    icon_push_pop_stack_isolation { scrollback_lines: 10, width: 10, height: 10 }
    <= term::ControlCodes::set_title(smallvec![b'A']),
       term::ControlCodes::set_icon_name(smallvec![b'1']),
       term::ControlCodes::save_title(Some(1)),
       term::ControlCodes::set_title(smallvec![b'B']),
       term::ControlCodes::set_icon_name(smallvec![b'2']),
       term::ControlCodes::restore_title(Some(1))
    => ContentRegion::All =>
            term::control_codes().clear_attrs,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_screen,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_attrs,
            term::ControlCodes::set_title(smallvec![b'B']),
            term::ControlCodes::set_icon_name(smallvec![b'1'])
}

frag! {
    title_pop_empty_stack { scrollback_lines: 10, width: 10, height: 10 }
    <= term::ControlCodes::restore_title(None),
       term::ControlCodes::set_title(smallvec![b'A'])
    => ContentRegion::All =>
            term::control_codes().clear_attrs,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_screen,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_attrs,
            term::ControlCodes::set_title(smallvec![b'A'])
}

frag! {
    title_push_empty_stack { scrollback_lines: 10, width: 10, height: 10 }
    <= term::ControlCodes::save_title(None),
       term::ControlCodes::set_title(smallvec![b'A']),
       term::ControlCodes::restore_title(None)
    => ContentRegion::All =>
            term::control_codes().clear_attrs,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_screen,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_attrs
}

frag! {
    dimension_queries_ignored { scrollback_lines: 10, width: 10, height: 10 }
    <= term::Raw::from("\x1b[14t\x1b[16t\x1b[18t\x1b[19t"),
       term::ControlCodes::set_title(smallvec![b'A'])
    => ContentRegion::All =>
            term::control_codes().clear_attrs,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_screen,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_attrs,
            term::ControlCodes::set_title(smallvec![b'A'])
}

#[test]
fn title_stack_depth_limit() {
    use shpool_vterm::term::AsTermInput;

    let mut term = shpool_vterm::Term::new(10, shpool_vterm::Size { width: 10, height: 10 });

    // Set initial title A
    term.process(b"\x1b]2;A\x1b\\");

    // Push 20 times (exceeding MAX_TITLE_STACK_DEPTH = 16)
    for _ in 0..20 {
        term.process(b"\x1b[22;2t");
    }

    // Set title B
    term.process(b"\x1b]2;B\x1b\\");

    // Pop once -> should restore A
    term.process(b"\x1b[23;2t");

    let mut want = vec![];
    term::control_codes().clear_attrs.term_input_into(&mut want);
    term::ControlCodes::cursor_position(1, 1).term_input_into(&mut want);
    term::control_codes().clear_screen.term_input_into(&mut want);
    term::ControlCodes::cursor_position(1, 1).term_input_into(&mut want);
    term::control_codes().clear_attrs.term_input_into(&mut want);
    term::ControlCodes::set_title(smallvec![b'A']).term_input_into(&mut want);

    assert_eq!(term.contents(ContentRegion::All), want);
}

frag! {
    title_push_empty_stack_title_only { scrollback_lines: 10, width: 10, height: 10 }
    <= term::ControlCodes::save_title(Some(2)),
       term::ControlCodes::set_title(smallvec![b'A']),
       term::ControlCodes::set_icon_name(smallvec![b'B']),
       term::ControlCodes::restore_title(Some(2))
    => ContentRegion::All =>
            term::control_codes().clear_attrs,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_screen,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_attrs,
            term::ControlCodes::set_icon_name(smallvec![b'B'])
}

frag! {
    icon_push_empty_stack_icon_only { scrollback_lines: 10, width: 10, height: 10 }
    <= term::ControlCodes::save_title(Some(1)),
       term::ControlCodes::set_title(smallvec![b'A']),
       term::ControlCodes::set_icon_name(smallvec![b'B']),
       term::ControlCodes::restore_title(Some(1))
    => ContentRegion::All =>
            term::control_codes().clear_attrs,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_screen,
            term::ControlCodes::cursor_position(1, 1),
            term::control_codes().clear_attrs,
            term::ControlCodes::set_title(smallvec![b'A'])
}