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<Arc<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
268 .update(|cx| {
269 lsp::LanguageServer::fake_with_capabilities(
270 fake_config.capabilities.clone(),
271 cx,
272 )
273 })
274 .await;
275 if let Some(initalizer) = &fake_config.initializer {
276 initalizer(&mut fake_server);
277 }
278 fake_config
279 .servers_tx
280 .clone()
281 .unbounded_send(fake_server)
282 .ok();
283 Ok(server.clone())
284 }));
285 }
286
287 let download_dir = self
288 .language_server_download_dir
289 .clone()
290 .ok_or_else(|| anyhow!("language server download directory has not been assigned"))
291 .log_err()?;
292
293 let adapter = language.adapter.clone()?;
294 let background = cx.background().clone();
295 let lsp_binary_statuses = self.lsp_binary_statuses_tx.clone();
296 let login_shell_env_loaded = self.login_shell_env_loaded.clone();
297 Some(cx.background().spawn(async move {
298 login_shell_env_loaded.await;
299 let server_binary_path = language
300 .lsp_binary_path
301 .lock()
302 .get_or_insert_with(|| {
303 get_server_binary_path(
304 adapter.clone(),
305 language.clone(),
306 http_client,
307 download_dir,
308 lsp_binary_statuses,
309 )
310 .map_err(Arc::new)
311 .boxed()
312 .shared()
313 })
314 .clone()
315 .map_err(|e| anyhow!(e));
316
317 let server_binary_path = server_binary_path.await?;
318 let server_args = adapter.server_args();
319 let server = lsp::LanguageServer::new(
320 &server_binary_path,
321 server_args,
322 adapter.initialization_options(),
323 &root_path,
324 background,
325 )
326 .await?;
327 Ok(server)
328 }))
329 }
330
331 pub fn language_server_binary_statuses(
332 &self,
333 ) -> async_broadcast::Receiver<(Arc<Language>, LanguageServerBinaryStatus)> {
334 self.lsp_binary_statuses_rx.clone()
335 }
336}
337
338async fn get_server_binary_path(
339 adapter: Arc<dyn LspAdapter>,
340 language: Arc<Language>,
341 http_client: Arc<dyn HttpClient>,
342 download_dir: Arc<Path>,
343 statuses: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
344) -> Result<PathBuf> {
345 let container_dir = download_dir.join(adapter.name());
346 if !container_dir.exists() {
347 smol::fs::create_dir_all(&container_dir)
348 .await
349 .context("failed to create container directory")?;
350 }
351
352 let path = fetch_latest_server_binary_path(
353 adapter.clone(),
354 language.clone(),
355 http_client,
356 &container_dir,
357 statuses.clone(),
358 )
359 .await;
360 if path.is_err() {
361 if let Some(cached_path) = adapter.cached_server_binary(container_dir).await {
362 statuses
363 .broadcast((language.clone(), LanguageServerBinaryStatus::Cached))
364 .await?;
365 return Ok(cached_path);
366 } else {
367 statuses
368 .broadcast((language.clone(), LanguageServerBinaryStatus::Failed))
369 .await?;
370 }
371 }
372 path
373}
374
375async fn fetch_latest_server_binary_path(
376 adapter: Arc<dyn LspAdapter>,
377 language: Arc<Language>,
378 http_client: Arc<dyn HttpClient>,
379 container_dir: &Path,
380 lsp_binary_statuses_tx: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
381) -> Result<PathBuf> {
382 lsp_binary_statuses_tx
383 .broadcast((
384 language.clone(),
385 LanguageServerBinaryStatus::CheckingForUpdate,
386 ))
387 .await?;
388 let version_info = adapter
389 .fetch_latest_server_version(http_client.clone())
390 .await?;
391 lsp_binary_statuses_tx
392 .broadcast((language.clone(), LanguageServerBinaryStatus::Downloading))
393 .await?;
394 let path = adapter
395 .fetch_server_binary(version_info, http_client, container_dir.to_path_buf())
396 .await?;
397 lsp_binary_statuses_tx
398 .broadcast((language.clone(), LanguageServerBinaryStatus::Downloaded))
399 .await?;
400 Ok(path)
401}
402
403impl Language {
404 pub fn new(config: LanguageConfig, ts_language: Option<tree_sitter::Language>) -> Self {
405 Self {
406 config,
407 grammar: ts_language.map(|ts_language| {
408 Arc::new(Grammar {
409 brackets_query: Query::new(ts_language, "").unwrap(),
410 highlights_query: Query::new(ts_language, "").unwrap(),
411 indents_query: Query::new(ts_language, "").unwrap(),
412 outline_query: Query::new(ts_language, "").unwrap(),
413 ts_language,
414 highlight_map: Default::default(),
415 })
416 }),
417 adapter: None,
418 lsp_binary_path: Default::default(),
419 }
420 }
421
422 pub fn with_highlights_query(mut self, source: &str) -> Result<Self> {
423 let grammar = self
424 .grammar
425 .as_mut()
426 .and_then(Arc::get_mut)
427 .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
428 grammar.highlights_query = Query::new(grammar.ts_language, source)?;
429 Ok(self)
430 }
431
432 pub fn with_brackets_query(mut self, source: &str) -> Result<Self> {
433 let grammar = self
434 .grammar
435 .as_mut()
436 .and_then(Arc::get_mut)
437 .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
438 grammar.brackets_query = Query::new(grammar.ts_language, source)?;
439 Ok(self)
440 }
441
442 pub fn with_indents_query(mut self, source: &str) -> Result<Self> {
443 let grammar = self
444 .grammar
445 .as_mut()
446 .and_then(Arc::get_mut)
447 .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
448 grammar.indents_query = Query::new(grammar.ts_language, source)?;
449 Ok(self)
450 }
451
452 pub fn with_outline_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.outline_query = Query::new(grammar.ts_language, source)?;
459 Ok(self)
460 }
461
462 pub fn with_lsp_adapter(mut self, lsp_adapter: impl LspAdapter) -> Self {
463 self.adapter = Some(Arc::new(lsp_adapter));
464 self
465 }
466
467 pub fn name(&self) -> Arc<str> {
468 self.config.name.clone()
469 }
470
471 pub fn line_comment_prefix(&self) -> Option<&str> {
472 self.config.line_comment.as_deref()
473 }
474
475 pub fn disk_based_diagnostic_sources(&self) -> Option<&HashSet<String>> {
476 self.config
477 .language_server
478 .as_ref()
479 .map(|config| &config.disk_based_diagnostic_sources)
480 }
481
482 pub fn disk_based_diagnostics_progress_token(&self) -> Option<&String> {
483 self.config
484 .language_server
485 .as_ref()
486 .and_then(|config| config.disk_based_diagnostics_progress_token.as_ref())
487 }
488
489 pub fn process_diagnostics(&self, diagnostics: &mut lsp::PublishDiagnosticsParams) {
490 if let Some(processor) = self.adapter.as_ref() {
491 processor.process_diagnostics(diagnostics);
492 }
493 }
494
495 pub fn label_for_completion(&self, completion: &lsp::CompletionItem) -> Option<CodeLabel> {
496 self.adapter
497 .as_ref()?
498 .label_for_completion(completion, self)
499 }
500
501 pub fn label_for_symbol(&self, name: &str, kind: lsp::SymbolKind) -> Option<CodeLabel> {
502 self.adapter.as_ref()?.label_for_symbol(name, kind, self)
503 }
504
505 pub fn highlight_text<'a>(
506 &'a self,
507 text: &'a Rope,
508 range: Range<usize>,
509 ) -> Vec<(Range<usize>, HighlightId)> {
510 let mut result = Vec::new();
511 if let Some(grammar) = &self.grammar {
512 let tree = grammar.parse_text(text, None);
513 let mut offset = 0;
514 for chunk in BufferChunks::new(text, range, Some(&tree), self.grammar.as_ref(), vec![])
515 {
516 let end_offset = offset + chunk.text.len();
517 if let Some(highlight_id) = chunk.highlight_id {
518 result.push((offset..end_offset, highlight_id));
519 }
520 offset = end_offset;
521 }
522 }
523 result
524 }
525
526 pub fn brackets(&self) -> &[BracketPair] {
527 &self.config.brackets
528 }
529
530 pub fn set_theme(&self, theme: &SyntaxTheme) {
531 if let Some(grammar) = self.grammar.as_ref() {
532 *grammar.highlight_map.lock() =
533 HighlightMap::new(grammar.highlights_query.capture_names(), theme);
534 }
535 }
536
537 pub fn grammar(&self) -> Option<&Arc<Grammar>> {
538 self.grammar.as_ref()
539 }
540}
541
542impl Grammar {
543 fn parse_text(&self, text: &Rope, old_tree: Option<Tree>) -> Tree {
544 PARSER.with(|parser| {
545 let mut parser = parser.borrow_mut();
546 parser
547 .set_language(self.ts_language)
548 .expect("incompatible grammar");
549 let mut chunks = text.chunks_in_range(0..text.len());
550 parser
551 .parse_with(
552 &mut move |offset, _| {
553 chunks.seek(offset);
554 chunks.next().unwrap_or("").as_bytes()
555 },
556 old_tree.as_ref(),
557 )
558 .unwrap()
559 })
560 }
561
562 pub fn highlight_map(&self) -> HighlightMap {
563 self.highlight_map.lock().clone()
564 }
565
566 pub fn highlight_id_for_name(&self, name: &str) -> Option<HighlightId> {
567 let capture_id = self.highlights_query.capture_index_for_name(name)?;
568 Some(self.highlight_map.lock().get(capture_id))
569 }
570}
571
572impl CodeLabel {
573 pub fn plain(text: String, filter_text: Option<&str>) -> Self {
574 let mut result = Self {
575 runs: Vec::new(),
576 filter_range: 0..text.len(),
577 text,
578 };
579 if let Some(filter_text) = filter_text {
580 if let Some(ix) = result.text.find(filter_text) {
581 result.filter_range = ix..ix + filter_text.len();
582 }
583 }
584 result
585 }
586}
587
588#[cfg(any(test, feature = "test-support"))]
589impl LanguageServerConfig {
590 pub fn fake() -> (Self, mpsc::UnboundedReceiver<lsp::FakeLanguageServer>) {
591 let (servers_tx, servers_rx) = mpsc::unbounded();
592 (
593 Self {
594 fake_config: Some(FakeLanguageServerConfig {
595 servers_tx,
596 capabilities: lsp::LanguageServer::full_capabilities(),
597 initializer: None,
598 }),
599 disk_based_diagnostics_progress_token: Some("fakeServer/check".to_string()),
600 ..Default::default()
601 },
602 servers_rx,
603 )
604 }
605
606 pub fn set_fake_capabilities(&mut self, capabilities: lsp::ServerCapabilities) {
607 self.fake_config.as_mut().unwrap().capabilities = capabilities;
608 }
609
610 pub fn set_fake_initializer(
611 &mut self,
612 initializer: impl 'static + Send + Sync + Fn(&mut lsp::FakeLanguageServer),
613 ) {
614 self.fake_config.as_mut().unwrap().initializer = Some(Box::new(initializer));
615 }
616}
617
618impl ToLspPosition for PointUtf16 {
619 fn to_lsp_position(self) -> lsp::Position {
620 lsp::Position::new(self.row, self.column)
621 }
622}
623
624pub fn point_from_lsp(point: lsp::Position) -> PointUtf16 {
625 PointUtf16::new(point.line, point.character)
626}
627
628pub fn range_from_lsp(range: lsp::Range) -> Range<PointUtf16> {
629 let start = PointUtf16::new(range.start.line, range.start.character);
630 let end = PointUtf16::new(range.end.line, range.end.character);
631 start..end
632}