nagisa-render 0.7.0

//! 文档模型(IR)—— 两个前端(标记解析 [`markup`](crate::parse_markup) / 构建器
//! [`Doc`](crate::Doc))的共同产物,也是版式引擎的唯一输入。块级 + 行内 + 可叠加的文字样式,
//! 全是普通数据,不含渲染状态。一般不直接构造,用构建器或标记文本得到。

use std::path::PathBuf;

/// 一份文档:从上到下排布的块序列。
#[derive(Clone, Debug, Default)]
pub struct Document {
    /// 块序列。
    pub blocks: Vec<Block>,
}

/// 块级元素。
#[derive(Clone, Debug)]
pub enum Block {
    /// 标题(h1–h6)。
    Heading {
        /// 级别,取 1..=6。
        level: u8,
        /// 行内内容。
        inlines: Vec<Inline>,
        /// 水平对齐。
        align: Align,
    },
    /// 段落。
    Paragraph {
        /// 行内内容。
        inlines: Vec<Inline>,
        /// 水平对齐。
        align: Align,
    },
    /// 有序 / 无序列表(项内容是块序列,可嵌套、可多段)。
    List(List),
    /// 引用块(裹块,可嵌套)。
    Quote(Vec<Block>),
    /// 代码块(等宽、带底色;按语言标签做轻量语法上色,认不出整块默认色)。
    Code {
        /// 语言标签;有则在代码盒右上角渲染成小标签,可缺。
        lang: Option<String>,
        /// 代码原文(保留换行)。
        text: String,
    },
    /// 分割线。
    Divider,
    /// 块级图片(可带宽度 / 对齐 / 图注)。
    Image(BlockImage),
    /// 多栏并排。
    Columns(Columns),
    /// 表格。
    Table(Table),
    /// 进度条。
    Progress(Progress),
    /// 面板(卡片容器:底色 / 边框 / 圆角 / 内边距 / 投影,内层是块容器)。
    Panel(Panel),
}

/// 面板:带装饰的块容器。作并排栏某栏唯一块时,装饰盒拉齐到本行最高栏(卡片排整齐)。
#[derive(Clone, Debug)]
pub struct Panel {
    /// 内容块。
    pub blocks: Vec<Block>,
    /// 装饰。
    pub decor: PanelDecor,
}

/// 面板装饰。`bg` 与 `border` 都缺省时按主题给「浅底 + 细边」的默认卡片样。
#[derive(Clone, Debug, Default)]
pub struct PanelDecor {
    /// 底色;`None` 且无边框时用主题代码底色。
    pub bg: Option<Color>,
    /// 边框;`None` 且无底色时用主题边框色细线。
    pub border: Option<ImageBorder>,
    /// 圆角半径(逻辑像素);`None` = 12。
    pub radius: Option<f32>,
    /// 内边距(逻辑像素);`None` = 0.6 倍基准字号。
    pub pad: Option<f32>,
    /// 投影。
    pub shadow: Option<Shadow>,
}

/// 表格。`cols` 给各列对齐与可选限宽(短于列数时,缺的列按默认:左对齐 + 自适应)。
#[derive(Clone, Debug)]
pub struct Table {
    /// 表头行;`None` = 无表头。
    pub header: Option<Vec<Cell>>,
    /// 数据行。
    pub rows: Vec<Vec<Cell>>,
    /// 各列规格(对齐 / 限宽)。
    pub cols: Vec<ColSpec>,
    /// 紧凑度与网格样式。
    pub style: TableStyle,
}

