console_engine 2.6.1

A simple terminal framework to draw things and manage user input
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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
use crossterm::event::{KeyCode, KeyEvent, KeyEventKind, KeyModifiers};

use crate::{events::Event, pixel, screen::Screen};

use super::{FormField, FormOptions, FormValidationResult, FormValue};

/// Generic text input
///
/// This form field generates a generic text input, that handles keyboard input (moving cursor, backspacing / deleting, home / end)
/// This field is inactive by default, you need to set it active once created
///
/// Outputs `FormValue::String`
///
/// see example `form-input` for basic usage
pub struct Text {
    screen: Screen,
    dirty: bool,
    active: bool,
    input_buffer: String,
    cursor_pos: usize,
    options: FormOptions,
}

impl Text {
    pub fn new(w: u32, options: FormOptions) -> Self {
        Self {
            screen: Screen::new(w, 1),
            dirty: true,
            active: false,
            input_buffer: String::new(),
            cursor_pos: 0,
            options,
        }
    }

    /// Sets a specific value inside the field
    pub fn set_input_buffer(&mut self, input: &str) {
        self.dirty = true;
        self.input_buffer = String::from(input);
        self.move_cursor(i32::MAX);
    }

    /// Clear the field
    pub fn clear_input_buffer(&mut self) {
        self.dirty = true;
        self.input_buffer = String::new();
        self.cursor_pos = 0;
    }

    /// Insert a character at the position of the cursor
    pub fn put_char(&mut self, chr: char) {
        let mut new_buffer = String::with_capacity(self.input_buffer.capacity() + 1);
        new_buffer.extend(
            self.input_buffer
                .chars()
                .take(self.cursor_pos)
                .chain(std::iter::once(chr))
                .chain(self.input_buffer.chars().skip(self.cursor_pos)),
        );
        self.input_buffer = new_buffer;
        self.move_cursor(1);
    }

    /// Removes a certain amount of characters either on the left (positive) or right (negative) side of the cursor
    pub fn remove_char(&mut self, amount: i32) {
        if amount == 0 {
            return;
        }
        self.dirty = true;
        let off_l = amount.max(0) as usize; // offset to the left from cursor, `positive` or 0
        let off_r = amount.min(0).unsigned_abs() as usize; // offset to the right from cursor,  `-negative` or 0
        let pos_l = self.cursor_pos.saturating_sub(off_l);
        let pos_r = self
            .cursor_pos
            .saturating_add(off_r)
            .min(self.input_buffer.len());
        self.input_buffer = self.input_buffer.chars().take(pos_l).collect::<String>()
            + &self.input_buffer.chars().skip(pos_r).collect::<String>(); // this skips the cursor +/- offsets
        self.move_cursor(-amount.max(0));
    }

    /// Moves the cursor left (negative) or right (positive)
    ///
    /// The cursor is clamped at its boundaries
    pub fn move_cursor(&mut self, amount: i32) {
        self.dirty = true;
        self.cursor_pos = (self.cursor_pos as i64 + amount as i64)
            .clamp(0, self.input_buffer.len() as i64) as usize;
    }
}

impl FormField for Text {
    fn make(w: u32, options: FormOptions) -> Self
    where
        Self: Sized,
    {
        Self::new(w, options)
    }

    fn reset(&mut self) {
        self.clear_input_buffer();
    }

    fn get_width(&self) -> u32 {
        self.screen.get_width()
    }

    fn get_height(&self) -> u32 {
        self.screen.get_height()
    }

    fn resize(&mut self, w: u32, _h: u32) {
        self.dirty = true;
        self.screen.resize(w, 1);
    }

    fn handle_event(&mut self, event: Event) {
        if !self.active {
            return;
        }
        if let Event::Key(KeyEvent {
            code,
            modifiers,
            kind: KeyEventKind::Press,
            state: _,
        }) = event
        {
            match code {
                KeyCode::Backspace => self.remove_char(1),
                KeyCode::Delete => self.remove_char(-1),
                KeyCode::Left => self.move_cursor(-1),
                KeyCode::Right => self.move_cursor(1),
                KeyCode::Home => self.move_cursor(i32::MIN),
                KeyCode::End => self.move_cursor(i32::MAX),
                KeyCode::Char(c) => {
                    if modifiers.is_empty()
                        || modifiers == KeyModifiers::CONTROL | KeyModifiers::ALT
                    {
                        self.put_char(c);
                    }
                    if modifiers == KeyModifiers::SHIFT {
                        // I don't understand why it works this way but not the other
                        if c.is_ascii_uppercase() {
                            self.put_char(c.to_ascii_uppercase());
                        } else {
                            self.put_char(c.to_ascii_lowercase());
                        }
                    }
                }
                _ => {}
            }
        }
    }

