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