src/libterm/lib.rs

   1 // Copyright 2013-2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Terminal formatting library.
  12 //!
  13 //! This crate provides the `Terminal` trait, which abstracts over an [ANSI
  14 //! Terminal][ansi] to provide color printing, among other things. There are two
  15 //! implementations, the `TerminfoTerminal`, which uses control characters from
  16 //! a [terminfo][ti] database, and `WinConsole`, which uses the [Win32 Console
  17 //! API][win].
  18 //!
  19 //! # Examples
  20 //!
  21 //! ```no_run
  22 //! # #![feature(rustc_private)]
  23 //! extern crate term;
  24 //! use std::io::prelude::*;
  25 //!
  26 //! fn main() {
  27 //!     let mut t = term::stdout().unwrap();
  28 //!
  29 //!     t.fg(term::color::GREEN).unwrap();
  30 //!     write!(t, "hello, ").unwrap();
  31 //!
  32 //!     t.fg(term::color::RED).unwrap();
  33 //!     writeln!(t, "world!").unwrap();
  34 //!
  35 //!     assert!(t.reset().unwrap());
  36 //! }
  37 //! ```
  38 //!
  39 //! [ansi]: https://en.wikipedia.org/wiki/ANSI_escape_code
  40 //! [win]: http://msdn.microsoft.com/en-us/library/windows/desktop/ms682010%28v=vs.85%29.aspx
  41 //! [ti]: https://en.wikipedia.org/wiki/Terminfo
  42
  43 #![crate_name = "term"]
  44 #![unstable(feature = "rustc_private",
  45             reason = "use the crates.io `term` library instead",
  46             issue = "27812")]
  47 #![crate_type = "rlib"]
  48 #![crate_type = "dylib"]
  49 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  50        html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
  51        html_root_url = "https://doc.rust-lang.org/nightly/",
  52        html_playground_url = "https://play.rust-lang.org/",
  53        test(attr(deny(warnings))))]
  54 #![deny(missing_docs)]
  55
  56 #![feature(box_syntax)]
  57 #![feature(staged_api)]
  58 #![cfg_attr(windows, feature(libc))]
  59 // Handle rustfmt skips
  60 #![feature(custom_attribute)]
  61 #![allow(unused_attributes)]
  62
  63 use std::io::prelude::*;
  64
  65 pub use terminfo::TerminfoTerminal;
  66 #[cfg(windows)]
  67 pub use win::WinConsole;
  68
  69 use std::io::{self, Stdout, Stderr};
  70
  71 pub mod terminfo;
  72
  73 #[cfg(windows)]
  74 mod win;
  75
  76 /// Alias for stdout terminals.
  77 pub type StdoutTerminal = Terminal<Output = Stdout> + Send;
  78 /// Alias for stderr terminals.
  79 pub type StderrTerminal = Terminal<Output = Stderr> + Send;
  80
  81 #[cfg(not(windows))]
  82 /// Return a Terminal wrapping stdout, or None if a terminal couldn't be
  83 /// opened.
  84 pub fn stdout() -> Option<Box<StdoutTerminal>> {
  85     TerminfoTerminal::new(io::stdout()).map(|t| Box::new(t) as Box<StdoutTerminal>)
  86 }
  87
  88 #[cfg(windows)]
  89 /// Return a Terminal wrapping stdout, or None if a terminal couldn't be
  90 /// opened.
  91 pub fn stdout() -> Option<Box<StdoutTerminal>> {
  92     TerminfoTerminal::new(io::stdout())
  93         .map(|t| Box::new(t) as Box<StdoutTerminal>)
  94         .or_else(|| WinConsole::new(io::stdout()).ok().map(|t| Box::new(t) as Box<StdoutTerminal>))
  95 }
  96
  97 #[cfg(not(windows))]
  98 /// Return a Terminal wrapping stderr, or None if a terminal couldn't be
  99 /// opened.
 100 pub fn stderr() -> Option<Box<StderrTerminal>> {
 101     TerminfoTerminal::new(io::stderr()).map(|t| Box::new(t) as Box<StderrTerminal>)
 102 }
 103
 104 #[cfg(windows)]
 105 /// Return a Terminal wrapping stderr, or None if a terminal couldn't be
 106 /// opened.
 107 pub fn stderr() -> Option<Box<StderrTerminal>> {
 108     TerminfoTerminal::new(io::stderr())
 109         .map(|t| Box::new(t) as Box<StderrTerminal>)
 110         .or_else(|| WinConsole::new(io::stderr()).ok().map(|t| Box::new(t) as Box<StderrTerminal>))
 111 }
 112
 113
 114 /// Terminal color definitions
 115 #[allow(missing_docs)]
 116 pub mod color {
 117     /// Number for a terminal color
 118     pub type Color = u16;
 119
 120     pub const BLACK: Color = 0;
 121     pub const RED: Color = 1;
 122     pub const GREEN: Color = 2;
 123     pub const YELLOW: Color = 3;
 124     pub const BLUE: Color = 4;
 125     pub const MAGENTA: Color = 5;
 126     pub const CYAN: Color = 6;
 127     pub const WHITE: Color = 7;
 128
 129     pub const BRIGHT_BLACK: Color = 8;
 130     pub const BRIGHT_RED: Color = 9;
 131     pub const BRIGHT_GREEN: Color = 10;
 132     pub const BRIGHT_YELLOW: Color = 11;
 133     pub const BRIGHT_BLUE: Color = 12;
 134     pub const BRIGHT_MAGENTA: Color = 13;
 135     pub const BRIGHT_CYAN: Color = 14;
 136     pub const BRIGHT_WHITE: Color = 15;
 137 }
 138
 139 /// Terminal attributes for use with term.attr().
 140 ///
 141 /// Most attributes can only be turned on and must be turned off with term.reset().
 142 /// The ones that can be turned off explicitly take a boolean value.
 143 /// Color is also represented as an attribute for convenience.
 144 #[derive(Debug, PartialEq, Eq, Copy, Clone)]
 145 pub enum Attr {
 146     /// Bold (or possibly bright) mode
 147     Bold,
 148     /// Dim mode, also called faint or half-bright. Often not supported
 149     Dim,
 150     /// Italics mode. Often not supported
 151     Italic(bool),
 152     /// Underline mode
 153     Underline(bool),
 154     /// Blink mode
 155     Blink,
 156     /// Standout mode. Often implemented as Reverse, sometimes coupled with Bold
 157     Standout(bool),
 158     /// Reverse mode, inverts the foreground and background colors
 159     Reverse,
 160     /// Secure mode, also called invis mode. Hides the printed text
 161     Secure,
 162     /// Convenience attribute to set the foreground color
 163     ForegroundColor(color::Color),
 164     /// Convenience attribute to set the background color
 165     BackgroundColor(color::Color),
 166 }
 167
 168 /// A terminal with similar capabilities to an ANSI Terminal
 169 /// (foreground/background colors etc).
 170 pub trait Terminal: Write {
 171     /// The terminal's output writer type.
 172     type Output: Write;
 173
 174     /// Sets the foreground color to the given color.
 175     ///
 176     /// If the color is a bright color, but the terminal only supports 8 colors,
 177     /// the corresponding normal color will be used instead.
 178     ///
 179     /// Returns `Ok(true)` if the color was set, `Ok(false)` otherwise, and `Err(e)`
 180     /// if there was an I/O error.
 181     fn fg(&mut self, color: color::Color) -> io::Result<bool>;
 182
 183     /// Sets the background color to the given color.
 184     ///
 185     /// If the color is a bright color, but the terminal only supports 8 colors,
 186     /// the corresponding normal color will be used instead.
 187     ///
 188     /// Returns `Ok(true)` if the color was set, `Ok(false)` otherwise, and `Err(e)`
 189     /// if there was an I/O error.
 190     fn bg(&mut self, color: color::Color) -> io::Result<bool>;
 191
 192     /// Sets the given terminal attribute, if supported.  Returns `Ok(true)`
 193     /// if the attribute was supported, `Ok(false)` otherwise, and `Err(e)` if
 194     /// there was an I/O error.
 195     fn attr(&mut self, attr: Attr) -> io::Result<bool>;
 196
 197     /// Returns whether the given terminal attribute is supported.
 198     fn supports_attr(&self, attr: Attr) -> bool;
 199
 200     /// Resets all terminal attributes and colors to their defaults.
 201     ///
 202     /// Returns `Ok(true)` if the terminal was reset, `Ok(false)` otherwise, and `Err(e)` if there
 203     /// was an I/O error.
 204     ///
 205     /// *Note: This does not flush.*
 206     ///
 207     /// That means the reset command may get buffered so, if you aren't planning on doing anything
 208     /// else that might flush stdout's buffer (e.g. writing a line of text), you should flush after
 209     /// calling reset.
 210     fn reset(&mut self) -> io::Result<bool>;
 211
 212     /// Gets an immutable reference to the stream inside
 213     fn get_ref<'a>(&'a self) -> &'a Self::Output;
 214
 215     /// Gets a mutable reference to the stream inside
 216     fn get_mut<'a>(&'a mut self) -> &'a mut Self::Output;
 217
 218     /// Returns the contained stream, destroying the `Terminal`
 219     fn into_inner(self) -> Self::Output where Self: Sized;
 220 }