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
use super::*;
use yansi::Paint;
pub struct Characters {
pub hbar: char,
pub vbar: char,
pub xbar: char,
pub vbar_break: char,
pub vbar_gap: char,
pub uarrow: char,
pub rarrow: char,
pub ltop: char,
pub mtop: char,
pub rtop: char,
pub lbot: char,
pub rbot: char,
pub mbot: char,
pub lbox: char,
pub rbox: char,
pub lcross: char,
pub rcross: char,
pub underbar: char,
pub underline: char,
}
impl Characters {
pub fn unicode() -> Self {
Self {
hbar: '─',
vbar: '│',
xbar: '┼',
vbar_break: '┆',
vbar_gap: '┆',
uarrow: '▲',
rarrow: '▶',
ltop: '╭',
mtop: '┬',
rtop: '╮',
lbot: '╰',
mbot: '┴',
rbot: '╯',
lbox: '[',
rbox: ']',
lcross: '├',
rcross: '┤',
underbar: '┬',
underline: '─',
}
}
pub fn ascii() -> Self {
Self {
hbar: '-',
vbar: '|',
xbar: '+',
vbar_break: '*',
vbar_gap: ':',
uarrow: '^',
rarrow: '>',
ltop: ',',
mtop: 'v',
rtop: '.',
lbot: '`',
mbot: '^',
rbot: '\'',
lbox: '[',
rbox: ']',
lcross: '|',
rcross: '|',
underbar: '|',
underline: '^',
}
}
}
/// Output stream to check for whether color is enabled.
#[derive(Clone, Copy, Debug)]
pub enum StreamType {
/// Standard Output
Stdout,
/// Standard Error
Stderr,
}
#[cfg(feature = "concolor")]
impl From<StreamType> for concolor::Stream {
fn from(s: StreamType) -> Self {
match s {
StreamType::Stdout => concolor::Stream::Stdout,
StreamType::Stderr => concolor::Stream::Stderr,
}
}
}
/// A trait used to add formatting attributes to displayable items intended to be written to a
/// particular stream (`stdout` or `stderr`).
///
/// Attributes specified through this trait are not composable (i.e: the behaviour of two nested attributes each with a
/// conflicting attribute is left unspecified).
pub trait StreamAwareFmt: Sized {
#[cfg(feature = "concolor")]
/// Returns true if color is enabled for the given stream.
fn color_enabled_for(s: StreamType) -> bool {
concolor::get(s.into()).color()
}
#[cfg(not(feature = "concolor"))]
#[doc(hidden)]
fn color_enabled_for(_: StreamType) -> bool {
true
}
/// Give this value the specified foreground colour, when color is enabled for the specified stream.
fn fg<C: Into<Option<Color>>>(self, color: C, stream: StreamType) -> Foreground<Self> {
if Self::color_enabled_for(stream) {
Foreground(self, color.into())
} else {
Foreground(self, None)
}
}
/// Give this value the specified background colour, when color is enabled for the specified stream.
fn bg<C: Into<Option<Color>>>(self, color: C, stream: StreamType) -> Background<Self> {
if Self::color_enabled_for(stream) {
Background(self, color.into())
} else {
Background(self, None)
}
}
}
impl<T: fmt::Display> StreamAwareFmt for T {}
/// A trait used to add formatting attributes to displayable items.
///
/// If using the `concolor` feature, this trait assumes that the items are going to be printed to
/// `stderr`. If you are printing to `stdout`, `use` the [`StdoutFmt`] trait instead.
///
/// Attributes specified through this trait are not composable (i.e: the behaviour of two nested attributes each with a
/// conflicting attribute is left unspecified).
pub trait Fmt: Sized {
/// Give this value the specified foreground colour.
fn fg<C: Into<Option<Color>>>(self, color: C) -> Foreground<Self>
where
Self: fmt::Display,
{
if cfg!(feature = "concolor") {
StreamAwareFmt::fg(self, color, StreamType::Stderr)
} else {
Foreground(self, color.into())
}
}
/// Give this value the specified background colour.
fn bg<C: Into<Option<Color>>>(self, color: C) -> Background<Self>
where
Self: fmt::Display,
{
if cfg!(feature = "concolor") {
StreamAwareFmt::bg(self, color, StreamType::Stdout)
} else {
Background(self, color.into())
}
}
}
impl<T: fmt::Display> Fmt for T {}
/// A trait used to add formatting attributes to displayable items intended to be written to `stdout`.
///
/// Attributes specified through this trait are not composable (i.e: the behaviour of two nested attributes each with a
/// conflicting attribute is left unspecified).
#[cfg(any(feature = "concolor", doc))]
pub trait StdoutFmt: StreamAwareFmt {
/// Give this value the specified foreground colour, when color is enabled for `stdout`.
fn fg<C: Into<Option<Color>>>(self, color: C) -> Foreground<Self> {
StreamAwareFmt::fg(self, color, StreamType::Stdout)
}
/// Give this value the specified background colour, when color is enabled for `stdout`.
fn bg<C: Into<Option<Color>>>(self, color: C) -> Background<Self> {
StreamAwareFmt::bg(self, color, StreamType::Stdout)
}
}
#[cfg(feature = "concolor")]
impl<T: fmt::Display> StdoutFmt for T {}
#[derive(Copy, Clone, Debug)]
pub struct Foreground<T>(T, Option<Color>);
impl<T: fmt::Display> fmt::Display for Foreground<T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
if let Some(col) = self.1 {
write!(f, "{}", Paint::new(&self.0).fg(col))
} else {
write!(f, "{}", self.0)
}
}
}
#[derive(Copy, Clone, Debug)]
pub struct Background<T>(T, Option<Color>);
impl<T: fmt::Display> fmt::Display for Background<T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
if let Some(col) = self.1 {
write!(f, "{}", Paint::new(&self.0).bg(col))
} else {
write!(f, "{}", self.0)
}
}
}
/// A type that can generate distinct 8-bit colors.
pub struct ColorGenerator {
state: [u16; 3],
min_brightness: f32,
}
impl Default for ColorGenerator {
fn default() -> Self {
Self::from_state([30000, 15000, 35000], 0.5)
}
}
impl ColorGenerator {
/// Create a new [`ColorGenerator`] with the given pre-chosen state.
///
/// The minimum brightness can be used to control the colour brightness (0.0 - 1.0). The default is 0.5.
pub fn from_state(state: [u16; 3], min_brightness: f32) -> Self {
Self {
state,
min_brightness: min_brightness.max(0.0).min(1.0),
}
}
/// Create a new [`ColorGenerator`] with the default state.
pub fn new() -> Self {
Self::default()
}
/// Generate the next colour in the sequence.
#[allow(clippy::should_implement_trait)]
pub fn next(&mut self) -> Color {
for i in 0..3 {
// magic constant, one of only two that have this property!
self.state[i] = (self.state[i] as usize).wrapping_add(40503 * (i * 4 + 1130)) as u16;
}
Color::Fixed(
16 + ((self.state[2] as f32 / 65535.0 * (1.0 - self.min_brightness)
+ self.min_brightness)
* 5.0
+ (self.state[1] as f32 / 65535.0 * (1.0 - self.min_brightness)
+ self.min_brightness)
* 30.0
+ (self.state[0] as f32 / 65535.0 * (1.0 - self.min_brightness)
+ self.min_brightness)
* 180.0) as u8,
)
}
}