summaryrefslogtreecommitdiff
path: root/support/texlab/src/hover/latex/component.rs
blob: 5285ec795a2b621ec5681e20d253b6d5e1786a6e (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
use crate::{
    components::COMPONENT_DATABASE,
    feature::{FeatureProvider, FeatureRequest},
    protocol::{Hover, HoverContents, RangeExt, TextDocumentPositionParams},
    syntax::{LatexIncludeKind, SyntaxNode},
};
use async_trait::async_trait;

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

#[async_trait]
impl FeatureProvider for LatexComponentHoverProvider {
    type Params = TextDocumentPositionParams;
    type Output = Option<Hover>;

    async fn execute<'a>(&'a self, req: &'a FeatureRequest<Self::Params>) -> Self::Output {
        let table = req.current().content.as_latex()?;
        for include in &table.includes {
            match include.kind {
                LatexIncludeKind::Package | LatexIncludeKind::Class => {
                    for path in include.paths(&table) {
                        if path.range().contains(req.params.position) {
                            let docs = COMPONENT_DATABASE.documentation(path.text())?;
                            return Some(Hover {
                                contents: HoverContents::Markup(docs),
                                range: Some(path.range()),
                            });
                        }
                    }
                }
                _ => {}
            }
        }
        None
    }
}

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

    #[tokio::test]
    async fn empty_latex_document() {
        let actual_hover = FeatureTester::new()
            .file("main.tex", "")
            .main("main.tex")
            .position(0, 0)
            .test_position(LatexComponentHoverProvider)
            .await;

        assert_eq!(actual_hover, None);
    }

    #[tokio::test]
    async fn empty_bibtex_document() {
        let actual_hover = FeatureTester::new()
            .file("main.bib", "")
            .main("main.bib")
            .position(0, 0)
            .test_position(LatexComponentHoverProvider)
            .await;

        assert_eq!(actual_hover, None);
    }

    #[tokio::test]
    async fn known_package() {
        let actual_hover = FeatureTester::new()
            .file("main.tex", r#"\usepackage{amsmath}"#)
            .main("main.tex")
            .position(0, 15)
            .test_position(LatexComponentHoverProvider)
            .await
            .unwrap();

        assert_eq!(actual_hover.range.unwrap(), Range::new_simple(0, 12, 0, 19));
    }

    #[tokio::test]
    async fn unknown_class() {
        let actual_hover = FeatureTester::new()
            .file("main.tex", r#"\documentclass{abcdefghijklmnop}"#)
            .main("main.tex")
            .position(0, 20)
            .test_position(LatexComponentHoverProvider)
            .await;

        assert_eq!(actual_hover, None);
    }
}