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

//! Validation for wgsl with [`naga`]

use naga::{
    front::wgsl::{self, ParseError},
    valid::{Capabilities, ValidationFlags},
};
use std::path::Path;

use crate::{
    position::{ShaderFileRange, ShaderPosition},
    shader::{ShaderParams, ShaderStage},
    shader_error::{ShaderDiagnostic, ShaderDiagnosticList, ShaderDiagnosticSeverity, ShaderError},
};

use super::validator::ValidatorImpl;

pub struct Naga {}

impl Naga {
    pub fn new() -> Self {
        Self {}
    }
    fn from_parse_err(err: ParseError, file_path: &Path, shader_content: &str) -> ShaderDiagnostic {
        let error = err.emit_to_string(shader_content);
        let loc = err.location(shader_content);
        if let Some(loc) = loc {
            ShaderDiagnostic {
                severity: ShaderDiagnosticSeverity::Error,
                error,
                range: ShaderFileRange::new(
                    file_path.into(),
                    ShaderPosition::new(loc.line_number - 1, loc.line_position),
                    ShaderPosition::new(loc.line_number - 1, loc.line_position),
                ),
            }
        } else {
            ShaderDiagnostic {
                severity: ShaderDiagnosticSeverity::Error,
                error,
                range: ShaderFileRange::zero(file_path.into()),
            }
        }
    }
}
impl ValidatorImpl for Naga {
    fn validate_shader(
        &self,
        shader_content: &str,
        file_path: &Path,
        _params: &ShaderParams,
        _include_callback: &mut dyn FnMut(&Path) -> Option<String>,
    ) -> Result<ShaderDiagnosticList, ShaderError> {
        let module = match wgsl::parse_str(shader_content)
            .map_err(|err| Self::from_parse_err(err, file_path, shader_content))
        {
            Ok(module) => module,
            Err(diag) => {
                return Ok(ShaderDiagnosticList::from(diag));
            }
        };

        let mut validator =
            naga::valid::Validator::new(ValidationFlags::all(), Capabilities::all());
        if let Err(error) = validator.validate(&module) {
            let mut list = ShaderDiagnosticList::empty();
            for (span, _) in error.spans() {
                let loc = span.location(shader_content);
                list.push(ShaderDiagnostic {
                    severity: ShaderDiagnosticSeverity::Error,
                    error: error.emit_to_string(""),
                    range: ShaderFileRange::new(
                        file_path.into(),
                        ShaderPosition::new(loc.line_number - 1, loc.line_position),
                        ShaderPosition::new(loc.line_number - 1, loc.line_position),
                    ),
                });
            }
            if list.is_empty() {
                Err(ShaderError::InternalErr(
                    error.emit_to_string(shader_content),
                ))
            } else {
                Ok(list)
            }
        } else {
            Ok(ShaderDiagnosticList::empty())
        }
    }
    fn support(&self, shader_stage: ShaderStage) -> bool {
        match shader_stage {
            ShaderStage::Vertex | ShaderStage::Fragment | ShaderStage::Compute => true,
            _ => false,
        }
    }
}