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