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