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