// Copyright 2016 Joe Wilm, The Alacritty Project Contributors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // //! Functions for computing properties of the terminal grid use std::ops::{Index, IndexMut, Deref, DerefMut, Range, RangeTo, RangeFrom, RangeFull}; use std::cmp::Ordering; use std::slice::{self, Iter, IterMut}; use std::iter::IntoIterator; use util::Rotate; use term::{Cursor, DEFAULT_FG, DEFAULT_BG}; use ::Rgb; #[derive(Clone, Debug)] pub struct Cell { pub c: char, pub fg: Rgb, pub bg: Rgb, pub flags: CellFlags, } bitflags! { pub flags CellFlags: u32 { const INVERSE = 0b00000001, const BOLD = 0b00000010, const ITALIC = 0b00000100, const UNDERLINE = 0b00001000, } } impl Cell { pub fn new(c: char) -> Cell { Cell { c: c.into(), bg: Default::default(), fg: Default::default(), flags: CellFlags::empty(), } } pub fn reset(&mut self) { self.c = ' '; self.flags = CellFlags::empty(); // FIXME shouldn't know about term self.bg = DEFAULT_BG; self.fg = DEFAULT_FG; } } /// Represents the terminal display contents #[derive(Clone)] pub struct Grid { /// Rows in the grid. Each row holds a list of cells corresponding to the columns in that row. raw: Vec, /// Number of columns cols: usize, /// Number of rows. /// /// Invariant: rows is equivalent to cells.len() rows: usize, } impl Grid { pub fn new(rows: usize, cols: usize) -> Grid { let mut raw = Vec::with_capacity(rows); for _ in 0..rows { raw.push(Row::new(cols)); } Grid { raw: raw, cols: cols, rows: rows, } } #[inline] pub fn rows(&self) -> Iter { self.raw.iter() } #[inline] pub fn rows_mut(&mut self) -> IterMut { self.raw.iter_mut() } #[inline] pub fn num_rows(&self) -> usize { self.raw.len() } #[inline] pub fn num_cols(&self) -> usize { self.raw[0].len() } pub fn scroll(&mut self, region: Range, positions: isize) { self.raw[region].rotate(positions) } #[inline] pub fn clear(&mut self) { let region = 0..self.num_rows(); self.clear_region(region); } pub fn resize(&mut self, rows: usize, cols: usize) { // Check that there's actually work to do and return early if not if rows == self.rows && cols == self.cols { return; } match self.rows.cmp(&rows) { Ordering::Less => self.grow_rows(rows), Ordering::Greater => self.shrink_rows(rows), Ordering::Equal => (), } match self.cols.cmp(&cols) { Ordering::Less => self.grow_cols(cols), Ordering::Greater => self.shrink_cols(cols), Ordering::Equal => (), } } fn grow_rows(&mut self, rows: usize) { for _ in self.num_rows()..rows { self.raw.push(Row::new(self.cols)); } self.rows = rows; } fn shrink_rows(&mut self, rows: usize) { while self.raw.len() != rows { self.raw.pop(); } self.rows = rows; } fn grow_cols(&mut self, cols: usize) { for row in self.rows_mut() { row.grow(cols); } self.cols = cols; } fn shrink_cols(&mut self, cols: usize) { for row in self.rows_mut() { row.shrink(cols); } self.cols = cols; } } impl Index for Grid { type Output = Row; #[inline] fn index<'a>(&'a self, index: usize) -> &'a Row { &self.raw[index] } } impl IndexMut for Grid { #[inline] fn index_mut<'a>(&'a mut self, index: usize) -> &'a mut Row { &mut self.raw[index] } } impl Index for Grid { type Output = Cell; #[inline] fn index<'a>(&'a self, cursor: Cursor) -> &'a Cell { &self.raw[cursor.y as usize][cursor.x as usize] } } impl IndexMut for Grid { #[inline] fn index_mut<'a>(&'a mut self, cursor: Cursor) -> &'a mut Cell { &mut self.raw[cursor.y as usize][cursor.x as usize] } } /// A row in the grid #[derive(Debug, Clone)] pub struct Row(Vec); impl Row { pub fn new(columns: usize) -> Row { Row(vec![Cell::new(' '); columns]) } pub fn grow(&mut self, cols: usize) { while self.len() != cols { self.push(Cell::new(' ')); } } pub fn shrink(&mut self, cols: usize) { while self.len() != cols { self.pop(); } } pub fn cells(&self) -> Iter { self.0.iter() } pub fn cells_mut(&mut self) -> IterMut { self.0.iter_mut() } } impl<'a> IntoIterator for &'a Row { type Item = &'a Cell; type IntoIter = slice::Iter<'a, Cell>; fn into_iter(self) -> slice::Iter<'a, Cell> { self.iter() } } impl<'a> IntoIterator for &'a mut Row { type Item = &'a mut Cell; type IntoIter = slice::IterMut<'a, Cell>; fn into_iter(mut self) -> slice::IterMut<'a, Cell> { self.iter_mut() } } impl Deref for Row { type Target = Vec; fn deref(&self) -> &Self::Target { &self.0 } } impl DerefMut for Row { fn deref_mut(&mut self) -> &mut Self::Target { &mut self.0 } } impl Index for Row { type Output = Cell; #[inline] fn index<'a>(&'a self, index: usize) -> &'a Cell { &self.0[index] } } impl IndexMut for Row { #[inline] fn index_mut<'a>(&'a mut self, index: usize) -> &'a mut Cell { &mut self.0[index] } } macro_rules! row_index_range { ($range:ty) => { impl Index<$range> for Row { type Output = [Cell]; #[inline] fn index<'a>(&'a self, index: $range) -> &'a [Cell] { &self.0[index] } } impl IndexMut<$range> for Row { #[inline] fn index_mut<'a>(&'a mut self, index: $range) -> &'a mut [Cell] { &mut self.0[index] } } } } row_index_range!(Range); row_index_range!(RangeTo); row_index_range!(RangeFrom); row_index_range!(RangeFull); pub trait ClearRegion { fn clear_region(&mut self, region: T); } macro_rules! clear_region_impl { ($range:ty) => { impl ClearRegion<$range> for Grid { fn clear_region(&mut self, region: $range) { for row in self.raw[region].iter_mut() { for cell in row { cell.reset(); } } } } } } clear_region_impl!(Range); clear_region_impl!(RangeTo); clear_region_impl!(RangeFrom);