1mod buffer;
2mod diagnostic_set;
3mod highlight_map;
4mod outline;
5pub mod proto;
6mod syntax_map;
7
8#[cfg(test)]
9mod buffer_tests;
10
11use anyhow::{anyhow, Context, Result};
12use async_trait::async_trait;
13use client::http::HttpClient;
14use collections::HashMap;
15use futures::{
16 future::{BoxFuture, Shared},
17 FutureExt, TryFutureExt,
18};
19use gpui::{executor::Background, MutableAppContext, Task};
20use highlight_map::HighlightMap;
21use lazy_static::lazy_static;
22use parking_lot::{Mutex, RwLock};
23use postage::watch;
24use regex::Regex;
25use serde::{de, Deserialize, Deserializer};
26use serde_json::Value;
27use std::{
28 any::Any,
29 borrow::Cow,
30 cell::RefCell,
31 fmt::Debug,
32 hash::Hash,
33 mem,
34 ops::Range,
35 path::{Path, PathBuf},
36 str,
37 sync::{
38 atomic::{AtomicUsize, Ordering::SeqCst},
39 Arc,
40 },
41};
42use syntax_map::SyntaxSnapshot;
43use theme::{SyntaxTheme, Theme};
44use tree_sitter::{self, Query};
45use unicase::UniCase;
46use util::ResultExt;
47
48#[cfg(any(test, feature = "test-support"))]
49use futures::channel::mpsc;
50
51pub use buffer::Operation;
52pub use buffer::*;
53pub use diagnostic_set::DiagnosticEntry;
54pub use outline::{Outline, OutlineItem};
55pub use tree_sitter::{Parser, Tree};
56
57thread_local! {
58 static PARSER: RefCell<Parser> = RefCell::new(Parser::new());
59}
60
61lazy_static! {
62 pub static ref NEXT_GRAMMAR_ID: AtomicUsize = Default::default();
63 pub static ref PLAIN_TEXT: Arc<Language> = Arc::new(Language::new(
64 LanguageConfig {
65 name: "Plain Text".into(),
66 ..Default::default()
67 },
68 None,
69 ));
70}
71
72pub trait ToLspPosition {
73 fn to_lsp_position(self) -> lsp::Position;
74}
75
76#[derive(Clone, Debug, PartialEq, Eq, Hash)]
77pub struct LanguageServerName(pub Arc<str>);
78
79/// Represents a Language Server, with certain cached sync properties.
80/// Uses [`LspAdapter`] under the hood, but calls all 'static' methods
81/// once at startup, and caches the results.
82pub struct CachedLspAdapter {
83 pub name: LanguageServerName,
84 pub server_args: Vec<String>,
85 pub initialization_options: Option<Value>,
86 pub disk_based_diagnostic_sources: Vec<String>,
87 pub disk_based_diagnostics_progress_token: Option<String>,
88 pub language_ids: HashMap<String, String>,
89 pub adapter: Box<dyn LspAdapter>,
90}
91
92impl CachedLspAdapter {
93 pub async fn new(adapter: Box<dyn LspAdapter>) -> Arc<Self> {
94 let name = adapter.name().await;
95 let server_args = adapter.server_args().await;
96 let initialization_options = adapter.initialization_options().await;
97 let disk_based_diagnostic_sources = adapter.disk_based_diagnostic_sources().await;
98 let disk_based_diagnostics_progress_token =
99 adapter.disk_based_diagnostics_progress_token().await;
100 let language_ids = adapter.language_ids().await;
101
102 Arc::new(CachedLspAdapter {
103 name,
104 server_args,
105 initialization_options,
106 disk_based_diagnostic_sources,
107 disk_based_diagnostics_progress_token,
108 language_ids,
109 adapter,
110 })
111 }
112
113 pub async fn fetch_latest_server_version(
114 &self,
115 http: Arc<dyn HttpClient>,
116 ) -> Result<Box<dyn 'static + Send + Any>> {
117 self.adapter.fetch_latest_server_version(http).await
118 }
119
120 pub async fn fetch_server_binary(
121 &self,
122 version: Box<dyn 'static + Send + Any>,
123 http: Arc<dyn HttpClient>,
124 container_dir: PathBuf,
125 ) -> Result<PathBuf> {
126 self.adapter
127 .fetch_server_binary(version, http, container_dir)
128 .await
129 }
130
131 pub async fn cached_server_binary(&self, container_dir: PathBuf) -> Option<PathBuf> {
132 self.adapter.cached_server_binary(container_dir).await
133 }
134
135 pub async fn process_diagnostics(&self, params: &mut lsp::PublishDiagnosticsParams) {
136 self.adapter.process_diagnostics(params).await
137 }
138
139 pub async fn process_completion(&self, completion_item: &mut lsp::CompletionItem) {
140 self.adapter.process_completion(completion_item).await
141 }
142
143 pub async fn label_for_completion(
144 &self,
145 completion_item: &lsp::CompletionItem,
146 language: &Arc<Language>,
147 ) -> Option<CodeLabel> {
148 self.adapter
149 .label_for_completion(completion_item, language)
150 .await
151 }
152
153 pub async fn label_for_symbol(
154 &self,
155 name: &str,
156 kind: lsp::SymbolKind,
157 language: &Arc<Language>,
158 ) -> Option<CodeLabel> {
159 self.adapter.label_for_symbol(name, kind, language).await
160 }
161}
162
163#[async_trait]
164pub trait LspAdapter: 'static + Send + Sync {
165 async fn name(&self) -> LanguageServerName;
166
167 async fn fetch_latest_server_version(
168 &self,
169 http: Arc<dyn HttpClient>,
170 ) -> Result<Box<dyn 'static + Send + Any>>;
171
172 async fn fetch_server_binary(
173 &self,
174 version: Box<dyn 'static + Send + Any>,
175 http: Arc<dyn HttpClient>,
176 container_dir: PathBuf,
177 ) -> Result<PathBuf>;
178
179 async fn cached_server_binary(&self, container_dir: PathBuf) -> Option<PathBuf>;
180
181 async fn process_diagnostics(&self, _: &mut lsp::PublishDiagnosticsParams) {}
182
183 async fn process_completion(&self, _: &mut lsp::CompletionItem) {}
184
185 async fn label_for_completion(
186 &self,
187 _: &lsp::CompletionItem,
188 _: &Arc<Language>,
189 ) -> Option<CodeLabel> {
190 None
191 }
192
193 async fn label_for_symbol(
194 &self,
195 _: &str,
196 _: lsp::SymbolKind,
197 _: &Arc<Language>,
198 ) -> Option<CodeLabel> {
199 None
200 }
201
202 async fn server_args(&self) -> Vec<String> {
203 Vec::new()
204 }
205
206 async fn initialization_options(&self) -> Option<Value> {
207 None
208 }
209
210 async fn disk_based_diagnostic_sources(&self) -> Vec<String> {
211 Default::default()
212 }
213
214 async fn disk_based_diagnostics_progress_token(&self) -> Option<String> {
215 None
216 }
217
218 async fn language_ids(&self) -> HashMap<String, String> {
219 Default::default()
220 }
221}
222
223#[derive(Clone, Debug, PartialEq, Eq)]
224pub struct CodeLabel {
225 pub text: String,
226 pub runs: Vec<(Range<usize>, HighlightId)>,
227 pub filter_range: Range<usize>,
228}
229
230#[derive(Deserialize)]
231pub struct LanguageConfig {
232 pub name: Arc<str>,
233 pub path_suffixes: Vec<String>,
234 pub brackets: BracketPairConfig,
235 #[serde(default = "auto_indent_using_last_non_empty_line_default")]
236 pub auto_indent_using_last_non_empty_line: bool,
237 #[serde(default, deserialize_with = "deserialize_regex")]
238 pub increase_indent_pattern: Option<Regex>,
239 #[serde(default, deserialize_with = "deserialize_regex")]
240 pub decrease_indent_pattern: Option<Regex>,
241 #[serde(default)]
242 pub autoclose_before: String,
243 #[serde(default)]
244 pub line_comment: Option<Arc<str>>,
245 #[serde(default)]
246 pub block_comment: Option<(Arc<str>, Arc<str>)>,
247 #[serde(default)]
248 pub overrides: HashMap<String, LanguageConfigOverride>,
249}
250
251#[derive(Debug, Default)]
252pub struct LanguageQueries {
253 pub highlights: Option<Cow<'static, str>>,
254 pub brackets: Option<Cow<'static, str>>,
255 pub indents: Option<Cow<'static, str>>,
256 pub outline: Option<Cow<'static, str>>,
257 pub injections: Option<Cow<'static, str>>,
258 pub overrides: Option<Cow<'static, str>>,
259}
260
261#[derive(Clone, Debug)]
262pub struct LanguageScope {
263 language: Arc<Language>,
264 override_id: Option<u32>,
265}
266
267#[derive(Deserialize, Default, Debug)]
268pub struct LanguageConfigOverride {
269 #[serde(default)]
270 pub line_comment: Override<Arc<str>>,
271 #[serde(default)]
272 pub block_comment: Override<(Arc<str>, Arc<str>)>,
273 #[serde(skip_deserializing)]
274 pub disabled_bracket_ixs: Vec<u16>,
275}
276
277#[derive(Deserialize, Debug)]
278#[serde(untagged)]
279pub enum Override<T> {
280 Remove { remove: bool },
281 Set(T),
282}
283
284impl<T> Default for Override<T> {
285 fn default() -> Self {
286 Override::Remove { remove: false }
287 }
288}
289
290impl<T> Override<T> {
291 fn as_option<'a>(this: Option<&'a Self>, original: Option<&'a T>) -> Option<&'a T> {
292 match this {
293 Some(Self::Set(value)) => Some(value),
294 Some(Self::Remove { remove: true }) => None,
295 Some(Self::Remove { remove: false }) | None => original,
296 }
297 }
298}
299
300impl Default for LanguageConfig {
301 fn default() -> Self {
302 Self {
303 name: "".into(),
304 path_suffixes: Default::default(),
305 brackets: Default::default(),
306 auto_indent_using_last_non_empty_line: auto_indent_using_last_non_empty_line_default(),
307 increase_indent_pattern: Default::default(),
308 decrease_indent_pattern: Default::default(),
309 autoclose_before: Default::default(),
310 line_comment: Default::default(),
311 block_comment: Default::default(),
312 overrides: Default::default(),
313 }
314 }
315}
316
317fn auto_indent_using_last_non_empty_line_default() -> bool {
318 true
319}
320
321fn deserialize_regex<'de, D: Deserializer<'de>>(d: D) -> Result<Option<Regex>, D::Error> {
322 let source = Option::<String>::deserialize(d)?;
323 if let Some(source) = source {
324 Ok(Some(regex::Regex::new(&source).map_err(de::Error::custom)?))
325 } else {
326 Ok(None)
327 }
328}
329
330#[cfg(any(test, feature = "test-support"))]
331pub struct FakeLspAdapter {
332 pub name: &'static str,
333 pub capabilities: lsp::ServerCapabilities,
334 pub initializer: Option<Box<dyn 'static + Send + Sync + Fn(&mut lsp::FakeLanguageServer)>>,
335 pub disk_based_diagnostics_progress_token: Option<String>,
336 pub disk_based_diagnostics_sources: Vec<String>,
337}
338
339#[derive(Clone, Debug, Default)]
340pub struct BracketPairConfig {
341 pub pairs: Vec<BracketPair>,
342 pub disabled_scopes_by_bracket_ix: Vec<Vec<String>>,
343}
344
345impl<'de> Deserialize<'de> for BracketPairConfig {
346 fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
347 where
348 D: Deserializer<'de>,
349 {
350 #[derive(Deserialize)]
351 pub struct Entry {
352 #[serde(flatten)]
353 pub bracket_pair: BracketPair,
354 #[serde(default)]
355 pub not_in: Vec<String>,
356 }
357
358 let result = Vec::<Entry>::deserialize(deserializer)?;
359 let mut brackets = Vec::with_capacity(result.len());
360 let mut disabled_scopes_by_bracket_ix = Vec::with_capacity(result.len());
361 for entry in result {
362 brackets.push(entry.bracket_pair);
363 disabled_scopes_by_bracket_ix.push(entry.not_in);
364 }
365
366 Ok(BracketPairConfig {
367 pairs: brackets,
368 disabled_scopes_by_bracket_ix,
369 })
370 }
371}
372
373#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
374pub struct BracketPair {
375 pub start: String,
376 pub end: String,
377 pub close: bool,
378 pub newline: bool,
379}
380
381pub struct Language {
382 pub(crate) config: LanguageConfig,
383 pub(crate) grammar: Option<Arc<Grammar>>,
384 pub(crate) adapter: Option<Arc<CachedLspAdapter>>,
385
386 #[cfg(any(test, feature = "test-support"))]
387 fake_adapter: Option<(
388 mpsc::UnboundedSender<lsp::FakeLanguageServer>,
389 Arc<FakeLspAdapter>,
390 )>,
391}
392
393pub struct Grammar {
394 id: usize,
395 pub(crate) ts_language: tree_sitter::Language,
396 pub(crate) error_query: Query,
397 pub(crate) highlights_query: Option<Query>,
398 pub(crate) brackets_config: Option<BracketConfig>,
399 pub(crate) indents_config: Option<IndentConfig>,
400 pub(crate) outline_config: Option<OutlineConfig>,
401 pub(crate) injection_config: Option<InjectionConfig>,
402 pub(crate) override_config: Option<OverrideConfig>,
403 pub(crate) highlight_map: Mutex<HighlightMap>,
404}
405
406struct IndentConfig {
407 query: Query,
408 indent_capture_ix: u32,
409 start_capture_ix: Option<u32>,
410 end_capture_ix: Option<u32>,
411 outdent_capture_ix: Option<u32>,
412}
413
414struct OutlineConfig {
415 query: Query,
416 item_capture_ix: u32,
417 name_capture_ix: u32,
418 context_capture_ix: Option<u32>,
419}
420
421struct InjectionConfig {
422 query: Query,
423 content_capture_ix: u32,
424 language_capture_ix: Option<u32>,
425 patterns: Vec<InjectionPatternConfig>,
426}
427
428struct OverrideConfig {
429 query: Query,
430 values: HashMap<u32, (String, LanguageConfigOverride)>,
431}
432
433#[derive(Default, Clone)]
434struct InjectionPatternConfig {
435 language: Option<Box<str>>,
436 combined: bool,
437}
438
439struct BracketConfig {
440 query: Query,
441 open_capture_ix: u32,
442 close_capture_ix: u32,
443}
444
445#[derive(Clone)]
446pub enum LanguageServerBinaryStatus {
447 CheckingForUpdate,
448 Downloading,
449 Downloaded,
450 Cached,
451 Failed { error: String },
452}
453
454struct AvailableLanguage {
455 path: &'static str,
456 config: LanguageConfig,
457 grammar: tree_sitter::Language,
458 lsp_adapter: Option<Box<dyn LspAdapter>>,
459 get_queries: fn(&str) -> LanguageQueries,
460}
461
462pub struct LanguageRegistry {
463 languages: RwLock<Vec<Arc<Language>>>,
464 available_languages: RwLock<Vec<AvailableLanguage>>,
465 language_server_download_dir: Option<Arc<Path>>,
466 lsp_binary_statuses_tx: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
467 lsp_binary_statuses_rx: async_broadcast::Receiver<(Arc<Language>, LanguageServerBinaryStatus)>,
468 login_shell_env_loaded: Shared<Task<()>>,
469 #[allow(clippy::type_complexity)]
470 lsp_binary_paths: Mutex<
471 HashMap<
472 LanguageServerName,
473 Shared<BoxFuture<'static, Result<PathBuf, Arc<anyhow::Error>>>>,
474 >,
475 >,
476 subscription: RwLock<(watch::Sender<()>, watch::Receiver<()>)>,
477 theme: RwLock<Option<Arc<Theme>>>,
478 executor: Option<Arc<Background>>,
479 version: AtomicUsize,
480}
481
482impl LanguageRegistry {
483 pub fn new(login_shell_env_loaded: Task<()>) -> Self {
484 let (lsp_binary_statuses_tx, lsp_binary_statuses_rx) = async_broadcast::broadcast(16);
485 Self {
486 language_server_download_dir: None,
487 languages: Default::default(),
488 available_languages: Default::default(),
489 lsp_binary_statuses_tx,
490 lsp_binary_statuses_rx,
491 login_shell_env_loaded: login_shell_env_loaded.shared(),
492 lsp_binary_paths: Default::default(),
493 subscription: RwLock::new(watch::channel()),
494 theme: Default::default(),
495 version: Default::default(),
496 executor: None,
497 }
498 }
499
500 #[cfg(any(test, feature = "test-support"))]
501 pub fn test() -> Self {
502 Self::new(Task::ready(()))
503 }
504
505 pub fn set_executor(&mut self, executor: Arc<Background>) {
506 self.executor = Some(executor);
507 }
508
509 pub fn register(
510 &self,
511 path: &'static str,
512 config: LanguageConfig,
513 grammar: tree_sitter::Language,
514 lsp_adapter: Option<Box<dyn LspAdapter>>,
515 get_queries: fn(&str) -> LanguageQueries,
516 ) {
517 self.available_languages.write().push(AvailableLanguage {
518 path,
519 config,
520 grammar,
521 lsp_adapter,
522 get_queries,
523 });
524 }
525
526 pub fn language_names(&self) -> Vec<String> {
527 let mut result = self
528 .available_languages
529 .read()
530 .iter()
531 .map(|l| l.config.name.to_string())
532 .chain(
533 self.languages
534 .read()
535 .iter()
536 .map(|l| l.config.name.to_string()),
537 )
538 .collect::<Vec<_>>();
539 result.sort_unstable();
540 result
541 }
542
543 pub fn add(&self, language: Arc<Language>) {
544 if let Some(theme) = self.theme.read().clone() {
545 language.set_theme(&theme.editor.syntax);
546 }
547 self.languages.write().push(language);
548 self.version.fetch_add(1, SeqCst);
549 *self.subscription.write().0.borrow_mut() = ();
550 }
551
552 pub fn subscribe(&self) -> watch::Receiver<()> {
553 self.subscription.read().1.clone()
554 }
555
556 pub fn version(&self) -> usize {
557 self.version.load(SeqCst)
558 }
559
560 pub fn set_theme(&self, theme: Arc<Theme>) {
561 *self.theme.write() = Some(theme.clone());
562 for language in self.languages.read().iter() {
563 language.set_theme(&theme.editor.syntax);
564 }
565 }
566
567 pub fn set_language_server_download_dir(&mut self, path: impl Into<Arc<Path>>) {
568 self.language_server_download_dir = Some(path.into());
569 }
570
571 pub fn language_for_name(self: &Arc<Self>, name: &str) -> Option<Arc<Language>> {
572 let name = UniCase::new(name);
573 self.get_or_load_language(|config| UniCase::new(config.name.as_ref()) == name)
574 }
575
576 pub fn language_for_name_or_extension(self: &Arc<Self>, string: &str) -> Option<Arc<Language>> {
577 let string = UniCase::new(string);
578 self.get_or_load_language(|config| {
579 UniCase::new(config.name.as_ref()) == string
580 || config
581 .path_suffixes
582 .iter()
583 .any(|suffix| UniCase::new(suffix) == string)
584 })
585 }
586
587 pub fn language_for_path(self: &Arc<Self>, path: impl AsRef<Path>) -> Option<Arc<Language>> {
588 let path = path.as_ref();
589 let filename = path.file_name().and_then(|name| name.to_str());
590 let extension = path.extension().and_then(|name| name.to_str());
591 let path_suffixes = [extension, filename];
592 self.get_or_load_language(|config| {
593 config
594 .path_suffixes
595 .iter()
596 .any(|suffix| path_suffixes.contains(&Some(suffix.as_str())))
597 })
598 }
599
600 fn get_or_load_language(
601 self: &Arc<Self>,
602 callback: impl Fn(&LanguageConfig) -> bool,
603 ) -> Option<Arc<Language>> {
604 if let Some(language) = self
605 .languages
606 .read()
607 .iter()
608 .find(|language| callback(&language.config))
609 {
610 return Some(language.clone());
611 }
612
613 if let Some(executor) = self.executor.clone() {
614 let mut available_languages = self.available_languages.write();
615
616 if let Some(ix) = available_languages.iter().position(|l| callback(&l.config)) {
617 let language = available_languages.remove(ix);
618 drop(available_languages);
619 let name = language.config.name.clone();
620 let this = self.clone();
621 executor
622 .spawn(async move {
623 let queries = (language.get_queries)(&language.path);
624 let language = Language::new(language.config, Some(language.grammar))
625 .with_lsp_adapter(language.lsp_adapter)
626 .await;
627 match language.with_queries(queries) {
628 Ok(language) => this.add(Arc::new(language)),
629 Err(err) => {
630 log::error!("failed to load language {}: {}", name, err);
631 return;
632 }
633 };
634 })
635 .detach();
636 }
637 }
638
639 None
640 }
641
642 pub fn to_vec(&self) -> Vec<Arc<Language>> {
643 self.languages.read().iter().cloned().collect()
644 }
645
646 pub fn start_language_server(
647 self: &Arc<Self>,
648 server_id: usize,
649 language: Arc<Language>,
650 root_path: Arc<Path>,
651 http_client: Arc<dyn HttpClient>,
652 cx: &mut MutableAppContext,
653 ) -> Option<Task<Result<lsp::LanguageServer>>> {
654 #[cfg(any(test, feature = "test-support"))]
655 if language.fake_adapter.is_some() {
656 let language = language;
657 return Some(cx.spawn(|cx| async move {
658 let (servers_tx, fake_adapter) = language.fake_adapter.as_ref().unwrap();
659 let (server, mut fake_server) = lsp::LanguageServer::fake(
660 fake_adapter.name.to_string(),
661 fake_adapter.capabilities.clone(),
662 cx.clone(),
663 );
664
665 if let Some(initializer) = &fake_adapter.initializer {
666 initializer(&mut fake_server);
667 }
668
669 let servers_tx = servers_tx.clone();
670 cx.background()
671 .spawn(async move {
672 if fake_server
673 .try_receive_notification::<lsp::notification::Initialized>()
674 .await
675 .is_some()
676 {
677 servers_tx.unbounded_send(fake_server).ok();
678 }
679 })
680 .detach();
681 Ok(server)
682 }));
683 }
684
685 let download_dir = self
686 .language_server_download_dir
687 .clone()
688 .ok_or_else(|| anyhow!("language server download directory has not been assigned"))
689 .log_err()?;
690
691 let this = self.clone();
692 let adapter = language.adapter.clone()?;
693 let lsp_binary_statuses = self.lsp_binary_statuses_tx.clone();
694 let login_shell_env_loaded = self.login_shell_env_loaded.clone();
695 Some(cx.spawn(|cx| async move {
696 login_shell_env_loaded.await;
697 let server_binary_path = this
698 .lsp_binary_paths
699 .lock()
700 .entry(adapter.name.clone())
701 .or_insert_with(|| {
702 get_server_binary_path(
703 adapter.clone(),
704 language.clone(),
705 http_client,
706 download_dir,
707 lsp_binary_statuses,
708 )
709 .map_err(Arc::new)
710 .boxed()
711 .shared()
712 })
713 .clone()
714 .map_err(|e| anyhow!(e));
715
716 let server_binary_path = server_binary_path.await?;
717 let server_args = &adapter.server_args;
718 let server = lsp::LanguageServer::new(
719 server_id,
720 &server_binary_path,
721 server_args,
722 &root_path,
723 cx,
724 )?;
725 Ok(server)
726 }))
727 }
728
729 pub fn language_server_binary_statuses(
730 &self,
731 ) -> async_broadcast::Receiver<(Arc<Language>, LanguageServerBinaryStatus)> {
732 self.lsp_binary_statuses_rx.clone()
733 }
734}
735
736#[cfg(any(test, feature = "test-support"))]
737impl Default for LanguageRegistry {
738 fn default() -> Self {
739 Self::test()
740 }
741}
742
743async fn get_server_binary_path(
744 adapter: Arc<CachedLspAdapter>,
745 language: Arc<Language>,
746 http_client: Arc<dyn HttpClient>,
747 download_dir: Arc<Path>,
748 statuses: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
749) -> Result<PathBuf> {
750 let container_dir = download_dir.join(adapter.name.0.as_ref());
751 if !container_dir.exists() {
752 smol::fs::create_dir_all(&container_dir)
753 .await
754 .context("failed to create container directory")?;
755 }
756
757 let path = fetch_latest_server_binary_path(
758 adapter.clone(),
759 language.clone(),
760 http_client,
761 &container_dir,
762 statuses.clone(),
763 )
764 .await;
765 if let Err(error) = path.as_ref() {
766 if let Some(cached_path) = adapter.cached_server_binary(container_dir).await {
767 statuses
768 .broadcast((language.clone(), LanguageServerBinaryStatus::Cached))
769 .await?;
770 return Ok(cached_path);
771 } else {
772 statuses
773 .broadcast((
774 language.clone(),
775 LanguageServerBinaryStatus::Failed {
776 error: format!("{:?}", error),
777 },
778 ))
779 .await?;
780 }
781 }
782 path
783}
784
785async fn fetch_latest_server_binary_path(
786 adapter: Arc<CachedLspAdapter>,
787 language: Arc<Language>,
788 http_client: Arc<dyn HttpClient>,
789 container_dir: &Path,
790 lsp_binary_statuses_tx: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
791) -> Result<PathBuf> {
792 let container_dir: Arc<Path> = container_dir.into();
793 lsp_binary_statuses_tx
794 .broadcast((
795 language.clone(),
796 LanguageServerBinaryStatus::CheckingForUpdate,
797 ))
798 .await?;
799 let version_info = adapter
800 .fetch_latest_server_version(http_client.clone())
801 .await?;
802 lsp_binary_statuses_tx
803 .broadcast((language.clone(), LanguageServerBinaryStatus::Downloading))
804 .await?;
805 let path = adapter
806 .fetch_server_binary(version_info, http_client, container_dir.to_path_buf())
807 .await?;
808 lsp_binary_statuses_tx
809 .broadcast((language.clone(), LanguageServerBinaryStatus::Downloaded))
810 .await?;
811 Ok(path)
812}
813
814impl Language {
815 pub fn new(config: LanguageConfig, ts_language: Option<tree_sitter::Language>) -> Self {
816 Self {
817 config,
818 grammar: ts_language.map(|ts_language| {
819 Arc::new(Grammar {
820 id: NEXT_GRAMMAR_ID.fetch_add(1, SeqCst),
821 highlights_query: None,
822 brackets_config: None,
823 outline_config: None,
824 indents_config: None,
825 injection_config: None,
826 override_config: None,
827 error_query: Query::new(ts_language, "(ERROR) @error").unwrap(),
828 ts_language,
829 highlight_map: Default::default(),
830 })
831 }),
832 adapter: None,
833
834 #[cfg(any(test, feature = "test-support"))]
835 fake_adapter: None,
836 }
837 }
838
839 pub fn lsp_adapter(&self) -> Option<Arc<CachedLspAdapter>> {
840 self.adapter.clone()
841 }
842
843 pub fn id(&self) -> Option<usize> {
844 self.grammar.as_ref().map(|g| g.id)
845 }
846
847 pub fn with_queries(mut self, queries: LanguageQueries) -> Result<Self> {
848 if let Some(query) = queries.highlights {
849 self = self
850 .with_highlights_query(query.as_ref())
851 .expect("failed to evaluate highlights query");
852 }
853 if let Some(query) = queries.brackets {
854 self = self
855 .with_brackets_query(query.as_ref())
856 .expect("failed to load brackets query");
857 }
858 if let Some(query) = queries.indents {
859 self = self
860 .with_indents_query(query.as_ref())
861 .expect("failed to load indents query");
862 }
863 if let Some(query) = queries.outline {
864 self = self
865 .with_outline_query(query.as_ref())
866 .expect("failed to load outline query");
867 }
868 if let Some(query) = queries.injections {
869 self = self
870 .with_injection_query(query.as_ref())
871 .expect("failed to load injection query");
872 }
873 if let Some(query) = queries.overrides {
874 self = self
875 .with_override_query(query.as_ref())
876 .expect("failed to load override query");
877 }
878 Ok(self)
879 }
880 pub fn with_highlights_query(mut self, source: &str) -> Result<Self> {
881 let grammar = self.grammar_mut();
882 grammar.highlights_query = Some(Query::new(grammar.ts_language, source)?);
883 Ok(self)
884 }
885
886 pub fn with_outline_query(mut self, source: &str) -> Result<Self> {
887 let grammar = self.grammar_mut();
888 let query = Query::new(grammar.ts_language, source)?;
889 let mut item_capture_ix = None;
890 let mut name_capture_ix = None;
891 let mut context_capture_ix = None;
892 get_capture_indices(
893 &query,
894 &mut [
895 ("item", &mut item_capture_ix),
896 ("name", &mut name_capture_ix),
897 ("context", &mut context_capture_ix),
898 ],
899 );
900 if let Some((item_capture_ix, name_capture_ix)) = item_capture_ix.zip(name_capture_ix) {
901 grammar.outline_config = Some(OutlineConfig {
902 query,
903 item_capture_ix,
904 name_capture_ix,
905 context_capture_ix,
906 });
907 }
908 Ok(self)
909 }
910
911 pub fn with_brackets_query(mut self, source: &str) -> Result<Self> {
912 let grammar = self.grammar_mut();
913 let query = Query::new(grammar.ts_language, source)?;
914 let mut open_capture_ix = None;
915 let mut close_capture_ix = None;
916 get_capture_indices(
917 &query,
918 &mut [
919 ("open", &mut open_capture_ix),
920 ("close", &mut close_capture_ix),
921 ],
922 );
923 if let Some((open_capture_ix, close_capture_ix)) = open_capture_ix.zip(close_capture_ix) {
924 grammar.brackets_config = Some(BracketConfig {
925 query,
926 open_capture_ix,
927 close_capture_ix,
928 });
929 }
930 Ok(self)
931 }
932
933 pub fn with_indents_query(mut self, source: &str) -> Result<Self> {
934 let grammar = self.grammar_mut();
935 let query = Query::new(grammar.ts_language, source)?;
936 let mut indent_capture_ix = None;
937 let mut start_capture_ix = None;
938 let mut end_capture_ix = None;
939 let mut outdent_capture_ix = None;
940 get_capture_indices(
941 &query,
942 &mut [
943 ("indent", &mut indent_capture_ix),
944 ("start", &mut start_capture_ix),
945 ("end", &mut end_capture_ix),
946 ("outdent", &mut outdent_capture_ix),
947 ],
948 );
949 if let Some(indent_capture_ix) = indent_capture_ix {
950 grammar.indents_config = Some(IndentConfig {
951 query,
952 indent_capture_ix,
953 start_capture_ix,
954 end_capture_ix,
955 outdent_capture_ix,
956 });
957 }
958 Ok(self)
959 }
960
961 pub fn with_injection_query(mut self, source: &str) -> Result<Self> {
962 let grammar = self.grammar_mut();
963 let query = Query::new(grammar.ts_language, source)?;
964 let mut language_capture_ix = None;
965 let mut content_capture_ix = None;
966 get_capture_indices(
967 &query,
968 &mut [
969 ("language", &mut language_capture_ix),
970 ("content", &mut content_capture_ix),
971 ],
972 );
973 let patterns = (0..query.pattern_count())
974 .map(|ix| {
975 let mut config = InjectionPatternConfig::default();
976 for setting in query.property_settings(ix) {
977 match setting.key.as_ref() {
978 "language" => {
979 config.language = setting.value.clone();
980 }
981 "combined" => {
982 config.combined = true;
983 }
984 _ => {}
985 }
986 }
987 config
988 })
989 .collect();
990 if let Some(content_capture_ix) = content_capture_ix {
991 grammar.injection_config = Some(InjectionConfig {
992 query,
993 language_capture_ix,
994 content_capture_ix,
995 patterns,
996 });
997 }
998 Ok(self)
999 }
1000
1001 pub fn with_override_query(mut self, source: &str) -> Result<Self> {
1002 let query = Query::new(self.grammar_mut().ts_language, source)?;
1003
1004 let mut override_configs_by_id = HashMap::default();
1005 for (ix, name) in query.capture_names().iter().enumerate() {
1006 if !name.starts_with('_') {
1007 let value = self.config.overrides.remove(name).unwrap_or_default();
1008 override_configs_by_id.insert(ix as u32, (name.clone(), value));
1009 }
1010 }
1011
1012 if !self.config.overrides.is_empty() {
1013 let keys = self.config.overrides.keys().collect::<Vec<_>>();
1014 Err(anyhow!(
1015 "language {:?} has overrides in config not in query: {keys:?}",
1016 self.config.name
1017 ))?;
1018 }
1019
1020 for disabled_scope_name in self
1021 .config
1022 .brackets
1023 .disabled_scopes_by_bracket_ix
1024 .iter()
1025 .flatten()
1026 {
1027 if !override_configs_by_id
1028 .values()
1029 .any(|(scope_name, _)| scope_name == disabled_scope_name)
1030 {
1031 Err(anyhow!(
1032 "language {:?} has overrides in config not in query: {disabled_scope_name:?}",
1033 self.config.name
1034 ))?;
1035 }
1036 }
1037
1038 for (name, override_config) in override_configs_by_id.values_mut() {
1039 override_config.disabled_bracket_ixs = self
1040 .config
1041 .brackets
1042 .disabled_scopes_by_bracket_ix
1043 .iter()
1044 .enumerate()
1045 .filter_map(|(ix, disabled_scope_names)| {
1046 if disabled_scope_names.contains(name) {
1047 Some(ix as u16)
1048 } else {
1049 None
1050 }
1051 })
1052 .collect();
1053 }
1054
1055 self.config.brackets.disabled_scopes_by_bracket_ix.clear();
1056 self.grammar_mut().override_config = Some(OverrideConfig {
1057 query,
1058 values: override_configs_by_id,
1059 });
1060 Ok(self)
1061 }
1062
1063 fn grammar_mut(&mut self) -> &mut Grammar {
1064 Arc::get_mut(self.grammar.as_mut().unwrap()).unwrap()
1065 }
1066
1067 pub async fn with_lsp_adapter(mut self, lsp_adapter: Option<Box<dyn LspAdapter>>) -> Self {
1068 if let Some(adapter) = lsp_adapter {
1069 self.adapter = Some(CachedLspAdapter::new(adapter).await);
1070 }
1071 self
1072 }
1073
1074 #[cfg(any(test, feature = "test-support"))]
1075 pub async fn set_fake_lsp_adapter(
1076 &mut self,
1077 fake_lsp_adapter: Arc<FakeLspAdapter>,
1078 ) -> mpsc::UnboundedReceiver<lsp::FakeLanguageServer> {
1079 let (servers_tx, servers_rx) = mpsc::unbounded();
1080 self.fake_adapter = Some((servers_tx, fake_lsp_adapter.clone()));
1081 let adapter = CachedLspAdapter::new(Box::new(fake_lsp_adapter)).await;
1082 self.adapter = Some(adapter);
1083 servers_rx
1084 }
1085
1086 pub fn name(&self) -> Arc<str> {
1087 self.config.name.clone()
1088 }
1089
1090 pub async fn disk_based_diagnostic_sources(&self) -> &[String] {
1091 match self.adapter.as_ref() {
1092 Some(adapter) => &adapter.disk_based_diagnostic_sources,
1093 None => &[],
1094 }
1095 }
1096
1097 pub async fn disk_based_diagnostics_progress_token(&self) -> Option<&str> {
1098 if let Some(adapter) = self.adapter.as_ref() {
1099 adapter.disk_based_diagnostics_progress_token.as_deref()
1100 } else {
1101 None
1102 }
1103 }
1104
1105 pub async fn process_diagnostics(&self, diagnostics: &mut lsp::PublishDiagnosticsParams) {
1106 if let Some(processor) = self.adapter.as_ref() {
1107 processor.process_diagnostics(diagnostics).await;
1108 }
1109 }
1110
1111 pub async fn process_completion(self: &Arc<Self>, completion: &mut lsp::CompletionItem) {
1112 if let Some(adapter) = self.adapter.as_ref() {
1113 adapter.process_completion(completion).await;
1114 }
1115 }
1116
1117 pub async fn label_for_completion(
1118 self: &Arc<Self>,
1119 completion: &lsp::CompletionItem,
1120 ) -> Option<CodeLabel> {
1121 self.adapter
1122 .as_ref()?
1123 .label_for_completion(completion, self)
1124 .await
1125 }
1126
1127 pub async fn label_for_symbol(
1128 self: &Arc<Self>,
1129 name: &str,
1130 kind: lsp::SymbolKind,
1131 ) -> Option<CodeLabel> {
1132 self.adapter
1133 .as_ref()?
1134 .label_for_symbol(name, kind, self)
1135 .await
1136 }
1137
1138 pub fn highlight_text<'a>(
1139 self: &'a Arc<Self>,
1140 text: &'a Rope,
1141 range: Range<usize>,
1142 ) -> Vec<(Range<usize>, HighlightId)> {
1143 let mut result = Vec::new();
1144 if let Some(grammar) = &self.grammar {
1145 let tree = grammar.parse_text(text, None);
1146 let captures =
1147 SyntaxSnapshot::single_tree_captures(range.clone(), text, &tree, self, |grammar| {
1148 grammar.highlights_query.as_ref()
1149 });
1150 let highlight_maps = vec![grammar.highlight_map()];
1151 let mut offset = 0;
1152 for chunk in BufferChunks::new(text, range, Some((captures, highlight_maps)), vec![]) {
1153 let end_offset = offset + chunk.text.len();
1154 if let Some(highlight_id) = chunk.syntax_highlight_id {
1155 if !highlight_id.is_default() {
1156 result.push((offset..end_offset, highlight_id));
1157 }
1158 }
1159 offset = end_offset;
1160 }
1161 }
1162 result
1163 }
1164
1165 pub fn path_suffixes(&self) -> &[String] {
1166 &self.config.path_suffixes
1167 }
1168
1169 pub fn should_autoclose_before(&self, c: char) -> bool {
1170 c.is_whitespace() || self.config.autoclose_before.contains(c)
1171 }
1172
1173 pub fn set_theme(&self, theme: &SyntaxTheme) {
1174 if let Some(grammar) = self.grammar.as_ref() {
1175 if let Some(highlights_query) = &grammar.highlights_query {
1176 *grammar.highlight_map.lock() =
1177 HighlightMap::new(highlights_query.capture_names(), theme);
1178 }
1179 }
1180 }
1181
1182 pub fn grammar(&self) -> Option<&Arc<Grammar>> {
1183 self.grammar.as_ref()
1184 }
1185}
1186
1187impl LanguageScope {
1188 pub fn line_comment_prefix(&self) -> Option<&Arc<str>> {
1189 Override::as_option(
1190 self.config_override().map(|o| &o.line_comment),
1191 self.language.config.line_comment.as_ref(),
1192 )
1193 }
1194
1195 pub fn block_comment_delimiters(&self) -> Option<(&Arc<str>, &Arc<str>)> {
1196 Override::as_option(
1197 self.config_override().map(|o| &o.block_comment),
1198 self.language.config.block_comment.as_ref(),
1199 )
1200 .map(|e| (&e.0, &e.1))
1201 }
1202
1203 pub fn brackets(&self) -> impl Iterator<Item = (&BracketPair, bool)> {
1204 let mut disabled_ids = self
1205 .config_override()
1206 .map_or(&[] as _, |o| o.disabled_bracket_ixs.as_slice());
1207 self.language
1208 .config
1209 .brackets
1210 .pairs
1211 .iter()
1212 .enumerate()
1213 .map(move |(ix, bracket)| {
1214 let mut is_enabled = true;
1215 if let Some(next_disabled_ix) = disabled_ids.first() {
1216 if ix == *next_disabled_ix as usize {
1217 disabled_ids = &disabled_ids[1..];
1218 is_enabled = false;
1219 }
1220 }
1221 (bracket, is_enabled)
1222 })
1223 }
1224
1225 pub fn should_autoclose_before(&self, c: char) -> bool {
1226 c.is_whitespace() || self.language.config.autoclose_before.contains(c)
1227 }
1228
1229 fn config_override(&self) -> Option<&LanguageConfigOverride> {
1230 let id = self.override_id?;
1231 let grammar = self.language.grammar.as_ref()?;
1232 let override_config = grammar.override_config.as_ref()?;
1233 override_config.values.get(&id).map(|e| &e.1)
1234 }
1235}
1236
1237impl Hash for Language {
1238 fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
1239 self.id().hash(state)
1240 }
1241}
1242
1243impl PartialEq for Language {
1244 fn eq(&self, other: &Self) -> bool {
1245 self.id().eq(&other.id())
1246 }
1247}
1248
1249impl Eq for Language {}
1250
1251impl Debug for Language {
1252 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1253 f.debug_struct("Language")
1254 .field("name", &self.config.name)
1255 .finish()
1256 }
1257}
1258
1259impl Grammar {
1260 pub fn id(&self) -> usize {
1261 self.id
1262 }
1263
1264 fn parse_text(&self, text: &Rope, old_tree: Option<Tree>) -> Tree {
1265 PARSER.with(|parser| {
1266 let mut parser = parser.borrow_mut();
1267 parser
1268 .set_language(self.ts_language)
1269 .expect("incompatible grammar");
1270 let mut chunks = text.chunks_in_range(0..text.len());
1271 parser
1272 .parse_with(
1273 &mut move |offset, _| {
1274 chunks.seek(offset);
1275 chunks.next().unwrap_or("").as_bytes()
1276 },
1277 old_tree.as_ref(),
1278 )
1279 .unwrap()
1280 })
1281 }
1282
1283 pub fn highlight_map(&self) -> HighlightMap {
1284 self.highlight_map.lock().clone()
1285 }
1286
1287 pub fn highlight_id_for_name(&self, name: &str) -> Option<HighlightId> {
1288 let capture_id = self
1289 .highlights_query
1290 .as_ref()?
1291 .capture_index_for_name(name)?;
1292 Some(self.highlight_map.lock().get(capture_id))
1293 }
1294}
1295
1296impl CodeLabel {
1297 pub fn plain(text: String, filter_text: Option<&str>) -> Self {
1298 let mut result = Self {
1299 runs: Vec::new(),
1300 filter_range: 0..text.len(),
1301 text,
1302 };
1303 if let Some(filter_text) = filter_text {
1304 if let Some(ix) = result.text.find(filter_text) {
1305 result.filter_range = ix..ix + filter_text.len();
1306 }
1307 }
1308 result
1309 }
1310}
1311
1312#[cfg(any(test, feature = "test-support"))]
1313impl Default for FakeLspAdapter {
1314 fn default() -> Self {
1315 Self {
1316 name: "the-fake-language-server",
1317 capabilities: lsp::LanguageServer::full_capabilities(),
1318 initializer: None,
1319 disk_based_diagnostics_progress_token: None,
1320 disk_based_diagnostics_sources: Vec::new(),
1321 }
1322 }
1323}
1324
1325#[cfg(any(test, feature = "test-support"))]
1326#[async_trait]
1327impl LspAdapter for Arc<FakeLspAdapter> {
1328 async fn name(&self) -> LanguageServerName {
1329 LanguageServerName(self.name.into())
1330 }
1331
1332 async fn fetch_latest_server_version(
1333 &self,
1334 _: Arc<dyn HttpClient>,
1335 ) -> Result<Box<dyn 'static + Send + Any>> {
1336 unreachable!();
1337 }
1338
1339 async fn fetch_server_binary(
1340 &self,
1341 _: Box<dyn 'static + Send + Any>,
1342 _: Arc<dyn HttpClient>,
1343 _: PathBuf,
1344 ) -> Result<PathBuf> {
1345 unreachable!();
1346 }
1347
1348 async fn cached_server_binary(&self, _: PathBuf) -> Option<PathBuf> {
1349 unreachable!();
1350 }
1351
1352 async fn process_diagnostics(&self, _: &mut lsp::PublishDiagnosticsParams) {}
1353
1354 async fn disk_based_diagnostic_sources(&self) -> Vec<String> {
1355 self.disk_based_diagnostics_sources.clone()
1356 }
1357
1358 async fn disk_based_diagnostics_progress_token(&self) -> Option<String> {
1359 self.disk_based_diagnostics_progress_token.clone()
1360 }
1361}
1362
1363fn get_capture_indices(query: &Query, captures: &mut [(&str, &mut Option<u32>)]) {
1364 for (ix, name) in query.capture_names().iter().enumerate() {
1365 for (capture_name, index) in captures.iter_mut() {
1366 if capture_name == name {
1367 **index = Some(ix as u32);
1368 break;
1369 }
1370 }
1371 }
1372}
1373
1374pub fn point_to_lsp(point: PointUtf16) -> lsp::Position {
1375 lsp::Position::new(point.row, point.column)
1376}
1377
1378pub fn point_from_lsp(point: lsp::Position) -> Unclipped<PointUtf16> {
1379 Unclipped(PointUtf16::new(point.line, point.character))
1380}
1381
1382pub fn range_to_lsp(range: Range<PointUtf16>) -> lsp::Range {
1383 lsp::Range {
1384 start: point_to_lsp(range.start),
1385 end: point_to_lsp(range.end),
1386 }
1387}
1388
1389pub fn range_from_lsp(range: lsp::Range) -> Range<Unclipped<PointUtf16>> {
1390 let mut start = point_from_lsp(range.start);
1391 let mut end = point_from_lsp(range.end);
1392 if start > end {
1393 mem::swap(&mut start, &mut end);
1394 }
1395 start..end
1396}