chartml_core/

element.rs

use std::collections::HashMap;

use serde::{Deserialize, Serialize};

/// The output of any ChartRenderer. Framework adapters walk this tree
/// and produce framework-specific DOM/view output.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "camelCase")]
pub enum ChartElement {
    Svg {
        viewbox: ViewBox,
        width: Option<f64>,
        height: Option<f64>,
        class: String,
        children: Vec<ChartElement>,
    },
    Group {
        class: String,
        transform: Option<Transform>,
        children: Vec<ChartElement>,
    },
    Rect {
        x: f64,
        y: f64,
        width: f64,
        height: f64,
        fill: String,
        stroke: Option<String>,
        /// Corner radius on the x axis. When `None`, no `rx` attribute is
        /// emitted (preserving byte-identical output for un-themed charts).
        /// Wired from `Theme::bar_corner_radius` in Phase 5 — bars emit
        /// `Some(v)` when `bar_corner_radius` is `Uniform(v)` with `v > 0.0`,
        /// else `None`. Top-only rounding is emitted as a `Path` instead of
        /// a `Rect` (see `BarCornerRadius::Top`).
        #[serde(default, skip_serializing_if = "Option::is_none")]
        rx: Option<f64>,
        /// Corner radius on the y axis. See `rx`.
        #[serde(default, skip_serializing_if = "Option::is_none")]
        ry: Option<f64>,
        class: String,
        data: Option<ElementData>,
        /// CSS `transform-origin` anchor for entrance animations, in the
        /// element's own coordinate space (absolute SVG coords). Populated
        /// by bar emission sites in `chartml-chart-cartesian/src/bar.rs` so
        /// the renderer never has to guess orientation/sign. `None` for
        /// every non-bar Rect — the renderer falls back to its legacy
        /// behavior, preserving byte-identical SVG output for all
        /// pre-existing baselines (see `backward_compat_goldens_byte_identical`).
        #[serde(default, skip_serializing_if = "Option::is_none")]
        animation_origin: Option<(f64, f64)>,
    },
    #[serde(rename_all = "camelCase")]
    Path {
        d: String,
        fill: Option<String>,
        stroke: Option<String>,
        stroke_width: Option<f64>,
        stroke_dasharray: Option<String>,
        opacity: Option<f64>,
        class: String,
        data: Option<ElementData>,
        /// See [`ChartElement::Rect::animation_origin`]. Populated by
        /// `build_bar_element` for top-rounded bars (`BarCornerRadius::Top`),
        /// which are emitted as `Path` instead of `Rect` because SVG `<rect>`
        /// can't round only two corners. `None` for every other Path.
        #[serde(default, skip_serializing_if = "Option::is_none")]
        animation_origin: Option<(f64, f64)>,
    },
    Circle {
        cx: f64,
        cy: f64,
        r: f64,
        fill: String,
        stroke: Option<String>,
        class: String,
        data: Option<ElementData>,
    },
    #[serde(rename_all = "camelCase")]
    Line {
        x1: f64,
        y1: f64,
        x2: f64,
        y2: f64,
        stroke: String,
        stroke_width: Option<f64>,
        stroke_dasharray: Option<String>,
        class: String,
    },
    #[serde(rename_all = "camelCase")]
    Text {
        x: f64,
        y: f64,
        content: String,
        anchor: TextAnchor,
        dominant_baseline: Option<String>,
        transform: Option<Transform>,
        font_family: Option<String>,
        font_size: Option<String>,
        font_weight: Option<String>,
        letter_spacing: Option<String>,
        text_transform: Option<String>,
        fill: Option<String>,
        class: String,
        data: Option<ElementData>,
    },
    /// Non-SVG container (e.g., metric card uses div-based layout)
    Div {
        class: String,
        style: HashMap<String, String>,
        children: Vec<ChartElement>,
    },
    /// Raw text node (for metric values, labels in div-based charts)
    Span {
        class: String,
        style: HashMap<String, String>,
        content: String,
    },
}

