src/librustc_errors/diagnostic_builder.rs

   1 use crate::{Applicability, Handler, Level, StashKey};
   2 use crate::{Diagnostic, DiagnosticId, DiagnosticStyledString};
   3
   4 use rustc_span::{MultiSpan, Span};
   5 use std::fmt::{self, Debug};
   6 use std::ops::{Deref, DerefMut};
   7 use std::thread::panicking;
   8 use tracing::debug;
   9
  10 /// Used for emitting structured error messages and other diagnostic information.
  11 ///
  12 /// If there is some state in a downstream crate you would like to
  13 /// access in the methods of `DiagnosticBuilder` here, consider
  14 /// extending `HandlerFlags`, accessed via `self.handler.flags`.
  15 #[must_use]
  16 #[derive(Clone)]
  17 pub struct DiagnosticBuilder<'a>(Box<DiagnosticBuilderInner<'a>>);
  18
  19 /// This is a large type, and often used as a return value, especially within
  20 /// the frequently-used `PResult` type. In theory, return value optimization
  21 /// (RVO) should avoid unnecessary copying. In practice, it does not (at the
  22 /// time of writing). The split between `DiagnosticBuilder` and
  23 /// `DiagnosticBuilderInner` exists to avoid many `memcpy` calls.
  24 #[must_use]
  25 #[derive(Clone)]
  26 struct DiagnosticBuilderInner<'a> {
  27     handler: &'a Handler,
  28     diagnostic: Diagnostic,
  29     allow_suggestions: bool,
  30 }
  31
  32 /// In general, the `DiagnosticBuilder` uses deref to allow access to
  33 /// the fields and methods of the embedded `diagnostic` in a
  34 /// transparent way. *However,* many of the methods are intended to
  35 /// be used in a chained way, and hence ought to return `self`. In
  36 /// that case, we can't just naively forward to the method on the
  37 /// `diagnostic`, because the return type would be a `&Diagnostic`
  38 /// instead of a `&DiagnosticBuilder<'a>`. This `forward!` macro makes
  39 /// it easy to declare such methods on the builder.
  40 macro_rules! forward {
  41     // Forward pattern for &self -> &Self
  42     (
  43         $(#[$attrs:meta])*
  44         pub fn $n:ident(&self, $($name:ident: $ty:ty),* $(,)?) -> &Self
  45     ) => {
  46         $(#[$attrs])*
  47         pub fn $n(&self, $($name: $ty),*) -> &Self {
  48             self.diagnostic.$n($($name),*);
  49             self
  50         }
  51     };
  52
  53     // Forward pattern for &mut self -> &mut Self
  54     (
  55         $(#[$attrs:meta])*
  56         pub fn $n:ident(&mut self, $($name:ident: $ty:ty),* $(,)?) -> &mut Self
  57     ) => {
  58         $(#[$attrs])*
  59         pub fn $n(&mut self, $($name: $ty),*) -> &mut Self {
  60             self.0.diagnostic.$n($($name),*);
  61             self
  62         }
  63     };
  64
  65     // Forward pattern for &mut self -> &mut Self, with S: Into<MultiSpan>
  66     // type parameter. No obvious way to make this more generic.
  67     (
  68         $(#[$attrs:meta])*
  69         pub fn $n:ident<S: Into<MultiSpan>>(
  70             &mut self,
  71             $($name:ident: $ty:ty),*
  72             $(,)?
  73         ) -> &mut Self
  74     ) => {
  75         $(#[$attrs])*
  76         pub fn $n<S: Into<MultiSpan>>(&mut self, $($name: $ty),*) -> &mut Self {
  77             self.0.diagnostic.$n($($name),*);
  78             self
  79         }
  80     };
  81 }
  82
  83 impl<'a> Deref for DiagnosticBuilder<'a> {
  84     type Target = Diagnostic;
  85
  86     fn deref(&self) -> &Diagnostic {
  87         &self.0.diagnostic
  88     }
  89 }
  90
  91 impl<'a> DerefMut for DiagnosticBuilder<'a> {
  92     fn deref_mut(&mut self) -> &mut Diagnostic {
  93         &mut self.0.diagnostic
  94     }
  95 }
  96
  97 impl<'a> DiagnosticBuilder<'a> {
  98     /// Emit the diagnostic.
  99     pub fn emit(&mut self) {
 100         self.0.handler.emit_diagnostic(&self);
 101         self.cancel();
 102     }
 103
 104     /// Emit the diagnostic unless `delay` is true,
 105     /// in which case the emission will be delayed as a bug.
 106     ///
 107     /// See `emit` and `delay_as_bug` for details.
 108     pub fn emit_unless(&mut self, delay: bool) {
 109         if delay {
 110             self.delay_as_bug();
 111         } else {
 112             self.emit();
 113         }
 114     }
 115
 116     /// Stashes diagnostic for possible later improvement in a different,
 117     /// later stage of the compiler. The diagnostic can be accessed with
 118     /// the provided `span` and `key` through `.steal_diagnostic` on `Handler`.
 119     ///
 120     /// As with `buffer`, this is unless the handler has disabled such buffering.
 121     pub fn stash(self, span: Span, key: StashKey) {
 122         if let Some((diag, handler)) = self.into_diagnostic() {
 123             handler.stash_diagnostic(span, key, diag);
 124         }
 125     }
 126
 127     /// Converts the builder to a `Diagnostic` for later emission,
 128     /// unless handler has disabled such buffering.
 129     pub fn into_diagnostic(mut self) -> Option<(Diagnostic, &'a Handler)> {
 130         if self.0.handler.flags.dont_buffer_diagnostics
 131             || self.0.handler.flags.treat_err_as_bug.is_some()
 132         {
 133             self.emit();
 134             return None;
 135         }
 136
 137         let handler = self.0.handler;
 138
 139         // We must use `Level::Cancelled` for `dummy` to avoid an ICE about an
 140         // unused diagnostic.
 141         let dummy = Diagnostic::new(Level::Cancelled, "");
 142         let diagnostic = std::mem::replace(&mut self.0.diagnostic, dummy);
 143
 144         // Logging here is useful to help track down where in logs an error was
 145         // actually emitted.
 146         debug!("buffer: diagnostic={:?}", diagnostic);
 147
 148         Some((diagnostic, handler))
 149     }
 150
 151     /// Buffers the diagnostic for later emission,
 152     /// unless handler has disabled such buffering.
 153     pub fn buffer(self, buffered_diagnostics: &mut Vec<Diagnostic>) {
 154         buffered_diagnostics.extend(self.into_diagnostic().map(|(diag, _)| diag));
 155     }
 156
 157     /// Convenience function for internal use, clients should use one of the
 158     /// span_* methods instead.
 159     pub fn sub<S: Into<MultiSpan>>(
 160         &mut self,
 161         level: Level,
 162         message: &str,
 163         span: Option<S>,
 164     ) -> &mut Self {
 165         let span = span.map(|s| s.into()).unwrap_or_else(MultiSpan::new);
 166         self.0.diagnostic.sub(level, message, span, None);
 167         self
 168     }
 169
 170     /// Delay emission of this diagnostic as a bug.
 171     ///
 172     /// This can be useful in contexts where an error indicates a bug but
 173     /// typically this only happens when other compilation errors have already
 174     /// happened. In those cases this can be used to defer emission of this
 175     /// diagnostic as a bug in the compiler only if no other errors have been
 176     /// emitted.
 177     ///
 178     /// In the meantime, though, callsites are required to deal with the "bug"
 179     /// locally in whichever way makes the most sense.
 180     pub fn delay_as_bug(&mut self) {
 181         self.level = Level::Bug;
 182         self.0.handler.delay_as_bug(self.0.diagnostic.clone());
 183         self.cancel();
 184     }
 185
 186     /// Adds a span/label to be included in the resulting snippet.
 187     /// This is pushed onto the `MultiSpan` that was created when the
 188     /// diagnostic was first built. If you don't call this function at
 189     /// all, and you just supplied a `Span` to create the diagnostic,
 190     /// then the snippet will just include that `Span`, which is
 191     /// called the primary span.
 192     pub fn span_label(&mut self, span: Span, label: impl Into<String>) -> &mut Self {
 193         self.0.diagnostic.span_label(span, label);
 194         self
 195     }
 196
 197     /// Labels all the given spans with the provided label.
 198     /// See `span_label` for more information.
 199     pub fn span_labels(
 200         &mut self,
 201         spans: impl IntoIterator<Item = Span>,
 202         label: impl AsRef<str>,
 203     ) -> &mut Self {
 204         let label = label.as_ref();
 205         for span in spans {
 206             self.0.diagnostic.span_label(span, label);
 207         }
 208         self
 209     }
 210
 211     forward!(pub fn note_expected_found(
 212         &mut self,
 213         expected_label: &dyn fmt::Display,
 214         expected: DiagnosticStyledString,
 215         found_label: &dyn fmt::Display,
 216         found: DiagnosticStyledString,
 217     ) -> &mut Self);
 218
 219     forward!(pub fn note_expected_found_extra(
 220         &mut self,
 221         expected_label: &dyn fmt::Display,
 222         expected: DiagnosticStyledString,
 223         found_label: &dyn fmt::Display,
 224         found: DiagnosticStyledString,
 225         expected_extra: &dyn fmt::Display,
 226         found_extra: &dyn fmt::Display,
 227     ) -> &mut Self);
 228
 229     forward!(pub fn note_unsuccessfull_coercion(
 230         &mut self,
 231         expected: DiagnosticStyledString,
 232         found: DiagnosticStyledString,
 233     ) -> &mut Self);
 234
 235     forward!(pub fn note(&mut self, msg: &str) -> &mut Self);
 236     forward!(pub fn span_note<S: Into<MultiSpan>>(
 237         &mut self,
 238         sp: S,
 239         msg: &str,
 240     ) -> &mut Self);
 241     forward!(pub fn warn(&mut self, msg: &str) -> &mut Self);
 242     forward!(pub fn span_warn<S: Into<MultiSpan>>(&mut self, sp: S, msg: &str) -> &mut Self);
 243     forward!(pub fn help(&mut self, msg: &str) -> &mut Self);
 244     forward!(pub fn span_help<S: Into<MultiSpan>>(
 245         &mut self,
 246         sp: S,
 247         msg: &str,
 248     ) -> &mut Self);
 249
 250     pub fn multipart_suggestion(
 251         &mut self,
 252         msg: &str,
 253         suggestion: Vec<(Span, String)>,
 254         applicability: Applicability,
 255     ) -> &mut Self {
 256         if !self.0.allow_suggestions {
 257             return self;
 258         }
 259         self.0.diagnostic.multipart_suggestion(msg, suggestion, applicability);
 260         self
 261     }
 262
 263     pub fn multipart_suggestions(
 264         &mut self,
 265         msg: &str,
 266         suggestions: Vec<Vec<(Span, String)>>,
 267         applicability: Applicability,
 268     ) -> &mut Self {
 269         if !self.0.allow_suggestions {
 270             return self;
 271         }
 272         self.0.diagnostic.multipart_suggestions(msg, suggestions, applicability);
 273         self
 274     }
 275
 276     pub fn tool_only_multipart_suggestion(
 277         &mut self,
 278         msg: &str,
 279         suggestion: Vec<(Span, String)>,
 280         applicability: Applicability,
 281     ) -> &mut Self {
 282         if !self.0.allow_suggestions {
 283             return self;
 284         }
 285         self.0.diagnostic.tool_only_multipart_suggestion(msg, suggestion, applicability);
 286         self
 287     }
 288
 289     pub fn span_suggestion(
 290         &mut self,
 291         sp: Span,
 292         msg: &str,
 293         suggestion: String,
 294         applicability: Applicability,
 295     ) -> &mut Self {
 296         if !self.0.allow_suggestions {
 297             return self;
 298         }
 299         self.0.diagnostic.span_suggestion(sp, msg, suggestion, applicability);
 300         self
 301     }
 302
 303     pub fn span_suggestions(
 304         &mut self,
 305         sp: Span,
 306         msg: &str,
 307         suggestions: impl Iterator<Item = String>,
 308         applicability: Applicability,
 309     ) -> &mut Self {
 310         if !self.0.allow_suggestions {
 311             return self;
 312         }
 313         self.0.diagnostic.span_suggestions(sp, msg, suggestions, applicability);
 314         self
 315     }
 316
 317     pub fn span_suggestion_short(
 318         &mut self,
 319         sp: Span,
 320         msg: &str,
 321         suggestion: String,
 322         applicability: Applicability,
 323     ) -> &mut Self {
 324         if !self.0.allow_suggestions {
 325             return self;
 326         }
 327         self.0.diagnostic.span_suggestion_short(sp, msg, suggestion, applicability);
 328         self
 329     }
 330
 331     pub fn span_suggestion_verbose(
 332         &mut self,
 333         sp: Span,
 334         msg: &str,
 335         suggestion: String,
 336         applicability: Applicability,
 337     ) -> &mut Self {
 338         if !self.0.allow_suggestions {
 339             return self;
 340         }
 341         self.0.diagnostic.span_suggestion_verbose(sp, msg, suggestion, applicability);
 342         self
 343     }
 344
 345     pub fn span_suggestion_hidden(
 346         &mut self,
 347         sp: Span,
 348         msg: &str,
 349         suggestion: String,
 350         applicability: Applicability,
 351     ) -> &mut Self {
 352         if !self.0.allow_suggestions {
 353             return self;
 354         }
 355         self.0.diagnostic.span_suggestion_hidden(sp, msg, suggestion, applicability);
 356         self
 357     }
 358
 359     pub fn tool_only_span_suggestion(
 360         &mut self,
 361         sp: Span,
 362         msg: &str,
 363         suggestion: String,
 364         applicability: Applicability,
 365     ) -> &mut Self {
 366         if !self.0.allow_suggestions {
 367             return self;
 368         }
 369         self.0.diagnostic.tool_only_span_suggestion(sp, msg, suggestion, applicability);
 370         self
 371     }
 372
 373     forward!(pub fn set_span<S: Into<MultiSpan>>(&mut self, sp: S) -> &mut Self);
 374     forward!(pub fn code(&mut self, s: DiagnosticId) -> &mut Self);
 375
 376     pub fn allow_suggestions(&mut self, allow: bool) -> &mut Self {
 377         self.0.allow_suggestions = allow;
 378         self
 379     }
 380
 381     /// Convenience function for internal use, clients should use one of the
 382     /// struct_* methods on Handler.
 383     crate fn new(handler: &'a Handler, level: Level, message: &str) -> DiagnosticBuilder<'a> {
 384         DiagnosticBuilder::new_with_code(handler, level, None, message)
 385     }
 386
 387     /// Convenience function for internal use, clients should use one of the
 388     /// struct_* methods on Handler.
 389     crate fn new_with_code(
 390         handler: &'a Handler,
 391         level: Level,
 392         code: Option<DiagnosticId>,
 393         message: &str,
 394     ) -> DiagnosticBuilder<'a> {
 395         let diagnostic = Diagnostic::new_with_code(level, code, message);
 396         DiagnosticBuilder::new_diagnostic(handler, diagnostic)
 397     }
 398
 399     /// Creates a new `DiagnosticBuilder` with an already constructed
 400     /// diagnostic.
 401     crate fn new_diagnostic(handler: &'a Handler, diagnostic: Diagnostic) -> DiagnosticBuilder<'a> {
 402         debug!("Created new diagnostic");
 403         DiagnosticBuilder(Box::new(DiagnosticBuilderInner {
 404             handler,
 405             diagnostic,
 406             allow_suggestions: true,
 407         }))
 408     }
 409 }
 410
 411 impl<'a> Debug for DiagnosticBuilder<'a> {
 412     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 413         self.0.diagnostic.fmt(f)
 414     }
 415 }
 416
 417 /// Destructor bomb - a `DiagnosticBuilder` must be either emitted or canceled
 418 /// or we emit a bug.
 419 impl<'a> Drop for DiagnosticBuilder<'a> {
 420     fn drop(&mut self) {
 421         if !panicking() && !self.cancelled() {
 422             let mut db = DiagnosticBuilder::new(
 423                 self.0.handler,
 424                 Level::Bug,
 425                 "the following error was constructed but not emitted",
 426             );
 427             db.emit();
 428             self.emit();
 429             panic!();
 430         }
 431     }
 432 }
 433
 434 #[macro_export]
 435 macro_rules! struct_span_err {
 436     ($session:expr, $span:expr, $code:ident, $($message:tt)*) => ({
 437         $session.struct_span_err_with_code(
 438             $span,
 439             &format!($($message)*),
 440             $crate::error_code!($code),
 441         )
 442     })
 443 }
 444
 445 #[macro_export]
 446 macro_rules! error_code {
 447     ($code:ident) => {{ $crate::DiagnosticId::Error(stringify!($code).to_owned()) }};
 448 }