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