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