Merge pull request #90 from Muscraft/use-bytes

fix!: Take in byte spans

Author: Muscraft

Diff for: Cargo.lock

@@ -25,6 +25,7 @@ maintenance = { status = "actively-developed" }
 
 [dependencies]
 anstyle = "1.0.4"
+itertools = "0.12.1"
 unicode-width = "0.1.11"
 
 [dev-dependencies]

Diff for: Cargo.toml

@@ -38,12 +38,12 @@ fn create_snippet(renderer: Renderer) {
                 SourceAnnotation {
                     label: "expected `Option<String>` because of return type",
                     annotation_type: AnnotationType::Warning,
-                    range: (5, 19),
+                    range: 5..19,
                 },
                 SourceAnnotation {
                     label: "expected enum `std::option::Option`",
                     annotation_type: AnnotationType::Error,
-                    range: (26, 724),
+                    range: 26..724,
                 },
             ],
         }],

Diff for: benches/simple.rs

@@ -20,12 +20,12 @@ fn main() {
                 SourceAnnotation {
                     label: "",
                     annotation_type: AnnotationType::Error,
-                    range: (193, 195),
+                    range: 193..195,
                 },
                 SourceAnnotation {
                     label: "while parsing this struct",
                     annotation_type: AnnotationType::Info,
-                    range: (34, 50),
+                    range: 34..50,
                 },
             ],
         }],

Diff for: examples/expected_type.rs

@@ -21,7 +21,7 @@ fn main() {
             fold: false,
             annotations: vec![SourceAnnotation {
                 label: "expected struct `annotate_snippets::snippet::Slice`, found reference",
-                range: (21, 24),
+                range: 21..24,
                 annotation_type: AnnotationType::Error,
             }],
         }],

Diff for: examples/footer.rs

@@ -32,12 +32,12 @@ fn main() {
                 SourceAnnotation {
                     label: "expected `Option<String>` because of return type",
                     annotation_type: AnnotationType::Warning,
-                    range: (5, 19),
+                    range: 5..19,
                 },
                 SourceAnnotation {
                     label: "expected enum `std::option::Option`",
                     annotation_type: AnnotationType::Error,
-                    range: (26, 724),
+                    range: 26..724,
                 },
             ],
         }],

Diff for: examples/format.rs

@@ -32,7 +32,10 @@
 //!
 //! The above snippet has been built out of the following structure:
 use crate::snippet;
+use itertools::FoldWhile::{Continue, Done};
+use itertools::Itertools;
 use std::fmt::{Display, Write};
+use std::ops::Range;
 use std::{cmp, fmt};
 
 use crate::renderer::{stylesheet::Stylesheet, Margin, Style};
@@ -766,7 +769,7 @@ fn format_slice(
     has_footer: bool,
     margin: Option<Margin>,
 ) -> Vec<DisplayLine<'_>> {
-    let main_range = slice.annotations.first().map(|x| x.range.0);
+    let main_range = slice.annotations.first().map(|x| x.range.start);
     let origin = slice.origin;
     let need_empty_header = origin.is_some() || is_first;
     let mut body = format_body(slice, need_empty_header, has_footer, margin);
