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