1mod buffer;
2mod diagnostic_set;
3mod highlight_map;
4mod outline;
5pub mod proto;
6#[cfg(test)]
7mod tests;
8
9use anyhow::{anyhow, Result};
10use collections::HashSet;
11use futures::{
12 future::{BoxFuture, Shared},
13 FutureExt,
14};
15use gpui::{executor, AppContext, Task};
16use highlight_map::HighlightMap;
17use lazy_static::lazy_static;
18use parking_lot::Mutex;
19use postage::watch;
20use serde::Deserialize;
21use std::{
22 cell::RefCell,
23 future::Future,
24 ops::Range,
25 path::{Path, PathBuf},
26 str,
27 sync::Arc,
28};
29use theme::SyntaxTheme;
30use tree_sitter::{self, Query};
31
32#[cfg(any(test, feature = "test-support"))]
33use futures::channel::mpsc;
34
35pub use buffer::Operation;
36pub use buffer::*;
37pub use diagnostic_set::DiagnosticEntry;
38pub use outline::{Outline, OutlineItem};
39pub use tree_sitter::{Parser, Tree};
40
41thread_local! {
42 static PARSER: RefCell<Parser> = RefCell::new(Parser::new());
43}
44
45lazy_static! {
46 pub static ref PLAIN_TEXT: Arc<Language> = Arc::new(Language::new(
47 LanguageConfig {
48 name: "Plain Text".to_string(),
49 path_suffixes: Default::default(),
50 brackets: Default::default(),
51 line_comment: None,
52 language_server: None,
53 },
54 None,
55 ));
56}
57
58pub trait ToLspPosition {
59 fn to_lsp_position(self) -> lsp::Position;
60}
61
62pub trait LspExt: 'static + Send + Sync {
63 fn server_bin_path(&self) -> BoxFuture<'static, Option<PathBuf>>;
64 fn process_diagnostics(&self, diagnostics: &mut lsp::PublishDiagnosticsParams);
65 fn label_for_completion(
66 &self,
67 _: &lsp::CompletionItem,
68 _: &Language,
69 ) -> Option<CompletionLabel> {
70 None
71 }
72}
73
74#[derive(Clone, Debug, PartialEq, Eq)]
75pub struct CompletionLabel {
76 pub text: String,
77 pub runs: Vec<(Range<usize>, HighlightId)>,
78 pub filter_range: Range<usize>,
79 pub left_aligned_len: usize,
80}
81
82#[derive(Default, Deserialize)]
83pub struct LanguageConfig {
84 pub name: String,
85 pub path_suffixes: Vec<String>,
86 pub brackets: Vec<BracketPair>,
87 pub line_comment: Option<String>,
88 pub language_server: Option<LanguageServerConfig>,
89}
90
91#[derive(Default, Deserialize)]
92pub struct LanguageServerConfig {
93 pub disk_based_diagnostic_sources: HashSet<String>,
94 pub disk_based_diagnostics_progress_token: Option<String>,
95 #[cfg(any(test, feature = "test-support"))]
96 #[serde(skip)]
97 fake_config: Option<FakeLanguageServerConfig>,
98}
99
100#[cfg(any(test, feature = "test-support"))]
101struct FakeLanguageServerConfig {
102 servers_tx: mpsc::UnboundedSender<lsp::FakeLanguageServer>,
103 capabilities: lsp::ServerCapabilities,
104 initializer: Option<Box<dyn 'static + Send + Sync + Fn(&mut lsp::FakeLanguageServer)>>,
105}
106
107#[derive(Clone, Debug, Deserialize)]
108pub struct BracketPair {
109 pub start: String,
110 pub end: String,
111 pub close: bool,
112 pub newline: bool,
113}
114
115pub struct Language {
116 pub(crate) config: LanguageConfig,
117 pub(crate) grammar: Option<Arc<Grammar>>,
118 pub(crate) lsp_ext: Option<Box<dyn LspExt>>,
119 lsp_binary_path: Mutex<Option<Shared<BoxFuture<'static, Option<PathBuf>>>>>,
120}
121
122pub struct Grammar {
123 pub(crate) ts_language: tree_sitter::Language,
124 pub(crate) highlights_query: Query,
125 pub(crate) brackets_query: Query,
126 pub(crate) indents_query: Query,
127 pub(crate) outline_query: Query,
128 pub(crate) highlight_map: Mutex<HighlightMap>,
129}
130
131pub struct LanguageRegistry {
132 languages: Vec<Arc<Language>>,
133 pending_lsp_binaries_tx: Arc<Mutex<watch::Sender<usize>>>,
134 pending_lsp_binaries_rx: watch::Receiver<usize>,
135}
136
137impl LanguageRegistry {
138 pub fn new() -> Self {
139 let (pending_lsp_binaries_tx, pending_lsp_binaries_rx) = watch::channel();
140 Self {
141 languages: Default::default(),
142 pending_lsp_binaries_tx: Arc::new(Mutex::new(pending_lsp_binaries_tx)),
143 pending_lsp_binaries_rx,
144 }
145 }
146
147 pub fn add(&mut self, language: Arc<Language>, cx: &executor::Background) {
148 self.languages.push(language.clone());
149 if let Some(lsp_binary_path) = language.lsp_binary_path() {
150 let pending_lsp_binaries_tx = self.pending_lsp_binaries_tx.clone();
151 cx.spawn(async move {
152 *pending_lsp_binaries_tx.lock().borrow_mut() += 1;
153 lsp_binary_path.await;
154 *pending_lsp_binaries_tx.lock().borrow_mut() -= 1;
155 })
156 .detach();
157 }
158 }
159
160 pub fn set_theme(&self, theme: &SyntaxTheme) {
161 for language in &self.languages {
162 language.set_theme(theme);
163 }
164 }
165
166 pub fn get_language(&self, name: &str) -> Option<&Arc<Language>> {
167 self.languages
168 .iter()
169 .find(|language| language.name() == name)
170 }
171
172 pub fn select_language(&self, path: impl AsRef<Path>) -> Option<&Arc<Language>> {
173 let path = path.as_ref();
174 let filename = path.file_name().and_then(|name| name.to_str());
175 let extension = path.extension().and_then(|name| name.to_str());
176 let path_suffixes = [extension, filename];
177 self.languages.iter().find(|language| {
178 language
179 .config
180 .path_suffixes
181 .iter()
182 .any(|suffix| path_suffixes.contains(&Some(suffix.as_str())))
183 })
184 }
185
186 pub fn pending_lsp_binaries(&self) -> watch::Receiver<usize> {
187 self.pending_lsp_binaries_rx.clone()
188 }
189}
190
191impl Language {
192 pub fn new(config: LanguageConfig, ts_language: Option<tree_sitter::Language>) -> Self {
193 Self {
194 config,
195 grammar: ts_language.map(|ts_language| {
196 Arc::new(Grammar {
197 brackets_query: Query::new(ts_language, "").unwrap(),
198 highlights_query: Query::new(ts_language, "").unwrap(),
199 indents_query: Query::new(ts_language, "").unwrap(),
200 outline_query: Query::new(ts_language, "").unwrap(),
201 ts_language,
202 highlight_map: Default::default(),
203 })
204 }),
205 lsp_ext: None,
206 lsp_binary_path: Default::default(),
207 }
208 }
209
210 pub fn with_highlights_query(mut self, source: &str) -> Result<Self> {
211 let grammar = self
212 .grammar
213 .as_mut()
214 .and_then(Arc::get_mut)
215 .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
216 grammar.highlights_query = Query::new(grammar.ts_language, source)?;
217 Ok(self)
218 }
219
220 pub fn with_brackets_query(mut self, source: &str) -> Result<Self> {
221 let grammar = self
222 .grammar
223 .as_mut()
224 .and_then(Arc::get_mut)
225 .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
226 grammar.brackets_query = Query::new(grammar.ts_language, source)?;
227 Ok(self)
228 }
229
230 pub fn with_indents_query(mut self, source: &str) -> Result<Self> {
231 let grammar = self
232 .grammar
233 .as_mut()
234 .and_then(Arc::get_mut)
235 .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
236 grammar.indents_query = Query::new(grammar.ts_language, source)?;
237 Ok(self)
238 }
239
240 pub fn with_outline_query(mut self, source: &str) -> Result<Self> {
241 let grammar = self
242 .grammar
243 .as_mut()
244 .and_then(Arc::get_mut)
245 .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
246 grammar.outline_query = Query::new(grammar.ts_language, source)?;
247 Ok(self)
248 }
249
250 pub fn with_lsp_ext(mut self, processor: impl LspExt) -> Self {
251 self.lsp_ext = Some(Box::new(processor));
252 self
253 }
254
255 pub fn name(&self) -> &str {
256 self.config.name.as_str()
257 }
258
259 pub fn line_comment_prefix(&self) -> Option<&str> {
260 self.config.line_comment.as_deref()
261 }
262
263 pub fn start_server(
264 &self,
265 root_path: Arc<Path>,
266 cx: &AppContext,
267 ) -> Task<Result<Option<Arc<lsp::LanguageServer>>>> {
268 #[cfg(any(test, feature = "test-support"))]
269 if let Some(config) = &self.config.language_server {
270 if let Some(fake_config) = &config.fake_config {
271 use postage::prelude::Stream;
272
273 let (server, mut fake_server) = lsp::LanguageServer::fake_with_capabilities(
274 fake_config.capabilities.clone(),
275 cx.background().clone(),
276 );
277
278 if let Some(initalizer) = &fake_config.initializer {
279 initalizer(&mut fake_server);
280 }
281
282 let servers_tx = fake_config.servers_tx.clone();
283 let mut initialized = server.capabilities();
284 cx.background()
285 .spawn(async move {
286 while initialized.recv().await.is_none() {}
287 servers_tx.unbounded_send(fake_server).ok();
288 })
289 .detach();
290
291 return Task::ready(Ok(Some(server.clone())));
292 }
293 }
294
295 let background = cx.background().clone();
296 let server_binary_path = self
297 .lsp_binary_path()
298 .ok_or_else(|| anyhow!("cannot locate or download language server"));
299 cx.background().spawn(async move {
300 if let Some(server_binary_path) = server_binary_path?.await {
301 let server = lsp::LanguageServer::new(&server_binary_path, &root_path, background)?;
302 Ok(Some(server))
303 } else {
304 Ok(None)
305 }
306 })
307 }
308
309 pub fn disk_based_diagnostic_sources(&self) -> Option<&HashSet<String>> {
310 self.config
311 .language_server
312 .as_ref()
313 .map(|config| &config.disk_based_diagnostic_sources)
314 }
315
316 pub fn disk_based_diagnostics_progress_token(&self) -> Option<&String> {
317 self.config
318 .language_server
319 .as_ref()
320 .and_then(|config| config.disk_based_diagnostics_progress_token.as_ref())
321 }
322
323 pub fn process_diagnostics(&self, diagnostics: &mut lsp::PublishDiagnosticsParams) {
324 if let Some(processor) = self.lsp_ext.as_ref() {
325 processor.process_diagnostics(diagnostics);
326 }
327 }
328
329 pub fn label_for_completion(
330 &self,
331 completion: &lsp::CompletionItem,
332 ) -> Option<CompletionLabel> {
333 self.lsp_ext
334 .as_ref()?
335 .label_for_completion(completion, self)
336 }
337
338 pub fn highlight_text<'a>(
339 &'a self,
340 text: &'a Rope,
341 range: Range<usize>,
342 ) -> Vec<(Range<usize>, HighlightId)> {
343 let mut result = Vec::new();
344 if let Some(grammar) = &self.grammar {
345 let tree = grammar.parse_text(text, None);
346 let mut offset = 0;
347 for chunk in BufferChunks::new(text, range, Some(&tree), self.grammar.as_ref(), vec![])
348 {
349 let end_offset = offset + chunk.text.len();
350 if let Some(highlight_id) = chunk.highlight_id {
351 result.push((offset..end_offset, highlight_id));
352 }
353 offset = end_offset;
354 }
355 }
356 result
357 }
358
359 fn lsp_binary_path(&self) -> Option<impl Future<Output = Option<PathBuf>>> {
360 if let Some(lsp_ext) = self.lsp_ext.as_ref() {
361 Some(
362 self.lsp_binary_path
363 .lock()
364 .get_or_insert_with(|| lsp_ext.server_bin_path().shared())
365 .clone(),
366 )
367 } else {
368 None
369 }
370 }
371
372 pub fn brackets(&self) -> &[BracketPair] {
373 &self.config.brackets
374 }
375
376 pub fn set_theme(&self, theme: &SyntaxTheme) {
377 if let Some(grammar) = self.grammar.as_ref() {
378 *grammar.highlight_map.lock() =
379 HighlightMap::new(grammar.highlights_query.capture_names(), theme);
380 }
381 }
382
383 pub fn grammar(&self) -> Option<&Arc<Grammar>> {
384 self.grammar.as_ref()
385 }
386}
387
388impl Grammar {
389 fn parse_text(&self, text: &Rope, old_tree: Option<Tree>) -> Tree {
390 PARSER.with(|parser| {
391 let mut parser = parser.borrow_mut();
392 parser
393 .set_language(self.ts_language)
394 .expect("incompatible grammar");
395 let mut chunks = text.chunks_in_range(0..text.len());
396 parser
397 .parse_with(
398 &mut move |offset, _| {
399 chunks.seek(offset);
400 chunks.next().unwrap_or("").as_bytes()
401 },
402 old_tree.as_ref(),
403 )
404 .unwrap()
405 })
406 }
407
408 pub fn highlight_map(&self) -> HighlightMap {
409 self.highlight_map.lock().clone()
410 }
411
412 pub fn highlight_id_for_name(&self, name: &str) -> Option<HighlightId> {
413 let capture_id = self.highlights_query.capture_index_for_name(name)?;
414 Some(self.highlight_map.lock().get(capture_id))
415 }
416}
417
418impl CompletionLabel {
419 pub fn plain(completion: &lsp::CompletionItem) -> Self {
420 let mut result = Self {
421 text: completion.label.clone(),
422 runs: Vec::new(),
423 left_aligned_len: completion.label.len(),
424 filter_range: 0..completion.label.len(),
425 };
426 if let Some(filter_text) = &completion.filter_text {
427 if let Some(ix) = completion.label.find(filter_text) {
428 result.filter_range = ix..ix + filter_text.len();
429 }
430 }
431 result
432 }
433}
434
435#[cfg(any(test, feature = "test-support"))]
436impl LanguageServerConfig {
437 pub fn fake() -> (Self, mpsc::UnboundedReceiver<lsp::FakeLanguageServer>) {
438 let (servers_tx, servers_rx) = mpsc::unbounded();
439 (
440 Self {
441 fake_config: Some(FakeLanguageServerConfig {
442 servers_tx,
443 capabilities: Default::default(),
444 initializer: None,
445 }),
446 disk_based_diagnostics_progress_token: Some("fakeServer/check".to_string()),
447 ..Default::default()
448 },
449 servers_rx,
450 )
451 }
452
453 pub fn set_fake_capabilities(&mut self, capabilities: lsp::ServerCapabilities) {
454 self.fake_config.as_mut().unwrap().capabilities = capabilities;
455 }
456
457 pub fn set_fake_initializer(
458 &mut self,
459 initializer: impl 'static + Send + Sync + Fn(&mut lsp::FakeLanguageServer),
460 ) {
461 self.fake_config.as_mut().unwrap().initializer = Some(Box::new(initializer));
462 }
463}
464
465impl ToLspPosition for PointUtf16 {
466 fn to_lsp_position(self) -> lsp::Position {
467 lsp::Position::new(self.row, self.column)
468 }
469}
470
471pub fn point_from_lsp(point: lsp::Position) -> PointUtf16 {
472 PointUtf16::new(point.line, point.character)
473}
474
475pub fn range_from_lsp(range: lsp::Range) -> Range<PointUtf16> {
476 let start = PointUtf16::new(range.start.line, range.start.character);
477 let end = PointUtf16::new(range.end.line, range.end.character);
478 start..end
479}