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