interaction/

lib.rs

//! Interaction is a minimal and a simple readline library.
//!
//! Features
//! * Single line editing mode
//! * Multi line editing mode
//! * Key bindings
//! * History
//! * Completion
//!
//! # Example
//! ```no_run
//! use interaction::InteractionBuilder;
//! use std::io;
//!
//! fn main() {
//!     let history_file = "./.example_history";
//!     let mut inter = InteractionBuilder::new()
//!         .prompt_str(";;>")
//!         .history_limit(5)
//!         .completion(|_input, completions| {
//!             completions.push(b"foo".to_vec());
//!             completions.push(b"bar".to_vec());
//!         })
//!         .load_history(history_file)
//!         .unwrap()
//!         .build();
//!     loop {
//!         match inter.line() {
//!             Ok(input) => {
//!                 // write any code.
//!             }
//!             Err(e) if e.kind() == io::ErrorKind::Interrupted => {
//!                 inter.save_history(history_file).unwrap();
//!                 break;
//!             }
//!             Err(_) => {
//!                 break;
//!             }
//!         }
//!     }
//! }
//! ```

use libc;
use std::collections::VecDeque;
use std::fs::File;
use std::io;
use std::io::{Read, Write};
use std::os::unix::io::RawFd;
use std::path::Path;
use termios::*;

fn get_stdin_fd() -> RawFd {
    libc::STDIN_FILENO
}

fn get_stdout_fd() -> RawFd {
    libc::STDOUT_FILENO
}

fn get_col() -> u16 {
    let mut winsize = libc::winsize {
        ws_row: 0,
        ws_col: 0,
        ws_xpixel: 0,
        ws_ypixel: 0,
    };
    if unsafe { libc::ioctl(get_stdout_fd(), libc::TIOCGWINSZ, &mut winsize) } == 0 {
        winsize.ws_col
    } else {
        80
    }
}

mod keys {
    pub(crate) const CTRL_A: u8 = 1;
    pub(crate) const CTRL_B: u8 = 2;
    pub(crate) const CTRL_C: u8 = 3;
    pub(crate) const CTRL_D: u8 = 4;
    pub(crate) const CTRL_E: u8 = 5;
    pub(crate) const CTRL_F: u8 = 6;
    pub(crate) const CTRL_H: u8 = 8;
    pub(crate) const CTRL_I: u8 = 9;
    pub(crate) const CTRL_J: u8 = 10;
    pub(crate) const CTRL_K: u8 = 11;
    pub(crate) const CTRL_L: u8 = 12;
    pub(crate) const CTRL_M: u8 = 13;
    pub(crate) const ESC: u8 = 27;
    pub(crate) const ONE: u8 = 49;
    pub(crate) const TWO: u8 = 50;
    pub(crate) const THREE: u8 = 51;
    pub(crate) const FOUR: u8 = 52;
    pub(crate) const FIVE: u8 = 53;
    pub(crate) const SIX: u8 = 54;
    pub(crate) const A: u8 = 65;
    pub(crate) const B: u8 = 66;
    pub(crate) const C: u8 = 67;
    pub(crate) const D: u8 = 68;
    // This char is `[`.
    pub(crate) const LEFT_BRACKET: u8 = 91;
    pub(crate) const BACKSPACE: u8 = 127;
}

/// The type is a callback for completion.
pub type Completion = fn(&Vec<u8>, &mut Vec<Vec<u8>>);

/// The struct is to management the history of command line.
pub struct History {
    commands: VecDeque<Vec<u8>>,
    position: usize,
    // if limit is 0, history is unlimited.
    limit: usize,
}

impl History {
    /// Initialize history. `limit` is the maximum size of history. If limit is zero, unlimited.
    pub fn new(limit: usize) -> Self {
        History {
            commands: VecDeque::new(),
            position: 0,
            limit,
        }
    }

    /// Return a next command from the current line.
    pub(crate) fn next(&mut self) -> Option<&Vec<u8>> {
        if self.commands.len() == 0 || self.position == self.commands.len() {
            None
        } else {
            self.position += 1;
            self.commands.get(self.position)
        }
    }

