2018-01-18 09:06:45 +11:00
|
|
|
//! With this module you can perform actions that are terminal related.
|
|
|
|
//! Like clearing and scrolling in the terminal or getting the size of the terminal.
|
2018-03-11 03:33:06 +11:00
|
|
|
|
2018-03-06 08:06:43 +11:00
|
|
|
use super::*;
|
2018-01-18 09:06:45 +11:00
|
|
|
|
2018-06-23 05:04:30 +10:00
|
|
|
use std::fmt;
|
2018-07-10 03:37:07 +10:00
|
|
|
use std::io::Write;
|
|
|
|
|
2018-01-18 09:06:45 +11:00
|
|
|
/// Struct that stores an specific platform implementation for terminal related actions.
|
2018-07-30 05:30:09 +10:00
|
|
|
///
|
|
|
|
/// Check `/examples/version/terminal` in the library for more specific examples.
|
|
|
|
///
|
|
|
|
/// #Example
|
|
|
|
///
|
|
|
|
/// ```rust
|
|
|
|
///
|
|
|
|
/// let crossterm = Crossterm::new();
|
|
|
|
/// let term = crossterm.terminal();
|
|
|
|
///
|
|
|
|
/// term.scroll_down(5);
|
|
|
|
/// term.scroll_up(4);
|
|
|
|
/// let (with, height) = term.terminal_size();
|
|
|
|
///
|
|
|
|
/// ```
|
2018-07-28 17:54:05 +10:00
|
|
|
pub struct Terminal<'terminal> {
|
2018-07-09 06:13:32 +10:00
|
|
|
terminal: Box<ITerminal>,
|
2018-07-28 17:54:05 +10:00
|
|
|
screen_manager: &'terminal ScreenManager,
|
2018-01-18 09:06:45 +11:00
|
|
|
}
|
|
|
|
|
2018-07-28 17:54:05 +10:00
|
|
|
impl<'terminal> Terminal<'terminal> {
|
2018-01-31 07:20:11 +11:00
|
|
|
/// Create new terminal instance whereon terminal related actions can be performed.
|
2018-07-28 17:54:05 +10:00
|
|
|
pub fn new(screen_manager: &'terminal ScreenManager) -> Terminal<'terminal> {
|
2018-03-04 01:40:51 +11:00
|
|
|
#[cfg(target_os = "windows")]
|
2018-07-02 06:43:43 +10:00
|
|
|
let terminal = functions::get_module::<Box<ITerminal>>(
|
2018-07-28 17:54:05 +10:00
|
|
|
Box::new(WinApiTerminal::new()),
|
|
|
|
Box::new(AnsiTerminal::new()),
|
2018-07-09 06:13:32 +10:00
|
|
|
).unwrap();
|
2018-02-04 03:17:28 +11:00
|
|
|
|
2018-03-04 01:40:51 +11:00
|
|
|
#[cfg(not(target_os = "windows"))]
|
2018-07-29 03:46:05 +10:00
|
|
|
let terminal = Box::from(AnsiTerminal::new()) as Box<ITerminal>;
|
2018-01-31 07:20:11 +11:00
|
|
|
|
2018-07-02 06:43:43 +10:00
|
|
|
Terminal {
|
|
|
|
terminal,
|
2018-07-31 05:35:35 +10:00
|
|
|
screen_manager: screen_manager,
|
2018-07-02 06:43:43 +10:00
|
|
|
}
|
2018-01-18 09:06:45 +11:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Clear the current cursor by specifying the clear type
|
2018-07-02 06:43:43 +10:00
|
|
|
///
|
2018-01-18 09:06:45 +11:00
|
|
|
/// #Example
|
|
|
|
///
|
|
|
|
/// ```rust
|
|
|
|
///
|
2018-07-30 05:30:09 +10:00
|
|
|
/// let crossterm = Crossterm::new();
|
|
|
|
/// let term = crossterm.terminal();
|
2018-07-02 06:43:43 +10:00
|
|
|
///
|
2018-01-18 09:06:45 +11:00
|
|
|
/// // clear all cells in terminal.
|
2018-03-11 03:33:06 +11:00
|
|
|
/// term.clear(terminal::ClearType::All);
|
2018-01-31 07:20:11 +11:00
|
|
|
/// // clear all cells from the cursor position downwards in terminal.
|
2018-03-11 03:33:06 +11:00
|
|
|
/// term.clear(terminal::ClearType::FromCursorDown);
|
2018-01-31 07:20:11 +11:00
|
|
|
/// // clear all cells from the cursor position upwards in terminal.
|
2018-03-11 03:33:06 +11:00
|
|
|
/// term.clear(terminal::ClearType::FromCursorUp);
|
2018-01-18 09:06:45 +11:00
|
|
|
/// // clear current line cells in terminal.
|
2018-03-11 03:33:06 +11:00
|
|
|
/// term.clear(terminal::ClearType::CurrentLine);
|
2018-01-18 09:06:45 +11:00
|
|
|
/// // clear all cells from cursor position until new line in terminal.
|
2018-03-11 03:33:06 +11:00
|
|
|
/// term.clear(terminal::ClearType::UntilNewLine);
|
2018-07-02 06:43:43 +10:00
|
|
|
///
|
2018-01-18 09:06:45 +11:00
|
|
|
/// ```
|
2018-08-01 07:05:45 +10:00
|
|
|
pub fn clear(&mut self, clear_type: ClearType) {
|
|
|
|
self.terminal.clear(clear_type, &mut self.screen_manager);
|
2018-01-18 09:06:45 +11:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Get the terminal size (x,y).
|
2018-07-02 06:43:43 +10:00
|
|
|
///
|
2018-01-18 09:06:45 +11:00
|
|
|
/// #Example
|
|
|
|
///
|
|
|
|
/// ```rust
|
|
|
|
///
|
|
|
|
/// extern crate crossterm;
|
2018-03-11 03:33:06 +11:00
|
|
|
/// use crossterm::terminal;
|
2018-06-17 04:10:51 +10:00
|
|
|
/// use crossterm::Context;
|
2018-03-11 03:33:06 +11:00
|
|
|
///
|
2018-07-30 05:30:09 +10:00
|
|
|
/// let crossterm = Crossterm::new();
|
|
|
|
/// let term = crossterm.terminal();
|
2018-01-18 09:06:45 +11:00
|
|
|
///
|
|
|
|
/// let size = term.terminal_size();
|
|
|
|
/// println!("{:?}", size);
|
2018-07-02 06:43:43 +10:00
|
|
|
///
|
2018-01-18 09:06:45 +11:00
|
|
|
/// ```
|
2018-07-12 06:59:54 +10:00
|
|
|
pub fn terminal_size(&self) -> (u16, u16) {
|
2018-07-28 17:54:05 +10:00
|
|
|
return self.terminal.terminal_size(&self.screen_manager);
|
2018-01-18 09:06:45 +11:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Scroll `n` lines up in the current terminal.
|
2018-07-02 06:43:43 +10:00
|
|
|
///
|
2018-01-18 09:06:45 +11:00
|
|
|
/// #Example
|
|
|
|
///
|
|
|
|
/// ```rust
|
|
|
|
///
|
2018-07-30 05:30:09 +10:00
|
|
|
/// let crossterm = Crossterm::new();
|
|
|
|
/// let term = crossterm.terminal();
|
2018-07-02 06:43:43 +10:00
|
|
|
///
|
2018-01-18 09:06:45 +11:00
|
|
|
/// // scroll up by 5 lines
|
|
|
|
/// let size = term.scroll_up(5);
|
2018-07-02 06:43:43 +10:00
|
|
|
///
|
2018-01-18 09:06:45 +11:00
|
|
|
/// ```
|
2018-07-12 06:59:54 +10:00
|
|
|
pub fn scroll_up(&self, count: i16) {
|
2018-07-31 05:35:35 +10:00
|
|
|
self.terminal.scroll_up(count, &self.screen_manager);
|
2018-01-18 09:06:45 +11:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Scroll `n` lines up in the current terminal.
|
2018-07-02 06:43:43 +10:00
|
|
|
///
|
2018-01-18 09:06:45 +11:00
|
|
|
/// #Example
|
|
|
|
///
|
|
|
|
/// ```rust
|
|
|
|
///
|
2018-07-31 05:35:35 +10:00
|
|
|
/// let crossterm = Crossterm::new();
|
2018-07-30 05:30:09 +10:00
|
|
|
/// let term = crossterm.terminal();
|
2018-07-02 06:43:43 +10:00
|
|
|
///
|
2018-01-18 09:06:45 +11:00
|
|
|
/// // scroll down by 5 lines
|
|
|
|
/// let size = term.scroll_down(5);
|
2018-07-02 06:43:43 +10:00
|
|
|
///
|
2018-01-18 09:06:45 +11:00
|
|
|
/// ```
|
2018-07-12 06:59:54 +10:00
|
|
|
pub fn scroll_down(&self, count: i16) {
|
2018-07-31 05:35:35 +10:00
|
|
|
self.terminal.scroll_down(count, &self.screen_manager);
|
2018-01-18 09:06:45 +11:00
|
|
|
}
|
2018-01-26 04:26:08 +11:00
|
|
|
|
2018-01-28 04:26:08 +11:00
|
|
|
/// Set the terminal size. Note that not all terminals can be set to a very small scale.
|
|
|
|
///
|
|
|
|
/// #Example
|
|
|
|
///
|
|
|
|
/// ```rust
|
|
|
|
///
|
2018-07-30 05:30:09 +10:00
|
|
|
/// let crossterm = Crossterm::new();
|
|
|
|
/// let term = crossterm.terminal();
|
2018-01-28 04:26:08 +11:00
|
|
|
///
|
|
|
|
/// // Set of the size to X: 10 and Y: 10
|
|
|
|
/// let size = term.set_size(10,10);
|
2018-07-02 06:43:43 +10:00
|
|
|
///
|
2018-01-28 04:26:08 +11:00
|
|
|
/// ```
|
2018-07-12 06:59:54 +10:00
|
|
|
pub fn set_size(&self, width: i16, height: i16) {
|
2018-07-31 05:35:35 +10:00
|
|
|
self.terminal.set_size(width, height, &self.screen_manager);
|
2018-01-26 04:26:08 +11:00
|
|
|
}
|
2018-06-17 04:10:51 +10:00
|
|
|
|
2018-07-12 03:43:12 +10:00
|
|
|
/// Exit the current process.
|
|
|
|
///
|
|
|
|
/// #Example
|
|
|
|
///
|
|
|
|
/// ```rust
|
|
|
|
///
|
2018-07-30 05:30:09 +10:00
|
|
|
/// let crossterm = Crossterm::new();
|
|
|
|
/// let term = crossterm.terminal();
|
2018-07-12 03:43:12 +10:00
|
|
|
///
|
|
|
|
/// let size = term.exit();
|
|
|
|
///
|
|
|
|
/// ```
|
2018-07-02 06:43:43 +10:00
|
|
|
pub fn exit(&self) {
|
2018-07-09 06:13:32 +10:00
|
|
|
self.terminal.exit();
|
2018-06-27 04:21:47 +10:00
|
|
|
}
|
2018-07-02 06:40:07 +10:00
|
|
|
|
2018-07-04 06:48:04 +10:00
|
|
|
/// Write any displayable content to the current terminal screen.
|
2018-07-12 03:43:12 +10:00
|
|
|
///
|
|
|
|
/// #Example
|
|
|
|
///
|
|
|
|
/// ```rust
|
|
|
|
///
|
2018-07-30 05:30:09 +10:00
|
|
|
/// let crossterm = Crossterm::new();
|
|
|
|
/// let term = crossterm.terminal();
|
2018-07-12 03:43:12 +10:00
|
|
|
///
|
|
|
|
/// let size = term.write("Some text \n Some text on new line");
|
|
|
|
///
|
|
|
|
/// ```
|
2018-07-12 06:59:54 +10:00
|
|
|
pub fn write<D: fmt::Display>(&self, value: D) {
|
2018-07-29 03:26:35 +10:00
|
|
|
use std::fmt::Write;
|
2018-07-28 17:54:05 +10:00
|
|
|
let mut string = String::new();
|
|
|
|
write!(string, "{}", value).unwrap();
|
|
|
|
self.screen_manager.write_string(string);
|
2018-07-02 06:40:07 +10:00
|
|
|
}
|
2018-01-18 09:06:45 +11:00
|
|
|
}
|
|
|
|
|
2018-07-30 05:30:09 +10:00
|
|
|
/// Get an terminal implementation whereon terminal related actions could performed
|
|
|
|
pub fn terminal(screen_manager: &mut ScreenManager) -> Terminal {
|
2018-07-28 17:54:05 +10:00
|
|
|
Terminal::new(screen_manager)
|
2018-01-18 09:06:45 +11:00
|
|
|
}
|