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