Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix display of annotation for double width characters #46

Merged
merged 4 commits into from
Sep 4, 2021
Merged

Fix display of annotation for double width characters #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ac31f8a
Fix display of annotation for double width characters
magurotuna Sep 4, 2021
29cfa73
Display annotation correctly for double width characters across lines
magurotuna Sep 4, 2021
bb47ac0
Add test containing multiple snippets for double width characters
magurotuna Sep 4, 2021
fbdab5c
Add test to ensure it works when double-width and signle-width are mixed
magurotuna Sep 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 65 additions & 21 deletions src/display_list/from_snippet.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,11 +293,23 @@ fn format_body(
let mut body = vec![];
let mut current_line = slice.line_start;
let mut current_index = 0;
let mut line_index_ranges = vec![];
let mut line_info = vec![];

struct LineInfo {
line_start_index: usize,
line_end_index: usize,
// How many spaces each character in the line take up when displayed
char_widths: Vec<usize>,
}

for (line, end_line) in CursorLines::new(slice.source) {
let line_length = line.chars().count();
let line_range = (current_index, current_index + line_length);
let char_widths = line
.chars()
.map(|c| unicode_width::UnicodeWidthChar::width(c).unwrap_or(0))
.chain(std::iter::once(1)) // treat the end of line as signle-width
.collect::<Vec<_>>();
body.push(DisplayLine::Source {
lineno: Some(current_line),
inline_marks: vec![],
Expand All @@ -306,16 +318,28 @@ fn format_body(
range: line_range,
},
});
line_index_ranges.push(line_range);
line_info.push(LineInfo {
line_start_index: line_range.0,
line_end_index: line_range.1,
char_widths,
});
current_line += 1;
current_index += line_length + end_line as usize;
}

let mut annotation_line_count = 0;
let mut annotations = slice.annotations;
for (idx, (line_start, line_end)) in line_index_ranges.into_iter().enumerate() {
for (
idx,
LineInfo {
line_start_index,
line_end_index,
char_widths,
},
) in line_info.into_iter().enumerate()
{
let margin_left = margin
.map(|m| m.left(line_end - line_start))
.map(|m| m.left(line_end_index - line_start_index))
.unwrap_or_default();
// It would be nice to use filter_drain here once it's stable.
annotations = annotations
Expand All @@ -328,15 +352,22 @@ fn format_body(
_ => DisplayAnnotationType::from(annotation.annotation_type),
};
match annotation.range {
(start, _) if start > line_end => true,
(start, _) if start > line_end_index => true,
(start, end)
if start >= line_start && end <= line_end
|| start == line_end && end - start <= 1 =>
if start >= line_start_index && end <= line_end_index
|| start == line_end_index && end - start <= 1 =>
{
let range = (
(start - line_start) - margin_left,
(end - line_start) - margin_left,
);
let annotation_start_col = char_widths
.iter()
.take(start - line_start_index)
.sum::<usize>()
- margin_left;
let annotation_end_col = char_widths
.iter()
.take(end - line_start_index)
.sum::<usize>()
- margin_left;
let range = (annotation_start_col, annotation_end_col);
body.insert(
body_idx + 1,
DisplayLine::Source {
Expand All @@ -359,8 +390,12 @@ fn format_body(
annotation_line_count += 1;
false
}
(start, end) if start >= line_start && start <= line_end && end > line_end => {
if start - line_start == 0 {
(start, end)
if start >= line_start_index
&& start <= line_end_index
&& end > line_end_index =>
{
if start - line_start_index == 0 {
if let DisplayLine::Source {
ref mut inline_marks,
..
Expand All @@ -374,7 +409,11 @@ fn format_body(
});
}
} else {
let range = (start - line_start, start - line_start + 1);
let annotation_start_col = char_widths
.iter()
.take(start - line_start_index)
.sum::<usize>();
let range = (annotation_start_col, annotation_start_col + 1);
body.insert(
body_idx + 1,
DisplayLine::Source {
Expand All @@ -398,7 +437,7 @@ fn format_body(
}
true
}
(start, end) if start < line_start && end > line_end => {
(start, end) if start < line_start_index && end > line_end_index => {
if let DisplayLine::Source {
ref mut inline_marks,
..
Expand All @@ -413,7 +452,11 @@ fn format_body(
}
true
}
(start, end) if start < line_start && end >= line_start && end <= line_end => {
(start, end)
if start < line_start_index
&& end >= line_start_index
&& end <= line_end_index =>
{
if let DisplayLine::Source {
ref mut inline_marks,
..
Expand All @@ -427,11 +470,12 @@ fn format_body(
});
}

let end_mark = (end - line_start).saturating_sub(1);
let range = (
end_mark - margin_left,
(end_mark + 1) - margin_left,
);
let end_mark = char_widths
.iter()
.take(end - line_start_index)
.sum::<usize>()
.saturating_sub(1);
let range = (end_mark - margin_left, (end_mark + 1) - margin_left);
body.insert(
body_idx + 1,
DisplayLine::Source {
Expand Down
123 changes: 123 additions & 0 deletions tests/formatter.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -550,3 +550,126 @@ fn test_i_29() {

assert_eq!(DisplayList::from(snippets).to_string(), expected);
}

#[test]
fn test_point_to_double_width_characters() {
let snippets = Snippet {
slices: vec![snippet::Slice {
source: "こんにちは、世界",
line_start: 1,
origin: Some("<current file>"),
annotations: vec![snippet::SourceAnnotation {
range: (6, 8),
label: "world",
annotation_type: snippet::AnnotationType::Error,
}],
fold: false,
}],
title: None,
footer: vec![],
opt: Default::default(),
};

let expected = r#" --> <current file>:1:7
|
1 | こんにちは、世界
| ^^^^ world
|"#;
Comment on lines +573 to +577
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image


assert_eq!(DisplayList::from(snippets).to_string(), expected);
}

#[test]
fn test_point_to_double_width_characters_across_lines() {
let snippets = Snippet {
slices: vec![snippet::Slice {
source: "おはよう\nございます",
line_start: 1,
origin: Some("<current file>"),
annotations: vec![snippet::SourceAnnotation {
range: (2, 8),
label: "Good morning",
annotation_type: snippet::AnnotationType::Error,
}],
fold: false,
}],
title: None,
footer: vec![],
opt: Default::default(),
};

let expected = r#" --> <current file>:1:3
|
1 | おはよう
| _____^
2 | | ございます
| |______^ Good morning
|"#;
Comment on lines +601 to +607
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image


assert_eq!(DisplayList::from(snippets).to_string(), expected);
}

#[test]
fn test_point_to_double_width_characters_multiple() {
let snippets = Snippet {
slices: vec![snippet::Slice {
source: "お寿司\n食べたい🍣",
line_start: 1,
origin: Some("<current file>"),
annotations: vec![
snippet::SourceAnnotation {
range: (0, 3),
label: "Sushi1",
annotation_type: snippet::AnnotationType::Error,
},
snippet::SourceAnnotation {
range: (6, 8),
label: "Sushi2",
annotation_type: snippet::AnnotationType::Note,
},
],
fold: false,
}],
title: None,
footer: vec![],
opt: Default::default(),
};

let expected = r#" --> <current file>:1:1
|
1 | お寿司
| ^^^^^^ Sushi1
2 | 食べたい🍣
| ---- note: Sushi2
|"#;
Comment on lines +638 to +644
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With monospace fonts, this is displayed like:

image


assert_eq!(DisplayList::from(snippets).to_string(), expected);
}

#[test]
fn test_point_to_double_width_characters_mixed() {
let snippets = Snippet {
slices: vec![snippet::Slice {
source: "こんにちは、新しいWorld！",
line_start: 1,
origin: Some("<current file>"),
annotations: vec![snippet::SourceAnnotation {
range: (6, 14),
label: "New world",
annotation_type: snippet::AnnotationType::Error,
}],
fold: false,
}],
title: None,
footer: vec![],
opt: Default::default(),
};

let expected = r#" --> <current file>:1:7
|
1 | こんにちは、新しいWorld！
| ^^^^^^^^^^^ New world
|"#;
Comment on lines +668 to +672
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image


assert_eq!(DisplayList::from(snippets).to_string(), expected);
}