colored/control.rs
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 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
//! A couple of functions to enable and disable coloring.
use std::default::Default;
use std::env;
use std::io::{self, IsTerminal};
use std::sync::atomic::{AtomicBool, Ordering};
/// Sets a flag to the console to use a virtual terminal environment.
///
/// This is primarily used for Windows 10 environments which will not correctly colorize
/// the outputs based on ANSI escape codes.
///
/// The returned `Result` is _always_ `Ok(())`, the return type was kept to ensure backwards
/// compatibility.
///
/// # Notes
/// > Only available to `Windows` build targets.
///
/// # Example
/// ```rust
/// use colored::*;
/// control::set_virtual_terminal(false).unwrap();
/// println!("{}", "bright cyan".bright_cyan()); // will print '[96mbright cyan[0m' on windows 10
///
/// control::set_virtual_terminal(true).unwrap();
/// println!("{}", "bright cyan".bright_cyan()); // will print correctly
/// ```
#[allow(clippy::result_unit_err)]
#[cfg(windows)]
pub fn set_virtual_terminal(use_virtual: bool) -> Result<(), ()> {
use windows_sys::Win32::System::Console::{
GetConsoleMode, GetStdHandle, SetConsoleMode, ENABLE_VIRTUAL_TERMINAL_PROCESSING,
STD_OUTPUT_HANDLE,
};
unsafe {
let handle = GetStdHandle(STD_OUTPUT_HANDLE);
let mut original_mode = 0;
GetConsoleMode(handle, &mut original_mode);
let enabled = original_mode & ENABLE_VIRTUAL_TERMINAL_PROCESSING
== ENABLE_VIRTUAL_TERMINAL_PROCESSING;
match (use_virtual, enabled) {
// not enabled, should be enabled
(true, false) => {
SetConsoleMode(handle, ENABLE_VIRTUAL_TERMINAL_PROCESSING | original_mode)
}
// already enabled, should be disabled
(false, true) => {
SetConsoleMode(handle, ENABLE_VIRTUAL_TERMINAL_PROCESSING ^ original_mode)
}
_ => 0,
};
}
Ok(())
}
/// A flag for whether coloring should occur.
pub struct ShouldColorize {
clicolor: bool,
clicolor_force: Option<bool>,
// XXX we can't use Option<Atomic> because we can't use &mut references to ShouldColorize
has_manual_override: AtomicBool,
manual_override: AtomicBool,
}
/// Use this to force colored to ignore the environment and always/never colorize
/// See example/control.rs
pub fn set_override(override_colorize: bool) {
SHOULD_COLORIZE.set_override(override_colorize)
}
/// Remove the manual override and let the environment decide if it's ok to colorize
/// See example/control.rs
pub fn unset_override() {
SHOULD_COLORIZE.unset_override()
}
lazy_static! {
/// The persistent [`ShouldColorize`].
pub static ref SHOULD_COLORIZE: ShouldColorize = ShouldColorize::from_env();
}
impl Default for ShouldColorize {
fn default() -> ShouldColorize {
ShouldColorize {
clicolor: true,
clicolor_force: None,
has_manual_override: AtomicBool::new(false),
manual_override: AtomicBool::new(false),
}
}
}
impl ShouldColorize {
/// Reads environment variables and checks if output is a tty to determine
/// whether colorization should be used or not.
/// `CLICOLOR_FORCE` takes highest priority, followed by `NO_COLOR`,
/// followed by `CLICOLOR` combined with tty check.
pub fn from_env() -> Self {
ShouldColorize {
clicolor: ShouldColorize::normalize_env(env::var("CLICOLOR")).unwrap_or(true)
&& io::stdout().is_terminal(),
clicolor_force: ShouldColorize::resolve_clicolor_force(
env::var("NO_COLOR"),
env::var("CLICOLOR_FORCE"),
),
..ShouldColorize::default()
}
}
/// Returns if the current coloring is expected.
pub fn should_colorize(&self) -> bool {
if self.has_manual_override.load(Ordering::Relaxed) {
return self.manual_override.load(Ordering::Relaxed);
}
if let Some(forced_value) = self.clicolor_force {
return forced_value;
}
self.clicolor
}
/// Use this to force colored to ignore the environment and always/never colorize
pub fn set_override(&self, override_colorize: bool) {
self.has_manual_override.store(true, Ordering::Relaxed);
self.manual_override
.store(override_colorize, Ordering::Relaxed);
}
/// Remove the manual override and let the environment decide if it's ok to colorize
pub fn unset_override(&self) {
self.has_manual_override.store(false, Ordering::Relaxed);
}
/* private */
fn normalize_env(env_res: Result<String, env::VarError>) -> Option<bool> {
match env_res {
Ok(string) => Some(string != "0"),
Err(_) => None,
}
}
fn resolve_clicolor_force(
no_color: Result<String, env::VarError>,
clicolor_force: Result<String, env::VarError>,
) -> Option<bool> {
if ShouldColorize::normalize_env(clicolor_force) == Some(true) {
Some(true)
} else if ShouldColorize::normalize_env(no_color).is_some() {
Some(false)
} else {
None
}
}
}
#[cfg(test)]
mod specs {
use super::*;
use rspec;
use rspec::context::*;
use std::env;
#[test]
fn clicolor_behavior() {
use std::io;
let stdout = &mut io::stdout();
let mut formatter = rspec::formatter::Simple::new(stdout);
let mut runner = describe("ShouldColorize", |ctx| {
ctx.describe("::normalize_env", |ctx| {
ctx.it("should return None if error", || {
assert_eq!(
None,
ShouldColorize::normalize_env(Err(env::VarError::NotPresent))
);
assert_eq!(
None,
ShouldColorize::normalize_env(Err(env::VarError::NotUnicode("".into())))
)
});
ctx.it("should return Some(true) if != 0", || {
Some(true) == ShouldColorize::normalize_env(Ok(String::from("1")))
});
ctx.it("should return Some(false) if == 0", || {
Some(false) == ShouldColorize::normalize_env(Ok(String::from("0")))
});
});
ctx.describe("::resolve_clicolor_force", |ctx| {
ctx.it(
"should return None if NO_COLOR is not set and CLICOLOR_FORCE is not set or set to 0",
|| {
assert_eq!(
None,
ShouldColorize::resolve_clicolor_force(
Err(env::VarError::NotPresent),
Err(env::VarError::NotPresent)
)
);
assert_eq!(
None,
ShouldColorize::resolve_clicolor_force(
Err(env::VarError::NotPresent),
Ok(String::from("0")),
)
);
},
);
ctx.it(
"should return Some(false) if NO_COLOR is set and CLICOLOR_FORCE is not enabled",
|| {
assert_eq!(
Some(false),
ShouldColorize::resolve_clicolor_force(
Ok(String::from("0")),
Err(env::VarError::NotPresent)
)
);
assert_eq!(
Some(false),
ShouldColorize::resolve_clicolor_force(
Ok(String::from("1")),
Err(env::VarError::NotPresent)
)
);
assert_eq!(
Some(false),
ShouldColorize::resolve_clicolor_force(
Ok(String::from("1")),
Ok(String::from("0")),
)
);
},
);
ctx.it(
"should prioritize CLICOLOR_FORCE over NO_COLOR if CLICOLOR_FORCE is set to non-zero value",
|| {
assert_eq!(
Some(true),
ShouldColorize::resolve_clicolor_force(
Ok(String::from("1")),
Ok(String::from("1")),
)
);
assert_eq!(
Some(false),
ShouldColorize::resolve_clicolor_force(
Ok(String::from("1")),
Ok(String::from("0")),
)
);
assert_eq!(
Some(true),
ShouldColorize::resolve_clicolor_force(
Err(env::VarError::NotPresent),
Ok(String::from("1")),
)
);
},
);
});
ctx.describe("constructors", |ctx| {
ctx.it("should have a default constructor", || {
ShouldColorize::default();
});
ctx.it("should have an environment constructor", || {
ShouldColorize::from_env();
});
});
ctx.describe("when only changing clicolors", |ctx| {
ctx.it("clicolor == false means no colors", || {
let colorize_control = ShouldColorize {
clicolor: false,
..ShouldColorize::default()
};
false == colorize_control.should_colorize()
});
ctx.it("clicolor == true means colors !", || {
let colorize_control = ShouldColorize {
clicolor: true,
..ShouldColorize::default()
};
true == colorize_control.should_colorize()
});
ctx.it("unset clicolors implies true", || {
true == ShouldColorize::default().should_colorize()
});
});
ctx.describe("when using clicolor_force", |ctx| {
ctx.it(
"clicolor_force should force to true no matter clicolor",
|| {
let colorize_control = ShouldColorize {
clicolor: false,
clicolor_force: Some(true),
..ShouldColorize::default()
};
true == colorize_control.should_colorize()
},
);
ctx.it(
"clicolor_force should force to false no matter clicolor",
|| {
let colorize_control = ShouldColorize {
clicolor: true,
clicolor_force: Some(false),
..ShouldColorize::default()
};
false == colorize_control.should_colorize()
},
);
});
ctx.describe("using a manual override", |ctx| {
ctx.it("shoud colorize if manual_override is true, but clicolor is false and clicolor_force also false", || {
let colorize_control = ShouldColorize {
clicolor: false,
clicolor_force: None,
has_manual_override: AtomicBool::new(true),
manual_override: AtomicBool::new(true),
.. ShouldColorize::default()
};
true == colorize_control.should_colorize()
});
ctx.it("should not colorize if manual_override is false, but clicolor is true or clicolor_force is true", || {
let colorize_control = ShouldColorize {
clicolor: true,
clicolor_force: Some(true),
has_manual_override: AtomicBool::new(true),
manual_override: AtomicBool::new(false),
.. ShouldColorize::default()
};
false == colorize_control.should_colorize()
})
});
ctx.describe("::set_override", |ctx| {
ctx.it("should exists", || {
let colorize_control = ShouldColorize::default();
colorize_control.set_override(true);
});
ctx.it("set the manual_override property", || {
let colorize_control = ShouldColorize::default();
colorize_control.set_override(true);
{
assert_eq!(
true,
colorize_control.has_manual_override.load(Ordering::Relaxed)
);
let val = colorize_control.manual_override.load(Ordering::Relaxed);
assert_eq!(true, val);
}
colorize_control.set_override(false);
{
assert_eq!(
true,
colorize_control.has_manual_override.load(Ordering::Relaxed)
);
let val = colorize_control.manual_override.load(Ordering::Relaxed);
assert_eq!(false, val);
}
});
});
ctx.describe("::unset_override", |ctx| {
ctx.it("should exists", || {
let colorize_control = ShouldColorize::default();
colorize_control.unset_override();
});
ctx.it("unset the manual_override property", || {
let colorize_control = ShouldColorize::default();
colorize_control.set_override(true);
colorize_control.unset_override();
assert_eq!(
false,
colorize_control.has_manual_override.load(Ordering::Relaxed)
);
});
});
});
runner.add_event_handler(&mut formatter);
runner.run().unwrap();
}
}