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