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