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