1mod buffer;
2mod diagnostic_set;
3mod highlight_map;
4mod outline;
5pub mod proto;
6#[cfg(test)]
7mod tests;
8
9use anyhow::{anyhow, Context, Result};
10use client::http::HttpClient;
11use collections::HashMap;
12use futures::{
13 future::{BoxFuture, Shared},
14 FutureExt, TryFutureExt,
15};
16use gpui::{MutableAppContext, Task};
17use highlight_map::HighlightMap;
18use lazy_static::lazy_static;
19use parking_lot::{Mutex, RwLock};
20use regex::Regex;
21use serde::{de, Deserialize, Deserializer};
22use serde_json::Value;
23use std::{
24 any::Any,
25 cell::RefCell,
26 mem,
27 ops::Range,
28 path::{Path, PathBuf},
29 str,
30 sync::Arc,
31};
32use theme::SyntaxTheme;
33use tree_sitter::{self, Query};
34use util::ResultExt;
35
36#[cfg(any(test, feature = "test-support"))]
37use futures::channel::mpsc;
38
39pub use buffer::Operation;
40pub use buffer::*;
41pub use diagnostic_set::DiagnosticEntry;
42pub use outline::{Outline, OutlineItem};
43pub use tree_sitter::{Parser, Tree};
44
45thread_local! {
46 static PARSER: RefCell<Parser> = RefCell::new(Parser::new());
47}
48
49lazy_static! {
50 pub static ref PLAIN_TEXT: Arc<Language> = Arc::new(Language::new(
51 LanguageConfig {
52 name: "Plain Text".into(),
53 ..Default::default()
54 },
55 None,
56 ));
57}
58
59pub trait ToLspPosition {
60 fn to_lsp_position(self) -> lsp::Position;
61}
62
63#[derive(Clone, Debug, PartialEq, Eq, Hash)]
64pub struct LanguageServerName(pub Arc<str>);
65
66pub trait LspAdapter: 'static + Send + Sync {
67 fn name(&self) -> LanguageServerName;
68 fn fetch_latest_server_version(
69 &self,
70 http: Arc<dyn HttpClient>,
71 ) -> BoxFuture<'static, Result<Box<dyn 'static + Send + Any>>>;
72 fn fetch_server_binary(
73 &self,
74 version: Box<dyn 'static + Send + Any>,
75 http: Arc<dyn HttpClient>,
76 container_dir: Arc<Path>,
77 ) -> BoxFuture<'static, Result<PathBuf>>;
78 fn cached_server_binary(&self, container_dir: Arc<Path>)
79 -> BoxFuture<'static, Option<PathBuf>>;
80
81 fn process_diagnostics(&self, _: &mut lsp::PublishDiagnosticsParams) {}
82
83 fn label_for_completion(&self, _: &lsp::CompletionItem, _: &Language) -> Option<CodeLabel> {
84 None
85 }
86
87 fn label_for_symbol(&self, _: &str, _: lsp::SymbolKind, _: &Language) -> Option<CodeLabel> {
88 None
89 }
90
91 fn server_args(&self) -> &[&str] {
92 &[]
93 }
94
95 fn initialization_options(&self) -> Option<Value> {
96 None
97 }
98
99 fn disk_based_diagnostic_sources(&self) -> &'static [&'static str] {
100 Default::default()
101 }
102
103 fn disk_based_diagnostics_progress_token(&self) -> Option<&'static str> {
104 None
105 }
106
107 fn id_for_language(&self, _name: &str) -> Option<String> {
108 None
109 }
110}
111
112#[derive(Clone, Debug, PartialEq, Eq)]
113pub struct CodeLabel {
114 pub text: String,
115 pub runs: Vec<(Range<usize>, HighlightId)>,
116 pub filter_range: Range<usize>,
117}
118
119#[derive(Deserialize)]
120pub struct LanguageConfig {
121 pub name: Arc<str>,
122 pub path_suffixes: Vec<String>,
123 pub brackets: Vec<BracketPair>,
124 #[serde(default = "auto_indent_using_last_non_empty_line_default")]
125 pub auto_indent_using_last_non_empty_line: bool,
126 #[serde(default, deserialize_with = "deserialize_regex")]
127 pub increase_indent_pattern: Option<Regex>,
128 #[serde(default, deserialize_with = "deserialize_regex")]
129 pub decrease_indent_pattern: Option<Regex>,
130 #[serde(default)]
131 pub autoclose_before: String,
132 pub line_comment: Option<String>,
133}
134
135impl Default for LanguageConfig {
136 fn default() -> Self {
137 Self {
138 name: "".into(),
139 path_suffixes: Default::default(),
140 brackets: Default::default(),
141 auto_indent_using_last_non_empty_line: auto_indent_using_last_non_empty_line_default(),
142 increase_indent_pattern: Default::default(),
143 decrease_indent_pattern: Default::default(),
144 autoclose_before: Default::default(),
145 line_comment: Default::default(),
146 }
147 }
148}
149
150fn auto_indent_using_last_non_empty_line_default() -> bool {
151 true
152}
153
154fn deserialize_regex<'de, D: Deserializer<'de>>(d: D) -> Result<Option<Regex>, D::Error> {
155 let source = Option::<String>::deserialize(d)?;
156 if let Some(source) = source {
157 Ok(Some(regex::Regex::new(&source).map_err(de::Error::custom)?))
158 } else {
159 Ok(None)
160 }
161}
162
163#[cfg(any(test, feature = "test-support"))]
164pub struct FakeLspAdapter {
165 pub name: &'static str,
166 pub capabilities: lsp::ServerCapabilities,
167 pub initializer: Option<Box<dyn 'static + Send + Sync + Fn(&mut lsp::FakeLanguageServer)>>,
168 pub disk_based_diagnostics_progress_token: Option<&'static str>,
169 pub disk_based_diagnostics_sources: &'static [&'static str],
170}
171
172#[derive(Clone, Debug, Deserialize)]
173pub struct BracketPair {
174 pub start: String,
175 pub end: String,
176 pub close: bool,
177 pub newline: bool,
178}
179
180pub struct Language {
181 pub(crate) config: LanguageConfig,
182 pub(crate) grammar: Option<Arc<Grammar>>,
183 pub(crate) adapter: Option<Arc<dyn LspAdapter>>,
184
185 #[cfg(any(test, feature = "test-support"))]
186 fake_adapter: Option<(
187 mpsc::UnboundedSender<lsp::FakeLanguageServer>,
188 Arc<FakeLspAdapter>,
189 )>,
190}
191
192pub struct Grammar {
193 pub(crate) ts_language: tree_sitter::Language,
194 pub(crate) highlights_query: Option<Query>,
195 pub(crate) brackets_query: Option<Query>,
196 pub(crate) indents_query: Option<Query>,
197 pub(crate) outline_query: Option<Query>,
198 pub(crate) highlight_map: Mutex<HighlightMap>,
199}
200
201#[derive(Clone)]
202pub enum LanguageServerBinaryStatus {
203 CheckingForUpdate,
204 Downloading,
205 Downloaded,
206 Cached,
207 Failed { error: String },
208}
209
210pub struct LanguageRegistry {
211 languages: RwLock<Vec<Arc<Language>>>,
212 language_server_download_dir: Option<Arc<Path>>,
213 lsp_binary_statuses_tx: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
214 lsp_binary_statuses_rx: async_broadcast::Receiver<(Arc<Language>, LanguageServerBinaryStatus)>,
215 login_shell_env_loaded: Shared<Task<()>>,
216 lsp_binary_paths: Mutex<
217 HashMap<
218 LanguageServerName,
219 Shared<BoxFuture<'static, Result<PathBuf, Arc<anyhow::Error>>>>,
220 >,
221 >,
222}
223
224impl LanguageRegistry {
225 pub fn new(login_shell_env_loaded: Task<()>) -> Self {
226 let (lsp_binary_statuses_tx, lsp_binary_statuses_rx) = async_broadcast::broadcast(16);
227 Self {
228 language_server_download_dir: None,
229 languages: Default::default(),
230 lsp_binary_statuses_tx,
231 lsp_binary_statuses_rx,
232 login_shell_env_loaded: login_shell_env_loaded.shared(),
233 lsp_binary_paths: Default::default(),
234 }
235 }
236
237 #[cfg(any(test, feature = "test-support"))]
238 pub fn test() -> Self {
239 Self::new(Task::ready(()))
240 }
241
242 pub fn add(&self, language: Arc<Language>) {
243 self.languages.write().push(language.clone());
244 }
245
246 pub fn set_theme(&self, theme: &SyntaxTheme) {
247 for language in self.languages.read().iter() {
248 language.set_theme(theme);
249 }
250 }
251
252 pub fn set_language_server_download_dir(&mut self, path: impl Into<Arc<Path>>) {
253 self.language_server_download_dir = Some(path.into());
254 }
255
256 pub fn get_language(&self, name: &str) -> Option<Arc<Language>> {
257 self.languages
258 .read()
259 .iter()
260 .find(|language| language.name().to_lowercase() == name.to_lowercase())
261 .cloned()
262 }
263
264 pub fn to_vec(&self) -> Vec<Arc<Language>> {
265 self.languages.read().iter().cloned().collect()
266 }
267
268 pub fn language_names(&self) -> Vec<String> {
269 self.languages
270 .read()
271 .iter()
272 .map(|language| language.name().to_string())
273 .collect()
274 }
275
276 pub fn select_language(&self, path: impl AsRef<Path>) -> Option<Arc<Language>> {
277 let path = path.as_ref();
278 let filename = path.file_name().and_then(|name| name.to_str());
279 let extension = path.extension().and_then(|name| name.to_str());
280 let path_suffixes = [extension, filename];
281 self.languages
282 .read()
283 .iter()
284 .find(|language| {
285 language
286 .config
287 .path_suffixes
288 .iter()
289 .any(|suffix| path_suffixes.contains(&Some(suffix.as_str())))
290 })
291 .cloned()
292 }
293
294 pub fn start_language_server(
295 self: &Arc<Self>,
296 server_id: usize,
297 language: Arc<Language>,
298 root_path: Arc<Path>,
299 http_client: Arc<dyn HttpClient>,
300 cx: &mut MutableAppContext,
301 ) -> Option<Task<Result<lsp::LanguageServer>>> {
302 #[cfg(any(test, feature = "test-support"))]
303 if language.fake_adapter.is_some() {
304 let language = language.clone();
305 return Some(cx.spawn(|cx| async move {
306 let (servers_tx, fake_adapter) = language.fake_adapter.as_ref().unwrap();
307 let (server, mut fake_server) = lsp::LanguageServer::fake(
308 fake_adapter.name.to_string(),
309 fake_adapter.capabilities.clone(),
310 cx.clone(),
311 );
312
313 if let Some(initializer) = &fake_adapter.initializer {
314 initializer(&mut fake_server);
315 }
316
317 let servers_tx = servers_tx.clone();
318 cx.background()
319 .spawn(async move {
320 if fake_server
321 .try_receive_notification::<lsp::notification::Initialized>()
322 .await
323 .is_some()
324 {
325 servers_tx.unbounded_send(fake_server).ok();
326 }
327 })
328 .detach();
329 Ok(server)
330 }));
331 }
332
333 let download_dir = self
334 .language_server_download_dir
335 .clone()
336 .ok_or_else(|| anyhow!("language server download directory has not been assigned"))
337 .log_err()?;
338
339 let this = self.clone();
340 let adapter = language.adapter.clone()?;
341 let lsp_binary_statuses = self.lsp_binary_statuses_tx.clone();
342 let login_shell_env_loaded = self.login_shell_env_loaded.clone();
343 Some(cx.spawn(|cx| async move {
344 login_shell_env_loaded.await;
345 let server_binary_path = this
346 .lsp_binary_paths
347 .lock()
348 .entry(adapter.name())
349 .or_insert_with(|| {
350 get_server_binary_path(
351 adapter.clone(),
352 language.clone(),
353 http_client,
354 download_dir,
355 lsp_binary_statuses,
356 )
357 .map_err(Arc::new)
358 .boxed()
359 .shared()
360 })
361 .clone()
362 .map_err(|e| anyhow!(e));
363
364 let server_binary_path = server_binary_path.await?;
365 let server_args = adapter.server_args();
366 let server = lsp::LanguageServer::new(
367 server_id,
368 &server_binary_path,
369 server_args,
370 &root_path,
371 cx,
372 )?;
373 Ok(server)
374 }))
375 }
376
377 pub fn language_server_binary_statuses(
378 &self,
379 ) -> async_broadcast::Receiver<(Arc<Language>, LanguageServerBinaryStatus)> {
380 self.lsp_binary_statuses_rx.clone()
381 }
382}
383
384async fn get_server_binary_path(
385 adapter: Arc<dyn LspAdapter>,
386 language: Arc<Language>,
387 http_client: Arc<dyn HttpClient>,
388 download_dir: Arc<Path>,
389 statuses: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
390) -> Result<PathBuf> {
391 let container_dir: Arc<Path> = download_dir.join(adapter.name().0.as_ref()).into();
392 if !container_dir.exists() {
393 smol::fs::create_dir_all(&container_dir)
394 .await
395 .context("failed to create container directory")?;
396 }
397
398 let path = fetch_latest_server_binary_path(
399 adapter.clone(),
400 language.clone(),
401 http_client,
402 &container_dir,
403 statuses.clone(),
404 )
405 .await;
406 if let Err(error) = path.as_ref() {
407 if let Some(cached_path) = adapter.cached_server_binary(container_dir).await {
408 statuses
409 .broadcast((language.clone(), LanguageServerBinaryStatus::Cached))
410 .await?;
411 return Ok(cached_path);
412 } else {
413 statuses
414 .broadcast((
415 language.clone(),
416 LanguageServerBinaryStatus::Failed {
417 error: format!("{:?}", error),
418 },
419 ))
420 .await?;
421 }
422 }
423 path
424}
425
426async fn fetch_latest_server_binary_path(
427 adapter: Arc<dyn LspAdapter>,
428 language: Arc<Language>,
429 http_client: Arc<dyn HttpClient>,
430 container_dir: &Path,
431 lsp_binary_statuses_tx: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
432) -> Result<PathBuf> {
433 let container_dir: Arc<Path> = container_dir.into();
434 lsp_binary_statuses_tx
435 .broadcast((
436 language.clone(),
437 LanguageServerBinaryStatus::CheckingForUpdate,
438 ))
439 .await?;
440 let version_info = adapter
441 .fetch_latest_server_version(http_client.clone())
442 .await?;
443 lsp_binary_statuses_tx
444 .broadcast((language.clone(), LanguageServerBinaryStatus::Downloading))
445 .await?;
446 let path = adapter
447 .fetch_server_binary(version_info, http_client, container_dir.clone())
448 .await?;
449 lsp_binary_statuses_tx
450 .broadcast((language.clone(), LanguageServerBinaryStatus::Downloaded))
451 .await?;
452 Ok(path)
453}
454
455impl Language {
456 pub fn new(config: LanguageConfig, ts_language: Option<tree_sitter::Language>) -> Self {
457 Self {
458 config,
459 grammar: ts_language.map(|ts_language| {
460 Arc::new(Grammar {
461 highlights_query: None,
462 brackets_query: None,
463 indents_query: None,
464 outline_query: None,
465 ts_language,
466 highlight_map: Default::default(),
467 })
468 }),
469 adapter: None,
470
471 #[cfg(any(test, feature = "test-support"))]
472 fake_adapter: None,
473 }
474 }
475
476 pub fn lsp_adapter(&self) -> Option<Arc<dyn LspAdapter>> {
477 self.adapter.clone()
478 }
479
480 pub fn with_highlights_query(mut self, source: &str) -> Result<Self> {
481 let grammar = self.grammar_mut();
482 grammar.highlights_query = Some(Query::new(grammar.ts_language, source)?);
483 Ok(self)
484 }
485
486 pub fn with_brackets_query(mut self, source: &str) -> Result<Self> {
487 let grammar = self.grammar_mut();
488 grammar.brackets_query = Some(Query::new(grammar.ts_language, source)?);
489 Ok(self)
490 }
491
492 pub fn with_indents_query(mut self, source: &str) -> Result<Self> {
493 let grammar = self.grammar_mut();
494 grammar.indents_query = Some(Query::new(grammar.ts_language, source)?);
495 Ok(self)
496 }
497
498 pub fn with_outline_query(mut self, source: &str) -> Result<Self> {
499 let grammar = self.grammar_mut();
500 grammar.outline_query = Some(Query::new(grammar.ts_language, source)?);
501 Ok(self)
502 }
503
504 fn grammar_mut(&mut self) -> &mut Grammar {
505 Arc::get_mut(self.grammar.as_mut().unwrap()).unwrap()
506 }
507
508 pub fn with_lsp_adapter(mut self, lsp_adapter: Arc<dyn LspAdapter>) -> Self {
509 self.adapter = Some(lsp_adapter);
510 self
511 }
512
513 #[cfg(any(test, feature = "test-support"))]
514 pub fn set_fake_lsp_adapter(
515 &mut self,
516 fake_lsp_adapter: FakeLspAdapter,
517 ) -> mpsc::UnboundedReceiver<lsp::FakeLanguageServer> {
518 let (servers_tx, servers_rx) = mpsc::unbounded();
519 let adapter = Arc::new(fake_lsp_adapter);
520 self.fake_adapter = Some((servers_tx, adapter.clone()));
521 self.adapter = Some(adapter);
522 servers_rx
523 }
524
525 pub fn name(&self) -> Arc<str> {
526 self.config.name.clone()
527 }
528
529 pub fn line_comment_prefix(&self) -> Option<&str> {
530 self.config.line_comment.as_deref()
531 }
532
533 pub fn disk_based_diagnostic_sources(&self) -> &'static [&'static str] {
534 self.adapter.as_ref().map_or(&[] as &[_], |adapter| {
535 adapter.disk_based_diagnostic_sources()
536 })
537 }
538
539 pub fn disk_based_diagnostics_progress_token(&self) -> Option<&'static str> {
540 self.adapter
541 .as_ref()
542 .and_then(|adapter| adapter.disk_based_diagnostics_progress_token())
543 }
544
545 pub fn process_diagnostics(&self, diagnostics: &mut lsp::PublishDiagnosticsParams) {
546 if let Some(processor) = self.adapter.as_ref() {
547 processor.process_diagnostics(diagnostics);
548 }
549 }
550
551 pub fn label_for_completion(&self, completion: &lsp::CompletionItem) -> Option<CodeLabel> {
552 self.adapter
553 .as_ref()?
554 .label_for_completion(completion, self)
555 }
556
557 pub fn label_for_symbol(&self, name: &str, kind: lsp::SymbolKind) -> Option<CodeLabel> {
558 self.adapter.as_ref()?.label_for_symbol(name, kind, self)
559 }
560
561 pub fn highlight_text<'a>(
562 &'a self,
563 text: &'a Rope,
564 range: Range<usize>,
565 ) -> Vec<(Range<usize>, HighlightId)> {
566 let mut result = Vec::new();
567 if let Some(grammar) = &self.grammar {
568 let tree = grammar.parse_text(text, None);
569 let mut offset = 0;
570 for chunk in BufferChunks::new(text, range, Some(&tree), self.grammar.as_ref(), vec![])
571 {
572 let end_offset = offset + chunk.text.len();
573 if let Some(highlight_id) = chunk.syntax_highlight_id {
574 if !highlight_id.is_default() {
575 result.push((offset..end_offset, highlight_id));
576 }
577 }
578 offset = end_offset;
579 }
580 }
581 result
582 }
583
584 pub fn brackets(&self) -> &[BracketPair] {
585 &self.config.brackets
586 }
587
588 pub fn path_suffixes(&self) -> &[String] {
589 &self.config.path_suffixes
590 }
591
592 pub fn should_autoclose_before(&self, c: char) -> bool {
593 c.is_whitespace() || self.config.autoclose_before.contains(c)
594 }
595
596 pub fn set_theme(&self, theme: &SyntaxTheme) {
597 if let Some(grammar) = self.grammar.as_ref() {
598 if let Some(highlights_query) = &grammar.highlights_query {
599 *grammar.highlight_map.lock() =
600 HighlightMap::new(highlights_query.capture_names(), theme);
601 }
602 }
603 }
604
605 pub fn grammar(&self) -> Option<&Arc<Grammar>> {
606 self.grammar.as_ref()
607 }
608}
609
610impl Grammar {
611 fn parse_text(&self, text: &Rope, old_tree: Option<Tree>) -> Tree {
612 PARSER.with(|parser| {
613 let mut parser = parser.borrow_mut();
614 parser
615 .set_language(self.ts_language)
616 .expect("incompatible grammar");
617 let mut chunks = text.chunks_in_range(0..text.len());
618 parser
619 .parse_with(
620 &mut move |offset, _| {
621 chunks.seek(offset);
622 chunks.next().unwrap_or("").as_bytes()
623 },
624 old_tree.as_ref(),
625 )
626 .unwrap()
627 })
628 }
629
630 pub fn highlight_map(&self) -> HighlightMap {
631 self.highlight_map.lock().clone()
632 }
633
634 pub fn highlight_id_for_name(&self, name: &str) -> Option<HighlightId> {
635 let capture_id = self
636 .highlights_query
637 .as_ref()?
638 .capture_index_for_name(name)?;
639 Some(self.highlight_map.lock().get(capture_id))
640 }
641}
642
643impl CodeLabel {
644 pub fn plain(text: String, filter_text: Option<&str>) -> Self {
645 let mut result = Self {
646 runs: Vec::new(),
647 filter_range: 0..text.len(),
648 text,
649 };
650 if let Some(filter_text) = filter_text {
651 if let Some(ix) = result.text.find(filter_text) {
652 result.filter_range = ix..ix + filter_text.len();
653 }
654 }
655 result
656 }
657}
658
659#[cfg(any(test, feature = "test-support"))]
660impl Default for FakeLspAdapter {
661 fn default() -> Self {
662 Self {
663 name: "the-fake-language-server",
664 capabilities: lsp::LanguageServer::full_capabilities(),
665 initializer: None,
666 disk_based_diagnostics_progress_token: None,
667 disk_based_diagnostics_sources: &[],
668 }
669 }
670}
671
672#[cfg(any(test, feature = "test-support"))]
673impl LspAdapter for FakeLspAdapter {
674 fn name(&self) -> LanguageServerName {
675 LanguageServerName(self.name.into())
676 }
677
678 fn fetch_latest_server_version(
679 &self,
680 _: Arc<dyn HttpClient>,
681 ) -> BoxFuture<'static, Result<Box<dyn 'static + Send + Any>>> {
682 unreachable!();
683 }
684
685 fn fetch_server_binary(
686 &self,
687 _: Box<dyn 'static + Send + Any>,
688 _: Arc<dyn HttpClient>,
689 _: Arc<Path>,
690 ) -> BoxFuture<'static, Result<PathBuf>> {
691 unreachable!();
692 }
693
694 fn cached_server_binary(&self, _: Arc<Path>) -> BoxFuture<'static, Option<PathBuf>> {
695 unreachable!();
696 }
697
698 fn process_diagnostics(&self, _: &mut lsp::PublishDiagnosticsParams) {}
699
700 fn disk_based_diagnostic_sources(&self) -> &'static [&'static str] {
701 self.disk_based_diagnostics_sources
702 }
703
704 fn disk_based_diagnostics_progress_token(&self) -> Option<&'static str> {
705 self.disk_based_diagnostics_progress_token
706 }
707}
708
709pub fn point_to_lsp(point: PointUtf16) -> lsp::Position {
710 lsp::Position::new(point.row, point.column)
711}
712
713pub fn point_from_lsp(point: lsp::Position) -> PointUtf16 {
714 PointUtf16::new(point.line, point.character)
715}
716
717pub fn range_to_lsp(range: Range<PointUtf16>) -> lsp::Range {
718 lsp::Range {
719 start: point_to_lsp(range.start),
720 end: point_to_lsp(range.end),
721 }
722}
723
724pub fn range_from_lsp(range: lsp::Range) -> Range<PointUtf16> {
725 let mut start = point_from_lsp(range.start);
726 let mut end = point_from_lsp(range.end);
727 if start > end {
728 mem::swap(&mut start, &mut end);
729 }
730 start..end
731}