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

use crate::config::ConfigOption;
use crate::linter::{SyntaxRule, SyntaxRuleResult};
use sv_parser::{NodeEvent, PackageItem, RefNode, SyntaxTree};

#[derive(Default)]
pub struct PackageItemNotUnderPackage {
    under_package_declaration: bool,
}

impl SyntaxRule for PackageItemNotUnderPackage {
    fn check(
        &mut self,
        _syntax_tree: &SyntaxTree,
        event: &NodeEvent,
        _option: &ConfigOption,
    ) -> SyntaxRuleResult {
        let node = match event {
            NodeEvent::Enter(x) => {
                match x {
                    RefNode::PackageDeclaration(_) => {
                        self.under_package_declaration = true;
                    }
                    _ => ()
                }
                x
            }
            NodeEvent::Leave(x) => {
                match x {
                    RefNode::PackageDeclaration(_) => {
                        self.under_package_declaration = false;
                    }
                    _ => ()
                }
                return SyntaxRuleResult::Pass;
            }
        };

        if self.under_package_declaration {
            SyntaxRuleResult::Pass
        } else {
            match node {
                RefNode::PackageItem(PackageItem::PackageOrGenerateItemDeclaration(_)) |
                RefNode::PackageItem(PackageItem::PackageExportDeclaration(_)) => SyntaxRuleResult::Fail,
                _ => SyntaxRuleResult::Pass
            }
        }
    }

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

    fn hint(&self, _option: &ConfigOption) -> String {
        String::from("Place item into a package, module, interface, program, udp, or config.")
    }

    fn reason(&self) -> String {
        String::from("Globally-scoped items are not supported by some tools.")
    }
}