1 //! Terminal formatting library.
3 //! This crate provides the `Terminal` trait, which abstracts over an [ANSI
4 //! Terminal][ansi] to provide color printing, among other things. There are two
5 //! implementations, the `TerminfoTerminal`, which uses control characters from
6 //! a [terminfo][ti] database, and `WinConsole`, which uses the [Win32 Console
12 //! # #![feature(rustc_private)]
13 //! extern crate term;
14 //! use std::io::prelude::*;
17 //! let mut t = term::stdout().unwrap();
19 //! t.fg(term::color::GREEN).unwrap();
20 //! write!(t, "hello, ").unwrap();
22 //! t.fg(term::color::RED).unwrap();
23 //! writeln!(t, "world!").unwrap();
25 //! assert!(t.reset().unwrap());
29 //! [ansi]: https://en.wikipedia.org/wiki/ANSI_escape_code
30 //! [win]: http://msdn.microsoft.com/en-us/library/windows/desktop/ms682010%28v=vs.85%29.aspx
31 //! [ti]: https://en.wikipedia.org/wiki/Terminfo
33 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
34 html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
35 html_root_url = "https://doc.rust-lang.org/nightly/",
36 html_playground_url = "https://play.rust-lang.org/",
37 test(attr(deny(warnings))))]
38 #![deny(missing_docs)]
40 #![cfg_attr(windows, feature(libc))]
41 // Handle rustfmt skips
42 #![feature(custom_attribute)]
44 #![allow(unused_attributes)]
46 use std::io::prelude::*;
48 pub use terminfo::TerminfoTerminal;
50 pub use win::WinConsole;
52 use std::io::{self, Stdout, Stderr};
59 /// Alias for stdout terminals.
60 pub type StdoutTerminal = dyn Terminal<Output = Stdout> + Send;
61 /// Alias for stderr terminals.
62 pub type StderrTerminal = dyn Terminal<Output = Stderr> + Send;
65 /// Return a Terminal wrapping stdout, or None if a terminal couldn't be
67 pub fn stdout() -> Option<Box<StdoutTerminal>> {
68 TerminfoTerminal::new(io::stdout()).map(|t| Box::new(t) as Box<StdoutTerminal>)
72 /// Return a Terminal wrapping stdout, or None if a terminal couldn't be
74 pub fn stdout() -> Option<Box<StdoutTerminal>> {
75 TerminfoTerminal::new(io::stdout())
76 .map(|t| Box::new(t) as Box<StdoutTerminal>)
77 .or_else(|| WinConsole::new(io::stdout()).ok().map(|t| Box::new(t) as Box<StdoutTerminal>))
81 /// Return a Terminal wrapping stderr, or None if a terminal couldn't be
83 pub fn stderr() -> Option<Box<StderrTerminal>> {
84 TerminfoTerminal::new(io::stderr()).map(|t| Box::new(t) as Box<StderrTerminal>)
88 /// Return a Terminal wrapping stderr, or None if a terminal couldn't be
90 pub fn stderr() -> Option<Box<StderrTerminal>> {
91 TerminfoTerminal::new(io::stderr())
92 .map(|t| Box::new(t) as Box<StderrTerminal>)
93 .or_else(|| WinConsole::new(io::stderr()).ok().map(|t| Box::new(t) as Box<StderrTerminal>))
97 /// Terminal color definitions
98 #[allow(missing_docs)]
100 /// Number for a terminal color
101 pub type Color = u16;
103 pub const BLACK: Color = 0;
104 pub const RED: Color = 1;
105 pub const GREEN: Color = 2;
106 pub const YELLOW: Color = 3;
107 pub const BLUE: Color = 4;
108 pub const MAGENTA: Color = 5;
109 pub const CYAN: Color = 6;
110 pub const WHITE: Color = 7;
112 pub const BRIGHT_BLACK: Color = 8;
113 pub const BRIGHT_RED: Color = 9;
114 pub const BRIGHT_GREEN: Color = 10;
115 pub const BRIGHT_YELLOW: Color = 11;
116 pub const BRIGHT_BLUE: Color = 12;
117 pub const BRIGHT_MAGENTA: Color = 13;
118 pub const BRIGHT_CYAN: Color = 14;
119 pub const BRIGHT_WHITE: Color = 15;
122 /// Terminal attributes for use with term.attr().
124 /// Most attributes can only be turned on and must be turned off with term.reset().
125 /// The ones that can be turned off explicitly take a boolean value.
126 /// Color is also represented as an attribute for convenience.
127 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
129 /// Bold (or possibly bright) mode
131 /// Dim mode, also called faint or half-bright. Often not supported
133 /// Italics mode. Often not supported
139 /// Standout mode. Often implemented as Reverse, sometimes coupled with Bold
141 /// Reverse mode, inverts the foreground and background colors
143 /// Secure mode, also called invis mode. Hides the printed text
145 /// Convenience attribute to set the foreground color
146 ForegroundColor(color::Color),
147 /// Convenience attribute to set the background color
148 BackgroundColor(color::Color),
151 /// A terminal with similar capabilities to an ANSI Terminal
152 /// (foreground/background colors etc).
153 pub trait Terminal: Write {
154 /// The terminal's output writer type.
157 /// Sets the foreground color to the given color.
159 /// If the color is a bright color, but the terminal only supports 8 colors,
160 /// the corresponding normal color will be used instead.
162 /// Returns `Ok(true)` if the color was set, `Ok(false)` otherwise, and `Err(e)`
163 /// if there was an I/O error.
164 fn fg(&mut self, color: color::Color) -> io::Result<bool>;
166 /// Sets the background color to the given color.
168 /// If the color is a bright color, but the terminal only supports 8 colors,
169 /// the corresponding normal color will be used instead.
171 /// Returns `Ok(true)` if the color was set, `Ok(false)` otherwise, and `Err(e)`
172 /// if there was an I/O error.
173 fn bg(&mut self, color: color::Color) -> io::Result<bool>;
175 /// Sets the given terminal attribute, if supported. Returns `Ok(true)`
176 /// if the attribute was supported, `Ok(false)` otherwise, and `Err(e)` if
177 /// there was an I/O error.
178 fn attr(&mut self, attr: Attr) -> io::Result<bool>;
180 /// Returns whether the given terminal attribute is supported.
181 fn supports_attr(&self, attr: Attr) -> bool;
183 /// Resets all terminal attributes and colors to their defaults.
185 /// Returns `Ok(true)` if the terminal was reset, `Ok(false)` otherwise, and `Err(e)` if there
186 /// was an I/O error.
188 /// *Note: This does not flush.*
190 /// That means the reset command may get buffered so, if you aren't planning on doing anything
191 /// else that might flush stdout's buffer (e.g., writing a line of text), you should flush after
193 fn reset(&mut self) -> io::Result<bool>;
195 /// Gets an immutable reference to the stream inside
196 fn get_ref(&self) -> &Self::Output;
198 /// Gets a mutable reference to the stream inside
199 fn get_mut(&mut self) -> &mut Self::Output;
201 /// Returns the contained stream, destroying the `Terminal`
202 fn into_inner(self) -> Self::Output where Self: Sized;