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