limu 0.1.1

A diagram layout engine. It reads Mermaid and leaves the drawing to your program.
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

//! What a timeline's parser fills, as Pele's TimelineDb in db.ts has it: its sections, and
//! its time periods with their events.

use crate::detect::DiagramType;
use crate::errors::{Error, ErrorCode};
use crate::js::chars::{drop_indents, trim_start};

/// A time period and its events, Pele's TimelinePeriod.
#[derive(Clone, Debug, Default, PartialEq)]
pub(crate) struct TimelinePeriod {
    pub(crate) text: String,
    pub(crate) events: Vec<String>,
    /// The name of the section in force when the period was declared, "" before the first
    /// one.
    pub(crate) section: String,
    /// The index into the sections of that section, -1 before the first one.
    pub(crate) section_index: isize,
}

/// A timeline as its parser fills it, Pele's TimelineDb. Its direction is "LR" or "TD".
#[derive(Clone, Debug)]
pub(crate) struct TimelineDb {
    pub(crate) title: Option<String>,
    pub(crate) acc_title: Option<String>,
    pub(crate) acc_descr: Option<String>,
    pub(crate) direction: &'static str,
    pub(crate) sections: Vec<String>,
    pub(crate) periods: Vec<TimelinePeriod>,

    current_section: String,
}

impl Default for TimelineDb {
    fn default() -> Self {
        TimelineDb {
            title: None,
            acc_title: None,
            acc_descr: None,
            direction: "LR",
            sections: Vec::new(),
            periods: Vec::new(),
            current_section: String::new(),
        }
    }
}

impl TimelineDb {
    /// An empty db, of the title its front matter gives.
    pub(crate) fn new(title: Option<&str>) -> TimelineDb {
        TimelineDb {
            title: title.map(str::to_string),
            ..TimelineDb::default()
        }
    }

    pub(crate) fn set_diagram_title(&mut self, text: &str) {
        self.title = Some(text.to_string());
    }

    pub(crate) fn set_acc_title(&mut self, text: &str) {
        self.acc_title = Some(trim_start(text).to_string());
    }

    pub(crate) fn set_acc_description(&mut self, text: &str) {
        self.acc_descr = Some(drop_indents(text));
    }

    pub(crate) fn set_direction(&mut self, direction: &'static str) {
        self.direction = direction;
    }

    pub(crate) fn add_section(&mut self, text: &str) {
        self.current_section = text.to_string();
        self.sections.push(text.to_string());
    }

    pub(crate) fn add_task(&mut self, period: &str, event: &str) {
        self.periods.push(TimelinePeriod {
            text: period.to_string(),
            events: if event.is_empty() {
                Vec::new()
            } else {
                vec![event.to_string()]
            },
            section: self.current_section.clone(),
            section_index: self.sections.len() as isize - 1,
        });
    }

    pub(crate) fn add_event(&mut self, event: &str) -> Result<(), Error> {
        let Some(period) = self.periods.last_mut() else {
            // Mermaid fails here too, with a TypeError.
            let mut e = Error::new(
                "An event needs a time period before it.",
                ErrorCode::Semantic,
            );
            e.diagram = Some(DiagramType::Timeline);
            return Err(e);
        };
        period.events.push(event.to_string());
        Ok(())
    }
}