/* * meli * * Copyright 2017-2018 Manos Pitsidianakis * * This file is part of meli. * * meli is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * meli is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with meli. If not, see . */ /*! Define a (x, y) point in the terminal display as a holder of a character, foreground/background colors and attributes. */ use super::position::*; use crate::state::Context; use melib::text_processing::wcwidth; use serde::{de, Deserialize, Deserializer, Serialize, Serializer}; use std::convert::From; use std::fmt; use std::ops::{Deref, DerefMut, Index, IndexMut}; use termion::color::{AnsiValue, Rgb as TermionRgb}; /// In a scroll region up and down cursor movements shift the region vertically. The new lines are /// empty. /// /// See `CellBuffer::scroll_up` and `CellBuffer::scroll_down` for an explanation of how `xterm` /// scrolling works. #[derive(Debug, Clone, PartialEq, Eq, Default)] pub struct ScrollRegion { pub top: usize, pub bottom: usize, pub left: usize, pub right: usize, } /// An array of `Cell`s that represents a terminal display. /// /// A `CellBuffer` is a two-dimensional array of `Cell`s, each pair of indices correspond to a /// single point on the underlying terminal. /// /// The first index, `Cellbuffer[y]`, corresponds to a row, and thus the y-axis. The second /// index, `Cellbuffer[y][x]`, corresponds to a column within a row and thus the x-axis. #[derive(Clone, PartialEq, Eq)] pub struct CellBuffer { cols: usize, rows: usize, buf: Vec, /// ASCII-only flag. pub ascii_drawing: bool, /// If printing to this buffer and we run out of space, expand it. growable: bool, } impl fmt::Debug for CellBuffer { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!( f, "CellBuffer {{ cols: {}, rows: {}, buf: {} cells", self.cols, self.rows, self.buf.len() ) } } impl CellBuffer { pub fn area(&self) -> Area { ( (0, 0), (self.cols.saturating_sub(1), self.rows.saturating_sub(1)), ) } pub fn set_cols(&mut self, new_cols: usize) { self.cols = new_cols; } /// Constructs a new `CellBuffer` with the given number of columns and rows, using the given /// `cell` as a blank. pub fn new(cols: usize, rows: usize, cell: Cell) -> CellBuffer { CellBuffer { cols, rows, buf: vec![cell; cols * rows], growable: false, ascii_drawing: false, } } pub fn new_with_context(cols: usize, rows: usize, cell: Cell, context: &Context) -> CellBuffer { CellBuffer { cols, rows, buf: vec![cell; cols * rows], growable: false, ascii_drawing: context.settings.terminal.ascii_drawing, } } pub fn set_ascii_drawing(&mut self, new_val: bool) { self.ascii_drawing = new_val; } pub fn set_growable(&mut self, new_val: bool) { self.growable = new_val; } /// Resizes `CellBuffer` to the given number of rows and columns, using the given `Cell` as /// a blank. pub fn resize(&mut self, newcols: usize, newrows: usize, blank: Cell) { let newlen = newcols * newrows; if self.buf.len() == newlen { self.cols = newcols; self.rows = newrows; return; } if newlen >= 200_000 { return; } let mut newbuf: Vec = Vec::with_capacity(newlen); for y in 0..newrows { for x in 0..newcols { let cell = self.get(x, y).unwrap_or(&blank); newbuf.push(*cell); } } self.buf = newbuf; self.cols = newcols; self.rows = newrows; } pub fn is_empty(&self) -> bool { self.buf.is_empty() } pub fn empty(&mut self) { self.buf.clear(); self.cols = 0; self.rows = 0; } /// Clears `self`, using the given `Cell` as a blank. pub fn clear(&mut self, blank: Cell) { for cell in self.cellvec_mut().iter_mut() { *cell = blank; } } pub fn pos_to_index(&self, x: usize, y: usize) -> Option { let (cols, rows) = self.size(); if x < cols && y < rows { Some((cols * y) + x) } else { None } } /// Returns a reference to the `Cell` at the given coordinates, or `None` if the index is out of /// bounds. /// /// # Examples /// /// ```no_run /// /// let mut term = Terminal::new().unwrap(); /// /// let a_cell = term.get(5, 5); /// ``` pub fn get(&self, x: usize, y: usize) -> Option<&Cell> { match self.pos_to_index(x, y) { Some(i) => self.cellvec().get(i), None => None, } } /// Returns a mutable reference to the `Cell` at the given coordinates, or `None` if the index /// is out of bounds. /// /// # Examples /// /// ```no_run /// /// let mut term = Terminal::new().unwrap(); /// /// let a_mut_cell = term.get_mut(5, 5); /// ``` pub fn get_mut(&mut self, x: usize, y: usize) -> Option<&mut Cell> { match self.pos_to_index(x, y) { Some(i) => self.cellvec_mut().get_mut(i), None => None, } } pub fn size(&self) -> (usize, usize) { (self.cols, self.rows) } pub fn cellvec(&self) -> &Vec { &self.buf } pub fn cellvec_mut(&mut self) -> &mut Vec { &mut self.buf } pub fn cols(&self) -> usize { self.size().0 } pub fn rows(&self) -> usize { self.size().1 } #[inline(always)] /// Performs the normal scroll up motion: /// /// First clear offset number of lines: /// /// For offset = 1, top = 1: /// /// ```text /// | 111111111111 | | | /// | 222222222222 | | 222222222222 | /// | 333333333333 | | 333333333333 | /// | 444444444444 | --> | 444444444444 | /// | 555555555555 | | 555555555555 | /// | 666666666666 | | 666666666666 | /// ``` /// /// In each step, swap the current line with the next by offset: /// /// ```text /// | | | 222222222222 | /// | 222222222222 | | | /// | 333333333333 | | 333333333333 | /// | 444444444444 | --> | 444444444444 | /// | 555555555555 | | 555555555555 | /// | 666666666666 | | 666666666666 | /// ``` /// /// Result: /// ```text /// Before After /// | 111111111111 | | 222222222222 | /// | 222222222222 | | 333333333333 | /// | 333333333333 | | 444444444444 | /// | 444444444444 | | 555555555555 | /// | 555555555555 | | 666666666666 | /// | 666666666666 | | | /// ``` /// pub fn scroll_up(&mut self, scroll_region: &ScrollRegion, top: usize, offset: usize) { //debug!( // "scroll_up scroll_region {:?}, top: {} offset {}", // scroll_region, top, offset //); let l = scroll_region.left; let r = if scroll_region.right == 0 { self.size().0 } else { scroll_region.right }; for y in top..=(top + offset - 1) { for x in l..r { self[(x, y)] = Cell::default(); } } for y in top..=(scroll_region.bottom - offset) { for x in l..r { let temp = self[(x, y)]; self[(x, y)] = self[(x, y + offset)]; self[(x, y + offset)] = temp; } } } #[inline(always)] /// Performs the normal scroll down motion: /// /// First clear offset number of lines: /// /// For offset = 1, top = 1: /// /// ```text /// | 111111111111 | | 111111111111 | /// | 222222222222 | | 222222222222 | /// | 333333333333 | | 333333333333 | /// | 444444444444 | --> | 444444444444 | /// | 555555555555 | | 555555555555 | /// | 666666666666 | | | /// ``` /// /// In each step, swap the current line with the prev by offset: /// /// ```text /// | 111111111111 | | 111111111111 | /// | 222222222222 | | 222222222222 | /// | 333333333333 | | 333333333333 | /// | 444444444444 | --> | 444444444444 | /// | 555555555555 | | | /// | | | 555555555555 | /// ``` /// /// Result: /// ```text /// Before After /// | 111111111111 | | | /// | 222222222222 | | 111111111111 | /// | 333333333333 | | 222222222222 | /// | 444444444444 | | 333333333333 | /// | 555555555555 | | 444444444444 | /// | 666666666666 | | 555555555555 | /// ``` /// pub fn scroll_down(&mut self, scroll_region: &ScrollRegion, top: usize, offset: usize) { //debug!( // "scroll_down scroll_region {:?}, top: {} offset {}", // scroll_region, top, offset //); for y in (scroll_region.bottom - offset + 1)..=scroll_region.bottom { for x in 0..self.size().0 { self[(x, y)] = Cell::default(); } } for y in ((top + offset)..=scroll_region.bottom).rev() { for x in 0..self.size().0 { let temp = self[(x, y)]; self[(x, y)] = self[(x, y - offset)]; self[(x, y - offset)] = temp; } } } /// See `BoundsIterator` documentation. pub fn bounds_iter(&self, area: Area) -> BoundsIterator { BoundsIterator { rows: std::cmp::min(self.rows.saturating_sub(1), get_y(upper_left!(area))) ..(std::cmp::min(self.rows, get_y(bottom_right!(area)) + 1)), cols: ( std::cmp::min(self.cols.saturating_sub(1), get_x(upper_left!(area))), std::cmp::min(self.cols, get_x(bottom_right!(area)) + 1), ), } } /// See `RowIterator` documentation. pub fn row_iter(&self, bounds: std::ops::Range, row: usize) -> RowIterator { if row < self.rows { RowIterator { row, col: std::cmp::min(self.cols.saturating_sub(1), bounds.start) ..(std::cmp::min(self.cols, bounds.end)), } } else { RowIterator { row, col: 0..0 } } } } impl Deref for CellBuffer { type Target = [Cell]; fn deref(&self) -> &[Cell] { &self.buf } } impl DerefMut for CellBuffer { fn deref_mut(&mut self) -> &mut [Cell] { &mut self.buf } } impl Index for CellBuffer { type Output = Cell; fn index(&self, index: Pos) -> &Cell { let (x, y) = index; self.get(x, y).expect("index out of bounds") } } impl IndexMut for CellBuffer { fn index_mut(&mut self, index: Pos) -> &mut Cell { let (x, y) = index; self.get_mut(x, y).expect("index out of bounds") } } impl Default for CellBuffer { /// Constructs a new `CellBuffer` with a size of `(0, 0)`, using the default `Cell` as a blank. fn default() -> CellBuffer { CellBuffer::new(0, 0, Cell::default()) } } impl fmt::Display for CellBuffer { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { '_y: for y in 0..self.rows { for x in 0..self.cols { let c: &char = &self[(x, y)].ch(); write!(f, "{}", *c).unwrap(); if *c == '\n' { continue '_y; } } } Ok(()) } } /// A single point on a terminal display. /// /// A `Cell` contains a character and style. #[derive(Debug, Copy, Clone, PartialEq, Eq)] pub struct Cell { ch: char, /// Set a `Cell` as empty when a previous cell spans multiple columns and it would /// "overflow" to this cell. empty: bool, fg: Color, bg: Color, attrs: Attr, keep_fg: bool, keep_bg: bool, } impl Cell { /// Creates a new `Cell` with the given `char`, `Color`s and `Attr`. /// /// # Examples /// /// ```no_run /// let cell = Cell::new('x', Color::Default, Color::Green, Attr::Default); /// assert_eq!(cell.ch(), 'x'); /// assert_eq!(cell.fg(), Color::Default); /// assert_eq!(cell.bg(), Color::Green); /// assert_eq!(cell.attrs(), Attr::Default); /// ``` pub fn new(ch: char, fg: Color, bg: Color, attrs: Attr) -> Cell { Cell { ch, fg, bg, attrs, empty: false, keep_fg: false, keep_bg: false, } } /// Creates a new `Cell` with the given `char` and default style. /// /// # Examples /// /// ```no_run /// let mut cell = Cell::with_char('x'); /// assert_eq!(cell.ch(), 'x'); /// assert_eq!(cell.fg(), Color::Default); /// assert_eq!(cell.bg(), Color::Default); /// assert_eq!(cell.attrs(), Attr::Default); /// ``` pub fn with_char(ch: char) -> Cell { Cell::new(ch, Color::Default, Color::Default, Attr::Default) } /// Creates a new `Cell` with the given style and a blank `char`. /// /// # Examples /// /// ```no_run /// let mut cell = Cell::with_style(Color::Default, Color::Red, Attr::Bold); /// assert_eq!(cell.fg(), Color::Default); /// assert_eq!(cell.bg(), Color::Red); /// assert_eq!(cell.attrs(), Attr::Bold); /// assert_eq!(cell.ch(), ' '); /// ``` pub fn with_style(fg: Color, bg: Color, attr: Attr) -> Cell { Cell::new(' ', fg, bg, attr) } /// Returns the `Cell`'s character. /// /// # Examples /// /// ```no_run /// let mut cell = Cell::with_char('x'); /// assert_eq!(cell.ch(), 'x'); /// ``` pub fn ch(&self) -> char { self.ch } /// Sets the `Cell`'s character to the given `char` /// /// # Examples /// /// ```no_run /// let mut cell = Cell::with_char('x'); /// assert_eq!(cell.ch(), 'x'); /// /// cell.set_ch('y'); /// assert_eq!(cell.ch(), 'y'); /// ``` pub fn set_ch(&mut self, newch: char) -> &mut Cell { self.ch = newch; self.keep_fg = false; self.keep_bg = false; self } /// Returns the `Cell`'s foreground `Color`. /// /// # Examples /// /// ```no_run /// let mut cell = Cell::with_style(Color::Blue, Color::Default, Attr::Default); /// assert_eq!(cell.fg(), Color::Blue); /// ``` pub fn fg(&self) -> Color { self.fg } /// Sets the `Cell`'s foreground `Color` to the given `Color`. /// /// # Examples /// /// ```no_run /// let mut cell = Cell::default(); /// assert_eq!(cell.fg(), Color::Default); /// /// cell.set_fg(Color::White); /// assert_eq!(cell.fg(), Color::White); /// ``` pub fn set_fg(&mut self, newfg: Color) -> &mut Cell { if !self.keep_fg { self.fg = newfg; } self } /// Returns the `Cell`'s background `Color`. /// /// # Examples /// /// ```no_run /// let mut cell = Cell::with_style(Color::Default, Color::Green, Attr::Default); /// assert_eq!(cell.bg(), Color::Green); /// ``` pub fn bg(&self) -> Color { self.bg } /// Sets the `Cell`'s background `Color` to the given `Color`. /// /// # Examples /// /// ```no_run /// let mut cell = Cell::default(); /// assert_eq!(cell.bg(), Color::Default); /// /// cell.set_bg(Color::Black); /// assert_eq!(cell.bg(), Color::Black); /// ``` pub fn set_bg(&mut self, newbg: Color) -> &mut Cell { if !self.keep_bg { self.bg = newbg; } self } pub fn attrs(&self) -> Attr { self.attrs } pub fn set_attrs(&mut self, newattrs: Attr) -> &mut Cell { self.attrs = newattrs; self } /// Set a `Cell` as empty when a previous cell spans multiple columns and it would /// "overflow" to this cell. pub fn empty(&self) -> bool { self.empty } pub fn set_empty(&mut self, new_val: bool) -> &mut Cell { self.empty = new_val; self } /// Sets `keep_fg` field. If true, the foreground color will not be altered if attempted so /// until the character content of the cell is changed. pub fn set_keep_fg(&mut self, new_val: bool) -> &mut Cell { self.keep_fg = new_val; self } /// Sets `keep_bg` field. If true, the background color will not be altered if attempted so /// until the character content of the cell is changed. pub fn set_keep_bg(&mut self, new_val: bool) -> &mut Cell { self.keep_bg = new_val; self } } impl Default for Cell { /// Constructs a new `Cell` with a blank `char` and default `Color`s. /// /// # Examples /// /// ```no_run /// let mut cell = Cell::default(); /// assert_eq!(cell.ch(), ' '); /// assert_eq!(cell.fg(), Color::Default); /// assert_eq!(cell.bg(), Color::Default); /// ``` fn default() -> Cell { Cell::new(' ', Color::Default, Color::Default, Attr::Default) } } /// The color of a `Cell`. /// /// `Color::Default` represents the default color of the underlying terminal. /// /// The eight basic colors may be used directly and correspond to 0x00..0x07 in the 8-bit (256) /// color range; in addition, the eight basic colors coupled with `Attr::Bold` correspond to /// 0x08..0x0f in the 8-bit color range. /// /// `Color::Byte(..)` may be used to specify a color in the 8-bit range. /// /// # Examples /// /// ```no_run /// // The default color. /// let default = Color::Default; /// /// // A basic color. /// let red = Color::Red; /// /// // An 8-bit color. /// let fancy = Color::Byte(0x01); /// /// // Basic colors are also 8-bit colors (but not vice-versa). /// assert_eq!(red.as_byte(), fancy.as_byte()) /// ``` #[derive(Debug, Copy, Clone, PartialEq, Eq)] pub enum Color { Black, Red, Green, Yellow, Blue, Magenta, Cyan, White, Byte(u8), Rgb(u8, u8, u8), /// Terminal default. Default, } impl Color { /// Returns the `u8` representation of the `Color`. pub fn as_byte(self) -> u8 { match self { Color::Black => 0x00, Color::Red => 0x01, Color::Green => 0x02, Color::Yellow => 0x03, Color::Blue => 0x04, Color::Magenta => 0x05, Color::Cyan => 0x06, Color::White => 0x07, Color::Byte(b) => b, Color::Rgb(_, _, _) => unreachable!(), Color::Default => 0x00, } } pub fn from_byte(val: u8) -> Self { match val { 0x00 => Color::Black, 0x01 => Color::Red, 0x02 => Color::Green, 0x03 => Color::Yellow, 0x04 => Color::Blue, 0x05 => Color::Magenta, 0x06 => Color::Cyan, 0x07 => Color::White, _ => Color::Default, } } pub fn write_fg(self, stdout: &mut crate::StateStdout) -> std::io::Result<()> { use std::io::Write; match self { Color::Default => write!(stdout, "{}", termion::color::Fg(termion::color::Reset)), Color::Rgb(r, g, b) => write!(stdout, "{}", termion::color::Fg(TermionRgb(r, g, b))), _ => write!(stdout, "{}", termion::color::Fg(self.as_termion())), } } pub fn write_bg(self, stdout: &mut crate::StateStdout) -> std::io::Result<()> { use std::io::Write; match self { Color::Default => write!(stdout, "{}", termion::color::Bg(termion::color::Reset)), Color::Rgb(r, g, b) => write!(stdout, "{}", termion::color::Bg(TermionRgb(r, g, b))), _ => write!(stdout, "{}", termion::color::Bg(self.as_termion())), } } pub fn as_termion(self) -> AnsiValue { match self { b @ Color::Black | b @ Color::Red | b @ Color::Green | b @ Color::Yellow | b @ Color::Blue | b @ Color::Magenta | b @ Color::Cyan | b @ Color::White | b @ Color::Default => AnsiValue(b.as_byte()), Color::Byte(b) => AnsiValue(b), Color::Rgb(_, _, _) => AnsiValue(0), } } pub fn from_string_de<'de, D>(s: String) -> std::result::Result where D: Deserializer<'de>, { let byte = match s.as_str() { "Aqua" => 14, "Aquamarine1" => 122, "Aquamarine2" => 86, "Aquamarine3" => 79, "Black" => 0, "Blue" => 12, "Blue1" => 21, "Blue2" => 19, "Blue3" => 20, "BlueViolet" => 57, "CadetBlue" => 72, "CadetBlue1" => 73, "Chartreuse1" => 118, "Chartreuse2" => 112, "Chartreuse3" => 82, "Chartreuse4" => 70, "Chartreuse5" => 76, "Chartreuse6" => 64, "CornflowerBlue" => 69, "Cornsilk1" => 230, "Cyan1" => 51, "Cyan2" => 50, "Cyan3" => 43, "DarkBlue" => 18, "DarkCyan" => 36, "DarkGoldenrod" => 136, "DarkGreen" => 22, "DarkKhaki" => 143, "DarkMagenta" => 90, "DarkMagenta1" => 91, "DarkOliveGreen1" => 192, "DarkOliveGreen2" => 155, "DarkOliveGreen3" => 191, "DarkOliveGreen4" => 107, "DarkOliveGreen5" => 113, "DarkOliveGreen6" => 149, "DarkOrange" => 208, "DarkOrange2" => 130, "DarkOrange3" => 166, "DarkRed" => 52, "DarkRed2" => 88, "DarkSeaGreen" => 108, "DarkSeaGreen1" => 158, "DarkSeaGreen2" => 193, "DarkSeaGreen3" => 151, "DarkSeaGreen4" => 157, "DarkSeaGreen5" => 115, "DarkSeaGreen6" => 150, "DarkSeaGreen7" => 65, "DarkSeaGreen8" => 71, "DarkSlateGray1" => 123, "DarkSlateGray2" => 87, "DarkSlateGray3" => 116, "DarkTurquoise" => 44, "DarkViolet" => 128, "DarkViolet1" => 92, "DeepPink1" => 199, "DeepPink2" => 197, "DeepPink3" => 198, "DeepPink4" => 125, "DeepPink6" => 162, "DeepPink7" => 89, "DeepPink8" => 53, "DeepPink9" => 161, "DeepSkyBlue1" => 39, "DeepSkyBlue2" => 38, "DeepSkyBlue3" => 31, "DeepSkyBlue4" => 32, "DeepSkyBlue5" => 23, "DeepSkyBlue6" => 24, "DeepSkyBlue7" => 25, "DodgerBlue1" => 33, "DodgerBlue2" => 27, "DodgerBlue3" => 26, "Fuchsia" => 13, "Gold1" => 220, "Gold2" => 142, "Gold3" => 178, "Green" => 2, "Green1" => 46, "Green2" => 34, "Green3" => 40, "Green4" => 28, "GreenYellow" => 154, "Grey" => 8, "Grey0" => 16, "Grey100" => 231, "Grey11" => 234, "Grey15" => 235, "Grey19" => 236, "Grey23" => 237, "Grey27" => 238, "Grey3" => 232, "Grey30" => 239, "Grey35" => 240, "Grey37" => 59, "Grey39" => 241, "Grey42" => 242, "Grey46" => 243, "Grey50" => 244, "Grey53" => 102, "Grey54" => 245, "Grey58" => 246, "Grey62" => 247, "Grey63" => 139, "Grey66" => 248, "Grey69" => 145, "Grey7" => 233, "Grey70" => 249, "Grey74" => 250, "Grey78" => 251, "Grey82" => 252, "Grey84" => 188, "Grey85" => 253, "Grey89" => 254, "Grey93" => 255, "Honeydew2" => 194, "HotPink" => 205, "HotPink1" => 206, "HotPink2" => 169, "HotPink3" => 132, "HotPink4" => 168, "IndianRed" => 131, "IndianRed1" => 167, "IndianRed2" => 204, "IndianRed3" => 203, "Khaki1" => 228, "Khaki3" => 185, "LightCoral" => 210, "LightCyan2" => 195, "LightCyan3" => 152, "LightGoldenrod1" => 227, "LightGoldenrod2" => 222, "LightGoldenrod3" => 179, "LightGoldenrod4" => 221, "LightGoldenrod5" => 186, "LightGreen" => 119, "LightGreen1" => 120, "LightPink1" => 217, "LightPink2" => 174, "LightPink3" => 95, "LightSalmon1" => 216, "LightSalmon2" => 137, "LightSalmon3" => 173, "LightSeaGreen" => 37, "LightSkyBlue1" => 153, "LightSkyBlue2" => 109, "LightSkyBlue3" => 110, "LightSlateBlue" => 105, "LightSlateGrey" => 103, "LightSteelBlue" => 147, "LightSteelBlue1" => 189, "LightSteelBlue3" => 146, "LightYellow3" => 187, "Lime" => 10, "Magenta1" => 201, "Magenta2" => 165, "Magenta3" => 200, "Magenta4" => 127, "Magenta5" => 163, "Magenta6" => 164, "Maroon" => 1, "MediumOrchid" => 134, "MediumOrchid1" => 171, "MediumOrchid2" => 207, "MediumOrchid3" => 133, "MediumPurple" => 104, "MediumPurple1" => 141, "MediumPurple2" => 135, "MediumPurple3" => 140, "MediumPurple4" => 97, "MediumPurple5" => 98, "MediumPurple6" => 60, "MediumSpringGreen" => 49, "MediumTurquoise" => 80, "MediumVioletRed" => 126, "MistyRose1" => 224, "MistyRose3" => 181, "NavajoWhite1" => 223, "NavajoWhite3" => 144, "Navy" => 4, "NavyBlue" => 17, "Olive" => 3, "Orange1" => 214, "Orange2" => 172, "Orange3" => 58, "Orange4" => 94, "OrangeRed1" => 202, "Orchid" => 170, "Orchid1" => 213, "Orchid2" => 212, "PaleGreen1" => 121, "PaleGreen2" => 156, "PaleGreen3" => 114, "PaleGreen4" => 77, "PaleTurquoise1" => 159, "PaleTurquoise4" => 66, "PaleVioletRed1" => 211, "Pink1" => 218, "Pink3" => 175, "Plum1" => 219, "Plum2" => 183, "Plum3" => 176, "Plum4" => 96, "Purple" => 129, "Purple1" => 5, "Purple2" => 93, "Purple3" => 56, "Purple4" => 54, "Purple5" => 55, "Red" => 9, "Red1" => 196, "Red2" => 124, "Red3" => 160, "RosyBrown" => 138, "RoyalBlue1" => 63, "Salmon1" => 209, "SandyBrown" => 215, "SeaGreen1" => 84, "SeaGreen2" => 85, "SeaGreen3" => 83, "SeaGreen4" => 78, "Silver" => 7, "SkyBlue1" => 117, "SkyBlue2" => 111, "SkyBlue3" => 74, "SlateBlue1" => 99, "SlateBlue2" => 61, "SlateBlue3" => 62, "SpringGreen1" => 48, "SpringGreen2" => 42, "SpringGreen3" => 47, "SpringGreen4" => 35, "SpringGreen5" => 41, "SpringGreen6" => 29, "SteelBlue" => 67, "SteelBlue1" => 75, "SteelBlue2" => 81, "SteelBlue3" => 68, "Tan" => 180, "Teal" => 6, "Thistle1" => 225, "Thistle3" => 182, "Turquoise2" => 45, "Turquoise4" => 30, "Violet" => 177, "Wheat1" => 229, "Wheat4" => 101, "White" => 15, "Yellow" => 11, "Yellow1" => 226, "Yellow2" => 190, "Yellow3" => 184, "Yellow4" => 100, "Yellow5" => 106, "Yellow6" => 148, "Default" => return Ok(Color::Default), s if s.starts_with("#") && s.len() == 7 && s[1..].as_bytes().iter().all(|&b| { (b >= b'0' && b <= b'9') || (b >= b'a' && b <= b'f') || (b >= b'A' && b <= b'F') }) => { return Ok(Color::Rgb( u8::from_str_radix(&s[1..3], 16) .map_err(|_| de::Error::custom("invalid `color` value"))?, u8::from_str_radix(&s[3..5], 16) .map_err(|_| de::Error::custom("invalid `color` value"))?, u8::from_str_radix(&s[5..7], 16) .map_err(|_| de::Error::custom("invalid `color` value"))?, )) } s if s.starts_with("#") && s.len() == 4 && s[1..].as_bytes().iter().all(|&b| { (b >= b'0' && b <= b'9') || (b >= b'a' && b <= b'f') || (b >= b'A' && b <= b'F') }) => { return Ok(Color::Rgb( 17 * u8::from_str_radix(&s[1..2], 16) .map_err(|_| de::Error::custom("invalid `color` value"))?, 17 * u8::from_str_radix(&s[2..3], 16) .map_err(|_| de::Error::custom("invalid `color` value"))?, 17 * u8::from_str_radix(&s[3..4], 16) .map_err(|_| de::Error::custom("invalid `color` value"))?, )) } _ => u8::from_str_radix(&s, 10) .map_err(|_| de::Error::custom("invalid `color` value"))?, }; return Ok(Color::Byte(byte)); } } impl Default for Color { fn default() -> Self { Color::Default } } impl<'de> Deserialize<'de> for Color { fn deserialize(deserializer: D) -> std::result::Result where D: Deserializer<'de>, { if let Ok(s) = ::deserialize(deserializer) { Color::from_string_de::<'de, D>(s) } else { Err(de::Error::custom("invalid `color` value")) } } } #[test] fn test_color_de() { #[derive(Debug, Deserialize, PartialEq)] struct V { k: Color, } macro_rules! test_color { ($s:literal, ok $v:expr) => { assert_eq!( toml::from_str::(std::concat!("k = \"", $s, "\"")), Ok(V { k: $v }) ); }; ($s:literal, err $v:literal) => { assert_eq!( toml::from_str::(std::concat!("k = \"", $s, "\"")) .unwrap_err() .to_string(), $v.to_string() ); }; } test_color!("#Ff6600", ok Color::Rgb(255, 102, 0)); test_color!("#f60", ok Color::Rgb(255, 102, 0)); test_color!("#gb0", err "invalid `color` value for key `k` at line 1 column 1"); test_color!("Olive", ok Color::Byte(3)); test_color!("Oafahifdave", err "invalid `color` value for key `k` at line 1 column 1"); } impl Serialize for Color { fn serialize(&self, serializer: S) -> std::result::Result where S: Serializer, { match self { Color::Black | Color::Byte(0) => serializer.serialize_str("Black"), Color::Byte(1) => serializer.serialize_str("Maroon"), Color::Green | Color::Byte(2) => serializer.serialize_str("Green"), Color::Byte(3) => serializer.serialize_str("Olive"), Color::Byte(4) => serializer.serialize_str("Navy"), Color::Byte(5) | Color::Magenta => serializer.serialize_str("Purple"), Color::Byte(6) | Color::Cyan => serializer.serialize_str("Teal"), Color::Byte(7) => serializer.serialize_str("Silver"), Color::Byte(8) => serializer.serialize_str("Grey"), Color::Red | Color::Byte(9) => serializer.serialize_str("Red"), Color::Byte(10) => serializer.serialize_str("Lime"), Color::Yellow | Color::Byte(11) => serializer.serialize_str("Yellow"), Color::Blue | Color::Byte(12) => serializer.serialize_str("Blue"), Color::Byte(13) => serializer.serialize_str("Fuchsia"), Color::Byte(14) => serializer.serialize_str("Aqua"), Color::White | Color::Byte(15) => serializer.serialize_str("White"), Color::Byte(16) => serializer.serialize_str("Grey0"), Color::Byte(17) => serializer.serialize_str("NavyBlue"), Color::Byte(18) => serializer.serialize_str("DarkBlue"), Color::Byte(19) => serializer.serialize_str("Blue3"), Color::Byte(20) => serializer.serialize_str("Blue3"), Color::Byte(21) => serializer.serialize_str("Blue1"), Color::Byte(22) => serializer.serialize_str("DarkGreen"), Color::Byte(23) => serializer.serialize_str("DeepSkyBlue4"), Color::Byte(24) => serializer.serialize_str("DeepSkyBlue4"), Color::Byte(25) => serializer.serialize_str("DeepSkyBlue4"), Color::Byte(26) => serializer.serialize_str("DodgerBlue3"), Color::Byte(27) => serializer.serialize_str("DodgerBlue2"), Color::Byte(28) => serializer.serialize_str("Green4"), Color::Byte(29) => serializer.serialize_str("SpringGreen4"), Color::Byte(30) => serializer.serialize_str("Turquoise4"), Color::Byte(31) => serializer.serialize_str("DeepSkyBlue3"), Color::Byte(32) => serializer.serialize_str("DeepSkyBlue3"), Color::Byte(33) => serializer.serialize_str("DodgerBlue1"), Color::Byte(34) => serializer.serialize_str("Green3"), Color::Byte(35) => serializer.serialize_str("SpringGreen3"), Color::Byte(36) => serializer.serialize_str("DarkCyan"), Color::Byte(37) => serializer.serialize_str("LightSeaGreen"), Color::Byte(38) => serializer.serialize_str("DeepSkyBlue2"), Color::Byte(39) => serializer.serialize_str("DeepSkyBlue1"), Color::Byte(40) => serializer.serialize_str("Green3"), Color::Byte(41) => serializer.serialize_str("SpringGreen3"), Color::Byte(42) => serializer.serialize_str("SpringGreen2"), Color::Byte(43) => serializer.serialize_str("Cyan3"), Color::Byte(44) => serializer.serialize_str("DarkTurquoise"), Color::Byte(45) => serializer.serialize_str("Turquoise2"), Color::Byte(46) => serializer.serialize_str("Green1"), Color::Byte(47) => serializer.serialize_str("SpringGreen2"), Color::Byte(48) => serializer.serialize_str("SpringGreen1"), Color::Byte(49) => serializer.serialize_str("MediumSpringGreen"), Color::Byte(50) => serializer.serialize_str("Cyan2"), Color::Byte(51) => serializer.serialize_str("Cyan1"), Color::Byte(52) => serializer.serialize_str("DarkRed"), Color::Byte(53) => serializer.serialize_str("DeepPink4"), Color::Byte(54) => serializer.serialize_str("Purple4"), Color::Byte(55) => serializer.serialize_str("Purple4"), Color::Byte(56) => serializer.serialize_str("Purple3"), Color::Byte(57) => serializer.serialize_str("BlueViolet"), Color::Byte(58) => serializer.serialize_str("Orange4"), Color::Byte(59) => serializer.serialize_str("Grey37"), Color::Byte(60) => serializer.serialize_str("MediumPurple4"), Color::Byte(61) => serializer.serialize_str("SlateBlue3"), Color::Byte(62) => serializer.serialize_str("SlateBlue3"), Color::Byte(63) => serializer.serialize_str("RoyalBlue1"), Color::Byte(64) => serializer.serialize_str("Chartreuse4"), Color::Byte(65) => serializer.serialize_str("DarkSeaGreen4"), Color::Byte(66) => serializer.serialize_str("PaleTurquoise4"), Color::Byte(67) => serializer.serialize_str("SteelBlue"), Color::Byte(68) => serializer.serialize_str("SteelBlue3"), Color::Byte(69) => serializer.serialize_str("CornflowerBlue"), Color::Byte(70) => serializer.serialize_str("Chartreuse3"), Color::Byte(71) => serializer.serialize_str("DarkSeaGreen4"), Color::Byte(72) => serializer.serialize_str("CadetBlue"), Color::Byte(73) => serializer.serialize_str("CadetBlue"), Color::Byte(74) => serializer.serialize_str("SkyBlue3"), Color::Byte(75) => serializer.serialize_str("SteelBlue1"), Color::Byte(76) => serializer.serialize_str("Chartreuse3"), Color::Byte(77) => serializer.serialize_str("PaleGreen3"), Color::Byte(78) => serializer.serialize_str("SeaGreen3"), Color::Byte(79) => serializer.serialize_str("Aquamarine3"), Color::Byte(80) => serializer.serialize_str("MediumTurquoise"), Color::Byte(81) => serializer.serialize_str("SteelBlue1"), Color::Byte(82) => serializer.serialize_str("Chartreuse2"), Color::Byte(83) => serializer.serialize_str("SeaGreen2"), Color::Byte(84) => serializer.serialize_str("SeaGreen1"), Color::Byte(85) => serializer.serialize_str("SeaGreen1"), Color::Byte(86) => serializer.serialize_str("Aquamarine1"), Color::Byte(87) => serializer.serialize_str("DarkSlateGray2"), Color::Byte(88) => serializer.serialize_str("DarkRed"), Color::Byte(89) => serializer.serialize_str("DeepPink4"), Color::Byte(90) => serializer.serialize_str("DarkMagenta"), Color::Byte(91) => serializer.serialize_str("DarkMagenta"), Color::Byte(92) => serializer.serialize_str("DarkViolet"), Color::Byte(93) => serializer.serialize_str("Purple"), Color::Byte(94) => serializer.serialize_str("Orange4"), Color::Byte(95) => serializer.serialize_str("LightPink4"), Color::Byte(96) => serializer.serialize_str("Plum4"), Color::Byte(97) => serializer.serialize_str("MediumPurple3"), Color::Byte(98) => serializer.serialize_str("MediumPurple3"), Color::Byte(99) => serializer.serialize_str("SlateBlue1"), Color::Byte(100) => serializer.serialize_str("Yellow4"), Color::Byte(101) => serializer.serialize_str("Wheat4"), Color::Byte(102) => serializer.serialize_str("Grey53"), Color::Byte(103) => serializer.serialize_str("LightSlateGrey"), Color::Byte(104) => serializer.serialize_str("MediumPurple"), Color::Byte(105) => serializer.serialize_str("LightSlateBlue"), Color::Byte(106) => serializer.serialize_str("Yellow4"), Color::Byte(107) => serializer.serialize_str("DarkOliveGreen3"), Color::Byte(108) => serializer.serialize_str("DarkSeaGreen"), Color::Byte(109) => serializer.serialize_str("LightSkyBlue3"), Color::Byte(110) => serializer.serialize_str("LightSkyBlue3"), Color::Byte(111) => serializer.serialize_str("SkyBlue2"), Color::Byte(112) => serializer.serialize_str("Chartreuse2"), Color::Byte(113) => serializer.serialize_str("DarkOliveGreen3"), Color::Byte(114) => serializer.serialize_str("PaleGreen3"), Color::Byte(115) => serializer.serialize_str("DarkSeaGreen3"), Color::Byte(116) => serializer.serialize_str("DarkSlateGray3"), Color::Byte(117) => serializer.serialize_str("SkyBlue1"), Color::Byte(118) => serializer.serialize_str("Chartreuse1"), Color::Byte(119) => serializer.serialize_str("LightGreen"), Color::Byte(120) => serializer.serialize_str("LightGreen"), Color::Byte(121) => serializer.serialize_str("PaleGreen1"), Color::Byte(122) => serializer.serialize_str("Aquamarine1"), Color::Byte(123) => serializer.serialize_str("DarkSlateGray1"), Color::Byte(124) => serializer.serialize_str("Red3"), Color::Byte(125) => serializer.serialize_str("DeepPink4"), Color::Byte(126) => serializer.serialize_str("MediumVioletRed"), Color::Byte(127) => serializer.serialize_str("Magenta3"), Color::Byte(128) => serializer.serialize_str("DarkViolet"), Color::Byte(129) => serializer.serialize_str("Purple"), Color::Byte(130) => serializer.serialize_str("DarkOrange3"), Color::Byte(131) => serializer.serialize_str("IndianRed"), Color::Byte(132) => serializer.serialize_str("HotPink3"), Color::Byte(133) => serializer.serialize_str("MediumOrchid3"), Color::Byte(134) => serializer.serialize_str("MediumOrchid"), Color::Byte(135) => serializer.serialize_str("MediumPurple2"), Color::Byte(136) => serializer.serialize_str("DarkGoldenrod"), Color::Byte(137) => serializer.serialize_str("LightSalmon3"), Color::Byte(138) => serializer.serialize_str("RosyBrown"), Color::Byte(139) => serializer.serialize_str("Grey63"), Color::Byte(140) => serializer.serialize_str("MediumPurple2"), Color::Byte(141) => serializer.serialize_str("MediumPurple1"), Color::Byte(142) => serializer.serialize_str("Gold3"), Color::Byte(143) => serializer.serialize_str("DarkKhaki"), Color::Byte(144) => serializer.serialize_str("NavajoWhite3"), Color::Byte(145) => serializer.serialize_str("Grey69"), Color::Byte(146) => serializer.serialize_str("LightSteelBlue3"), Color::Byte(147) => serializer.serialize_str("LightSteelBlue"), Color::Byte(148) => serializer.serialize_str("Yellow3"), Color::Byte(149) => serializer.serialize_str("DarkOliveGreen3"), Color::Byte(150) => serializer.serialize_str("DarkSeaGreen3"), Color::Byte(151) => serializer.serialize_str("DarkSeaGreen2"), Color::Byte(152) => serializer.serialize_str("LightCyan3"), Color::Byte(153) => serializer.serialize_str("LightSkyBlue1"), Color::Byte(154) => serializer.serialize_str("GreenYellow"), Color::Byte(155) => serializer.serialize_str("DarkOliveGreen2"), Color::Byte(156) => serializer.serialize_str("PaleGreen1"), Color::Byte(157) => serializer.serialize_str("DarkSeaGreen2"), Color::Byte(158) => serializer.serialize_str("DarkSeaGreen1"), Color::Byte(159) => serializer.serialize_str("PaleTurquoise1"), Color::Byte(160) => serializer.serialize_str("Red3"), Color::Byte(161) => serializer.serialize_str("DeepPink3"), Color::Byte(162) => serializer.serialize_str("DeepPink3"), Color::Byte(163) => serializer.serialize_str("Magenta3"), Color::Byte(164) => serializer.serialize_str("Magenta3"), Color::Byte(165) => serializer.serialize_str("Magenta2"), Color::Byte(166) => serializer.serialize_str("DarkOrange3"), Color::Byte(167) => serializer.serialize_str("IndianRed"), Color::Byte(168) => serializer.serialize_str("HotPink3"), Color::Byte(169) => serializer.serialize_str("HotPink2"), Color::Byte(170) => serializer.serialize_str("Orchid"), Color::Byte(171) => serializer.serialize_str("MediumOrchid1"), Color::Byte(172) => serializer.serialize_str("Orange3"), Color::Byte(173) => serializer.serialize_str("LightSalmon3"), Color::Byte(174) => serializer.serialize_str("LightPink3"), Color::Byte(175) => serializer.serialize_str("Pink3"), Color::Byte(176) => serializer.serialize_str("Plum3"), Color::Byte(177) => serializer.serialize_str("Violet"), Color::Byte(178) => serializer.serialize_str("Gold3"), Color::Byte(179) => serializer.serialize_str("LightGoldenrod3"), Color::Byte(180) => serializer.serialize_str("Tan"), Color::Byte(181) => serializer.serialize_str("MistyRose3"), Color::Byte(182) => serializer.serialize_str("Thistle3"), Color::Byte(183) => serializer.serialize_str("Plum2"), Color::Byte(184) => serializer.serialize_str("Yellow3"), Color::Byte(185) => serializer.serialize_str("Khaki3"), Color::Byte(186) => serializer.serialize_str("LightGoldenrod2"), Color::Byte(187) => serializer.serialize_str("LightYellow3"), Color::Byte(188) => serializer.serialize_str("Grey84"), Color::Byte(189) => serializer.serialize_str("LightSteelBlue1"), Color::Byte(190) => serializer.serialize_str("Yellow2"), Color::Byte(191) => serializer.serialize_str("DarkOliveGreen1"), Color::Byte(192) => serializer.serialize_str("DarkOliveGreen1"), Color::Byte(193) => serializer.serialize_str("DarkSeaGreen1"), Color::Byte(194) => serializer.serialize_str("Honeydew2"), Color::Byte(195) => serializer.serialize_str("LightCyan1"), Color::Byte(196) => serializer.serialize_str("Red1"), Color::Byte(197) => serializer.serialize_str("DeepPink2"), Color::Byte(198) => serializer.serialize_str("DeepPink1"), Color::Byte(199) => serializer.serialize_str("DeepPink1"), Color::Byte(200) => serializer.serialize_str("Magenta2"), Color::Byte(201) => serializer.serialize_str("Magenta1"), Color::Byte(202) => serializer.serialize_str("OrangeRed1"), Color::Byte(203) => serializer.serialize_str("IndianRed1"), Color::Byte(204) => serializer.serialize_str("IndianRed1"), Color::Byte(205) => serializer.serialize_str("HotPink"), Color::Byte(206) => serializer.serialize_str("HotPink"), Color::Byte(207) => serializer.serialize_str("MediumOrchid1"), Color::Byte(208) => serializer.serialize_str("DarkOrange"), Color::Byte(209) => serializer.serialize_str("Salmon1"), Color::Byte(210) => serializer.serialize_str("LightCoral"), Color::Byte(211) => serializer.serialize_str("PaleVioletRed1"), Color::Byte(212) => serializer.serialize_str("Orchid2"), Color::Byte(213) => serializer.serialize_str("Orchid1"), Color::Byte(214) => serializer.serialize_str("Orange1"), Color::Byte(215) => serializer.serialize_str("SandyBrown"), Color::Byte(216) => serializer.serialize_str("LightSalmon1"), Color::Byte(217) => serializer.serialize_str("LightPink1"), Color::Byte(218) => serializer.serialize_str("Pink1"), Color::Byte(219) => serializer.serialize_str("Plum1"), Color::Byte(220) => serializer.serialize_str("Gold1"), Color::Byte(221) => serializer.serialize_str("LightGoldenrod2"), Color::Byte(222) => serializer.serialize_str("LightGoldenrod2"), Color::Byte(223) => serializer.serialize_str("NavajoWhite1"), Color::Byte(224) => serializer.serialize_str("MistyRose1"), Color::Byte(225) => serializer.serialize_str("Thistle1"), Color::Byte(226) => serializer.serialize_str("Yellow1"), Color::Byte(227) => serializer.serialize_str("LightGoldenrod1"), Color::Byte(228) => serializer.serialize_str("Khaki1"), Color::Byte(229) => serializer.serialize_str("Wheat1"), Color::Byte(230) => serializer.serialize_str("Cornsilk1"), Color::Byte(231) => serializer.serialize_str("Grey100"), Color::Byte(232) => serializer.serialize_str("Grey3"), Color::Byte(233) => serializer.serialize_str("Grey7"), Color::Byte(234) => serializer.serialize_str("Grey11"), Color::Byte(235) => serializer.serialize_str("Grey15"), Color::Byte(236) => serializer.serialize_str("Grey19"), Color::Byte(237) => serializer.serialize_str("Grey23"), Color::Byte(238) => serializer.serialize_str("Grey27"), Color::Byte(239) => serializer.serialize_str("Grey30"), Color::Byte(240) => serializer.serialize_str("Grey35"), Color::Byte(241) => serializer.serialize_str("Grey39"), Color::Byte(242) => serializer.serialize_str("Grey42"), Color::Byte(243) => serializer.serialize_str("Grey46"), Color::Byte(244) => serializer.serialize_str("Grey50"), Color::Byte(245) => serializer.serialize_str("Grey54"), Color::Byte(246) => serializer.serialize_str("Grey58"), Color::Byte(247) => serializer.serialize_str("Grey62"), Color::Byte(248) => serializer.serialize_str("Grey66"), Color::Byte(249) => serializer.serialize_str("Grey70"), Color::Byte(250) => serializer.serialize_str("Grey74"), Color::Byte(251) => serializer.serialize_str("Grey78"), Color::Byte(252) => serializer.serialize_str("Grey82"), Color::Byte(253) => serializer.serialize_str("Grey85"), Color::Byte(254) => serializer.serialize_str("Grey89"), Color::Byte(255) => serializer.serialize_str("Grey93"), Color::Rgb(r, g, b) => { serializer.serialize_str(&format!("#{:02x}{:02x}{:02x}", r, g, b)) } Color::Default => serializer.serialize_str("Default"), } } } /// The attributes of a `Cell`. /// /// `Attr` enumerates all combinations of attributes a given style may have. /// /// `Attr::Default` represents no attribute. /// /// # Examples /// /// ```no_run /// // Default attribute. /// let def = Attr::Default; /// /// // Base attribute. /// let base = Attr::Bold; /// /// // Combination. /// let comb = Attr::UnderlineReverse; /// ``` #[derive(Debug, Copy, Clone, PartialEq, Eq)] pub enum Attr { /// Terminal default. Default = 0b000, Bold = 0b001, Underline = 0b100, BoldUnderline = 0b011, Reverse = 0b010, BoldReverse = 0b101, UnderlineReverse = 0b110, BoldReverseUnderline = 0b111, } impl core::ops::BitOr for Attr { type Output = Attr; fn bitor(self, rhs: Self) -> Self::Output { match self as u8 | rhs as u8 { 0b000 => Attr::Default, 0b001 => Attr::Bold, 0b100 => Attr::Underline, 0b011 => Attr::BoldUnderline, 0b010 => Attr::Reverse, 0b101 => Attr::BoldReverse, 0b110 => Attr::UnderlineReverse, 0b111 => Attr::BoldReverseUnderline, _ => unsafe { std::hint::unreachable_unchecked() }, } } } impl core::ops::BitAnd for Attr { type Output = bool; fn bitand(self, rhs: Self) -> Self::Output { self as u8 & rhs as u8 > 0 } } impl core::ops::BitOrAssign for Attr { fn bitor_assign(&mut self, rhs: Attr) { use Attr::*; *self = match *self as u8 | rhs as u8 { 0b000 => Default, 0b001 => Bold, 0b100 => Underline, 0b011 => BoldUnderline, 0b010 => Reverse, 0b101 => BoldReverse, 0b110 => UnderlineReverse, 0b111 => BoldReverseUnderline, _ => unsafe { std::hint::unreachable_unchecked() }, }; } } impl Default for Attr { fn default() -> Self { Attr::Default } } impl<'de> Deserialize<'de> for Attr { fn deserialize(deserializer: D) -> std::result::Result where D: Deserializer<'de>, { if let Ok(s) = ::deserialize(deserializer) { Attr::from_string_de::<'de, D>(s) } else { Err(de::Error::custom("invalid attr value")) } } } impl Serialize for Attr { fn serialize(&self, serializer: S) -> std::result::Result where S: Serializer, { match self { Attr::Default => serializer.serialize_str("Default"), Attr::Bold => serializer.serialize_str("Bold"), Attr::Underline => serializer.serialize_str("Underline"), Attr::BoldUnderline => serializer.serialize_str("BoldUnderline"), Attr::Reverse => serializer.serialize_str("Reverse"), Attr::BoldReverse => serializer.serialize_str("BoldReverse"), Attr::UnderlineReverse => serializer.serialize_str("UnderlineReverse"), Attr::BoldReverseUnderline => serializer.serialize_str("BoldReverseUnderline"), } } } impl Attr { pub fn from_string_de<'de, D>(s: String) -> std::result::Result where D: Deserializer<'de>, { match s.as_str() { "Default" => Ok(Attr::Default), "Bold" => Ok(Attr::Bold), "Underline" => Ok(Attr::Underline), "BoldUnderline" => Ok(Attr::BoldUnderline), "Reverse" => Ok(Attr::Reverse), "BoldReverse" => Ok(Attr::BoldReverse), "UnderlineReverse" => Ok(Attr::UnderlineReverse), "BoldReverseUnderline" => Ok(Attr::BoldReverseUnderline), _ => Err(de::Error::custom("invalid attr value")), } } pub fn write(self, prev: Attr, stdout: &mut crate::StateStdout) -> std::io::Result<()> { use std::io::Write; match (self & Attr::Bold, prev & Attr::Bold) { (true, true) | (false, false) => Ok(()), (false, true) => write!(stdout, "\x1B[22m"), (true, false) => write!(stdout, "\x1B[1m"), } .and_then(|_| match (self & Attr::Underline, prev & Attr::Underline) { (true, true) | (false, false) => Ok(()), (false, true) => write!(stdout, "\x1B[24m"), (true, false) => write!(stdout, "\x1B[4m"), }) .and_then(|_| match (self & Attr::Reverse, prev & Attr::Reverse) { (true, true) | (false, false) => Ok(()), (false, true) => write!(stdout, "\x1B[27m"), (true, false) => write!(stdout, "\x1B[7m"), }) } } pub fn copy_area_with_break( grid_dest: &mut CellBuffer, grid_src: &CellBuffer, dest: Area, src: Area, ) -> Pos { if !is_valid_area!(dest) || !is_valid_area!(src) { debug!( "BUG: Invalid areas in copy_area:\n src: {:?}\n dest: {:?}", src, dest ); return upper_left!(dest); } if grid_src.is_empty() || grid_dest.is_empty() { return upper_left!(dest); } let mut ret = bottom_right!(dest); let mut src_x = get_x(upper_left!(src)); let mut src_y = get_y(upper_left!(src)); 'y_: for y in get_y(upper_left!(dest))..=get_y(bottom_right!(dest)) { 'x_: for x in get_x(upper_left!(dest))..=get_x(bottom_right!(dest)) { if grid_src[(src_x, src_y)].ch() == '\n' { src_y += 1; src_x = 0; if src_y >= get_y(bottom_right!(src)) { ret.1 = y; break 'y_; } continue 'y_; } grid_dest[(x, y)] = grid_src[(src_x, src_y)]; src_x += 1; if src_x >= get_x(bottom_right!(src)) { src_y += 1; src_x = 0; if src_y >= get_y(bottom_right!(src)) { //clear_area(grid_dest, ((get_x(upper_left!(dest)), y), bottom_right!(dest))); ret.1 = y; break 'y_; } break 'x_; } } } ret } /// Copy a source `Area` to a destination. pub fn copy_area(grid_dest: &mut CellBuffer, grid_src: &CellBuffer, dest: Area, src: Area) -> Pos { if !is_valid_area!(dest) || !is_valid_area!(src) { debug!( "BUG: Invalid areas in copy_area:\n src: {:?}\n dest: {:?}", src, dest ); return upper_left!(dest); } if grid_src.is_empty() || grid_dest.is_empty() { return upper_left!(dest); } let mut ret = bottom_right!(dest); let mut src_x = get_x(upper_left!(src)); let mut src_y = get_y(upper_left!(src)); let (cols, rows) = grid_src.size(); if src_x >= cols || src_y >= rows { debug!("BUG: src area outside of grid_src in copy_area",); return upper_left!(dest); } for y in get_y(upper_left!(dest))..=get_y(bottom_right!(dest)) { 'for_x: for x in get_x(upper_left!(dest))..=get_x(bottom_right!(dest)) { grid_dest[(x, y)] = grid_src[(src_x, src_y)]; if src_x >= get_x(bottom_right!(src)) { break 'for_x; } src_x += 1; } src_x = get_x(upper_left!(src)); src_y += 1; if src_y > get_y(bottom_right!(src)) { clear_area( grid_dest, ((get_x(upper_left!(dest)), y + 1), bottom_right!(dest)), ); ret.1 = y; break; } } ret } /// Change foreground and background colors in an `Area` pub fn change_colors(grid: &mut CellBuffer, area: Area, fg_color: Color, bg_color: Color) { if cfg!(feature = "debug-tracing") { let bounds = grid.size(); let upper_left = upper_left!(area); let bottom_right = bottom_right!(area); let (x, y) = upper_left; if y > (get_y(bottom_right)) || x > get_x(bottom_right) || y >= get_y(bounds) || x >= get_x(bounds) { debug!("BUG: Invalid area in change_colors:\n area: {:?}", area); return; } if !is_valid_area!(area) { debug!("BUG: Invalid area in change_colors:\n area: {:?}", area); return; } } for row in grid.bounds_iter(area) { for c in row { grid[c].set_fg(fg_color).set_bg(bg_color); } } } macro_rules! inspect_bounds { ($grid:ident, $area:ident, $x: ident, $y: ident, $line_break:ident) => { let bounds = $grid.size(); let (upper_left, bottom_right) = $area; if $x > (get_x(bottom_right)) || $x > get_x(bounds) { if $grid.growable { $grid.resize($grid.cols * 2, $grid.rows, Cell::default()); } else { $x = get_x(upper_left); $y += 1; if $line_break.is_none() { break; } else { $x = $line_break.unwrap(); } } } if $y > (get_y(bottom_right)) || $y > get_y(bounds) { if $grid.growable { $grid.resize($grid.cols, $grid.rows * 2, Cell::default()); } else { return ($x, $y - 1); } } }; } /// Write an `&str` to a `CellBuffer` in a specified `Area` with the passed colors. pub fn write_string_to_grid( s: &str, grid: &mut CellBuffer, fg_color: Color, bg_color: Color, attrs: Attr, area: Area, // The left-most x coordinate. line_break: Option, ) -> Pos { let bounds = grid.size(); let upper_left = upper_left!(area); let bottom_right = bottom_right!(area); let (mut x, mut y) = upper_left; if y == get_y(bounds) || x == get_x(bounds) { if grid.growable { grid.resize( std::cmp::max(grid.cols, x), std::cmp::max(grid.rows, y) * 4, Cell::default(), ); } else { return (x, y); } } if y > (get_y(bottom_right)) || x > get_x(bottom_right) || y > get_y(bounds) || x > get_x(bounds) { if grid.growable { grid.resize( std::cmp::max(grid.cols, x), std::cmp::max(grid.rows, y) * 4, Cell::default(), ); } else { debug!(" Invalid area with string {} and area {:?}", s, area); return (x, y); } } for c in s.chars() { if c == '\r' { continue; } if c == '\t' { grid[(x, y)].set_ch(' '); x += 1; inspect_bounds!(grid, area, x, y, line_break); grid[(x, y)].set_ch(' '); } else { grid[(x, y)].set_ch(c); } grid[(x, y)] .set_fg(fg_color) .set_bg(bg_color) .set_attrs(attrs); match wcwidth(u32::from(c)) { Some(0) | None => { /* Skip drawing zero width characters */ grid[(x, y)].empty = true; } Some(2) => { /* Grapheme takes more than one column, so the next cell will be * drawn over. Set it as empty to skip drawing it. */ x += 1; inspect_bounds!(grid, area, x, y, line_break); grid[(x, y)] = Cell::default(); grid[(x, y)] .set_fg(fg_color) .set_bg(bg_color) .set_attrs(attrs) .set_empty(true); } _ => {} } x += 1; inspect_bounds!(grid, area, x, y, line_break); } (x, y) } /// Completely clear an `Area` with an empty char and the terminal's default colors. pub fn clear_area(grid: &mut CellBuffer, area: Area) { if !is_valid_area!(area) { return; } for row in grid.bounds_iter(area) { for c in row { grid[c] = Cell::default(); } } } pub fn center_area(area: Area, (width, height): (usize, usize)) -> Area { let mid_x = { std::cmp::max(width!(area) / 2, width / 2) - width / 2 }; let mid_y = { std::cmp::max(height!(area) / 2, height / 2) - height / 2 }; let (upper_x, upper_y) = upper_left!(area); let (max_x, max_y) = bottom_right!(area); ( ( std::cmp::min(max_x, upper_x + mid_x), std::cmp::min(max_y, upper_y + mid_y), ), ( std::cmp::min(max_x, upper_x + mid_x + width), std::cmp::min(max_y, upper_y + mid_y + height), ), ) } pub mod ansi { //! Create a `CellBuffer` from a string slice containing ANSI escape codes. use super::{Cell, CellBuffer, Color}; /// Create a `CellBuffer` from a string slice containing ANSI escape codes. pub fn ansi_to_cellbuffer(s: &str) -> Option { let mut buf: Vec = Vec::with_capacity(2048); enum State { Start, Csi, SetFg, SetBg, } use State::*; let mut rows = 0; let mut cols = 0; let mut current_fg = Color::Default; let mut current_bg = Color::Default; let mut cur_cell; let mut state: State; for l in s.lines() { cur_cell = Cell::default(); state = State::Start; let mut chars = l.chars().peekable(); cols = 0; rows += 1; 'line_loop: loop { let c = chars.next(); if c.is_none() { break 'line_loop; } match (&state, c.unwrap()) { (Start, '\x1b') => { if chars.next() != Some('[') { return None; } state = Csi; } (Start, c) => { cur_cell.set_ch(c); cur_cell.set_fg(current_fg); cur_cell.set_bg(current_bg); buf.push(cur_cell); cur_cell = Cell::default(); cols += 1; } (Csi, 'm') => { /* Reset styles */ current_fg = Color::Default; current_bg = Color::Default; state = Start; } (Csi, '0') => { if chars.next() != Some('m') { return None; } /* Reset styles */ current_fg = Color::Default; current_bg = Color::Default; state = Start; } (Csi, '3') => { match chars.next() { Some('8') => { /* Set foreground color */ if chars.next() == Some(';') { state = SetFg; /* Next arguments are 5;n or 2;r;g;b */ continue; } return None; } Some(c) if c >= '0' && c < '8' => { current_fg = Color::from_byte(c as u8 - 0x30); if chars.next() != Some('m') { return None; } state = Start; } _ => return None, } } (Csi, '4') => { match chars.next() { Some('8') => { /* Set background color */ if chars.next() == Some(';') { state = SetBg; /* Next arguments are 5;n or 2;r;g;b */ continue; } return None; } Some(c) if c >= '0' && c < '8' => { current_bg = Color::from_byte(c as u8 - 0x30); if chars.next() != Some('m') { return None; } state = Start; } _ => return None, } } (SetFg, '5') => { if chars.next() != Some(';') { return None; } let mut accum = 0; while chars.peek().is_some() && chars.peek() != Some(&'m') { let c = chars.next().unwrap(); accum *= 10; accum += c as u8 - 0x30; } if chars.next() != Some('m') { return None; } current_fg = Color::from_byte(accum); state = Start; } (SetFg, '2') => { if chars.next() != Some(';') { return None; } let mut rgb_color = Color::Rgb(0, 0, 0); if let Color::Rgb(ref mut r, ref mut g, ref mut b) = rgb_color { 'rgb_fg: for val in &mut [r, g, b] { let mut accum = 0; while chars.peek().is_some() && chars.peek() != Some(&';') && chars.peek() != Some(&'m') { let c = chars.next().unwrap(); accum *= 10; accum += c as u8 - 0x30; } **val = accum; match chars.peek() { Some(&'m') => { break 'rgb_fg; } Some(&';') => { chars.next(); } _ => return None, } } } if chars.next() != Some('m') { return None; } current_fg = rgb_color; state = Start; } (SetBg, '5') => { if chars.next() != Some(';') { return None; } let mut accum = 0; while chars.peek().is_some() && chars.peek() != Some(&'m') { let c = chars.next().unwrap(); accum *= 10; accum += c as u8 - 0x30; } if chars.next() != Some('m') { return None; } current_bg = Color::from_byte(accum); state = Start; } (SetBg, '2') => { if chars.next() != Some(';') { return None; } let mut rgb_color = Color::Rgb(0, 0, 0); if let Color::Rgb(ref mut r, ref mut g, ref mut b) = rgb_color { 'rgb_bg: for val in &mut [r, g, b] { let mut accum = 0; while chars.peek().is_some() && chars.peek() != Some(&';') && chars.peek() != Some(&'m') { let c = chars.next().unwrap(); accum *= 10; accum += c as u8 - 0x30; } **val = accum; match chars.peek() { Some(&'m') => { break 'rgb_bg; } Some(&';') => { chars.next(); } _ => return None, } } } if chars.next() != Some('m') { return None; } current_bg = rgb_color; state = Start; } _ => unreachable!(), } } } if buf.len() != rows * cols { debug!("rows: {} cols: {}, buf.len() = {}", rows, cols, buf.len()); } Some(CellBuffer { buf, rows, cols, growable: false, ascii_drawing: false, }) } } /// Use `RowIterator` to iterate the cells of a row without the need to do any bounds checking; /// the iterator will simply return `None` when it reaches the end of the row. /// `RowIterator` can be created via the `CellBuffer::row_iter` method and can be returned by /// `BoundsIterator` which iterates each row. /// ```no_run /// for c in grid.row_iter( /// x..(x + 11), /// 0, /// ) { /// grid[c].set_ch('w'); /// } /// ``` pub struct RowIterator { row: usize, col: std::ops::Range, } /// `BoundsIterator` iterates each row returning a `RowIterator`. /// ```no_run /// /* Visit each `Cell` in `area`. */ /// for c in grid.bounds_iter(area) { /// grid[c].set_ch('w'); /// } /// ``` pub struct BoundsIterator { rows: std::ops::Range, cols: (usize, usize), } impl Iterator for BoundsIterator { type Item = RowIterator; fn next(&mut self) -> Option { if let Some(next_row) = self.rows.next() { Some(RowIterator { row: next_row, col: self.cols.0..self.cols.1, }) } else { None } } } impl Iterator for RowIterator { type Item = (usize, usize); fn next(&mut self) -> Option { if let Some(next_col) = self.col.next() { Some((next_col, self.row)) } else { None } } } impl RowIterator { pub fn forward_col(mut self, new_val: usize) -> Self { if self.col.start > new_val { self } else if self.col.end <= new_val { self.col.start = self.col.end; self } else { self.col.start = new_val; self } } }