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