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