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