#![doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
html_favicon_url = "http://www.rust-lang.org/favicon.ico",
html_root_url = "http://doc.rust-lang.org/nightly/",
html_playground_url = "http://play.rust-lang.org/")]
#![deny(missing_docs)]
#![cfg_attr(test, deny(warnings))]
#![cfg_attr(rust_build, feature(staged_api))]
#![cfg_attr(rust_build, staged_api)]
#![cfg_attr(rust_build,
unstable(feature = "rustc_private",
reason = "use the crates.io `term` library instead"))]
use std::io::prelude::*;
pub use terminfo::TerminfoTerminal;
#[cfg(windows)]
pub use win::WinConsole;
use std::io::{self, Stdout, Stderr};
pub mod terminfo;
#[cfg(windows)]
mod win;
pub type StdoutTerminal = Terminal<Output=Stdout> + Send;
pub type StderrTerminal = Terminal<Output=Stderr> + Send;
#[cfg(not(windows))]
pub fn stdout() -> Option<Box<StdoutTerminal>> {
TerminfoTerminal::new(io::stdout()).map(|t| {
Box::new(t) as Box<StdoutTerminal>
})
}
#[cfg(windows)]
pub fn stdout() -> Option<Box<StdoutTerminal>> {
TerminfoTerminal::new(io::stdout()).map(|t| {
Box::new(t) as Box<StdoutTerminal>
}).or_else(|| WinConsole::new(io::stdout()).ok().map(|t| {
Box::new(t) as Box<StdoutTerminal>
}))
}
#[cfg(not(windows))]
pub fn stderr() -> Option<Box<StderrTerminal>> {
TerminfoTerminal::new(io::stderr()).map(|t| {
Box::new(t) as Box<StderrTerminal>
})
}
#[cfg(windows)]
pub fn stderr() -> Option<Box<StderrTerminal>> {
TerminfoTerminal::new(io::stderr()).map(|t| {
Box::new(t) as Box<StderrTerminal>
}).or_else(|| WinConsole::new(io::stderr()).ok().map(|t| {
Box::new(t) as Box<StderrTerminal>
}))
}
#[allow(missing_docs)]
pub mod color {
pub type Color = u16;
pub const BLACK: Color = 0;
pub const RED: Color = 1;
pub const GREEN: Color = 2;
pub const YELLOW: Color = 3;
pub const BLUE: Color = 4;
pub const MAGENTA: Color = 5;
pub const CYAN: Color = 6;
pub const WHITE: Color = 7;
pub const BRIGHT_BLACK: Color = 8;
pub const BRIGHT_RED: Color = 9;
pub const BRIGHT_GREEN: Color = 10;
pub const BRIGHT_YELLOW: Color = 11;
pub const BRIGHT_BLUE: Color = 12;
pub const BRIGHT_MAGENTA: Color = 13;
pub const BRIGHT_CYAN: Color = 14;
pub const BRIGHT_WHITE: Color = 15;
}
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
pub enum Attr {
Bold,
Dim,
Italic(bool),
Underline(bool),
Blink,
Standout(bool),
Reverse,
Secure,
ForegroundColor(color::Color),
BackgroundColor(color::Color)
}
pub trait Terminal: Write {
type Output: Write;
fn fg(&mut self, color: color::Color) -> io::Result<bool>;
fn bg(&mut self, color: color::Color) -> io::Result<bool>;
fn attr(&mut self, attr: Attr) -> io::Result<bool>;
fn supports_attr(&self, attr: Attr) -> bool;
fn reset(&mut self) -> io::Result<bool>;
fn cursor_up(&mut self) -> io::Result<bool>;
fn delete_line(&mut self) -> io::Result<bool>;
fn carriage_return(&mut self) -> io::Result<bool>;
fn get_ref<'a>(&'a self) -> &'a Self::Output;
fn get_mut<'a>(&'a mut self) -> &'a mut Self::Output;
fn into_inner(self) -> Self::Output where Self: Sized;
}