rio-config 0.0.27

Rio terminal config.
Documentation
use crate::colors::{ColorArray, ColorBuilder, ColorRgb, Format};
use std::ops::{Index, IndexMut};

use crate::colors::defaults;
use crate::colors::NamedColor;

/// Number of terminal colors.
pub const COUNT: usize = 269;

/// > The 256 color table and its partitioning
///
/// The color range of a 256 color terminal consists of 4 parts,
/// often 5, in which case you actually get 258 colors:
///
/// Color numbers 0 to 7 are the default terminal colors, the actual RGB
/// value of which is not standardized and can often be configured.
///
/// Color numbers 8 to 15 are the "bright" colors. Most of the time these are a
/// lighter shade of the color with index - 8. They are also not standardized and
/// can often be configured. Depending on terminal and shell, they are often used instead of or in conjunction with bold font faces.
///
/// Color numbers 16 to 231 are RGB colors.
/// These 216 colors are defined by 6 values on each of the three RGB axes.
/// That is, instead of values 0 - 255, each color only ranges from 0 - 5.
///
/// The color number is then calculated like this:
/// number = 16 + 36 * r + 6 * g + b
/// with r, g and b in the range 0 - 5.
///
/// The color numbers 232 to 255 are grayscale with 24 shades
/// of gray from dark to light.
///
/// The default colors for foreground and background.
/// In many terminals they can be configured independently from the
/// 256 indexed colors, giving an additional two configurable colors.
/// You get them when not setting any other color or disabling other colors
/// (i.e. print '\e[m').

#[derive(Copy, Debug, Clone)]
pub struct TermColors([Option<ColorArray>; COUNT]);

impl Default for TermColors {
    fn default() -> Self {
        Self([None; COUNT])
    }
}

impl Index<usize> for TermColors {
    type Output = Option<ColorArray>;

    #[inline]
    fn index(&self, index: usize) -> &Self::Output {
        &self.0[index]
    }
}

impl IndexMut<usize> for TermColors {
    #[inline]
    fn index_mut(&mut self, index: usize) -> &mut Self::Output {
        &mut self.0[index]
    }
}

impl Index<NamedColor> for TermColors {
    type Output = Option<ColorArray>;

    #[inline]
    fn index(&self, index: NamedColor) -> &Self::Output {
        &self.0[index as usize]
    }
}

impl IndexMut<NamedColor> for TermColors {
    #[inline]
    fn index_mut(&mut self, index: NamedColor) -> &mut Self::Output {
        &mut self.0[index as usize]
    }
}

#[derive(Copy, Debug, Clone)]
pub struct List([ColorArray; COUNT]);

impl<'a> From<&'a TermColors> for List {
    fn from(_colors: &TermColors) -> List {
        // Type inference fails without this annotation.
        let mut list = List([ColorArray::default(); COUNT]);

        list.fill_named();
        list.fill_cube();
        list.fill_gray_ramp();

        list
    }
}

impl List {
    pub fn fill_named(&mut self) {
        self[NamedColor::Black] = defaults::black();
        self[NamedColor::Red] = defaults::red();
        self[NamedColor::Green] = defaults::green();
        self[NamedColor::Yellow] = defaults::yellow();
        self[NamedColor::Blue] = defaults::blue();
        self[NamedColor::Magenta] = defaults::magenta();
        self[NamedColor::Cyan] = defaults::cyan();
        self[NamedColor::White] = defaults::white();
        self[NamedColor::LightBlack] = defaults::light_black();
        self[NamedColor::LightRed] = defaults::light_red();
        self[NamedColor::LightGreen] = defaults::light_green();
        self[NamedColor::LightYellow] = defaults::light_yellow();
        self[NamedColor::LightBlue] = defaults::light_blue();
        self[NamedColor::LightMagenta] = defaults::light_magenta();
        self[NamedColor::LightCyan] = defaults::light_cyan();
        self[NamedColor::LightWhite] = defaults::light_white();
        self[NamedColor::LightForeground] = defaults::light_foreground();
        self[NamedColor::Foreground] = defaults::foreground();
        self[NamedColor::Background] = defaults::background().0;
        self[NamedColor::DimForeground] = defaults::dim_foreground();
        self[NamedColor::DimBlack] = defaults::dim_black();
        self[NamedColor::DimRed] = defaults::dim_red();
        self[NamedColor::DimGreen] = defaults::dim_green();
        self[NamedColor::DimYellow] = defaults::dim_yellow();
        self[NamedColor::DimBlue] = defaults::dim_blue();
        self[NamedColor::DimMagenta] = defaults::dim_magenta();
        self[NamedColor::DimCyan] = defaults::dim_cyan();
        self[NamedColor::DimWhite] = defaults::dim_white();
    }

    pub fn fill_cube(&mut self) {
        let mut index: usize = 16;
        // Build colors.
        for r in 0..6 {
            for g in 0..6 {
                for b in 0..6 {
                    let rgb = ColorRgb {
                        r: if r == 0 { 0 } else { r * 40 + 55 },
                        b: if b == 0 { 0 } else { b * 40 + 55 },
                        g: if g == 0 { 0 } else { g * 40 + 55 },
                    };

                    let arr = ColorBuilder::from_rgb(rgb, Format::SRGB0_1).to_arr();
                    self[index] = arr;
                    index += 1;
                }
            }
        }

        debug_assert!(index == 232);
    }

    pub fn fill_gray_ramp(&mut self) {
        let mut index: usize = 232;

        for i in 0..24 {
            let value = i * 10 + 8;
            let rgb = ColorRgb {
                r: value,
                g: value,
                b: value,
            };
            let arr = ColorBuilder::from_rgb(rgb, Format::SRGB0_1).to_arr();
            self[index] = arr;
            index += 1;
        }

        debug_assert!(index == 256);
    }
}

impl Index<usize> for List {
    type Output = ColorArray;

    #[inline]
    fn index(&self, idx: usize) -> &Self::Output {
        &self.0[idx]
    }
}

impl IndexMut<usize> for List {
    #[inline]
    fn index_mut(&mut self, idx: usize) -> &mut Self::Output {
        &mut self.0[idx]
    }
}

impl Index<NamedColor> for List {
    type Output = ColorArray;

    #[inline]
    fn index(&self, idx: NamedColor) -> &Self::Output {
        &self.0[idx as usize]
    }
}

impl IndexMut<NamedColor> for List {
    #[inline]
    fn index_mut(&mut self, idx: NamedColor) -> &mut Self::Output {
        &mut self.0[idx as usize]
    }
}