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