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
use core::fmt;
#[cfg(all(feature = "alloc", not(feature = "std")))]
use alloc::{string::{String, ToString}, borrow::Cow};
#[cfg(feature = "std")]
use std::borrow::Cow;
use crate::{Color, Attribute, Quirk, Style, Condition};
/// An arbitrary value with a [`Style`] applied to it.
///
/// A `Painted` can be directly formatted. This results in the internal
/// [`value`](Self::value) being formatted as specified and ANSI code styling
/// sequences corresponding to [`style`](Self::style) being prefixed and
/// suffixed as necessary. Both the global and local [`Condition`] affects
/// whether styling sequences are actually emitted: both must evaluated to true.
/// Otherwise, no styling sequences are emitted.
///
/// ```rust
/// use yansi::{Paint, Condition};
///
/// println!("Hello, {}!", "world".red().underline().blink());
/// // > Hello, world! # world is red, underlined, and blinking
///
/// let v = format!("{}", "world".red().underline().blink());
/// assert_eq!(v, "\u{1b}[4;5;31mworld\u{1b}[0m");
/// println!("{}", v); // > world # world is red, underlined, and blinking
///
/// let v = format!("{}", "world".red().underline().blink().whenever(Condition::NEVER));
/// assert_eq!(v, "world");
/// ```
#[derive(Copy, Clone)]
pub struct Painted<T> {
/// The value to be styled.
pub value: T,
/// The style to apply.
pub style: Style,
}
/// A trait to apply styling to any value, implemented for all types.
///
/// See the [crate level docs](crate#usage) for usage details.
pub trait Paint {
/// Create a new [`Painted`] with a default [`Style`].
///
/// # Example
///
/// ```rust
/// use yansi::Paint;
///
/// let painted = Paint::new("hello");
/// assert_eq!(painted.style, yansi::Style::new());
/// ```
#[inline(always)]
fn new(self) -> Painted<Self> where Self: Sized {
Painted::new(self)
}
#[doc(hidden)]
#[inline(always)]
fn apply(&self, a: crate::style::Application) -> Painted<&Self> {
Painted::new(self).apply(a)
}
/// Apply a style wholesale to `self`. Any previous style is replaced.
///
/// # Example
///
/// ```rust
/// use yansi::{Paint, Style, Color::*};
///
/// static DEBUG: Style = Black.bold().on_yellow();
///
/// let painted = "hello".paint(DEBUG);
/// ```
#[inline(always)]
fn paint<S: Into<Style>>(&self, style: S) -> Painted<&Self> {
Painted { value: self, style: style.into() }
}
properties!(signature(&Self) -> Painted<&Self>);
}
#[allow(rustdoc::broken_intra_doc_links)]
impl<T: ?Sized> Paint for T {
properties!(constructor(&Self) -> Painted<&Self>);
}
impl<T> Painted<T> {
/// Create a new [`Painted`] with a default [`Style`].
///
/// # Example
///
/// ```rust
/// use yansi::Painted;
///
/// let painted = Painted::new("hello");
/// assert_eq!(painted.style, yansi::Style::new());
/// ```
#[inline(always)]
pub const fn new(value: T) -> Painted<T> {
Painted { value, style: Style::new() }
}
#[inline(always)]
const fn apply(mut self, a: crate::style::Application) -> Self {
self.style = self.style.apply(a);
self
}
#[inline]
pub(crate) fn enabled(&self) -> bool {
crate::is_enabled() && self.style.condition.map_or(true, |c| c())
}
properties!([pub const] constructor(Self) -> Self);
}
impl<T> Painted<T> {
pub(crate) fn color_fmt_value(
&self,
fmt: &dyn Fn(&T, &mut fmt::Formatter) -> fmt::Result,
f: &mut fmt::Formatter,
) -> fmt::Result {
self.style.fmt_prefix(f)?;
fmt(&self.value, f)?;
self.style.fmt_suffix(f)
}
#[cfg(feature = "alloc")]
pub(crate) fn clear_fmt_args(
&self,
fmt: &dyn Fn(&T, &mut fmt::Formatter) -> fmt::Result,
f: &mut fmt::Formatter,
args: &fmt::Arguments<'_>,
) -> fmt::Result {
// A tiny state machine to find escape sequences.
enum State { Searching, Open, }
let mut state = State::Searching;
let escape = |c: char| {
match state {
State::Searching if c == '\x1B' => { state = State::Open; true }
State::Open if c == 'm' => { state = State::Searching; true }
State::Searching => false,
State::Open => true,
}
};
// Only replace when the string contains styling.
let string = args.as_str()
.map(|string| Cow::Borrowed(string))
.unwrap_or_else(|| Cow::Owned(args.to_string()));
if string.contains('\x1B') {
f.write_str(&string.replace(escape, ""))
} else {
fmt(&self.value, f)
}
}
#[cfg(feature = "alloc")]
pub(crate) fn color_wrap_fmt_args(
&self,
fmt: &dyn Fn(&T, &mut fmt::Formatter) -> fmt::Result,
f: &mut fmt::Formatter,
args: &fmt::Arguments<'_>,
) -> fmt::Result {
// Only replace when the string contains styling.
let string = args.as_str()
.map(|string| Cow::Borrowed(string))
.unwrap_or_else(|| Cow::Owned(args.to_string()));
if !string.contains('\x1B') {
return self.color_fmt_value(fmt, f);
}
// Compute the prefix for the style with a reset in front.
let mut prefix = String::new();
prefix.push_str("\x1B[0m");
self.style.fmt_prefix(&mut prefix)?;
// Write out formatted string, replacing resets with computed prefix.
self.style.fmt_prefix(f)?;
write!(f, "{}", string.replace("\x1B[0m", &prefix))?;
self.style.fmt_suffix(f)
}
pub(crate) fn fmt_args(
&self,
fmt: &dyn Fn(&T, &mut fmt::Formatter) -> fmt::Result,
f: &mut fmt::Formatter,
_args: fmt::Arguments<'_>,
) -> fmt::Result {
let enabled = self.enabled();
let masked = self.style.quirks.contains(Quirk::Mask);
#[cfg(not(feature = "alloc"))]
match (enabled, masked) {
(true, _) => self.color_fmt_value(fmt, f),
(false, false) => fmt(&self.value, f),
(false, true) => Ok(()),
}
#[cfg(feature = "alloc")]
match (enabled, masked, self.style.quirks.contains(Quirk::Wrap)) {
(true, _, true) => self.color_wrap_fmt_args(fmt, f, &_args),
(true, _, false) => self.color_fmt_value(fmt, f),
(false, false, true) => self.clear_fmt_args(fmt, f, &_args),
(false, false, false) => fmt(&self.value, f),
(false, true, _) => Ok(()),
}
}
}
impl_fmt_traits!(<T> Painted<T> => self.value (T));
impl<T> From<Painted<T>> for Style {
fn from(painted: Painted<T>) -> Self {
painted.style
}
}