mirror of https://github.com/fdehau/tui-rs
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
249 lines
7.7 KiB
Rust
249 lines
7.7 KiB
Rust
use std::cmp::min;
|
|
use std::usize;
|
|
|
|
use unicode_segmentation::UnicodeSegmentation;
|
|
|
|
use layout::Rect;
|
|
use style::{Style, Color, Modifier};
|
|
|
|
/// A buffer cell
|
|
#[derive(Debug, Clone, PartialEq)]
|
|
pub struct Cell {
|
|
pub symbol: String,
|
|
pub style: Style,
|
|
}
|
|
|
|
impl Cell {
|
|
pub fn set_symbol(&mut self, symbol: &str) -> &mut Cell {
|
|
self.symbol.clear();
|
|
self.symbol.push_str(symbol);
|
|
self
|
|
}
|
|
|
|
pub fn set_char(&mut self, ch: char) -> &mut Cell {
|
|
self.symbol.clear();
|
|
self.symbol.push(ch);
|
|
self
|
|
}
|
|
|
|
pub fn set_fg(&mut self, color: Color) -> &mut Cell {
|
|
self.style.fg = color;
|
|
self
|
|
}
|
|
|
|
pub fn set_bg(&mut self, color: Color) -> &mut Cell {
|
|
self.style.bg = color;
|
|
self
|
|
}
|
|
|
|
pub fn set_modifier(&mut self, modifier: Modifier) -> &mut Cell {
|
|
self.style.modifier = modifier;
|
|
self
|
|
}
|
|
|
|
pub fn set_style(&mut self, style: Style) -> &mut Cell {
|
|
self.style = style;
|
|
self
|
|
}
|
|
|
|
pub fn reset(&mut self) {
|
|
self.symbol.clear();
|
|
self.symbol.push(' ');
|
|
self.style.reset();
|
|
}
|
|
}
|
|
|
|
impl Default for Cell {
|
|
fn default() -> Cell {
|
|
Cell {
|
|
symbol: " ".into(),
|
|
style: Default::default(),
|
|
}
|
|
}
|
|
}
|
|
|
|
/// A buffer that maps to the desired content of the terminal after the draw call
|
|
///
|
|
/// No widget in the library interacts directly with the terminal. Instead each of them is required
|
|
/// to draw their state to an intermediate buffer. It is basically a grid where each cell contains
|
|
/// a grapheme, a foreground color and a background color. This grid will then be used to output
|
|
/// the appropriate escape sequences and characters to draw the UI as the user has defined it.
|
|
///
|
|
/// # Examples:
|
|
///
|
|
/// ```
|
|
/// # extern crate tui;
|
|
/// use tui::buffer::{Buffer, Cell};
|
|
/// use tui::layout::Rect;
|
|
/// use tui::style::{Color, Style, Modifier};
|
|
///
|
|
/// # fn main() {
|
|
/// let mut buf = Buffer::empty(Rect{x: 0, y: 0, width: 10, height: 5});
|
|
/// buf.get_mut(0, 2).set_symbol("x");
|
|
/// assert_eq!(buf.get(0, 2).symbol, "x");
|
|
/// buf.set_string(3, 0, "string", &Style::default().fg(Color::Red).bg(Color::White));
|
|
/// assert_eq!(buf.get(5, 0), &Cell{
|
|
/// symbol: String::from("r"),
|
|
/// style: Style {
|
|
/// fg: Color::Red,
|
|
/// bg: Color::White,
|
|
/// modifier: Modifier::Reset
|
|
/// }});
|
|
/// buf.get_mut(5, 0).set_char('x');
|
|
/// assert_eq!(buf.get(5, 0).symbol, "x");
|
|
/// # }
|
|
/// ```
|
|
#[derive(Debug, Clone)]
|
|
pub struct Buffer {
|
|
/// The area represented by this buffer
|
|
pub area: Rect,
|
|
/// The content of the buffer. The length of this Vec should always be equal to area.width *
|
|
/// area.height
|
|
pub content: Vec<Cell>,
|
|
}
|
|
|
|
impl Default for Buffer {
|
|
fn default() -> Buffer {
|
|
Buffer {
|
|
area: Default::default(),
|
|
content: Vec::new(),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Buffer {
|
|
/// Returns a Buffer with all cells set to the default one
|
|
pub fn empty(area: Rect) -> Buffer {
|
|
let cell: Cell = Default::default();
|
|
Buffer::filled(area, cell)
|
|
}
|
|
|
|
/// Returns a Buffer with all cells initialized with the attributes of the given Cell
|
|
pub fn filled(area: Rect, cell: Cell) -> Buffer {
|
|
let size = area.area() as usize;
|
|
let mut content = Vec::with_capacity(size);
|
|
for _ in 0..size {
|
|
content.push(cell.clone());
|
|
}
|
|
Buffer {
|
|
area: area,
|
|
content: content,
|
|
}
|
|
}
|
|
|
|
/// Returns the content of the buffer as a slice
|
|
pub fn content(&self) -> &[Cell] {
|
|
&self.content
|
|
}
|
|
|
|
/// Returns the area covered by this buffer
|
|
pub fn area(&self) -> &Rect {
|
|
&self.area
|
|
}
|
|
|
|
/// Returns a reference to Cell at the given coordinates
|
|
pub fn get(&self, x: u16, y: u16) -> &Cell {
|
|
let i = self.index_of(x, y);
|
|
&self.content[i]
|
|
}
|
|
|
|
/// Returns a mutable reference to Cell at the given coordinates
|
|
pub fn get_mut(&mut self, x: u16, y: u16) -> &mut Cell {
|
|
let i = self.index_of(x, y);
|
|
&mut self.content[i]
|
|
}
|
|
|
|
/// Returns the index in the Vec<Cell> for the given (x, y)
|
|
pub fn index_of(&self, x: u16, y: u16) -> usize {
|
|
debug_assert!(x >= self.area.left() && x < self.area.right() && y >= self.area.top() &&
|
|
y < self.area.bottom(),
|
|
"Trying to access position outside the buffer: x={}, y={}, area={:?}",
|
|
x,
|
|
y,
|
|
self.area);
|
|
let index = ((y - self.area.y) * self.area.width + (x - self.area.x)) as usize;
|
|
index
|
|
}
|
|
|
|
/// Returns the coordinates of a cell given its index
|
|
pub fn pos_of(&self, i: usize) -> (u16, u16) {
|
|
debug_assert!(i >= self.content.len(),
|
|
"Trying to get the coords of a cell outside the buffer: i={} len={}",
|
|
i,
|
|
self.content.len());
|
|
(self.area.x + i as u16 % self.area.width, self.area.y + i as u16 / self.area.width)
|
|
}
|
|
|
|
/// Print a string, starting at the position (x, y)
|
|
pub fn set_string(&mut self, x: u16, y: u16, string: &str, style: &Style) {
|
|
self.set_stringn(x, y, string, usize::MAX, style);
|
|
}
|
|
|
|
/// Print at most the first n characters of a string if enough space is available
|
|
/// until the end of the line
|
|
pub fn set_stringn(&mut self, x: u16, y: u16, string: &str, limit: usize, style: &Style) {
|
|
let mut index = self.index_of(x, y);
|
|
let graphemes = UnicodeSegmentation::graphemes(string, true).collect::<Vec<&str>>();
|
|
let max_index = min((self.area.right() - x) as usize, limit);
|
|
for s in graphemes.into_iter().take(max_index) {
|
|
self.content[index].symbol.clear();
|
|
self.content[index].symbol.push_str(s);
|
|
self.content[index].style = style.clone();
|
|
index += 1;
|
|
}
|
|
}
|
|
|
|
/// Resize the buffer so that the mapped area matches the given area and that the buffer
|
|
/// length is equal to area.width * area.height
|
|
pub fn resize(&mut self, area: Rect) {
|
|
let length = area.area() as usize;
|
|
if self.content.len() > length {
|
|
self.content.truncate(length);
|
|
} else {
|
|
self.content.resize(length, Default::default());
|
|
}
|
|
self.area = area;
|
|
}
|
|
|
|
/// Reset all cells in the buffer
|
|
pub fn reset(&mut self) {
|
|
for c in &mut self.content {
|
|
c.reset();
|
|
}
|
|
}
|
|
|
|
/// Merge an other buffer into this one
|
|
pub fn merge(&mut self, other: Buffer) {
|
|
let area = self.area.union(&other.area);
|
|
let cell: Cell = Default::default();
|
|
self.content.resize(area.area() as usize, cell.clone());
|
|
|
|
// Move original content to the appropriate space
|
|
let offset_x = self.area.x - area.x;
|
|
let offset_y = self.area.y - area.y;
|
|
let size = self.area.area() as usize;
|
|
for i in (0..size).rev() {
|
|
let (x, y) = self.pos_of(i);
|
|
// New index in content
|
|
let k = ((y + offset_y) * area.width + (x + offset_x)) as usize;
|
|
self.content[k] = self.content[i].clone();
|
|
if i != k {
|
|
self.content[i] = cell.clone();
|
|
}
|
|
}
|
|
|
|
// Push content of the other buffer into this one (may erase previous
|
|
// data)
|
|
let offset_x = other.area.x - area.x;
|
|
let offset_y = other.area.y - area.y;
|
|
let size = other.area.area() as usize;
|
|
for i in 0..size {
|
|
let (x, y) = other.pos_of(i);
|
|
// New index in content
|
|
let k = ((y + offset_y) * area.width + (x + offset_x)) as usize;
|
|
self.content[k] = other.content[i].clone();
|
|
}
|
|
self.area = area;
|
|
}
|
|
}
|