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
//! ANSI-256 colors.
use palette::convert::FromColorUnclamped;
use palette::{Oklch, SetHue, Srgb};
use std::borrow::Borrow;
use std::fmt;
use crate::base16::Base16;
use crate::color::Gray;
#[derive(Copy, Clone, Debug, PartialEq)]
pub struct Ansi256Color {
pub index: u8,
pub srgb: Srgb<u8>,
pub oklch: Oklch,
}
impl Ansi256Color {
/// Construct color info from ANSI-256 index.
///
/// # Examples
///
/// ```rust
/// use approx::assert_abs_diff_eq;
/// use palette::Srgb;
/// # use colors_by_example::ansi256::Ansi256Color;
///
/// let color = Ansi256Color::new(208, 255, 135, 0);
///
/// assert_eq!(color.index, 208);
/// assert_eq!(color.srgb, Srgb::new(255u8, 135, 0));
///
/// // cross-check with https://ajalt.github.io/colormath/converter/
/// // sRGB (0-255) 255, 135, 0
/// // Oklab 0.74264, 0.10158, 0.15067
/// // Oklch 0.74264, 0.18171, 56.01118
///
/// assert_abs_diff_eq!(color.oklch.l, 0.74264, epsilon = 0.0001);
/// assert_abs_diff_eq!(color.oklch.chroma, 0.18171, epsilon = 0.0001);
/// assert_abs_diff_eq!(color.oklch.hue.into_inner(), 56.01118, epsilon = 0.0001);
/// ```
pub fn new(index: u8, r: u8, g: u8, b: u8) -> Self {
let srgb = Srgb::new(r, g, b);
let srgb_linear = srgb.into_linear::<f32>();
let mut oklch = Oklch::from_color_unclamped(srgb_linear);
if srgb.is_gray() {
oklch.set_hue(0.0);
}
Self { index, srgb, oklch }
}
}
impl fmt::Display for Ansi256Color {
// This trait requires `fmt` with this exact signature.
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(
f,
"index: {}, srgb({},{},{}), Oklch: l:{} chroma:{} hue: {}",
self.index,
self.srgb.red,
self.srgb.green,
self.srgb.blue,
self.oklch.l,
self.oklch.chroma,
self.oklch.hue.into_inner(),
)
}
}
impl Gray for Ansi256Color {
fn is_gray(&self) -> bool {
self.srgb.is_gray()
}
}
#[derive(Debug)]
pub struct Ansi256Colors {
colors: Vec<Ansi256Color>,
}
impl Ansi256Colors {
/// Construct all ANSI-256 colors with provided palette.
///
/// # Examples
///
/// ```rust
/// # use colors_by_example::ansi256::Ansi256Colors;
/// use colors_by_example::base16::DEFAULT;
///
/// let colors = Ansi256Colors::new(DEFAULT);
/// assert_eq!(colors.as_slice().len(), 256);
/// ```
pub fn new<T: Borrow<Base16>>(base16: T) -> Self {
const CUBE: [u8; 6] = [0, 95, 135, 175, 215, 255];
// start index of 6x6x6 cube
const CUBE666_START: u8 = 16;
// start index of grayscale
const GRAYSCALE_START: u8 = 232;
let &Base16(base16) = base16.borrow();
// chain ranges of:
// 1. 0 - 15: platform dependent palette
// 2. 16 - 231: cube 6x6x6 colors
// 3. 232 - 255: grayscale
let rgb_channels = base16
.into_iter()
.chain(((16u8 - CUBE666_START)..=(231u8 - CUBE666_START)).map(|x| {
[
CUBE[(x / 36) as usize],
CUBE[(x / 6 % 6) as usize],
CUBE[(x % 6) as usize],
]
}))
.chain(
((232u8 - GRAYSCALE_START)..=(255u8 - GRAYSCALE_START)).map(|x| [x * 10 + 8; 3]),
);
Self {
colors: rgb_channels
.enumerate()
.map(|(index, channels)| {
Ansi256Color::new(index as u8, channels[0], channels[1], channels[2])
})
.collect::<Vec<_>>(),
}
}
/// Return Oklch from ANSI-256 index.
///
/// # Examples
///
/// ```rust
/// use approx::assert_abs_diff_eq;
/// # use colors_by_example::ansi256::Ansi256Colors;
///
/// let colors = Ansi256Colors::default();
/// let oklch = colors.oklch_from_index(208);
///
/// // cross-check with https://ajalt.github.io/colormath/converter/
/// // Oklch 0.74264, 0.18171, 56.01118
/// assert_abs_diff_eq!(oklch.l, 0.74264, epsilon = 0.0001);
/// assert_abs_diff_eq!(oklch.chroma, 0.18171, epsilon = 0.0001);
/// assert_abs_diff_eq!(oklch.hue.into_inner(), 56.01118, epsilon = 0.0001);
/// ```
pub fn oklch_from_index(&self, index: u8) -> Oklch {
self.colors[index as usize].oklch
}
/// Return SRGB from ANSI-256 index.
///
/// # Examples
///
/// ```rust
/// use palette::Srgb;
/// # use colors_by_example::ansi256::Ansi256Colors;
///
/// let colors = Ansi256Colors::default();
/// let srgb = colors.srgb_from_index(208);
///
/// assert_eq!(srgb, Srgb::new(255, 135, 0));
/// ```
pub fn srgb_from_index(&self, index: u8) -> Srgb<u8> {
self.colors[index as usize].srgb
}
/// Extracts a slice containing the entire range of colors.
pub fn as_slice(&self) -> &[Ansi256Color] {
&self.colors
}
}
impl AsRef<Ansi256Colors> for Ansi256Colors {
fn as_ref(&self) -> &Ansi256Colors {
self
}
}
impl Default for Ansi256Colors {
fn default() -> Self {
Self::new(Base16::default())
}
}
/// Indexes of gray in ANSI-256 which is not platform dependent.
///
/// Gray colors are ordered pure black to pure white in increasing intensities.
pub const GRAY_INDEXES: [u8; 26] = [
16_u8, // black
232, 233, 234, 235, 236, 237, 238, 239, 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250,
251, 252, 253, 254, 255, 231, // white
];
#[cfg(test)]
mod tests {
use crate::base16::TERMINAL_APP;
use super::*;
#[test]
fn test_ansi256_colors() {
let colors = Ansi256Colors::new(TERMINAL_APP);
// color in platform dependent palette
insta::assert_yaml_snapshot!(colors.srgb_from_index(2));
// color in cube 6x6x6
insta::assert_yaml_snapshot!(colors.srgb_from_index(30));
// color in grayscale range
insta::assert_yaml_snapshot!(colors.srgb_from_index(253));
}
#[test]
fn test_ansi256_grayscale() {
let colors = Ansi256Colors::default();
let black = colors.srgb_from_index(GRAY_INDEXES[0]);
assert_eq!(black, Srgb::new(0, 0, 0));
let white = colors.srgb_from_index(GRAY_INDEXES[25]);
assert_eq!(white, Srgb::new(255, 255, 255));
for i in 1..25 {
let c = colors.srgb_from_index(GRAY_INDEXES[i]);
assert_eq!(c.red, c.green);
assert_eq!(c.green, c.blue);
}
}
}