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