    /// Return a previous command from the current line.
    pub(crate) fn prev(&mut self) -> Option<&Vec<u8>> {
        if self.commands.len() == 0 || self.position == 0 {
            None
        } else {
            self.position -= 1;
            self.commands.get(self.position)
        }
    }

    fn _append(&mut self, history: Vec<u8>) {
        if self.limit > 0 && self.commands.len() == self.limit {
            self.commands.pop_front();
        }
        self.commands.push_back(history);
    }

    /// Append a new command.
    pub fn append(&mut self, history: Vec<u8>) {
        self._append(history);
        self.position = self.commands.len();
    }

    /// Load a history from the given `file_path`.
    pub fn load<P: AsRef<Path>>(&mut self, file_path: P) -> io::Result<()> {
        let mut file = match File::open(file_path) {
            Ok(file) => file,
            Err(e) if e.kind() == io::ErrorKind::NotFound => return Ok(()),
            Err(e) => return Err(e),
        };
        let mut buffer = vec![0; 4096];
        let mut cmd = vec![0; 0];
        loop {
            let n = file.read(&mut buffer)?;
            if n == 0 {
                break;
            }
            for c in buffer[..n].iter() {
                if *c == b'\n' && cmd.len() > 0 {
                    self._append(cmd);
                    cmd = vec![0; 0];
                    continue;
                }
                cmd.push(*c);
            }
        }
        if cmd.len() > 0 {
            self._append(cmd);
        }
        if self.commands.len() > 0 {
            self.position = self.commands.len();
        }
        Ok(())
    }

    /// Save the history to the given `file_path`.
    pub fn save<P: AsRef<Path>>(&mut self, file_path: P) -> io::Result<()> {
        File::create(file_path).and_then(|mut file| {
            for cmd in self.commands.iter() {
                file.write_all(cmd).and(file.write_all(b"\n"))?;
            }
            file.flush()
        })
    }
}

struct Line<'a> {
    backup: Termios,
    position: usize,
    buffer: &'a mut Vec<u8>,
    prompt: &'a [u8],
    completion: &'a Option<Completion>,
    multi: bool,
    row: usize,
    history: &'a mut History,
}

impl<'a> Line<'a> {
    fn new(
        buffer: &'a mut Vec<u8>,
        prompt: &'a [u8],
        completion: &'a Option<Completion>,
        multi: bool,
        history: &'a mut History,
    ) -> Self {
        let backup = Termios::from_fd(get_stdin_fd()).unwrap();
        Line::enable_raw_mode().unwrap();
        Line {
            backup,
            position: 0,
            buffer,
            prompt,
            completion,
            multi,
            row: 0,
            history,
        }
    }

    fn enable_raw_mode() -> io::Result<()> {
        let fd = get_stdin_fd();
        Termios::from_fd(fd).and_then(|mut termios| {
            termios.c_iflag &= !(BRKINT | INPCK | ISTRIP | ICRNL | IXON);
            termios.c_oflag &= !OPOST;
            termios.c_cflag |= CS8;
            termios.c_lflag &= !(ECHO | ICANON | IEXTEN | ISIG);
            termios.c_cc[VMIN] = 1;
            termios.c_cc[VTIME] = 0;
            tcsetattr(fd, TCSANOW, &termios).and(tcflush(fd, TCIOFLUSH))
        })
    }

    fn disable_raw_mode(&self) -> io::Result<()> {
        let fd = get_stdin_fd();
        tcsetattr(fd, TCSANOW, &self.backup).and(tcflush(fd, TCIOFLUSH))
    }

    fn refresh_single_line(&self) -> io::Result<()> {
        let mut stdout = io::stdout();
        stdout
            .write_all(
                &[
                    b"\x1b[0G\x1b[K",
                    self.prompt,
                    &self.buffer[..],
                    format!("\r\x1b[{}C", self.position + self.prompt.len()).as_bytes(),
                ]
                .concat(),
            )
            .and(stdout.flush())
    }

