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