1//! The `language` crate provides a large chunk of Zed's language-related
2//! features (the other big contributors being project and lsp crates that revolve around LSP features).
3//! Namely, this crate:
4//! - Provides [`Language`], [`Grammar`] and [`LanguageRegistry`] types that
5//! use Tree-sitter to provide syntax highlighting to the editor; note though that `language` doesn't perform the highlighting by itself. It only maps ranges in a buffer to colors. Treesitter is also used for buffer outlines (lists of symbols in a buffer)
6//! - Exposes [`LanguageConfig`] that describes how constructs (like brackets or line comments) should be handled by the editor for a source file of a particular language.
7//!
8//! Notably we do *not* assign a single language to a single file; in real world a single file can consist of multiple programming languages - HTML is a good example of that - and `language` crate tends to reflect that status quo in its API.
9mod buffer;
10mod diagnostic_set;
11mod highlight_map;
12mod language_registry;
13pub mod language_settings;
14mod manifest;
15mod outline;
16pub mod proto;
17mod syntax_map;
18mod task_context;
19mod text_diff;
20mod toolchain;
21
22#[cfg(test)]
23pub mod buffer_tests;
24
25pub use crate::language_settings::EditPredictionsMode;
26use crate::language_settings::SoftWrap;
27use anyhow::{Context as _, Result, anyhow};
28use async_trait::async_trait;
29use collections::{HashMap, HashSet, IndexSet};
30use fs::Fs;
31use futures::Future;
32use gpui::{App, AsyncApp, Entity, SharedString, Task};
33pub use highlight_map::HighlightMap;
34use http_client::HttpClient;
35pub use language_registry::{LanguageName, LoadedLanguage};
36use lsp::{CodeActionKind, InitializeParams, LanguageServerBinary, LanguageServerBinaryOptions};
37pub use manifest::{ManifestName, ManifestProvider, ManifestQuery};
38use parking_lot::Mutex;
39use regex::Regex;
40use schemars::{
41 JsonSchema,
42 r#gen::SchemaGenerator,
43 schema::{InstanceType, Schema, SchemaObject},
44};
45use serde::{Deserialize, Deserializer, Serialize, Serializer, de};
46use serde_json::Value;
47use settings::WorktreeId;
48use smol::future::FutureExt as _;
49use std::{
50 any::Any,
51 ffi::OsStr,
52 fmt::Debug,
53 hash::Hash,
54 mem,
55 ops::{DerefMut, Range},
56 path::{Path, PathBuf},
57 pin::Pin,
58 str,
59 sync::{
60 Arc, LazyLock,
61 atomic::{AtomicU64, AtomicUsize, Ordering::SeqCst},
62 },
63};
64use std::{num::NonZeroU32, sync::OnceLock};
65use syntax_map::{QueryCursorHandle, SyntaxSnapshot};
66use task::RunnableTag;
67pub use task_context::{ContextProvider, RunnableRange};
68pub use text_diff::{DiffOptions, line_diff, text_diff, text_diff_with_options, unified_diff};
69use theme::SyntaxTheme;
70pub use toolchain::{LanguageToolchainStore, Toolchain, ToolchainList, ToolchainLister};
71use tree_sitter::{self, Query, QueryCursor, WasmStore, wasmtime};
72use util::serde::default_true;
73
74pub use buffer::Operation;
75pub use buffer::*;
76pub use diagnostic_set::{DiagnosticEntry, DiagnosticGroup};
77pub use language_registry::{
78 AvailableLanguage, BinaryStatus, LanguageNotFound, LanguageQueries, LanguageRegistry,
79 QUERY_FILENAME_PREFIXES,
80};
81pub use lsp::{LanguageServerId, LanguageServerName};
82pub use outline::*;
83pub use syntax_map::{OwnedSyntaxLayer, SyntaxLayer, ToTreeSitterPoint, TreeSitterOptions};
84pub use text::{AnchorRangeExt, LineEnding};
85pub use tree_sitter::{Node, Parser, Tree, TreeCursor};
86
87/// Initializes the `language` crate.
88///
89/// This should be called before making use of items from the create.
90pub fn init(cx: &mut App) {
91 language_settings::init(cx);
92}
93
94static QUERY_CURSORS: Mutex<Vec<QueryCursor>> = Mutex::new(vec![]);
95static PARSERS: Mutex<Vec<Parser>> = Mutex::new(vec![]);
96
97pub fn with_parser<F, R>(func: F) -> R
98where
99 F: FnOnce(&mut Parser) -> R,
100{
101 let mut parser = PARSERS.lock().pop().unwrap_or_else(|| {
102 let mut parser = Parser::new();
103 parser
104 .set_wasm_store(WasmStore::new(&WASM_ENGINE).unwrap())
105 .unwrap();
106 parser
107 });
108 parser.set_included_ranges(&[]).unwrap();
109 let result = func(&mut parser);
110 PARSERS.lock().push(parser);
111 result
112}
113
114pub fn with_query_cursor<F, R>(func: F) -> R
115where
116 F: FnOnce(&mut QueryCursor) -> R,
117{
118 let mut cursor = QueryCursorHandle::new();
119 func(cursor.deref_mut())
120}
121
122static NEXT_LANGUAGE_ID: LazyLock<AtomicUsize> = LazyLock::new(Default::default);
123static NEXT_GRAMMAR_ID: LazyLock<AtomicUsize> = LazyLock::new(Default::default);
124static WASM_ENGINE: LazyLock<wasmtime::Engine> = LazyLock::new(|| {
125 wasmtime::Engine::new(&wasmtime::Config::new()).expect("Failed to create Wasmtime engine")
126});
127
128/// A shared grammar for plain text, exposed for reuse by downstream crates.
129pub static PLAIN_TEXT: LazyLock<Arc<Language>> = LazyLock::new(|| {
130 Arc::new(Language::new(
131 LanguageConfig {
132 name: "Plain Text".into(),
133 soft_wrap: Some(SoftWrap::EditorWidth),
134 matcher: LanguageMatcher {
135 path_suffixes: vec!["txt".to_owned()],
136 first_line_pattern: None,
137 },
138 ..Default::default()
139 },
140 None,
141 ))
142});
143
144/// Types that represent a position in a buffer, and can be converted into
145/// an LSP position, to send to a language server.
146pub trait ToLspPosition {
147 /// Converts the value into an LSP position.
148 fn to_lsp_position(self) -> lsp::Position;
149}
150
151#[derive(Debug, Clone, PartialEq, Eq, Hash)]
152pub struct Location {
153 pub buffer: Entity<Buffer>,
154 pub range: Range<Anchor>,
155}
156
157/// Represents a Language Server, with certain cached sync properties.
158/// Uses [`LspAdapter`] under the hood, but calls all 'static' methods
159/// once at startup, and caches the results.
160pub struct CachedLspAdapter {
161 pub name: LanguageServerName,
162 pub disk_based_diagnostic_sources: Vec<String>,
163 pub disk_based_diagnostics_progress_token: Option<String>,
164 language_ids: HashMap<String, String>,
165 pub adapter: Arc<dyn LspAdapter>,
166 pub reinstall_attempt_count: AtomicU64,
167 cached_binary: futures::lock::Mutex<Option<LanguageServerBinary>>,
168 manifest_name: OnceLock<Option<ManifestName>>,
169 attach_kind: OnceLock<Attach>,
170}
171
172impl Debug for CachedLspAdapter {
173 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
174 f.debug_struct("CachedLspAdapter")
175 .field("name", &self.name)
176 .field(
177 "disk_based_diagnostic_sources",
178 &self.disk_based_diagnostic_sources,
179 )
180 .field(
181 "disk_based_diagnostics_progress_token",
182 &self.disk_based_diagnostics_progress_token,
183 )
184 .field("language_ids", &self.language_ids)
185 .field("reinstall_attempt_count", &self.reinstall_attempt_count)
186 .finish_non_exhaustive()
187 }
188}
189
190impl CachedLspAdapter {
191 pub fn new(adapter: Arc<dyn LspAdapter>) -> Arc<Self> {
192 let name = adapter.name();
193 let disk_based_diagnostic_sources = adapter.disk_based_diagnostic_sources();
194 let disk_based_diagnostics_progress_token = adapter.disk_based_diagnostics_progress_token();
195 let language_ids = adapter.language_ids();
196
197 Arc::new(CachedLspAdapter {
198 name,
199 disk_based_diagnostic_sources,
200 disk_based_diagnostics_progress_token,
201 language_ids,
202 adapter,
203 cached_binary: Default::default(),
204 reinstall_attempt_count: AtomicU64::new(0),
205 attach_kind: Default::default(),
206 manifest_name: Default::default(),
207 })
208 }
209
210 pub fn name(&self) -> LanguageServerName {
211 self.adapter.name().clone()
212 }
213
214 pub async fn get_language_server_command(
215 self: Arc<Self>,
216 delegate: Arc<dyn LspAdapterDelegate>,
217 toolchains: Arc<dyn LanguageToolchainStore>,
218 binary_options: LanguageServerBinaryOptions,
219 cx: &mut AsyncApp,
220 ) -> Result<LanguageServerBinary> {
221 let cached_binary = self.cached_binary.lock().await;
222 self.adapter
223 .clone()
224 .get_language_server_command(delegate, toolchains, binary_options, cached_binary, cx)
225 .await
226 }
227
228 pub fn code_action_kinds(&self) -> Option<Vec<CodeActionKind>> {
229 self.adapter.code_action_kinds()
230 }
231
232 pub fn process_diagnostics(
233 &self,
234 params: &mut lsp::PublishDiagnosticsParams,
235 server_id: LanguageServerId,
236 existing_diagnostics: Option<&'_ Buffer>,
237 ) {
238 self.adapter
239 .process_diagnostics(params, server_id, existing_diagnostics)
240 }
241
242 pub fn retain_old_diagnostic(&self, previous_diagnostic: &Diagnostic, cx: &App) -> bool {
243 self.adapter.retain_old_diagnostic(previous_diagnostic, cx)
244 }
245
246 pub fn diagnostic_message_to_markdown(&self, message: &str) -> Option<String> {
247 self.adapter.diagnostic_message_to_markdown(message)
248 }
249
250 pub async fn process_completions(&self, completion_items: &mut [lsp::CompletionItem]) {
251 self.adapter.process_completions(completion_items).await
252 }
253
254 pub async fn labels_for_completions(
255 &self,
256 completion_items: &[lsp::CompletionItem],
257 language: &Arc<Language>,
258 ) -> Result<Vec<Option<CodeLabel>>> {
259 self.adapter
260 .clone()
261 .labels_for_completions(completion_items, language)
262 .await
263 }
264
265 pub async fn labels_for_symbols(
266 &self,
267 symbols: &[(String, lsp::SymbolKind)],
268 language: &Arc<Language>,
269 ) -> Result<Vec<Option<CodeLabel>>> {
270 self.adapter
271 .clone()
272 .labels_for_symbols(symbols, language)
273 .await
274 }
275
276 pub fn language_id(&self, language_name: &LanguageName) -> String {
277 self.language_ids
278 .get(language_name.as_ref())
279 .cloned()
280 .unwrap_or_else(|| language_name.lsp_id())
281 }
282 pub fn manifest_name(&self) -> Option<ManifestName> {
283 self.manifest_name
284 .get_or_init(|| self.adapter.manifest_name())
285 .clone()
286 }
287 pub fn attach_kind(&self) -> Attach {
288 *self.attach_kind.get_or_init(|| self.adapter.attach_kind())
289 }
290}
291
292#[derive(Clone, Copy, Debug, PartialEq)]
293pub enum Attach {
294 /// Create a single language server instance per subproject root.
295 InstancePerRoot,
296 /// Use one shared language server instance for all subprojects within a project.
297 Shared,
298}
299
300impl Attach {
301 pub fn root_path(
302 &self,
303 root_subproject_path: (WorktreeId, Arc<Path>),
304 ) -> (WorktreeId, Arc<Path>) {
305 match self {
306 Attach::InstancePerRoot => root_subproject_path,
307 Attach::Shared => (root_subproject_path.0, Arc::from(Path::new(""))),
308 }
309 }
310}
311
312/// [`LspAdapterDelegate`] allows [`LspAdapter]` implementations to interface with the application
313// e.g. to display a notification or fetch data from the web.
314#[async_trait]
315pub trait LspAdapterDelegate: Send + Sync {
316 fn show_notification(&self, message: &str, cx: &mut App);
317 fn http_client(&self) -> Arc<dyn HttpClient>;
318 fn worktree_id(&self) -> WorktreeId;
319 fn worktree_root_path(&self) -> &Path;
320 fn exists(&self, path: &Path, is_dir: Option<bool>) -> bool;
321 fn update_status(&self, language: LanguageServerName, status: BinaryStatus);
322 fn registered_lsp_adapters(&self) -> Vec<Arc<dyn LspAdapter>>;
323 async fn language_server_download_dir(&self, name: &LanguageServerName) -> Option<Arc<Path>>;
324
325 async fn npm_package_installed_version(
326 &self,
327 package_name: &str,
328 ) -> Result<Option<(PathBuf, String)>>;
329 async fn which(&self, command: &OsStr) -> Option<PathBuf>;
330 async fn shell_env(&self) -> HashMap<String, String>;
331 async fn read_text_file(&self, path: PathBuf) -> Result<String>;
332 async fn try_exec(&self, binary: LanguageServerBinary) -> Result<()>;
333}
334
335#[async_trait(?Send)]
336pub trait LspAdapter: 'static + Send + Sync {
337 fn name(&self) -> LanguageServerName;
338
339 fn get_language_server_command<'a>(
340 self: Arc<Self>,
341 delegate: Arc<dyn LspAdapterDelegate>,
342 toolchains: Arc<dyn LanguageToolchainStore>,
343 binary_options: LanguageServerBinaryOptions,
344 mut cached_binary: futures::lock::MutexGuard<'a, Option<LanguageServerBinary>>,
345 cx: &'a mut AsyncApp,
346 ) -> Pin<Box<dyn 'a + Future<Output = Result<LanguageServerBinary>>>> {
347 async move {
348 // First we check whether the adapter can give us a user-installed binary.
349 // If so, we do *not* want to cache that, because each worktree might give us a different
350 // binary:
351 //
352 // worktree 1: user-installed at `.bin/gopls`
353 // worktree 2: user-installed at `~/bin/gopls`
354 // worktree 3: no gopls found in PATH -> fallback to Zed installation
355 //
356 // We only want to cache when we fall back to the global one,
357 // because we don't want to download and overwrite our global one
358 // for each worktree we might have open.
359 if binary_options.allow_path_lookup {
360 if let Some(binary) = self.check_if_user_installed(delegate.as_ref(), toolchains, cx).await {
361 log::info!(
362 "found user-installed language server for {}. path: {:?}, arguments: {:?}",
363 self.name().0,
364 binary.path,
365 binary.arguments
366 );
367 return Ok(binary);
368 }
369 }
370
371 if !binary_options.allow_binary_download {
372 return Err(anyhow!("downloading language servers disabled"));
373 }
374
375 if let Some(cached_binary) = cached_binary.as_ref() {
376 return Ok(cached_binary.clone());
377 }
378
379 let Some(container_dir) = delegate.language_server_download_dir(&self.name()).await else {
380 anyhow::bail!("no language server download dir defined")
381 };
382
383 let mut binary = try_fetch_server_binary(self.as_ref(), &delegate, container_dir.to_path_buf(), cx).await;
384
385 if let Err(error) = binary.as_ref() {
386 if let Some(prev_downloaded_binary) = self
387 .cached_server_binary(container_dir.to_path_buf(), delegate.as_ref())
388 .await
389 {
390 log::info!(
391 "failed to fetch newest version of language server {:?}. error: {:?}, falling back to using {:?}",
392 self.name(),
393 error,
394 prev_downloaded_binary.path
395 );
396 binary = Ok(prev_downloaded_binary);
397 } else {
398 delegate.update_status(
399 self.name(),
400 BinaryStatus::Failed {
401 error: format!("{error:?}"),
402 },
403 );
404 }
405 }
406
407 if let Ok(binary) = &binary {
408 *cached_binary = Some(binary.clone());
409 }
410
411 binary
412 }
413 .boxed_local()
414 }
415
416 async fn check_if_user_installed(
417 &self,
418 _: &dyn LspAdapterDelegate,
419 _: Arc<dyn LanguageToolchainStore>,
420 _: &AsyncApp,
421 ) -> Option<LanguageServerBinary> {
422 None
423 }
424
425 async fn fetch_latest_server_version(
426 &self,
427 delegate: &dyn LspAdapterDelegate,
428 ) -> Result<Box<dyn 'static + Send + Any>>;
429
430 fn will_fetch_server(
431 &self,
432 _: &Arc<dyn LspAdapterDelegate>,
433 _: &mut AsyncApp,
434 ) -> Option<Task<Result<()>>> {
435 None
436 }
437
438 async fn check_if_version_installed(
439 &self,
440 _version: &(dyn 'static + Send + Any),
441 _container_dir: &PathBuf,
442 _delegate: &dyn LspAdapterDelegate,
443 ) -> Option<LanguageServerBinary> {
444 None
445 }
446
447 async fn fetch_server_binary(
448 &self,
449 latest_version: Box<dyn 'static + Send + Any>,
450 container_dir: PathBuf,
451 delegate: &dyn LspAdapterDelegate,
452 ) -> Result<LanguageServerBinary>;
453
454 async fn cached_server_binary(
455 &self,
456 container_dir: PathBuf,
457 delegate: &dyn LspAdapterDelegate,
458 ) -> Option<LanguageServerBinary>;
459
460 fn process_diagnostics(
461 &self,
462 _: &mut lsp::PublishDiagnosticsParams,
463 _: LanguageServerId,
464 _: Option<&'_ Buffer>,
465 ) {
466 }
467
468 /// When processing new `lsp::PublishDiagnosticsParams` diagnostics, whether to retain previous one(s) or not.
469 fn retain_old_diagnostic(&self, _previous_diagnostic: &Diagnostic, _cx: &App) -> bool {
470 false
471 }
472
473 /// Post-processes completions provided by the language server.
474 async fn process_completions(&self, _: &mut [lsp::CompletionItem]) {}
475
476 fn diagnostic_message_to_markdown(&self, _message: &str) -> Option<String> {
477 None
478 }
479
480 async fn labels_for_completions(
481 self: Arc<Self>,
482 completions: &[lsp::CompletionItem],
483 language: &Arc<Language>,
484 ) -> Result<Vec<Option<CodeLabel>>> {
485 let mut labels = Vec::new();
486 for (ix, completion) in completions.iter().enumerate() {
487 let label = self.label_for_completion(completion, language).await;
488 if let Some(label) = label {
489 labels.resize(ix + 1, None);
490 *labels.last_mut().unwrap() = Some(label);
491 }
492 }
493 Ok(labels)
494 }
495
496 async fn label_for_completion(
497 &self,
498 _: &lsp::CompletionItem,
499 _: &Arc<Language>,
500 ) -> Option<CodeLabel> {
501 None
502 }
503
504 async fn labels_for_symbols(
505 self: Arc<Self>,
506 symbols: &[(String, lsp::SymbolKind)],
507 language: &Arc<Language>,
508 ) -> Result<Vec<Option<CodeLabel>>> {
509 let mut labels = Vec::new();
510 for (ix, (name, kind)) in symbols.iter().enumerate() {
511 let label = self.label_for_symbol(name, *kind, language).await;
512 if let Some(label) = label {
513 labels.resize(ix + 1, None);
514 *labels.last_mut().unwrap() = Some(label);
515 }
516 }
517 Ok(labels)
518 }
519
520 async fn label_for_symbol(
521 &self,
522 _: &str,
523 _: lsp::SymbolKind,
524 _: &Arc<Language>,
525 ) -> Option<CodeLabel> {
526 None
527 }
528
529 /// Returns initialization options that are going to be sent to a LSP server as a part of [`lsp::InitializeParams`]
530 async fn initialization_options(
531 self: Arc<Self>,
532 _: &dyn Fs,
533 _: &Arc<dyn LspAdapterDelegate>,
534 ) -> Result<Option<Value>> {
535 Ok(None)
536 }
537
538 async fn workspace_configuration(
539 self: Arc<Self>,
540 _: &dyn Fs,
541 _: &Arc<dyn LspAdapterDelegate>,
542 _: Arc<dyn LanguageToolchainStore>,
543 _cx: &mut AsyncApp,
544 ) -> Result<Value> {
545 Ok(serde_json::json!({}))
546 }
547
548 async fn additional_initialization_options(
549 self: Arc<Self>,
550 _target_language_server_id: LanguageServerName,
551 _: &dyn Fs,
552 _: &Arc<dyn LspAdapterDelegate>,
553 ) -> Result<Option<Value>> {
554 Ok(None)
555 }
556
557 async fn additional_workspace_configuration(
558 self: Arc<Self>,
559 _target_language_server_id: LanguageServerName,
560 _: &dyn Fs,
561 _: &Arc<dyn LspAdapterDelegate>,
562 _: Arc<dyn LanguageToolchainStore>,
563 _cx: &mut AsyncApp,
564 ) -> Result<Option<Value>> {
565 Ok(None)
566 }
567
568 /// Returns a list of code actions supported by a given LspAdapter
569 fn code_action_kinds(&self) -> Option<Vec<CodeActionKind>> {
570 None
571 }
572
573 fn disk_based_diagnostic_sources(&self) -> Vec<String> {
574 Default::default()
575 }
576
577 fn disk_based_diagnostics_progress_token(&self) -> Option<String> {
578 None
579 }
580
581 fn language_ids(&self) -> HashMap<String, String> {
582 Default::default()
583 }
584
585 /// Support custom initialize params.
586 fn prepare_initialize_params(
587 &self,
588 original: InitializeParams,
589 _: &App,
590 ) -> Result<InitializeParams> {
591 Ok(original)
592 }
593
594 fn attach_kind(&self) -> Attach {
595 Attach::Shared
596 }
597
598 fn manifest_name(&self) -> Option<ManifestName> {
599 None
600 }
601
602 /// Method only implemented by the default JSON language server adapter.
603 /// Used to provide dynamic reloading of the JSON schemas used to
604 /// provide autocompletion and diagnostics in Zed setting and keybind
605 /// files
606 fn is_primary_zed_json_schema_adapter(&self) -> bool {
607 false
608 }
609
610 /// Method only implemented by the default JSON language server adapter.
611 /// Used to clear the cache of JSON schemas that are used to provide
612 /// autocompletion and diagnostics in Zed settings and keybinds files.
613 /// Should not be called unless the callee is sure that
614 /// `Self::is_primary_zed_json_schema_adapter` returns `true`
615 async fn clear_zed_json_schema_cache(&self) {
616 unreachable!(
617 "Not implemented for this adapter. This method should only be called on the default JSON language server adapter"
618 );
619 }
620}
621
622async fn try_fetch_server_binary<L: LspAdapter + 'static + Send + Sync + ?Sized>(
623 adapter: &L,
624 delegate: &Arc<dyn LspAdapterDelegate>,
625 container_dir: PathBuf,
626 cx: &mut AsyncApp,
627) -> Result<LanguageServerBinary> {
628 if let Some(task) = adapter.will_fetch_server(delegate, cx) {
629 task.await?;
630 }
631
632 let name = adapter.name();
633 log::info!("fetching latest version of language server {:?}", name.0);
634 delegate.update_status(name.clone(), BinaryStatus::CheckingForUpdate);
635
636 let latest_version = adapter
637 .fetch_latest_server_version(delegate.as_ref())
638 .await?;
639
640 if let Some(binary) = adapter
641 .check_if_version_installed(latest_version.as_ref(), &container_dir, delegate.as_ref())
642 .await
643 {
644 log::info!("language server {:?} is already installed", name.0);
645 delegate.update_status(name.clone(), BinaryStatus::None);
646 Ok(binary)
647 } else {
648 log::info!("downloading language server {:?}", name.0);
649 delegate.update_status(adapter.name(), BinaryStatus::Downloading);
650 let binary = adapter
651 .fetch_server_binary(latest_version, container_dir, delegate.as_ref())
652 .await;
653
654 delegate.update_status(name.clone(), BinaryStatus::None);
655 binary
656 }
657}
658
659#[derive(Clone, Debug, Default, PartialEq, Eq)]
660pub struct CodeLabel {
661 /// The text to display.
662 pub text: String,
663 /// Syntax highlighting runs.
664 pub runs: Vec<(Range<usize>, HighlightId)>,
665 /// The portion of the text that should be used in fuzzy filtering.
666 pub filter_range: Range<usize>,
667}
668
669#[derive(Clone, Deserialize, JsonSchema)]
670pub struct LanguageConfig {
671 /// Human-readable name of the language.
672 pub name: LanguageName,
673 /// The name of this language for a Markdown code fence block
674 pub code_fence_block_name: Option<Arc<str>>,
675 // The name of the grammar in a WASM bundle (experimental).
676 pub grammar: Option<Arc<str>>,
677 /// The criteria for matching this language to a given file.
678 #[serde(flatten)]
679 pub matcher: LanguageMatcher,
680 /// List of bracket types in a language.
681 #[serde(default)]
682 #[schemars(schema_with = "bracket_pair_config_json_schema")]
683 pub brackets: BracketPairConfig,
684 /// If set to true, indicates the language uses significant whitespace/indentation
685 /// for syntax structure (like Python) rather than brackets/braces for code blocks.
686 #[serde(default)]
687 pub significant_indentation: bool,
688 /// If set to true, auto indentation uses last non empty line to determine
689 /// the indentation level for a new line.
690 #[serde(default = "auto_indent_using_last_non_empty_line_default")]
691 pub auto_indent_using_last_non_empty_line: bool,
692 // Whether indentation of pasted content should be adjusted based on the context.
693 #[serde(default)]
694 pub auto_indent_on_paste: Option<bool>,
695 /// A regex that is used to determine whether the indentation level should be
696 /// increased in the following line.
697 #[serde(default, deserialize_with = "deserialize_regex")]
698 #[schemars(schema_with = "regex_json_schema")]
699 pub increase_indent_pattern: Option<Regex>,
700 /// A regex that is used to determine whether the indentation level should be
701 /// decreased in the following line.
702 #[serde(default, deserialize_with = "deserialize_regex")]
703 #[schemars(schema_with = "regex_json_schema")]
704 pub decrease_indent_pattern: Option<Regex>,
705 /// A list of characters that trigger the automatic insertion of a closing
706 /// bracket when they immediately precede the point where an opening
707 /// bracket is inserted.
708 #[serde(default)]
709 pub autoclose_before: String,
710 /// A placeholder used internally by Semantic Index.
711 #[serde(default)]
712 pub collapsed_placeholder: String,
713 /// A line comment string that is inserted in e.g. `toggle comments` action.
714 /// A language can have multiple flavours of line comments. All of the provided line comments are
715 /// used for comment continuations on the next line, but only the first one is used for Editor::ToggleComments.
716 #[serde(default)]
717 pub line_comments: Vec<Arc<str>>,
718 /// Starting and closing characters of a block comment.
719 #[serde(default)]
720 pub block_comment: Option<(Arc<str>, Arc<str>)>,
721 /// A list of language servers that are allowed to run on subranges of a given language.
722 #[serde(default)]
723 pub scope_opt_in_language_servers: Vec<LanguageServerName>,
724 #[serde(default)]
725 pub overrides: HashMap<String, LanguageConfigOverride>,
726 /// A list of characters that Zed should treat as word characters for the
727 /// purpose of features that operate on word boundaries, like 'move to next word end'
728 /// or a whole-word search in buffer search.
729 #[serde(default)]
730 pub word_characters: HashSet<char>,
731 /// Whether to indent lines using tab characters, as opposed to multiple
732 /// spaces.
733 #[serde(default)]
734 pub hard_tabs: Option<bool>,
735 /// How many columns a tab should occupy.
736 #[serde(default)]
737 pub tab_size: Option<NonZeroU32>,
738 /// How to soft-wrap long lines of text.
739 #[serde(default)]
740 pub soft_wrap: Option<SoftWrap>,
741 /// The name of a Prettier parser that will be used for this language when no file path is available.
742 /// If there's a parser name in the language settings, that will be used instead.
743 #[serde(default)]
744 pub prettier_parser_name: Option<String>,
745 /// If true, this language is only for syntax highlighting via an injection into other
746 /// languages, but should not appear to the user as a distinct language.
747 #[serde(default)]
748 pub hidden: bool,
749 /// If configured, this language contains JSX style tags, and should support auto-closing of those tags.
750 #[serde(default)]
751 pub jsx_tag_auto_close: Option<JsxTagAutoCloseConfig>,
752 /// A list of characters that Zed should treat as word characters for completion queries.
753 #[serde(default)]
754 pub completion_query_characters: HashSet<char>,
755 /// A list of preferred debuggers for this language.
756 #[serde(default)]
757 pub debuggers: IndexSet<SharedString>,
758 /// A character to add as a prefix when a new line is added to a documentation block.
759 #[serde(default)]
760 pub documentation_comment_prefix: Option<Arc<str>>,
761 /// Returns string documentation block of this language should start with.
762 #[serde(default)]
763 pub documentation_block: Option<Vec<Arc<str>>>,
764}
765
766#[derive(Clone, Debug, Serialize, Deserialize, Default, JsonSchema)]
767pub struct LanguageMatcher {
768 /// Given a list of `LanguageConfig`'s, the language of a file can be determined based on the path extension matching any of the `path_suffixes`.
769 #[serde(default)]
770 pub path_suffixes: Vec<String>,
771 /// A regex pattern that determines whether the language should be assigned to a file or not.
772 #[serde(
773 default,
774 serialize_with = "serialize_regex",
775 deserialize_with = "deserialize_regex"
776 )]
777 #[schemars(schema_with = "regex_json_schema")]
778 pub first_line_pattern: Option<Regex>,
779}
780
781/// The configuration for JSX tag auto-closing.
782#[derive(Clone, Deserialize, JsonSchema)]
783pub struct JsxTagAutoCloseConfig {
784 /// The name of the node for a opening tag
785 pub open_tag_node_name: String,
786 /// The name of the node for an closing tag
787 pub close_tag_node_name: String,
788 /// The name of the node for a complete element with children for open and close tags
789 pub jsx_element_node_name: String,
790 /// The name of the node found within both opening and closing
791 /// tags that describes the tag name
792 pub tag_name_node_name: String,
793 /// Alternate Node names for tag names.
794 /// Specifically needed as TSX represents the name in `<Foo.Bar>`
795 /// as `member_expression` rather than `identifier` as usual
796 #[serde(default)]
797 pub tag_name_node_name_alternates: Vec<String>,
798 /// Some grammars are smart enough to detect a closing tag
799 /// that is not valid i.e. doesn't match it's corresponding
800 /// opening tag or does not have a corresponding opening tag
801 /// This should be set to the name of the node for invalid
802 /// closing tags if the grammar contains such a node, otherwise
803 /// detecting already closed tags will not work properly
804 #[serde(default)]
805 pub erroneous_close_tag_node_name: Option<String>,
806 /// See above for erroneous_close_tag_node_name for details
807 /// This should be set if the node used for the tag name
808 /// within erroneous closing tags is different from the
809 /// normal tag name node name
810 #[serde(default)]
811 pub erroneous_close_tag_name_node_name: Option<String>,
812}
813
814/// Represents a language for the given range. Some languages (e.g. HTML)
815/// interleave several languages together, thus a single buffer might actually contain
816/// several nested scopes.
817#[derive(Clone, Debug)]
818pub struct LanguageScope {
819 language: Arc<Language>,
820 override_id: Option<u32>,
821}
822
823#[derive(Clone, Deserialize, Default, Debug, JsonSchema)]
824pub struct LanguageConfigOverride {
825 #[serde(default)]
826 pub line_comments: Override<Vec<Arc<str>>>,
827 #[serde(default)]
828 pub block_comment: Override<(Arc<str>, Arc<str>)>,
829 #[serde(skip)]
830 pub disabled_bracket_ixs: Vec<u16>,
831 #[serde(default)]
832 pub word_characters: Override<HashSet<char>>,
833 #[serde(default)]
834 pub completion_query_characters: Override<HashSet<char>>,
835 #[serde(default)]
836 pub opt_into_language_servers: Vec<LanguageServerName>,
837 #[serde(default)]
838 pub prefer_label_for_snippet: Option<bool>,
839}
840
841#[derive(Clone, Deserialize, Debug, Serialize, JsonSchema)]
842#[serde(untagged)]
843pub enum Override<T> {
844 Remove { remove: bool },
845 Set(T),
846}
847
848impl<T> Default for Override<T> {
849 fn default() -> Self {
850 Override::Remove { remove: false }
851 }
852}
853
854impl<T> Override<T> {
855 fn as_option<'a>(this: Option<&'a Self>, original: Option<&'a T>) -> Option<&'a T> {
856 match this {
857 Some(Self::Set(value)) => Some(value),
858 Some(Self::Remove { remove: true }) => None,
859 Some(Self::Remove { remove: false }) | None => original,
860 }
861 }
862}
863
864impl Default for LanguageConfig {
865 fn default() -> Self {
866 Self {
867 name: LanguageName::new(""),
868 code_fence_block_name: None,
869 grammar: None,
870 matcher: LanguageMatcher::default(),
871 brackets: Default::default(),
872 auto_indent_using_last_non_empty_line: auto_indent_using_last_non_empty_line_default(),
873 auto_indent_on_paste: None,
874 increase_indent_pattern: Default::default(),
875 decrease_indent_pattern: Default::default(),
876 autoclose_before: Default::default(),
877 line_comments: Default::default(),
878 block_comment: Default::default(),
879 scope_opt_in_language_servers: Default::default(),
880 overrides: Default::default(),
881 word_characters: Default::default(),
882 collapsed_placeholder: Default::default(),
883 hard_tabs: None,
884 tab_size: None,
885 soft_wrap: None,
886 prettier_parser_name: None,
887 hidden: false,
888 jsx_tag_auto_close: None,
889 completion_query_characters: Default::default(),
890 debuggers: Default::default(),
891 significant_indentation: Default::default(),
892 documentation_comment_prefix: None,
893 documentation_block: None,
894 }
895 }
896}
897
898fn auto_indent_using_last_non_empty_line_default() -> bool {
899 true
900}
901
902fn deserialize_regex<'de, D: Deserializer<'de>>(d: D) -> Result<Option<Regex>, D::Error> {
903 let source = Option::<String>::deserialize(d)?;
904 if let Some(source) = source {
905 Ok(Some(regex::Regex::new(&source).map_err(de::Error::custom)?))
906 } else {
907 Ok(None)
908 }
909}
910
911fn regex_json_schema(_: &mut SchemaGenerator) -> Schema {
912 Schema::Object(SchemaObject {
913 instance_type: Some(InstanceType::String.into()),
914 ..Default::default()
915 })
916}
917
918fn serialize_regex<S>(regex: &Option<Regex>, serializer: S) -> Result<S::Ok, S::Error>
919where
920 S: Serializer,
921{
922 match regex {
923 Some(regex) => serializer.serialize_str(regex.as_str()),
924 None => serializer.serialize_none(),
925 }
926}
927
928#[doc(hidden)]
929#[cfg(any(test, feature = "test-support"))]
930pub struct FakeLspAdapter {
931 pub name: &'static str,
932 pub initialization_options: Option<Value>,
933 pub prettier_plugins: Vec<&'static str>,
934 pub disk_based_diagnostics_progress_token: Option<String>,
935 pub disk_based_diagnostics_sources: Vec<String>,
936 pub language_server_binary: LanguageServerBinary,
937
938 pub capabilities: lsp::ServerCapabilities,
939 pub initializer: Option<Box<dyn 'static + Send + Sync + Fn(&mut lsp::FakeLanguageServer)>>,
940 pub label_for_completion: Option<
941 Box<
942 dyn 'static
943 + Send
944 + Sync
945 + Fn(&lsp::CompletionItem, &Arc<Language>) -> Option<CodeLabel>,
946 >,
947 >,
948}
949
950/// Configuration of handling bracket pairs for a given language.
951///
952/// This struct includes settings for defining which pairs of characters are considered brackets and
953/// also specifies any language-specific scopes where these pairs should be ignored for bracket matching purposes.
954#[derive(Clone, Debug, Default, JsonSchema)]
955pub struct BracketPairConfig {
956 /// A list of character pairs that should be treated as brackets in the context of a given language.
957 pub pairs: Vec<BracketPair>,
958 /// A list of tree-sitter scopes for which a given bracket should not be active.
959 /// N-th entry in `[Self::disabled_scopes_by_bracket_ix]` contains a list of disabled scopes for an n-th entry in `[Self::pairs]`
960 #[serde(skip)]
961 pub disabled_scopes_by_bracket_ix: Vec<Vec<String>>,
962}
963
964impl BracketPairConfig {
965 pub fn is_closing_brace(&self, c: char) -> bool {
966 self.pairs.iter().any(|pair| pair.end.starts_with(c))
967 }
968}
969
970fn bracket_pair_config_json_schema(r#gen: &mut SchemaGenerator) -> Schema {
971 Option::<Vec<BracketPairContent>>::json_schema(r#gen)
972}
973
974#[derive(Deserialize, JsonSchema)]
975pub struct BracketPairContent {
976 #[serde(flatten)]
977 pub bracket_pair: BracketPair,
978 #[serde(default)]
979 pub not_in: Vec<String>,
980}
981
982impl<'de> Deserialize<'de> for BracketPairConfig {
983 fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
984 where
985 D: Deserializer<'de>,
986 {
987 let result = Vec::<BracketPairContent>::deserialize(deserializer)?;
988 let mut brackets = Vec::with_capacity(result.len());
989 let mut disabled_scopes_by_bracket_ix = Vec::with_capacity(result.len());
990 for entry in result {
991 brackets.push(entry.bracket_pair);
992 disabled_scopes_by_bracket_ix.push(entry.not_in);
993 }
994
995 Ok(BracketPairConfig {
996 pairs: brackets,
997 disabled_scopes_by_bracket_ix,
998 })
999 }
1000}
1001
1002/// Describes a single bracket pair and how an editor should react to e.g. inserting
1003/// an opening bracket or to a newline character insertion in between `start` and `end` characters.
1004#[derive(Clone, Debug, Default, Deserialize, PartialEq, JsonSchema)]
1005pub struct BracketPair {
1006 /// Starting substring for a bracket.
1007 pub start: String,
1008 /// Ending substring for a bracket.
1009 pub end: String,
1010 /// True if `end` should be automatically inserted right after `start` characters.
1011 pub close: bool,
1012 /// True if selected text should be surrounded by `start` and `end` characters.
1013 #[serde(default = "default_true")]
1014 pub surround: bool,
1015 /// True if an extra newline should be inserted while the cursor is in the middle
1016 /// of that bracket pair.
1017 pub newline: bool,
1018}
1019
1020#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy)]
1021pub struct LanguageId(usize);
1022
1023impl LanguageId {
1024 pub(crate) fn new() -> Self {
1025 Self(NEXT_LANGUAGE_ID.fetch_add(1, SeqCst))
1026 }
1027}
1028
1029pub struct Language {
1030 pub(crate) id: LanguageId,
1031 pub(crate) config: LanguageConfig,
1032 pub(crate) grammar: Option<Arc<Grammar>>,
1033 pub(crate) context_provider: Option<Arc<dyn ContextProvider>>,
1034 pub(crate) toolchain: Option<Arc<dyn ToolchainLister>>,
1035}
1036
1037#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy)]
1038pub struct GrammarId(pub usize);
1039
1040impl GrammarId {
1041 pub(crate) fn new() -> Self {
1042 Self(NEXT_GRAMMAR_ID.fetch_add(1, SeqCst))
1043 }
1044}
1045
1046pub struct Grammar {
1047 id: GrammarId,
1048 pub ts_language: tree_sitter::Language,
1049 pub(crate) error_query: Option<Query>,
1050 pub(crate) highlights_query: Option<Query>,
1051 pub(crate) brackets_config: Option<BracketsConfig>,
1052 pub(crate) redactions_config: Option<RedactionConfig>,
1053 pub(crate) runnable_config: Option<RunnableConfig>,
1054 pub(crate) indents_config: Option<IndentConfig>,
1055 pub outline_config: Option<OutlineConfig>,
1056 pub text_object_config: Option<TextObjectConfig>,
1057 pub embedding_config: Option<EmbeddingConfig>,
1058 pub(crate) injection_config: Option<InjectionConfig>,
1059 pub(crate) override_config: Option<OverrideConfig>,
1060 pub(crate) highlight_map: Mutex<HighlightMap>,
1061}
1062
1063struct IndentConfig {
1064 query: Query,
1065 indent_capture_ix: u32,
1066 start_capture_ix: Option<u32>,
1067 end_capture_ix: Option<u32>,
1068 outdent_capture_ix: Option<u32>,
1069}
1070
1071pub struct OutlineConfig {
1072 pub query: Query,
1073 pub item_capture_ix: u32,
1074 pub name_capture_ix: u32,
1075 pub context_capture_ix: Option<u32>,
1076 pub extra_context_capture_ix: Option<u32>,
1077 pub open_capture_ix: Option<u32>,
1078 pub close_capture_ix: Option<u32>,
1079 pub annotation_capture_ix: Option<u32>,
1080}
1081
1082#[derive(Debug, Clone, Copy, PartialEq)]
1083pub enum TextObject {
1084 InsideFunction,
1085 AroundFunction,
1086 InsideClass,
1087 AroundClass,
1088 InsideComment,
1089 AroundComment,
1090}
1091
1092impl TextObject {
1093 pub fn from_capture_name(name: &str) -> Option<TextObject> {
1094 match name {
1095 "function.inside" => Some(TextObject::InsideFunction),
1096 "function.around" => Some(TextObject::AroundFunction),
1097 "class.inside" => Some(TextObject::InsideClass),
1098 "class.around" => Some(TextObject::AroundClass),
1099 "comment.inside" => Some(TextObject::InsideComment),
1100 "comment.around" => Some(TextObject::AroundComment),
1101 _ => None,
1102 }
1103 }
1104
1105 pub fn around(&self) -> Option<Self> {
1106 match self {
1107 TextObject::InsideFunction => Some(TextObject::AroundFunction),
1108 TextObject::InsideClass => Some(TextObject::AroundClass),
1109 TextObject::InsideComment => Some(TextObject::AroundComment),
1110 _ => None,
1111 }
1112 }
1113}
1114
1115pub struct TextObjectConfig {
1116 pub query: Query,
1117 pub text_objects_by_capture_ix: Vec<(u32, TextObject)>,
1118}
1119
1120#[derive(Debug)]
1121pub struct EmbeddingConfig {
1122 pub query: Query,
1123 pub item_capture_ix: u32,
1124 pub name_capture_ix: Option<u32>,
1125 pub context_capture_ix: Option<u32>,
1126 pub collapse_capture_ix: Option<u32>,
1127 pub keep_capture_ix: Option<u32>,
1128}
1129
1130struct InjectionConfig {
1131 query: Query,
1132 content_capture_ix: u32,
1133 language_capture_ix: Option<u32>,
1134 patterns: Vec<InjectionPatternConfig>,
1135}
1136
1137struct RedactionConfig {
1138 pub query: Query,
1139 pub redaction_capture_ix: u32,
1140}
1141
1142#[derive(Clone, Debug, PartialEq)]
1143enum RunnableCapture {
1144 Named(SharedString),
1145 Run,
1146}
1147
1148struct RunnableConfig {
1149 pub query: Query,
1150 /// A mapping from capture indice to capture kind
1151 pub extra_captures: Vec<RunnableCapture>,
1152}
1153
1154struct OverrideConfig {
1155 query: Query,
1156 values: HashMap<u32, OverrideEntry>,
1157}
1158
1159#[derive(Debug)]
1160struct OverrideEntry {
1161 name: String,
1162 range_is_inclusive: bool,
1163 value: LanguageConfigOverride,
1164}
1165
1166#[derive(Default, Clone)]
1167struct InjectionPatternConfig {
1168 language: Option<Box<str>>,
1169 combined: bool,
1170}
1171
1172struct BracketsConfig {
1173 query: Query,
1174 open_capture_ix: u32,
1175 close_capture_ix: u32,
1176 patterns: Vec<BracketsPatternConfig>,
1177}
1178
1179#[derive(Clone, Debug, Default)]
1180struct BracketsPatternConfig {
1181 newline_only: bool,
1182}
1183
1184impl Language {
1185 pub fn new(config: LanguageConfig, ts_language: Option<tree_sitter::Language>) -> Self {
1186 Self::new_with_id(LanguageId::new(), config, ts_language)
1187 }
1188
1189 pub fn id(&self) -> LanguageId {
1190 self.id
1191 }
1192
1193 fn new_with_id(
1194 id: LanguageId,
1195 config: LanguageConfig,
1196 ts_language: Option<tree_sitter::Language>,
1197 ) -> Self {
1198 Self {
1199 id,
1200 config,
1201 grammar: ts_language.map(|ts_language| {
1202 Arc::new(Grammar {
1203 id: GrammarId::new(),
1204 highlights_query: None,
1205 brackets_config: None,
1206 outline_config: None,
1207 text_object_config: None,
1208 embedding_config: None,
1209 indents_config: None,
1210 injection_config: None,
1211 override_config: None,
1212 redactions_config: None,
1213 runnable_config: None,
1214 error_query: Query::new(&ts_language, "(ERROR) @error").ok(),
1215 ts_language,
1216 highlight_map: Default::default(),
1217 })
1218 }),
1219 context_provider: None,
1220 toolchain: None,
1221 }
1222 }
1223
1224 pub fn with_context_provider(mut self, provider: Option<Arc<dyn ContextProvider>>) -> Self {
1225 self.context_provider = provider;
1226 self
1227 }
1228
1229 pub fn with_toolchain_lister(mut self, provider: Option<Arc<dyn ToolchainLister>>) -> Self {
1230 self.toolchain = provider;
1231 self
1232 }
1233
1234 pub fn with_queries(mut self, queries: LanguageQueries) -> Result<Self> {
1235 if let Some(query) = queries.highlights {
1236 self = self
1237 .with_highlights_query(query.as_ref())
1238 .context("Error loading highlights query")?;
1239 }
1240 if let Some(query) = queries.brackets {
1241 self = self
1242 .with_brackets_query(query.as_ref())
1243 .context("Error loading brackets query")?;
1244 }
1245 if let Some(query) = queries.indents {
1246 self = self
1247 .with_indents_query(query.as_ref())
1248 .context("Error loading indents query")?;
1249 }
1250 if let Some(query) = queries.outline {
1251 self = self
1252 .with_outline_query(query.as_ref())
1253 .context("Error loading outline query")?;
1254 }
1255 if let Some(query) = queries.embedding {
1256 self = self
1257 .with_embedding_query(query.as_ref())
1258 .context("Error loading embedding query")?;
1259 }
1260 if let Some(query) = queries.injections {
1261 self = self
1262 .with_injection_query(query.as_ref())
1263 .context("Error loading injection query")?;
1264 }
1265 if let Some(query) = queries.overrides {
1266 self = self
1267 .with_override_query(query.as_ref())
1268 .context("Error loading override query")?;
1269 }
1270 if let Some(query) = queries.redactions {
1271 self = self
1272 .with_redaction_query(query.as_ref())
1273 .context("Error loading redaction query")?;
1274 }
1275 if let Some(query) = queries.runnables {
1276 self = self
1277 .with_runnable_query(query.as_ref())
1278 .context("Error loading runnables query")?;
1279 }
1280 if let Some(query) = queries.text_objects {
1281 self = self
1282 .with_text_object_query(query.as_ref())
1283 .context("Error loading textobject query")?;
1284 }
1285 Ok(self)
1286 }
1287
1288 pub fn with_highlights_query(mut self, source: &str) -> Result<Self> {
1289 let grammar = self
1290 .grammar_mut()
1291 .ok_or_else(|| anyhow!("cannot mutate grammar"))?;
1292 grammar.highlights_query = Some(Query::new(&grammar.ts_language, source)?);
1293 Ok(self)
1294 }
1295
1296 pub fn with_runnable_query(mut self, source: &str) -> Result<Self> {
1297 let grammar = self
1298 .grammar_mut()
1299 .ok_or_else(|| anyhow!("cannot mutate grammar"))?;
1300
1301 let query = Query::new(&grammar.ts_language, source)?;
1302 let mut extra_captures = Vec::with_capacity(query.capture_names().len());
1303
1304 for name in query.capture_names().iter() {
1305 let kind = if *name == "run" {
1306 RunnableCapture::Run
1307 } else {
1308 RunnableCapture::Named(name.to_string().into())
1309 };
1310 extra_captures.push(kind);
1311 }
1312
1313 grammar.runnable_config = Some(RunnableConfig {
1314 extra_captures,
1315 query,
1316 });
1317
1318 Ok(self)
1319 }
1320
1321 pub fn with_outline_query(mut self, source: &str) -> Result<Self> {
1322 let grammar = self
1323 .grammar_mut()
1324 .ok_or_else(|| anyhow!("cannot mutate grammar"))?;
1325 let query = Query::new(&grammar.ts_language, source)?;
1326 let mut item_capture_ix = None;
1327 let mut name_capture_ix = None;
1328 let mut context_capture_ix = None;
1329 let mut extra_context_capture_ix = None;
1330 let mut open_capture_ix = None;
1331 let mut close_capture_ix = None;
1332 let mut annotation_capture_ix = None;
1333 get_capture_indices(
1334 &query,
1335 &mut [
1336 ("item", &mut item_capture_ix),
1337 ("name", &mut name_capture_ix),
1338 ("context", &mut context_capture_ix),
1339 ("context.extra", &mut extra_context_capture_ix),
1340 ("open", &mut open_capture_ix),
1341 ("close", &mut close_capture_ix),
1342 ("annotation", &mut annotation_capture_ix),
1343 ],
1344 );
1345 if let Some((item_capture_ix, name_capture_ix)) = item_capture_ix.zip(name_capture_ix) {
1346 grammar.outline_config = Some(OutlineConfig {
1347 query,
1348 item_capture_ix,
1349 name_capture_ix,
1350 context_capture_ix,
1351 extra_context_capture_ix,
1352 open_capture_ix,
1353 close_capture_ix,
1354 annotation_capture_ix,
1355 });
1356 }
1357 Ok(self)
1358 }
1359
1360 pub fn with_text_object_query(mut self, source: &str) -> Result<Self> {
1361 let grammar = self
1362 .grammar_mut()
1363 .ok_or_else(|| anyhow!("cannot mutate grammar"))?;
1364 let query = Query::new(&grammar.ts_language, source)?;
1365
1366 let mut text_objects_by_capture_ix = Vec::new();
1367 for (ix, name) in query.capture_names().iter().enumerate() {
1368 if let Some(text_object) = TextObject::from_capture_name(name) {
1369 text_objects_by_capture_ix.push((ix as u32, text_object));
1370 }
1371 }
1372
1373 grammar.text_object_config = Some(TextObjectConfig {
1374 query,
1375 text_objects_by_capture_ix,
1376 });
1377 Ok(self)
1378 }
1379
1380 pub fn with_embedding_query(mut self, source: &str) -> Result<Self> {
1381 let grammar = self
1382 .grammar_mut()
1383 .ok_or_else(|| anyhow!("cannot mutate grammar"))?;
1384 let query = Query::new(&grammar.ts_language, source)?;
1385 let mut item_capture_ix = None;
1386 let mut name_capture_ix = None;
1387 let mut context_capture_ix = None;
1388 let mut collapse_capture_ix = None;
1389 let mut keep_capture_ix = None;
1390 get_capture_indices(
1391 &query,
1392 &mut [
1393 ("item", &mut item_capture_ix),
1394 ("name", &mut name_capture_ix),
1395 ("context", &mut context_capture_ix),
1396 ("keep", &mut keep_capture_ix),
1397 ("collapse", &mut collapse_capture_ix),
1398 ],
1399 );
1400 if let Some(item_capture_ix) = item_capture_ix {
1401 grammar.embedding_config = Some(EmbeddingConfig {
1402 query,
1403 item_capture_ix,
1404 name_capture_ix,
1405 context_capture_ix,
1406 collapse_capture_ix,
1407 keep_capture_ix,
1408 });
1409 }
1410 Ok(self)
1411 }
1412
1413 pub fn with_brackets_query(mut self, source: &str) -> Result<Self> {
1414 let grammar = self
1415 .grammar_mut()
1416 .ok_or_else(|| anyhow!("cannot mutate grammar"))?;
1417 let query = Query::new(&grammar.ts_language, source)?;
1418 let mut open_capture_ix = None;
1419 let mut close_capture_ix = None;
1420 get_capture_indices(
1421 &query,
1422 &mut [
1423 ("open", &mut open_capture_ix),
1424 ("close", &mut close_capture_ix),
1425 ],
1426 );
1427 let patterns = (0..query.pattern_count())
1428 .map(|ix| {
1429 let mut config = BracketsPatternConfig::default();
1430 for setting in query.property_settings(ix) {
1431 match setting.key.as_ref() {
1432 "newline.only" => config.newline_only = true,
1433 _ => {}
1434 }
1435 }
1436 config
1437 })
1438 .collect();
1439 if let Some((open_capture_ix, close_capture_ix)) = open_capture_ix.zip(close_capture_ix) {
1440 grammar.brackets_config = Some(BracketsConfig {
1441 query,
1442 open_capture_ix,
1443 close_capture_ix,
1444 patterns,
1445 });
1446 }
1447 Ok(self)
1448 }
1449
1450 pub fn with_indents_query(mut self, source: &str) -> Result<Self> {
1451 let grammar = self
1452 .grammar_mut()
1453 .ok_or_else(|| anyhow!("cannot mutate grammar"))?;
1454 let query = Query::new(&grammar.ts_language, source)?;
1455 let mut indent_capture_ix = None;
1456 let mut start_capture_ix = None;
1457 let mut end_capture_ix = None;
1458 let mut outdent_capture_ix = None;
1459 get_capture_indices(
1460 &query,
1461 &mut [
1462 ("indent", &mut indent_capture_ix),
1463 ("start", &mut start_capture_ix),
1464 ("end", &mut end_capture_ix),
1465 ("outdent", &mut outdent_capture_ix),
1466 ],
1467 );
1468 if let Some(indent_capture_ix) = indent_capture_ix {
1469 grammar.indents_config = Some(IndentConfig {
1470 query,
1471 indent_capture_ix,
1472 start_capture_ix,
1473 end_capture_ix,
1474 outdent_capture_ix,
1475 });
1476 }
1477 Ok(self)
1478 }
1479
1480 pub fn with_injection_query(mut self, source: &str) -> Result<Self> {
1481 let grammar = self
1482 .grammar_mut()
1483 .ok_or_else(|| anyhow!("cannot mutate grammar"))?;
1484 let query = Query::new(&grammar.ts_language, source)?;
1485 let mut language_capture_ix = None;
1486 let mut injection_language_capture_ix = None;
1487 let mut content_capture_ix = None;
1488 let mut injection_content_capture_ix = None;
1489 get_capture_indices(
1490 &query,
1491 &mut [
1492 ("language", &mut language_capture_ix),
1493 ("injection.language", &mut injection_language_capture_ix),
1494 ("content", &mut content_capture_ix),
1495 ("injection.content", &mut injection_content_capture_ix),
1496 ],
1497 );
1498 language_capture_ix = match (language_capture_ix, injection_language_capture_ix) {
1499 (None, Some(ix)) => Some(ix),
1500 (Some(_), Some(_)) => {
1501 return Err(anyhow!(
1502 "both language and injection.language captures are present"
1503 ));
1504 }
1505 _ => language_capture_ix,
1506 };
1507 content_capture_ix = match (content_capture_ix, injection_content_capture_ix) {
1508 (None, Some(ix)) => Some(ix),
1509 (Some(_), Some(_)) => {
1510 return Err(anyhow!(
1511 "both content and injection.content captures are present"
1512 ));
1513 }
1514 _ => content_capture_ix,
1515 };
1516 let patterns = (0..query.pattern_count())
1517 .map(|ix| {
1518 let mut config = InjectionPatternConfig::default();
1519 for setting in query.property_settings(ix) {
1520 match setting.key.as_ref() {
1521 "language" | "injection.language" => {
1522 config.language.clone_from(&setting.value);
1523 }
1524 "combined" | "injection.combined" => {
1525 config.combined = true;
1526 }
1527 _ => {}
1528 }
1529 }
1530 config
1531 })
1532 .collect();
1533 if let Some(content_capture_ix) = content_capture_ix {
1534 grammar.injection_config = Some(InjectionConfig {
1535 query,
1536 language_capture_ix,
1537 content_capture_ix,
1538 patterns,
1539 });
1540 }
1541 Ok(self)
1542 }
1543
1544 pub fn with_override_query(mut self, source: &str) -> anyhow::Result<Self> {
1545 let query = {
1546 let grammar = self
1547 .grammar
1548 .as_ref()
1549 .ok_or_else(|| anyhow!("no grammar for language"))?;
1550 Query::new(&grammar.ts_language, source)?
1551 };
1552
1553 let mut override_configs_by_id = HashMap::default();
1554 for (ix, mut name) in query.capture_names().iter().copied().enumerate() {
1555 let mut range_is_inclusive = false;
1556 if name.starts_with('_') {
1557 continue;
1558 }
1559 if let Some(prefix) = name.strip_suffix(".inclusive") {
1560 name = prefix;
1561 range_is_inclusive = true;
1562 }
1563
1564 let value = self.config.overrides.get(name).cloned().unwrap_or_default();
1565 for server_name in &value.opt_into_language_servers {
1566 if !self
1567 .config
1568 .scope_opt_in_language_servers
1569 .contains(server_name)
1570 {
1571 util::debug_panic!(
1572 "Server {server_name:?} has been opted-in by scope {name:?} but has not been marked as an opt-in server"
1573 );
1574 }
1575 }
1576
1577 override_configs_by_id.insert(
1578 ix as u32,
1579 OverrideEntry {
1580 name: name.to_string(),
1581 range_is_inclusive,
1582 value,
1583 },
1584 );
1585 }
1586
1587 let referenced_override_names = self.config.overrides.keys().chain(
1588 self.config
1589 .brackets
1590 .disabled_scopes_by_bracket_ix
1591 .iter()
1592 .flatten(),
1593 );
1594
1595 for referenced_name in referenced_override_names {
1596 if !override_configs_by_id
1597 .values()
1598 .any(|entry| entry.name == *referenced_name)
1599 {
1600 Err(anyhow!(
1601 "language {:?} has overrides in config not in query: {referenced_name:?}",
1602 self.config.name
1603 ))?;
1604 }
1605 }
1606
1607 for entry in override_configs_by_id.values_mut() {
1608 entry.value.disabled_bracket_ixs = self
1609 .config
1610 .brackets
1611 .disabled_scopes_by_bracket_ix
1612 .iter()
1613 .enumerate()
1614 .filter_map(|(ix, disabled_scope_names)| {
1615 if disabled_scope_names.contains(&entry.name) {
1616 Some(ix as u16)
1617 } else {
1618 None
1619 }
1620 })
1621 .collect();
1622 }
1623
1624 self.config.brackets.disabled_scopes_by_bracket_ix.clear();
1625
1626 let grammar = self
1627 .grammar_mut()
1628 .ok_or_else(|| anyhow!("cannot mutate grammar"))?;
1629 grammar.override_config = Some(OverrideConfig {
1630 query,
1631 values: override_configs_by_id,
1632 });
1633 Ok(self)
1634 }
1635
1636 pub fn with_redaction_query(mut self, source: &str) -> anyhow::Result<Self> {
1637 let grammar = self
1638 .grammar_mut()
1639 .ok_or_else(|| anyhow!("cannot mutate grammar"))?;
1640
1641 let query = Query::new(&grammar.ts_language, source)?;
1642 let mut redaction_capture_ix = None;
1643 get_capture_indices(&query, &mut [("redact", &mut redaction_capture_ix)]);
1644
1645 if let Some(redaction_capture_ix) = redaction_capture_ix {
1646 grammar.redactions_config = Some(RedactionConfig {
1647 query,
1648 redaction_capture_ix,
1649 });
1650 }
1651
1652 Ok(self)
1653 }
1654
1655 fn grammar_mut(&mut self) -> Option<&mut Grammar> {
1656 Arc::get_mut(self.grammar.as_mut()?)
1657 }
1658
1659 pub fn name(&self) -> LanguageName {
1660 self.config.name.clone()
1661 }
1662
1663 pub fn code_fence_block_name(&self) -> Arc<str> {
1664 self.config
1665 .code_fence_block_name
1666 .clone()
1667 .unwrap_or_else(|| self.config.name.as_ref().to_lowercase().into())
1668 }
1669
1670 pub fn context_provider(&self) -> Option<Arc<dyn ContextProvider>> {
1671 self.context_provider.clone()
1672 }
1673
1674 pub fn toolchain_lister(&self) -> Option<Arc<dyn ToolchainLister>> {
1675 self.toolchain.clone()
1676 }
1677
1678 pub fn highlight_text<'a>(
1679 self: &'a Arc<Self>,
1680 text: &'a Rope,
1681 range: Range<usize>,
1682 ) -> Vec<(Range<usize>, HighlightId)> {
1683 let mut result = Vec::new();
1684 if let Some(grammar) = &self.grammar {
1685 let tree = grammar.parse_text(text, None);
1686 let captures =
1687 SyntaxSnapshot::single_tree_captures(range.clone(), text, &tree, self, |grammar| {
1688 grammar.highlights_query.as_ref()
1689 });
1690 let highlight_maps = vec![grammar.highlight_map()];
1691 let mut offset = 0;
1692 for chunk in
1693 BufferChunks::new(text, range, Some((captures, highlight_maps)), false, None)
1694 {
1695 let end_offset = offset + chunk.text.len();
1696 if let Some(highlight_id) = chunk.syntax_highlight_id {
1697 if !highlight_id.is_default() {
1698 result.push((offset..end_offset, highlight_id));
1699 }
1700 }
1701 offset = end_offset;
1702 }
1703 }
1704 result
1705 }
1706
1707 pub fn path_suffixes(&self) -> &[String] {
1708 &self.config.matcher.path_suffixes
1709 }
1710
1711 pub fn should_autoclose_before(&self, c: char) -> bool {
1712 c.is_whitespace() || self.config.autoclose_before.contains(c)
1713 }
1714
1715 pub fn set_theme(&self, theme: &SyntaxTheme) {
1716 if let Some(grammar) = self.grammar.as_ref() {
1717 if let Some(highlights_query) = &grammar.highlights_query {
1718 *grammar.highlight_map.lock() =
1719 HighlightMap::new(highlights_query.capture_names(), theme);
1720 }
1721 }
1722 }
1723
1724 pub fn grammar(&self) -> Option<&Arc<Grammar>> {
1725 self.grammar.as_ref()
1726 }
1727
1728 pub fn default_scope(self: &Arc<Self>) -> LanguageScope {
1729 LanguageScope {
1730 language: self.clone(),
1731 override_id: None,
1732 }
1733 }
1734
1735 pub fn lsp_id(&self) -> String {
1736 self.config.name.lsp_id()
1737 }
1738
1739 pub fn prettier_parser_name(&self) -> Option<&str> {
1740 self.config.prettier_parser_name.as_deref()
1741 }
1742
1743 pub fn config(&self) -> &LanguageConfig {
1744 &self.config
1745 }
1746}
1747
1748impl LanguageScope {
1749 pub fn path_suffixes(&self) -> &[String] {
1750 &self.language.path_suffixes()
1751 }
1752
1753 pub fn language_name(&self) -> LanguageName {
1754 self.language.config.name.clone()
1755 }
1756
1757 pub fn collapsed_placeholder(&self) -> &str {
1758 self.language.config.collapsed_placeholder.as_ref()
1759 }
1760
1761 /// Returns line prefix that is inserted in e.g. line continuations or
1762 /// in `toggle comments` action.
1763 pub fn line_comment_prefixes(&self) -> &[Arc<str>] {
1764 Override::as_option(
1765 self.config_override().map(|o| &o.line_comments),
1766 Some(&self.language.config.line_comments),
1767 )
1768 .map_or([].as_slice(), |e| e.as_slice())
1769 }
1770
1771 pub fn block_comment_delimiters(&self) -> Option<(&Arc<str>, &Arc<str>)> {
1772 Override::as_option(
1773 self.config_override().map(|o| &o.block_comment),
1774 self.language.config.block_comment.as_ref(),
1775 )
1776 .map(|e| (&e.0, &e.1))
1777 }
1778
1779 /// Returns a list of language-specific word characters.
1780 ///
1781 /// By default, Zed treats alphanumeric characters (and '_') as word characters for
1782 /// the purpose of actions like 'move to next word end` or whole-word search.
1783 /// It additionally accounts for language's additional word characters.
1784 pub fn word_characters(&self) -> Option<&HashSet<char>> {
1785 Override::as_option(
1786 self.config_override().map(|o| &o.word_characters),
1787 Some(&self.language.config.word_characters),
1788 )
1789 }
1790
1791 /// Returns a list of language-specific characters that are considered part of
1792 /// a completion query.
1793 pub fn completion_query_characters(&self) -> Option<&HashSet<char>> {
1794 Override::as_option(
1795 self.config_override()
1796 .map(|o| &o.completion_query_characters),
1797 Some(&self.language.config.completion_query_characters),
1798 )
1799 }
1800
1801 /// Returns whether to prefer snippet `label` over `new_text` to replace text when
1802 /// completion is accepted.
1803 ///
1804 /// In cases like when cursor is in string or renaming existing function,
1805 /// you don't want to expand function signature instead just want function name
1806 /// to replace existing one.
1807 pub fn prefers_label_for_snippet_in_completion(&self) -> bool {
1808 self.config_override()
1809 .and_then(|o| o.prefer_label_for_snippet)
1810 .unwrap_or(false)
1811 }
1812
1813 /// A character to add as a prefix when a new line is added to a documentation block.
1814 ///
1815 /// Used for documentation styles that require a leading character on each line,
1816 /// such as the asterisk in JSDoc, Javadoc, etc.
1817 pub fn documentation_comment_prefix(&self) -> Option<&Arc<str>> {
1818 self.language.config.documentation_comment_prefix.as_ref()
1819 }
1820
1821 /// Returns prefix and suffix for documentation block of this language.
1822 pub fn documentation_block(&self) -> &[Arc<str>] {
1823 self.language
1824 .config
1825 .documentation_block
1826 .as_ref()
1827 .map_or([].as_slice(), |e| e.as_slice())
1828 }
1829
1830 /// Returns a list of bracket pairs for a given language with an additional
1831 /// piece of information about whether the particular bracket pair is currently active for a given language.
1832 pub fn brackets(&self) -> impl Iterator<Item = (&BracketPair, bool)> {
1833 let mut disabled_ids = self
1834 .config_override()
1835 .map_or(&[] as _, |o| o.disabled_bracket_ixs.as_slice());
1836 self.language
1837 .config
1838 .brackets
1839 .pairs
1840 .iter()
1841 .enumerate()
1842 .map(move |(ix, bracket)| {
1843 let mut is_enabled = true;
1844 if let Some(next_disabled_ix) = disabled_ids.first() {
1845 if ix == *next_disabled_ix as usize {
1846 disabled_ids = &disabled_ids[1..];
1847 is_enabled = false;
1848 }
1849 }
1850 (bracket, is_enabled)
1851 })
1852 }
1853
1854 pub fn should_autoclose_before(&self, c: char) -> bool {
1855 c.is_whitespace() || self.language.config.autoclose_before.contains(c)
1856 }
1857
1858 pub fn language_allowed(&self, name: &LanguageServerName) -> bool {
1859 let config = &self.language.config;
1860 let opt_in_servers = &config.scope_opt_in_language_servers;
1861 if opt_in_servers.iter().any(|o| *o == *name) {
1862 if let Some(over) = self.config_override() {
1863 over.opt_into_language_servers.iter().any(|o| *o == *name)
1864 } else {
1865 false
1866 }
1867 } else {
1868 true
1869 }
1870 }
1871
1872 pub fn override_name(&self) -> Option<&str> {
1873 let id = self.override_id?;
1874 let grammar = self.language.grammar.as_ref()?;
1875 let override_config = grammar.override_config.as_ref()?;
1876 override_config.values.get(&id).map(|e| e.name.as_str())
1877 }
1878
1879 fn config_override(&self) -> Option<&LanguageConfigOverride> {
1880 let id = self.override_id?;
1881 let grammar = self.language.grammar.as_ref()?;
1882 let override_config = grammar.override_config.as_ref()?;
1883 override_config.values.get(&id).map(|e| &e.value)
1884 }
1885}
1886
1887impl Hash for Language {
1888 fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
1889 self.id.hash(state)
1890 }
1891}
1892
1893impl PartialEq for Language {
1894 fn eq(&self, other: &Self) -> bool {
1895 self.id.eq(&other.id)
1896 }
1897}
1898
1899impl Eq for Language {}
1900
1901impl Debug for Language {
1902 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1903 f.debug_struct("Language")
1904 .field("name", &self.config.name)
1905 .finish()
1906 }
1907}
1908
1909impl Grammar {
1910 pub fn id(&self) -> GrammarId {
1911 self.id
1912 }
1913
1914 fn parse_text(&self, text: &Rope, old_tree: Option<Tree>) -> Tree {
1915 with_parser(|parser| {
1916 parser
1917 .set_language(&self.ts_language)
1918 .expect("incompatible grammar");
1919 let mut chunks = text.chunks_in_range(0..text.len());
1920 parser
1921 .parse_with_options(
1922 &mut move |offset, _| {
1923 chunks.seek(offset);
1924 chunks.next().unwrap_or("").as_bytes()
1925 },
1926 old_tree.as_ref(),
1927 None,
1928 )
1929 .unwrap()
1930 })
1931 }
1932
1933 pub fn highlight_map(&self) -> HighlightMap {
1934 self.highlight_map.lock().clone()
1935 }
1936
1937 pub fn highlight_id_for_name(&self, name: &str) -> Option<HighlightId> {
1938 let capture_id = self
1939 .highlights_query
1940 .as_ref()?
1941 .capture_index_for_name(name)?;
1942 Some(self.highlight_map.lock().get(capture_id))
1943 }
1944}
1945
1946impl CodeLabel {
1947 pub fn fallback_for_completion(
1948 item: &lsp::CompletionItem,
1949 language: Option<&Language>,
1950 ) -> Self {
1951 let highlight_id = item.kind.and_then(|kind| {
1952 let grammar = language?.grammar()?;
1953 use lsp::CompletionItemKind as Kind;
1954 match kind {
1955 Kind::CLASS => grammar.highlight_id_for_name("type"),
1956 Kind::CONSTANT => grammar.highlight_id_for_name("constant"),
1957 Kind::CONSTRUCTOR => grammar.highlight_id_for_name("constructor"),
1958 Kind::ENUM => grammar
1959 .highlight_id_for_name("enum")
1960 .or_else(|| grammar.highlight_id_for_name("type")),
1961 Kind::ENUM_MEMBER => grammar
1962 .highlight_id_for_name("variant")
1963 .or_else(|| grammar.highlight_id_for_name("property")),
1964 Kind::FIELD => grammar.highlight_id_for_name("property"),
1965 Kind::FUNCTION => grammar.highlight_id_for_name("function"),
1966 Kind::INTERFACE => grammar.highlight_id_for_name("type"),
1967 Kind::METHOD => grammar
1968 .highlight_id_for_name("function.method")
1969 .or_else(|| grammar.highlight_id_for_name("function")),
1970 Kind::OPERATOR => grammar.highlight_id_for_name("operator"),
1971 Kind::PROPERTY => grammar.highlight_id_for_name("property"),
1972 Kind::STRUCT => grammar.highlight_id_for_name("type"),
1973 Kind::VARIABLE => grammar.highlight_id_for_name("variable"),
1974 Kind::KEYWORD => grammar.highlight_id_for_name("keyword"),
1975 _ => None,
1976 }
1977 });
1978
1979 let label = &item.label;
1980 let label_length = label.len();
1981 let runs = highlight_id
1982 .map(|highlight_id| vec![(0..label_length, highlight_id)])
1983 .unwrap_or_default();
1984 let text = if let Some(detail) = item.detail.as_deref().filter(|detail| detail != label) {
1985 format!("{label} {detail}")
1986 } else if let Some(description) = item
1987 .label_details
1988 .as_ref()
1989 .and_then(|label_details| label_details.description.as_deref())
1990 .filter(|description| description != label)
1991 {
1992 format!("{label} {description}")
1993 } else {
1994 label.clone()
1995 };
1996 Self {
1997 text,
1998 runs,
1999 filter_range: 0..label_length,
2000 }
2001 }
2002
2003 pub fn plain(text: String, filter_text: Option<&str>) -> Self {
2004 let mut result = Self {
2005 runs: Vec::new(),
2006 filter_range: 0..text.len(),
2007 text,
2008 };
2009 if let Some(filter_text) = filter_text {
2010 if let Some(ix) = result.text.find(filter_text) {
2011 result.filter_range = ix..ix + filter_text.len();
2012 }
2013 }
2014 result
2015 }
2016
2017 pub fn push_str(&mut self, text: &str, highlight: Option<HighlightId>) {
2018 let start_ix = self.text.len();
2019 self.text.push_str(text);
2020 let end_ix = self.text.len();
2021 if let Some(highlight) = highlight {
2022 self.runs.push((start_ix..end_ix, highlight));
2023 }
2024 }
2025
2026 pub fn text(&self) -> &str {
2027 self.text.as_str()
2028 }
2029
2030 pub fn filter_text(&self) -> &str {
2031 &self.text[self.filter_range.clone()]
2032 }
2033}
2034
2035impl From<String> for CodeLabel {
2036 fn from(value: String) -> Self {
2037 Self::plain(value, None)
2038 }
2039}
2040
2041impl From<&str> for CodeLabel {
2042 fn from(value: &str) -> Self {
2043 Self::plain(value.to_string(), None)
2044 }
2045}
2046
2047impl Ord for LanguageMatcher {
2048 fn cmp(&self, other: &Self) -> std::cmp::Ordering {
2049 self.path_suffixes.cmp(&other.path_suffixes).then_with(|| {
2050 self.first_line_pattern
2051 .as_ref()
2052 .map(Regex::as_str)
2053 .cmp(&other.first_line_pattern.as_ref().map(Regex::as_str))
2054 })
2055 }
2056}
2057
2058impl PartialOrd for LanguageMatcher {
2059 fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
2060 Some(self.cmp(other))
2061 }
2062}
2063
2064impl Eq for LanguageMatcher {}
2065
2066impl PartialEq for LanguageMatcher {
2067 fn eq(&self, other: &Self) -> bool {
2068 self.path_suffixes == other.path_suffixes
2069 && self.first_line_pattern.as_ref().map(Regex::as_str)
2070 == other.first_line_pattern.as_ref().map(Regex::as_str)
2071 }
2072}
2073
2074#[cfg(any(test, feature = "test-support"))]
2075impl Default for FakeLspAdapter {
2076 fn default() -> Self {
2077 Self {
2078 name: "the-fake-language-server",
2079 capabilities: lsp::LanguageServer::full_capabilities(),
2080 initializer: None,
2081 disk_based_diagnostics_progress_token: None,
2082 initialization_options: None,
2083 disk_based_diagnostics_sources: Vec::new(),
2084 prettier_plugins: Vec::new(),
2085 language_server_binary: LanguageServerBinary {
2086 path: "/the/fake/lsp/path".into(),
2087 arguments: vec![],
2088 env: Default::default(),
2089 },
2090 label_for_completion: None,
2091 }
2092 }
2093}
2094
2095#[cfg(any(test, feature = "test-support"))]
2096#[async_trait(?Send)]
2097impl LspAdapter for FakeLspAdapter {
2098 fn name(&self) -> LanguageServerName {
2099 LanguageServerName(self.name.into())
2100 }
2101
2102 async fn check_if_user_installed(
2103 &self,
2104 _: &dyn LspAdapterDelegate,
2105 _: Arc<dyn LanguageToolchainStore>,
2106 _: &AsyncApp,
2107 ) -> Option<LanguageServerBinary> {
2108 Some(self.language_server_binary.clone())
2109 }
2110
2111 fn get_language_server_command<'a>(
2112 self: Arc<Self>,
2113 _: Arc<dyn LspAdapterDelegate>,
2114 _: Arc<dyn LanguageToolchainStore>,
2115 _: LanguageServerBinaryOptions,
2116 _: futures::lock::MutexGuard<'a, Option<LanguageServerBinary>>,
2117 _: &'a mut AsyncApp,
2118 ) -> Pin<Box<dyn 'a + Future<Output = Result<LanguageServerBinary>>>> {
2119 async move { Ok(self.language_server_binary.clone()) }.boxed_local()
2120 }
2121
2122 async fn fetch_latest_server_version(
2123 &self,
2124 _: &dyn LspAdapterDelegate,
2125 ) -> Result<Box<dyn 'static + Send + Any>> {
2126 unreachable!();
2127 }
2128
2129 async fn fetch_server_binary(
2130 &self,
2131 _: Box<dyn 'static + Send + Any>,
2132 _: PathBuf,
2133 _: &dyn LspAdapterDelegate,
2134 ) -> Result<LanguageServerBinary> {
2135 unreachable!();
2136 }
2137
2138 async fn cached_server_binary(
2139 &self,
2140 _: PathBuf,
2141 _: &dyn LspAdapterDelegate,
2142 ) -> Option<LanguageServerBinary> {
2143 unreachable!();
2144 }
2145
2146 fn disk_based_diagnostic_sources(&self) -> Vec<String> {
2147 self.disk_based_diagnostics_sources.clone()
2148 }
2149
2150 fn disk_based_diagnostics_progress_token(&self) -> Option<String> {
2151 self.disk_based_diagnostics_progress_token.clone()
2152 }
2153
2154 async fn initialization_options(
2155 self: Arc<Self>,
2156 _: &dyn Fs,
2157 _: &Arc<dyn LspAdapterDelegate>,
2158 ) -> Result<Option<Value>> {
2159 Ok(self.initialization_options.clone())
2160 }
2161
2162 async fn label_for_completion(
2163 &self,
2164 item: &lsp::CompletionItem,
2165 language: &Arc<Language>,
2166 ) -> Option<CodeLabel> {
2167 let label_for_completion = self.label_for_completion.as_ref()?;
2168 label_for_completion(item, language)
2169 }
2170}
2171
2172fn get_capture_indices(query: &Query, captures: &mut [(&str, &mut Option<u32>)]) {
2173 for (ix, name) in query.capture_names().iter().enumerate() {
2174 for (capture_name, index) in captures.iter_mut() {
2175 if capture_name == name {
2176 **index = Some(ix as u32);
2177 break;
2178 }
2179 }
2180 }
2181}
2182
2183pub fn point_to_lsp(point: PointUtf16) -> lsp::Position {
2184 lsp::Position::new(point.row, point.column)
2185}
2186
2187pub fn point_from_lsp(point: lsp::Position) -> Unclipped<PointUtf16> {
2188 Unclipped(PointUtf16::new(point.line, point.character))
2189}
2190
2191pub fn range_to_lsp(range: Range<PointUtf16>) -> Result<lsp::Range> {
2192 if range.start > range.end {
2193 Err(anyhow!(
2194 "Inverted range provided to an LSP request: {:?}-{:?}",
2195 range.start,
2196 range.end
2197 ))
2198 } else {
2199 Ok(lsp::Range {
2200 start: point_to_lsp(range.start),
2201 end: point_to_lsp(range.end),
2202 })
2203 }
2204}
2205
2206pub fn range_from_lsp(range: lsp::Range) -> Range<Unclipped<PointUtf16>> {
2207 let mut start = point_from_lsp(range.start);
2208 let mut end = point_from_lsp(range.end);
2209 if start > end {
2210 log::warn!("range_from_lsp called with inverted range {start:?}-{end:?}");
2211 mem::swap(&mut start, &mut end);
2212 }
2213 start..end
2214}
2215
2216#[cfg(test)]
2217mod tests {
2218 use super::*;
2219 use gpui::TestAppContext;
2220
2221 #[gpui::test(iterations = 10)]
2222 async fn test_language_loading(cx: &mut TestAppContext) {
2223 let languages = LanguageRegistry::test(cx.executor());
2224 let languages = Arc::new(languages);
2225 languages.register_native_grammars([
2226 ("json", tree_sitter_json::LANGUAGE),
2227 ("rust", tree_sitter_rust::LANGUAGE),
2228 ]);
2229 languages.register_test_language(LanguageConfig {
2230 name: "JSON".into(),
2231 grammar: Some("json".into()),
2232 matcher: LanguageMatcher {
2233 path_suffixes: vec!["json".into()],
2234 ..Default::default()
2235 },
2236 ..Default::default()
2237 });
2238 languages.register_test_language(LanguageConfig {
2239 name: "Rust".into(),
2240 grammar: Some("rust".into()),
2241 matcher: LanguageMatcher {
2242 path_suffixes: vec!["rs".into()],
2243 ..Default::default()
2244 },
2245 ..Default::default()
2246 });
2247 assert_eq!(
2248 languages.language_names(),
2249 &[
2250 "JSON".to_string(),
2251 "Plain Text".to_string(),
2252 "Rust".to_string(),
2253 ]
2254 );
2255
2256 let rust1 = languages.language_for_name("Rust");
2257 let rust2 = languages.language_for_name("Rust");
2258
2259 // Ensure language is still listed even if it's being loaded.
2260 assert_eq!(
2261 languages.language_names(),
2262 &[
2263 "JSON".to_string(),
2264 "Plain Text".to_string(),
2265 "Rust".to_string(),
2266 ]
2267 );
2268
2269 let (rust1, rust2) = futures::join!(rust1, rust2);
2270 assert!(Arc::ptr_eq(&rust1.unwrap(), &rust2.unwrap()));
2271
2272 // Ensure language is still listed even after loading it.
2273 assert_eq!(
2274 languages.language_names(),
2275 &[
2276 "JSON".to_string(),
2277 "Plain Text".to_string(),
2278 "Rust".to_string(),
2279 ]
2280 );
2281
2282 // Loading an unknown language returns an error.
2283 assert!(languages.language_for_name("Unknown").await.is_err());
2284 }
2285
2286 #[gpui::test]
2287 async fn test_completion_label_omits_duplicate_data() {
2288 let regular_completion_item_1 = lsp::CompletionItem {
2289 label: "regular1".to_string(),
2290 detail: Some("detail1".to_string()),
2291 label_details: Some(lsp::CompletionItemLabelDetails {
2292 detail: None,
2293 description: Some("description 1".to_string()),
2294 }),
2295 ..lsp::CompletionItem::default()
2296 };
2297
2298 let regular_completion_item_2 = lsp::CompletionItem {
2299 label: "regular2".to_string(),
2300 label_details: Some(lsp::CompletionItemLabelDetails {
2301 detail: None,
2302 description: Some("description 2".to_string()),
2303 }),
2304 ..lsp::CompletionItem::default()
2305 };
2306
2307 let completion_item_with_duplicate_detail_and_proper_description = lsp::CompletionItem {
2308 detail: Some(regular_completion_item_1.label.clone()),
2309 ..regular_completion_item_1.clone()
2310 };
2311
2312 let completion_item_with_duplicate_detail = lsp::CompletionItem {
2313 detail: Some(regular_completion_item_1.label.clone()),
2314 label_details: None,
2315 ..regular_completion_item_1.clone()
2316 };
2317
2318 let completion_item_with_duplicate_description = lsp::CompletionItem {
2319 label_details: Some(lsp::CompletionItemLabelDetails {
2320 detail: None,
2321 description: Some(regular_completion_item_2.label.clone()),
2322 }),
2323 ..regular_completion_item_2.clone()
2324 };
2325
2326 assert_eq!(
2327 CodeLabel::fallback_for_completion(®ular_completion_item_1, None).text,
2328 format!(
2329 "{} {}",
2330 regular_completion_item_1.label,
2331 regular_completion_item_1.detail.unwrap()
2332 ),
2333 "LSP completion items with both detail and label_details.description should prefer detail"
2334 );
2335 assert_eq!(
2336 CodeLabel::fallback_for_completion(®ular_completion_item_2, None).text,
2337 format!(
2338 "{} {}",
2339 regular_completion_item_2.label,
2340 regular_completion_item_2
2341 .label_details
2342 .as_ref()
2343 .unwrap()
2344 .description
2345 .as_ref()
2346 .unwrap()
2347 ),
2348 "LSP completion items without detail but with label_details.description should use that"
2349 );
2350 assert_eq!(
2351 CodeLabel::fallback_for_completion(
2352 &completion_item_with_duplicate_detail_and_proper_description,
2353 None
2354 )
2355 .text,
2356 format!(
2357 "{} {}",
2358 regular_completion_item_1.label,
2359 regular_completion_item_1
2360 .label_details
2361 .as_ref()
2362 .unwrap()
2363 .description
2364 .as_ref()
2365 .unwrap()
2366 ),
2367 "LSP completion items with both detail and label_details.description should prefer description only if the detail duplicates the completion label"
2368 );
2369 assert_eq!(
2370 CodeLabel::fallback_for_completion(&completion_item_with_duplicate_detail, None).text,
2371 regular_completion_item_1.label,
2372 "LSP completion items with duplicate label and detail, should omit the detail"
2373 );
2374 assert_eq!(
2375 CodeLabel::fallback_for_completion(&completion_item_with_duplicate_description, None)
2376 .text,
2377 regular_completion_item_2.label,
2378 "LSP completion items with duplicate label and detail, should omit the detail"
2379 );
2380 }
2381}