    fn refresh_multi_line(&mut self) -> io::Result<()> {
        let col = get_col() as usize;
        let mut stdout = io::stdout();
        if self.row == 0 {
            stdout.write_all(b"\x1b[0G\x1b[J")?;
        } else {
            stdout.write_all(format!("\x1b[0G\x1b[{}A\x1b[J", self.row).as_bytes())?;
        }
        let mut cnt = 0;
        let mut row: usize = 0;
        for c in self.prompt.iter().chain(self.buffer.iter()) {
            stdout.write_all(&[*c])?;
            cnt += 1;
            if cnt == col {
                stdout.write_all(b"\n\x1b[0G")?;
                cnt = 0;
                row += 1;
            }
        }
        stdout.write_all(b"\r")?;
        if row == 0 {
            stdout.write_all(b"\x1b[0G")?;
        } else {
            stdout.write_all(format!("\x1b[0G\x1b[{}A", row).as_bytes())?;
        }
        let pos = self.prompt.len() + self.position;
        let m = pos % col;
        self.row = pos / col;
        if self.row > 0 {
            stdout.write_all(format!("\x1b[{}B", self.row).as_bytes())?;
        }
        if m > 0 {
            stdout.write_all(format!("\x1b[{}C", m).as_bytes())?;
        }
        stdout.flush()?;
        Ok(())
    }

    fn refresh_line(&mut self) -> io::Result<()> {
        if self.multi {
            self.refresh_multi_line()
        } else {
            self.refresh_single_line()
        }
    }

    fn completion(&mut self, callback: &Completion) -> io::Result<u8> {
        let mut completions = Vec::new();
        callback(self.buffer, &mut completions);
        if completions.len() == 0 {
            return Ok(0);
        }
        let mut stdin = io::stdin();
        let bk = self.buffer.clone();
        let mut buf = vec![0; 1];
        loop {
            for comp in completions.iter() {
                self.buffer.clear();
                self.buffer.extend(comp);
                self.position = self.buffer.len();
                self.refresh_line()?;

                let n = stdin.read(&mut buf)?;
                assert_eq!(n, 1);

                match buf[0] {
                    keys::CTRL_I => {
                        continue;
                    }
                    keys::ESC => {
                        self.buffer.clear();
                        self.buffer.extend(&bk);
                        self.position = self.buffer.len();
                        self.refresh_line()?;
                        return Ok(buf[0]);
                    }
                    _ => {
                        return Ok(buf[0]);
                    }
                }
            }
        }
    }

