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