idf-parser 0.1.2

A parser for the IDF (Intermediate Data Format) used for interchange of PCB design data.
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

use nom::bytes::complete::{is_not, tag};
use nom::{Parser, character::complete::multispace0, sequence::delimited};

/// A combinator that takes a parser `inner` and produces a parser that also consumes both leading and
/// trailing whitespace, returning the output of `inner`.
pub fn ws<'a, Output, Function>(
    inner: Function,
) -> impl Parser<&'a str, Output = Output, Error = nom::error::Error<&'a str>>
where
    Function: Parser<&'a str, Output = Output, Error = nom::error::Error<&'a str>>,
{
    delimited(multispace0, inner, multispace0)
}

/// Takes in a tuple of parsers with different return types
/// and returns a tuple of parsers each wrapped with `ws`.
///
/// # Example
/// ```
/// use nom::character::complete::u32;
/// use nom::number::complete::float;
/// use nom::Parser;
/// use idf_parser::ws_separated;
/// use idf_parser::primitives::ws;
///
/// let input = "0 100.0 200.0 45.0";
///
/// let (remaining, (label, x, y, angle)) = ws_separated!((u32, float, float, float)).parse(input).unwrap();
/// ```
#[macro_export]
macro_rules! ws_separated {
    (($($parser:expr),+)) => {
        ($(ws($parser)),+)
    };
}

/// Section parser
///
/// Takes a section delimited by `.section` and `.end_section` and applies the given parser to the
/// content of the section.
///
/// # Example
///
/// ```
/// use idf_parser::primitives::ws;
/// use idf_parser::parse_section;
/// use nom::Parser;
/// use nom::sequence::delimited;
/// use nom::bytes::complete::tag;
///
/// let input = ".SECTION
/// howdy!
/// .END_SECTION";
///
/// let (remaining, point) = parse_section!("SECTION", tag("howdy!")).parse(input).unwrap();
/// ```
#[macro_export]
macro_rules! parse_section {
    ($section:expr, $parser:expr) => {
        delimited(
            ws(tag(format!(".{}", $section).as_str())),
            $parser,
            ws(tag(format!(".END_{}", $section).as_str())),
        )
    };
}

/// Parses a quoted string from the input string.
///
/// # Example
///
/// ```
/// use idf_parser::primitives::quote_string;
///
/// let input = "\"Hello, World!\"";
///
/// let (remaining, quoted_str) = quote_string(input).unwrap();
///  assert_eq!(quoted_str, "Hello, World!");
/// ```
pub fn quote_string(input: &str) -> nom::IResult<&str, &str> {
    delimited(tag("\""), is_not("\""), tag("\"")).parse(input)
}
#[cfg(test)]
mod tests {
    use super::*;
    use crate::primitives::ws;
    use nom::Parser;
    use nom::bytes::complete::tag;
    use nom::character::complete::u32;
    use nom::number::complete::float;

    #[test]
    fn test_ws() {
        let input = "\r0 \n\n\n100.0   200.0 \n45.0  ";
        let (remaining, (label, x, y, angle)) = (ws(u32), ws(float), ws(float), ws(float))
            .parse(input)
            .unwrap();
        assert_eq!(remaining, "");
        assert_eq!(label, 0);
        assert_eq!(x, 100.0);
        assert_eq!(y, 200.0);
        assert_eq!(angle, 45.0);
    }

    #[test]
    fn test_ws_separated() {
        let input = "0 100.0 200.0 45.0";
        let (remaining, (label, x, y, angle)) = ws_separated!((u32, float, float, float))
            .parse(input)
            .unwrap();
        assert_eq!(remaining, "");
        assert_eq!(label, 0);
        assert_eq!(x, 100.0);
        assert_eq!(y, 200.0);
        assert_eq!(angle, 45.0);
    }

    #[test]
    fn test_section() {
        let input = ".SECTION\n123 456\n.END_SECTION";
        let (remaining, ints) = parse_section!("SECTION", (ws(u32), ws(u32)))
            .parse(input)
            .unwrap();
        assert_eq!(remaining, "");
        assert_eq!(ints, (123, 456));
    }

    #[test]
    fn test_quote_string() {
        let input = "\"Hello, World!\"";
        let (remaining, quoted_str) = quote_string(input).unwrap();
        assert_eq!(remaining, "");
        assert_eq!(quoted_str, "Hello, World!");
    }
}