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