typst/src/library/shapes.rs

use std::f64::consts::SQRT_2;

use super::*;
use crate::color::Color;
use crate::layout::{BackgroundNode, BackgroundShape, Fill, FixedNode, PadNode};

/// `rect`: A rectangle with optional content.
///
/// # Positional parameters
/// - Body: optional, of type `template`.
///
/// # Named parameters
/// - Width: `width`, of type `linear` relative to parent width.
/// - Height: `height`, of type `linear` relative to parent height.
/// - Fill color: `fill`, of type `color`.
///
/// # Return value
/// A template that inserts a rectangle and sets the body into it.
pub fn rect(ctx: &mut EvalContext, args: &mut FuncArgs) -> Value {
    let width = args.get(ctx, "width");
    let height = args.get(ctx, "height");
    let fill = args.get(ctx, "fill");
    let body = args.find::<TemplateValue>(ctx).unwrap_or_default();
    rect_impl("rect", width, height, None, fill, body)
}

/// `square`: A square with optional content.
///
/// # Positional parameters
/// - Body: optional, of type `template`.
///
/// # Named parameters
/// - Side length: `length`, of type `length`.
/// - Width: `width`, of type `linear` relative to parent width.
/// - Height: `height`, of type `linear` relative to parent height.
/// - Fill color: `fill`, of type `color`.
///
/// Note that you can specify only one of `length`, `width` and `height`. The
/// width and height parameters exist so that you can size the square relative
/// to its parent's size, which isn't possible by setting the side length.
///
/// # Return value
/// A template that inserts a square and sets the body into it.
pub fn square(ctx: &mut EvalContext, args: &mut FuncArgs) -> Value {
    let length = args.get::<Length>(ctx, "length").map(Linear::from);
    let width = length.or_else(|| args.get(ctx, "width"));
    let height = if width.is_none() { args.get(ctx, "height") } else { None };
    let fill = args.get(ctx, "fill");
    let body = args.find::<TemplateValue>(ctx).unwrap_or_default();
    rect_impl("square", width, height, Some(1.0), fill, body)
}

fn rect_impl(
    name: &str,
    width: Option<Linear>,
    height: Option<Linear>,
    aspect: Option<f64>,
    fill: Option<Color>,
    body: TemplateValue,
) -> Value {
    Value::template(name, move |ctx| {
        let child = ctx.exec_group(&body).into();
        let node = FixedNode { width, height, aspect, child };

        if let Some(color) = fill {
            ctx.push_into_par(BackgroundNode {
                shape: BackgroundShape::Rect,
                fill: Fill::Color(color),
                child: node.into(),
            });
        } else {
            ctx.push_into_par(node);
        }
    })
}

/// `ellipse`: An ellipse with optional content.
///
/// # Positional parameters
/// - Body: optional, of type `template`.
///
/// # Named parameters
/// - Width: `width`, of type `linear` relative to parent width.
/// - Height: `height`, of type `linear` relative to parent height.
/// - Fill color: `fill`, of type `color`.
///
/// # Return value
/// A template that inserts an ellipse and sets the body into it.
pub fn ellipse(ctx: &mut EvalContext, args: &mut FuncArgs) -> Value {
    let width = args.get(ctx, "width");
    let height = args.get(ctx, "height");
    let fill = args.get(ctx, "fill");
    let body = args.find::<TemplateValue>(ctx).unwrap_or_default();
    ellipse_impl("ellipse", width, height, None, fill, body)
}

/// `circle`: A circle with optional content.
///
/// # Positional parameters
/// - Body: optional, of type `template`.
///
/// # Named parameters
/// - Radius: `radius`, of type `length`.
/// - Width: `width`, of type `linear` relative to parent width.
/// - Height: `height`, of type `linear` relative to parent height.
/// - Fill color: `fill`, of type `color`.
///
/// Note that you can specify only one of `radius`, `width` and `height`. The
/// width and height parameters exist so that you can size the circle relative
/// to its parent's size, which isn't possible by setting the radius.
///
/// # Return value
/// A template that inserts a circle and sets the body into it.
pub fn circle(ctx: &mut EvalContext, args: &mut FuncArgs) -> Value {
    let radius = args.get::<Length>(ctx, "radius").map(|r| 2.0 * Linear::from(r));
    let width = radius.or_else(|| args.get(ctx, "width"));
    let height = if width.is_none() { args.get(ctx, "height") } else { None };
    let fill = args.get(ctx, "fill");
    let body = args.find::<TemplateValue>(ctx).unwrap_or_default();
    ellipse_impl("circle", width, height, Some(1.0), fill, body)
}

fn ellipse_impl(
    name: &str,
    width: Option<Linear>,
    height: Option<Linear>,
    aspect: Option<f64>,
    fill: Option<Color>,
    body: TemplateValue,
) -> Value {
    Value::template(name, move |ctx| {
        // This padding ratio ensures that the rectangular padded area fits
        // perfectly into the ellipse.
        const PAD: f64 = 0.5 - SQRT_2 / 4.0;

        let child = ctx.exec_group(&body).into();
        let node = FixedNode {
            width,
            height,
            aspect,
            child: PadNode {
                padding: Sides::uniform(Relative::new(PAD).into()),
                child,
            }
            .into(),
        };

        if let Some(color) = fill {
            ctx.push_into_par(BackgroundNode {
                shape: BackgroundShape::Ellipse,
                fill: Fill::Color(color),
                child: node.into(),
            });
        } else {
            ctx.push_into_par(node);
        }
    })
}