    fn fetch(mut self) -> io::Result<()> {
        let mut stdin = io::stdin();

        self.refresh_line()?;

        let mut buf = vec![0; 1];
        let mut tmp = vec![0; 0];
        let mut used = false;
        loop {
            let n = stdin.read(&mut buf)?;
            assert_eq!(n, 1);

            if buf[0] == keys::ESC {
                let mut buf2 = vec![0; 3];
                let n = stdin.read(&mut buf2[0..1])?;
                assert_eq!(n, 1);
                match buf2[0] {
                    // arrows, home, end or del
                    keys::LEFT_BRACKET => {
                        let n = stdin.read(&mut buf2[1..2])?;
                        assert_eq!(n, 1);
                        match buf2[1] {
                            // HOME
                            keys::ONE => {
                                let _ = stdin.read(&mut buf2[2..3])?;
                                buf[0] = keys::CTRL_A;
                            }
                            // INS
                            keys::TWO => {
                                let _ = stdin.read(&mut buf2[2..3])?;
                                continue;
                            }
                            // DEL
                            keys::THREE => {
                                let _ = stdin.read(&mut buf2[2..3])?;
                                if self.position < self.buffer.len() {
                                    buf[0] = keys::CTRL_D;
                                } else {
                                    continue;
                                }
                            }
                            // END
                            keys::FOUR => {
                                let _ = stdin.read(&mut buf2[2..3])?;
                                buf[0] = keys::CTRL_E;
                            }
                            // PgUp
                            keys::FIVE => {
                                let _ = stdin.read(&mut buf2[2..3])?;
                                continue;
                            }
                            // PgDn
                            keys::SIX => {
                                let _ = stdin.read(&mut buf2[2..3])?;
                                continue;
                            }
                            // Up
                            keys::A => match self.history.prev() {
                                Some(cmd) => {
                                    if !used {
                                        tmp.extend(&self.buffer[..]);
                                        used = true;
                                    }
                                    self.buffer.clear();
                                    self.buffer.extend(cmd);
                                    self.position = self.buffer.len();
                                    self.refresh_line()?;
                                    continue;
                                }
                                None => {
                                    continue;
                                }
                            },
                            // Down
                            keys::B => match self.history.next() {
                                Some(cmd) => {
                                    self.buffer.clear();
                                    self.buffer.extend(cmd);
                                    self.position = self.buffer.len();
                                    self.refresh_line()?;
                                    continue;
                                }
                                None => {
                                    if used {
                                        used = false;
                                        self.buffer.clear();
                                        self.buffer.extend(&tmp[..]);
                                        self.position = self.buffer.len();
                                        tmp.clear();
                                        self.refresh_line()?;
                                    }
                                    continue;
                                }
                            },
                            // Right
                            keys::C => {
                                buf[0] = keys::CTRL_F;
                            }
                            // Left
                            keys::D => {
                                buf[0] = keys::CTRL_B;
                            }
                            _ => {
                                buf[0] = buf2[1];
                            }
                        }
                    }
                    _ => {
                        // handle to esc
                        // ...
                        buf[0] = buf2[0];
                    }
                }
            }

            // Tab
            if buf[0] == keys::CTRL_I {
                match self.completion {
                    Some(callback) => {
                        let c = self.completion(callback)?;
                        if c == 0 {
                            continue;
                        }
                        buf[0] = c;
                    }
                    None => continue,
                }
            }

            match buf[0] {
                // Move the cursor start of line.
                keys::CTRL_A => {
                    self.position = 0;
                    self.refresh_line()?;
                }
                // Move the cursor forward 1 column.
                keys::CTRL_B => {
                    if self.position == 0 {
                        continue;
                    }
                    self.position -= 1;
                    self.refresh_line()?;
                }
                // Exit the process.
                keys::CTRL_C => {
                    self.disable_raw_mode()?;
                    return Err(io::ErrorKind::Interrupted.into());
                }
                keys::CTRL_D => {
                    // If the buffer is empty, exit the process.
                    if self.buffer.len() == 0 {
                        self.disable_raw_mode()?;
                        return Err(io::ErrorKind::Interrupted.into());
                    // Delete a char at the cursor.
                    } else if self.position < self.buffer.len() {
                        self.buffer.remove(self.position);
                        self.refresh_line()?;
                    }
                }
                // Move the cursor end of line.
                keys::CTRL_E => {
                    self.position = self.buffer.len();
                    self.refresh_line()?;
                }
                // Move the cursor backward 1 column.
                keys::CTRL_F => {
                    if self.position == self.buffer.len() {
                        continue;
                    }
                    self.position += 1;
                    self.refresh_line()?;
                }
                keys::CTRL_H | keys::BACKSPACE => {
                    if self.position == 0 || self.buffer.len() == 0 {
                        continue;
                    }
                    self.position -= 1;
                    self.buffer.remove(self.position);
                    self.refresh_line()?;
                }
                // Enter
                keys::CTRL_J | keys::CTRL_M => {
                    break;
                }
                keys::CTRL_K => {
                    self.buffer.truncate(self.position);
                    self.refresh_line()?;
                }
                keys::CTRL_L => {
                    let mut stdout = io::stdout();
                    stdout.write_all(b"\x1b[H\x1b[2J")?;
                    self.refresh_line()?;
                }
                // esc,
                keys::ESC => {
                    continue;
                }
                _ => {
                    if self.position < self.buffer.len() {
                        self.buffer[self.position] = buf[0];
                    } else {
                        self.buffer.extend(&buf);
                    }
                    self.position += 1;
                    self.refresh_line()?;
                }
            }
        }
        let mut stdout = io::stdout();
        stdout
            .write_all(format!("\n\x1b[{}D", self.prompt.len() + self.position).as_bytes())
            .and(stdout.flush())
    }
}

impl<'a> Drop for Line<'a> {
    fn drop(&mut self) {
        self.disable_raw_mode().unwrap()
    }
}