/// 表格的紧凑度与网格样式。
#[derive(Clone, Debug)]
pub struct TableStyle {
    /// 单元格左右内边距(逻辑像素);`None` = 默认。越小列越紧凑。
    pub pad_x: Option<f32>,
    /// 单元格上下内边距(逻辑像素);`None` = 默认。越小行越紧凑(行距越小)。
    pub pad_y: Option<f32>,
    /// 网格线开关。
    pub grid: TableGrid,
    /// 表头浅底,默认开。
    pub header_fill: bool,
    /// 拉伸铺满可用宽:列宽合计不足时把富余宽度按比例分给自适应列(全是固定列则整体
    /// 等比放大)。默认关——窄表保持自然宽。
    pub expand: bool,
    /// 整表水平对齐(窄于内容宽时生效;`expand` 开了自然铺满,无所谓对齐)。
    pub align: Align,
}

impl Default for TableStyle {
    fn default() -> Self {
        Self {
            pad_x: None,
            pad_y: None,
            grid: TableGrid::default(),
            header_fill: true,
            expand: false,
            align: Align::Left,
        }
    }
}

/// 网格线开关,默认全开。
#[derive(Clone, Copy, Debug)]
pub struct TableGrid {
    /// 外框线。
    pub outer: bool,
    /// 列竖线。
    pub vertical: bool,
    /// 行横线。
    pub horizontal: bool,
}

impl Default for TableGrid {
    fn default() -> Self {
        Self { outer: true, vertical: true, horizontal: true }
    }
}

/// 列规格:对齐 + 可选限宽。
#[derive(Clone, Debug)]
pub struct ColSpec {
    /// 该列对齐。
    pub align: Align,
    /// 限宽;`None` = 按内容自适应。
    pub width: Option<Length>,
}

impl Default for ColSpec {
    fn default() -> Self {
        Self { align: Align::Left, width: None }
    }
}

/// 单元格:行内内容(按列宽自动换行)+ 可选背景填色。
#[derive(Clone, Debug)]
pub struct Cell {
    /// 单元格的行内内容。
    pub inlines: Vec<Inline>,
    /// 背景填色;`None` = 无(随表)。
    pub bg: Option<Color>,
}

/// 多栏容器:各栏并排,行高取最高栏。
#[derive(Clone, Debug)]
pub struct Columns {
    /// 各栏。
    pub cols: Vec<Column>,
    /// 栏间距(逻辑像素);`None` = 主题默认。
    pub gap: Option<f32>,
}

/// 一栏:块内容 + 宽度权重(按权重瓜分可用宽,默认 1.0)。
#[derive(Clone, Debug)]
pub struct Column {
    /// 栏内容。
    pub blocks: Vec<Block>,
    /// 宽度权重。
    pub weight: f32,
}

/// 进度条:`value` 按比例填充,余下露出底槽。
#[derive(Clone, Debug)]
pub struct Progress {
    /// 进度值(0–1;越界与非有限值渲染时夹取)。
    pub value: f32,
    /// 条高(逻辑像素)。
    pub height: f32,
    /// 填充色;`None` = 主题强调色。
    pub fill: Option<Color>,
    /// 底槽色;`None` = 主题边框色。
    pub track: Option<Color>,
    /// 圆角半径(逻辑像素);`None` = 半高(胶囊形)。渲染时夹到半高以内。
    pub radius: Option<f32>,
    /// 条宽;`None` = 铺满内容宽。
    pub width: Option<Length>,
    /// 水平对齐(窄于内容宽时生效)。
    pub align: Align,
}

/// 列表。
#[derive(Clone, Debug)]
pub struct List {
    /// 有序 / 无序。
    pub kind: ListKind,
    /// 有序列表的起始序号(无序忽略)。
    pub start: u32,
    /// 列表项。
    pub items: Vec<ListItem>,
}

/// 列表种类。
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ListKind {
    /// 无序(项目符号)。
    Unordered,
    /// 有序(序号)。
    Ordered,
}

/// 列表项:内容是块序列,故支持多段与嵌套子列表。
#[derive(Clone, Debug)]
pub struct ListItem {
    /// 项内容。
    pub blocks: Vec<Block>,
    /// 任务复选标记:`None` = 普通项;`Some(已完成)` = 渲染成复选标记(`□` / `✓`),
    /// 对应标记文本的 `- [ ]` / `- [x]`。
    pub check: Option<bool>,
}

