]> git.lizzy.rs Git - rust.git/blob - crates/rust-analyzer/src/to_proto.rs
Merge #8023
[rust.git] / crates / rust-analyzer / src / to_proto.rs
1 //! Conversion of rust-analyzer specific types to lsp_types equivalents.
2 use std::{
3     path::{self, Path},
4     sync::atomic::{AtomicU32, Ordering},
5 };
6
7 use ide::{
8     Annotation, AnnotationKind, Assist, AssistKind, CallInfo, CompletionItem, CompletionItemKind,
9     CompletionRelevance, Documentation, FileId, FileRange, FileSystemEdit, Fold, FoldKind,
10     Highlight, HlMod, HlPunct, HlRange, HlTag, Indel, InlayHint, InlayKind, InsertTextFormat,
11     Markup, NavigationTarget, ReferenceAccess, RenameError, Runnable, Severity, SourceChange,
12     StructureNodeKind, SymbolKind, TextEdit, TextRange, TextSize,
13 };
14 use itertools::Itertools;
15 use serde_json::to_value;
16
17 use crate::{
18     cargo_target_spec::CargoTargetSpec,
19     global_state::GlobalStateSnapshot,
20     line_index::{LineEndings, LineIndex, OffsetEncoding},
21     lsp_ext, semantic_tokens, Result,
22 };
23
24 pub(crate) fn position(line_index: &LineIndex, offset: TextSize) -> lsp_types::Position {
25     let line_col = line_index.index.line_col(offset);
26     match line_index.encoding {
27         OffsetEncoding::Utf8 => lsp_types::Position::new(line_col.line, line_col.col),
28         OffsetEncoding::Utf16 => {
29             let line_col = line_index.index.to_utf16(line_col);
30             lsp_types::Position::new(line_col.line, line_col.col)
31         }
32     }
33 }
34
35 pub(crate) fn range(line_index: &LineIndex, range: TextRange) -> lsp_types::Range {
36     let start = position(line_index, range.start());
37     let end = position(line_index, range.end());
38     lsp_types::Range::new(start, end)
39 }
40
41 pub(crate) fn symbol_kind(symbol_kind: SymbolKind) -> lsp_types::SymbolKind {
42     match symbol_kind {
43         SymbolKind::Function => lsp_types::SymbolKind::Function,
44         SymbolKind::Struct => lsp_types::SymbolKind::Struct,
45         SymbolKind::Enum => lsp_types::SymbolKind::Enum,
46         SymbolKind::Variant => lsp_types::SymbolKind::EnumMember,
47         SymbolKind::Trait => lsp_types::SymbolKind::Interface,
48         SymbolKind::Macro => lsp_types::SymbolKind::Function,
49         SymbolKind::Module => lsp_types::SymbolKind::Module,
50         SymbolKind::TypeAlias | SymbolKind::TypeParam => lsp_types::SymbolKind::TypeParameter,
51         SymbolKind::Field => lsp_types::SymbolKind::Field,
52         SymbolKind::Static => lsp_types::SymbolKind::Constant,
53         SymbolKind::Const => lsp_types::SymbolKind::Constant,
54         SymbolKind::ConstParam => lsp_types::SymbolKind::Constant,
55         SymbolKind::Impl => lsp_types::SymbolKind::Object,
56         SymbolKind::Local
57         | SymbolKind::SelfParam
58         | SymbolKind::LifetimeParam
59         | SymbolKind::ValueParam
60         | SymbolKind::Label => lsp_types::SymbolKind::Variable,
61         SymbolKind::Union => lsp_types::SymbolKind::Struct,
62     }
63 }
64
65 pub(crate) fn structure_node_kind(kind: StructureNodeKind) -> lsp_types::SymbolKind {
66     match kind {
67         StructureNodeKind::SymbolKind(symbol) => symbol_kind(symbol),
68         StructureNodeKind::Region => lsp_types::SymbolKind::Namespace,
69     }
70 }
71
72 pub(crate) fn document_highlight_kind(
73     reference_access: ReferenceAccess,
74 ) -> lsp_types::DocumentHighlightKind {
75     match reference_access {
76         ReferenceAccess::Read => lsp_types::DocumentHighlightKind::Read,
77         ReferenceAccess::Write => lsp_types::DocumentHighlightKind::Write,
78     }
79 }
80
81 pub(crate) fn diagnostic_severity(severity: Severity) -> lsp_types::DiagnosticSeverity {
82     match severity {
83         Severity::Error => lsp_types::DiagnosticSeverity::Error,
84         Severity::WeakWarning => lsp_types::DiagnosticSeverity::Hint,
85     }
86 }
87
88 pub(crate) fn documentation(documentation: Documentation) -> lsp_types::Documentation {
89     let value = crate::markdown::format_docs(documentation.as_str());
90     let markup_content = lsp_types::MarkupContent { kind: lsp_types::MarkupKind::Markdown, value };
91     lsp_types::Documentation::MarkupContent(markup_content)
92 }
93
94 pub(crate) fn insert_text_format(
95     insert_text_format: InsertTextFormat,
96 ) -> lsp_types::InsertTextFormat {
97     match insert_text_format {
98         InsertTextFormat::Snippet => lsp_types::InsertTextFormat::Snippet,
99         InsertTextFormat::PlainText => lsp_types::InsertTextFormat::PlainText,
100     }
101 }
102
103 pub(crate) fn completion_item_kind(
104     completion_item_kind: CompletionItemKind,
105 ) -> lsp_types::CompletionItemKind {
106     match completion_item_kind {
107         CompletionItemKind::Attribute => lsp_types::CompletionItemKind::EnumMember,
108         CompletionItemKind::Binding => lsp_types::CompletionItemKind::Variable,
109         CompletionItemKind::BuiltinType => lsp_types::CompletionItemKind::Struct,
110         CompletionItemKind::Keyword => lsp_types::CompletionItemKind::Keyword,
111         CompletionItemKind::Method => lsp_types::CompletionItemKind::Method,
112         CompletionItemKind::Snippet => lsp_types::CompletionItemKind::Snippet,
113         CompletionItemKind::UnresolvedReference => lsp_types::CompletionItemKind::Reference,
114         CompletionItemKind::SymbolKind(symbol) => match symbol {
115             SymbolKind::Const => lsp_types::CompletionItemKind::Constant,
116             SymbolKind::ConstParam => lsp_types::CompletionItemKind::TypeParameter,
117             SymbolKind::Enum => lsp_types::CompletionItemKind::Enum,
118             SymbolKind::Field => lsp_types::CompletionItemKind::Field,
119             SymbolKind::Function => lsp_types::CompletionItemKind::Function,
120             SymbolKind::Impl => lsp_types::CompletionItemKind::Text,
121             SymbolKind::Label => lsp_types::CompletionItemKind::Variable,
122             SymbolKind::LifetimeParam => lsp_types::CompletionItemKind::TypeParameter,
123             SymbolKind::Local => lsp_types::CompletionItemKind::Variable,
124             SymbolKind::Macro => lsp_types::CompletionItemKind::Method,
125             SymbolKind::Module => lsp_types::CompletionItemKind::Module,
126             SymbolKind::SelfParam => lsp_types::CompletionItemKind::Value,
127             SymbolKind::Static => lsp_types::CompletionItemKind::Value,
128             SymbolKind::Struct => lsp_types::CompletionItemKind::Struct,
129             SymbolKind::Trait => lsp_types::CompletionItemKind::Interface,
130             SymbolKind::TypeAlias => lsp_types::CompletionItemKind::Struct,
131             SymbolKind::TypeParam => lsp_types::CompletionItemKind::TypeParameter,
132             SymbolKind::Union => lsp_types::CompletionItemKind::Struct,
133             SymbolKind::ValueParam => lsp_types::CompletionItemKind::Value,
134             SymbolKind::Variant => lsp_types::CompletionItemKind::EnumMember,
135         },
136     }
137 }
138
139 pub(crate) fn text_edit(line_index: &LineIndex, indel: Indel) -> lsp_types::TextEdit {
140     let range = range(line_index, indel.delete);
141     let new_text = match line_index.endings {
142         LineEndings::Unix => indel.insert,
143         LineEndings::Dos => indel.insert.replace('\n', "\r\n"),
144     };
145     lsp_types::TextEdit { range, new_text }
146 }
147
148 pub(crate) fn snippet_text_edit(
149     line_index: &LineIndex,
150     is_snippet: bool,
151     indel: Indel,
152 ) -> lsp_ext::SnippetTextEdit {
153     let text_edit = text_edit(line_index, indel);
154     let insert_text_format =
155         if is_snippet { Some(lsp_types::InsertTextFormat::Snippet) } else { None };
156     lsp_ext::SnippetTextEdit {
157         range: text_edit.range,
158         new_text: text_edit.new_text,
159         insert_text_format,
160     }
161 }
162
163 pub(crate) fn text_edit_vec(
164     line_index: &LineIndex,
165     text_edit: TextEdit,
166 ) -> Vec<lsp_types::TextEdit> {
167     text_edit.into_iter().map(|indel| self::text_edit(line_index, indel)).collect()
168 }
169
170 pub(crate) fn snippet_text_edit_vec(
171     line_index: &LineIndex,
172     is_snippet: bool,
173     text_edit: TextEdit,
174 ) -> Vec<lsp_ext::SnippetTextEdit> {
175     text_edit
176         .into_iter()
177         .map(|indel| self::snippet_text_edit(line_index, is_snippet, indel))
178         .collect()
179 }
180
181 pub(crate) fn completion_item(
182     line_index: &LineIndex,
183     item: CompletionItem,
184 ) -> Vec<lsp_types::CompletionItem> {
185     let mut additional_text_edits = Vec::new();
186     let mut text_edit = None;
187     // LSP does not allow arbitrary edits in completion, so we have to do a
188     // non-trivial mapping here.
189     let source_range = item.source_range();
190     for indel in item.text_edit().iter() {
191         if indel.delete.contains_range(source_range) {
192             text_edit = Some(if indel.delete == source_range {
193                 self::text_edit(line_index, indel.clone())
194             } else {
195                 assert!(source_range.end() == indel.delete.end());
196                 let range1 = TextRange::new(indel.delete.start(), source_range.start());
197                 let range2 = source_range;
198                 let indel1 = Indel::replace(range1, String::new());
199                 let indel2 = Indel::replace(range2, indel.insert.clone());
200                 additional_text_edits.push(self::text_edit(line_index, indel1));
201                 self::text_edit(line_index, indel2)
202             })
203         } else {
204             assert!(source_range.intersect(indel.delete).is_none());
205             let text_edit = self::text_edit(line_index, indel.clone());
206             additional_text_edits.push(text_edit);
207         }
208     }
209     let text_edit = text_edit.unwrap();
210
211     let mut lsp_item = lsp_types::CompletionItem {
212         label: item.label().to_string(),
213         detail: item.detail().map(|it| it.to_string()),
214         filter_text: Some(item.lookup().to_string()),
215         kind: item.kind().map(completion_item_kind),
216         text_edit: Some(text_edit.into()),
217         additional_text_edits: Some(additional_text_edits),
218         documentation: item.documentation().map(documentation),
219         deprecated: Some(item.deprecated()),
220         ..Default::default()
221     };
222
223     fn set_score(res: &mut lsp_types::CompletionItem, relevance: CompletionRelevance) {
224         if relevance.is_relevant() {
225             res.preselect = Some(true);
226         }
227         // The relevance needs to be inverted to come up with a sort score
228         // because the client will sort ascending.
229         let sort_score = relevance.score() ^ 0xFF_FF_FF_FF;
230         // Zero pad the string to ensure values can be properly sorted
231         // by the client. Hex format is used because it is easier to
232         // visually compare very large values, which the sort text
233         // tends to be since it is the opposite of the score.
234         res.sort_text = Some(format!("{:08x}", sort_score));
235     }
236
237     set_score(&mut lsp_item, item.relevance());
238
239     if item.deprecated() {
240         lsp_item.tags = Some(vec![lsp_types::CompletionItemTag::Deprecated])
241     }
242
243     if item.trigger_call_info() {
244         lsp_item.command = Some(command::trigger_parameter_hints());
245     }
246
247     let mut res = match item.ref_match() {
248         Some((mutability, relevance)) => {
249             let mut lsp_item_with_ref = lsp_item.clone();
250             set_score(&mut lsp_item_with_ref, relevance);
251             lsp_item_with_ref.label =
252                 format!("&{}{}", mutability.as_keyword_for_ref(), lsp_item_with_ref.label);
253             if let Some(lsp_types::CompletionTextEdit::Edit(it)) = &mut lsp_item_with_ref.text_edit
254             {
255                 it.new_text = format!("&{}{}", mutability.as_keyword_for_ref(), it.new_text);
256             }
257             vec![lsp_item_with_ref, lsp_item]
258         }
259         None => vec![lsp_item],
260     };
261
262     for lsp_item in res.iter_mut() {
263         lsp_item.insert_text_format = Some(insert_text_format(item.insert_text_format()));
264     }
265     res
266 }
267
268 pub(crate) fn signature_help(
269     call_info: CallInfo,
270     concise: bool,
271     label_offsets: bool,
272 ) -> lsp_types::SignatureHelp {
273     let (label, parameters) = match (concise, label_offsets) {
274         (_, false) => {
275             let params = call_info
276                 .parameter_labels()
277                 .map(|label| lsp_types::ParameterInformation {
278                     label: lsp_types::ParameterLabel::Simple(label.to_string()),
279                     documentation: None,
280                 })
281                 .collect::<Vec<_>>();
282             let label =
283                 if concise { call_info.parameter_labels().join(", ") } else { call_info.signature };
284             (label, params)
285         }
286         (false, true) => {
287             let params = call_info
288                 .parameter_ranges()
289                 .iter()
290                 .map(|it| [u32::from(it.start()).into(), u32::from(it.end()).into()])
291                 .map(|label_offsets| lsp_types::ParameterInformation {
292                     label: lsp_types::ParameterLabel::LabelOffsets(label_offsets),
293                     documentation: None,
294                 })
295                 .collect::<Vec<_>>();
296             (call_info.signature, params)
297         }
298         (true, true) => {
299             let mut params = Vec::new();
300             let mut label = String::new();
301             let mut first = true;
302             for param in call_info.parameter_labels() {
303                 if !first {
304                     label.push_str(", ");
305                 }
306                 first = false;
307                 let start = label.len() as u32;
308                 label.push_str(param);
309                 let end = label.len() as u32;
310                 params.push(lsp_types::ParameterInformation {
311                     label: lsp_types::ParameterLabel::LabelOffsets([start, end]),
312                     documentation: None,
313                 });
314             }
315
316             (label, params)
317         }
318     };
319
320     let documentation = if concise {
321         None
322     } else {
323         call_info.doc.map(|doc| {
324             lsp_types::Documentation::MarkupContent(lsp_types::MarkupContent {
325                 kind: lsp_types::MarkupKind::Markdown,
326                 value: doc,
327             })
328         })
329     };
330
331     let active_parameter = call_info.active_parameter.map(|it| it as u32);
332
333     let signature = lsp_types::SignatureInformation {
334         label,
335         documentation,
336         parameters: Some(parameters),
337         active_parameter,
338     };
339     lsp_types::SignatureHelp {
340         signatures: vec![signature],
341         active_signature: None,
342         active_parameter,
343     }
344 }
345
346 pub(crate) fn inlay_hint(line_index: &LineIndex, inlay_hint: InlayHint) -> lsp_ext::InlayHint {
347     lsp_ext::InlayHint {
348         label: inlay_hint.label.to_string(),
349         range: range(line_index, inlay_hint.range),
350         kind: match inlay_hint.kind {
351             InlayKind::ParameterHint => lsp_ext::InlayKind::ParameterHint,
352             InlayKind::TypeHint => lsp_ext::InlayKind::TypeHint,
353             InlayKind::ChainingHint => lsp_ext::InlayKind::ChainingHint,
354         },
355     }
356 }
357
358 static TOKEN_RESULT_COUNTER: AtomicU32 = AtomicU32::new(1);
359
360 pub(crate) fn semantic_tokens(
361     text: &str,
362     line_index: &LineIndex,
363     highlights: Vec<HlRange>,
364 ) -> lsp_types::SemanticTokens {
365     let id = TOKEN_RESULT_COUNTER.fetch_add(1, Ordering::SeqCst).to_string();
366     let mut builder = semantic_tokens::SemanticTokensBuilder::new(id);
367
368     for highlight_range in highlights {
369         if highlight_range.highlight.is_empty() {
370             continue;
371         }
372         let (type_, mods) = semantic_token_type_and_modifiers(highlight_range.highlight);
373         let token_index = semantic_tokens::type_index(type_);
374         let modifier_bitset = mods.0;
375
376         for mut text_range in line_index.index.lines(highlight_range.range) {
377             if text[text_range].ends_with('\n') {
378                 text_range =
379                     TextRange::new(text_range.start(), text_range.end() - TextSize::of('\n'));
380             }
381             let range = range(&line_index, text_range);
382             builder.push(range, token_index, modifier_bitset);
383         }
384     }
385
386     builder.build()
387 }
388
389 pub(crate) fn semantic_token_delta(
390     previous: &lsp_types::SemanticTokens,
391     current: &lsp_types::SemanticTokens,
392 ) -> lsp_types::SemanticTokensDelta {
393     let result_id = current.result_id.clone();
394     let edits = semantic_tokens::diff_tokens(&previous.data, &current.data);
395     lsp_types::SemanticTokensDelta { result_id, edits }
396 }
397
398 fn semantic_token_type_and_modifiers(
399     highlight: Highlight,
400 ) -> (lsp_types::SemanticTokenType, semantic_tokens::ModifierSet) {
401     let mut mods = semantic_tokens::ModifierSet::default();
402     let type_ = match highlight.tag {
403         HlTag::Symbol(symbol) => match symbol {
404             SymbolKind::Module => lsp_types::SemanticTokenType::NAMESPACE,
405             SymbolKind::Impl => lsp_types::SemanticTokenType::TYPE,
406             SymbolKind::Field => lsp_types::SemanticTokenType::PROPERTY,
407             SymbolKind::TypeParam => lsp_types::SemanticTokenType::TYPE_PARAMETER,
408             SymbolKind::ConstParam => semantic_tokens::CONST_PARAMETER,
409             SymbolKind::LifetimeParam => semantic_tokens::LIFETIME,
410             SymbolKind::Label => semantic_tokens::LABEL,
411             SymbolKind::ValueParam => lsp_types::SemanticTokenType::PARAMETER,
412             SymbolKind::SelfParam => semantic_tokens::SELF_KEYWORD,
413             SymbolKind::Local => lsp_types::SemanticTokenType::VARIABLE,
414             SymbolKind::Function => {
415                 if highlight.mods.contains(HlMod::Associated) {
416                     lsp_types::SemanticTokenType::METHOD
417                 } else {
418                     lsp_types::SemanticTokenType::FUNCTION
419                 }
420             }
421             SymbolKind::Const => {
422                 mods |= semantic_tokens::CONSTANT;
423                 mods |= lsp_types::SemanticTokenModifier::STATIC;
424                 lsp_types::SemanticTokenType::VARIABLE
425             }
426             SymbolKind::Static => {
427                 mods |= lsp_types::SemanticTokenModifier::STATIC;
428                 lsp_types::SemanticTokenType::VARIABLE
429             }
430             SymbolKind::Struct => lsp_types::SemanticTokenType::STRUCT,
431             SymbolKind::Enum => lsp_types::SemanticTokenType::ENUM,
432             SymbolKind::Variant => lsp_types::SemanticTokenType::ENUM_MEMBER,
433             SymbolKind::Union => semantic_tokens::UNION,
434             SymbolKind::TypeAlias => semantic_tokens::TYPE_ALIAS,
435             SymbolKind::Trait => lsp_types::SemanticTokenType::INTERFACE,
436             SymbolKind::Macro => lsp_types::SemanticTokenType::MACRO,
437         },
438         HlTag::BuiltinType => semantic_tokens::BUILTIN_TYPE,
439         HlTag::None => semantic_tokens::GENERIC,
440         HlTag::ByteLiteral | HlTag::NumericLiteral => lsp_types::SemanticTokenType::NUMBER,
441         HlTag::BoolLiteral => semantic_tokens::BOOLEAN,
442         HlTag::StringLiteral => lsp_types::SemanticTokenType::STRING,
443         HlTag::CharLiteral => semantic_tokens::CHAR_LITERAL,
444         HlTag::Comment => lsp_types::SemanticTokenType::COMMENT,
445         HlTag::Attribute => semantic_tokens::ATTRIBUTE,
446         HlTag::Keyword => lsp_types::SemanticTokenType::KEYWORD,
447         HlTag::UnresolvedReference => semantic_tokens::UNRESOLVED_REFERENCE,
448         HlTag::FormatSpecifier => semantic_tokens::FORMAT_SPECIFIER,
449         HlTag::Operator => lsp_types::SemanticTokenType::OPERATOR,
450         HlTag::EscapeSequence => semantic_tokens::ESCAPE_SEQUENCE,
451         HlTag::Punctuation(punct) => match punct {
452             HlPunct::Bracket => semantic_tokens::BRACKET,
453             HlPunct::Brace => semantic_tokens::BRACE,
454             HlPunct::Parenthesis => semantic_tokens::PARENTHESIS,
455             HlPunct::Angle => semantic_tokens::ANGLE,
456             HlPunct::Comma => semantic_tokens::COMMA,
457             HlPunct::Dot => semantic_tokens::DOT,
458             HlPunct::Colon => semantic_tokens::COLON,
459             HlPunct::Semi => semantic_tokens::SEMICOLON,
460             HlPunct::Other => semantic_tokens::PUNCTUATION,
461         },
462     };
463
464     for modifier in highlight.mods.iter() {
465         let modifier = match modifier {
466             HlMod::Attribute => semantic_tokens::ATTRIBUTE_MODIFIER,
467             HlMod::Definition => lsp_types::SemanticTokenModifier::DECLARATION,
468             HlMod::Documentation => lsp_types::SemanticTokenModifier::DOCUMENTATION,
469             HlMod::Injected => semantic_tokens::INJECTED,
470             HlMod::ControlFlow => semantic_tokens::CONTROL_FLOW,
471             HlMod::Mutable => semantic_tokens::MUTABLE,
472             HlMod::Consuming => semantic_tokens::CONSUMING,
473             HlMod::Unsafe => semantic_tokens::UNSAFE,
474             HlMod::Callable => semantic_tokens::CALLABLE,
475             HlMod::Static => lsp_types::SemanticTokenModifier::STATIC,
476             HlMod::Associated => continue,
477         };
478         mods |= modifier;
479     }
480
481     (type_, mods)
482 }
483
484 pub(crate) fn folding_range(
485     text: &str,
486     line_index: &LineIndex,
487     line_folding_only: bool,
488     fold: Fold,
489 ) -> lsp_types::FoldingRange {
490     let kind = match fold.kind {
491         FoldKind::Comment => Some(lsp_types::FoldingRangeKind::Comment),
492         FoldKind::Imports => Some(lsp_types::FoldingRangeKind::Imports),
493         FoldKind::Region => Some(lsp_types::FoldingRangeKind::Region),
494         FoldKind::Mods | FoldKind::Block | FoldKind::ArgList => None,
495     };
496
497     let range = range(line_index, fold.range);
498
499     if line_folding_only {
500         // Clients with line_folding_only == true (such as VSCode) will fold the whole end line
501         // even if it contains text not in the folding range. To prevent that we exclude
502         // range.end.line from the folding region if there is more text after range.end
503         // on the same line.
504         let has_more_text_on_end_line = text[TextRange::new(fold.range.end(), TextSize::of(text))]
505             .chars()
506             .take_while(|it| *it != '\n')
507             .any(|it| !it.is_whitespace());
508
509         let end_line = if has_more_text_on_end_line {
510             range.end.line.saturating_sub(1)
511         } else {
512             range.end.line
513         };
514
515         lsp_types::FoldingRange {
516             start_line: range.start.line,
517             start_character: None,
518             end_line,
519             end_character: None,
520             kind,
521         }
522     } else {
523         lsp_types::FoldingRange {
524             start_line: range.start.line,
525             start_character: Some(range.start.character),
526             end_line: range.end.line,
527             end_character: Some(range.end.character),
528             kind,
529         }
530     }
531 }
532
533 pub(crate) fn url(snap: &GlobalStateSnapshot, file_id: FileId) -> lsp_types::Url {
534     snap.file_id_to_url(file_id)
535 }
536
537 /// Returns a `Url` object from a given path, will lowercase drive letters if present.
538 /// This will only happen when processing windows paths.
539 ///
540 /// When processing non-windows path, this is essentially the same as `Url::from_file_path`.
541 pub(crate) fn url_from_abs_path(path: &Path) -> lsp_types::Url {
542     assert!(path.is_absolute());
543     let url = lsp_types::Url::from_file_path(path).unwrap();
544     match path.components().next() {
545         Some(path::Component::Prefix(prefix))
546             if matches!(prefix.kind(), path::Prefix::Disk(_) | path::Prefix::VerbatimDisk(_)) =>
547         {
548             // Need to lowercase driver letter
549         }
550         _ => return url,
551     }
552
553     let driver_letter_range = {
554         let (scheme, drive_letter, _rest) = match url.as_str().splitn(3, ':').collect_tuple() {
555             Some(it) => it,
556             None => return url,
557         };
558         let start = scheme.len() + ':'.len_utf8();
559         start..(start + drive_letter.len())
560     };
561
562     // Note: lowercasing the `path` itself doesn't help, the `Url::parse`
563     // machinery *also* canonicalizes the drive letter. So, just massage the
564     // string in place.
565     let mut url = url.into_string();
566     url[driver_letter_range].make_ascii_lowercase();
567     lsp_types::Url::parse(&url).unwrap()
568 }
569
570 pub(crate) fn optional_versioned_text_document_identifier(
571     snap: &GlobalStateSnapshot,
572     file_id: FileId,
573 ) -> lsp_types::OptionalVersionedTextDocumentIdentifier {
574     let url = url(snap, file_id);
575     let version = snap.url_file_version(&url);
576     lsp_types::OptionalVersionedTextDocumentIdentifier { uri: url, version }
577 }
578
579 pub(crate) fn location(
580     snap: &GlobalStateSnapshot,
581     frange: FileRange,
582 ) -> Result<lsp_types::Location> {
583     let url = url(snap, frange.file_id);
584     let line_index = snap.file_line_index(frange.file_id)?;
585     let range = range(&line_index, frange.range);
586     let loc = lsp_types::Location::new(url, range);
587     Ok(loc)
588 }
589
590 /// Perefer using `location_link`, if the client has the cap.
591 pub(crate) fn location_from_nav(
592     snap: &GlobalStateSnapshot,
593     nav: NavigationTarget,
594 ) -> Result<lsp_types::Location> {
595     let url = url(snap, nav.file_id);
596     let line_index = snap.file_line_index(nav.file_id)?;
597     let range = range(&line_index, nav.full_range);
598     let loc = lsp_types::Location::new(url, range);
599     Ok(loc)
600 }
601
602 pub(crate) fn location_link(
603     snap: &GlobalStateSnapshot,
604     src: Option<FileRange>,
605     target: NavigationTarget,
606 ) -> Result<lsp_types::LocationLink> {
607     let origin_selection_range = match src {
608         Some(src) => {
609             let line_index = snap.file_line_index(src.file_id)?;
610             let range = range(&line_index, src.range);
611             Some(range)
612         }
613         None => None,
614     };
615     let (target_uri, target_range, target_selection_range) = location_info(snap, target)?;
616     let res = lsp_types::LocationLink {
617         origin_selection_range,
618         target_uri,
619         target_range,
620         target_selection_range,
621     };
622     Ok(res)
623 }
624
625 fn location_info(
626     snap: &GlobalStateSnapshot,
627     target: NavigationTarget,
628 ) -> Result<(lsp_types::Url, lsp_types::Range, lsp_types::Range)> {
629     let line_index = snap.file_line_index(target.file_id)?;
630
631     let target_uri = url(snap, target.file_id);
632     let target_range = range(&line_index, target.full_range);
633     let target_selection_range =
634         target.focus_range.map(|it| range(&line_index, it)).unwrap_or(target_range);
635     Ok((target_uri, target_range, target_selection_range))
636 }
637
638 pub(crate) fn goto_definition_response(
639     snap: &GlobalStateSnapshot,
640     src: Option<FileRange>,
641     targets: Vec<NavigationTarget>,
642 ) -> Result<lsp_types::GotoDefinitionResponse> {
643     if snap.config.location_link() {
644         let links = targets
645             .into_iter()
646             .map(|nav| location_link(snap, src, nav))
647             .collect::<Result<Vec<_>>>()?;
648         Ok(links.into())
649     } else {
650         let locations = targets
651             .into_iter()
652             .map(|nav| {
653                 location(snap, FileRange { file_id: nav.file_id, range: nav.focus_or_full_range() })
654             })
655             .collect::<Result<Vec<_>>>()?;
656         Ok(locations.into())
657     }
658 }
659
660 pub(crate) fn snippet_text_document_edit(
661     snap: &GlobalStateSnapshot,
662     is_snippet: bool,
663     file_id: FileId,
664     edit: TextEdit,
665 ) -> Result<lsp_ext::SnippetTextDocumentEdit> {
666     let text_document = optional_versioned_text_document_identifier(snap, file_id);
667     let line_index = snap.file_line_index(file_id)?;
668     let edits = edit.into_iter().map(|it| snippet_text_edit(&line_index, is_snippet, it)).collect();
669     Ok(lsp_ext::SnippetTextDocumentEdit { text_document, edits })
670 }
671
672 pub(crate) fn snippet_text_document_ops(
673     snap: &GlobalStateSnapshot,
674     file_system_edit: FileSystemEdit,
675 ) -> Vec<lsp_ext::SnippetDocumentChangeOperation> {
676     let mut ops = Vec::new();
677     match file_system_edit {
678         FileSystemEdit::CreateFile { dst, initial_contents } => {
679             let uri = snap.anchored_path(&dst);
680             let create_file = lsp_types::ResourceOp::Create(lsp_types::CreateFile {
681                 uri: uri.clone(),
682                 options: None,
683                 annotation_id: None,
684             });
685             ops.push(lsp_ext::SnippetDocumentChangeOperation::Op(create_file));
686             if !initial_contents.is_empty() {
687                 let text_document =
688                     lsp_types::OptionalVersionedTextDocumentIdentifier { uri, version: None };
689                 let text_edit = lsp_ext::SnippetTextEdit {
690                     range: lsp_types::Range::default(),
691                     new_text: initial_contents,
692                     insert_text_format: Some(lsp_types::InsertTextFormat::PlainText),
693                 };
694                 let edit_file =
695                     lsp_ext::SnippetTextDocumentEdit { text_document, edits: vec![text_edit] };
696                 ops.push(lsp_ext::SnippetDocumentChangeOperation::Edit(edit_file));
697             }
698         }
699         FileSystemEdit::MoveFile { src, dst } => {
700             let old_uri = snap.file_id_to_url(src);
701             let new_uri = snap.anchored_path(&dst);
702             let rename_file = lsp_types::ResourceOp::Rename(lsp_types::RenameFile {
703                 old_uri,
704                 new_uri,
705                 options: None,
706                 annotation_id: None,
707             });
708             ops.push(lsp_ext::SnippetDocumentChangeOperation::Op(rename_file))
709         }
710     }
711     ops
712 }
713
714 pub(crate) fn snippet_workspace_edit(
715     snap: &GlobalStateSnapshot,
716     source_change: SourceChange,
717 ) -> Result<lsp_ext::SnippetWorkspaceEdit> {
718     let mut document_changes: Vec<lsp_ext::SnippetDocumentChangeOperation> = Vec::new();
719     for op in source_change.file_system_edits {
720         let ops = snippet_text_document_ops(snap, op);
721         document_changes.extend_from_slice(&ops);
722     }
723     for (file_id, edit) in source_change.source_file_edits {
724         let edit = snippet_text_document_edit(&snap, source_change.is_snippet, file_id, edit)?;
725         document_changes.push(lsp_ext::SnippetDocumentChangeOperation::Edit(edit));
726     }
727     let workspace_edit =
728         lsp_ext::SnippetWorkspaceEdit { changes: None, document_changes: Some(document_changes) };
729     Ok(workspace_edit)
730 }
731
732 pub(crate) fn workspace_edit(
733     snap: &GlobalStateSnapshot,
734     source_change: SourceChange,
735 ) -> Result<lsp_types::WorkspaceEdit> {
736     assert!(!source_change.is_snippet);
737     snippet_workspace_edit(snap, source_change).map(|it| it.into())
738 }
739
740 impl From<lsp_ext::SnippetWorkspaceEdit> for lsp_types::WorkspaceEdit {
741     fn from(snippet_workspace_edit: lsp_ext::SnippetWorkspaceEdit) -> lsp_types::WorkspaceEdit {
742         lsp_types::WorkspaceEdit {
743             changes: None,
744             document_changes: snippet_workspace_edit.document_changes.map(|changes| {
745                 lsp_types::DocumentChanges::Operations(
746                     changes
747                         .into_iter()
748                         .map(|change| match change {
749                             lsp_ext::SnippetDocumentChangeOperation::Op(op) => {
750                                 lsp_types::DocumentChangeOperation::Op(op)
751                             }
752                             lsp_ext::SnippetDocumentChangeOperation::Edit(edit) => {
753                                 lsp_types::DocumentChangeOperation::Edit(
754                                     lsp_types::TextDocumentEdit {
755                                         text_document: edit.text_document,
756                                         edits: edit
757                                             .edits
758                                             .into_iter()
759                                             .map(|edit| {
760                                                 lsp_types::OneOf::Left(lsp_types::TextEdit {
761                                                     range: edit.range,
762                                                     new_text: edit.new_text,
763                                                 })
764                                             })
765                                             .collect(),
766                                     },
767                                 )
768                             }
769                         })
770                         .collect(),
771                 )
772             }),
773             change_annotations: None,
774         }
775     }
776 }
777
778 pub(crate) fn call_hierarchy_item(
779     snap: &GlobalStateSnapshot,
780     target: NavigationTarget,
781 ) -> Result<lsp_types::CallHierarchyItem> {
782     let name = target.name.to_string();
783     let detail = target.description.clone();
784     let kind = target.kind.map(symbol_kind).unwrap_or(lsp_types::SymbolKind::Function);
785     let (uri, range, selection_range) = location_info(snap, target)?;
786     Ok(lsp_types::CallHierarchyItem {
787         name,
788         kind,
789         tags: None,
790         detail,
791         uri,
792         range,
793         selection_range,
794         data: None,
795     })
796 }
797
798 pub(crate) fn code_action_kind(kind: AssistKind) -> lsp_types::CodeActionKind {
799     match kind {
800         AssistKind::None | AssistKind::Generate => lsp_types::CodeActionKind::EMPTY,
801         AssistKind::QuickFix => lsp_types::CodeActionKind::QUICKFIX,
802         AssistKind::Refactor => lsp_types::CodeActionKind::REFACTOR,
803         AssistKind::RefactorExtract => lsp_types::CodeActionKind::REFACTOR_EXTRACT,
804         AssistKind::RefactorInline => lsp_types::CodeActionKind::REFACTOR_INLINE,
805         AssistKind::RefactorRewrite => lsp_types::CodeActionKind::REFACTOR_REWRITE,
806     }
807 }
808
809 pub(crate) fn unresolved_code_action(
810     snap: &GlobalStateSnapshot,
811     code_action_params: lsp_types::CodeActionParams,
812     assist: Assist,
813     index: usize,
814 ) -> Result<lsp_ext::CodeAction> {
815     assert!(assist.source_change.is_none());
816     let res = lsp_ext::CodeAction {
817         title: assist.label.to_string(),
818         group: assist.group.filter(|_| snap.config.code_action_group()).map(|gr| gr.0),
819         kind: Some(code_action_kind(assist.id.1)),
820         edit: None,
821         is_preferred: None,
822         data: Some(lsp_ext::CodeActionData {
823             id: format!("{}:{}", assist.id.0, index.to_string()),
824             code_action_params,
825         }),
826     };
827     Ok(res)
828 }
829
830 pub(crate) fn resolved_code_action(
831     snap: &GlobalStateSnapshot,
832     assist: Assist,
833 ) -> Result<lsp_ext::CodeAction> {
834     let change = assist.source_change.unwrap();
835     let res = lsp_ext::CodeAction {
836         edit: Some(snippet_workspace_edit(snap, change)?),
837         title: assist.label.to_string(),
838         group: assist.group.filter(|_| snap.config.code_action_group()).map(|gr| gr.0),
839         kind: Some(code_action_kind(assist.id.1)),
840         is_preferred: None,
841         data: None,
842     };
843     Ok(res)
844 }
845
846 pub(crate) fn runnable(
847     snap: &GlobalStateSnapshot,
848     runnable: Runnable,
849 ) -> Result<lsp_ext::Runnable> {
850     let config = snap.config.runnables();
851     let spec = CargoTargetSpec::for_file(snap, runnable.nav.file_id)?;
852     let workspace_root = spec.as_ref().map(|it| it.workspace_root.clone());
853     let target = spec.as_ref().map(|s| s.target.clone());
854     let (cargo_args, executable_args) =
855         CargoTargetSpec::runnable_args(snap, spec, &runnable.kind, &runnable.cfg)?;
856     let label = runnable.label(target);
857     let location = location_link(snap, None, runnable.nav)?;
858
859     Ok(lsp_ext::Runnable {
860         label,
861         location: Some(location),
862         kind: lsp_ext::RunnableKind::Cargo,
863         args: lsp_ext::CargoRunnable {
864             workspace_root: workspace_root.map(|it| it.into()),
865             override_cargo: config.override_cargo,
866             cargo_args,
867             cargo_extra_args: config.cargo_extra_args,
868             executable_args,
869             expect_test: None,
870         },
871     })
872 }
873
874 pub(crate) fn code_lens(
875     snap: &GlobalStateSnapshot,
876     annotation: Annotation,
877 ) -> Result<lsp_types::CodeLens> {
878     match annotation.kind {
879         AnnotationKind::Runnable { debug, runnable: run } => {
880             let line_index = snap.file_line_index(run.nav.file_id)?;
881             let annotation_range = range(&line_index, annotation.range);
882
883             let action = run.action();
884             let r = runnable(&snap, run)?;
885
886             let command = if debug {
887                 command::debug_single(&r)
888             } else {
889                 let title = action.run_title.to_string();
890                 command::run_single(&r, &title)
891             };
892
893             Ok(lsp_types::CodeLens { range: annotation_range, command: Some(command), data: None })
894         }
895         AnnotationKind::HasImpls { position: file_position, data } => {
896             let line_index = snap.file_line_index(file_position.file_id)?;
897             let annotation_range = range(&line_index, annotation.range);
898             let url = url(snap, file_position.file_id);
899
900             let position = position(&line_index, file_position.offset);
901
902             let id = lsp_types::TextDocumentIdentifier { uri: url.clone() };
903
904             let doc_pos = lsp_types::TextDocumentPositionParams::new(id, position);
905
906             let goto_params = lsp_types::request::GotoImplementationParams {
907                 text_document_position_params: doc_pos,
908                 work_done_progress_params: Default::default(),
909                 partial_result_params: Default::default(),
910             };
911
912             let command = data.map(|ranges| {
913                 let locations: Vec<lsp_types::Location> = ranges
914                     .into_iter()
915                     .filter_map(|target| {
916                         location(
917                             snap,
918                             FileRange { file_id: target.file_id, range: target.full_range },
919                         )
920                         .ok()
921                     })
922                     .collect();
923
924                 command::show_references(
925                     implementation_title(locations.len()),
926                     &url,
927                     position,
928                     locations,
929                 )
930             });
931
932             Ok(lsp_types::CodeLens {
933                 range: annotation_range,
934                 command,
935                 data: Some(to_value(lsp_ext::CodeLensResolveData::Impls(goto_params)).unwrap()),
936             })
937         }
938         AnnotationKind::HasReferences { position: file_position, data } => {
939             let line_index = snap.file_line_index(file_position.file_id)?;
940             let annotation_range = range(&line_index, annotation.range);
941             let url = url(snap, file_position.file_id);
942
943             let position = position(&line_index, file_position.offset);
944
945             let id = lsp_types::TextDocumentIdentifier { uri: url.clone() };
946
947             let doc_pos = lsp_types::TextDocumentPositionParams::new(id, position);
948
949             let command = data.map(|ranges| {
950                 let locations: Vec<lsp_types::Location> =
951                     ranges.into_iter().filter_map(|range| location(snap, range).ok()).collect();
952
953                 command::show_references(
954                     reference_title(locations.len()),
955                     &url,
956                     position,
957                     locations,
958                 )
959             });
960
961             Ok(lsp_types::CodeLens {
962                 range: annotation_range,
963                 command,
964                 data: Some(to_value(lsp_ext::CodeLensResolveData::References(doc_pos)).unwrap()),
965             })
966         }
967     }
968 }
969
970 pub(crate) mod command {
971     use ide::{FileRange, NavigationTarget};
972     use serde_json::to_value;
973
974     use crate::{
975         global_state::GlobalStateSnapshot,
976         lsp_ext,
977         to_proto::{location, location_link},
978     };
979
980     pub(crate) fn show_references(
981         title: String,
982         uri: &lsp_types::Url,
983         position: lsp_types::Position,
984         locations: Vec<lsp_types::Location>,
985     ) -> lsp_types::Command {
986         // We cannot use the 'editor.action.showReferences' command directly
987         // because that command requires vscode types which we convert in the handler
988         // on the client side.
989
990         lsp_types::Command {
991             title,
992             command: "rust-analyzer.showReferences".into(),
993             arguments: Some(vec![
994                 to_value(uri).unwrap(),
995                 to_value(position).unwrap(),
996                 to_value(locations).unwrap(),
997             ]),
998         }
999     }
1000
1001     pub(crate) fn run_single(runnable: &lsp_ext::Runnable, title: &str) -> lsp_types::Command {
1002         lsp_types::Command {
1003             title: title.to_string(),
1004             command: "rust-analyzer.runSingle".into(),
1005             arguments: Some(vec![to_value(runnable).unwrap()]),
1006         }
1007     }
1008
1009     pub(crate) fn debug_single(runnable: &lsp_ext::Runnable) -> lsp_types::Command {
1010         lsp_types::Command {
1011             title: "Debug".into(),
1012             command: "rust-analyzer.debugSingle".into(),
1013             arguments: Some(vec![to_value(runnable).unwrap()]),
1014         }
1015     }
1016
1017     pub(crate) fn goto_location(
1018         snap: &GlobalStateSnapshot,
1019         nav: &NavigationTarget,
1020     ) -> Option<lsp_types::Command> {
1021         let value = if snap.config.location_link() {
1022             let link = location_link(snap, None, nav.clone()).ok()?;
1023             to_value(link).ok()?
1024         } else {
1025             let range = FileRange { file_id: nav.file_id, range: nav.focus_or_full_range() };
1026             let location = location(snap, range).ok()?;
1027             to_value(location).ok()?
1028         };
1029
1030         Some(lsp_types::Command {
1031             title: nav.name.to_string(),
1032             command: "rust-analyzer.gotoLocation".into(),
1033             arguments: Some(vec![value]),
1034         })
1035     }
1036
1037     pub(crate) fn trigger_parameter_hints() -> lsp_types::Command {
1038         lsp_types::Command {
1039             title: "triggerParameterHints".into(),
1040             command: "editor.action.triggerParameterHints".into(),
1041             arguments: None,
1042         }
1043     }
1044 }
1045
1046 pub(crate) fn implementation_title(count: usize) -> String {
1047     if count == 1 {
1048         "1 implementation".into()
1049     } else {
1050         format!("{} implementations", count)
1051     }
1052 }
1053
1054 pub(crate) fn reference_title(count: usize) -> String {
1055     if count == 1 {
1056         "1 reference".into()
1057     } else {
1058         format!("{} references", count)
1059     }
1060 }
1061
1062 pub(crate) fn markup_content(markup: Markup) -> lsp_types::MarkupContent {
1063     let value = crate::markdown::format_docs(markup.as_str());
1064     lsp_types::MarkupContent { kind: lsp_types::MarkupKind::Markdown, value }
1065 }
1066
1067 pub(crate) fn rename_error(err: RenameError) -> crate::LspError {
1068     crate::LspError { code: lsp_server::ErrorCode::InvalidParams as i32, message: err.to_string() }
1069 }
1070
1071 #[cfg(test)]
1072 mod tests {
1073     use std::sync::Arc;
1074
1075     use hir::PrefixKind;
1076     use ide::Analysis;
1077     use ide_db::helpers::{insert_use::InsertUseConfig, SnippetCap};
1078
1079     use super::*;
1080
1081     #[test]
1082     fn test_completion_with_ref() {
1083         let fixture = r#"
1084         struct Foo;
1085         fn foo(arg: &Foo) {}
1086         fn main() {
1087             let arg = Foo;
1088             foo($0)
1089         }"#;
1090
1091         let (offset, text) = test_utils::extract_offset(fixture);
1092         let line_index = LineIndex {
1093             index: Arc::new(ide::LineIndex::new(&text)),
1094             endings: LineEndings::Unix,
1095             encoding: OffsetEncoding::Utf16,
1096         };
1097         let (analysis, file_id) = Analysis::from_single_file(text);
1098         let completions: Vec<(String, Option<String>)> = analysis
1099             .completions(
1100                 &ide::CompletionConfig {
1101                     enable_postfix_completions: true,
1102                     enable_imports_on_the_fly: true,
1103                     add_call_parenthesis: true,
1104                     add_call_argument_snippets: true,
1105                     snippet_cap: SnippetCap::new(true),
1106                     insert_use: InsertUseConfig {
1107                         merge: None,
1108                         prefix_kind: PrefixKind::Plain,
1109                         group: true,
1110                     },
1111                 },
1112                 ide_db::base_db::FilePosition { file_id, offset },
1113             )
1114             .unwrap()
1115             .unwrap()
1116             .into_iter()
1117             .filter(|c| c.label().ends_with("arg"))
1118             .map(|c| completion_item(&line_index, c))
1119             .flat_map(|comps| comps.into_iter().map(|c| (c.label, c.sort_text)))
1120             .collect();
1121         expect_test::expect![[r#"
1122             [
1123                 (
1124                     "&arg",
1125                     Some(
1126                         "fffffffa",
1127                     ),
1128                 ),
1129                 (
1130                     "arg",
1131                     Some(
1132                         "fffffffd",
1133                     ),
1134                 ),
1135             ]
1136         "#]]
1137         .assert_debug_eq(&completions);
1138     }
1139
1140     #[test]
1141     fn conv_fold_line_folding_only_fixup() {
1142         let text = r#"mod a;
1143 mod b;
1144 mod c;
1145
1146 fn main() {
1147     if cond {
1148         a::do_a();
1149     } else {
1150         b::do_b();
1151     }
1152 }"#;
1153
1154         let (analysis, file_id) = Analysis::from_single_file(text.to_string());
1155         let folds = analysis.folding_ranges(file_id).unwrap();
1156         assert_eq!(folds.len(), 4);
1157
1158         let line_index = LineIndex {
1159             index: Arc::new(ide::LineIndex::new(&text)),
1160             endings: LineEndings::Unix,
1161             encoding: OffsetEncoding::Utf16,
1162         };
1163         let converted: Vec<lsp_types::FoldingRange> =
1164             folds.into_iter().map(|it| folding_range(&text, &line_index, true, it)).collect();
1165
1166         let expected_lines = [(0, 2), (4, 10), (5, 6), (7, 9)];
1167         assert_eq!(converted.len(), expected_lines.len());
1168         for (folding_range, (start_line, end_line)) in converted.iter().zip(expected_lines.iter()) {
1169             assert_eq!(folding_range.start_line, *start_line);
1170             assert_eq!(folding_range.start_character, None);
1171             assert_eq!(folding_range.end_line, *end_line);
1172             assert_eq!(folding_range.end_character, None);
1173         }
1174     }
1175
1176     // `Url` is not able to parse windows paths on unix machines.
1177     #[test]
1178     #[cfg(target_os = "windows")]
1179     fn test_lowercase_drive_letter_with_drive() {
1180         let url = url_from_abs_path(Path::new("C:\\Test"));
1181         assert_eq!(url.to_string(), "file:///c:/Test");
1182     }
1183
1184     #[test]
1185     #[cfg(target_os = "windows")]
1186     fn test_drive_without_colon_passthrough() {
1187         let url = url_from_abs_path(Path::new(r#"\\localhost\C$\my_dir"#));
1188         assert_eq!(url.to_string(), "file://localhost/C$/my_dir");
1189     }
1190 }