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