language_registry.rs

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