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