1use anyhow::{anyhow, bail, Result};
2use async_compression::futures::bufread::GzipDecoder;
3use async_trait::async_trait;
4use futures::{io::BufReader, StreamExt};
5use gpui::AsyncAppContext;
6pub use language::*;
7use lazy_static::lazy_static;
8use lsp::LanguageServerBinary;
9use project::project_settings::ProjectSettings;
10use regex::Regex;
11use settings::Settings;
12use smol::fs::{self, File};
13use std::{any::Any, borrow::Cow, env::consts, path::PathBuf, sync::Arc};
14use util::{
15 async_maybe,
16 fs::remove_matching,
17 github::{latest_github_release, GitHubLspBinaryVersion},
18 ResultExt,
19};
20
21pub struct RustLspAdapter;
22
23impl RustLspAdapter {
24 const SERVER_NAME: &'static str = "rust-analyzer";
25}
26
27#[async_trait(?Send)]
28impl LspAdapter for RustLspAdapter {
29 fn name(&self) -> LanguageServerName {
30 LanguageServerName(Self::SERVER_NAME.into())
31 }
32
33 async fn check_if_user_installed(
34 &self,
35 _delegate: &dyn LspAdapterDelegate,
36 cx: &AsyncAppContext,
37 ) -> Option<LanguageServerBinary> {
38 let binary = cx
39 .update(|cx| {
40 ProjectSettings::get_global(cx)
41 .lsp
42 .get(Self::SERVER_NAME)
43 .and_then(|s| s.binary.clone())
44 })
45 .ok()??;
46
47 let path = binary.path?;
48 Some(LanguageServerBinary {
49 path: path.into(),
50 arguments: binary
51 .arguments
52 .unwrap_or_default()
53 .iter()
54 .map(|arg| arg.into())
55 .collect(),
56 env: None,
57 })
58 }
59
60 async fn fetch_latest_server_version(
61 &self,
62 delegate: &dyn LspAdapterDelegate,
63 ) -> Result<Box<dyn 'static + Send + Any>> {
64 let release = latest_github_release(
65 "rust-lang/rust-analyzer",
66 true,
67 false,
68 delegate.http_client(),
69 )
70 .await?;
71 let os = match consts::OS {
72 "macos" => "apple-darwin",
73 "linux" => "unknown-linux-gnu",
74 "windows" => "pc-windows-msvc",
75 other => bail!("Running on unsupported os: {other}"),
76 };
77 let asset_name = format!("rust-analyzer-{}-{os}.gz", consts::ARCH);
78 let asset = release
79 .assets
80 .iter()
81 .find(|asset| asset.name == asset_name)
82 .ok_or_else(|| anyhow!("no asset found matching {:?}", asset_name))?;
83 Ok(Box::new(GitHubLspBinaryVersion {
84 name: release.tag_name,
85 url: asset.browser_download_url.clone(),
86 }))
87 }
88
89 async fn fetch_server_binary(
90 &self,
91 version: Box<dyn 'static + Send + Any>,
92 container_dir: PathBuf,
93 delegate: &dyn LspAdapterDelegate,
94 ) -> Result<LanguageServerBinary> {
95 let version = version.downcast::<GitHubLspBinaryVersion>().unwrap();
96 let destination_path = container_dir.join(format!("rust-analyzer-{}", version.name));
97
98 if fs::metadata(&destination_path).await.is_err() {
99 let mut response = delegate
100 .http_client()
101 .get(&version.url, Default::default(), true)
102 .await
103 .map_err(|err| anyhow!("error downloading release: {}", err))?;
104 let decompressed_bytes = GzipDecoder::new(BufReader::new(response.body_mut()));
105 let mut file = File::create(&destination_path).await?;
106 futures::io::copy(decompressed_bytes, &mut file).await?;
107 // todo("windows")
108 #[cfg(not(windows))]
109 {
110 fs::set_permissions(
111 &destination_path,
112 <fs::Permissions as fs::unix::PermissionsExt>::from_mode(0o755),
113 )
114 .await?;
115 }
116
117 remove_matching(&container_dir, |entry| entry != destination_path).await;
118 }
119
120 Ok(LanguageServerBinary {
121 path: destination_path,
122 env: None,
123 arguments: Default::default(),
124 })
125 }
126
127 async fn cached_server_binary(
128 &self,
129 container_dir: PathBuf,
130 _: &dyn LspAdapterDelegate,
131 ) -> Option<LanguageServerBinary> {
132 get_cached_server_binary(container_dir).await
133 }
134
135 async fn installation_test_binary(
136 &self,
137 container_dir: PathBuf,
138 ) -> Option<LanguageServerBinary> {
139 get_cached_server_binary(container_dir)
140 .await
141 .map(|mut binary| {
142 binary.arguments = vec!["--help".into()];
143 binary
144 })
145 }
146
147 fn disk_based_diagnostic_sources(&self) -> Vec<String> {
148 vec!["rustc".into()]
149 }
150
151 fn disk_based_diagnostics_progress_token(&self) -> Option<String> {
152 Some("rust-analyzer/flycheck".into())
153 }
154
155 fn process_diagnostics(&self, params: &mut lsp::PublishDiagnosticsParams) {
156 lazy_static! {
157 static ref REGEX: Regex = Regex::new("(?m)`([^`]+)\n`$").unwrap();
158 }
159
160 for diagnostic in &mut params.diagnostics {
161 for message in diagnostic
162 .related_information
163 .iter_mut()
164 .flatten()
165 .map(|info| &mut info.message)
166 .chain([&mut diagnostic.message])
167 {
168 if let Cow::Owned(sanitized) = REGEX.replace_all(message, "`$1`") {
169 *message = sanitized;
170 }
171 }
172 }
173 }
174
175 async fn label_for_completion(
176 &self,
177 completion: &lsp::CompletionItem,
178 language: &Arc<Language>,
179 ) -> Option<CodeLabel> {
180 match completion.kind {
181 Some(lsp::CompletionItemKind::FIELD) if completion.detail.is_some() => {
182 let detail = completion.detail.as_ref().unwrap();
183 let name = &completion.label;
184 let text = format!("{}: {}", name, detail);
185 let source = Rope::from(format!("struct S {{ {} }}", text).as_str());
186 let runs = language.highlight_text(&source, 11..11 + text.len());
187 return Some(CodeLabel {
188 text,
189 runs,
190 filter_range: 0..name.len(),
191 });
192 }
193 Some(lsp::CompletionItemKind::CONSTANT | lsp::CompletionItemKind::VARIABLE)
194 if completion.detail.is_some()
195 && completion.insert_text_format != Some(lsp::InsertTextFormat::SNIPPET) =>
196 {
197 let detail = completion.detail.as_ref().unwrap();
198 let name = &completion.label;
199 let text = format!("{}: {}", name, detail);
200 let source = Rope::from(format!("let {} = ();", text).as_str());
201 let runs = language.highlight_text(&source, 4..4 + text.len());
202 return Some(CodeLabel {
203 text,
204 runs,
205 filter_range: 0..name.len(),
206 });
207 }
208 Some(lsp::CompletionItemKind::FUNCTION | lsp::CompletionItemKind::METHOD)
209 if completion.detail.is_some() =>
210 {
211 lazy_static! {
212 static ref REGEX: Regex = Regex::new("\\(…?\\)").unwrap();
213 }
214 let detail = completion.detail.as_ref().unwrap();
215 const FUNCTION_PREFIXES: [&'static str; 2] = ["async fn", "fn"];
216 let prefix = FUNCTION_PREFIXES
217 .iter()
218 .find_map(|prefix| detail.strip_prefix(*prefix).map(|suffix| (prefix, suffix)));
219 // fn keyword should be followed by opening parenthesis.
220 if let Some((prefix, suffix)) = prefix {
221 if suffix.starts_with('(') {
222 let text = REGEX.replace(&completion.label, suffix).to_string();
223 let source = Rope::from(format!("{prefix} {} {{}}", text).as_str());
224 let run_start = prefix.len() + 1;
225 let runs =
226 language.highlight_text(&source, run_start..run_start + text.len());
227 return Some(CodeLabel {
228 filter_range: 0..completion.label.find('(').unwrap_or(text.len()),
229 text,
230 runs,
231 });
232 }
233 }
234 }
235 Some(kind) => {
236 let highlight_name = match kind {
237 lsp::CompletionItemKind::STRUCT
238 | lsp::CompletionItemKind::INTERFACE
239 | lsp::CompletionItemKind::ENUM => Some("type"),
240 lsp::CompletionItemKind::ENUM_MEMBER => Some("variant"),
241 lsp::CompletionItemKind::KEYWORD => Some("keyword"),
242 lsp::CompletionItemKind::VALUE | lsp::CompletionItemKind::CONSTANT => {
243 Some("constant")
244 }
245 _ => None,
246 };
247 let highlight_id = language.grammar()?.highlight_id_for_name(highlight_name?)?;
248 let mut label = CodeLabel::plain(completion.label.clone(), None);
249 label.runs.push((
250 0..label.text.rfind('(').unwrap_or(label.text.len()),
251 highlight_id,
252 ));
253 return Some(label);
254 }
255 _ => {}
256 }
257 None
258 }
259
260 async fn label_for_symbol(
261 &self,
262 name: &str,
263 kind: lsp::SymbolKind,
264 language: &Arc<Language>,
265 ) -> Option<CodeLabel> {
266 let (text, filter_range, display_range) = match kind {
267 lsp::SymbolKind::METHOD | lsp::SymbolKind::FUNCTION => {
268 let text = format!("fn {} () {{}}", name);
269 let filter_range = 3..3 + name.len();
270 let display_range = 0..filter_range.end;
271 (text, filter_range, display_range)
272 }
273 lsp::SymbolKind::STRUCT => {
274 let text = format!("struct {} {{}}", name);
275 let filter_range = 7..7 + name.len();
276 let display_range = 0..filter_range.end;
277 (text, filter_range, display_range)
278 }
279 lsp::SymbolKind::ENUM => {
280 let text = format!("enum {} {{}}", name);
281 let filter_range = 5..5 + name.len();
282 let display_range = 0..filter_range.end;
283 (text, filter_range, display_range)
284 }
285 lsp::SymbolKind::INTERFACE => {
286 let text = format!("trait {} {{}}", name);
287 let filter_range = 6..6 + name.len();
288 let display_range = 0..filter_range.end;
289 (text, filter_range, display_range)
290 }
291 lsp::SymbolKind::CONSTANT => {
292 let text = format!("const {}: () = ();", name);
293 let filter_range = 6..6 + name.len();
294 let display_range = 0..filter_range.end;
295 (text, filter_range, display_range)
296 }
297 lsp::SymbolKind::MODULE => {
298 let text = format!("mod {} {{}}", name);
299 let filter_range = 4..4 + name.len();
300 let display_range = 0..filter_range.end;
301 (text, filter_range, display_range)
302 }
303 lsp::SymbolKind::TYPE_PARAMETER => {
304 let text = format!("type {} {{}}", name);
305 let filter_range = 5..5 + name.len();
306 let display_range = 0..filter_range.end;
307 (text, filter_range, display_range)
308 }
309 _ => return None,
310 };
311
312 Some(CodeLabel {
313 runs: language.highlight_text(&text.as_str().into(), display_range.clone()),
314 text: text[display_range].to_string(),
315 filter_range,
316 })
317 }
318}
319
320async fn get_cached_server_binary(container_dir: PathBuf) -> Option<LanguageServerBinary> {
321 async_maybe!({
322 let mut last = None;
323 let mut entries = fs::read_dir(&container_dir).await?;
324 while let Some(entry) = entries.next().await {
325 last = Some(entry?.path());
326 }
327
328 anyhow::Ok(LanguageServerBinary {
329 path: last.ok_or_else(|| anyhow!("no cached binary"))?,
330 env: None,
331 arguments: Default::default(),
332 })
333 })
334 .await
335 .log_err()
336}
337
338#[cfg(test)]
339mod tests {
340 use std::num::NonZeroU32;
341
342 use super::*;
343 use crate::language;
344 use gpui::{Context, Hsla, TestAppContext};
345 use language::language_settings::AllLanguageSettings;
346 use settings::SettingsStore;
347 use text::BufferId;
348 use theme::SyntaxTheme;
349
350 #[gpui::test]
351 async fn test_process_rust_diagnostics() {
352 let mut params = lsp::PublishDiagnosticsParams {
353 uri: lsp::Url::from_file_path("/a").unwrap(),
354 version: None,
355 diagnostics: vec![
356 // no newlines
357 lsp::Diagnostic {
358 message: "use of moved value `a`".to_string(),
359 ..Default::default()
360 },
361 // newline at the end of a code span
362 lsp::Diagnostic {
363 message: "consider importing this struct: `use b::c;\n`".to_string(),
364 ..Default::default()
365 },
366 // code span starting right after a newline
367 lsp::Diagnostic {
368 message: "cannot borrow `self.d` as mutable\n`self` is a `&` reference"
369 .to_string(),
370 ..Default::default()
371 },
372 ],
373 };
374 RustLspAdapter.process_diagnostics(&mut params);
375
376 assert_eq!(params.diagnostics[0].message, "use of moved value `a`");
377
378 // remove trailing newline from code span
379 assert_eq!(
380 params.diagnostics[1].message,
381 "consider importing this struct: `use b::c;`"
382 );
383
384 // do not remove newline before the start of code span
385 assert_eq!(
386 params.diagnostics[2].message,
387 "cannot borrow `self.d` as mutable\n`self` is a `&` reference"
388 );
389 }
390
391 #[gpui::test]
392 async fn test_rust_label_for_completion() {
393 let adapter = Arc::new(RustLspAdapter);
394 let language = language("rust", tree_sitter_rust::language());
395 let grammar = language.grammar().unwrap();
396 let theme = SyntaxTheme::new_test([
397 ("type", Hsla::default()),
398 ("keyword", Hsla::default()),
399 ("function", Hsla::default()),
400 ("property", Hsla::default()),
401 ]);
402
403 language.set_theme(&theme);
404
405 let highlight_function = grammar.highlight_id_for_name("function").unwrap();
406 let highlight_type = grammar.highlight_id_for_name("type").unwrap();
407 let highlight_keyword = grammar.highlight_id_for_name("keyword").unwrap();
408 let highlight_field = grammar.highlight_id_for_name("property").unwrap();
409
410 assert_eq!(
411 adapter
412 .label_for_completion(
413 &lsp::CompletionItem {
414 kind: Some(lsp::CompletionItemKind::FUNCTION),
415 label: "hello(…)".to_string(),
416 detail: Some("fn(&mut Option<T>) -> Vec<T>".to_string()),
417 ..Default::default()
418 },
419 &language
420 )
421 .await,
422 Some(CodeLabel {
423 text: "hello(&mut Option<T>) -> Vec<T>".to_string(),
424 filter_range: 0..5,
425 runs: vec![
426 (0..5, highlight_function),
427 (7..10, highlight_keyword),
428 (11..17, highlight_type),
429 (18..19, highlight_type),
430 (25..28, highlight_type),
431 (29..30, highlight_type),
432 ],
433 })
434 );
435 assert_eq!(
436 adapter
437 .label_for_completion(
438 &lsp::CompletionItem {
439 kind: Some(lsp::CompletionItemKind::FUNCTION),
440 label: "hello(…)".to_string(),
441 detail: Some("async fn(&mut Option<T>) -> Vec<T>".to_string()),
442 ..Default::default()
443 },
444 &language
445 )
446 .await,
447 Some(CodeLabel {
448 text: "hello(&mut Option<T>) -> Vec<T>".to_string(),
449 filter_range: 0..5,
450 runs: vec![
451 (0..5, highlight_function),
452 (7..10, highlight_keyword),
453 (11..17, highlight_type),
454 (18..19, highlight_type),
455 (25..28, highlight_type),
456 (29..30, highlight_type),
457 ],
458 })
459 );
460 assert_eq!(
461 adapter
462 .label_for_completion(
463 &lsp::CompletionItem {
464 kind: Some(lsp::CompletionItemKind::FIELD),
465 label: "len".to_string(),
466 detail: Some("usize".to_string()),
467 ..Default::default()
468 },
469 &language
470 )
471 .await,
472 Some(CodeLabel {
473 text: "len: usize".to_string(),
474 filter_range: 0..3,
475 runs: vec![(0..3, highlight_field), (5..10, highlight_type),],
476 })
477 );
478
479 assert_eq!(
480 adapter
481 .label_for_completion(
482 &lsp::CompletionItem {
483 kind: Some(lsp::CompletionItemKind::FUNCTION),
484 label: "hello(…)".to_string(),
485 detail: Some("fn(&mut Option<T>) -> Vec<T>".to_string()),
486 ..Default::default()
487 },
488 &language
489 )
490 .await,
491 Some(CodeLabel {
492 text: "hello(&mut Option<T>) -> Vec<T>".to_string(),
493 filter_range: 0..5,
494 runs: vec![
495 (0..5, highlight_function),
496 (7..10, highlight_keyword),
497 (11..17, highlight_type),
498 (18..19, highlight_type),
499 (25..28, highlight_type),
500 (29..30, highlight_type),
501 ],
502 })
503 );
504 }
505
506 #[gpui::test]
507 async fn test_rust_label_for_symbol() {
508 let adapter = Arc::new(RustLspAdapter);
509 let language = language("rust", tree_sitter_rust::language());
510 let grammar = language.grammar().unwrap();
511 let theme = SyntaxTheme::new_test([
512 ("type", Hsla::default()),
513 ("keyword", Hsla::default()),
514 ("function", Hsla::default()),
515 ("property", Hsla::default()),
516 ]);
517
518 language.set_theme(&theme);
519
520 let highlight_function = grammar.highlight_id_for_name("function").unwrap();
521 let highlight_type = grammar.highlight_id_for_name("type").unwrap();
522 let highlight_keyword = grammar.highlight_id_for_name("keyword").unwrap();
523
524 assert_eq!(
525 adapter
526 .label_for_symbol("hello", lsp::SymbolKind::FUNCTION, &language)
527 .await,
528 Some(CodeLabel {
529 text: "fn hello".to_string(),
530 filter_range: 3..8,
531 runs: vec![(0..2, highlight_keyword), (3..8, highlight_function)],
532 })
533 );
534
535 assert_eq!(
536 adapter
537 .label_for_symbol("World", lsp::SymbolKind::TYPE_PARAMETER, &language)
538 .await,
539 Some(CodeLabel {
540 text: "type World".to_string(),
541 filter_range: 5..10,
542 runs: vec![(0..4, highlight_keyword), (5..10, highlight_type)],
543 })
544 );
545 }
546
547 #[gpui::test]
548 async fn test_rust_autoindent(cx: &mut TestAppContext) {
549 // cx.executor().set_block_on_ticks(usize::MAX..=usize::MAX);
550 cx.update(|cx| {
551 let test_settings = SettingsStore::test(cx);
552 cx.set_global(test_settings);
553 language::init(cx);
554 cx.update_global::<SettingsStore, _>(|store, cx| {
555 store.update_user_settings::<AllLanguageSettings>(cx, |s| {
556 s.defaults.tab_size = NonZeroU32::new(2);
557 });
558 });
559 });
560
561 let language = crate::language("rust", tree_sitter_rust::language());
562
563 cx.new_model(|cx| {
564 let mut buffer = Buffer::new(0, BufferId::new(cx.entity_id().as_u64()).unwrap(), "")
565 .with_language(language, cx);
566
567 // indent between braces
568 buffer.set_text("fn a() {}", cx);
569 let ix = buffer.len() - 1;
570 buffer.edit([(ix..ix, "\n\n")], Some(AutoindentMode::EachLine), cx);
571 assert_eq!(buffer.text(), "fn a() {\n \n}");
572
573 // indent between braces, even after empty lines
574 buffer.set_text("fn a() {\n\n\n}", cx);
575 let ix = buffer.len() - 2;
576 buffer.edit([(ix..ix, "\n")], Some(AutoindentMode::EachLine), cx);
577 assert_eq!(buffer.text(), "fn a() {\n\n\n \n}");
578
579 // indent a line that continues a field expression
580 buffer.set_text("fn a() {\n \n}", cx);
581 let ix = buffer.len() - 2;
582 buffer.edit([(ix..ix, "b\n.c")], Some(AutoindentMode::EachLine), cx);
583 assert_eq!(buffer.text(), "fn a() {\n b\n .c\n}");
584
585 // indent further lines that continue the field expression, even after empty lines
586 let ix = buffer.len() - 2;
587 buffer.edit([(ix..ix, "\n\n.d")], Some(AutoindentMode::EachLine), cx);
588 assert_eq!(buffer.text(), "fn a() {\n b\n .c\n \n .d\n}");
589
590 // dedent the line after the field expression
591 let ix = buffer.len() - 2;
592 buffer.edit([(ix..ix, ";\ne")], Some(AutoindentMode::EachLine), cx);
593 assert_eq!(
594 buffer.text(),
595 "fn a() {\n b\n .c\n \n .d;\n e\n}"
596 );
597
598 // indent inside a struct within a call
599 buffer.set_text("const a: B = c(D {});", cx);
600 let ix = buffer.len() - 3;
601 buffer.edit([(ix..ix, "\n\n")], Some(AutoindentMode::EachLine), cx);
602 assert_eq!(buffer.text(), "const a: B = c(D {\n \n});");
603
604 // indent further inside a nested call
605 let ix = buffer.len() - 4;
606 buffer.edit([(ix..ix, "e: f(\n\n)")], Some(AutoindentMode::EachLine), cx);
607 assert_eq!(buffer.text(), "const a: B = c(D {\n e: f(\n \n )\n});");
608
609 // keep that indent after an empty line
610 let ix = buffer.len() - 8;
611 buffer.edit([(ix..ix, "\n")], Some(AutoindentMode::EachLine), cx);
612 assert_eq!(
613 buffer.text(),
614 "const a: B = c(D {\n e: f(\n \n \n )\n});"
615 );
616
617 buffer
618 });
619 }
620}