summaryrefslogtreecommitdiff
path: root/support/texlab/src/features/hover/field.rs
blob: daa0c301cd183535b3adb2bf567fdf9c5644e1aa (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
use lsp_types::{Hover, HoverContents, HoverParams, MarkupContent};
use rowan::ast::AstNode;

use crate::{features::cursor::CursorContext, syntax::bibtex, LineIndexExt, LANGUAGE_DATA};

pub fn find_field_hover(context: &CursorContext<HoverParams>) -> Option<Hover> {
    let main_document = context.request.main_document();

    let name = context
        .cursor
        .as_bibtex()
        .filter(|token| token.kind() == bibtex::NAME)?;

    bibtex::Field::cast(name.parent()?)?;

    let docs = LANGUAGE_DATA.field_documentation(name.text())?;
    Some(Hover {
        contents: HoverContents::Markup(MarkupContent {
            kind: lsp_types::MarkupKind::Markdown,
            value: docs.to_string(),
        }),
        range: Some(
            main_document
                .line_index
                .line_col_lsp_range(name.text_range()),
        ),
    })
}

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

    use crate::{features::testing::FeatureTester, RangeExt};

    use super::*;

    #[test]
    fn test_empty_latex_document() {
        let request = FeatureTester::builder()
            .files(vec![("main.tex", "")])
            .main("main.tex")
            .line(0)
            .character(0)
            .build()
            .hover();

        let context = CursorContext::new(request);
        let actual_hover = find_field_hover(&context);

        assert_eq!(actual_hover, None);
    }

    #[test]
    fn test_empty_bibtex_document() {
        let request = FeatureTester::builder()
            .files(vec![("main.bib", "")])
            .main("main.bib")
            .line(0)
            .character(0)
            .build()
            .hover();

        let context = CursorContext::new(request);
        let actual_hover = find_field_hover(&context);

        assert_eq!(actual_hover, None);
    }

    #[test]
    fn test_known_field() {
        let request = FeatureTester::builder()
            .files(vec![("main.bib", r#"@article{foo, author = bar}"#)])
            .main("main.bib")
            .line(0)
            .character(15)
            .build()
            .hover();

        let context = CursorContext::new(request);
        let actual_hover = find_field_hover(&context).unwrap();
        let expected_hover = Hover {
            contents: HoverContents::Markup(MarkupContent {
                kind: MarkupKind::Markdown,
                value: LANGUAGE_DATA.field_documentation("author").unwrap().into(),
            }),
            range: Some(Range::new_simple(0, 14, 0, 20)),
        };
        assert_eq!(actual_hover, expected_hover);
    }

    #[test]
    fn test_unknown_field() {
        let request = FeatureTester::builder()
            .files(vec![("main.bib", r#"@article{foo, bar = baz}"#)])
            .main("main.bib")
            .line(0)
            .character(15)
            .build()
            .hover();

        let context = CursorContext::new(request);
        let actual_hover = find_field_hover(&context);
        assert_eq!(actual_hover, None);
    }

    #[test]
    fn test_entry_key() {
        let request = FeatureTester::builder()
            .files(vec![("main.bib", r#"@article{foo, author = bar}"#)])
            .main("main.bib")
            .line(0)
            .character(11)
            .build()
            .hover();

        let context = CursorContext::new(request);
        let actual_hover = find_field_hover(&context);
        assert_eq!(actual_hover, None);
    }
}