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