gen_analyzer 0.1.1

syntax analyzer for genui
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

use std::fmt::Display;
use gen_utils::parser::trim;
use nom::{
    branch::alt, bytes::complete::{tag, take_while}, error::ErrorKind, IResult
};
use crate::nom_err;

#[derive(Debug, Clone)]
pub enum Comment {
    /// `//`
    Normal(String),
    /// `///`
    Document(String),
    /// `//!`
    File(String),
}

impl Comment {
    /// ## parse comment
    /// - //
    /// - ///
    /// - //!
    /// this method just can parse a comment and convert to CommentTypes
    pub fn parse(input: &str) -> IResult<&str, Self> {
        let (input, comment_type) = trim(alt((tag("//!"), tag("///"), tag("//"))))(input)?;
        let (input, comment) = take_while(|c: char| c != '\n')(input)?;
        match comment_type {
            "//" => Ok((input, Comment::Normal(comment.to_string()))),
            "///" => Ok((input, Comment::Document(comment.to_string()))),
            "//!" => Ok((input, Comment::File(comment.to_string()))),
            _ => Err(nom_err!(input, ErrorKind::Tag)),
        }
    }
}

impl Display for Comment {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Comment::Normal(c) => write!(f, "// {}", c),
            Comment::Document(c) => write!(f, "/// {}", c),
            Comment::File(c) => write!(f, "//! {}", c),
        }
    }
}
// /// # CommentPosition
// /// Although in code we can not limit the position of the comment, we should follow the rules:
// /// - `Comment::File` and `Comment::Document` should be above the code
// /// - `Comment::Normal` can be above or inline with the code
// #[derive(Debug, Clone, PartialEq, Default)]
// pub enum CommentPosition {
//     /// Above the code:
//     /// ```
//     /// // above comment
//     /// <label text="'hello'"></label>
//     /// ```
//     #[default]
//     Above,
//     /// Inline with the code:
//     /// ```
//     /// <label text="'hello'"></label> // inline comment
//     /// ```
//     Inline,
// }

#[cfg(test)]
mod test_comments {
    use super::Comment;

    #[test]
    fn display() {
        let c1 = Comment::Document("hello".to_string());
        let c2 = Comment::File("hello".to_string());
        let c3 = Comment::Normal("hello".to_string());

        assert_eq!(c1.to_string().as_str(), "/// hello");
        assert_eq!(c2.to_string().as_str(), "//! hello");
        assert_eq!(c3.to_string().as_str(), "// hello");
    }
}