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