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