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