scarf-parser 0.1.1

A helper crate of scarf for parsing a SystemVerilog source file
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

// =======================================================================
// utils.rs
// =======================================================================
// Helper functions for implementing parsers

use crate::*;
use scarf_syntax::*;
use winnow::Parser;
#[cfg(feature = "parse_lossless")]
use winnow::combinator::alt;
use winnow::error::ModalResult;
#[cfg(feature = "parse_lossless")]
use winnow::token::any;

// A parser for matching extra nodes
#[cfg(feature = "parse_lossless")]
pub fn non_trivia_parser<'s>(
    input: &mut Tokens<'s>,
) -> ModalResult<Vec<NonTriviaToken<'s>>, VerboseError<'s>> {
    let comment_parser = any.verify_map(|s: &'s SpannedToken<'s>| match s.0 {
        Token::OnelineComment(text) => {
            Some(NonTriviaToken::OnelineComment(text, s.1.clone()))
        }
        Token::BlockComment(text) => {
            Some(NonTriviaToken::BlockComment(text, s.1.clone()))
        }
        _ => None,
    });
    let newline_parser = any.verify_map(|s: &'s SpannedToken<'s>| match s.0 {
        Token::Newline => Some(NonTriviaToken::Newline),
        _ => None,
    });
    repeat_note(alt((comment_parser, newline_parser))).parse_next(input)
}

#[inline]
#[cfg(not(feature = "parse_lossless"))]
pub fn non_trivia_parser<'s>(
    _: &mut Tokens<'s>,
) -> ModalResult<Vec<NonTriviaToken<'s>>, VerboseError<'s>> {
    Ok(vec![])
}

// A mapping function for replacing extra nodes in metadata
#[cfg(feature = "parse_lossless")]
pub fn replace_non_trivia<'a>(
    old_metadata: Metadata<'a>,
    non_trivia: Vec<NonTriviaToken<'a>>,
) -> Metadata<'a> {
    Metadata::new(old_metadata.span, non_trivia)
}

// A mapping function for replacing extra nodes in metadata
#[inline]
#[cfg(not(feature = "parse_lossless"))]
pub fn replace_non_trivia<'a>(
    old_metadata: Metadata<'a>,
    _: Vec<NonTriviaToken<'a>>,
) -> Metadata<'a> {
    old_metadata
}

// A parser for matching a token and extra nodes, producing metadata
#[cfg(feature = "parse_lossless")]
pub fn token<'s>(
    token_to_match: Token<'s>,
) -> impl FnMut(&mut Tokens<'s>) -> ModalResult<Metadata<'s>, VerboseError<'s>>
{
    move |input: &mut Tokens<'s>| {
        (token_to_match, non_trivia_parser)
            .context(token_to_match)
            .parse_next(input)
            .map(|(spanned_token, extra_nodes)| {
                Metadata::new(spanned_token.1.clone(), extra_nodes)
            })
    }
}

#[cfg(not(feature = "parse_lossless"))]
pub fn token<'s>(
    token_to_match: Token<'s>,
) -> impl FnMut(&mut Tokens<'s>) -> ModalResult<Metadata<'s>, VerboseError<'s>>
{
    move |input: &mut Tokens<'s>| {
        token_to_match
            .context(token_to_match)
            .map(|spanned_token| Metadata::new(spanned_token.1.clone(), vec![]))
            .parse_next(input)
    }
}