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