language.rs

  1use crate::HighlightMap;
  2use anyhow::{anyhow, Result};
  3use gpui::{executor::Background, AppContext};
  4use lazy_static::lazy_static;
  5use lsp::LanguageServer;
  6use parking_lot::Mutex;
  7use serde::Deserialize;
  8use std::{collections::HashSet, path::Path, str, sync::Arc};
  9use theme::SyntaxTheme;
 10use tree_sitter::{self, Query};
 11pub use tree_sitter::{Parser, Tree};
 12
 13lazy_static! {
 14    pub static ref PLAIN_TEXT: Arc<Language> = Arc::new(Language::new(
 15        LanguageConfig {
 16            name: "Plain Text".to_string(),
 17            path_suffixes: Default::default(),
 18            brackets: Default::default(),
 19            line_comment: None,
 20            language_server: None,
 21        },
 22        None,
 23    ));
 24}
 25
 26#[derive(Default, Deserialize)]
 27pub struct LanguageConfig {
 28    pub name: String,
 29    pub path_suffixes: Vec<String>,
 30    pub brackets: Vec<BracketPair>,
 31    pub line_comment: Option<String>,
 32    pub language_server: Option<LanguageServerConfig>,
 33}
 34
 35#[derive(Default, Deserialize)]
 36pub struct LanguageServerConfig {
 37    pub binary: String,
 38    pub disk_based_diagnostic_sources: HashSet<String>,
 39    #[cfg(any(test, feature = "test-support"))]
 40    #[serde(skip)]
 41    pub fake_server: Option<(Arc<LanguageServer>, Arc<std::sync::atomic::AtomicBool>)>,
 42}
 43
 44#[derive(Clone, Debug, Deserialize)]
 45pub struct BracketPair {
 46    pub start: String,
 47    pub end: String,
 48    pub close: bool,
 49    pub newline: bool,
 50}
 51
 52pub struct Language {
 53    pub(crate) config: LanguageConfig,
 54    pub(crate) grammar: Option<Arc<Grammar>>,
 55}
 56
 57pub struct Grammar {
 58    pub(crate) ts_language: tree_sitter::Language,
 59    pub(crate) highlights_query: Query,
 60    pub(crate) brackets_query: Query,
 61    pub(crate) indents_query: Query,
 62    pub(crate) highlight_map: Mutex<HighlightMap>,
 63}
 64
 65#[derive(Default)]
 66pub struct LanguageRegistry {
 67    languages: Vec<Arc<Language>>,
 68}
 69
 70impl LanguageRegistry {
 71    pub fn new() -> Self {
 72        Self::default()
 73    }
 74
 75    pub fn add(&mut self, language: Arc<Language>) {
 76        self.languages.push(language);
 77    }
 78
 79    pub fn set_theme(&self, theme: &SyntaxTheme) {
 80        for language in &self.languages {
 81            language.set_theme(theme);
 82        }
 83    }
 84
 85    pub fn get_language(&self, name: &str) -> Option<&Arc<Language>> {
 86        self.languages
 87            .iter()
 88            .find(|language| language.name() == name)
 89    }
 90
 91    pub fn select_language(&self, path: impl AsRef<Path>) -> Option<&Arc<Language>> {
 92        let path = path.as_ref();
 93        let filename = path.file_name().and_then(|name| name.to_str());
 94        let extension = path.extension().and_then(|name| name.to_str());
 95        let path_suffixes = [extension, filename];
 96        self.languages.iter().find(|language| {
 97            language
 98                .config
 99                .path_suffixes
100                .iter()
101                .any(|suffix| path_suffixes.contains(&Some(suffix.as_str())))
102        })
103    }
104}
105
106impl Language {
107    pub fn new(config: LanguageConfig, ts_language: Option<tree_sitter::Language>) -> Self {
108        Self {
109            config,
110            grammar: ts_language.map(|ts_language| {
111                Arc::new(Grammar {
112                    brackets_query: Query::new(ts_language, "").unwrap(),
113                    highlights_query: Query::new(ts_language, "").unwrap(),
114                    indents_query: Query::new(ts_language, "").unwrap(),
115                    ts_language,
116                    highlight_map: Default::default(),
117                })
118            }),
119        }
120    }
121
122    pub fn with_highlights_query(mut self, source: &str) -> Result<Self> {
123        let grammar = self
124            .grammar
125            .as_mut()
126            .and_then(Arc::get_mut)
127            .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
128        grammar.highlights_query = Query::new(grammar.ts_language, source)?;
129        Ok(self)
130    }
131
132    pub fn with_brackets_query(mut self, source: &str) -> Result<Self> {
133        let grammar = self
134            .grammar
135            .as_mut()
136            .and_then(Arc::get_mut)
137            .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
138        grammar.brackets_query = Query::new(grammar.ts_language, source)?;
139        Ok(self)
140    }
141
142    pub fn with_indents_query(mut self, source: &str) -> Result<Self> {
143        let grammar = self
144            .grammar
145            .as_mut()
146            .and_then(Arc::get_mut)
147            .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
148        grammar.indents_query = Query::new(grammar.ts_language, source)?;
149        Ok(self)
150    }
151
152    pub fn name(&self) -> &str {
153        self.config.name.as_str()
154    }
155
156    pub fn line_comment_prefix(&self) -> Option<&str> {
157        self.config.line_comment.as_deref()
158    }
159
160    pub fn start_server(
161        &self,
162        root_path: &Path,
163        cx: &AppContext,
164    ) -> Result<Option<Arc<lsp::LanguageServer>>> {
165        if let Some(config) = &self.config.language_server {
166            #[cfg(any(test, feature = "test-support"))]
167            if let Some((server, started)) = &config.fake_server {
168                started.store(true, std::sync::atomic::Ordering::SeqCst);
169                return Ok(Some(server.clone()));
170            }
171
172            const ZED_BUNDLE: Option<&'static str> = option_env!("ZED_BUNDLE");
173            let binary_path = if ZED_BUNDLE.map_or(Ok(false), |b| b.parse())? {
174                cx.platform()
175                    .path_for_resource(Some(&config.binary), None)?
176            } else {
177                Path::new(&config.binary).to_path_buf()
178            };
179            lsp::LanguageServer::new(&binary_path, root_path, cx.background().clone()).map(Some)
180        } else {
181            Ok(None)
182        }
183    }
184
185    pub fn disk_based_diagnostic_sources(&self) -> Option<&HashSet<String>> {
186        self.config
187            .language_server
188            .as_ref()
189            .map(|config| &config.disk_based_diagnostic_sources)
190    }
191
192    pub fn brackets(&self) -> &[BracketPair] {
193        &self.config.brackets
194    }
195
196    pub fn set_theme(&self, theme: &SyntaxTheme) {
197        if let Some(grammar) = self.grammar.as_ref() {
198            *grammar.highlight_map.lock() =
199                HighlightMap::new(grammar.highlights_query.capture_names(), theme);
200        }
201    }
202}
203
204impl Grammar {
205    pub fn highlight_map(&self) -> HighlightMap {
206        self.highlight_map.lock().clone()
207    }
208}
209
210#[cfg(any(test, feature = "test-support"))]
211impl LanguageServerConfig {
212    pub async fn fake(executor: Arc<Background>) -> (Self, lsp::FakeLanguageServer) {
213        let (server, fake) = lsp::LanguageServer::fake(executor).await;
214        fake.started
215            .store(false, std::sync::atomic::Ordering::SeqCst);
216        let started = fake.started.clone();
217        (
218            Self {
219                fake_server: Some((server, started)),
220                ..Default::default()
221            },
222            fake,
223        )
224    }
225}
226
227#[cfg(test)]
228mod tests {
229    use super::*;
230
231    #[test]
232    fn test_select_language() {
233        let registry = LanguageRegistry {
234            languages: vec![
235                Arc::new(Language::new(
236                    LanguageConfig {
237                        name: "Rust".to_string(),
238                        path_suffixes: vec!["rs".to_string()],
239                        ..Default::default()
240                    },
241                    Some(tree_sitter_rust::language()),
242                )),
243                Arc::new(Language::new(
244                    LanguageConfig {
245                        name: "Make".to_string(),
246                        path_suffixes: vec!["Makefile".to_string(), "mk".to_string()],
247                        ..Default::default()
248                    },
249                    Some(tree_sitter_rust::language()),
250                )),
251            ],
252        };
253
254        // matching file extension
255        assert_eq!(
256            registry.select_language("zed/lib.rs").map(|l| l.name()),
257            Some("Rust")
258        );
259        assert_eq!(
260            registry.select_language("zed/lib.mk").map(|l| l.name()),
261            Some("Make")
262        );
263
264        // matching filename
265        assert_eq!(
266            registry.select_language("zed/Makefile").map(|l| l.name()),
267            Some("Make")
268        );
269
270        // matching suffix that is not the full file extension or filename
271        assert_eq!(registry.select_language("zed/cars").map(|l| l.name()), None);
272        assert_eq!(
273            registry.select_language("zed/a.cars").map(|l| l.name()),
274            None
275        );
276        assert_eq!(registry.select_language("zed/sumk").map(|l| l.name()), None);
277    }
278}