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