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