//! Semantic errors and warnings. //! //! The `Diagnostic` trait defines a trait object which can represent any //! diagnostic. //! //! `DiagnosticSink` struct is used as an emitter for diagnostic. When creating //! a `DiagnosticSink`, you supply a callback which can react to a `dyn //! Diagnostic` or to any concrete diagnostic (downcasting is sued internally). //! //! Because diagnostics store file offsets, it's a bad idea to store them //! directly in salsa. For this reason, every hir subsytem defines it's own //! strongly-typed closed set of diagnostics which use hir ids internally, are //! stored in salsa and do *not* implement the `Diagnostic` trait. Instead, a //! subsystem provides a separate, non-query-based API which can walk all stored //! values and transform them into instances of `Diagnostic`. use std::{any::Any, fmt}; use ra_syntax::SyntaxNodePtr; use crate::InFile; pub trait Diagnostic: Any + Send + Sync + fmt::Debug + 'static { fn message(&self) -> String; fn presentation(&self) -> InFile; fn as_any(&self) -> &(dyn Any + Send + 'static); fn is_experimental(&self) -> bool { false } } pub struct DiagnosticSink<'a> { callbacks: Vec Result<(), ()> + 'a>>, filters: Vec bool + 'a>>, default_callback: Box, } impl<'a> DiagnosticSink<'a> { pub fn push(&mut self, d: impl Diagnostic) { let d: &dyn Diagnostic = &d; self._push(d); } fn _push(&mut self, d: &dyn Diagnostic) { for filter in &mut self.filters { if !filter(d) { return; } } for cb in &mut self.callbacks { match cb(d) { Ok(()) => return, Err(()) => (), } } (self.default_callback)(d) } } pub struct DiagnosticSinkBuilder<'a> { callbacks: Vec Result<(), ()> + 'a>>, filters: Vec bool + 'a>>, } impl<'a> DiagnosticSinkBuilder<'a> { pub fn new() -> Self { Self { callbacks: Vec::new(), filters: Vec::new() } } pub fn filter bool + 'a>(mut self, cb: F) -> Self { self.filters.push(Box::new(cb)); self } pub fn on(mut self, mut cb: F) -> Self { let cb = move |diag: &dyn Diagnostic| match diag.as_any().downcast_ref::() { Some(d) => { cb(d); Ok(()) } None => Err(()), }; self.callbacks.push(Box::new(cb)); self } pub fn build(self, default_callback: F) -> DiagnosticSink<'a> { DiagnosticSink { callbacks: self.callbacks, filters: self.filters, default_callback: Box::new(default_callback), } } }