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