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