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