emmylua_parser 0.25.0

A parser for EmmyLua and luals
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

use std::collections::HashMap;

use rowan::NodeCache;

use crate::{LuaNonStdSymbolSet, kind::LuaLanguageLevel, lexer::LexerConfig};

pub struct ParserConfig<'cache> {
    pub level: LuaLanguageLevel,
    lexer_config: LexerConfig,
    node_cache: Option<&'cache mut NodeCache>,
    special_like: HashMap<String, SpecialFunction>,
    pub enable_emmylua_doc: bool,
}

impl<'cache> ParserConfig<'cache> {
    pub fn new(
        level: LuaLanguageLevel,
        node_cache: Option<&'cache mut NodeCache>,
        special_like: HashMap<String, SpecialFunction>,
        non_std_symbols: LuaNonStdSymbolSet,
        enable_emmylua_doc: bool,
    ) -> Self {
        Self {
            level,
            lexer_config: LexerConfig {
                language_level: level,
                non_std_symbols,
            },
            node_cache,
            special_like,
            enable_emmylua_doc,
        }
    }

    pub fn lexer_config(&self) -> LexerConfig {
        self.lexer_config
    }

    pub fn support_local_attrib(&self) -> bool {
        self.level >= LuaLanguageLevel::Lua54
    }

    pub fn support_emmylua_doc(&self) -> bool {
        self.enable_emmylua_doc
    }

    pub fn support_named_var_args(&self) -> bool {
        self.level >= LuaLanguageLevel::Lua55
    }

    pub fn node_cache(&mut self) -> Option<&mut NodeCache> {
        self.node_cache.as_deref_mut()
    }

    pub fn get_special_function(&self, name: &str) -> SpecialFunction {
        match name {
            "require" => SpecialFunction::Require,
            "error" => SpecialFunction::Error,
            "assert" => SpecialFunction::Assert,
            "type" => SpecialFunction::Type,
            "setmetatable" => SpecialFunction::Setmetaatable,
            _ => *self
                .special_like
                .get(name)
                .unwrap_or(&SpecialFunction::None),
        }
    }

    pub fn with_level(level: LuaLanguageLevel) -> Self {
        Self {
            level,
            lexer_config: LexerConfig {
                language_level: level,
                non_std_symbols: LuaNonStdSymbolSet::new(),
            },
            node_cache: None,
            special_like: HashMap::new(),
            enable_emmylua_doc: true,
        }
    }
}

impl Default for ParserConfig<'_> {
    fn default() -> Self {
        Self {
            level: LuaLanguageLevel::Lua55,
            lexer_config: LexerConfig {
                language_level: LuaLanguageLevel::Lua55,
                non_std_symbols: LuaNonStdSymbolSet::new(),
            },
            node_cache: None,
            special_like: HashMap::new(),
            enable_emmylua_doc: true,
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum SpecialFunction {
    None,
    Require,
    Error,
    Assert,
    Type,
    Setmetaatable,
}