device-driver-parser 2.0.0

Internal compiler crate for the device-driver toolkit
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

use std::path::Path;

use chumsky::Parser;
use device_driver_diagnostics::{DynError, ResultExt};

use crate::{InputType, RichExtra};

pub fn gen_docs(output_path: &Path) -> Result<(), DynError> {
    // railroad

    gen_railroad(&output_path.join("node.svg"), super::node())
        .with_message(|| "generating node railroad diagram")?;
    gen_railroad(&output_path.join("range.svg"), super::range())
        .with_message(|| "generating range railroad diagram")?;
    gen_railroad(&output_path.join("byte-array.svg"), super::byte_array())
        .with_message(|| "generating byte-array railroad diagram")?;
    gen_railroad(
        &output_path.join("simple-expression.svg"),
        super::simple_expression(),
    )
    .with_message(|| "generating nodsimple-expressione railroad diagram")?;
    gen_railroad(&output_path.join("repeat.svg"), super::repeat())
        .with_message(|| "generating repeat railroad diagram")?;
    gen_railroad(
        &output_path.join("property.svg"),
        super::property(super::node()),
    )
    .with_message(|| "generating property railroad diagram")?;
    gen_railroad(
        &output_path.join("type-specifier.svg"),
        super::type_specifier(super::node()),
    )
    .with_message(|| "generating type-specifier railroad diagram")?;
    gen_railroad(
        &output_path.join("node-body.svg"),
        super::node_body(super::node()),
    )
    .with_message(|| "generating node-body railroad diagram")?;

    // ebnf

    gen_ebnf(&output_path.join("node.ebnf"), super::node())
        .with_message(|| "generating node railroad diagram")?;
    gen_ebnf(&output_path.join("range.ebnf"), super::range())
        .with_message(|| "generating range railroad diagram")?;
    gen_ebnf(&output_path.join("byte-array.ebnf"), super::byte_array())
        .with_message(|| "generating byte-array railroad diagram")?;
    gen_ebnf(
        &output_path.join("simple-expression.ebnf"),
        super::simple_expression(),
    )
    .with_message(|| "generating simple-expression railroad diagram")?;
    gen_ebnf(&output_path.join("repeat.ebnf"), super::repeat())
        .with_message(|| "generating repeat railroad diagram")?;
    gen_ebnf(
        &output_path.join("property.ebnf"),
        super::property(super::node()),
    )
    .with_message(|| "generating property railroad diagram")?;
    gen_ebnf(
        &output_path.join("type-specifier.ebnf"),
        super::type_specifier(super::node()),
    )
    .with_message(|| "generating type-specifier railroad diagram")?;
    gen_ebnf(
        &output_path.join("node-body.ebnf"),
        super::node_body(super::node()),
    )
    .with_message(|| "generating node-body railroad diagram")?;

    Ok(())
}

fn gen_railroad<'src: 'tokens, 'tokens, O>(
    output_path: &Path,
    parser: impl Parser<'tokens, InputType<'tokens, 'src>, O, RichExtra<'tokens, 'src>>,
) -> Result<(), DynError> {
    std::fs::write(output_path, parser.debug().to_railroad_svg().to_string())
        .with_message(|| format!("writing diagram to {}", output_path.display()))?;

    Ok(())
}

fn gen_ebnf<'src: 'tokens, 'tokens, O>(
    output_path: &Path,
    parser: impl Parser<'tokens, InputType<'tokens, 'src>, O, RichExtra<'tokens, 'src>>,
) -> Result<(), DynError> {
    std::fs::write(output_path, parser.debug().to_ebnf())
        .with_message(|| format!("writing diagram to {}", output_path.display()))?;

    Ok(())
}