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