language.rs

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