summaryrefslogtreecommitdiff
path: root/support/texlab/src/db/document.rs
blob: 40d0ab025fb3ca8daa7040db7af1c26179853fee (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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
use std::path::{Path, PathBuf};

use lsp_types::Url;
use rowan::{TextRange, TextSize};

use crate::{
    db::{
        diagnostics::Diagnostic,
        parse::{BibDocumentData, LogDocumentData, TectonicData, TexDocumentData, TexlabRootData},
    },
    parser::{parse_bibtex, parse_build_log, parse_latex},
    util::line_index::LineIndex,
    Db,
};

use super::{
    analysis::TexLinkKind,
    parse::{self, DocumentData},
};

#[salsa::interned]
pub struct Location {
    #[return_ref]
    pub uri: Url,
}

#[salsa::tracked]
impl Location {
    #[salsa::tracked(return_ref)]
    pub fn path(self, db: &dyn Db) -> Option<PathBuf> {
        let uri = self.uri(db);
        if uri.scheme() == "file" {
            uri.to_file_path().ok()
        } else {
            None
        }
    }

    pub fn stem(self, db: &dyn Db) -> Option<String> {
        let path = self.uri(db).to_file_path().ok()?;
        let stem = path.file_stem()?.to_str()?;
        Some(String::from(stem))
    }

    pub fn join(self, db: &dyn Db, path: &str) -> Option<Location> {
        let uri = self.uri(db).join(path).ok()?;
        Some(Location::new(db, uri))
    }
}

#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Copy, Hash)]
pub enum Owner {
    Client,
    Server,
}

#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Clone, Copy, Hash)]
pub enum Language {
    Tex,
    Bib,
    Log,
    TexlabRoot,
    Tectonic,
}

impl Language {
    pub fn from_path(path: &Path) -> Option<Self> {
        let name = path.file_name()?;
        if name.eq_ignore_ascii_case(".texlabroot") || name.eq_ignore_ascii_case("texlabroot") {
            return Some(Self::TexlabRoot);
        }

        if name.eq_ignore_ascii_case("Tectonic.toml") {
            return Some(Self::Tectonic);
        }

        let extname = path.extension()?.to_str()?;
        match extname.to_lowercase().as_str() {
            "tex" | "sty" | "cls" | "def" | "lco" | "aux" | "rnw" => Some(Self::Tex),
            "bib" | "bibtex" => Some(Self::Bib),
            "log" => Some(Self::Log),
            _ => None,
        }
    }

    pub fn from_id(id: &str) -> Option<Self> {
        match id {
            "tex" | "latex" => Some(Self::Tex),
            "bib" | "bibtex" => Some(Self::Bib),
            "texlabroot" => Some(Self::TexlabRoot),
            _ => None,
        }
    }
}

#[salsa::input]
pub struct LinterData {
    #[return_ref]
    pub chktex: Vec<Diagnostic>,
}

#[salsa::input]
pub struct Document {
    /// An object containing the URI of the document.
    pub location: Location,

    /// The source code.
    #[return_ref]
    pub text: String,

    /// The programming language.
    pub language: Language,

    /// The program (either server or client) which opened the document.
    pub owner: Owner,

    /// An estimate of the current cursor position.
    pub cursor: TextSize,

    /// The diagnostics reported from external linters such as ChkTeX.
    pub linter: LinterData,
}

impl Document {
    pub fn edit(self, db: &mut dyn Db, range: TextRange, replace_with: &str) {
        let mut text = self.set_text(db).to(String::new());
        text.replace_range(std::ops::Range::<usize>::from(range), replace_with);
        self.set_text(db).to(text);
        self.set_cursor(db).to(range.start());
    }

    pub fn directory(self, db: &dyn Db) -> Location {
        self.location(db).join(db, ".").unwrap()
    }

    pub fn ancestor_dirs<'db>(self, db: &'db dyn Db) -> impl Iterator<Item = &'db Path> + 'db {
        self.location(db)
            .path(db)
            .as_deref()
            .into_iter()
            .flat_map(|path| path.ancestors())
            .skip(1)
    }
}

#[salsa::tracked]
impl Document {
    #[salsa::tracked]
    pub fn parse(self, db: &dyn Db) -> DocumentData {
        let text = self.text(db);
        match self.language(db) {
            Language::Tex => {
                let data = TexDocumentData::new(db, parse_latex(text));
                parse::DocumentData::Tex(data)
            }
            Language::Bib => {
                let data = BibDocumentData::new(db, parse_bibtex(text));
                DocumentData::Bib(data)
            }
            Language::Log => {
                let data = LogDocumentData::new(db, parse_build_log(text));
                DocumentData::Log(data)
            }
            Language::TexlabRoot => {
                let data = TexlabRootData;
                DocumentData::TexlabRoot(data)
            }
            Language::Tectonic => {
                let data = TectonicData;
                DocumentData::Tectonic(data)
            }
        }
    }

    #[salsa::tracked]
    pub fn can_be_root(self, db: &dyn Db) -> bool {
        self.parse(db).as_tex().map_or(false, |data| {
            let analysis = data.analyze(db);
            analysis.has_document_environment(db)
                && !analysis
                    .links(db)
                    .iter()
                    .filter(|link| link.kind(db) == TexLinkKind::Cls)
                    .any(|link| link.path(db).text(db) == "subfiles")
        })
    }

    #[salsa::tracked]
    pub fn can_be_built(self, db: &dyn Db) -> bool {
        self.parse(db)
            .as_tex()
            .map_or(false, |data| data.analyze(db).has_document_environment(db))
    }

    #[salsa::tracked(return_ref)]
    pub fn line_index(self, db: &dyn Db) -> LineIndex {
        LineIndex::new(self.text(db))
    }
}