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