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
/// The Colour enum is used to set the colours in the Terminal
///
/// The available colours come from the ANSI_escape_codes
/// <https://en.wikipedia.org/wiki/ANSI_escape_code#Colors>

#[derive(Copy, Clone, Debug, PartialEq)]
pub enum Colour {
    Black,
    Red,
    Green,
    Yellow,
    Blue,
    Magenta,
    Cyan,
    White,
    BrightBlack,
    BrightRed,
    BrightGreen,
    BrightYellow,
    BrightBlue,
    BrightMagenta,
    BrightCyan,
    BrightWhite,
}

impl Colour {
    /// Get the enum value from a string
    ///
    /// ```
    /// use terminal_graphics::Colour;
    ///
    /// let black = Colour::of("Black");
    /// assert_eq!(Colour::Black, black);
    /// ```
    pub fn of(colour: &str) -> Colour {
        match colour {
            "Black" => Colour::Black,
            "Red" => Colour::Red,
            "Green" => Colour::Green,
            "Yellow" => Colour::Yellow,
            "Blue" => Colour::Blue,
            "Magenta" => Colour::Magenta,
            "Cyan"  => Colour::Cyan,
            "White" => Colour::White,
            "BrightBlack" => Colour::BrightBlack,
            "BrightRed" => Colour::BrightRed,
            "BrightGreen" => Colour::BrightGreen,
            "BrightYellow" => Colour::BrightYellow,
            "BrightBlue" => Colour::BrightBlue,
            "BrightMagenta" => Colour::BrightMagenta,
            "BrightCyan"  => Colour::BrightCyan,
            "BrightWhite" => Colour::BrightWhite,
            _   => Colour::White,
        }
    }

    pub fn to_str(&self) -> &str {
        match *self {
            Colour::Black => "Black",
            Colour::Red => "Red",
            Colour::Green => "Green",
            Colour::Yellow => "Yellow",
            Colour::Blue => "Blue",
            Colour::Magenta => "Magenta",
            Colour::Cyan => "Cyan",
            Colour::White => "White",
            Colour::BrightBlack => "BrightBlack",
            Colour::BrightRed => "BrightRed",
            Colour::BrightGreen => "BrightGreen",
            Colour::BrightYellow => "BrightYellow",
            Colour::BrightBlue => "BrightBlue",
            Colour::BrightMagenta => "BrightMagenta",
            Colour::BrightCyan => "BrightCyan",
            Colour::BrightWhite => "BrightWhite",
        }
    }

    /// Returns an array of all the colours.
    /// Useful for iterating over the enum.
    ///
    /// ```
    /// use terminal_graphics::Colour;
    ///
    /// assert_eq!(Colour::variants().len(), 16);
    /// ```
    pub fn variants() -> [Colour; 16] {
        [Colour::Black,
        Colour::Red,
        Colour::Green,
        Colour::Yellow,
        Colour::Blue,
        Colour::Magenta,
        Colour::Cyan,
        Colour::White,
        Colour::BrightBlack,
        Colour::BrightRed,
        Colour::BrightGreen,
        Colour::BrightYellow,
        Colour::BrightBlue,
        Colour::BrightMagenta,
        Colour::BrightCyan,
        Colour::BrightWhite]
    }

    /// Get the enum value from an RGB value.
    /// Finds the closest colour using euclidean distance.
    ///
    /// ```
    /// use terminal_graphics::Colour;
    ///
    /// assert_eq!(Colour::Black, Colour::from_rgb(0,0,0));
    /// assert_eq!(Colour::BrightWhite, Colour::from_rgb(255,255,255));
    /// assert_eq!(Colour::BrightGreen, Colour::from_rgb(0, 255, 0));
    /// ```
    pub fn from_rgb(red: u8, green: u8, blue: u8) -> Colour {

        let mut closest = Colour::Black;
        let mut distance: f64 = 1000.00;

        for colour in Colour::variants().iter() {
            // find the distance between this rbg value and the colour
            let (r, g, b) = colour.get_rbg();
            let red_1 = r as f64;
            let blue_1 = b as f64;
            let green_1 = g as f64;
            let red_2 = red as f64;
            let blue_2 = blue as f64;
            let green_2 = green as f64;
            let this_distance = ((red_1 - red_2).powi(2) +
                                (green_1 - green_2).powi(2) +
                                (blue_1 - blue_2).powi(2)).sqrt();
            if this_distance < distance {
                closest = Colour::of(colour.to_str());
                distance = this_distance;
            }
        }

        closest
    }

    /// Gets the values for the colour:
    /// from <https://en.wikipedia.org/wiki/ANSI_escape_code#Colors>
    ///
    /// ```
    /// use terminal_graphics::Colour;
    ///
    /// let red = Colour::Red;
    /// let (character_colour, background_colour) = red.get_codes();
    ///
    /// assert_eq!(character_colour, 31);
    /// assert_eq!(background_colour, 41);
    /// ```
    pub fn get_codes(&self) -> (u32, u32) {
        match *self {
            Colour::Black => (30, 40),
            Colour::Red => (31, 41),
            Colour::Green => (32, 42),
            Colour::Yellow => (33, 43),
            Colour::Blue => (34, 44),
            Colour::Magenta => (35, 45),
            Colour::Cyan => (36, 46),
            Colour::White => (37, 47),
            Colour::BrightBlack => (90, 100),
            Colour::BrightRed => (91, 101),
            Colour::BrightGreen => (92, 102),
            Colour::BrightYellow => (93, 103),
            Colour::BrightBlue => (94, 104),
            Colour::BrightMagenta => (95, 105),
            Colour::BrightCyan => (96, 106),
            Colour::BrightWhite => (97, 107),
        }
    }

    /// Gets the RBG tiple for the colour.
    ///
    /// ```
    /// use terminal_graphics::Colour;
    ///
    /// let cyan = Colour::Cyan;
    /// let (r, b, g) = cyan.get_rbg();
    ///
    /// assert_eq!(r, 0);
    /// assert_eq!(b, 128);
    /// assert_eq!(g, 128);
    /// ```
    pub fn get_rbg(&self) -> (u8, u8, u8) {
        match *self {
            Colour::Black => (0, 0, 0),
            Colour::Red => (128, 0, 0),
            Colour::Green => (0, 128, 0),
            Colour::Yellow => (128, 128, 0),
            Colour::Blue => (0, 0, 128),
            Colour::Magenta => (128, 0, 128),
            Colour::Cyan => (0, 128, 128),
            Colour::White => (128, 128, 128),
            Colour::BrightBlack => (85, 0, 0),
            Colour::BrightRed => (255, 0, 0),
            Colour::BrightGreen => (0, 255, 0),
            Colour::BrightYellow => (255, 255, 0),
            Colour::BrightBlue => (0, 0, 255),
            Colour::BrightMagenta => (255, 0, 255),
            Colour::BrightCyan => (0, 255, 255),
            Colour::BrightWhite => (255, 255, 255),
        }
    }
}