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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
use crate::config::{Config, ConfigOption};
use libloading::{Library, Symbol};
use regex::Regex;
use std::collections::HashMap;
use std::path::{Path, PathBuf};
use sv_parser::{unwrap_locate, Locate, NodeEvent, RefNode, SyntaxTree};

// Rule enum is for use by plugins.
#[derive(Clone, Copy)]
pub enum Rule {
    Text(*mut dyn TextRule),
    Syntax(*mut dyn SyntaxRule),
}

// Macro for use within plugins.
// Example usage in a plugin's `get_plugin` function:
//    pluginrules!(
//        SamplePlugin,
//        AnotherPlugin,
//    )
#[macro_export]
macro_rules! pluginrules {
    ( $( $x:ty ),* $(,)? ) => {
        {
            let mut vec: Vec<Rule> = Vec::new();
            $(
                let rule = <$x>::default();
                vec.push(rule.into_rule());
            )*
            vec
        }
    };
}

#[derive(Clone, Copy)]
pub enum TextRuleEvent<'a> {
    StartOfFile,
    Line(&'a str),
}

#[derive(Clone, Copy)]
pub enum TextRuleResult {
    Pass,
    Fail {
        offset: usize, // Character index, on this line, beginning failure.
        len: usize, // Number of characters causing failure.
    },
}

pub trait TextRule: Sync + Send {
    fn check(
        &mut self,
        event: TextRuleEvent,
        config: &ConfigOption,
    ) -> TextRuleResult;
    fn name(&self) -> String;
    fn hint(&self, config: &ConfigOption) -> String;
    fn reason(&self) -> String;

    fn into_rule(self) -> Rule
    where
        Self: Sized + 'static,
    {
        let temp = Box::new(self);
        Rule::Text(Box::into_raw(temp))
    }
}

#[derive(Clone, Copy)]
pub enum SyntaxRuleResult {
    Pass,
    Fail,
    FailAt(usize, usize),
    FailLocate(Locate),
}

pub trait SyntaxRule: Sync + Send {
    fn check(
        &mut self,
        syntax_tree: &SyntaxTree,
        event: &NodeEvent,
        config: &ConfigOption,
    ) -> SyntaxRuleResult;
    fn name(&self) -> String;
    fn hint(&self, config: &ConfigOption) -> String;
    fn reason(&self) -> String;

    fn into_rule(self) -> Rule
    where
        Self: Sized + 'static,
    {
        let temp = Box::new(self);
        Rule::Syntax(Box::into_raw(temp))
    }
}

pub struct Linter {
    option: ConfigOption,
    textrules: Vec<Box<dyn TextRule>>,
    syntaxrules: Vec<Box<dyn SyntaxRule>>,
    plugins: Vec<Library>,
    re_ctl: Regex,
    pub ctl_enabled: HashMap<String, bool>,
}

#[derive(Debug)]
pub struct LintFailed {
    pub path: PathBuf,
    pub beg: usize,
    pub len: usize,
    pub name: String,
    pub hint: String,
    pub reason: String,
}

impl Linter {
    pub fn new(config: Config) -> Linter {
        let textrules = config.gen_textrules();
        let syntaxrules = config.gen_syntaxrules();

        // NOTE: Only syntaxrules are comment-controllable, not textrules.
        let re_ctl = Regex::new(r"/\*\s*svlint\s+(on|off)\s+([a-z0-9_]+)\s*\*/").unwrap();
        let mut ctl_enabled = HashMap::new();
        for rule in &syntaxrules {
            ctl_enabled.insert(rule.name(), true);
        }

        Linter {
            option: config.option,
            textrules,
            syntaxrules,
            plugins: Vec::new(),
            re_ctl,
            ctl_enabled,
        }
    }

    pub fn load(&mut self, path: &Path) -> Result<(), libloading::Error> {
        let lib = unsafe { Library::new(path) }?;

        self.plugins.push(lib);
        let lib = self.plugins.last().unwrap();

        let get_plugin: Result<Symbol<extern "C" fn() -> Vec<Rule>>, _> =
            unsafe { lib.get(b"get_plugin") };
        if let Ok(get_plugin) = get_plugin {
            let plugins = get_plugin();
            for plugin in plugins {
                match plugin {
                    Rule::Text(p) => {
                        let plugin = unsafe { Box::from_raw(p) };
                        self.textrules.push(plugin);
                    },
                    Rule::Syntax(p) => {
                        let plugin = unsafe { Box::from_raw(p) };
                        self.ctl_enabled.insert(plugin.name(), true);
                        self.syntaxrules.push(plugin);
                    },
                }
            }
        }

        Ok(())
    }