/// Data attached to interactive elements for tooltips.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ElementData {
    pub label: String,
    pub value: String,
    pub series: Option<String>,
    pub raw: HashMap<String, serde_json::Value>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ViewBox {
    pub x: f64,
    pub y: f64,
    pub width: f64,
    pub height: f64,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum Transform {
    Translate(f64, f64),
    Rotate(f64, f64, f64),
    Multiple(Vec<Transform>),
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum TextAnchor {
    Start,
    Middle,
    End,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Dimensions {
    pub width: Option<f64>,
    pub height: f64,
}

impl ViewBox {
    pub fn new(x: f64, y: f64, width: f64, height: f64) -> Self {
        Self { x, y, width, height }
    }

    /// Format as SVG viewBox attribute string: "x y width height"
    pub fn to_svg_string(&self) -> String {
        format!("{} {} {} {}", self.x, self.y, self.width, self.height)
    }
}

impl std::fmt::Display for ViewBox {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{} {} {} {}", self.x, self.y, self.width, self.height)
    }
}

impl Transform {
    /// Format as SVG transform attribute string.
    pub fn to_svg_string(&self) -> String {
        match self {
            Transform::Translate(x, y) => format!("translate({},{})", x, y),
            Transform::Rotate(angle, cx, cy) => format!("rotate({},{},{})", angle, cx, cy),
            Transform::Multiple(transforms) => {
                transforms.iter().map(|t| t.to_svg_string()).collect::<Vec<_>>().join(" ")
            }
        }
    }
}

impl std::fmt::Display for Transform {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.to_svg_string())
    }
}

impl std::fmt::Display for TextAnchor {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            TextAnchor::Start => write!(f, "start"),
            TextAnchor::Middle => write!(f, "middle"),
            TextAnchor::End => write!(f, "end"),
        }
    }
}

impl ElementData {
    pub fn new(label: impl Into<String>, value: impl Into<String>) -> Self {
        Self {
            label: label.into(),
            value: value.into(),
            series: None,
            raw: HashMap::new(),
        }
    }

    pub fn with_series(mut self, series: impl Into<String>) -> Self {
        self.series = Some(series.into());
        self
    }
}

impl Dimensions {
    pub fn new(height: f64) -> Self {
        Self { width: None, height }
    }

    pub fn with_width(mut self, width: f64) -> Self {
        self.width = Some(width);
        self
    }
}

/// Count elements in the tree matching a predicate.
pub fn count_elements<F>(element: &ChartElement, predicate: &F) -> usize
where
    F: Fn(&ChartElement) -> bool,
{
    let mut count = if predicate(element) { 1 } else { 0 };
    match element {
        ChartElement::Svg { children, .. }
        | ChartElement::Group { children, .. }
        | ChartElement::Div { children, .. } => {
            for child in children {
                count += count_elements(child, predicate);
            }
        }
        _ => {}
    }
    count
}

// =============================================================================
// TextStyle — role-based typography resolution from a Theme.
// =============================================================================
//
// Theme typography fields are wired into `ChartElement::Text` via `TextStyle`.
// Each text emission site picks a `TextRole` (axis-label / tick-value /
// legend-label), builds a `TextStyle` from the active theme, and plugs the
// resulting `Option<String>` fields into the `Text` literal.
//
// ## Backward-compatibility sentinels
//
// Phase 4 must preserve byte-identical SVG output for the `Theme::default()`
// case. The pre-existing emission uses hardcoded values that differ from
// `Theme::default()`'s typography fields (for example, the SVG serializer
// stamps `font-family="Inter, Liberation Sans, Arial, sans-serif"` on every
// `<text>` element regardless of what the `Text` element carries). The
// "legacy sentinel" for each attribute is the value that would otherwise be
// emitted today. `TextStyle` returns `None` for any attribute whose theme
// value equals its legacy sentinel, ensuring the attribute is omitted (for
// `font-family` / `letter-spacing` / `text-transform` / `font-weight`) or
// restated unchanged (for `font-size`).

/// Legacy hardcoded font-size string for axis labels and tick labels.
///
/// Companion constants for the other legacy typography values are not
/// exported because they have no code consumers: the legacy font-family
/// (`"Inter, Liberation Sans, Arial, sans-serif"`, owned by
/// `chartml-render/src/svg.rs`) and legacy font-style (`"normal"`) are
/// handled purely by the `Theme::default()` sentinel comparison in
/// `TextStyle::for_role`, not by explicit constants.
pub const LEGACY_LABEL_FONT_SIZE: &str = "12px";

/// Legacy hardcoded font-size string for legend labels. Note this differs
/// from `LEGACY_LABEL_FONT_SIZE` — the legend has historically used a
/// slightly smaller size (11px) while all other chrome uses 12px.
pub const LEGACY_LEGEND_FONT_SIZE: &str = "11px";

/// Legacy font-weight for all chrome text. `None` because no current
/// emission site sets `font-weight` at all — the attribute is absent from
/// every pre-Phase-4 baseline SVG.
pub const LEGACY_FONT_WEIGHT: u16 = 400;

