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