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