compiler/rustc_errors/src/snippet.rs

   1 // Code for annotating snippets.
   2
   3 use crate::Level;
   4
   5 #[derive(Clone, Debug, PartialOrd, Ord, PartialEq, Eq)]
   6 pub struct Line {
   7     pub line_index: usize,
   8     pub annotations: Vec<Annotation>,
   9 }
  10
  11 #[derive(Clone, Debug, PartialOrd, Ord, PartialEq, Eq)]
  12 pub struct MultilineAnnotation {
  13     pub depth: usize,
  14     pub line_start: usize,
  15     pub line_end: usize,
  16     pub start_col: usize,
  17     pub end_col: usize,
  18     pub is_primary: bool,
  19     pub label: Option<String>,
  20     pub overlaps_exactly: bool,
  21 }
  22
  23 impl MultilineAnnotation {
  24     pub fn increase_depth(&mut self) {
  25         self.depth += 1;
  26     }
  27
  28     /// Compare two `MultilineAnnotation`s considering only the `Span` they cover.
  29     pub fn same_span(&self, other: &MultilineAnnotation) -> bool {
  30         self.line_start == other.line_start
  31             && self.line_end == other.line_end
  32             && self.start_col == other.start_col
  33             && self.end_col == other.end_col
  34     }
  35
  36     pub fn as_start(&self) -> Annotation {
  37         Annotation {
  38             start_col: self.start_col,
  39             end_col: self.start_col + 1,
  40             is_primary: self.is_primary,
  41             label: None,
  42             annotation_type: AnnotationType::MultilineStart(self.depth),
  43         }
  44     }
  45
  46     pub fn as_end(&self) -> Annotation {
  47         Annotation {
  48             start_col: self.end_col.saturating_sub(1),
  49             end_col: self.end_col,
  50             is_primary: self.is_primary,
  51             label: self.label.clone(),
  52             annotation_type: AnnotationType::MultilineEnd(self.depth),
  53         }
  54     }
  55
  56     pub fn as_line(&self) -> Annotation {
  57         Annotation {
  58             start_col: 0,
  59             end_col: 0,
  60             is_primary: self.is_primary,
  61             label: None,
  62             annotation_type: AnnotationType::MultilineLine(self.depth),
  63         }
  64     }
  65 }
  66
  67 #[derive(Clone, Debug, PartialOrd, Ord, PartialEq, Eq)]
  68 pub enum AnnotationType {
  69     /// Annotation under a single line of code
  70     Singleline,
  71
  72     // The Multiline type above is replaced with the following three in order
  73     // to reuse the current label drawing code.
  74     //
  75     // Each of these corresponds to one part of the following diagram:
  76     //
  77     //     x |   foo(1 + bar(x,
  78     //       |  _________^              < MultilineStart
  79     //     x | |             y),        < MultilineLine
  80     //       | |______________^ label   < MultilineEnd
  81     //     x |       z);
  82     /// Annotation marking the first character of a fully shown multiline span
  83     MultilineStart(usize),
  84     /// Annotation marking the last character of a fully shown multiline span
  85     MultilineEnd(usize),
  86     /// Line at the left enclosing the lines of a fully shown multiline span
  87     // Just a placeholder for the drawing algorithm, to know that it shouldn't skip the first 4
  88     // and last 2 lines of code. The actual line is drawn in `emit_message_default` and not in
  89     // `draw_multiline_line`.
  90     MultilineLine(usize),
  91 }
  92
  93 #[derive(Clone, Debug, PartialOrd, Ord, PartialEq, Eq)]
  94 pub struct Annotation {
  95     /// Start column, 0-based indexing -- counting *characters*, not
  96     /// utf-8 bytes. Note that it is important that this field goes
  97     /// first, so that when we sort, we sort orderings by start
  98     /// column.
  99     pub start_col: usize,
 100
 101     /// End column within the line (exclusive)
 102     pub end_col: usize,
 103
 104     /// Is this annotation derived from primary span
 105     pub is_primary: bool,
 106
 107     /// Optional label to display adjacent to the annotation.
 108     pub label: Option<String>,
 109
 110     /// Is this a single line, multiline or multiline span minimized down to a
 111     /// smaller span.
 112     pub annotation_type: AnnotationType,
 113 }
 114
 115 impl Annotation {
 116     /// Whether this annotation is a vertical line placeholder.
 117     pub fn is_line(&self) -> bool {
 118         matches!(self.annotation_type, AnnotationType::MultilineLine(_))
 119     }
 120
 121     pub fn len(&self) -> usize {
 122         // Account for usize underflows
 123         if self.end_col > self.start_col {
 124             self.end_col - self.start_col
 125         } else {
 126             self.start_col - self.end_col
 127         }
 128     }
 129
 130     pub fn has_label(&self) -> bool {
 131         if let Some(ref label) = self.label {
 132             // Consider labels with no text as effectively not being there
 133             // to avoid weird output with unnecessary vertical lines, like:
 134             //
 135             //     X | fn foo(x: u32) {
 136             //       | -------^------
 137             //       | |      |
 138             //       | |
 139             //       |
 140             //
 141             // Note that this would be the complete output users would see.
 142             !label.is_empty()
 143         } else {
 144             false
 145         }
 146     }
 147
 148     pub fn takes_space(&self) -> bool {
 149         // Multiline annotations always have to keep vertical space.
 150         matches!(
 151             self.annotation_type,
 152             AnnotationType::MultilineStart(_) | AnnotationType::MultilineEnd(_)
 153         )
 154     }
 155 }
 156
 157 #[derive(Debug)]
 158 pub struct StyledString {
 159     pub text: String,
 160     pub style: Style,
 161 }
 162
 163 #[derive(Copy, Clone, Debug, PartialEq, Hash, Encodable, Decodable)]
 164 pub enum Style {
 165     MainHeaderMsg,
 166     HeaderMsg,
 167     LineAndColumn,
 168     LineNumber,
 169     Quotation,
 170     UnderlinePrimary,
 171     UnderlineSecondary,
 172     LabelPrimary,
 173     LabelSecondary,
 174     NoStyle,
 175     Level(Level),
 176     Highlight,
 177     Addition,
 178     Removal,
 179 }