src/librustc_errors/emitter.rs

   1 // Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use self::Destination::*;
  12
  13 use syntax_pos::{DUMMY_SP, FileMap, Span, MultiSpan, CharPos};
  14
  15 use {Level, CodeSuggestion, DiagnosticBuilder, SubDiagnostic, CodeMapper};
  16 use RenderSpan::*;
  17 use snippet::{Annotation, AnnotationType, Line, MultilineAnnotation, StyledString, Style};
  18 use styled_buffer::StyledBuffer;
  19
  20 use std::io::prelude::*;
  21 use std::io;
  22 use std::rc::Rc;
  23 use term;
  24 use std::collections::HashMap;
  25 use std::cmp::min;
  26
  27 /// Emitter trait for emitting errors.
  28 pub trait Emitter {
  29     /// Emit a structured diagnostic.
  30     fn emit(&mut self, db: &DiagnosticBuilder);
  31 }
  32
  33 impl Emitter for EmitterWriter {
  34     fn emit(&mut self, db: &DiagnosticBuilder) {
  35         let mut primary_span = db.span.clone();
  36         let mut children = db.children.clone();
  37
  38         if let Some((sugg, rest)) = db.suggestions.split_first() {
  39             if rest.is_empty() &&
  40                // don't display multipart suggestions as labels
  41                sugg.substitution_parts.len() == 1 &&
  42                // don't display multi-suggestions as labels
  43                sugg.substitutions() == 1 &&
  44                // don't display long messages as labels
  45                sugg.msg.split_whitespace().count() < 10 &&
  46                // don't display multiline suggestions as labels
  47                sugg.substitution_parts[0].substitutions[0].find('\n').is_none() {
  48                 let substitution = &sugg.substitution_parts[0].substitutions[0];
  49                 let msg = format!("help: {} `{}`", sugg.msg, substitution);
  50                 primary_span.push_span_label(sugg.substitution_spans().next().unwrap(), msg);
  51             } else {
  52                 // if there are multiple suggestions, print them all in full
  53                 // to be consistent. We could try to figure out if we can
  54                 // make one (or the first one) inline, but that would give
  55                 // undue importance to a semi-random suggestion
  56                 for sugg in &db.suggestions {
  57                     children.push(SubDiagnostic {
  58                         level: Level::Help,
  59                         message: Vec::new(),
  60                         span: MultiSpan::new(),
  61                         render_span: Some(Suggestion(sugg.clone())),
  62                     });
  63                 }
  64             }
  65         }
  66
  67         self.fix_multispans_in_std_macros(&mut primary_span, &mut children);
  68         self.emit_messages_default(&db.level,
  69                                    &db.styled_message(),
  70                                    &db.code,
  71                                    &primary_span,
  72                                    &children);
  73     }
  74 }
  75
  76 /// maximum number of lines we will print for each error; arbitrary.
  77 pub const MAX_HIGHLIGHT_LINES: usize = 6;
  78 /// maximum number of suggestions to be shown
  79 ///
  80 /// Arbitrary, but taken from trait import suggestion limit
  81 pub const MAX_SUGGESTIONS: usize = 4;
  82
  83 #[derive(Clone, Copy, Debug, PartialEq, Eq)]
  84 pub enum ColorConfig {
  85     Auto,
  86     Always,
  87     Never,
  88 }
  89
  90 impl ColorConfig {
  91     fn use_color(&self) -> bool {
  92         match *self {
  93             ColorConfig::Always => true,
  94             ColorConfig::Never => false,
  95             ColorConfig::Auto => stderr_isatty(),
  96         }
  97     }
  98 }
  99
 100 pub struct EmitterWriter {
 101     dst: Destination,
 102     cm: Option<Rc<CodeMapper>>,
 103 }
 104
 105 struct FileWithAnnotatedLines {
 106     file: Rc<FileMap>,
 107     lines: Vec<Line>,
 108     multiline_depth: usize,
 109 }
 110
 111 impl EmitterWriter {
 112     pub fn stderr(color_config: ColorConfig, code_map: Option<Rc<CodeMapper>>) -> EmitterWriter {
 113         if color_config.use_color() {
 114             let dst = Destination::from_stderr();
 115             EmitterWriter {
 116                 dst: dst,
 117                 cm: code_map,
 118             }
 119         } else {
 120             EmitterWriter {
 121                 dst: Raw(Box::new(io::stderr())),
 122                 cm: code_map,
 123             }
 124         }
 125     }
 126
 127     pub fn new(dst: Box<Write + Send>, code_map: Option<Rc<CodeMapper>>) -> EmitterWriter {
 128         EmitterWriter {
 129             dst: Raw(dst),
 130             cm: code_map,
 131         }
 132     }
 133
 134     fn preprocess_annotations(&self, msp: &MultiSpan) -> Vec<FileWithAnnotatedLines> {
 135         fn add_annotation_to_file(file_vec: &mut Vec<FileWithAnnotatedLines>,
 136                                   file: Rc<FileMap>,
 137                                   line_index: usize,
 138                                   ann: Annotation) {
 139
 140             for slot in file_vec.iter_mut() {
 141                 // Look through each of our files for the one we're adding to
 142                 if slot.file.name == file.name {
 143                     // See if we already have a line for it
 144                     for line_slot in &mut slot.lines {
 145                         if line_slot.line_index == line_index {
 146                             line_slot.annotations.push(ann);
 147                             return;
 148                         }
 149                     }
 150                     // We don't have a line yet, create one
 151                     slot.lines.push(Line {
 152                         line_index: line_index,
 153                         annotations: vec![ann],
 154                     });
 155                     slot.lines.sort();
 156                     return;
 157                 }
 158             }
 159             // This is the first time we're seeing the file
 160             file_vec.push(FileWithAnnotatedLines {
 161                 file: file,
 162                 lines: vec![Line {
 163                                 line_index: line_index,
 164                                 annotations: vec![ann],
 165                             }],
 166                 multiline_depth: 0,
 167             });
 168         }
 169
 170         let mut output = vec![];
 171         let mut multiline_annotations = vec![];
 172
 173         if let Some(ref cm) = self.cm {
 174             for span_label in msp.span_labels() {
 175                 if span_label.span == DUMMY_SP {
 176                     continue;
 177                 }
 178                 let lo = cm.lookup_char_pos(span_label.span.lo);
 179                 let mut hi = cm.lookup_char_pos(span_label.span.hi);
 180
 181                 // Watch out for "empty spans". If we get a span like 6..6, we
 182                 // want to just display a `^` at 6, so convert that to
 183                 // 6..7. This is degenerate input, but it's best to degrade
 184                 // gracefully -- and the parser likes to supply a span like
 185                 // that for EOF, in particular.
 186                 if lo.col == hi.col && lo.line == hi.line {
 187                     hi.col = CharPos(lo.col.0 + 1);
 188                 }
 189
 190                 let ann_type = if lo.line != hi.line {
 191                     let ml = MultilineAnnotation {
 192                         depth: 1,
 193                         line_start: lo.line,
 194                         line_end: hi.line,
 195                         start_col: lo.col.0,
 196                         end_col: hi.col.0,
 197                         is_primary: span_label.is_primary,
 198                         label: span_label.label.clone(),
 199                     };
 200                     multiline_annotations.push((lo.file.clone(), ml.clone()));
 201                     AnnotationType::Multiline(ml)
 202                 } else {
 203                     AnnotationType::Singleline
 204                 };
 205                 let ann = Annotation {
 206                     start_col: lo.col.0,
 207                     end_col: hi.col.0,
 208                     is_primary: span_label.is_primary,
 209                     label: span_label.label.clone(),
 210                     annotation_type: ann_type,
 211                 };
 212
 213                 if !ann.is_multiline() {
 214                     add_annotation_to_file(&mut output,
 215                                            lo.file,
 216                                            lo.line,
 217                                            ann);
 218                 }
 219             }
 220         }
 221
 222         // Find overlapping multiline annotations, put them at different depths
 223         multiline_annotations.sort_by(|a, b| {
 224             (a.1.line_start, a.1.line_end).cmp(&(b.1.line_start, b.1.line_end))
 225         });
 226         for item in multiline_annotations.clone() {
 227             let ann = item.1;
 228             for item in multiline_annotations.iter_mut() {
 229                 let ref mut a = item.1;
 230                 // Move all other multiline annotations overlapping with this one
 231                 // one level to the right.
 232                 if &ann != a &&
 233                     num_overlap(ann.line_start, ann.line_end, a.line_start, a.line_end, true)
 234                 {
 235                     a.increase_depth();
 236                 } else {
 237                     break;
 238                 }
 239             }
 240         }
 241
 242         let mut max_depth = 0;  // max overlapping multiline spans
 243         for (file, ann) in multiline_annotations {
 244             if ann.depth > max_depth {
 245                 max_depth = ann.depth;
 246             }
 247             add_annotation_to_file(&mut output, file.clone(), ann.line_start, ann.as_start());
 248             let middle = min(ann.line_start + 4, ann.line_end);
 249             for line in ann.line_start + 1..middle {
 250                 add_annotation_to_file(&mut output, file.clone(), line, ann.as_line());
 251             }
 252             if middle < ann.line_end - 1 {
 253                 for line in ann.line_end - 1..ann.line_end {
 254                     add_annotation_to_file(&mut output, file.clone(), line, ann.as_line());
 255                 }
 256             }
 257             add_annotation_to_file(&mut output, file, ann.line_end, ann.as_end());
 258         }
 259         for file_vec in output.iter_mut() {
 260             file_vec.multiline_depth = max_depth;
 261         }
 262         output
 263     }
 264
 265     fn render_source_line(&self,
 266                           buffer: &mut StyledBuffer,
 267                           file: Rc<FileMap>,
 268                           line: &Line,
 269                           width_offset: usize,
 270                           code_offset: usize) -> Vec<(usize, Style)> {
 271         let source_string = match file.get_line(line.line_index - 1) {
 272             Some(s) => s,
 273             None => return Vec::new(),
 274         };
 275
 276         let line_offset = buffer.num_lines();
 277
 278         // First create the source line we will highlight.
 279         buffer.puts(line_offset, code_offset, &source_string, Style::Quotation);
 280         buffer.puts(line_offset,
 281                     0,
 282                     &(line.line_index.to_string()),
 283                     Style::LineNumber);
 284
 285         draw_col_separator(buffer, line_offset, width_offset - 2);
 286
 287         // Special case when there's only one annotation involved, it is the start of a multiline
 288         // span and there's no text at the beginning of the code line. Instead of doing the whole
 289         // graph:
 290         //
 291         // 2 |   fn foo() {
 292         //   |  _^
 293         // 3 | |
 294         // 4 | | }
 295         //   | |_^ test
 296         //
 297         // we simplify the output to:
 298         //
 299         // 2 | / fn foo() {
 300         // 3 | |
 301         // 4 | | }
 302         //   | |_^ test
 303         if line.annotations.len() == 1 {
 304             if let Some(ref ann) = line.annotations.get(0) {
 305                 if let AnnotationType::MultilineStart(depth) = ann.annotation_type {
 306                     if source_string[0..ann.start_col].trim() == "" {
 307                         let style = if ann.is_primary {
 308                             Style::UnderlinePrimary
 309                         } else {
 310                             Style::UnderlineSecondary
 311                         };
 312                         buffer.putc(line_offset,
 313                                     width_offset + depth - 1,
 314                                     '/',
 315                                     style);
 316                         return vec![(depth, style)];
 317                     }
 318                 }
 319             }
 320         }
 321
 322         // We want to display like this:
 323         //
 324         //      vec.push(vec.pop().unwrap());
 325         //      ---      ^^^               - previous borrow ends here
 326         //      |        |
 327         //      |        error occurs here
 328         //      previous borrow of `vec` occurs here
 329         //
 330         // But there are some weird edge cases to be aware of:
 331         //
 332         //      vec.push(vec.pop().unwrap());
 333         //      --------                    - previous borrow ends here
 334         //      ||
 335         //      |this makes no sense
 336         //      previous borrow of `vec` occurs here
 337         //
 338         // For this reason, we group the lines into "highlight lines"
 339         // and "annotations lines", where the highlight lines have the `^`.
 340
 341         // Sort the annotations by (start, end col)
 342         let mut annotations = line.annotations.clone();
 343         annotations.sort();
 344         annotations.reverse();
 345
 346         // First, figure out where each label will be positioned.
 347         //
 348         // In the case where you have the following annotations:
 349         //
 350         //      vec.push(vec.pop().unwrap());
 351         //      --------                    - previous borrow ends here [C]
 352         //      ||
 353         //      |this makes no sense [B]
 354         //      previous borrow of `vec` occurs here [A]
 355         //
 356         // `annotations_position` will hold [(2, A), (1, B), (0, C)].
 357         //
 358         // We try, when possible, to stick the rightmost annotation at the end
 359         // of the highlight line:
 360         //
 361         //      vec.push(vec.pop().unwrap());
 362         //      ---      ---               - previous borrow ends here
 363         //
 364         // But sometimes that's not possible because one of the other
 365         // annotations overlaps it. For example, from the test
 366         // `span_overlap_label`, we have the following annotations
 367         // (written on distinct lines for clarity):
 368         //
 369         //      fn foo(x: u32) {
 370         //      --------------
 371         //             -
 372         //
 373         // In this case, we can't stick the rightmost-most label on
 374         // the highlight line, or we would get:
 375         //
 376         //      fn foo(x: u32) {
 377         //      -------- x_span
 378         //      |
 379         //      fn_span
 380         //
 381         // which is totally weird. Instead we want:
 382         //
 383         //      fn foo(x: u32) {
 384         //      --------------
 385         //      |      |
 386         //      |      x_span
 387         //      fn_span
 388         //
 389         // which is...less weird, at least. In fact, in general, if
 390         // the rightmost span overlaps with any other span, we should
 391         // use the "hang below" version, so we can at least make it
 392         // clear where the span *starts*. There's an exception for this
 393         // logic, when the labels do not have a message:
 394         //
 395         //      fn foo(x: u32) {
 396         //      --------------
 397         //             |
 398         //             x_span
 399         //
 400         // instead of:
 401         //
 402         //      fn foo(x: u32) {
 403         //      --------------
 404         //      |      |
 405         //      |      x_span
 406         //      <EMPTY LINE>
 407         //
 408         let mut annotations_position = vec![];
 409         let mut line_len = 0;
 410         let mut p = 0;
 411         for (i, annotation) in annotations.iter().enumerate() {
 412             for (j, next) in annotations.iter().enumerate() {
 413                 if overlaps(next, annotation, 0)  // This label overlaps with another one and both
 414                     && annotation.has_label()     // take space (they have text and are not
 415                     && j > i                      // multiline lines).
 416                     && p == 0  // We're currently on the first line, move the label one line down
 417                 {
 418                     // This annotation needs a new line in the output.
 419                     p += 1;
 420                     break;
 421                 }
 422             }
 423             annotations_position.push((p, annotation));
 424             for (j, next) in annotations.iter().enumerate() {
 425                 if j > i  {
 426                     let l = if let Some(ref label) = next.label {
 427                         label.len() + 2
 428                     } else {
 429                         0
 430                     };
 431                     if (overlaps(next, annotation, l) // Do not allow two labels to be in the same
 432                                                      // line if they overlap including padding, to
 433                                                      // avoid situations like:
 434                                                      //
 435                                                      //      fn foo(x: u32) {
 436                                                      //      -------^------
 437                                                      //      |      |
 438                                                      //      fn_spanx_span
 439                                                      //
 440                         && annotation.has_label()    // Both labels must have some text, otherwise
 441                         && next.has_label())         // they are not overlapping.
 442                                                      // Do not add a new line if this annotation
 443                                                      // or the next are vertical line placeholders.
 444                         || (annotation.takes_space() // If either this or the next annotation is
 445                             && next.has_label())     // multiline start/end, move it to a new line
 446                         || (annotation.has_label()   // so as not to overlap the orizontal lines.
 447                             && next.takes_space())
 448                         || (annotation.takes_space()
 449                             && next.takes_space())
 450                     {
 451                         // This annotation needs a new line in the output.
 452                         p += 1;
 453                         break;
 454                     }
 455                 }
 456             }
 457             if line_len < p {
 458                 line_len = p;
 459             }
 460         }
 461
 462         if line_len != 0 {
 463             line_len += 1;
 464         }
 465
 466         // If there are no annotations or the only annotations on this line are
 467         // MultilineLine, then there's only code being shown, stop processing.
 468         if line.annotations.is_empty() || line.annotations.iter()
 469             .filter(|a| !a.is_line()).collect::<Vec<_>>().len() == 0
 470         {
 471             return vec![];
 472         }
 473
 474         // Write the colunmn separator.
 475         //
 476         // After this we will have:
 477         //
 478         // 2 |   fn foo() {
 479         //   |
 480         //   |
 481         //   |
 482         // 3 |
 483         // 4 |   }
 484         //   |
 485         for pos in 0..line_len + 1 {
 486             draw_col_separator(buffer, line_offset + pos + 1, width_offset - 2);
 487             buffer.putc(line_offset + pos + 1,
 488                         width_offset - 2,
 489                         '|',
 490                         Style::LineNumber);
 491         }
 492
 493         // Write the horizontal lines for multiline annotations
 494         // (only the first and last lines need this).
 495         //
 496         // After this we will have:
 497         //
 498         // 2 |   fn foo() {
 499         //   |  __________
 500         //   |
 501         //   |
 502         // 3 |
 503         // 4 |   }
 504         //   |  _
 505         for &(pos, annotation) in &annotations_position {
 506             let style = if annotation.is_primary {
 507                 Style::UnderlinePrimary
 508             } else {
 509                 Style::UnderlineSecondary
 510             };
 511             let pos = pos + 1;
 512             match annotation.annotation_type {
 513                 AnnotationType::MultilineStart(depth) |
 514                 AnnotationType::MultilineEnd(depth) => {
 515                     draw_range(buffer,
 516                                '_',
 517                                line_offset + pos,
 518                                width_offset + depth,
 519                                code_offset + annotation.start_col,
 520                                style);
 521                 }
 522                 _ => (),
 523             }
 524         }
 525
 526         // Write the vertical lines for labels that are on a different line as the underline.
 527         //
 528         // After this we will have:
 529         //
 530         // 2 |   fn foo() {
 531         //   |  __________
 532         //   | |    |
 533         //   | |
 534         // 3 |
 535         // 4 | | }
 536         //   | |_
 537         for &(pos, annotation) in &annotations_position {
 538             let style = if annotation.is_primary {
 539                 Style::UnderlinePrimary
 540             } else {
 541                 Style::UnderlineSecondary
 542             };
 543             let pos = pos + 1;
 544
 545             if pos > 1 && (annotation.has_label() || annotation.takes_space()) {
 546                 for p in line_offset + 1..line_offset + pos + 1 {
 547                     buffer.putc(p,
 548                                 code_offset + annotation.start_col,
 549                                 '|',
 550                                 style);
 551                 }
 552             }
 553             match annotation.annotation_type {
 554                 AnnotationType::MultilineStart(depth) => {
 555                     for p in line_offset + pos + 1..line_offset + line_len + 2 {
 556                         buffer.putc(p,
 557                                     width_offset + depth - 1,
 558                                     '|',
 559                                     style);
 560                     }
 561                 }
 562                 AnnotationType::MultilineEnd(depth) => {
 563                     for p in line_offset..line_offset + pos + 1 {
 564                         buffer.putc(p,
 565                                     width_offset + depth - 1,
 566                                     '|',
 567                                     style);
 568                     }
 569                 }
 570                 _ => (),
 571             }
 572         }
 573
 574         // Write the labels on the annotations that actually have a label.
 575         //
 576         // After this we will have:
 577         //
 578         // 2 |   fn foo() {
 579         //   |  __________
 580         //   |      |
 581         //   |      something about `foo`
 582         // 3 |
 583         // 4 |   }
 584         //   |  _  test
 585         for &(pos, annotation) in &annotations_position {
 586             let style = if annotation.is_primary {
 587                 Style::LabelPrimary
 588             } else {
 589                 Style::LabelSecondary
 590             };
 591             let (pos, col) = if pos == 0 {
 592                 (pos + 1, annotation.end_col + 1)
 593             } else {
 594                 (pos + 2, annotation.start_col)
 595             };
 596             if let Some(ref label) = annotation.label {
 597                 buffer.puts(line_offset + pos,
 598                             code_offset + col,
 599                             &label,
 600                             style);
 601             }
 602         }
 603
 604         // Sort from biggest span to smallest span so that smaller spans are
 605         // represented in the output:
 606         //
 607         // x | fn foo()
 608         //   | ^^^---^^
 609         //   | |  |
 610         //   | |  something about `foo`
 611         //   | something about `fn foo()`
 612         annotations_position.sort_by(|a, b| {
 613             // Decreasing order
 614             a.1.len().cmp(&b.1.len()).reverse()
 615         });
 616
 617         // Write the underlines.
 618         //
 619         // After this we will have:
 620         //
 621         // 2 |   fn foo() {
 622         //   |  ____-_____^
 623         //   |      |
 624         //   |      something about `foo`
 625         // 3 |
 626         // 4 |   }
 627         //   |  _^  test
 628         for &(_, annotation) in &annotations_position {
 629             let (underline, style) = if annotation.is_primary {
 630                 ('^', Style::UnderlinePrimary)
 631             } else {
 632                 ('-', Style::UnderlineSecondary)
 633             };
 634             for p in annotation.start_col..annotation.end_col {
 635                 buffer.putc(line_offset + 1,
 636                             code_offset + p,
 637                             underline,
 638                             style);
 639             }
 640         }
 641         annotations_position.iter().filter_map(|&(_, annotation)| {
 642             match annotation.annotation_type {
 643                 AnnotationType::MultilineStart(p) | AnnotationType::MultilineEnd(p) => {
 644                     let style = if annotation.is_primary {
 645                         Style::LabelPrimary
 646                     } else {
 647                         Style::LabelSecondary
 648                     };
 649                     Some((p, style))
 650                 },
 651                 _ => None
 652             }
 653
 654         }).collect::<Vec<_>>()
 655     }
 656
 657     fn get_multispan_max_line_num(&mut self, msp: &MultiSpan) -> usize {
 658         let mut max = 0;
 659         if let Some(ref cm) = self.cm {
 660             for primary_span in msp.primary_spans() {
 661                 if primary_span != &DUMMY_SP {
 662                     let hi = cm.lookup_char_pos(primary_span.hi);
 663                     if hi.line > max {
 664                         max = hi.line;
 665                     }
 666                 }
 667             }
 668             for span_label in msp.span_labels() {
 669                 if span_label.span != DUMMY_SP {
 670                     let hi = cm.lookup_char_pos(span_label.span.hi);
 671                     if hi.line > max {
 672                         max = hi.line;
 673                     }
 674                 }
 675             }
 676         }
 677         max
 678     }
 679
 680     fn get_max_line_num(&mut self, span: &MultiSpan, children: &Vec<SubDiagnostic>) -> usize {
 681         let mut max = 0;
 682
 683         let primary = self.get_multispan_max_line_num(span);
 684         max = if primary > max { primary } else { max };
 685
 686         for sub in children {
 687             let sub_result = self.get_multispan_max_line_num(&sub.span);
 688             max = if sub_result > max { primary } else { max };
 689         }
 690         max
 691     }
 692
 693     // This "fixes" MultiSpans that contain Spans that are pointing to locations inside of
 694     // <*macros>. Since these locations are often difficult to read, we move these Spans from
 695     // <*macros> to their corresponding use site.
 696     fn fix_multispan_in_std_macros(&mut self, span: &mut MultiSpan) -> bool {
 697         let mut spans_updated = false;
 698
 699         if let Some(ref cm) = self.cm {
 700             let mut before_after: Vec<(Span, Span)> = vec![];
 701             let mut new_labels: Vec<(Span, String)> = vec![];
 702
 703             // First, find all the spans in <*macros> and point instead at their use site
 704             for sp in span.primary_spans() {
 705                 if *sp == DUMMY_SP {
 706                     continue;
 707                 }
 708                 if cm.span_to_filename(sp.clone()).contains("macros>") {
 709                     let v = sp.macro_backtrace();
 710                     if let Some(use_site) = v.last() {
 711                         before_after.push((sp.clone(), use_site.call_site.clone()));
 712                     }
 713                 }
 714                 for trace in sp.macro_backtrace().iter().rev() {
 715                     // Only show macro locations that are local
 716                     // and display them like a span_note
 717                     if let Some(def_site) = trace.def_site_span {
 718                         if def_site == DUMMY_SP {
 719                             continue;
 720                         }
 721                         // Check to make sure we're not in any <*macros>
 722                         if !cm.span_to_filename(def_site).contains("macros>") &&
 723                            !trace.macro_decl_name.starts_with("#[") {
 724                             new_labels.push((trace.call_site,
 725                                              "in this macro invocation".to_string()));
 726                             break;
 727                         }
 728                     }
 729                 }
 730             }
 731             for (label_span, label_text) in new_labels {
 732                 span.push_span_label(label_span, label_text);
 733             }
 734             for sp_label in span.span_labels() {
 735                 if sp_label.span == DUMMY_SP {
 736                     continue;
 737                 }
 738                 if cm.span_to_filename(sp_label.span.clone()).contains("macros>") {
 739                     let v = sp_label.span.macro_backtrace();
 740                     if let Some(use_site) = v.last() {
 741                         before_after.push((sp_label.span.clone(), use_site.call_site.clone()));
 742                     }
 743                 }
 744             }
 745             // After we have them, make sure we replace these 'bad' def sites with their use sites
 746             for (before, after) in before_after {
 747                 span.replace(before, after);
 748                 spans_updated = true;
 749             }
 750         }
 751
 752         spans_updated
 753     }
 754
 755     // This does a small "fix" for multispans by looking to see if it can find any that
 756     // point directly at <*macros>. Since these are often difficult to read, this
 757     // will change the span to point at the use site.
 758     fn fix_multispans_in_std_macros(&mut self,
 759                                     span: &mut MultiSpan,
 760                                     children: &mut Vec<SubDiagnostic>) {
 761         let mut spans_updated = self.fix_multispan_in_std_macros(span);
 762         for child in children.iter_mut() {
 763             spans_updated |= self.fix_multispan_in_std_macros(&mut child.span);
 764         }
 765         if spans_updated {
 766             children.push(SubDiagnostic {
 767                 level: Level::Note,
 768                 message: vec![("this error originates in a macro outside of the current crate"
 769                     .to_string(), Style::NoStyle)],
 770                 span: MultiSpan::new(),
 771                 render_span: None,
 772             });
 773         }
 774     }
 775
 776     /// Add a left margin to every line but the first, given a padding length and the label being
 777     /// displayed, keeping the provided highlighting.
 778     fn msg_to_buffer(&self,
 779                      buffer: &mut StyledBuffer,
 780                      msg: &[(String, Style)],
 781                      padding: usize,
 782                      label: &str,
 783                      override_style: Option<Style>) {
 784
 785         // The extra 5 ` ` is padding that's always needed to align to the `note: `:
 786         //
 787         //   error: message
 788         //     --> file.rs:13:20
 789         //      |
 790         //   13 |     <CODE>
 791         //      |      ^^^^
 792         //      |
 793         //      = note: multiline
 794         //              message
 795         //   ++^^^----xx
 796         //    |  |   | |
 797         //    |  |   | magic `2`
 798         //    |  |   length of label
 799         //    |  magic `3`
 800         //    `max_line_num_len`
 801         let padding = (0..padding + label.len() + 5)
 802             .map(|_| " ")
 803             .collect::<String>();
 804
 805         /// Return wether `style`, or the override if present and the style is `NoStyle`.
 806         fn style_or_override(style: Style, override_style: Option<Style>) -> Style {
 807             if let Some(o) = override_style {
 808                 if style == Style::NoStyle {
 809                     return o;
 810                 }
 811             }
 812             style
 813         }
 814
 815         let mut line_number = 0;
 816
 817         // Provided the following diagnostic message:
 818         //
 819         //     let msg = vec![
 820         //       ("
 821         //       ("highlighted multiline\nstring to\nsee how it ", Style::NoStyle),
 822         //       ("looks", Style::Highlight),
 823         //       ("with\nvery ", Style::NoStyle),
 824         //       ("weird", Style::Highlight),
 825         //       (" formats\n", Style::NoStyle),
 826         //       ("see?", Style::Highlight),
 827         //     ];
 828         //
 829         // the expected output on a note is (* surround the  highlighted text)
 830         //
 831         //        = note: highlighted multiline
 832         //                string to
 833         //                see how it *looks* with
 834         //                very *weird* formats
 835         //                see?
 836         for &(ref text, ref style) in msg.iter() {
 837             let lines = text.split('\n').collect::<Vec<_>>();
 838             if lines.len() > 1 {
 839                 for (i, line) in lines.iter().enumerate() {
 840                     if i != 0 {
 841                         line_number += 1;
 842                         buffer.append(line_number, &padding, Style::NoStyle);
 843                     }
 844                     buffer.append(line_number, line, style_or_override(*style, override_style));
 845                 }
 846             } else {
 847                 buffer.append(line_number, text, style_or_override(*style, override_style));
 848             }
 849         }
 850     }
 851
 852     fn emit_message_default(&mut self,
 853                             msp: &MultiSpan,
 854                             msg: &Vec<(String, Style)>,
 855                             code: &Option<String>,
 856                             level: &Level,
 857                             max_line_num_len: usize,
 858                             is_secondary: bool)
 859                             -> io::Result<()> {
 860         let mut buffer = StyledBuffer::new();
 861
 862         if msp.primary_spans().is_empty() && msp.span_labels().is_empty() && is_secondary {
 863             // This is a secondary message with no span info
 864             for _ in 0..max_line_num_len {
 865                 buffer.prepend(0, " ", Style::NoStyle);
 866             }
 867             draw_note_separator(&mut buffer, 0, max_line_num_len + 1);
 868             buffer.append(0, &level.to_string(), Style::HeaderMsg);
 869             buffer.append(0, ": ", Style::NoStyle);
 870             self.msg_to_buffer(&mut buffer, msg, max_line_num_len, "note", None);
 871         } else {
 872             buffer.append(0, &level.to_string(), Style::Level(level.clone()));
 873             match code {
 874                 &Some(ref code) => {
 875                     buffer.append(0, "[", Style::Level(level.clone()));
 876                     buffer.append(0, &code, Style::Level(level.clone()));
 877                     buffer.append(0, "]", Style::Level(level.clone()));
 878                 }
 879                 _ => {}
 880             }
 881             buffer.append(0, ": ", Style::HeaderMsg);
 882             for &(ref text, _) in msg.iter() {
 883                 buffer.append(0, text, Style::HeaderMsg);
 884             }
 885         }
 886
 887         // Preprocess all the annotations so that they are grouped by file and by line number
 888         // This helps us quickly iterate over the whole message (including secondary file spans)
 889         let mut annotated_files = self.preprocess_annotations(msp);
 890
 891         // Make sure our primary file comes first
 892         let primary_lo = if let (Some(ref cm), Some(ref primary_span)) =
 893             (self.cm.as_ref(), msp.primary_span().as_ref()) {
 894             if primary_span != &&DUMMY_SP {
 895                 cm.lookup_char_pos(primary_span.lo)
 896             } else {
 897                 emit_to_destination(&buffer.render(), level, &mut self.dst)?;
 898                 return Ok(());
 899             }
 900         } else {
 901             // If we don't have span information, emit and exit
 902             emit_to_destination(&buffer.render(), level, &mut self.dst)?;
 903             return Ok(());
 904         };
 905         if let Ok(pos) =
 906             annotated_files.binary_search_by(|x| x.file.name.cmp(&primary_lo.file.name)) {
 907             annotated_files.swap(0, pos);
 908         }
 909
 910         // Print out the annotate source lines that correspond with the error
 911         for annotated_file in annotated_files {
 912             // we can't annotate anything if the source is unavailable.
 913             if annotated_file.file.src.is_none() {
 914                 continue;
 915             }
 916
 917             // print out the span location and spacer before we print the annotated source
 918             // to do this, we need to know if this span will be primary
 919             let is_primary = primary_lo.file.name == annotated_file.file.name;
 920             if is_primary {
 921                 // remember where we are in the output buffer for easy reference
 922                 let buffer_msg_line_offset = buffer.num_lines();
 923
 924                 buffer.prepend(buffer_msg_line_offset, "--> ", Style::LineNumber);
 925                 let loc = primary_lo.clone();
 926                 buffer.append(buffer_msg_line_offset,
 927                               &format!("{}:{}:{}", loc.file.name, loc.line, loc.col.0 + 1),
 928                               Style::LineAndColumn);
 929                 for _ in 0..max_line_num_len {
 930                     buffer.prepend(buffer_msg_line_offset, " ", Style::NoStyle);
 931                 }
 932             } else {
 933                 // remember where we are in the output buffer for easy reference
 934                 let buffer_msg_line_offset = buffer.num_lines();
 935
 936                 // Add spacing line
 937                 draw_col_separator(&mut buffer, buffer_msg_line_offset, max_line_num_len + 1);
 938
 939                 // Then, the secondary file indicator
 940                 buffer.prepend(buffer_msg_line_offset + 1, "::: ", Style::LineNumber);
 941                 buffer.append(buffer_msg_line_offset + 1,
 942                               &annotated_file.file.name,
 943                               Style::LineAndColumn);
 944                 for _ in 0..max_line_num_len {
 945                     buffer.prepend(buffer_msg_line_offset + 1, " ", Style::NoStyle);
 946                 }
 947             }
 948
 949             // Put in the spacer between the location and annotated source
 950             let buffer_msg_line_offset = buffer.num_lines();
 951             draw_col_separator_no_space(&mut buffer, buffer_msg_line_offset, max_line_num_len + 1);
 952
 953             // Contains the vertical lines' positions for active multiline annotations
 954             let mut multilines = HashMap::new();
 955
 956             // Next, output the annotate source for this file
 957             for line_idx in 0..annotated_file.lines.len() {
 958                 let previous_buffer_line = buffer.num_lines();
 959
 960                 let width_offset = 3 + max_line_num_len;
 961                 let code_offset = if annotated_file.multiline_depth == 0 {
 962                     width_offset
 963                 } else {
 964                     width_offset + annotated_file.multiline_depth + 1
 965                 };
 966
 967                 let depths = self.render_source_line(&mut buffer,
 968                                                      annotated_file.file.clone(),
 969                                                      &annotated_file.lines[line_idx],
 970                                                      width_offset,
 971                                                      code_offset);
 972
 973                 let mut to_add = HashMap::new();
 974
 975                 for (depth, style) in depths {
 976                     if multilines.get(&depth).is_some() {
 977                         multilines.remove(&depth);
 978                     } else {
 979                         to_add.insert(depth, style);
 980                     }
 981                 }
 982
 983                 // Set the multiline annotation vertical lines to the left of
 984                 // the code in this line.
 985                 for (depth, style) in &multilines {
 986                     for line in previous_buffer_line..buffer.num_lines() {
 987                         draw_multiline_line(&mut buffer,
 988                                             line,
 989                                             width_offset,
 990                                             *depth,
 991                                             *style);
 992                     }
 993                 }
 994                 // check to see if we need to print out or elide lines that come between
 995                 // this annotated line and the next one.
 996                 if line_idx < (annotated_file.lines.len() - 1) {
 997                     let line_idx_delta = annotated_file.lines[line_idx + 1].line_index -
 998                                          annotated_file.lines[line_idx].line_index;
 999                     if line_idx_delta > 2 {
1000                         let last_buffer_line_num = buffer.num_lines();
1001                         buffer.puts(last_buffer_line_num, 0, "...", Style::LineNumber);
1002
1003                         // Set the multiline annotation vertical lines on `...` bridging line.
1004                         for (depth, style) in &multilines {
1005                             draw_multiline_line(&mut buffer,
1006                                                 last_buffer_line_num,
1007                                                 width_offset,
1008                                                 *depth,
1009                                                 *style);
1010                         }
1011                     } else if line_idx_delta == 2 {
1012                         let unannotated_line = annotated_file.file
1013                             .get_line(annotated_file.lines[line_idx].line_index)
1014                             .unwrap_or("");
1015
1016                         let last_buffer_line_num = buffer.num_lines();
1017
1018                         buffer.puts(last_buffer_line_num,
1019                                     0,
1020                                     &(annotated_file.lines[line_idx + 1].line_index - 1)
1021                                         .to_string(),
1022                                     Style::LineNumber);
1023                         draw_col_separator(&mut buffer, last_buffer_line_num, 1 + max_line_num_len);
1024                         buffer.puts(last_buffer_line_num,
1025                                     code_offset,
1026                                     &unannotated_line,
1027                                     Style::Quotation);
1028
1029                         for (depth, style) in &multilines {
1030                             draw_multiline_line(&mut buffer,
1031                                                 last_buffer_line_num,
1032                                                 width_offset,
1033                                                 *depth,
1034                                                 *style);
1035                         }
1036                     }
1037                 }
1038
1039                 multilines.extend(&to_add);
1040             }
1041         }
1042
1043         // final step: take our styled buffer, render it, then output it
1044         emit_to_destination(&buffer.render(), level, &mut self.dst)?;
1045
1046         Ok(())
1047     }
1048     fn emit_suggestion_default(&mut self,
1049                                suggestion: &CodeSuggestion,
1050                                level: &Level,
1051                                max_line_num_len: usize)
1052                                -> io::Result<()> {
1053         use std::borrow::Borrow;
1054
1055         let primary_span = suggestion.substitution_spans().next().unwrap();
1056         if let Some(ref cm) = self.cm {
1057             let mut buffer = StyledBuffer::new();
1058
1059             let lines = cm.span_to_lines(primary_span).unwrap();
1060
1061             assert!(!lines.lines.is_empty());
1062
1063             buffer.append(0, &level.to_string(), Style::Level(level.clone()));
1064             buffer.append(0, ": ", Style::HeaderMsg);
1065             self.msg_to_buffer(&mut buffer,
1066                             &[(suggestion.msg.to_owned(), Style::NoStyle)],
1067                             max_line_num_len,
1068                             "suggestion",
1069                             Some(Style::HeaderMsg));
1070
1071             let suggestions = suggestion.splice_lines(cm.borrow());
1072             let mut row_num = 1;
1073             for complete in suggestions.iter().take(MAX_SUGGESTIONS) {
1074
1075                 // print the suggestion without any line numbers, but leave
1076                 // space for them. This helps with lining up with previous
1077                 // snippets from the actual error being reported.
1078                 let mut lines = complete.lines();
1079                 for line in lines.by_ref().take(MAX_HIGHLIGHT_LINES) {
1080                     draw_col_separator(&mut buffer, row_num, max_line_num_len + 1);
1081                     buffer.append(row_num, line, Style::NoStyle);
1082                     row_num += 1;
1083                 }
1084
1085                 // if we elided some lines, add an ellipsis
1086                 if let Some(_) = lines.next() {
1087                     buffer.append(row_num, "...", Style::NoStyle);
1088                 }
1089             }
1090             if suggestions.len() > MAX_SUGGESTIONS {
1091                 let msg = format!("and {} other candidates", suggestions.len() - MAX_SUGGESTIONS);
1092                 buffer.append(row_num, &msg, Style::NoStyle);
1093             }
1094             emit_to_destination(&buffer.render(), level, &mut self.dst)?;
1095         }
1096         Ok(())
1097     }
1098     fn emit_messages_default(&mut self,
1099                              level: &Level,
1100                              message: &Vec<(String, Style)>,
1101                              code: &Option<String>,
1102                              span: &MultiSpan,
1103                              children: &Vec<SubDiagnostic>) {
1104         let max_line_num = self.get_max_line_num(span, children);
1105         let max_line_num_len = max_line_num.to_string().len();
1106
1107         match self.emit_message_default(span, message, code, level, max_line_num_len, false) {
1108             Ok(()) => {
1109                 if !children.is_empty() {
1110                     let mut buffer = StyledBuffer::new();
1111                     draw_col_separator_no_space(&mut buffer, 0, max_line_num_len + 1);
1112                     match emit_to_destination(&buffer.render(), level, &mut self.dst) {
1113                         Ok(()) => (),
1114                         Err(e) => panic!("failed to emit error: {}", e)
1115                     }
1116                 }
1117                 for child in children {
1118                     match child.render_span {
1119                         Some(FullSpan(ref msp)) => {
1120                             match self.emit_message_default(msp,
1121                                                             &child.styled_message(),
1122                                                             &None,
1123                                                             &child.level,
1124                                                             max_line_num_len,
1125                                                             true) {
1126                                 Err(e) => panic!("failed to emit error: {}", e),
1127                                 _ => ()
1128                             }
1129                         },
1130                         Some(Suggestion(ref cs)) => {
1131                             match self.emit_suggestion_default(cs,
1132                                                                &child.level,
1133                                                                max_line_num_len) {
1134                                 Err(e) => panic!("failed to emit error: {}", e),
1135                                 _ => ()
1136                             }
1137                         },
1138                         None => {
1139                             match self.emit_message_default(&child.span,
1140                                                             &child.styled_message(),
1141                                                             &None,
1142                                                             &child.level,
1143                                                             max_line_num_len,
1144                                                             true) {
1145                                 Err(e) => panic!("failed to emit error: {}", e),
1146                                 _ => (),
1147                             }
1148                         }
1149                     }
1150                 }
1151             }
1152             Err(e) => panic!("failed to emit error: {}", e),
1153         }
1154         match write!(&mut self.dst, "\n") {
1155             Err(e) => panic!("failed to emit error: {}", e),
1156             _ => {
1157                 match self.dst.flush() {
1158                     Err(e) => panic!("failed to emit error: {}", e),
1159                     _ => (),
1160                 }
1161             }
1162         }
1163     }
1164 }
1165
1166 fn draw_col_separator(buffer: &mut StyledBuffer, line: usize, col: usize) {
1167     buffer.puts(line, col, "| ", Style::LineNumber);
1168 }
1169
1170 fn draw_col_separator_no_space(buffer: &mut StyledBuffer, line: usize, col: usize) {
1171     draw_col_separator_no_space_with_style(buffer, line, col, Style::LineNumber);
1172 }
1173
1174 fn draw_col_separator_no_space_with_style(buffer: &mut StyledBuffer,
1175                                           line: usize,
1176                                           col: usize,
1177                                           style: Style) {
1178     buffer.putc(line, col, '|', style);
1179 }
1180
1181 fn draw_range(buffer: &mut StyledBuffer, symbol: char, line: usize,
1182               col_from: usize, col_to: usize, style: Style) {
1183     for col in col_from..col_to {
1184         buffer.putc(line, col, symbol, style);
1185     }
1186 }
1187
1188 fn draw_note_separator(buffer: &mut StyledBuffer, line: usize, col: usize) {
1189     buffer.puts(line, col, "= ", Style::LineNumber);
1190 }
1191
1192 fn draw_multiline_line(buffer: &mut StyledBuffer,
1193                        line: usize,
1194                        offset: usize,
1195                        depth: usize,
1196                        style: Style)
1197 {
1198     buffer.putc(line, offset + depth - 1, '|', style);
1199 }
1200
1201 fn num_overlap(a_start: usize, a_end: usize, b_start: usize, b_end:usize, inclusive: bool) -> bool {
1202     let extra = if inclusive {
1203         1
1204     } else {
1205         0
1206     };
1207     (b_start..b_end + extra).contains(a_start) ||
1208     (a_start..a_end + extra).contains(b_start)
1209 }
1210 fn overlaps(a1: &Annotation, a2: &Annotation, padding: usize) -> bool {
1211     num_overlap(a1.start_col, a1.end_col + padding, a2.start_col, a2.end_col, false)
1212 }
1213
1214 fn emit_to_destination(rendered_buffer: &Vec<Vec<StyledString>>,
1215                        lvl: &Level,
1216                        dst: &mut Destination)
1217                        -> io::Result<()> {
1218     use lock;
1219
1220     // In order to prevent error message interleaving, where multiple error lines get intermixed
1221     // when multiple compiler processes error simultaneously, we emit errors with additional
1222     // steps.
1223     //
1224     // On Unix systems, we write into a buffered terminal rather than directly to a terminal. When
1225     // the .flush() is called we take the buffer created from the buffered writes and write it at
1226     // one shot.  Because the Unix systems use ANSI for the colors, which is a text-based styling
1227     // scheme, this buffered approach works and maintains the styling.
1228     //
1229     // On Windows, styling happens through calls to a terminal API. This prevents us from using the
1230     // same buffering approach.  Instead, we use a global Windows mutex, which we acquire long
1231     // enough to output the full error message, then we release.
1232     let _buffer_lock = lock::acquire_global_lock("rustc_errors");
1233     for line in rendered_buffer {
1234         for part in line {
1235             dst.apply_style(lvl.clone(), part.style)?;
1236             write!(dst, "{}", part.text)?;
1237             dst.reset_attrs()?;
1238         }
1239         write!(dst, "\n")?;
1240     }
1241     dst.flush()?;
1242     Ok(())
1243 }
1244
1245 #[cfg(unix)]
1246 fn stderr_isatty() -> bool {
1247     use libc;
1248     unsafe { libc::isatty(libc::STDERR_FILENO) != 0 }
1249 }
1250 #[cfg(windows)]
1251 fn stderr_isatty() -> bool {
1252     type DWORD = u32;
1253     type BOOL = i32;
1254     type HANDLE = *mut u8;
1255     const STD_ERROR_HANDLE: DWORD = -12i32 as DWORD;
1256     extern "system" {
1257         fn GetStdHandle(which: DWORD) -> HANDLE;
1258         fn GetConsoleMode(hConsoleHandle: HANDLE, lpMode: *mut DWORD) -> BOOL;
1259     }
1260     unsafe {
1261         let handle = GetStdHandle(STD_ERROR_HANDLE);
1262         let mut out = 0;
1263         GetConsoleMode(handle, &mut out) != 0
1264     }
1265 }
1266
1267 pub type BufferedStderr = term::Terminal<Output = BufferedWriter> + Send;
1268
1269 pub enum Destination {
1270     Terminal(Box<term::StderrTerminal>),
1271     BufferedTerminal(Box<BufferedStderr>),
1272     Raw(Box<Write + Send>),
1273 }
1274
1275 /// Buffered writer gives us a way on Unix to buffer up an entire error message before we output
1276 /// it.  This helps to prevent interleaving of multiple error messages when multiple compiler
1277 /// processes error simultaneously
1278 pub struct BufferedWriter {
1279     buffer: Vec<u8>,
1280 }
1281
1282 impl BufferedWriter {
1283     // note: we use _new because the conditional compilation at its use site may make this
1284     // this function unused on some platforms
1285     fn _new() -> BufferedWriter {
1286         BufferedWriter { buffer: vec![] }
1287     }
1288 }
1289
1290 impl Write for BufferedWriter {
1291     fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
1292         for b in buf {
1293             self.buffer.push(*b);
1294         }
1295         Ok(buf.len())
1296     }
1297     fn flush(&mut self) -> io::Result<()> {
1298         let mut stderr = io::stderr();
1299         let result = stderr.write_all(&self.buffer)
1300                            .and_then(|_| stderr.flush());
1301         self.buffer.clear();
1302         result
1303     }
1304 }
1305
1306 impl Destination {
1307     #[cfg(not(windows))]
1308     /// When not on Windows, prefer the buffered terminal so that we can buffer an entire error
1309     /// to be emitted at one time.
1310     fn from_stderr() -> Destination {
1311         let stderr: Option<Box<BufferedStderr>> =
1312             term::TerminfoTerminal::new(BufferedWriter::_new())
1313                 .map(|t| Box::new(t) as Box<BufferedStderr>);
1314
1315         match stderr {
1316             Some(t) => BufferedTerminal(t),
1317             None => Raw(Box::new(io::stderr())),
1318         }
1319     }
1320
1321     #[cfg(windows)]
1322     /// Return a normal, unbuffered terminal when on Windows.
1323     fn from_stderr() -> Destination {
1324         let stderr: Option<Box<term::StderrTerminal>> = term::TerminfoTerminal::new(io::stderr())
1325             .map(|t| Box::new(t) as Box<term::StderrTerminal>)
1326             .or_else(|| {
1327                 term::WinConsole::new(io::stderr())
1328                     .ok()
1329                     .map(|t| Box::new(t) as Box<term::StderrTerminal>)
1330             });
1331
1332         match stderr {
1333             Some(t) => Terminal(t),
1334             None => Raw(Box::new(io::stderr())),
1335         }
1336     }
1337
1338     fn apply_style(&mut self, lvl: Level, style: Style) -> io::Result<()> {
1339         match style {
1340             Style::FileNameStyle | Style::LineAndColumn => {}
1341             Style::LineNumber => {
1342                 self.start_attr(term::Attr::Bold)?;
1343                 if cfg!(windows) {
1344                     self.start_attr(term::Attr::ForegroundColor(term::color::BRIGHT_CYAN))?;
1345                 } else {
1346                     self.start_attr(term::Attr::ForegroundColor(term::color::BRIGHT_BLUE))?;
1347                 }
1348             }
1349             Style::ErrorCode => {
1350                 self.start_attr(term::Attr::Bold)?;
1351                 self.start_attr(term::Attr::ForegroundColor(term::color::BRIGHT_MAGENTA))?;
1352             }
1353             Style::Quotation => {}
1354             Style::OldSchoolNote => {
1355                 self.start_attr(term::Attr::Bold)?;
1356                 self.start_attr(term::Attr::ForegroundColor(term::color::BRIGHT_GREEN))?;
1357             }
1358             Style::OldSchoolNoteText | Style::HeaderMsg => {
1359                 self.start_attr(term::Attr::Bold)?;
1360                 if cfg!(windows) {
1361                     self.start_attr(term::Attr::ForegroundColor(term::color::BRIGHT_WHITE))?;
1362                 }
1363             }
1364             Style::UnderlinePrimary | Style::LabelPrimary => {
1365                 self.start_attr(term::Attr::Bold)?;
1366                 self.start_attr(term::Attr::ForegroundColor(lvl.color()))?;
1367             }
1368             Style::UnderlineSecondary |
1369             Style::LabelSecondary => {
1370                 self.start_attr(term::Attr::Bold)?;
1371                 if cfg!(windows) {
1372                     self.start_attr(term::Attr::ForegroundColor(term::color::BRIGHT_CYAN))?;
1373                 } else {
1374                     self.start_attr(term::Attr::ForegroundColor(term::color::BRIGHT_BLUE))?;
1375                 }
1376             }
1377             Style::NoStyle => {}
1378             Style::Level(l) => {
1379                 self.start_attr(term::Attr::Bold)?;
1380                 self.start_attr(term::Attr::ForegroundColor(l.color()))?;
1381             }
1382             Style::Highlight => self.start_attr(term::Attr::Bold)?,
1383         }
1384         Ok(())
1385     }
1386
1387     fn start_attr(&mut self, attr: term::Attr) -> io::Result<()> {
1388         match *self {
1389             Terminal(ref mut t) => {
1390                 t.attr(attr)?;
1391             }
1392             BufferedTerminal(ref mut t) => {
1393                 t.attr(attr)?;
1394             }
1395             Raw(_) => {}
1396         }
1397         Ok(())
1398     }
1399
1400     fn reset_attrs(&mut self) -> io::Result<()> {
1401         match *self {
1402             Terminal(ref mut t) => {
1403                 t.reset()?;
1404             }
1405             BufferedTerminal(ref mut t) => {
1406                 t.reset()?;
1407             }
1408             Raw(_) => {}
1409         }
1410         Ok(())
1411     }
1412 }
1413
1414 impl Write for Destination {
1415     fn write(&mut self, bytes: &[u8]) -> io::Result<usize> {
1416         match *self {
1417             Terminal(ref mut t) => t.write(bytes),
1418             BufferedTerminal(ref mut t) => t.write(bytes),
1419             Raw(ref mut w) => w.write(bytes),
1420         }
1421     }
1422     fn flush(&mut self) -> io::Result<()> {
1423         match *self {
1424             Terminal(ref mut t) => t.flush(),
1425             BufferedTerminal(ref mut t) => t.flush(),
1426             Raw(ref mut w) => w.flush(),
1427         }
1428     }
1429 }