annotate-snippets 0.0.1

Library for building code 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
155
156
157
158
159
160
161
162
163
164
165
166

use display_list::{DisplayAnnotationType, DisplayLine, DisplayList, DisplayMark};
use std::fmt;

pub struct FormattedDisplayList {
    body: Vec<FormattedDisplayLine>,
}

impl From<DisplayList> for FormattedDisplayList {
    fn from(dl: DisplayList) -> Self {
        let lineno_width = dl.body.iter().fold(0, |max, ref line| match line {
            DisplayLine::Source { lineno, .. } => {
                let width = lineno.to_string().len();
                if width > max {
                    width
                } else {
                    max
                }
            }
            _ => max,
        });
        let inline_marks_width = dl.body.iter().fold(0, |max, ref line| match line {
            DisplayLine::Source { inline_marks, .. } => {
                let width = inline_marks.len();
                if width > max {
                    width + 1
                } else {
                    max
                }
            }
            _ => max,
        });
        let body = dl.body
            .into_iter()
            .map(|line| FormattedDisplayLine::format(line, lineno_width, inline_marks_width))
            .collect();
        FormattedDisplayList { body }
    }
}

impl fmt::Display for FormattedDisplayList {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        if let Some((last, elements)) = &self.body.split_last() {
            for line in elements.iter() {
                line.fmt(f)?;
                writeln!(f)?;
            }
            last.fmt(f)?;
        }
        Ok(())
    }
}

#[derive(Debug)]
enum FormattedDisplayLine {
    Raw(String),
    EmptySource {
        lineno: String,
    },
    Source {
        lineno: String,
        inline_marks: String,
        content: String,
    },
    Annotation {
        lineno: String,
        inline_marks: String,
        content: String,
    },
    Fold,
}

impl FormattedDisplayLine {
    fn format(dl: DisplayLine, lineno_width: usize, inline_marks_width: usize) -> Self {
        match dl {
            DisplayLine::Raw(s) => FormattedDisplayLine::Raw(s),
            DisplayLine::EmptySource => FormattedDisplayLine::EmptySource {
                lineno: " ".repeat(lineno_width),
            },
            DisplayLine::Source {
                lineno,
                inline_marks,
                content,
            } => FormattedDisplayLine::Source {
                lineno: format!("{: >width$}", lineno, width = lineno_width),
                inline_marks: Self::format_inline_marks(&inline_marks, inline_marks_width),
                content,
            },
            DisplayLine::Annotation {
                inline_marks,
                range,
                label,
                annotation_type,
            } => FormattedDisplayLine::Annotation {
                lineno: " ".repeat(lineno_width),
                inline_marks: Self::format_inline_marks(&inline_marks, inline_marks_width),
                content: Self::format_annotation_content(range, &label, annotation_type),
            },
            DisplayLine::Fold => FormattedDisplayLine::Fold,
        }
    }

    fn format_inline_marks(inline_marks: &[DisplayMark], inline_marks_width: usize) -> String {
        format!(
            "{: >width$}",
            inline_marks
                .iter()
                .map(|mark| format!("{}", mark))
                .collect::<Vec<String>>()
                .join(""),
            width = inline_marks_width
        )
    }

    fn format_annotation_content(
        range: (usize, usize),
        label: &str,
        annotation_type: DisplayAnnotationType,
    ) -> String {
        match annotation_type {
            DisplayAnnotationType::Error => format!(
                "{}{} {}",
                " ".repeat(range.0),
                "^".repeat(range.1 - range.0),
                label
            ),
            DisplayAnnotationType::Warning => format!(
                "{}{} {}",
                " ".repeat(range.0),
                "-".repeat(range.1 - range.0),
                label
            ),
            DisplayAnnotationType::MultilineStart => format!(
                "{}{} {}",
                "_".repeat(range.0),
                "^".repeat(range.1 - range.0),
                label
            ),
            DisplayAnnotationType::MultilineEnd => format!(
                "{}{} {}",
                "_".repeat(range.0),
                "^".repeat(range.1 - range.0),
                label
            ),
        }
    }
}

impl fmt::Display for FormattedDisplayLine {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            FormattedDisplayLine::EmptySource { lineno } => write!(f, "{} |", lineno),
            FormattedDisplayLine::Source {
                lineno,
                inline_marks,
                content,
            } => write!(f, "{} |{} {}", lineno, inline_marks, content),
            FormattedDisplayLine::Raw(body) => write!(f, "{}", body),
            FormattedDisplayLine::Annotation {
                lineno,
                inline_marks,
                content,
            } => write!(f, "{} |{}{}", lineno, inline_marks, content),
            FormattedDisplayLine::Fold => write!(f, "...  |"),
        }
    }
}