marginalia 0.2.0

Trivia-preserving parsing and formatting for logos + lalrpop
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

use super::map::{CommentMap, HasSpan};
use crate::{Span, TriviaEvent, TriviaTable};

#[derive(Clone, Copy, Debug)]
pub struct AttachOptions {
    pub trailing_same_line: bool,
}

impl Default for AttachOptions {
    fn default() -> Self {
        Self {
            trailing_same_line: true,
        }
    }
}

pub fn attach<N: HasSpan, K: Clone + Default>(
    source: &str,
    table: &TriviaTable<K>,
    nodes: impl IntoIterator<Item = N>,
    opts: AttachOptions,
) -> CommentMap<K> {
    let mut spans: Vec<Span> = nodes.into_iter().map(|n| n.span()).collect();
    spans.sort_unstable();
    spans.dedup();

    let mut map = CommentMap::new();
    for event in table.events() {
        place_event(source, event, &spans, &mut map, opts);
    }
    map
}

fn place_event<K: Clone + Default>(
    source: &str,
    event: &TriviaEvent<K>,
    spans: &[Span],
    map: &mut CommentMap<K>,
    opts: AttachOptions,
) {
    let lo = event.span.start;
    let prev = preceding_node(spans, lo);
    let next = following_node(spans, lo);

    if event.trivia.is_blank() {
        if let Some(n) = next {
            map.entry(n).leading.push(event.trivia.clone());
        }
        return;
    }

    if opts.trailing_same_line {
        if let Some(p) = prev {
            if same_line(source, p.end, lo) {
                map.entry(p).trailing.push(event.trivia.clone());
                return;
            }
        }
    }

    if let Some(n) = next {
        map.entry(n).leading.push(event.trivia.clone());
    } else {
        map.push_dangling(event.trivia.clone());
    }
}

fn preceding_node(spans: &[Span], pos: usize) -> Option<Span> {
    spans
        .iter()
        .filter(|s| s.end <= pos)
        .max_by_key(|s| (s.end, std::cmp::Reverse(s.start)))
        .copied()
}

fn following_node(spans: &[Span], pos: usize) -> Option<Span> {
    spans
        .iter()
        .filter(|s| s.start >= pos)
        .min_by_key(|s| (s.start, std::cmp::Reverse(s.end)))
        .copied()
}

fn same_line(source: &str, from: usize, to: usize) -> bool {
    source
        .get(from..to)
        .is_some_and(|s| !s.bytes().any(|b| b == b'\n'))
}