limu 0.1.0

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

//! Flowcharts, as Pele's src/diagrams/flowchart reads them: a lexer and a parser that agree
//! with Mermaid's flow.jison, the FlowDb they fill, and the graph that is drawn of it.

mod db;
mod graph;
mod lexer;
mod parser;
mod render;
mod shapes;
mod tokens;

#[cfg(test)]
mod tests;

pub(crate) use db::FlowDb;
#[cfg(test)]
pub(crate) use graph::build_flow_graph;
pub(crate) use graph::{FlowGraph, GraphNode};
pub(crate) use render::{Roles, Variant, layout, layout_variant};
// An agent flow takes its shapes from a flowchart's.
#[cfg(feature = "agentflow")]
pub(crate) use shapes::{canonical_shape, is_valid_shape};

use db::FlowDbOptions;
use parser::parse_flowchart;

use crate::errors::Error;
use crate::value::{Map, Value};

/// The flowchart section of a configuration, or none where it is no object.
fn flowchart_config(config: &Map) -> Option<&Map> {
    config.get("flowchart").and_then(Value::as_object)
}

/// Parses a flowchart's text, as Pele's flowchart.parse does. title is the one its front
/// matter gives.
pub(crate) fn parse(
    source: &str,
    config: &Map,
    title: Option<&str>,
    max_edges: Option<usize>,
) -> Result<FlowDb, Error> {
    let inherit_dir =
        flowchart_config(config).and_then(|f| f.get("inheritDir")) == Some(&Value::Bool(true));
    let mut db = FlowDb::new(FlowDbOptions {
        max_edges,
        inherit_dir,
    });
    if let Some(title) = title.filter(|t| !t.is_empty()) {
        db.title = Some(title.to_string());
    }
    parse_flowchart(source, &mut db)?;
    Ok(db)
}

/// The curve a flowchart's configuration gives its edges, where it is a string, as Pele's
/// renderFlowchart reads it.
#[cfg(test)]
pub(crate) fn default_curve(config: &Map) -> Option<&str> {
    flowchart_config(config)
        .and_then(|f| f.get("curve"))
        .and_then(Value::as_str)
}