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