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};
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, auto indentation uses last non empty line to determine
685 /// the indentation level for a new line.
686 #[serde(default = "auto_indent_using_last_non_empty_line_default")]
687 pub auto_indent_using_last_non_empty_line: bool,
688 // Whether indentation of pasted content should be adjusted based on the context.
689 #[serde(default)]
690 pub auto_indent_on_paste: Option<bool>,
691 /// A regex that is used to determine whether the indentation level should be
692 /// increased in the following line.
693 #[serde(default, deserialize_with = "deserialize_regex")]
694 #[schemars(schema_with = "regex_json_schema")]
695 pub increase_indent_pattern: Option<Regex>,
696 /// A regex that is used to determine whether the indentation level should be
697 /// decreased in the following line.
698 #[serde(default, deserialize_with = "deserialize_regex")]
699 #[schemars(schema_with = "regex_json_schema")]
700 pub decrease_indent_pattern: Option<Regex>,
701 /// A list of characters that trigger the automatic insertion of a closing
702 /// bracket when they immediately precede the point where an opening
703 /// bracket is inserted.
704 #[serde(default)]
705 pub autoclose_before: String,
706 /// A placeholder used internally by Semantic Index.
707 #[serde(default)]
708 pub collapsed_placeholder: String,
709 /// A line comment string that is inserted in e.g. `toggle comments` action.
710 /// A language can have multiple flavours of line comments. All of the provided line comments are
711 /// used for comment continuations on the next line, but only the first one is used for Editor::ToggleComments.
712 #[serde(default)]
713 pub line_comments: Vec<Arc<str>>,
714 /// Starting and closing characters of a block comment.
715 #[serde(default)]
716 pub block_comment: Option<(Arc<str>, Arc<str>)>,
717 /// A list of language servers that are allowed to run on subranges of a given language.
718 #[serde(default)]
719 pub scope_opt_in_language_servers: Vec<LanguageServerName>,
720 #[serde(default)]
721 pub overrides: HashMap<String, LanguageConfigOverride>,
722 /// A list of characters that Zed should treat as word characters for the
723 /// purpose of features that operate on word boundaries, like 'move to next word end'
724 /// or a whole-word search in buffer search.
725 #[serde(default)]
726 pub word_characters: HashSet<char>,
727 /// Whether to indent lines using tab characters, as opposed to multiple
728 /// spaces.
729 #[serde(default)]
730 pub hard_tabs: Option<bool>,
731 /// How many columns a tab should occupy.
732 #[serde(default)]
733 pub tab_size: Option<NonZeroU32>,
734 /// How to soft-wrap long lines of text.
735 #[serde(default)]
736 pub soft_wrap: Option<SoftWrap>,
737 /// The name of a Prettier parser that will be used for this language when no file path is available.
738 /// If there's a parser name in the language settings, that will be used instead.
739 #[serde(default)]
740 pub prettier_parser_name: Option<String>,
741 /// If true, this language is only for syntax highlighting via an injection into other
742 /// languages, but should not appear to the user as a distinct language.
743 #[serde(default)]
744 pub hidden: bool,
745 /// If configured, this language contains JSX style tags, and should support auto-closing of those tags.
746 #[serde(default)]
747 pub jsx_tag_auto_close: Option<JsxTagAutoCloseConfig>,
748 /// A list of characters that Zed should treat as word characters for completion queries.
749 #[serde(default)]
750 pub completion_query_characters: HashSet<char>,
751}
752
753#[derive(Clone, Debug, Serialize, Deserialize, Default, JsonSchema)]
754pub struct LanguageMatcher {
755 /// 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`.
756 #[serde(default)]
757 pub path_suffixes: Vec<String>,
758 /// A regex pattern that determines whether the language should be assigned to a file or not.
759 #[serde(
760 default,
761 serialize_with = "serialize_regex",
762 deserialize_with = "deserialize_regex"
763 )]
764 #[schemars(schema_with = "regex_json_schema")]
765 pub first_line_pattern: Option<Regex>,
766}
767
768/// The configuration for JSX tag auto-closing.
769#[derive(Clone, Deserialize, JsonSchema)]
770pub struct JsxTagAutoCloseConfig {
771 /// The name of the node for a opening tag
772 pub open_tag_node_name: String,
773 /// The name of the node for an closing tag
774 pub close_tag_node_name: String,
775 /// The name of the node for a complete element with children for open and close tags
776 pub jsx_element_node_name: String,
777 /// The name of the node found within both opening and closing
778 /// tags that describes the tag name
779 pub tag_name_node_name: String,
780 /// Alternate Node names for tag names.
781 /// Specifically needed as TSX represents the name in `<Foo.Bar>`
782 /// as `member_expression` rather than `identifier` as usual
783 #[serde(default)]
784 pub tag_name_node_name_alternates: Vec<String>,
785 /// Some grammars are smart enough to detect a closing tag
786 /// that is not valid i.e. doesn't match it's corresponding
787 /// opening tag or does not have a corresponding opening tag
788 /// This should be set to the name of the node for invalid
789 /// closing tags if the grammar contains such a node, otherwise
790 /// detecting already closed tags will not work properly
791 #[serde(default)]
792 pub erroneous_close_tag_node_name: Option<String>,
793 /// See above for erroneous_close_tag_node_name for details
794 /// This should be set if the node used for the tag name
795 /// within erroneous closing tags is different from the
796 /// normal tag name node name
797 #[serde(default)]
798 pub erroneous_close_tag_name_node_name: Option<String>,
799}
800
801/// Represents a language for the given range. Some languages (e.g. HTML)
802/// interleave several languages together, thus a single buffer might actually contain
803/// several nested scopes.
804#[derive(Clone, Debug)]
805pub struct LanguageScope {
806 language: Arc<Language>,
807 override_id: Option<u32>,
808}
809
810#[derive(Clone, Deserialize, Default, Debug, JsonSchema)]
811pub struct LanguageConfigOverride {
812 #[serde(default)]
813 pub line_comments: Override<Vec<Arc<str>>>,
814 #[serde(default)]
815 pub block_comment: Override<(Arc<str>, Arc<str>)>,
816 #[serde(skip)]
817 pub disabled_bracket_ixs: Vec<u16>,
818 #[serde(default)]
819 pub word_characters: Override<HashSet<char>>,
820 #[serde(default)]
821 pub completion_query_characters: Override<HashSet<char>>,
822 #[serde(default)]
823 pub opt_into_language_servers: Vec<LanguageServerName>,
824}
825
826#[derive(Clone, Deserialize, Debug, Serialize, JsonSchema)]
827#[serde(untagged)]
828pub enum Override<T> {
829 Remove { remove: bool },
830 Set(T),
831}
832
833impl<T> Default for Override<T> {
834 fn default() -> Self {
835 Override::Remove { remove: false }
836 }
837}
838
839impl<T> Override<T> {
840 fn as_option<'a>(this: Option<&'a Self>, original: Option<&'a T>) -> Option<&'a T> {
841 match this {
842 Some(Self::Set(value)) => Some(value),
843 Some(Self::Remove { remove: true }) => None,
844 Some(Self::Remove { remove: false }) | None => original,
845 }
846 }
847}
848
849impl Default for LanguageConfig {
850 fn default() -> Self {
851 Self {
852 name: LanguageName::new(""),
853 code_fence_block_name: None,
854 grammar: None,
855 matcher: LanguageMatcher::default(),
856 brackets: Default::default(),
857 auto_indent_using_last_non_empty_line: auto_indent_using_last_non_empty_line_default(),
858 auto_indent_on_paste: None,
859 increase_indent_pattern: Default::default(),
860 decrease_indent_pattern: Default::default(),
861 autoclose_before: Default::default(),
862 line_comments: Default::default(),
863 block_comment: Default::default(),
864 scope_opt_in_language_servers: Default::default(),
865 overrides: Default::default(),
866 word_characters: Default::default(),
867 collapsed_placeholder: Default::default(),
868 hard_tabs: None,
869 tab_size: None,
870 soft_wrap: None,
871 prettier_parser_name: None,
872 hidden: false,
873 jsx_tag_auto_close: None,
874 completion_query_characters: Default::default(),
875 }
876 }
877}
878
879fn auto_indent_using_last_non_empty_line_default() -> bool {
880 true
881}
882
883fn deserialize_regex<'de, D: Deserializer<'de>>(d: D) -> Result<Option<Regex>, D::Error> {
884 let source = Option::<String>::deserialize(d)?;
885 if let Some(source) = source {
886 Ok(Some(regex::Regex::new(&source).map_err(de::Error::custom)?))
887 } else {
888 Ok(None)
889 }
890}
891
892fn regex_json_schema(_: &mut SchemaGenerator) -> Schema {
893 Schema::Object(SchemaObject {
894 instance_type: Some(InstanceType::String.into()),
895 ..Default::default()
896 })
897}
898
899fn serialize_regex<S>(regex: &Option<Regex>, serializer: S) -> Result<S::Ok, S::Error>
900where
901 S: Serializer,
902{
903 match regex {
904 Some(regex) => serializer.serialize_str(regex.as_str()),
905 None => serializer.serialize_none(),
906 }
907}
908
909#[doc(hidden)]
910#[cfg(any(test, feature = "test-support"))]
911pub struct FakeLspAdapter {
912 pub name: &'static str,
913 pub initialization_options: Option<Value>,
914 pub prettier_plugins: Vec<&'static str>,
915 pub disk_based_diagnostics_progress_token: Option<String>,
916 pub disk_based_diagnostics_sources: Vec<String>,
917 pub language_server_binary: LanguageServerBinary,
918
919 pub capabilities: lsp::ServerCapabilities,
920 pub initializer: Option<Box<dyn 'static + Send + Sync + Fn(&mut lsp::FakeLanguageServer)>>,
921 pub label_for_completion: Option<
922 Box<
923 dyn 'static
924 + Send
925 + Sync
926 + Fn(&lsp::CompletionItem, &Arc<Language>) -> Option<CodeLabel>,
927 >,
928 >,
929}
930
931/// Configuration of handling bracket pairs for a given language.
932///
933/// This struct includes settings for defining which pairs of characters are considered brackets and
934/// also specifies any language-specific scopes where these pairs should be ignored for bracket matching purposes.
935#[derive(Clone, Debug, Default, JsonSchema)]
936pub struct BracketPairConfig {
937 /// A list of character pairs that should be treated as brackets in the context of a given language.
938 pub pairs: Vec<BracketPair>,
939 /// A list of tree-sitter scopes for which a given bracket should not be active.
940 /// N-th entry in `[Self::disabled_scopes_by_bracket_ix]` contains a list of disabled scopes for an n-th entry in `[Self::pairs]`
941 #[serde(skip)]
942 pub disabled_scopes_by_bracket_ix: Vec<Vec<String>>,
943}
944
945impl BracketPairConfig {
946 pub fn is_closing_brace(&self, c: char) -> bool {
947 self.pairs.iter().any(|pair| pair.end.starts_with(c))
948 }
949}
950
951fn bracket_pair_config_json_schema(r#gen: &mut SchemaGenerator) -> Schema {
952 Option::<Vec<BracketPairContent>>::json_schema(r#gen)
953}
954
955#[derive(Deserialize, JsonSchema)]
956pub struct BracketPairContent {
957 #[serde(flatten)]
958 pub bracket_pair: BracketPair,
959 #[serde(default)]
960 pub not_in: Vec<String>,
961}
962
963impl<'de> Deserialize<'de> for BracketPairConfig {
964 fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
965 where
966 D: Deserializer<'de>,
967 {
968 let result = Vec::<BracketPairContent>::deserialize(deserializer)?;
969 let mut brackets = Vec::with_capacity(result.len());
970 let mut disabled_scopes_by_bracket_ix = Vec::with_capacity(result.len());
971 for entry in result {
972 brackets.push(entry.bracket_pair);
973 disabled_scopes_by_bracket_ix.push(entry.not_in);
974 }
975
976 Ok(BracketPairConfig {
977 pairs: brackets,
978 disabled_scopes_by_bracket_ix,
979 })
980 }
981}
982
983/// Describes a single bracket pair and how an editor should react to e.g. inserting
984/// an opening bracket or to a newline character insertion in between `start` and `end` characters.
985#[derive(Clone, Debug, Default, Deserialize, PartialEq, JsonSchema)]
986pub struct BracketPair {
987 /// Starting substring for a bracket.
988 pub start: String,
989 /// Ending substring for a bracket.
990 pub end: String,
991 /// True if `end` should be automatically inserted right after `start` characters.
992 pub close: bool,
993 /// True if selected text should be surrounded by `start` and `end` characters.
994 #[serde(default = "default_true")]
995 pub surround: bool,
996 /// True if an extra newline should be inserted while the cursor is in the middle
997 /// of that bracket pair.
998 pub newline: bool,
999}
1000
1001#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy)]
1002pub struct LanguageId(usize);
1003
1004impl LanguageId {
1005 pub(crate) fn new() -> Self {
1006 Self(NEXT_LANGUAGE_ID.fetch_add(1, SeqCst))
1007 }
1008}
1009
1010pub struct Language {
1011 pub(crate) id: LanguageId,
1012 pub(crate) config: LanguageConfig,
1013 pub(crate) grammar: Option<Arc<Grammar>>,
1014 pub(crate) context_provider: Option<Arc<dyn ContextProvider>>,
1015 pub(crate) toolchain: Option<Arc<dyn ToolchainLister>>,
1016}
1017
1018#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy)]
1019pub struct GrammarId(pub usize);
1020
1021impl GrammarId {
1022 pub(crate) fn new() -> Self {
1023 Self(NEXT_GRAMMAR_ID.fetch_add(1, SeqCst))
1024 }
1025}
1026
1027pub struct Grammar {
1028 id: GrammarId,
1029 pub ts_language: tree_sitter::Language,
1030 pub(crate) error_query: Option<Query>,
1031 pub(crate) highlights_query: Option<Query>,
1032 pub(crate) brackets_config: Option<BracketsConfig>,
1033 pub(crate) redactions_config: Option<RedactionConfig>,
1034 pub(crate) runnable_config: Option<RunnableConfig>,
1035 pub(crate) debug_variables_config: Option<DebugVariablesConfig>,
1036 pub(crate) indents_config: Option<IndentConfig>,
1037 pub outline_config: Option<OutlineConfig>,
1038 pub text_object_config: Option<TextObjectConfig>,
1039 pub embedding_config: Option<EmbeddingConfig>,
1040 pub(crate) injection_config: Option<InjectionConfig>,
1041 pub(crate) override_config: Option<OverrideConfig>,
1042 pub(crate) highlight_map: Mutex<HighlightMap>,
1043}
1044
1045struct IndentConfig {
1046 query: Query,
1047 indent_capture_ix: u32,
1048 start_capture_ix: Option<u32>,
1049 end_capture_ix: Option<u32>,
1050 outdent_capture_ix: Option<u32>,
1051}
1052
1053pub struct OutlineConfig {
1054 pub query: Query,
1055 pub item_capture_ix: u32,
1056 pub name_capture_ix: u32,
1057 pub context_capture_ix: Option<u32>,
1058 pub extra_context_capture_ix: Option<u32>,
1059 pub open_capture_ix: Option<u32>,
1060 pub close_capture_ix: Option<u32>,
1061 pub annotation_capture_ix: Option<u32>,
1062}
1063
1064#[derive(Debug, Clone, Copy, PartialEq)]
1065pub enum TextObject {
1066 InsideFunction,
1067 AroundFunction,
1068 InsideClass,
1069 AroundClass,
1070 InsideComment,
1071 AroundComment,
1072}
1073
1074impl TextObject {
1075 pub fn from_capture_name(name: &str) -> Option<TextObject> {
1076 match name {
1077 "function.inside" => Some(TextObject::InsideFunction),
1078 "function.around" => Some(TextObject::AroundFunction),
1079 "class.inside" => Some(TextObject::InsideClass),
1080 "class.around" => Some(TextObject::AroundClass),
1081 "comment.inside" => Some(TextObject::InsideComment),
1082 "comment.around" => Some(TextObject::AroundComment),
1083 _ => None,
1084 }
1085 }
1086
1087 pub fn around(&self) -> Option<Self> {
1088 match self {
1089 TextObject::InsideFunction => Some(TextObject::AroundFunction),
1090 TextObject::InsideClass => Some(TextObject::AroundClass),
1091 TextObject::InsideComment => Some(TextObject::AroundComment),
1092 _ => None,
1093 }
1094 }
1095}
1096
1097pub struct TextObjectConfig {
1098 pub query: Query,
1099 pub text_objects_by_capture_ix: Vec<(u32, TextObject)>,
1100}
1101
1102#[derive(Debug)]
1103pub struct EmbeddingConfig {
1104 pub query: Query,
1105 pub item_capture_ix: u32,
1106 pub name_capture_ix: Option<u32>,
1107 pub context_capture_ix: Option<u32>,
1108 pub collapse_capture_ix: Option<u32>,
1109 pub keep_capture_ix: Option<u32>,
1110}
1111
1112struct InjectionConfig {
1113 query: Query,
1114 content_capture_ix: u32,
1115 language_capture_ix: Option<u32>,
1116 patterns: Vec<InjectionPatternConfig>,
1117}
1118
1119struct RedactionConfig {
1120 pub query: Query,
1121 pub redaction_capture_ix: u32,
1122}
1123
1124#[derive(Clone, Debug, PartialEq)]
1125enum RunnableCapture {
1126 Named(SharedString),
1127 Run,
1128}
1129
1130struct RunnableConfig {
1131 pub query: Query,
1132 /// A mapping from capture indice to capture kind
1133 pub extra_captures: Vec<RunnableCapture>,
1134}
1135
1136#[derive(Clone, Debug, PartialEq)]
1137enum DebugVariableCapture {
1138 Named(SharedString),
1139 Variable,
1140}
1141
1142#[derive(Debug)]
1143struct DebugVariablesConfig {
1144 pub query: Query,
1145 pub captures: Vec<DebugVariableCapture>,
1146}
1147
1148struct OverrideConfig {
1149 query: Query,
1150 values: HashMap<u32, OverrideEntry>,
1151}
1152
1153#[derive(Debug)]
1154struct OverrideEntry {
1155 name: String,
1156 range_is_inclusive: bool,
1157 value: LanguageConfigOverride,
1158}
1159
1160#[derive(Default, Clone)]
1161struct InjectionPatternConfig {
1162 language: Option<Box<str>>,
1163 combined: bool,
1164}
1165
1166struct BracketsConfig {
1167 query: Query,
1168 open_capture_ix: u32,
1169 close_capture_ix: u32,
1170 patterns: Vec<BracketsPatternConfig>,
1171}
1172
1173#[derive(Clone, Debug, Default)]
1174struct BracketsPatternConfig {
1175 newline_only: bool,
1176}
1177
1178impl Language {
1179 pub fn new(config: LanguageConfig, ts_language: Option<tree_sitter::Language>) -> Self {
1180 Self::new_with_id(LanguageId::new(), config, ts_language)
1181 }
1182
1183 pub fn id(&self) -> LanguageId {
1184 self.id
1185 }
1186
1187 fn new_with_id(
1188 id: LanguageId,
1189 config: LanguageConfig,
1190 ts_language: Option<tree_sitter::Language>,
1191 ) -> Self {
1192 Self {
1193 id,
1194 config,
1195 grammar: ts_language.map(|ts_language| {
1196 Arc::new(Grammar {
1197 id: GrammarId::new(),
1198 highlights_query: None,
1199 brackets_config: None,
1200 outline_config: None,
1201 text_object_config: None,
1202 embedding_config: None,
1203 indents_config: None,
1204 injection_config: None,
1205 override_config: None,
1206 redactions_config: None,
1207 runnable_config: None,
1208 debug_variables_config: None,
1209 error_query: Query::new(&ts_language, "(ERROR) @error").ok(),
1210 ts_language,
1211 highlight_map: Default::default(),
1212 })
1213 }),
1214 context_provider: None,
1215 toolchain: None,
1216 }
1217 }
1218
1219 pub fn with_context_provider(mut self, provider: Option<Arc<dyn ContextProvider>>) -> Self {
1220 self.context_provider = provider;
1221 self
1222 }
1223
1224 pub fn with_toolchain_lister(mut self, provider: Option<Arc<dyn ToolchainLister>>) -> Self {
1225 self.toolchain = provider;
1226 self
1227 }
1228
1229 pub fn with_queries(mut self, queries: LanguageQueries) -> Result<Self> {
1230 if let Some(query) = queries.highlights {
1231 self = self
1232 .with_highlights_query(query.as_ref())
1233 .context("Error loading highlights query")?;
1234 }
1235 if let Some(query) = queries.brackets {
1236 self = self
1237 .with_brackets_query(query.as_ref())
1238 .context("Error loading brackets query")?;
1239 }
1240 if let Some(query) = queries.indents {
1241 self = self
1242 .with_indents_query(query.as_ref())
1243 .context("Error loading indents query")?;
1244 }
1245 if let Some(query) = queries.outline {
1246 self = self
1247 .with_outline_query(query.as_ref())
1248 .context("Error loading outline query")?;
1249 }
1250 if let Some(query) = queries.embedding {
1251 self = self
1252 .with_embedding_query(query.as_ref())
1253 .context("Error loading embedding query")?;
1254 }
1255 if let Some(query) = queries.injections {
1256 self = self
1257 .with_injection_query(query.as_ref())
1258 .context("Error loading injection query")?;
1259 }
1260 if let Some(query) = queries.overrides {
1261 self = self
1262 .with_override_query(query.as_ref())
1263 .context("Error loading override query")?;
1264 }
1265 if let Some(query) = queries.redactions {
1266 self = self
1267 .with_redaction_query(query.as_ref())
1268 .context("Error loading redaction query")?;
1269 }
1270 if let Some(query) = queries.runnables {
1271 self = self
1272 .with_runnable_query(query.as_ref())
1273 .context("Error loading runnables query")?;
1274 }
1275 if let Some(query) = queries.text_objects {
1276 self = self
1277 .with_text_object_query(query.as_ref())
1278 .context("Error loading textobject query")?;
1279 }
1280 if let Some(query) = queries.debug_variables {
1281 self = self
1282 .with_debug_variables_query(query.as_ref())
1283 .context("Error loading debug variable 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_debug_variables_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
1386 let mut captures = Vec::new();
1387 for name in query.capture_names() {
1388 captures.push(if *name == "debug_variable" {
1389 DebugVariableCapture::Variable
1390 } else {
1391 DebugVariableCapture::Named(name.to_string().into())
1392 });
1393 }
1394 grammar.debug_variables_config = Some(DebugVariablesConfig { query, captures });
1395
1396 Ok(self)
1397 }
1398
1399 pub fn with_embedding_query(mut self, source: &str) -> Result<Self> {
1400 let grammar = self
1401 .grammar_mut()
1402 .ok_or_else(|| anyhow!("cannot mutate grammar"))?;
1403 let query = Query::new(&grammar.ts_language, source)?;
1404 let mut item_capture_ix = None;
1405 let mut name_capture_ix = None;
1406 let mut context_capture_ix = None;
1407 let mut collapse_capture_ix = None;
1408 let mut keep_capture_ix = None;
1409 get_capture_indices(
1410 &query,
1411 &mut [
1412 ("item", &mut item_capture_ix),
1413 ("name", &mut name_capture_ix),
1414 ("context", &mut context_capture_ix),
1415 ("keep", &mut keep_capture_ix),
1416 ("collapse", &mut collapse_capture_ix),
1417 ],
1418 );
1419 if let Some(item_capture_ix) = item_capture_ix {
1420 grammar.embedding_config = Some(EmbeddingConfig {
1421 query,
1422 item_capture_ix,
1423 name_capture_ix,
1424 context_capture_ix,
1425 collapse_capture_ix,
1426 keep_capture_ix,
1427 });
1428 }
1429 Ok(self)
1430 }
1431
1432 pub fn with_brackets_query(mut self, source: &str) -> Result<Self> {
1433 let grammar = self
1434 .grammar_mut()
1435 .ok_or_else(|| anyhow!("cannot mutate grammar"))?;
1436 let query = Query::new(&grammar.ts_language, source)?;
1437 let mut open_capture_ix = None;
1438 let mut close_capture_ix = None;
1439 get_capture_indices(
1440 &query,
1441 &mut [
1442 ("open", &mut open_capture_ix),
1443 ("close", &mut close_capture_ix),
1444 ],
1445 );
1446 let patterns = (0..query.pattern_count())
1447 .map(|ix| {
1448 let mut config = BracketsPatternConfig::default();
1449 for setting in query.property_settings(ix) {
1450 match setting.key.as_ref() {
1451 "newline.only" => config.newline_only = true,
1452 _ => {}
1453 }
1454 }
1455 config
1456 })
1457 .collect();
1458 if let Some((open_capture_ix, close_capture_ix)) = open_capture_ix.zip(close_capture_ix) {
1459 grammar.brackets_config = Some(BracketsConfig {
1460 query,
1461 open_capture_ix,
1462 close_capture_ix,
1463 patterns,
1464 });
1465 }
1466 Ok(self)
1467 }
1468
1469 pub fn with_indents_query(mut self, source: &str) -> Result<Self> {
1470 let grammar = self
1471 .grammar_mut()
1472 .ok_or_else(|| anyhow!("cannot mutate grammar"))?;
1473 let query = Query::new(&grammar.ts_language, source)?;
1474 let mut indent_capture_ix = None;
1475 let mut start_capture_ix = None;
1476 let mut end_capture_ix = None;
1477 let mut outdent_capture_ix = None;
1478 get_capture_indices(
1479 &query,
1480 &mut [
1481 ("indent", &mut indent_capture_ix),
1482 ("start", &mut start_capture_ix),
1483 ("end", &mut end_capture_ix),
1484 ("outdent", &mut outdent_capture_ix),
1485 ],
1486 );
1487 if let Some(indent_capture_ix) = indent_capture_ix {
1488 grammar.indents_config = Some(IndentConfig {
1489 query,
1490 indent_capture_ix,
1491 start_capture_ix,
1492 end_capture_ix,
1493 outdent_capture_ix,
1494 });
1495 }
1496 Ok(self)
1497 }
1498
1499 pub fn with_injection_query(mut self, source: &str) -> Result<Self> {
1500 let grammar = self
1501 .grammar_mut()
1502 .ok_or_else(|| anyhow!("cannot mutate grammar"))?;
1503 let query = Query::new(&grammar.ts_language, source)?;
1504 let mut language_capture_ix = None;
1505 let mut injection_language_capture_ix = None;
1506 let mut content_capture_ix = None;
1507 let mut injection_content_capture_ix = None;
1508 get_capture_indices(
1509 &query,
1510 &mut [
1511 ("language", &mut language_capture_ix),
1512 ("injection.language", &mut injection_language_capture_ix),
1513 ("content", &mut content_capture_ix),
1514 ("injection.content", &mut injection_content_capture_ix),
1515 ],
1516 );
1517 language_capture_ix = match (language_capture_ix, injection_language_capture_ix) {
1518 (None, Some(ix)) => Some(ix),
1519 (Some(_), Some(_)) => {
1520 return Err(anyhow!(
1521 "both language and injection.language captures are present"
1522 ));
1523 }
1524 _ => language_capture_ix,
1525 };
1526 content_capture_ix = match (content_capture_ix, injection_content_capture_ix) {
1527 (None, Some(ix)) => Some(ix),
1528 (Some(_), Some(_)) => {
1529 return Err(anyhow!(
1530 "both content and injection.content captures are present"
1531 ));
1532 }
1533 _ => content_capture_ix,
1534 };
1535 let patterns = (0..query.pattern_count())
1536 .map(|ix| {
1537 let mut config = InjectionPatternConfig::default();
1538 for setting in query.property_settings(ix) {
1539 match setting.key.as_ref() {
1540 "language" | "injection.language" => {
1541 config.language.clone_from(&setting.value);
1542 }
1543 "combined" | "injection.combined" => {
1544 config.combined = true;
1545 }
1546 _ => {}
1547 }
1548 }
1549 config
1550 })
1551 .collect();
1552 if let Some(content_capture_ix) = content_capture_ix {
1553 grammar.injection_config = Some(InjectionConfig {
1554 query,
1555 language_capture_ix,
1556 content_capture_ix,
1557 patterns,
1558 });
1559 }
1560 Ok(self)
1561 }
1562
1563 pub fn with_override_query(mut self, source: &str) -> anyhow::Result<Self> {
1564 let query = {
1565 let grammar = self
1566 .grammar
1567 .as_ref()
1568 .ok_or_else(|| anyhow!("no grammar for language"))?;
1569 Query::new(&grammar.ts_language, source)?
1570 };
1571
1572 let mut override_configs_by_id = HashMap::default();
1573 for (ix, mut name) in query.capture_names().iter().copied().enumerate() {
1574 let mut range_is_inclusive = false;
1575 if name.starts_with('_') {
1576 continue;
1577 }
1578 if let Some(prefix) = name.strip_suffix(".inclusive") {
1579 name = prefix;
1580 range_is_inclusive = true;
1581 }
1582
1583 let value = self.config.overrides.get(name).cloned().unwrap_or_default();
1584 for server_name in &value.opt_into_language_servers {
1585 if !self
1586 .config
1587 .scope_opt_in_language_servers
1588 .contains(server_name)
1589 {
1590 util::debug_panic!(
1591 "Server {server_name:?} has been opted-in by scope {name:?} but has not been marked as an opt-in server"
1592 );
1593 }
1594 }
1595
1596 override_configs_by_id.insert(
1597 ix as u32,
1598 OverrideEntry {
1599 name: name.to_string(),
1600 range_is_inclusive,
1601 value,
1602 },
1603 );
1604 }
1605
1606 let referenced_override_names = self.config.overrides.keys().chain(
1607 self.config
1608 .brackets
1609 .disabled_scopes_by_bracket_ix
1610 .iter()
1611 .flatten(),
1612 );
1613
1614 for referenced_name in referenced_override_names {
1615 if !override_configs_by_id
1616 .values()
1617 .any(|entry| entry.name == *referenced_name)
1618 {
1619 Err(anyhow!(
1620 "language {:?} has overrides in config not in query: {referenced_name:?}",
1621 self.config.name
1622 ))?;
1623 }
1624 }
1625
1626 for entry in override_configs_by_id.values_mut() {
1627 entry.value.disabled_bracket_ixs = self
1628 .config
1629 .brackets
1630 .disabled_scopes_by_bracket_ix
1631 .iter()
1632 .enumerate()
1633 .filter_map(|(ix, disabled_scope_names)| {
1634 if disabled_scope_names.contains(&entry.name) {
1635 Some(ix as u16)
1636 } else {
1637 None
1638 }
1639 })
1640 .collect();
1641 }
1642
1643 self.config.brackets.disabled_scopes_by_bracket_ix.clear();
1644
1645 let grammar = self
1646 .grammar_mut()
1647 .ok_or_else(|| anyhow!("cannot mutate grammar"))?;
1648 grammar.override_config = Some(OverrideConfig {
1649 query,
1650 values: override_configs_by_id,
1651 });
1652 Ok(self)
1653 }
1654
1655 pub fn with_redaction_query(mut self, source: &str) -> anyhow::Result<Self> {
1656 let grammar = self
1657 .grammar_mut()
1658 .ok_or_else(|| anyhow!("cannot mutate grammar"))?;
1659
1660 let query = Query::new(&grammar.ts_language, source)?;
1661 let mut redaction_capture_ix = None;
1662 get_capture_indices(&query, &mut [("redact", &mut redaction_capture_ix)]);
1663
1664 if let Some(redaction_capture_ix) = redaction_capture_ix {
1665 grammar.redactions_config = Some(RedactionConfig {
1666 query,
1667 redaction_capture_ix,
1668 });
1669 }
1670
1671 Ok(self)
1672 }
1673
1674 fn grammar_mut(&mut self) -> Option<&mut Grammar> {
1675 Arc::get_mut(self.grammar.as_mut()?)
1676 }
1677
1678 pub fn name(&self) -> LanguageName {
1679 self.config.name.clone()
1680 }
1681
1682 pub fn code_fence_block_name(&self) -> Arc<str> {
1683 self.config
1684 .code_fence_block_name
1685 .clone()
1686 .unwrap_or_else(|| self.config.name.as_ref().to_lowercase().into())
1687 }
1688
1689 pub fn context_provider(&self) -> Option<Arc<dyn ContextProvider>> {
1690 self.context_provider.clone()
1691 }
1692
1693 pub fn toolchain_lister(&self) -> Option<Arc<dyn ToolchainLister>> {
1694 self.toolchain.clone()
1695 }
1696
1697 pub fn highlight_text<'a>(
1698 self: &'a Arc<Self>,
1699 text: &'a Rope,
1700 range: Range<usize>,
1701 ) -> Vec<(Range<usize>, HighlightId)> {
1702 let mut result = Vec::new();
1703 if let Some(grammar) = &self.grammar {
1704 let tree = grammar.parse_text(text, None);
1705 let captures =
1706 SyntaxSnapshot::single_tree_captures(range.clone(), text, &tree, self, |grammar| {
1707 grammar.highlights_query.as_ref()
1708 });
1709 let highlight_maps = vec![grammar.highlight_map()];
1710 let mut offset = 0;
1711 for chunk in
1712 BufferChunks::new(text, range, Some((captures, highlight_maps)), false, None)
1713 {
1714 let end_offset = offset + chunk.text.len();
1715 if let Some(highlight_id) = chunk.syntax_highlight_id {
1716 if !highlight_id.is_default() {
1717 result.push((offset..end_offset, highlight_id));
1718 }
1719 }
1720 offset = end_offset;
1721 }
1722 }
1723 result
1724 }
1725
1726 pub fn path_suffixes(&self) -> &[String] {
1727 &self.config.matcher.path_suffixes
1728 }
1729
1730 pub fn should_autoclose_before(&self, c: char) -> bool {
1731 c.is_whitespace() || self.config.autoclose_before.contains(c)
1732 }
1733
1734 pub fn set_theme(&self, theme: &SyntaxTheme) {
1735 if let Some(grammar) = self.grammar.as_ref() {
1736 if let Some(highlights_query) = &grammar.highlights_query {
1737 *grammar.highlight_map.lock() =
1738 HighlightMap::new(highlights_query.capture_names(), theme);
1739 }
1740 }
1741 }
1742
1743 pub fn grammar(&self) -> Option<&Arc<Grammar>> {
1744 self.grammar.as_ref()
1745 }
1746
1747 pub fn default_scope(self: &Arc<Self>) -> LanguageScope {
1748 LanguageScope {
1749 language: self.clone(),
1750 override_id: None,
1751 }
1752 }
1753
1754 pub fn lsp_id(&self) -> String {
1755 self.config.name.lsp_id()
1756 }
1757
1758 pub fn prettier_parser_name(&self) -> Option<&str> {
1759 self.config.prettier_parser_name.as_deref()
1760 }
1761
1762 pub fn config(&self) -> &LanguageConfig {
1763 &self.config
1764 }
1765}
1766
1767impl LanguageScope {
1768 pub fn path_suffixes(&self) -> &[String] {
1769 &self.language.path_suffixes()
1770 }
1771
1772 pub fn language_name(&self) -> LanguageName {
1773 self.language.config.name.clone()
1774 }
1775
1776 pub fn collapsed_placeholder(&self) -> &str {
1777 self.language.config.collapsed_placeholder.as_ref()
1778 }
1779
1780 /// Returns line prefix that is inserted in e.g. line continuations or
1781 /// in `toggle comments` action.
1782 pub fn line_comment_prefixes(&self) -> &[Arc<str>] {
1783 Override::as_option(
1784 self.config_override().map(|o| &o.line_comments),
1785 Some(&self.language.config.line_comments),
1786 )
1787 .map_or([].as_slice(), |e| e.as_slice())
1788 }
1789
1790 pub fn block_comment_delimiters(&self) -> Option<(&Arc<str>, &Arc<str>)> {
1791 Override::as_option(
1792 self.config_override().map(|o| &o.block_comment),
1793 self.language.config.block_comment.as_ref(),
1794 )
1795 .map(|e| (&e.0, &e.1))
1796 }
1797
1798 /// Returns a list of language-specific word characters.
1799 ///
1800 /// By default, Zed treats alphanumeric characters (and '_') as word characters for
1801 /// the purpose of actions like 'move to next word end` or whole-word search.
1802 /// It additionally accounts for language's additional word characters.
1803 pub fn word_characters(&self) -> Option<&HashSet<char>> {
1804 Override::as_option(
1805 self.config_override().map(|o| &o.word_characters),
1806 Some(&self.language.config.word_characters),
1807 )
1808 }
1809
1810 /// Returns a list of language-specific characters that are considered part of
1811 /// a completion query.
1812 pub fn completion_query_characters(&self) -> Option<&HashSet<char>> {
1813 Override::as_option(
1814 self.config_override()
1815 .map(|o| &o.completion_query_characters),
1816 Some(&self.language.config.completion_query_characters),
1817 )
1818 }
1819
1820 /// Returns a list of bracket pairs for a given language with an additional
1821 /// piece of information about whether the particular bracket pair is currently active for a given language.
1822 pub fn brackets(&self) -> impl Iterator<Item = (&BracketPair, bool)> {
1823 let mut disabled_ids = self
1824 .config_override()
1825 .map_or(&[] as _, |o| o.disabled_bracket_ixs.as_slice());
1826 self.language
1827 .config
1828 .brackets
1829 .pairs
1830 .iter()
1831 .enumerate()
1832 .map(move |(ix, bracket)| {
1833 let mut is_enabled = true;
1834 if let Some(next_disabled_ix) = disabled_ids.first() {
1835 if ix == *next_disabled_ix as usize {
1836 disabled_ids = &disabled_ids[1..];
1837 is_enabled = false;
1838 }
1839 }
1840 (bracket, is_enabled)
1841 })
1842 }
1843
1844 pub fn should_autoclose_before(&self, c: char) -> bool {
1845 c.is_whitespace() || self.language.config.autoclose_before.contains(c)
1846 }
1847
1848 pub fn language_allowed(&self, name: &LanguageServerName) -> bool {
1849 let config = &self.language.config;
1850 let opt_in_servers = &config.scope_opt_in_language_servers;
1851 if opt_in_servers.iter().any(|o| *o == *name) {
1852 if let Some(over) = self.config_override() {
1853 over.opt_into_language_servers.iter().any(|o| *o == *name)
1854 } else {
1855 false
1856 }
1857 } else {
1858 true
1859 }
1860 }
1861
1862 pub fn override_name(&self) -> Option<&str> {
1863 let id = self.override_id?;
1864 let grammar = self.language.grammar.as_ref()?;
1865 let override_config = grammar.override_config.as_ref()?;
1866 override_config.values.get(&id).map(|e| e.name.as_str())
1867 }
1868
1869 fn config_override(&self) -> Option<&LanguageConfigOverride> {
1870 let id = self.override_id?;
1871 let grammar = self.language.grammar.as_ref()?;
1872 let override_config = grammar.override_config.as_ref()?;
1873 override_config.values.get(&id).map(|e| &e.value)
1874 }
1875}
1876
1877impl Hash for Language {
1878 fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
1879 self.id.hash(state)
1880 }
1881}
1882
1883impl PartialEq for Language {
1884 fn eq(&self, other: &Self) -> bool {
1885 self.id.eq(&other.id)
1886 }
1887}
1888
1889impl Eq for Language {}
1890
1891impl Debug for Language {
1892 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1893 f.debug_struct("Language")
1894 .field("name", &self.config.name)
1895 .finish()
1896 }
1897}
1898
1899impl Grammar {
1900 pub fn id(&self) -> GrammarId {
1901 self.id
1902 }
1903
1904 fn parse_text(&self, text: &Rope, old_tree: Option<Tree>) -> Tree {
1905 with_parser(|parser| {
1906 parser
1907 .set_language(&self.ts_language)
1908 .expect("incompatible grammar");
1909 let mut chunks = text.chunks_in_range(0..text.len());
1910 parser
1911 .parse_with_options(
1912 &mut move |offset, _| {
1913 chunks.seek(offset);
1914 chunks.next().unwrap_or("").as_bytes()
1915 },
1916 old_tree.as_ref(),
1917 None,
1918 )
1919 .unwrap()
1920 })
1921 }
1922
1923 pub fn highlight_map(&self) -> HighlightMap {
1924 self.highlight_map.lock().clone()
1925 }
1926
1927 pub fn highlight_id_for_name(&self, name: &str) -> Option<HighlightId> {
1928 let capture_id = self
1929 .highlights_query
1930 .as_ref()?
1931 .capture_index_for_name(name)?;
1932 Some(self.highlight_map.lock().get(capture_id))
1933 }
1934}
1935
1936impl CodeLabel {
1937 pub fn fallback_for_completion(
1938 item: &lsp::CompletionItem,
1939 language: Option<&Language>,
1940 ) -> Self {
1941 let highlight_id = item.kind.and_then(|kind| {
1942 let grammar = language?.grammar()?;
1943 use lsp::CompletionItemKind as Kind;
1944 match kind {
1945 Kind::CLASS => grammar.highlight_id_for_name("type"),
1946 Kind::CONSTANT => grammar.highlight_id_for_name("constant"),
1947 Kind::CONSTRUCTOR => grammar.highlight_id_for_name("constructor"),
1948 Kind::ENUM => grammar
1949 .highlight_id_for_name("enum")
1950 .or_else(|| grammar.highlight_id_for_name("type")),
1951 Kind::ENUM_MEMBER => grammar
1952 .highlight_id_for_name("variant")
1953 .or_else(|| grammar.highlight_id_for_name("property")),
1954 Kind::FIELD => grammar.highlight_id_for_name("property"),
1955 Kind::FUNCTION => grammar.highlight_id_for_name("function"),
1956 Kind::INTERFACE => grammar.highlight_id_for_name("type"),
1957 Kind::METHOD => grammar
1958 .highlight_id_for_name("function.method")
1959 .or_else(|| grammar.highlight_id_for_name("function")),
1960 Kind::OPERATOR => grammar.highlight_id_for_name("operator"),
1961 Kind::PROPERTY => grammar.highlight_id_for_name("property"),
1962 Kind::STRUCT => grammar.highlight_id_for_name("type"),
1963 Kind::VARIABLE => grammar.highlight_id_for_name("variable"),
1964 Kind::KEYWORD => grammar.highlight_id_for_name("keyword"),
1965 _ => None,
1966 }
1967 });
1968
1969 let label = &item.label;
1970 let label_length = label.len();
1971 let runs = highlight_id
1972 .map(|highlight_id| vec![(0..label_length, highlight_id)])
1973 .unwrap_or_default();
1974 let text = if let Some(detail) = item.detail.as_deref().filter(|detail| detail != label) {
1975 format!("{label} {detail}")
1976 } else if let Some(description) = item
1977 .label_details
1978 .as_ref()
1979 .and_then(|label_details| label_details.description.as_deref())
1980 .filter(|description| description != label)
1981 {
1982 format!("{label} {description}")
1983 } else {
1984 label.clone()
1985 };
1986 Self {
1987 text,
1988 runs,
1989 filter_range: 0..label_length,
1990 }
1991 }
1992
1993 pub fn plain(text: String, filter_text: Option<&str>) -> Self {
1994 let mut result = Self {
1995 runs: Vec::new(),
1996 filter_range: 0..text.len(),
1997 text,
1998 };
1999 if let Some(filter_text) = filter_text {
2000 if let Some(ix) = result.text.find(filter_text) {
2001 result.filter_range = ix..ix + filter_text.len();
2002 }
2003 }
2004 result
2005 }
2006
2007 pub fn push_str(&mut self, text: &str, highlight: Option<HighlightId>) {
2008 let start_ix = self.text.len();
2009 self.text.push_str(text);
2010 let end_ix = self.text.len();
2011 if let Some(highlight) = highlight {
2012 self.runs.push((start_ix..end_ix, highlight));
2013 }
2014 }
2015
2016 pub fn text(&self) -> &str {
2017 self.text.as_str()
2018 }
2019
2020 pub fn filter_text(&self) -> &str {
2021 &self.text[self.filter_range.clone()]
2022 }
2023}
2024
2025impl From<String> for CodeLabel {
2026 fn from(value: String) -> Self {
2027 Self::plain(value, None)
2028 }
2029}
2030
2031impl From<&str> for CodeLabel {
2032 fn from(value: &str) -> Self {
2033 Self::plain(value.to_string(), None)
2034 }
2035}
2036
2037impl Ord for LanguageMatcher {
2038 fn cmp(&self, other: &Self) -> std::cmp::Ordering {
2039 self.path_suffixes.cmp(&other.path_suffixes).then_with(|| {
2040 self.first_line_pattern
2041 .as_ref()
2042 .map(Regex::as_str)
2043 .cmp(&other.first_line_pattern.as_ref().map(Regex::as_str))
2044 })
2045 }
2046}
2047
2048impl PartialOrd for LanguageMatcher {
2049 fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
2050 Some(self.cmp(other))
2051 }
2052}
2053
2054impl Eq for LanguageMatcher {}
2055
2056impl PartialEq for LanguageMatcher {
2057 fn eq(&self, other: &Self) -> bool {
2058 self.path_suffixes == other.path_suffixes
2059 && self.first_line_pattern.as_ref().map(Regex::as_str)
2060 == other.first_line_pattern.as_ref().map(Regex::as_str)
2061 }
2062}
2063
2064#[cfg(any(test, feature = "test-support"))]
2065impl Default for FakeLspAdapter {
2066 fn default() -> Self {
2067 Self {
2068 name: "the-fake-language-server",
2069 capabilities: lsp::LanguageServer::full_capabilities(),
2070 initializer: None,
2071 disk_based_diagnostics_progress_token: None,
2072 initialization_options: None,
2073 disk_based_diagnostics_sources: Vec::new(),
2074 prettier_plugins: Vec::new(),
2075 language_server_binary: LanguageServerBinary {
2076 path: "/the/fake/lsp/path".into(),
2077 arguments: vec![],
2078 env: Default::default(),
2079 },
2080 label_for_completion: None,
2081 }
2082 }
2083}
2084
2085#[cfg(any(test, feature = "test-support"))]
2086#[async_trait(?Send)]
2087impl LspAdapter for FakeLspAdapter {
2088 fn name(&self) -> LanguageServerName {
2089 LanguageServerName(self.name.into())
2090 }
2091
2092 async fn check_if_user_installed(
2093 &self,
2094 _: &dyn LspAdapterDelegate,
2095 _: Arc<dyn LanguageToolchainStore>,
2096 _: &AsyncApp,
2097 ) -> Option<LanguageServerBinary> {
2098 Some(self.language_server_binary.clone())
2099 }
2100
2101 fn get_language_server_command<'a>(
2102 self: Arc<Self>,
2103 _: Arc<dyn LspAdapterDelegate>,
2104 _: Arc<dyn LanguageToolchainStore>,
2105 _: LanguageServerBinaryOptions,
2106 _: futures::lock::MutexGuard<'a, Option<LanguageServerBinary>>,
2107 _: &'a mut AsyncApp,
2108 ) -> Pin<Box<dyn 'a + Future<Output = Result<LanguageServerBinary>>>> {
2109 async move { Ok(self.language_server_binary.clone()) }.boxed_local()
2110 }
2111
2112 async fn fetch_latest_server_version(
2113 &self,
2114 _: &dyn LspAdapterDelegate,
2115 ) -> Result<Box<dyn 'static + Send + Any>> {
2116 unreachable!();
2117 }
2118
2119 async fn fetch_server_binary(
2120 &self,
2121 _: Box<dyn 'static + Send + Any>,
2122 _: PathBuf,
2123 _: &dyn LspAdapterDelegate,
2124 ) -> Result<LanguageServerBinary> {
2125 unreachable!();
2126 }
2127
2128 async fn cached_server_binary(
2129 &self,
2130 _: PathBuf,
2131 _: &dyn LspAdapterDelegate,
2132 ) -> Option<LanguageServerBinary> {
2133 unreachable!();
2134 }
2135
2136 fn disk_based_diagnostic_sources(&self) -> Vec<String> {
2137 self.disk_based_diagnostics_sources.clone()
2138 }
2139
2140 fn disk_based_diagnostics_progress_token(&self) -> Option<String> {
2141 self.disk_based_diagnostics_progress_token.clone()
2142 }
2143
2144 async fn initialization_options(
2145 self: Arc<Self>,
2146 _: &dyn Fs,
2147 _: &Arc<dyn LspAdapterDelegate>,
2148 ) -> Result<Option<Value>> {
2149 Ok(self.initialization_options.clone())
2150 }
2151
2152 async fn label_for_completion(
2153 &self,
2154 item: &lsp::CompletionItem,
2155 language: &Arc<Language>,
2156 ) -> Option<CodeLabel> {
2157 let label_for_completion = self.label_for_completion.as_ref()?;
2158 label_for_completion(item, language)
2159 }
2160}
2161
2162fn get_capture_indices(query: &Query, captures: &mut [(&str, &mut Option<u32>)]) {
2163 for (ix, name) in query.capture_names().iter().enumerate() {
2164 for (capture_name, index) in captures.iter_mut() {
2165 if capture_name == name {
2166 **index = Some(ix as u32);
2167 break;
2168 }
2169 }
2170 }
2171}
2172
2173pub fn point_to_lsp(point: PointUtf16) -> lsp::Position {
2174 lsp::Position::new(point.row, point.column)
2175}
2176
2177pub fn point_from_lsp(point: lsp::Position) -> Unclipped<PointUtf16> {
2178 Unclipped(PointUtf16::new(point.line, point.character))
2179}
2180
2181pub fn range_to_lsp(range: Range<PointUtf16>) -> Result<lsp::Range> {
2182 if range.start > range.end {
2183 Err(anyhow!(
2184 "Inverted range provided to an LSP request: {:?}-{:?}",
2185 range.start,
2186 range.end
2187 ))
2188 } else {
2189 Ok(lsp::Range {
2190 start: point_to_lsp(range.start),
2191 end: point_to_lsp(range.end),
2192 })
2193 }
2194}
2195
2196pub fn range_from_lsp(range: lsp::Range) -> Range<Unclipped<PointUtf16>> {
2197 let mut start = point_from_lsp(range.start);
2198 let mut end = point_from_lsp(range.end);
2199 if start > end {
2200 log::warn!("range_from_lsp called with inverted range {start:?}-{end:?}");
2201 mem::swap(&mut start, &mut end);
2202 }
2203 start..end
2204}
2205
2206#[cfg(test)]
2207mod tests {
2208 use super::*;
2209 use gpui::TestAppContext;
2210
2211 #[gpui::test(iterations = 10)]
2212 async fn test_language_loading(cx: &mut TestAppContext) {
2213 let languages = LanguageRegistry::test(cx.executor());
2214 let languages = Arc::new(languages);
2215 languages.register_native_grammars([
2216 ("json", tree_sitter_json::LANGUAGE),
2217 ("rust", tree_sitter_rust::LANGUAGE),
2218 ]);
2219 languages.register_test_language(LanguageConfig {
2220 name: "JSON".into(),
2221 grammar: Some("json".into()),
2222 matcher: LanguageMatcher {
2223 path_suffixes: vec!["json".into()],
2224 ..Default::default()
2225 },
2226 ..Default::default()
2227 });
2228 languages.register_test_language(LanguageConfig {
2229 name: "Rust".into(),
2230 grammar: Some("rust".into()),
2231 matcher: LanguageMatcher {
2232 path_suffixes: vec!["rs".into()],
2233 ..Default::default()
2234 },
2235 ..Default::default()
2236 });
2237 assert_eq!(
2238 languages.language_names(),
2239 &[
2240 "JSON".to_string(),
2241 "Plain Text".to_string(),
2242 "Rust".to_string(),
2243 ]
2244 );
2245
2246 let rust1 = languages.language_for_name("Rust");
2247 let rust2 = languages.language_for_name("Rust");
2248
2249 // Ensure language is still listed even if it's being loaded.
2250 assert_eq!(
2251 languages.language_names(),
2252 &[
2253 "JSON".to_string(),
2254 "Plain Text".to_string(),
2255 "Rust".to_string(),
2256 ]
2257 );
2258
2259 let (rust1, rust2) = futures::join!(rust1, rust2);
2260 assert!(Arc::ptr_eq(&rust1.unwrap(), &rust2.unwrap()));
2261
2262 // Ensure language is still listed even after loading it.
2263 assert_eq!(
2264 languages.language_names(),
2265 &[
2266 "JSON".to_string(),
2267 "Plain Text".to_string(),
2268 "Rust".to_string(),
2269 ]
2270 );
2271
2272 // Loading an unknown language returns an error.
2273 assert!(languages.language_for_name("Unknown").await.is_err());
2274 }
2275
2276 #[gpui::test]
2277 async fn test_completion_label_omits_duplicate_data() {
2278 let regular_completion_item_1 = lsp::CompletionItem {
2279 label: "regular1".to_string(),
2280 detail: Some("detail1".to_string()),
2281 label_details: Some(lsp::CompletionItemLabelDetails {
2282 detail: None,
2283 description: Some("description 1".to_string()),
2284 }),
2285 ..lsp::CompletionItem::default()
2286 };
2287
2288 let regular_completion_item_2 = lsp::CompletionItem {
2289 label: "regular2".to_string(),
2290 label_details: Some(lsp::CompletionItemLabelDetails {
2291 detail: None,
2292 description: Some("description 2".to_string()),
2293 }),
2294 ..lsp::CompletionItem::default()
2295 };
2296
2297 let completion_item_with_duplicate_detail_and_proper_description = lsp::CompletionItem {
2298 detail: Some(regular_completion_item_1.label.clone()),
2299 ..regular_completion_item_1.clone()
2300 };
2301
2302 let completion_item_with_duplicate_detail = lsp::CompletionItem {
2303 detail: Some(regular_completion_item_1.label.clone()),
2304 label_details: None,
2305 ..regular_completion_item_1.clone()
2306 };
2307
2308 let completion_item_with_duplicate_description = lsp::CompletionItem {
2309 label_details: Some(lsp::CompletionItemLabelDetails {
2310 detail: None,
2311 description: Some(regular_completion_item_2.label.clone()),
2312 }),
2313 ..regular_completion_item_2.clone()
2314 };
2315
2316 assert_eq!(
2317 CodeLabel::fallback_for_completion(®ular_completion_item_1, None).text,
2318 format!(
2319 "{} {}",
2320 regular_completion_item_1.label,
2321 regular_completion_item_1.detail.unwrap()
2322 ),
2323 "LSP completion items with both detail and label_details.description should prefer detail"
2324 );
2325 assert_eq!(
2326 CodeLabel::fallback_for_completion(®ular_completion_item_2, None).text,
2327 format!(
2328 "{} {}",
2329 regular_completion_item_2.label,
2330 regular_completion_item_2
2331 .label_details
2332 .as_ref()
2333 .unwrap()
2334 .description
2335 .as_ref()
2336 .unwrap()
2337 ),
2338 "LSP completion items without detail but with label_details.description should use that"
2339 );
2340 assert_eq!(
2341 CodeLabel::fallback_for_completion(
2342 &completion_item_with_duplicate_detail_and_proper_description,
2343 None
2344 )
2345 .text,
2346 format!(
2347 "{} {}",
2348 regular_completion_item_1.label,
2349 regular_completion_item_1
2350 .label_details
2351 .as_ref()
2352 .unwrap()
2353 .description
2354 .as_ref()
2355 .unwrap()
2356 ),
2357 "LSP completion items with both detail and label_details.description should prefer description only if the detail duplicates the completion label"
2358 );
2359 assert_eq!(
2360 CodeLabel::fallback_for_completion(&completion_item_with_duplicate_detail, None).text,
2361 regular_completion_item_1.label,
2362 "LSP completion items with duplicate label and detail, should omit the detail"
2363 );
2364 assert_eq!(
2365 CodeLabel::fallback_for_completion(&completion_item_with_duplicate_description, None)
2366 .text,
2367 regular_completion_item_2.label,
2368 "LSP completion items with duplicate label and detail, should omit the detail"
2369 );
2370 }
2371}