shader-sense 1.3.0

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
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

//! Parser specific for HLSL
mod hlsl_parser;
mod hlsl_preprocessor;
mod hlsl_regions;
mod hlsl_word;

use hlsl_parser::get_hlsl_parsers;
use hlsl_preprocessor::get_hlsl_preprocessor_parser;

// For glsl
pub use hlsl_regions::HlslSymbolRegionFinder;
pub use hlsl_word::HlslSymbolWordProvider;

use crate::shader::ShadingLanguage;

use super::symbol_provider::SymbolProvider;

pub(super) fn create_hlsl_symbol_provider(
    tree_sitter_language: &tree_sitter::Language,
) -> SymbolProvider {
    SymbolProvider::new(
        tree_sitter_language,
        get_hlsl_parsers(),
        get_hlsl_preprocessor_parser(),
        Box::new(HlslSymbolRegionFinder::new(ShadingLanguage::Hlsl)),
        Box::new(hlsl_word::HlslSymbolWordProvider {}),
    )
}

#[cfg(test)]
mod tests {
    use std::path::Path;

    use crate::{
        position::{ShaderPosition, ShaderRange},
        shader::{
            GlslShadingLanguageTag, HlslShadingLanguageTag, ShaderParams, ShadingLanguage,
            ShadingLanguageTag,
        },
        symbols::{
            hlsl::hlsl_word::HlslSymbolWordProvider,
            prepocessor::ShaderRegion,
            shader_module_parser::ShaderModuleParser,
            symbol_parser::SymbolWordProvider,
            symbol_provider::{default_include_callback, SymbolProvider},
        },
    };

    #[test]
    fn test_hlsl_regions() {
        let shader_module_parser = ShaderModuleParser::from_shading_language(ShadingLanguage::Hlsl);
        let symbol_provider = SymbolProvider::from_shading_language(ShadingLanguage::Hlsl);
        test_regions::<HlslShadingLanguageTag>(shader_module_parser, symbol_provider);
    }
    #[test]
    fn test_glsl_regions() {
        let shader_module_parser = ShaderModuleParser::from_shading_language(ShadingLanguage::Glsl);
        let symbol_provider = SymbolProvider::from_shading_language(ShadingLanguage::Glsl);
        test_regions::<GlslShadingLanguageTag>(shader_module_parser, symbol_provider);
    }

    fn test_regions<T: ShadingLanguageTag>(
        mut shader_module_parser: ShaderModuleParser,
        symbol_provider: SymbolProvider,
    ) {
        let file_path = Path::new("./test/hlsl/regions.hlsl");
        let shader_content = std::fs::read_to_string(file_path).unwrap();
        let shader_module = shader_module_parser
            .create_module(file_path, &shader_content)
            .unwrap();
        let symbols = symbol_provider
            .query_symbols(
                &shader_module,
                ShaderParams::default(),
                &mut default_include_callback::<T>,
                None,
            )
            .unwrap();
        let set_region =
            |start_line: u32, start_pos: u32, end_line: u32, end_pos: u32, active: bool| {
                ShaderRegion {
                    range: ShaderRange::new(
                        ShaderPosition::new(start_line, start_pos),
                        ShaderPosition::new(end_line, end_pos),
                    ),
                    is_active: active,
                }
            };
        let expected_regions = vec![
            // elif
            set_region(7, 21, 8, 16, true),   // 00
            set_region(9, 32, 10, 16, false), // 01
            set_region(11, 5, 12, 16, false), // 02
            // ifdef true
            set_region(15, 24, 16, 16, true), // 03
            set_region(17, 5, 18, 16, false), // 04
            // ifndef
            set_region(21, 25, 22, 16, false), // 05
            set_region(23, 5, 24, 16, true),   // 06
            // ifdef false
            set_region(27, 28, 28, 16, false), // 07
            // if 0
            set_region(31, 5, 32, 16, false), // 08
            // if parenthesized
            set_region(36, 50, 37, 16, false), // 09
            // if binary
            set_region(41, 43, 42, 16, false), // 10
            // if unary
            set_region(46, 22, 47, 16, false), // 11
            // unary defined expression
            set_region(51, 66, 52, 16, false), // 12
            // region depending on region not defined
            set_region(56, 25, 57, 35, false), // 13
            set_region(59, 28, 60, 34, false), // 14
            // region depending on region defined
            set_region(64, 21, 65, 29, true), // 15
            set_region(67, 22, 68, 16, true), // 16
            // macro included before
            set_region(72, 26, 73, 34, false), // 17
            // macro defined after
            set_region(77, 18, 78, 34, false), // 18
            // macro included after
            set_region(82, 31, 83, 34, false), // 19
        ];
        assert!(
            symbols.preprocessor.regions.len() == expected_regions.len(),
            "Expecting {} regions, found {}",
            expected_regions.len(),
            symbols.preprocessor.regions.len()
        );
        for region_index in 0..symbols.preprocessor.regions.len() {
            println!(
                "region {}: {:#?}",
                region_index, symbols.preprocessor.regions[region_index]
            );
            assert!(
                symbols.preprocessor.regions[region_index].range.start
                    == expected_regions[region_index].range.start,
                "Failed start assert for region {}",
                region_index
            );
            assert!(
                symbols.preprocessor.regions[region_index].range.end
                    == expected_regions[region_index].range.end,
                "Failed end assert for region {}",
                region_index
            );
            assert!(
                symbols.preprocessor.regions[region_index].is_active
                    == expected_regions[region_index].is_active,
                "Failed active assert for region {}",
                region_index
            );
        }
    }

    #[test]
    fn test_words() {
        let file_path = "./test/hlsl/struct.hlsl";
        let shader_content = std::fs::read_to_string(file_path).unwrap();
        let word_provider = HlslSymbolWordProvider {};
        let mut shader_module_parser =
            ShaderModuleParser::from_shading_language(ShadingLanguage::Hlsl);
        let shader_module = shader_module_parser
            .create_module(Path::new(file_path), &shader_content)
            .unwrap();

        // container
        let word = word_provider
            .find_word_at_position_in_node(
                &shader_module,
                shader_module.tree.root_node(),
                &ShaderPosition::new(23, 17),
            )
            .unwrap();
        assert!(word.get_word() == "container");
        assert!(word.get_parent().is_none());

        // container.method()
        let word = word_provider
            .find_word_at_position_in_node(
                &shader_module,
                shader_module.tree.root_node(),
                &ShaderPosition::new(23, 27),
            )
            .unwrap();
        assert!(word.get_word() == "method");
        assert!(word.get_parent().unwrap().get_word() == "container");

        // container.method().test2
        let word = word_provider
            .find_word_at_position_in_node(
                &shader_module,
                shader_module.tree.root_node(),
                &ShaderPosition::new(23, 44),
            )
            .unwrap();
        assert!(word.get_word() == "test2");
        assert!(word.get_parent().unwrap().get_word() == "method");
        assert!(word.get_parent().unwrap().get_parent().unwrap().get_word() == "container");

        // container.testArray[0].oui
        let word = word_provider
            .find_word_at_position_in_node(
                &shader_module,
                shader_module.tree.root_node(),
                &ShaderPosition::new(24, 44),
            )
            .unwrap();
        assert!(word.get_word() == "oui");
        assert!(word.get_parent().unwrap().get_word() == "testArray");
        assert!(word.get_parent().unwrap().get_parent().unwrap().get_word() == "container");
    }
}