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