compiler/rustc_errors/src/emitter.rs

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