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