marginalia 0.2.1

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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

use std::collections::BTreeMap;

use crate::{trivia::BuiltinKind, Span, Trivia};

pub trait HasSpan {
    fn span(&self) -> Span;
}

impl HasSpan for Span {
    fn span(&self) -> Span {
        *self
    }
}

/// Comments attached to a single anchor span.
///
/// `leading` comments precede the anchor (each rendered on its own line).
/// `trailing` comments follow the anchor on the *same source line* — the
/// attacher only populates this slot when the comment was on the same line
/// as the anchor's last token. Comments separated by a line break instead
/// become leading on the next anchor, or dangling if no next anchor exists.
#[derive(Clone, Debug)]
pub struct Comments<K = BuiltinKind> {
    pub leading: Vec<Trivia<K>>,
    pub trailing: Vec<Trivia<K>>,
}

impl<K> Default for Comments<K> {
    fn default() -> Self {
        Self {
            leading: Vec::new(),
            trailing: Vec::new(),
        }
    }
}

impl<K> Comments<K> {
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.leading.is_empty() && self.trailing.is_empty()
    }
}

#[derive(Clone, Debug)]
pub struct CommentMap<K = BuiltinKind> {
    by_span: BTreeMap<Span, Comments<K>>,
    dangling: Vec<Trivia<K>>,
}

impl<K> Default for CommentMap<K> {
    fn default() -> Self {
        Self {
            by_span: BTreeMap::new(),
            dangling: Vec::new(),
        }
    }
}

impl<K> CommentMap<K> {
    #[must_use]
    pub const fn new() -> Self {
        Self {
            by_span: BTreeMap::new(),
            dangling: Vec::new(),
        }
    }

    pub fn entry(&mut self, span: Span) -> &mut Comments<K> {
        self.by_span.entry(span).or_default()
    }

    #[must_use]
    pub fn get(&self, span: Span) -> Option<&Comments<K>> {
        self.by_span.get(&span)
    }

    #[must_use]
    pub fn leading(&self, span: Span) -> &[Trivia<K>] {
        self.by_span
            .get(&span)
            .map_or(&[][..], |c| c.leading.as_slice())
    }

    #[must_use]
    pub fn trailing(&self, span: Span) -> &[Trivia<K>] {
        self.by_span
            .get(&span)
            .map_or(&[][..], |c| c.trailing.as_slice())
    }

    #[must_use]
    pub fn dangling(&self) -> &[Trivia<K>] {
        &self.dangling
    }

    pub fn push_dangling(&mut self, t: Trivia<K>) {
        self.dangling.push(t);
    }

    #[must_use]
    pub fn len(&self) -> usize {
        self.by_span.len()
    }

    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.by_span.is_empty() && self.dangling.is_empty()
    }
}