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