@@ -804,13 +807,27 @@ fn format_header<'a>(
 
         for item in body {
             if let DisplayLine::Source {
-                line: DisplaySourceLine::Content { range, .. },
+                line: DisplaySourceLine::Content { text, range },
                 lineno,
                 ..
             } = item
             {
                 if main_range >= range.0 && main_range <= range.1 {
-                    col = main_range - range.0 + 1;
+                    let char_column = text
+                        .chars()
+                        .map(|c| unicode_width::UnicodeWidthChar::width(c).unwrap_or(0))
+                        .chain(std::iter::once(1)) // treat the end of line as single-width
+                        .enumerate()
+                        .fold_while((0, 0), |(count, acc), (i, width)| {
+                            if acc <= main_range - range.0 {
+                                Continue((i, acc + width))
+                            } else {
+                                Done((count, acc))
+                            }
+                        })
+                        .into_inner()
+                        .0;
+                    col = char_column + 1;
                     line_offset = lineno.unwrap_or(1);
                     break;
                 }
@@ -932,11 +949,11 @@ fn format_body(
     has_footer: bool,
     margin: Option<Margin>,
 ) -> Vec<DisplayLine<'_>> {
-    let source_len = slice.source.chars().count();
+    let source_len = slice.source.len();
     if let Some(bigger) = slice.annotations.iter().find_map(|x| {
         // Allow highlighting one past the last character in the source.
-        if source_len + 1 < x.range.1 {
-            Some(x.range)
+        if source_len + 1 < x.range.end {
+            Some(&x.range)
         } else {
             None
         }
@@ -955,18 +972,14 @@ fn format_body(
     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
+        let line_length: usize = line
             .chars()
             .map(|c| unicode_width::UnicodeWidthChar::width(c).unwrap_or(0))
-            .chain(std::iter::once(1)) // treat the end of line as single-width
-            .collect::<Vec<_>>();
+            .sum();
+        let line_range = (current_index, current_index + line_length);
         body.push(DisplayLine::Source {
             lineno: Some(current_line),
             inline_marks: vec![],
@@ -978,7 +991,6 @@ fn format_body(
         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;
@@ -991,7 +1003,6 @@ fn format_body(
         LineInfo {
             line_start_index,
             line_end_index,
-            char_widths,
         },
     ) in line_info.into_iter().enumerate()
     {
@@ -1007,21 +1018,13 @@ fn format_body(
                 _ => DisplayAnnotationType::from(annotation.annotation_type),
             };
             match annotation.range {
-                (start, _) if start > line_end_index => true,
-                (start, end)
+                Range { start, .. } if start > line_end_index => true,
+                Range { start, end }
                     if start >= line_start_index && end <= line_end_index
                         || start == line_end_index && end - start <= 1 =>
                 {
-                    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 annotation_start_col = start - line_start_index - margin_left;
+                    let annotation_end_col = end - line_start_index - margin_left;
                     let range = (annotation_start_col, annotation_end_col);
                     body.insert(
                         body_idx + 1,
@@ -1045,7 +1048,7 @@ fn format_body(
                     annotation_line_count += 1;
                     false
                 }
-                (start, end)
+                Range { start, end }
                     if start >= line_start_index
                         && start <= line_end_index
                         && end > line_end_index =>
@@ -1064,10 +1067,7 @@ fn format_body(
                             });
                         }
                     } else {
-                        let annotation_start_col = char_widths
-                            .iter()
-                            .take(start - line_start_index)
-                            .sum::<usize>();
+                        let annotation_start_col = start - line_start_index;
                         let range = (annotation_start_col, annotation_start_col + 1);
                         body.insert(
                             body_idx + 1,
@@ -1092,7 +1092,7 @@ fn format_body(
                     }
                     true
                 }
-                (start, end) if start < line_start_index && end > line_end_index => {
+                Range { start, end } if start < line_start_index && end > line_end_index => {
                     if let DisplayLine::Source {
                         ref mut inline_marks,
                         ..
@@ -1107,7 +1107,7 @@ fn format_body(
                     }
                     true
                 }
-                (start, end)
+                Range { start, end }
                     if start < line_start_index
                         && end >= line_start_index
                         && end <= line_end_index =>
@@ -1125,11 +1125,7 @@ fn format_body(
                         });
                     }
 
-                    let end_mark = char_widths
-                        .iter()
-                        .take(end - line_start_index)
-                        .sum::<usize>()
-                        .saturating_sub(1);
+                    let end_mark = (end - line_start_index).saturating_sub(1);
                     let range = (end_mark - margin_left, (end_mark + 1) - margin_left);
                     body.insert(
                         body_idx + 1,
@@ -1380,7 +1376,7 @@ mod tests {
         let line_2 = "This is line 2";
         let source = [line_1, line_2].join("\n");
         // In line 2
-        let range = (22, 24);
+        let range = 22..24;
         let input = snippet::Snippet {
             title: None,
             footer: vec![],
@@ -1389,7 +1385,7 @@ mod tests {
                 line_start: 5402,
                 origin: None,
                 annotations: vec![snippet::SourceAnnotation {
-                    range,
+                    range: range.clone(),
                     label: "Test annotation",
                     annotation_type: snippet::AnnotationType::Info,
                 }],
@@ -1430,7 +1426,10 @@ mod tests {
                             style: DisplayTextStyle::Regular,
                         }],
                     },
-                    range: (range.0 - (line_1.len() + 1), range.1 - (line_1.len() + 1)),
+                    range: (
+                        range.start - (line_1.len() + 1),
+                        range.end - (line_1.len() + 1),
+                    ),
                     annotation_type: DisplayAnnotationType::Info,
                     annotation_part: DisplayAnnotationPart::Standalone,
                 },
@@ -1480,7 +1479,7 @@ mod tests {
             footer: vec![],
             slices: vec![snippet::Slice {
                 annotations: vec![snippet::SourceAnnotation {
-                    range: (0, source.len() + 2),
+                    range: 0..source.len() + 2,
                     label,
                     annotation_type: snippet::AnnotationType::Error,
                 }],
@@ -1507,7 +1506,7 @@ mod tests {
                 line_start: 1,
                 origin: Some("<current file>"),
                 annotations: vec![snippet::SourceAnnotation {
-                    range: (19, 23),
+                    range: 19..23,
                     label: "oops",
                     annotation_type: snippet::AnnotationType::Error,
                 }],

Diff for: src/renderer/display_list.rs

@@ -31,6 +31,8 @@
 //! };
 //! ```
 
+use std::ops::Range;
+
 /// Primary structure provided for formatting
 #[derive(Debug, Default)]
 pub struct Snippet<'a> {
@@ -70,7 +72,8 @@ pub enum AnnotationType {
 /// An annotation for a `Slice`.
 #[derive(Debug)]
 pub struct SourceAnnotation<'a> {
-    pub range: (usize, usize),
+    /// The byte range of the annotation in the `source` string
+    pub range: Range<usize>,
     pub label: &'a str,
     pub annotation_type: AnnotationType,
 }

Diff for: src/snippet.rs

@@ -1,4 +1,5 @@
 use serde::{Deserialize, Deserializer, Serialize};
+use std::ops::Range;
 
 use annotate_snippets::{
     renderer::Margin, Annotation, AnnotationType, Renderer, Slice, Snippet, SourceAnnotation,
@@ -122,7 +123,7 @@ where
 #[derive(Serialize, Deserialize)]
 #[serde(remote = "SourceAnnotation")]
 pub struct SourceAnnotationDef<'a> {
-    pub range: (usize, usize),
+    pub range: Range<usize>,
     #[serde(borrow)]
     pub label: &'a str,
     #[serde(with = "AnnotationTypeDef")]