/// 块级图片。
#[derive(Clone, Debug)]
pub struct BlockImage {
    /// 图片来源。
    pub src: ImageSource,
    /// 显示宽度;`None` = 适配内容宽(不超出)。
    pub width: Option<Length>,
    /// 水平对齐。
    pub align: Align,
    /// 图注(排在图下方,居中小字);`None` = 无。
    pub caption: Option<Vec<Inline>>,
    /// 装饰层(角标/边框/水印/圆角/阴影);默认全无。
    pub decor: ImageDecor,
}

/// 图片装饰层 —— 叠在图面上的附加呈现,**不改变布局尺寸**(阴影溢出照画)。
#[derive(Clone, Debug, Default)]
pub struct ImageDecor {
    /// 角标:小标签贴在图的一角(如「动图」「GIF」)。
    pub badge: Option<Badge>,
    /// 边框:沿图片边缘描边(圆角时随圆角走)。
    pub border: Option<ImageBorder>,
    /// 水印:半透明文字叠在图面。
    pub watermark: Option<Watermark>,
    /// 圆角半径(逻辑像素,0 = 直角):裁切图面,边框/阴影随之。
    pub radius: f32,
    /// 投影;`None` = 无。
    pub shadow: Option<Shadow>,
}

/// 图面上的锚点位置(角标 / 水印的停靠处)。
#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
pub enum Anchor {
    /// 左上。
    TopLeft,
    /// 右上(角标默认)。
    #[default]
    TopRight,
    /// 左下。
    BottomLeft,
    /// 右下(水印默认)。
    BottomRight,
    /// 正中。
    Center,
}

/// 图片角标:圆角底板 + 短文字,贴在图的一角。
#[derive(Clone, Debug)]
pub struct Badge {
    /// 标签文字(宜短,如「动图」)。
    pub text: String,
    /// 停靠角。
    pub anchor: Anchor,
    /// 底板色(默认黑 72%)。
    pub bg: Color,
    /// 文字色(默认白)。
    pub fg: Color,
    /// 相对基准字号的倍率(默认 0.75)。
    pub size: f32,
}

impl Badge {
    /// 默认形态的角标(右上角、黑底白字)。
    pub fn new(text: impl Into<String>) -> Self {
        Self {
            text: text.into(),
            anchor: Anchor::TopRight,
            bg: Color::rgba(0, 0, 0, 184),
            fg: Color::rgb(255, 255, 255),
            size: 0.75,
        }
    }
}

/// 图片边框(沿图缘描边;有圆角时随圆角)。
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct ImageBorder {
    /// 线宽(逻辑像素)。
    pub width: f32,
    /// 颜色。
    pub color: Color,
}

/// 图片水印:无底板的半透明文字。
#[derive(Clone, Debug)]
pub struct Watermark {
    /// 水印文字。
    pub text: String,
    /// 停靠处。
    pub anchor: Anchor,
    /// 颜色(含 alpha;默认白 40%)。
    pub color: Color,
    /// 相对基准字号的倍率(默认 0.9)。
    pub size: f32,
}

impl Watermark {
    /// 默认形态的水印(右下角、白 40%)。
    pub fn new(text: impl Into<String>) -> Self {
        Self {
            text: text.into(),
            anchor: Anchor::BottomRight,
            color: Color::rgba(255, 255, 255, 102),
            size: 0.9,
        }
    }
}

/// 行内元素。
#[derive(Clone, Debug)]
pub enum Inline {
    /// 一段带样式的文字。
    Text {
        /// 文字。
        text: String,
        /// 样式。
        style: TextStyle,
    },
    /// 行内代码(等宽 + 浅底)。
    Code(String),
    /// 硬换行。
    LineBreak,
}