    pub fn textrules_check(&mut self, event: TextRuleEvent, path: &Path, beg: &usize) -> Vec<LintFailed> {

        let mut ret = Vec::new();
        'outer: for rule in &mut self.textrules {
            match rule.check(event, &self.option) {
                TextRuleResult::Fail {offset, len} => {
                    match event {
                        TextRuleEvent::StartOfFile => {}
                        TextRuleEvent::Line(_) => {
                            for exclude in &self.option.exclude_paths {
                                if exclude.is_match(&path.to_string_lossy()) {
                                    continue 'outer;
                                }
                            }
                            let result = LintFailed {
                                path: path.to_path_buf(),
                                beg: beg + offset,
                                len,
                                name: rule.name(),
                                hint: rule.hint(&self.option),
                                reason: rule.reason(),
                            };
                            ret.push(result);
                        }
                    }
                }
                _ => (),
            }
        }
        ret
    }

    fn update_ctl_enabled(&mut self, syntax_tree: &SyntaxTree, event: &NodeEvent) {
        match event {
            NodeEvent::Enter(RefNode::Comment(x)) => {
                let loc: Option<&Locate> = unwrap_locate!(*x);
                let text: Option<&str> = match &loc {
                    Some(x) => syntax_tree.get_str(*x),
                    _ => None,
                };
                let caps = self.re_ctl.captures(text.unwrap());
                if caps.is_some() {
                    let caps = caps.unwrap();
                    let ctl_name = caps.get(2).unwrap().as_str();
                    if self.ctl_enabled.contains_key(ctl_name) {
                        let ctl_enable = match caps.get(1).unwrap().as_str() {
                            "off" => false,
                            _ => true,
                        };
                        self.ctl_enabled.insert(ctl_name.to_string(), ctl_enable);
                    }
                }
            }
            _ => {}
        }
    }

    pub fn syntaxrules_check(&mut self, syntax_tree: &SyntaxTree, event: &NodeEvent) -> Vec<LintFailed> {
        self.update_ctl_enabled(syntax_tree, event);

        let node = match event {
            NodeEvent::Enter(x) => x,
            NodeEvent::Leave(x) => x,
        };
        let locate = if let Some(x) = unwrap_locate!(node.clone()) {
            x
        } else {
            return vec![];
        };

        let mut ret = Vec::new();
        'outer: for rule in &mut self.syntaxrules {
            match self.ctl_enabled[&rule.name()] {
                true => {}
                _ => {
                    continue 'outer;
                }
            }

            match rule.check(syntax_tree, event, &self.option) {
                SyntaxRuleResult::Fail => {
                    if let Some((path, beg)) = syntax_tree.get_origin(&locate) {
                        for exclude in &self.option.exclude_paths {
                            if exclude.is_match(&path.to_string_lossy()) {
                                continue 'outer;
                            }
                        }
                        let result = LintFailed {
                            path: path.clone(),
                            beg,
                            len: locate.len,
                            name: rule.name(),
                            hint: rule.hint(&self.option),
                            reason: rule.reason(),
                        };
                        ret.push(result);
                    }
                }
                SyntaxRuleResult::FailAt(offset, len) => {
                    if let Some((path, beg)) = syntax_tree.get_origin(&locate) {
                        for exclude in &self.option.exclude_paths {
                            if exclude.is_match(&path.to_string_lossy()) {
                                continue 'outer;
                            }
                        }
                        let result = LintFailed {
                            path: path.clone(),
                            beg: beg + offset,
                            len,
                            name: rule.name(),
                            hint: rule.hint(&self.option),
                            reason: rule.reason(),
                        };
                        ret.push(result);
                    }
                }
                SyntaxRuleResult::FailLocate(x) => {
                    if let Some((path, beg)) = syntax_tree.get_origin(&x) {
                        for exclude in &self.option.exclude_paths {
                            if exclude.is_match(&path.to_string_lossy()) {
                                continue 'outer;
                            }
                        }
                        let result = LintFailed {
                            path: path.clone(),
                            beg,
                            len: x.len,
                            name: rule.name(),
                            hint: rule.hint(&self.option),
                            reason: rule.reason(),
                        };
                        ret.push(result);
                    }
                }
                _ => (),
            }
        }
        ret
    }
}

// Utility function used by syntaxrules `re_(required|forbidden)_*`.
pub fn check_regex(
    required_not_forbidden: bool,
    id: Option<RefNode>,
    syntax_tree: &SyntaxTree,
    re: &Regex,
) -> SyntaxRuleResult {
    let loc: &Locate = match id {
        Some(x) => unwrap_locate!(x),
        _ => None,
    }
    .unwrap();

    let is_match: bool = re.is_match(syntax_tree.get_str(loc).unwrap());

    if is_match == required_not_forbidden {
        SyntaxRuleResult::Pass
    } else {
        SyntaxRuleResult::Fail
    }
}

// Utility function used by syntaxrules `prefix_*`.
pub fn check_prefix(
    id: Option<RefNode>,
    syntax_tree: &SyntaxTree,
    prefix: &String,
) -> SyntaxRuleResult {
    let loc: &Locate = match id {
        Some(x) => unwrap_locate!(x),
        _ => None,
    }
    .unwrap();

    let is_prefixed: bool = syntax_tree.get_str(loc).unwrap().starts_with(prefix);

    if is_prefixed {
        SyntaxRuleResult::Pass
    } else {
        SyntaxRuleResult::Fail
    }
}