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