/// 可叠加的文字样式。span 嵌套时逐字段合并。
#[derive(Clone, Debug, PartialEq)]
pub struct TextStyle {
    /// 字重(CSS 习惯值:细 300 / 常规 400 / 粗 700,内置字体 100–900 都有真实例)。
    /// `None` = 跟随语境:正文常规,标题 / 表头加粗。
    pub weight: Option<u16>,
    /// 斜体。
    pub italic: bool,
    /// 下划线。
    pub underline: bool,
    /// 删除线。
    pub strike: bool,
    /// 文字色;`None` = 用主题文字色。
    pub color: Option<Color>,
    /// 高亮底色;`None` = 无高亮。
    pub highlight: Option<Highlight>,
    /// 相对基准字号的倍率(默认 1.0)。
    pub size: f32,
    /// 字族角色。
    pub font: FontRole,
    /// 链接文字(标记文本 `[文字](URL)` 的产物):无显式 `color` 时按主题强调色渲染。
    /// 图片不可点,URL 本身不展示。
    pub link: bool,
    /// 文字阴影;`None` = 无。
    pub shadow: Option<Shadow>,
    /// 圈注:以这段文字为中心画一圈椭圆描边(醒目标注,如圈出日历上的某天;不参与
    /// 布局尺寸,圈溢出到行距里)。
    pub ring: Option<RingMark>,
    /// 着重点:这段文字正下方一枚实心小点(中文「着重号」式标注;画进行距,不占高度)。
    pub dot: Option<DotMark>,
    /// 边注:这段文字挂到本行内容的外侧(左或右),**参与绘制、不参与布局**——行宽与
    /// 居中 / 对齐都按其余内容算,边注不挤不偏(与圈注 / 着重点同一哲学)。适合
    /// 「当前」「✓」这类行尾行首标记。多行段落里右边注跟末行、左边注跟首行;整段
    /// 只有边注没有正文时按普通内容排(边注失去锚点)。
    pub aside: Option<AsideSide>,
}

/// 边注的停靠侧。
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum AsideSide {
    /// 行首左外侧。
    Left,
    /// 行尾右外侧。
    Right,
}

/// 圈注参数。半径给定后圈的大小与文字宽窄无关——日历里「1」和「10」能圈出同样大的圈。
#[derive(Clone, Copy, Debug, Default, PartialEq)]
pub struct RingMark {
    /// 描边颜色;`None` = 跟随文字墨色。
    pub color: Option<Color>,
    /// 横向半径(逻辑像素);`None` = 按文字宽自适应。
    pub rx: Option<f32>,
    /// 纵向半径(逻辑像素);`None` 且 `rx` 有值 = 取 `rx`(正圆),都缺 = 按字高自适应。
    pub ry: Option<f32>,
    /// 线宽(逻辑像素);`None` = 0.07 倍字号。
    pub width: Option<f32>,
    /// 逐字圈:整段一字一圈(空白跳过),全自适应时缺省**正圆**;`false` = 整段一个圈
    /// (范围圈,自适应为扁椭圆)。
    pub each: bool,
}

/// 着重点参数。
#[derive(Clone, Copy, Debug, Default, PartialEq)]
pub struct DotMark {
    /// 点色;`None` = 跟随文字墨色。
    pub color: Option<Color>,
    /// 点半径(逻辑像素);`None` = 0.09 倍字号。
    pub radius: Option<f32>,
    /// 逐字点:一字一点(中文着重号的正字法;空白跳过);`false` = 整段中线下一点。
    pub each: bool,
}

impl Default for TextStyle {
    fn default() -> Self {
        Self {
            weight: None,
            italic: false,
            underline: false,
            strike: false,
            color: None,
            highlight: None,
            size: 1.0,
            font: FontRole::Sans,
            link: false,
            shadow: None,
            ring: None,
            dot: None,
            aside: None,
        }
    }
}

