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