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