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