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