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