mull 0.36.26

A tool for managing a wiki stored in a plain text file.
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

// This index records where each line of some source contents starts, so finding the line that
// contains a byte offset doesn't require scanning the source from its start.
#[derive(Clone, Debug)]
pub struct LineIndex {
    line_starts: Vec<usize>, // The first line starts at 0, and every other line follows a `\n`.
    source_len: usize,       // The length of the source contents in bytes
}

impl LineIndex {
    // Find the start of each line in the source contents.
    pub fn new(source_contents: &str) -> Self {
        Self {
            line_starts: std::iter::once(0)
                .chain(
                    source_contents
                        .match_indices('\n')
                        .map(|(index, _)| index + '\n'.len_utf8()),
                )
                .collect(),
            source_len: source_contents.len(),
        }
    }

    // Find the zero-based line containing a byte offset, if the offset is within the source or at
    // its end.
    pub fn line(&self, byte_offset: usize) -> Option<usize> {
        (byte_offset <= self.source_len).then(|| {
            self.line_starts
                .partition_point(|line_start| *line_start <= byte_offset)
                - 1
        })
    }

    // Find where a line starts, if the source has that line.
    pub fn line_start(&self, line: usize) -> Option<usize> {
        self.line_starts.get(line).copied()
    }

    // Find where a line ends, not including its `\n`, if the source has that line.
    pub fn line_end(&self, line: usize) -> Option<usize> {
        self.line_start(line)?;
        Some(
            self.line_start(line + 1)
                .map_or(self.source_len, |next_line_start| {
                    next_line_start - '\n'.len_utf8()
                }),
        )
    }
}

#[cfg(test)]
mod tests {
    use super::LineIndex;

    // Treat an empty source as a single empty line.
    #[test]
    fn empty_source() {
        let line_index = LineIndex::new("");

        assert_eq!(line_index.line(0), Some(0));
        assert_eq!(line_index.line(1), None);
        assert_eq!(line_index.line_start(0), Some(0));
        assert_eq!(line_index.line_end(0), Some(0));
        assert_eq!(line_index.line_start(1), None);
        assert_eq!(line_index.line_end(1), None);
    }

    // Locate offsets on the lines that contain them, including the empty line after a final line
    // break, and reject offsets beyond the source.
    #[test]
    fn lines_contain_offsets() {
        let source = "zero\none\n";
        let line_index = LineIndex::new(source);

        assert_eq!(line_index.line(0), Some(0));
        assert_eq!(line_index.line(4), Some(0));
        assert_eq!(line_index.line(5), Some(1));
        assert_eq!(line_index.line(8), Some(1));
        assert_eq!(line_index.line(9), Some(2));
        assert_eq!(line_index.line(10), None);
    }

    // Report each line's extent without its line break.
    #[test]
    fn line_extents() {
        let source = "zero\r\none\n";
        let line_index = LineIndex::new(source);

        assert_eq!(line_index.line_start(0), Some(0));
        assert_eq!(line_index.line_end(0), Some(5));
        assert_eq!(line_index.line_start(1), Some(6));
        assert_eq!(line_index.line_end(1), Some(9));
        assert_eq!(line_index.line_start(2), Some(10));
        assert_eq!(line_index.line_end(2), Some(10));
        assert_eq!(line_index.line_start(3), None);
        assert_eq!(line_index.line_end(3), None);
    }
}