summaryrefslogtreecommitdiff
path: root/support/texlab/src/definition/latex_label.rs
blob: 8d1a415749177411747e7cecc62c522ea99dfeb6 (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
use crate::range::RangeExt;
use crate::symbol::build_section_tree;
use crate::syntax::*;
use crate::workspace::*;
use futures_boxed::boxed;
use lsp_types::{LocationLink, TextDocumentPositionParams};
use std::sync::Arc;

#[derive(Debug, PartialEq, Eq, Clone)]
pub struct LatexLabelDefinitionProvider;

impl FeatureProvider for LatexLabelDefinitionProvider {
    type Params = TextDocumentPositionParams;
    type Output = Vec<LocationLink>;

    #[boxed]
    async fn execute<'a>(&'a self, request: &'a FeatureRequest<Self::Params>) -> Self::Output {
        let mut links = Vec::new();
        if let Some(reference) = Self::find_reference(&request) {
            for document in request.related_documents() {
                let workspace = Arc::clone(&request.view.workspace);
                let view = DocumentView::new(workspace, Arc::clone(&document));
                Self::find_definitions(&view, &reference, &mut links);
            }
        }
        links
    }
}

impl LatexLabelDefinitionProvider {
    fn find_definitions(
        view: &DocumentView,
        reference: &LatexToken,
        links: &mut Vec<LocationLink>,
    ) {
        if let SyntaxTree::Latex(tree) = &view.document.tree {
            let outline = Outline::from(view);
            let section_tree = build_section_tree(view, tree);
            for label in &tree.structure.labels {
                if label.kind == LatexLabelKind::Definition {
                    let context = OutlineContext::parse(view, label, &outline);
                    for name in label.names() {
                        if name.text() == reference.text() {
                            let target_range = if let Some(OutlineContextItem::Section { .. }) =
                                context.as_ref().map(|ctx| &ctx.item)
                            {
                                section_tree
                                    .find(reference.text())
                                    .map(|sec| sec.full_range)
                            } else {
                                context.as_ref().map(|ctx| ctx.range)
                            };

                            links.push(LocationLink {
                                origin_selection_range: Some(reference.range()),
                                target_uri: view.document.uri.clone().into(),
                                target_range: target_range.unwrap_or_else(|| label.range()),
                                target_selection_range: label.range(),
                            });
                        }
                    }
                }
            }
        }
    }

    fn find_reference(request: &FeatureRequest<TextDocumentPositionParams>) -> Option<&LatexToken> {
        if let SyntaxTree::Latex(tree) = &request.document().tree {
            tree.structure
                .labels
                .iter()
                .flat_map(LatexLabel::names)
                .find(|label| label.range().contains(request.params.position))
        } else {
            None
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use lsp_types::{Position, Range};

    #[test]
    fn test_has_definition() {
        let links = test_feature(
            LatexLabelDefinitionProvider,
            FeatureSpec {
                files: vec![
                    FeatureSpec::file("foo.tex", "\\label{foo}"),
                    FeatureSpec::file(
                        "bar.tex",
                        "\\begin{a}\\begin{b}\\label{foo}\\end{b}\\end{a}\n\\input{baz.tex}",
                    ),
                    FeatureSpec::file("baz.tex", "\\ref{foo}"),
                ],
                main_file: "baz.tex",
                position: Position::new(0, 5),
                ..FeatureSpec::default()
            },
        );
        assert_eq!(
            links,
            vec![LocationLink {
                origin_selection_range: Some(Range::new_simple(0, 5, 0, 8)),
                target_uri: FeatureSpec::uri("bar.tex"),
                target_range: Range::new_simple(0, 18, 0, 29),
                target_selection_range: Range::new_simple(0, 18, 0, 29)
            }]
        );
    }

    #[test]
    fn test_no_definition_latex() {
        let links = test_feature(
            LatexLabelDefinitionProvider,
            FeatureSpec {
                files: vec![FeatureSpec::file("foo.tex", "")],
                main_file: "foo.tex",
                position: Position::new(0, 0),
                ..FeatureSpec::default()
            },
        );
        assert!(links.is_empty());
    }

    #[test]
    fn test_no_definition_bibtex() {
        let links = test_feature(
            LatexLabelDefinitionProvider,
            FeatureSpec {
                files: vec![FeatureSpec::file("foo.bib", "")],
                main_file: "foo.bib",
                position: Position::new(0, 0),
                ..FeatureSpec::default()
            },
        );
        assert!(links.is_empty());
    }
}