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