rustyline/tty/
mod.rs

1//! This module implements and describes common TTY methods & traits
2
3use unicode_width::UnicodeWidthStr;
4
5use crate::config::{Behavior, BellStyle, ColorMode, Config};
6use crate::highlight::Highlighter;
7use crate::keys::KeyEvent;
8use crate::layout::{Layout, Position};
9use crate::line_buffer::LineBuffer;
10use crate::{Cmd, Result};
11
12/// Terminal state
13pub trait RawMode: Sized {
14    /// Disable RAW mode for the terminal.
15    fn disable_raw_mode(&self) -> Result<()>;
16}
17
18/// Input event
19pub enum Event {
20    KeyPress(KeyEvent),
21    ExternalPrint(String),
22}
23
24/// Translate bytes read from stdin to keys.
25pub trait RawReader {
26    type Buffer;
27    /// Blocking wait for either a key press or an external print
28    fn wait_for_input(&mut self, single_esc_abort: bool) -> Result<Event>; // TODO replace calls to `next_key` by `wait_for_input` where relevant
29    /// Blocking read of key pressed.
30    fn next_key(&mut self, single_esc_abort: bool) -> Result<KeyEvent>;
31    /// For CTRL-V support
32    #[cfg(unix)]
33    fn next_char(&mut self) -> Result<char>;
34    /// Bracketed paste
35    fn read_pasted_text(&mut self) -> Result<String>;
36    /// Check if `key` is bound to a peculiar command
37    fn find_binding(&self, key: &KeyEvent) -> Option<Cmd>;
38    /// Backup type ahead
39    fn unbuffer(self) -> Option<Buffer>;
40}
41
42/// Display prompt, line and cursor in terminal output
43pub trait Renderer {
44    type Reader: RawReader;
45
46    fn move_cursor(&mut self, old: Position, new: Position) -> Result<()>;
47
48    /// Display `prompt`, line and cursor in terminal output
49    fn refresh_line(
50        &mut self,
51        prompt: &str,
52        line: &LineBuffer,
53        hint: Option<&str>,
54        old_layout: &Layout,
55        new_layout: &Layout,
56        highlighter: Option<&dyn Highlighter>,
57    ) -> Result<()>;
58
59    /// Compute layout for rendering prompt + line + some info (either hint,
60    /// validation msg, ...). on the screen. Depending on screen width, line
61    /// wrapping may be applied.
62    fn compute_layout(
63        &self,
64        prompt_size: Position,
65        default_prompt: bool,
66        line: &LineBuffer,
67        info: Option<&str>,
68    ) -> Layout {
69        // calculate the desired position of the cursor
70        let pos = line.pos();
71        let cursor = self.calculate_position(&line[..pos], prompt_size);
72        // calculate the position of the end of the input line
73        let mut end = if pos == line.len() {
74            cursor
75        } else {
76            self.calculate_position(&line[pos..], cursor)
77        };
78        if let Some(info) = info {
79            end = self.calculate_position(info, end);
80        }
81
82        let new_layout = Layout {
83            prompt_size,
84            default_prompt,
85            cursor,
86            end,
87        };
88        debug_assert!(new_layout.prompt_size <= new_layout.cursor);
89        debug_assert!(new_layout.cursor <= new_layout.end);
90        new_layout
91    }
92
93    /// Calculate the number of columns and rows used to display `s` on a
94    /// `cols` width terminal starting at `orig`.
95    fn calculate_position(&self, s: &str, orig: Position) -> Position;
96
97    fn write_and_flush(&mut self, buf: &str) -> Result<()>;
98
99    /// Beep, used for completion when there is nothing to complete or when all
100    /// the choices were already shown.
101    fn beep(&mut self) -> Result<()>;
102
103    /// Clear the screen. Used to handle ctrl+l
104    fn clear_screen(&mut self) -> Result<()>;
105    /// Clear rows used by prompt and edited line
106    fn clear_rows(&mut self, layout: &Layout) -> Result<()>;
107
108    /// Update the number of columns/rows in the current terminal.
109    fn update_size(&mut self);
110    /// Get the number of columns in the current terminal.
111    fn get_columns(&self) -> usize;
112    /// Get the number of rows in the current terminal.
113    fn get_rows(&self) -> usize;
114    /// Check if output supports colors.
115    fn colors_enabled(&self) -> bool;
116
117    /// Make sure prompt is at the leftmost edge of the screen
118    fn move_cursor_at_leftmost(&mut self, rdr: &mut Self::Reader) -> Result<()>;
119}
120
121// ignore ANSI escape sequence
122fn width(s: &str, esc_seq: &mut u8) -> usize {
123    if *esc_seq == 1 {
124        if s == "[" {
125            // CSI
126            *esc_seq = 2;
127        } else {
128            // two-character sequence
129            *esc_seq = 0;
130        }
131        0
132    } else if *esc_seq == 2 {
133        if s == ";" || (s.as_bytes()[0] >= b'0' && s.as_bytes()[0] <= b'9') {
134            /*} else if s == "m" {
135            // last
136             *esc_seq = 0;*/
137        } else {
138            // not supported
139            *esc_seq = 0;
140        }
141        0
142    } else if s == "\x1b" {
143        *esc_seq = 1;
144        0
145    } else if s == "\n" {
146        0
147    } else {
148        s.width()
149    }
150}
151
152/// External printer
153pub trait ExternalPrinter {
154    /// Print message to stdout
155    fn print(&mut self, msg: String) -> Result<()>;
156}
157
158/// Terminal contract
159pub trait Term {
160    type Buffer;
161    type KeyMap;
162    type Reader: RawReader<Buffer = Self::Buffer>; // rl_instream
163    type Writer: Renderer<Reader = Self::Reader>; // rl_outstream
164    type Mode: RawMode;
165    type ExternalPrinter: ExternalPrinter;
166    type CursorGuard;
167
168    fn new(
169        color_mode: ColorMode,
170        behavior: Behavior,
171        tab_stop: usize,
172        bell_style: BellStyle,
173        enable_bracketed_paste: bool,
174        enable_signals: bool,
175    ) -> Result<Self>
176    where
177        Self: Sized;
178    /// Check if current terminal can provide a rich line-editing user
179    /// interface.
180    fn is_unsupported(&self) -> bool;
181    /// check if input stream is connected to a terminal.
182    fn is_input_tty(&self) -> bool;
183    /// check if output stream is connected to a terminal.
184    fn is_output_tty(&self) -> bool;
185    /// Enable RAW mode for the terminal.
186    fn enable_raw_mode(&mut self) -> Result<(Self::Mode, Self::KeyMap)>;
187    /// Create a RAW reader
188    fn create_reader(
189        &self,
190        buffer: Option<Self::Buffer>,
191        config: &Config,
192        key_map: Self::KeyMap,
193    ) -> Self::Reader;
194    /// Create a writer
195    fn create_writer(&self) -> Self::Writer;
196    fn writeln(&self) -> Result<()>;
197    /// Create an external printer
198    fn create_external_printer(&mut self) -> Result<Self::ExternalPrinter>;
199    /// Change cursor visibility
200    fn set_cursor_visibility(&mut self, visible: bool) -> Result<Option<Self::CursorGuard>>;
201}
202
203// If on Windows platform import Windows TTY module
204// and re-export into mod.rs scope
205#[cfg(all(windows, not(target_arch = "wasm32")))]
206mod windows;
207#[cfg(all(windows, not(target_arch = "wasm32"), not(test)))]
208pub use self::windows::*;
209
210// If on Unix platform import Unix TTY module
211// and re-export into mod.rs scope
212#[cfg(all(unix, not(target_arch = "wasm32")))]
213mod unix;
214#[cfg(all(unix, not(target_arch = "wasm32"), not(test)))]
215pub use self::unix::*;
216
217#[cfg(any(test, target_arch = "wasm32"))]
218mod test;
219#[cfg(any(test, target_arch = "wasm32"))]
220pub use self::test::*;
rustyline/tty/mod.rs

rustyline/tty/
mod.rs
