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