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