/// A instance of interaction.
pub struct Interaction {
    prompt: Vec<u8>,
    completion: Option<Completion>,
    /// If true, the interaction mode is multi line.
    pub multi: bool,
    history: History,
}

impl Interaction {
    /// Initialize a interaction.
    pub fn new(
        prompt: Vec<u8>,
        completion: Option<Completion>,
        multi: bool,
        limit: usize,
    ) -> Self {
        Interaction {
            prompt,
            completion,
            multi,
            history: History::new(limit),
        }
    }

    /// Initialize interaction from prompt.
    pub fn from(prompt: &[u8]) -> Self {
        Interaction::new(prompt.to_vec(), None, true, 0)
    }

    /// Initialize interaction from prompt.
    pub fn from_str(prompt: &str) -> Self {
        Interaction::new(prompt.as_bytes().to_vec(), None, true, 0)
    }

    /// Get the line of input.
    pub fn line(&mut self) -> io::Result<Vec<u8>> {
        let mut buffer = vec![0; 0];
        Line::new(
            &mut buffer,
            &self.prompt,
            &self.completion,
            self.multi,
            &mut self.history,
        )
        .fetch()
        .and_then(|_| {
            if buffer.len() > 0 {
                self.history.append(buffer.clone());
            }
            Ok(buffer)
        })
    }

    /// Set the prompt.
    pub fn set_prompt(&mut self, prompt: &[u8]) {
        self.prompt = prompt.to_vec();
    }

    /// Set the completion.
    pub fn set_completion(&mut self, completion: Completion) {
        self.completion = Some(completion);
    }

    /// Set the maximum size of history.
    pub fn set_history_limit(&mut self, limit: usize) {
        self.history = History::new(limit);
    }

    /// Load a history from `file_path`.
    pub fn load_history<P: AsRef<Path>>(&mut self, file_path: P) -> io::Result<()> {
        self.history.load(file_path)
    }

    /// Save the history to `file_path`.
    pub fn save_history<P: AsRef<Path>>(&mut self, file_path: P) -> io::Result<()> {
        self.history.save(file_path)
    }
}

/// Builder of [Interaction](struct.Interaction.html).
///
/// # Example
/// ```no_run
/// use interaction::InteractionBuilder;
///
/// let history_file = "./.example_history";
/// let inter = InteractionBuilder::new()
///     .prompt_str(";;>")
///     .history_limit(5)
///     .completion(|_input, completions| {
///         completions.push(b"foo".to_vec());
///         completions.push(b"bar".to_vec());
///     })
///     .load_history(history_file)
///     .unwrap()
///     .build();
/// ```
pub struct InteractionBuilder {
    prompt: Vec<u8>,
    completion: Option<Completion>,
    multi: bool,
    history: History,
}

impl InteractionBuilder {
    /// Initialize a builder.
    pub fn new() -> Self {
        InteractionBuilder {
            prompt: vec![0; 0],
            completion: None,
            multi: true,
            history: History::new(0),
        }
    }

    /// Build a interaction.
    pub fn build(self) -> Interaction {
        Interaction {
            prompt: self.prompt,
            completion: self.completion,
            multi: self.multi,
            history: self.history,
        }
    }

    /// Set a prompt.
    pub fn prompt(mut self, prompt: &[u8]) -> Self {
        self.prompt = prompt.to_vec();
        self
    }

    /// Set a prompt.
    pub fn prompt_str(mut self, prompt: &str) -> Self {
        self.prompt = prompt.as_bytes().to_vec();
        self
    }

    /// Set a completion.
    pub fn completion(mut self, completion: Completion) -> Self {
        self.completion = Some(completion);
        self
    }

    /// Set a mode.
    pub fn mode(mut self, multi: bool) -> Self {
        self.multi = multi;
        self
    }

    /// Set a maximum size of history.
    pub fn history_limit(mut self, limit: usize) -> Self {
        self.history = History::new(limit);
        self
    }

    /// Load a history from `file_path`.
    pub fn load_history<P: AsRef<Path>>(mut self, file_path: P) -> io::Result<Self> {
        self.history.load(file_path).and(Ok(self))
    }
}