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

use crate::config::ConfigOption;
use crate::linter::{check_regex, SyntaxRule, SyntaxRuleResult};
use regex::Regex;
use sv_parser::{unwrap_node, NodeEvent, RefNode, SyntaxTree};

#[derive(Default)]
pub struct ReForbiddenAssert {
    re: Option<Regex>,
    under_statement: Option<SyntaxRuleResult>,
}

impl SyntaxRule for ReForbiddenAssert {
    fn check(
        &mut self,
        syntax_tree: &SyntaxTree,
        event: &NodeEvent,
        option: &ConfigOption,
    ) -> SyntaxRuleResult {
        if self.re.is_none() {
            self.re = Some(Regex::new(&option.re_forbidden_assert).unwrap());
        }

        let node = match event {
            NodeEvent::Enter(x) => {
                match x {
                    RefNode::Statement(x) => {
                        self.under_statement =
                            if let (Some(_id), _, _) = &x.nodes {
                                Some(check_regex(false, unwrap_node!(*x, BlockIdentifier),
                                                 &syntax_tree, &self.re.as_ref().unwrap()))
                            } else {
                                None // No check on anonymous statements.
                            };
                    }
                    _ => ()
                }
                x
            }
            NodeEvent::Leave(x) => {
                match x {
                    RefNode::Statement(_) => {
                        self.under_statement = None;
                    }
                    _ => ()
                }
                return SyntaxRuleResult::Pass;
            }
        };

        match node {
            RefNode::DeferredImmediateAssertionItem(x) => {
                if let (Some(_id), _) = &x.nodes {
                    check_regex(false, unwrap_node!(*x, BlockIdentifier),
                                &syntax_tree, &self.re.as_ref().unwrap())
                } else {
                    SyntaxRuleResult::Pass // No check on anonymous immediate assertions.
                }
            }
            RefNode::SimpleImmediateAssertStatement(_) |
            RefNode::DeferredImmediateAssertStatement(_) => {
                match self.under_statement {
                    Some(r) => r,
                    None => SyntaxRuleResult::Pass,
                }
            }
            _ => SyntaxRuleResult::Pass,
        }
    }

    fn name(&self) -> String {
        String::from("re_forbidden_assert")
    }

    fn hint(&self, option: &ConfigOption) -> String {
        String::from(format!(
            "Use an immediate assertion identifier not matching regex `{}`.",
            &option.re_forbidden_assert
        ))
    }

    fn reason(&self) -> String {
        String::from("Identifiers must conform to the naming scheme.")
    }
}