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