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