use std::fmt::Write;
use cairo_lang_defs::db::DefsGroup;
use cairo_lang_defs::ids::ModuleId;
use cairo_lang_diagnostics::{DiagnosticEntry, Diagnostics, FormattedDiagnosticEntry, Severity};
use cairo_lang_filesystem::db::FilesGroup;
use cairo_lang_filesystem::ids::{CrateId, FileLongId};
use cairo_lang_lowering::db::LoweringGroup;
use cairo_lang_parser::db::ParserGroup;
use cairo_lang_semantic::db::SemanticGroup;
use cairo_lang_utils::{LookupIntern, Upcast};
use thiserror::Error;
use crate::db::RootDatabase;
#[cfg(test)]
#[path = "diagnostics_test.rs"]
mod test;
#[derive(Error, Debug, Eq, PartialEq)]
#[error("Compilation failed.")]
pub struct DiagnosticsError;
trait DiagnosticCallback {
fn on_diagnostic(&mut self, diagnostic: FormattedDiagnosticEntry);
}
impl<'a> DiagnosticCallback for Option<Box<dyn DiagnosticCallback + 'a>> {
fn on_diagnostic(&mut self, diagnostic: FormattedDiagnosticEntry) {
if let Some(callback) = self {
callback.on_diagnostic(diagnostic)
}
}
}
pub struct DiagnosticsReporter<'a> {
callback: Option<Box<dyn DiagnosticCallback + 'a>>,
crate_ids: Vec<CrateId>,
allow_warnings: bool,
}
impl DiagnosticsReporter<'static> {
pub fn ignoring() -> Self {
Self { callback: None, crate_ids: vec![], allow_warnings: false }
}
pub fn stderr() -> Self {
Self::callback(|diagnostic| eprint!("{diagnostic}"))
}
}
impl<'a> DiagnosticsReporter<'a> {
pub fn callback(callback: impl FnMut(FormattedDiagnosticEntry) + 'a) -> Self {
struct Func<F>(F);
impl<F> DiagnosticCallback for Func<F>
where
F: FnMut(FormattedDiagnosticEntry),
{
fn on_diagnostic(&mut self, diagnostic: FormattedDiagnosticEntry) {
self.0(diagnostic)
}
}
Self::new(Func(callback))
}
pub fn write_to_string(string: &'a mut String) -> Self {
Self::callback(|diagnostic| {
write!(string, "{diagnostic}").unwrap();
})
}
fn new(callback: impl DiagnosticCallback + 'a) -> Self {
Self { callback: Some(Box::new(callback)), crate_ids: vec![], allow_warnings: false }
}
pub fn with_crates(mut self, crate_ids: &[CrateId]) -> Self {
self.crate_ids = crate_ids.to_vec();
self
}
pub fn allow_warnings(mut self) -> Self {
self.allow_warnings = true;
self
}
pub fn check(&mut self, db: &RootDatabase) -> bool {
let mut found_diagnostics = false;
let crates = if self.crate_ids.is_empty() { db.crates() } else { self.crate_ids.clone() };
for crate_id in crates {
let Ok(module_file) = db.module_main_file(ModuleId::CrateRoot(crate_id)) else {
found_diagnostics = true;
self.callback.on_diagnostic(FormattedDiagnosticEntry::new(
Severity::Error,
None,
"Failed to get main module file".to_string(),
));
continue;
};
if db.file_content(module_file).is_none() {
match module_file.lookup_intern(db) {
FileLongId::OnDisk(path) => {
self.callback.on_diagnostic(FormattedDiagnosticEntry::new(
Severity::Error,
None,
format!("{} not found\n", path.display()),
))
}
FileLongId::Virtual(_) => panic!("Missing virtual file."),
}
found_diagnostics = true;
}
for module_id in &*db.crate_modules(crate_id) {
if let Ok(module_files) = db.module_files(*module_id) {
for file_id in module_files.iter().copied() {
found_diagnostics |=
self.check_diag_group(db.upcast(), db.file_syntax_diagnostics(file_id));
}
}
if let Ok(group) = db.module_semantic_diagnostics(*module_id) {
found_diagnostics |= self.check_diag_group(db.upcast(), group);
}
if let Ok(group) = db.module_lowering_diagnostics(*module_id) {
found_diagnostics |= self.check_diag_group(db.upcast(), group);
}
}
}
found_diagnostics
}
fn check_diag_group<TEntry: DiagnosticEntry>(
&mut self,
db: &TEntry::DbType,
group: Diagnostics<TEntry>,
) -> bool {
let mut found: bool = false;
for entry in group.format_with_severity(db) {
if !entry.is_empty() {
self.callback.on_diagnostic(entry);
found |= !self.allow_warnings || group.check_error_free().is_err();
}
}
found
}
pub fn ensure(&mut self, db: &RootDatabase) -> Result<(), DiagnosticsError> {
if self.check(db) { Err(DiagnosticsError) } else { Ok(()) }
}
}
impl Default for DiagnosticsReporter<'static> {
fn default() -> Self {
DiagnosticsReporter::stderr()
}
}
pub fn get_diagnostics_as_string(db: &RootDatabase, extra_crate_ids: &[CrateId]) -> String {
let mut diagnostics = String::default();
DiagnosticsReporter::write_to_string(&mut diagnostics).with_crates(extra_crate_ids).check(db);
diagnostics
}