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