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