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