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