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::{Not, Range},
38 path::{Path, PathBuf},
39 str,
40 sync::{
41 atomic::{AtomicUsize, Ordering::SeqCst},
42 Arc,
43 },
44};
45use syntax_map::SyntaxSnapshot;
46use theme::{SyntaxTheme, Theme};
47use tree_sitter::{self, Query};
48use unicase::UniCase;
49use util::http::HttpClient;
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 extra_context_capture_ix: Option<u32>,
459}
460
461struct InjectionConfig {
462 query: Query,
463 content_capture_ix: u32,
464 language_capture_ix: Option<u32>,
465 patterns: Vec<InjectionPatternConfig>,
466}
467
468struct OverrideConfig {
469 query: Query,
470 values: HashMap<u32, (String, LanguageConfigOverride)>,
471}
472
473#[derive(Default, Clone)]
474struct InjectionPatternConfig {
475 language: Option<Box<str>>,
476 combined: bool,
477}
478
479struct BracketConfig {
480 query: Query,
481 open_capture_ix: u32,
482 close_capture_ix: u32,
483}
484
485#[derive(Clone)]
486pub enum LanguageServerBinaryStatus {
487 CheckingForUpdate,
488 Downloading,
489 Downloaded,
490 Cached,
491 Failed { error: String },
492}
493
494type AvailableLanguageId = usize;
495
496#[derive(Clone)]
497struct AvailableLanguage {
498 id: AvailableLanguageId,
499 path: &'static str,
500 config: LanguageConfig,
501 grammar: tree_sitter::Language,
502 lsp_adapters: Vec<Arc<dyn LspAdapter>>,
503 get_queries: fn(&str) -> LanguageQueries,
504 loaded: bool,
505}
506
507pub struct LanguageRegistry {
508 state: RwLock<LanguageRegistryState>,
509 language_server_download_dir: Option<Arc<Path>>,
510 lsp_binary_statuses_tx: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
511 lsp_binary_statuses_rx: async_broadcast::Receiver<(Arc<Language>, LanguageServerBinaryStatus)>,
512 login_shell_env_loaded: Shared<Task<()>>,
513 #[allow(clippy::type_complexity)]
514 lsp_binary_paths: Mutex<
515 HashMap<
516 LanguageServerName,
517 Shared<BoxFuture<'static, Result<LanguageServerBinary, Arc<anyhow::Error>>>>,
518 >,
519 >,
520 executor: Option<Arc<Background>>,
521}
522
523struct LanguageRegistryState {
524 next_language_server_id: usize,
525 languages: Vec<Arc<Language>>,
526 available_languages: Vec<AvailableLanguage>,
527 next_available_language_id: AvailableLanguageId,
528 loading_languages: HashMap<AvailableLanguageId, Vec<oneshot::Sender<Result<Arc<Language>>>>>,
529 subscription: (watch::Sender<()>, watch::Receiver<()>),
530 theme: Option<Arc<Theme>>,
531 version: usize,
532 reload_count: usize,
533}
534
535pub struct PendingLanguageServer {
536 pub server_id: LanguageServerId,
537 pub task: Task<Result<lsp::LanguageServer>>,
538}
539
540impl LanguageRegistry {
541 pub fn new(login_shell_env_loaded: Task<()>) -> Self {
542 let (lsp_binary_statuses_tx, lsp_binary_statuses_rx) = async_broadcast::broadcast(16);
543 Self {
544 state: RwLock::new(LanguageRegistryState {
545 next_language_server_id: 0,
546 languages: vec![PLAIN_TEXT.clone()],
547 available_languages: Default::default(),
548 next_available_language_id: 0,
549 loading_languages: Default::default(),
550 subscription: watch::channel(),
551 theme: Default::default(),
552 version: 0,
553 reload_count: 0,
554 }),
555 language_server_download_dir: None,
556 lsp_binary_statuses_tx,
557 lsp_binary_statuses_rx,
558 login_shell_env_loaded: login_shell_env_loaded.shared(),
559 lsp_binary_paths: Default::default(),
560 executor: None,
561 }
562 }
563
564 #[cfg(any(test, feature = "test-support"))]
565 pub fn test() -> Self {
566 Self::new(Task::ready(()))
567 }
568
569 pub fn set_executor(&mut self, executor: Arc<Background>) {
570 self.executor = Some(executor);
571 }
572
573 /// Clear out all of the loaded languages and reload them from scratch.
574 ///
575 /// This is useful in development, when queries have changed.
576 #[cfg(debug_assertions)]
577 pub fn reload(&self) {
578 self.state.write().reload();
579 }
580
581 pub fn register(
582 &self,
583 path: &'static str,
584 config: LanguageConfig,
585 grammar: tree_sitter::Language,
586 lsp_adapters: Vec<Arc<dyn LspAdapter>>,
587 get_queries: fn(&str) -> LanguageQueries,
588 ) {
589 let state = &mut *self.state.write();
590 state.available_languages.push(AvailableLanguage {
591 id: post_inc(&mut state.next_available_language_id),
592 path,
593 config,
594 grammar,
595 lsp_adapters,
596 get_queries,
597 loaded: false,
598 });
599 }
600
601 pub fn language_names(&self) -> Vec<String> {
602 let state = self.state.read();
603 let mut result = state
604 .available_languages
605 .iter()
606 .filter_map(|l| l.loaded.not().then_some(l.config.name.to_string()))
607 .chain(state.languages.iter().map(|l| l.config.name.to_string()))
608 .collect::<Vec<_>>();
609 result.sort_unstable_by_key(|language_name| language_name.to_lowercase());
610 result
611 }
612
613 pub fn workspace_configuration(&self, cx: &mut AppContext) -> Task<serde_json::Value> {
614 let lsp_adapters = {
615 let state = self.state.read();
616 state
617 .available_languages
618 .iter()
619 .filter(|l| !l.loaded)
620 .flat_map(|l| l.lsp_adapters.clone())
621 .chain(
622 state
623 .languages
624 .iter()
625 .flat_map(|language| &language.adapters)
626 .map(|adapter| adapter.adapter.clone()),
627 )
628 .collect::<Vec<_>>()
629 };
630
631 let mut language_configs = Vec::new();
632 for adapter in &lsp_adapters {
633 if let Some(language_config) = adapter.workspace_configuration(cx) {
634 language_configs.push(language_config);
635 }
636 }
637
638 cx.background().spawn(async move {
639 let mut config = serde_json::json!({});
640 let language_configs = futures::future::join_all(language_configs).await;
641 for language_config in language_configs {
642 merge_json_value_into(language_config, &mut config);
643 }
644 config
645 })
646 }
647
648 pub fn add(&self, language: Arc<Language>) {
649 self.state.write().add(language);
650 }
651
652 pub fn subscribe(&self) -> watch::Receiver<()> {
653 self.state.read().subscription.1.clone()
654 }
655
656 /// The number of times that the registry has been changed,
657 /// by adding languages or reloading.
658 pub fn version(&self) -> usize {
659 self.state.read().version
660 }
661
662 /// The number of times that the registry has been reloaded.
663 pub fn reload_count(&self) -> usize {
664 self.state.read().reload_count
665 }
666
667 pub fn set_theme(&self, theme: Arc<Theme>) {
668 let mut state = self.state.write();
669 state.theme = Some(theme.clone());
670 for language in &state.languages {
671 language.set_theme(&theme.editor.syntax);
672 }
673 }
674
675 pub fn set_language_server_download_dir(&mut self, path: impl Into<Arc<Path>>) {
676 self.language_server_download_dir = Some(path.into());
677 }
678
679 pub fn language_for_name(
680 self: &Arc<Self>,
681 name: &str,
682 ) -> UnwrapFuture<oneshot::Receiver<Result<Arc<Language>>>> {
683 let name = UniCase::new(name);
684 self.get_or_load_language(|config| UniCase::new(config.name.as_ref()) == name)
685 }
686
687 pub fn language_for_name_or_extension(
688 self: &Arc<Self>,
689 string: &str,
690 ) -> UnwrapFuture<oneshot::Receiver<Result<Arc<Language>>>> {
691 let string = UniCase::new(string);
692 self.get_or_load_language(|config| {
693 UniCase::new(config.name.as_ref()) == string
694 || config
695 .path_suffixes
696 .iter()
697 .any(|suffix| UniCase::new(suffix) == string)
698 })
699 }
700
701 pub fn language_for_file(
702 self: &Arc<Self>,
703 path: impl AsRef<Path>,
704 content: Option<&Rope>,
705 ) -> UnwrapFuture<oneshot::Receiver<Result<Arc<Language>>>> {
706 let path = path.as_ref();
707 let filename = path.file_name().and_then(|name| name.to_str());
708 let extension = path.extension().and_then(|name| name.to_str());
709 let path_suffixes = [extension, filename];
710 self.get_or_load_language(|config| {
711 let path_matches = config
712 .path_suffixes
713 .iter()
714 .any(|suffix| path_suffixes.contains(&Some(suffix.as_str())));
715 let content_matches = content.zip(config.first_line_pattern.as_ref()).map_or(
716 false,
717 |(content, pattern)| {
718 let end = content.clip_point(Point::new(0, 256), Bias::Left);
719 let end = content.point_to_offset(end);
720 let text = content.chunks_in_range(0..end).collect::<String>();
721 pattern.is_match(&text)
722 },
723 );
724 path_matches || content_matches
725 })
726 }
727
728 fn get_or_load_language(
729 self: &Arc<Self>,
730 callback: impl Fn(&LanguageConfig) -> bool,
731 ) -> UnwrapFuture<oneshot::Receiver<Result<Arc<Language>>>> {
732 let (tx, rx) = oneshot::channel();
733
734 let mut state = self.state.write();
735 if let Some(language) = state
736 .languages
737 .iter()
738 .find(|language| callback(&language.config))
739 {
740 let _ = tx.send(Ok(language.clone()));
741 } else if let Some(executor) = self.executor.clone() {
742 if let Some(language) = state
743 .available_languages
744 .iter()
745 .find(|l| !l.loaded && callback(&l.config))
746 .cloned()
747 {
748 let txs = state
749 .loading_languages
750 .entry(language.id)
751 .or_insert_with(|| {
752 let this = self.clone();
753 executor
754 .spawn(async move {
755 let id = language.id;
756 let queries = (language.get_queries)(&language.path);
757 let language =
758 Language::new(language.config, Some(language.grammar))
759 .with_lsp_adapters(language.lsp_adapters)
760 .await;
761 let name = language.name();
762 match language.with_queries(queries) {
763 Ok(language) => {
764 let language = Arc::new(language);
765 let mut state = this.state.write();
766 state.add(language.clone());
767 state.mark_language_loaded(id);
768 if let Some(mut txs) = state.loading_languages.remove(&id) {
769 for tx in txs.drain(..) {
770 let _ = tx.send(Ok(language.clone()));
771 }
772 }
773 }
774 Err(err) => {
775 log::error!("failed to load language {name} - {err}");
776 let mut state = this.state.write();
777 state.mark_language_loaded(id);
778 if let Some(mut txs) = state.loading_languages.remove(&id) {
779 for tx in txs.drain(..) {
780 let _ = tx.send(Err(anyhow!(
781 "failed to load language {}: {}",
782 name,
783 err
784 )));
785 }
786 }
787 }
788 };
789 })
790 .detach();
791
792 Vec::new()
793 });
794 txs.push(tx);
795 } else {
796 let _ = tx.send(Err(anyhow!("language not found")));
797 }
798 } else {
799 let _ = tx.send(Err(anyhow!("executor does not exist")));
800 }
801
802 rx.unwrap()
803 }
804
805 pub fn to_vec(&self) -> Vec<Arc<Language>> {
806 self.state.read().languages.iter().cloned().collect()
807 }
808
809 pub fn start_language_server(
810 self: &Arc<Self>,
811 language: Arc<Language>,
812 adapter: Arc<CachedLspAdapter>,
813 root_path: Arc<Path>,
814 http_client: Arc<dyn HttpClient>,
815 cx: &mut AppContext,
816 ) -> Option<PendingLanguageServer> {
817 let server_id = self.state.write().next_language_server_id();
818 log::info!(
819 "starting language server name:{}, path:{root_path:?}, id:{server_id}",
820 adapter.name.0
821 );
822
823 #[cfg(any(test, feature = "test-support"))]
824 if language.fake_adapter.is_some() {
825 let task = cx.spawn(|cx| async move {
826 let (servers_tx, fake_adapter) = language.fake_adapter.as_ref().unwrap();
827 let (server, mut fake_server) = lsp::LanguageServer::fake(
828 fake_adapter.name.to_string(),
829 fake_adapter.capabilities.clone(),
830 cx.clone(),
831 );
832
833 if let Some(initializer) = &fake_adapter.initializer {
834 initializer(&mut fake_server);
835 }
836
837 let servers_tx = servers_tx.clone();
838 cx.background()
839 .spawn(async move {
840 if fake_server
841 .try_receive_notification::<lsp::notification::Initialized>()
842 .await
843 .is_some()
844 {
845 servers_tx.unbounded_send(fake_server).ok();
846 }
847 })
848 .detach();
849 Ok(server)
850 });
851
852 return Some(PendingLanguageServer { server_id, task });
853 }
854
855 let download_dir = self
856 .language_server_download_dir
857 .clone()
858 .ok_or_else(|| anyhow!("language server download directory has not been assigned"))
859 .log_err()?;
860 let this = self.clone();
861 let language = language.clone();
862 let http_client = http_client.clone();
863 let download_dir = download_dir.clone();
864 let root_path = root_path.clone();
865 let adapter = adapter.clone();
866 let lsp_binary_statuses = self.lsp_binary_statuses_tx.clone();
867 let login_shell_env_loaded = self.login_shell_env_loaded.clone();
868
869 let task = cx.spawn(|cx| async move {
870 login_shell_env_loaded.await;
871
872 let mut lock = this.lsp_binary_paths.lock();
873 let entry = lock
874 .entry(adapter.name.clone())
875 .or_insert_with(|| {
876 get_binary(
877 adapter.clone(),
878 language.clone(),
879 http_client,
880 download_dir,
881 lsp_binary_statuses,
882 )
883 .map_err(Arc::new)
884 .boxed()
885 .shared()
886 })
887 .clone();
888 drop(lock);
889 let binary = entry.clone().map_err(|e| anyhow!(e)).await?;
890
891 let server = lsp::LanguageServer::new(
892 server_id,
893 &binary.path,
894 &binary.arguments,
895 &root_path,
896 adapter.code_action_kinds(),
897 cx,
898 )?;
899
900 Ok(server)
901 });
902
903 Some(PendingLanguageServer { server_id, task })
904 }
905
906 pub fn language_server_binary_statuses(
907 &self,
908 ) -> async_broadcast::Receiver<(Arc<Language>, LanguageServerBinaryStatus)> {
909 self.lsp_binary_statuses_rx.clone()
910 }
911}
912
913impl LanguageRegistryState {
914 fn next_language_server_id(&mut self) -> LanguageServerId {
915 LanguageServerId(post_inc(&mut self.next_language_server_id))
916 }
917
918 fn add(&mut self, language: Arc<Language>) {
919 if let Some(theme) = self.theme.as_ref() {
920 language.set_theme(&theme.editor.syntax);
921 }
922 self.languages.push(language);
923 self.version += 1;
924 *self.subscription.0.borrow_mut() = ();
925 }
926
927 #[cfg(debug_assertions)]
928 fn reload(&mut self) {
929 self.languages.clear();
930 self.version += 1;
931 self.reload_count += 1;
932 for language in &mut self.available_languages {
933 language.loaded = false;
934 }
935 *self.subscription.0.borrow_mut() = ();
936 }
937
938 /// Mark the given language a having been loaded, so that the
939 /// language registry won't try to load it again.
940 fn mark_language_loaded(&mut self, id: AvailableLanguageId) {
941 for language in &mut self.available_languages {
942 if language.id == id {
943 language.loaded = true;
944 break;
945 }
946 }
947 }
948}
949
950#[cfg(any(test, feature = "test-support"))]
951impl Default for LanguageRegistry {
952 fn default() -> Self {
953 Self::test()
954 }
955}
956
957async fn get_binary(
958 adapter: Arc<CachedLspAdapter>,
959 language: Arc<Language>,
960 http_client: Arc<dyn HttpClient>,
961 download_dir: Arc<Path>,
962 statuses: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
963) -> Result<LanguageServerBinary> {
964 let container_dir = download_dir.join(adapter.name.0.as_ref());
965 if !container_dir.exists() {
966 smol::fs::create_dir_all(&container_dir)
967 .await
968 .context("failed to create container directory")?;
969 }
970
971 let binary = fetch_latest_binary(
972 adapter.clone(),
973 language.clone(),
974 http_client,
975 &container_dir,
976 statuses.clone(),
977 )
978 .await;
979
980 if let Err(error) = binary.as_ref() {
981 if let Some(cached) = adapter.cached_server_binary(container_dir).await {
982 statuses
983 .broadcast((language.clone(), LanguageServerBinaryStatus::Cached))
984 .await?;
985 return Ok(cached);
986 } else {
987 statuses
988 .broadcast((
989 language.clone(),
990 LanguageServerBinaryStatus::Failed {
991 error: format!("{:?}", error),
992 },
993 ))
994 .await?;
995 }
996 }
997 binary
998}
999
1000async fn fetch_latest_binary(
1001 adapter: Arc<CachedLspAdapter>,
1002 language: Arc<Language>,
1003 http_client: Arc<dyn HttpClient>,
1004 container_dir: &Path,
1005 lsp_binary_statuses_tx: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
1006) -> Result<LanguageServerBinary> {
1007 let container_dir: Arc<Path> = container_dir.into();
1008 lsp_binary_statuses_tx
1009 .broadcast((
1010 language.clone(),
1011 LanguageServerBinaryStatus::CheckingForUpdate,
1012 ))
1013 .await?;
1014 let version_info = adapter
1015 .fetch_latest_server_version(http_client.clone())
1016 .await?;
1017 lsp_binary_statuses_tx
1018 .broadcast((language.clone(), LanguageServerBinaryStatus::Downloading))
1019 .await?;
1020 let binary = adapter
1021 .fetch_server_binary(version_info, http_client, container_dir.to_path_buf())
1022 .await?;
1023 lsp_binary_statuses_tx
1024 .broadcast((language.clone(), LanguageServerBinaryStatus::Downloaded))
1025 .await?;
1026 Ok(binary)
1027}
1028
1029impl Language {
1030 pub fn new(config: LanguageConfig, ts_language: Option<tree_sitter::Language>) -> Self {
1031 Self {
1032 config,
1033 grammar: ts_language.map(|ts_language| {
1034 Arc::new(Grammar {
1035 id: NEXT_GRAMMAR_ID.fetch_add(1, SeqCst),
1036 highlights_query: None,
1037 brackets_config: None,
1038 outline_config: None,
1039 indents_config: None,
1040 injection_config: None,
1041 override_config: None,
1042 error_query: Query::new(ts_language, "(ERROR) @error").unwrap(),
1043 ts_language,
1044 highlight_map: Default::default(),
1045 })
1046 }),
1047 adapters: Vec::new(),
1048
1049 #[cfg(any(test, feature = "test-support"))]
1050 fake_adapter: None,
1051 }
1052 }
1053
1054 pub fn lsp_adapters(&self) -> &[Arc<CachedLspAdapter>] {
1055 &self.adapters
1056 }
1057
1058 pub fn id(&self) -> Option<usize> {
1059 self.grammar.as_ref().map(|g| g.id)
1060 }
1061
1062 pub fn with_queries(mut self, queries: LanguageQueries) -> Result<Self> {
1063 if let Some(query) = queries.highlights {
1064 self = self.with_highlights_query(query.as_ref())?;
1065 }
1066 if let Some(query) = queries.brackets {
1067 self = self.with_brackets_query(query.as_ref())?;
1068 }
1069 if let Some(query) = queries.indents {
1070 self = self.with_indents_query(query.as_ref())?;
1071 }
1072 if let Some(query) = queries.outline {
1073 self = self.with_outline_query(query.as_ref())?;
1074 }
1075 if let Some(query) = queries.injections {
1076 self = self.with_injection_query(query.as_ref())?;
1077 }
1078 if let Some(query) = queries.overrides {
1079 self = self.with_override_query(query.as_ref())?;
1080 }
1081 Ok(self)
1082 }
1083 pub fn with_highlights_query(mut self, source: &str) -> Result<Self> {
1084 let grammar = self.grammar_mut();
1085 grammar.highlights_query = Some(Query::new(grammar.ts_language, source)?);
1086 Ok(self)
1087 }
1088
1089 pub fn with_outline_query(mut self, source: &str) -> Result<Self> {
1090 let grammar = self.grammar_mut();
1091 let query = Query::new(grammar.ts_language, source)?;
1092 let mut item_capture_ix = None;
1093 let mut name_capture_ix = None;
1094 let mut context_capture_ix = None;
1095 let mut extra_context_capture_ix = None;
1096 get_capture_indices(
1097 &query,
1098 &mut [
1099 ("item", &mut item_capture_ix),
1100 ("name", &mut name_capture_ix),
1101 ("context", &mut context_capture_ix),
1102 ("context.extra", &mut extra_context_capture_ix),
1103 ],
1104 );
1105 if let Some((item_capture_ix, name_capture_ix)) = item_capture_ix.zip(name_capture_ix) {
1106 grammar.outline_config = Some(OutlineConfig {
1107 query,
1108 item_capture_ix,
1109 name_capture_ix,
1110 context_capture_ix,
1111 extra_context_capture_ix,
1112 });
1113 }
1114 Ok(self)
1115 }
1116
1117 pub fn with_brackets_query(mut self, source: &str) -> Result<Self> {
1118 let grammar = self.grammar_mut();
1119 let query = Query::new(grammar.ts_language, source)?;
1120 let mut open_capture_ix = None;
1121 let mut close_capture_ix = None;
1122 get_capture_indices(
1123 &query,
1124 &mut [
1125 ("open", &mut open_capture_ix),
1126 ("close", &mut close_capture_ix),
1127 ],
1128 );
1129 if let Some((open_capture_ix, close_capture_ix)) = open_capture_ix.zip(close_capture_ix) {
1130 grammar.brackets_config = Some(BracketConfig {
1131 query,
1132 open_capture_ix,
1133 close_capture_ix,
1134 });
1135 }
1136 Ok(self)
1137 }
1138
1139 pub fn with_indents_query(mut self, source: &str) -> Result<Self> {
1140 let grammar = self.grammar_mut();
1141 let query = Query::new(grammar.ts_language, source)?;
1142 let mut indent_capture_ix = None;
1143 let mut start_capture_ix = None;
1144 let mut end_capture_ix = None;
1145 let mut outdent_capture_ix = None;
1146 get_capture_indices(
1147 &query,
1148 &mut [
1149 ("indent", &mut indent_capture_ix),
1150 ("start", &mut start_capture_ix),
1151 ("end", &mut end_capture_ix),
1152 ("outdent", &mut outdent_capture_ix),
1153 ],
1154 );
1155 if let Some(indent_capture_ix) = indent_capture_ix {
1156 grammar.indents_config = Some(IndentConfig {
1157 query,
1158 indent_capture_ix,
1159 start_capture_ix,
1160 end_capture_ix,
1161 outdent_capture_ix,
1162 });
1163 }
1164 Ok(self)
1165 }
1166
1167 pub fn with_injection_query(mut self, source: &str) -> Result<Self> {
1168 let grammar = self.grammar_mut();
1169 let query = Query::new(grammar.ts_language, source)?;
1170 let mut language_capture_ix = None;
1171 let mut content_capture_ix = None;
1172 get_capture_indices(
1173 &query,
1174 &mut [
1175 ("language", &mut language_capture_ix),
1176 ("content", &mut content_capture_ix),
1177 ],
1178 );
1179 let patterns = (0..query.pattern_count())
1180 .map(|ix| {
1181 let mut config = InjectionPatternConfig::default();
1182 for setting in query.property_settings(ix) {
1183 match setting.key.as_ref() {
1184 "language" => {
1185 config.language = setting.value.clone();
1186 }
1187 "combined" => {
1188 config.combined = true;
1189 }
1190 _ => {}
1191 }
1192 }
1193 config
1194 })
1195 .collect();
1196 if let Some(content_capture_ix) = content_capture_ix {
1197 grammar.injection_config = Some(InjectionConfig {
1198 query,
1199 language_capture_ix,
1200 content_capture_ix,
1201 patterns,
1202 });
1203 }
1204 Ok(self)
1205 }
1206
1207 pub fn with_override_query(mut self, source: &str) -> Result<Self> {
1208 let query = Query::new(self.grammar_mut().ts_language, source)?;
1209
1210 let mut override_configs_by_id = HashMap::default();
1211 for (ix, name) in query.capture_names().iter().enumerate() {
1212 if !name.starts_with('_') {
1213 let value = self.config.overrides.remove(name).unwrap_or_default();
1214 override_configs_by_id.insert(ix as u32, (name.clone(), value));
1215 }
1216 }
1217
1218 if !self.config.overrides.is_empty() {
1219 let keys = self.config.overrides.keys().collect::<Vec<_>>();
1220 Err(anyhow!(
1221 "language {:?} has overrides in config not in query: {keys:?}",
1222 self.config.name
1223 ))?;
1224 }
1225
1226 for disabled_scope_name in self
1227 .config
1228 .brackets
1229 .disabled_scopes_by_bracket_ix
1230 .iter()
1231 .flatten()
1232 {
1233 if !override_configs_by_id
1234 .values()
1235 .any(|(scope_name, _)| scope_name == disabled_scope_name)
1236 {
1237 Err(anyhow!(
1238 "language {:?} has overrides in config not in query: {disabled_scope_name:?}",
1239 self.config.name
1240 ))?;
1241 }
1242 }
1243
1244 for (name, override_config) in override_configs_by_id.values_mut() {
1245 override_config.disabled_bracket_ixs = self
1246 .config
1247 .brackets
1248 .disabled_scopes_by_bracket_ix
1249 .iter()
1250 .enumerate()
1251 .filter_map(|(ix, disabled_scope_names)| {
1252 if disabled_scope_names.contains(name) {
1253 Some(ix as u16)
1254 } else {
1255 None
1256 }
1257 })
1258 .collect();
1259 }
1260
1261 self.config.brackets.disabled_scopes_by_bracket_ix.clear();
1262 self.grammar_mut().override_config = Some(OverrideConfig {
1263 query,
1264 values: override_configs_by_id,
1265 });
1266 Ok(self)
1267 }
1268
1269 fn grammar_mut(&mut self) -> &mut Grammar {
1270 Arc::get_mut(self.grammar.as_mut().unwrap()).unwrap()
1271 }
1272
1273 pub async fn with_lsp_adapters(mut self, lsp_adapters: Vec<Arc<dyn LspAdapter>>) -> Self {
1274 for adapter in lsp_adapters {
1275 self.adapters.push(CachedLspAdapter::new(adapter).await);
1276 }
1277 self
1278 }
1279
1280 #[cfg(any(test, feature = "test-support"))]
1281 pub async fn set_fake_lsp_adapter(
1282 &mut self,
1283 fake_lsp_adapter: Arc<FakeLspAdapter>,
1284 ) -> mpsc::UnboundedReceiver<lsp::FakeLanguageServer> {
1285 let (servers_tx, servers_rx) = mpsc::unbounded();
1286 self.fake_adapter = Some((servers_tx, fake_lsp_adapter.clone()));
1287 let adapter = CachedLspAdapter::new(Arc::new(fake_lsp_adapter)).await;
1288 self.adapters = vec![adapter];
1289 servers_rx
1290 }
1291
1292 pub fn name(&self) -> Arc<str> {
1293 self.config.name.clone()
1294 }
1295
1296 pub async fn disk_based_diagnostic_sources(&self) -> &[String] {
1297 match self.adapters.first().as_ref() {
1298 Some(adapter) => &adapter.disk_based_diagnostic_sources,
1299 None => &[],
1300 }
1301 }
1302
1303 pub async fn disk_based_diagnostics_progress_token(&self) -> Option<&str> {
1304 for adapter in &self.adapters {
1305 let token = adapter.disk_based_diagnostics_progress_token.as_deref();
1306 if token.is_some() {
1307 return token;
1308 }
1309 }
1310
1311 None
1312 }
1313
1314 pub async fn process_diagnostics(&self, diagnostics: &mut lsp::PublishDiagnosticsParams) {
1315 for adapter in &self.adapters {
1316 adapter.process_diagnostics(diagnostics).await;
1317 }
1318 }
1319
1320 pub async fn process_completion(self: &Arc<Self>, completion: &mut lsp::CompletionItem) {
1321 for adapter in &self.adapters {
1322 adapter.process_completion(completion).await;
1323 }
1324 }
1325
1326 pub async fn label_for_completion(
1327 self: &Arc<Self>,
1328 completion: &lsp::CompletionItem,
1329 ) -> Option<CodeLabel> {
1330 self.adapters
1331 .first()
1332 .as_ref()?
1333 .label_for_completion(completion, self)
1334 .await
1335 }
1336
1337 pub async fn label_for_symbol(
1338 self: &Arc<Self>,
1339 name: &str,
1340 kind: lsp::SymbolKind,
1341 ) -> Option<CodeLabel> {
1342 self.adapters
1343 .first()
1344 .as_ref()?
1345 .label_for_symbol(name, kind, self)
1346 .await
1347 }
1348
1349 pub fn highlight_text<'a>(
1350 self: &'a Arc<Self>,
1351 text: &'a Rope,
1352 range: Range<usize>,
1353 ) -> Vec<(Range<usize>, HighlightId)> {
1354 let mut result = Vec::new();
1355 if let Some(grammar) = &self.grammar {
1356 let tree = grammar.parse_text(text, None);
1357 let captures =
1358 SyntaxSnapshot::single_tree_captures(range.clone(), text, &tree, self, |grammar| {
1359 grammar.highlights_query.as_ref()
1360 });
1361 let highlight_maps = vec![grammar.highlight_map()];
1362 let mut offset = 0;
1363 for chunk in BufferChunks::new(text, range, Some((captures, highlight_maps)), vec![]) {
1364 let end_offset = offset + chunk.text.len();
1365 if let Some(highlight_id) = chunk.syntax_highlight_id {
1366 if !highlight_id.is_default() {
1367 result.push((offset..end_offset, highlight_id));
1368 }
1369 }
1370 offset = end_offset;
1371 }
1372 }
1373 result
1374 }
1375
1376 pub fn path_suffixes(&self) -> &[String] {
1377 &self.config.path_suffixes
1378 }
1379
1380 pub fn should_autoclose_before(&self, c: char) -> bool {
1381 c.is_whitespace() || self.config.autoclose_before.contains(c)
1382 }
1383
1384 pub fn set_theme(&self, theme: &SyntaxTheme) {
1385 if let Some(grammar) = self.grammar.as_ref() {
1386 if let Some(highlights_query) = &grammar.highlights_query {
1387 *grammar.highlight_map.lock() =
1388 HighlightMap::new(highlights_query.capture_names(), theme);
1389 }
1390 }
1391 }
1392
1393 pub fn grammar(&self) -> Option<&Arc<Grammar>> {
1394 self.grammar.as_ref()
1395 }
1396}
1397
1398impl LanguageScope {
1399 pub fn line_comment_prefix(&self) -> Option<&Arc<str>> {
1400 Override::as_option(
1401 self.config_override().map(|o| &o.line_comment),
1402 self.language.config.line_comment.as_ref(),
1403 )
1404 }
1405
1406 pub fn block_comment_delimiters(&self) -> Option<(&Arc<str>, &Arc<str>)> {
1407 Override::as_option(
1408 self.config_override().map(|o| &o.block_comment),
1409 self.language.config.block_comment.as_ref(),
1410 )
1411 .map(|e| (&e.0, &e.1))
1412 }
1413
1414 pub fn brackets(&self) -> impl Iterator<Item = (&BracketPair, bool)> {
1415 let mut disabled_ids = self
1416 .config_override()
1417 .map_or(&[] as _, |o| o.disabled_bracket_ixs.as_slice());
1418 self.language
1419 .config
1420 .brackets
1421 .pairs
1422 .iter()
1423 .enumerate()
1424 .map(move |(ix, bracket)| {
1425 let mut is_enabled = true;
1426 if let Some(next_disabled_ix) = disabled_ids.first() {
1427 if ix == *next_disabled_ix as usize {
1428 disabled_ids = &disabled_ids[1..];
1429 is_enabled = false;
1430 }
1431 }
1432 (bracket, is_enabled)
1433 })
1434 }
1435
1436 pub fn should_autoclose_before(&self, c: char) -> bool {
1437 c.is_whitespace() || self.language.config.autoclose_before.contains(c)
1438 }
1439
1440 fn config_override(&self) -> Option<&LanguageConfigOverride> {
1441 let id = self.override_id?;
1442 let grammar = self.language.grammar.as_ref()?;
1443 let override_config = grammar.override_config.as_ref()?;
1444 override_config.values.get(&id).map(|e| &e.1)
1445 }
1446}
1447
1448impl Hash for Language {
1449 fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
1450 self.id().hash(state)
1451 }
1452}
1453
1454impl PartialEq for Language {
1455 fn eq(&self, other: &Self) -> bool {
1456 self.id().eq(&other.id())
1457 }
1458}
1459
1460impl Eq for Language {}
1461
1462impl Debug for Language {
1463 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1464 f.debug_struct("Language")
1465 .field("name", &self.config.name)
1466 .finish()
1467 }
1468}
1469
1470impl Grammar {
1471 pub fn id(&self) -> usize {
1472 self.id
1473 }
1474
1475 fn parse_text(&self, text: &Rope, old_tree: Option<Tree>) -> Tree {
1476 PARSER.with(|parser| {
1477 let mut parser = parser.borrow_mut();
1478 parser
1479 .set_language(self.ts_language)
1480 .expect("incompatible grammar");
1481 let mut chunks = text.chunks_in_range(0..text.len());
1482 parser
1483 .parse_with(
1484 &mut move |offset, _| {
1485 chunks.seek(offset);
1486 chunks.next().unwrap_or("").as_bytes()
1487 },
1488 old_tree.as_ref(),
1489 )
1490 .unwrap()
1491 })
1492 }
1493
1494 pub fn highlight_map(&self) -> HighlightMap {
1495 self.highlight_map.lock().clone()
1496 }
1497
1498 pub fn highlight_id_for_name(&self, name: &str) -> Option<HighlightId> {
1499 let capture_id = self
1500 .highlights_query
1501 .as_ref()?
1502 .capture_index_for_name(name)?;
1503 Some(self.highlight_map.lock().get(capture_id))
1504 }
1505}
1506
1507impl CodeLabel {
1508 pub fn plain(text: String, filter_text: Option<&str>) -> Self {
1509 let mut result = Self {
1510 runs: Vec::new(),
1511 filter_range: 0..text.len(),
1512 text,
1513 };
1514 if let Some(filter_text) = filter_text {
1515 if let Some(ix) = result.text.find(filter_text) {
1516 result.filter_range = ix..ix + filter_text.len();
1517 }
1518 }
1519 result
1520 }
1521}
1522
1523#[cfg(any(test, feature = "test-support"))]
1524impl Default for FakeLspAdapter {
1525 fn default() -> Self {
1526 Self {
1527 name: "the-fake-language-server",
1528 capabilities: lsp::LanguageServer::full_capabilities(),
1529 initializer: None,
1530 disk_based_diagnostics_progress_token: None,
1531 disk_based_diagnostics_sources: Vec::new(),
1532 }
1533 }
1534}
1535
1536#[cfg(any(test, feature = "test-support"))]
1537#[async_trait]
1538impl LspAdapter for Arc<FakeLspAdapter> {
1539 async fn name(&self) -> LanguageServerName {
1540 LanguageServerName(self.name.into())
1541 }
1542
1543 async fn fetch_latest_server_version(
1544 &self,
1545 _: Arc<dyn HttpClient>,
1546 ) -> Result<Box<dyn 'static + Send + Any>> {
1547 unreachable!();
1548 }
1549
1550 async fn fetch_server_binary(
1551 &self,
1552 _: Box<dyn 'static + Send + Any>,
1553 _: Arc<dyn HttpClient>,
1554 _: PathBuf,
1555 ) -> Result<LanguageServerBinary> {
1556 unreachable!();
1557 }
1558
1559 async fn cached_server_binary(&self, _: PathBuf) -> Option<LanguageServerBinary> {
1560 unreachable!();
1561 }
1562
1563 async fn process_diagnostics(&self, _: &mut lsp::PublishDiagnosticsParams) {}
1564
1565 async fn disk_based_diagnostic_sources(&self) -> Vec<String> {
1566 self.disk_based_diagnostics_sources.clone()
1567 }
1568
1569 async fn disk_based_diagnostics_progress_token(&self) -> Option<String> {
1570 self.disk_based_diagnostics_progress_token.clone()
1571 }
1572}
1573
1574fn get_capture_indices(query: &Query, captures: &mut [(&str, &mut Option<u32>)]) {
1575 for (ix, name) in query.capture_names().iter().enumerate() {
1576 for (capture_name, index) in captures.iter_mut() {
1577 if capture_name == name {
1578 **index = Some(ix as u32);
1579 break;
1580 }
1581 }
1582 }
1583}
1584
1585pub fn point_to_lsp(point: PointUtf16) -> lsp::Position {
1586 lsp::Position::new(point.row, point.column)
1587}
1588
1589pub fn point_from_lsp(point: lsp::Position) -> Unclipped<PointUtf16> {
1590 Unclipped(PointUtf16::new(point.line, point.character))
1591}
1592
1593pub fn range_to_lsp(range: Range<PointUtf16>) -> lsp::Range {
1594 lsp::Range {
1595 start: point_to_lsp(range.start),
1596 end: point_to_lsp(range.end),
1597 }
1598}
1599
1600pub fn range_from_lsp(range: lsp::Range) -> Range<Unclipped<PointUtf16>> {
1601 let mut start = point_from_lsp(range.start);
1602 let mut end = point_from_lsp(range.end);
1603 if start > end {
1604 mem::swap(&mut start, &mut end);
1605 }
1606 start..end
1607}
1608
1609#[cfg(test)]
1610mod tests {
1611 use super::*;
1612 use gpui::TestAppContext;
1613
1614 #[gpui::test(iterations = 10)]
1615 async fn test_first_line_pattern(cx: &mut TestAppContext) {
1616 let mut languages = LanguageRegistry::test();
1617 languages.set_executor(cx.background());
1618 let languages = Arc::new(languages);
1619 languages.register(
1620 "/javascript",
1621 LanguageConfig {
1622 name: "JavaScript".into(),
1623 path_suffixes: vec!["js".into()],
1624 first_line_pattern: Some(Regex::new(r"\bnode\b").unwrap()),
1625 ..Default::default()
1626 },
1627 tree_sitter_javascript::language(),
1628 vec![],
1629 |_| Default::default(),
1630 );
1631
1632 languages
1633 .language_for_file("the/script", None)
1634 .await
1635 .unwrap_err();
1636 languages
1637 .language_for_file("the/script", Some(&"nothing".into()))
1638 .await
1639 .unwrap_err();
1640 assert_eq!(
1641 languages
1642 .language_for_file("the/script", Some(&"#!/bin/env node".into()))
1643 .await
1644 .unwrap()
1645 .name()
1646 .as_ref(),
1647 "JavaScript"
1648 );
1649 }
1650
1651 #[gpui::test(iterations = 10)]
1652 async fn test_language_loading(cx: &mut TestAppContext) {
1653 let mut languages = LanguageRegistry::test();
1654 languages.set_executor(cx.background());
1655 let languages = Arc::new(languages);
1656 languages.register(
1657 "/JSON",
1658 LanguageConfig {
1659 name: "JSON".into(),
1660 path_suffixes: vec!["json".into()],
1661 ..Default::default()
1662 },
1663 tree_sitter_json::language(),
1664 vec![],
1665 |_| Default::default(),
1666 );
1667 languages.register(
1668 "/rust",
1669 LanguageConfig {
1670 name: "Rust".into(),
1671 path_suffixes: vec!["rs".into()],
1672 ..Default::default()
1673 },
1674 tree_sitter_rust::language(),
1675 vec![],
1676 |_| Default::default(),
1677 );
1678 assert_eq!(
1679 languages.language_names(),
1680 &[
1681 "JSON".to_string(),
1682 "Plain Text".to_string(),
1683 "Rust".to_string(),
1684 ]
1685 );
1686
1687 let rust1 = languages.language_for_name("Rust");
1688 let rust2 = languages.language_for_name("Rust");
1689
1690 // Ensure language is still listed even if it's being loaded.
1691 assert_eq!(
1692 languages.language_names(),
1693 &[
1694 "JSON".to_string(),
1695 "Plain Text".to_string(),
1696 "Rust".to_string(),
1697 ]
1698 );
1699
1700 let (rust1, rust2) = futures::join!(rust1, rust2);
1701 assert!(Arc::ptr_eq(&rust1.unwrap(), &rust2.unwrap()));
1702
1703 // Ensure language is still listed even after loading it.
1704 assert_eq!(
1705 languages.language_names(),
1706 &[
1707 "JSON".to_string(),
1708 "Plain Text".to_string(),
1709 "Rust".to_string(),
1710 ]
1711 );
1712
1713 // Loading an unknown language returns an error.
1714 assert!(languages.language_for_name("Unknown").await.is_err());
1715 }
1716}