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