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