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