Skip to content

Commit

Permalink
Merge pull request #131 from Muscraft/fix-no-highlght-line-end
Browse files Browse the repository at this point in the history 
Fix annotating line endings
  • Loading branch information
@epage
epage authored Jun 14, 2024
2 parents ca313bf + c68600d commit b5a0af2
Show file tree
Hide file tree
Showing 5 changed files with 514 additions and 36 deletions.
87 changes: 68 additions & 19 deletions src/renderer/display_list.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -524,6 +524,7 @@ pub(crate) enum DisplaySourceLine<'a> {
Content {
text: &'a str,
range: (usize, usize), // meta information for annotation placement.
end_line: EndLine,
},
/// An empty source line.
Empty,
Expand Down Expand Up @@ -658,7 +659,8 @@ impl<'a> CursorLines<'a> {
}
}

enum EndLine {
#[derive(Copy, Clone, Debug, PartialEq)]
pub(crate) enum EndLine {
Eof = 0,
Crlf = 1,
Lf = 2,
Expand Down Expand Up @@ -847,13 +849,20 @@ fn format_header<'a>(

for item in body {
if let DisplayLine::Source {
line: DisplaySourceLine::Content { text, range },
line:
DisplaySourceLine::Content {
text,
range,
end_line,
},
lineno,
..
} = item
{
if main_range >= range.0 && main_range <= range.1 {
let char_column = text[0..(main_range - range.0)].chars().count();
if main_range >= range.0 && main_range <= range.1 + *end_line as usize {
let char_column = text[0..(main_range - range.0).min(text.len())]
.chars()
.count();
col = char_column + 1;
line_offset = lineno.unwrap_or(1);
break;
Expand Down Expand Up @@ -927,8 +936,18 @@ fn fold_body(body: Vec<DisplayLine<'_>>) -> Vec<DisplayLine<'_>> {
let mut unhighlighed_lines = vec![];
for line in body {
match &line {
DisplayLine::Source { annotations, .. } => {
if annotations.is_empty() {
DisplayLine::Source {
annotations,
inline_marks,
..
} => {
if annotations.is_empty()
// A multiline start mark (`/`) needs be treated as an
// annotation or the line could get folded.
&& inline_marks
.iter()
.all(|m| m.mark_type != DisplayMarkType::AnnotationStart)
{
unhighlighed_lines.push(line);
} else {
if lines.is_empty() {
Expand Down Expand Up @@ -1016,12 +1035,14 @@ fn format_body(
for (idx, (line, end_line)) in CursorLines::new(snippet.source).enumerate() {
let line_length: usize = line.len();
let line_range = (current_index, current_index + line_length);
let end_line_size = end_line as usize;
body.push(DisplayLine::Source {
lineno: Some(current_line),
inline_marks: vec![],
line: DisplaySourceLine::Content {
text: line,
range: line_range,
end_line,
},
annotations: vec![],
});
Expand All @@ -1045,7 +1066,7 @@ fn format_body(
let line_start_index = line_range.0;
let line_end_index = line_range.1;
current_line += 1;
current_index += line_length + end_line as usize;
current_index += line_length + end_line_size;

// It would be nice to use filter_drain here once it's stable.
annotations.retain(|annotation| {
Expand All @@ -1057,18 +1078,24 @@ fn format_body(
};
let label_right = annotation.label.map_or(0, |label| label.len() + 1);
match annotation.range {
Range { start, .. } if start > line_end_index => true,
// This handles if the annotation is on the next line. We add
// the `end_line_size` to account for annotating the line end.
Range { start, .. } if start > line_end_index + end_line_size => true,
// This handles the case where an annotation is contained
// within the current line including any line-end characters.
Range { start, end }
if start >= line_start_index && end <= line_end_index
// Allow annotating eof or stripped eol
|| start == line_end_index && end - start <= 1 =>
if start >= line_start_index
// We add at least one to `line_end_index` to allow
// highlighting the end of a file
&& end <= line_end_index + max(end_line_size, 1) =>
{
if let DisplayLine::Source {
ref mut annotations,
..
} = body[body_idx]
{
let annotation_start_col = line[0..(start - line_start_index)]
let annotation_start_col = line
[0..(start - line_start_index).min(line_length)]
.chars()
.map(|c| unicode_width::UnicodeWidthChar::width(c).unwrap_or(0))
.sum::<usize>();
Expand Down Expand Up @@ -1101,11 +1128,16 @@ fn format_body(
}
false
}
// This handles the case where a multiline annotation starts
// somewhere on the current line, including any line-end chars
Range { start, end }
if start >= line_start_index
&& start <= line_end_index
// The annotation can start on a line ending
&& start <= line_end_index + end_line_size.saturating_sub(1)
&& end > line_end_index =>
{
// Special case for multiline annotations that start at the
// beginning of a line, which requires a special mark (`/`)
if start - line_start_index == 0 {
if let DisplayLine::Source {
ref mut inline_marks,
Expand All @@ -1122,7 +1154,8 @@ fn format_body(
..
} = body[body_idx]
{
let annotation_start_col = line[0..(start - line_start_index)]
let annotation_start_col = line
[0..(start - line_start_index).min(line_length)]
.chars()
.map(|c| unicode_width::UnicodeWidthChar::width(c).unwrap_or(0))
.sum::<usize>();
Expand All @@ -1147,7 +1180,11 @@ fn format_body(
}
true
}
Range { start, end } if start < line_start_index && end > line_end_index => {
// This handles the case where a multiline annotation starts
// somewhere before this line and ends after it as well
Range { start, end }
if start < line_start_index && end > line_end_index + max(end_line_size, 1) =>
{
if let DisplayLine::Source {
ref mut inline_marks,
..
Expand All @@ -1160,10 +1197,14 @@ fn format_body(
}
true
}
// This handles the case where a multiline annotation ends
// somewhere on the current line, including any line-end chars
Range { start, end }
if start < line_start_index
&& end >= line_start_index
&& end <= line_end_index =>
// We add at least one to `line_end_index` to allow
// highlighting the end of a file
&& end <= line_end_index + max(end_line_size, 1) =>
{
if let DisplayLine::Source {
ref mut inline_marks,
Expand All @@ -1175,13 +1216,21 @@ fn format_body(
mark_type: DisplayMarkType::AnnotationThrough,
annotation_type: DisplayAnnotationType::from(annotation.level),
});
let end_mark = line[0..(end - line_start_index)]
let end_mark = line[0..(end - line_start_index).min(line_length)]
.chars()
.map(|c| unicode_width::UnicodeWidthChar::width(c).unwrap_or(0))
.sum::<usize>()
.saturating_sub(1);

let end_plus_one = end_mark + 1;
// If the annotation ends on a line-end character, we
// need to annotate one past the end of the line
let (end_mark, end_plus_one) = if end > line_end_index
// Special case for highlighting the end of a file
|| (end == line_end_index + 1 && end_line_size == 0)
{
(end_mark + 1, end_mark + 2)
} else {
(end_mark, end_mark + 1)
};

span_left_margin = min(span_left_margin, end_mark);
span_right_margin = max(span_right_margin, end_plus_one);
Expand Down
14 changes: 6 additions & 8 deletions tests/fixtures/no-color/ann_multiline2.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions tests/fixtures/no-color/ann_multiline2.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ title = "spacing error found"

[[message.snippets]]
source = """
This is an exampl
e of an edge case of an annotation overflowing
This is an example
of an edge case of an annotation overflowing
to exactly one character on next line.
"""
line_start = 26
Expand All @@ -15,4 +15,4 @@ fold = false
[[message.snippets.annotations]]
label = "this should not be on separate lines"
level = "Error"
range = [11, 18]
range = [11, 19]
14 changes: 8 additions & 6 deletions tests/fixtures/no-color/fold_ann_multiline.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit b5a0af2

Please sign in to comment.