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