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