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