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