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