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
96
97
98
99

//! Diagnostics and builders to create them.

use std::io::prelude::*;

use calypso_base::ui::termcolor::Buffer;
use calypso_error::CalResult;

use codespan_reporting::files::SimpleFiles;
use codespan_reporting::{
    diagnostic::Diagnostic as CodespanDiag,
    term::{self, Config},
};

use super::error::DiagnosticError;

pub mod builder;

pub use builder::{Builder, EnsembleBuilder};

pub use codespan_reporting::diagnostic::{LabelStyle, Severity};

/// The structure used for managing source file names, IDs, and contents.
pub type SourceMgr = SimpleFiles<String, String>;

/// A diagnostic.
#[derive(Debug)]
pub struct Diagnostic(CodespanDiag<usize>);

impl Diagnostic {
    /// Render the diagnostic to the provided buffer. This will add a newline
    /// at the end.
    ///
    /// # Errors
    ///
    /// This function will error if rendering the diagnostic or writing to the
    /// buffer failed.
    pub fn render<'gcx>(
        &self,
        buf: &mut Buffer,
        sourcemgr: &'gcx SourceMgr,
        config: Option<&Config>,
    ) -> CalResult<()> {
        let def_config = Config::default();
        let config = config.unwrap_or(&def_config);

        term::emit(buf, config, sourcemgr, &self.0).map_err(DiagnosticError::from)?;
        writeln!(buf)?;

        Ok(())
    }
}

/// One or more diagnostics in a specific order, in order to form an "ensemble
/// diagnostic" which is emitted all at once.
#[allow(clippy::module_name_repetitions)]
#[derive(Debug)]
pub enum EnsembleDiagnostic {
    /// One diagnostic
    One(Diagnostic),
    /// Many diagnostics
    Many(Vec<Diagnostic>),
}

impl EnsembleDiagnostic {
    /// Render the ensemble diagnostic to the provided buffer. This will add a
    /// newline at the end.
    ///
    /// # Errors
    ///
    /// This function will error if rendering the diagnostic or writing to the
    /// buffer failed.
    // TODO(@ThePuzzlemaker: diag|cli): use compact displaystyle for syntax
    //   errors, add "force rich error" CLI arg for syntax errors
    pub fn render<'gcx>(
        &self,
        buf: &mut Buffer,
        sourcemgr: &'gcx SourceMgr,
        config: Option<&Config>,
    ) -> CalResult<()> {
        match self {
            Self::One(diag) => diag.render(buf, sourcemgr, config),
            Self::Many(diags) => diags
                .iter()
                .try_for_each(|diag| diag.render(buf, sourcemgr, config)),
        }
    }
}

impl From<Diagnostic> for EnsembleDiagnostic {
    fn from(diag: Diagnostic) -> Self {
        Self::One(diag)
    }
}

impl From<Vec<Diagnostic>> for EnsembleDiagnostic {
    fn from(diags: Vec<Diagnostic>) -> Self {
        Self::Many(diags)
    }
}