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
use std::fmt::Display;
use serde::{Deserialize, Serialize};
#[cfg(feature = "ansi")]
use anstyle;
#[cfg(feature = "ansi")]
use tint;
///
/// Terminal output style
#[derive(Clone, Debug, PartialEq, Eq, Default, Serialize, Deserialize)]
#[serde(default)]
pub struct Style {
/// The style's foreground colour, if it has one.
pub foreground: Option<Color>,
/// The style's background colour, if it has one.
pub background: Option<Color>,
/// Whether this style is bold.
pub bold: bool,
/// Whether this style is dimmed.
pub dimmed: bool,
/// Whether this style is italic.
pub italic: bool,
/// Whether this style is underlined.
pub underline: bool,
/// Whether this style is blinking.
pub blink: bool,
/// Whether this style has reverse colours.
pub reverse: bool,
/// Whether this style is hidden.
pub hidden: bool,
/// Whether this style is struckthrough.
pub strikethrough: bool,
}
/// A colour is one specific type of ANSI escape code, and can refer
/// to either the foreground or background colour.
///
/// These use the standard numeric sequences.
/// See <http://invisible-island.net/xterm/ctlseqs/ctlseqs.html>
#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(untagged, rename_all = "lowercase")]
pub enum Color {
/// Color #0 (foreground code `30`, background code `40`).
///
/// This is not necessarily the background colour, and using it as one may
/// render the text hard to read on terminals with dark backgrounds.
#[default]
Black,
/// Color #1 (foreground code `31`, background code `41`).
Red,
/// Color #2 (foreground code `32`, background code `42`).
Green,
/// Color #3 (foreground code `33`, background code `43`).
Yellow,
/// Color #4 (foreground code `34`, background code `44`).
Blue,
/// Color #5 (foreground code `35`, background code `45`).
Purple,
/// Color #6 (foreground code `36`, background code `46`).
Cyan,
/// Color #7 (foreground code `37`, background code `47`).
///
/// As above, this is not necessarily the foreground colour, and may be
/// hard to read on terminals with light backgrounds.
White,
/// A colour number from 0 to 255, for use in 256-colour terminal
/// environments.
///
/// - Colors 0 to 7 are the `Black` to `White` variants respectively. These
/// colours can usually be changed in the terminal emulator.
/// - Colors 8 to 15 are brighter versions of the eight colours above. These
/// can also usually be changed in the terminal emulator, or it could be
/// configured to use the original colours and show the text in bold
/// instead. It varies depending on the program.
/// - Colors 16 to 231 contain several palettes of bright colours, arranged
/// in six squares measuring six by six each.
/// - Colors 232 to 255 are shades of grey from black to white.
///
/// It might make more sense to look at a [colour chart][cc].
///
/// [cc]: https://upload.wikimedia.org/wikipedia/commons/1/15/Xterm_256color_chart.svg
Fixed(u8),
/// A 24-bit RGB color, as specified by ISO-8613-3.
RGB(u8, u8, u8),
/// A named color, as supported by `tint`.
Named(String),
}
impl Color {
#[cfg(feature = "ansi")]
fn to_ansi_color(&self) -> anstyle::Color {
match self {
Color::Black => anstyle::Color::Ansi(anstyle::AnsiColor::Black),
Color::Red => anstyle::Color::Ansi(anstyle::AnsiColor::Red),
Color::Green => anstyle::Color::Ansi(anstyle::AnsiColor::Green),
Color::Yellow => anstyle::Color::Ansi(anstyle::AnsiColor::Yellow),
Color::Blue => anstyle::Color::Ansi(anstyle::AnsiColor::Blue),
Color::Purple => anstyle::Color::Ansi(anstyle::AnsiColor::Magenta),
Color::Cyan => anstyle::Color::Ansi(anstyle::AnsiColor::Cyan),
Color::White => anstyle::Color::Ansi(anstyle::AnsiColor::White),
Color::Fixed(f) => anstyle::Color::Ansi256(anstyle::Ansi256Color(*f)),
Color::RGB(r, g, b) => anstyle::Color::Rgb(anstyle::RgbColor(*r, *g, *b)),
Color::Named(n) => match &n[..] {
// ANSI color names still take precedence over HTML and CSS colors,
// because only ANSI colors can be dimmed.
"black" => anstyle::Color::Ansi(anstyle::AnsiColor::Black),
"red" => anstyle::Color::Ansi(anstyle::AnsiColor::Red),
"green" => anstyle::Color::Ansi(anstyle::AnsiColor::Green),
"yellow" => anstyle::Color::Ansi(anstyle::AnsiColor::Yellow),
"blue" => anstyle::Color::Ansi(anstyle::AnsiColor::Blue),
"purple" => anstyle::Color::Ansi(anstyle::AnsiColor::Magenta),
"cyan" => anstyle::Color::Ansi(anstyle::AnsiColor::Cyan),
"white" => anstyle::Color::Ansi(anstyle::AnsiColor::White),
n => {
let c = tint::Color::from(n);
let (r, g, b) = c.to_rgb255();
anstyle::Color::Rgb(anstyle::RgbColor(r, g, b))
}
},
}
}
}
impl Style {
///
/// Paints `input` according to this style.
///
/// If the `"ansi"` feature is enabled, this function uses
/// `ansi_term` to style text.
///
/// If the `"ansi"` feature is disabled, this function
/// always returns the output unchanged.
pub fn paint(&self, input: impl Display) -> impl Display {
#[cfg(feature = "ansi")]
{
let mut ansi_style = anstyle::Style::new();
ansi_style = ansi_style.fg_color(self.foreground.as_ref().map(Color::to_ansi_color));
ansi_style = ansi_style.bg_color(self.background.as_ref().map(Color::to_ansi_color));
if self.bold {
ansi_style = ansi_style.bold();
}
if self.dimmed {
ansi_style = ansi_style.dimmed();
}
if self.italic {
ansi_style = ansi_style.italic();
}
if self.underline {
ansi_style = ansi_style.underline();
}
format!("{ansi_style}{}{ansi_style:#}", input)
}
#[cfg(not(feature = "ansi"))]
return input;
}
}
#[cfg(test)]
mod tests {
use super::*;
use serde_any;
#[cfg(feature = "ansi")]
use anstyle;
#[derive(Deserialize)]
pub struct Wrapper {
color: Color,
}
#[cfg(feature = "ansi")]
fn toml_to_ansi(s: &str) -> anstyle::Color {
serde_any::from_str::<Wrapper>(&format!("color = {}", s), serde_any::Format::Toml)
.unwrap()
.color
.to_ansi_color()
}
#[cfg(feature = "ansi")]
fn yaml_to_ansi(s: &str) -> anstyle::Color {
serde_any::from_str::<Wrapper>(&format!("color: {}", s), serde_any::Format::Yaml)
.unwrap()
.color
.to_ansi_color()
}
#[test]
#[cfg(feature = "ansi")]
fn color_from_toml() {
assert_eq!(toml_to_ansi("\"red\""), anstyle::Color::Ansi(anstyle::AnsiColor::Red));
assert_eq!(
toml_to_ansi("\"green\""),
anstyle::Color::Ansi(anstyle::AnsiColor::Green)
);
assert_eq!(toml_to_ansi("10"), anstyle::Color::Ansi256(anstyle::Ansi256Color(10)));
assert_eq!(toml_to_ansi("110"), anstyle::Color::Ansi256(anstyle::Ansi256Color(110)));
assert_eq!(
toml_to_ansi("[10, 20, 30]"),
anstyle::Color::Rgb(anstyle::RgbColor(10, 20, 30))
);
assert_eq!(
toml_to_ansi("\"maroon\""),
anstyle::Color::Rgb(anstyle::RgbColor(128, 0, 0))
);
assert_eq!(
toml_to_ansi("\"steelblue\""),
anstyle::Color::Rgb(anstyle::RgbColor(70, 130, 180))
);
assert_eq!(
toml_to_ansi("\"#4682B4\""),
anstyle::Color::Rgb(anstyle::RgbColor(70, 130, 180))
);
}
#[test]
#[cfg(feature = "ansi")]
fn color_from_yaml() {
assert_eq!(yaml_to_ansi("\"red\""), anstyle::Color::Ansi(anstyle::AnsiColor::Red));
assert_eq!(
yaml_to_ansi("\"green\""),
anstyle::Color::Ansi(anstyle::AnsiColor::Green)
);
assert_eq!(yaml_to_ansi("10"), anstyle::Color::Ansi256(anstyle::Ansi256Color(10)));
assert_eq!(yaml_to_ansi("110"), anstyle::Color::Ansi256(anstyle::Ansi256Color(110)));
assert_eq!(
yaml_to_ansi("[10, 20, 30]"),
anstyle::Color::Rgb(anstyle::RgbColor(10, 20, 30))
);
assert_eq!(
yaml_to_ansi("\"maroon\""),
anstyle::Color::Rgb(anstyle::RgbColor(128, 0, 0))
);
assert_eq!(
yaml_to_ansi("\"steelblue\""),
anstyle::Color::Rgb(anstyle::RgbColor(70, 130, 180))
);
assert_eq!(
yaml_to_ansi("\"#4682B4\""),
anstyle::Color::Rgb(anstyle::RgbColor(70, 130, 180))
);
}
#[test]
fn style_from_toml() {
let toml = "foreground = \"#102030\"\nbackground = 3\ndimmed = true\nbold = true";
let actual = serde_any::from_str::<Style>(toml, serde_any::Format::Toml).unwrap();
let expected = Style {
dimmed: true,
bold: true,
foreground: Some(Color::Named("#102030".to_string())),
background: Some(Color::Fixed(3)),
..Style::default()
};
assert_eq!(actual, expected);
}
}