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