1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
use std::io::prelude::*;
use std::ops::{Deref, DerefMut};
use atty::Stream;
use termcolor::{Buffer, BufferWriter, Color, ColorChoice, ColorSpec, WriteColor};
use calypso_error::CalResult;
pub use atty;
pub use termcolor;
/// Parse a color preference (`always`, `ansi`, `auto`, anything else: auto) to
/// a color preference. Uses [`atty`] internally to test if the output stream
/// is a TTY.
#[must_use]
pub fn parse_color_pref(pref: &str, stream: Stream) -> ColorChoice {
match pref {
"always" => ColorChoice::Always,
"ansi" => ColorChoice::AlwaysAnsi,
"auto" => {
if atty::is(stream) {
ColorChoice::Auto
} else {
ColorChoice::Never
}
}
_ => ColorChoice::Never,
}
}
/// A helper struct containing the emitters for stdout and stderr.
pub struct Emitters {
/// Emits to stdout
pub out: Emitter,
/// Emits to stderr
pub err: Emitter,
}
impl Emitters {
/// Create a new instance of this structure with the given preferences for
/// color output for each stream. These can be parsed from text using
/// [`parse_color_pref`].
#[must_use]
pub fn new(out_colors: ColorChoice, err_colors: ColorChoice) -> Self {
{
Self {
out: Emitter::new(BufferWriter::stdout(out_colors)),
err: Emitter::new(BufferWriter::stdout(err_colors)),
}
}
}
}
/// A structure handling emitting messages to the terminal. This [`Deref`]s and
/// [`DerefMut`]s to a [`termcolor::Buffer`], so you can use
/// [`termcolor::WriteColor`] and methods on `Buffer` to write custom text.
///
/// Note that text is never automatically flushed, so you must manually use
/// [`Emitter::flush`].
pub struct Emitter {
writer: BufferWriter,
buf: Buffer,
}
impl Emitter {
/// Create a new emitter.
pub fn new(writer: BufferWriter) -> Self {
let buf = writer.buffer();
Self { writer, buf }
}
/// Create a new buffer based on the color preferences of this emitter.
pub fn buffer(&self) -> Buffer {
self.writer.buffer()
}
/// Flush the emitter. This will clear the internal buffer.
///
/// # Errors
///
/// This function will error if the emitter could not print the contents of
/// the internal buffer.
pub fn flush(&mut self) -> CalResult<&mut Self> {
self.writer.print(&self.buf)?;
self.buf.clear();
Ok(self)
}
/// Add a newline to the internal buffer.
///
/// # Errors
///
/// This function will error if the buffer could not be updated.
pub fn newline(&mut self) -> CalResult<&mut Self> {
writeln!(self.buf)?;
Ok(self)
}
/// Add the string provided to the internal buffer verbatim. (Chainable)
///
/// # Errors
///
/// This function will error if the buffer could not be updated.
pub fn print(&mut self, s: &str) -> CalResult<&mut Self> {
write!(self.buf, "{}", s)?;
Ok(self)
}
/// Emit an error. Note that this function **will** reset the existing
/// color of the internal buffer. The emitted text will have a newline.
///
/// # Forms
///
/// Angle brackets (`<>`) indicate a string provided to the function.
///
/// ## Without `code` or `message`
///
/// ```text
/// error: <short>
/// ```
///
/// ## With `code` but not `message`
///
/// ```text
/// error[<code>]: <short>
/// ```
///
/// ## With `message` but not `code`
///
/// ```text
/// error: <short>: <message>
/// ```
///
/// ## With `code` and `message`
///
/// ```text
/// error[<code>]: <short>: <message>
/// ```
///
/// # Color
///
/// When color is enabled for the output provided, the segments will be
/// colored as such:
///
/// - `error[<code>]`: Red; bold, intense
/// - `<short>`: White; bold, intense
/// - `<message>`: Default color
///
/// # Errors
///
/// This function will error if at any point text could not be written to
/// the internal buffer.
pub fn error(
&mut self,
code: Option<&str>,
short: &str,
message: Option<&str>,
) -> CalResult<&mut Self> {
self.buf.set_color(
ColorSpec::new()
.set_fg(Some(Color::Red))
.set_bold(true)
.set_intense(true),
)?;
write!(self.buf, "error")?;
if let Some(code) = code {
write!(self.buf, "[{}]", code)?;
}
write!(self.buf, ": ")?;
self.buf.set_color(
ColorSpec::new()
.set_fg(Some(Color::White))
.set_bold(true)
.set_intense(true),
)?;
write!(self.buf, "{}", short)?;
if let Some(message) = message {
write!(self.buf, ": ")?;
self.buf.reset()?;
write!(self.buf, "{}", message)?;
}
writeln!(self.buf)?;
Ok(self)
}
fn message_general(
&mut self,
main: &'static str,
color: Color,
short: &str,
message: Option<&str>,
) -> CalResult<&mut Self> {
self.buf.set_color(
ColorSpec::new()
.set_fg(Some(color))
.set_bold(true)
.set_intense(true),
)?;
write!(self.buf, "{}: ", main)?;
self.buf.set_color(
ColorSpec::new()
.set_fg(Some(Color::White))
.set_bold(true)
.set_intense(true),
)?;
write!(self.buf, "{}", short)?;
if let Some(message) = message {
write!(self.buf, ": ")?;
self.buf.reset()?;
write!(self.buf, "{}", message)?;
}
writeln!(self.buf)?;
Ok(self)
}
/// Emit an informational message. Note that this function **will** reset
/// the existing color of the internal buffer. The emitted text will have a
/// newline.
///
/// # Forms
///
/// Angle brackets (`<>`) indicate a string provided to the function.
///
/// ## Without `message`
///
/// ```text
/// info: <short>
/// ```
///
/// ## With `message`
///
/// ```text
/// info: <short>: <message>
/// ```
///
/// # Color
///
/// When color is enabled for the output provided, the segments will be
/// colored as such:
///
/// - `info`: Cyan; bold, intense
/// - `<short>`: White; bold, intense
/// - `<message>`: Default color
///
/// # Errors
///
/// This function will error if at any point text could not be written to
/// the internal buffer.
pub fn info(&mut self, short: &str, message: Option<&str>) -> CalResult<&mut Self> {
self.message_general("info", Color::Cyan, short, message)
}
/// Emit a note. Note that this function **will** reset the existing color
/// of the internal buffer. The emitted text will have a newline.
///
/// # Forms
///
/// Angle brackets (`<>`) indicate a string provided to the function.
///
/// ## Without `message`
///
/// ```text
/// note: <short>
/// ```
///
/// ## With `message`
///
/// ```text
/// note: <short>: <message>
/// ```
///
/// # Color
///
/// When color is enabled for the output provided, the segments will be
/// colored as such:
///
/// - `note`: Green; bold, intense
/// - `<short>`: White; bold, intense
/// - `<message>`: Default color
///
/// # Errors
///
/// This function will error if at any point text could not be written to
/// the internal buffer.
pub fn note(&mut self, short: &str, message: Option<&str>) -> CalResult<&mut Self> {
self.message_general("note", Color::Green, short, message)
}
/// Emit a warning. Note that this function **will** reset the existing
/// color of the internal buffer. The emitted text will have a newline.
///
/// # Forms
///
/// Angle brackets (`<>`) indicate a string provided to the function.
///
/// ## Without `message`
///
/// ```text
/// warn: <short>
/// ```
///
/// ## With `message`
///
/// ```text
/// warn: <short>: <message>
/// ```
///
/// # Color
///
/// When color is enabled for the output provided, the segments will be
/// colored as such:
///
/// - `warn`: Yellow; bold, intense
/// - `<short>`: White; bold, intense
/// - `<message>`: Default color
///
/// # Errors
///
/// This function will error if at any point text could not be written to
/// the internal buffer.
pub fn warn(&mut self, short: &str, message: Option<&str>) -> CalResult<&mut Self> {
self.message_general("warn", Color::Yellow, short, message)
}
/// Emit a `Buffer` now.
///
/// Since we can't merge buffers (see
/// [termcolor#45](https://github.com/BurntSushi/termcolor/issues/45)),
/// this function directly prints the buffer instead of extending the
/// internal buffer with this one.
///
/// # Errors
///
/// This function will error
pub fn emit(&mut self, buf: &Buffer) -> CalResult<&mut Self> {
self.writer.print(buf)?;
Ok(self)
}
}
impl Deref for Emitter {
type Target = Buffer;
fn deref(&self) -> &Self::Target {
&self.buf
}
}
impl DerefMut for Emitter {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.buf
}
}