/// Role of a text element, used to select the right bundle of typography
/// fields from the active `Theme`.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TextRole {
    /// Axis titles and category/axis tick labels. Reads `label_*` fields.
    AxisLabel,
    /// Numeric tick labels. Reads `numeric_*` for family/size; inherits
    /// `label_font_weight` / `label_letter_spacing` / `label_text_transform`.
    TickValue,
    /// Legend labels. Reads `legend_*` fields.
    LegendLabel,
}

/// Resolved typography for a single `ChartElement::Text` literal. All fields
/// are already prepared as `Option<String>` — plug them directly into the
/// `Text` enum variant.
#[derive(Debug, Clone)]
pub struct TextStyle {
    pub font_family: Option<String>,
    pub font_size: Option<String>,
    pub font_weight: Option<String>,
    pub letter_spacing: Option<String>,
    pub text_transform: Option<String>,
}

impl TextStyle {
    /// Build a `TextStyle` for the given role from a `Theme`.
    ///
    /// Returns `Some(...)` only for attributes whose theme value diverges
    /// from its legacy sentinel (see the module-level constants). This keeps
    /// byte-identical output whenever `Theme::default()` is in effect.
    pub fn for_role(theme: &crate::theme::Theme, role: TextRole) -> Self {
        use crate::theme::{TextTransform, Theme};

        let default_theme = Theme::default();

        let (family, default_family, size_px, default_size_px, legacy_size) = match role {
            TextRole::AxisLabel => (
                &theme.label_font_family,
                &default_theme.label_font_family,
                theme.label_font_size,
                default_theme.label_font_size,
                LEGACY_LABEL_FONT_SIZE,
            ),
            TextRole::TickValue => (
                &theme.numeric_font_family,
                &default_theme.numeric_font_family,
                theme.numeric_font_size,
                default_theme.numeric_font_size,
                LEGACY_LABEL_FONT_SIZE,
            ),
            TextRole::LegendLabel => (
                &theme.legend_font_family,
                &default_theme.legend_font_family,
                theme.legend_font_size,
                default_theme.legend_font_size,
                LEGACY_LEGEND_FONT_SIZE,
            ),
        };
        let weight = match role {
            TextRole::AxisLabel | TextRole::TickValue => theme.label_font_weight,
            TextRole::LegendLabel => theme.legend_font_weight,
        };

        // Axis-label, tick-value, and legend-label all inherit
        // `label_letter_spacing` / `label_text_transform` (no legend-specific
        // overrides per Phase 4 mapping).
        let letter_spacing = theme.label_letter_spacing;
        let text_transform = &theme.label_text_transform;

        // Emit `font-family` only when the user has overridden the theme
        // default. When the theme's family equals the default theme's family,
        // omit the attribute so the SVG serializer's legacy hardcoded
        // `Inter, Liberation Sans, Arial, sans-serif` path is preserved and
        // baseline output stays byte-identical.
        let font_family = if family == default_family {
            None
        } else {
            Some(family.clone())
        };

        // Font size: `font-size` is always emitted today. To preserve
        // byte-identical output for `Theme::default()`, when the theme's
        // size equals the default (i.e. the user hasn't overridden it),
        // emit the legacy hardcoded string — which differs from the default
        // for the legend role (11px vs. 12.0 default).
        let font_size = if (size_px - default_size_px).abs() < f32::EPSILON {
            Some(legacy_size.to_string())
        } else {
            Some(format!("{}px", format_px(size_px)))
        };

        let font_weight = if weight == LEGACY_FONT_WEIGHT {
            None
        } else {
            Some(weight.to_string())
        };

        // Exact-equals on f32 is safe here: the sentinel is the literal
        // `0.0_f32` produced by `Theme::default()`, never the result of
        // arithmetic. Same reasoning as the `size_px == default_size_px`
        // sentinel above.
        let letter_spacing = if letter_spacing == 0.0 {
            None
        } else {
            Some(format_px(letter_spacing))
        };

        let text_transform = match text_transform {
            TextTransform::None => None,
            TextTransform::Uppercase => Some("uppercase".to_string()),
            TextTransform::Lowercase => Some("lowercase".to_string()),
        };

        Self {
            font_family,
            font_size,
            font_weight,
            letter_spacing,
            text_transform,
        }
    }
}

