1 // Copyright 2013-2014 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.
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.
11 //! Simple ANSI color library
13 #[crate_id = "term#0.10-pre"];
14 #[comment = "Simple ANSI color library"];
15 #[license = "MIT/ASL2"];
16 #[crate_type = "rlib"];
17 #[crate_type = "dylib"];
18 #[doc(html_logo_url = "http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
19 html_favicon_url = "http://www.rust-lang.org/favicon.ico",
20 html_root_url = "http://static.rust-lang.org/doc/master")];
22 #[feature(macro_rules)];
23 #[allow(deprecated_owned_vector)]; // NOTE: remove after stage0
25 extern crate collections;
29 use terminfo::TermInfo;
30 use terminfo::searcher::open;
31 use terminfo::parser::compiled::{parse, msys_terminfo};
32 use terminfo::parm::{expand, Number, Variables};
36 // FIXME (#2807): Windows support.
41 pub static BLACK: Color = 0u16;
42 pub static RED: Color = 1u16;
43 pub static GREEN: Color = 2u16;
44 pub static YELLOW: Color = 3u16;
45 pub static BLUE: Color = 4u16;
46 pub static MAGENTA: Color = 5u16;
47 pub static CYAN: Color = 6u16;
48 pub static WHITE: Color = 7u16;
50 pub static BRIGHT_BLACK: Color = 8u16;
51 pub static BRIGHT_RED: Color = 9u16;
52 pub static BRIGHT_GREEN: Color = 10u16;
53 pub static BRIGHT_YELLOW: Color = 11u16;
54 pub static BRIGHT_BLUE: Color = 12u16;
55 pub static BRIGHT_MAGENTA: Color = 13u16;
56 pub static BRIGHT_CYAN: Color = 14u16;
57 pub static BRIGHT_WHITE: Color = 15u16;
61 /// Terminal attributes for use with term.attr().
62 /// Most attributes can only be turned on and must be turned off with term.reset().
63 /// The ones that can be turned off explicitly take a boolean value.
64 /// Color is also represented as an attribute for convenience.
66 /// Bold (or possibly bright) mode
68 /// Dim mode, also called faint or half-bright. Often not supported
70 /// Italics mode. Often not supported
76 /// Standout mode. Often implemented as Reverse, sometimes coupled with Bold
78 /// Reverse mode, inverts the foreground and background colors
80 /// Secure mode, also called invis mode. Hides the printed text
82 /// Convenience attribute to set the foreground color
83 ForegroundColor(super::color::Color),
84 /// Convenience attribute to set the background color
85 BackgroundColor(super::color::Color)
89 fn cap_for_attr(attr: attr::Attr) -> &'static str {
93 attr::Italic(true) => "sitm",
94 attr::Italic(false) => "ritm",
95 attr::Underline(true) => "smul",
96 attr::Underline(false) => "rmul",
97 attr::Blink => "blink",
98 attr::Standout(true) => "smso",
99 attr::Standout(false) => "rmso",
100 attr::Reverse => "rev",
101 attr::Secure => "invis",
102 attr::ForegroundColor(_) => "setaf",
103 attr::BackgroundColor(_) => "setab"
107 pub struct Terminal<T> {
108 priv num_colors: u16,
113 impl<T: Writer> Terminal<T> {
114 pub fn new(out: T) -> Result<Terminal<T>, ~str> {
115 let term = match os::getenv("TERM") {
117 None => return Err(~"TERM environment variable undefined")
120 let entry = open(term);
122 if "cygwin" == term { // msys terminal
123 return Ok(Terminal {out: out, ti: msys_terminfo(), num_colors: 8});
125 return Err(entry.unwrap_err());
128 let mut file = entry.unwrap();
129 let ti = parse(&mut file, false);
131 return Err(ti.unwrap_err());
134 let inf = ti.unwrap();
135 let nc = if inf.strings.find_equiv(&("setaf")).is_some()
136 && inf.strings.find_equiv(&("setab")).is_some() {
137 inf.numbers.find_equiv(&("colors")).map_or(0, |&n| n)
140 return Ok(Terminal {out: out, ti: inf, num_colors: nc});
142 /// Sets the foreground color to the given color.
144 /// If the color is a bright color, but the terminal only supports 8 colors,
145 /// the corresponding normal color will be used instead.
147 /// Returns Ok(true) if the color was set, Ok(false) otherwise, and Err(e)
148 /// if there was an I/O error
149 pub fn fg(&mut self, color: color::Color) -> io::IoResult<bool> {
150 let color = self.dim_if_necessary(color);
151 if self.num_colors > color {
152 let s = expand(self.ti
154 .find_equiv(&("setaf"))
157 [Number(color as int)], &mut Variables::new());
159 try!(self.out.write(s.unwrap().as_slice()));
165 /// Sets the background color to the given color.
167 /// If the color is a bright color, but the terminal only supports 8 colors,
168 /// the corresponding normal color will be used instead.
170 /// Returns Ok(true) if the color was set, Ok(false) otherwise, and Err(e)
171 /// if there was an I/O error
172 pub fn bg(&mut self, color: color::Color) -> io::IoResult<bool> {
173 let color = self.dim_if_necessary(color);
174 if self.num_colors > color {
175 let s = expand(self.ti
177 .find_equiv(&("setab"))
180 [Number(color as int)], &mut Variables::new());
182 try!(self.out.write(s.unwrap().as_slice()));
189 /// Sets the given terminal attribute, if supported.
190 /// Returns Ok(true) if the attribute was supported, Ok(false) otherwise,
191 /// and Err(e) if there was an I/O error.
192 pub fn attr(&mut self, attr: attr::Attr) -> io::IoResult<bool> {
194 attr::ForegroundColor(c) => self.fg(c),
195 attr::BackgroundColor(c) => self.bg(c),
197 let cap = cap_for_attr(attr);
198 let parm = self.ti.strings.find_equiv(&cap);
200 let s = expand(parm.unwrap().as_slice(),
202 &mut Variables::new());
204 try!(self.out.write(s.unwrap().as_slice()));
213 /// Returns whether the given terminal attribute is supported.
214 pub fn supports_attr(&self, attr: attr::Attr) -> bool {
216 attr::ForegroundColor(_) | attr::BackgroundColor(_) => {
220 let cap = cap_for_attr(attr);
221 self.ti.strings.find_equiv(&cap).is_some()
226 /// Resets all terminal attributes and color to the default.
227 pub fn reset(&mut self) -> io::IoResult<()> {
228 let mut cap = self.ti.strings.find_equiv(&("sgr0"));
230 // are there any terminals that have color/attrs and not sgr0?
231 // Try falling back to sgr, then op
232 cap = self.ti.strings.find_equiv(&("sgr"));
234 cap = self.ti.strings.find_equiv(&("op"));
237 let s = cap.map_or(Err(~"can't find terminfo capability `sgr0`"), |op| {
238 expand(op.as_slice(), [], &mut Variables::new())
241 return self.out.write(s.unwrap().as_slice())
246 fn dim_if_necessary(&self, color: color::Color) -> color::Color {
247 if color >= self.num_colors && color >= 8 && color < 16 {
252 pub fn unwrap(self) -> T { self.out }
254 pub fn get_ref<'a>(&'a self) -> &'a T { &self.out }
256 pub fn get_mut<'a>(&'a mut self) -> &'a mut T { &mut self.out }
259 impl<T: Writer> Writer for Terminal<T> {
260 fn write(&mut self, buf: &[u8]) -> io::IoResult<()> {
264 fn flush(&mut self) -> io::IoResult<()> {