shader-sense 1.3.1

Library for runtime shader validation and symbol inspection
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
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

use std::path::Path;

use crate::{
    position::{ShaderFileRange, ShaderRange},
    symbols::{
        prepocessor::{
            ShaderPreprocessor, ShaderPreprocessorContext, ShaderPreprocessorDefine,
            ShaderPreprocessorInclude,
        },
        symbol_parser::{get_name, SymbolTreePreprocessorParser},
    },
};

pub fn get_glsl_preprocessor_parser() -> Vec<Box<dyn SymbolTreePreprocessorParser>> {
    vec![
        Box::new(GlslIncludeTreePreprocessorParser {}),
        Box::new(GlslDefineTreePreprocessorParser {}),
        Box::new(GlslDefineFuncTreePreprocessorParser {}),
    ]
}
struct GlslIncludeTreePreprocessorParser {}

impl SymbolTreePreprocessorParser for GlslIncludeTreePreprocessorParser {
    fn get_query(&self) -> String {
        r#"(preproc_include
            (#include)
            path: [(string_literal)(system_lib_string)] @include
        )"#
        .into()
    }
    fn process_match(
        &self,
        symbol_match: &tree_sitter::QueryMatch,
        file_path: &Path,
        shader_content: &str,
        preprocessor: &mut ShaderPreprocessor,
        context: &mut ShaderPreprocessorContext,
    ) {
        let include_node = symbol_match.captures[0].node;
        let range =
            ShaderFileRange::from(file_path.into(), ShaderRange::from(include_node.range()));
        let relative_path = get_name(shader_content, include_node);
        let relative_path = &relative_path[1..relative_path.len() - 1];

        // Only add symbol if path can be resolved.
        match context.search_path_in_includes(Path::new(relative_path)) {
            Some(absolute_path) => {
                preprocessor.includes.push(ShaderPreprocessorInclude::new(
                    relative_path.into(),
                    absolute_path,
                    range,
                ));
            }
            None => {}
        }
    }
}
struct GlslDefineTreePreprocessorParser {}

impl SymbolTreePreprocessorParser for GlslDefineTreePreprocessorParser {
    fn get_query(&self) -> String {
        r#"(preproc_def
            (#define)
            name: (identifier) @define.label
            value: (preproc_arg)? @define.value
        )"#
        .into()
    }
    fn process_match(
        &self,
        symbol_match: &tree_sitter::QueryMatch,
        file_path: &Path,
        shader_content: &str,
        symbols: &mut ShaderPreprocessor,
        _context: &mut ShaderPreprocessorContext,
    ) {
        let identifier_node = symbol_match.captures[0].node;
        let range =
            ShaderFileRange::from(file_path.into(), ShaderRange::from(identifier_node.range()));
        let name = get_name(shader_content, identifier_node).into();
        let value = if symbol_match.captures.len() > 1 {
            Some(get_name(shader_content, symbol_match.captures[1].node).trim())
        } else {
            None
        };
        // TODO: check exist & first one / last one. Need regions aswell... Duplicate with position as key ?
        symbols.defines.push(ShaderPreprocessorDefine::new(
            name,
            range,
            value.map(|s| s.into()),
            None,
        ));
    }
}

struct GlslDefineFuncTreePreprocessorParser {}

impl SymbolTreePreprocessorParser for GlslDefineFuncTreePreprocessorParser {
    fn get_query(&self) -> String {
        r#"(preproc_function_def
            (#define)
            name: (identifier) @define.name
            parameters: (preproc_params 
                (identifier) @define.param
            )
            value: (preproc_arg) @define.value
        )"#
        .into()
    }
    fn process_match(
        &self,
        symbol_match: &tree_sitter::QueryMatch,
        file_path: &Path,
        shader_content: &str,
        symbols: &mut ShaderPreprocessor,
        _context: &mut ShaderPreprocessorContext,
    ) {
        let identifier_node = symbol_match.captures[0].node;
        let range =
            ShaderFileRange::from(file_path.into(), ShaderRange::from(identifier_node.range()));
        let name = get_name(shader_content, identifier_node).into();
        assert!(symbol_match.captures.len() >= 2);
        let arguments = symbol_match.captures[1..symbol_match.captures.len() - 1]
            .iter()
            .map(|c| get_name(shader_content, c.node).trim().into())
            .collect::<Vec<String>>();
        let value = get_name(
            shader_content,
            symbol_match.captures[symbol_match.captures.len() - 1].node,
        )
        .trim();
        symbols.defines.push(ShaderPreprocessorDefine::new(
            name,
            range,
            Some(value.into()),
            Some(arguments),
        ));
    }
}