2 use crate::DiagnosticId;
3 use crate::DiagnosticStyledString;
4 use crate::Applicability;
8 use std::fmt::{self, Debug};
9 use std::ops::{Deref, DerefMut};
10 use std::thread::panicking;
11 use syntax_pos::{MultiSpan, Span};
14 /// Used for emitting structured error messages and other diagnostic information.
16 /// If there is some state in a downstream crate you would like to
17 /// access in the methods of `DiagnosticBuilder` here, consider
18 /// extending `HandlerFlags`, accessed via `self.handler.flags`.
21 pub struct DiagnosticBuilder<'a> {
22 pub handler: &'a Handler,
23 diagnostic: Diagnostic,
24 allow_suggestions: bool,
27 /// In general, the `DiagnosticBuilder` uses deref to allow access to
28 /// the fields and methods of the embedded `diagnostic` in a
29 /// transparent way. *However,* many of the methods are intended to
30 /// be used in a chained way, and hence ought to return `self`. In
31 /// that case, we can't just naively forward to the method on the
32 /// `diagnostic`, because the return type would be a `&Diagnostic`
33 /// instead of a `&DiagnosticBuilder<'a>`. This `forward!` macro makes
34 /// it easy to declare such methods on the builder.
35 macro_rules! forward {
36 // Forward pattern for &self -> &Self
39 pub fn $n:ident(&self, $($name:ident: $ty:ty),* $(,)?) -> &Self
42 pub fn $n(&self, $($name: $ty),*) -> &Self {
43 self.diagnostic.$n($($name),*);
48 // Forward pattern for &mut self -> &mut Self
51 pub fn $n:ident(&mut self, $($name:ident: $ty:ty),* $(,)?) -> &mut Self
54 pub fn $n(&mut self, $($name: $ty),*) -> &mut Self {
55 self.diagnostic.$n($($name),*);
60 // Forward pattern for &mut self -> &mut Self, with S: Into<MultiSpan>
61 // type parameter. No obvious way to make this more generic.
64 pub fn $n:ident<S: Into<MultiSpan>>(
66 $($name:ident: $ty:ty),*
71 pub fn $n<S: Into<MultiSpan>>(&mut self, $($name: $ty),*) -> &mut Self {
72 self.diagnostic.$n($($name),*);
78 impl<'a> Deref for DiagnosticBuilder<'a> {
79 type Target = Diagnostic;
81 fn deref(&self) -> &Diagnostic {
86 impl<'a> DerefMut for DiagnosticBuilder<'a> {
87 fn deref_mut(&mut self) -> &mut Diagnostic {
92 impl<'a> DiagnosticBuilder<'a> {
93 /// Emit the diagnostic.
94 pub fn emit(&mut self) {
99 self.handler.emit_db(&self);
103 /// Buffers the diagnostic for later emission, unless handler
104 /// has disabled such buffering.
105 pub fn buffer(mut self, buffered_diagnostics: &mut Vec<Diagnostic>) {
106 if self.handler.flags.dont_buffer_diagnostics ||
107 self.handler.flags.treat_err_as_bug.is_some()
113 // We need to use `ptr::read` because `DiagnosticBuilder`
114 // implements `Drop`.
117 diagnostic = std::ptr::read(&self.diagnostic);
118 std::mem::forget(self);
120 // Logging here is useful to help track down where in logs an error was
122 debug!("buffer: diagnostic={:?}", diagnostic);
123 buffered_diagnostics.push(diagnostic);
126 /// Convenience function for internal use, clients should use one of the
127 /// span_* methods instead.
128 pub fn sub<S: Into<MultiSpan>>(
134 let span = span.map(|s| s.into()).unwrap_or_else(|| MultiSpan::new());
135 self.diagnostic.sub(level, message, span, None);
139 /// Delay emission of this diagnostic as a bug.
141 /// This can be useful in contexts where an error indicates a bug but
142 /// typically this only happens when other compilation errors have already
143 /// happened. In those cases this can be used to defer emission of this
144 /// diagnostic as a bug in the compiler only if no other errors have been
147 /// In the meantime, though, callsites are required to deal with the "bug"
148 /// locally in whichever way makes the most sense.
149 pub fn delay_as_bug(&mut self) {
150 self.level = Level::Bug;
151 self.handler.delay_as_bug(self.diagnostic.clone());
155 /// Adds a span/label to be included in the resulting snippet.
156 /// This is pushed onto the `MultiSpan` that was created when the
157 /// diagnostic was first built. If you don't call this function at
158 /// all, and you just supplied a `Span` to create the diagnostic,
159 /// then the snippet will just include that `Span`, which is
160 /// called the primary span.
161 pub fn span_label<T: Into<String>>(&mut self, span: Span, label: T) -> &mut Self {
162 self.diagnostic.span_label(span, label);
166 forward!(pub fn note_expected_found(&mut self,
167 label: &dyn fmt::Display,
168 expected: DiagnosticStyledString,
169 found: DiagnosticStyledString,
172 forward!(pub fn note_expected_found_extra(&mut self,
173 label: &dyn fmt::Display,
174 expected: DiagnosticStyledString,
175 found: DiagnosticStyledString,
176 expected_extra: &dyn fmt::Display,
177 found_extra: &dyn fmt::Display,
180 forward!(pub fn note(&mut self, msg: &str) -> &mut Self);
181 forward!(pub fn span_note<S: Into<MultiSpan>>(&mut self,
185 forward!(pub fn warn(&mut self, msg: &str) -> &mut Self);
186 forward!(pub fn span_warn<S: Into<MultiSpan>>(&mut self, sp: S, msg: &str) -> &mut Self);
187 forward!(pub fn help(&mut self , msg: &str) -> &mut Self);
188 forward!(pub fn span_help<S: Into<MultiSpan>>(&mut self,
193 pub fn multipart_suggestion(
196 suggestion: Vec<(Span, String)>,
197 applicability: Applicability,
199 if !self.allow_suggestions {
202 self.diagnostic.multipart_suggestion(
210 pub fn tool_only_multipart_suggestion(
213 suggestion: Vec<(Span, String)>,
214 applicability: Applicability,
216 if !self.allow_suggestions {
219 self.diagnostic.tool_only_multipart_suggestion(
228 pub fn span_suggestion(
233 applicability: Applicability,
235 if !self.allow_suggestions {
238 self.diagnostic.span_suggestion(
247 pub fn span_suggestions(
251 suggestions: impl Iterator<Item = String>,
252 applicability: Applicability,
254 if !self.allow_suggestions {
257 self.diagnostic.span_suggestions(
266 pub fn span_suggestion_short(
271 applicability: Applicability,
273 if !self.allow_suggestions {
276 self.diagnostic.span_suggestion_short(
285 pub fn span_suggestion_hidden(
290 applicability: Applicability,
292 if !self.allow_suggestions {
295 self.diagnostic.span_suggestion_hidden(
304 pub fn tool_only_span_suggestion(
309 applicability: Applicability,
311 if !self.allow_suggestions {
314 self.diagnostic.tool_only_span_suggestion(
323 forward!(pub fn set_span<S: Into<MultiSpan>>(&mut self, sp: S) -> &mut Self);
324 forward!(pub fn code(&mut self, s: DiagnosticId) -> &mut Self);
326 pub fn allow_suggestions(&mut self, allow: bool) -> &mut Self {
327 self.allow_suggestions = allow;
331 /// Convenience function for internal use, clients should use one of the
332 /// struct_* methods on Handler.
333 pub fn new(handler: &'a Handler, level: Level, message: &str) -> DiagnosticBuilder<'a> {
334 DiagnosticBuilder::new_with_code(handler, level, None, message)
337 /// Convenience function for internal use, clients should use one of the
338 /// struct_* methods on Handler.
339 pub fn new_with_code(handler: &'a Handler,
341 code: Option<DiagnosticId>,
343 -> DiagnosticBuilder<'a> {
344 let diagnostic = Diagnostic::new_with_code(level, code, message);
345 DiagnosticBuilder::new_diagnostic(handler, diagnostic)
348 /// Creates a new `DiagnosticBuilder` with an already constructed
350 pub fn new_diagnostic(handler: &'a Handler, diagnostic: Diagnostic)
351 -> DiagnosticBuilder<'a> {
355 allow_suggestions: true,
360 impl<'a> Debug for DiagnosticBuilder<'a> {
361 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
362 self.diagnostic.fmt(f)
366 /// Destructor bomb - a `DiagnosticBuilder` must be either emitted or canceled
367 /// or we emit a bug.
368 impl<'a> Drop for DiagnosticBuilder<'a> {
370 if !panicking() && !self.cancelled() {
371 let mut db = DiagnosticBuilder::new(self.handler,
373 "Error constructed but not emitted");