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