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