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