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

nagisa_render/
model.rs
