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