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