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_server(
 786        self: &Arc<Self>,
 787        language: Arc<Language>,
 788        adapter: Arc<CachedLspAdapter>,
 789        root_path: Arc<Path>,
 790        http_client: Arc<dyn HttpClient>,
 791        cx: &mut AppContext,
 792    ) -> Option<PendingLanguageServer> {
 793        #[cfg(any(test, feature = "test-support"))]
 794        if language.fake_adapter.is_some() {
 795            let task = cx.spawn(|cx| async move {
 796                let (servers_tx, fake_adapter) = language.fake_adapter.as_ref().unwrap();
 797                let (server, mut fake_server) = lsp::LanguageServer::fake(
 798                    fake_adapter.name.to_string(),
 799                    fake_adapter.capabilities.clone(),
 800                    cx.clone(),
 801                );
 802
 803                if let Some(initializer) = &fake_adapter.initializer {
 804                    initializer(&mut fake_server);
 805                }
 806
 807                let servers_tx = servers_tx.clone();
 808                cx.background()
 809                    .spawn(async move {
 810                        if fake_server
 811                            .try_receive_notification::<lsp::notification::Initialized>()
 812                            .await
 813                            .is_some()
 814                        {
 815                            servers_tx.unbounded_send(fake_server).ok();
 816                        }
 817                    })
 818                    .detach();
 819                Ok(server)
 820            });
 821
 822            let server_id = post_inc(&mut self.state.write().next_language_server_id);
 823            return Some(PendingLanguageServer { server_id, task });
 824        }
 825
 826        let download_dir = self
 827            .language_server_download_dir
 828            .clone()
 829            .ok_or_else(|| anyhow!("language server download directory has not been assigned"))
 830            .log_err()?;
 831
 832        let this = self.clone();
 833        let language = language.clone();
 834        let http_client = http_client.clone();
 835        let download_dir = download_dir.clone();
 836        let root_path = root_path.clone();
 837        let adapter = adapter.clone();
 838        let lsp_binary_statuses = self.lsp_binary_statuses_tx.clone();
 839        let login_shell_env_loaded = self.login_shell_env_loaded.clone();
 840        let server_id = post_inc(&mut self.state.write().next_language_server_id);
 841
 842        let task = cx.spawn(|cx| async move {
 843            login_shell_env_loaded.await;
 844
 845            let mut lock = this.lsp_binary_paths.lock();
 846            let entry = lock
 847                .entry(adapter.name.clone())
 848                .or_insert_with(|| {
 849                    get_binary(
 850                        adapter.clone(),
 851                        language.clone(),
 852                        http_client,
 853                        download_dir,
 854                        lsp_binary_statuses,
 855                    )
 856                    .map_err(Arc::new)
 857                    .boxed()
 858                    .shared()
 859                })
 860                .clone();
 861            drop(lock);
 862            let binary = entry.clone().map_err(|e| anyhow!(e)).await?;
 863
 864            let server = lsp::LanguageServer::new(
 865                server_id,
 866                &binary.path,
 867                &binary.arguments,
 868                &root_path,
 869                adapter.code_action_kinds(),
 870                cx,
 871            )?;
 872
 873            Ok(server)
 874        });
 875
 876        Some(PendingLanguageServer { server_id, task })
 877    }
 878
 879    pub fn language_server_binary_statuses(
 880        &self,
 881    ) -> async_broadcast::Receiver<(Arc<Language>, LanguageServerBinaryStatus)> {
 882        self.lsp_binary_statuses_rx.clone()
 883    }
 884}
 885
 886impl LanguageRegistryState {
 887    fn add(&mut self, language: Arc<Language>) {
 888        if let Some(theme) = self.theme.as_ref() {
 889            language.set_theme(&theme.editor.syntax);
 890        }
 891        self.languages.push(language);
 892        self.version += 1;
 893        *self.subscription.0.borrow_mut() = ();
 894    }
 895}
 896
 897#[cfg(any(test, feature = "test-support"))]
 898impl Default for LanguageRegistry {
 899    fn default() -> Self {
 900        Self::test()
 901    }
 902}
 903
 904async fn get_binary(
 905    adapter: Arc<CachedLspAdapter>,
 906    language: Arc<Language>,
 907    http_client: Arc<dyn HttpClient>,
 908    download_dir: Arc<Path>,
 909    statuses: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
 910) -> Result<LanguageServerBinary> {
 911    let container_dir = download_dir.join(adapter.name.0.as_ref());
 912    if !container_dir.exists() {
 913        smol::fs::create_dir_all(&container_dir)
 914            .await
 915            .context("failed to create container directory")?;
 916    }
 917
 918    let binary = fetch_latest_binary(
 919        adapter.clone(),
 920        language.clone(),
 921        http_client,
 922        &container_dir,
 923        statuses.clone(),
 924    )
 925    .await;
 926
 927    if let Err(error) = binary.as_ref() {
 928        if let Some(cached) = adapter.cached_server_binary(container_dir).await {
 929            statuses
 930                .broadcast((language.clone(), LanguageServerBinaryStatus::Cached))
 931                .await?;
 932            return Ok(cached);
 933        } else {
 934            statuses
 935                .broadcast((
 936                    language.clone(),
 937                    LanguageServerBinaryStatus::Failed {
 938                        error: format!("{:?}", error),
 939                    },
 940                ))
 941                .await?;
 942        }
 943    }
 944    binary
 945}
 946
 947async fn fetch_latest_binary(
 948    adapter: Arc<CachedLspAdapter>,
 949    language: Arc<Language>,
 950    http_client: Arc<dyn HttpClient>,
 951    container_dir: &Path,
 952    lsp_binary_statuses_tx: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
 953) -> Result<LanguageServerBinary> {
 954    let container_dir: Arc<Path> = container_dir.into();
 955    lsp_binary_statuses_tx
 956        .broadcast((
 957            language.clone(),
 958            LanguageServerBinaryStatus::CheckingForUpdate,
 959        ))
 960        .await?;
 961    let version_info = adapter
 962        .fetch_latest_server_version(http_client.clone())
 963        .await?;
 964    lsp_binary_statuses_tx
 965        .broadcast((language.clone(), LanguageServerBinaryStatus::Downloading))
 966        .await?;
 967    let binary = adapter
 968        .fetch_server_binary(version_info, http_client, container_dir.to_path_buf())
 969        .await?;
 970    lsp_binary_statuses_tx
 971        .broadcast((language.clone(), LanguageServerBinaryStatus::Downloaded))
 972        .await?;
 973    Ok(binary)
 974}
 975
 976impl Language {
 977    pub fn new(config: LanguageConfig, ts_language: Option<tree_sitter::Language>) -> Self {
 978        Self {
 979            config,
 980            grammar: ts_language.map(|ts_language| {
 981                Arc::new(Grammar {
 982                    id: NEXT_GRAMMAR_ID.fetch_add(1, SeqCst),
 983                    highlights_query: None,
 984                    brackets_config: None,
 985                    outline_config: None,
 986                    indents_config: None,
 987                    injection_config: None,
 988                    override_config: None,
 989                    error_query: Query::new(ts_language, "(ERROR) @error").unwrap(),
 990                    ts_language,
 991                    highlight_map: Default::default(),
 992                })
 993            }),
 994            adapters: Vec::new(),
 995
 996            #[cfg(any(test, feature = "test-support"))]
 997            fake_adapter: None,
 998        }
 999    }
1000
1001    pub fn lsp_adapters(&self) -> &[Arc<CachedLspAdapter>] {
1002        &self.adapters
1003    }
1004
1005    pub fn id(&self) -> Option<usize> {
1006        self.grammar.as_ref().map(|g| g.id)
1007    }
1008
1009    pub fn with_queries(mut self, queries: LanguageQueries) -> Result<Self> {
1010        if let Some(query) = queries.highlights {
1011            self = self
1012                .with_highlights_query(query.as_ref())
1013                .expect("failed to evaluate highlights query");
1014        }
1015        if let Some(query) = queries.brackets {
1016            self = self
1017                .with_brackets_query(query.as_ref())
1018                .expect("failed to load brackets query");
1019        }
1020        if let Some(query) = queries.indents {
1021            self = self
1022                .with_indents_query(query.as_ref())
1023                .expect("failed to load indents query");
1024        }
1025        if let Some(query) = queries.outline {
1026            self = self
1027                .with_outline_query(query.as_ref())
1028                .expect("failed to load outline query");
1029        }
1030        if let Some(query) = queries.injections {
1031            self = self
1032                .with_injection_query(query.as_ref())
1033                .expect("failed to load injection query");
1034        }
1035        if let Some(query) = queries.overrides {
1036            self = self
1037                .with_override_query(query.as_ref())
1038                .expect("failed to load override query");
1039        }
1040        Ok(self)
1041    }
1042    pub fn with_highlights_query(mut self, source: &str) -> Result<Self> {
1043        let grammar = self.grammar_mut();
1044        grammar.highlights_query = Some(Query::new(grammar.ts_language, source)?);
1045        Ok(self)
1046    }
1047
1048    pub fn with_outline_query(mut self, source: &str) -> Result<Self> {
1049        let grammar = self.grammar_mut();
1050        let query = Query::new(grammar.ts_language, source)?;
1051        let mut item_capture_ix = None;
1052        let mut name_capture_ix = None;
1053        let mut context_capture_ix = None;
1054        get_capture_indices(
1055            &query,
1056            &mut [
1057                ("item", &mut item_capture_ix),
1058                ("name", &mut name_capture_ix),
1059                ("context", &mut context_capture_ix),
1060            ],
1061        );
1062        if let Some((item_capture_ix, name_capture_ix)) = item_capture_ix.zip(name_capture_ix) {
1063            grammar.outline_config = Some(OutlineConfig {
1064                query,
1065                item_capture_ix,
1066                name_capture_ix,
1067                context_capture_ix,
1068            });
1069        }
1070        Ok(self)
1071    }
1072
1073    pub fn with_brackets_query(mut self, source: &str) -> Result<Self> {
1074        let grammar = self.grammar_mut();
1075        let query = Query::new(grammar.ts_language, source)?;
1076        let mut open_capture_ix = None;
1077        let mut close_capture_ix = None;
1078        get_capture_indices(
1079            &query,
1080            &mut [
1081                ("open", &mut open_capture_ix),
1082                ("close", &mut close_capture_ix),
1083            ],
1084        );
1085        if let Some((open_capture_ix, close_capture_ix)) = open_capture_ix.zip(close_capture_ix) {
1086            grammar.brackets_config = Some(BracketConfig {
1087                query,
1088                open_capture_ix,
1089                close_capture_ix,
1090            });
1091        }
1092        Ok(self)
1093    }
1094
1095    pub fn with_indents_query(mut self, source: &str) -> Result<Self> {
1096        let grammar = self.grammar_mut();
1097        let query = Query::new(grammar.ts_language, source)?;
1098        let mut indent_capture_ix = None;
1099        let mut start_capture_ix = None;
1100        let mut end_capture_ix = None;
1101        let mut outdent_capture_ix = None;
1102        get_capture_indices(
1103            &query,
1104            &mut [
1105                ("indent", &mut indent_capture_ix),
1106                ("start", &mut start_capture_ix),
1107                ("end", &mut end_capture_ix),
1108                ("outdent", &mut outdent_capture_ix),
1109            ],
1110        );
1111        if let Some(indent_capture_ix) = indent_capture_ix {
1112            grammar.indents_config = Some(IndentConfig {
1113                query,
1114                indent_capture_ix,
1115                start_capture_ix,
1116                end_capture_ix,
1117                outdent_capture_ix,
1118            });
1119        }
1120        Ok(self)
1121    }
1122
1123    pub fn with_injection_query(mut self, source: &str) -> Result<Self> {
1124        let grammar = self.grammar_mut();
1125        let query = Query::new(grammar.ts_language, source)?;
1126        let mut language_capture_ix = None;
1127        let mut content_capture_ix = None;
1128        get_capture_indices(
1129            &query,
1130            &mut [
1131                ("language", &mut language_capture_ix),
1132                ("content", &mut content_capture_ix),
1133            ],
1134        );
1135        let patterns = (0..query.pattern_count())
1136            .map(|ix| {
1137                let mut config = InjectionPatternConfig::default();
1138                for setting in query.property_settings(ix) {
1139                    match setting.key.as_ref() {
1140                        "language" => {
1141                            config.language = setting.value.clone();
1142                        }
1143                        "combined" => {
1144                            config.combined = true;
1145                        }
1146                        _ => {}
1147                    }
1148                }
1149                config
1150            })
1151            .collect();
1152        if let Some(content_capture_ix) = content_capture_ix {
1153            grammar.injection_config = Some(InjectionConfig {
1154                query,
1155                language_capture_ix,
1156                content_capture_ix,
1157                patterns,
1158            });
1159        }
1160        Ok(self)
1161    }
1162
1163    pub fn with_override_query(mut self, source: &str) -> Result<Self> {
1164        let query = Query::new(self.grammar_mut().ts_language, source)?;
1165
1166        let mut override_configs_by_id = HashMap::default();
1167        for (ix, name) in query.capture_names().iter().enumerate() {
1168            if !name.starts_with('_') {
1169                let value = self.config.overrides.remove(name).unwrap_or_default();
1170                override_configs_by_id.insert(ix as u32, (name.clone(), value));
1171            }
1172        }
1173
1174        if !self.config.overrides.is_empty() {
1175            let keys = self.config.overrides.keys().collect::<Vec<_>>();
1176            Err(anyhow!(
1177                "language {:?} has overrides in config not in query: {keys:?}",
1178                self.config.name
1179            ))?;
1180        }
1181
1182        for disabled_scope_name in self
1183            .config
1184            .brackets
1185            .disabled_scopes_by_bracket_ix
1186            .iter()
1187            .flatten()
1188        {
1189            if !override_configs_by_id
1190                .values()
1191                .any(|(scope_name, _)| scope_name == disabled_scope_name)
1192            {
1193                Err(anyhow!(
1194                    "language {:?} has overrides in config not in query: {disabled_scope_name:?}",
1195                    self.config.name
1196                ))?;
1197            }
1198        }
1199
1200        for (name, override_config) in override_configs_by_id.values_mut() {
1201            override_config.disabled_bracket_ixs = self
1202                .config
1203                .brackets
1204                .disabled_scopes_by_bracket_ix
1205                .iter()
1206                .enumerate()
1207                .filter_map(|(ix, disabled_scope_names)| {
1208                    if disabled_scope_names.contains(name) {
1209                        Some(ix as u16)
1210                    } else {
1211                        None
1212                    }
1213                })
1214                .collect();
1215        }
1216
1217        self.config.brackets.disabled_scopes_by_bracket_ix.clear();
1218        self.grammar_mut().override_config = Some(OverrideConfig {
1219            query,
1220            values: override_configs_by_id,
1221        });
1222        Ok(self)
1223    }
1224
1225    fn grammar_mut(&mut self) -> &mut Grammar {
1226        Arc::get_mut(self.grammar.as_mut().unwrap()).unwrap()
1227    }
1228
1229    pub async fn with_lsp_adapters(mut self, lsp_adapters: Vec<Arc<dyn LspAdapter>>) -> Self {
1230        for adapter in lsp_adapters {
1231            self.adapters.push(CachedLspAdapter::new(adapter).await);
1232        }
1233        self
1234    }
1235
1236    #[cfg(any(test, feature = "test-support"))]
1237    pub async fn set_fake_lsp_adapter(
1238        &mut self,
1239        fake_lsp_adapter: Arc<FakeLspAdapter>,
1240    ) -> mpsc::UnboundedReceiver<lsp::FakeLanguageServer> {
1241        let (servers_tx, servers_rx) = mpsc::unbounded();
1242        self.fake_adapter = Some((servers_tx, fake_lsp_adapter.clone()));
1243        let adapter = CachedLspAdapter::new(Arc::new(fake_lsp_adapter)).await;
1244        self.adapters = vec![adapter];
1245        servers_rx
1246    }
1247
1248    pub fn name(&self) -> Arc<str> {
1249        self.config.name.clone()
1250    }
1251
1252    pub async fn disk_based_diagnostic_sources(&self) -> &[String] {
1253        match self.adapters.first().as_ref() {
1254            Some(adapter) => &adapter.disk_based_diagnostic_sources,
1255            None => &[],
1256        }
1257    }
1258
1259    pub async fn disk_based_diagnostics_progress_token(&self) -> Option<&str> {
1260        for adapter in &self.adapters {
1261            let token = adapter.disk_based_diagnostics_progress_token.as_deref();
1262            if token.is_some() {
1263                return token;
1264            }
1265        }
1266
1267        None
1268    }
1269
1270    pub async fn process_diagnostics(&self, diagnostics: &mut lsp::PublishDiagnosticsParams) {
1271        for adapter in &self.adapters {
1272            adapter.process_diagnostics(diagnostics).await;
1273        }
1274    }
1275
1276    pub async fn process_completion(self: &Arc<Self>, completion: &mut lsp::CompletionItem) {
1277        for adapter in &self.adapters {
1278            adapter.process_completion(completion).await;
1279        }
1280    }
1281
1282    pub async fn label_for_completion(
1283        self: &Arc<Self>,
1284        completion: &lsp::CompletionItem,
1285    ) -> Option<CodeLabel> {
1286        self.adapters
1287            .first()
1288            .as_ref()?
1289            .label_for_completion(completion, self)
1290            .await
1291    }
1292
1293    pub async fn label_for_symbol(
1294        self: &Arc<Self>,
1295        name: &str,
1296        kind: lsp::SymbolKind,
1297    ) -> Option<CodeLabel> {
1298        self.adapters
1299            .first()
1300            .as_ref()?
1301            .label_for_symbol(name, kind, self)
1302            .await
1303    }
1304
1305    pub fn highlight_text<'a>(
1306        self: &'a Arc<Self>,
1307        text: &'a Rope,
1308        range: Range<usize>,
1309    ) -> Vec<(Range<usize>, HighlightId)> {
1310        let mut result = Vec::new();
1311        if let Some(grammar) = &self.grammar {
1312            let tree = grammar.parse_text(text, None);
1313            let captures =
1314                SyntaxSnapshot::single_tree_captures(range.clone(), text, &tree, self, |grammar| {
1315                    grammar.highlights_query.as_ref()
1316                });
1317            let highlight_maps = vec![grammar.highlight_map()];
1318            let mut offset = 0;
1319            for chunk in BufferChunks::new(text, range, Some((captures, highlight_maps)), vec![]) {
1320                let end_offset = offset + chunk.text.len();
1321                if let Some(highlight_id) = chunk.syntax_highlight_id {
1322                    if !highlight_id.is_default() {
1323                        result.push((offset..end_offset, highlight_id));
1324                    }
1325                }
1326                offset = end_offset;
1327            }
1328        }
1329        result
1330    }
1331
1332    pub fn path_suffixes(&self) -> &[String] {
1333        &self.config.path_suffixes
1334    }
1335
1336    pub fn should_autoclose_before(&self, c: char) -> bool {
1337        c.is_whitespace() || self.config.autoclose_before.contains(c)
1338    }
1339
1340    pub fn set_theme(&self, theme: &SyntaxTheme) {
1341        if let Some(grammar) = self.grammar.as_ref() {
1342            if let Some(highlights_query) = &grammar.highlights_query {
1343                *grammar.highlight_map.lock() =
1344                    HighlightMap::new(highlights_query.capture_names(), theme);
1345            }
1346        }
1347    }
1348
1349    pub fn grammar(&self) -> Option<&Arc<Grammar>> {
1350        self.grammar.as_ref()
1351    }
1352}
1353
1354impl LanguageScope {
1355    pub fn line_comment_prefix(&self) -> Option<&Arc<str>> {
1356        Override::as_option(
1357            self.config_override().map(|o| &o.line_comment),
1358            self.language.config.line_comment.as_ref(),
1359        )
1360    }
1361
1362    pub fn block_comment_delimiters(&self) -> Option<(&Arc<str>, &Arc<str>)> {
1363        Override::as_option(
1364            self.config_override().map(|o| &o.block_comment),
1365            self.language.config.block_comment.as_ref(),
1366        )
1367        .map(|e| (&e.0, &e.1))
1368    }
1369
1370    pub fn brackets(&self) -> impl Iterator<Item = (&BracketPair, bool)> {
1371        let mut disabled_ids = self
1372            .config_override()
1373            .map_or(&[] as _, |o| o.disabled_bracket_ixs.as_slice());
1374        self.language
1375            .config
1376            .brackets
1377            .pairs
1378            .iter()
1379            .enumerate()
1380            .map(move |(ix, bracket)| {
1381                let mut is_enabled = true;
1382                if let Some(next_disabled_ix) = disabled_ids.first() {
1383                    if ix == *next_disabled_ix as usize {
1384                        disabled_ids = &disabled_ids[1..];
1385                        is_enabled = false;
1386                    }
1387                }
1388                (bracket, is_enabled)
1389            })
1390    }
1391
1392    pub fn should_autoclose_before(&self, c: char) -> bool {
1393        c.is_whitespace() || self.language.config.autoclose_before.contains(c)
1394    }
1395
1396    fn config_override(&self) -> Option<&LanguageConfigOverride> {
1397        let id = self.override_id?;
1398        let grammar = self.language.grammar.as_ref()?;
1399        let override_config = grammar.override_config.as_ref()?;
1400        override_config.values.get(&id).map(|e| &e.1)
1401    }
1402}
1403
1404impl Hash for Language {
1405    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
1406        self.id().hash(state)
1407    }
1408}
1409
1410impl PartialEq for Language {
1411    fn eq(&self, other: &Self) -> bool {
1412        self.id().eq(&other.id())
1413    }
1414}
1415
1416impl Eq for Language {}
1417
1418impl Debug for Language {
1419    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1420        f.debug_struct("Language")
1421            .field("name", &self.config.name)
1422            .finish()
1423    }
1424}
1425
1426impl Grammar {
1427    pub fn id(&self) -> usize {
1428        self.id
1429    }
1430
1431    fn parse_text(&self, text: &Rope, old_tree: Option<Tree>) -> Tree {
1432        PARSER.with(|parser| {
1433            let mut parser = parser.borrow_mut();
1434            parser
1435                .set_language(self.ts_language)
1436                .expect("incompatible grammar");
1437            let mut chunks = text.chunks_in_range(0..text.len());
1438            parser
1439                .parse_with(
1440                    &mut move |offset, _| {
1441                        chunks.seek(offset);
1442                        chunks.next().unwrap_or("").as_bytes()
1443                    },
1444                    old_tree.as_ref(),
1445                )
1446                .unwrap()
1447        })
1448    }
1449
1450    pub fn highlight_map(&self) -> HighlightMap {
1451        self.highlight_map.lock().clone()
1452    }
1453
1454    pub fn highlight_id_for_name(&self, name: &str) -> Option<HighlightId> {
1455        let capture_id = self
1456            .highlights_query
1457            .as_ref()?
1458            .capture_index_for_name(name)?;
1459        Some(self.highlight_map.lock().get(capture_id))
1460    }
1461}
1462
1463impl CodeLabel {
1464    pub fn plain(text: String, filter_text: Option<&str>) -> Self {
1465        let mut result = Self {
1466            runs: Vec::new(),
1467            filter_range: 0..text.len(),
1468            text,
1469        };
1470        if let Some(filter_text) = filter_text {
1471            if let Some(ix) = result.text.find(filter_text) {
1472                result.filter_range = ix..ix + filter_text.len();
1473            }
1474        }
1475        result
1476    }
1477}
1478
1479#[cfg(any(test, feature = "test-support"))]
1480impl Default for FakeLspAdapter {
1481    fn default() -> Self {
1482        Self {
1483            name: "the-fake-language-server",
1484            capabilities: lsp::LanguageServer::full_capabilities(),
1485            initializer: None,
1486            disk_based_diagnostics_progress_token: None,
1487            disk_based_diagnostics_sources: Vec::new(),
1488        }
1489    }
1490}
1491
1492#[cfg(any(test, feature = "test-support"))]
1493#[async_trait]
1494impl LspAdapter for Arc<FakeLspAdapter> {
1495    async fn name(&self) -> LanguageServerName {
1496        LanguageServerName(self.name.into())
1497    }
1498
1499    async fn fetch_latest_server_version(
1500        &self,
1501        _: Arc<dyn HttpClient>,
1502    ) -> Result<Box<dyn 'static + Send + Any>> {
1503        unreachable!();
1504    }
1505
1506    async fn fetch_server_binary(
1507        &self,
1508        _: Box<dyn 'static + Send + Any>,
1509        _: Arc<dyn HttpClient>,
1510        _: PathBuf,
1511    ) -> Result<LanguageServerBinary> {
1512        unreachable!();
1513    }
1514
1515    async fn cached_server_binary(&self, _: PathBuf) -> Option<LanguageServerBinary> {
1516        unreachable!();
1517    }
1518
1519    async fn process_diagnostics(&self, _: &mut lsp::PublishDiagnosticsParams) {}
1520
1521    async fn disk_based_diagnostic_sources(&self) -> Vec<String> {
1522        self.disk_based_diagnostics_sources.clone()
1523    }
1524
1525    async fn disk_based_diagnostics_progress_token(&self) -> Option<String> {
1526        self.disk_based_diagnostics_progress_token.clone()
1527    }
1528}
1529
1530fn get_capture_indices(query: &Query, captures: &mut [(&str, &mut Option<u32>)]) {
1531    for (ix, name) in query.capture_names().iter().enumerate() {
1532        for (capture_name, index) in captures.iter_mut() {
1533            if capture_name == name {
1534                **index = Some(ix as u32);
1535                break;
1536            }
1537        }
1538    }
1539}
1540
1541pub fn point_to_lsp(point: PointUtf16) -> lsp::Position {
1542    lsp::Position::new(point.row, point.column)
1543}
1544
1545pub fn point_from_lsp(point: lsp::Position) -> Unclipped<PointUtf16> {
1546    Unclipped(PointUtf16::new(point.line, point.character))
1547}
1548
1549pub fn range_to_lsp(range: Range<PointUtf16>) -> lsp::Range {
1550    lsp::Range {
1551        start: point_to_lsp(range.start),
1552        end: point_to_lsp(range.end),
1553    }
1554}
1555
1556pub fn range_from_lsp(range: lsp::Range) -> Range<Unclipped<PointUtf16>> {
1557    let mut start = point_from_lsp(range.start);
1558    let mut end = point_from_lsp(range.end);
1559    if start > end {
1560        mem::swap(&mut start, &mut end);
1561    }
1562    start..end
1563}
1564
1565#[cfg(test)]
1566mod tests {
1567    use super::*;
1568    use gpui::TestAppContext;
1569
1570    #[gpui::test(iterations = 10)]
1571    async fn test_first_line_pattern(cx: &mut TestAppContext) {
1572        let mut languages = LanguageRegistry::test();
1573        languages.set_executor(cx.background());
1574        let languages = Arc::new(languages);
1575        languages.register(
1576            "/javascript",
1577            LanguageConfig {
1578                name: "JavaScript".into(),
1579                path_suffixes: vec!["js".into()],
1580                first_line_pattern: Some(Regex::new(r"\bnode\b").unwrap()),
1581                ..Default::default()
1582            },
1583            tree_sitter_javascript::language(),
1584            vec![],
1585            |_| Default::default(),
1586        );
1587
1588        languages
1589            .language_for_file("the/script", None)
1590            .await
1591            .unwrap_err();
1592        languages
1593            .language_for_file("the/script", Some(&"nothing".into()))
1594            .await
1595            .unwrap_err();
1596        assert_eq!(
1597            languages
1598                .language_for_file("the/script", Some(&"#!/bin/env node".into()))
1599                .await
1600                .unwrap()
1601                .name()
1602                .as_ref(),
1603            "JavaScript"
1604        );
1605    }
1606
1607    #[gpui::test(iterations = 10)]
1608    async fn test_language_loading(cx: &mut TestAppContext) {
1609        let mut languages = LanguageRegistry::test();
1610        languages.set_executor(cx.background());
1611        let languages = Arc::new(languages);
1612        languages.register(
1613            "/JSON",
1614            LanguageConfig {
1615                name: "JSON".into(),
1616                path_suffixes: vec!["json".into()],
1617                ..Default::default()
1618            },
1619            tree_sitter_json::language(),
1620            vec![],
1621            |_| Default::default(),
1622        );
1623        languages.register(
1624            "/rust",
1625            LanguageConfig {
1626                name: "Rust".into(),
1627                path_suffixes: vec!["rs".into()],
1628                ..Default::default()
1629            },
1630            tree_sitter_rust::language(),
1631            vec![],
1632            |_| Default::default(),
1633        );
1634        assert_eq!(
1635            languages.language_names(),
1636            &[
1637                "JSON".to_string(),
1638                "Plain Text".to_string(),
1639                "Rust".to_string(),
1640            ]
1641        );
1642
1643        let rust1 = languages.language_for_name("Rust");
1644        let rust2 = languages.language_for_name("Rust");
1645
1646        // Ensure language is still listed even if it's being loaded.
1647        assert_eq!(
1648            languages.language_names(),
1649            &[
1650                "JSON".to_string(),
1651                "Plain Text".to_string(),
1652                "Rust".to_string(),
1653            ]
1654        );
1655
1656        let (rust1, rust2) = futures::join!(rust1, rust2);
1657        assert!(Arc::ptr_eq(&rust1.unwrap(), &rust2.unwrap()));
1658
1659        // Ensure language is still listed even after loading it.
1660        assert_eq!(
1661            languages.language_names(),
1662            &[
1663                "JSON".to_string(),
1664                "Plain Text".to_string(),
1665                "Rust".to_string(),
1666            ]
1667        );
1668
1669        // Loading an unknown language returns an error.
1670        assert!(languages.language_for_name("Unknown").await.is_err());
1671    }
1672}