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
use super::byte_prefix_tree::{BytePrefixTree, Found};
use super::low_level::LowLevel;
use super::term_info_cache::{MousePrefix, TermInfoCache, TerminalInput};
use crate::error::Result;
use chargrid_input::*;
use chargrid_render::*;
use std::collections::{vec_deque, VecDeque};
use term::terminfo::parm::{self, Param};

const OUTPUT_BUFFER_INITIAL_CAPACITY: usize = 32 * 1024;
const INPUT_BUFFER_INITIAL_CAPACITY: usize = 32;
const INPUT_RING_INITIAL_CAPACITY: usize = 32;

pub type DrainInput<'a> = vec_deque::Drain<'a, Input>;

pub struct AnsiTerminal {
    low_level: LowLevel,
    output_buffer: String,
    input_buffer: Vec<u8>,
    ti_cache: TermInfoCache,
    input_ring: VecDeque<Input>,
}

pub mod col_encode {
    use crate::terminal::ansi_colour_codes::{
        nearest_ansi_code, nearest_mean_greyscale_code, nearest_palette_code,
    };
    use crate::terminal::term_info_cache::TermInfoCache;
    use chargrid_render::Rgb24;

    pub trait Trait: Clone {
        fn encode_foreground(buffer: &mut String, rgb24: Rgb24, term_info_cache: &TermInfoCache);
        fn encode_background(buffer: &mut String, rgb24: Rgb24, term_info_cache: &TermInfoCache);
    }

    #[derive(Clone, Copy)]
    pub struct FromTermInfoRgb;
    impl Trait for FromTermInfoRgb {
        fn encode_foreground(buffer: &mut String, rgb24: Rgb24, term_info_cache: &TermInfoCache) {
            buffer.push_str(term_info_cache.fg_colour(nearest_palette_code(rgb24)));
        }
        fn encode_background(buffer: &mut String, rgb24: Rgb24, term_info_cache: &TermInfoCache) {
            buffer.push_str(term_info_cache.bg_colour(nearest_palette_code(rgb24)));
        }
    }

    #[derive(Clone, Copy)]
    pub struct FromTermInfoGreyscale;
    impl Trait for FromTermInfoGreyscale {
        fn encode_foreground(buffer: &mut String, rgb24: Rgb24, term_info_cache: &TermInfoCache) {
            buffer.push_str(term_info_cache.fg_colour(nearest_mean_greyscale_code(rgb24)));
        }
        fn encode_background(buffer: &mut String, rgb24: Rgb24, term_info_cache: &TermInfoCache) {
            buffer.push_str(term_info_cache.bg_colour(nearest_mean_greyscale_code(rgb24)));
        }
    }

    #[derive(Clone, Copy)]
    pub struct FromTermInfoAnsi16Colour;
    impl Trait for FromTermInfoAnsi16Colour {
        fn encode_foreground(buffer: &mut String, rgb24: Rgb24, term_info_cache: &TermInfoCache) {
            buffer.push_str(term_info_cache.fg_colour(nearest_ansi_code(rgb24)));
        }
        fn encode_background(buffer: &mut String, rgb24: Rgb24, term_info_cache: &TermInfoCache) {
            buffer.push_str(term_info_cache.bg_colour(nearest_ansi_code(rgb24)));
        }
    }

    #[derive(Clone, Copy)]
    pub struct NoColour;
    impl Trait for NoColour {
        fn encode_foreground(
            _buffer: &mut String,
            _rgb24: Rgb24,
            _term_info_cache: &TermInfoCache,
        ) {
        }
        fn encode_background(
            _buffer: &mut String,
            _rgb24: Rgb24,
            _term_info_cache: &TermInfoCache,
        ) {
        }
    }

    #[derive(Clone, Copy)]
    pub struct XtermTrueColour;
    impl Trait for XtermTrueColour {
        fn encode_foreground(
            buffer: &mut String,
            Rgb24 { r, g, b }: Rgb24,
            _term_info_cache: &TermInfoCache,
        ) {
            buffer.push_str(&format!("\x1B[38;2;{};{};{}m", r, g, b));
        }
        fn encode_background(
            buffer: &mut String,
            Rgb24 { r, g, b }: Rgb24,
            _term_info_cache: &TermInfoCache,
        ) {
            buffer.push_str(&format!("\x1B[48;2;{};{};{}m", r, g, b));
        }
    }
}

pub use self::col_encode::Trait as ColEncode;

impl AnsiTerminal {
    pub fn new() -> Result<Self> {
        let low_level = LowLevel::new()?;
        let output_buffer = String::with_capacity(OUTPUT_BUFFER_INITIAL_CAPACITY);
        let input_buffer = Vec::with_capacity(INPUT_BUFFER_INITIAL_CAPACITY);
        let ti_cache = TermInfoCache::new()?;
        let input_ring = VecDeque::with_capacity(INPUT_RING_INITIAL_CAPACITY);
        let mut terminal = Self {
            low_level,
            output_buffer,
            input_buffer,
            ti_cache,
            input_ring,
        };
        terminal.init()?;
        Ok(terminal)
    }

    fn init(&mut self) -> Result<()> {
        if let Some(enter_ca) = self.ti_cache.enter_ca.as_ref() {
            self.output_buffer.push_str(enter_ca);
        }
        if let Some(enter_xmit) = self.ti_cache.enter_xmit.as_ref() {
            self.output_buffer.push_str(enter_xmit);
        }
        self.output_buffer.push_str(&self.ti_cache.hide_cursor);
        self.output_buffer.push_str(&self.ti_cache.clear);
        self.output_buffer
            .push_str(&self.ti_cache.enable_mouse_reporting);
        self.flush_buffer().map_err(Into::into)
    }

