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