1use crate::{
2 CachedLspAdapter, File, Language, LanguageConfig, LanguageId, LanguageMatcher,
3 LanguageServerName, LspAdapter, PLAIN_TEXT, ToolchainLister,
4 language_settings::{
5 AllLanguageSettingsContent, LanguageSettingsContent, all_language_settings,
6 },
7 task_context::ContextProvider,
8 with_parser,
9};
10use anyhow::{Context as _, Result, anyhow};
11use collections::{HashMap, HashSet, hash_map};
12
13use futures::{
14 Future,
15 channel::{mpsc, oneshot},
16};
17use globset::GlobSet;
18use gpui::{App, BackgroundExecutor, SharedString};
19use lsp::LanguageServerId;
20use parking_lot::{Mutex, RwLock};
21use postage::watch;
22use schemars::JsonSchema;
23use serde::{Deserialize, Serialize};
24use std::{
25 borrow::{Borrow, Cow},
26 ffi::OsStr,
27 ops::Not,
28 path::{Path, PathBuf},
29 sync::Arc,
30};
31use sum_tree::Bias;
32use text::{Point, Rope};
33use theme::Theme;
34use unicase::UniCase;
35use util::{ResultExt, maybe, post_inc};
36
37#[derive(
38 Debug, Clone, Hash, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize, JsonSchema,
39)]
40pub struct LanguageName(SharedString);
41
42impl LanguageName {
43 pub fn new(s: &str) -> Self {
44 Self(SharedString::new(s))
45 }
46
47 pub fn from_proto(s: String) -> Self {
48 Self(SharedString::from(s))
49 }
50 pub fn to_proto(self) -> String {
51 self.0.to_string()
52 }
53 pub fn lsp_id(&self) -> String {
54 match self.0.as_ref() {
55 "Plain Text" => "plaintext".to_string(),
56 language_name => language_name.to_lowercase(),
57 }
58 }
59}
60
61impl From<LanguageName> for SharedString {
62 fn from(value: LanguageName) -> Self {
63 value.0
64 }
65}
66
67impl AsRef<str> for LanguageName {
68 fn as_ref(&self) -> &str {
69 self.0.as_ref()
70 }
71}
72
73impl Borrow<str> for LanguageName {
74 fn borrow(&self) -> &str {
75 self.0.as_ref()
76 }
77}
78
79impl std::fmt::Display for LanguageName {
80 fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
81 write!(f, "{}", self.0)
82 }
83}
84
85impl<'a> From<&'a str> for LanguageName {
86 fn from(str: &'a str) -> LanguageName {
87 LanguageName(SharedString::new(str))
88 }
89}
90
91impl From<LanguageName> for String {
92 fn from(value: LanguageName) -> Self {
93 let value: &str = &value.0;
94 Self::from(value)
95 }
96}
97
98pub struct LanguageRegistry {
99 state: RwLock<LanguageRegistryState>,
100 language_server_download_dir: Option<Arc<Path>>,
101 executor: BackgroundExecutor,
102 lsp_binary_status_tx: BinaryStatusSender,
103 dap_binary_status_tx: BinaryStatusSender,
104}
105
106struct LanguageRegistryState {
107 next_language_server_id: usize,
108 languages: Vec<Arc<Language>>,
109 language_settings: AllLanguageSettingsContent,
110 available_languages: Vec<AvailableLanguage>,
111 grammars: HashMap<Arc<str>, AvailableGrammar>,
112 lsp_adapters: HashMap<LanguageName, Vec<Arc<CachedLspAdapter>>>,
113 all_lsp_adapters: HashMap<LanguageServerName, Arc<CachedLspAdapter>>,
114 available_lsp_adapters:
115 HashMap<LanguageServerName, Arc<dyn Fn() -> Arc<CachedLspAdapter> + 'static + Send + Sync>>,
116 loading_languages: HashMap<LanguageId, Vec<oneshot::Sender<Result<Arc<Language>>>>>,
117 subscription: (watch::Sender<()>, watch::Receiver<()>),
118 theme: Option<Arc<Theme>>,
119 version: usize,
120 reload_count: usize,
121
122 #[cfg(any(test, feature = "test-support"))]
123 fake_server_entries: HashMap<LanguageServerName, FakeLanguageServerEntry>,
124}
125
126#[cfg(any(test, feature = "test-support"))]
127pub struct FakeLanguageServerEntry {
128 pub capabilities: lsp::ServerCapabilities,
129 pub initializer: Option<Box<dyn 'static + Send + Sync + Fn(&mut lsp::FakeLanguageServer)>>,
130 pub tx: futures::channel::mpsc::UnboundedSender<lsp::FakeLanguageServer>,
131 pub _server: Option<lsp::FakeLanguageServer>,
132}
133
134#[derive(Clone, Debug, PartialEq, Eq)]
135pub enum BinaryStatus {
136 None,
137 CheckingForUpdate,
138 Downloading,
139 Failed { error: String },
140}
141
142#[derive(Clone)]
143pub struct AvailableLanguage {
144 id: LanguageId,
145 name: LanguageName,
146 grammar: Option<Arc<str>>,
147 matcher: LanguageMatcher,
148 hidden: bool,
149 load: Arc<dyn Fn() -> Result<LoadedLanguage> + 'static + Send + Sync>,
150 loaded: bool,
151}
152
153impl AvailableLanguage {
154 pub fn name(&self) -> LanguageName {
155 self.name.clone()
156 }
157
158 pub fn matcher(&self) -> &LanguageMatcher {
159 &self.matcher
160 }
161 pub fn hidden(&self) -> bool {
162 self.hidden
163 }
164}
165
166enum AvailableGrammar {
167 Native(tree_sitter::Language),
168 Loaded(#[allow(unused)] PathBuf, tree_sitter::Language),
169 Loading(
170 #[allow(unused)] PathBuf,
171 Vec<oneshot::Sender<Result<tree_sitter::Language, Arc<anyhow::Error>>>>,
172 ),
173 Unloaded(PathBuf),
174 LoadFailed(Arc<anyhow::Error>),
175}
176
177#[derive(Debug)]
178pub struct LanguageNotFound;
179
180impl std::fmt::Display for LanguageNotFound {
181 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
182 write!(f, "language not found")
183 }
184}
185
186pub const QUERY_FILENAME_PREFIXES: &[(
187 &str,
188 fn(&mut LanguageQueries) -> &mut Option<Cow<'static, str>>,
189)] = &[
190 ("highlights", |q| &mut q.highlights),
191 ("brackets", |q| &mut q.brackets),
192 ("outline", |q| &mut q.outline),
193 ("indents", |q| &mut q.indents),
194 ("embedding", |q| &mut q.embedding),
195 ("injections", |q| &mut q.injections),
196 ("overrides", |q| &mut q.overrides),
197 ("redactions", |q| &mut q.redactions),
198 ("runnables", |q| &mut q.runnables),
199 ("textobjects", |q| &mut q.text_objects),
200];
201
202/// Tree-sitter language queries for a given language.
203#[derive(Debug, Default)]
204pub struct LanguageQueries {
205 pub highlights: Option<Cow<'static, str>>,
206 pub brackets: Option<Cow<'static, str>>,
207 pub indents: Option<Cow<'static, str>>,
208 pub outline: Option<Cow<'static, str>>,
209 pub embedding: Option<Cow<'static, str>>,
210 pub injections: Option<Cow<'static, str>>,
211 pub overrides: Option<Cow<'static, str>>,
212 pub redactions: Option<Cow<'static, str>>,
213 pub runnables: Option<Cow<'static, str>>,
214 pub text_objects: Option<Cow<'static, str>>,
215}
216
217#[derive(Clone, Default)]
218struct BinaryStatusSender {
219 txs: Arc<Mutex<Vec<mpsc::UnboundedSender<(SharedString, BinaryStatus)>>>>,
220}
221
222pub struct LoadedLanguage {
223 pub config: LanguageConfig,
224 pub queries: LanguageQueries,
225 pub context_provider: Option<Arc<dyn ContextProvider>>,
226 pub toolchain_provider: Option<Arc<dyn ToolchainLister>>,
227}
228
229impl LanguageRegistry {
230 pub fn new(executor: BackgroundExecutor) -> Self {
231 let this = Self {
232 state: RwLock::new(LanguageRegistryState {
233 next_language_server_id: 0,
234 languages: Vec::new(),
235 available_languages: Vec::new(),
236 grammars: Default::default(),
237 language_settings: Default::default(),
238 loading_languages: Default::default(),
239 lsp_adapters: Default::default(),
240 all_lsp_adapters: Default::default(),
241 available_lsp_adapters: HashMap::default(),
242 subscription: watch::channel(),
243 theme: Default::default(),
244 version: 0,
245 reload_count: 0,
246
247 #[cfg(any(test, feature = "test-support"))]
248 fake_server_entries: Default::default(),
249 }),
250 language_server_download_dir: None,
251 lsp_binary_status_tx: Default::default(),
252 dap_binary_status_tx: Default::default(),
253 executor,
254 };
255 this.add(PLAIN_TEXT.clone());
256 this
257 }
258
259 #[cfg(any(test, feature = "test-support"))]
260 pub fn test(executor: BackgroundExecutor) -> Self {
261 let mut this = Self::new(executor);
262 this.language_server_download_dir = Some(Path::new("/the-download-dir").into());
263 this
264 }
265
266 /// Clears out all of the loaded languages and reload them from scratch.
267 pub fn reload(&self) {
268 self.state.write().reload();
269 }
270
271 /// Reorders the list of language servers for the given language.
272 ///
273 /// Uses the provided list of ordered [`CachedLspAdapters`] as the desired order.
274 ///
275 /// Any existing language servers not present in `ordered_lsp_adapters` will be
276 /// appended to the end.
277 pub fn reorder_language_servers(
278 &self,
279 language: &LanguageName,
280 ordered_lsp_adapters: Vec<Arc<CachedLspAdapter>>,
281 ) {
282 self.state
283 .write()
284 .reorder_language_servers(language, ordered_lsp_adapters);
285 }
286
287 /// Removes the specified languages and grammars from the registry.
288 pub fn remove_languages(
289 &self,
290 languages_to_remove: &[LanguageName],
291 grammars_to_remove: &[Arc<str>],
292 ) {
293 self.state
294 .write()
295 .remove_languages(languages_to_remove, grammars_to_remove)
296 }
297
298 pub fn remove_lsp_adapter(&self, language_name: &LanguageName, name: &LanguageServerName) {
299 let mut state = self.state.write();
300 if let Some(adapters) = state.lsp_adapters.get_mut(language_name) {
301 adapters.retain(|adapter| &adapter.name != name)
302 }
303 state.version += 1;
304 state.reload_count += 1;
305 *state.subscription.0.borrow_mut() = ();
306 }
307
308 #[cfg(any(feature = "test-support", test))]
309 pub fn register_test_language(&self, config: LanguageConfig) {
310 self.register_language(
311 config.name.clone(),
312 config.grammar.clone(),
313 config.matcher.clone(),
314 config.hidden,
315 Arc::new(move || {
316 Ok(LoadedLanguage {
317 config: config.clone(),
318 queries: Default::default(),
319 toolchain_provider: None,
320 context_provider: None,
321 })
322 }),
323 )
324 }
325
326 /// Registers an available language server adapter.
327 ///
328 /// The language server is registered under the language server name, but
329 /// not bound to a particular language.
330 ///
331 /// When a language wants to load this particular language server, it will
332 /// invoke the `load` function.
333 pub fn register_available_lsp_adapter(
334 &self,
335 name: LanguageServerName,
336 load: impl Fn() -> Arc<dyn LspAdapter> + 'static + Send + Sync,
337 ) {
338 self.state.write().available_lsp_adapters.insert(
339 name,
340 Arc::new(move || {
341 let lsp_adapter = load();
342 CachedLspAdapter::new(lsp_adapter)
343 }),
344 );
345 }
346
347 /// Loads the language server adapter for the language server with the given name.
348 pub fn load_available_lsp_adapter(
349 &self,
350 name: &LanguageServerName,
351 ) -> Option<Arc<CachedLspAdapter>> {
352 let state = self.state.read();
353 let load_lsp_adapter = state.available_lsp_adapters.get(name)?;
354
355 Some(load_lsp_adapter())
356 }
357
358 pub fn register_lsp_adapter(
359 &self,
360 language_name: LanguageName,
361 adapter: Arc<dyn LspAdapter>,
362 ) -> Arc<CachedLspAdapter> {
363 let cached = CachedLspAdapter::new(adapter);
364 let mut state = self.state.write();
365 state
366 .lsp_adapters
367 .entry(language_name)
368 .or_default()
369 .push(cached.clone());
370 state
371 .all_lsp_adapters
372 .insert(cached.name.clone(), cached.clone());
373
374 cached
375 }
376
377 pub fn get_or_register_lsp_adapter(
378 &self,
379 language_name: LanguageName,
380 server_name: LanguageServerName,
381 build_adapter: impl FnOnce() -> Arc<dyn LspAdapter> + 'static,
382 ) -> Arc<CachedLspAdapter> {
383 let registered = self
384 .state
385 .write()
386 .lsp_adapters
387 .entry(language_name.clone())
388 .or_default()
389 .iter()
390 .find(|cached_adapter| cached_adapter.name == server_name)
391 .cloned();
392
393 if let Some(found) = registered {
394 found
395 } else {
396 let adapter = build_adapter();
397 self.register_lsp_adapter(language_name, adapter)
398 }
399 }
400
401 /// Register a fake language server and adapter
402 /// The returned channel receives a new instance of the language server every time it is started
403 #[cfg(any(feature = "test-support", test))]
404 pub fn register_fake_lsp(
405 &self,
406 language_name: impl Into<LanguageName>,
407 mut adapter: crate::FakeLspAdapter,
408 ) -> futures::channel::mpsc::UnboundedReceiver<lsp::FakeLanguageServer> {
409 let language_name = language_name.into();
410 let adapter_name = LanguageServerName(adapter.name.into());
411 let capabilities = adapter.capabilities.clone();
412 let initializer = adapter.initializer.take();
413 let adapter = CachedLspAdapter::new(Arc::new(adapter));
414 {
415 let mut state = self.state.write();
416 state
417 .lsp_adapters
418 .entry(language_name.clone())
419 .or_default()
420 .push(adapter.clone());
421 state.all_lsp_adapters.insert(adapter.name(), adapter);
422 }
423
424 self.register_fake_language_server(adapter_name, capabilities, initializer)
425 }
426
427 /// Register a fake lsp adapter (without the language server)
428 /// The returned channel receives a new instance of the language server every time it is started
429 #[cfg(any(feature = "test-support", test))]
430 pub fn register_fake_lsp_adapter(
431 &self,
432 language_name: impl Into<LanguageName>,
433 adapter: crate::FakeLspAdapter,
434 ) {
435 let language_name = language_name.into();
436 let mut state = self.state.write();
437 let cached_adapter = CachedLspAdapter::new(Arc::new(adapter));
438 state
439 .lsp_adapters
440 .entry(language_name.clone())
441 .or_default()
442 .push(cached_adapter.clone());
443 state
444 .all_lsp_adapters
445 .insert(cached_adapter.name(), cached_adapter);
446 }
447
448 /// Register a fake language server (without the adapter)
449 /// The returned channel receives a new instance of the language server every time it is started
450 #[cfg(any(feature = "test-support", test))]
451 pub fn register_fake_language_server(
452 &self,
453 lsp_name: LanguageServerName,
454 capabilities: lsp::ServerCapabilities,
455 initializer: Option<Box<dyn Fn(&mut lsp::FakeLanguageServer) + Send + Sync>>,
456 ) -> futures::channel::mpsc::UnboundedReceiver<lsp::FakeLanguageServer> {
457 let (servers_tx, servers_rx) = futures::channel::mpsc::unbounded();
458 self.state.write().fake_server_entries.insert(
459 lsp_name,
460 FakeLanguageServerEntry {
461 tx: servers_tx,
462 capabilities,
463 initializer,
464 _server: None,
465 },
466 );
467 servers_rx
468 }
469
470 /// Adds a language to the registry, which can be loaded if needed.
471 pub fn register_language(
472 &self,
473 name: LanguageName,
474 grammar_name: Option<Arc<str>>,
475 matcher: LanguageMatcher,
476 hidden: bool,
477 load: Arc<dyn Fn() -> Result<LoadedLanguage> + 'static + Send + Sync>,
478 ) {
479 let state = &mut *self.state.write();
480
481 for existing_language in &mut state.available_languages {
482 if existing_language.name == name {
483 existing_language.grammar = grammar_name;
484 existing_language.matcher = matcher;
485 existing_language.load = load;
486 return;
487 }
488 }
489
490 state.available_languages.push(AvailableLanguage {
491 id: LanguageId::new(),
492 name,
493 grammar: grammar_name,
494 matcher,
495 load,
496 hidden,
497 loaded: false,
498 });
499 state.version += 1;
500 state.reload_count += 1;
501 *state.subscription.0.borrow_mut() = ();
502 }
503
504 /// Adds grammars to the registry. Language configurations reference a grammar by name. The
505 /// grammar controls how the source code is parsed.
506 pub fn register_native_grammars(
507 &self,
508 grammars: impl IntoIterator<Item = (impl Into<Arc<str>>, impl Into<tree_sitter::Language>)>,
509 ) {
510 self.state.write().grammars.extend(
511 grammars
512 .into_iter()
513 .map(|(name, grammar)| (name.into(), AvailableGrammar::Native(grammar.into()))),
514 );
515 }
516
517 /// Adds paths to WASM grammar files, which can be loaded if needed.
518 pub fn register_wasm_grammars(
519 &self,
520 grammars: impl IntoIterator<Item = (impl Into<Arc<str>>, PathBuf)>,
521 ) {
522 let mut state = self.state.write();
523 state.grammars.extend(
524 grammars
525 .into_iter()
526 .map(|(name, path)| (name.into(), AvailableGrammar::Unloaded(path))),
527 );
528 state.version += 1;
529 state.reload_count += 1;
530 *state.subscription.0.borrow_mut() = ();
531 }
532
533 pub fn language_settings(&self) -> AllLanguageSettingsContent {
534 self.state.read().language_settings.clone()
535 }
536
537 pub fn language_names(&self) -> Vec<String> {
538 let state = self.state.read();
539 let mut result = state
540 .available_languages
541 .iter()
542 .filter_map(|l| l.loaded.not().then_some(l.name.to_string()))
543 .chain(state.languages.iter().map(|l| l.config.name.to_string()))
544 .collect::<Vec<_>>();
545 result.sort_unstable_by_key(|language_name| language_name.to_lowercase());
546 result
547 }
548
549 pub fn grammar_names(&self) -> Vec<Arc<str>> {
550 let state = self.state.read();
551 let mut result = state.grammars.keys().cloned().collect::<Vec<_>>();
552 result.sort_unstable_by_key(|grammar_name| grammar_name.to_lowercase());
553 result
554 }
555
556 /// Add a pre-loaded language to the registry.
557 pub fn add(&self, language: Arc<Language>) {
558 let mut state = self.state.write();
559 state.available_languages.push(AvailableLanguage {
560 id: language.id,
561 name: language.name(),
562 grammar: language.config.grammar.clone(),
563 matcher: language.config.matcher.clone(),
564 hidden: language.config.hidden,
565 load: Arc::new(|| Err(anyhow!("already loaded"))),
566 loaded: true,
567 });
568 state.add(language);
569 }
570
571 pub fn subscribe(&self) -> watch::Receiver<()> {
572 self.state.read().subscription.1.clone()
573 }
574
575 /// Returns the number of times that the registry has been changed,
576 /// by adding languages or reloading.
577 pub fn version(&self) -> usize {
578 self.state.read().version
579 }
580
581 /// Returns the number of times that the registry has been reloaded.
582 pub fn reload_count(&self) -> usize {
583 self.state.read().reload_count
584 }
585
586 pub fn set_theme(&self, theme: Arc<Theme>) {
587 let mut state = self.state.write();
588 state.theme = Some(theme.clone());
589 for language in &state.languages {
590 language.set_theme(theme.syntax());
591 }
592 }
593
594 pub fn set_language_server_download_dir(&mut self, path: impl Into<Arc<Path>>) {
595 self.language_server_download_dir = Some(path.into());
596 }
597
598 pub fn language_for_name(
599 self: &Arc<Self>,
600 name: &str,
601 ) -> impl Future<Output = Result<Arc<Language>>> + use<> {
602 let name = UniCase::new(name);
603 let rx = self.get_or_load_language(|language_name, _| {
604 if UniCase::new(&language_name.0) == name {
605 1
606 } else {
607 0
608 }
609 });
610 async move { rx.await? }
611 }
612
613 pub fn language_for_name_or_extension(
614 self: &Arc<Self>,
615 string: &str,
616 ) -> impl Future<Output = Result<Arc<Language>>> {
617 let string = UniCase::new(string);
618 let rx = self.get_or_load_language(|name, config| {
619 if UniCase::new(&name.0) == string
620 || config
621 .path_suffixes
622 .iter()
623 .any(|suffix| UniCase::new(suffix) == string)
624 {
625 1
626 } else {
627 0
628 }
629 });
630 async move { rx.await? }
631 }
632
633 pub fn available_language_for_name(self: &Arc<Self>, name: &str) -> Option<AvailableLanguage> {
634 let state = self.state.read();
635 state
636 .available_languages
637 .iter()
638 .find(|l| l.name.0.as_ref() == name)
639 .cloned()
640 }
641
642 pub fn language_for_file(
643 self: &Arc<Self>,
644 file: &Arc<dyn File>,
645 content: Option<&Rope>,
646 cx: &App,
647 ) -> Option<AvailableLanguage> {
648 let user_file_types = all_language_settings(Some(file), cx);
649
650 self.language_for_file_internal(
651 &file.full_path(cx),
652 content,
653 Some(&user_file_types.file_types),
654 )
655 }
656
657 pub fn language_for_file_path<'a>(
658 self: &Arc<Self>,
659 path: &'a Path,
660 ) -> impl Future<Output = Result<Arc<Language>>> + 'a {
661 let available_language = self.language_for_file_internal(path, None, None);
662
663 let this = self.clone();
664 async move {
665 if let Some(language) = available_language {
666 this.load_language(&language).await?
667 } else {
668 Err(anyhow!(LanguageNotFound))
669 }
670 }
671 }
672
673 fn language_for_file_internal(
674 self: &Arc<Self>,
675 path: &Path,
676 content: Option<&Rope>,
677 user_file_types: Option<&HashMap<Arc<str>, GlobSet>>,
678 ) -> Option<AvailableLanguage> {
679 let filename = path.file_name().and_then(|name| name.to_str());
680 // `Path.extension()` returns None for files with a leading '.'
681 // and no other extension which is not the desired behavior here,
682 // as we want `.zshrc` to result in extension being `Some("zshrc")`
683 let extension = filename.and_then(|filename| filename.split('.').next_back());
684 let path_suffixes = [extension, filename, path.to_str()];
685 let empty = GlobSet::empty();
686
687 self.find_matching_language(move |language_name, config| {
688 let path_matches_default_suffix = config
689 .path_suffixes
690 .iter()
691 .any(|suffix| path_suffixes.contains(&Some(suffix.as_str())));
692 let custom_suffixes = user_file_types
693 .and_then(|types| types.get(language_name.as_ref()))
694 .unwrap_or(&empty);
695 let path_matches_custom_suffix = path_suffixes
696 .iter()
697 .map(|suffix| suffix.unwrap_or(""))
698 .any(|suffix| custom_suffixes.is_match(suffix));
699 let content_matches = content.zip(config.first_line_pattern.as_ref()).map_or(
700 false,
701 |(content, pattern)| {
702 let end = content.clip_point(Point::new(0, 256), Bias::Left);
703 let end = content.point_to_offset(end);
704 let text = content.chunks_in_range(0..end).collect::<String>();
705 pattern.is_match(&text)
706 },
707 );
708 if path_matches_custom_suffix {
709 2
710 } else if path_matches_default_suffix || content_matches {
711 1
712 } else {
713 0
714 }
715 })
716 }
717
718 fn find_matching_language(
719 self: &Arc<Self>,
720 callback: impl Fn(&LanguageName, &LanguageMatcher) -> usize,
721 ) -> Option<AvailableLanguage> {
722 let state = self.state.read();
723 let available_language = state
724 .available_languages
725 .iter()
726 .filter_map(|language| {
727 let score = callback(&language.name, &language.matcher);
728 if score > 0 {
729 Some((language.clone(), score))
730 } else {
731 None
732 }
733 })
734 .max_by_key(|e| e.1)
735 .clone()
736 .map(|(available_language, _)| available_language);
737 drop(state);
738 available_language
739 }
740
741 pub fn load_language(
742 self: &Arc<Self>,
743 language: &AvailableLanguage,
744 ) -> oneshot::Receiver<Result<Arc<Language>>> {
745 let (tx, rx) = oneshot::channel();
746
747 let mut state = self.state.write();
748
749 // If the language is already loaded, resolve with it immediately.
750 for loaded_language in state.languages.iter() {
751 if loaded_language.id == language.id {
752 tx.send(Ok(loaded_language.clone())).unwrap();
753 return rx;
754 }
755 }
756
757 match state.loading_languages.entry(language.id) {
758 // If the language is already being loaded, then add this
759 // channel to a list that will be sent to when the load completes.
760 hash_map::Entry::Occupied(mut entry) => entry.get_mut().push(tx),
761
762 // Otherwise, start loading the language.
763 hash_map::Entry::Vacant(entry) => {
764 let this = self.clone();
765
766 let id = language.id;
767 let name = language.name.clone();
768 let language_load = language.load.clone();
769
770 self.executor
771 .spawn(async move {
772 let language = async {
773 let loaded_language = (language_load)()?;
774 if let Some(grammar) = loaded_language.config.grammar.clone() {
775 let grammar = Some(this.get_or_load_grammar(grammar).await?);
776
777 Language::new_with_id(id, loaded_language.config, grammar)
778 .with_context_provider(loaded_language.context_provider)
779 .with_toolchain_lister(loaded_language.toolchain_provider)
780 .with_queries(loaded_language.queries)
781 } else {
782 Ok(Language::new_with_id(id, loaded_language.config, None)
783 .with_context_provider(loaded_language.context_provider)
784 .with_toolchain_lister(loaded_language.toolchain_provider))
785 }
786 }
787 .await;
788
789 match language {
790 Ok(language) => {
791 let language = Arc::new(language);
792 let mut state = this.state.write();
793
794 state.add(language.clone());
795 state.mark_language_loaded(id);
796 if let Some(mut txs) = state.loading_languages.remove(&id) {
797 for tx in txs.drain(..) {
798 let _ = tx.send(Ok(language.clone()));
799 }
800 }
801 }
802 Err(e) => {
803 log::error!("failed to load language {name}:\n{:?}", e);
804 let mut state = this.state.write();
805 state.mark_language_loaded(id);
806 if let Some(mut txs) = state.loading_languages.remove(&id) {
807 for tx in txs.drain(..) {
808 let _ = tx.send(Err(anyhow!(
809 "failed to load language {}: {}",
810 name,
811 e
812 )));
813 }
814 }
815 }
816 };
817 })
818 .detach();
819
820 entry.insert(vec![tx]);
821 }
822 }
823
824 drop(state);
825 rx
826 }
827
828 fn get_or_load_language(
829 self: &Arc<Self>,
830 callback: impl Fn(&LanguageName, &LanguageMatcher) -> usize,
831 ) -> oneshot::Receiver<Result<Arc<Language>>> {
832 let Some(language) = self.find_matching_language(callback) else {
833 let (tx, rx) = oneshot::channel();
834 let _ = tx.send(Err(anyhow!(LanguageNotFound)));
835 return rx;
836 };
837
838 self.load_language(&language)
839 }
840
841 fn get_or_load_grammar(
842 self: &Arc<Self>,
843 name: Arc<str>,
844 ) -> impl Future<Output = Result<tree_sitter::Language>> {
845 let (tx, rx) = oneshot::channel();
846 let mut state = self.state.write();
847
848 if let Some(grammar) = state.grammars.get_mut(name.as_ref()) {
849 match grammar {
850 AvailableGrammar::LoadFailed(error) => {
851 tx.send(Err(error.clone())).ok();
852 }
853 AvailableGrammar::Native(grammar) | AvailableGrammar::Loaded(_, grammar) => {
854 tx.send(Ok(grammar.clone())).ok();
855 }
856 AvailableGrammar::Loading(_, txs) => {
857 txs.push(tx);
858 }
859 AvailableGrammar::Unloaded(wasm_path) => {
860 let this = self.clone();
861 let wasm_path = wasm_path.clone();
862 *grammar = AvailableGrammar::Loading(wasm_path.clone(), vec![tx]);
863 self.executor
864 .spawn(async move {
865 let grammar_result = maybe!({
866 let wasm_bytes = std::fs::read(&wasm_path)?;
867 let grammar_name = wasm_path
868 .file_stem()
869 .and_then(OsStr::to_str)
870 .ok_or_else(|| anyhow!("invalid grammar filename"))?;
871 anyhow::Ok(with_parser(|parser| {
872 let mut store = parser.take_wasm_store().unwrap();
873 let grammar = store.load_language(grammar_name, &wasm_bytes);
874 parser.set_wasm_store(store).unwrap();
875 grammar
876 })?)
877 })
878 .map_err(Arc::new);
879
880 let value = match &grammar_result {
881 Ok(grammar) => AvailableGrammar::Loaded(wasm_path, grammar.clone()),
882 Err(error) => AvailableGrammar::LoadFailed(error.clone()),
883 };
884
885 let old_value = this.state.write().grammars.insert(name, value);
886 if let Some(AvailableGrammar::Loading(_, txs)) = old_value {
887 for tx in txs {
888 tx.send(grammar_result.clone()).ok();
889 }
890 }
891 })
892 .detach();
893 }
894 }
895 } else {
896 tx.send(Err(Arc::new(anyhow!("no such grammar {}", name))))
897 .ok();
898 }
899
900 async move { rx.await?.map_err(|e| anyhow!(e)) }
901 }
902
903 pub fn to_vec(&self) -> Vec<Arc<Language>> {
904 self.state.read().languages.to_vec()
905 }
906
907 pub fn lsp_adapters(&self, language_name: &LanguageName) -> Vec<Arc<CachedLspAdapter>> {
908 self.state
909 .read()
910 .lsp_adapters
911 .get(language_name)
912 .cloned()
913 .unwrap_or_default()
914 }
915
916 pub fn all_lsp_adapters(&self) -> Vec<Arc<CachedLspAdapter>> {
917 self.state
918 .read()
919 .all_lsp_adapters
920 .values()
921 .cloned()
922 .collect()
923 }
924
925 pub fn adapter_for_name(&self, name: &LanguageServerName) -> Option<Arc<CachedLspAdapter>> {
926 self.state.read().all_lsp_adapters.get(name).cloned()
927 }
928
929 pub fn update_lsp_status(&self, server_name: LanguageServerName, status: BinaryStatus) {
930 self.lsp_binary_status_tx.send(server_name.0, status);
931 }
932
933 pub fn update_dap_status(&self, server_name: LanguageServerName, status: BinaryStatus) {
934 self.dap_binary_status_tx.send(server_name.0, status);
935 }
936
937 pub fn next_language_server_id(&self) -> LanguageServerId {
938 self.state.write().next_language_server_id()
939 }
940
941 pub fn language_server_download_dir(&self, name: &LanguageServerName) -> Option<Arc<Path>> {
942 self.language_server_download_dir
943 .as_ref()
944 .map(|dir| Arc::from(dir.join(name.0.as_ref())))
945 }
946
947 #[cfg(any(test, feature = "test-support"))]
948 pub fn create_fake_language_server(
949 &self,
950 server_id: LanguageServerId,
951 name: &LanguageServerName,
952 binary: lsp::LanguageServerBinary,
953 cx: &mut gpui::AsyncApp,
954 ) -> Option<lsp::LanguageServer> {
955 use gpui::AppContext as _;
956
957 let mut state = self.state.write();
958 let fake_entry = state.fake_server_entries.get_mut(&name)?;
959 let (server, mut fake_server) = lsp::FakeLanguageServer::new(
960 server_id,
961 binary,
962 name.0.to_string(),
963 fake_entry.capabilities.clone(),
964 cx,
965 );
966 fake_entry._server = Some(fake_server.clone());
967
968 if let Some(initializer) = &fake_entry.initializer {
969 initializer(&mut fake_server);
970 }
971
972 let tx = fake_entry.tx.clone();
973 cx.background_spawn(async move {
974 if fake_server
975 .try_receive_notification::<lsp::notification::Initialized>()
976 .await
977 .is_some()
978 {
979 tx.unbounded_send(fake_server.clone()).ok();
980 }
981 })
982 .detach();
983
984 Some(server)
985 }
986
987 pub fn language_server_binary_statuses(
988 &self,
989 ) -> mpsc::UnboundedReceiver<(SharedString, BinaryStatus)> {
990 self.lsp_binary_status_tx.subscribe()
991 }
992
993 pub fn dap_server_binary_statuses(
994 &self,
995 ) -> mpsc::UnboundedReceiver<(SharedString, BinaryStatus)> {
996 self.dap_binary_status_tx.subscribe()
997 }
998
999 pub async fn delete_server_container(&self, name: LanguageServerName) {
1000 log::info!("deleting server container");
1001 let Some(dir) = self.language_server_download_dir(&name) else {
1002 return;
1003 };
1004
1005 smol::fs::remove_dir_all(dir)
1006 .await
1007 .context("server container removal")
1008 .log_err();
1009 }
1010}
1011
1012impl LanguageRegistryState {
1013 fn next_language_server_id(&mut self) -> LanguageServerId {
1014 LanguageServerId(post_inc(&mut self.next_language_server_id))
1015 }
1016
1017 fn add(&mut self, language: Arc<Language>) {
1018 if let Some(theme) = self.theme.as_ref() {
1019 language.set_theme(theme.syntax());
1020 }
1021 self.language_settings.languages.insert(
1022 language.name(),
1023 LanguageSettingsContent {
1024 tab_size: language.config.tab_size,
1025 hard_tabs: language.config.hard_tabs,
1026 soft_wrap: language.config.soft_wrap,
1027 auto_indent_on_paste: language.config.auto_indent_on_paste,
1028 ..Default::default()
1029 }
1030 .clone(),
1031 );
1032 self.languages.push(language);
1033 self.version += 1;
1034 *self.subscription.0.borrow_mut() = ();
1035 }
1036
1037 fn reload(&mut self) {
1038 self.languages.clear();
1039 self.version += 1;
1040 self.reload_count += 1;
1041 for language in &mut self.available_languages {
1042 language.loaded = false;
1043 }
1044 *self.subscription.0.borrow_mut() = ();
1045 }
1046
1047 /// Reorders the list of language servers for the given language.
1048 ///
1049 /// Uses the provided list of ordered [`CachedLspAdapters`] as the desired order.
1050 ///
1051 /// Any existing language servers not present in `ordered_lsp_adapters` will be
1052 /// appended to the end.
1053 fn reorder_language_servers(
1054 &mut self,
1055 language_name: &LanguageName,
1056 ordered_lsp_adapters: Vec<Arc<CachedLspAdapter>>,
1057 ) {
1058 let Some(lsp_adapters) = self.lsp_adapters.get_mut(language_name) else {
1059 return;
1060 };
1061
1062 let ordered_lsp_adapter_ids = ordered_lsp_adapters
1063 .iter()
1064 .map(|lsp_adapter| lsp_adapter.name.clone())
1065 .collect::<HashSet<_>>();
1066
1067 let mut new_lsp_adapters = ordered_lsp_adapters;
1068 for adapter in lsp_adapters.iter() {
1069 if !ordered_lsp_adapter_ids.contains(&adapter.name) {
1070 new_lsp_adapters.push(adapter.clone());
1071 }
1072 }
1073
1074 *lsp_adapters = new_lsp_adapters;
1075 }
1076
1077 fn remove_languages(
1078 &mut self,
1079 languages_to_remove: &[LanguageName],
1080 grammars_to_remove: &[Arc<str>],
1081 ) {
1082 if languages_to_remove.is_empty() && grammars_to_remove.is_empty() {
1083 return;
1084 }
1085
1086 self.languages
1087 .retain(|language| !languages_to_remove.contains(&language.name()));
1088 self.available_languages
1089 .retain(|language| !languages_to_remove.contains(&language.name));
1090 self.grammars
1091 .retain(|name, _| !grammars_to_remove.contains(name));
1092 self.version += 1;
1093 self.reload_count += 1;
1094 *self.subscription.0.borrow_mut() = ();
1095 }
1096
1097 /// Mark the given language as having been loaded, so that the
1098 /// language registry won't try to load it again.
1099 fn mark_language_loaded(&mut self, id: LanguageId) {
1100 for language in &mut self.available_languages {
1101 if language.id == id {
1102 language.loaded = true;
1103 break;
1104 }
1105 }
1106 }
1107}
1108
1109impl BinaryStatusSender {
1110 fn subscribe(&self) -> mpsc::UnboundedReceiver<(SharedString, BinaryStatus)> {
1111 let (tx, rx) = mpsc::unbounded();
1112 self.txs.lock().push(tx);
1113 rx
1114 }
1115
1116 fn send(&self, name: SharedString, status: BinaryStatus) {
1117 let mut txs = self.txs.lock();
1118 txs.retain(|tx| tx.unbounded_send((name.clone(), status.clone())).is_ok());
1119 }
1120}