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