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