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