language.rs

   1mod buffer;
   2mod diagnostic_set;
   3mod highlight_map;
   4mod outline;
   5pub mod proto;
   6mod syntax_map;
   7
   8#[cfg(test)]
   9mod buffer_tests;
  10
  11use anyhow::{anyhow, Context, Result};
  12use async_trait::async_trait;
  13use client::http::HttpClient;
  14use collections::HashMap;
  15use futures::{
  16    channel::oneshot,
  17    future::{BoxFuture, Shared},
  18    FutureExt, TryFutureExt as _,
  19};
  20use gpui::{executor::Background, MutableAppContext, Task};
  21use highlight_map::HighlightMap;
  22use lazy_static::lazy_static;
  23use parking_lot::{Mutex, RwLock};
  24use postage::watch;
  25use regex::Regex;
  26use serde::{de, Deserialize, Deserializer};
  27use serde_json::Value;
  28use std::{
  29    any::Any,
  30    borrow::Cow,
  31    cell::RefCell,
  32    fmt::Debug,
  33    hash::Hash,
  34    mem,
  35    ops::Range,
  36    path::{Path, PathBuf},
  37    str,
  38    sync::{
  39        atomic::{AtomicUsize, Ordering::SeqCst},
  40        Arc,
  41    },
  42};
  43use syntax_map::SyntaxSnapshot;
  44use theme::{SyntaxTheme, Theme};
  45use tree_sitter::{self, Query};
  46use unicase::UniCase;
  47use util::{merge_json_value_into, post_inc, ResultExt, TryFutureExt as _, UnwrapFuture};
  48
  49#[cfg(any(test, feature = "test-support"))]
  50use futures::channel::mpsc;
  51
  52pub use buffer::Operation;
  53pub use buffer::*;
  54pub use diagnostic_set::DiagnosticEntry;
  55pub use outline::{Outline, OutlineItem};
  56pub use tree_sitter::{Parser, Tree};
  57
  58thread_local! {
  59    static PARSER: RefCell<Parser> = RefCell::new(Parser::new());
  60}
  61
  62lazy_static! {
  63    pub static ref NEXT_GRAMMAR_ID: AtomicUsize = Default::default();
  64    pub static ref PLAIN_TEXT: Arc<Language> = Arc::new(Language::new(
  65        LanguageConfig {
  66            name: "Plain Text".into(),
  67            ..Default::default()
  68        },
  69        None,
  70    ));
  71}
  72
  73pub trait ToLspPosition {
  74    fn to_lsp_position(self) -> lsp::Position;
  75}
  76
  77#[derive(Clone, Debug, PartialEq, Eq, Hash)]
  78pub struct LanguageServerName(pub Arc<str>);
  79
  80/// Represents a Language Server, with certain cached sync properties.
  81/// Uses [`LspAdapter`] under the hood, but calls all 'static' methods
  82/// once at startup, and caches the results.
  83pub struct CachedLspAdapter {
  84    pub name: LanguageServerName,
  85    pub server_args: Vec<String>,
  86    pub initialization_options: Option<Value>,
  87    pub disk_based_diagnostic_sources: Vec<String>,
  88    pub disk_based_diagnostics_progress_token: Option<String>,
  89    pub language_ids: HashMap<String, String>,
  90    pub adapter: Arc<dyn LspAdapter>,
  91}
  92
  93impl CachedLspAdapter {
  94    pub async fn new(adapter: Arc<dyn LspAdapter>) -> Arc<Self> {
  95        let name = adapter.name().await;
  96        let server_args = adapter.server_args().await;
  97        let initialization_options = adapter.initialization_options().await;
  98        let disk_based_diagnostic_sources = adapter.disk_based_diagnostic_sources().await;
  99        let disk_based_diagnostics_progress_token =
 100            adapter.disk_based_diagnostics_progress_token().await;
 101        let language_ids = adapter.language_ids().await;
 102
 103        Arc::new(CachedLspAdapter {
 104            name,
 105            server_args,
 106            initialization_options,
 107            disk_based_diagnostic_sources,
 108            disk_based_diagnostics_progress_token,
 109            language_ids,
 110            adapter,
 111        })
 112    }
 113
 114    pub async fn fetch_latest_server_version(
 115        &self,
 116        http: Arc<dyn HttpClient>,
 117    ) -> Result<Box<dyn 'static + Send + Any>> {
 118        self.adapter.fetch_latest_server_version(http).await
 119    }
 120
 121    pub async fn fetch_server_binary(
 122        &self,
 123        version: Box<dyn 'static + Send + Any>,
 124        http: Arc<dyn HttpClient>,
 125        container_dir: PathBuf,
 126    ) -> Result<PathBuf> {
 127        self.adapter
 128            .fetch_server_binary(version, http, container_dir)
 129            .await
 130    }
 131
 132    pub async fn cached_server_binary(&self, container_dir: PathBuf) -> Option<PathBuf> {
 133        self.adapter.cached_server_binary(container_dir).await
 134    }
 135
 136    pub fn workspace_configuration(
 137        &self,
 138        cx: &mut MutableAppContext,
 139    ) -> Option<BoxFuture<'static, Value>> {
 140        self.adapter.workspace_configuration(cx)
 141    }
 142
 143    pub async fn process_diagnostics(&self, params: &mut lsp::PublishDiagnosticsParams) {
 144        self.adapter.process_diagnostics(params).await
 145    }
 146
 147    pub async fn process_completion(&self, completion_item: &mut lsp::CompletionItem) {
 148        self.adapter.process_completion(completion_item).await
 149    }
 150
 151    pub async fn label_for_completion(
 152        &self,
 153        completion_item: &lsp::CompletionItem,
 154        language: &Arc<Language>,
 155    ) -> Option<CodeLabel> {
 156        self.adapter
 157            .label_for_completion(completion_item, language)
 158            .await
 159    }
 160
 161    pub async fn label_for_symbol(
 162        &self,
 163        name: &str,
 164        kind: lsp::SymbolKind,
 165        language: &Arc<Language>,
 166    ) -> Option<CodeLabel> {
 167        self.adapter.label_for_symbol(name, kind, language).await
 168    }
 169}
 170
 171#[async_trait]
 172pub trait LspAdapter: 'static + Send + Sync {
 173    async fn name(&self) -> LanguageServerName;
 174
 175    async fn fetch_latest_server_version(
 176        &self,
 177        http: Arc<dyn HttpClient>,
 178    ) -> Result<Box<dyn 'static + Send + Any>>;
 179
 180    async fn fetch_server_binary(
 181        &self,
 182        version: Box<dyn 'static + Send + Any>,
 183        http: Arc<dyn HttpClient>,
 184        container_dir: PathBuf,
 185    ) -> Result<PathBuf>;
 186
 187    async fn cached_server_binary(&self, container_dir: PathBuf) -> Option<PathBuf>;
 188
 189    async fn process_diagnostics(&self, _: &mut lsp::PublishDiagnosticsParams) {}
 190
 191    async fn process_completion(&self, _: &mut lsp::CompletionItem) {}
 192
 193    async fn label_for_completion(
 194        &self,
 195        _: &lsp::CompletionItem,
 196        _: &Arc<Language>,
 197    ) -> Option<CodeLabel> {
 198        None
 199    }
 200
 201    async fn label_for_symbol(
 202        &self,
 203        _: &str,
 204        _: lsp::SymbolKind,
 205        _: &Arc<Language>,
 206    ) -> Option<CodeLabel> {
 207        None
 208    }
 209
 210    async fn server_args(&self) -> Vec<String> {
 211        Vec::new()
 212    }
 213
 214    async fn initialization_options(&self) -> Option<Value> {
 215        None
 216    }
 217
 218    fn workspace_configuration(
 219        &self,
 220        _: &mut MutableAppContext,
 221    ) -> Option<BoxFuture<'static, Value>> {
 222        None
 223    }
 224
 225    async fn disk_based_diagnostic_sources(&self) -> Vec<String> {
 226        Default::default()
 227    }
 228
 229    async fn disk_based_diagnostics_progress_token(&self) -> Option<String> {
 230        None
 231    }
 232
 233    async fn language_ids(&self) -> HashMap<String, String> {
 234        Default::default()
 235    }
 236}
 237
 238#[derive(Clone, Debug, PartialEq, Eq)]
 239pub struct CodeLabel {
 240    pub text: String,
 241    pub runs: Vec<(Range<usize>, HighlightId)>,
 242    pub filter_range: Range<usize>,
 243}
 244
 245#[derive(Clone, Deserialize)]
 246pub struct LanguageConfig {
 247    pub name: Arc<str>,
 248    pub path_suffixes: Vec<String>,
 249    pub brackets: BracketPairConfig,
 250    #[serde(default = "auto_indent_using_last_non_empty_line_default")]
 251    pub auto_indent_using_last_non_empty_line: bool,
 252    #[serde(default, deserialize_with = "deserialize_regex")]
 253    pub increase_indent_pattern: Option<Regex>,
 254    #[serde(default, deserialize_with = "deserialize_regex")]
 255    pub decrease_indent_pattern: Option<Regex>,
 256    #[serde(default)]
 257    pub autoclose_before: String,
 258    #[serde(default)]
 259    pub line_comment: Option<Arc<str>>,
 260    #[serde(default)]
 261    pub block_comment: Option<(Arc<str>, Arc<str>)>,
 262    #[serde(default)]
 263    pub overrides: HashMap<String, LanguageConfigOverride>,
 264}
 265
 266#[derive(Debug, Default)]
 267pub struct LanguageQueries {
 268    pub highlights: Option<Cow<'static, str>>,
 269    pub brackets: Option<Cow<'static, str>>,
 270    pub indents: Option<Cow<'static, str>>,
 271    pub outline: Option<Cow<'static, str>>,
 272    pub injections: Option<Cow<'static, str>>,
 273    pub overrides: Option<Cow<'static, str>>,
 274}
 275
 276#[derive(Clone, Debug)]
 277pub struct LanguageScope {
 278    language: Arc<Language>,
 279    override_id: Option<u32>,
 280}
 281
 282#[derive(Clone, Deserialize, Default, Debug)]
 283pub struct LanguageConfigOverride {
 284    #[serde(default)]
 285    pub line_comment: Override<Arc<str>>,
 286    #[serde(default)]
 287    pub block_comment: Override<(Arc<str>, Arc<str>)>,
 288    #[serde(skip_deserializing)]
 289    pub disabled_bracket_ixs: Vec<u16>,
 290}
 291
 292#[derive(Clone, Deserialize, Debug)]
 293#[serde(untagged)]
 294pub enum Override<T> {
 295    Remove { remove: bool },
 296    Set(T),
 297}
 298
 299impl<T> Default for Override<T> {
 300    fn default() -> Self {
 301        Override::Remove { remove: false }
 302    }
 303}
 304
 305impl<T> Override<T> {
 306    fn as_option<'a>(this: Option<&'a Self>, original: Option<&'a T>) -> Option<&'a T> {
 307        match this {
 308            Some(Self::Set(value)) => Some(value),
 309            Some(Self::Remove { remove: true }) => None,
 310            Some(Self::Remove { remove: false }) | None => original,
 311        }
 312    }
 313}
 314
 315impl Default for LanguageConfig {
 316    fn default() -> Self {
 317        Self {
 318            name: "".into(),
 319            path_suffixes: Default::default(),
 320            brackets: Default::default(),
 321            auto_indent_using_last_non_empty_line: auto_indent_using_last_non_empty_line_default(),
 322            increase_indent_pattern: Default::default(),
 323            decrease_indent_pattern: Default::default(),
 324            autoclose_before: Default::default(),
 325            line_comment: Default::default(),
 326            block_comment: Default::default(),
 327            overrides: Default::default(),
 328        }
 329    }
 330}
 331
 332fn auto_indent_using_last_non_empty_line_default() -> bool {
 333    true
 334}
 335
 336fn deserialize_regex<'de, D: Deserializer<'de>>(d: D) -> Result<Option<Regex>, D::Error> {
 337    let source = Option::<String>::deserialize(d)?;
 338    if let Some(source) = source {
 339        Ok(Some(regex::Regex::new(&source).map_err(de::Error::custom)?))
 340    } else {
 341        Ok(None)
 342    }
 343}
 344
 345#[cfg(any(test, feature = "test-support"))]
 346pub struct FakeLspAdapter {
 347    pub name: &'static str,
 348    pub capabilities: lsp::ServerCapabilities,
 349    pub initializer: Option<Box<dyn 'static + Send + Sync + Fn(&mut lsp::FakeLanguageServer)>>,
 350    pub disk_based_diagnostics_progress_token: Option<String>,
 351    pub disk_based_diagnostics_sources: Vec<String>,
 352}
 353
 354#[derive(Clone, Debug, Default)]
 355pub struct BracketPairConfig {
 356    pub pairs: Vec<BracketPair>,
 357    pub disabled_scopes_by_bracket_ix: Vec<Vec<String>>,
 358}
 359
 360impl<'de> Deserialize<'de> for BracketPairConfig {
 361    fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
 362    where
 363        D: Deserializer<'de>,
 364    {
 365        #[derive(Deserialize)]
 366        pub struct Entry {
 367            #[serde(flatten)]
 368            pub bracket_pair: BracketPair,
 369            #[serde(default)]
 370            pub not_in: Vec<String>,
 371        }
 372
 373        let result = Vec::<Entry>::deserialize(deserializer)?;
 374        let mut brackets = Vec::with_capacity(result.len());
 375        let mut disabled_scopes_by_bracket_ix = Vec::with_capacity(result.len());
 376        for entry in result {
 377            brackets.push(entry.bracket_pair);
 378            disabled_scopes_by_bracket_ix.push(entry.not_in);
 379        }
 380
 381        Ok(BracketPairConfig {
 382            pairs: brackets,
 383            disabled_scopes_by_bracket_ix,
 384        })
 385    }
 386}
 387
 388#[derive(Clone, Debug, Default, Deserialize, PartialEq)]
 389pub struct BracketPair {
 390    pub start: String,
 391    pub end: String,
 392    pub close: bool,
 393    pub newline: bool,
 394}
 395
 396pub struct Language {
 397    pub(crate) config: LanguageConfig,
 398    pub(crate) grammar: Option<Arc<Grammar>>,
 399    pub(crate) adapter: Option<Arc<CachedLspAdapter>>,
 400
 401    #[cfg(any(test, feature = "test-support"))]
 402    fake_adapter: Option<(
 403        mpsc::UnboundedSender<lsp::FakeLanguageServer>,
 404        Arc<FakeLspAdapter>,
 405    )>,
 406}
 407
 408pub struct Grammar {
 409    id: usize,
 410    pub(crate) ts_language: tree_sitter::Language,
 411    pub(crate) error_query: Query,
 412    pub(crate) highlights_query: Option<Query>,
 413    pub(crate) brackets_config: Option<BracketConfig>,
 414    pub(crate) indents_config: Option<IndentConfig>,
 415    pub(crate) outline_config: Option<OutlineConfig>,
 416    pub(crate) injection_config: Option<InjectionConfig>,
 417    pub(crate) override_config: Option<OverrideConfig>,
 418    pub(crate) highlight_map: Mutex<HighlightMap>,
 419}
 420
 421struct IndentConfig {
 422    query: Query,
 423    indent_capture_ix: u32,
 424    start_capture_ix: Option<u32>,
 425    end_capture_ix: Option<u32>,
 426    outdent_capture_ix: Option<u32>,
 427}
 428
 429struct OutlineConfig {
 430    query: Query,
 431    item_capture_ix: u32,
 432    name_capture_ix: u32,
 433    context_capture_ix: Option<u32>,
 434}
 435
 436struct InjectionConfig {
 437    query: Query,
 438    content_capture_ix: u32,
 439    language_capture_ix: Option<u32>,
 440    patterns: Vec<InjectionPatternConfig>,
 441}
 442
 443struct OverrideConfig {
 444    query: Query,
 445    values: HashMap<u32, (String, LanguageConfigOverride)>,
 446}
 447
 448#[derive(Default, Clone)]
 449struct InjectionPatternConfig {
 450    language: Option<Box<str>>,
 451    combined: bool,
 452}
 453
 454struct BracketConfig {
 455    query: Query,
 456    open_capture_ix: u32,
 457    close_capture_ix: u32,
 458}
 459
 460#[derive(Clone)]
 461pub enum LanguageServerBinaryStatus {
 462    CheckingForUpdate,
 463    Downloading,
 464    Downloaded,
 465    Cached,
 466    Failed { error: String },
 467}
 468
 469type AvailableLanguageId = usize;
 470
 471#[derive(Clone)]
 472struct AvailableLanguage {
 473    id: AvailableLanguageId,
 474    path: &'static str,
 475    config: LanguageConfig,
 476    grammar: tree_sitter::Language,
 477    lsp_adapter: Option<Arc<dyn LspAdapter>>,
 478    get_queries: fn(&str) -> LanguageQueries,
 479}
 480
 481pub struct LanguageRegistry {
 482    state: RwLock<LanguageRegistryState>,
 483    language_server_download_dir: Option<Arc<Path>>,
 484    lsp_binary_statuses_tx: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
 485    lsp_binary_statuses_rx: async_broadcast::Receiver<(Arc<Language>, LanguageServerBinaryStatus)>,
 486    login_shell_env_loaded: Shared<Task<()>>,
 487    #[allow(clippy::type_complexity)]
 488    lsp_binary_paths: Mutex<
 489        HashMap<
 490            LanguageServerName,
 491            Shared<BoxFuture<'static, Result<PathBuf, Arc<anyhow::Error>>>>,
 492        >,
 493    >,
 494    executor: Option<Arc<Background>>,
 495}
 496
 497struct LanguageRegistryState {
 498    languages: Vec<Arc<Language>>,
 499    available_languages: Vec<AvailableLanguage>,
 500    next_available_language_id: AvailableLanguageId,
 501    loading_languages: HashMap<AvailableLanguageId, Vec<oneshot::Sender<Result<Arc<Language>>>>>,
 502    subscription: (watch::Sender<()>, watch::Receiver<()>),
 503    theme: Option<Arc<Theme>>,
 504    version: usize,
 505}
 506
 507impl LanguageRegistry {
 508    pub fn new(login_shell_env_loaded: Task<()>) -> Self {
 509        let (lsp_binary_statuses_tx, lsp_binary_statuses_rx) = async_broadcast::broadcast(16);
 510        Self {
 511            state: RwLock::new(LanguageRegistryState {
 512                languages: vec![PLAIN_TEXT.clone()],
 513                available_languages: Default::default(),
 514                next_available_language_id: 0,
 515                loading_languages: Default::default(),
 516                subscription: watch::channel(),
 517                theme: Default::default(),
 518                version: 0,
 519            }),
 520            language_server_download_dir: None,
 521            lsp_binary_statuses_tx,
 522            lsp_binary_statuses_rx,
 523            login_shell_env_loaded: login_shell_env_loaded.shared(),
 524            lsp_binary_paths: Default::default(),
 525            executor: None,
 526        }
 527    }
 528
 529    #[cfg(any(test, feature = "test-support"))]
 530    pub fn test() -> Self {
 531        Self::new(Task::ready(()))
 532    }
 533
 534    pub fn set_executor(&mut self, executor: Arc<Background>) {
 535        self.executor = Some(executor);
 536    }
 537
 538    pub fn register(
 539        &self,
 540        path: &'static str,
 541        config: LanguageConfig,
 542        grammar: tree_sitter::Language,
 543        lsp_adapter: Option<Arc<dyn LspAdapter>>,
 544        get_queries: fn(&str) -> LanguageQueries,
 545    ) {
 546        let state = &mut *self.state.write();
 547        state.available_languages.push(AvailableLanguage {
 548            id: post_inc(&mut state.next_available_language_id),
 549            path,
 550            config,
 551            grammar,
 552            lsp_adapter,
 553            get_queries,
 554        });
 555    }
 556
 557    pub fn language_names(&self) -> Vec<String> {
 558        let state = self.state.read();
 559        let mut result = state
 560            .available_languages
 561            .iter()
 562            .map(|l| l.config.name.to_string())
 563            .chain(state.languages.iter().map(|l| l.config.name.to_string()))
 564            .collect::<Vec<_>>();
 565        result.sort_unstable_by_key(|language_name| language_name.to_lowercase());
 566        result
 567    }
 568
 569    pub fn workspace_configuration(&self, cx: &mut MutableAppContext) -> Task<serde_json::Value> {
 570        let lsp_adapters = {
 571            let state = self.state.read();
 572            state
 573                .available_languages
 574                .iter()
 575                .filter_map(|l| l.lsp_adapter.clone())
 576                .chain(
 577                    state
 578                        .languages
 579                        .iter()
 580                        .filter_map(|l| l.adapter.as_ref().map(|a| a.adapter.clone())),
 581                )
 582                .collect::<Vec<_>>()
 583        };
 584
 585        let mut language_configs = Vec::new();
 586        for adapter in &lsp_adapters {
 587            if let Some(language_config) = adapter.workspace_configuration(cx) {
 588                language_configs.push(language_config);
 589            }
 590        }
 591
 592        cx.background().spawn(async move {
 593            let mut config = serde_json::json!({});
 594            let language_configs = futures::future::join_all(language_configs).await;
 595            for language_config in language_configs {
 596                merge_json_value_into(language_config, &mut config);
 597            }
 598            config
 599        })
 600    }
 601
 602    pub fn add(&self, language: Arc<Language>) {
 603        self.state.write().add(language);
 604    }
 605
 606    pub fn subscribe(&self) -> watch::Receiver<()> {
 607        self.state.read().subscription.1.clone()
 608    }
 609
 610    pub fn version(&self) -> usize {
 611        self.state.read().version
 612    }
 613
 614    pub fn set_theme(&self, theme: Arc<Theme>) {
 615        let mut state = self.state.write();
 616        state.theme = Some(theme.clone());
 617        for language in &state.languages {
 618            language.set_theme(&theme.editor.syntax);
 619        }
 620    }
 621
 622    pub fn set_language_server_download_dir(&mut self, path: impl Into<Arc<Path>>) {
 623        self.language_server_download_dir = Some(path.into());
 624    }
 625
 626    pub fn language_for_name(
 627        self: &Arc<Self>,
 628        name: &str,
 629    ) -> UnwrapFuture<oneshot::Receiver<Result<Arc<Language>>>> {
 630        let name = UniCase::new(name);
 631        self.get_or_load_language(|config| UniCase::new(config.name.as_ref()) == name)
 632    }
 633
 634    pub fn language_for_name_or_extension(
 635        self: &Arc<Self>,
 636        string: &str,
 637    ) -> UnwrapFuture<oneshot::Receiver<Result<Arc<Language>>>> {
 638        let string = UniCase::new(string);
 639        self.get_or_load_language(|config| {
 640            UniCase::new(config.name.as_ref()) == string
 641                || config
 642                    .path_suffixes
 643                    .iter()
 644                    .any(|suffix| UniCase::new(suffix) == string)
 645        })
 646    }
 647
 648    pub fn language_for_path(
 649        self: &Arc<Self>,
 650        path: impl AsRef<Path>,
 651    ) -> UnwrapFuture<oneshot::Receiver<Result<Arc<Language>>>> {
 652        let path = path.as_ref();
 653        let filename = path.file_name().and_then(|name| name.to_str());
 654        let extension = path.extension().and_then(|name| name.to_str());
 655        let path_suffixes = [extension, filename];
 656        self.get_or_load_language(|config| {
 657            config
 658                .path_suffixes
 659                .iter()
 660                .any(|suffix| path_suffixes.contains(&Some(suffix.as_str())))
 661        })
 662    }
 663
 664    fn get_or_load_language(
 665        self: &Arc<Self>,
 666        callback: impl Fn(&LanguageConfig) -> bool,
 667    ) -> UnwrapFuture<oneshot::Receiver<Result<Arc<Language>>>> {
 668        let (tx, rx) = oneshot::channel();
 669
 670        let mut state = self.state.write();
 671        if let Some(language) = state
 672            .languages
 673            .iter()
 674            .find(|language| callback(&language.config))
 675        {
 676            let _ = tx.send(Ok(language.clone()));
 677        } else if let Some(executor) = self.executor.clone() {
 678            if let Some(language) = state
 679                .available_languages
 680                .iter()
 681                .find(|l| callback(&l.config))
 682                .cloned()
 683            {
 684                let txs = state
 685                    .loading_languages
 686                    .entry(language.id)
 687                    .or_insert_with(|| {
 688                        let this = self.clone();
 689                        executor
 690                            .spawn(async move {
 691                                let id = language.id;
 692                                let queries = (language.get_queries)(&language.path);
 693                                let language =
 694                                    Language::new(language.config, Some(language.grammar))
 695                                        .with_lsp_adapter(language.lsp_adapter)
 696                                        .await;
 697                                let name = language.name();
 698                                match language.with_queries(queries) {
 699                                    Ok(language) => {
 700                                        let language = Arc::new(language);
 701                                        let mut state = this.state.write();
 702                                        state.add(language.clone());
 703                                        state
 704                                            .available_languages
 705                                            .retain(|language| language.id != id);
 706                                        if let Some(mut txs) = state.loading_languages.remove(&id) {
 707                                            for tx in txs.drain(..) {
 708                                                let _ = tx.send(Ok(language.clone()));
 709                                            }
 710                                        }
 711                                    }
 712                                    Err(err) => {
 713                                        let mut state = this.state.write();
 714                                        state
 715                                            .available_languages
 716                                            .retain(|language| language.id != id);
 717                                        if let Some(mut txs) = state.loading_languages.remove(&id) {
 718                                            for tx in txs.drain(..) {
 719                                                let _ = tx.send(Err(anyhow!(
 720                                                    "failed to load language {}: {}",
 721                                                    name,
 722                                                    err
 723                                                )));
 724                                            }
 725                                        }
 726                                    }
 727                                };
 728                            })
 729                            .detach();
 730
 731                        Vec::new()
 732                    });
 733                txs.push(tx);
 734            } else {
 735                let _ = tx.send(Err(anyhow!("language not found")));
 736            }
 737        } else {
 738            let _ = tx.send(Err(anyhow!("executor does not exist")));
 739        }
 740
 741        rx.unwrap()
 742    }
 743
 744    pub fn to_vec(&self) -> Vec<Arc<Language>> {
 745        self.state.read().languages.iter().cloned().collect()
 746    }
 747
 748    pub fn start_language_server(
 749        self: &Arc<Self>,
 750        server_id: usize,
 751        language: Arc<Language>,
 752        root_path: Arc<Path>,
 753        http_client: Arc<dyn HttpClient>,
 754        cx: &mut MutableAppContext,
 755    ) -> Option<Task<Result<lsp::LanguageServer>>> {
 756        #[cfg(any(test, feature = "test-support"))]
 757        if language.fake_adapter.is_some() {
 758            let language = language;
 759            return Some(cx.spawn(|cx| async move {
 760                let (servers_tx, fake_adapter) = language.fake_adapter.as_ref().unwrap();
 761                let (server, mut fake_server) = lsp::LanguageServer::fake(
 762                    fake_adapter.name.to_string(),
 763                    fake_adapter.capabilities.clone(),
 764                    cx.clone(),
 765                );
 766
 767                if let Some(initializer) = &fake_adapter.initializer {
 768                    initializer(&mut fake_server);
 769                }
 770
 771                let servers_tx = servers_tx.clone();
 772                cx.background()
 773                    .spawn(async move {
 774                        if fake_server
 775                            .try_receive_notification::<lsp::notification::Initialized>()
 776                            .await
 777                            .is_some()
 778                        {
 779                            servers_tx.unbounded_send(fake_server).ok();
 780                        }
 781                    })
 782                    .detach();
 783                Ok(server)
 784            }));
 785        }
 786
 787        let download_dir = self
 788            .language_server_download_dir
 789            .clone()
 790            .ok_or_else(|| anyhow!("language server download directory has not been assigned"))
 791            .log_err()?;
 792
 793        let this = self.clone();
 794        let adapter = language.adapter.clone()?;
 795        let lsp_binary_statuses = self.lsp_binary_statuses_tx.clone();
 796        let login_shell_env_loaded = self.login_shell_env_loaded.clone();
 797        Some(cx.spawn(|cx| async move {
 798            login_shell_env_loaded.await;
 799            let server_binary_path = this
 800                .lsp_binary_paths
 801                .lock()
 802                .entry(adapter.name.clone())
 803                .or_insert_with(|| {
 804                    get_server_binary_path(
 805                        adapter.clone(),
 806                        language.clone(),
 807                        http_client,
 808                        download_dir,
 809                        lsp_binary_statuses,
 810                    )
 811                    .map_err(Arc::new)
 812                    .boxed()
 813                    .shared()
 814                })
 815                .clone()
 816                .map_err(|e| anyhow!(e));
 817
 818            let server_binary_path = server_binary_path.await?;
 819            let server_args = &adapter.server_args;
 820            let server = lsp::LanguageServer::new(
 821                server_id,
 822                &server_binary_path,
 823                server_args,
 824                &root_path,
 825                cx,
 826            )?;
 827            Ok(server)
 828        }))
 829    }
 830
 831    pub fn language_server_binary_statuses(
 832        &self,
 833    ) -> async_broadcast::Receiver<(Arc<Language>, LanguageServerBinaryStatus)> {
 834        self.lsp_binary_statuses_rx.clone()
 835    }
 836}
 837
 838impl LanguageRegistryState {
 839    fn add(&mut self, language: Arc<Language>) {
 840        if let Some(theme) = self.theme.as_ref() {
 841            language.set_theme(&theme.editor.syntax);
 842        }
 843        self.languages.push(language);
 844        self.version += 1;
 845        *self.subscription.0.borrow_mut() = ();
 846    }
 847}
 848
 849#[cfg(any(test, feature = "test-support"))]
 850impl Default for LanguageRegistry {
 851    fn default() -> Self {
 852        Self::test()
 853    }
 854}
 855
 856async fn get_server_binary_path(
 857    adapter: Arc<CachedLspAdapter>,
 858    language: Arc<Language>,
 859    http_client: Arc<dyn HttpClient>,
 860    download_dir: Arc<Path>,
 861    statuses: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
 862) -> Result<PathBuf> {
 863    let container_dir = download_dir.join(adapter.name.0.as_ref());
 864    if !container_dir.exists() {
 865        smol::fs::create_dir_all(&container_dir)
 866            .await
 867            .context("failed to create container directory")?;
 868    }
 869
 870    let path = fetch_latest_server_binary_path(
 871        adapter.clone(),
 872        language.clone(),
 873        http_client,
 874        &container_dir,
 875        statuses.clone(),
 876    )
 877    .await;
 878    if let Err(error) = path.as_ref() {
 879        if let Some(cached_path) = adapter.cached_server_binary(container_dir).await {
 880            statuses
 881                .broadcast((language.clone(), LanguageServerBinaryStatus::Cached))
 882                .await?;
 883            return Ok(cached_path);
 884        } else {
 885            statuses
 886                .broadcast((
 887                    language.clone(),
 888                    LanguageServerBinaryStatus::Failed {
 889                        error: format!("{:?}", error),
 890                    },
 891                ))
 892                .await?;
 893        }
 894    }
 895    path
 896}
 897
 898async fn fetch_latest_server_binary_path(
 899    adapter: Arc<CachedLspAdapter>,
 900    language: Arc<Language>,
 901    http_client: Arc<dyn HttpClient>,
 902    container_dir: &Path,
 903    lsp_binary_statuses_tx: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
 904) -> Result<PathBuf> {
 905    let container_dir: Arc<Path> = container_dir.into();
 906    lsp_binary_statuses_tx
 907        .broadcast((
 908            language.clone(),
 909            LanguageServerBinaryStatus::CheckingForUpdate,
 910        ))
 911        .await?;
 912    let version_info = adapter
 913        .fetch_latest_server_version(http_client.clone())
 914        .await?;
 915    lsp_binary_statuses_tx
 916        .broadcast((language.clone(), LanguageServerBinaryStatus::Downloading))
 917        .await?;
 918    let path = adapter
 919        .fetch_server_binary(version_info, http_client, container_dir.to_path_buf())
 920        .await?;
 921    lsp_binary_statuses_tx
 922        .broadcast((language.clone(), LanguageServerBinaryStatus::Downloaded))
 923        .await?;
 924    Ok(path)
 925}
 926
 927impl Language {
 928    pub fn new(config: LanguageConfig, ts_language: Option<tree_sitter::Language>) -> Self {
 929        Self {
 930            config,
 931            grammar: ts_language.map(|ts_language| {
 932                Arc::new(Grammar {
 933                    id: NEXT_GRAMMAR_ID.fetch_add(1, SeqCst),
 934                    highlights_query: None,
 935                    brackets_config: None,
 936                    outline_config: None,
 937                    indents_config: None,
 938                    injection_config: None,
 939                    override_config: None,
 940                    error_query: Query::new(ts_language, "(ERROR) @error").unwrap(),
 941                    ts_language,
 942                    highlight_map: Default::default(),
 943                })
 944            }),
 945            adapter: None,
 946
 947            #[cfg(any(test, feature = "test-support"))]
 948            fake_adapter: None,
 949        }
 950    }
 951
 952    pub fn lsp_adapter(&self) -> Option<Arc<CachedLspAdapter>> {
 953        self.adapter.clone()
 954    }
 955
 956    pub fn id(&self) -> Option<usize> {
 957        self.grammar.as_ref().map(|g| g.id)
 958    }
 959
 960    pub fn with_queries(mut self, queries: LanguageQueries) -> Result<Self> {
 961        if let Some(query) = queries.highlights {
 962            self = self
 963                .with_highlights_query(query.as_ref())
 964                .expect("failed to evaluate highlights query");
 965        }
 966        if let Some(query) = queries.brackets {
 967            self = self
 968                .with_brackets_query(query.as_ref())
 969                .expect("failed to load brackets query");
 970        }
 971        if let Some(query) = queries.indents {
 972            self = self
 973                .with_indents_query(query.as_ref())
 974                .expect("failed to load indents query");
 975        }
 976        if let Some(query) = queries.outline {
 977            self = self
 978                .with_outline_query(query.as_ref())
 979                .expect("failed to load outline query");
 980        }
 981        if let Some(query) = queries.injections {
 982            self = self
 983                .with_injection_query(query.as_ref())
 984                .expect("failed to load injection query");
 985        }
 986        if let Some(query) = queries.overrides {
 987            self = self
 988                .with_override_query(query.as_ref())
 989                .expect("failed to load override query");
 990        }
 991        Ok(self)
 992    }
 993    pub fn with_highlights_query(mut self, source: &str) -> Result<Self> {
 994        let grammar = self.grammar_mut();
 995        grammar.highlights_query = Some(Query::new(grammar.ts_language, source)?);
 996        Ok(self)
 997    }
 998
 999    pub fn with_outline_query(mut self, source: &str) -> Result<Self> {
1000        let grammar = self.grammar_mut();
1001        let query = Query::new(grammar.ts_language, source)?;
1002        let mut item_capture_ix = None;
1003        let mut name_capture_ix = None;
1004        let mut context_capture_ix = None;
1005        get_capture_indices(
1006            &query,
1007            &mut [
1008                ("item", &mut item_capture_ix),
1009                ("name", &mut name_capture_ix),
1010                ("context", &mut context_capture_ix),
1011            ],
1012        );
1013        if let Some((item_capture_ix, name_capture_ix)) = item_capture_ix.zip(name_capture_ix) {
1014            grammar.outline_config = Some(OutlineConfig {
1015                query,
1016                item_capture_ix,
1017                name_capture_ix,
1018                context_capture_ix,
1019            });
1020        }
1021        Ok(self)
1022    }
1023
1024    pub fn with_brackets_query(mut self, source: &str) -> Result<Self> {
1025        let grammar = self.grammar_mut();
1026        let query = Query::new(grammar.ts_language, source)?;
1027        let mut open_capture_ix = None;
1028        let mut close_capture_ix = None;
1029        get_capture_indices(
1030            &query,
1031            &mut [
1032                ("open", &mut open_capture_ix),
1033                ("close", &mut close_capture_ix),
1034            ],
1035        );
1036        if let Some((open_capture_ix, close_capture_ix)) = open_capture_ix.zip(close_capture_ix) {
1037            grammar.brackets_config = Some(BracketConfig {
1038                query,
1039                open_capture_ix,
1040                close_capture_ix,
1041            });
1042        }
1043        Ok(self)
1044    }
1045
1046    pub fn with_indents_query(mut self, source: &str) -> Result<Self> {
1047        let grammar = self.grammar_mut();
1048        let query = Query::new(grammar.ts_language, source)?;
1049        let mut indent_capture_ix = None;
1050        let mut start_capture_ix = None;
1051        let mut end_capture_ix = None;
1052        let mut outdent_capture_ix = None;
1053        get_capture_indices(
1054            &query,
1055            &mut [
1056                ("indent", &mut indent_capture_ix),
1057                ("start", &mut start_capture_ix),
1058                ("end", &mut end_capture_ix),
1059                ("outdent", &mut outdent_capture_ix),
1060            ],
1061        );
1062        if let Some(indent_capture_ix) = indent_capture_ix {
1063            grammar.indents_config = Some(IndentConfig {
1064                query,
1065                indent_capture_ix,
1066                start_capture_ix,
1067                end_capture_ix,
1068                outdent_capture_ix,
1069            });
1070        }
1071        Ok(self)
1072    }
1073
1074    pub fn with_injection_query(mut self, source: &str) -> Result<Self> {
1075        let grammar = self.grammar_mut();
1076        let query = Query::new(grammar.ts_language, source)?;
1077        let mut language_capture_ix = None;
1078        let mut content_capture_ix = None;
1079        get_capture_indices(
1080            &query,
1081            &mut [
1082                ("language", &mut language_capture_ix),
1083                ("content", &mut content_capture_ix),
1084            ],
1085        );
1086        let patterns = (0..query.pattern_count())
1087            .map(|ix| {
1088                let mut config = InjectionPatternConfig::default();
1089                for setting in query.property_settings(ix) {
1090                    match setting.key.as_ref() {
1091                        "language" => {
1092                            config.language = setting.value.clone();
1093                        }
1094                        "combined" => {
1095                            config.combined = true;
1096                        }
1097                        _ => {}
1098                    }
1099                }
1100                config
1101            })
1102            .collect();
1103        if let Some(content_capture_ix) = content_capture_ix {
1104            grammar.injection_config = Some(InjectionConfig {
1105                query,
1106                language_capture_ix,
1107                content_capture_ix,
1108                patterns,
1109            });
1110        }
1111        Ok(self)
1112    }
1113
1114    pub fn with_override_query(mut self, source: &str) -> Result<Self> {
1115        let query = Query::new(self.grammar_mut().ts_language, source)?;
1116
1117        let mut override_configs_by_id = HashMap::default();
1118        for (ix, name) in query.capture_names().iter().enumerate() {
1119            if !name.starts_with('_') {
1120                let value = self.config.overrides.remove(name).unwrap_or_default();
1121                override_configs_by_id.insert(ix as u32, (name.clone(), value));
1122            }
1123        }
1124
1125        if !self.config.overrides.is_empty() {
1126            let keys = self.config.overrides.keys().collect::<Vec<_>>();
1127            Err(anyhow!(
1128                "language {:?} has overrides in config not in query: {keys:?}",
1129                self.config.name
1130            ))?;
1131        }
1132
1133        for disabled_scope_name in self
1134            .config
1135            .brackets
1136            .disabled_scopes_by_bracket_ix
1137            .iter()
1138            .flatten()
1139        {
1140            if !override_configs_by_id
1141                .values()
1142                .any(|(scope_name, _)| scope_name == disabled_scope_name)
1143            {
1144                Err(anyhow!(
1145                    "language {:?} has overrides in config not in query: {disabled_scope_name:?}",
1146                    self.config.name
1147                ))?;
1148            }
1149        }
1150
1151        for (name, override_config) in override_configs_by_id.values_mut() {
1152            override_config.disabled_bracket_ixs = self
1153                .config
1154                .brackets
1155                .disabled_scopes_by_bracket_ix
1156                .iter()
1157                .enumerate()
1158                .filter_map(|(ix, disabled_scope_names)| {
1159                    if disabled_scope_names.contains(name) {
1160                        Some(ix as u16)
1161                    } else {
1162                        None
1163                    }
1164                })
1165                .collect();
1166        }
1167
1168        self.config.brackets.disabled_scopes_by_bracket_ix.clear();
1169        self.grammar_mut().override_config = Some(OverrideConfig {
1170            query,
1171            values: override_configs_by_id,
1172        });
1173        Ok(self)
1174    }
1175
1176    fn grammar_mut(&mut self) -> &mut Grammar {
1177        Arc::get_mut(self.grammar.as_mut().unwrap()).unwrap()
1178    }
1179
1180    pub async fn with_lsp_adapter(mut self, lsp_adapter: Option<Arc<dyn LspAdapter>>) -> Self {
1181        if let Some(adapter) = lsp_adapter {
1182            self.adapter = Some(CachedLspAdapter::new(adapter).await);
1183        }
1184        self
1185    }
1186
1187    #[cfg(any(test, feature = "test-support"))]
1188    pub async fn set_fake_lsp_adapter(
1189        &mut self,
1190        fake_lsp_adapter: Arc<FakeLspAdapter>,
1191    ) -> mpsc::UnboundedReceiver<lsp::FakeLanguageServer> {
1192        let (servers_tx, servers_rx) = mpsc::unbounded();
1193        self.fake_adapter = Some((servers_tx, fake_lsp_adapter.clone()));
1194        let adapter = CachedLspAdapter::new(Arc::new(fake_lsp_adapter)).await;
1195        self.adapter = Some(adapter);
1196        servers_rx
1197    }
1198
1199    pub fn name(&self) -> Arc<str> {
1200        self.config.name.clone()
1201    }
1202
1203    pub async fn disk_based_diagnostic_sources(&self) -> &[String] {
1204        match self.adapter.as_ref() {
1205            Some(adapter) => &adapter.disk_based_diagnostic_sources,
1206            None => &[],
1207        }
1208    }
1209
1210    pub async fn disk_based_diagnostics_progress_token(&self) -> Option<&str> {
1211        if let Some(adapter) = self.adapter.as_ref() {
1212            adapter.disk_based_diagnostics_progress_token.as_deref()
1213        } else {
1214            None
1215        }
1216    }
1217
1218    pub async fn process_diagnostics(&self, diagnostics: &mut lsp::PublishDiagnosticsParams) {
1219        if let Some(processor) = self.adapter.as_ref() {
1220            processor.process_diagnostics(diagnostics).await;
1221        }
1222    }
1223
1224    pub async fn process_completion(self: &Arc<Self>, completion: &mut lsp::CompletionItem) {
1225        if let Some(adapter) = self.adapter.as_ref() {
1226            adapter.process_completion(completion).await;
1227        }
1228    }
1229
1230    pub async fn label_for_completion(
1231        self: &Arc<Self>,
1232        completion: &lsp::CompletionItem,
1233    ) -> Option<CodeLabel> {
1234        self.adapter
1235            .as_ref()?
1236            .label_for_completion(completion, self)
1237            .await
1238    }
1239
1240    pub async fn label_for_symbol(
1241        self: &Arc<Self>,
1242        name: &str,
1243        kind: lsp::SymbolKind,
1244    ) -> Option<CodeLabel> {
1245        self.adapter
1246            .as_ref()?
1247            .label_for_symbol(name, kind, self)
1248            .await
1249    }
1250
1251    pub fn highlight_text<'a>(
1252        self: &'a Arc<Self>,
1253        text: &'a Rope,
1254        range: Range<usize>,
1255    ) -> Vec<(Range<usize>, HighlightId)> {
1256        let mut result = Vec::new();
1257        if let Some(grammar) = &self.grammar {
1258            let tree = grammar.parse_text(text, None);
1259            let captures =
1260                SyntaxSnapshot::single_tree_captures(range.clone(), text, &tree, self, |grammar| {
1261                    grammar.highlights_query.as_ref()
1262                });
1263            let highlight_maps = vec![grammar.highlight_map()];
1264            let mut offset = 0;
1265            for chunk in BufferChunks::new(text, range, Some((captures, highlight_maps)), vec![]) {
1266                let end_offset = offset + chunk.text.len();
1267                if let Some(highlight_id) = chunk.syntax_highlight_id {
1268                    if !highlight_id.is_default() {
1269                        result.push((offset..end_offset, highlight_id));
1270                    }
1271                }
1272                offset = end_offset;
1273            }
1274        }
1275        result
1276    }
1277
1278    pub fn path_suffixes(&self) -> &[String] {
1279        &self.config.path_suffixes
1280    }
1281
1282    pub fn should_autoclose_before(&self, c: char) -> bool {
1283        c.is_whitespace() || self.config.autoclose_before.contains(c)
1284    }
1285
1286    pub fn set_theme(&self, theme: &SyntaxTheme) {
1287        if let Some(grammar) = self.grammar.as_ref() {
1288            if let Some(highlights_query) = &grammar.highlights_query {
1289                *grammar.highlight_map.lock() =
1290                    HighlightMap::new(highlights_query.capture_names(), theme);
1291            }
1292        }
1293    }
1294
1295    pub fn grammar(&self) -> Option<&Arc<Grammar>> {
1296        self.grammar.as_ref()
1297    }
1298}
1299
1300impl LanguageScope {
1301    pub fn line_comment_prefix(&self) -> Option<&Arc<str>> {
1302        Override::as_option(
1303            self.config_override().map(|o| &o.line_comment),
1304            self.language.config.line_comment.as_ref(),
1305        )
1306    }
1307
1308    pub fn block_comment_delimiters(&self) -> Option<(&Arc<str>, &Arc<str>)> {
1309        Override::as_option(
1310            self.config_override().map(|o| &o.block_comment),
1311            self.language.config.block_comment.as_ref(),
1312        )
1313        .map(|e| (&e.0, &e.1))
1314    }
1315
1316    pub fn brackets(&self) -> impl Iterator<Item = (&BracketPair, bool)> {
1317        let mut disabled_ids = self
1318            .config_override()
1319            .map_or(&[] as _, |o| o.disabled_bracket_ixs.as_slice());
1320        self.language
1321            .config
1322            .brackets
1323            .pairs
1324            .iter()
1325            .enumerate()
1326            .map(move |(ix, bracket)| {
1327                let mut is_enabled = true;
1328                if let Some(next_disabled_ix) = disabled_ids.first() {
1329                    if ix == *next_disabled_ix as usize {
1330                        disabled_ids = &disabled_ids[1..];
1331                        is_enabled = false;
1332                    }
1333                }
1334                (bracket, is_enabled)
1335            })
1336    }
1337
1338    pub fn should_autoclose_before(&self, c: char) -> bool {
1339        c.is_whitespace() || self.language.config.autoclose_before.contains(c)
1340    }
1341
1342    fn config_override(&self) -> Option<&LanguageConfigOverride> {
1343        let id = self.override_id?;
1344        let grammar = self.language.grammar.as_ref()?;
1345        let override_config = grammar.override_config.as_ref()?;
1346        override_config.values.get(&id).map(|e| &e.1)
1347    }
1348}
1349
1350impl Hash for Language {
1351    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
1352        self.id().hash(state)
1353    }
1354}
1355
1356impl PartialEq for Language {
1357    fn eq(&self, other: &Self) -> bool {
1358        self.id().eq(&other.id())
1359    }
1360}
1361
1362impl Eq for Language {}
1363
1364impl Debug for Language {
1365    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1366        f.debug_struct("Language")
1367            .field("name", &self.config.name)
1368            .finish()
1369    }
1370}
1371
1372impl Grammar {
1373    pub fn id(&self) -> usize {
1374        self.id
1375    }
1376
1377    fn parse_text(&self, text: &Rope, old_tree: Option<Tree>) -> Tree {
1378        PARSER.with(|parser| {
1379            let mut parser = parser.borrow_mut();
1380            parser
1381                .set_language(self.ts_language)
1382                .expect("incompatible grammar");
1383            let mut chunks = text.chunks_in_range(0..text.len());
1384            parser
1385                .parse_with(
1386                    &mut move |offset, _| {
1387                        chunks.seek(offset);
1388                        chunks.next().unwrap_or("").as_bytes()
1389                    },
1390                    old_tree.as_ref(),
1391                )
1392                .unwrap()
1393        })
1394    }
1395
1396    pub fn highlight_map(&self) -> HighlightMap {
1397        self.highlight_map.lock().clone()
1398    }
1399
1400    pub fn highlight_id_for_name(&self, name: &str) -> Option<HighlightId> {
1401        let capture_id = self
1402            .highlights_query
1403            .as_ref()?
1404            .capture_index_for_name(name)?;
1405        Some(self.highlight_map.lock().get(capture_id))
1406    }
1407}
1408
1409impl CodeLabel {
1410    pub fn plain(text: String, filter_text: Option<&str>) -> Self {
1411        let mut result = Self {
1412            runs: Vec::new(),
1413            filter_range: 0..text.len(),
1414            text,
1415        };
1416        if let Some(filter_text) = filter_text {
1417            if let Some(ix) = result.text.find(filter_text) {
1418                result.filter_range = ix..ix + filter_text.len();
1419            }
1420        }
1421        result
1422    }
1423}
1424
1425#[cfg(any(test, feature = "test-support"))]
1426impl Default for FakeLspAdapter {
1427    fn default() -> Self {
1428        Self {
1429            name: "the-fake-language-server",
1430            capabilities: lsp::LanguageServer::full_capabilities(),
1431            initializer: None,
1432            disk_based_diagnostics_progress_token: None,
1433            disk_based_diagnostics_sources: Vec::new(),
1434        }
1435    }
1436}
1437
1438#[cfg(any(test, feature = "test-support"))]
1439#[async_trait]
1440impl LspAdapter for Arc<FakeLspAdapter> {
1441    async fn name(&self) -> LanguageServerName {
1442        LanguageServerName(self.name.into())
1443    }
1444
1445    async fn fetch_latest_server_version(
1446        &self,
1447        _: Arc<dyn HttpClient>,
1448    ) -> Result<Box<dyn 'static + Send + Any>> {
1449        unreachable!();
1450    }
1451
1452    async fn fetch_server_binary(
1453        &self,
1454        _: Box<dyn 'static + Send + Any>,
1455        _: Arc<dyn HttpClient>,
1456        _: PathBuf,
1457    ) -> Result<PathBuf> {
1458        unreachable!();
1459    }
1460
1461    async fn cached_server_binary(&self, _: PathBuf) -> Option<PathBuf> {
1462        unreachable!();
1463    }
1464
1465    async fn process_diagnostics(&self, _: &mut lsp::PublishDiagnosticsParams) {}
1466
1467    async fn disk_based_diagnostic_sources(&self) -> Vec<String> {
1468        self.disk_based_diagnostics_sources.clone()
1469    }
1470
1471    async fn disk_based_diagnostics_progress_token(&self) -> Option<String> {
1472        self.disk_based_diagnostics_progress_token.clone()
1473    }
1474}
1475
1476fn get_capture_indices(query: &Query, captures: &mut [(&str, &mut Option<u32>)]) {
1477    for (ix, name) in query.capture_names().iter().enumerate() {
1478        for (capture_name, index) in captures.iter_mut() {
1479            if capture_name == name {
1480                **index = Some(ix as u32);
1481                break;
1482            }
1483        }
1484    }
1485}
1486
1487pub fn point_to_lsp(point: PointUtf16) -> lsp::Position {
1488    lsp::Position::new(point.row, point.column)
1489}
1490
1491pub fn point_from_lsp(point: lsp::Position) -> Unclipped<PointUtf16> {
1492    Unclipped(PointUtf16::new(point.line, point.character))
1493}
1494
1495pub fn range_to_lsp(range: Range<PointUtf16>) -> lsp::Range {
1496    lsp::Range {
1497        start: point_to_lsp(range.start),
1498        end: point_to_lsp(range.end),
1499    }
1500}
1501
1502pub fn range_from_lsp(range: lsp::Range) -> Range<Unclipped<PointUtf16>> {
1503    let mut start = point_from_lsp(range.start);
1504    let mut end = point_from_lsp(range.end);
1505    if start > end {
1506        mem::swap(&mut start, &mut end);
1507    }
1508    start..end
1509}
1510
1511#[cfg(test)]
1512mod tests {
1513    use gpui::TestAppContext;
1514
1515    use super::*;
1516
1517    #[gpui::test(iterations = 10)]
1518    async fn test_language_loading(cx: &mut TestAppContext) {
1519        let mut languages = LanguageRegistry::new(Task::ready(()));
1520        languages.set_executor(cx.background());
1521        let languages = Arc::new(languages);
1522        languages.register(
1523            "/JSON",
1524            LanguageConfig {
1525                name: "JSON".into(),
1526                path_suffixes: vec!["json".into()],
1527                ..Default::default()
1528            },
1529            tree_sitter_json::language(),
1530            None,
1531            |_| Default::default(),
1532        );
1533        languages.register(
1534            "/rust",
1535            LanguageConfig {
1536                name: "Rust".into(),
1537                path_suffixes: vec!["rs".into()],
1538                ..Default::default()
1539            },
1540            tree_sitter_rust::language(),
1541            None,
1542            |_| Default::default(),
1543        );
1544        assert_eq!(
1545            languages.language_names(),
1546            &[
1547                "JSON".to_string(),
1548                "Plain Text".to_string(),
1549                "Rust".to_string(),
1550            ]
1551        );
1552
1553        let rust1 = languages.language_for_name("Rust");
1554        let rust2 = languages.language_for_name("Rust");
1555
1556        // Ensure language is still listed even if it's being loaded.
1557        assert_eq!(
1558            languages.language_names(),
1559            &[
1560                "JSON".to_string(),
1561                "Plain Text".to_string(),
1562                "Rust".to_string(),
1563            ]
1564        );
1565
1566        let (rust1, rust2) = futures::join!(rust1, rust2);
1567        assert!(Arc::ptr_eq(&rust1.unwrap(), &rust2.unwrap()));
1568
1569        // Ensure language is still listed even after loading it.
1570        assert_eq!(
1571            languages.language_names(),
1572            &[
1573                "JSON".to_string(),
1574                "Plain Text".to_string(),
1575                "Rust".to_string(),
1576            ]
1577        );
1578
1579        // Loading an unknown language returns an error.
1580        assert!(languages.language_for_name("Unknown").await.is_err());
1581    }
1582}