liemermaid 0.3.1

Mermaid diagram parser + renderer (SVG / vello_cpu PNG), unified through lievisual Scene IR.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
// `serde` 是可选依赖(`default` feature 开启):关闭时必须能编译,
// 故导入与全部派生都按 feature 门控(见各处的 `cfg_attr`)。
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum Diagram {
    Flowchart(Flowchart),
    Sequence(SequenceDiagram),
    Class(ClassDiagram),
    State(StateDiagram),
    Er(ErDiagram),
    Pie(PieDiagram),
    Timeline(TimelineDiagram),
    GitGraph(GitGraphDiagram),
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Flowchart {
    pub direction: Option<Direction>,
    pub nodes: Vec<Node>,
    pub edges: Vec<Edge>,
    pub subgraphs: Vec<Subgraph>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum Direction {
    TB,
    TD,
    BT,
    RL,
    LR,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Node {
    pub id: String,
    pub shape: Option<NodeShape>,
    pub text: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum NodeShape {
    Rectangle,
    Rounded,
    Stadium,
    Subroutine,
    Diamond,
    Hexagon,
    Circle,
    DoubleCircle,
    Cylinder,
    Asymmetric,
    Parallelogram,
    ParallelogramAlt,
    Trapezoid,
    TrapezoidAlt,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Edge {
    pub source: String,
    pub target: String,
    pub arrow_type: ArrowType,
    pub label: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum ArrowType {
    Solid,
    Dotted,
    Thick,
    /// 无箭头(`---`)
    NoArrow,
    /// 双向箭头(`<-->`)
    Both,
    /// 终点圆点(`--o`)
    Circle,
    /// 终点叉号(`--x`)
    Cross,
    /// 不可见边(`~~~`)
    Invisible,
    /// 双向圆点箭头(`o--o`)
    MultiCircle,
    /// 双向叉号箭头(`x--x`)
    MultiCross,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Subgraph {
    pub title: Option<String>,
    /// 子图内 `direction` 声明(如 `subgraph One\ndirection LR`)。
    ///
    /// 保留在 AST 中供后续布局使用;当前布局仍按整图方向排布。
    #[cfg_attr(feature = "serde", serde(default))]
    pub direction: Option<Direction>,
    /// 直接属于本子图的节点(不含嵌套子图成员)。
    pub nodes: Vec<Node>,
    /// 直接属于本子图的边(不含嵌套子图内部的边)。
    pub edges: Vec<Edge>,
    /// 嵌套子图(保留层级,供容器嵌套绘制)。
    #[cfg_attr(feature = "serde", serde(default))]
    pub subgraphs: Vec<Subgraph>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct SequenceDiagram {
    pub participants: Vec<Participant>,
    /// 顶层语句(消息、备注、分组块)按输入顺序排列
    pub statements: Vec<SequenceStatement>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum SequenceStatement {
    Message(Message),
    Note(Note),
    Block(SequenceBlock),
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum SequenceBlockKind {
    Loop,
    Alt,
    Opt,
    Par,
    /// `critical ... option ... end`(mermaid v10.7+)
    Critical,
    /// `break ... end`:跳出 enclosing loop
    Break,
    /// `rect rgb(...) ... end`:底色分组块
    Rect,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct SequenceBlock {
    pub kind: SequenceBlockKind,
    pub label: Option<String>,
    /// 分支段:首段是块头分支(`alt cond1` 之后的语句,条件存于 [`Self::label`]),
    /// 后续每段对应一个 `else` / `and` / `option` 分隔出的分支。
    /// 单分支块(loop / opt / break / rect)恒为 1 段。
    pub branches: Vec<SequenceBranch>,
}

/// 时序图分组块的一个分支段(`alt` 的 else 段 / `par` 的 and 段 / `critical` 的 option 段)。
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct SequenceBranch {
    /// 分支条件文本(`else condition two` 的 `condition two`;首分支为 `None`)。
    pub label: Option<String>,
    /// 分支内的语句(消息、备注、嵌套块)
    pub items: Vec<SequenceItem>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum SequenceItem {
    Message(Message),
    Note(Note),
    Block(SequenceBlock),
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Participant {
    pub name: String,
    pub alias: Option<String>,
    pub kind: ParticipantKind,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum ParticipantKind {
    Participant,
    Actor,
    Boundary,
    Control,
    Entity,
    Database,
    Collections,
    Queue,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum MessageActivation {
    Activate,
    Deactivate,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Message {
    pub from: String,
    pub to: String,
    pub arrow: MessageArrow,
    /// 箭头后的激活/取消激活快捷符号(`->>+B` 激活,`-->>-A` 取消)
    pub activation: Option<MessageActivation>,
    pub text: Option<String>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum MessageArrow {
    Solid,
    SolidTip,
    Dashed,
    DashedTip,
    Cross,
    Open,
    /// 双向箭头(`<<->>` / `<<-->>`)
    Both,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Note {
    pub placement: NotePlacement,
    pub targets: Vec<String>,
    pub text: String,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum NotePlacement {
    LeftOf,
    RightOf,
    Over,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct ClassDiagram {
    pub classes: Vec<Class>,
    pub relations: Vec<Relation>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Class {
    pub name: String,
    /// 泛型参数(mermaid `~T~` 语法),如 `T`
    pub generic: Option<String>,
    /// 注解/构造型,如 `<<Interface>>`
    pub annotation: Option<String>,
    pub members: Vec<ClassMember>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct ClassMember {
    pub visibility: Option<Visibility>,
    pub name: String,
    pub type_: Option<String>,
    pub is_method: bool,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum Visibility {
    Public,
    Private,
    Protected,
    Package,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Relation {
    pub source: String,
    pub target: String,
    pub kind: RelationKind,
    /// 源端基数(`"1"`),可选
    pub cardinality_first: Option<String>,
    /// 目标端基数(`"many"`),可选
    pub cardinality_second: Option<String>,
    pub label: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum RelationKind {
    Inheritance,
    Composition,
    Aggregation,
    Association,
    Dependency,
    /// 实现(`..|>` / `<|..`)
    Realization,
    /// 实线连接(`--`)
    Link,
    /// 虚线连接(`..`)
    Dashed,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct StateDiagram {
    #[cfg_attr(feature = "serde", serde(default))]
    pub states: Vec<State>,
    #[cfg_attr(feature = "serde", serde(default))]
    pub transitions: Vec<Transition>,
    /// 语句在源码中的**交错顺序**(`states` / `transitions` 的下标序列)。
    ///
    /// mermaid 的状态库按源码顺序建节点:若某个 id **先被转移引用**、之后才出现
    /// `state X <<fork>>` 声明,则它已经是一个普通状态,类型声明不会覆盖它
    /// (官方 `state__fork_join` 中 `fork_state` 画成横条、`join_state` 却是带标签的
    /// 普通状态框,原因就在于后者先被 `State2 --> join_state` 引用)。
    /// extract 据此决定是否把 `<<fork>>`/`<<join>>` 降级为普通状态。
    #[cfg_attr(feature = "serde", serde(default))]
    pub order: Vec<StateStmt>,
}

/// [`StateDiagram::order`] 的一项:指向 `states` 或 `transitions` 的下标。
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum StateStmt {
    /// 状态声明(`states[i]`)。
    Decl(usize),
    /// 转移(`transitions[i]`)。
    Trans(usize),
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum State {
    Simple {
        id: String,
        description: Option<String>,
    },
    Composite {
        id: String,
        inner: Box<StateDiagram>,
    },
    Fork {
        id: String,
    },
    Join {
        id: String,
    },
    Start,
    End,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Transition {
    pub from: String,
    pub to: String,
    pub label: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct ErDiagram {
    pub entities: Vec<ErEntity>,
    pub relationships: Vec<ErRelationship>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct ErEntity {
    pub name: String,
    pub attributes: Vec<ErAttribute>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct ErAttribute {
    pub type_: String,
    pub name: String,
    /// 可选约束标记(如 PK / FK / UK / NN)。
    pub constraint: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct ErRelationship {
    pub first_entity: String,
    pub second_entity: String,
    pub cardinality_first: Cardinality,
    pub cardinality_second: Cardinality,
    pub label: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum Cardinality {
    ZeroOrOne,
    ExactlyOne,
    ZeroOrMany,
    OneOrMany,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct PieDiagram {
    pub title: Option<String>,
    pub show_data: bool,
    pub data: Vec<PieData>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct PieData {
    pub label: String,
    pub value: String,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct TimelineDiagram {
    pub title: Option<String>,
    /// 方向:`LR`(默认)或 `TD`
    pub direction: Option<TimelineDirection>,
    pub sections: Vec<TimelineSection>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum TimelineDirection {
    LR,
    TD,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct TimelineSection {
    pub name: String,
    pub events: Vec<String>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct GitGraphDiagram {
    pub statements: Vec<GitGraphStatement>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum GitGraphStatement {
    Commit {
        id: Option<String>,
        commit_type: Option<String>,
        tag: Option<String>,
    },
    Branch {
        name: String,
    },
    Checkout {
        branch: String,
    },
    Merge {
        branch: String,
        id: Option<String>,
        tag: Option<String>,
        commit_type: Option<String>,
    },
    CherryPick {
        id: Option<String>,
        parent: Option<String>,
    },
}