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}
183
184impl LanguageRegistry {
185 pub fn new() -> Self {
186 let (lsp_binary_statuses_tx, lsp_binary_statuses_rx) = async_broadcast::broadcast(16);
187 Self {
188 language_server_download_dir: None,
189 languages: Default::default(),
190 lsp_binary_statuses_tx,
191 lsp_binary_statuses_rx,
192 }
193 }
194
195 pub fn add(&self, language: Arc<Language>) {
196 self.languages.write().push(language.clone());
197 }
198
199 pub fn set_theme(&self, theme: &SyntaxTheme) {
200 for language in self.languages.read().iter() {
201 language.set_theme(theme);
202 }
203 }
204
205 pub fn set_language_server_download_dir(&mut self, path: impl Into<Arc<Path>>) {
206 self.language_server_download_dir = Some(path.into());
207 }
208
209 pub fn get_language(&self, name: &str) -> Option<Arc<Language>> {
210 self.languages
211 .read()
212 .iter()
213 .find(|language| language.name().as_ref() == name)
214 .cloned()
215 }
216
217 pub fn select_language(&self, path: impl AsRef<Path>) -> Option<Arc<Language>> {
218 let path = path.as_ref();
219 let filename = path.file_name().and_then(|name| name.to_str());
220 let extension = path.extension().and_then(|name| name.to_str());
221 let path_suffixes = [extension, filename];
222 self.languages
223 .read()
224 .iter()
225 .find(|language| {
226 language
227 .config
228 .path_suffixes
229 .iter()
230 .any(|suffix| path_suffixes.contains(&Some(suffix.as_str())))
231 })
232 .cloned()
233 }
234
235 pub fn start_language_server(
236 &self,
237 language: &Arc<Language>,
238 root_path: Arc<Path>,
239 http_client: Arc<dyn HttpClient>,
240 cx: &mut MutableAppContext,
241 ) -> Option<Task<Result<Arc<lsp::LanguageServer>>>> {
242 #[cfg(any(test, feature = "test-support"))]
243 if let Some(config) = &language.config.language_server {
244 if let Some(fake_config) = &config.fake_config {
245 let (server, mut fake_server) = lsp::LanguageServer::fake_with_capabilities(
246 fake_config.capabilities.clone(),
247 cx,
248 );
249
250 if let Some(initalizer) = &fake_config.initializer {
251 initalizer(&mut fake_server);
252 }
253
254 let servers_tx = fake_config.servers_tx.clone();
255 let initialized = server.capabilities();
256 cx.background()
257 .spawn(async move {
258 if initialized.await.is_some() {
259 servers_tx.unbounded_send(fake_server).ok();
260 }
261 })
262 .detach();
263
264 return Some(Task::ready(Ok(server.clone())));
265 }
266 }
267
268 let download_dir = self
269 .language_server_download_dir
270 .clone()
271 .ok_or_else(|| anyhow!("language server download directory has not been assigned"))
272 .log_err()?;
273
274 let adapter = language.adapter.clone()?;
275 let background = cx.background().clone();
276 let server_binary_path = {
277 Some(
278 language
279 .lsp_binary_path
280 .lock()
281 .get_or_insert_with(|| {
282 get_server_binary_path(
283 adapter.clone(),
284 language.clone(),
285 http_client,
286 download_dir,
287 self.lsp_binary_statuses_tx.clone(),
288 )
289 .map_err(Arc::new)
290 .boxed()
291 .shared()
292 })
293 .clone()
294 .map_err(|e| anyhow!(e)),
295 )
296 }?;
297 Some(cx.background().spawn(async move {
298 let server_binary_path = server_binary_path.await?;
299 let server_args = adapter.server_args();
300 let server = lsp::LanguageServer::new(
301 &server_binary_path,
302 server_args,
303 adapter.initialization_options(),
304 &root_path,
305 background,
306 )?;
307 Ok(server)
308 }))
309 }
310
311 pub fn language_server_binary_statuses(
312 &self,
313 ) -> async_broadcast::Receiver<(Arc<Language>, LanguageServerBinaryStatus)> {
314 self.lsp_binary_statuses_rx.clone()
315 }
316}
317
318async fn get_server_binary_path(
319 adapter: Arc<dyn LspAdapter>,
320 language: Arc<Language>,
321 http_client: Arc<dyn HttpClient>,
322 download_dir: Arc<Path>,
323 statuses: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
324) -> Result<PathBuf> {
325 let container_dir = download_dir.join(adapter.name());
326 if !container_dir.exists() {
327 smol::fs::create_dir_all(&container_dir)
328 .await
329 .context("failed to create container directory")?;
330 }
331
332 let path = fetch_latest_server_binary_path(
333 adapter.clone(),
334 language.clone(),
335 http_client,
336 &container_dir,
337 statuses.clone(),
338 )
339 .await;
340 if path.is_err() {
341 if let Some(cached_path) = adapter.cached_server_binary(container_dir).await {
342 statuses
343 .broadcast((language.clone(), LanguageServerBinaryStatus::Cached))
344 .await?;
345 return Ok(cached_path);
346 } else {
347 statuses
348 .broadcast((language.clone(), LanguageServerBinaryStatus::Failed))
349 .await?;
350 }
351 }
352 path
353}
354
355async fn fetch_latest_server_binary_path(
356 adapter: Arc<dyn LspAdapter>,
357 language: Arc<Language>,
358 http_client: Arc<dyn HttpClient>,
359 container_dir: &Path,
360 lsp_binary_statuses_tx: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
361) -> Result<PathBuf> {
362 lsp_binary_statuses_tx
363 .broadcast((
364 language.clone(),
365 LanguageServerBinaryStatus::CheckingForUpdate,
366 ))
367 .await?;
368 let version_info = adapter
369 .fetch_latest_server_version(http_client.clone())
370 .await?;
371 lsp_binary_statuses_tx
372 .broadcast((language.clone(), LanguageServerBinaryStatus::Downloading))
373 .await?;
374 let path = adapter
375 .fetch_server_binary(version_info, http_client, container_dir.to_path_buf())
376 .await?;
377 lsp_binary_statuses_tx
378 .broadcast((language.clone(), LanguageServerBinaryStatus::Downloaded))
379 .await?;
380 Ok(path)
381}
382
383impl Language {
384 pub fn new(config: LanguageConfig, ts_language: Option<tree_sitter::Language>) -> Self {
385 Self {
386 config,
387 grammar: ts_language.map(|ts_language| {
388 Arc::new(Grammar {
389 brackets_query: Query::new(ts_language, "").unwrap(),
390 highlights_query: Query::new(ts_language, "").unwrap(),
391 indents_query: Query::new(ts_language, "").unwrap(),
392 outline_query: Query::new(ts_language, "").unwrap(),
393 ts_language,
394 highlight_map: Default::default(),
395 })
396 }),
397 adapter: None,
398 lsp_binary_path: Default::default(),
399 }
400 }
401
402 pub fn with_highlights_query(mut self, source: &str) -> Result<Self> {
403 let grammar = self
404 .grammar
405 .as_mut()
406 .and_then(Arc::get_mut)
407 .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
408 grammar.highlights_query = Query::new(grammar.ts_language, source)?;
409 Ok(self)
410 }
411
412 pub fn with_brackets_query(mut self, source: &str) -> Result<Self> {
413 let grammar = self
414 .grammar
415 .as_mut()
416 .and_then(Arc::get_mut)
417 .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
418 grammar.brackets_query = Query::new(grammar.ts_language, source)?;
419 Ok(self)
420 }
421
422 pub fn with_indents_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.indents_query = Query::new(grammar.ts_language, source)?;
429 Ok(self)
430 }
431
432 pub fn with_outline_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.outline_query = Query::new(grammar.ts_language, source)?;
439 Ok(self)
440 }
441
442 pub fn with_lsp_adapter(mut self, lsp_adapter: impl LspAdapter) -> Self {
443 self.adapter = Some(Arc::new(lsp_adapter));
444 self
445 }
446
447 pub fn name(&self) -> Arc<str> {
448 self.config.name.clone()
449 }
450
451 pub fn line_comment_prefix(&self) -> Option<&str> {
452 self.config.line_comment.as_deref()
453 }
454
455 pub fn disk_based_diagnostic_sources(&self) -> Option<&HashSet<String>> {
456 self.config
457 .language_server
458 .as_ref()
459 .map(|config| &config.disk_based_diagnostic_sources)
460 }
461
462 pub fn disk_based_diagnostics_progress_token(&self) -> Option<&String> {
463 self.config
464 .language_server
465 .as_ref()
466 .and_then(|config| config.disk_based_diagnostics_progress_token.as_ref())
467 }
468
469 pub fn process_diagnostics(&self, diagnostics: &mut lsp::PublishDiagnosticsParams) {
470 if let Some(processor) = self.adapter.as_ref() {
471 processor.process_diagnostics(diagnostics);
472 }
473 }
474
475 pub fn label_for_completion(&self, completion: &lsp::CompletionItem) -> Option<CodeLabel> {
476 self.adapter
477 .as_ref()?
478 .label_for_completion(completion, self)
479 }
480
481 pub fn label_for_symbol(&self, name: &str, kind: lsp::SymbolKind) -> Option<CodeLabel> {
482 self.adapter.as_ref()?.label_for_symbol(name, kind, self)
483 }
484
485 pub fn highlight_text<'a>(
486 &'a self,
487 text: &'a Rope,
488 range: Range<usize>,
489 ) -> Vec<(Range<usize>, HighlightId)> {
490 let mut result = Vec::new();
491 if let Some(grammar) = &self.grammar {
492 let tree = grammar.parse_text(text, None);
493 let mut offset = 0;
494 for chunk in BufferChunks::new(text, range, Some(&tree), self.grammar.as_ref(), vec![])
495 {
496 let end_offset = offset + chunk.text.len();
497 if let Some(highlight_id) = chunk.highlight_id {
498 result.push((offset..end_offset, highlight_id));
499 }
500 offset = end_offset;
501 }
502 }
503 result
504 }
505
506 pub fn brackets(&self) -> &[BracketPair] {
507 &self.config.brackets
508 }
509
510 pub fn set_theme(&self, theme: &SyntaxTheme) {
511 if let Some(grammar) = self.grammar.as_ref() {
512 *grammar.highlight_map.lock() =
513 HighlightMap::new(grammar.highlights_query.capture_names(), theme);
514 }
515 }
516
517 pub fn grammar(&self) -> Option<&Arc<Grammar>> {
518 self.grammar.as_ref()
519 }
520}
521
522impl Grammar {
523 fn parse_text(&self, text: &Rope, old_tree: Option<Tree>) -> Tree {
524 PARSER.with(|parser| {
525 let mut parser = parser.borrow_mut();
526 parser
527 .set_language(self.ts_language)
528 .expect("incompatible grammar");
529 let mut chunks = text.chunks_in_range(0..text.len());
530 parser
531 .parse_with(
532 &mut move |offset, _| {
533 chunks.seek(offset);
534 chunks.next().unwrap_or("").as_bytes()
535 },
536 old_tree.as_ref(),
537 )
538 .unwrap()
539 })
540 }
541
542 pub fn highlight_map(&self) -> HighlightMap {
543 self.highlight_map.lock().clone()
544 }
545
546 pub fn highlight_id_for_name(&self, name: &str) -> Option<HighlightId> {
547 let capture_id = self.highlights_query.capture_index_for_name(name)?;
548 Some(self.highlight_map.lock().get(capture_id))
549 }
550}
551
552impl CodeLabel {
553 pub fn plain(text: String, filter_text: Option<&str>) -> Self {
554 let mut result = Self {
555 runs: Vec::new(),
556 filter_range: 0..text.len(),
557 text,
558 };
559 if let Some(filter_text) = filter_text {
560 if let Some(ix) = result.text.find(filter_text) {
561 result.filter_range = ix..ix + filter_text.len();
562 }
563 }
564 result
565 }
566}
567
568#[cfg(any(test, feature = "test-support"))]
569impl LanguageServerConfig {
570 pub fn fake() -> (Self, mpsc::UnboundedReceiver<lsp::FakeLanguageServer>) {
571 let (servers_tx, servers_rx) = mpsc::unbounded();
572 (
573 Self {
574 fake_config: Some(FakeLanguageServerConfig {
575 servers_tx,
576 capabilities: lsp::LanguageServer::full_capabilities(),
577 initializer: None,
578 }),
579 disk_based_diagnostics_progress_token: Some("fakeServer/check".to_string()),
580 ..Default::default()
581 },
582 servers_rx,
583 )
584 }
585
586 pub fn set_fake_capabilities(&mut self, capabilities: lsp::ServerCapabilities) {
587 self.fake_config.as_mut().unwrap().capabilities = capabilities;
588 }
589
590 pub fn set_fake_initializer(
591 &mut self,
592 initializer: impl 'static + Send + Sync + Fn(&mut lsp::FakeLanguageServer),
593 ) {
594 self.fake_config.as_mut().unwrap().initializer = Some(Box::new(initializer));
595 }
596}
597
598impl ToLspPosition for PointUtf16 {
599 fn to_lsp_position(self) -> lsp::Position {
600 lsp::Position::new(self.row, self.column)
601 }
602}
603
604pub fn point_from_lsp(point: lsp::Position) -> PointUtf16 {
605 PointUtf16::new(point.line, point.character)
606}
607
608pub fn range_from_lsp(range: lsp::Range) -> Range<PointUtf16> {
609 let start = PointUtf16::new(range.start.line, range.start.character);
610 let end = PointUtf16::new(range.end.line, range.end.character);
611 start..end
612}