summaryrefslogtreecommitdiff
path: root/support/texlab/src/symbol/bibtex_entry.rs
blob: f719937e8097332870436a755a0fbffe7c07a30c (plain)
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
use super::types::{LatexSymbol, LatexSymbolKind};
use crate::{
    feature::{FeatureProvider, FeatureRequest},
    protocol::DocumentSymbolParams,
    syntax::{bibtex, BibtexEntryTypeCategory, SyntaxNode, LANGUAGE_DATA},
    workspace::DocumentContent,
};
use async_trait::async_trait;
use petgraph::graph::NodeIndex;

#[derive(Debug, PartialEq, Eq, Clone, Copy, Default)]
pub struct BibtexEntrySymbolProvider;

#[async_trait]
impl FeatureProvider for BibtexEntrySymbolProvider {
    type Params = DocumentSymbolParams;
    type Output = Vec<LatexSymbol>;

    async fn execute<'a>(&'a self, req: &'a FeatureRequest<Self::Params>) -> Self::Output {
        let mut symbols = Vec::new();
        if let DocumentContent::Bibtex(tree) = &req.current().content {
            for entry_node in tree.children(tree.root) {
                if let Some(entry) = tree
                    .as_entry(entry_node)
                    .filter(|entry| !entry.is_comment())
                    .filter(|entry| entry.key.is_some())
                {
                    let category = LANGUAGE_DATA
                        .find_entry_type(&entry.ty.text()[1..])
                        .map(|ty| ty.category)
                        .unwrap_or(BibtexEntryTypeCategory::Misc);

                    let key = entry.key.as_ref().unwrap();
                    let symbol = LatexSymbol {
                        name: key.text().to_owned(),
                        label: None,
                        kind: LatexSymbolKind::Entry(category),
                        deprecated: false,
                        full_range: entry.range(),
                        selection_range: key.range(),
                        children: Self::field_symbols(tree, entry_node),
                    };
                    symbols.push(symbol);
                }
            }
        }
        symbols
    }
}

impl BibtexEntrySymbolProvider {
    fn field_symbols(tree: &bibtex::Tree, entry_node: NodeIndex) -> Vec<LatexSymbol> {
        let mut symbols = Vec::new();
        for field in tree
            .children(entry_node)
            .filter_map(|node| tree.as_field(node))
        {
            let symbol = LatexSymbol {
                name: field.name.text().to_owned(),
                label: None,
                kind: LatexSymbolKind::Field,
                deprecated: false,
                full_range: field.range(),
                selection_range: field.name.range(),
                children: Vec::new(),
            };
            symbols.push(symbol);
        }
        symbols
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{
        feature::FeatureTester,
        protocol::{Range, RangeExt},
    };

    #[tokio::test]
    async fn empty_latex_document() {
        let actual_symbols = FeatureTester::new()
            .file("main.tex", "")
            .main("main.tex")
            .test_symbol(BibtexEntrySymbolProvider)
            .await;

        assert!(actual_symbols.is_empty());
    }

    #[tokio::test]
    async fn empty_bibtex_document() {
        let actual_symbols = FeatureTester::new()
            .file("main.bib", "")
            .main("main.bib")
            .test_symbol(BibtexEntrySymbolProvider)
            .await;

        assert!(actual_symbols.is_empty());
    }

    #[tokio::test]
    async fn entry() {
        let actual_symbols = FeatureTester::new()
            .file("main.bib", r#"@article{key, foo = bar, baz = qux}"#)
            .main("main.bib")
            .test_symbol(BibtexEntrySymbolProvider)
            .await;

        let expected_symbols = vec![LatexSymbol {
            name: "key".into(),
            label: None,
            kind: LatexSymbolKind::Entry(BibtexEntryTypeCategory::Article),
            deprecated: false,
            full_range: Range::new_simple(0, 0, 0, 35),
            selection_range: Range::new_simple(0, 9, 0, 12),
            children: vec![
                LatexSymbol {
                    name: "foo".into(),
                    label: None,
                    kind: LatexSymbolKind::Field,
                    deprecated: false,
                    full_range: Range::new_simple(0, 14, 0, 24),
                    selection_range: Range::new_simple(0, 14, 0, 17),
                    children: Vec::new(),
                },
                LatexSymbol {
                    name: "baz".into(),
                    label: None,
                    kind: LatexSymbolKind::Field,
                    deprecated: false,
                    full_range: Range::new_simple(0, 25, 0, 34),
                    selection_range: Range::new_simple(0, 25, 0, 28),
                    children: Vec::new(),
                },
            ],
        }];

        assert_eq!(actual_symbols, expected_symbols);
    }

    #[tokio::test]
    async fn comment() {
        let actual_symbols = FeatureTester::new()
            .file("main.bib", r#"@comment{key, foo = bar, baz = qux}"#)
            .main("main.bib")
            .test_symbol(BibtexEntrySymbolProvider)
            .await;

        assert!(actual_symbols.is_empty());
    }
}