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