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