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 state.version += 1;
323 *state.subscription.0.borrow_mut() = ();
324 }
325
326 /// Register a fake language server and adapter
327 /// The returned channel receives a new instance of the language server every time it is started
328 #[cfg(any(feature = "test-support", test))]
329 pub fn register_fake_lsp(
330 &self,
331 language_name: impl Into<LanguageName>,
332 mut adapter: crate::FakeLspAdapter,
333 ) -> futures::channel::mpsc::UnboundedReceiver<lsp::FakeLanguageServer> {
334 let adapter_name = LanguageServerName(adapter.name.into());
335 let capabilities = adapter.capabilities.clone();
336 let initializer = adapter.initializer.take();
337 self.register_fake_lsp_adapter(language_name, adapter);
338 self.register_fake_lsp_server(adapter_name, capabilities, initializer)
339 }
340
341 /// Register a fake lsp adapter (without the language server)
342 #[cfg(any(feature = "test-support", test))]
343 pub fn register_fake_lsp_adapter(
344 &self,
345 language_name: impl Into<LanguageName>,
346 adapter: crate::FakeLspAdapter,
347 ) {
348 let language_name = language_name.into();
349 let mut state = self.state.write();
350 let cached_adapter = CachedLspAdapter::new(Arc::new(adapter));
351 state
352 .lsp_adapters
353 .entry(language_name)
354 .or_default()
355 .push(cached_adapter.clone());
356 state
357 .all_lsp_adapters
358 .insert(cached_adapter.name(), cached_adapter);
359 state.version += 1;
360 *state.subscription.0.borrow_mut() = ();
361 }
362
363 /// Register a fake language server (without the adapter)
364 /// The returned channel receives a new instance of the language server every time it is started
365 #[cfg(any(feature = "test-support", test))]
366 pub fn register_fake_lsp_server(
367 &self,
368 lsp_name: LanguageServerName,
369 capabilities: lsp::ServerCapabilities,
370 initializer: Option<Box<dyn Fn(&mut lsp::FakeLanguageServer) + Send + Sync>>,
371 ) -> futures::channel::mpsc::UnboundedReceiver<lsp::FakeLanguageServer> {
372 let (servers_tx, servers_rx) = futures::channel::mpsc::unbounded();
373 self.state.write().fake_server_entries.insert(
374 lsp_name,
375 FakeLanguageServerEntry {
376 tx: servers_tx,
377 capabilities,
378 initializer,
379 _server: None,
380 },
381 );
382 servers_rx
383 }
384
385 #[cfg(any(feature = "test-support", test))]
386 pub fn has_fake_lsp_server(&self, lsp_name: &LanguageServerName) -> bool {
387 self.state.read().fake_server_entries.contains_key(lsp_name)
388 }
389
390 /// Adds a language to the registry, which can be loaded if needed.
391 pub fn register_language(
392 &self,
393 name: LanguageName,
394 grammar_name: Option<Arc<str>>,
395 matcher: LanguageMatcher,
396 hidden: bool,
397 manifest_name: Option<ManifestName>,
398 load: Arc<dyn Fn() -> Result<LoadedLanguage> + 'static + Send + Sync>,
399 ) {
400 let state = &mut *self.state.write();
401
402 for existing_language in &mut state.available_languages {
403 if existing_language.name == name {
404 existing_language.grammar = grammar_name;
405 existing_language.matcher = matcher;
406 existing_language.load = load;
407 existing_language.manifest_name = manifest_name;
408 return;
409 }
410 }
411
412 state.available_languages.push(AvailableLanguage {
413 id: LanguageId::new(),
414 name,
415 grammar: grammar_name,
416 matcher,
417 load,
418 hidden,
419 loaded: false,
420 manifest_name,
421 });
422 state.version += 1;
423 state.reload_count += 1;
424 *state.subscription.0.borrow_mut() = ();
425 }
426
427 /// Adds grammars to the registry. Language configurations reference a grammar by name. The
428 /// grammar controls how the source code is parsed.
429 pub fn register_native_grammars(
430 &self,
431 grammars: impl IntoIterator<Item = (impl Into<Arc<str>>, impl Into<tree_sitter::Language>)>,
432 ) {
433 self.state.write().grammars.extend(
434 grammars
435 .into_iter()
436 .map(|(name, grammar)| (name.into(), AvailableGrammar::Native(grammar.into()))),
437 );
438 }
439
440 /// Adds paths to WASM grammar files, which can be loaded if needed.
441 pub fn register_wasm_grammars(&self, grammars: Vec<(Arc<str>, PathBuf)>) {
442 if grammars.is_empty() {
443 return;
444 }
445
446 let mut state = self.state.write();
447 state.grammars.extend(
448 grammars
449 .into_iter()
450 .map(|(name, path)| (name, AvailableGrammar::Unloaded(path))),
451 );
452 state.version += 1;
453 state.reload_count += 1;
454 *state.subscription.0.borrow_mut() = ();
455 }
456
457 pub fn language_settings(&self) -> AllLanguageSettingsContent {
458 self.state.read().language_settings.clone()
459 }
460
461 pub fn language_names(&self) -> Vec<LanguageName> {
462 let state = self.state.read();
463 let mut result = state
464 .available_languages
465 .iter()
466 .filter_map(|l| l.loaded.not().then_some(l.name.clone()))
467 .chain(state.languages.iter().map(|l| l.config.name.clone()))
468 .collect::<Vec<_>>();
469 result.sort_unstable_by_key(|language_name| language_name.as_ref().to_lowercase());
470 result
471 }
472
473 pub fn grammar_names(&self) -> Vec<Arc<str>> {
474 let state = self.state.read();
475 let mut result = state.grammars.keys().cloned().collect::<Vec<_>>();
476 result.sort_unstable_by_key(|grammar_name| grammar_name.to_lowercase());
477 result
478 }
479
480 /// Add a pre-loaded language to the registry.
481 pub fn add(&self, language: Arc<Language>) {
482 let mut state = self.state.write();
483 state.available_languages.push(AvailableLanguage {
484 id: language.id,
485 name: language.name(),
486 grammar: language.config.grammar.clone(),
487 matcher: language.config.matcher.clone(),
488 hidden: language.config.hidden,
489 manifest_name: None,
490 load: Arc::new(|| Err(anyhow!("already loaded"))),
491 loaded: true,
492 });
493 state.add(language);
494 }
495
496 pub fn subscribe(&self) -> watch::Receiver<()> {
497 self.state.read().subscription.1.clone()
498 }
499
500 /// Returns the number of times that the registry has been changed,
501 /// by adding languages or reloading.
502 pub fn version(&self) -> usize {
503 self.state.read().version
504 }
505
506 /// Returns the number of times that the registry has been reloaded.
507 pub fn reload_count(&self) -> usize {
508 self.state.read().reload_count
509 }
510
511 pub fn set_theme(&self, theme: Arc<Theme>) {
512 let mut state = self.state.write();
513 state.theme = Some(theme.clone());
514 for language in &state.languages {
515 language.set_theme(theme.syntax());
516 }
517 }
518
519 pub fn set_language_server_download_dir(&mut self, path: impl Into<Arc<Path>>) {
520 self.language_server_download_dir = Some(path.into());
521 }
522
523 pub fn language_for_name(
524 self: &Arc<Self>,
525 name: &str,
526 ) -> impl Future<Output = Result<Arc<Language>>> + use<> {
527 let name = UniCase::new(name);
528 let rx = self.get_or_load_language(|language_name, _, current_best_match| {
529 match current_best_match {
530 LanguageMatchPrecedence::Undetermined if UniCase::new(&language_name.0) == name => {
531 Some(LanguageMatchPrecedence::PathOrContent(name.len()))
532 }
533 LanguageMatchPrecedence::Undetermined
534 | LanguageMatchPrecedence::UserConfigured(_)
535 | LanguageMatchPrecedence::PathOrContent(_) => None,
536 }
537 });
538 async move { rx.await? }
539 }
540
541 pub async fn language_for_id(self: &Arc<Self>, id: LanguageId) -> Result<Arc<Language>> {
542 let available_language = {
543 let state = self.state.read();
544
545 let Some(available_language) = state
546 .available_languages
547 .iter()
548 .find(|lang| lang.id == id)
549 .cloned()
550 else {
551 anyhow::bail!(LanguageNotFound);
552 };
553 available_language
554 };
555
556 self.load_language(&available_language).await?
557 }
558
559 pub fn language_name_for_extension(self: &Arc<Self>, extension: &str) -> Option<LanguageName> {
560 self.state.try_read().and_then(|state| {
561 state
562 .available_languages
563 .iter()
564 .find(|language| {
565 language
566 .matcher()
567 .path_suffixes
568 .iter()
569 .any(|suffix| *suffix == extension)
570 })
571 .map(|language| language.name.clone())
572 })
573 }
574
575 pub fn language_for_name_or_extension(
576 self: &Arc<Self>,
577 string: &str,
578 ) -> impl Future<Output = Result<Arc<Language>>> {
579 let string = UniCase::new(string);
580 let rx = self.get_or_load_language(|name, config, current_best_match| {
581 let name_matches = || {
582 UniCase::new(&name.0) == string
583 || config
584 .path_suffixes
585 .iter()
586 .any(|suffix| UniCase::new(suffix) == string)
587 };
588
589 match current_best_match {
590 LanguageMatchPrecedence::Undetermined => {
591 name_matches().then_some(LanguageMatchPrecedence::PathOrContent(string.len()))
592 }
593 LanguageMatchPrecedence::PathOrContent(len) => (string.len() > len
594 && name_matches())
595 .then_some(LanguageMatchPrecedence::PathOrContent(string.len())),
596 LanguageMatchPrecedence::UserConfigured(_) => None,
597 }
598 });
599 async move { rx.await? }
600 }
601
602 pub fn available_language_for_name(self: &Arc<Self>, name: &str) -> Option<AvailableLanguage> {
603 let state = self.state.read();
604 state
605 .available_languages
606 .iter()
607 .find(|l| l.name.0.as_ref() == name)
608 .cloned()
609 }
610
611 /// Look up a language by its modeline name (vim filetype or emacs mode).
612 ///
613 /// This performs a case-insensitive match against:
614 /// 1. Explicit modeline aliases defined in the language config
615 /// 2. The language's grammar name
616 /// 3. The language name itself
617 pub fn available_language_for_modeline_name(
618 self: &Arc<Self>,
619 modeline_name: &str,
620 ) -> Option<AvailableLanguage> {
621 let modeline_name_lower = modeline_name.to_lowercase();
622 let state = self.state.read();
623
624 state
625 .available_languages
626 .iter()
627 .find(|lang| {
628 lang.matcher
629 .modeline_aliases
630 .iter()
631 .any(|alias| alias.to_lowercase() == modeline_name_lower)
632 })
633 .or_else(|| {
634 state.available_languages.iter().find(|lang| {
635 lang.grammar
636 .as_ref()
637 .is_some_and(|g| g.to_lowercase() == modeline_name_lower)
638 })
639 })
640 .or_else(|| {
641 state
642 .available_languages
643 .iter()
644 .find(|lang| lang.name.0.to_lowercase() == modeline_name_lower)
645 })
646 .cloned()
647 }
648
649 pub fn language_for_file(
650 self: &Arc<Self>,
651 file: &Arc<dyn File>,
652 content: Option<&Rope>,
653 cx: &App,
654 ) -> Option<AvailableLanguage> {
655 let user_file_types = all_language_settings(Some(file), cx);
656
657 self.language_for_file_internal(
658 &file.full_path(cx),
659 content,
660 Some(&user_file_types.file_types),
661 )
662 }
663
664 pub fn language_for_file_path(self: &Arc<Self>, path: &Path) -> Option<AvailableLanguage> {
665 self.language_for_file_internal(path, None, None)
666 }
667
668 #[ztracing::instrument(skip_all)]
669 pub fn load_language_for_file_path<'a>(
670 self: &Arc<Self>,
671 path: &'a Path,
672 ) -> impl Future<Output = Result<Arc<Language>>> + 'a {
673 let language = self.language_for_file_path(path);
674
675 let this = self.clone();
676 async move {
677 if let Some(language) = language {
678 this.load_language(&language).await?
679 } else {
680 Err(anyhow!(LanguageNotFound))
681 }
682 }
683 }
684
685 fn language_for_file_internal(
686 self: &Arc<Self>,
687 path: &Path,
688 content: Option<&Rope>,
689 user_file_types: Option<&FxHashMap<Arc<str>, (GlobSet, Vec<String>)>>,
690 ) -> Option<AvailableLanguage> {
691 let filename = path.file_name().and_then(|filename| filename.to_str());
692 // `Path.extension()` returns None for files with a leading '.'
693 // and no other extension which is not the desired behavior here,
694 // as we want `.zshrc` to result in extension being `Some("zshrc")`
695 let extension = filename.and_then(|filename| filename.split('.').next_back());
696 let path_suffixes = [extension, filename, path.to_str()]
697 .iter()
698 .filter_map(|suffix| suffix.map(|suffix| (suffix, globset::Candidate::new(suffix))))
699 .collect::<SmallVec<[_; 3]>>();
700 let content = LazyCell::new(|| {
701 content.map(|content| {
702 let end = content.clip_point(Point::new(0, 256), Bias::Left);
703 let end = content.point_to_offset(end);
704 content.chunks_in_range(0..end).collect::<String>()
705 })
706 });
707 self.find_matching_language(move |language_name, config, current_best_match| {
708 let path_matches_default_suffix = || {
709 let len =
710 config
711 .path_suffixes
712 .iter()
713 .fold(0, |acc: usize, path_suffix: &String| {
714 let ext = ".".to_string() + path_suffix;
715
716 let matched_suffix_len = path_suffixes
717 .iter()
718 .find(|(suffix, _)| suffix.ends_with(&ext) || suffix == path_suffix)
719 .map(|(suffix, _)| suffix.len());
720
721 match matched_suffix_len {
722 Some(len) => acc.max(len),
723 None => acc,
724 }
725 });
726 (len > 0).then_some(len)
727 };
728
729 let path_matches_custom_suffix = || {
730 user_file_types
731 .and_then(|types| types.get(language_name.as_ref()))
732 .map_or(None, |(custom_suffixes, _)| {
733 path_suffixes
734 .iter()
735 .find(|(_, candidate)| custom_suffixes.is_match_candidate(candidate))
736 .map(|(suffix, _)| suffix.len())
737 })
738 };
739
740 let content_matches = || {
741 config.first_line_pattern.as_ref().is_some_and(|pattern| {
742 content
743 .as_ref()
744 .is_some_and(|content| pattern.is_match(content))
745 })
746 };
747
748 // Only return a match for the given file if we have a better match than
749 // the current one.
750 match current_best_match {
751 LanguageMatchPrecedence::PathOrContent(current_len) => {
752 if let Some(len) = path_matches_custom_suffix() {
753 // >= because user config should win tie with system ext len
754 (len >= current_len).then_some(LanguageMatchPrecedence::UserConfigured(len))
755 } else if let Some(len) = path_matches_default_suffix() {
756 // >= because user config should win tie with system ext len
757 (len >= current_len).then_some(LanguageMatchPrecedence::PathOrContent(len))
758 } else {
759 None
760 }
761 }
762 LanguageMatchPrecedence::Undetermined => {
763 if let Some(len) = path_matches_custom_suffix() {
764 Some(LanguageMatchPrecedence::UserConfigured(len))
765 } else if let Some(len) = path_matches_default_suffix() {
766 Some(LanguageMatchPrecedence::PathOrContent(len))
767 } else if content_matches() {
768 Some(LanguageMatchPrecedence::PathOrContent(1))
769 } else {
770 None
771 }
772 }
773 LanguageMatchPrecedence::UserConfigured(_) => None,
774 }
775 })
776 }
777
778 fn find_matching_language(
779 self: &Arc<Self>,
780 callback: impl Fn(
781 &LanguageName,
782 &LanguageMatcher,
783 LanguageMatchPrecedence,
784 ) -> Option<LanguageMatchPrecedence>,
785 ) -> Option<AvailableLanguage> {
786 let state = self.state.read();
787 let available_language = state
788 .available_languages
789 .iter()
790 .rev()
791 .fold(None, |best_language_match, language| {
792 let current_match_type = best_language_match
793 .as_ref()
794 .map_or(LanguageMatchPrecedence::default(), |(_, score)| *score);
795 let language_score =
796 callback(&language.name, &language.matcher, current_match_type);
797
798 match (language_score, current_match_type) {
799 // no current best, so our candidate is better
800 (
801 Some(
802 LanguageMatchPrecedence::PathOrContent(_)
803 | LanguageMatchPrecedence::UserConfigured(_),
804 ),
805 LanguageMatchPrecedence::Undetermined,
806 ) => language_score.map(|new_score| (language.clone(), new_score)),
807
808 // our candidate is better only if the name is longer
809 (
810 Some(LanguageMatchPrecedence::PathOrContent(new_len)),
811 LanguageMatchPrecedence::PathOrContent(current_len),
812 )
813 | (
814 Some(LanguageMatchPrecedence::UserConfigured(new_len)),
815 LanguageMatchPrecedence::UserConfigured(current_len),
816 )
817 | (
818 Some(LanguageMatchPrecedence::PathOrContent(new_len)),
819 LanguageMatchPrecedence::UserConfigured(current_len),
820 ) => {
821 if new_len > current_len {
822 language_score.map(|new_score| (language.clone(), new_score))
823 } else {
824 best_language_match
825 }
826 }
827
828 // our candidate is better if the name is longer or equal to
829 (
830 Some(LanguageMatchPrecedence::UserConfigured(new_len)),
831 LanguageMatchPrecedence::PathOrContent(current_len),
832 ) => {
833 if new_len >= current_len {
834 language_score.map(|new_score| (language.clone(), new_score))
835 } else {
836 best_language_match
837 }
838 }
839
840 // no candidate, use current best
841 (None, _) | (Some(LanguageMatchPrecedence::Undetermined), _) => {
842 best_language_match
843 }
844 }
845 })
846 .map(|(available_language, _)| available_language);
847 drop(state);
848 available_language
849 }
850
851 #[ztracing::instrument(skip_all)]
852 pub fn load_language(
853 self: &Arc<Self>,
854 language: &AvailableLanguage,
855 ) -> oneshot::Receiver<Result<Arc<Language>>> {
856 let (tx, rx) = oneshot::channel();
857
858 let mut state = self.state.write();
859
860 // If the language is already loaded, resolve with it immediately.
861 for loaded_language in state.languages.iter() {
862 if loaded_language.id == language.id {
863 tx.send(Ok(loaded_language.clone())).unwrap();
864 return rx;
865 }
866 }
867
868 match state.loading_languages.entry(language.id) {
869 // If the language is already being loaded, then add this
870 // channel to a list that will be sent to when the load completes.
871 hash_map::Entry::Occupied(mut entry) => entry.get_mut().push(tx),
872
873 // Otherwise, start loading the language.
874 hash_map::Entry::Vacant(entry) => {
875 let this = self.clone();
876
877 let id = language.id;
878 let name = language.name.clone();
879 let language_load = language.load.clone();
880
881 self.executor
882 .spawn(async move {
883 let language = async {
884 let loaded_language = (language_load)()?;
885 if let Some(grammar) = loaded_language.config.grammar.clone() {
886 let grammar = Some(this.get_or_load_grammar(grammar).await?);
887
888 Language::new_with_id(id, loaded_language.config, grammar)
889 .with_context_provider(loaded_language.context_provider)
890 .with_toolchain_lister(loaded_language.toolchain_provider)
891 .with_manifest(loaded_language.manifest_name)
892 .with_queries(loaded_language.queries)
893 } else {
894 Ok(Language::new_with_id(id, loaded_language.config, None)
895 .with_context_provider(loaded_language.context_provider)
896 .with_manifest(loaded_language.manifest_name)
897 .with_toolchain_lister(loaded_language.toolchain_provider))
898 }
899 }
900 .await;
901
902 match language {
903 Ok(language) => {
904 let language = Arc::new(language);
905 let mut state = this.state.write();
906
907 state.add(language.clone());
908 state.mark_language_loaded(id);
909 if let Some(mut txs) = state.loading_languages.remove(&id) {
910 for tx in txs.drain(..) {
911 let _ = tx.send(Ok(language.clone()));
912 }
913 }
914 }
915 Err(e) => {
916 log::error!("failed to load language {name}:\n{e:?}");
917 let mut state = this.state.write();
918 state.mark_language_loaded(id);
919 if let Some(mut txs) = state.loading_languages.remove(&id) {
920 for tx in txs.drain(..) {
921 let _ = tx.send(Err(anyhow!(
922 "failed to load language {name}: {e}",
923 )));
924 }
925 }
926 }
927 };
928 })
929 .detach();
930
931 entry.insert(vec![tx]);
932 }
933 }
934
935 drop(state);
936 rx
937 }
938
939 #[ztracing::instrument(skip_all)]
940 fn get_or_load_language(
941 self: &Arc<Self>,
942 callback: impl Fn(
943 &LanguageName,
944 &LanguageMatcher,
945 LanguageMatchPrecedence,
946 ) -> Option<LanguageMatchPrecedence>,
947 ) -> oneshot::Receiver<Result<Arc<Language>>> {
948 let Some(language) = self.find_matching_language(callback) else {
949 let (tx, rx) = oneshot::channel();
950 let _ = tx.send(Err(anyhow!(LanguageNotFound)));
951 return rx;
952 };
953
954 self.load_language(&language)
955 }
956
957 fn get_or_load_grammar(
958 self: &Arc<Self>,
959 name: Arc<str>,
960 ) -> impl Future<Output = Result<tree_sitter::Language>> {
961 let span = ztracing::debug_span!("get_or_load_grammar", name = &*name.clone());
962 let _enter = span.enter();
963 let (tx, rx) = oneshot::channel();
964 let mut state = self.state.write();
965
966 if let Some(grammar) = state.grammars.get_mut(name.as_ref()) {
967 match grammar {
968 AvailableGrammar::LoadFailed(error) => {
969 tx.send(Err(error.clone())).ok();
970 }
971 AvailableGrammar::Native(grammar) | AvailableGrammar::Loaded(_, grammar) => {
972 tx.send(Ok(grammar.clone())).ok();
973 }
974 AvailableGrammar::Loading(_, txs) => {
975 txs.push(tx);
976 }
977 AvailableGrammar::Unloaded(wasm_path) => {
978 log::trace!("start loading grammar {name:?}");
979 let this = self.clone();
980 let wasm_path = wasm_path.clone();
981 *grammar = AvailableGrammar::Loading(wasm_path.clone(), vec![tx]);
982 self.executor
983 .spawn(async move {
984 let grammar_result = maybe!({
985 let wasm_bytes = std::fs::read(&wasm_path)?;
986 let grammar_name = wasm_path
987 .file_stem()
988 .and_then(OsStr::to_str)
989 .context("invalid grammar filename")?;
990 anyhow::Ok(with_parser(|parser| {
991 let mut store = parser.take_wasm_store().unwrap();
992 let grammar = store.load_language(grammar_name, &wasm_bytes);
993 parser.set_wasm_store(store).unwrap();
994 grammar
995 })?)
996 })
997 .map_err(Arc::new);
998
999 let value = match &grammar_result {
1000 Ok(grammar) => AvailableGrammar::Loaded(wasm_path, grammar.clone()),
1001 Err(error) => AvailableGrammar::LoadFailed(error.clone()),
1002 };
1003
1004 log::trace!("finish loading grammar {name:?}");
1005 let old_value = this.state.write().grammars.insert(name, value);
1006 if let Some(AvailableGrammar::Loading(_, txs)) = old_value {
1007 for tx in txs {
1008 tx.send(grammar_result.clone()).ok();
1009 }
1010 }
1011 })
1012 .detach();
1013 }
1014 }
1015 } else {
1016 tx.send(Err(Arc::new(anyhow!("no such grammar {name}"))))
1017 .ok();
1018 }
1019
1020 async move { rx.await?.map_err(|e| anyhow!(e)) }
1021 }
1022
1023 pub fn to_vec(&self) -> Vec<Arc<Language>> {
1024 self.state.read().languages.to_vec()
1025 }
1026
1027 pub fn lsp_adapters(&self, language_name: &LanguageName) -> Vec<Arc<CachedLspAdapter>> {
1028 self.state
1029 .read()
1030 .lsp_adapters
1031 .get(language_name)
1032 .cloned()
1033 .unwrap_or_default()
1034 }
1035
1036 pub fn all_lsp_adapters(&self) -> Vec<Arc<CachedLspAdapter>> {
1037 self.state
1038 .read()
1039 .all_lsp_adapters
1040 .values()
1041 .cloned()
1042 .collect()
1043 }
1044
1045 pub fn adapter_for_name(&self, name: &LanguageServerName) -> Option<Arc<CachedLspAdapter>> {
1046 self.state.read().all_lsp_adapters.get(name).cloned()
1047 }
1048
1049 pub fn update_lsp_binary_status(&self, server_name: LanguageServerName, status: BinaryStatus) {
1050 self.lsp_binary_status_tx.send(server_name, status);
1051 }
1052
1053 pub fn next_language_server_id(&self) -> LanguageServerId {
1054 self.state.write().next_language_server_id()
1055 }
1056
1057 pub fn language_server_download_dir(&self, name: &LanguageServerName) -> Option<Arc<Path>> {
1058 self.language_server_download_dir
1059 .as_ref()
1060 .map(|dir| Arc::from(dir.join(name.0.as_ref())))
1061 }
1062
1063 #[cfg(any(test, feature = "test-support"))]
1064 pub fn create_fake_language_server(
1065 &self,
1066 server_id: LanguageServerId,
1067 name: &LanguageServerName,
1068 binary: lsp::LanguageServerBinary,
1069 cx: &mut gpui::AsyncApp,
1070 ) -> Option<lsp::LanguageServer> {
1071 let mut state = self.state.write();
1072 let fake_entry = state.fake_server_entries.get_mut(name)?;
1073
1074 let (server, mut fake_server) = lsp::FakeLanguageServer::new(
1075 server_id,
1076 binary,
1077 name.0.to_string(),
1078 fake_entry.capabilities.clone(),
1079 cx,
1080 );
1081 fake_entry._server = Some(fake_server.clone());
1082
1083 if let Some(initializer) = &fake_entry.initializer {
1084 initializer(&mut fake_server);
1085 }
1086
1087 // Emit synchronously so tests can reliably observe server creation even if the LSP startup
1088 // task hasn't progressed to initialization yet.
1089 fake_entry.tx.unbounded_send(fake_server).ok();
1090
1091 Some(server)
1092 }
1093
1094 pub fn language_server_binary_statuses(
1095 &self,
1096 ) -> mpsc::UnboundedReceiver<(LanguageServerName, BinaryStatus)> {
1097 self.lsp_binary_status_tx.subscribe()
1098 }
1099
1100 pub async fn delete_server_container(&self, name: LanguageServerName) {
1101 log::info!("deleting server container");
1102 let Some(dir) = self.language_server_download_dir(&name) else {
1103 return;
1104 };
1105
1106 smol::fs::remove_dir_all(dir)
1107 .await
1108 .context("server container removal")
1109 .log_err();
1110 }
1111}
1112
1113impl LanguageRegistryState {
1114 fn next_language_server_id(&mut self) -> LanguageServerId {
1115 LanguageServerId(post_inc(&mut self.next_language_server_id))
1116 }
1117
1118 fn add(&mut self, language: Arc<Language>) {
1119 if let Some(theme) = self.theme.as_ref() {
1120 language.set_theme(theme.syntax());
1121 }
1122 self.language_settings.languages.0.insert(
1123 language.name().0.to_string(),
1124 LanguageSettingsContent {
1125 tab_size: language.config.tab_size,
1126 hard_tabs: language.config.hard_tabs,
1127 soft_wrap: language.config.soft_wrap.map(crate::to_settings_soft_wrap),
1128 auto_indent_on_paste: language.config.auto_indent_on_paste,
1129 ..Default::default()
1130 },
1131 );
1132 self.languages.push(language);
1133 self.version += 1;
1134 *self.subscription.0.borrow_mut() = ();
1135 }
1136
1137 fn reload(&mut self) {
1138 self.languages.clear();
1139 self.version += 1;
1140 self.reload_count += 1;
1141 for language in &mut self.available_languages {
1142 language.loaded = false;
1143 }
1144 *self.subscription.0.borrow_mut() = ();
1145 }
1146
1147 /// Reorders the list of language servers for the given language.
1148 ///
1149 /// Uses the provided list of ordered [`CachedLspAdapters`] as the desired order.
1150 ///
1151 /// Any existing language servers not present in `ordered_lsp_adapters` will be
1152 /// appended to the end.
1153 fn reorder_language_servers(
1154 &mut self,
1155 language_name: &LanguageName,
1156 ordered_lsp_adapters: Vec<Arc<CachedLspAdapter>>,
1157 ) {
1158 let Some(lsp_adapters) = self.lsp_adapters.get_mut(language_name) else {
1159 return;
1160 };
1161
1162 let ordered_lsp_adapter_ids = ordered_lsp_adapters
1163 .iter()
1164 .map(|lsp_adapter| lsp_adapter.name.clone())
1165 .collect::<HashSet<_>>();
1166
1167 let mut new_lsp_adapters = ordered_lsp_adapters;
1168 for adapter in lsp_adapters.iter() {
1169 if !ordered_lsp_adapter_ids.contains(&adapter.name) {
1170 new_lsp_adapters.push(adapter.clone());
1171 }
1172 }
1173
1174 *lsp_adapters = new_lsp_adapters;
1175 }
1176
1177 fn remove_languages(
1178 &mut self,
1179 languages_to_remove: &[LanguageName],
1180 grammars_to_remove: &[Arc<str>],
1181 ) {
1182 if languages_to_remove.is_empty() && grammars_to_remove.is_empty() {
1183 return;
1184 }
1185
1186 self.languages
1187 .retain(|language| !languages_to_remove.contains(&language.name()));
1188 self.available_languages
1189 .retain(|language| !languages_to_remove.contains(&language.name));
1190 self.grammars
1191 .retain(|name, _| !grammars_to_remove.contains(name));
1192 self.version += 1;
1193 self.reload_count += 1;
1194 *self.subscription.0.borrow_mut() = ();
1195 }
1196
1197 /// Mark the given language as having been loaded, so that the
1198 /// language registry won't try to load it again.
1199 fn mark_language_loaded(&mut self, id: LanguageId) {
1200 for language in &mut self.available_languages {
1201 if language.id == id {
1202 language.loaded = true;
1203 break;
1204 }
1205 }
1206 }
1207}
1208
1209impl ServerStatusSender {
1210 fn subscribe(&self) -> mpsc::UnboundedReceiver<(LanguageServerName, BinaryStatus)> {
1211 let (tx, rx) = mpsc::unbounded();
1212 self.txs.lock().push(tx);
1213 rx
1214 }
1215
1216 fn send(&self, name: LanguageServerName, status: BinaryStatus) {
1217 let mut txs = self.txs.lock();
1218 txs.retain(|tx| tx.unbounded_send((name.clone(), status.clone())).is_ok());
1219 }
1220}