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