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