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