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