1mod buffer;
2mod diagnostic_set;
3mod highlight_map;
4pub mod language_settings;
5mod outline;
6pub mod proto;
7mod syntax_map;
8
9#[cfg(test)]
10mod buffer_tests;
11
12use anyhow::{anyhow, Context, Result};
13use async_trait::async_trait;
14use collections::{HashMap, HashSet};
15use futures::{
16 channel::{mpsc, oneshot},
17 future::{BoxFuture, Shared},
18 FutureExt, TryFutureExt as _,
19};
20use gpui2::{AppContext, AsyncAppContext, Executor, Task};
21pub use highlight_map::HighlightMap;
22use lazy_static::lazy_static;
23use lsp2::{CodeActionKind, LanguageServerBinary};
24use parking_lot::{Mutex, RwLock};
25use postage::watch;
26use regex::Regex;
27use serde::{de, Deserialize, Deserializer};
28use serde_json::Value;
29use std::{
30 any::Any,
31 borrow::Cow,
32 cell::RefCell,
33 fmt::Debug,
34 hash::Hash,
35 mem,
36 ops::{Not, Range},
37 path::{Path, PathBuf},
38 str,
39 sync::{
40 atomic::{AtomicU64, AtomicUsize, Ordering::SeqCst},
41 Arc,
42 },
43};
44use syntax_map::SyntaxSnapshot;
45use theme2::{SyntaxTheme, Theme};
46use tree_sitter::{self, Query};
47use unicase::UniCase;
48use util::{http::HttpClient, paths::PathExt};
49use util::{post_inc, ResultExt, TryFutureExt as _, UnwrapFuture};
50
51pub use buffer::Operation;
52pub use buffer::*;
53pub use diagnostic_set::DiagnosticEntry;
54pub use lsp2::LanguageServerId;
55pub use outline::{Outline, OutlineItem};
56pub use syntax_map::{OwnedSyntaxLayerInfo, SyntaxLayerInfo};
57pub use text::LineEnding;
58pub use tree_sitter::{Parser, Tree};
59
60pub fn init(cx: &mut AppContext) {
61 language_settings::init(cx);
62}
63
64#[derive(Clone, Default)]
65struct LspBinaryStatusSender {
66 txs: Arc<Mutex<Vec<mpsc::UnboundedSender<(Arc<Language>, LanguageServerBinaryStatus)>>>>,
67}
68
69impl LspBinaryStatusSender {
70 fn subscribe(&self) -> mpsc::UnboundedReceiver<(Arc<Language>, LanguageServerBinaryStatus)> {
71 let (tx, rx) = mpsc::unbounded();
72 self.txs.lock().push(tx);
73 rx
74 }
75
76 fn send(&self, language: Arc<Language>, status: LanguageServerBinaryStatus) {
77 let mut txs = self.txs.lock();
78 txs.retain(|tx| {
79 tx.unbounded_send((language.clone(), status.clone()))
80 .is_ok()
81 });
82 }
83}
84
85thread_local! {
86 static PARSER: RefCell<Parser> = RefCell::new(Parser::new());
87}
88
89lazy_static! {
90 pub static ref NEXT_GRAMMAR_ID: AtomicUsize = Default::default();
91 pub static ref PLAIN_TEXT: Arc<Language> = Arc::new(Language::new(
92 LanguageConfig {
93 name: "Plain Text".into(),
94 ..Default::default()
95 },
96 None,
97 ));
98}
99
100pub trait ToLspPosition {
101 fn to_lsp_position(self) -> lsp2::Position;
102}
103
104#[derive(Clone, Debug, PartialEq, Eq, Hash)]
105pub struct LanguageServerName(pub Arc<str>);
106
107/// Represents a Language Server, with certain cached sync properties.
108/// Uses [`LspAdapter`] under the hood, but calls all 'static' methods
109/// once at startup, and caches the results.
110pub struct CachedLspAdapter {
111 pub name: LanguageServerName,
112 pub short_name: &'static str,
113 pub initialization_options: Option<Value>,
114 pub disk_based_diagnostic_sources: Vec<String>,
115 pub disk_based_diagnostics_progress_token: Option<String>,
116 pub language_ids: HashMap<String, String>,
117 pub adapter: Arc<dyn LspAdapter>,
118 pub reinstall_attempt_count: AtomicU64,
119}
120
121impl CachedLspAdapter {
122 pub async fn new(adapter: Arc<dyn LspAdapter>) -> Arc<Self> {
123 let name = adapter.name().await;
124 let short_name = adapter.short_name();
125 let initialization_options = adapter.initialization_options().await;
126 let disk_based_diagnostic_sources = adapter.disk_based_diagnostic_sources().await;
127 let disk_based_diagnostics_progress_token =
128 adapter.disk_based_diagnostics_progress_token().await;
129 let language_ids = adapter.language_ids().await;
130
131 Arc::new(CachedLspAdapter {
132 name,
133 short_name,
134 initialization_options,
135 disk_based_diagnostic_sources,
136 disk_based_diagnostics_progress_token,
137 language_ids,
138 adapter,
139 reinstall_attempt_count: AtomicU64::new(0),
140 })
141 }
142
143 pub async fn fetch_latest_server_version(
144 &self,
145 delegate: &dyn LspAdapterDelegate,
146 ) -> Result<Box<dyn 'static + Send + Any>> {
147 self.adapter.fetch_latest_server_version(delegate).await
148 }
149
150 pub fn will_fetch_server(
151 &self,
152 delegate: &Arc<dyn LspAdapterDelegate>,
153 cx: &mut AsyncAppContext,
154 ) -> Option<Task<Result<()>>> {
155 self.adapter.will_fetch_server(delegate, cx)
156 }
157
158 pub fn will_start_server(
159 &self,
160 delegate: &Arc<dyn LspAdapterDelegate>,
161 cx: &mut AsyncAppContext,
162 ) -> Option<Task<Result<()>>> {
163 self.adapter.will_start_server(delegate, cx)
164 }
165
166 pub async fn fetch_server_binary(
167 &self,
168 version: Box<dyn 'static + Send + Any>,
169 container_dir: PathBuf,
170 delegate: &dyn LspAdapterDelegate,
171 ) -> Result<LanguageServerBinary> {
172 self.adapter
173 .fetch_server_binary(version, container_dir, delegate)
174 .await
175 }
176
177 pub async fn cached_server_binary(
178 &self,
179 container_dir: PathBuf,
180 delegate: &dyn LspAdapterDelegate,
181 ) -> Option<LanguageServerBinary> {
182 self.adapter
183 .cached_server_binary(container_dir, delegate)
184 .await
185 }
186
187 pub fn can_be_reinstalled(&self) -> bool {
188 self.adapter.can_be_reinstalled()
189 }
190
191 pub async fn installation_test_binary(
192 &self,
193 container_dir: PathBuf,
194 ) -> Option<LanguageServerBinary> {
195 self.adapter.installation_test_binary(container_dir).await
196 }
197
198 pub fn code_action_kinds(&self) -> Option<Vec<CodeActionKind>> {
199 self.adapter.code_action_kinds()
200 }
201
202 pub fn workspace_configuration(&self, cx: &mut AppContext) -> BoxFuture<'static, Value> {
203 self.adapter.workspace_configuration(cx)
204 }
205
206 pub fn process_diagnostics(&self, params: &mut lsp2::PublishDiagnosticsParams) {
207 self.adapter.process_diagnostics(params)
208 }
209
210 pub async fn process_completion(&self, completion_item: &mut lsp2::CompletionItem) {
211 self.adapter.process_completion(completion_item).await
212 }
213
214 pub async fn label_for_completion(
215 &self,
216 completion_item: &lsp2::CompletionItem,
217 language: &Arc<Language>,
218 ) -> Option<CodeLabel> {
219 self.adapter
220 .label_for_completion(completion_item, language)
221 .await
222 }
223
224 pub async fn label_for_symbol(
225 &self,
226 name: &str,
227 kind: lsp2::SymbolKind,
228 language: &Arc<Language>,
229 ) -> Option<CodeLabel> {
230 self.adapter.label_for_symbol(name, kind, language).await
231 }
232
233 pub fn enabled_formatters(&self) -> Vec<BundledFormatter> {
234 self.adapter.enabled_formatters()
235 }
236}
237
238pub trait LspAdapterDelegate: Send + Sync {
239 fn show_notification(&self, message: &str, cx: &mut AppContext);
240 fn http_client(&self) -> Arc<dyn HttpClient>;
241}
242
243#[async_trait]
244pub trait LspAdapter: 'static + Send + Sync {
245 async fn name(&self) -> LanguageServerName;
246
247 fn short_name(&self) -> &'static str;
248
249 async fn fetch_latest_server_version(
250 &self,
251 delegate: &dyn LspAdapterDelegate,
252 ) -> Result<Box<dyn 'static + Send + Any>>;
253
254 fn will_fetch_server(
255 &self,
256 _: &Arc<dyn LspAdapterDelegate>,
257 _: &mut AsyncAppContext,
258 ) -> Option<Task<Result<()>>> {
259 None
260 }
261
262 fn will_start_server(
263 &self,
264 _: &Arc<dyn LspAdapterDelegate>,
265 _: &mut AsyncAppContext,
266 ) -> Option<Task<Result<()>>> {
267 None
268 }
269
270 async fn fetch_server_binary(
271 &self,
272 version: Box<dyn 'static + Send + Any>,
273 container_dir: PathBuf,
274 delegate: &dyn LspAdapterDelegate,
275 ) -> Result<LanguageServerBinary>;
276
277 async fn cached_server_binary(
278 &self,
279 container_dir: PathBuf,
280 delegate: &dyn LspAdapterDelegate,
281 ) -> Option<LanguageServerBinary>;
282
283 fn can_be_reinstalled(&self) -> bool {
284 true
285 }
286
287 async fn installation_test_binary(
288 &self,
289 container_dir: PathBuf,
290 ) -> Option<LanguageServerBinary>;
291
292 fn process_diagnostics(&self, _: &mut lsp2::PublishDiagnosticsParams) {}
293
294 async fn process_completion(&self, _: &mut lsp2::CompletionItem) {}
295
296 async fn label_for_completion(
297 &self,
298 _: &lsp2::CompletionItem,
299 _: &Arc<Language>,
300 ) -> Option<CodeLabel> {
301 None
302 }
303
304 async fn label_for_symbol(
305 &self,
306 _: &str,
307 _: lsp2::SymbolKind,
308 _: &Arc<Language>,
309 ) -> Option<CodeLabel> {
310 None
311 }
312
313 async fn initialization_options(&self) -> Option<Value> {
314 None
315 }
316
317 fn workspace_configuration(&self, _: &mut AppContext) -> BoxFuture<'static, Value> {
318 futures::future::ready(serde_json::json!({})).boxed()
319 }
320
321 fn code_action_kinds(&self) -> Option<Vec<CodeActionKind>> {
322 Some(vec![
323 CodeActionKind::EMPTY,
324 CodeActionKind::QUICKFIX,
325 CodeActionKind::REFACTOR,
326 CodeActionKind::REFACTOR_EXTRACT,
327 CodeActionKind::SOURCE,
328 ])
329 }
330
331 async fn disk_based_diagnostic_sources(&self) -> Vec<String> {
332 Default::default()
333 }
334
335 async fn disk_based_diagnostics_progress_token(&self) -> Option<String> {
336 None
337 }
338
339 async fn language_ids(&self) -> HashMap<String, String> {
340 Default::default()
341 }
342
343 fn enabled_formatters(&self) -> Vec<BundledFormatter> {
344 Vec::new()
345 }
346}
347
348#[derive(Clone, Debug, PartialEq, Eq)]
349pub enum BundledFormatter {
350 Prettier {
351 // See https://prettier.io/docs/en/options.html#parser for a list of valid values.
352 // Usually, every language has a single parser (standard or plugin-provided), hence `Some("parser_name")` can be used.
353 // There can not be multiple parsers for a single language, in case of a conflict, we would attempt to select the one with most plugins.
354 //
355 // But exceptions like Tailwind CSS exist, which uses standard parsers for CSS/JS/HTML/etc. but require an extra plugin to be installed.
356 // For those cases, `None` will install the plugin but apply other, regular parser defined for the language, and this would not be a conflict.
357 parser_name: Option<&'static str>,
358 plugin_names: Vec<&'static str>,
359 },
360}
361
362impl BundledFormatter {
363 pub fn prettier(parser_name: &'static str) -> Self {
364 Self::Prettier {
365 parser_name: Some(parser_name),
366 plugin_names: Vec::new(),
367 }
368 }
369}
370
371#[derive(Clone, Debug, PartialEq, Eq)]
372pub struct CodeLabel {
373 pub text: String,
374 pub runs: Vec<(Range<usize>, HighlightId)>,
375 pub filter_range: Range<usize>,
376}
377
378#[derive(Clone, Deserialize)]
379pub struct LanguageConfig {
380 pub name: Arc<str>,
381 pub path_suffixes: Vec<String>,
382 pub brackets: BracketPairConfig,
383 #[serde(default, deserialize_with = "deserialize_regex")]
384 pub first_line_pattern: Option<Regex>,
385 #[serde(default = "auto_indent_using_last_non_empty_line_default")]
386 pub auto_indent_using_last_non_empty_line: bool,
387 #[serde(default, deserialize_with = "deserialize_regex")]
388 pub increase_indent_pattern: Option<Regex>,
389 #[serde(default, deserialize_with = "deserialize_regex")]
390 pub decrease_indent_pattern: Option<Regex>,
391 #[serde(default)]
392 pub autoclose_before: String,
393 #[serde(default)]
394 pub line_comment: Option<Arc<str>>,
395 #[serde(default)]
396 pub collapsed_placeholder: String,
397 #[serde(default)]
398 pub block_comment: Option<(Arc<str>, Arc<str>)>,
399 #[serde(default)]
400 pub scope_opt_in_language_servers: Vec<String>,
401 #[serde(default)]
402 pub overrides: HashMap<String, LanguageConfigOverride>,
403 #[serde(default)]
404 pub word_characters: HashSet<char>,
405}
406
407#[derive(Debug, Default)]
408pub struct LanguageQueries {
409 pub highlights: Option<Cow<'static, str>>,
410 pub brackets: Option<Cow<'static, str>>,
411 pub indents: Option<Cow<'static, str>>,
412 pub outline: Option<Cow<'static, str>>,
413 pub embedding: Option<Cow<'static, str>>,
414 pub injections: Option<Cow<'static, str>>,
415 pub overrides: Option<Cow<'static, str>>,
416}
417
418#[derive(Clone, Debug)]
419pub struct LanguageScope {
420 language: Arc<Language>,
421 override_id: Option<u32>,
422}
423
424#[derive(Clone, Deserialize, Default, Debug)]
425pub struct LanguageConfigOverride {
426 #[serde(default)]
427 pub line_comment: Override<Arc<str>>,
428 #[serde(default)]
429 pub block_comment: Override<(Arc<str>, Arc<str>)>,
430 #[serde(skip_deserializing)]
431 pub disabled_bracket_ixs: Vec<u16>,
432 #[serde(default)]
433 pub word_characters: Override<HashSet<char>>,
434 #[serde(default)]
435 pub opt_into_language_servers: Vec<String>,
436}
437
438#[derive(Clone, Deserialize, Debug)]
439#[serde(untagged)]
440pub enum Override<T> {
441 Remove { remove: bool },
442 Set(T),
443}
444
445impl<T> Default for Override<T> {
446 fn default() -> Self {
447 Override::Remove { remove: false }
448 }
449}
450
451impl<T> Override<T> {
452 fn as_option<'a>(this: Option<&'a Self>, original: Option<&'a T>) -> Option<&'a T> {
453 match this {
454 Some(Self::Set(value)) => Some(value),
455 Some(Self::Remove { remove: true }) => None,
456 Some(Self::Remove { remove: false }) | None => original,
457 }
458 }
459}
460
461impl Default for LanguageConfig {
462 fn default() -> Self {
463 Self {
464 name: "".into(),
465 path_suffixes: Default::default(),
466 brackets: Default::default(),
467 auto_indent_using_last_non_empty_line: auto_indent_using_last_non_empty_line_default(),
468 first_line_pattern: Default::default(),
469 increase_indent_pattern: Default::default(),
470 decrease_indent_pattern: Default::default(),
471 autoclose_before: Default::default(),
472 line_comment: Default::default(),
473 block_comment: Default::default(),
474 scope_opt_in_language_servers: Default::default(),
475 overrides: Default::default(),
476 collapsed_placeholder: Default::default(),
477 word_characters: Default::default(),
478 }
479 }
480}
481
482fn auto_indent_using_last_non_empty_line_default() -> bool {
483 true
484}
485
486fn deserialize_regex<'de, D: Deserializer<'de>>(d: D) -> Result<Option<Regex>, D::Error> {
487 let source = Option::<String>::deserialize(d)?;
488 if let Some(source) = source {
489 Ok(Some(regex::Regex::new(&source).map_err(de::Error::custom)?))
490 } else {
491 Ok(None)
492 }
493}
494
495#[cfg(any(test, feature = "test-support"))]
496pub struct FakeLspAdapter {
497 pub name: &'static str,
498 pub initialization_options: Option<Value>,
499 pub capabilities: lsp2::ServerCapabilities,
500 pub initializer: Option<Box<dyn 'static + Send + Sync + Fn(&mut lsp2::FakeLanguageServer)>>,
501 pub disk_based_diagnostics_progress_token: Option<String>,
502 pub disk_based_diagnostics_sources: Vec<String>,
503 pub enabled_formatters: Vec<BundledFormatter>,
504}
505
506#[derive(Clone, Debug, Default)]
507pub struct BracketPairConfig {
508 pub pairs: Vec<BracketPair>,
509 pub disabled_scopes_by_bracket_ix: Vec<Vec<String>>,
510}
511
512impl<'de> Deserialize<'de> for BracketPairConfig {
513 fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
514 where
515 D: Deserializer<'de>,
516 {
517 #[derive(Deserialize)]
518 pub struct Entry {
519 #[serde(flatten)]
520 pub bracket_pair: BracketPair,
521 #[serde(default)]
522 pub not_in: Vec<String>,
523 }
524
525 let result = Vec::<Entry>::deserialize(deserializer)?;
526 let mut brackets = Vec::with_capacity(result.len());
527 let mut disabled_scopes_by_bracket_ix = Vec::with_capacity(result.len());
528 for entry in result {
529 brackets.push(entry.bracket_pair);
530 disabled_scopes_by_bracket_ix.push(entry.not_in);
531 }
532
533 Ok(BracketPairConfig {
534 pairs: brackets,
535 disabled_scopes_by_bracket_ix,
536 })
537 }
538}
539
540#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
541pub struct BracketPair {
542 pub start: String,
543 pub end: String,
544 pub close: bool,
545 pub newline: bool,
546}
547
548pub struct Language {
549 pub(crate) config: LanguageConfig,
550 pub(crate) grammar: Option<Arc<Grammar>>,
551 pub(crate) adapters: Vec<Arc<CachedLspAdapter>>,
552
553 #[cfg(any(test, feature = "test-support"))]
554 fake_adapter: Option<(
555 mpsc::UnboundedSender<lsp2::FakeLanguageServer>,
556 Arc<FakeLspAdapter>,
557 )>,
558}
559
560pub struct Grammar {
561 id: usize,
562 pub ts_language: tree_sitter::Language,
563 pub(crate) error_query: Query,
564 pub(crate) highlights_query: Option<Query>,
565 pub(crate) brackets_config: Option<BracketConfig>,
566 pub(crate) indents_config: Option<IndentConfig>,
567 pub outline_config: Option<OutlineConfig>,
568 pub embedding_config: Option<EmbeddingConfig>,
569 pub(crate) injection_config: Option<InjectionConfig>,
570 pub(crate) override_config: Option<OverrideConfig>,
571 pub(crate) highlight_map: Mutex<HighlightMap>,
572}
573
574struct IndentConfig {
575 query: Query,
576 indent_capture_ix: u32,
577 start_capture_ix: Option<u32>,
578 end_capture_ix: Option<u32>,
579 outdent_capture_ix: Option<u32>,
580}
581
582pub struct OutlineConfig {
583 pub query: Query,
584 pub item_capture_ix: u32,
585 pub name_capture_ix: u32,
586 pub context_capture_ix: Option<u32>,
587 pub extra_context_capture_ix: Option<u32>,
588}
589
590#[derive(Debug)]
591pub struct EmbeddingConfig {
592 pub query: Query,
593 pub item_capture_ix: u32,
594 pub name_capture_ix: Option<u32>,
595 pub context_capture_ix: Option<u32>,
596 pub collapse_capture_ix: Option<u32>,
597 pub keep_capture_ix: Option<u32>,
598}
599
600struct InjectionConfig {
601 query: Query,
602 content_capture_ix: u32,
603 language_capture_ix: Option<u32>,
604 patterns: Vec<InjectionPatternConfig>,
605}
606
607struct OverrideConfig {
608 query: Query,
609 values: HashMap<u32, (String, LanguageConfigOverride)>,
610}
611
612#[derive(Default, Clone)]
613struct InjectionPatternConfig {
614 language: Option<Box<str>>,
615 combined: bool,
616}
617
618struct BracketConfig {
619 query: Query,
620 open_capture_ix: u32,
621 close_capture_ix: u32,
622}
623
624#[derive(Clone)]
625pub enum LanguageServerBinaryStatus {
626 CheckingForUpdate,
627 Downloading,
628 Downloaded,
629 Cached,
630 Failed { error: String },
631}
632
633type AvailableLanguageId = usize;
634
635#[derive(Clone)]
636struct AvailableLanguage {
637 id: AvailableLanguageId,
638 path: &'static str,
639 config: LanguageConfig,
640 grammar: tree_sitter::Language,
641 lsp_adapters: Vec<Arc<dyn LspAdapter>>,
642 get_queries: fn(&str) -> LanguageQueries,
643 loaded: bool,
644}
645
646pub struct LanguageRegistry {
647 state: RwLock<LanguageRegistryState>,
648 language_server_download_dir: Option<Arc<Path>>,
649 login_shell_env_loaded: Shared<Task<()>>,
650 #[allow(clippy::type_complexity)]
651 lsp_binary_paths: Mutex<
652 HashMap<LanguageServerName, Shared<Task<Result<LanguageServerBinary, Arc<anyhow::Error>>>>>,
653 >,
654 executor: Option<Executor>,
655 lsp_binary_status_tx: LspBinaryStatusSender,
656}
657
658struct LanguageRegistryState {
659 next_language_server_id: usize,
660 languages: Vec<Arc<Language>>,
661 available_languages: Vec<AvailableLanguage>,
662 next_available_language_id: AvailableLanguageId,
663 loading_languages: HashMap<AvailableLanguageId, Vec<oneshot::Sender<Result<Arc<Language>>>>>,
664 subscription: (watch::Sender<()>, watch::Receiver<()>),
665 theme: Option<Arc<Theme>>,
666 version: usize,
667 reload_count: usize,
668}
669
670pub struct PendingLanguageServer {
671 pub server_id: LanguageServerId,
672 pub task: Task<Result<lsp2::LanguageServer>>,
673 pub container_dir: Option<Arc<Path>>,
674}
675
676impl LanguageRegistry {
677 pub fn new(login_shell_env_loaded: Task<()>) -> Self {
678 Self {
679 state: RwLock::new(LanguageRegistryState {
680 next_language_server_id: 0,
681 languages: vec![PLAIN_TEXT.clone()],
682 available_languages: Default::default(),
683 next_available_language_id: 0,
684 loading_languages: Default::default(),
685 subscription: watch::channel(),
686 theme: Default::default(),
687 version: 0,
688 reload_count: 0,
689 }),
690 language_server_download_dir: None,
691 login_shell_env_loaded: login_shell_env_loaded.shared(),
692 lsp_binary_paths: Default::default(),
693 executor: None,
694 lsp_binary_status_tx: Default::default(),
695 }
696 }
697
698 #[cfg(any(test, feature = "test-support"))]
699 pub fn test() -> Self {
700 Self::new(Task::ready(()))
701 }
702
703 pub fn set_executor(&mut self, executor: Executor) {
704 self.executor = Some(executor);
705 }
706
707 /// Clear out all of the loaded languages and reload them from scratch.
708 ///
709 /// This is useful in development, when queries have changed.
710 #[cfg(debug_assertions)]
711 pub fn reload(&self) {
712 self.state.write().reload();
713 }
714
715 pub fn register(
716 &self,
717 path: &'static str,
718 config: LanguageConfig,
719 grammar: tree_sitter::Language,
720 lsp_adapters: Vec<Arc<dyn LspAdapter>>,
721 get_queries: fn(&str) -> LanguageQueries,
722 ) {
723 let state = &mut *self.state.write();
724 state.available_languages.push(AvailableLanguage {
725 id: post_inc(&mut state.next_available_language_id),
726 path,
727 config,
728 grammar,
729 lsp_adapters,
730 get_queries,
731 loaded: false,
732 });
733 }
734
735 pub fn language_names(&self) -> Vec<String> {
736 let state = self.state.read();
737 let mut result = state
738 .available_languages
739 .iter()
740 .filter_map(|l| l.loaded.not().then_some(l.config.name.to_string()))
741 .chain(state.languages.iter().map(|l| l.config.name.to_string()))
742 .collect::<Vec<_>>();
743 result.sort_unstable_by_key(|language_name| language_name.to_lowercase());
744 result
745 }
746
747 pub fn add(&self, language: Arc<Language>) {
748 self.state.write().add(language);
749 }
750
751 pub fn subscribe(&self) -> watch::Receiver<()> {
752 self.state.read().subscription.1.clone()
753 }
754
755 /// The number of times that the registry has been changed,
756 /// by adding languages or reloading.
757 pub fn version(&self) -> usize {
758 self.state.read().version
759 }
760
761 /// The number of times that the registry has been reloaded.
762 pub fn reload_count(&self) -> usize {
763 self.state.read().reload_count
764 }
765
766 pub fn set_theme(&self, theme: Arc<Theme>) {
767 let mut state = self.state.write();
768 state.theme = Some(theme.clone());
769 for language in &state.languages {
770 language.set_theme(&theme.syntax);
771 }
772 }
773
774 pub fn set_language_server_download_dir(&mut self, path: impl Into<Arc<Path>>) {
775 self.language_server_download_dir = Some(path.into());
776 }
777
778 pub fn language_for_name(
779 self: &Arc<Self>,
780 name: &str,
781 ) -> UnwrapFuture<oneshot::Receiver<Result<Arc<Language>>>> {
782 let name = UniCase::new(name);
783 self.get_or_load_language(|config| UniCase::new(config.name.as_ref()) == name)
784 }
785
786 pub fn language_for_name_or_extension(
787 self: &Arc<Self>,
788 string: &str,
789 ) -> UnwrapFuture<oneshot::Receiver<Result<Arc<Language>>>> {
790 let string = UniCase::new(string);
791 self.get_or_load_language(|config| {
792 UniCase::new(config.name.as_ref()) == string
793 || config
794 .path_suffixes
795 .iter()
796 .any(|suffix| UniCase::new(suffix) == string)
797 })
798 }
799
800 pub fn language_for_file(
801 self: &Arc<Self>,
802 path: impl AsRef<Path>,
803 content: Option<&Rope>,
804 ) -> UnwrapFuture<oneshot::Receiver<Result<Arc<Language>>>> {
805 let path = path.as_ref();
806 let filename = path.file_name().and_then(|name| name.to_str());
807 let extension = path.extension_or_hidden_file_name();
808 let path_suffixes = [extension, filename];
809 self.get_or_load_language(|config| {
810 let path_matches = config
811 .path_suffixes
812 .iter()
813 .any(|suffix| path_suffixes.contains(&Some(suffix.as_str())));
814 let content_matches = content.zip(config.first_line_pattern.as_ref()).map_or(
815 false,
816 |(content, pattern)| {
817 let end = content.clip_point(Point::new(0, 256), Bias::Left);
818 let end = content.point_to_offset(end);
819 let text = content.chunks_in_range(0..end).collect::<String>();
820 pattern.is_match(&text)
821 },
822 );
823 path_matches || content_matches
824 })
825 }
826
827 fn get_or_load_language(
828 self: &Arc<Self>,
829 callback: impl Fn(&LanguageConfig) -> bool,
830 ) -> UnwrapFuture<oneshot::Receiver<Result<Arc<Language>>>> {
831 let (tx, rx) = oneshot::channel();
832
833 let mut state = self.state.write();
834 if let Some(language) = state
835 .languages
836 .iter()
837 .find(|language| callback(&language.config))
838 {
839 let _ = tx.send(Ok(language.clone()));
840 } else if let Some(executor) = self.executor.clone() {
841 if let Some(language) = state
842 .available_languages
843 .iter()
844 .find(|l| !l.loaded && callback(&l.config))
845 .cloned()
846 {
847 let txs = state
848 .loading_languages
849 .entry(language.id)
850 .or_insert_with(|| {
851 let this = self.clone();
852 executor
853 .spawn(async move {
854 let id = language.id;
855 let queries = (language.get_queries)(&language.path);
856 let language =
857 Language::new(language.config, Some(language.grammar))
858 .with_lsp_adapters(language.lsp_adapters)
859 .await;
860 let name = language.name();
861 match language.with_queries(queries) {
862 Ok(language) => {
863 let language = Arc::new(language);
864 let mut state = this.state.write();
865
866 state.add(language.clone());
867 state.mark_language_loaded(id);
868 if let Some(mut txs) = state.loading_languages.remove(&id) {
869 for tx in txs.drain(..) {
870 let _ = tx.send(Ok(language.clone()));
871 }
872 }
873 }
874 Err(e) => {
875 log::error!("failed to load language {name}:\n{:?}", e);
876 let mut state = this.state.write();
877 state.mark_language_loaded(id);
878 if let Some(mut txs) = state.loading_languages.remove(&id) {
879 for tx in txs.drain(..) {
880 let _ = tx.send(Err(anyhow!(
881 "failed to load language {}: {}",
882 name,
883 e
884 )));
885 }
886 }
887 }
888 };
889 })
890 .detach();
891
892 Vec::new()
893 });
894 txs.push(tx);
895 } else {
896 let _ = tx.send(Err(anyhow!("language not found")));
897 }
898 } else {
899 let _ = tx.send(Err(anyhow!("executor does not exist")));
900 }
901
902 rx.unwrap()
903 }
904
905 pub fn to_vec(&self) -> Vec<Arc<Language>> {
906 self.state.read().languages.iter().cloned().collect()
907 }
908
909 pub fn create_pending_language_server(
910 self: &Arc<Self>,
911 stderr_capture: Arc<Mutex<Option<String>>>,
912 language: Arc<Language>,
913 adapter: Arc<CachedLspAdapter>,
914 root_path: Arc<Path>,
915 delegate: Arc<dyn LspAdapterDelegate>,
916 cx: &mut AppContext,
917 ) -> Option<PendingLanguageServer> {
918 let server_id = self.state.write().next_language_server_id();
919 log::info!(
920 "starting language server {:?}, path: {root_path:?}, id: {server_id}",
921 adapter.name.0
922 );
923
924 #[cfg(any(test, feature = "test-support"))]
925 if language.fake_adapter.is_some() {
926 let task = cx.spawn(|cx| async move {
927 let (servers_tx, fake_adapter) = language.fake_adapter.as_ref().unwrap();
928 let (server, mut fake_server) = lsp2::LanguageServer::fake(
929 fake_adapter.name.to_string(),
930 fake_adapter.capabilities.clone(),
931 cx.clone(),
932 );
933
934 if let Some(initializer) = &fake_adapter.initializer {
935 initializer(&mut fake_server);
936 }
937
938 let servers_tx = servers_tx.clone();
939 cx.executor()
940 .spawn(async move {
941 if fake_server
942 .try_receive_notification::<lsp2::notification::Initialized>()
943 .await
944 .is_some()
945 {
946 servers_tx.unbounded_send(fake_server).ok();
947 }
948 })
949 .detach();
950
951 Ok(server)
952 });
953
954 return Some(PendingLanguageServer {
955 server_id,
956 task,
957 container_dir: None,
958 });
959 }
960
961 let download_dir = self
962 .language_server_download_dir
963 .clone()
964 .ok_or_else(|| anyhow!("language server download directory has not been assigned before starting server"))
965 .log_err()?;
966 let this = self.clone();
967 let language = language.clone();
968 let container_dir: Arc<Path> = Arc::from(download_dir.join(adapter.name.0.as_ref()));
969 let root_path = root_path.clone();
970 let adapter = adapter.clone();
971 let login_shell_env_loaded = self.login_shell_env_loaded.clone();
972 let lsp_binary_statuses = self.lsp_binary_status_tx.clone();
973
974 let task = {
975 let container_dir = container_dir.clone();
976 cx.spawn(move |mut cx| async move {
977 login_shell_env_loaded.await;
978
979 let entry = this
980 .lsp_binary_paths
981 .lock()
982 .entry(adapter.name.clone())
983 .or_insert_with(|| {
984 let adapter = adapter.clone();
985 let language = language.clone();
986 let delegate = delegate.clone();
987 cx.spawn(|cx| {
988 get_binary(
989 adapter,
990 language,
991 delegate,
992 container_dir,
993 lsp_binary_statuses,
994 cx,
995 )
996 .map_err(Arc::new)
997 })
998 .shared()
999 })
1000 .clone();
1001
1002 let binary = match entry.await {
1003 Ok(binary) => binary,
1004 Err(err) => anyhow::bail!("{err}"),
1005 };
1006
1007 if let Some(task) = adapter.will_start_server(&delegate, &mut cx) {
1008 task.await?;
1009 }
1010
1011 lsp2::LanguageServer::new(
1012 stderr_capture,
1013 server_id,
1014 binary,
1015 &root_path,
1016 adapter.code_action_kinds(),
1017 cx,
1018 )
1019 })
1020 };
1021
1022 Some(PendingLanguageServer {
1023 server_id,
1024 task,
1025 container_dir: Some(container_dir),
1026 })
1027 }
1028
1029 pub fn language_server_binary_statuses(
1030 &self,
1031 ) -> mpsc::UnboundedReceiver<(Arc<Language>, LanguageServerBinaryStatus)> {
1032 self.lsp_binary_status_tx.subscribe()
1033 }
1034
1035 pub fn delete_server_container(
1036 &self,
1037 adapter: Arc<CachedLspAdapter>,
1038 cx: &mut AppContext,
1039 ) -> Task<()> {
1040 log::info!("deleting server container");
1041
1042 let mut lock = self.lsp_binary_paths.lock();
1043 lock.remove(&adapter.name);
1044
1045 let download_dir = self
1046 .language_server_download_dir
1047 .clone()
1048 .expect("language server download directory has not been assigned before deleting server container");
1049
1050 cx.spawn(|_| async move {
1051 let container_dir = download_dir.join(adapter.name.0.as_ref());
1052 smol::fs::remove_dir_all(container_dir)
1053 .await
1054 .context("server container removal")
1055 .log_err();
1056 })
1057 }
1058
1059 pub fn next_language_server_id(&self) -> LanguageServerId {
1060 self.state.write().next_language_server_id()
1061 }
1062}
1063
1064impl LanguageRegistryState {
1065 fn next_language_server_id(&mut self) -> LanguageServerId {
1066 LanguageServerId(post_inc(&mut self.next_language_server_id))
1067 }
1068
1069 fn add(&mut self, language: Arc<Language>) {
1070 if let Some(theme) = self.theme.as_ref() {
1071 language.set_theme(&theme.syntax);
1072 }
1073 self.languages.push(language);
1074 self.version += 1;
1075 *self.subscription.0.borrow_mut() = ();
1076 }
1077
1078 #[cfg(debug_assertions)]
1079 fn reload(&mut self) {
1080 self.languages.clear();
1081 self.version += 1;
1082 self.reload_count += 1;
1083 for language in &mut self.available_languages {
1084 language.loaded = false;
1085 }
1086 *self.subscription.0.borrow_mut() = ();
1087 }
1088
1089 /// Mark the given language a having been loaded, so that the
1090 /// language registry won't try to load it again.
1091 fn mark_language_loaded(&mut self, id: AvailableLanguageId) {
1092 for language in &mut self.available_languages {
1093 if language.id == id {
1094 language.loaded = true;
1095 break;
1096 }
1097 }
1098 }
1099}
1100
1101#[cfg(any(test, feature = "test-support"))]
1102impl Default for LanguageRegistry {
1103 fn default() -> Self {
1104 Self::test()
1105 }
1106}
1107
1108async fn get_binary(
1109 adapter: Arc<CachedLspAdapter>,
1110 language: Arc<Language>,
1111 delegate: Arc<dyn LspAdapterDelegate>,
1112 container_dir: Arc<Path>,
1113 statuses: LspBinaryStatusSender,
1114 mut cx: AsyncAppContext,
1115) -> Result<LanguageServerBinary> {
1116 if !container_dir.exists() {
1117 smol::fs::create_dir_all(&container_dir)
1118 .await
1119 .context("failed to create container directory")?;
1120 }
1121
1122 if let Some(task) = adapter.will_fetch_server(&delegate, &mut cx) {
1123 task.await?;
1124 }
1125
1126 let binary = fetch_latest_binary(
1127 adapter.clone(),
1128 language.clone(),
1129 delegate.as_ref(),
1130 &container_dir,
1131 statuses.clone(),
1132 )
1133 .await;
1134
1135 if let Err(error) = binary.as_ref() {
1136 if let Some(binary) = adapter
1137 .cached_server_binary(container_dir.to_path_buf(), delegate.as_ref())
1138 .await
1139 {
1140 statuses.send(language.clone(), LanguageServerBinaryStatus::Cached);
1141 return Ok(binary);
1142 } else {
1143 statuses.send(
1144 language.clone(),
1145 LanguageServerBinaryStatus::Failed {
1146 error: format!("{:?}", error),
1147 },
1148 );
1149 }
1150 }
1151
1152 binary
1153}
1154
1155async fn fetch_latest_binary(
1156 adapter: Arc<CachedLspAdapter>,
1157 language: Arc<Language>,
1158 delegate: &dyn LspAdapterDelegate,
1159 container_dir: &Path,
1160 lsp_binary_statuses_tx: LspBinaryStatusSender,
1161) -> Result<LanguageServerBinary> {
1162 let container_dir: Arc<Path> = container_dir.into();
1163 lsp_binary_statuses_tx.send(
1164 language.clone(),
1165 LanguageServerBinaryStatus::CheckingForUpdate,
1166 );
1167
1168 let version_info = adapter.fetch_latest_server_version(delegate).await?;
1169 lsp_binary_statuses_tx.send(language.clone(), LanguageServerBinaryStatus::Downloading);
1170
1171 let binary = adapter
1172 .fetch_server_binary(version_info, container_dir.to_path_buf(), delegate)
1173 .await?;
1174 lsp_binary_statuses_tx.send(language.clone(), LanguageServerBinaryStatus::Downloaded);
1175
1176 Ok(binary)
1177}
1178
1179impl Language {
1180 pub fn new(config: LanguageConfig, ts_language: Option<tree_sitter::Language>) -> Self {
1181 Self {
1182 config,
1183 grammar: ts_language.map(|ts_language| {
1184 Arc::new(Grammar {
1185 id: NEXT_GRAMMAR_ID.fetch_add(1, SeqCst),
1186 highlights_query: None,
1187 brackets_config: None,
1188 outline_config: None,
1189 embedding_config: None,
1190 indents_config: None,
1191 injection_config: None,
1192 override_config: None,
1193 error_query: Query::new(ts_language, "(ERROR) @error").unwrap(),
1194 ts_language,
1195 highlight_map: Default::default(),
1196 })
1197 }),
1198 adapters: Vec::new(),
1199
1200 #[cfg(any(test, feature = "test-support"))]
1201 fake_adapter: None,
1202 }
1203 }
1204
1205 pub fn lsp_adapters(&self) -> &[Arc<CachedLspAdapter>] {
1206 &self.adapters
1207 }
1208
1209 pub fn id(&self) -> Option<usize> {
1210 self.grammar.as_ref().map(|g| g.id)
1211 }
1212
1213 pub fn with_queries(mut self, queries: LanguageQueries) -> Result<Self> {
1214 if let Some(query) = queries.highlights {
1215 self = self
1216 .with_highlights_query(query.as_ref())
1217 .context("Error loading highlights query")?;
1218 }
1219 if let Some(query) = queries.brackets {
1220 self = self
1221 .with_brackets_query(query.as_ref())
1222 .context("Error loading brackets query")?;
1223 }
1224 if let Some(query) = queries.indents {
1225 self = self
1226 .with_indents_query(query.as_ref())
1227 .context("Error loading indents query")?;
1228 }
1229 if let Some(query) = queries.outline {
1230 self = self
1231 .with_outline_query(query.as_ref())
1232 .context("Error loading outline query")?;
1233 }
1234 if let Some(query) = queries.embedding {
1235 self = self
1236 .with_embedding_query(query.as_ref())
1237 .context("Error loading embedding query")?;
1238 }
1239 if let Some(query) = queries.injections {
1240 self = self
1241 .with_injection_query(query.as_ref())
1242 .context("Error loading injection query")?;
1243 }
1244 if let Some(query) = queries.overrides {
1245 self = self
1246 .with_override_query(query.as_ref())
1247 .context("Error loading override query")?;
1248 }
1249 Ok(self)
1250 }
1251
1252 pub fn with_highlights_query(mut self, source: &str) -> Result<Self> {
1253 let grammar = self.grammar_mut();
1254 grammar.highlights_query = Some(Query::new(grammar.ts_language, source)?);
1255 Ok(self)
1256 }
1257
1258 pub fn with_outline_query(mut self, source: &str) -> Result<Self> {
1259 let grammar = self.grammar_mut();
1260 let query = Query::new(grammar.ts_language, source)?;
1261 let mut item_capture_ix = None;
1262 let mut name_capture_ix = None;
1263 let mut context_capture_ix = None;
1264 let mut extra_context_capture_ix = None;
1265 get_capture_indices(
1266 &query,
1267 &mut [
1268 ("item", &mut item_capture_ix),
1269 ("name", &mut name_capture_ix),
1270 ("context", &mut context_capture_ix),
1271 ("context.extra", &mut extra_context_capture_ix),
1272 ],
1273 );
1274 if let Some((item_capture_ix, name_capture_ix)) = item_capture_ix.zip(name_capture_ix) {
1275 grammar.outline_config = Some(OutlineConfig {
1276 query,
1277 item_capture_ix,
1278 name_capture_ix,
1279 context_capture_ix,
1280 extra_context_capture_ix,
1281 });
1282 }
1283 Ok(self)
1284 }
1285
1286 pub fn with_embedding_query(mut self, source: &str) -> Result<Self> {
1287 let grammar = self.grammar_mut();
1288 let query = Query::new(grammar.ts_language, source)?;
1289 let mut item_capture_ix = None;
1290 let mut name_capture_ix = None;
1291 let mut context_capture_ix = None;
1292 let mut collapse_capture_ix = None;
1293 let mut keep_capture_ix = None;
1294 get_capture_indices(
1295 &query,
1296 &mut [
1297 ("item", &mut item_capture_ix),
1298 ("name", &mut name_capture_ix),
1299 ("context", &mut context_capture_ix),
1300 ("keep", &mut keep_capture_ix),
1301 ("collapse", &mut collapse_capture_ix),
1302 ],
1303 );
1304 if let Some(item_capture_ix) = item_capture_ix {
1305 grammar.embedding_config = Some(EmbeddingConfig {
1306 query,
1307 item_capture_ix,
1308 name_capture_ix,
1309 context_capture_ix,
1310 collapse_capture_ix,
1311 keep_capture_ix,
1312 });
1313 }
1314 Ok(self)
1315 }
1316
1317 pub fn with_brackets_query(mut self, source: &str) -> Result<Self> {
1318 let grammar = self.grammar_mut();
1319 let query = Query::new(grammar.ts_language, source)?;
1320 let mut open_capture_ix = None;
1321 let mut close_capture_ix = None;
1322 get_capture_indices(
1323 &query,
1324 &mut [
1325 ("open", &mut open_capture_ix),
1326 ("close", &mut close_capture_ix),
1327 ],
1328 );
1329 if let Some((open_capture_ix, close_capture_ix)) = open_capture_ix.zip(close_capture_ix) {
1330 grammar.brackets_config = Some(BracketConfig {
1331 query,
1332 open_capture_ix,
1333 close_capture_ix,
1334 });
1335 }
1336 Ok(self)
1337 }
1338
1339 pub fn with_indents_query(mut self, source: &str) -> Result<Self> {
1340 let grammar = self.grammar_mut();
1341 let query = Query::new(grammar.ts_language, source)?;
1342 let mut indent_capture_ix = None;
1343 let mut start_capture_ix = None;
1344 let mut end_capture_ix = None;
1345 let mut outdent_capture_ix = None;
1346 get_capture_indices(
1347 &query,
1348 &mut [
1349 ("indent", &mut indent_capture_ix),
1350 ("start", &mut start_capture_ix),
1351 ("end", &mut end_capture_ix),
1352 ("outdent", &mut outdent_capture_ix),
1353 ],
1354 );
1355 if let Some(indent_capture_ix) = indent_capture_ix {
1356 grammar.indents_config = Some(IndentConfig {
1357 query,
1358 indent_capture_ix,
1359 start_capture_ix,
1360 end_capture_ix,
1361 outdent_capture_ix,
1362 });
1363 }
1364 Ok(self)
1365 }
1366
1367 pub fn with_injection_query(mut self, source: &str) -> Result<Self> {
1368 let grammar = self.grammar_mut();
1369 let query = Query::new(grammar.ts_language, source)?;
1370 let mut language_capture_ix = None;
1371 let mut content_capture_ix = None;
1372 get_capture_indices(
1373 &query,
1374 &mut [
1375 ("language", &mut language_capture_ix),
1376 ("content", &mut content_capture_ix),
1377 ],
1378 );
1379 let patterns = (0..query.pattern_count())
1380 .map(|ix| {
1381 let mut config = InjectionPatternConfig::default();
1382 for setting in query.property_settings(ix) {
1383 match setting.key.as_ref() {
1384 "language" => {
1385 config.language = setting.value.clone();
1386 }
1387 "combined" => {
1388 config.combined = true;
1389 }
1390 _ => {}
1391 }
1392 }
1393 config
1394 })
1395 .collect();
1396 if let Some(content_capture_ix) = content_capture_ix {
1397 grammar.injection_config = Some(InjectionConfig {
1398 query,
1399 language_capture_ix,
1400 content_capture_ix,
1401 patterns,
1402 });
1403 }
1404 Ok(self)
1405 }
1406
1407 pub fn with_override_query(mut self, source: &str) -> anyhow::Result<Self> {
1408 let query = Query::new(self.grammar_mut().ts_language, source)?;
1409
1410 let mut override_configs_by_id = HashMap::default();
1411 for (ix, name) in query.capture_names().iter().enumerate() {
1412 if !name.starts_with('_') {
1413 let value = self.config.overrides.remove(name).unwrap_or_default();
1414 for server_name in &value.opt_into_language_servers {
1415 if !self
1416 .config
1417 .scope_opt_in_language_servers
1418 .contains(server_name)
1419 {
1420 util::debug_panic!("Server {server_name:?} has been opted-in by scope {name:?} but has not been marked as an opt-in server");
1421 }
1422 }
1423
1424 override_configs_by_id.insert(ix as u32, (name.clone(), value));
1425 }
1426 }
1427
1428 if !self.config.overrides.is_empty() {
1429 let keys = self.config.overrides.keys().collect::<Vec<_>>();
1430 Err(anyhow!(
1431 "language {:?} has overrides in config not in query: {keys:?}",
1432 self.config.name
1433 ))?;
1434 }
1435
1436 for disabled_scope_name in self
1437 .config
1438 .brackets
1439 .disabled_scopes_by_bracket_ix
1440 .iter()
1441 .flatten()
1442 {
1443 if !override_configs_by_id
1444 .values()
1445 .any(|(scope_name, _)| scope_name == disabled_scope_name)
1446 {
1447 Err(anyhow!(
1448 "language {:?} has overrides in config not in query: {disabled_scope_name:?}",
1449 self.config.name
1450 ))?;
1451 }
1452 }
1453
1454 for (name, override_config) in override_configs_by_id.values_mut() {
1455 override_config.disabled_bracket_ixs = self
1456 .config
1457 .brackets
1458 .disabled_scopes_by_bracket_ix
1459 .iter()
1460 .enumerate()
1461 .filter_map(|(ix, disabled_scope_names)| {
1462 if disabled_scope_names.contains(name) {
1463 Some(ix as u16)
1464 } else {
1465 None
1466 }
1467 })
1468 .collect();
1469 }
1470
1471 self.config.brackets.disabled_scopes_by_bracket_ix.clear();
1472 self.grammar_mut().override_config = Some(OverrideConfig {
1473 query,
1474 values: override_configs_by_id,
1475 });
1476 Ok(self)
1477 }
1478
1479 fn grammar_mut(&mut self) -> &mut Grammar {
1480 Arc::get_mut(self.grammar.as_mut().unwrap()).unwrap()
1481 }
1482
1483 pub async fn with_lsp_adapters(mut self, lsp_adapters: Vec<Arc<dyn LspAdapter>>) -> Self {
1484 for adapter in lsp_adapters {
1485 self.adapters.push(CachedLspAdapter::new(adapter).await);
1486 }
1487 self
1488 }
1489
1490 #[cfg(any(test, feature = "test-support"))]
1491 pub async fn set_fake_lsp_adapter(
1492 &mut self,
1493 fake_lsp_adapter: Arc<FakeLspAdapter>,
1494 ) -> mpsc::UnboundedReceiver<lsp2::FakeLanguageServer> {
1495 let (servers_tx, servers_rx) = mpsc::unbounded();
1496 self.fake_adapter = Some((servers_tx, fake_lsp_adapter.clone()));
1497 let adapter = CachedLspAdapter::new(Arc::new(fake_lsp_adapter)).await;
1498 self.adapters = vec![adapter];
1499 servers_rx
1500 }
1501
1502 pub fn name(&self) -> Arc<str> {
1503 self.config.name.clone()
1504 }
1505
1506 pub async fn disk_based_diagnostic_sources(&self) -> &[String] {
1507 match self.adapters.first().as_ref() {
1508 Some(adapter) => &adapter.disk_based_diagnostic_sources,
1509 None => &[],
1510 }
1511 }
1512
1513 pub async fn disk_based_diagnostics_progress_token(&self) -> Option<&str> {
1514 for adapter in &self.adapters {
1515 let token = adapter.disk_based_diagnostics_progress_token.as_deref();
1516 if token.is_some() {
1517 return token;
1518 }
1519 }
1520
1521 None
1522 }
1523
1524 pub async fn process_completion(self: &Arc<Self>, completion: &mut lsp2::CompletionItem) {
1525 for adapter in &self.adapters {
1526 adapter.process_completion(completion).await;
1527 }
1528 }
1529
1530 pub async fn label_for_completion(
1531 self: &Arc<Self>,
1532 completion: &lsp2::CompletionItem,
1533 ) -> Option<CodeLabel> {
1534 self.adapters
1535 .first()
1536 .as_ref()?
1537 .label_for_completion(completion, self)
1538 .await
1539 }
1540
1541 pub async fn label_for_symbol(
1542 self: &Arc<Self>,
1543 name: &str,
1544 kind: lsp2::SymbolKind,
1545 ) -> Option<CodeLabel> {
1546 self.adapters
1547 .first()
1548 .as_ref()?
1549 .label_for_symbol(name, kind, self)
1550 .await
1551 }
1552
1553 pub fn highlight_text<'a>(
1554 self: &'a Arc<Self>,
1555 text: &'a Rope,
1556 range: Range<usize>,
1557 ) -> Vec<(Range<usize>, HighlightId)> {
1558 let mut result = Vec::new();
1559 if let Some(grammar) = &self.grammar {
1560 let tree = grammar.parse_text(text, None);
1561 let captures =
1562 SyntaxSnapshot::single_tree_captures(range.clone(), text, &tree, self, |grammar| {
1563 grammar.highlights_query.as_ref()
1564 });
1565 let highlight_maps = vec![grammar.highlight_map()];
1566 let mut offset = 0;
1567 for chunk in BufferChunks::new(text, range, Some((captures, highlight_maps)), vec![]) {
1568 let end_offset = offset + chunk.text.len();
1569 if let Some(highlight_id) = chunk.syntax_highlight_id {
1570 if !highlight_id.is_default() {
1571 result.push((offset..end_offset, highlight_id));
1572 }
1573 }
1574 offset = end_offset;
1575 }
1576 }
1577 result
1578 }
1579
1580 pub fn path_suffixes(&self) -> &[String] {
1581 &self.config.path_suffixes
1582 }
1583
1584 pub fn should_autoclose_before(&self, c: char) -> bool {
1585 c.is_whitespace() || self.config.autoclose_before.contains(c)
1586 }
1587
1588 pub fn set_theme(&self, theme: &SyntaxTheme) {
1589 if let Some(grammar) = self.grammar.as_ref() {
1590 if let Some(highlights_query) = &grammar.highlights_query {
1591 *grammar.highlight_map.lock() =
1592 HighlightMap::new(highlights_query.capture_names(), theme);
1593 }
1594 }
1595 }
1596
1597 pub fn grammar(&self) -> Option<&Arc<Grammar>> {
1598 self.grammar.as_ref()
1599 }
1600
1601 pub fn default_scope(self: &Arc<Self>) -> LanguageScope {
1602 LanguageScope {
1603 language: self.clone(),
1604 override_id: None,
1605 }
1606 }
1607}
1608
1609impl LanguageScope {
1610 pub fn collapsed_placeholder(&self) -> &str {
1611 self.language.config.collapsed_placeholder.as_ref()
1612 }
1613
1614 pub fn line_comment_prefix(&self) -> Option<&Arc<str>> {
1615 Override::as_option(
1616 self.config_override().map(|o| &o.line_comment),
1617 self.language.config.line_comment.as_ref(),
1618 )
1619 }
1620
1621 pub fn block_comment_delimiters(&self) -> Option<(&Arc<str>, &Arc<str>)> {
1622 Override::as_option(
1623 self.config_override().map(|o| &o.block_comment),
1624 self.language.config.block_comment.as_ref(),
1625 )
1626 .map(|e| (&e.0, &e.1))
1627 }
1628
1629 pub fn word_characters(&self) -> Option<&HashSet<char>> {
1630 Override::as_option(
1631 self.config_override().map(|o| &o.word_characters),
1632 Some(&self.language.config.word_characters),
1633 )
1634 }
1635
1636 pub fn brackets(&self) -> impl Iterator<Item = (&BracketPair, bool)> {
1637 let mut disabled_ids = self
1638 .config_override()
1639 .map_or(&[] as _, |o| o.disabled_bracket_ixs.as_slice());
1640 self.language
1641 .config
1642 .brackets
1643 .pairs
1644 .iter()
1645 .enumerate()
1646 .map(move |(ix, bracket)| {
1647 let mut is_enabled = true;
1648 if let Some(next_disabled_ix) = disabled_ids.first() {
1649 if ix == *next_disabled_ix as usize {
1650 disabled_ids = &disabled_ids[1..];
1651 is_enabled = false;
1652 }
1653 }
1654 (bracket, is_enabled)
1655 })
1656 }
1657
1658 pub fn should_autoclose_before(&self, c: char) -> bool {
1659 c.is_whitespace() || self.language.config.autoclose_before.contains(c)
1660 }
1661
1662 pub fn language_allowed(&self, name: &LanguageServerName) -> bool {
1663 let config = &self.language.config;
1664 let opt_in_servers = &config.scope_opt_in_language_servers;
1665 if opt_in_servers.iter().any(|o| *o == *name.0) {
1666 if let Some(over) = self.config_override() {
1667 over.opt_into_language_servers.iter().any(|o| *o == *name.0)
1668 } else {
1669 false
1670 }
1671 } else {
1672 true
1673 }
1674 }
1675
1676 fn config_override(&self) -> Option<&LanguageConfigOverride> {
1677 let id = self.override_id?;
1678 let grammar = self.language.grammar.as_ref()?;
1679 let override_config = grammar.override_config.as_ref()?;
1680 override_config.values.get(&id).map(|e| &e.1)
1681 }
1682}
1683
1684impl Hash for Language {
1685 fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
1686 self.id().hash(state)
1687 }
1688}
1689
1690impl PartialEq for Language {
1691 fn eq(&self, other: &Self) -> bool {
1692 self.id().eq(&other.id())
1693 }
1694}
1695
1696impl Eq for Language {}
1697
1698impl Debug for Language {
1699 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1700 f.debug_struct("Language")
1701 .field("name", &self.config.name)
1702 .finish()
1703 }
1704}
1705
1706impl Grammar {
1707 pub fn id(&self) -> usize {
1708 self.id
1709 }
1710
1711 fn parse_text(&self, text: &Rope, old_tree: Option<Tree>) -> Tree {
1712 PARSER.with(|parser| {
1713 let mut parser = parser.borrow_mut();
1714 parser
1715 .set_language(self.ts_language)
1716 .expect("incompatible grammar");
1717 let mut chunks = text.chunks_in_range(0..text.len());
1718 parser
1719 .parse_with(
1720 &mut move |offset, _| {
1721 chunks.seek(offset);
1722 chunks.next().unwrap_or("").as_bytes()
1723 },
1724 old_tree.as_ref(),
1725 )
1726 .unwrap()
1727 })
1728 }
1729
1730 pub fn highlight_map(&self) -> HighlightMap {
1731 self.highlight_map.lock().clone()
1732 }
1733
1734 pub fn highlight_id_for_name(&self, name: &str) -> Option<HighlightId> {
1735 let capture_id = self
1736 .highlights_query
1737 .as_ref()?
1738 .capture_index_for_name(name)?;
1739 Some(self.highlight_map.lock().get(capture_id))
1740 }
1741}
1742
1743impl CodeLabel {
1744 pub fn plain(text: String, filter_text: Option<&str>) -> Self {
1745 let mut result = Self {
1746 runs: Vec::new(),
1747 filter_range: 0..text.len(),
1748 text,
1749 };
1750 if let Some(filter_text) = filter_text {
1751 if let Some(ix) = result.text.find(filter_text) {
1752 result.filter_range = ix..ix + filter_text.len();
1753 }
1754 }
1755 result
1756 }
1757}
1758
1759#[cfg(any(test, feature = "test-support"))]
1760impl Default for FakeLspAdapter {
1761 fn default() -> Self {
1762 Self {
1763 name: "the-fake-language-server",
1764 capabilities: lsp2::LanguageServer::full_capabilities(),
1765 initializer: None,
1766 disk_based_diagnostics_progress_token: None,
1767 initialization_options: None,
1768 disk_based_diagnostics_sources: Vec::new(),
1769 enabled_formatters: Vec::new(),
1770 }
1771 }
1772}
1773
1774#[cfg(any(test, feature = "test-support"))]
1775#[async_trait]
1776impl LspAdapter for Arc<FakeLspAdapter> {
1777 async fn name(&self) -> LanguageServerName {
1778 LanguageServerName(self.name.into())
1779 }
1780
1781 fn short_name(&self) -> &'static str {
1782 "FakeLspAdapter"
1783 }
1784
1785 async fn fetch_latest_server_version(
1786 &self,
1787 _: &dyn LspAdapterDelegate,
1788 ) -> Result<Box<dyn 'static + Send + Any>> {
1789 unreachable!();
1790 }
1791
1792 async fn fetch_server_binary(
1793 &self,
1794 _: Box<dyn 'static + Send + Any>,
1795 _: PathBuf,
1796 _: &dyn LspAdapterDelegate,
1797 ) -> Result<LanguageServerBinary> {
1798 unreachable!();
1799 }
1800
1801 async fn cached_server_binary(
1802 &self,
1803 _: PathBuf,
1804 _: &dyn LspAdapterDelegate,
1805 ) -> Option<LanguageServerBinary> {
1806 unreachable!();
1807 }
1808
1809 async fn installation_test_binary(&self, _: PathBuf) -> Option<LanguageServerBinary> {
1810 unreachable!();
1811 }
1812
1813 fn process_diagnostics(&self, _: &mut lsp2::PublishDiagnosticsParams) {}
1814
1815 async fn disk_based_diagnostic_sources(&self) -> Vec<String> {
1816 self.disk_based_diagnostics_sources.clone()
1817 }
1818
1819 async fn disk_based_diagnostics_progress_token(&self) -> Option<String> {
1820 self.disk_based_diagnostics_progress_token.clone()
1821 }
1822
1823 async fn initialization_options(&self) -> Option<Value> {
1824 self.initialization_options.clone()
1825 }
1826
1827 fn enabled_formatters(&self) -> Vec<BundledFormatter> {
1828 self.enabled_formatters.clone()
1829 }
1830}
1831
1832fn get_capture_indices(query: &Query, captures: &mut [(&str, &mut Option<u32>)]) {
1833 for (ix, name) in query.capture_names().iter().enumerate() {
1834 for (capture_name, index) in captures.iter_mut() {
1835 if capture_name == name {
1836 **index = Some(ix as u32);
1837 break;
1838 }
1839 }
1840 }
1841}
1842
1843pub fn point_to_lsp(point: PointUtf16) -> lsp2::Position {
1844 lsp2::Position::new(point.row, point.column)
1845}
1846
1847pub fn point_from_lsp(point: lsp2::Position) -> Unclipped<PointUtf16> {
1848 Unclipped(PointUtf16::new(point.line, point.character))
1849}
1850
1851pub fn range_to_lsp(range: Range<PointUtf16>) -> lsp2::Range {
1852 lsp2::Range {
1853 start: point_to_lsp(range.start),
1854 end: point_to_lsp(range.end),
1855 }
1856}
1857
1858pub fn range_from_lsp(range: lsp2::Range) -> Range<Unclipped<PointUtf16>> {
1859 let mut start = point_from_lsp(range.start);
1860 let mut end = point_from_lsp(range.end);
1861 if start > end {
1862 mem::swap(&mut start, &mut end);
1863 }
1864 start..end
1865}
1866
1867#[cfg(test)]
1868mod tests {
1869 use super::*;
1870 use gpui2::TestAppContext;
1871
1872 #[gpui2::test(iterations = 10)]
1873 async fn test_first_line_pattern(cx: &mut TestAppContext) {
1874 let mut languages = LanguageRegistry::test();
1875
1876 languages.set_executor(cx.executor().clone());
1877 let languages = Arc::new(languages);
1878 languages.register(
1879 "/javascript",
1880 LanguageConfig {
1881 name: "JavaScript".into(),
1882 path_suffixes: vec!["js".into()],
1883 first_line_pattern: Some(Regex::new(r"\bnode\b").unwrap()),
1884 ..Default::default()
1885 },
1886 tree_sitter_typescript::language_tsx(),
1887 vec![],
1888 |_| Default::default(),
1889 );
1890
1891 languages
1892 .language_for_file("the/script", None)
1893 .await
1894 .unwrap_err();
1895 languages
1896 .language_for_file("the/script", Some(&"nothing".into()))
1897 .await
1898 .unwrap_err();
1899 assert_eq!(
1900 languages
1901 .language_for_file("the/script", Some(&"#!/bin/env node".into()))
1902 .await
1903 .unwrap()
1904 .name()
1905 .as_ref(),
1906 "JavaScript"
1907 );
1908 }
1909
1910 #[gpui2::test(iterations = 10)]
1911 async fn test_language_loading(cx: &mut TestAppContext) {
1912 let mut languages = LanguageRegistry::test();
1913 languages.set_executor(cx.executor().clone());
1914 let languages = Arc::new(languages);
1915 languages.register(
1916 "/JSON",
1917 LanguageConfig {
1918 name: "JSON".into(),
1919 path_suffixes: vec!["json".into()],
1920 ..Default::default()
1921 },
1922 tree_sitter_json::language(),
1923 vec![],
1924 |_| Default::default(),
1925 );
1926 languages.register(
1927 "/rust",
1928 LanguageConfig {
1929 name: "Rust".into(),
1930 path_suffixes: vec!["rs".into()],
1931 ..Default::default()
1932 },
1933 tree_sitter_rust::language(),
1934 vec![],
1935 |_| Default::default(),
1936 );
1937 assert_eq!(
1938 languages.language_names(),
1939 &[
1940 "JSON".to_string(),
1941 "Plain Text".to_string(),
1942 "Rust".to_string(),
1943 ]
1944 );
1945
1946 let rust1 = languages.language_for_name("Rust");
1947 let rust2 = languages.language_for_name("Rust");
1948
1949 // Ensure language is still listed even if it's being loaded.
1950 assert_eq!(
1951 languages.language_names(),
1952 &[
1953 "JSON".to_string(),
1954 "Plain Text".to_string(),
1955 "Rust".to_string(),
1956 ]
1957 );
1958
1959 let (rust1, rust2) = futures::join!(rust1, rust2);
1960 assert!(Arc::ptr_eq(&rust1.unwrap(), &rust2.unwrap()));
1961
1962 // Ensure language is still listed even after loading it.
1963 assert_eq!(
1964 languages.language_names(),
1965 &[
1966 "JSON".to_string(),
1967 "Plain Text".to_string(),
1968 "Rust".to_string(),
1969 ]
1970 );
1971
1972 // Loading an unknown language returns an error.
1973 assert!(languages.language_for_name("Unknown").await.is_err());
1974 }
1975}