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