compiler/rustc_errors/src/emitter.rs

   1 //! The current rustc diagnostics emitter.
   2 //!
   3 //! An `Emitter` takes care of generating the output from a `DiagnosticBuilder` struct.
   4 //!
   5 //! There are various `Emitter` implementations that generate different output formats such as
   6 //! JSON and human readable output.
   7 //!
   8 //! The output types are defined in `rustc_session::config::ErrorOutputType`.
   9
  10 use Destination::*;
  11
  12 use rustc_span::source_map::SourceMap;
  13 use rustc_span::{FileLines, SourceFile, Span};
  14
  15 use crate::snippet::{Annotation, AnnotationType, Line, MultilineAnnotation, Style, StyledString};
  16 use crate::styled_buffer::StyledBuffer;
  17 use crate::{
  18     CodeSuggestion, Diagnostic, DiagnosticArg, DiagnosticId, DiagnosticMessage, FluentBundle,
  19     Handler, LazyFallbackBundle, Level, MultiSpan, SubDiagnostic, SubstitutionHighlight,
  20     SuggestionStyle,
  21 };
  22
  23 use rustc_lint_defs::pluralize;
  24
  25 use rustc_data_structures::fx::FxHashMap;
  26 use rustc_data_structures::sync::Lrc;
  27 use rustc_error_messages::FluentArgs;
  28 use rustc_span::hygiene::{ExpnKind, MacroKind};
  29 use std::borrow::Cow;
  30 use std::cmp::{max, min, Reverse};
  31 use std::io;
  32 use std::io::prelude::*;
  33 use std::iter;
  34 use std::path::Path;
  35 use termcolor::{Ansi, BufferWriter, ColorChoice, ColorSpec, StandardStream};
  36 use termcolor::{Buffer, Color, WriteColor};
  37 use tracing::*;
  38
  39 /// Default column width, used in tests and when terminal dimensions cannot be determined.
  40 const DEFAULT_COLUMN_WIDTH: usize = 140;
  41
  42 /// Describes the way the content of the `rendered` field of the json output is generated
  43 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
  44 pub enum HumanReadableErrorType {
  45     Default(ColorConfig),
  46     AnnotateSnippet(ColorConfig),
  47     Short(ColorConfig),
  48 }
  49
  50 impl HumanReadableErrorType {
  51     /// Returns a (`short`, `color`) tuple
  52     pub fn unzip(self) -> (bool, ColorConfig) {
  53         match self {
  54             HumanReadableErrorType::Default(cc) => (false, cc),
  55             HumanReadableErrorType::Short(cc) => (true, cc),
  56             HumanReadableErrorType::AnnotateSnippet(cc) => (false, cc),
  57         }
  58     }
  59     pub fn new_emitter(
  60         self,
  61         dst: Box<dyn Write + Send>,
  62         source_map: Option<Lrc<SourceMap>>,
  63         bundle: Option<Lrc<FluentBundle>>,
  64         fallback_bundle: LazyFallbackBundle,
  65         teach: bool,
  66         diagnostic_width: Option<usize>,
  67         macro_backtrace: bool,
  68     ) -> EmitterWriter {
  69         let (short, color_config) = self.unzip();
  70         let color = color_config.suggests_using_colors();
  71         EmitterWriter::new(
  72             dst,
  73             source_map,
  74             bundle,
  75             fallback_bundle,
  76             short,
  77             teach,
  78             color,
  79             diagnostic_width,
  80             macro_backtrace,
  81         )
  82     }
  83 }
  84
  85 #[derive(Clone, Copy, Debug)]
  86 struct Margin {
  87     /// The available whitespace in the left that can be consumed when centering.
  88     pub whitespace_left: usize,
  89     /// The column of the beginning of left-most span.
  90     pub span_left: usize,
  91     /// The column of the end of right-most span.
  92     pub span_right: usize,
  93     /// The beginning of the line to be displayed.
  94     pub computed_left: usize,
  95     /// The end of the line to be displayed.
  96     pub computed_right: usize,
  97     /// The current width of the terminal. Uses value of `DEFAULT_COLUMN_WIDTH` constant by default
  98     /// and in tests.
  99     pub column_width: usize,
 100     /// The end column of a span label, including the span. Doesn't account for labels not in the
 101     /// same line as the span.
 102     pub label_right: usize,
 103 }
 104
 105 impl Margin {
 106     fn new(
 107         whitespace_left: usize,
 108         span_left: usize,
 109         span_right: usize,
 110         label_right: usize,
 111         column_width: usize,
 112         max_line_len: usize,
 113     ) -> Self {
 114         // The 6 is padding to give a bit of room for `...` when displaying:
 115         // ```
 116         // error: message
 117         //   --> file.rs:16:58
 118         //    |
 119         // 16 | ... fn foo(self) -> Self::Bar {
 120         //    |                     ^^^^^^^^^
 121         // ```
 122
 123         let mut m = Margin {
 124             whitespace_left: whitespace_left.saturating_sub(6),
 125             span_left: span_left.saturating_sub(6),
 126             span_right: span_right + 6,
 127             computed_left: 0,
 128             computed_right: 0,
 129             column_width,
 130             label_right: label_right + 6,
 131         };
 132         m.compute(max_line_len);
 133         m
 134     }
 135
 136     fn was_cut_left(&self) -> bool {
 137         self.computed_left > 0
 138     }
 139
 140     fn was_cut_right(&self, line_len: usize) -> bool {
 141         let right =
 142             if self.computed_right == self.span_right || self.computed_right == self.label_right {
 143                 // Account for the "..." padding given above. Otherwise we end up with code lines that
 144                 // do fit but end in "..." as if they were trimmed.
 145                 self.computed_right - 6
 146             } else {
 147                 self.computed_right
 148             };
 149         right < line_len && self.computed_left + self.column_width < line_len
 150     }
 151
 152     fn compute(&mut self, max_line_len: usize) {
 153         // When there's a lot of whitespace (>20), we want to trim it as it is useless.
 154         self.computed_left = if self.whitespace_left > 20 {
 155             self.whitespace_left - 16 // We want some padding.
 156         } else {
 157             0
 158         };
 159         // We want to show as much as possible, max_line_len is the right-most boundary for the
 160         // relevant code.
 161         self.computed_right = max(max_line_len, self.computed_left);
 162
 163         if self.computed_right - self.computed_left > self.column_width {
 164             // Trimming only whitespace isn't enough, let's get craftier.
 165             if self.label_right - self.whitespace_left <= self.column_width {
 166                 // Attempt to fit the code window only trimming whitespace.
 167                 self.computed_left = self.whitespace_left;
 168                 self.computed_right = self.computed_left + self.column_width;
 169             } else if self.label_right - self.span_left <= self.column_width {
 170                 // Attempt to fit the code window considering only the spans and labels.
 171                 let padding_left = (self.column_width - (self.label_right - self.span_left)) / 2;
 172                 self.computed_left = self.span_left.saturating_sub(padding_left);
 173                 self.computed_right = self.computed_left + self.column_width;
 174             } else if self.span_right - self.span_left <= self.column_width {
 175                 // Attempt to fit the code window considering the spans and labels plus padding.
 176                 let padding_left = (self.column_width - (self.span_right - self.span_left)) / 5 * 2;
 177                 self.computed_left = self.span_left.saturating_sub(padding_left);
 178                 self.computed_right = self.computed_left + self.column_width;
 179             } else {
 180                 // Mostly give up but still don't show the full line.
 181                 self.computed_left = self.span_left;
 182                 self.computed_right = self.span_right;
 183             }
 184         }
 185     }
 186
 187     fn left(&self, line_len: usize) -> usize {
 188         min(self.computed_left, line_len)
 189     }
 190
 191     fn right(&self, line_len: usize) -> usize {
 192         if line_len.saturating_sub(self.computed_left) <= self.column_width {
 193             line_len
 194         } else {
 195             min(line_len, self.computed_right)
 196         }
 197     }
 198 }
 199
 200 const ANONYMIZED_LINE_NUM: &str = "LL";
 201
 202 /// Emitter trait for emitting errors.
 203 pub trait Emitter {
 204     /// Emit a structured diagnostic.
 205     fn emit_diagnostic(&mut self, diag: &Diagnostic);
 206
 207     /// Emit a notification that an artifact has been output.
 208     /// This is currently only supported for the JSON format,
 209     /// other formats can, and will, simply ignore it.
 210     fn emit_artifact_notification(&mut self, _path: &Path, _artifact_type: &str) {}
 211
 212     fn emit_future_breakage_report(&mut self, _diags: Vec<Diagnostic>) {}
 213
 214     /// Emit list of unused externs
 215     fn emit_unused_externs(
 216         &mut self,
 217         _lint_level: rustc_lint_defs::Level,
 218         _unused_externs: &[&str],
 219     ) {
 220     }
 221
 222     /// Checks if should show explanations about "rustc --explain"
 223     fn should_show_explain(&self) -> bool {
 224         true
 225     }
 226
 227     /// Checks if we can use colors in the current output stream.
 228     fn supports_color(&self) -> bool {
 229         false
 230     }
 231
 232     fn source_map(&self) -> Option<&Lrc<SourceMap>>;
 233
 234     /// Return `FluentBundle` with localized diagnostics for the locale requested by the user. If no
 235     /// language was requested by the user then this will be `None` and `fallback_fluent_bundle`
 236     /// should be used.
 237     fn fluent_bundle(&self) -> Option<&Lrc<FluentBundle>>;
 238
 239     /// Return `FluentBundle` with localized diagnostics for the default locale of the compiler.
 240     /// Used when the user has not requested a specific language or when a localized diagnostic is
 241     /// unavailable for the requested locale.
 242     fn fallback_fluent_bundle(&self) -> &FluentBundle;
 243
 244     /// Convert diagnostic arguments (a rustc internal type that exists to implement
 245     /// `Encodable`/`Decodable`) into `FluentArgs` which is necessary to perform translation.
 246     ///
 247     /// Typically performed once for each diagnostic at the start of `emit_diagnostic` and then
 248     /// passed around as a reference thereafter.
 249     fn to_fluent_args<'arg>(&self, args: &[DiagnosticArg<'arg>]) -> FluentArgs<'arg> {
 250         FromIterator::from_iter(args.to_vec().drain(..))
 251     }
 252
 253     /// Convert `DiagnosticMessage`s to a string, performing translation if necessary.
 254     fn translate_messages(
 255         &self,
 256         messages: &[(DiagnosticMessage, Style)],
 257         args: &FluentArgs<'_>,
 258     ) -> Cow<'_, str> {
 259         Cow::Owned(
 260             messages.iter().map(|(m, _)| self.translate_message(m, args)).collect::<String>(),
 261         )
 262     }
 263
 264     /// Convert a `DiagnosticMessage` to a string, performing translation if necessary.
 265     fn translate_message<'a>(
 266         &'a self,
 267         message: &'a DiagnosticMessage,
 268         args: &'a FluentArgs<'_>,
 269     ) -> Cow<'_, str> {
 270         trace!(?message, ?args);
 271         let (identifier, attr) = match message {
 272             DiagnosticMessage::Str(msg) => return Cow::Borrowed(&msg),
 273             DiagnosticMessage::FluentIdentifier(identifier, attr) => (identifier, attr),
 274         };
 275
 276         let bundle = match self.fluent_bundle() {
 277             Some(bundle) if bundle.has_message(&identifier) => bundle,
 278             _ => self.fallback_fluent_bundle(),
 279         };
 280
 281         let message = bundle.get_message(&identifier).expect("missing diagnostic in fluent bundle");
 282         let value = match attr {
 283             Some(attr) => {
 284                 if let Some(attr) = message.get_attribute(attr) {
 285                     attr.value()
 286                 } else {
 287                     panic!("missing attribute `{attr}` in fluent message `{identifier}`")
 288                 }
 289             }
 290             None => {
 291                 if let Some(value) = message.value() {
 292                     value
 293                 } else {
 294                     panic!("missing value in fluent message `{identifier}`")
 295                 }
 296             }
 297         };
 298
 299         let mut err = vec![];
 300         let translated = bundle.format_pattern(value, Some(&args), &mut err);
 301         trace!(?translated, ?err);
 302         debug_assert!(
 303             err.is_empty(),
 304             "identifier: {:?}, args: {:?}, errors: {:?}",
 305             identifier,
 306             args,
 307             err
 308         );
 309         translated
 310     }
 311
 312     /// Formats the substitutions of the primary_span
 313     ///
 314     /// There are a lot of conditions to this method, but in short:
 315     ///
 316     /// * If the current `Diagnostic` has only one visible `CodeSuggestion`,
 317     ///   we format the `help` suggestion depending on the content of the
 318     ///   substitutions. In that case, we return the modified span only.
 319     ///
 320     /// * If the current `Diagnostic` has multiple suggestions,
 321     ///   we return the original `primary_span` and the original suggestions.
 322     fn primary_span_formatted<'a>(
 323         &mut self,
 324         diag: &'a Diagnostic,
 325         fluent_args: &FluentArgs<'_>,
 326     ) -> (MultiSpan, &'a [CodeSuggestion]) {
 327         let mut primary_span = diag.span.clone();
 328         let suggestions = diag.suggestions.as_ref().map_or(&[][..], |suggestions| &suggestions[..]);
 329         if let Some((sugg, rest)) = suggestions.split_first() {
 330             let msg = self.translate_message(&sugg.msg, fluent_args);
 331             if rest.is_empty() &&
 332                // ^ if there is only one suggestion
 333                // don't display multi-suggestions as labels
 334                sugg.substitutions.len() == 1 &&
 335                // don't display multipart suggestions as labels
 336                sugg.substitutions[0].parts.len() == 1 &&
 337                // don't display long messages as labels
 338                msg.split_whitespace().count() < 10 &&
 339                // don't display multiline suggestions as labels
 340                !sugg.substitutions[0].parts[0].snippet.contains('\n') &&
 341                ![
 342                     // when this style is set we want the suggestion to be a message, not inline
 343                     SuggestionStyle::HideCodeAlways,
 344                     // trivial suggestion for tooling's sake, never shown
 345                     SuggestionStyle::CompletelyHidden,
 346                     // subtle suggestion, never shown inline
 347                     SuggestionStyle::ShowAlways,
 348                ].contains(&sugg.style)
 349             {
 350                 let substitution = &sugg.substitutions[0].parts[0].snippet.trim();
 351                 let msg = if substitution.is_empty() || sugg.style.hide_inline() {
 352                     // This substitution is only removal OR we explicitly don't want to show the
 353                     // code inline (`hide_inline`). Therefore, we don't show the substitution.
 354                     format!("help: {}", &msg)
 355                 } else {
 356                     // Show the default suggestion text with the substitution
 357                     format!(
 358                         "help: {}{}: `{}`",
 359                         &msg,
 360                         if self
 361                             .source_map()
 362                             .map(|sm| is_case_difference(
 363                                 &**sm,
 364                                 substitution,
 365                                 sugg.substitutions[0].parts[0].span,
 366                             ))
 367                             .unwrap_or(false)
 368                         {
 369                             " (notice the capitalization)"
 370                         } else {
 371                             ""
 372                         },
 373                         substitution,
 374                     )
 375                 };
 376                 primary_span.push_span_label(sugg.substitutions[0].parts[0].span, msg);
 377
 378                 // We return only the modified primary_span
 379                 (primary_span, &[])
 380             } else {
 381                 // if there are multiple suggestions, print them all in full
 382                 // to be consistent. We could try to figure out if we can
 383                 // make one (or the first one) inline, but that would give
 384                 // undue importance to a semi-random suggestion
 385                 (primary_span, suggestions)
 386             }
 387         } else {
 388             (primary_span, suggestions)
 389         }
 390     }
 391
 392     fn fix_multispans_in_extern_macros_and_render_macro_backtrace(
 393         &self,
 394         source_map: &Option<Lrc<SourceMap>>,
 395         span: &mut MultiSpan,
 396         children: &mut Vec<SubDiagnostic>,
 397         level: &Level,
 398         backtrace: bool,
 399     ) {
 400         // Check for spans in macros, before `fix_multispans_in_extern_macros`
 401         // has a chance to replace them.
 402         let has_macro_spans: Vec<_> = iter::once(&*span)
 403             .chain(children.iter().map(|child| &child.span))
 404             .flat_map(|span| span.primary_spans())
 405             .flat_map(|sp| sp.macro_backtrace())
 406             .filter_map(|expn_data| {
 407                 match expn_data.kind {
 408                     ExpnKind::Root => None,
 409
 410                     // Skip past non-macro entries, just in case there
 411                     // are some which do actually involve macros.
 412                     ExpnKind::Inlined | ExpnKind::Desugaring(..) | ExpnKind::AstPass(..) => None,
 413
 414                     ExpnKind::Macro(macro_kind, name) => Some((macro_kind, name)),
 415                 }
 416             })
 417             .collect();
 418
 419         if !backtrace {
 420             self.fix_multispans_in_extern_macros(source_map, span, children);
 421         }
 422
 423         self.render_multispans_macro_backtrace(span, children, backtrace);
 424
 425         if !backtrace {
 426             if let Some((macro_kind, name)) = has_macro_spans.first() {
 427                 // Mark the actual macro this originates from
 428                 let and_then = if let Some((macro_kind, last_name)) = has_macro_spans.last()
 429                     && last_name != name
 430                 {
 431                     let descr = macro_kind.descr();
 432                     format!(
 433                         " which comes from the expansion of the {descr} `{last_name}`",
 434                     )
 435                 } else {
 436                     "".to_string()
 437                 };
 438
 439                 let descr = macro_kind.descr();
 440                 let msg = format!(
 441                     "this {level} originates in the {descr} `{name}`{and_then} \
 442                     (in Nightly builds, run with -Z macro-backtrace for more info)",
 443                 );
 444
 445                 children.push(SubDiagnostic {
 446                     level: Level::Note,
 447                     message: vec![(DiagnosticMessage::Str(msg), Style::NoStyle)],
 448                     span: MultiSpan::new(),
 449                     render_span: None,
 450                 });
 451             }
 452         }
 453     }
 454
 455     fn render_multispans_macro_backtrace(
 456         &self,
 457         span: &mut MultiSpan,
 458         children: &mut Vec<SubDiagnostic>,
 459         backtrace: bool,
 460     ) {
 461         for span in iter::once(span).chain(children.iter_mut().map(|child| &mut child.span)) {
 462             self.render_multispan_macro_backtrace(span, backtrace);
 463         }
 464     }
 465
 466     fn render_multispan_macro_backtrace(&self, span: &mut MultiSpan, always_backtrace: bool) {
 467         let mut new_labels: Vec<(Span, String)> = vec![];
 468
 469         for &sp in span.primary_spans() {
 470             if sp.is_dummy() {
 471                 continue;
 472             }
 473
 474             // FIXME(eddyb) use `retain` on `macro_backtrace` to remove all the
 475             // entries we don't want to print, to make sure the indices being
 476             // printed are contiguous (or omitted if there's only one entry).
 477             let macro_backtrace: Vec<_> = sp.macro_backtrace().collect();
 478             for (i, trace) in macro_backtrace.iter().rev().enumerate() {
 479                 if trace.def_site.is_dummy() {
 480                     continue;
 481                 }
 482
 483                 if always_backtrace && !matches!(trace.kind, ExpnKind::Inlined) {
 484                     new_labels.push((
 485                         trace.def_site,
 486                         format!(
 487                             "in this expansion of `{}`{}",
 488                             trace.kind.descr(),
 489                             if macro_backtrace.len() > 1 {
 490                                 // if macro_backtrace.len() == 1 it'll be
 491                                 // pointed at by "in this macro invocation"
 492                                 format!(" (#{})", i + 1)
 493                             } else {
 494                                 String::new()
 495                             },
 496                         ),
 497                     ));
 498                 }
 499
 500                 // Don't add a label on the call site if the diagnostic itself
 501                 // already points to (a part of) that call site, as the label
 502                 // is meant for showing the relevant invocation when the actual
 503                 // diagnostic is pointing to some part of macro definition.
 504                 //
 505                 // This also handles the case where an external span got replaced
 506                 // with the call site span by `fix_multispans_in_extern_macros`.
 507                 //
 508                 // NB: `-Zmacro-backtrace` overrides this, for uniformity, as the
 509                 // "in this expansion of" label above is always added in that mode,
 510                 // and it needs an "in this macro invocation" label to match that.
 511                 let redundant_span = trace.call_site.contains(sp);
 512
 513                 if !redundant_span || always_backtrace {
 514                     let msg: Cow<'static, _> = match trace.kind {
 515                         ExpnKind::Macro(MacroKind::Attr, _) => {
 516                             "this procedural macro expansion".into()
 517                         }
 518                         ExpnKind::Macro(MacroKind::Derive, _) => {
 519                             "this derive macro expansion".into()
 520                         }
 521                         ExpnKind::Macro(MacroKind::Bang, _) => "this macro invocation".into(),
 522                         ExpnKind::Inlined => "this inlined function call".into(),
 523                         ExpnKind::Root => "the crate root".into(),
 524                         ExpnKind::AstPass(kind) => kind.descr().into(),
 525                         ExpnKind::Desugaring(kind) => {
 526                             format!("this {} desugaring", kind.descr()).into()
 527                         }
 528                     };
 529                     new_labels.push((
 530                         trace.call_site,
 531                         format!(
 532                             "in {}{}",
 533                             msg,
 534                             if macro_backtrace.len() > 1 && always_backtrace {
 535                                 // only specify order when the macro
 536                                 // backtrace is multiple levels deep
 537                                 format!(" (#{})", i + 1)
 538                             } else {
 539                                 String::new()
 540                             },
 541                         ),
 542                     ));
 543                 }
 544                 if !always_backtrace {
 545                     break;
 546                 }
 547             }
 548         }
 549
 550         for (label_span, label_text) in new_labels {
 551             span.push_span_label(label_span, label_text);
 552         }
 553     }
 554
 555     // This does a small "fix" for multispans by looking to see if it can find any that
 556     // point directly at external macros. Since these are often difficult to read,
 557     // this will change the span to point at the use site.
 558     fn fix_multispans_in_extern_macros(
 559         &self,
 560         source_map: &Option<Lrc<SourceMap>>,
 561         span: &mut MultiSpan,
 562         children: &mut Vec<SubDiagnostic>,
 563     ) {
 564         let Some(source_map) = source_map else { return };
 565         debug!("fix_multispans_in_extern_macros: before: span={:?} children={:?}", span, children);
 566         self.fix_multispan_in_extern_macros(source_map, span);
 567         for child in children.iter_mut() {
 568             self.fix_multispan_in_extern_macros(source_map, &mut child.span);
 569         }
 570         debug!("fix_multispans_in_extern_macros: after: span={:?} children={:?}", span, children);
 571     }
 572
 573     // This "fixes" MultiSpans that contain `Span`s pointing to locations inside of external macros.
 574     // Since these locations are often difficult to read,
 575     // we move these spans from the external macros to their corresponding use site.
 576     fn fix_multispan_in_extern_macros(&self, source_map: &Lrc<SourceMap>, span: &mut MultiSpan) {
 577         // First, find all the spans in external macros and point instead at their use site.
 578         let replacements: Vec<(Span, Span)> = span
 579             .primary_spans()
 580             .iter()
 581             .copied()
 582             .chain(span.span_labels().iter().map(|sp_label| sp_label.span))
 583             .filter_map(|sp| {
 584                 if !sp.is_dummy() && source_map.is_imported(sp) {
 585                     let maybe_callsite = sp.source_callsite();
 586                     if sp != maybe_callsite {
 587                         return Some((sp, maybe_callsite));
 588                     }
 589                 }
 590                 None
 591             })
 592             .collect();
 593
 594         // After we have them, make sure we replace these 'bad' def sites with their use sites.
 595         for (from, to) in replacements {
 596             span.replace(from, to);
 597         }
 598     }
 599 }
 600
 601 impl Emitter for EmitterWriter {
 602     fn source_map(&self) -> Option<&Lrc<SourceMap>> {
 603         self.sm.as_ref()
 604     }
 605
 606     fn fluent_bundle(&self) -> Option<&Lrc<FluentBundle>> {
 607         self.fluent_bundle.as_ref()
 608     }
 609
 610     fn fallback_fluent_bundle(&self) -> &FluentBundle {
 611         &**self.fallback_bundle
 612     }
 613
 614     fn emit_diagnostic(&mut self, diag: &Diagnostic) {
 615         let fluent_args = self.to_fluent_args(diag.args());
 616
 617         let mut children = diag.children.clone();
 618         let (mut primary_span, suggestions) = self.primary_span_formatted(&diag, &fluent_args);
 619         debug!("emit_diagnostic: suggestions={:?}", suggestions);
 620
 621         self.fix_multispans_in_extern_macros_and_render_macro_backtrace(
 622             &self.sm,
 623             &mut primary_span,
 624             &mut children,
 625             &diag.level,
 626             self.macro_backtrace,
 627         );
 628
 629         self.emit_messages_default(
 630             &diag.level,
 631             &diag.message,
 632             &fluent_args,
 633             &diag.code,
 634             &primary_span,
 635             &children,
 636             &suggestions,
 637         );
 638     }
 639
 640     fn should_show_explain(&self) -> bool {
 641         !self.short_message
 642     }
 643
 644     fn supports_color(&self) -> bool {
 645         self.dst.supports_color()
 646     }
 647 }
 648
 649 /// An emitter that does nothing when emitting a non-fatal diagnostic.
 650 /// Fatal diagnostics are forwarded to `fatal_handler` to avoid silent
 651 /// failures of rustc, as witnessed e.g. in issue #89358.
 652 pub struct SilentEmitter {
 653     pub fatal_handler: Handler,
 654     pub fatal_note: Option<String>,
 655 }
 656
 657 impl Emitter for SilentEmitter {
 658     fn source_map(&self) -> Option<&Lrc<SourceMap>> {
 659         None
 660     }
 661
 662     fn fluent_bundle(&self) -> Option<&Lrc<FluentBundle>> {
 663         None
 664     }
 665
 666     fn fallback_fluent_bundle(&self) -> &FluentBundle {
 667         panic!("silent emitter attempted to translate message")
 668     }
 669
 670     fn emit_diagnostic(&mut self, d: &Diagnostic) {
 671         if d.level == Level::Fatal {
 672             let mut d = d.clone();
 673             if let Some(ref note) = self.fatal_note {
 674                 d.note(note);
 675             }
 676             self.fatal_handler.emit_diagnostic(&mut d);
 677         }
 678     }
 679 }
 680
 681 /// Maximum number of suggestions to be shown
 682 ///
 683 /// Arbitrary, but taken from trait import suggestion limit
 684 pub const MAX_SUGGESTIONS: usize = 4;
 685
 686 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
 687 pub enum ColorConfig {
 688     Auto,
 689     Always,
 690     Never,
 691 }
 692
 693 impl ColorConfig {
 694     fn to_color_choice(self) -> ColorChoice {
 695         match self {
 696             ColorConfig::Always => {
 697                 if atty::is(atty::Stream::Stderr) {
 698                     ColorChoice::Always
 699                 } else {
 700                     ColorChoice::AlwaysAnsi
 701                 }
 702             }
 703             ColorConfig::Never => ColorChoice::Never,
 704             ColorConfig::Auto if atty::is(atty::Stream::Stderr) => ColorChoice::Auto,
 705             ColorConfig::Auto => ColorChoice::Never,
 706         }
 707     }
 708     fn suggests_using_colors(self) -> bool {
 709         match self {
 710             ColorConfig::Always | ColorConfig::Auto => true,
 711             ColorConfig::Never => false,
 712         }
 713     }
 714 }
 715
 716 /// Handles the writing of `HumanReadableErrorType::Default` and `HumanReadableErrorType::Short`
 717 pub struct EmitterWriter {
 718     dst: Destination,
 719     sm: Option<Lrc<SourceMap>>,
 720     fluent_bundle: Option<Lrc<FluentBundle>>,
 721     fallback_bundle: LazyFallbackBundle,
 722     short_message: bool,
 723     teach: bool,
 724     ui_testing: bool,
 725     diagnostic_width: Option<usize>,
 726
 727     macro_backtrace: bool,
 728 }
 729
 730 #[derive(Debug)]
 731 pub struct FileWithAnnotatedLines {
 732     pub file: Lrc<SourceFile>,
 733     pub lines: Vec<Line>,
 734     multiline_depth: usize,
 735 }
 736
 737 impl EmitterWriter {
 738     pub fn stderr(
 739         color_config: ColorConfig,
 740         source_map: Option<Lrc<SourceMap>>,
 741         fluent_bundle: Option<Lrc<FluentBundle>>,
 742         fallback_bundle: LazyFallbackBundle,
 743         short_message: bool,
 744         teach: bool,
 745         diagnostic_width: Option<usize>,
 746         macro_backtrace: bool,
 747     ) -> EmitterWriter {
 748         let dst = Destination::from_stderr(color_config);
 749         EmitterWriter {
 750             dst,
 751             sm: source_map,
 752             fluent_bundle,
 753             fallback_bundle,
 754             short_message,
 755             teach,
 756             ui_testing: false,
 757             diagnostic_width,
 758             macro_backtrace,
 759         }
 760     }
 761
 762     pub fn new(
 763         dst: Box<dyn Write + Send>,
 764         source_map: Option<Lrc<SourceMap>>,
 765         fluent_bundle: Option<Lrc<FluentBundle>>,
 766         fallback_bundle: LazyFallbackBundle,
 767         short_message: bool,
 768         teach: bool,
 769         colored: bool,
 770         diagnostic_width: Option<usize>,
 771         macro_backtrace: bool,
 772     ) -> EmitterWriter {
 773         EmitterWriter {
 774             dst: Raw(dst, colored),
 775             sm: source_map,
 776             fluent_bundle,
 777             fallback_bundle,
 778             short_message,
 779             teach,
 780             ui_testing: false,
 781             diagnostic_width,
 782             macro_backtrace,
 783         }
 784     }
 785
 786     pub fn ui_testing(mut self, ui_testing: bool) -> Self {
 787         self.ui_testing = ui_testing;
 788         self
 789     }
 790
 791     fn maybe_anonymized(&self, line_num: usize) -> Cow<'static, str> {
 792         if self.ui_testing {
 793             Cow::Borrowed(ANONYMIZED_LINE_NUM)
 794         } else {
 795             Cow::Owned(line_num.to_string())
 796         }
 797     }
 798
 799     fn draw_line(
 800         &self,
 801         buffer: &mut StyledBuffer,
 802         source_string: &str,
 803         line_index: usize,
 804         line_offset: usize,
 805         width_offset: usize,
 806         code_offset: usize,
 807         margin: Margin,
 808     ) {
 809         // Tabs are assumed to have been replaced by spaces in calling code.
 810         debug_assert!(!source_string.contains('\t'));
 811         let line_len = source_string.len();
 812         // Create the source line we will highlight.
 813         let left = margin.left(line_len);
 814         let right = margin.right(line_len);
 815         // On long lines, we strip the source line, accounting for unicode.
 816         let mut taken = 0;
 817         let code: String = source_string
 818             .chars()
 819             .skip(left)
 820             .take_while(|ch| {
 821                 // Make sure that the trimming on the right will fall within the terminal width.
 822                 // FIXME: `unicode_width` sometimes disagrees with terminals on how wide a `char` is.
 823                 // For now, just accept that sometimes the code line will be longer than desired.
 824                 let next = unicode_width::UnicodeWidthChar::width(*ch).unwrap_or(1);
 825                 if taken + next > right - left {
 826                     return false;
 827                 }
 828                 taken += next;
 829                 true
 830             })
 831             .collect();
 832         buffer.puts(line_offset, code_offset, &code, Style::Quotation);
 833         if margin.was_cut_left() {
 834             // We have stripped some code/whitespace from the beginning, make it clear.
 835             buffer.puts(line_offset, code_offset, "...", Style::LineNumber);
 836         }
 837         if margin.was_cut_right(line_len) {
 838             // We have stripped some code after the right-most span end, make it clear we did so.
 839             buffer.puts(line_offset, code_offset + taken - 3, "...", Style::LineNumber);
 840         }
 841         buffer.puts(line_offset, 0, &self.maybe_anonymized(line_index), Style::LineNumber);
 842
 843         draw_col_separator_no_space(buffer, line_offset, width_offset - 2);
 844     }
 845
 846     fn render_source_line(
 847         &self,
 848         buffer: &mut StyledBuffer,
 849         file: Lrc<SourceFile>,
 850         line: &Line,
 851         width_offset: usize,
 852         code_offset: usize,
 853         margin: Margin,
 854     ) -> Vec<(usize, Style)> {
 855         // Draw:
 856         //
 857         //   LL | ... code ...
 858         //      |     ^^-^ span label
 859         //      |       |
 860         //      |       secondary span label
 861         //
 862         //   ^^ ^ ^^^ ^^^^ ^^^ we don't care about code too far to the right of a span, we trim it
 863         //   |  | |   |
 864         //   |  | |   actual code found in your source code and the spans we use to mark it
 865         //   |  | when there's too much wasted space to the left, trim it
 866         //   |  vertical divider between the column number and the code
 867         //   column number
 868
 869         if line.line_index == 0 {
 870             return Vec::new();
 871         }
 872
 873         let source_string = match file.get_line(line.line_index - 1) {
 874             Some(s) => normalize_whitespace(&*s),
 875             None => return Vec::new(),
 876         };
 877
 878         let line_offset = buffer.num_lines();
 879
 880         // Left trim
 881         let left = margin.left(source_string.len());
 882
 883         // Account for unicode characters of width !=0 that were removed.
 884         let left = source_string
 885             .chars()
 886             .take(left)
 887             .map(|ch| unicode_width::UnicodeWidthChar::width(ch).unwrap_or(1))
 888             .sum();
 889
 890         self.draw_line(
 891             buffer,
 892             &source_string,
 893             line.line_index,
 894             line_offset,
 895             width_offset,
 896             code_offset,
 897             margin,
 898         );
 899
 900         // Special case when there's only one annotation involved, it is the start of a multiline
 901         // span and there's no text at the beginning of the code line. Instead of doing the whole
 902         // graph:
 903         //
 904         // 2 |   fn foo() {
 905         //   |  _^
 906         // 3 | |
 907         // 4 | | }
 908         //   | |_^ test
 909         //
 910         // we simplify the output to:
 911         //
 912         // 2 | / fn foo() {
 913         // 3 | |
 914         // 4 | | }
 915         //   | |_^ test
 916         if let [ann] = &line.annotations[..] {
 917             if let AnnotationType::MultilineStart(depth) = ann.annotation_type {
 918                 if source_string.chars().take(ann.start_col).all(|c| c.is_whitespace()) {
 919                     let style = if ann.is_primary {
 920                         Style::UnderlinePrimary
 921                     } else {
 922                         Style::UnderlineSecondary
 923                     };
 924                     buffer.putc(line_offset, width_offset + depth - 1, '/', style);
 925                     return vec![(depth, style)];
 926                 }
 927             }
 928         }
 929
 930         // We want to display like this:
 931         //
 932         //      vec.push(vec.pop().unwrap());
 933         //      ---      ^^^               - previous borrow ends here
 934         //      |        |
 935         //      |        error occurs here
 936         //      previous borrow of `vec` occurs here
 937         //
 938         // But there are some weird edge cases to be aware of:
 939         //
 940         //      vec.push(vec.pop().unwrap());
 941         //      --------                    - previous borrow ends here
 942         //      ||
 943         //      |this makes no sense
 944         //      previous borrow of `vec` occurs here
 945         //
 946         // For this reason, we group the lines into "highlight lines"
 947         // and "annotations lines", where the highlight lines have the `^`.
 948
 949         // Sort the annotations by (start, end col)
 950         // The labels are reversed, sort and then reversed again.
 951         // Consider a list of annotations (A1, A2, C1, C2, B1, B2) where
 952         // the letter signifies the span. Here we are only sorting by the
 953         // span and hence, the order of the elements with the same span will
 954         // not change. On reversing the ordering (|a, b| but b.cmp(a)), you get
 955         // (C1, C2, B1, B2, A1, A2). All the elements with the same span are
 956         // still ordered first to last, but all the elements with different
 957         // spans are ordered by their spans in last to first order. Last to
 958         // first order is important, because the jiggly lines and | are on
 959         // the left, so the rightmost span needs to be rendered first,
 960         // otherwise the lines would end up needing to go over a message.
 961
 962         let mut annotations = line.annotations.clone();
 963         annotations.sort_by_key(|a| Reverse(a.start_col));
 964
 965         // First, figure out where each label will be positioned.
 966         //
 967         // In the case where you have the following annotations:
 968         //
 969         //      vec.push(vec.pop().unwrap());
 970         //      --------                    - previous borrow ends here [C]
 971         //      ||
 972         //      |this makes no sense [B]
 973         //      previous borrow of `vec` occurs here [A]
 974         //
 975         // `annotations_position` will hold [(2, A), (1, B), (0, C)].
 976         //
 977         // We try, when possible, to stick the rightmost annotation at the end
 978         // of the highlight line:
 979         //
 980         //      vec.push(vec.pop().unwrap());
 981         //      ---      ---               - previous borrow ends here
 982         //
 983         // But sometimes that's not possible because one of the other
 984         // annotations overlaps it. For example, from the test
 985         // `span_overlap_label`, we have the following annotations
 986         // (written on distinct lines for clarity):
 987         //
 988         //      fn foo(x: u32) {
 989         //      --------------
 990         //             -
 991         //
 992         // In this case, we can't stick the rightmost-most label on
 993         // the highlight line, or we would get:
 994         //
 995         //      fn foo(x: u32) {
 996         //      -------- x_span
 997         //      |
 998         //      fn_span
 999         //
1000         // which is totally weird. Instead we want:
1001         //
1002         //      fn foo(x: u32) {
1003         //      --------------
1004         //      |      |
1005         //      |      x_span
1006         //      fn_span
1007         //
1008         // which is...less weird, at least. In fact, in general, if
1009         // the rightmost span overlaps with any other span, we should
1010         // use the "hang below" version, so we can at least make it
1011         // clear where the span *starts*. There's an exception for this
1012         // logic, when the labels do not have a message:
1013         //
1014         //      fn foo(x: u32) {
1015         //      --------------
1016         //             |
1017         //             x_span
1018         //
1019         // instead of:
1020         //
1021         //      fn foo(x: u32) {
1022         //      --------------
1023         //      |      |
1024         //      |      x_span
1025         //      <EMPTY LINE>
1026         //
1027         let mut annotations_position = vec![];
1028         let mut line_len = 0;
1029         let mut p = 0;
1030         for (i, annotation) in annotations.iter().enumerate() {
1031             for (j, next) in annotations.iter().enumerate() {
1032                 if overlaps(next, annotation, 0)  // This label overlaps with another one and both
1033                     && annotation.has_label()     // take space (they have text and are not
1034                     && j > i                      // multiline lines).
1035                     && p == 0
1036                 // We're currently on the first line, move the label one line down
1037                 {
1038                     // If we're overlapping with an un-labelled annotation with the same span
1039                     // we can just merge them in the output
1040                     if next.start_col == annotation.start_col
1041                         && next.end_col == annotation.end_col
1042                         && !next.has_label()
1043                     {
1044                         continue;
1045                     }
1046
1047                     // This annotation needs a new line in the output.
1048                     p += 1;
1049                     break;
1050                 }
1051             }
1052             annotations_position.push((p, annotation));
1053             for (j, next) in annotations.iter().enumerate() {
1054                 if j > i {
1055                     let l = next.label.as_ref().map_or(0, |label| label.len() + 2);
1056                     if (overlaps(next, annotation, l) // Do not allow two labels to be in the same
1057                                                      // line if they overlap including padding, to
1058                                                      // avoid situations like:
1059                                                      //
1060                                                      //      fn foo(x: u32) {
1061                                                      //      -------^------
1062                                                      //      |      |
1063                                                      //      fn_spanx_span
1064                                                      //
1065                         && annotation.has_label()    // Both labels must have some text, otherwise
1066                         && next.has_label())         // they are not overlapping.
1067                                                      // Do not add a new line if this annotation
1068                                                      // or the next are vertical line placeholders.
1069                         || (annotation.takes_space() // If either this or the next annotation is
1070                             && next.has_label())     // multiline start/end, move it to a new line
1071                         || (annotation.has_label()   // so as not to overlap the horizontal lines.
1072                             && next.takes_space())
1073                         || (annotation.takes_space() && next.takes_space())
1074                         || (overlaps(next, annotation, l)
1075                             && next.end_col <= annotation.end_col
1076                             && next.has_label()
1077                             && p == 0)
1078                     // Avoid #42595.
1079                     {
1080                         // This annotation needs a new line in the output.
1081                         p += 1;
1082                         break;
1083                     }
1084                 }
1085             }
1086             line_len = max(line_len, p);
1087         }
1088
1089         if line_len != 0 {
1090             line_len += 1;
1091         }
1092
1093         // If there are no annotations or the only annotations on this line are
1094         // MultilineLine, then there's only code being shown, stop processing.
1095         if line.annotations.iter().all(|a| a.is_line()) {
1096             return vec![];
1097         }
1098
1099         // Write the column separator.
1100         //
1101         // After this we will have:
1102         //
1103         // 2 |   fn foo() {
1104         //   |
1105         //   |
1106         //   |
1107         // 3 |
1108         // 4 |   }
1109         //   |
1110         for pos in 0..=line_len {
1111             draw_col_separator(buffer, line_offset + pos + 1, width_offset - 2);
1112         }
1113
1114         // Write the horizontal lines for multiline annotations
1115         // (only the first and last lines need this).
1116         //
1117         // After this we will have:
1118         //
1119         // 2 |   fn foo() {
1120         //   |  __________
1121         //   |
1122         //   |
1123         // 3 |
1124         // 4 |   }
1125         //   |  _
1126         for &(pos, annotation) in &annotations_position {
1127             let style = if annotation.is_primary {
1128                 Style::UnderlinePrimary
1129             } else {
1130                 Style::UnderlineSecondary
1131             };
1132             let pos = pos + 1;
1133             match annotation.annotation_type {
1134                 AnnotationType::MultilineStart(depth) | AnnotationType::MultilineEnd(depth) => {
1135                     draw_range(
1136                         buffer,
1137                         '_',
1138                         line_offset + pos,
1139                         width_offset + depth,
1140                         (code_offset + annotation.start_col).saturating_sub(left),
1141                         style,
1142                     );
1143                 }
1144                 _ if self.teach => {
1145                     buffer.set_style_range(
1146                         line_offset,
1147                         (code_offset + annotation.start_col).saturating_sub(left),
1148                         (code_offset + annotation.end_col).saturating_sub(left),
1149                         style,
1150                         annotation.is_primary,
1151                     );
1152                 }
1153                 _ => {}
1154             }
1155         }
1156
1157         // Write the vertical lines for labels that are on a different line as the underline.
1158         //
1159         // After this we will have:
1160         //
1161         // 2 |   fn foo() {
1162         //   |  __________
1163         //   | |    |
1164         //   | |
1165         // 3 | |
1166         // 4 | | }
1167         //   | |_
1168         for &(pos, annotation) in &annotations_position {
1169             let style = if annotation.is_primary {
1170                 Style::UnderlinePrimary
1171             } else {
1172                 Style::UnderlineSecondary
1173             };
1174             let pos = pos + 1;
1175
1176             if pos > 1 && (annotation.has_label() || annotation.takes_space()) {
1177                 for p in line_offset + 1..=line_offset + pos {
1178                     buffer.putc(
1179                         p,
1180                         (code_offset + annotation.start_col).saturating_sub(left),
1181                         '|',
1182                         style,
1183                     );
1184                 }
1185             }
1186             match annotation.annotation_type {
1187                 AnnotationType::MultilineStart(depth) => {
1188                     for p in line_offset + pos + 1..line_offset + line_len + 2 {
1189                         buffer.putc(p, width_offset + depth - 1, '|', style);
1190                     }
1191                 }
1192                 AnnotationType::MultilineEnd(depth) => {
1193                     for p in line_offset..=line_offset + pos {
1194                         buffer.putc(p, width_offset + depth - 1, '|', style);
1195                     }
1196                 }
1197                 _ => (),
1198             }
1199         }
1200
1201         // Write the labels on the annotations that actually have a label.
1202         //
1203         // After this we will have:
1204         //
1205         // 2 |   fn foo() {
1206         //   |  __________
1207         //   |      |
1208         //   |      something about `foo`
1209         // 3 |
1210         // 4 |   }
1211         //   |  _  test
1212         for &(pos, annotation) in &annotations_position {
1213             let style =
1214                 if annotation.is_primary { Style::LabelPrimary } else { Style::LabelSecondary };
1215             let (pos, col) = if pos == 0 {
1216                 (pos + 1, (annotation.end_col + 1).saturating_sub(left))
1217             } else {
1218                 (pos + 2, annotation.start_col.saturating_sub(left))
1219             };
1220             if let Some(ref label) = annotation.label {
1221                 buffer.puts(line_offset + pos, code_offset + col, &label, style);
1222             }
1223         }
1224
1225         // Sort from biggest span to smallest span so that smaller spans are
1226         // represented in the output:
1227         //
1228         // x | fn foo()
1229         //   | ^^^---^^
1230         //   | |  |
1231         //   | |  something about `foo`
1232         //   | something about `fn foo()`
1233         annotations_position.sort_by_key(|(_, ann)| {
1234             // Decreasing order. When annotations share the same length, prefer `Primary`.
1235             (Reverse(ann.len()), ann.is_primary)
1236         });
1237
1238         // Write the underlines.
1239         //
1240         // After this we will have:
1241         //
1242         // 2 |   fn foo() {
1243         //   |  ____-_____^
1244         //   |      |
1245         //   |      something about `foo`
1246         // 3 |
1247         // 4 |   }
1248         //   |  _^  test
1249         for &(_, annotation) in &annotations_position {
1250             let (underline, style) = if annotation.is_primary {
1251                 ('^', Style::UnderlinePrimary)
1252             } else {
1253                 ('-', Style::UnderlineSecondary)
1254             };
1255             for p in annotation.start_col..annotation.end_col {
1256                 buffer.putc(
1257                     line_offset + 1,
1258                     (code_offset + p).saturating_sub(left),
1259                     underline,
1260                     style,
1261                 );
1262             }
1263         }
1264         annotations_position
1265             .iter()
1266             .filter_map(|&(_, annotation)| match annotation.annotation_type {
1267                 AnnotationType::MultilineStart(p) | AnnotationType::MultilineEnd(p) => {
1268                     let style = if annotation.is_primary {
1269                         Style::LabelPrimary
1270                     } else {
1271                         Style::LabelSecondary
1272                     };
1273                     Some((p, style))
1274                 }
1275                 _ => None,
1276             })
1277             .collect::<Vec<_>>()
1278     }
1279
1280     fn get_multispan_max_line_num(&mut self, msp: &MultiSpan) -> usize {
1281         let Some(ref sm) = self.sm else {
1282             return 0;
1283         };
1284
1285         let will_be_emitted = |span: Span| {
1286             !span.is_dummy() && {
1287                 let file = sm.lookup_source_file(span.hi());
1288                 sm.ensure_source_file_source_present(file)
1289             }
1290         };
1291
1292         let mut max = 0;
1293         for primary_span in msp.primary_spans() {
1294             if will_be_emitted(*primary_span) {
1295                 let hi = sm.lookup_char_pos(primary_span.hi());
1296                 max = (hi.line).max(max);
1297             }
1298         }
1299         if !self.short_message {
1300             for span_label in msp.span_labels() {
1301                 if will_be_emitted(span_label.span) {
1302                     let hi = sm.lookup_char_pos(span_label.span.hi());
1303                     max = (hi.line).max(max);
1304                 }
1305             }
1306         }
1307
1308         max
1309     }
1310
1311     fn get_max_line_num(&mut self, span: &MultiSpan, children: &[SubDiagnostic]) -> usize {
1312         let primary = self.get_multispan_max_line_num(span);
1313         children
1314             .iter()
1315             .map(|sub| self.get_multispan_max_line_num(&sub.span))
1316             .max()
1317             .unwrap_or(0)
1318             .max(primary)
1319     }
1320
1321     /// Adds a left margin to every line but the first, given a padding length and the label being
1322     /// displayed, keeping the provided highlighting.
1323     fn msg_to_buffer(
1324         &self,
1325         buffer: &mut StyledBuffer,
1326         msg: &[(DiagnosticMessage, Style)],
1327         args: &FluentArgs<'_>,
1328         padding: usize,
1329         label: &str,
1330         override_style: Option<Style>,
1331     ) {
1332         // The extra 5 ` ` is padding that's always needed to align to the `note: `:
1333         //
1334         //   error: message
1335         //     --> file.rs:13:20
1336         //      |
1337         //   13 |     <CODE>
1338         //      |      ^^^^
1339         //      |
1340         //      = note: multiline
1341         //              message
1342         //   ++^^^----xx
1343         //    |  |   | |
1344         //    |  |   | magic `2`
1345         //    |  |   length of label
1346         //    |  magic `3`
1347         //    `max_line_num_len`
1348         let padding = " ".repeat(padding + label.len() + 5);
1349
1350         /// Returns `override` if it is present and `style` is `NoStyle` or `style` otherwise
1351         fn style_or_override(style: Style, override_: Option<Style>) -> Style {
1352             match (style, override_) {
1353                 (Style::NoStyle, Some(override_)) => override_,
1354                 _ => style,
1355             }
1356         }
1357
1358         let mut line_number = 0;
1359
1360         // Provided the following diagnostic message:
1361         //
1362         //     let msg = vec![
1363         //       ("
1364         //       ("highlighted multiline\nstring to\nsee how it ", Style::NoStyle),
1365         //       ("looks", Style::Highlight),
1366         //       ("with\nvery ", Style::NoStyle),
1367         //       ("weird", Style::Highlight),
1368         //       (" formats\n", Style::NoStyle),
1369         //       ("see?", Style::Highlight),
1370         //     ];
1371         //
1372         // the expected output on a note is (* surround the highlighted text)
1373         //
1374         //        = note: highlighted multiline
1375         //                string to
1376         //                see how it *looks* with
1377         //                very *weird* formats
1378         //                see?
1379         for &(ref text, ref style) in msg.iter() {
1380             let text = self.translate_message(text, args);
1381             let lines = text.split('\n').collect::<Vec<_>>();
1382             if lines.len() > 1 {
1383                 for (i, line) in lines.iter().enumerate() {
1384                     if i != 0 {
1385                         line_number += 1;
1386                         buffer.append(line_number, &padding, Style::NoStyle);
1387                     }
1388                     buffer.append(line_number, line, style_or_override(*style, override_style));
1389                 }
1390             } else {
1391                 buffer.append(line_number, &text, style_or_override(*style, override_style));
1392             }
1393         }
1394     }
1395
1396     fn emit_message_default(
1397         &mut self,
1398         msp: &MultiSpan,
1399         msg: &[(DiagnosticMessage, Style)],
1400         args: &FluentArgs<'_>,
1401         code: &Option<DiagnosticId>,
1402         level: &Level,
1403         max_line_num_len: usize,
1404         is_secondary: bool,
1405     ) -> io::Result<()> {
1406         let mut buffer = StyledBuffer::new();
1407
1408         if !msp.has_primary_spans() && !msp.has_span_labels() && is_secondary && !self.short_message
1409         {
1410             // This is a secondary message with no span info
1411             for _ in 0..max_line_num_len {
1412                 buffer.prepend(0, " ", Style::NoStyle);
1413             }
1414             draw_note_separator(&mut buffer, 0, max_line_num_len + 1);
1415             if *level != Level::FailureNote {
1416                 buffer.append(0, level.to_str(), Style::MainHeaderMsg);
1417                 buffer.append(0, ": ", Style::NoStyle);
1418             }
1419             self.msg_to_buffer(&mut buffer, msg, args, max_line_num_len, "note", None);
1420         } else {
1421             let mut label_width = 0;
1422             // The failure note level itself does not provide any useful diagnostic information
1423             if *level != Level::FailureNote {
1424                 buffer.append(0, level.to_str(), Style::Level(*level));
1425                 label_width += level.to_str().len();
1426             }
1427             // only render error codes, not lint codes
1428             if let Some(DiagnosticId::Error(ref code)) = *code {
1429                 buffer.append(0, "[", Style::Level(*level));
1430                 buffer.append(0, &code, Style::Level(*level));
1431                 buffer.append(0, "]", Style::Level(*level));
1432                 label_width += 2 + code.len();
1433             }
1434             let header_style = if is_secondary { Style::HeaderMsg } else { Style::MainHeaderMsg };
1435             if *level != Level::FailureNote {
1436                 buffer.append(0, ": ", header_style);
1437                 label_width += 2;
1438             }
1439             for &(ref text, _) in msg.iter() {
1440                 let text = self.translate_message(text, args);
1441                 // Account for newlines to align output to its label.
1442                 for (line, text) in normalize_whitespace(&text).lines().enumerate() {
1443                     buffer.append(
1444                         0 + line,
1445                         &format!(
1446                             "{}{}",
1447                             if line == 0 { String::new() } else { " ".repeat(label_width) },
1448                             text
1449                         ),
1450                         header_style,
1451                     );
1452                 }
1453             }
1454         }
1455
1456         let mut annotated_files = FileWithAnnotatedLines::collect_annotations(self, args, msp);
1457
1458         // Make sure our primary file comes first
1459         let (primary_lo, sm) = if let (Some(sm), Some(ref primary_span)) =
1460             (self.sm.as_ref(), msp.primary_span().as_ref())
1461         {
1462             if !primary_span.is_dummy() {
1463                 (sm.lookup_char_pos(primary_span.lo()), sm)
1464             } else {
1465                 emit_to_destination(&buffer.render(), level, &mut self.dst, self.short_message)?;
1466                 return Ok(());
1467             }
1468         } else {
1469             // If we don't have span information, emit and exit
1470             emit_to_destination(&buffer.render(), level, &mut self.dst, self.short_message)?;
1471             return Ok(());
1472         };
1473         if let Ok(pos) =
1474             annotated_files.binary_search_by(|x| x.file.name.cmp(&primary_lo.file.name))
1475         {
1476             annotated_files.swap(0, pos);
1477         }
1478
1479         // Print out the annotate source lines that correspond with the error
1480         for annotated_file in annotated_files {
1481             // we can't annotate anything if the source is unavailable.
1482             if !sm.ensure_source_file_source_present(annotated_file.file.clone()) {
1483                 continue;
1484             }
1485
1486             // print out the span location and spacer before we print the annotated source
1487             // to do this, we need to know if this span will be primary
1488             let is_primary = primary_lo.file.name == annotated_file.file.name;
1489             if is_primary {
1490                 let loc = primary_lo.clone();
1491                 if !self.short_message {
1492                     // remember where we are in the output buffer for easy reference
1493                     let buffer_msg_line_offset = buffer.num_lines();
1494
1495                     buffer.prepend(buffer_msg_line_offset, "--> ", Style::LineNumber);
1496                     buffer.append(
1497                         buffer_msg_line_offset,
1498                         &format!(
1499                             "{}:{}:{}",
1500                             sm.filename_for_diagnostics(&loc.file.name),
1501                             sm.doctest_offset_line(&loc.file.name, loc.line),
1502                             loc.col.0 + 1,
1503                         ),
1504                         Style::LineAndColumn,
1505                     );
1506                     for _ in 0..max_line_num_len {
1507                         buffer.prepend(buffer_msg_line_offset, " ", Style::NoStyle);
1508                     }
1509                 } else {
1510                     buffer.prepend(
1511                         0,
1512                         &format!(
1513                             "{}:{}:{}: ",
1514                             sm.filename_for_diagnostics(&loc.file.name),
1515                             sm.doctest_offset_line(&loc.file.name, loc.line),
1516                             loc.col.0 + 1,
1517                         ),
1518                         Style::LineAndColumn,
1519                     );
1520                 }
1521             } else if !self.short_message {
1522                 // remember where we are in the output buffer for easy reference
1523                 let buffer_msg_line_offset = buffer.num_lines();
1524
1525                 // Add spacing line
1526                 draw_col_separator_no_space(
1527                     &mut buffer,
1528                     buffer_msg_line_offset,
1529                     max_line_num_len + 1,
1530                 );
1531
1532                 // Then, the secondary file indicator
1533                 buffer.prepend(buffer_msg_line_offset + 1, "::: ", Style::LineNumber);
1534                 let loc = if let Some(first_line) = annotated_file.lines.first() {
1535                     let col = if let Some(first_annotation) = first_line.annotations.first() {
1536                         format!(":{}", first_annotation.start_col + 1)
1537                     } else {
1538                         String::new()
1539                     };
1540                     format!(
1541                         "{}:{}{}",
1542                         sm.filename_for_diagnostics(&annotated_file.file.name),
1543                         sm.doctest_offset_line(&annotated_file.file.name, first_line.line_index),
1544                         col
1545                     )
1546                 } else {
1547                     format!("{}", sm.filename_for_diagnostics(&annotated_file.file.name))
1548                 };
1549                 buffer.append(buffer_msg_line_offset + 1, &loc, Style::LineAndColumn);
1550                 for _ in 0..max_line_num_len {
1551                     buffer.prepend(buffer_msg_line_offset + 1, " ", Style::NoStyle);
1552                 }
1553             }
1554
1555             if !self.short_message {
1556                 // Put in the spacer between the location and annotated source
1557                 let buffer_msg_line_offset = buffer.num_lines();
1558                 draw_col_separator_no_space(
1559                     &mut buffer,
1560                     buffer_msg_line_offset,
1561                     max_line_num_len + 1,
1562                 );
1563
1564                 // Contains the vertical lines' positions for active multiline annotations
1565                 let mut multilines = FxHashMap::default();
1566
1567                 // Get the left-side margin to remove it
1568                 let mut whitespace_margin = usize::MAX;
1569                 for line_idx in 0..annotated_file.lines.len() {
1570                     let file = annotated_file.file.clone();
1571                     let line = &annotated_file.lines[line_idx];
1572                     if let Some(source_string) = file.get_line(line.line_index - 1) {
1573                         let leading_whitespace = source_string
1574                             .chars()
1575                             .take_while(|c| c.is_whitespace())
1576                             .map(|c| {
1577                                 match c {
1578                                     // Tabs are displayed as 4 spaces
1579                                     '\t' => 4,
1580                                     _ => 1,
1581                                 }
1582                             })
1583                             .sum();
1584                         if source_string.chars().any(|c| !c.is_whitespace()) {
1585                             whitespace_margin = min(whitespace_margin, leading_whitespace);
1586                         }
1587                     }
1588                 }
1589                 if whitespace_margin == usize::MAX {
1590                     whitespace_margin = 0;
1591                 }
1592
1593                 // Left-most column any visible span points at.
1594                 let mut span_left_margin = usize::MAX;
1595                 for line in &annotated_file.lines {
1596                     for ann in &line.annotations {
1597                         span_left_margin = min(span_left_margin, ann.start_col);
1598                         span_left_margin = min(span_left_margin, ann.end_col);
1599                     }
1600                 }
1601                 if span_left_margin == usize::MAX {
1602                     span_left_margin = 0;
1603                 }
1604
1605                 // Right-most column any visible span points at.
1606                 let mut span_right_margin = 0;
1607                 let mut label_right_margin = 0;
1608                 let mut max_line_len = 0;
1609                 for line in &annotated_file.lines {
1610                     max_line_len = max(
1611                         max_line_len,
1612                         annotated_file.file.get_line(line.line_index - 1).map_or(0, |s| s.len()),
1613                     );
1614                     for ann in &line.annotations {
1615                         span_right_margin = max(span_right_margin, ann.start_col);
1616                         span_right_margin = max(span_right_margin, ann.end_col);
1617                         // FIXME: account for labels not in the same line
1618                         let label_right = ann.label.as_ref().map_or(0, |l| l.len() + 1);
1619                         label_right_margin = max(label_right_margin, ann.end_col + label_right);
1620                     }
1621                 }
1622
1623                 let width_offset = 3 + max_line_num_len;
1624                 let code_offset = if annotated_file.multiline_depth == 0 {
1625                     width_offset
1626                 } else {
1627                     width_offset + annotated_file.multiline_depth + 1
1628                 };
1629
1630                 let column_width = if let Some(width) = self.diagnostic_width {
1631                     width.saturating_sub(code_offset)
1632                 } else if self.ui_testing {
1633                     DEFAULT_COLUMN_WIDTH
1634                 } else {
1635                     termize::dimensions()
1636                         .map(|(w, _)| w.saturating_sub(code_offset))
1637                         .unwrap_or(DEFAULT_COLUMN_WIDTH)
1638                 };
1639
1640                 let margin = Margin::new(
1641                     whitespace_margin,
1642                     span_left_margin,
1643                     span_right_margin,
1644                     label_right_margin,
1645                     column_width,
1646                     max_line_len,
1647                 );
1648
1649                 // Next, output the annotate source for this file
1650                 for line_idx in 0..annotated_file.lines.len() {
1651                     let previous_buffer_line = buffer.num_lines();
1652
1653                     let depths = self.render_source_line(
1654                         &mut buffer,
1655                         annotated_file.file.clone(),
1656                         &annotated_file.lines[line_idx],
1657                         width_offset,
1658                         code_offset,
1659                         margin,
1660                     );
1661
1662                     let mut to_add = FxHashMap::default();
1663
1664                     for (depth, style) in depths {
1665                         if multilines.remove(&depth).is_none() {
1666                             to_add.insert(depth, style);
1667                         }
1668                     }
1669
1670                     // Set the multiline annotation vertical lines to the left of
1671                     // the code in this line.
1672                     for (depth, style) in &multilines {
1673                         for line in previous_buffer_line..buffer.num_lines() {
1674                             draw_multiline_line(&mut buffer, line, width_offset, *depth, *style);
1675                         }
1676                     }
1677                     // check to see if we need to print out or elide lines that come between
1678                     // this annotated line and the next one.
1679                     if line_idx < (annotated_file.lines.len() - 1) {
1680                         let line_idx_delta = annotated_file.lines[line_idx + 1].line_index
1681                             - annotated_file.lines[line_idx].line_index;
1682                         if line_idx_delta > 2 {
1683                             let last_buffer_line_num = buffer.num_lines();
1684                             buffer.puts(last_buffer_line_num, 0, "...", Style::LineNumber);
1685
1686                             // Set the multiline annotation vertical lines on `...` bridging line.
1687                             for (depth, style) in &multilines {
1688                                 draw_multiline_line(
1689                                     &mut buffer,
1690                                     last_buffer_line_num,
1691                                     width_offset,
1692                                     *depth,
1693                                     *style,
1694                                 );
1695                             }
1696                         } else if line_idx_delta == 2 {
1697                             let unannotated_line = annotated_file
1698                                 .file
1699                                 .get_line(annotated_file.lines[line_idx].line_index)
1700                                 .unwrap_or_else(|| Cow::from(""));
1701
1702                             let last_buffer_line_num = buffer.num_lines();
1703
1704                             self.draw_line(
1705                                 &mut buffer,
1706                                 &normalize_whitespace(&unannotated_line),
1707                                 annotated_file.lines[line_idx + 1].line_index - 1,
1708                                 last_buffer_line_num,
1709                                 width_offset,
1710                                 code_offset,
1711                                 margin,
1712                             );
1713
1714                             for (depth, style) in &multilines {
1715                                 draw_multiline_line(
1716                                     &mut buffer,
1717                                     last_buffer_line_num,
1718                                     width_offset,
1719                                     *depth,
1720                                     *style,
1721                                 );
1722                             }
1723                         }
1724                     }
1725
1726                     multilines.extend(&to_add);
1727                 }
1728             }
1729         }
1730
1731         // final step: take our styled buffer, render it, then output it
1732         emit_to_destination(&buffer.render(), level, &mut self.dst, self.short_message)?;
1733
1734         Ok(())
1735     }
1736
1737     fn emit_suggestion_default(
1738         &mut self,
1739         span: &MultiSpan,
1740         suggestion: &CodeSuggestion,
1741         args: &FluentArgs<'_>,
1742         level: &Level,
1743         max_line_num_len: usize,
1744     ) -> io::Result<()> {
1745         let Some(ref sm) = self.sm else {
1746             return Ok(());
1747         };
1748
1749         // Render the replacements for each suggestion
1750         let suggestions = suggestion.splice_lines(&**sm);
1751         debug!("emit_suggestion_default: suggestions={:?}", suggestions);
1752
1753         if suggestions.is_empty() {
1754             // Suggestions coming from macros can have malformed spans. This is a heavy handed
1755             // approach to avoid ICEs by ignoring the suggestion outright.
1756             return Ok(());
1757         }
1758
1759         let mut buffer = StyledBuffer::new();
1760
1761         // Render the suggestion message
1762         buffer.append(0, level.to_str(), Style::Level(*level));
1763         buffer.append(0, ": ", Style::HeaderMsg);
1764
1765         self.msg_to_buffer(
1766             &mut buffer,
1767             &[(suggestion.msg.to_owned(), Style::NoStyle)],
1768             args,
1769             max_line_num_len,
1770             "suggestion",
1771             Some(Style::HeaderMsg),
1772         );
1773
1774         let mut row_num = 2;
1775         draw_col_separator_no_space(&mut buffer, 1, max_line_num_len + 1);
1776         let mut notice_capitalization = false;
1777         for (complete, parts, highlights, only_capitalization) in
1778             suggestions.iter().take(MAX_SUGGESTIONS)
1779         {
1780             notice_capitalization |= only_capitalization;
1781
1782             let has_deletion = parts.iter().any(|p| p.is_deletion());
1783             let is_multiline = complete.lines().count() > 1;
1784
1785             if let Some(span) = span.primary_span() {
1786                 // Compare the primary span of the diagnostic with the span of the suggestion
1787                 // being emitted.  If they belong to the same file, we don't *need* to show the
1788                 // file name, saving in verbosity, but if it *isn't* we do need it, otherwise we're
1789                 // telling users to make a change but not clarifying *where*.
1790                 let loc = sm.lookup_char_pos(parts[0].span.lo());
1791                 if loc.file.name != sm.span_to_filename(span) && loc.file.name.is_real() {
1792                     buffer.puts(row_num - 1, 0, "--> ", Style::LineNumber);
1793                     buffer.append(
1794                         row_num - 1,
1795                         &format!(
1796                             "{}:{}:{}",
1797                             sm.filename_for_diagnostics(&loc.file.name),
1798                             sm.doctest_offset_line(&loc.file.name, loc.line),
1799                             loc.col.0 + 1,
1800                         ),
1801                         Style::LineAndColumn,
1802                     );
1803                     for _ in 0..max_line_num_len {
1804                         buffer.prepend(row_num - 1, " ", Style::NoStyle);
1805                     }
1806                     row_num += 1;
1807                 }
1808             }
1809             let show_code_change = if has_deletion && !is_multiline {
1810                 DisplaySuggestion::Diff
1811             } else if (parts.len() != 1 || parts[0].snippet.trim() != complete.trim())
1812                 && !is_multiline
1813             {
1814                 DisplaySuggestion::Underline
1815             } else {
1816                 DisplaySuggestion::None
1817             };
1818
1819             if let DisplaySuggestion::Diff = show_code_change {
1820                 row_num += 1;
1821             }
1822
1823             let file_lines = sm
1824                 .span_to_lines(parts[0].span)
1825                 .expect("span_to_lines failed when emitting suggestion");
1826
1827             assert!(!file_lines.lines.is_empty() || parts[0].span.is_dummy());
1828
1829             let line_start = sm.lookup_char_pos(parts[0].span.lo()).line;
1830             draw_col_separator_no_space(&mut buffer, row_num - 1, max_line_num_len + 1);
1831             let mut lines = complete.lines();
1832             if lines.clone().next().is_none() {
1833                 // Account for a suggestion to completely remove a line(s) with whitespace (#94192).
1834                 let line_end = sm.lookup_char_pos(parts[0].span.hi()).line;
1835                 for line in line_start..=line_end {
1836                     buffer.puts(
1837                         row_num - 1 + line - line_start,
1838                         0,
1839                         &self.maybe_anonymized(line),
1840                         Style::LineNumber,
1841                     );
1842                     buffer.puts(
1843                         row_num - 1 + line - line_start,
1844                         max_line_num_len + 1,
1845                         "- ",
1846                         Style::Removal,
1847                     );
1848                     buffer.puts(
1849                         row_num - 1 + line - line_start,
1850                         max_line_num_len + 3,
1851                         &normalize_whitespace(&*file_lines.file.get_line(line - 1).unwrap()),
1852                         Style::Removal,
1853                     );
1854                 }
1855                 row_num += line_end - line_start;
1856             }
1857             let mut unhighlighted_lines = Vec::new();
1858             for (line_pos, (line, highlight_parts)) in lines.by_ref().zip(highlights).enumerate() {
1859                 debug!(%line_pos, %line, ?highlight_parts);
1860
1861                 // Remember lines that are not highlighted to hide them if needed
1862                 if highlight_parts.is_empty() {
1863                     unhighlighted_lines.push((line_pos, line));
1864                     continue;
1865                 }
1866
1867                 match unhighlighted_lines.len() {
1868                     0 => (),
1869                     // Since we show first line, "..." line and last line,
1870                     // There is no reason to hide if there are 3 or less lines
1871                     // (because then we just replace a line with ... which is
1872                     // not helpful)
1873                     n if n <= 3 => unhighlighted_lines.drain(..).for_each(|(p, l)| {
1874                         self.draw_code_line(
1875                             &mut buffer,
1876                             &mut row_num,
1877                             &Vec::new(),
1878                             p,
1879                             l,
1880                             line_start,
1881                             show_code_change,
1882                             max_line_num_len,
1883                             &file_lines,
1884                             is_multiline,
1885                         )
1886                     }),
1887                     // Print first unhighlighted line, "..." and last unhighlighted line, like so:
1888                     //
1889                     // LL | this line was highlighted
1890                     // LL | this line is just for context
1891                     //   ...
1892                     // LL | this line is just for context
1893                     // LL | this line was highlighted
1894                     _ => {
1895                         let last_line = unhighlighted_lines.pop();
1896                         let first_line = unhighlighted_lines.drain(..).next();
1897
1898                         first_line.map(|(p, l)| {
1899                             self.draw_code_line(
1900                                 &mut buffer,
1901                                 &mut row_num,
1902                                 &Vec::new(),
1903                                 p,
1904                                 l,
1905                                 line_start,
1906                                 show_code_change,
1907                                 max_line_num_len,
1908                                 &file_lines,
1909                                 is_multiline,
1910                             )
1911                         });
1912
1913                         buffer.puts(row_num, max_line_num_len - 1, "...", Style::LineNumber);
1914                         row_num += 1;
1915
1916                         last_line.map(|(p, l)| {
1917                             self.draw_code_line(
1918                                 &mut buffer,
1919                                 &mut row_num,
1920                                 &Vec::new(),
1921                                 p,
1922                                 l,
1923                                 line_start,
1924                                 show_code_change,
1925                                 max_line_num_len,
1926                                 &file_lines,
1927                                 is_multiline,
1928                             )
1929                         });
1930                     }
1931                 }
1932
1933                 self.draw_code_line(
1934                     &mut buffer,
1935                     &mut row_num,
1936                     highlight_parts,
1937                     line_pos,
1938                     line,
1939                     line_start,
1940                     show_code_change,
1941                     max_line_num_len,
1942                     &file_lines,
1943                     is_multiline,
1944                 )
1945             }
1946
1947             // This offset and the ones below need to be signed to account for replacement code
1948             // that is shorter than the original code.
1949             let mut offsets: Vec<(usize, isize)> = Vec::new();
1950             // Only show an underline in the suggestions if the suggestion is not the
1951             // entirety of the code being shown and the displayed code is not multiline.
1952             if let DisplaySuggestion::Diff | DisplaySuggestion::Underline = show_code_change {
1953                 draw_col_separator_no_space(&mut buffer, row_num, max_line_num_len + 1);
1954                 for part in parts {
1955                     let span_start_pos = sm.lookup_char_pos(part.span.lo()).col_display;
1956                     let span_end_pos = sm.lookup_char_pos(part.span.hi()).col_display;
1957
1958                     // Do not underline the leading...
1959                     let start = part.snippet.len().saturating_sub(part.snippet.trim_start().len());
1960                     // ...or trailing spaces. Account for substitutions containing unicode
1961                     // characters.
1962                     let sub_len: usize = part
1963                         .snippet
1964                         .trim()
1965                         .chars()
1966                         .map(|ch| unicode_width::UnicodeWidthChar::width(ch).unwrap_or(1))
1967                         .sum();
1968
1969                     let offset: isize = offsets
1970                         .iter()
1971                         .filter_map(
1972                             |(start, v)| if span_start_pos <= *start { None } else { Some(v) },
1973                         )
1974                         .sum();
1975                     let underline_start = (span_start_pos + start) as isize + offset;
1976                     let underline_end = (span_start_pos + start + sub_len) as isize + offset;
1977                     assert!(underline_start >= 0 && underline_end >= 0);
1978                     let padding: usize = max_line_num_len + 3;
1979                     for p in underline_start..underline_end {
1980                         if let DisplaySuggestion::Underline = show_code_change {
1981                             // If this is a replacement, underline with `^`, if this is an addition
1982                             // underline with `+`.
1983                             buffer.putc(
1984                                 row_num,
1985                                 (padding as isize + p) as usize,
1986                                 if part.is_addition(&sm) { '+' } else { '~' },
1987                                 Style::Addition,
1988                             );
1989                         }
1990                     }
1991                     if let DisplaySuggestion::Diff = show_code_change {
1992                         // Colorize removal with red in diff format.
1993                         buffer.set_style_range(
1994                             row_num - 2,
1995                             (padding as isize + span_start_pos as isize) as usize,
1996                             (padding as isize + span_end_pos as isize) as usize,
1997                             Style::Removal,
1998                             true,
1999                         );
2000                     }
2001
2002                     // length of the code after substitution
2003                     let full_sub_len = part
2004                         .snippet
2005                         .chars()
2006                         .map(|ch| unicode_width::UnicodeWidthChar::width(ch).unwrap_or(1))
2007                         .sum::<usize>() as isize;
2008
2009                     // length of the code to be substituted
2010                     let snippet_len = span_end_pos as isize - span_start_pos as isize;
2011                     // For multiple substitutions, use the position *after* the previous
2012                     // substitutions have happened, only when further substitutions are
2013                     // located strictly after.
2014                     offsets.push((span_end_pos, full_sub_len - snippet_len));
2015                 }
2016                 row_num += 1;
2017             }
2018
2019             // if we elided some lines, add an ellipsis
2020             if lines.next().is_some() {
2021                 buffer.puts(row_num, max_line_num_len - 1, "...", Style::LineNumber);
2022             } else if let DisplaySuggestion::None = show_code_change {
2023                 draw_col_separator_no_space(&mut buffer, row_num, max_line_num_len + 1);
2024                 row_num += 1;
2025             }
2026         }
2027         if suggestions.len() > MAX_SUGGESTIONS {
2028             let others = suggestions.len() - MAX_SUGGESTIONS;
2029             let msg = format!("and {} other candidate{}", others, pluralize!(others));
2030             buffer.puts(row_num, max_line_num_len + 3, &msg, Style::NoStyle);
2031         } else if notice_capitalization {
2032             let msg = "notice the capitalization difference";
2033             buffer.puts(row_num, max_line_num_len + 3, &msg, Style::NoStyle);
2034         }
2035         emit_to_destination(&buffer.render(), level, &mut self.dst, self.short_message)?;
2036         Ok(())
2037     }
2038
2039     fn emit_messages_default(
2040         &mut self,
2041         level: &Level,
2042         message: &[(DiagnosticMessage, Style)],
2043         args: &FluentArgs<'_>,
2044         code: &Option<DiagnosticId>,
2045         span: &MultiSpan,
2046         children: &[SubDiagnostic],
2047         suggestions: &[CodeSuggestion],
2048     ) {
2049         let max_line_num_len = if self.ui_testing {
2050             ANONYMIZED_LINE_NUM.len()
2051         } else {
2052             let n = self.get_max_line_num(span, children);
2053             num_decimal_digits(n)
2054         };
2055
2056         match self.emit_message_default(span, message, args, code, level, max_line_num_len, false) {
2057             Ok(()) => {
2058                 if !children.is_empty()
2059                     || suggestions.iter().any(|s| s.style != SuggestionStyle::CompletelyHidden)
2060                 {
2061                     let mut buffer = StyledBuffer::new();
2062                     if !self.short_message {
2063                         draw_col_separator_no_space(&mut buffer, 0, max_line_num_len + 1);
2064                     }
2065                     if let Err(e) = emit_to_destination(
2066                         &buffer.render(),
2067                         level,
2068                         &mut self.dst,
2069                         self.short_message,
2070                     ) {
2071                         panic!("failed to emit error: {}", e)
2072                     }
2073                 }
2074                 if !self.short_message {
2075                     for child in children {
2076                         let span = child.render_span.as_ref().unwrap_or(&child.span);
2077                         if let Err(err) = self.emit_message_default(
2078                             &span,
2079                             &child.message,
2080                             args,
2081                             &None,
2082                             &child.level,
2083                             max_line_num_len,
2084                             true,
2085                         ) {
2086                             panic!("failed to emit error: {}", err);
2087                         }
2088                     }
2089                     for sugg in suggestions {
2090                         if sugg.style == SuggestionStyle::CompletelyHidden {
2091                             // do not display this suggestion, it is meant only for tools
2092                         } else if sugg.style == SuggestionStyle::HideCodeAlways {
2093                             if let Err(e) = self.emit_message_default(
2094                                 &MultiSpan::new(),
2095                                 &[(sugg.msg.to_owned(), Style::HeaderMsg)],
2096                                 args,
2097                                 &None,
2098                                 &Level::Help,
2099                                 max_line_num_len,
2100                                 true,
2101                             ) {
2102                                 panic!("failed to emit error: {}", e);
2103                             }
2104                         } else if let Err(e) = self.emit_suggestion_default(
2105                             span,
2106                             sugg,
2107                             args,
2108                             &Level::Help,
2109                             max_line_num_len,
2110                         ) {
2111                             panic!("failed to emit error: {}", e);
2112                         };
2113                     }
2114                 }
2115             }
2116             Err(e) => panic!("failed to emit error: {}", e),
2117         }
2118
2119         let mut dst = self.dst.writable();
2120         match writeln!(dst) {
2121             Err(e) => panic!("failed to emit error: {}", e),
2122             _ => {
2123                 if let Err(e) = dst.flush() {
2124                     panic!("failed to emit error: {}", e)
2125                 }
2126             }
2127         }
2128     }
2129
2130     fn draw_code_line(
2131         &self,
2132         buffer: &mut StyledBuffer,
2133         row_num: &mut usize,
2134         highlight_parts: &Vec<SubstitutionHighlight>,
2135         line_pos: usize,
2136         line: &str,
2137         line_start: usize,
2138         show_code_change: DisplaySuggestion,
2139         max_line_num_len: usize,
2140         file_lines: &FileLines,
2141         is_multiline: bool,
2142     ) {
2143         // Print the span column to avoid confusion
2144         buffer.puts(*row_num, 0, &self.maybe_anonymized(line_start + line_pos), Style::LineNumber);
2145         if let DisplaySuggestion::Diff = show_code_change {
2146             // Add the line number for both addition and removal to drive the point home.
2147             //
2148             // N - fn foo<A: T>(bar: A) {
2149             // N + fn foo(bar: impl T) {
2150             buffer.puts(
2151                 *row_num - 1,
2152                 0,
2153                 &self.maybe_anonymized(line_start + line_pos),
2154                 Style::LineNumber,
2155             );
2156             buffer.puts(*row_num - 1, max_line_num_len + 1, "- ", Style::Removal);
2157             buffer.puts(
2158                 *row_num - 1,
2159                 max_line_num_len + 3,
2160                 &normalize_whitespace(
2161                     &*file_lines.file.get_line(file_lines.lines[line_pos].line_index).unwrap(),
2162                 ),
2163                 Style::NoStyle,
2164             );
2165             buffer.puts(*row_num, max_line_num_len + 1, "+ ", Style::Addition);
2166         } else if is_multiline {
2167             match &highlight_parts[..] {
2168                 [SubstitutionHighlight { start: 0, end }] if *end == line.len() => {
2169                     buffer.puts(*row_num, max_line_num_len + 1, "+ ", Style::Addition);
2170                 }
2171                 [] => {
2172                     draw_col_separator(buffer, *row_num, max_line_num_len + 1);
2173                 }
2174                 _ => {
2175                     buffer.puts(*row_num, max_line_num_len + 1, "~ ", Style::Addition);
2176                 }
2177             }
2178         } else {
2179             draw_col_separator(buffer, *row_num, max_line_num_len + 1);
2180         }
2181
2182         // print the suggestion
2183         buffer.append(*row_num, &normalize_whitespace(line), Style::NoStyle);
2184
2185         // Colorize addition/replacements with green.
2186         for &SubstitutionHighlight { start, end } in highlight_parts {
2187             // Account for tabs when highlighting (#87972).
2188             let tabs: usize = line
2189                 .chars()
2190                 .take(start)
2191                 .map(|ch| match ch {
2192                     '\t' => 3,
2193                     _ => 0,
2194                 })
2195                 .sum();
2196             buffer.set_style_range(
2197                 *row_num,
2198                 max_line_num_len + 3 + start + tabs,
2199                 max_line_num_len + 3 + end + tabs,
2200                 Style::Addition,
2201                 true,
2202             );
2203         }
2204         *row_num += 1;
2205     }
2206 }
2207
2208 #[derive(Clone, Copy)]
2209 enum DisplaySuggestion {
2210     Underline,
2211     Diff,
2212     None,
2213 }
2214
2215 impl FileWithAnnotatedLines {
2216     /// Preprocess all the annotations so that they are grouped by file and by line number
2217     /// This helps us quickly iterate over the whole message (including secondary file spans)
2218     pub fn collect_annotations(
2219         emitter: &dyn Emitter,
2220         args: &FluentArgs<'_>,
2221         msp: &MultiSpan,
2222     ) -> Vec<FileWithAnnotatedLines> {
2223         fn add_annotation_to_file(
2224             file_vec: &mut Vec<FileWithAnnotatedLines>,
2225             file: Lrc<SourceFile>,
2226             line_index: usize,
2227             ann: Annotation,
2228         ) {
2229             for slot in file_vec.iter_mut() {
2230                 // Look through each of our files for the one we're adding to
2231                 if slot.file.name == file.name {
2232                     // See if we already have a line for it
2233                     for line_slot in &mut slot.lines {
2234                         if line_slot.line_index == line_index {
2235                             line_slot.annotations.push(ann);
2236                             return;
2237                         }
2238                     }
2239                     // We don't have a line yet, create one
2240                     slot.lines.push(Line { line_index, annotations: vec![ann] });
2241                     slot.lines.sort();
2242                     return;
2243                 }
2244             }
2245             // This is the first time we're seeing the file
2246             file_vec.push(FileWithAnnotatedLines {
2247                 file,
2248                 lines: vec![Line { line_index, annotations: vec![ann] }],
2249                 multiline_depth: 0,
2250             });
2251         }
2252
2253         let mut output = vec![];
2254         let mut multiline_annotations = vec![];
2255
2256         if let Some(ref sm) = emitter.source_map() {
2257             for span_label in msp.span_labels() {
2258                 if span_label.span.is_dummy() {
2259                     continue;
2260                 }
2261
2262                 let lo = sm.lookup_char_pos(span_label.span.lo());
2263                 let mut hi = sm.lookup_char_pos(span_label.span.hi());
2264
2265                 // Watch out for "empty spans". If we get a span like 6..6, we
2266                 // want to just display a `^` at 6, so convert that to
2267                 // 6..7. This is degenerate input, but it's best to degrade
2268                 // gracefully -- and the parser likes to supply a span like
2269                 // that for EOF, in particular.
2270
2271                 if lo.col_display == hi.col_display && lo.line == hi.line {
2272                     hi.col_display += 1;
2273                 }
2274
2275                 if lo.line != hi.line {
2276                     let ml = MultilineAnnotation {
2277                         depth: 1,
2278                         line_start: lo.line,
2279                         line_end: hi.line,
2280                         start_col: lo.col_display,
2281                         end_col: hi.col_display,
2282                         is_primary: span_label.is_primary,
2283                         label: span_label
2284                             .label
2285                             .as_ref()
2286                             .map(|m| emitter.translate_message(m, args).to_string()),
2287                         overlaps_exactly: false,
2288                     };
2289                     multiline_annotations.push((lo.file, ml));
2290                 } else {
2291                     let ann = Annotation {
2292                         start_col: lo.col_display,
2293                         end_col: hi.col_display,
2294                         is_primary: span_label.is_primary,
2295                         label: span_label
2296                             .label
2297                             .as_ref()
2298                             .map(|m| emitter.translate_message(m, args).to_string()),
2299                         annotation_type: AnnotationType::Singleline,
2300                     };
2301                     add_annotation_to_file(&mut output, lo.file, lo.line, ann);
2302                 };
2303             }
2304         }
2305
2306         // Find overlapping multiline annotations, put them at different depths
2307         multiline_annotations.sort_by_key(|&(_, ref ml)| (ml.line_start, ml.line_end));
2308         for (_, ann) in multiline_annotations.clone() {
2309             for (_, a) in multiline_annotations.iter_mut() {
2310                 // Move all other multiline annotations overlapping with this one
2311                 // one level to the right.
2312                 if !(ann.same_span(a))
2313                     && num_overlap(ann.line_start, ann.line_end, a.line_start, a.line_end, true)
2314                 {
2315                     a.increase_depth();
2316                 } else if ann.same_span(a) && &ann != a {
2317                     a.overlaps_exactly = true;
2318                 } else {
2319                     break;
2320                 }
2321             }
2322         }
2323
2324         let mut max_depth = 0; // max overlapping multiline spans
2325         for (file, ann) in multiline_annotations {
2326             max_depth = max(max_depth, ann.depth);
2327             let mut end_ann = ann.as_end();
2328             if !ann.overlaps_exactly {
2329                 // avoid output like
2330                 //
2331                 //  |        foo(
2332                 //  |   _____^
2333                 //  |  |_____|
2334                 //  | ||         bar,
2335                 //  | ||     );
2336                 //  | ||      ^
2337                 //  | ||______|
2338                 //  |  |______foo
2339                 //  |         baz
2340                 //
2341                 // and instead get
2342                 //
2343                 //  |       foo(
2344                 //  |  _____^
2345                 //  | |         bar,
2346                 //  | |     );
2347                 //  | |      ^
2348                 //  | |      |
2349                 //  | |______foo
2350                 //  |        baz
2351                 add_annotation_to_file(&mut output, file.clone(), ann.line_start, ann.as_start());
2352                 // 4 is the minimum vertical length of a multiline span when presented: two lines
2353                 // of code and two lines of underline. This is not true for the special case where
2354                 // the beginning doesn't have an underline, but the current logic seems to be
2355                 // working correctly.
2356                 let middle = min(ann.line_start + 4, ann.line_end);
2357                 for line in ann.line_start + 1..middle {
2358                     // Every `|` that joins the beginning of the span (`___^`) to the end (`|__^`).
2359                     add_annotation_to_file(&mut output, file.clone(), line, ann.as_line());
2360                 }
2361                 let line_end = ann.line_end - 1;
2362                 if middle < line_end {
2363                     add_annotation_to_file(&mut output, file.clone(), line_end, ann.as_line());
2364                 }
2365             } else {
2366                 end_ann.annotation_type = AnnotationType::Singleline;
2367             }
2368             add_annotation_to_file(&mut output, file, ann.line_end, end_ann);
2369         }
2370         for file_vec in output.iter_mut() {
2371             file_vec.multiline_depth = max_depth;
2372         }
2373         output
2374     }
2375 }
2376
2377 // instead of taking the String length or dividing by 10 while > 0, we multiply a limit by 10 until
2378 // we're higher. If the loop isn't exited by the `return`, the last multiplication will wrap, which
2379 // is OK, because while we cannot fit a higher power of 10 in a usize, the loop will end anyway.
2380 // This is also why we need the max number of decimal digits within a `usize`.
2381 fn num_decimal_digits(num: usize) -> usize {
2382     #[cfg(target_pointer_width = "64")]
2383     const MAX_DIGITS: usize = 20;
2384
2385     #[cfg(target_pointer_width = "32")]
2386     const MAX_DIGITS: usize = 10;
2387
2388     #[cfg(target_pointer_width = "16")]
2389     const MAX_DIGITS: usize = 5;
2390
2391     let mut lim = 10;
2392     for num_digits in 1..MAX_DIGITS {
2393         if num < lim {
2394             return num_digits;
2395         }
2396         lim = lim.wrapping_mul(10);
2397     }
2398     MAX_DIGITS
2399 }
2400
2401 // We replace some characters so the CLI output is always consistent and underlines aligned.
2402 const OUTPUT_REPLACEMENTS: &[(char, &str)] = &[
2403     ('\t', "    "),   // We do our own tab replacement
2404     ('\u{200D}', ""), // Replace ZWJ with nothing for consistent terminal output of grapheme clusters.
2405     ('\u{202A}', ""), // The following unicode text flow control characters are inconsistently
2406     ('\u{202B}', ""), // supported across CLIs and can cause confusion due to the bytes on disk
2407     ('\u{202D}', ""), // not corresponding to the visible source code, so we replace them always.
2408     ('\u{202E}', ""),
2409     ('\u{2066}', ""),
2410     ('\u{2067}', ""),
2411     ('\u{2068}', ""),
2412     ('\u{202C}', ""),
2413     ('\u{2069}', ""),
2414 ];
2415
2416 fn normalize_whitespace(str: &str) -> String {
2417     let mut s = str.to_string();
2418     for (c, replacement) in OUTPUT_REPLACEMENTS {
2419         s = s.replace(*c, replacement);
2420     }
2421     s
2422 }
2423
2424 fn draw_col_separator(buffer: &mut StyledBuffer, line: usize, col: usize) {
2425     buffer.puts(line, col, "| ", Style::LineNumber);
2426 }
2427
2428 fn draw_col_separator_no_space(buffer: &mut StyledBuffer, line: usize, col: usize) {
2429     draw_col_separator_no_space_with_style(buffer, line, col, Style::LineNumber);
2430 }
2431
2432 fn draw_col_separator_no_space_with_style(
2433     buffer: &mut StyledBuffer,
2434     line: usize,
2435     col: usize,
2436     style: Style,
2437 ) {
2438     buffer.putc(line, col, '|', style);
2439 }
2440
2441 fn draw_range(
2442     buffer: &mut StyledBuffer,
2443     symbol: char,
2444     line: usize,
2445     col_from: usize,
2446     col_to: usize,
2447     style: Style,
2448 ) {
2449     for col in col_from..col_to {
2450         buffer.putc(line, col, symbol, style);
2451     }
2452 }
2453
2454 fn draw_note_separator(buffer: &mut StyledBuffer, line: usize, col: usize) {
2455     buffer.puts(line, col, "= ", Style::LineNumber);
2456 }
2457
2458 fn draw_multiline_line(
2459     buffer: &mut StyledBuffer,
2460     line: usize,
2461     offset: usize,
2462     depth: usize,
2463     style: Style,
2464 ) {
2465     buffer.putc(line, offset + depth - 1, '|', style);
2466 }
2467
2468 fn num_overlap(
2469     a_start: usize,
2470     a_end: usize,
2471     b_start: usize,
2472     b_end: usize,
2473     inclusive: bool,
2474 ) -> bool {
2475     let extra = if inclusive { 1 } else { 0 };
2476     (b_start..b_end + extra).contains(&a_start) || (a_start..a_end + extra).contains(&b_start)
2477 }
2478 fn overlaps(a1: &Annotation, a2: &Annotation, padding: usize) -> bool {
2479     num_overlap(a1.start_col, a1.end_col + padding, a2.start_col, a2.end_col, false)
2480 }
2481
2482 fn emit_to_destination(
2483     rendered_buffer: &[Vec<StyledString>],
2484     lvl: &Level,
2485     dst: &mut Destination,
2486     short_message: bool,
2487 ) -> io::Result<()> {
2488     use crate::lock;
2489
2490     let mut dst = dst.writable();
2491
2492     // In order to prevent error message interleaving, where multiple error lines get intermixed
2493     // when multiple compiler processes error simultaneously, we emit errors with additional
2494     // steps.
2495     //
2496     // On Unix systems, we write into a buffered terminal rather than directly to a terminal. When
2497     // the .flush() is called we take the buffer created from the buffered writes and write it at
2498     // one shot.  Because the Unix systems use ANSI for the colors, which is a text-based styling
2499     // scheme, this buffered approach works and maintains the styling.
2500     //
2501     // On Windows, styling happens through calls to a terminal API. This prevents us from using the
2502     // same buffering approach.  Instead, we use a global Windows mutex, which we acquire long
2503     // enough to output the full error message, then we release.
2504     let _buffer_lock = lock::acquire_global_lock("rustc_errors");
2505     for (pos, line) in rendered_buffer.iter().enumerate() {
2506         for part in line {
2507             dst.apply_style(*lvl, part.style)?;
2508             write!(dst, "{}", part.text)?;
2509             dst.reset()?;
2510         }
2511         if !short_message && (!lvl.is_failure_note() || pos != rendered_buffer.len() - 1) {
2512             writeln!(dst)?;
2513         }
2514     }
2515     dst.flush()?;
2516     Ok(())
2517 }
2518
2519 pub enum Destination {
2520     Terminal(StandardStream),
2521     Buffered(BufferWriter),
2522     // The bool denotes whether we should be emitting ansi color codes or not
2523     Raw(Box<(dyn Write + Send)>, bool),
2524 }
2525
2526 pub enum WritableDst<'a> {
2527     Terminal(&'a mut StandardStream),
2528     Buffered(&'a mut BufferWriter, Buffer),
2529     Raw(&'a mut (dyn Write + Send)),
2530     ColoredRaw(Ansi<&'a mut (dyn Write + Send)>),
2531 }
2532
2533 impl Destination {
2534     fn from_stderr(color: ColorConfig) -> Destination {
2535         let choice = color.to_color_choice();
2536         // On Windows we'll be performing global synchronization on the entire
2537         // system for emitting rustc errors, so there's no need to buffer
2538         // anything.
2539         //
2540         // On non-Windows we rely on the atomicity of `write` to ensure errors
2541         // don't get all jumbled up.
2542         if cfg!(windows) {
2543             Terminal(StandardStream::stderr(choice))
2544         } else {
2545             Buffered(BufferWriter::stderr(choice))
2546         }
2547     }
2548
2549     fn writable(&mut self) -> WritableDst<'_> {
2550         match *self {
2551             Destination::Terminal(ref mut t) => WritableDst::Terminal(t),
2552             Destination::Buffered(ref mut t) => {
2553                 let buf = t.buffer();
2554                 WritableDst::Buffered(t, buf)
2555             }
2556             Destination::Raw(ref mut t, false) => WritableDst::Raw(t),
2557             Destination::Raw(ref mut t, true) => WritableDst::ColoredRaw(Ansi::new(t)),
2558         }
2559     }
2560
2561     fn supports_color(&self) -> bool {
2562         match *self {
2563             Self::Terminal(ref stream) => stream.supports_color(),
2564             Self::Buffered(ref buffer) => buffer.buffer().supports_color(),
2565             Self::Raw(_, supports_color) => supports_color,
2566         }
2567     }
2568 }
2569
2570 impl<'a> WritableDst<'a> {
2571     fn apply_style(&mut self, lvl: Level, style: Style) -> io::Result<()> {
2572         let mut spec = ColorSpec::new();
2573         match style {
2574             Style::Addition => {
2575                 spec.set_fg(Some(Color::Green)).set_intense(true);
2576             }
2577             Style::Removal => {
2578                 spec.set_fg(Some(Color::Red)).set_intense(true);
2579             }
2580             Style::LineAndColumn => {}
2581             Style::LineNumber => {
2582                 spec.set_bold(true);
2583                 spec.set_intense(true);
2584                 if cfg!(windows) {
2585                     spec.set_fg(Some(Color::Cyan));
2586                 } else {
2587                     spec.set_fg(Some(Color::Blue));
2588                 }
2589             }
2590             Style::Quotation => {}
2591             Style::MainHeaderMsg => {
2592                 spec.set_bold(true);
2593                 if cfg!(windows) {
2594                     spec.set_intense(true).set_fg(Some(Color::White));
2595                 }
2596             }
2597             Style::UnderlinePrimary | Style::LabelPrimary => {
2598                 spec = lvl.color();
2599                 spec.set_bold(true);
2600             }
2601             Style::UnderlineSecondary | Style::LabelSecondary => {
2602                 spec.set_bold(true).set_intense(true);
2603                 if cfg!(windows) {
2604                     spec.set_fg(Some(Color::Cyan));
2605                 } else {
2606                     spec.set_fg(Some(Color::Blue));
2607                 }
2608             }
2609             Style::HeaderMsg | Style::NoStyle => {}
2610             Style::Level(lvl) => {
2611                 spec = lvl.color();
2612                 spec.set_bold(true);
2613             }
2614             Style::Highlight => {
2615                 spec.set_bold(true);
2616             }
2617         }
2618         self.set_color(&spec)
2619     }
2620
2621     fn set_color(&mut self, color: &ColorSpec) -> io::Result<()> {
2622         match *self {
2623             WritableDst::Terminal(ref mut t) => t.set_color(color),
2624             WritableDst::Buffered(_, ref mut t) => t.set_color(color),
2625             WritableDst::ColoredRaw(ref mut t) => t.set_color(color),
2626             WritableDst::Raw(_) => Ok(()),
2627         }
2628     }
2629
2630     fn reset(&mut self) -> io::Result<()> {
2631         match *self {
2632             WritableDst::Terminal(ref mut t) => t.reset(),
2633             WritableDst::Buffered(_, ref mut t) => t.reset(),
2634             WritableDst::ColoredRaw(ref mut t) => t.reset(),
2635             WritableDst::Raw(_) => Ok(()),
2636         }
2637     }
2638 }
2639
2640 impl<'a> Write for WritableDst<'a> {
2641     fn write(&mut self, bytes: &[u8]) -> io::Result<usize> {
2642         match *self {
2643             WritableDst::Terminal(ref mut t) => t.write(bytes),
2644             WritableDst::Buffered(_, ref mut buf) => buf.write(bytes),
2645             WritableDst::Raw(ref mut w) => w.write(bytes),
2646             WritableDst::ColoredRaw(ref mut t) => t.write(bytes),
2647         }
2648     }
2649
2650     fn flush(&mut self) -> io::Result<()> {
2651         match *self {
2652             WritableDst::Terminal(ref mut t) => t.flush(),
2653             WritableDst::Buffered(_, ref mut buf) => buf.flush(),
2654             WritableDst::Raw(ref mut w) => w.flush(),
2655             WritableDst::ColoredRaw(ref mut w) => w.flush(),
2656         }
2657     }
2658 }
2659
2660 impl<'a> Drop for WritableDst<'a> {
2661     fn drop(&mut self) {
2662         if let WritableDst::Buffered(ref mut dst, ref mut buf) = self {
2663             drop(dst.print(buf));
2664         }
2665     }
2666 }
2667
2668 /// Whether the original and suggested code are visually similar enough to warrant extra wording.
2669 pub fn is_case_difference(sm: &SourceMap, suggested: &str, sp: Span) -> bool {
2670     // FIXME: this should probably be extended to also account for `FO0` → `FOO` and unicode.
2671     let found = match sm.span_to_snippet(sp) {
2672         Ok(snippet) => snippet,
2673         Err(e) => {
2674             warn!(error = ?e, "Invalid span {:?}", sp);
2675             return false;
2676         }
2677     };
2678     let ascii_confusables = &['c', 'f', 'i', 'k', 'o', 's', 'u', 'v', 'w', 'x', 'y', 'z'];
2679     // All the chars that differ in capitalization are confusable (above):
2680     let confusable = iter::zip(found.chars(), suggested.chars())
2681         .filter(|(f, s)| f != s)
2682         .all(|(f, s)| (ascii_confusables.contains(&f) || ascii_confusables.contains(&s)));
2683     confusable && found.to_lowercase() == suggested.to_lowercase()
2684             // FIXME: We sometimes suggest the same thing we already have, which is a
2685             //        bug, but be defensive against that here.
2686             && found != suggested
2687 }