rune/workspace/
emit.rs

Help
1//! Runtime helpers for loading code and emitting diagnostics.
2
3use std::fmt;
4use std::io;
5
6use codespan_reporting::diagnostic as d;
7use codespan_reporting::term;
8use codespan_reporting::term::termcolor::WriteColor;
9
10use crate::alloc;
11use crate::alloc::prelude::*;
12use crate::ast::Spanned;
13use crate::workspace::{Diagnostic, Diagnostics, FatalDiagnostic};
14use crate::Sources;
15
16/// Errors that can be raised when formatting diagnostics.
17#[derive(Debug)]
18#[non_exhaustive]
19pub enum EmitError {
20    /// Source Error.
21    Io(io::Error),
22    /// Allocation Error.
23    Alloc(alloc::Error),
24    /// Codespan reporting error.
25    CodespanReporting(codespan_reporting::files::Error),
26}
27
28impl fmt::Display for EmitError {
29    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
30        match self {
31            EmitError::Io(..) => write!(f, "I/O error"),
32            EmitError::Alloc(error) => error.fmt(f),
33            EmitError::CodespanReporting(..) => write!(f, "codespan reporting error"),
34        }
35    }
36}
37
38impl From<io::Error> for EmitError {
39    fn from(source: io::Error) -> Self {
40        EmitError::Io(source)
41    }
42}
43
44impl From<alloc::Error> for EmitError {
45    fn from(error: alloc::Error) -> Self {
46        EmitError::Alloc(error)
47    }
48}
49
50impl From<codespan_reporting::files::Error> for EmitError {
51    fn from(source: codespan_reporting::files::Error) -> Self {
52        EmitError::CodespanReporting(source)
53    }
54}
55
56impl core::error::Error for EmitError {
57    fn source(&self) -> Option<&(dyn core::error::Error + 'static)> {
58        match self {
59            EmitError::Io(error) => Some(error),
60            EmitError::CodespanReporting(error) => Some(error),
61            _ => None,
62        }
63    }
64}
65
66impl Diagnostics {
67    /// Generate formatted diagnostics capable of referencing source lines and
68    /// hints.
69    ///
70    /// See [prepare][crate::prepare] for how to use.
71    pub fn emit<O>(&self, out: &mut O, sources: &Sources) -> Result<(), EmitError>
72    where
73        O: WriteColor,
74    {
75        if self.is_empty() {
76            return Ok(());
77        }
78
79        let config = codespan_reporting::term::Config::default();
80
81        for diagnostic in &self.diagnostics {
82            match diagnostic {
83                Diagnostic::Fatal(e) => {
84                    error_diagnostics_emit(e, out, sources, &config)?;
85                }
86            }
87        }
88
89        Ok(())
90    }
91}
92
93/// Custom shared helper for emitting diagnostics for a single error.
94fn error_diagnostics_emit<O>(
95    this: &FatalDiagnostic,
96    out: &mut O,
97    sources: &Sources,
98    config: &codespan_reporting::term::Config,
99) -> Result<(), EmitError>
100where
101    O: WriteColor,
102{
103    let mut labels = rust_alloc::vec::Vec::new();
104
105    let span = this.error().span();
106
107    labels.push(
108        d::Label::primary(this.source_id(), span.range())
109            .with_message(this.error().try_to_string()?.into_std()),
110    );
111
112    let diagnostic = d::Diagnostic::error()
113        .with_message(this.error().try_to_string()?.into_std())
114        .with_labels(labels);
115
116    term::emit(out, config, sources, &diagnostic)?;
117    Ok(())
118}
rune/workspace/emit.rs

rune/workspace/
emit.rs