    fn set_active(&mut self, active: bool) {
        self.active = active;
    }

    fn is_active(&self) -> bool {
        self.active
    }

    fn validate(&self, validation_result: &mut FormValidationResult) {
        self.self_validate(validation_result);
    }

    fn get_output(&self) -> FormValue {
        FormValue::String(self.input_buffer.to_string())
    }

    fn set_options(&mut self, options: FormOptions) {
        self.options = options
    }

    fn get_options(&self) -> &FormOptions {
        &self.options
    }

    fn draw(&mut self, tick: usize) -> &Screen {
        if self.dirty {
            self.screen.fill(pixel::pxl_fbg(
                ' ',
                self.options.style.fg,
                self.options.style.bg,
            ));
            self.screen.print_fbg(
                if self.cursor_pos >= self.screen.get_width() as usize {
                    -((self.cursor_pos - self.screen.get_width() as usize) as i32) - 1
                } else {
                    0
                },
                0,
                &self.input_buffer,
                self.options.style.fg,
                self.options.style.bg,
            );
            self.dirty = false;
        }
        let current_cursor_pos =
            std::cmp::min(self.cursor_pos as i32, self.screen.get_width() as i32 - 1);
        if let Ok(mut cursor_pxl) = self.screen.get_pxl(current_cursor_pos, 0) {
            if self.active && tick % 2 == 0 {
                cursor_pxl.bg = self.options.style.fg;
                cursor_pxl.fg = self.options.style.bg;
            } else {
                cursor_pxl.bg = self.options.style.bg;
                cursor_pxl.fg = self.options.style.fg;
            }
            self.screen.set_pxl(current_cursor_pos, 0, cursor_pxl);
        }
        &self.screen
    }
}

/// Hidden text input
///
/// This form field generates a generic text input, that'll hide what the user writes in it. (e.g. for passwords)
/// This field is inactive by default, you need to set it active once created
///
/// Outputs `FormValue::String`
///
/// see example `form-input` for basic usage
pub struct HiddenText {
    screen: Screen,
    dirty: bool,
    active: bool,
    hide_character: char,
    input_buffer: String,
    cursor_pos: usize,
    options: FormOptions,
}

impl HiddenText {
    pub fn new(w: u32, hide_character: char, options: FormOptions) -> Self {
        Self {
            screen: Screen::new(w, 1),
            dirty: true,
            active: false,
            hide_character,
            input_buffer: String::new(),
            cursor_pos: 0,
            options,
        }
    }

    pub fn set_input_buffer(&mut self, input: &str) {
        self.dirty = true;
        self.input_buffer = String::from(input);
        self.move_cursor(i32::MAX);
    }

    pub fn clear_input_buffer(&mut self) {
        self.dirty = true;
        self.input_buffer = String::new();
        self.cursor_pos = 0;
    }

    /// Insert a character at the position of the cursor
    pub fn put_char(&mut self, chr: char) {
        let mut new_buffer = String::with_capacity(self.input_buffer.capacity() + 1);
        new_buffer.extend(
            self.input_buffer
                .chars()
                .take(self.cursor_pos)
                .chain(std::iter::once(chr))
                .chain(self.input_buffer.chars().skip(self.cursor_pos)),
        );
        self.input_buffer = new_buffer;
        self.move_cursor(1);
    }

