language_registry.rs

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