tui-realm-stdlib 4.0.0

//! A canvas where you can draw more complex figures.

use tuirealm::command::{Cmd, CmdResult};
use tuirealm::component::Component;
use tuirealm::props::{
    AttrValue, Attribute, Borders, Color, PropPayload, PropValue, Props, QueryResult, Shape, Style,
    TextModifiers, Title,
};
use tuirealm::ratatui::Frame;
use tuirealm::ratatui::layout::Rect;
use tuirealm::ratatui::symbols::Marker;
use tuirealm::ratatui::text::{Line as Spans, Span};
use tuirealm::ratatui::widgets::canvas::{Canvas as TuiCanvas, Context, Points};
use tuirealm::state::State;

// -- Props
use super::props::{CANVAS_X_BOUNDS, CANVAS_Y_BOUNDS};
use crate::prop_ext::CommonProps;

// -- Component

/// The Canvas component may be used to draw more detailed figures using braille patterns (each cell can have a braille character in 8 different positions).
#[derive(Default)]
#[must_use]
pub struct Canvas {
    common: CommonProps,
    props: Props,
}

impl Canvas {
    /// Note that setting this value has no effect.
    ///
    /// If you want to set the border color, use [`borders`](Self::borders).
    /// If you want to set some point in the canvas, set it in the data.
    pub fn foreground(mut self, fg: Color) -> Self {
        self.attr(Attribute::Foreground, AttrValue::Color(fg));
        self
    }

    /// Set the main background color. This may get overwritten by individual text styles.
    pub fn background(mut self, bg: Color) -> Self {
        self.attr(Attribute::Background, AttrValue::Color(bg));
        self
    }

    /// Set the main text modifiers. This may get overwritten by individual text styles.
    pub fn modifiers(mut self, m: TextModifiers) -> Self {
        self.attr(Attribute::TextProps, AttrValue::TextModifiers(m));
        self
    }

    /// Set the main style. This may get overwritten by individual text styles.
    ///
    /// This option will overwrite any previous [`foreground`](Self::foreground), [`background`](Self::background) and [`modifiers`](Self::modifiers)!
    pub fn style(mut self, style: Style) -> Self {
        self.attr(Attribute::Style, AttrValue::Style(style));
        self
    }

    /// Set a custom style for the border when the component is unfocused.
    pub fn inactive(mut self, s: Style) -> Self {
        self.attr(Attribute::UnfocusedBorderStyle, AttrValue::Style(s));
        self
    }

    /// Add a border to the component.
    pub fn borders(mut self, b: Borders) -> Self {
        self.attr(Attribute::Borders, AttrValue::Borders(b));
        self
    }

    /// Add a title to the component.
    pub fn title<T: Into<Title>>(mut self, title: T) -> Self {
        self.attr(Attribute::Title, AttrValue::Title(title.into()));
        self
    }

    /// Set the initial data to display on the Canvas.
    pub fn data(mut self, data: impl IntoIterator<Item = Shape>) -> Self {
        self.attr(
            Attribute::Shape,
            AttrValue::Payload(PropPayload::Vec(
                data.into_iter().map(PropValue::Shape).collect(),
            )),
        );
        self
    }

    /// Those are used to define the viewport of the canvas.
    /// Only the points whose coordinates are within the viewport are displayed.
    /// When you render the canvas using Frame::render_widget, you give an area to draw the widget to (a Rect) and
    /// the crate translates the floating point coordinates to those used by our internal terminal representation.
    ///
    /// From <https://github.com/fdehau/tui-rs/issues/286>, also read [`Canvas::x_bounds`](TuiCanvas::x_bounds).
    pub fn x_bounds(mut self, bounds: (f64, f64)) -> Self {
        self.attr(
            Attribute::Custom(CANVAS_X_BOUNDS),
            AttrValue::Payload(PropPayload::Pair((
                PropValue::F64(bounds.0),
                PropValue::F64(bounds.1),
            ))),
        );
        self
    }

    /// Those are used to define the viewport of the canvas.
    /// Only the points whose coordinates are within the viewport are displayed.
    /// When you render the canvas using Frame::render_widget, you give an area to draw the widget to (a Rect) and
    /// the crate translates the floating point coordinates to those used by our internal terminal representation.
    ///
    /// From <https://github.com/fdehau/tui-rs/issues/286>, also read [`Canvas::y_bounds`](TuiCanvas::y_bounds).
    pub fn y_bounds(mut self, bounds: (f64, f64)) -> Self {
        self.attr(
            Attribute::Custom(CANVAS_Y_BOUNDS),
            AttrValue::Payload(PropPayload::Pair((
                PropValue::F64(bounds.0),
                PropValue::F64(bounds.1),
            ))),
        );
        self
    }

