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 any::Any,
24 cell::RefCell,
25 ops::Range,
26 path::{Path, PathBuf},
27 str,
28 sync::Arc,
29};
30use theme::SyntaxTheme;
31use tree_sitter::{self, Query};
32use util::ResultExt;
33
34#[cfg(any(test, feature = "test-support"))]
35use futures::channel::mpsc;
36
37pub use buffer::Operation;
38pub use buffer::*;
39pub use diagnostic_set::DiagnosticEntry;
40pub use outline::{Outline, OutlineItem};
41pub use tree_sitter::{Parser, Tree};
42
43thread_local! {
44 static PARSER: RefCell<Parser> = RefCell::new(Parser::new());
45}
46
47lazy_static! {
48 pub static ref PLAIN_TEXT: Arc<Language> = Arc::new(Language::new(
49 LanguageConfig {
50 name: "Plain Text".into(),
51 path_suffixes: Default::default(),
52 brackets: Default::default(),
53 autoclose_before: Default::default(),
54 line_comment: None,
55 language_server: Default::default(),
56 },
57 None,
58 ));
59}
60
61pub trait ToLspPosition {
62 fn to_lsp_position(self) -> lsp::Position;
63}
64
65pub struct GitHubLspBinaryVersion {
66 pub name: String,
67 pub url: http::Url,
68}
69
70pub trait LspAdapter: 'static + Send + Sync {
71 fn name(&self) -> &'static str;
72 fn fetch_latest_server_version(
73 &self,
74 http: Arc<dyn HttpClient>,
75 ) -> BoxFuture<'static, Result<Box<dyn 'static + Send + Any>>>;
76 fn fetch_server_binary(
77 &self,
78 version: Box<dyn 'static + Send + Any>,
79 http: Arc<dyn HttpClient>,
80 container_dir: PathBuf,
81 ) -> BoxFuture<'static, Result<PathBuf>>;
82 fn cached_server_binary(&self, container_dir: PathBuf) -> BoxFuture<'static, Option<PathBuf>>;
83 fn process_diagnostics(&self, diagnostics: &mut lsp::PublishDiagnosticsParams);
84
85 fn label_for_completion(&self, _: &lsp::CompletionItem, _: &Language) -> Option<CodeLabel> {
86 None
87 }
88
89 fn label_for_symbol(&self, _: &str, _: lsp::SymbolKind, _: &Language) -> Option<CodeLabel> {
90 None
91 }
92
93 fn server_args(&self) -> &[&str] {
94 &[]
95 }
96
97 fn initialization_options(&self) -> Option<Value> {
98 None
99 }
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 #[serde(default)]
115 pub autoclose_before: String,
116 pub line_comment: Option<String>,
117 #[serde(default)]
118 pub language_server: LanguageServerConfig,
119}
120
121impl Default for LanguageConfig {
122 fn default() -> Self {
123 Self {
124 name: "".into(),
125 path_suffixes: Default::default(),
126 brackets: Default::default(),
127 autoclose_before: Default::default(),
128 line_comment: Default::default(),
129 language_server: Default::default(),
130 }
131 }
132}
133
134#[derive(Default, Deserialize)]
135pub struct LanguageServerConfig {
136 pub disk_based_diagnostic_sources: HashSet<String>,
137 pub disk_based_diagnostics_progress_token: Option<String>,
138 #[cfg(any(test, feature = "test-support"))]
139 #[serde(skip)]
140 fake_config: Option<FakeLanguageServerConfig>,
141}
142
143#[cfg(any(test, feature = "test-support"))]
144struct FakeLanguageServerConfig {
145 servers_tx: mpsc::UnboundedSender<lsp::FakeLanguageServer>,
146 capabilities: lsp::ServerCapabilities,
147 initializer: Option<Box<dyn 'static + Send + Sync + Fn(&mut lsp::FakeLanguageServer)>>,
148}
149
150#[derive(Clone, Debug, Deserialize)]
151pub struct BracketPair {
152 pub start: String,
153 pub end: String,
154 pub close: bool,
155 pub newline: bool,
156}
157
158pub struct Language {
159 pub(crate) config: LanguageConfig,
160 pub(crate) grammar: Option<Arc<Grammar>>,
161 pub(crate) adapter: Option<Arc<dyn LspAdapter>>,
162 lsp_binary_path: Mutex<Option<Shared<BoxFuture<'static, Result<PathBuf, Arc<anyhow::Error>>>>>>,
163}
164
165pub struct Grammar {
166 pub(crate) ts_language: tree_sitter::Language,
167 pub(crate) highlights_query: Query,
168 pub(crate) brackets_query: Query,
169 pub(crate) indents_query: Query,
170 pub(crate) outline_query: Query,
171 pub(crate) highlight_map: Mutex<HighlightMap>,
172}
173
174#[derive(Clone)]
175pub enum LanguageServerBinaryStatus {
176 CheckingForUpdate,
177 Downloading,
178 Downloaded,
179 Cached,
180 Failed,
181}
182
183pub struct LanguageRegistry {
184 languages: RwLock<Vec<Arc<Language>>>,
185 language_server_download_dir: Option<Arc<Path>>,
186 lsp_binary_statuses_tx: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
187 lsp_binary_statuses_rx: async_broadcast::Receiver<(Arc<Language>, LanguageServerBinaryStatus)>,
188 login_shell_env_loaded: Shared<Task<()>>,
189}
190
191impl LanguageRegistry {
192 pub fn new(login_shell_env_loaded: Task<()>) -> Self {
193 let (lsp_binary_statuses_tx, lsp_binary_statuses_rx) = async_broadcast::broadcast(16);
194 Self {
195 language_server_download_dir: None,
196 languages: Default::default(),
197 lsp_binary_statuses_tx,
198 lsp_binary_statuses_rx,
199 login_shell_env_loaded: login_shell_env_loaded.shared(),
200 }
201 }
202
203 #[cfg(any(test, feature = "test-support"))]
204 pub fn test() -> Self {
205 Self::new(Task::ready(()))
206 }
207
208 pub fn add(&self, language: Arc<Language>) {
209 self.languages.write().push(language.clone());
210 }
211
212 pub fn set_theme(&self, theme: &SyntaxTheme) {
213 for language in self.languages.read().iter() {
214 language.set_theme(theme);
215 }
216 }
217
218 pub fn set_language_server_download_dir(&mut self, path: impl Into<Arc<Path>>) {
219 self.language_server_download_dir = Some(path.into());
220 }
221
222 pub fn get_language(&self, name: &str) -> Option<Arc<Language>> {
223 self.languages
224 .read()
225 .iter()
226 .find(|language| language.name().as_ref() == name)
227 .cloned()
228 }
229
230 pub fn select_language(&self, path: impl AsRef<Path>) -> Option<Arc<Language>> {
231 let path = path.as_ref();
232 let filename = path.file_name().and_then(|name| name.to_str());
233 let extension = path.extension().and_then(|name| name.to_str());
234 let path_suffixes = [extension, filename];
235 self.languages
236 .read()
237 .iter()
238 .find(|language| {
239 language
240 .config
241 .path_suffixes
242 .iter()
243 .any(|suffix| path_suffixes.contains(&Some(suffix.as_str())))
244 })
245 .cloned()
246 }
247
248 pub fn start_language_server(
249 &self,
250 language: Arc<Language>,
251 root_path: Arc<Path>,
252 http_client: Arc<dyn HttpClient>,
253 cx: &mut MutableAppContext,
254 ) -> Option<Task<Result<lsp::LanguageServer>>> {
255 #[cfg(any(test, feature = "test-support"))]
256 if language.config.language_server.fake_config.is_some() {
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 .fake_config
263 .as_ref()
264 .unwrap();
265 let (server, mut fake_server) = cx.update(|cx| {
266 lsp::LanguageServer::fake_with_capabilities(
267 fake_config.capabilities.clone(),
268 cx,
269 )
270 });
271 if let Some(initializer) = &fake_config.initializer {
272 initializer(&mut fake_server);
273 }
274
275 let servers_tx = fake_config.servers_tx.clone();
276 cx.background()
277 .spawn(async move {
278 fake_server
279 .receive_notification::<lsp::notification::Initialized>()
280 .await;
281 servers_tx.unbounded_send(fake_server).ok();
282 })
283 .detach();
284 Ok(server)
285 }));
286 }
287
288 let download_dir = self
289 .language_server_download_dir
290 .clone()
291 .ok_or_else(|| anyhow!("language server download directory has not been assigned"))
292 .log_err()?;
293
294 let adapter = language.adapter.clone()?;
295 let background = cx.background().clone();
296 let lsp_binary_statuses = self.lsp_binary_statuses_tx.clone();
297 let login_shell_env_loaded = self.login_shell_env_loaded.clone();
298 Some(cx.background().spawn(async move {
299 login_shell_env_loaded.await;
300 let server_binary_path = language
301 .lsp_binary_path
302 .lock()
303 .get_or_insert_with(|| {
304 get_server_binary_path(
305 adapter.clone(),
306 language.clone(),
307 http_client,
308 download_dir,
309 lsp_binary_statuses,
310 )
311 .map_err(Arc::new)
312 .boxed()
313 .shared()
314 })
315 .clone()
316 .map_err(|e| anyhow!(e));
317
318 let server_binary_path = server_binary_path.await?;
319 let server_args = adapter.server_args();
320 let server = lsp::LanguageServer::new(
321 &server_binary_path,
322 server_args,
323 &root_path,
324 adapter.initialization_options(),
325 background,
326 )?;
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: Arc<dyn LspAdapter>) -> Self {
463 self.adapter = Some(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) -> &HashSet<String> {
476 &self.config.language_server.disk_based_diagnostic_sources
477 }
478
479 pub fn disk_based_diagnostics_progress_token(&self) -> Option<&String> {
480 self.config
481 .language_server
482 .disk_based_diagnostics_progress_token
483 .as_ref()
484 }
485
486 pub fn process_diagnostics(&self, diagnostics: &mut lsp::PublishDiagnosticsParams) {
487 if let Some(processor) = self.adapter.as_ref() {
488 processor.process_diagnostics(diagnostics);
489 }
490 }
491
492 pub fn label_for_completion(&self, completion: &lsp::CompletionItem) -> Option<CodeLabel> {
493 self.adapter
494 .as_ref()?
495 .label_for_completion(completion, self)
496 }
497
498 pub fn label_for_symbol(&self, name: &str, kind: lsp::SymbolKind) -> Option<CodeLabel> {
499 self.adapter.as_ref()?.label_for_symbol(name, kind, self)
500 }
501
502 pub fn highlight_text<'a>(
503 &'a self,
504 text: &'a Rope,
505 range: Range<usize>,
506 ) -> Vec<(Range<usize>, HighlightId)> {
507 let mut result = Vec::new();
508 if let Some(grammar) = &self.grammar {
509 let tree = grammar.parse_text(text, None);
510 let mut offset = 0;
511 for chunk in BufferChunks::new(text, range, Some(&tree), self.grammar.as_ref(), vec![])
512 {
513 let end_offset = offset + chunk.text.len();
514 if let Some(highlight_id) = chunk.syntax_highlight_id {
515 result.push((offset..end_offset, highlight_id));
516 }
517 offset = end_offset;
518 }
519 }
520 result
521 }
522
523 pub fn brackets(&self) -> &[BracketPair] {
524 &self.config.brackets
525 }
526
527 pub fn should_autoclose_before(&self, c: char) -> bool {
528 c.is_whitespace() || self.config.autoclose_before.contains(c)
529 }
530
531 pub fn set_theme(&self, theme: &SyntaxTheme) {
532 if let Some(grammar) = self.grammar.as_ref() {
533 *grammar.highlight_map.lock() =
534 HighlightMap::new(grammar.highlights_query.capture_names(), theme);
535 }
536 }
537
538 pub fn grammar(&self) -> Option<&Arc<Grammar>> {
539 self.grammar.as_ref()
540 }
541}
542
543impl Grammar {
544 fn parse_text(&self, text: &Rope, old_tree: Option<Tree>) -> Tree {
545 PARSER.with(|parser| {
546 let mut parser = parser.borrow_mut();
547 parser
548 .set_language(self.ts_language)
549 .expect("incompatible grammar");
550 let mut chunks = text.chunks_in_range(0..text.len());
551 parser
552 .parse_with(
553 &mut move |offset, _| {
554 chunks.seek(offset);
555 chunks.next().unwrap_or("").as_bytes()
556 },
557 old_tree.as_ref(),
558 )
559 .unwrap()
560 })
561 }
562
563 pub fn highlight_map(&self) -> HighlightMap {
564 self.highlight_map.lock().clone()
565 }
566
567 pub fn highlight_id_for_name(&self, name: &str) -> Option<HighlightId> {
568 let capture_id = self.highlights_query.capture_index_for_name(name)?;
569 Some(self.highlight_map.lock().get(capture_id))
570 }
571}
572
573impl CodeLabel {
574 pub fn plain(text: String, filter_text: Option<&str>) -> Self {
575 let mut result = Self {
576 runs: Vec::new(),
577 filter_range: 0..text.len(),
578 text,
579 };
580 if let Some(filter_text) = filter_text {
581 if let Some(ix) = result.text.find(filter_text) {
582 result.filter_range = ix..ix + filter_text.len();
583 }
584 }
585 result
586 }
587}
588
589#[cfg(any(test, feature = "test-support"))]
590impl LanguageServerConfig {
591 pub fn fake() -> (Self, mpsc::UnboundedReceiver<lsp::FakeLanguageServer>) {
592 let (servers_tx, servers_rx) = mpsc::unbounded();
593 (
594 Self {
595 fake_config: Some(FakeLanguageServerConfig {
596 servers_tx,
597 capabilities: lsp::LanguageServer::full_capabilities(),
598 initializer: None,
599 }),
600 disk_based_diagnostics_progress_token: Some("fakeServer/check".to_string()),
601 ..Default::default()
602 },
603 servers_rx,
604 )
605 }
606
607 pub fn set_fake_capabilities(&mut self, capabilities: lsp::ServerCapabilities) {
608 self.fake_config.as_mut().unwrap().capabilities = capabilities;
609 }
610
611 pub fn set_fake_initializer(
612 &mut self,
613 initializer: impl 'static + Send + Sync + Fn(&mut lsp::FakeLanguageServer),
614 ) {
615 self.fake_config.as_mut().unwrap().initializer = Some(Box::new(initializer));
616 }
617}
618
619impl ToLspPosition for PointUtf16 {
620 fn to_lsp_position(self) -> lsp::Position {
621 lsp::Position::new(self.row, self.column)
622 }
623}
624
625pub fn point_from_lsp(point: lsp::Position) -> PointUtf16 {
626 PointUtf16::new(point.line, point.character)
627}
628
629pub fn range_from_lsp(range: lsp::Range) -> Range<PointUtf16> {
630 let start = PointUtf16::new(range.start.line, range.start.character);
631 let end = PointUtf16::new(range.end.line, range.end.character);
632 start..end
633}