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