    /// Set which kind of [`Marker`] type should be used for a point.
    pub fn marker(mut self, marker: Marker) -> Self {
        self.attr(Attribute::Marker, AttrValue::Marker(marker));
        self
    }

    /// Draw a shape into the canvas `Context`.
    fn draw_shape(ctx: &mut Context, shape: &Shape) {
        match shape {
            Shape::Label((x, y, label, color)) => {
                let span = Span::styled(label.to_string(), Style::default().fg(*color));
                ctx.print(*x, *y, Spans::from(vec![span]));
            }
            Shape::Layer => ctx.layer(),
            Shape::Line(line) => ctx.draw(line),
            Shape::Map(map) => ctx.draw(map),
            Shape::Points((coords, color)) => ctx.draw(&Points {
                coords,
                color: *color,
            }),
            Shape::Rectangle(rectangle) => ctx.draw(rectangle),
        }
    }
}

impl Component for Canvas {
    fn view(&mut self, render: &mut Frame, area: Rect) {
        if !self.common.display {
            return;
        }

        // Get properties
        let x_bounds: [f64; 2] = self
            .props
            .get(Attribute::Custom(CANVAS_X_BOUNDS))
            .and_then(AttrValue::as_payload)
            .and_then(PropPayload::as_pair)
            .and_then(|(a, b)| Some([a.as_f64()?, b.as_f64()?]))
            .unwrap_or_default();
        let y_bounds: [f64; 2] = self
            .props
            .get(Attribute::Custom(CANVAS_Y_BOUNDS))
            .and_then(AttrValue::as_payload)
            .and_then(PropPayload::as_pair)
            .and_then(|(a, b)| Some([a.as_f64()?, b.as_f64()?]))
            .unwrap_or_default();
        // Get shapes
        let shapes: Vec<Shape> = self
            .props
            .get(Attribute::Shape)
            .and_then(AttrValue::as_payload)
            .and_then(PropPayload::as_vec)
            .map(|v| v.iter().filter_map(PropValue::as_shape).cloned().collect())
            .unwrap_or_default();

        let marker = self
            .props
            .get(Attribute::Marker)
            .and_then(AttrValue::as_marker)
            .unwrap_or(Marker::Braille);

        // Make canvas
        let mut widget = TuiCanvas::default()
            .marker(marker)
            .x_bounds(x_bounds)
            .y_bounds(y_bounds)
            .paint(|ctx| shapes.iter().for_each(|x| Self::draw_shape(ctx, x)));

        if let Some(block) = self.common.get_block() {
            widget = widget.block(block);
        }
        if let Some(color) = self.common.style.bg {
            widget = widget.background_color(color);
        }

        // Render
        render.render_widget(widget, area);
    }

    fn query<'a>(&'a self, attr: Attribute) -> Option<QueryResult<'a>> {
        if let Some(value) = self.common.get_for_query(attr) {
            return Some(value);
        }

        self.props.get_for_query(attr)
    }

    fn attr(&mut self, attr: Attribute, value: AttrValue) {
        if let Some(value) = self.common.set(attr, value) {
            self.props.set(attr, value);
        }
    }

    fn state(&self) -> State {
        State::None
    }

    fn perform(&mut self, cmd: Cmd) -> CmdResult {
        CmdResult::Invalid(cmd)
    }
}

#[cfg(test)]
mod test {

    use pretty_assertions::assert_eq;
    use tuirealm::props::HorizontalAlignment;
    use tuirealm::ratatui::widgets::canvas::{Line, Map, MapResolution, Rectangle};

    use super::*;

    #[test]
    fn test_component_canvas_with_shapes() {
        let component: Canvas = Canvas::default()
            .background(Color::Black)
            .title(Title::from("playing risiko").alignment(HorizontalAlignment::Center))
            .borders(Borders::default())
            .marker(Marker::Dot)
            .x_bounds((-180.0, 180.0))
            .y_bounds((-90.0, 90.0))
            .data([
                Shape::Map(Map {
                    resolution: MapResolution::High,
                    color: Color::Rgb(240, 240, 240),
                }),
                Shape::Layer,
                Shape::Line(Line {
                    x1: 0.0,
                    y1: 10.0,
                    x2: 10.0,
                    y2: 10.0,
                    color: Color::Red,
                }),
                Shape::Rectangle(Rectangle {
                    x: 60.0,
                    y: 20.0,
                    width: 70.0,
                    height: 22.0,
                    color: Color::Cyan,
                }),
                Shape::Points((
                    vec![
                        (21.0, 13.0),
                        (66.0, 77.0),
                        (34.0, 69.0),
                        (45.0, 76.0),
                        (120.0, 55.0),
                        (-32.0, -50.0),
                        (-4.0, 2.0),
                        (-32.0, -48.0),
                    ],
                    Color::Green,
                )),
            ]);
        assert_eq!(component.state(), State::None);
    }
}