vdf-reader 0.3.3

Rust parser for valve vdf files.
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

use logos::Logos;
use parse_display::Display;
use std::str;

/// Parser token.
#[derive(PartialEq, Debug, Logos, Display, Clone)]
#[logos(skip r"[ \t\f\r\n]+")] // whitespace
#[logos(skip r"//[^\n]*")] // comments
pub enum Token {
    /// A group is starting.
    #[token("{")]
    #[display("start of group")]
    GroupStart,
    /// A group is ending.
    #[token("}")]
    #[display("end of group")]
    GroupEnd,
    /// An enclosed or bare item.
    #[regex("[^# \t\n{}\"][^ \t\n\r{}]*", priority = 0)]
    #[display("item")]
    Item,
    /// An enclosed or bare item.
    #[regex("\"([^\"\\\\]|\\\\.)*\"")]
    #[display("quoted item")]
    QuotedItem,
    /// An enclosed or bare statement.
    #[regex("#[^ \"\t\n\r{}]+")]
    #[display("statement")]
    Statement,
    /// An enclosed or bare statement.
    #[regex("\"#([^\"\\\\]|\\\\.)*\"")]
    #[display("quoted statement")]
    QuotedStatement,
}

#[cfg(test)]
mod tests {
    use super::Token;
    use logos::Logos;

    fn get_token<'input>(
        input: &'input str,
    ) -> Option<Result<Token, <Token as Logos<'input>>::Error>> {
        let mut lex = Token::lexer(input);
        lex.next()
    }

    fn get_tokens<'input>(
        input: &str,
    ) -> Result<Vec<(Token, &str)>, <Token as Logos<'input>>::Error> {
        Token::lexer(input)
            .spanned()
            .map(|(res, span)| res.map(|token| (token, &input[span])))
            .collect()
    }

    #[test]
    fn next() {
        assert_eq!(get_token("test"), Some(Ok(Token::Item)));
        assert_eq!(get_token("\"test\""), Some(Ok(Token::QuotedItem)));
        assert_eq!(get_token("\"\""), Some(Ok(Token::QuotedItem)));
        assert_eq!(get_token("\"\" "), Some(Ok(Token::QuotedItem)));
        assert_eq!(get_token("#test"), Some(Ok(Token::Statement)));
        assert_eq!(get_token("\"#test\""), Some(Ok(Token::QuotedStatement)));
        assert_eq!(get_token("{"), Some(Ok(Token::GroupStart)));
        assert_eq!(get_token("}"), Some(Ok(Token::GroupEnd)));
        assert_eq!(get_token("//test more"), None);

        assert_eq!(get_token("test"), Some(Ok(Token::Item)));
        assert_eq!(get_token("#test"), Some(Ok(Token::Statement)));

        assert_eq!(get_token("lol wut"), Some(Ok(Token::Item)));
        assert_eq!(get_token("#lol wut"), Some(Ok(Token::Statement)));

        assert_eq!(get_token("lol{"), Some(Ok(Token::Item)));
        assert_eq!(get_token("#lol{"), Some(Ok(Token::Statement)));

        assert_eq!(get_token("lol}"), Some(Ok(Token::Item)));
        assert_eq!(get_token("#lol}"), Some(Ok(Token::Statement)));

        assert_eq!(get_token("\"test\""), Some(Ok(Token::QuotedItem)));
        assert_eq!(get_token("\"#test\""), Some(Ok(Token::QuotedStatement)));

        assert_eq!(get_token("\"te\\\"st\""), Some(Ok(Token::QuotedItem)));
        assert_eq!(get_token("\"te\\st\""), Some(Ok(Token::QuotedItem)));
        assert_eq!(get_token("\"#te\\\"st\""), Some(Ok(Token::QuotedStatement)));
    }

    #[test]
    fn tokenize() {
        assert_eq!(
            get_tokens(
                r#"foo { // eol comment
                "asd" "bar"
                // a comment
                #include other
                empty ""
                \\"broken" comment
            }"#
            ),
            Ok(vec![
                (Token::Item, "foo"),
                (Token::GroupStart, "{"),
                (Token::QuotedItem, r#""asd""#),
                (Token::QuotedItem, r#""bar""#),
                (Token::Statement, r#"#include"#),
                (Token::Item, r#"other"#),
                (Token::Item, r#"empty"#),
                (Token::QuotedItem, r#""""#),
                (Token::Item, r#"\\"broken""#),
                (Token::Item, r#"comment"#),
                (Token::GroupEnd, "}")
            ])
        )
    }
}