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