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