// =============================================================================
// Dot halo helper (Phase 8) — outer ring behind dot markers.
// =============================================================================
//
// Every dot marker in ChartML (scatter points, line endpoint markers, combo
// dot markers) is a `ChartElement::Circle`. When `theme.dot_halo_color` is
// `Some`, a halo is emitted BEFORE the dot so it renders underneath. The
// halo is a stroke-based ring at the same radius as the dot, which means the
// stroke extends half-outside the dot — producing a crisp visible outline.
//
// The helper returns `None` when `theme.dot_halo_color` is `None`, which
// keeps byte-identical emission for the default theme (Phase 0 contract).
//
// The halo is emitted as a `ChartElement::Path` (not `Circle`) because
// `Circle` has no `stroke_width` field — `Path` supports `stroke_width`,
// `stroke`, and `fill` directly and renders the same visual result. The
// emitted class is `dot-halo`, which Phase 9 CSS can target regardless of
// underlying SVG tag.

/// Emit a halo element to render BEFORE a dot marker, or `None` when
/// `theme.dot_halo_color` is `None`. Uses `theme.dot_halo_width` as the
/// stroke width. The halo radius always matches the dot's own radius so the
/// ring hugs the dot — bubble charts pass the per-point radius here, not a
/// static theme default.
pub fn emit_dot_halo_if_enabled(
    theme: &crate::theme::Theme,
    cx: f64,
    cy: f64,
    r: f64,
) -> Option<ChartElement> {
    let color = theme.dot_halo_color.as_ref()?;
    // SVG circle-as-path: move to (cx-r, cy), arc 180° to (cx+r, cy), arc
    // 180° back. Two half-arcs form a full circle.
    let d = format!(
        "M {cx},{cy} m -{r},0 a {r},{r} 0 1,0 {d2},0 a {r},{r} 0 1,0 -{d2},0",
        cx = cx,
        cy = cy,
        r = r,
        d2 = 2.0 * r,
    );
    Some(ChartElement::Path {
        d,
        fill: None,
        stroke: Some(color.clone()),
        stroke_width: Some(theme.dot_halo_width as f64),
        stroke_dasharray: None,
        opacity: None,
        class: "dot-halo".to_string(),
        data: None,
        animation_origin: None,
    })
}

/// Format a pixel value, preferring an integer rendering when the value has
/// no fractional part. Mirrors the pre-Phase-4 emission of `"12px"`
/// (not `"12.0px"`), which every baseline snapshot asserts.
fn format_px(v: f32) -> String {
    if v.fract() == 0.0 {
        format!("{}", v as i64)
    } else {
        format!("{}", v)
    }
}

#[cfg(test)]
mod tests {
    #![allow(clippy::unwrap_used)]
    use super::*;

    #[test]
    fn viewbox_display() {
        let vb = ViewBox::new(0.0, 0.0, 800.0, 400.0);
        assert_eq!(vb.to_string(), "0 0 800 400");
    }

    #[test]
    fn transform_translate_display() {
        let t = Transform::Translate(10.0, 20.0);
        assert_eq!(t.to_string(), "translate(10,20)");
    }

    #[test]
    fn transform_rotate_display() {
        let t = Transform::Rotate(45.0, 100.0, 200.0);
        assert_eq!(t.to_string(), "rotate(45,100,200)");
    }

    #[test]
    fn transform_multiple_display() {
        let t = Transform::Multiple(vec![
            Transform::Translate(10.0, 20.0),
            Transform::Rotate(45.0, 0.0, 0.0),
        ]);
        assert_eq!(t.to_string(), "translate(10,20) rotate(45,0,0)");
    }

    #[test]
    fn text_anchor_display() {
        assert_eq!(TextAnchor::Start.to_string(), "start");
        assert_eq!(TextAnchor::Middle.to_string(), "middle");
        assert_eq!(TextAnchor::End.to_string(), "end");
    }

    #[test]
    fn element_data_builder() {
        let data = ElementData::new("Jan", "1234")
            .with_series("Revenue");
        assert_eq!(data.label, "Jan");
        assert_eq!(data.value, "1234");
        assert_eq!(data.series, Some("Revenue".to_string()));
    }

    #[test]
    fn count_rects_in_tree() {
        let tree = ChartElement::Svg {
            viewbox: ViewBox::new(0.0, 0.0, 800.0, 400.0),
            width: Some(800.0),
            height: Some(400.0),
            class: "chart".to_string(),
            children: vec![
                ChartElement::Group {
                    class: "bars".to_string(),
                    transform: None,
                    children: vec![
                        ChartElement::Rect {
                            x: 0.0, y: 0.0, width: 50.0, height: 100.0,
                            fill: "red".to_string(), stroke: None,
                            rx: None, ry: None,
                            class: "bar".to_string(), data: None,
                            animation_origin: None,
                        },
                        ChartElement::Rect {
                            x: 60.0, y: 0.0, width: 50.0, height: 150.0,
                            fill: "blue".to_string(), stroke: None,
                            rx: None, ry: None,
                            class: "bar".to_string(), data: None,
                            animation_origin: None,
                        },
                    ],
                },
                ChartElement::Text {
                    x: 400.0, y: 20.0, content: "Title".to_string(),
                    anchor: TextAnchor::Middle, dominant_baseline: None,
                    transform: None, font_family: None, font_size: None, font_weight: None,
                    letter_spacing: None, text_transform: None, fill: None,
                    class: "title".to_string(),
                    data: None,
                },
            ],
        };
        let rect_count = count_elements(&tree, &|e| matches!(e, ChartElement::Rect { .. }));
        assert_eq!(rect_count, 2);
    }

