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