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