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