rust/crates/ra_hir_expand/src/diagnostics.rs

//! 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, collections::HashSet, fmt};

use ra_syntax::{SyntaxNode, SyntaxNodePtr};

use crate::{db::AstDatabase, InFile};

pub trait Diagnostic: Any + Send + Sync + fmt::Debug + 'static {
    fn name(&self) -> String;
    fn message(&self) -> String;
    fn source(&self) -> InFile<SyntaxNodePtr>;
    fn as_any(&self) -> &(dyn Any + Send + 'static);
    fn is_experimental(&self) -> bool {
        false
    }
}

pub trait AstDiagnostic {
    type AST;
    fn ast(&self, db: &dyn AstDatabase) -> Self::AST;
}

impl dyn Diagnostic {
    pub fn syntax_node(&self, db: &impl AstDatabase) -> SyntaxNode {
        let node = db.parse_or_expand(self.source().file_id).unwrap();
        self.source().value.to_node(&node)
    }

    pub fn downcast_ref<D: Diagnostic>(&self) -> Option<&D> {
        self.as_any().downcast_ref()
    }
}

pub struct DiagnosticSink<'a> {
    callbacks: Vec<Box<dyn FnMut(&dyn Diagnostic) -> Result<(), ()> + 'a>>,
    filters: Vec<Box<dyn FnMut(&dyn Diagnostic) -> bool + 'a>>,
    default_callback: Box<dyn FnMut(&dyn Diagnostic) + 'a>,
    disabled_diagnostics: HashSet<String>,
}

impl<'a> DiagnosticSink<'a> {
    pub fn push(&mut self, d: impl Diagnostic) {
        if self.disabled_diagnostics.contains(&d.name()) {
            // This diagnostic is disabled, ignore it completely.
            return;
        }

        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<Box<dyn FnMut(&dyn Diagnostic) -> Result<(), ()> + 'a>>,
    filters: Vec<Box<dyn FnMut(&dyn Diagnostic) -> bool + 'a>>,
    disabled_diagnostics: HashSet<String>,
}

impl<'a> DiagnosticSinkBuilder<'a> {
    pub fn new() -> Self {
        Self { callbacks: Vec::new(), filters: Vec::new(), disabled_diagnostics: HashSet::new() }
    }

    pub fn filter<F: FnMut(&dyn Diagnostic) -> bool + 'a>(mut self, cb: F) -> Self {
        self.filters.push(Box::new(cb));
        self
    }

    pub fn on<D: Diagnostic, F: FnMut(&D) + 'a>(mut self, mut cb: F) -> Self {
        let cb = move |diag: &dyn Diagnostic| match diag.downcast_ref::<D>() {
            Some(d) => {
                cb(d);
                Ok(())
            }
            None => Err(()),
        };
        self.callbacks.push(Box::new(cb));
        self
    }

    pub fn disable_diagnostic(mut self, diagnostic: impl Into<String>) -> Self {
        self.disabled_diagnostics.insert(diagnostic.into());
        self
    }

    pub fn build<F: FnMut(&dyn Diagnostic) + 'a>(self, default_callback: F) -> DiagnosticSink<'a> {
        DiagnosticSink {
            callbacks: self.callbacks,
            filters: self.filters,
            default_callback: Box::new(default_callback),
            disabled_diagnostics: self.disabled_diagnostics,
        }
    }
}