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.
497 lines
13 KiB
Rust
497 lines
13 KiB
Rust
mod line;
|
|
mod map;
|
|
mod points;
|
|
mod rectangle;
|
|
mod world;
|
|
|
|
pub use self::line::Line;
|
|
pub use self::map::{Map, MapResolution};
|
|
pub use self::points::Points;
|
|
pub use self::rectangle::Rectangle;
|
|
|
|
use crate::{
|
|
buffer::Buffer,
|
|
layout::Rect,
|
|
style::{Color, Style},
|
|
symbols,
|
|
widgets::{Block, Widget},
|
|
};
|
|
use std::fmt::Debug;
|
|
|
|
/// Interface for all shapes that may be drawn on a Canvas widget.
|
|
pub trait Shape {
|
|
fn draw(&self, painter: &mut Painter);
|
|
}
|
|
|
|
/// Label to draw some text on the canvas
|
|
#[derive(Debug, Clone)]
|
|
pub struct Label<'a> {
|
|
pub x: f64,
|
|
pub y: f64,
|
|
pub text: &'a str,
|
|
pub color: Color,
|
|
}
|
|
|
|
#[derive(Debug, Clone)]
|
|
struct Layer {
|
|
string: String,
|
|
colors: Vec<Color>,
|
|
}
|
|
|
|
trait Grid: Debug {
|
|
fn width(&self) -> u16;
|
|
fn height(&self) -> u16;
|
|
fn resolution(&self) -> (f64, f64);
|
|
fn paint(&mut self, x: usize, y: usize, color: Color);
|
|
fn save(&self) -> Layer;
|
|
fn reset(&mut self);
|
|
}
|
|
|
|
#[derive(Debug, Clone)]
|
|
struct BrailleGrid {
|
|
width: u16,
|
|
height: u16,
|
|
cells: Vec<u16>,
|
|
colors: Vec<Color>,
|
|
}
|
|
|
|
impl BrailleGrid {
|
|
fn new(width: u16, height: u16) -> BrailleGrid {
|
|
let length = usize::from(width * height);
|
|
BrailleGrid {
|
|
width,
|
|
height,
|
|
cells: vec![symbols::braille::BLANK; length],
|
|
colors: vec![Color::Reset; length],
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Grid for BrailleGrid {
|
|
fn width(&self) -> u16 {
|
|
self.width
|
|
}
|
|
|
|
fn height(&self) -> u16 {
|
|
self.height
|
|
}
|
|
|
|
fn resolution(&self) -> (f64, f64) {
|
|
(
|
|
f64::from(self.width) * 2.0 - 1.0,
|
|
f64::from(self.height) * 4.0 - 1.0,
|
|
)
|
|
}
|
|
|
|
fn save(&self) -> Layer {
|
|
Layer {
|
|
string: String::from_utf16(&self.cells).unwrap(),
|
|
colors: self.colors.clone(),
|
|
}
|
|
}
|
|
|
|
fn reset(&mut self) {
|
|
for c in &mut self.cells {
|
|
*c = symbols::braille::BLANK;
|
|
}
|
|
for c in &mut self.colors {
|
|
*c = Color::Reset;
|
|
}
|
|
}
|
|
|
|
fn paint(&mut self, x: usize, y: usize, color: Color) {
|
|
let index = y / 4 * self.width as usize + x / 2;
|
|
if let Some(c) = self.cells.get_mut(index) {
|
|
*c |= symbols::braille::DOTS[y % 4][x % 2];
|
|
}
|
|
if let Some(c) = self.colors.get_mut(index) {
|
|
*c = color;
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, Clone)]
|
|
struct DotGrid {
|
|
width: u16,
|
|
height: u16,
|
|
cells: Vec<char>,
|
|
colors: Vec<Color>,
|
|
}
|
|
|
|
impl DotGrid {
|
|
fn new(width: u16, height: u16) -> DotGrid {
|
|
let length = usize::from(width * height);
|
|
DotGrid {
|
|
width,
|
|
height,
|
|
cells: vec![' '; length],
|
|
colors: vec![Color::Reset; length],
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Grid for DotGrid {
|
|
fn width(&self) -> u16 {
|
|
self.width
|
|
}
|
|
|
|
fn height(&self) -> u16 {
|
|
self.height
|
|
}
|
|
|
|
fn resolution(&self) -> (f64, f64) {
|
|
(f64::from(self.width) - 1.0, f64::from(self.height) - 1.0)
|
|
}
|
|
|
|
fn save(&self) -> Layer {
|
|
Layer {
|
|
string: self.cells.iter().collect(),
|
|
colors: self.colors.clone(),
|
|
}
|
|
}
|
|
|
|
fn reset(&mut self) {
|
|
for c in &mut self.cells {
|
|
*c = ' ';
|
|
}
|
|
for c in &mut self.colors {
|
|
*c = Color::Reset;
|
|
}
|
|
}
|
|
|
|
fn paint(&mut self, x: usize, y: usize, color: Color) {
|
|
let index = y * self.width as usize + x;
|
|
if let Some(c) = self.cells.get_mut(index) {
|
|
*c = '•';
|
|
}
|
|
if let Some(c) = self.colors.get_mut(index) {
|
|
*c = color;
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Debug)]
|
|
pub struct Painter<'a, 'b> {
|
|
context: &'a mut Context<'b>,
|
|
resolution: (f64, f64),
|
|
}
|
|
|
|
impl<'a, 'b> Painter<'a, 'b> {
|
|
/// Convert the (x, y) coordinates to location of a point on the grid
|
|
///
|
|
/// # Examples:
|
|
/// ```
|
|
/// use tui::{symbols, widgets::canvas::{Painter, Context}};
|
|
///
|
|
/// let mut ctx = Context::new(2, 2, [1.0, 2.0], [0.0, 2.0], symbols::Marker::Braille);
|
|
/// let mut painter = Painter::from(&mut ctx);
|
|
/// let point = painter.get_point(1.0, 0.0);
|
|
/// assert_eq!(point, Some((0, 7)));
|
|
/// let point = painter.get_point(1.5, 1.0);
|
|
/// assert_eq!(point, Some((1, 3)));
|
|
/// let point = painter.get_point(0.0, 0.0);
|
|
/// assert_eq!(point, None);
|
|
/// let point = painter.get_point(2.0, 2.0);
|
|
/// assert_eq!(point, Some((3, 0)));
|
|
/// let point = painter.get_point(1.0, 2.0);
|
|
/// assert_eq!(point, Some((0, 0)));
|
|
/// ```
|
|
pub fn get_point(&self, x: f64, y: f64) -> Option<(usize, usize)> {
|
|
let left = self.context.x_bounds[0];
|
|
let right = self.context.x_bounds[1];
|
|
let top = self.context.y_bounds[1];
|
|
let bottom = self.context.y_bounds[0];
|
|
if x < left || x > right || y < bottom || y > top {
|
|
return None;
|
|
}
|
|
let width = (self.context.x_bounds[1] - self.context.x_bounds[0]).abs();
|
|
let height = (self.context.y_bounds[1] - self.context.y_bounds[0]).abs();
|
|
if width == 0.0 || height == 0.0 {
|
|
return None;
|
|
}
|
|
let x = ((x - left) * self.resolution.0 / width) as usize;
|
|
let y = ((top - y) * self.resolution.1 / height) as usize;
|
|
Some((x, y))
|
|
}
|
|
|
|
/// Paint a point of the grid
|
|
///
|
|
/// # Examples:
|
|
/// ```
|
|
/// use tui::{style::Color, symbols, widgets::canvas::{Painter, Context}};
|
|
///
|
|
/// let mut ctx = Context::new(1, 1, [0.0, 2.0], [0.0, 2.0], symbols::Marker::Braille);
|
|
/// let mut painter = Painter::from(&mut ctx);
|
|
/// let cell = painter.paint(1, 3, Color::Red);
|
|
/// ```
|
|
pub fn paint(&mut self, x: usize, y: usize, color: Color) {
|
|
self.context.grid.paint(x, y, color);
|
|
}
|
|
}
|
|
|
|
impl<'a, 'b> From<&'a mut Context<'b>> for Painter<'a, 'b> {
|
|
fn from(context: &'a mut Context<'b>) -> Painter<'a, 'b> {
|
|
let resolution = context.grid.resolution();
|
|
Painter {
|
|
context,
|
|
resolution,
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Holds the state of the Canvas when painting to it.
|
|
#[derive(Debug)]
|
|
pub struct Context<'a> {
|
|
x_bounds: [f64; 2],
|
|
y_bounds: [f64; 2],
|
|
grid: Box<dyn Grid>,
|
|
dirty: bool,
|
|
layers: Vec<Layer>,
|
|
labels: Vec<Label<'a>>,
|
|
}
|
|
|
|
impl<'a> Context<'a> {
|
|
pub fn new(
|
|
width: u16,
|
|
height: u16,
|
|
x_bounds: [f64; 2],
|
|
y_bounds: [f64; 2],
|
|
marker: symbols::Marker,
|
|
) -> Context<'a> {
|
|
let grid: Box<dyn Grid> = match marker {
|
|
symbols::Marker::Dot => Box::new(DotGrid::new(width, height)),
|
|
symbols::Marker::Braille => Box::new(BrailleGrid::new(width, height)),
|
|
};
|
|
Context {
|
|
x_bounds,
|
|
y_bounds,
|
|
grid,
|
|
dirty: false,
|
|
layers: Vec::new(),
|
|
labels: Vec::new(),
|
|
}
|
|
}
|
|
|
|
/// Draw any object that may implement the Shape trait
|
|
pub fn draw<S>(&mut self, shape: &S)
|
|
where
|
|
S: Shape,
|
|
{
|
|
self.dirty = true;
|
|
let mut painter = Painter::from(self);
|
|
shape.draw(&mut painter);
|
|
}
|
|
|
|
/// Go one layer above in the canvas.
|
|
pub fn layer(&mut self) {
|
|
self.layers.push(self.grid.save());
|
|
self.grid.reset();
|
|
self.dirty = false;
|
|
}
|
|
|
|
/// Print a string on the canvas at the given position
|
|
pub fn print(&mut self, x: f64, y: f64, text: &'a str, color: Color) {
|
|
self.labels.push(Label { x, y, text, color });
|
|
}
|
|
|
|
/// Push the last layer if necessary
|
|
fn finish(&mut self) {
|
|
if self.dirty {
|
|
self.layer()
|
|
}
|
|
}
|
|
}
|
|
|
|
/// The Canvas widget may be used to draw more detailed figures using braille patterns (each
|
|
/// cell can have a braille character in 8 different positions).
|
|
/// # Examples
|
|
///
|
|
/// ```
|
|
/// # use tui::widgets::{Block, Borders};
|
|
/// # use tui::layout::Rect;
|
|
/// # use tui::widgets::canvas::{Canvas, Shape, Line, Rectangle, Map, MapResolution};
|
|
/// # use tui::style::Color;
|
|
/// Canvas::default()
|
|
/// .block(Block::default().title("Canvas").borders(Borders::ALL))
|
|
/// .x_bounds([-180.0, 180.0])
|
|
/// .y_bounds([-90.0, 90.0])
|
|
/// .paint(|ctx| {
|
|
/// ctx.draw(&Map {
|
|
/// resolution: MapResolution::High,
|
|
/// color: Color::White
|
|
/// });
|
|
/// ctx.layer();
|
|
/// ctx.draw(&Line {
|
|
/// x1: 0.0,
|
|
/// y1: 10.0,
|
|
/// x2: 10.0,
|
|
/// y2: 10.0,
|
|
/// color: Color::White,
|
|
/// });
|
|
/// ctx.draw(&Rectangle {
|
|
/// x: 10.0,
|
|
/// y: 20.0,
|
|
/// width: 10.0,
|
|
/// height: 10.0,
|
|
/// color: Color::Red
|
|
/// });
|
|
/// });
|
|
/// ```
|
|
pub struct Canvas<'a, F>
|
|
where
|
|
F: Fn(&mut Context),
|
|
{
|
|
block: Option<Block<'a>>,
|
|
x_bounds: [f64; 2],
|
|
y_bounds: [f64; 2],
|
|
painter: Option<F>,
|
|
background_color: Color,
|
|
marker: symbols::Marker,
|
|
}
|
|
|
|
impl<'a, F> Default for Canvas<'a, F>
|
|
where
|
|
F: Fn(&mut Context),
|
|
{
|
|
fn default() -> Canvas<'a, F> {
|
|
Canvas {
|
|
block: None,
|
|
x_bounds: [0.0, 0.0],
|
|
y_bounds: [0.0, 0.0],
|
|
painter: None,
|
|
background_color: Color::Reset,
|
|
marker: symbols::Marker::Braille,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<'a, F> Canvas<'a, F>
|
|
where
|
|
F: Fn(&mut Context),
|
|
{
|
|
pub fn block(mut self, block: Block<'a>) -> Canvas<'a, F> {
|
|
self.block = Some(block);
|
|
self
|
|
}
|
|
|
|
pub fn x_bounds(mut self, bounds: [f64; 2]) -> Canvas<'a, F> {
|
|
self.x_bounds = bounds;
|
|
self
|
|
}
|
|
|
|
pub fn y_bounds(mut self, bounds: [f64; 2]) -> Canvas<'a, F> {
|
|
self.y_bounds = bounds;
|
|
self
|
|
}
|
|
|
|
/// Store the closure that will be used to draw to the Canvas
|
|
pub fn paint(mut self, f: F) -> Canvas<'a, F> {
|
|
self.painter = Some(f);
|
|
self
|
|
}
|
|
|
|
pub fn background_color(mut self, color: Color) -> Canvas<'a, F> {
|
|
self.background_color = color;
|
|
self
|
|
}
|
|
|
|
/// Change the type of points used to draw the shapes. By default the braille patterns are used
|
|
/// as they provide a more fine grained result but you might want to use the simple dot instead
|
|
/// if the targeted terminal does not support those symbols.
|
|
///
|
|
/// # Examples
|
|
///
|
|
/// ```
|
|
/// # use tui::widgets::canvas::Canvas;
|
|
/// # use tui::symbols;
|
|
/// Canvas::default().marker(symbols::Marker::Braille).paint(|ctx| {});
|
|
///
|
|
/// Canvas::default().marker(symbols::Marker::Dot).paint(|ctx| {});
|
|
/// ```
|
|
pub fn marker(mut self, marker: symbols::Marker) -> Canvas<'a, F> {
|
|
self.marker = marker;
|
|
self
|
|
}
|
|
}
|
|
|
|
impl<'a, F> Widget for Canvas<'a, F>
|
|
where
|
|
F: Fn(&mut Context),
|
|
{
|
|
fn render(mut self, area: Rect, buf: &mut Buffer) {
|
|
let canvas_area = match self.block {
|
|
Some(ref mut b) => {
|
|
b.render(area, buf);
|
|
b.inner(area)
|
|
}
|
|
None => area,
|
|
};
|
|
|
|
let width = canvas_area.width as usize;
|
|
|
|
let painter = match self.painter {
|
|
Some(ref p) => p,
|
|
None => return,
|
|
};
|
|
|
|
// Create a blank context that match the size of the canvas
|
|
let mut ctx = Context::new(
|
|
canvas_area.width,
|
|
canvas_area.height,
|
|
self.x_bounds,
|
|
self.y_bounds,
|
|
self.marker,
|
|
);
|
|
// Paint to this context
|
|
painter(&mut ctx);
|
|
ctx.finish();
|
|
|
|
// Retreive painted points for each layer
|
|
for layer in ctx.layers {
|
|
for (i, (ch, color)) in layer
|
|
.string
|
|
.chars()
|
|
.zip(layer.colors.into_iter())
|
|
.enumerate()
|
|
{
|
|
if ch != ' ' && ch != '\u{2800}' {
|
|
let (x, y) = (i % width, i / width);
|
|
buf.get_mut(x as u16 + canvas_area.left(), y as u16 + canvas_area.top())
|
|
.set_char(ch)
|
|
.set_fg(color)
|
|
.set_bg(self.background_color);
|
|
}
|
|
}
|
|
}
|
|
|
|
// Finally draw the labels
|
|
let style = Style::default().bg(self.background_color);
|
|
let left = self.x_bounds[0];
|
|
let right = self.x_bounds[1];
|
|
let top = self.y_bounds[1];
|
|
let bottom = self.y_bounds[0];
|
|
let width = (self.x_bounds[1] - self.x_bounds[0]).abs();
|
|
let height = (self.y_bounds[1] - self.y_bounds[0]).abs();
|
|
let resolution = {
|
|
let width = f64::from(canvas_area.width - 1);
|
|
let height = f64::from(canvas_area.height - 1);
|
|
(width, height)
|
|
};
|
|
for label in ctx
|
|
.labels
|
|
.iter()
|
|
.filter(|l| l.x >= left && l.x <= right && l.y <= top && l.y >= bottom)
|
|
{
|
|
let x = ((label.x - left) * resolution.0 / width) as u16 + canvas_area.left();
|
|
let y = ((top - label.y) * resolution.1 / height) as u16 + canvas_area.top();
|
|
buf.set_stringn(
|
|
x,
|
|
y,
|
|
label.text,
|
|
(canvas_area.right() - x) as usize,
|
|
style.fg(label.color),
|
|
);
|
|
}
|
|
}
|
|
}
|