-
Notifications
You must be signed in to change notification settings - Fork 929
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(wgsl-in): parse
diagnostic(…) directives (with no effect)
- Loading branch information
1 parent
0ebfb1c
commit 4d609af
Showing
6 changed files
with
346 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| //! [`DiagnosticFilter`]s and supporting functionality. | ||
|
|
||
| use crate::Handle; | ||
| #[cfg(feature = "wgsl-in")] | ||
| use crate::Span; | ||
| #[cfg(feature = "wgsl-in")] | ||
| use indexmap::IndexMap; | ||
|
|
||
| /// A severity set on a [`DiagnosticFilter`]. | ||
| /// | ||
| /// <https://www.w3.org/TR/WGSL/#diagnostic-severity> | ||
| #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)] | ||
| pub enum Severity { | ||
| Off, | ||
| Info, | ||
| Warning, | ||
| Error, | ||
| } | ||
|
|
||
| impl Severity { | ||
| const ERROR: &'static str = "error"; | ||
| const WARNING: &'static str = "warning"; | ||
| const INFO: &'static str = "info"; | ||
| const OFF: &'static str = "off"; | ||
|
|
||
| /// Convert from a sentinel word in WGSL into its associated [`Severity`], if possible. | ||
| pub fn from_ident(s: &str) -> Option<Self> { | ||
| Some(match s { | ||
| Self::ERROR => Self::Error, | ||
| Self::WARNING => Self::Warning, | ||
| Self::INFO => Self::Info, | ||
| Self::OFF => Self::Off, | ||
| _ => return None, | ||
| }) | ||
| } | ||
|
|
||
| /// Checks whether this severity is [`Self::Error`]. | ||
| /// | ||
| /// Naga does not yet support diagnostic items at lesser severities than | ||
| /// [`Severity::Error`]. When this is implemented, this method should be deleted, and the | ||
| /// severity should be used directly for reporting diagnostics. | ||
| #[cfg(feature = "wgsl-in")] | ||
| pub(crate) fn report_diag<E>( | ||
| self, | ||
| err: E, | ||
| log_handler: impl FnOnce(E, log::Level), | ||
| ) -> Result<(), E> { | ||
| let log_level = match self { | ||
| Severity::Off => return Ok(()), | ||
|
|
||
| // NOTE: These severities are not yet reported. | ||
| Severity::Info => log::Level::Info, | ||
| Severity::Warning => log::Level::Warn, | ||
|
|
||
| Severity::Error => return Err(err), | ||
| }; | ||
| log_handler(err, log_level); | ||
| Ok(()) | ||
| } | ||
| } | ||
|
|
||
| /// A filterable triggering rule in a [`DiagnosticFilter`]. | ||
| /// | ||
| /// <https://www.w3.org/TR/WGSL/#filterable-triggering-rules> | ||
| #[derive(Clone, Copy, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)] | ||
| pub enum FilterableTriggeringRule { | ||
| DerivativeUniformity, | ||
| } | ||
|
|
||
| impl FilterableTriggeringRule { | ||
| const DERIVATIVE_UNIFORMITY: &'static str = "derivative_uniformity"; | ||
|
|
||
| /// Convert from a sentinel word in WGSL into its associated [`FilterableTriggeringRule`], if possible. | ||
| pub fn from_ident(s: &str) -> Option<Self> { | ||
| Some(match s { | ||
| Self::DERIVATIVE_UNIFORMITY => Self::DerivativeUniformity, | ||
| _ => return None, | ||
| }) | ||
| } | ||
|
|
||
| /// Maps this [`FilterableTriggeringRule`] into the sentinel word associated with it in WGSL. | ||
| pub const fn to_ident(self) -> &'static str { | ||
| match self { | ||
| Self::DerivativeUniformity => Self::DERIVATIVE_UNIFORMITY, | ||
| } | ||
| } | ||
|
|
||
| #[cfg(feature = "wgsl-in")] | ||
| pub(crate) const fn tracking_issue_num(self) -> u16 { | ||
| match self { | ||
| FilterableTriggeringRule::DerivativeUniformity => 5320, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// A filter that modifies how diagnostics are emitted for shaders. | ||
| /// | ||
| /// <https://www.w3.org/TR/WGSL/#diagnostic-filter> | ||
| #[derive(Clone, Debug)] | ||
| pub struct DiagnosticFilter { | ||
| pub new_severity: Severity, | ||
| pub triggering_rule: FilterableTriggeringRule, | ||
| } | ||
|
|
||
| /// A map of diagnostic filters to their severity and first occurrence's span. | ||
| /// | ||
| /// Intended for front ends' first step into storing parsed [`DiagnosticFilter`]s. | ||
| #[derive(Clone, Debug, Default)] | ||
| #[cfg(feature = "wgsl-in")] | ||
| pub(crate) struct DiagnosticFilterMap(IndexMap<FilterableTriggeringRule, (Severity, Span)>); | ||
|
|
||
| #[cfg(feature = "wgsl-in")] | ||
| impl DiagnosticFilterMap { | ||
| pub(crate) fn new() -> Self { | ||
| Self::default() | ||
| } | ||
|
|
||
| /// Add the given `diagnostic_filter` parsed at the given `span` to this map. | ||
| pub(crate) fn add( | ||
| &mut self, | ||
| diagnostic_filter: DiagnosticFilter, | ||
| span: Span, | ||
| ) -> Result<(), ConflictingDiagnosticRuleError> { | ||
| use indexmap::map::Entry; | ||
|
|
||
| let &mut Self(ref mut diagnostic_filters) = self; | ||
| let DiagnosticFilter { | ||
| new_severity, | ||
| triggering_rule, | ||
| } = diagnostic_filter; | ||
|
|
||
| match diagnostic_filters.entry(triggering_rule) { | ||
| Entry::Vacant(entry) => { | ||
| entry.insert((new_severity, span)); | ||
| Ok(()) | ||
| } | ||
| Entry::Occupied(entry) => { | ||
| return Err(ConflictingDiagnosticRuleError { | ||
| triggering_rule, | ||
| triggering_rule_spans: [entry.get().1, span], | ||
| }) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// An error yielded by [`DiagnosticFilterMap::add`]. | ||
| #[cfg(feature = "wgsl-in")] | ||
| #[derive(Clone, Debug)] | ||
| pub(crate) struct ConflictingDiagnosticRuleError { | ||
| pub triggering_rule: FilterableTriggeringRule, | ||
| pub triggering_rule_spans: [Span; 2], | ||
| } | ||
|
|
||
| /// Represents a single link in a linked list of [`DiagnosticFilter`]s backed by a | ||
| /// [`crate::Arena`]. | ||
| #[derive(Clone, Debug)] | ||
| pub struct DiagnosticFilterNode { | ||
| pub inner: DiagnosticFilter, | ||
| pub parent: Option<Handle<DiagnosticFilterNode>>, | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.