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