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
//! This crate offers a couple of macros to easily print colored and formatted //! text to a terminal. It is basically just a convenience API on top of //! [`termcolor`](https://crates.io/crates/termcolor). Thus, some understanding //! of `termcolor` is useful to use `bunt`. //! //! Mini example: //! //! ``` //! let ty = "u32"; //! bunt::println!("{$bold+red}error:{/$} invalid value for type `{[blue]}`", ty); //! ``` //! //! # Format string syntax //! //! The macros in this crate have almost the same syntax as the corresponding //! `std::fmt` macros: arguments are inserted with `{}` and braces are escaped //! with `{{` and `}}`. `bunt` has two additions to that syntax: //! //! ## Style tags //! //! With `{$style_spec}...{/$}`, you can apply a style to a section of your //! string (which can also contain arguments). The start tag `{$...}` contains //! the style specification, while the end tag is always `{/$}`. These tags can //! also be nested. //! //! ``` //! bunt::println!("normal color ... {$yellow}Yellow :){/$} ... normal color again"); //! bunt::println!("{$bold}This is bold. {$red}This is also red!{/$} Just bold again{/$}."); //! ``` //! //!Each opening tag needs a matching closing one and the other way around. //! //! ```compile_fail //! bunt::println!("{$red}unclosed tag :o"); //! ``` //! //! ```compile_fail //! bunt::println!("{$red}close it once{/$} and close it another time 🙁 {/$}"); //! ``` //! //! ## Styled arguments //! //! If you want to style an argument, you can use tags right before and after //! that argument. However, there is also a shorthand syntax: `{[style_spec] //! ...}`. You can still use the syntax for named arguments, positional //! arguments, width, fill/alignmen, precision, formatting traits and everything //! else from `std::fmt` after the `[...]`. //! //! ``` //! // Normal output via `Display`. Equivalent to `"value: {$green}{}{/$}"` //! bunt::println!("value: {[green]}", 27); //! //! // Output via `Debug`. All argument formatting syntax from `fmt` works //! // inside the braces, after the `[...]`. //! bunt::println!("value: {[green]:?}", vec![1, 2, 3]); //! //! // Named argument + precision specified: works. //! bunt::println!("value: {[green]foo:.5}", foo = 3.14); //! ``` //! //! ## Style specification //! //! `bunt` has the same capabilities as `termcolor`. See [`termcolor::Color`] //! and [`termcolor::ColorSpec`] for more information. The syntax for style //! specs in `bunt` is a simple list of fragments that are joined by `+`. //! Examples: //! //! - `red` //! - `#ff8030+bold` //! - `yellow+italic+intense` //! - `bg:white+blue+bold` //! //! Full list of allowed fragments: //! //! - Colors: //! - `black`, `blue`, `green`, `red`, `cyan`, `magenta`, `yellow`, `white` //! - RGB as hex string: `#rrggbb`, e.g. `#27ae60` //! - (yes, there is currently no syntax for `Color::Ansi256` because I //! couldn't come up with a nice syntax and I never used these ansi //! colors...) //! - Background colors: same as colors but prefixed with `bg:`, e.g. `bg:blue` //! or `bg:#c0392b` //! - Attributes: //! - `bold` //! - `italic` //! - `underline` //! - `intense` //! //! `bunt` macros make sure that your style spec makes sense (only one //! foreground/background color is allowed, duplicated attributes are not //! allowed). Invalid style specs result in a compile error. //! //! ```compile_fail //! bunt::println!("{$red+blue}what{/$}"); //! ``` //! //! ```compile_fail //! bunt::println!("{$bold+red+bold}you don't have to say it twice buddy{/$}"); //! ``` //! //! //! [`termcolor::Color`]: https://docs.rs/termcolor/1.1.0/termcolor/enum.Color.html //! [`termcolor::ColorSpec`]: https://docs.rs/termcolor/1.1.0/termcolor/struct.ColorSpec.html //! //! //! # Available macros //! //! - [`write`] and [`writeln`]: print to a `termcolor::WriteColor` instance. //! - [`print`] and [`println`]: print to stdout. //! - [`eprint`] and [`eprintln`]: print to stderr. //! - [`style`]: parses a format specification and returns the corresponding //! `termcolor::ColorSpec` value. //! //! In larger applications, you should probably use `write!` and `writeln!` to //! have more control over how the stdout/stderr handle is created. You usually //! want to give your users the choice of color usage, e.g. via a `--color` CLI //! argument. //! #![deny(intra_doc_link_resolution_failure)] // Reexport of `termcolor`. This is mostly to be used by the code generated by // the macros. pub extern crate termcolor; // To consistently refer to the macros crate. #[doc(hidden)] pub extern crate bunt_macros; /// Writes formatted data to a `termcolor::WriteColor` target. /// /// This is a more general version of `print` as you can specify the destination /// of the formatted data as first parameter. `write` also returns a `Result<(), /// std::io::Error>` which is `Err` in case writing to the target or setting the /// color fails. `print!` simply panics in that case. /// /// ``` /// use bunt::termcolor::{ColorChoice, StandardStream}; /// /// // Choosing a different color choice, just to show something `println` /// // can't do. /// let mut stdout = StandardStream::stdout(ColorChoice::Always); /// let result = bunt::write!(stdout, "{$red}bad error!{/$}"); /// /// if result.is_err() { /// // Writing to stdout failed... /// } /// ``` /// /// See crate-level docs for more information. // pub use bunt_macros::write; #[macro_export] macro_rules! write { ($target:expr, $format_str:literal $(, $arg:expr)* $(,)?) => { $crate::bunt_macros::write!( $target $format_str $( $arg )* ) }; } /// Writes formatted data with newline to a `termcolor::WriteColor` target. /// /// Like [`write!`], but adds a newline (`\n`) at the end. /// /// ``` /// use bunt::termcolor::{ColorChoice, StandardStream}; /// /// // Choosing a different color choice, just to show something `println` /// // can't do. /// let mut stdout = StandardStream::stdout(ColorChoice::Always); /// let _ = bunt::writeln!(stdout, "{$red}bad error!{/$}"); /// ``` /// /// See crate-level docs for more information. #[macro_export] macro_rules! writeln { ($target:expr, $format_str:literal $(, $arg:expr)* $(,)?) => { $crate::bunt_macros::writeln!( $target $format_str $( $arg )* ) }; } /// Writes formatted data to stdout (with `ColorChoice::Auto`). /// /// This is like `write`, but always writes to /// `StandardStream::stdout(termcolor::ColorChoice::Auto)`. `print` also does /// not return a result, but instead panics if an error occurs writing to /// stdout. /// /// ``` /// bunt::print!("{$magenta}foo {[bold]} bar{/$}", 27); /// ``` /// /// See crate-level docs for more information. #[macro_export] macro_rules! print { ($format_str:literal $(, $arg:expr)* $(,)?) => { $crate::bunt_macros::write!( ($crate::termcolor::StandardStream::stdout($crate::termcolor::ColorChoice::Auto)) $format_str $( $arg )* ).expect("failed to write to stdout in `bunt::print`") }; } /// Writes formatted data with newline to stdout (with `ColorChoice::Auto`). /// /// Like [`print!`], but adds a newline (`\n`) at the end. /// /// ``` /// bunt::println!("{$cyan}foo {[bold]} bar{/$}", true); /// ``` /// /// See crate-level docs for more information. #[macro_export] macro_rules! println { ($format_str:literal $(, $arg:expr)* $(,)?) => { $crate::bunt_macros::writeln!( ($crate::termcolor::StandardStream::stdout($crate::termcolor::ColorChoice::Auto)) $format_str $( $arg )* ).expect("failed to write to stdout in `bunt::println`") }; } /// Writes formatted data to stderr (with `ColorChoice::Auto`). /// /// This is like `write`, but always writes to /// `StandardStream::stderr(termcolor::ColorChoice::Auto)`. `eprint` also does /// not return a result, but instead panics if an error occurs writing to /// stderr. /// /// ``` /// bunt::eprint!("{$magenta}foo {[bold]} bar{/$}", 27); /// ``` /// /// See crate-level docs for more information. #[macro_export] macro_rules! eprint { ($format_str:literal $(, $arg:expr)* $(,)?) => { $crate::bunt_macros::write!( ($crate::termcolor::StandardStream::stderr($crate::termcolor::ColorChoice::Auto)) $format_str $( $arg )* ).expect("failed to write to stderr in `bunt::eprint`") }; } /// Writes formatted data with newline to stderr (with `ColorChoice::Auto`). /// /// Like [`eprint!`], but adds a newline (`\n`) at the end. /// /// ``` /// bunt::eprintln!("{$cyan}foo {[bold]} bar{/$}", true); /// ``` /// /// See crate-level docs for more information. #[macro_export] macro_rules! eprintln { ($format_str:literal $(, $arg:expr)* $(,)?) => { $crate::bunt_macros::writeln!( ($crate::termcolor::StandardStream::stderr($crate::termcolor::ColorChoice::Auto)) $format_str $( $arg )* ).expect("failed to write to stderr in `bunt::eprintln`") }; } /// Parses the given style specification string and returns the corresponding /// `termcolor::ColorSpec` value. /// /// ``` /// use bunt::termcolor::{Color, ColorChoice, StandardStream, WriteColor}; /// /// let style = bunt::style!("red+bold+bg:yellow"); /// let mut stdout = StandardStream::stdout(ColorChoice::Auto); /// stdout.set_color(&style)?; /// /// assert_eq!(style.fg(), Some(&Color::Red)); /// assert_eq!(style.bg(), Some(&Color::Yellow)); /// assert!(style.bold()); /// assert!(!style.italic()); /// assert!(!style.underline()); /// assert!(!style.intense()); /// # std::io::Result::Ok(()) /// ``` /// /// See crate-level docs for more information. pub use bunt_macros::style;