language_registry.rs

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