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