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