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 language_names(&self) -> Vec<String> {
245 self.languages
246 .read()
247 .iter()
248 .map(|language| language.name().to_string())
249 .collect()
250 }
251
252 pub fn select_language(&self, path: impl AsRef<Path>) -> Option<Arc<Language>> {
253 let path = path.as_ref();
254 let filename = path.file_name().and_then(|name| name.to_str());
255 let extension = path.extension().and_then(|name| name.to_str());
256 let path_suffixes = [extension, filename];
257 self.languages
258 .read()
259 .iter()
260 .find(|language| {
261 language
262 .config
263 .path_suffixes
264 .iter()
265 .any(|suffix| path_suffixes.contains(&Some(suffix.as_str())))
266 })
267 .cloned()
268 }
269
270 pub fn start_language_server(
271 self: &Arc<Self>,
272 server_id: usize,
273 language: Arc<Language>,
274 root_path: Arc<Path>,
275 http_client: Arc<dyn HttpClient>,
276 cx: &mut MutableAppContext,
277 ) -> Option<Task<Result<lsp::LanguageServer>>> {
278 #[cfg(any(test, feature = "test-support"))]
279 if language.fake_adapter.is_some() {
280 let language = language.clone();
281 return Some(cx.spawn(|cx| async move {
282 let (servers_tx, fake_adapter) = language.fake_adapter.as_ref().unwrap();
283 let (server, mut fake_server) = lsp::LanguageServer::fake_with_capabilities(
284 fake_adapter.capabilities.clone(),
285 cx.clone(),
286 );
287
288 if let Some(initializer) = &fake_adapter.initializer {
289 initializer(&mut fake_server);
290 }
291
292 let servers_tx = servers_tx.clone();
293 cx.background()
294 .spawn(async move {
295 if fake_server
296 .try_receive_notification::<lsp::notification::Initialized>()
297 .await
298 .is_some()
299 {
300 servers_tx.unbounded_send(fake_server).ok();
301 }
302 })
303 .detach();
304 Ok(server)
305 }));
306 }
307
308 let download_dir = self
309 .language_server_download_dir
310 .clone()
311 .ok_or_else(|| anyhow!("language server download directory has not been assigned"))
312 .log_err()?;
313
314 let this = self.clone();
315 let adapter = language.adapter.clone()?;
316 let lsp_binary_statuses = self.lsp_binary_statuses_tx.clone();
317 let login_shell_env_loaded = self.login_shell_env_loaded.clone();
318 Some(cx.spawn(|cx| async move {
319 login_shell_env_loaded.await;
320 let server_binary_path = this
321 .lsp_binary_paths
322 .lock()
323 .entry(adapter.name())
324 .or_insert_with(|| {
325 get_server_binary_path(
326 adapter.clone(),
327 language.clone(),
328 http_client,
329 download_dir,
330 lsp_binary_statuses,
331 )
332 .map_err(Arc::new)
333 .boxed()
334 .shared()
335 })
336 .clone()
337 .map_err(|e| anyhow!(e));
338
339 let server_binary_path = server_binary_path.await?;
340 let server_args = adapter.server_args();
341 let server = lsp::LanguageServer::new(
342 server_id,
343 &server_binary_path,
344 server_args,
345 &root_path,
346 cx,
347 )?;
348 Ok(server)
349 }))
350 }
351
352 pub fn language_server_binary_statuses(
353 &self,
354 ) -> async_broadcast::Receiver<(Arc<Language>, LanguageServerBinaryStatus)> {
355 self.lsp_binary_statuses_rx.clone()
356 }
357}
358
359async fn get_server_binary_path(
360 adapter: Arc<dyn LspAdapter>,
361 language: Arc<Language>,
362 http_client: Arc<dyn HttpClient>,
363 download_dir: Arc<Path>,
364 statuses: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
365) -> Result<PathBuf> {
366 let container_dir: Arc<Path> = download_dir.join(adapter.name().0.as_ref()).into();
367 if !container_dir.exists() {
368 smol::fs::create_dir_all(&container_dir)
369 .await
370 .context("failed to create container directory")?;
371 }
372
373 let path = fetch_latest_server_binary_path(
374 adapter.clone(),
375 language.clone(),
376 http_client,
377 &container_dir,
378 statuses.clone(),
379 )
380 .await;
381 if path.is_err() {
382 if let Some(cached_path) = adapter.cached_server_binary(container_dir).await {
383 statuses
384 .broadcast((language.clone(), LanguageServerBinaryStatus::Cached))
385 .await?;
386 return Ok(cached_path);
387 } else {
388 statuses
389 .broadcast((language.clone(), LanguageServerBinaryStatus::Failed))
390 .await?;
391 }
392 }
393 path
394}
395
396async fn fetch_latest_server_binary_path(
397 adapter: Arc<dyn LspAdapter>,
398 language: Arc<Language>,
399 http_client: Arc<dyn HttpClient>,
400 container_dir: &Path,
401 lsp_binary_statuses_tx: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
402) -> Result<PathBuf> {
403 let container_dir: Arc<Path> = container_dir.into();
404 lsp_binary_statuses_tx
405 .broadcast((
406 language.clone(),
407 LanguageServerBinaryStatus::CheckingForUpdate,
408 ))
409 .await?;
410 let version_info = adapter
411 .fetch_latest_server_version(http_client.clone())
412 .await?;
413 lsp_binary_statuses_tx
414 .broadcast((language.clone(), LanguageServerBinaryStatus::Downloading))
415 .await?;
416 let path = adapter
417 .fetch_server_binary(version_info, http_client, container_dir.clone())
418 .await?;
419 lsp_binary_statuses_tx
420 .broadcast((language.clone(), LanguageServerBinaryStatus::Downloaded))
421 .await?;
422 Ok(path)
423}
424
425impl Language {
426 pub fn new(config: LanguageConfig, ts_language: Option<tree_sitter::Language>) -> Self {
427 Self {
428 config,
429 grammar: ts_language.map(|ts_language| {
430 Arc::new(Grammar {
431 brackets_query: Query::new(ts_language, "").unwrap(),
432 highlights_query: Query::new(ts_language, "").unwrap(),
433 indents_query: Query::new(ts_language, "").unwrap(),
434 outline_query: Query::new(ts_language, "").unwrap(),
435 ts_language,
436 highlight_map: Default::default(),
437 })
438 }),
439 adapter: None,
440
441 #[cfg(any(test, feature = "test-support"))]
442 fake_adapter: None,
443 }
444 }
445
446 pub fn lsp_adapter(&self) -> Option<Arc<dyn LspAdapter>> {
447 self.adapter.clone()
448 }
449
450 pub fn with_highlights_query(mut self, source: &str) -> Result<Self> {
451 let grammar = self
452 .grammar
453 .as_mut()
454 .and_then(Arc::get_mut)
455 .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
456 grammar.highlights_query = Query::new(grammar.ts_language, source)?;
457 Ok(self)
458 }
459
460 pub fn with_brackets_query(mut self, source: &str) -> Result<Self> {
461 let grammar = self
462 .grammar
463 .as_mut()
464 .and_then(Arc::get_mut)
465 .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
466 grammar.brackets_query = Query::new(grammar.ts_language, source)?;
467 Ok(self)
468 }
469
470 pub fn with_indents_query(mut self, source: &str) -> Result<Self> {
471 let grammar = self
472 .grammar
473 .as_mut()
474 .and_then(Arc::get_mut)
475 .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
476 grammar.indents_query = Query::new(grammar.ts_language, source)?;
477 Ok(self)
478 }
479
480 pub fn with_outline_query(mut self, source: &str) -> Result<Self> {
481 let grammar = self
482 .grammar
483 .as_mut()
484 .and_then(Arc::get_mut)
485 .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
486 grammar.outline_query = Query::new(grammar.ts_language, source)?;
487 Ok(self)
488 }
489
490 pub fn with_lsp_adapter(mut self, lsp_adapter: Arc<dyn LspAdapter>) -> Self {
491 self.adapter = Some(lsp_adapter);
492 self
493 }
494
495 #[cfg(any(test, feature = "test-support"))]
496 pub fn set_fake_lsp_adapter(
497 &mut self,
498 fake_lsp_adapter: FakeLspAdapter,
499 ) -> mpsc::UnboundedReceiver<lsp::FakeLanguageServer> {
500 let (servers_tx, servers_rx) = mpsc::unbounded();
501 let adapter = Arc::new(fake_lsp_adapter);
502 self.fake_adapter = Some((servers_tx, adapter.clone()));
503 self.adapter = Some(adapter);
504 servers_rx
505 }
506
507 pub fn name(&self) -> Arc<str> {
508 self.config.name.clone()
509 }
510
511 pub fn line_comment_prefix(&self) -> Option<&str> {
512 self.config.line_comment.as_deref()
513 }
514
515 pub fn disk_based_diagnostic_sources(&self) -> &'static [&'static str] {
516 self.adapter.as_ref().map_or(&[] as &[_], |adapter| {
517 adapter.disk_based_diagnostic_sources()
518 })
519 }
520
521 pub fn disk_based_diagnostics_progress_token(&self) -> Option<&'static str> {
522 self.adapter
523 .as_ref()
524 .and_then(|adapter| adapter.disk_based_diagnostics_progress_token())
525 }
526
527 pub fn process_diagnostics(&self, diagnostics: &mut lsp::PublishDiagnosticsParams) {
528 if let Some(processor) = self.adapter.as_ref() {
529 processor.process_diagnostics(diagnostics);
530 }
531 }
532
533 pub fn label_for_completion(&self, completion: &lsp::CompletionItem) -> Option<CodeLabel> {
534 self.adapter
535 .as_ref()?
536 .label_for_completion(completion, self)
537 }
538
539 pub fn label_for_symbol(&self, name: &str, kind: lsp::SymbolKind) -> Option<CodeLabel> {
540 self.adapter.as_ref()?.label_for_symbol(name, kind, self)
541 }
542
543 pub fn highlight_text<'a>(
544 &'a self,
545 text: &'a Rope,
546 range: Range<usize>,
547 ) -> Vec<(Range<usize>, HighlightId)> {
548 let mut result = Vec::new();
549 if let Some(grammar) = &self.grammar {
550 let tree = grammar.parse_text(text, None);
551 let mut offset = 0;
552 for chunk in BufferChunks::new(text, range, Some(&tree), self.grammar.as_ref(), vec![])
553 {
554 let end_offset = offset + chunk.text.len();
555 if let Some(highlight_id) = chunk.syntax_highlight_id {
556 if !highlight_id.is_default() {
557 result.push((offset..end_offset, highlight_id));
558 }
559 }
560 offset = end_offset;
561 }
562 }
563 result
564 }
565
566 pub fn brackets(&self) -> &[BracketPair] {
567 &self.config.brackets
568 }
569
570 pub fn should_autoclose_before(&self, c: char) -> bool {
571 c.is_whitespace() || self.config.autoclose_before.contains(c)
572 }
573
574 pub fn set_theme(&self, theme: &SyntaxTheme) {
575 if let Some(grammar) = self.grammar.as_ref() {
576 *grammar.highlight_map.lock() =
577 HighlightMap::new(grammar.highlights_query.capture_names(), theme);
578 }
579 }
580
581 pub fn grammar(&self) -> Option<&Arc<Grammar>> {
582 self.grammar.as_ref()
583 }
584}
585
586impl Grammar {
587 fn parse_text(&self, text: &Rope, old_tree: Option<Tree>) -> Tree {
588 PARSER.with(|parser| {
589 let mut parser = parser.borrow_mut();
590 parser
591 .set_language(self.ts_language)
592 .expect("incompatible grammar");
593 let mut chunks = text.chunks_in_range(0..text.len());
594 parser
595 .parse_with(
596 &mut move |offset, _| {
597 chunks.seek(offset);
598 chunks.next().unwrap_or("").as_bytes()
599 },
600 old_tree.as_ref(),
601 )
602 .unwrap()
603 })
604 }
605
606 pub fn highlight_map(&self) -> HighlightMap {
607 self.highlight_map.lock().clone()
608 }
609
610 pub fn highlight_id_for_name(&self, name: &str) -> Option<HighlightId> {
611 let capture_id = self.highlights_query.capture_index_for_name(name)?;
612 Some(self.highlight_map.lock().get(capture_id))
613 }
614}
615
616impl CodeLabel {
617 pub fn plain(text: String, filter_text: Option<&str>) -> Self {
618 let mut result = Self {
619 runs: Vec::new(),
620 filter_range: 0..text.len(),
621 text,
622 };
623 if let Some(filter_text) = filter_text {
624 if let Some(ix) = result.text.find(filter_text) {
625 result.filter_range = ix..ix + filter_text.len();
626 }
627 }
628 result
629 }
630}
631
632#[cfg(any(test, feature = "test-support"))]
633impl Default for FakeLspAdapter {
634 fn default() -> Self {
635 Self {
636 name: "the-fake-language-server",
637 capabilities: lsp::LanguageServer::full_capabilities(),
638 initializer: None,
639 disk_based_diagnostics_progress_token: None,
640 disk_based_diagnostics_sources: &[],
641 }
642 }
643}
644
645#[cfg(any(test, feature = "test-support"))]
646impl LspAdapter for FakeLspAdapter {
647 fn name(&self) -> LanguageServerName {
648 LanguageServerName(self.name.into())
649 }
650
651 fn fetch_latest_server_version(
652 &self,
653 _: Arc<dyn HttpClient>,
654 ) -> BoxFuture<'static, Result<Box<dyn 'static + Send + Any>>> {
655 unreachable!();
656 }
657
658 fn fetch_server_binary(
659 &self,
660 _: Box<dyn 'static + Send + Any>,
661 _: Arc<dyn HttpClient>,
662 _: Arc<Path>,
663 ) -> BoxFuture<'static, Result<PathBuf>> {
664 unreachable!();
665 }
666
667 fn cached_server_binary(&self, _: Arc<Path>) -> BoxFuture<'static, Option<PathBuf>> {
668 unreachable!();
669 }
670
671 fn process_diagnostics(&self, _: &mut lsp::PublishDiagnosticsParams) {}
672
673 fn disk_based_diagnostic_sources(&self) -> &'static [&'static str] {
674 self.disk_based_diagnostics_sources
675 }
676
677 fn disk_based_diagnostics_progress_token(&self) -> Option<&'static str> {
678 self.disk_based_diagnostics_progress_token
679 }
680}
681
682pub fn point_to_lsp(point: PointUtf16) -> lsp::Position {
683 lsp::Position::new(point.row, point.column)
684}
685
686pub fn point_from_lsp(point: lsp::Position) -> PointUtf16 {
687 PointUtf16::new(point.line, point.character)
688}
689
690pub fn range_to_lsp(range: Range<PointUtf16>) -> lsp::Range {
691 lsp::Range {
692 start: point_to_lsp(range.start),
693 end: point_to_lsp(range.end),
694 }
695}
696
697pub fn range_from_lsp(range: lsp::Range) -> Range<PointUtf16> {
698 let mut start = point_from_lsp(range.start);
699 let mut end = point_from_lsp(range.end);
700 if start > end {
701 mem::swap(&mut start, &mut end);
702 }
703 start..end
704}