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