    #[test]
    fn dimensions_builder() {
        let dims = Dimensions::new(400.0).with_width(800.0);
        assert_eq!(dims.height, 400.0);
        assert_eq!(dims.width, Some(800.0));
    }

    #[test]
    fn serde_round_trip_chart_element_tree() {
        let tree = ChartElement::Svg {
            viewbox: ViewBox::new(0.0, 0.0, 800.0, 400.0),
            width: Some(800.0),
            height: Some(400.0),
            class: "chart".to_string(),
            children: vec![
                ChartElement::Group {
                    class: "bars".to_string(),
                    transform: Some(Transform::Translate(50.0, 10.0)),
                    children: vec![
                        ChartElement::Rect {
                            x: 0.0,
                            y: 0.0,
                            width: 50.0,
                            height: 100.0,
                            fill: "red".to_string(),
                            stroke: None,
                            rx: None,
                            ry: None,
                            class: "bar".to_string(),
                            data: Some(
                                ElementData::new("Jan", "1234").with_series("Revenue"),
                            ),
                            animation_origin: None,
                        },
                        ChartElement::Path {
                            d: "M0,0 L10,10".to_string(),
                            fill: None,
                            stroke: Some("blue".to_string()),
                            stroke_width: Some(2.0),
                            stroke_dasharray: Some("4,2".to_string()),
                            opacity: Some(0.8),
                            class: "line".to_string(),
                            data: None,
                            animation_origin: None,
                        },
                    ],
                },
                ChartElement::Line {
                    x1: 0.0,
                    y1: 0.0,
                    x2: 100.0,
                    y2: 100.0,
                    stroke: "black".to_string(),
                    stroke_width: Some(1.0),
                    stroke_dasharray: None,
                    class: "axis".to_string(),
                },
                ChartElement::Text {
                    x: 400.0,
                    y: 20.0,
                    content: "Title".to_string(),
                    anchor: TextAnchor::Middle,
                    dominant_baseline: Some("central".to_string()),
                    transform: Some(Transform::Rotate(45.0, 400.0, 20.0)),
                    font_family: None,
                    font_size: Some("14px".to_string()),
                    font_weight: Some("bold".to_string()),
                    letter_spacing: None,
                    text_transform: None,
                    fill: Some("black".to_string()),
                    class: "title".to_string(),
                    data: None,
                },
                ChartElement::Circle {
                    cx: 50.0,
                    cy: 50.0,
                    r: 5.0,
                    fill: "green".to_string(),
                    stroke: None,
                    class: "dot".to_string(),
                    data: None,
                },
                ChartElement::Div {
                    class: "metric-card".to_string(),
                    style: HashMap::from([
                        ("display".to_string(), "flex".to_string()),
                    ]),
                    children: vec![ChartElement::Span {
                        class: "value".to_string(),
                        style: HashMap::from([
                            ("font-size".to_string(), "24px".to_string()),
                        ]),
                        content: "$1,234".to_string(),
                    }],
                },
            ],
        };

        let json = serde_json::to_string(&tree).expect("serialize");
        let deserialized: ChartElement =
            serde_json::from_str(&json).expect("deserialize");

        // Re-serialize to confirm structural equality
        let json2 = serde_json::to_string(&deserialized).expect("re-serialize");
        assert_eq!(json, json2);

        // Verify the tag format is correct
        let value: serde_json::Value =
            serde_json::from_str(&json).expect("parse as Value");
        assert_eq!(value["type"], "svg");
        assert_eq!(value["children"][0]["type"], "group");
        assert_eq!(value["children"][0]["children"][1]["type"], "path");
        assert_eq!(
            value["children"][0]["children"][1]["strokeWidth"],
            serde_json::json!(2.0)
        );
        assert_eq!(
            value["children"][2]["dominantBaseline"],
            serde_json::json!("central")
        );
    }
}