wright/
reporting.rs

Help
1//! Reporting for errors, warnings, and everything else.
2//!
3//! The code in this module is heavily inspired by [codespan-reporting] and [ariadne].
4//!
5//! [codespan-reporting]: https://crates.io/crates/codespan-reporting
6//! [ariadne]: https://crates.io/crates/ariadne
7
8use crate::source_tracking::SourceMap;
9use crate::source_tracking::filename::FileName;
10use crate::source_tracking::immutable_string::ImmutableString;
11use crate::source_tracking::{fragment::Fragment, source::SourceId};
12use codespan_reporting::diagnostic::Diagnostic as CRDiagnostic;
13use codespan_reporting::diagnostic::Label;
14use codespan_reporting::files::{Error as CRError, Files};
15use codespan_reporting::term::Config;
16use std::sync::Mutex;
17use termcolor::{ColorChoice, StandardStream, WriteColor};
18
19#[cfg(doc)]
20use crate::source_tracking::source::Source;
21
22// Publicly re-export codespan's severity type, since it's pretty much exactly what we want/use.
23pub use codespan_reporting::diagnostic::Severity;
24
25/// The style/priority applied to a [Highlight] being rendered.
26pub use codespan_reporting::diagnostic::LabelStyle;
27
28/// The global-static color choice for printing to the standard output.
29static STDOUT_COLOR_CHOICE: Mutex<ColorChoice> = Mutex::new(ColorChoice::Auto);
30
31/// Set the [ColorChoice] to use when printing [Diagnostic]s to the standard output.
32pub fn set_stdout_color(c: ColorChoice) {
33    *STDOUT_COLOR_CHOICE.lock().unwrap() = c;
34}
35
36/// Get the current [ColorChoice] used when printing [Diagnostic]s to the standard output.
37pub fn get_stdout_color() -> ColorChoice {
38    *STDOUT_COLOR_CHOICE.lock().unwrap()
39}
40
41/// Wright's [Diagnostic] type wraps one from [codespan_reporting] to make it compatible with
42/// things like [Fragment] and [SourceId].
43#[derive(Debug)]
44pub struct Diagnostic(pub CRDiagnostic<SourceId>);
45
46impl Diagnostic {
47    /// Construct a new [Diagnostic] with the given [Severity].
48    pub fn new(severity: Severity) -> Self {
49        Diagnostic(CRDiagnostic::new(severity))
50    }
51
52    /// Construct a new [Diagnostic] representing a wright compiler bug.
53    #[inline]
54    pub fn bug() -> Self {
55        Self::new(Severity::Bug)
56    }
57
58    /// Construct a new [Diagnostic] representing an error.
59    #[inline]
60    pub fn error() -> Self {
61        Self::new(Severity::Error)
62    }
63
64    /// Construct a new [Diagnostic] representing a warning.
65    #[inline]
66    pub fn warning() -> Self {
67        Self::new(Severity::Warning)
68    }
69
70    /// Construct a new [Diagnostic] representing a note.
71    #[inline]
72    pub fn note() -> Self {
73        Self::new(Severity::Note)
74    }
75
76    /// Construct a new [Diagnostic] representing a note to the user.
77    #[inline]
78    pub fn help() -> Self {
79        Self::new(Severity::Note)
80    }
81
82    /// Builder style function to set an error/warning code for this [Diagnostic].
83    pub fn with_code(self, code: impl Into<String>) -> Self {
84        Diagnostic(self.0.with_code(code))
85    }
86
87    /// Builder style function to set a message for this [Diagnostic].
88    pub fn with_message(self, message: impl Into<String>) -> Self {
89        Diagnostic(self.0.with_message(message))
90    }
91
92    /// Add all the notes from the given [Iterator] to this [Diagnostic].
93    pub fn with_notes<I: Into<String>>(mut self, notes: impl IntoIterator<Item = I>) -> Self {
94        self.0.notes.extend(notes.into_iter().map(Into::into));
95        self
96    }
97
98    /// Add all the [Highlight]s from a given [Iterator] to this [Diagnostic].
99    pub fn with_highlights(mut self, highlights: impl IntoIterator<Item = Highlight>) -> Self {
100        self.0.labels.extend(highlights.into_iter().map(Into::into));
101        self
102    }
103
104    /// Write this [Diagnostic] to a given [WriteColor]. This will error if any of the [Highlight]s are not in
105    /// the referenced [SourceMap], or if any were constructed from invalid [Fragment]s.
106    pub fn write(
107        &self,
108        map: &SourceMap,
109        writer: &mut dyn WriteColor,
110        config: &Config,
111    ) -> Result<(), CRError> {
112        codespan_reporting::term::emit(writer, config, map, &self.0)
113    }
114
115    /// Print this [Diagnostic] to the standard output. This locks the standard output until the diagnostic is printed.
116    /// This uses the global [get_stdout_color] function to determine whether or not to use colors while printing.
117    /// This uses the [Config::default] configuration from [codespan_reporting] when printing.
118    pub fn print(&self, map: &SourceMap) -> Result<(), codespan_reporting::files::Error> {
119        let stream = StandardStream::stdout(get_stdout_color());
120        let mut lock = stream.lock();
121        self.write(map, &mut lock, &Config::default())
122    }
123}
124
125/// A highlighted section of a [Source] that's used in a [Diagnostic].
126#[derive(Clone, Debug)]
127pub struct Highlight {
128    /// The style/importance of this [Highlight]. [Highlight]s with [LabelStyle::Primary] are given priority
129    /// when being displayed.
130    pub style: LabelStyle,
131    /// The [Fragment] containing the relevant section of code.
132    pub fragment: Fragment,
133    /// The message attached to this [Highlight]. This can be empty, in which case the [Fragment] will
134    /// just be underlined when displayed.
135    pub message: String,
136}
137
138impl Highlight {
139    /// Construct a new [Highlight] with [LabelStyle::Primary].
140    pub fn primary(fragment: Fragment, message: impl Into<String>) -> Self {
141        Highlight {
142            style: LabelStyle::Primary,
143            fragment,
144            message: message.into(),
145        }
146    }
147
148    /// Construct a new [Highlight] with [LabelStyle::Secondary].
149    pub fn secondary(fragment: Fragment, message: impl Into<String>) -> Self {
150        Highlight {
151            style: LabelStyle::Secondary,
152            fragment,
153            message: message.into(),
154        }
155    }
156
157    /// Builder style function to set the [Highlight::message].
158    pub fn with_message(mut self, message: impl Into<String>) -> Self {
159        self.message = message.into();
160        self
161    }
162}
163
164impl From<Highlight> for Label<SourceId> {
165    fn from(value: Highlight) -> Self {
166        Label {
167            style: value.style,
168            file_id: value.fragment.source.id,
169            range: value.fragment.range,
170            message: value.message,
171        }
172    }
173}
174
175impl<'f> Files<'f> for SourceMap {
176    type FileId = SourceId;
177
178    type Name = FileName;
179
180    type Source = ImmutableString;
181
182    fn name(&'f self, id: Self::FileId) -> Result<Self::Name, codespan_reporting::files::Error> {
183        self.get(id)
184            .map(|source| source.name().clone())
185            .ok_or(CRError::FileMissing)
186    }
187
188    fn source(
189        &'f self,
190        id: Self::FileId,
191    ) -> Result<Self::Source, codespan_reporting::files::Error> {
192        self.get(id)
193            .map(|source| source.source().clone())
194            .ok_or(CRError::FileMissing)
195    }
196
197    fn line_index(
198        &'f self,
199        id: Self::FileId,
200        byte_index: usize,
201    ) -> Result<usize, codespan_reporting::files::Error> {
202        Ok(self
203            .get(id)
204            .ok_or(CRError::FileMissing)?
205            .line_index(byte_index))
206    }
207
208    fn line_range(
209        &'f self,
210        id: Self::FileId,
211        line_index: usize,
212    ) -> Result<std::ops::Range<usize>, codespan_reporting::files::Error> {
213        Ok(self
214            .get(id)
215            .ok_or(CRError::FileMissing)?
216            .get_line(line_index)
217            .range)
218    }
219}
wright/reporting.rs

wright/
reporting.rs
