use std::cmp;
use std::io::{self, ErrorKind, Read, Write};
use std::os::unix::io::{AsRawFd, RawFd};
use std::sync;
use std::sync::atomic::{AtomicBool, Ordering};
use log::{debug, warn};
use nix::poll::{self, PollFlags};
use nix::sys::signal;
use nix::sys::termios;
use nix::sys::termios::{SetArg, SpecialCharacterIndices as SCI, Termios};
use unicode_segmentation::UnicodeSegmentation;
use utf8parse::{Parser, Receiver};
use super::{width, RawMode, RawReader, Renderer, Term};
use crate::config::{BellStyle, ColorMode, Config, OutputStreamType};
use crate::highlight::Highlighter;
use crate::keys::{KeyCode as K, KeyEvent, KeyEvent as E, Modifiers as M};
use crate::layout::{Layout, Position};
use crate::line_buffer::LineBuffer;
use crate::{error, Cmd, Result};
use std::collections::HashMap;
const STDIN_FILENO: RawFd = libc::STDIN_FILENO;
const UNSUPPORTED_TERM: [&str; 3] = ["dumb", "cons25", "emacs"];
const BRACKETED_PASTE_ON: &[u8] = b"\x1b[?2004h";
const BRACKETED_PASTE_OFF: &[u8] = b"\x1b[?2004l";
impl AsRawFd for OutputStreamType {
fn as_raw_fd(&self) -> RawFd {
match self {
OutputStreamType::Stdout => libc::STDOUT_FILENO,
OutputStreamType::Stderr => libc::STDERR_FILENO,
}
}
}
nix::ioctl_read_bad!(win_size, libc::TIOCGWINSZ, libc::winsize);
#[allow(clippy::useless_conversion)]
fn get_win_size<T: AsRawFd + ?Sized>(fileno: &T) -> (usize, usize) {
use std::mem::zeroed;
if cfg!(test) {
return (80, 24);
}
unsafe {
let mut size: libc::winsize = zeroed();
match win_size(fileno.as_raw_fd(), &mut size) {
Ok(0) => {
let cols = if size.ws_col == 0 {
80
} else {
size.ws_col as usize
};
let rows = if size.ws_row == 0 {
usize::MAX
} else {
size.ws_row as usize
};
(cols, rows)
}
_ => (80, 24),
}
}
}
fn is_unsupported_term() -> bool {
match std::env::var("TERM") {
Ok(term) => {
for iter in &UNSUPPORTED_TERM {
if (*iter).eq_ignore_ascii_case(&term) {
return true;
}
}
false
}
Err(_) => false,
}
}
fn is_a_tty(fd: RawFd) -> bool {
unsafe { libc::isatty(fd) != 0 }
}
pub type PosixKeyMap = HashMap<KeyEvent, Cmd>;
#[cfg(not(test))]
pub type KeyMap = PosixKeyMap;
#[must_use = "You must restore default mode (disable_raw_mode)"]
pub struct PosixMode {
termios: termios::Termios,
out: Option<OutputStreamType>,
}
#[cfg(not(test))]
pub type Mode = PosixMode;
impl RawMode for PosixMode {
fn disable_raw_mode(&self) -> Result<()> {
termios::tcsetattr(STDIN_FILENO, SetArg::TCSADRAIN, &self.termios)?;
if let Some(out) = self.out {
write_and_flush(out, BRACKETED_PASTE_OFF)?;
}
Ok(())
}
}
struct StdinRaw {}
impl Read for StdinRaw {
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
loop {
let res = unsafe {
libc::read(
STDIN_FILENO,
buf.as_mut_ptr() as *mut libc::c_void,
buf.len() as libc::size_t,
)
};
if res == -1 {
let error = io::Error::last_os_error();
if error.kind() != ErrorKind::Interrupted || SIGWINCH.load(Ordering::Relaxed) {
return Err(error);
}
} else {
#[allow(clippy::cast_sign_loss)]
return Ok(res as usize);
}
}
}
}
pub struct PosixRawReader {
stdin: StdinRaw,
timeout_ms: i32,
buf: [u8; 1],
parser: Parser,
receiver: Utf8,
key_map: PosixKeyMap,
}
struct Utf8 {
c: Option<char>,
valid: bool,
}
const UP: char = 'A'; const DOWN: char = 'B'; const RIGHT: char = 'C'; const LEFT: char = 'D'; const END: char = 'F'; const HOME: char = 'H'; const INSERT: char = '2'; const DELETE: char = '3'; const PAGE_UP: char = '5'; const PAGE_DOWN: char = '6';
const RXVT_HOME: char = '7';
const RXVT_END: char = '8';
const SHIFT: char = '2';
const ALT: char = '3';
const ALT_SHIFT: char = '4';
const CTRL: char = '5';
const CTRL_SHIFT: char = '6';
const CTRL_ALT: char = '7';
const CTRL_ALT_SHIFT: char = '8';
const RXVT_SHIFT: char = '$';
const RXVT_CTRL: char = '\x1e';
const RXVT_CTRL_SHIFT: char = '@';
impl PosixRawReader {
fn new(config: &Config, key_map: PosixKeyMap) -> Self {
Self {
stdin: StdinRaw {},
timeout_ms: config.keyseq_timeout(),
buf: [0; 1],
parser: Parser::new(),
receiver: Utf8 {
c: None,
valid: true,
},
key_map,
}
}
fn escape_sequence(&mut self) -> Result<KeyEvent> {
self._do_escape_sequence(true)
}
fn _do_escape_sequence(&mut self, allow_recurse: bool) -> Result<KeyEvent> {
let seq1 = self.next_char()?;
if seq1 == '[' {
self.escape_csi()
} else if seq1 == 'O' {
self.escape_o()
} else if seq1 == '\x1b' {
if !allow_recurse {
return Ok(E::ESC);
}
let timeout = if self.timeout_ms < 0 {
100
} else {
self.timeout_ms
};
match self.poll(timeout) {
Ok(0) | Err(_) => Ok(E::ESC),
Ok(n) => {
debug_assert!(n > 0, "{}", n);
let E(k, m) = self._do_escape_sequence(false)?;
Ok(E(k, m | M::ALT))
}
}
} else {
Ok(E::alt(seq1))
}
}
fn escape_csi(&mut self) -> Result<KeyEvent> {
let seq2 = self.next_char()?;
if seq2.is_digit(10) {
match seq2 {
'0' | '9' => {
debug!(target: "rustyline", "unsupported esc sequence: \\E[{:?}", seq2);
Ok(E(K::UnknownEscSeq, M::NONE))
}
_ => {
self.extended_escape(seq2)
}
}
} else if seq2 == '[' {
let seq3 = self.next_char()?;
Ok(match seq3 {
'A' => E(K::F(1), M::NONE),
'B' => E(K::F(2), M::NONE),
'C' => E(K::F(3), M::NONE),
'D' => E(K::F(4), M::NONE),
'E' => E(K::F(5), M::NONE),
_ => {
debug!(target: "rustyline", "unsupported esc sequence: \\E[[{:?}", seq3);
E(K::UnknownEscSeq, M::NONE)
}
})
} else {
Ok(match seq2 {
UP => E(K::Up, M::NONE),
DOWN => E(K::Down, M::NONE),
RIGHT => E(K::Right, M::NONE),
LEFT => E(K::Left, M::NONE),
END => E(K::End, M::NONE),
HOME => E(K::Home, M::NONE), 'Z' => E(K::BackTab, M::NONE),
'a' => E(K::Up, M::SHIFT), 'b' => E(K::Down, M::SHIFT), 'c' => E(K::Right, M::SHIFT), 'd' => E(K::Left, M::SHIFT), _ => {
debug!(target: "rustyline", "unsupported esc sequence: \\E[{:?}", seq2);
E(K::UnknownEscSeq, M::NONE)
}
})
}
}
#[allow(clippy::cognitive_complexity)]
fn extended_escape(&mut self, seq2: char) -> Result<KeyEvent> {
let seq3 = self.next_char()?;
if seq3 == '~' {
Ok(match seq2 {
'1' | RXVT_HOME => E(K::Home, M::NONE), INSERT => E(K::Insert, M::NONE),
DELETE => E(K::Delete, M::NONE),
'4' | RXVT_END => E(K::End, M::NONE), PAGE_UP => E(K::PageUp, M::NONE),
PAGE_DOWN => E(K::PageDown, M::NONE),
_ => {
debug!(target: "rustyline",
"unsupported esc sequence: \\E[{}~", seq2);
E(K::UnknownEscSeq, M::NONE)
}
})
} else if seq3.is_digit(10) {
let seq4 = self.next_char()?;
if seq4 == '~' {
Ok(match (seq2, seq3) {
('1', '1') => E(K::F(1), M::NONE), ('1', '2') => E(K::F(2), M::NONE), ('1', '3') => E(K::F(3), M::NONE), ('1', '4') => E(K::F(4), M::NONE), ('1', '5') => E(K::F(5), M::NONE), ('1', '7') => E(K::F(6), M::NONE), ('1', '8') => E(K::F(7), M::NONE), ('1', '9') => E(K::F(8), M::NONE), ('2', '0') => E(K::F(9), M::NONE), ('2', '1') => E(K::F(10), M::NONE), ('2', '3') => E(K::F(11), M::NONE), ('2', '4') => E(K::F(12), M::NONE), _ => {
debug!(target: "rustyline",
"unsupported esc sequence: \\E[{}{}~", seq2, seq3);
E(K::UnknownEscSeq, M::NONE)
}
})
} else if seq4 == ';' {
let seq5 = self.next_char()?;
if seq5.is_digit(10) {
let seq6 = self.next_char()?;
if seq6.is_digit(10) {
self.next_char()?; Ok(E(K::UnknownEscSeq, M::NONE))
} else if seq6 == 'R' {
Ok(E(K::UnknownEscSeq, M::NONE))
} else if seq6 == '~' {
Ok(match (seq2, seq3, seq5) {
('1', '5', CTRL) => E(K::F(5), M::CTRL),
('1', '7', CTRL) => E(K::F(6), M::CTRL),
('1', '8', CTRL) => E(K::F(7), M::CTRL),
('1', '9', CTRL) => E(K::F(8), M::CTRL),
('2', '0', CTRL) => E(K::F(9), M::CTRL),
('2', '1', CTRL) => E(K::F(10), M::CTRL),
('2', '3', CTRL) => E(K::F(11), M::CTRL),
('2', '4', CTRL) => E(K::F(12), M::CTRL),
_ => {
debug!(target: "rustyline",
"unsupported esc sequence: \\E[{}{};{}~", seq2, seq3, seq5);
E(K::UnknownEscSeq, M::NONE)
}
})
} else {
debug!(target: "rustyline",
"unsupported esc sequence: \\E[{}{};{}{}", seq2, seq3, seq5, seq6);
Ok(E(K::UnknownEscSeq, M::NONE))
}
} else {
debug!(target: "rustyline",
"unsupported esc sequence: \\E[{}{};{:?}", seq2, seq3, seq5);
Ok(E(K::UnknownEscSeq, M::NONE))
}
} else if seq4.is_digit(10) {
let seq5 = self.next_char()?;
if seq5 == '~' {
Ok(match (seq2, seq3, seq4) {
('2', '0', '0') => E(K::BracketedPasteStart, M::NONE),
('2', '0', '1') => E(K::BracketedPasteEnd, M::NONE),
_ => {
debug!(target: "rustyline",
"unsupported esc sequence: \\E[{}{}{}~", seq2, seq3, seq4);
E(K::UnknownEscSeq, M::NONE)
}
})
} else {
debug!(target: "rustyline",
"unsupported esc sequence: \\E[{}{}{}{}", seq2, seq3, seq4, seq5);
Ok(E(K::UnknownEscSeq, M::NONE))
}
} else {
debug!(target: "rustyline",
"unsupported esc sequence: \\E[{}{}{:?}", seq2, seq3, seq4);
Ok(E(K::UnknownEscSeq, M::NONE))
}
} else if seq3 == ';' {
let seq4 = self.next_char()?;
if seq4.is_digit(10) {
let seq5 = self.next_char()?;
if seq5.is_digit(10) {
self.next_char()?; Ok(E(K::UnknownEscSeq, M::NONE))
} else if seq2 == '1' {
Ok(match (seq4, seq5) {
(SHIFT, UP) => E(K::Up, M::SHIFT), (SHIFT, DOWN) => E(K::Down, M::SHIFT), (SHIFT, RIGHT) => E(K::Right, M::SHIFT),
(SHIFT, LEFT) => E(K::Left, M::SHIFT),
(SHIFT, END) => E(K::End, M::SHIFT), (SHIFT, HOME) => E(K::Home, M::SHIFT), (ALT, UP) => E(K::Up, M::ALT),
(ALT, DOWN) => E(K::Down, M::ALT),
(ALT, RIGHT) => E(K::Right, M::ALT),
(ALT, LEFT) => E(K::Left, M::ALT),
(ALT, END) => E(K::End, M::ALT),
(ALT, HOME) => E(K::Home, M::ALT),
(ALT_SHIFT, UP) => E(K::Up, M::ALT_SHIFT),
(ALT_SHIFT, DOWN) => E(K::Down, M::ALT_SHIFT),
(ALT_SHIFT, RIGHT) => E(K::Right, M::ALT_SHIFT),
(ALT_SHIFT, LEFT) => E(K::Left, M::ALT_SHIFT),
(ALT_SHIFT, END) => E(K::End, M::ALT_SHIFT),
(ALT_SHIFT, HOME) => E(K::Home, M::ALT_SHIFT),
(CTRL, UP) => E(K::Up, M::CTRL),
(CTRL, DOWN) => E(K::Down, M::CTRL),
(CTRL, RIGHT) => E(K::Right, M::CTRL),
(CTRL, LEFT) => E(K::Left, M::CTRL),
(CTRL, END) => E(K::End, M::CTRL),
(CTRL, HOME) => E(K::Home, M::CTRL),
(CTRL, 'P') => E(K::F(1), M::CTRL),
(CTRL, 'Q') => E(K::F(2), M::CTRL),
(CTRL, 'S') => E(K::F(4), M::CTRL),
(CTRL, 'p') => E(K::Char('0'), M::CTRL),
(CTRL, 'q') => E(K::Char('1'), M::CTRL),
(CTRL, 'r') => E(K::Char('2'), M::CTRL),
(CTRL, 's') => E(K::Char('3'), M::CTRL),
(CTRL, 't') => E(K::Char('4'), M::CTRL),
(CTRL, 'u') => E(K::Char('5'), M::CTRL),
(CTRL, 'v') => E(K::Char('6'), M::CTRL),
(CTRL, 'w') => E(K::Char('7'), M::CTRL),
(CTRL, 'x') => E(K::Char('8'), M::CTRL),
(CTRL, 'y') => E(K::Char('9'), M::CTRL),
(CTRL_SHIFT, UP) => E(K::Up, M::CTRL_SHIFT),
(CTRL_SHIFT, DOWN) => E(K::Down, M::CTRL_SHIFT),
(CTRL_SHIFT, RIGHT) => E(K::Right, M::CTRL_SHIFT),
(CTRL_SHIFT, LEFT) => E(K::Left, M::CTRL_SHIFT),
(CTRL_SHIFT, END) => E(K::End, M::CTRL_SHIFT),
(CTRL_SHIFT, HOME) => E(K::Home, M::CTRL_SHIFT),
(CTRL_SHIFT, 'p') => E(K::Char('0'), M::CTRL_SHIFT),
(CTRL_SHIFT, 'q') => E(K::Char('1'), M::CTRL_SHIFT),
(CTRL_SHIFT, 'r') => E(K::Char('2'), M::CTRL_SHIFT),
(CTRL_SHIFT, 's') => E(K::Char('3'), M::CTRL_SHIFT),
(CTRL_SHIFT, 't') => E(K::Char('4'), M::CTRL_SHIFT),
(CTRL_SHIFT, 'u') => E(K::Char('5'), M::CTRL_SHIFT),
(CTRL_SHIFT, 'v') => E(K::Char('6'), M::CTRL_SHIFT),
(CTRL_SHIFT, 'w') => E(K::Char('7'), M::CTRL_SHIFT),
(CTRL_SHIFT, 'x') => E(K::Char('8'), M::CTRL_SHIFT),
(CTRL_SHIFT, 'y') => E(K::Char('9'), M::CTRL_SHIFT),
(CTRL_ALT, UP) => E(K::Up, M::CTRL_ALT),
(CTRL_ALT, DOWN) => E(K::Down, M::CTRL_ALT),
(CTRL_ALT, RIGHT) => E(K::Right, M::CTRL_ALT),
(CTRL_ALT, LEFT) => E(K::Left, M::CTRL_ALT),
(CTRL_ALT, END) => E(K::End, M::CTRL_ALT),
(CTRL_ALT, HOME) => E(K::Home, M::CTRL_ALT),
(CTRL_ALT, 'p') => E(K::Char('0'), M::CTRL_ALT),
(CTRL_ALT, 'q') => E(K::Char('1'), M::CTRL_ALT),
(CTRL_ALT, 'r') => E(K::Char('2'), M::CTRL_ALT),
(CTRL_ALT, 's') => E(K::Char('3'), M::CTRL_ALT),
(CTRL_ALT, 't') => E(K::Char('4'), M::CTRL_ALT),
(CTRL_ALT, 'u') => E(K::Char('5'), M::CTRL_ALT),
(CTRL_ALT, 'v') => E(K::Char('6'), M::CTRL_ALT),
(CTRL_ALT, 'w') => E(K::Char('7'), M::CTRL_ALT),
(CTRL_ALT, 'x') => E(K::Char('8'), M::CTRL_ALT),
(CTRL_ALT, 'y') => E(K::Char('9'), M::CTRL_ALT),
(CTRL_ALT_SHIFT, UP) => E(K::Up, M::CTRL_ALT_SHIFT),
(CTRL_ALT_SHIFT, DOWN) => E(K::Down, M::CTRL_ALT_SHIFT),
(CTRL_ALT_SHIFT, RIGHT) => E(K::Right, M::CTRL_ALT_SHIFT),
(CTRL_ALT_SHIFT, LEFT) => E(K::Left, M::CTRL_ALT_SHIFT),
(CTRL_ALT_SHIFT, END) => E(K::End, M::CTRL_ALT_SHIFT),
(CTRL_ALT_SHIFT, HOME) => E(K::Home, M::CTRL_ALT_SHIFT),
(CTRL_ALT_SHIFT, 'p') => E(K::Char('0'), M::CTRL_ALT_SHIFT),
(CTRL_ALT_SHIFT, 'q') => E(K::Char('1'), M::CTRL_ALT_SHIFT),
(CTRL_ALT_SHIFT, 'r') => E(K::Char('2'), M::CTRL_ALT_SHIFT),
(CTRL_ALT_SHIFT, 's') => E(K::Char('3'), M::CTRL_ALT_SHIFT),
(CTRL_ALT_SHIFT, 't') => E(K::Char('4'), M::CTRL_ALT_SHIFT),
(CTRL_ALT_SHIFT, 'u') => E(K::Char('5'), M::CTRL_ALT_SHIFT),
(CTRL_ALT_SHIFT, 'v') => E(K::Char('6'), M::CTRL_ALT_SHIFT),
(CTRL_ALT_SHIFT, 'w') => E(K::Char('7'), M::CTRL_ALT_SHIFT),
(CTRL_ALT_SHIFT, 'x') => E(K::Char('8'), M::CTRL_ALT_SHIFT),
(CTRL_ALT_SHIFT, 'y') => E(K::Char('9'), M::CTRL_ALT_SHIFT),
('9', UP) => E(K::Up, M::ALT),
('9', DOWN) => E(K::Down, M::ALT),
('9', RIGHT) => E(K::Right, M::ALT),
('9', LEFT) => E(K::Left, M::ALT),
_ => {
debug!(target: "rustyline",
"unsupported esc sequence: \\E[1;{}{:?}", seq4, seq5);
E(K::UnknownEscSeq, M::NONE)
}
})
} else if seq5 == '~' {
Ok(match (seq2, seq4) {
(INSERT, SHIFT) => E(K::Insert, M::SHIFT),
(INSERT, ALT) => E(K::Insert, M::ALT),
(INSERT, ALT_SHIFT) => E(K::Insert, M::ALT_SHIFT),
(INSERT, CTRL) => E(K::Insert, M::CTRL),
(INSERT, CTRL_SHIFT) => E(K::Insert, M::CTRL_SHIFT),
(INSERT, CTRL_ALT) => E(K::Insert, M::CTRL_ALT),
(INSERT, CTRL_ALT_SHIFT) => E(K::Insert, M::CTRL_ALT_SHIFT),
(DELETE, SHIFT) => E(K::Delete, M::SHIFT),
(DELETE, ALT) => E(K::Delete, M::ALT),
(DELETE, ALT_SHIFT) => E(K::Delete, M::ALT_SHIFT),
(DELETE, CTRL) => E(K::Delete, M::CTRL),
(DELETE, CTRL_SHIFT) => E(K::Delete, M::CTRL_SHIFT),
(DELETE, CTRL_ALT) => E(K::Delete, M::CTRL_ALT),
(DELETE, CTRL_ALT_SHIFT) => E(K::Delete, M::CTRL_ALT_SHIFT),
(PAGE_UP, SHIFT) => E(K::PageUp, M::SHIFT),
(PAGE_UP, ALT) => E(K::PageUp, M::ALT),
(PAGE_UP, ALT_SHIFT) => E(K::PageUp, M::ALT_SHIFT),
(PAGE_UP, CTRL) => E(K::PageUp, M::CTRL),
(PAGE_UP, CTRL_SHIFT) => E(K::PageUp, M::CTRL_SHIFT),
(PAGE_UP, CTRL_ALT) => E(K::PageUp, M::CTRL_ALT),
(PAGE_UP, CTRL_ALT_SHIFT) => E(K::PageUp, M::CTRL_ALT_SHIFT),
(PAGE_DOWN, SHIFT) => E(K::PageDown, M::SHIFT),
(PAGE_DOWN, ALT) => E(K::PageDown, M::ALT),
(PAGE_DOWN, ALT_SHIFT) => E(K::PageDown, M::ALT_SHIFT),
(PAGE_DOWN, CTRL) => E(K::PageDown, M::CTRL),
(PAGE_DOWN, CTRL_SHIFT) => E(K::PageDown, M::CTRL_SHIFT),
(PAGE_DOWN, CTRL_ALT) => E(K::PageDown, M::CTRL_ALT),
(PAGE_DOWN, CTRL_ALT_SHIFT) => E(K::PageDown, M::CTRL_ALT_SHIFT),
_ => {
debug!(target: "rustyline",
"unsupported esc sequence: \\E[{};{:?}~", seq2, seq4);
E(K::UnknownEscSeq, M::NONE)
}
})
} else {
debug!(target: "rustyline",
"unsupported esc sequence: \\E[{};{}{:?}", seq2, seq4, seq5);
Ok(E(K::UnknownEscSeq, M::NONE))
}
} else {
debug!(target: "rustyline",
"unsupported esc sequence: \\E[{};{:?}", seq2, seq4);
Ok(E(K::UnknownEscSeq, M::NONE))
}
} else {
Ok(match (seq2, seq3) {
(DELETE, RXVT_CTRL) => E(K::Delete, M::CTRL),
(DELETE, RXVT_CTRL_SHIFT) => E(K::Delete, M::CTRL_SHIFT),
(CTRL, UP) => E(K::Up, M::CTRL),
(CTRL, DOWN) => E(K::Down, M::CTRL),
(CTRL, RIGHT) => E(K::Right, M::CTRL),
(CTRL, LEFT) => E(K::Left, M::CTRL),
(PAGE_UP, RXVT_CTRL) => E(K::PageUp, M::CTRL),
(PAGE_UP, RXVT_SHIFT) => E(K::PageUp, M::SHIFT),
(PAGE_UP, RXVT_CTRL_SHIFT) => E(K::PageUp, M::CTRL_SHIFT),
(PAGE_DOWN, RXVT_CTRL) => E(K::PageDown, M::CTRL),
(PAGE_DOWN, RXVT_SHIFT) => E(K::PageDown, M::SHIFT),
(PAGE_DOWN, RXVT_CTRL_SHIFT) => E(K::PageDown, M::CTRL_SHIFT),
(RXVT_HOME, RXVT_CTRL) => E(K::Home, M::CTRL),
(RXVT_HOME, RXVT_SHIFT) => E(K::Home, M::SHIFT),
(RXVT_HOME, RXVT_CTRL_SHIFT) => E(K::Home, M::CTRL_SHIFT),
(RXVT_END, RXVT_CTRL) => E(K::End, M::CTRL), (RXVT_END, RXVT_SHIFT) => E(K::End, M::SHIFT),
(RXVT_END, RXVT_CTRL_SHIFT) => E(K::End, M::CTRL_SHIFT),
_ => {
debug!(target: "rustyline",
"unsupported esc sequence: \\E[{}{:?}", seq2, seq3);
E(K::UnknownEscSeq, M::NONE)
}
})
}
}
fn escape_o(&mut self) -> Result<KeyEvent> {
let seq2 = self.next_char()?;
Ok(match seq2 {
UP => E(K::Up, M::NONE),
DOWN => E(K::Down, M::NONE),
RIGHT => E(K::Right, M::NONE),
LEFT => E(K::Left, M::NONE),
END => E(K::End, M::NONE), HOME => E(K::Home, M::NONE), 'M' => E::ENTER, 'P' => E(K::F(1), M::NONE), 'Q' => E(K::F(2), M::NONE), 'R' => E(K::F(3), M::NONE), 'S' => E(K::F(4), M::NONE), 'a' => E(K::Up, M::CTRL),
'b' => E(K::Down, M::CTRL),
'c' => E(K::Right, M::CTRL), 'd' => E(K::Left, M::CTRL), 'l' => E(K::F(8), M::NONE),
't' => E(K::F(5), M::NONE), 'u' => E(K::F(6), M::NONE), 'v' => E(K::F(7), M::NONE), 'w' => E(K::F(9), M::NONE), 'x' => E(K::F(10), M::NONE), _ => {
debug!(target: "rustyline", "unsupported esc sequence: \\EO{:?}", seq2);
E(K::UnknownEscSeq, M::NONE)
}
})
}
fn poll(&mut self, timeout_ms: i32) -> ::nix::Result<i32> {
let mut fds = [poll::PollFd::new(STDIN_FILENO, PollFlags::POLLIN)];
let r = poll::poll(&mut fds, timeout_ms);
match r {
Ok(_) => r,
Err(nix::errno::Errno::EINTR) => {
if SIGWINCH.load(Ordering::Relaxed) {
r
} else {
Ok(0) }
}
Err(_) => r,
}
}
}
impl RawReader for PosixRawReader {
fn next_key(&mut self, single_esc_abort: bool) -> Result<KeyEvent> {
let c = self.next_char()?;
let mut key = KeyEvent::new(c, M::NONE);
if key == E::ESC {
let timeout_ms = if single_esc_abort && self.timeout_ms == -1 {
0
} else {
self.timeout_ms
};
match self.poll(timeout_ms) {
Ok(n) if n == 0 => {
}
Ok(_) => {
key = self.escape_sequence()?
}
Err(e) => return Err(e.into()),
}
}
debug!(target: "rustyline", "c: {:?} => key: {:?}", c, key);
Ok(key)
}
fn next_char(&mut self) -> Result<char> {
loop {
let n = self.stdin.read(&mut self.buf)?;
if n == 0 {
return Err(error::ReadlineError::Eof);
}
let b = self.buf[0];
self.parser.advance(&mut self.receiver, b);
if !self.receiver.valid {
return Err(error::ReadlineError::Utf8Error);
} else if let Some(c) = self.receiver.c.take() {
return Ok(c);
}
}
}
fn read_pasted_text(&mut self) -> Result<String> {
let mut buffer = String::new();
loop {
match self.next_char()? {
'\x1b' => {
let key = self.escape_sequence()?;
if key == E(K::BracketedPasteEnd, M::NONE) {
break;
} else {
continue; }
}
c => buffer.push(c),
};
}
let buffer = buffer.replace("\r\n", "\n");
let buffer = buffer.replace("\r", "\n");
Ok(buffer)
}
fn find_binding(&self, key: &KeyEvent) -> Option<Cmd> {
let cmd = self.key_map.get(key).cloned();
if let Some(ref cmd) = cmd {
debug!(target: "rustyline", "terminal key binding: {:?} => {:?}", key, cmd);
}
cmd
}
}
impl Receiver for Utf8 {
fn codepoint(&mut self, c: char) {
self.c = Some(c);
self.valid = true;
}
fn invalid_sequence(&mut self) {
self.c = None;
self.valid = false;
}
}
pub struct PosixRenderer {
out: OutputStreamType,
cols: usize, buffer: String,
tab_stop: usize,
colors_enabled: bool,
bell_style: BellStyle,
}
impl PosixRenderer {
fn new(
out: OutputStreamType,
tab_stop: usize,
colors_enabled: bool,
bell_style: BellStyle,
) -> Self {
let (cols, _) = get_win_size(&out);
Self {
out,
cols,
buffer: String::with_capacity(1024),
tab_stop,
colors_enabled,
bell_style,
}
}
fn clear_old_rows(&mut self, layout: &Layout) {
use std::fmt::Write;
let current_row = layout.cursor.row;
let old_rows = layout.end.row;
let cursor_row_movement = old_rows.saturating_sub(current_row);
if cursor_row_movement > 0 {
write!(self.buffer, "\x1b[{}B", cursor_row_movement).unwrap();
}
for _ in 0..old_rows {
self.buffer.push_str("\r\x1b[0K\x1b[A");
}
self.buffer.push_str("\r\x1b[0K");
}
}
impl Renderer for PosixRenderer {
type Reader = PosixRawReader;
fn move_cursor(&mut self, old: Position, new: Position) -> Result<()> {
use std::fmt::Write;
self.buffer.clear();
let row_ordering = new.row.cmp(&old.row);
if row_ordering == cmp::Ordering::Greater {
let row_shift = new.row - old.row;
if row_shift == 1 {
self.buffer.push_str("\x1b[B");
} else {
write!(self.buffer, "\x1b[{}B", row_shift).unwrap();
}
} else if row_ordering == cmp::Ordering::Less {
let row_shift = old.row - new.row;
if row_shift == 1 {
self.buffer.push_str("\x1b[A");
} else {
write!(self.buffer, "\x1b[{}A", row_shift).unwrap();
}
}
let col_ordering = new.col.cmp(&old.col);
if col_ordering == cmp::Ordering::Greater {
let col_shift = new.col - old.col;
if col_shift == 1 {
self.buffer.push_str("\x1b[C");
} else {
write!(self.buffer, "\x1b[{}C", col_shift).unwrap();
}
} else if col_ordering == cmp::Ordering::Less {
let col_shift = old.col - new.col;
if col_shift == 1 {
self.buffer.push_str("\x1b[D");
} else {
write!(self.buffer, "\x1b[{}D", col_shift).unwrap();
}
}
self.write_and_flush(self.buffer.as_bytes())
}
fn refresh_line(
&mut self,
prompt: &str,
line: &LineBuffer,
hint: Option<&str>,
old_layout: &Layout,
new_layout: &Layout,
highlighter: Option<&dyn Highlighter>,
) -> Result<()> {
use std::fmt::Write;
self.buffer.clear();
let default_prompt = new_layout.default_prompt;
let cursor = new_layout.cursor;
let end_pos = new_layout.end;
self.clear_old_rows(old_layout);
if let Some(highlighter) = highlighter {
self.buffer
.push_str(&highlighter.highlight_prompt(prompt, default_prompt));
self.buffer
.push_str(&highlighter.highlight(line, line.pos()));
} else {
self.buffer.push_str(prompt);
self.buffer.push_str(line);
}
if let Some(hint) = hint {
if let Some(highlighter) = highlighter {
self.buffer.push_str(&highlighter.highlight_hint(hint));
} else {
self.buffer.push_str(hint);
}
}
if end_pos.col == 0
&& end_pos.row > 0
&& !hint
.map(|h| h.ends_with('\n'))
.unwrap_or_else(|| line.ends_with('\n'))
{
self.buffer.push('\n');
}
let new_cursor_row_movement = end_pos.row - cursor.row;
if new_cursor_row_movement > 0 {
write!(self.buffer, "\x1b[{}A", new_cursor_row_movement).unwrap();
}
if cursor.col > 0 {
write!(self.buffer, "\r\x1b[{}C", cursor.col).unwrap();
} else {
self.buffer.push('\r');
}
self.write_and_flush(self.buffer.as_bytes())?;
Ok(())
}
fn write_and_flush(&self, buf: &[u8]) -> Result<()> {
write_and_flush(self.out, buf)
}
fn calculate_position(&self, s: &str, orig: Position) -> Position {
let mut pos = orig;
let mut esc_seq = 0;
for c in s.graphemes(true) {
if c == "\n" {
pos.row += 1;
pos.col = 0;
continue;
}
let cw = if c == "\t" {
self.tab_stop - (pos.col % self.tab_stop)
} else {
width(c, &mut esc_seq)
};
pos.col += cw;
if pos.col > self.cols {
pos.row += 1;
pos.col = cw;
}
}
if pos.col == self.cols {
pos.col = 0;
pos.row += 1;
}
pos
}
fn beep(&mut self) -> Result<()> {
match self.bell_style {
BellStyle::Audible => {
io::stderr().write_all(b"\x07")?;
io::stderr().flush()?;
Ok(())
}
_ => Ok(()),
}
}
fn clear_screen(&mut self) -> Result<()> {
self.write_and_flush(b"\x1b[H\x1b[2J")
}
fn sigwinch(&self) -> bool {
SIGWINCH
.compare_exchange(true, false, Ordering::SeqCst, Ordering::SeqCst)
.unwrap_or(false)
}
fn update_size(&mut self) {
let (cols, _) = get_win_size(&self.out);
self.cols = cols;
}
fn get_columns(&self) -> usize {
self.cols
}
fn get_rows(&self) -> usize {
let (_, rows) = get_win_size(&self.out);
rows
}
fn colors_enabled(&self) -> bool {
self.colors_enabled
}
fn move_cursor_at_leftmost(&mut self, rdr: &mut PosixRawReader) -> Result<()> {
if rdr.poll(0)? != 0 {
debug!(target: "rustyline", "cannot request cursor location");
return Ok(());
}
self.write_and_flush(b"\x1b[6n")?;
if rdr.poll(100)? == 0
|| rdr.next_char()? != '\x1b'
|| rdr.next_char()? != '['
|| read_digits_until(rdr, ';')?.is_none()
{
warn!(target: "rustyline", "cannot read initial cursor location");
return Ok(());
}
let col = read_digits_until(rdr, 'R')?;
debug!(target: "rustyline", "initial cursor location: {:?}", col);
if col != Some(1) {
self.write_and_flush(b"\n")?;
}
Ok(())
}
}
fn read_digits_until(rdr: &mut PosixRawReader, sep: char) -> Result<Option<u32>> {
let mut num: u32 = 0;
loop {
match rdr.next_char()? {
digit @ '0'..='9' => {
num = num
.saturating_mul(10)
.saturating_add(digit.to_digit(10).unwrap());
continue;
}
c if c == sep => break,
_ => return Ok(None),
}
}
Ok(Some(num))
}
static SIGWINCH_ONCE: sync::Once = sync::Once::new();
static SIGWINCH: AtomicBool = AtomicBool::new(false);
fn install_sigwinch_handler() {
SIGWINCH_ONCE.call_once(|| unsafe {
let sigwinch = signal::SigAction::new(
signal::SigHandler::Handler(sigwinch_handler),
signal::SaFlags::empty(),
signal::SigSet::empty(),
);
let _ = signal::sigaction(signal::SIGWINCH, &sigwinch);
});
}
extern "C" fn sigwinch_handler(_: libc::c_int) {
SIGWINCH.store(true, Ordering::SeqCst);
debug!(target: "rustyline", "SIGWINCH");
}
fn map_key(key_map: &mut HashMap<KeyEvent, Cmd>, raw: &Termios, index: SCI, name: &str, cmd: Cmd) {
let cc = char::from(raw.control_chars[index as usize]);
let key = KeyEvent::new(cc, M::NONE);
debug!(target: "rustyline", "{}: {:?}", name, key);
key_map.insert(key, cmd);
}
#[cfg(not(test))]
pub type Terminal = PosixTerminal;
#[derive(Clone, Debug)]
pub struct PosixTerminal {
unsupported: bool,
stdin_isatty: bool,
stdstream_isatty: bool,
pub(crate) color_mode: ColorMode,
stream_type: OutputStreamType,
tab_stop: usize,
bell_style: BellStyle,
enable_bracketed_paste: bool,
}
impl PosixTerminal {
fn colors_enabled(&self) -> bool {
match self.color_mode {
ColorMode::Enabled => self.stdstream_isatty,
ColorMode::Forced => true,
ColorMode::Disabled => false,
}
}
}
impl Term for PosixTerminal {
type KeyMap = PosixKeyMap;
type Mode = PosixMode;
type Reader = PosixRawReader;
type Writer = PosixRenderer;
fn new(
color_mode: ColorMode,
stream_type: OutputStreamType,
tab_stop: usize,
bell_style: BellStyle,
enable_bracketed_paste: bool,
) -> Self {
let term = Self {
unsupported: is_unsupported_term(),
stdin_isatty: is_a_tty(STDIN_FILENO),
stdstream_isatty: is_a_tty(stream_type.as_raw_fd()),
color_mode,
stream_type,
tab_stop,
bell_style,
enable_bracketed_paste,
};
if !term.unsupported && term.stdin_isatty && term.stdstream_isatty {
install_sigwinch_handler();
}
term
}
fn is_unsupported(&self) -> bool {
self.unsupported
}
fn is_stdin_tty(&self) -> bool {
self.stdin_isatty
}
fn is_output_tty(&self) -> bool {
self.stdstream_isatty
}
fn enable_raw_mode(&mut self) -> Result<(Self::Mode, PosixKeyMap)> {
use nix::errno::Errno::ENOTTY;
use nix::sys::termios::{ControlFlags, InputFlags, LocalFlags};
if !self.stdin_isatty {
return Err(ENOTTY.into());
}
let original_mode = termios::tcgetattr(STDIN_FILENO)?;
let mut raw = original_mode.clone();
raw.input_flags &= !(InputFlags::BRKINT
| InputFlags::ICRNL
| InputFlags::INPCK
| InputFlags::ISTRIP
| InputFlags::IXON);
raw.control_flags |= ControlFlags::CS8;
raw.local_flags &=
!(LocalFlags::ECHO | LocalFlags::ICANON | LocalFlags::IEXTEN | LocalFlags::ISIG);
raw.control_chars[SCI::VMIN as usize] = 1; raw.control_chars[SCI::VTIME as usize] = 0;
let mut key_map: HashMap<KeyEvent, Cmd> = HashMap::with_capacity(4);
map_key(&mut key_map, &raw, SCI::VEOF, "VEOF", Cmd::EndOfFile);
map_key(&mut key_map, &raw, SCI::VINTR, "VINTR", Cmd::Interrupt);
map_key(&mut key_map, &raw, SCI::VQUIT, "VQUIT", Cmd::Interrupt);
map_key(&mut key_map, &raw, SCI::VSUSP, "VSUSP", Cmd::Suspend);
termios::tcsetattr(STDIN_FILENO, SetArg::TCSADRAIN, &raw)?;
let out = if !self.enable_bracketed_paste {
None
} else if let Err(e) = write_and_flush(self.stream_type, BRACKETED_PASTE_ON) {
debug!(target: "rustyline", "Cannot enable bracketed paste: {}", e);
None
} else {
Some(self.stream_type)
};
Ok((
PosixMode {
termios: original_mode,
out,
},
key_map,
))
}
fn create_reader(&self, config: &Config, key_map: PosixKeyMap) -> Result<PosixRawReader> {
Ok(PosixRawReader::new(config, key_map))
}
fn create_writer(&self) -> PosixRenderer {
PosixRenderer::new(
self.stream_type,
self.tab_stop,
self.colors_enabled(),
self.bell_style,
)
}
}
#[cfg(not(test))]
pub fn suspend() -> Result<()> {
use nix::unistd::Pid;
signal::kill(Pid::from_raw(0), signal::SIGTSTP)?;
Ok(())
}
fn write_and_flush(out: OutputStreamType, buf: &[u8]) -> Result<()> {
match out {
OutputStreamType::Stdout => {
io::stdout().write_all(buf)?;
io::stdout().flush()?;
}
OutputStreamType::Stderr => {
io::stderr().write_all(buf)?;
io::stderr().flush()?;
}
}
Ok(())
}
#[cfg(test)]
mod test {
use super::{Position, PosixRenderer, PosixTerminal, Renderer};
use crate::config::{BellStyle, OutputStreamType};
use crate::line_buffer::LineBuffer;
#[test]
#[ignore]
fn prompt_with_ansi_escape_codes() {
let out = PosixRenderer::new(OutputStreamType::Stdout, 4, true, BellStyle::default());
let pos = out.calculate_position("\x1b[1;32m>>\x1b[0m ", Position::default());
assert_eq!(3, pos.col);
assert_eq!(0, pos.row);
}
#[test]
fn test_unsupported_term() {
::std::env::set_var("TERM", "xterm");
assert!(!super::is_unsupported_term());
::std::env::set_var("TERM", "dumb");
assert!(super::is_unsupported_term());
}
#[test]
fn test_send() {
fn assert_send<T: Send>() {}
assert_send::<PosixTerminal>();
}
#[test]
fn test_sync() {
fn assert_sync<T: Sync>() {}
assert_sync::<PosixTerminal>();
}
#[test]
fn test_line_wrap() {
let mut out = PosixRenderer::new(OutputStreamType::Stdout, 4, true, BellStyle::default());
let prompt = "> ";
let default_prompt = true;
let prompt_size = out.calculate_position(prompt, Position::default());
let mut line = LineBuffer::init("", 0, None);
let old_layout = out.compute_layout(prompt_size, default_prompt, &line, None);
assert_eq!(Position { col: 2, row: 0 }, old_layout.cursor);
assert_eq!(old_layout.cursor, old_layout.end);
assert_eq!(Some(true), line.insert('a', out.cols - prompt_size.col + 1));
let new_layout = out.compute_layout(prompt_size, default_prompt, &line, None);
assert_eq!(Position { col: 1, row: 1 }, new_layout.cursor);
assert_eq!(new_layout.cursor, new_layout.end);
out.refresh_line(prompt, &line, None, &old_layout, &new_layout, None)
.unwrap();
#[rustfmt::skip]
assert_eq!(
"\r\u{1b}[0K> aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\r\u{1b}[1C",
out.buffer
);
}
}