language.rs

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