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