/// 阴影(文字与图片共用):偏移 + 软化半径 + 颜色,尺寸皆**逻辑像素**。
/// 不参与布局(不撑大占位),溢出块界照画。
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct Shadow {
    /// 水平偏移(右正)。
    pub dx: f32,
    /// 垂直偏移(下正)。
    pub dy: f32,
    /// 软化半径(0 = 实边)。
    pub blur: f32,
    /// 颜色(含 alpha,通常用半透明)。
    pub color: Color,
}

impl Default for Shadow {
    fn default() -> Self {
        // 默认一枚朴素下坠软影。
        Self { dx: 0.0, dy: 2.0, blur: 6.0, color: Color::rgba(0, 0, 0, 64) }
    }
}

/// 高亮底色来源。
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Highlight {
    /// 跟随主题默认高亮色(随亮 / 暗变)。
    Theme,
    /// 指定具体色。
    Custom(Color),
}

/// 字族角色。`Named` 直接按字族名匹配,匹配不到回退 Sans。
#[derive(Clone, Debug, PartialEq)]
pub enum FontRole {
    /// 无衬线(默认正文)。
    Sans,
    /// 衬线。
    Serif,
    /// 等宽。
    Mono,
    /// 楷体。
    Kai,
    /// 指定字族名。
    Named(String),
}

/// 水平对齐。
#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
pub enum Align {
    /// 左对齐(默认)。
    #[default]
    Left,
    /// 居中。
    Center,
    /// 右对齐。
    Right,
    /// 两端对齐。
    Justify,
}

/// RGBA 颜色(每通道 8 位,非预乘)。
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct Color {
    /// 红。
    pub r: u8,
    /// 绿。
    pub g: u8,
    /// 蓝。
    pub b: u8,
    /// 不透明度(255 = 不透明)。
    pub a: u8,
}

impl Color {
    /// 不透明色。
    pub const fn rgb(r: u8, g: u8, b: u8) -> Self {
        Self { r, g, b, a: 255 }
    }

    /// 带 alpha 的色。
    pub const fn rgba(r: u8, g: u8, b: u8, a: u8) -> Self {
        Self { r, g, b, a }
    }

    /// 解析十六进制色:`#rgb` / `#rrggbb` / `#rrggbbaa`(井号可省,大小写不限)。
    /// 非法返回 `None`。`#rgb` 每位扩成两位(`f` → `ff`)。
    pub fn hex(s: &str) -> Option<Self> {
        let h = s.strip_prefix('#').unwrap_or(s);
        if !h.bytes().all(|b| b.is_ascii_hexdigit()) {
            return None;
        }
        let n = |slice: &str| u8::from_str_radix(slice, 16).ok();
        match h.len() {
            3 => {
                let b = h.as_bytes();
                let dup = |c: u8| {
                    let d = (c as char).to_digit(16)? as u8;
                    Some(d << 4 | d)
                };
                Some(Self::rgb(dup(b[0])?, dup(b[1])?, dup(b[2])?))
            }
            6 => Some(Self::rgb(n(&h[0..2])?, n(&h[2..4])?, n(&h[4..6])?)),
            8 => Some(Self::rgba(n(&h[0..2])?, n(&h[2..4])?, n(&h[4..6])?, n(&h[6..8])?)),
            _ => None,
        }
    }
}

/// 长度:绝对像素,或相对内容宽的百分比。
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum Length {
    /// 绝对逻辑像素。
    Px(f32),
    /// 内容宽的百分比(0–100)。
    Percent(f32),
}

/// 图片来源。引擎不联网:URL 由调用方下好,以 `Bytes` 传入。
#[derive(Clone, Debug)]
pub enum ImageSource {
    /// 已加载的图片字节。
    Bytes(Vec<u8>),
    /// 磁盘路径,渲染时读取。
    Path(PathBuf),
    /// 具名引用(标记文本里的 `@名字`),渲染时从 [`RenderOptions::images`](crate::RenderOptions::images) 取字节。
    Named(String),
}