    fn teardown(&mut self) -> Result<()> {
        self.output_buffer
            .push_str(&self.ti_cache.disable_mouse_reporting);
        if let Some(exit_ca) = self.ti_cache.exit_ca.as_ref() {
            self.output_buffer.push_str(exit_ca);
        }
        if let Some(exit_xmit) = self.ti_cache.exit_xmit.as_ref() {
            self.output_buffer.push_str(exit_xmit);
        }
        self.output_buffer.push_str(&self.ti_cache.show_cursor);
        self.output_buffer.push_str(&self.ti_cache.reset);
        self.flush_buffer().map_err(Into::into)
    }

    pub fn size(&self) -> Result<Size> {
        self.low_level.size()
    }

    pub fn set_cursor(&mut self, coord: Coord) -> Result<()> {
        let params = &[Param::Number(coord.y), Param::Number(coord.x)];
        let command = parm::expand(
            self.ti_cache.set_cursor.as_bytes(),
            params,
            &mut self.ti_cache.vars,
        )?;
        let command_slice = ::std::str::from_utf8(&command)?;
        self.output_buffer.push_str(command_slice);
        Ok(())
    }

    pub fn set_foreground_colour<E>(&mut self, rgb24: Rgb24)
    where
        E: ColEncode,
    {
        E::encode_foreground(&mut self.output_buffer, rgb24, &self.ti_cache);
    }

    pub fn set_background_colour<E>(&mut self, rgb24: Rgb24)
    where
        E: ColEncode,
    {
        E::encode_background(&mut self.output_buffer, rgb24, &self.ti_cache);
    }

    pub fn set_bold(&mut self) {
        self.output_buffer.push_str(&self.ti_cache.bold);
    }

    pub fn set_underline(&mut self) {
        self.output_buffer.push_str(&self.ti_cache.underline);
    }

    pub fn clear_underline(&mut self) {
        self.output_buffer.push_str(&self.ti_cache.no_underline);
    }

    pub fn reset(&mut self) {
        self.output_buffer.push_str(&self.ti_cache.reset);
    }

    pub fn drain_input(&mut self) -> Result<DrainInput> {
        self.low_level.read_polling(&mut self.input_buffer)?;
        self.drain_input_into_ring()?;
        Ok(self.input_ring.drain(..))
    }

    fn drain_input_into_ring(&mut self) -> Result<()> {
        Self::populate_input_ring(
            &mut self.input_ring,
            &self.ti_cache.escape_sequence_prefix_tree,
            &self.input_buffer,
        )?;
        self.input_buffer.clear();
        Ok(())
    }

    fn chip_char(s: &str) -> Option<(char, &str)> {
        let mut chars = s.chars();
        if let Some(first) = chars.next() {
            Some((first, chars.as_str()))
        } else {
            None
        }
    }

    fn populate_input_ring(
        input_ring: &mut VecDeque<Input>,
        prefix_tree: &BytePrefixTree<TerminalInput>,
        slice: &[u8],
    ) -> Result<()> {
        let (term_input, rest) = match prefix_tree.get_longest(slice) {
            None => {
                // slice does not begin with an escape sequence - chip off the start and try again
                let s = if let Ok(s) = ::std::str::from_utf8(&slice) {
                    s
                } else {
                    return Ok(());
                };
                if let Some((ch, rest)) = Self::chip_char(s) {
                    (Some(TerminalInput::Char(ch)), Some(rest.as_bytes()))
                } else {
                    (None, None)
                }
            }
            Some(Found::Exact(input)) => (Some(*input), None),
            Some(Found::WithRemaining(input, remaining)) => (Some(*input), Some(remaining)),
        };
        let rest = if let Some(input) = term_input {
            let (input, rest) = match input {
                TerminalInput::Char(ch) => (Some(Input::Keyboard(KeyboardInput::Char(ch))), rest),
                TerminalInput::Literal(input) => (Some(input), rest),
                TerminalInput::MousePrefix(prefix) => {
                    if let Some(rest) = rest {
                        if rest.len() >= 2 {
                            const COORD_OFFSET: i32 = 33;
                            let x = rest[0] as i32 - COORD_OFFSET;
                            let y = rest[1] as i32 - COORD_OFFSET;
                            let coord = Coord::new(x, y);
                            let input = match prefix {
                                MousePrefix::Move(button) => {
                                    Input::Mouse(MouseInput::MouseMove { button, coord })
                                }
                                MousePrefix::Press(button) => {
                                    Input::Mouse(MouseInput::MousePress { button, coord })
                                }
                                MousePrefix::Release => Input::Mouse(MouseInput::MouseRelease {
                                    button: Err(NotSupported),
                                    coord,
                                }),
                                MousePrefix::Scroll(direction) => {
                                    Input::Mouse(MouseInput::MouseScroll { direction, coord })
                                }
                            };
                            (Some(input), Some(&rest[2..]))
                        } else {
                            (None, Some(rest))
                        }
                    } else {
                        (None, None)
                    }
                }
            };
            if let Some(input) = input {
                input_ring.push_back(input);
            }
            rest
        } else {
            rest
        };

        if let Some(rest) = rest {
            Self::populate_input_ring(input_ring, prefix_tree, rest)?;
        }

        Ok(())
    }

    pub fn add_char_to_buffer(&mut self, ch: char) {
        self.output_buffer.push(ch);
    }

    pub fn flush_buffer(&mut self) -> Result<()> {
        self.low_level.send(&self.output_buffer)?;
        self.output_buffer.clear();
        Ok(())
    }
}

impl Drop for AnsiTerminal {
    fn drop(&mut self) {
        self.teardown()
            .expect("Failed to reset terminal to original settings");
    }
}