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