sourceannot 0.3.1

A library to render snippets of source code with annotations
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

#![warn(
    rust_2018_idioms,
    trivial_casts,
    trivial_numeric_casts,
    unreachable_pub,
    unused_qualifications
)]
#![forbid(unsafe_code)]

// Simple rendering tests focused on snippet building.

mod chars;
mod latin1;
mod utf16_words;
mod utf8;
mod utf8_bytes;

const MAIN_STYLE: sourceannot::MainStyle<char> = sourceannot::MainStyle {
    margin: None,
    horizontal_char: '─',
    vertical_char: '│',
    top_vertical_char: '╭',
    top_corner_char: '╭',
    bottom_corner_char: '╰',
    spaces_meta: 's',
    text_normal_meta: 't',
    text_alt_meta: 'T',
};

const ANNOT_STYLE: sourceannot::AnnotStyle<char> = sourceannot::AnnotStyle {
    caret: '^',
    text_normal_meta: 't',
    text_alt_meta: 'T',
    line_meta: 'l',
};

struct TestOutput {
    text: String,
    styles: String,
}

impl sourceannot::Output<char> for &mut TestOutput {
    type Error = core::convert::Infallible;

    fn put_str(&mut self, s: &str, &style: &char) -> Result<(), Self::Error> {
        self.text.push_str(s);
        for c in s.chars() {
            self.styles.push(style);
            if c == '\n' {
                self.styles.push('\n');
            }
        }

        Ok(())
    }
}

#[track_caller]
fn test_render_simple(
    snippet: &sourceannot::Snippet,
    span: std::ops::Range<usize>,
    text_line: &str,
    carets_line: &str,
    text_styles: &str,
) {
    let mut annots = sourceannot::Annotations::new(snippet, &MAIN_STYLE);
    annots.add_annotation(span, &ANNOT_STYLE, Vec::new());

    let mut output = TestOutput {
        text: String::new(),
        styles: String::new(),
    };
    let max_line_no_width = annots.max_line_no_width();
    annots.render(max_line_no_width, 0, 0, &mut output);

    let carets_line = carets_line.trim_end_matches(' ');
    let mut expected_styles = String::new();
    expected_styles.push_str(text_styles);
    expected_styles.push_str("s\n");
    for c in carets_line.chars() {
        match c {
            ' ' => expected_styles.push('s'),
            '^' => expected_styles.push('l'),
            _ => unreachable!(),
        }
    }
    expected_styles.push_str("s\n");

    assert_eq!(output.text, format!("{text_line}\n{carets_line}\n"));
    assert_eq!(output.styles, expected_styles);
}

#[test]
fn test_large_chunk() {
    for n in 0..=500 {
        let mut builder = sourceannot::Snippet::builder(0);
        builder.push_char('a', 1, false);
        builder.push_str(&"¬".repeat(n), 4, true);
        builder.push_char('b', 1, false);
        let snippet = builder.finish();

        let rendered_line = format!("a{}b", "¬".repeat(n));
        let rendered_line_style = format!("t{}t", "T".repeat(n));
        test_render_simple(
            &snippet,
            0..1,
            &rendered_line,
            &format!("^{} ", " ".repeat(n)),
            &rendered_line_style,
        );
        test_render_simple(
            &snippet,
            1..2,
            &rendered_line,
            &format!(" {} ", "^".repeat(n.max(1))),
            &rendered_line_style,
        );
        test_render_simple(
            &snippet,
            2..3,
            &rendered_line,
            &format!(" {} ", "^".repeat(n.max(1))),
            &rendered_line_style,
        );
        test_render_simple(
            &snippet,
            3..4,
            &rendered_line,
            &format!(" {} ", "^".repeat(n.max(1))),
            &rendered_line_style,
        );
        test_render_simple(
            &snippet,
            4..5,
            &rendered_line,
            &format!(" {} ", "^".repeat(n.max(1))),
            &rendered_line_style,
        );
        test_render_simple(
            &snippet,
            1..5,
            &rendered_line,
            &format!(" {} ", "^".repeat(n.max(1))),
            &rendered_line_style,
        );
        test_render_simple(
            &snippet,
            5..6,
            &rendered_line,
            &format!(" {}^", " ".repeat(n)),
            &rendered_line_style,
        );
    }
}