Skip to content

Commit

Permalink
Show multiline spans in full if short enough
Browse files Browse the repository at this point in the history
When dealing with multiline spans that span few lines, show the complete
span instead of restricting to the first character of the first line.

For example, instead of:

```
% ./rustc foo.rs
error[E0277]: the trait bound `{integer}: std::ops::Add<()>` is not satisfied
  --> foo.rs:13:9
   |
13 |    foo(1 + bar(x,
   |        ^ trait `{integer}: std::ops::Add<()>` not satisfied
   |
```

show

```
% ./rustc foo.rs
error[E0277]: the trait bound `{integer}: std::ops::Add<()>` is not satisfied
  --> foo.rs:13:9
   |
13 |      foo(1 + bar(x,
   |  ________^ starting here...
14 | |            y),
   | |_____________^ ...ending here: trait `{integer}: std::ops::Add<()>` not satisfied
   |
```
  • Loading branch information
estebank committed Nov 22, 2016
1 parent fb12219 commit eb53ca3
Show file tree
Hide file tree
Showing 15 changed files with 1,081 additions and 144 deletions.
484 changes: 379 additions & 105 deletions src/librustc_errors/emitter.rs

Large diffs are not rendered by default.

103 changes: 100 additions & 3 deletions src/librustc_errors/snippet.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,57 @@ pub struct Line {
pub annotations: Vec<Annotation>,
}

#[derive(Clone, Debug, PartialOrd, Ord, PartialEq, Eq)]
pub enum AnnotationType {
/// Annotation under a single line of code
Singleline,

/// Annotation under the first character of a multiline span
Minimized,

/// Annotation enclosing the first and last character of a multiline span
Multiline {
depth: usize,
line_start: usize,
line_end: usize,
},

// The Multiline type above is replaced with the following three in order
// to reuse the current label drawing code.
//
// Each of these corresponds to one part of the following diagram:
//
// x | foo(1 + bar(x,
// | _________^ starting here... < MultilineStart
// x | | y), < MultilineLine
// | |______________^ ...ending here: label < MultilineEnd
// x | z);
/// Annotation marking the first character of a fully shown multiline span
MultilineStart(usize),
/// Annotation marking the last character of a fully shown multiline span
MultilineEnd(usize),
/// Line at the left enclosing the lines of a fully shown multiline span
MultilineLine(usize),
}

impl AnnotationType {
pub fn depth(&self) -> usize {
match self {
&AnnotationType::Multiline {depth, ..} |
&AnnotationType::MultilineStart(depth) |
&AnnotationType::MultilineLine(depth) |
&AnnotationType::MultilineEnd(depth) => depth,
_ => 0,
}
}

pub fn increase_depth(&mut self) {
if let AnnotationType::Multiline {ref mut depth, ..} = *self {
*depth += 1;
}
}
}

#[derive(Clone, Debug, PartialOrd, Ord, PartialEq, Eq)]
pub struct Annotation {
/// Start column, 0-based indexing -- counting *characters*, not
Expand All @@ -55,11 +106,57 @@ pub struct Annotation {
/// Is this annotation derived from primary span
pub is_primary: bool,

/// Is this a large span minimized down to a smaller span
pub is_minimized: bool,

/// Optional label to display adjacent to the annotation.
pub label: Option<String>,

/// Is this a single line, multiline or multiline span minimized down to a
/// smaller span.
pub annotation_type: AnnotationType,
}

impl Annotation {
pub fn is_minimized(&self) -> bool {
match self.annotation_type {
AnnotationType::Minimized => true,
_ => false,
}
}

pub fn is_multiline(&self) -> bool {
match self.annotation_type {
AnnotationType::Multiline {..} |
AnnotationType::MultilineStart(_) |
AnnotationType::MultilineLine(_) |
AnnotationType::MultilineEnd(_) => true,
_ => false,
}
}

pub fn as_start(&self) -> Annotation {
let mut a = self.clone();
a.annotation_type = AnnotationType::MultilineStart(self.annotation_type.depth());
a.end_col = a.start_col + 1;
a.label = Some("starting here...".to_owned());
a
}

pub fn as_end(&self) -> Annotation {
let mut a = self.clone();
a.annotation_type = AnnotationType::MultilineEnd(self.annotation_type.depth());
a.start_col = a.end_col - 1;
a.label = match a.label {
Some(l) => Some(format!("...ending here: {}", l)),
None => Some("..ending here".to_owned()),
};
a
}

pub fn as_line(&self) -> Annotation {
let mut a = self.clone();
a.annotation_type = AnnotationType::MultilineLine(self.annotation_type.depth());
a.label = None;
a
}
}

#[derive(Debug)]
Expand Down
3 changes: 3 additions & 0 deletions src/libsyntax/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -144,4 +144,7 @@ pub mod ext {
}
}

#[cfg(test)]
mod test_snippet;

// __build_diagnostic_array! { libsyntax, DIAGNOSTICS }
Loading

0 comments on commit eb53ca3

Please sign in to comment.