    /// Removes a certain amount of characters either on the left (positive) or right (negative) side of the cursor
    pub fn remove_char(&mut self, amount: i32) {
        if amount == 0 {
            return;
        }
        self.dirty = true;
        let off_l = amount.max(0) as usize; // offset to the left from cursor, `positive` or 0
        let off_r = amount.min(0).unsigned_abs() as usize; // offset to the right from cursor,  `-negative` or 0
        let pos_l = self.cursor_pos.saturating_sub(off_l);
        let pos_r = self
            .cursor_pos
            .saturating_add(off_r)
            .min(self.input_buffer.len());
        self.input_buffer = self.input_buffer.chars().take(pos_l).collect::<String>()
            + &self.input_buffer.chars().skip(pos_r).collect::<String>(); // this skips the cursor +/- offsets
        self.move_cursor(-amount.max(0));
    }

    pub fn move_cursor(&mut self, amount: i32) {
        self.dirty = true;
        self.cursor_pos = (self.cursor_pos as i64 + amount as i64)
            .clamp(0, self.input_buffer.len() as i64) as usize;
    }
}

impl FormField for HiddenText {
    fn make(w: u32, options: FormOptions) -> Self
    where
        Self: Sized,
    {
        Self::new(w, '*', options)
    }

    fn reset(&mut self) {
        self.clear_input_buffer();
    }

    fn get_width(&self) -> u32 {
        self.screen.get_width()
    }

    fn get_height(&self) -> u32 {
        self.screen.get_height()
    }

    fn resize(&mut self, w: u32, _h: u32) {
        self.dirty = true;
        self.screen.resize(w, 1);
    }

    fn handle_event(&mut self, event: Event) {
        if !self.active {
            return;
        }
        if let Event::Key(KeyEvent {
            code,
            modifiers,
            kind: KeyEventKind::Press,
            state: _,
        }) = event
        {
            match code {
                KeyCode::Backspace => self.remove_char(1),
                KeyCode::Delete => self.remove_char(-1),
                KeyCode::Left => self.move_cursor(-1),
                KeyCode::Right => self.move_cursor(1),
                KeyCode::Home => self.move_cursor(i32::MIN),
                KeyCode::End => self.move_cursor(i32::MAX),
                KeyCode::Char(c) => {
                    if modifiers.is_empty()
                        || modifiers == KeyModifiers::CONTROL | KeyModifiers::ALT
                    {
                        self.put_char(c);
                    }
                    if modifiers == KeyModifiers::SHIFT {
                        // I don't understand why it works this way but not the other
                        if c.is_ascii_uppercase() {
                            self.put_char(c.to_ascii_uppercase());
                        } else {
                            self.put_char(c.to_ascii_lowercase());
                        }
                    }
                }
                _ => {}
            }
        }
    }

    fn set_active(&mut self, active: bool) {
        self.active = active;
    }

    fn is_active(&self) -> bool {
        self.active
    }

    fn validate(&self, validation_result: &mut FormValidationResult) {
        self.self_validate(validation_result);
    }

    fn get_output(&self) -> FormValue {
        FormValue::String(self.input_buffer.to_string())
    }

    fn set_options(&mut self, options: FormOptions) {
        self.options = options
    }

    fn get_options(&self) -> &FormOptions {
        &self.options
    }

    fn draw(&mut self, tick: usize) -> &Screen {
        if self.dirty {
            self.screen.fill(pixel::pxl_fbg(
                ' ',
                self.options.style.fg,
                self.options.style.bg,
            ));
            if !self.input_buffer.is_empty() {
                self.screen.h_line(
                    if self.cursor_pos >= self.screen.get_width() as usize {
                        -((self.cursor_pos - self.screen.get_width() as usize) as i32) - 1
                    } else {
                        0
                    },
                    0,
                    self.input_buffer.len() as i32 - 1,
                    pixel::pxl_fbg(
                        self.hide_character,
                        self.options.style.fg,
                        self.options.style.bg,
                    ),
                );
            }
            self.dirty = false;
        }
        let current_cursor_pos =
            std::cmp::min(self.cursor_pos as i32, self.screen.get_width() as i32 - 1);
        if let Ok(mut cursor_pxl) = self.screen.get_pxl(current_cursor_pos, 0) {
            if self.active && tick % 2 == 0 {
                cursor_pxl.bg = self.options.style.fg;
                cursor_pxl.fg = self.options.style.bg;
            } else {
                cursor_pxl.bg = self.options.style.bg;
                cursor_pxl.fg = self.options.style.fg;
            }
            self.screen.set_pxl(current_cursor_pos, 0, cursor_pxl);
        }
        &self.screen
    }
}