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