language.rs

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