nagisa_render/
model.rs

1//! 文档模型(IR)—— 两个前端(标记解析 [`markup`](crate::parse_markup) / 构建器
2//! [`Doc`](crate::Doc))的共同产物,也是版式引擎的唯一输入。块级 + 行内 + 可叠加的文字样式,
3//! 全是普通数据,不含渲染状态。一般不直接构造,用构建器或标记文本得到。
4
5use std::path::PathBuf;
6
7/// 一份文档:从上到下排布的块序列。
8#[derive(Clone, Debug, Default)]
9pub struct Document {
10    /// 块序列。
11    pub blocks: Vec<Block>,
12}
13
14/// 块级元素。
15#[derive(Clone, Debug)]
16pub enum Block {
17    /// 标题(h1–h6)。
18    Heading {
19        /// 级别,取 1..=6。
20        level: u8,
21        /// 行内内容。
22        inlines: Vec<Inline>,
23        /// 水平对齐。
24        align: Align,
25    },
26    /// 段落。
27    Paragraph {
28        /// 行内内容。
29        inlines: Vec<Inline>,
30        /// 水平对齐。
31        align: Align,
32    },
33    /// 有序 / 无序列表(项内容是块序列,可嵌套、可多段)。
34    List(List),
35    /// 引用块(裹块,可嵌套)。
36    Quote(Vec<Block>),
37    /// 代码块(等宽、带底色;不做语法高亮)。
38    Code {
39        /// 语言标签;有则在代码盒右上角渲染成小标签,可缺。
40        lang: Option<String>,
41        /// 代码原文(保留换行)。
42        text: String,
43    },
44    /// 分割线。
45    Divider,
46    /// 块级图片(可带宽度 / 对齐 / 图注)。
47    Image(BlockImage),
48    /// 多栏并排。
49    Columns(Columns),
50    /// 表格。
51    Table(Table),
52    /// 进度条。
53    Progress(Progress),
54    /// 面板(卡片容器:底色 / 边框 / 圆角 / 内边距 / 投影,内层是块容器)。
55    Panel(Panel),
56}
57
58/// 面板:带装饰的块容器。作并排栏某栏唯一块时,装饰盒拉齐到本行最高栏(卡片排整齐)。
59#[derive(Clone, Debug)]
60pub struct Panel {
61    /// 内容块。
62    pub blocks: Vec<Block>,
63    /// 装饰。
64    pub decor: PanelDecor,
65}
66
67/// 面板装饰。`bg` 与 `border` 都缺省时按主题给「浅底 + 细边」的默认卡片样。
68#[derive(Clone, Debug, Default)]
69pub struct PanelDecor {
70    /// 底色;`None` 且无边框时用主题代码底色。
71    pub bg: Option<Color>,
72    /// 边框;`None` 且无底色时用主题边框色细线。
73    pub border: Option<ImageBorder>,
74    /// 圆角半径(逻辑像素);`None` = 12。
75    pub radius: Option<f32>,
76    /// 内边距(逻辑像素);`None` = 0.6 倍基准字号。
77    pub pad: Option<f32>,
78    /// 投影。
79    pub shadow: Option<Shadow>,
80}
81
82/// 表格。`cols` 给各列对齐与可选限宽(短于列数时,缺的列按默认:左对齐 + 自适应)。
83#[derive(Clone, Debug)]
84pub struct Table {
85    /// 表头行;`None` = 无表头。
86    pub header: Option<Vec<Cell>>,
87    /// 数据行。
88    pub rows: Vec<Vec<Cell>>,
89    /// 各列规格(对齐 / 限宽)。
90    pub cols: Vec<ColSpec>,
91    /// 紧凑度与网格样式。
92    pub style: TableStyle,
93}
94
95/// 表格的紧凑度与网格样式。
96#[derive(Clone, Debug)]
97pub struct TableStyle {
98    /// 单元格左右内边距(逻辑像素);`None` = 默认。越小列越紧凑。
99    pub pad_x: Option<f32>,
100    /// 单元格上下内边距(逻辑像素);`None` = 默认。越小行越紧凑(行距越小)。
101    pub pad_y: Option<f32>,
102    /// 网格线开关。
103    pub grid: TableGrid,
104    /// 表头浅底,默认开。
105    pub header_fill: bool,
106    /// 拉伸铺满可用宽:列宽合计不足时把富余宽度按比例分给自适应列(全是固定列则整体
107    /// 等比放大)。默认关——窄表保持自然宽。
108    pub expand: bool,
109}
110
111impl Default for TableStyle {
112    fn default() -> Self {
113        Self { pad_x: None, pad_y: None, grid: TableGrid::default(), header_fill: true, expand: false }
114    }
115}
116
117/// 网格线开关,默认全开。
118#[derive(Clone, Copy, Debug)]
119pub struct TableGrid {
120    /// 外框线。
121    pub outer: bool,
122    /// 列竖线。
123    pub vertical: bool,
124    /// 行横线。
125    pub horizontal: bool,
126}
127
128impl Default for TableGrid {
129    fn default() -> Self {
130        Self { outer: true, vertical: true, horizontal: true }
131    }
132}
133
134/// 列规格:对齐 + 可选限宽。
135#[derive(Clone, Debug)]
136pub struct ColSpec {
137    /// 该列对齐。
138    pub align: Align,
139    /// 限宽;`None` = 按内容自适应。
140    pub width: Option<Length>,
141}
142
143impl Default for ColSpec {
144    fn default() -> Self {
145        Self { align: Align::Left, width: None }
146    }
147}
148
149/// 单元格:行内内容(按列宽自动换行)+ 可选背景填色。
150#[derive(Clone, Debug)]
151pub struct Cell {
152    /// 单元格的行内内容。
153    pub inlines: Vec<Inline>,
154    /// 背景填色;`None` = 无(随表)。
155    pub bg: Option<Color>,
156}
157
158/// 多栏容器:各栏并排,行高取最高栏。
159#[derive(Clone, Debug)]
160pub struct Columns {
161    /// 各栏。
162    pub cols: Vec<Column>,
163    /// 栏间距(逻辑像素);`None` = 主题默认。
164    pub gap: Option<f32>,
165}
166
167/// 一栏:块内容 + 宽度权重(按权重瓜分可用宽,默认 1.0)。
168#[derive(Clone, Debug)]
169pub struct Column {
170    /// 栏内容。
171    pub blocks: Vec<Block>,
172    /// 宽度权重。
173    pub weight: f32,
174}
175
176/// 进度条:`value` 按比例填充,余下露出底槽。
177#[derive(Clone, Debug)]
178pub struct Progress {
179    /// 进度值(0–1;越界与非有限值渲染时夹取)。
180    pub value: f32,
181    /// 条高(逻辑像素)。
182    pub height: f32,
183    /// 填充色;`None` = 主题强调色。
184    pub fill: Option<Color>,
185    /// 底槽色;`None` = 主题边框色。
186    pub track: Option<Color>,
187    /// 圆角半径(逻辑像素);`None` = 半高(胶囊形)。渲染时夹到半高以内。
188    pub radius: Option<f32>,
189    /// 条宽;`None` = 铺满内容宽。
190    pub width: Option<Length>,
191    /// 水平对齐(窄于内容宽时生效)。
192    pub align: Align,
193}
194
195/// 列表。
196#[derive(Clone, Debug)]
197pub struct List {
198    /// 有序 / 无序。
199    pub kind: ListKind,
200    /// 有序列表的起始序号(无序忽略)。
201    pub start: u32,
202    /// 列表项。
203    pub items: Vec<ListItem>,
204}
205
206/// 列表种类。
207#[derive(Clone, Copy, Debug, PartialEq, Eq)]
208pub enum ListKind {
209    /// 无序(项目符号)。
210    Unordered,
211    /// 有序(序号)。
212    Ordered,
213}
214
215/// 列表项:内容是块序列,故支持多段与嵌套子列表。
216#[derive(Clone, Debug)]
217pub struct ListItem {
218    /// 项内容。
219    pub blocks: Vec<Block>,
220    /// 任务复选标记:`None` = 普通项;`Some(已完成)` = 渲染成复选标记(`□` / `✓`),
221    /// 对应标记文本的 `- [ ]` / `- [x]`。
222    pub check: Option<bool>,
223}
224
225/// 块级图片。
226#[derive(Clone, Debug)]
227pub struct BlockImage {
228    /// 图片来源。
229    pub src: ImageSource,
230    /// 显示宽度;`None` = 适配内容宽(不超出)。
231    pub width: Option<Length>,
232    /// 水平对齐。
233    pub align: Align,
234    /// 图注(排在图下方,居中小字);`None` = 无。
235    pub caption: Option<Vec<Inline>>,
236    /// 装饰层(角标/边框/水印/圆角/阴影);默认全无。
237    pub decor: ImageDecor,
238}
239
240/// 图片装饰层 —— 叠在图面上的附加呈现,**不改变布局尺寸**(阴影溢出照画)。
241#[derive(Clone, Debug, Default)]
242pub struct ImageDecor {
243    /// 角标:小标签贴在图的一角(如「动图」「GIF」)。
244    pub badge: Option<Badge>,
245    /// 边框:沿图片边缘描边(圆角时随圆角走)。
246    pub border: Option<ImageBorder>,
247    /// 水印:半透明文字叠在图面。
248    pub watermark: Option<Watermark>,
249    /// 圆角半径(逻辑像素,0 = 直角):裁切图面,边框/阴影随之。
250    pub radius: f32,
251    /// 投影;`None` = 无。
252    pub shadow: Option<Shadow>,
253}
254
255/// 图面上的锚点位置(角标 / 水印的停靠处)。
256#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
257pub enum Anchor {
258    /// 左上。
259    TopLeft,
260    /// 右上(角标默认)。
261    #[default]
262    TopRight,
263    /// 左下。
264    BottomLeft,
265    /// 右下(水印默认)。
266    BottomRight,
267    /// 正中。
268    Center,
269}
270
271/// 图片角标:圆角底板 + 短文字,贴在图的一角。
272#[derive(Clone, Debug)]
273pub struct Badge {
274    /// 标签文字(宜短,如「动图」)。
275    pub text: String,
276    /// 停靠角。
277    pub anchor: Anchor,
278    /// 底板色(默认黑 72%)。
279    pub bg: Color,
280    /// 文字色(默认白)。
281    pub fg: Color,
282    /// 相对基准字号的倍率(默认 0.75)。
283    pub size: f32,
284}
285
286impl Badge {
287    /// 默认形态的角标(右上角、黑底白字)。
288    pub fn new(text: impl Into<String>) -> Self {
289        Self {
290            text: text.into(),
291            anchor: Anchor::TopRight,
292            bg: Color::rgba(0, 0, 0, 184),
293            fg: Color::rgb(255, 255, 255),
294            size: 0.75,
295        }
296    }
297}
298
299/// 图片边框(沿图缘描边;有圆角时随圆角)。
300#[derive(Clone, Copy, Debug, PartialEq)]
301pub struct ImageBorder {
302    /// 线宽(逻辑像素)。
303    pub width: f32,
304    /// 颜色。
305    pub color: Color,
306}
307
308/// 图片水印:无底板的半透明文字。
309#[derive(Clone, Debug)]
310pub struct Watermark {
311    /// 水印文字。
312    pub text: String,
313    /// 停靠处。
314    pub anchor: Anchor,
315    /// 颜色(含 alpha;默认白 40%)。
316    pub color: Color,
317    /// 相对基准字号的倍率(默认 0.9)。
318    pub size: f32,
319}
320
321impl Watermark {
322    /// 默认形态的水印(右下角、白 40%)。
323    pub fn new(text: impl Into<String>) -> Self {
324        Self {
325            text: text.into(),
326            anchor: Anchor::BottomRight,
327            color: Color::rgba(255, 255, 255, 102),
328            size: 0.9,
329        }
330    }
331}
332
333/// 行内元素。
334#[derive(Clone, Debug)]
335pub enum Inline {
336    /// 一段带样式的文字。
337    Text {
338        /// 文字。
339        text: String,
340        /// 样式。
341        style: TextStyle,
342    },
343    /// 行内代码(等宽 + 浅底)。
344    Code(String),
345    /// 硬换行。
346    LineBreak,
347}
348
349/// 可叠加的文字样式。span 嵌套时逐字段合并。
350#[derive(Clone, Debug, PartialEq)]
351pub struct TextStyle {
352    /// 字重(CSS 习惯值:细 300 / 常规 400 / 粗 700,内置字体 100–900 都有真实例)。
353    /// `None` = 跟随语境:正文常规,标题 / 表头加粗。
354    pub weight: Option<u16>,
355    /// 斜体。
356    pub italic: bool,
357    /// 下划线。
358    pub underline: bool,
359    /// 删除线。
360    pub strike: bool,
361    /// 文字色;`None` = 用主题文字色。
362    pub color: Option<Color>,
363    /// 高亮底色;`None` = 无高亮。
364    pub highlight: Option<Highlight>,
365    /// 相对基准字号的倍率(默认 1.0)。
366    pub size: f32,
367    /// 字族角色。
368    pub font: FontRole,
369    /// 链接文字(标记文本 `[文字](URL)` 的产物):无显式 `color` 时按主题强调色渲染。
370    /// 图片不可点,URL 本身不展示。
371    pub link: bool,
372    /// 文字阴影;`None` = 无。
373    pub shadow: Option<Shadow>,
374    /// 圈注:以这段文字为中心画一圈椭圆描边(醒目标注,如圈出日历上的某天;不参与
375    /// 布局尺寸,圈溢出到行距里)。
376    pub ring: Option<RingMark>,
377    /// 着重点:这段文字正下方一枚实心小点(中文「着重号」式标注;画进行距,不占高度)。
378    pub dot: Option<DotMark>,
379    /// 边注:这段文字挂到本行内容的外侧(左或右),**参与绘制、不参与布局**——行宽与
380    /// 居中 / 对齐都按其余内容算,边注不挤不偏(与圈注 / 着重点同一哲学)。适合
381    /// 「当前」「✓」这类行尾行首标记。多行段落里右边注跟末行、左边注跟首行;整段
382    /// 只有边注没有正文时按普通内容排(边注失去锚点)。
383    pub aside: Option<AsideSide>,
384}
385
386/// 边注的停靠侧。
387#[derive(Clone, Copy, Debug, PartialEq, Eq)]
388pub enum AsideSide {
389    /// 行首左外侧。
390    Left,
391    /// 行尾右外侧。
392    Right,
393}
394
395/// 圈注参数。半径给定后圈的大小与文字宽窄无关——日历里「1」和「10」能圈出同样大的圈。
396#[derive(Clone, Copy, Debug, Default, PartialEq)]
397pub struct RingMark {
398    /// 描边颜色;`None` = 跟随文字墨色。
399    pub color: Option<Color>,
400    /// 横向半径(逻辑像素);`None` = 按文字宽自适应。
401    pub rx: Option<f32>,
402    /// 纵向半径(逻辑像素);`None` 且 `rx` 有值 = 取 `rx`(正圆),都缺 = 按字高自适应。
403    pub ry: Option<f32>,
404    /// 线宽(逻辑像素);`None` = 0.07 倍字号。
405    pub width: Option<f32>,
406    /// 逐字圈:整段一字一圈(空白跳过),全自适应时缺省**正圆**;`false` = 整段一个圈
407    /// (范围圈,自适应为扁椭圆)。
408    pub each: bool,
409}
410
411/// 着重点参数。
412#[derive(Clone, Copy, Debug, Default, PartialEq)]
413pub struct DotMark {
414    /// 点色;`None` = 跟随文字墨色。
415    pub color: Option<Color>,
416    /// 点半径(逻辑像素);`None` = 0.09 倍字号。
417    pub radius: Option<f32>,
418    /// 逐字点:一字一点(中文着重号的正字法;空白跳过);`false` = 整段中线下一点。
419    pub each: bool,
420}
421
422impl Default for TextStyle {
423    fn default() -> Self {
424        Self {
425            weight: None,
426            italic: false,
427            underline: false,
428            strike: false,
429            color: None,
430            highlight: None,
431            size: 1.0,
432            font: FontRole::Sans,
433            link: false,
434            shadow: None,
435            ring: None,
436            dot: None,
437            aside: None,
438        }
439    }
440}
441
442/// 阴影(文字与图片共用):偏移 + 软化半径 + 颜色,尺寸皆**逻辑像素**。
443/// 不参与布局(不撑大占位),溢出块界照画。
444#[derive(Clone, Copy, Debug, PartialEq)]
445pub struct Shadow {
446    /// 水平偏移(右正)。
447    pub dx: f32,
448    /// 垂直偏移(下正)。
449    pub dy: f32,
450    /// 软化半径(0 = 实边)。
451    pub blur: f32,
452    /// 颜色(含 alpha,通常用半透明)。
453    pub color: Color,
454}
455
456impl Default for Shadow {
457    fn default() -> Self {
458        // 默认一枚朴素下坠软影。
459        Self { dx: 0.0, dy: 2.0, blur: 6.0, color: Color::rgba(0, 0, 0, 64) }
460    }
461}
462
463/// 高亮底色来源。
464#[derive(Clone, Copy, Debug, PartialEq, Eq)]
465pub enum Highlight {
466    /// 跟随主题默认高亮色(随亮 / 暗变)。
467    Theme,
468    /// 指定具体色。
469    Custom(Color),
470}
471
472/// 字族角色。`Named` 直接按字族名匹配,匹配不到回退 Sans。
473#[derive(Clone, Debug, PartialEq)]
474pub enum FontRole {
475    /// 无衬线(默认正文)。
476    Sans,
477    /// 衬线。
478    Serif,
479    /// 等宽。
480    Mono,
481    /// 楷体。
482    Kai,
483    /// 指定字族名。
484    Named(String),
485}
486
487/// 水平对齐。
488#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
489pub enum Align {
490    /// 左对齐(默认)。
491    #[default]
492    Left,
493    /// 居中。
494    Center,
495    /// 右对齐。
496    Right,
497    /// 两端对齐。
498    Justify,
499}
500
501/// RGBA 颜色(每通道 8 位,非预乘)。
502#[derive(Clone, Copy, Debug, PartialEq, Eq)]
503pub struct Color {
504    /// 红。
505    pub r: u8,
506    /// 绿。
507    pub g: u8,
508    /// 蓝。
509    pub b: u8,
510    /// 不透明度(255 = 不透明)。
511    pub a: u8,
512}
513
514impl Color {
515    /// 不透明色。
516    pub const fn rgb(r: u8, g: u8, b: u8) -> Self {
517        Self { r, g, b, a: 255 }
518    }
519
520    /// 带 alpha 的色。
521    pub const fn rgba(r: u8, g: u8, b: u8, a: u8) -> Self {
522        Self { r, g, b, a }
523    }
524
525    /// 解析十六进制色:`#rgb` / `#rrggbb` / `#rrggbbaa`(井号可省,大小写不限)。
526    /// 非法返回 `None`。`#rgb` 每位扩成两位(`f` → `ff`)。
527    pub fn hex(s: &str) -> Option<Self> {
528        let h = s.strip_prefix('#').unwrap_or(s);
529        if !h.bytes().all(|b| b.is_ascii_hexdigit()) {
530            return None;
531        }
532        let n = |slice: &str| u8::from_str_radix(slice, 16).ok();
533        match h.len() {
534            3 => {
535                let b = h.as_bytes();
536                let dup = |c: u8| {
537                    let d = (c as char).to_digit(16)? as u8;
538                    Some(d << 4 | d)
539                };
540                Some(Self::rgb(dup(b[0])?, dup(b[1])?, dup(b[2])?))
541            }
542            6 => Some(Self::rgb(n(&h[0..2])?, n(&h[2..4])?, n(&h[4..6])?)),
543            8 => Some(Self::rgba(n(&h[0..2])?, n(&h[2..4])?, n(&h[4..6])?, n(&h[6..8])?)),
544            _ => None,
545        }
546    }
547}
548
549/// 长度:绝对像素,或相对内容宽的百分比。
550#[derive(Clone, Copy, Debug, PartialEq)]
551pub enum Length {
552    /// 绝对逻辑像素。
553    Px(f32),
554    /// 内容宽的百分比(0–100)。
555    Percent(f32),
556}
557
558/// 图片来源。引擎不联网:URL 由调用方下好,以 `Bytes` 传入。
559#[derive(Clone, Debug)]
560pub enum ImageSource {
561    /// 已加载的图片字节。
562    Bytes(Vec<u8>),
563    /// 磁盘路径,渲染时读取。
564    Path(PathBuf),
565    /// 具名引用(标记文本里的 `@名字`),渲染时从 [`RenderOptions::images`](crate::RenderOptions::images) 取字节。
566    Named(String),
567}
nagisa_render/model.rs

nagisa_render/
model.rs
