mmdflux 2.1.0

Render Mermaid diagrams as Unicode text, ASCII, SVG, and MMDS JSON.
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

//! Sequence diagram AST types.
//!
//! These represent the raw parsed syntax before validation/compilation
//! into the `Sequence` model used by the layout engine.
pub use crate::timeline::sequence::model::{
    ArrowHead, BlockDividerKind, BlockKind, LineStyle, NotePlacement, ParticipantKind,
};

/// Activation modifier from `+`/`-` shorthand on message arrows.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ActivationModifier {
    /// `+` on arrow: activate the target participant.
    Activate,
    /// `-` on arrow: deactivate the target participant.
    Deactivate,
}

/// Autonumber control statement.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum AutonumberMode {
    /// Enable autonumbering, optionally overriding the next value and step.
    On {
        start: Option<usize>,
        step: Option<usize>,
    },
    /// Disable autonumbering while preserving the next value.
    Off,
}

/// A parsed sequence diagram statement.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum SequenceStatement {
    /// `participant A` or `participant A as Alice`.
    Participant {
        kind: ParticipantKind,
        id: String,
        alias: Option<String>,
    },
    /// `create participant A` or `create actor A as Alice`.
    CreateParticipant {
        kind: ParticipantKind,
        id: String,
        alias: Option<String>,
    },
    /// `box [color] [label]`.
    ParticipantBoxStart {
        color: Option<String>,
        label: Option<String>,
    },
    /// End of a participant box section.
    ParticipantBoxEnd,
    /// A message between participants (e.g., `A->>B: hello`).
    Message {
        from: String,
        to: String,
        line_style: LineStyle,
        arrow_head: ArrowHead,
        text: String,
        /// Optional activation modifier from `+`/`-` shorthand.
        activate: Option<ActivationModifier>,
    },
    /// `Note over A: text`, `Note left of A: text`, `Note right of A: text`,
    /// or `Note over A,B: text` (spanning).
    Note {
        placement: NotePlacement,
        participants: Vec<String>,
        text: String,
    },
    /// `activate <participant>`.
    Activate { participant: String },
    /// `deactivate <participant>`.
    Deactivate { participant: String },
    /// `destroy <participant>`.
    DestroyParticipant { participant: String },
    /// `loop label`, `alt label`, `opt label`.
    BlockStart { kind: BlockKind, label: String },
    /// `else label`.
    BlockDivider {
        kind: BlockDividerKind,
        label: String,
    },
    /// `end`.
    BlockEnd,
    /// `autonumber`.
    Autonumber(AutonumberMode),
    /// `title <text>`.
    Title(String),
}