compiler/rustc_errors/src/diagnostic_builder.rs

   1 use crate::diagnostic::IntoDiagnosticArg;
   2 use crate::{
   3     Diagnostic, DiagnosticId, DiagnosticMessage, DiagnosticStyledString, ErrorGuaranteed,
   4     ExplicitBug, SubdiagnosticMessage,
   5 };
   6 use crate::{Handler, Level, MultiSpan, StashKey};
   7 use rustc_lint_defs::Applicability;
   8 use rustc_span::source_map::Spanned;
   9
  10 use rustc_span::Span;
  11 use std::borrow::Cow;
  12 use std::fmt::{self, Debug};
  13 use std::marker::PhantomData;
  14 use std::ops::{Deref, DerefMut};
  15 use std::panic;
  16 use std::thread::panicking;
  17
  18 /// Trait implemented by error types. This should not be implemented manually. Instead, use
  19 /// `#[derive(Diagnostic)]` -- see [rustc_macros::Diagnostic].
  20 #[rustc_diagnostic_item = "IntoDiagnostic"]
  21 pub trait IntoDiagnostic<'a, T: EmissionGuarantee = ErrorGuaranteed> {
  22     /// Write out as a diagnostic out of `Handler`.
  23     #[must_use]
  24     fn into_diagnostic(self, handler: &'a Handler) -> DiagnosticBuilder<'a, T>;
  25 }
  26
  27 impl<'a, T, E> IntoDiagnostic<'a, E> for Spanned<T>
  28 where
  29     T: IntoDiagnostic<'a, E>,
  30     E: EmissionGuarantee,
  31 {
  32     fn into_diagnostic(self, handler: &'a Handler) -> DiagnosticBuilder<'a, E> {
  33         let mut diag = self.node.into_diagnostic(handler);
  34         diag.set_span(self.span);
  35         diag
  36     }
  37 }
  38
  39 /// Used for emitting structured error messages and other diagnostic information.
  40 ///
  41 /// If there is some state in a downstream crate you would like to
  42 /// access in the methods of `DiagnosticBuilder` here, consider
  43 /// extending `HandlerFlags`, accessed via `self.handler.flags`.
  44 #[must_use]
  45 #[derive(Clone)]
  46 pub struct DiagnosticBuilder<'a, G: EmissionGuarantee> {
  47     inner: DiagnosticBuilderInner<'a>,
  48     _marker: PhantomData<G>,
  49 }
  50
  51 /// This type exists only for `DiagnosticBuilder::forget_guarantee`, because it:
  52 /// 1. lacks the `G` parameter and therefore `DiagnosticBuilder<G1>` can be
  53 ///    converted into `DiagnosticBuilder<G2>` while reusing the `inner` field
  54 /// 2. can implement the `Drop` "bomb" instead of `DiagnosticBuilder`, as it
  55 ///    contains all of the data (`state` + `diagnostic`) of `DiagnosticBuilder`
  56 ///
  57 /// The `diagnostic` field is not `Copy` and can't be moved out of whichever
  58 /// type implements the `Drop` "bomb", but because of the above two facts, that
  59 /// never needs to happen - instead, the whole `inner: DiagnosticBuilderInner`
  60 /// can be moved out of a `DiagnosticBuilder` and into another.
  61 #[must_use]
  62 #[derive(Clone)]
  63 struct DiagnosticBuilderInner<'a> {
  64     state: DiagnosticBuilderState<'a>,
  65
  66     /// `Diagnostic` is a large type, and `DiagnosticBuilder` is often used as a
  67     /// return value, especially within the frequently-used `PResult` type.
  68     /// In theory, return value optimization (RVO) should avoid unnecessary
  69     /// copying. In practice, it does not (at the time of writing).
  70     diagnostic: Box<Diagnostic>,
  71 }
  72
  73 #[derive(Clone)]
  74 enum DiagnosticBuilderState<'a> {
  75     /// Initial state of a `DiagnosticBuilder`, before `.emit()` or `.cancel()`.
  76     ///
  77     /// The `Diagnostic` will be emitted through this `Handler`.
  78     Emittable(&'a Handler),
  79
  80     /// State of a `DiagnosticBuilder`, after `.emit()` or *during* `.cancel()`.
  81     ///
  82     /// The `Diagnostic` will be ignored when calling `.emit()`, and it can be
  83     /// assumed that `.emit()` was previously called, to end up in this state.
  84     ///
  85     /// While this is also used by `.cancel()`, this state is only observed by
  86     /// the `Drop` `impl` of `DiagnosticBuilderInner`, as `.cancel()` takes
  87     /// `self` by-value specifically to prevent any attempts to `.emit()`.
  88     ///
  89     // FIXME(eddyb) currently this doesn't prevent extending the `Diagnostic`,
  90     // despite that being potentially lossy, if important information is added
  91     // *after* the original `.emit()` call.
  92     AlreadyEmittedOrDuringCancellation,
  93 }
  94
  95 // `DiagnosticBuilderState` should be pointer-sized.
  96 rustc_data_structures::static_assert_size!(
  97     DiagnosticBuilderState<'_>,
  98     std::mem::size_of::<&Handler>()
  99 );
 100
 101 /// Trait for types that `DiagnosticBuilder::emit` can return as a "guarantee"
 102 /// (or "proof") token that the emission happened.
 103 pub trait EmissionGuarantee: Sized {
 104     /// Implementation of `DiagnosticBuilder::emit`, fully controlled by each
 105     /// `impl` of `EmissionGuarantee`, to make it impossible to create a value
 106     /// of `Self` without actually performing the emission.
 107     #[track_caller]
 108     fn diagnostic_builder_emit_producing_guarantee(db: &mut DiagnosticBuilder<'_, Self>) -> Self;
 109
 110     /// Creates a new `DiagnosticBuilder` that will return this type of guarantee.
 111     #[track_caller]
 112     fn make_diagnostic_builder(
 113         handler: &Handler,
 114         msg: impl Into<DiagnosticMessage>,
 115     ) -> DiagnosticBuilder<'_, Self>;
 116 }
 117
 118 /// Private module for sealing the `IsError` helper trait.
 119 mod sealed_level_is_error {
 120     use crate::Level;
 121
 122     /// Sealed helper trait for statically checking that a `Level` is an error.
 123     pub(crate) trait IsError<const L: Level> {}
 124
 125     impl IsError<{ Level::Bug }> for () {}
 126     impl IsError<{ Level::DelayedBug }> for () {}
 127     impl IsError<{ Level::Fatal }> for () {}
 128     // NOTE(eddyb) `Level::Error { lint: true }` is also an error, but lints
 129     // don't need error guarantees, as their levels are always dynamic.
 130     impl IsError<{ Level::Error { lint: false } }> for () {}
 131 }
 132
 133 impl<'a> DiagnosticBuilder<'a, ErrorGuaranteed> {
 134     /// Convenience function for internal use, clients should use one of the
 135     /// `struct_*` methods on [`Handler`].
 136     #[track_caller]
 137     pub(crate) fn new_guaranteeing_error<M: Into<DiagnosticMessage>, const L: Level>(
 138         handler: &'a Handler,
 139         message: M,
 140     ) -> Self
 141     where
 142         (): sealed_level_is_error::IsError<L>,
 143     {
 144         Self {
 145             inner: DiagnosticBuilderInner {
 146                 state: DiagnosticBuilderState::Emittable(handler),
 147                 diagnostic: Box::new(Diagnostic::new_with_code(L, None, message)),
 148             },
 149             _marker: PhantomData,
 150         }
 151     }
 152
 153     /// Discard the guarantee `.emit()` would return, in favor of having the
 154     /// type `DiagnosticBuilder<'a, ()>`. This may be necessary whenever there
 155     /// is a common codepath handling both errors and warnings.
 156     pub fn forget_guarantee(self) -> DiagnosticBuilder<'a, ()> {
 157         DiagnosticBuilder { inner: self.inner, _marker: PhantomData }
 158     }
 159 }
 160
 161 // FIXME(eddyb) make `ErrorGuaranteed` impossible to create outside `.emit()`.
 162 impl EmissionGuarantee for ErrorGuaranteed {
 163     fn diagnostic_builder_emit_producing_guarantee(db: &mut DiagnosticBuilder<'_, Self>) -> Self {
 164         match db.inner.state {
 165             // First `.emit()` call, the `&Handler` is still available.
 166             DiagnosticBuilderState::Emittable(handler) => {
 167                 db.inner.state = DiagnosticBuilderState::AlreadyEmittedOrDuringCancellation;
 168
 169                 let guar = handler.emit_diagnostic(&mut db.inner.diagnostic);
 170
 171                 // Only allow a guarantee if the `level` wasn't switched to a
 172                 // non-error - the field isn't `pub`, but the whole `Diagnostic`
 173                 // can be overwritten with a new one, thanks to `DerefMut`.
 174                 assert!(
 175                     db.inner.diagnostic.is_error(),
 176                     "emitted non-error ({:?}) diagnostic \
 177                      from `DiagnosticBuilder<ErrorGuaranteed>`",
 178                     db.inner.diagnostic.level,
 179                 );
 180                 guar.unwrap()
 181             }
 182             // `.emit()` was previously called, disallowed from repeating it,
 183             // but can take advantage of the previous `.emit()`'s guarantee
 184             // still being applicable (i.e. as a form of idempotency).
 185             DiagnosticBuilderState::AlreadyEmittedOrDuringCancellation => {
 186                 // Only allow a guarantee if the `level` wasn't switched to a
 187                 // non-error - the field isn't `pub`, but the whole `Diagnostic`
 188                 // can be overwritten with a new one, thanks to `DerefMut`.
 189                 assert!(
 190                     db.inner.diagnostic.is_error(),
 191                     "`DiagnosticBuilder<ErrorGuaranteed>`'s diagnostic \
 192                      became non-error ({:?}), after original `.emit()`",
 193                     db.inner.diagnostic.level,
 194                 );
 195                 ErrorGuaranteed::unchecked_claim_error_was_emitted()
 196             }
 197         }
 198     }
 199
 200     #[track_caller]
 201     fn make_diagnostic_builder(
 202         handler: &Handler,
 203         msg: impl Into<DiagnosticMessage>,
 204     ) -> DiagnosticBuilder<'_, Self> {
 205         DiagnosticBuilder::new_guaranteeing_error::<_, { Level::Error { lint: false } }>(
 206             handler, msg,
 207         )
 208     }
 209 }
 210
 211 impl<'a> DiagnosticBuilder<'a, ()> {
 212     /// Convenience function for internal use, clients should use one of the
 213     /// `struct_*` methods on [`Handler`].
 214     #[track_caller]
 215     pub(crate) fn new<M: Into<DiagnosticMessage>>(
 216         handler: &'a Handler,
 217         level: Level,
 218         message: M,
 219     ) -> Self {
 220         let diagnostic = Diagnostic::new_with_code(level, None, message);
 221         Self::new_diagnostic(handler, diagnostic)
 222     }
 223
 224     /// Creates a new `DiagnosticBuilder` with an already constructed
 225     /// diagnostic.
 226     #[track_caller]
 227     pub(crate) fn new_diagnostic(handler: &'a Handler, diagnostic: Diagnostic) -> Self {
 228         debug!("Created new diagnostic");
 229         Self {
 230             inner: DiagnosticBuilderInner {
 231                 state: DiagnosticBuilderState::Emittable(handler),
 232                 diagnostic: Box::new(diagnostic),
 233             },
 234             _marker: PhantomData,
 235         }
 236     }
 237 }
 238
 239 // FIXME(eddyb) should there be a `Option<ErrorGuaranteed>` impl as well?
 240 impl EmissionGuarantee for () {
 241     fn diagnostic_builder_emit_producing_guarantee(db: &mut DiagnosticBuilder<'_, Self>) -> Self {
 242         match db.inner.state {
 243             // First `.emit()` call, the `&Handler` is still available.
 244             DiagnosticBuilderState::Emittable(handler) => {
 245                 db.inner.state = DiagnosticBuilderState::AlreadyEmittedOrDuringCancellation;
 246
 247                 handler.emit_diagnostic(&mut db.inner.diagnostic);
 248             }
 249             // `.emit()` was previously called, disallowed from repeating it.
 250             DiagnosticBuilderState::AlreadyEmittedOrDuringCancellation => {}
 251         }
 252     }
 253
 254     fn make_diagnostic_builder(
 255         handler: &Handler,
 256         msg: impl Into<DiagnosticMessage>,
 257     ) -> DiagnosticBuilder<'_, Self> {
 258         DiagnosticBuilder::new(handler, Level::Warning(None), msg)
 259     }
 260 }
 261
 262 /// Marker type which enables implementation of `create_note` and `emit_note` functions for
 263 /// note-without-error struct diagnostics.
 264 #[derive(Copy, Clone)]
 265 pub struct Noted;
 266
 267 impl<'a> DiagnosticBuilder<'a, Noted> {
 268     /// Convenience function for internal use, clients should use one of the
 269     /// `struct_*` methods on [`Handler`].
 270     pub(crate) fn new_note(handler: &'a Handler, message: impl Into<DiagnosticMessage>) -> Self {
 271         let diagnostic = Diagnostic::new_with_code(Level::Note, None, message);
 272         Self::new_diagnostic_note(handler, diagnostic)
 273     }
 274
 275     /// Creates a new `DiagnosticBuilder` with an already constructed
 276     /// diagnostic.
 277     pub(crate) fn new_diagnostic_note(handler: &'a Handler, diagnostic: Diagnostic) -> Self {
 278         debug!("Created new diagnostic");
 279         Self {
 280             inner: DiagnosticBuilderInner {
 281                 state: DiagnosticBuilderState::Emittable(handler),
 282                 diagnostic: Box::new(diagnostic),
 283             },
 284             _marker: PhantomData,
 285         }
 286     }
 287 }
 288
 289 impl EmissionGuarantee for Noted {
 290     fn diagnostic_builder_emit_producing_guarantee(db: &mut DiagnosticBuilder<'_, Self>) -> Self {
 291         match db.inner.state {
 292             // First `.emit()` call, the `&Handler` is still available.
 293             DiagnosticBuilderState::Emittable(handler) => {
 294                 db.inner.state = DiagnosticBuilderState::AlreadyEmittedOrDuringCancellation;
 295                 handler.emit_diagnostic(&mut db.inner.diagnostic);
 296             }
 297             // `.emit()` was previously called, disallowed from repeating it.
 298             DiagnosticBuilderState::AlreadyEmittedOrDuringCancellation => {}
 299         }
 300
 301         Noted
 302     }
 303
 304     fn make_diagnostic_builder(
 305         handler: &Handler,
 306         msg: impl Into<DiagnosticMessage>,
 307     ) -> DiagnosticBuilder<'_, Self> {
 308         DiagnosticBuilder::new_note(handler, msg)
 309     }
 310 }
 311
 312 /// Marker type which enables implementation of `create_bug` and `emit_bug` functions for
 313 /// bug struct diagnostics.
 314 #[derive(Copy, Clone)]
 315 pub struct Bug;
 316
 317 impl<'a> DiagnosticBuilder<'a, Bug> {
 318     /// Convenience function for internal use, clients should use one of the
 319     /// `struct_*` methods on [`Handler`].
 320     #[track_caller]
 321     pub(crate) fn new_bug(handler: &'a Handler, message: impl Into<DiagnosticMessage>) -> Self {
 322         let diagnostic = Diagnostic::new_with_code(Level::Bug, None, message);
 323         Self::new_diagnostic_bug(handler, diagnostic)
 324     }
 325
 326     /// Creates a new `DiagnosticBuilder` with an already constructed
 327     /// diagnostic.
 328     pub(crate) fn new_diagnostic_bug(handler: &'a Handler, diagnostic: Diagnostic) -> Self {
 329         debug!("Created new diagnostic bug");
 330         Self {
 331             inner: DiagnosticBuilderInner {
 332                 state: DiagnosticBuilderState::Emittable(handler),
 333                 diagnostic: Box::new(diagnostic),
 334             },
 335             _marker: PhantomData,
 336         }
 337     }
 338 }
 339
 340 impl EmissionGuarantee for Bug {
 341     fn diagnostic_builder_emit_producing_guarantee(db: &mut DiagnosticBuilder<'_, Self>) -> Self {
 342         match db.inner.state {
 343             // First `.emit()` call, the `&Handler` is still available.
 344             DiagnosticBuilderState::Emittable(handler) => {
 345                 db.inner.state = DiagnosticBuilderState::AlreadyEmittedOrDuringCancellation;
 346
 347                 handler.emit_diagnostic(&mut db.inner.diagnostic);
 348             }
 349             // `.emit()` was previously called, disallowed from repeating it.
 350             DiagnosticBuilderState::AlreadyEmittedOrDuringCancellation => {}
 351         }
 352         // Then panic. No need to return the marker type.
 353         panic::panic_any(ExplicitBug);
 354     }
 355
 356     fn make_diagnostic_builder(
 357         handler: &Handler,
 358         msg: impl Into<DiagnosticMessage>,
 359     ) -> DiagnosticBuilder<'_, Self> {
 360         DiagnosticBuilder::new_bug(handler, msg)
 361     }
 362 }
 363
 364 impl<'a> DiagnosticBuilder<'a, !> {
 365     /// Convenience function for internal use, clients should use one of the
 366     /// `struct_*` methods on [`Handler`].
 367     #[track_caller]
 368     pub(crate) fn new_fatal(handler: &'a Handler, message: impl Into<DiagnosticMessage>) -> Self {
 369         let diagnostic = Diagnostic::new_with_code(Level::Fatal, None, message);
 370         Self::new_diagnostic_fatal(handler, diagnostic)
 371     }
 372
 373     /// Creates a new `DiagnosticBuilder` with an already constructed
 374     /// diagnostic.
 375     pub(crate) fn new_diagnostic_fatal(handler: &'a Handler, diagnostic: Diagnostic) -> Self {
 376         debug!("Created new diagnostic");
 377         Self {
 378             inner: DiagnosticBuilderInner {
 379                 state: DiagnosticBuilderState::Emittable(handler),
 380                 diagnostic: Box::new(diagnostic),
 381             },
 382             _marker: PhantomData,
 383         }
 384     }
 385 }
 386
 387 impl EmissionGuarantee for ! {
 388     fn diagnostic_builder_emit_producing_guarantee(db: &mut DiagnosticBuilder<'_, Self>) -> Self {
 389         match db.inner.state {
 390             // First `.emit()` call, the `&Handler` is still available.
 391             DiagnosticBuilderState::Emittable(handler) => {
 392                 db.inner.state = DiagnosticBuilderState::AlreadyEmittedOrDuringCancellation;
 393
 394                 handler.emit_diagnostic(&mut db.inner.diagnostic);
 395             }
 396             // `.emit()` was previously called, disallowed from repeating it.
 397             DiagnosticBuilderState::AlreadyEmittedOrDuringCancellation => {}
 398         }
 399         // Then fatally error, returning `!`
 400         crate::FatalError.raise()
 401     }
 402
 403     fn make_diagnostic_builder(
 404         handler: &Handler,
 405         msg: impl Into<DiagnosticMessage>,
 406     ) -> DiagnosticBuilder<'_, Self> {
 407         DiagnosticBuilder::new_fatal(handler, msg)
 408     }
 409 }
 410
 411 /// In general, the `DiagnosticBuilder` uses deref to allow access to
 412 /// the fields and methods of the embedded `diagnostic` in a
 413 /// transparent way. *However,* many of the methods are intended to
 414 /// be used in a chained way, and hence ought to return `self`. In
 415 /// that case, we can't just naively forward to the method on the
 416 /// `diagnostic`, because the return type would be a `&Diagnostic`
 417 /// instead of a `&DiagnosticBuilder<'a>`. This `forward!` macro makes
 418 /// it easy to declare such methods on the builder.
 419 macro_rules! forward {
 420     // Forward pattern for &mut self -> &mut Self
 421     (
 422         $(#[$attrs:meta])*
 423         pub fn $n:ident(&mut self, $($name:ident: $ty:ty),* $(,)?) -> &mut Self
 424     ) => {
 425         $(#[$attrs])*
 426         #[doc = concat!("See [`Diagnostic::", stringify!($n), "()`].")]
 427         pub fn $n(&mut self, $($name: $ty),*) -> &mut Self {
 428             self.inner.diagnostic.$n($($name),*);
 429             self
 430         }
 431     };
 432 }
 433
 434 impl<G: EmissionGuarantee> Deref for DiagnosticBuilder<'_, G> {
 435     type Target = Diagnostic;
 436
 437     fn deref(&self) -> &Diagnostic {
 438         &self.inner.diagnostic
 439     }
 440 }
 441
 442 impl<G: EmissionGuarantee> DerefMut for DiagnosticBuilder<'_, G> {
 443     fn deref_mut(&mut self) -> &mut Diagnostic {
 444         &mut self.inner.diagnostic
 445     }
 446 }
 447
 448 impl<'a, G: EmissionGuarantee> DiagnosticBuilder<'a, G> {
 449     /// Emit the diagnostic.
 450     #[track_caller]
 451     pub fn emit(&mut self) -> G {
 452         G::diagnostic_builder_emit_producing_guarantee(self)
 453     }
 454
 455     /// Emit the diagnostic unless `delay` is true,
 456     /// in which case the emission will be delayed as a bug.
 457     ///
 458     /// See `emit` and `delay_as_bug` for details.
 459     #[track_caller]
 460     pub fn emit_unless(&mut self, delay: bool) -> G {
 461         if delay {
 462             self.downgrade_to_delayed_bug();
 463         }
 464         self.emit()
 465     }
 466
 467     /// Cancel the diagnostic (a structured diagnostic must either be emitted or
 468     /// cancelled or it will panic when dropped).
 469     ///
 470     /// This method takes `self` by-value to disallow calling `.emit()` on it,
 471     /// which may be expected to *guarantee* the emission of an error, either
 472     /// at the time of the call, or through a prior `.emit()` call.
 473     pub fn cancel(mut self) {
 474         self.inner.state = DiagnosticBuilderState::AlreadyEmittedOrDuringCancellation;
 475         drop(self);
 476     }
 477
 478     /// Stashes diagnostic for possible later improvement in a different,
 479     /// later stage of the compiler. The diagnostic can be accessed with
 480     /// the provided `span` and `key` through [`Handler::steal_diagnostic()`].
 481     ///
 482     /// As with `buffer`, this is unless the handler has disabled such buffering.
 483     pub fn stash(self, span: Span, key: StashKey) {
 484         if let Some((diag, handler)) = self.into_diagnostic() {
 485             handler.stash_diagnostic(span, key, diag);
 486         }
 487     }
 488
 489     /// Converts the builder to a `Diagnostic` for later emission,
 490     /// unless handler has disabled such buffering, or `.emit()` was called.
 491     pub fn into_diagnostic(mut self) -> Option<(Diagnostic, &'a Handler)> {
 492         let handler = match self.inner.state {
 493             // No `.emit()` calls, the `&Handler` is still available.
 494             DiagnosticBuilderState::Emittable(handler) => handler,
 495             // `.emit()` was previously called, nothing we can do.
 496             DiagnosticBuilderState::AlreadyEmittedOrDuringCancellation => {
 497                 return None;
 498             }
 499         };
 500
 501         if handler.flags.dont_buffer_diagnostics || handler.flags.treat_err_as_bug.is_some() {
 502             self.emit();
 503             return None;
 504         }
 505
 506         // Take the `Diagnostic` by replacing it with a dummy.
 507         let dummy = Diagnostic::new(Level::Allow, DiagnosticMessage::Str("".to_string()));
 508         let diagnostic = std::mem::replace(&mut *self.inner.diagnostic, dummy);
 509
 510         // Disable the ICE on `Drop`.
 511         self.cancel();
 512
 513         // Logging here is useful to help track down where in logs an error was
 514         // actually emitted.
 515         debug!("buffer: diagnostic={:?}", diagnostic);
 516
 517         Some((diagnostic, handler))
 518     }
 519
 520     /// Buffers the diagnostic for later emission,
 521     /// unless handler has disabled such buffering.
 522     pub fn buffer(self, buffered_diagnostics: &mut Vec<Diagnostic>) {
 523         buffered_diagnostics.extend(self.into_diagnostic().map(|(diag, _)| diag));
 524     }
 525
 526     /// Delay emission of this diagnostic as a bug.
 527     ///
 528     /// This can be useful in contexts where an error indicates a bug but
 529     /// typically this only happens when other compilation errors have already
 530     /// happened. In those cases this can be used to defer emission of this
 531     /// diagnostic as a bug in the compiler only if no other errors have been
 532     /// emitted.
 533     ///
 534     /// In the meantime, though, callsites are required to deal with the "bug"
 535     /// locally in whichever way makes the most sense.
 536     #[track_caller]
 537     pub fn delay_as_bug(&mut self) -> G {
 538         self.downgrade_to_delayed_bug();
 539         self.emit()
 540     }
 541
 542     forward!(
 543         #[track_caller]
 544         pub fn downgrade_to_delayed_bug(&mut self,) -> &mut Self
 545     );
 546
 547     forward!(
 548     /// Appends a labeled span to the diagnostic.
 549     ///
 550     /// Labels are used to convey additional context for the diagnostic's primary span. They will
 551     /// be shown together with the original diagnostic's span, *not* with spans added by
 552     /// `span_note`, `span_help`, etc. Therefore, if the primary span is not displayable (because
 553     /// the span is `DUMMY_SP` or the source code isn't found), labels will not be displayed
 554     /// either.
 555     ///
 556     /// Implementation-wise, the label span is pushed onto the [`MultiSpan`] that was created when
 557     /// the diagnostic was constructed. However, the label span is *not* considered a
 558     /// ["primary span"][`MultiSpan`]; only the `Span` supplied when creating the diagnostic is
 559     /// primary.
 560     pub fn span_label(&mut self, span: Span, label: impl Into<SubdiagnosticMessage>) -> &mut Self);
 561
 562     forward!(
 563     /// Labels all the given spans with the provided label.
 564     /// See [`Diagnostic::span_label()`] for more information.
 565     pub fn span_labels(
 566         &mut self,
 567         spans: impl IntoIterator<Item = Span>,
 568         label: impl AsRef<str>,
 569     ) -> &mut Self);
 570
 571     forward!(pub fn note_expected_found(
 572         &mut self,
 573         expected_label: &dyn fmt::Display,
 574         expected: DiagnosticStyledString,
 575         found_label: &dyn fmt::Display,
 576         found: DiagnosticStyledString,
 577     ) -> &mut Self);
 578
 579     forward!(pub fn note_expected_found_extra(
 580         &mut self,
 581         expected_label: &dyn fmt::Display,
 582         expected: DiagnosticStyledString,
 583         found_label: &dyn fmt::Display,
 584         found: DiagnosticStyledString,
 585         expected_extra: &dyn fmt::Display,
 586         found_extra: &dyn fmt::Display,
 587     ) -> &mut Self);
 588
 589     forward!(pub fn note_unsuccessful_coercion(
 590         &mut self,
 591         expected: DiagnosticStyledString,
 592         found: DiagnosticStyledString,
 593     ) -> &mut Self);
 594
 595     forward!(pub fn note(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self);
 596     forward!(pub fn note_once(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self);
 597     forward!(pub fn span_note(
 598         &mut self,
 599         sp: impl Into<MultiSpan>,
 600         msg: impl Into<SubdiagnosticMessage>,
 601     ) -> &mut Self);
 602     forward!(pub fn span_note_once(
 603         &mut self,
 604         sp: impl Into<MultiSpan>,
 605         msg: impl Into<SubdiagnosticMessage>,
 606     ) -> &mut Self);
 607     forward!(pub fn warn(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self);
 608     forward!(pub fn span_warn(
 609         &mut self,
 610         sp: impl Into<MultiSpan>,
 611         msg: impl Into<SubdiagnosticMessage>,
 612     ) -> &mut Self);
 613     forward!(pub fn help(&mut self, msg: impl Into<SubdiagnosticMessage>) -> &mut Self);
 614     forward!(pub fn span_help(
 615         &mut self,
 616         sp: impl Into<MultiSpan>,
 617         msg: impl Into<SubdiagnosticMessage>,
 618     ) -> &mut Self);
 619     forward!(pub fn help_use_latest_edition(&mut self,) -> &mut Self);
 620     forward!(pub fn set_is_lint(&mut self,) -> &mut Self);
 621
 622     forward!(pub fn disable_suggestions(&mut self,) -> &mut Self);
 623     forward!(pub fn clear_suggestions(&mut self,) -> &mut Self);
 624
 625     forward!(pub fn multipart_suggestion(
 626         &mut self,
 627         msg: impl Into<SubdiagnosticMessage>,
 628         suggestion: Vec<(Span, String)>,
 629         applicability: Applicability,
 630     ) -> &mut Self);
 631     forward!(pub fn multipart_suggestion_verbose(
 632         &mut self,
 633         msg: impl Into<SubdiagnosticMessage>,
 634         suggestion: Vec<(Span, String)>,
 635         applicability: Applicability,
 636     ) -> &mut Self);
 637     forward!(pub fn tool_only_multipart_suggestion(
 638         &mut self,
 639         msg: impl Into<SubdiagnosticMessage>,
 640         suggestion: Vec<(Span, String)>,
 641         applicability: Applicability,
 642     ) -> &mut Self);
 643     forward!(pub fn span_suggestion(
 644         &mut self,
 645         sp: Span,
 646         msg: impl Into<SubdiagnosticMessage>,
 647         suggestion: impl ToString,
 648         applicability: Applicability,
 649     ) -> &mut Self);
 650     forward!(pub fn span_suggestions(
 651         &mut self,
 652         sp: Span,
 653         msg: impl Into<SubdiagnosticMessage>,
 654         suggestions: impl IntoIterator<Item = String>,
 655         applicability: Applicability,
 656     ) -> &mut Self);
 657     forward!(pub fn multipart_suggestions(
 658         &mut self,
 659         msg: impl Into<SubdiagnosticMessage>,
 660         suggestions: impl IntoIterator<Item = Vec<(Span, String)>>,
 661         applicability: Applicability,
 662     ) -> &mut Self);
 663     forward!(pub fn span_suggestion_short(
 664         &mut self,
 665         sp: Span,
 666         msg: impl Into<SubdiagnosticMessage>,
 667         suggestion: impl ToString,
 668         applicability: Applicability,
 669     ) -> &mut Self);
 670     forward!(pub fn span_suggestion_verbose(
 671         &mut self,
 672         sp: Span,
 673         msg: impl Into<SubdiagnosticMessage>,
 674         suggestion: impl ToString,
 675         applicability: Applicability,
 676     ) -> &mut Self);
 677     forward!(pub fn span_suggestion_hidden(
 678         &mut self,
 679         sp: Span,
 680         msg: impl Into<SubdiagnosticMessage>,
 681         suggestion: impl ToString,
 682         applicability: Applicability,
 683     ) -> &mut Self);
 684     forward!(pub fn tool_only_span_suggestion(
 685         &mut self,
 686         sp: Span,
 687         msg: impl Into<SubdiagnosticMessage>,
 688         suggestion: impl ToString,
 689         applicability: Applicability,
 690     ) -> &mut Self);
 691
 692     forward!(pub fn set_primary_message(&mut self, msg: impl Into<DiagnosticMessage>) -> &mut Self);
 693     forward!(pub fn set_span(&mut self, sp: impl Into<MultiSpan>) -> &mut Self);
 694     forward!(pub fn code(&mut self, s: DiagnosticId) -> &mut Self);
 695     forward!(pub fn set_arg(
 696         &mut self,
 697         name: impl Into<Cow<'static, str>>,
 698         arg: impl IntoDiagnosticArg,
 699     ) -> &mut Self);
 700
 701     forward!(pub fn subdiagnostic(
 702         &mut self,
 703         subdiagnostic: impl crate::AddToDiagnostic
 704     ) -> &mut Self);
 705 }
 706
 707 impl<G: EmissionGuarantee> Debug for DiagnosticBuilder<'_, G> {
 708     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 709         self.inner.diagnostic.fmt(f)
 710     }
 711 }
 712
 713 /// Destructor bomb - a `DiagnosticBuilder` must be either emitted or cancelled
 714 /// or we emit a bug.
 715 impl Drop for DiagnosticBuilderInner<'_> {
 716     fn drop(&mut self) {
 717         match self.state {
 718             // No `.emit()` or `.cancel()` calls.
 719             DiagnosticBuilderState::Emittable(handler) => {
 720                 if !panicking() {
 721                     handler.emit_diagnostic(&mut Diagnostic::new(
 722                         Level::Bug,
 723                         DiagnosticMessage::Str(
 724                             "the following error was constructed but not emitted".to_string(),
 725                         ),
 726                     ));
 727                     handler.emit_diagnostic(&mut self.diagnostic);
 728                     panic!("error was constructed but not emitted");
 729                 }
 730             }
 731             // `.emit()` was previously called, or maybe we're during `.cancel()`.
 732             DiagnosticBuilderState::AlreadyEmittedOrDuringCancellation => {}
 733         }
 734     }
 735 }
 736
 737 #[macro_export]
 738 macro_rules! struct_span_err {
 739     ($session:expr, $span:expr, $code:ident, $($message:tt)*) => ({
 740         $session.struct_span_err_with_code(
 741             $span,
 742             &format!($($message)*),
 743             $crate::error_code!($code),
 744         )
 745     })
 746 }
 747
 748 #[macro_export]
 749 macro_rules! error_code {
 750     ($code:ident) => {{ $crate::DiagnosticId::Error(stringify!($code).to_owned()) }};
 751 }