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