1 //! Conversion of rust-analyzer specific types to lsp_types equivalents.
4 sync::atomic::{AtomicU32, Ordering},
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,
14 use itertools::Itertools;
15 use serde_json::to_value;
18 cargo_target_spec::CargoTargetSpec,
19 global_state::GlobalStateSnapshot,
20 line_index::{LineEndings, LineIndex, OffsetEncoding},
21 lsp_ext, semantic_tokens, Result,
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)
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)
41 pub(crate) fn symbol_kind(symbol_kind: SymbolKind) -> lsp_types::SymbolKind {
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,
57 | SymbolKind::SelfParam
58 | SymbolKind::LifetimeParam
59 | SymbolKind::ValueParam
60 | SymbolKind::Label => lsp_types::SymbolKind::Variable,
61 SymbolKind::Union => lsp_types::SymbolKind::Struct,
65 pub(crate) fn structure_node_kind(kind: StructureNodeKind) -> lsp_types::SymbolKind {
67 StructureNodeKind::SymbolKind(symbol) => symbol_kind(symbol),
68 StructureNodeKind::Region => lsp_types::SymbolKind::Namespace,
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,
81 pub(crate) fn diagnostic_severity(severity: Severity) -> lsp_types::DiagnosticSeverity {
83 Severity::Error => lsp_types::DiagnosticSeverity::Error,
84 Severity::WeakWarning => lsp_types::DiagnosticSeverity::Hint,
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)
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,
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,
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"),
145 lsp_types::TextEdit { range, new_text }
148 pub(crate) fn snippet_text_edit(
149 line_index: &LineIndex,
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,
163 pub(crate) fn text_edit_vec(
164 line_index: &LineIndex,
166 ) -> Vec<lsp_types::TextEdit> {
167 text_edit.into_iter().map(|indel| self::text_edit(line_index, indel)).collect()
170 pub(crate) fn snippet_text_edit_vec(
171 line_index: &LineIndex,
174 ) -> Vec<lsp_ext::SnippetTextEdit> {
177 .map(|indel| self::snippet_text_edit(line_index, is_snippet, indel))
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())
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)
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);
209 let text_edit = text_edit.unwrap();
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()),
223 fn set_score(res: &mut lsp_types::CompletionItem, relevance: CompletionRelevance) {
224 if relevance.is_relevant() {
225 res.preselect = Some(true);
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));
237 set_score(&mut lsp_item, item.relevance());
239 if item.deprecated() {
240 lsp_item.tags = Some(vec![lsp_types::CompletionItemTag::Deprecated])
243 if item.trigger_call_info() {
244 lsp_item.command = Some(command::trigger_parameter_hints());
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
255 it.new_text = format!("&{}{}", mutability.as_keyword_for_ref(), it.new_text);
257 vec![lsp_item_with_ref, lsp_item]
259 None => vec![lsp_item],
262 for lsp_item in res.iter_mut() {
263 lsp_item.insert_text_format = Some(insert_text_format(item.insert_text_format()));
268 pub(crate) fn signature_help(
272 ) -> lsp_types::SignatureHelp {
273 let (label, parameters) = match (concise, label_offsets) {
275 let params = call_info
277 .map(|label| lsp_types::ParameterInformation {
278 label: lsp_types::ParameterLabel::Simple(label.to_string()),
281 .collect::<Vec<_>>();
283 if concise { call_info.parameter_labels().join(", ") } else { call_info.signature };
287 let params = call_info
290 .map(|it| [u32::from(it.start()), u32::from(it.end())])
291 .map(|label_offsets| lsp_types::ParameterInformation {
292 label: lsp_types::ParameterLabel::LabelOffsets(label_offsets),
295 .collect::<Vec<_>>();
296 (call_info.signature, params)
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() {
304 label.push_str(", ");
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]),
320 let documentation = if concise {
323 call_info.doc.map(|doc| {
324 lsp_types::Documentation::MarkupContent(lsp_types::MarkupContent {
325 kind: lsp_types::MarkupKind::Markdown,
331 let active_parameter = call_info.active_parameter.map(|it| it as u32);
333 let signature = lsp_types::SignatureInformation {
336 parameters: Some(parameters),
339 lsp_types::SignatureHelp {
340 signatures: vec![signature],
341 active_signature: None,
346 pub(crate) fn inlay_hint(line_index: &LineIndex, inlay_hint: InlayHint) -> 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,
358 static TOKEN_RESULT_COUNTER: AtomicU32 = AtomicU32::new(1);
360 pub(crate) fn semantic_tokens(
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);
368 for highlight_range in highlights {
369 if highlight_range.highlight.is_empty() {
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;
376 for mut text_range in line_index.index.lines(highlight_range.range) {
377 if text[text_range].ends_with('\n') {
379 TextRange::new(text_range.start(), text_range.end() - TextSize::of('\n'));
381 let range = range(&line_index, text_range);
382 builder.push(range, token_index, modifier_bitset);
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, ¤t.data);
395 lsp_types::SemanticTokensDelta { result_id, edits }
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
418 lsp_types::SemanticTokenType::FUNCTION
421 SymbolKind::Const => {
422 mods |= semantic_tokens::CONSTANT;
423 mods |= lsp_types::SemanticTokenModifier::STATIC;
424 lsp_types::SemanticTokenType::VARIABLE
426 SymbolKind::Static => {
427 mods |= lsp_types::SemanticTokenModifier::STATIC;
428 lsp_types::SemanticTokenType::VARIABLE
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,
438 HlTag::Attribute => semantic_tokens::ATTRIBUTE,
439 HlTag::BoolLiteral => semantic_tokens::BOOLEAN,
440 HlTag::BuiltinType => semantic_tokens::BUILTIN_TYPE,
441 HlTag::ByteLiteral | HlTag::NumericLiteral => lsp_types::SemanticTokenType::NUMBER,
442 HlTag::CharLiteral => semantic_tokens::CHAR_LITERAL,
443 HlTag::Comment => lsp_types::SemanticTokenType::COMMENT,
444 HlTag::EscapeSequence => semantic_tokens::ESCAPE_SEQUENCE,
445 HlTag::FormatSpecifier => semantic_tokens::FORMAT_SPECIFIER,
446 HlTag::Keyword => lsp_types::SemanticTokenType::KEYWORD,
447 HlTag::None => semantic_tokens::GENERIC,
448 HlTag::Operator => lsp_types::SemanticTokenType::OPERATOR,
449 HlTag::StringLiteral => lsp_types::SemanticTokenType::STRING,
450 HlTag::UnresolvedReference => semantic_tokens::UNRESOLVED_REFERENCE,
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,
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::IntraDocLink => semantic_tokens::INTRA_DOC_LINK,
477 HlMod::Associated => continue,
485 pub(crate) fn folding_range(
487 line_index: &LineIndex,
488 line_folding_only: bool,
490 ) -> lsp_types::FoldingRange {
491 let kind = match fold.kind {
492 FoldKind::Comment => Some(lsp_types::FoldingRangeKind::Comment),
493 FoldKind::Imports => Some(lsp_types::FoldingRangeKind::Imports),
494 FoldKind::Region => Some(lsp_types::FoldingRangeKind::Region),
495 FoldKind::Mods | FoldKind::Block | FoldKind::ArgList | FoldKind::Consts | FoldKind::Statics => None,
498 let range = range(line_index, fold.range);
500 if line_folding_only {
501 // Clients with line_folding_only == true (such as VSCode) will fold the whole end line
502 // even if it contains text not in the folding range. To prevent that we exclude
503 // range.end.line from the folding region if there is more text after range.end
505 let has_more_text_on_end_line = text[TextRange::new(fold.range.end(), TextSize::of(text))]
507 .take_while(|it| *it != '\n')
508 .any(|it| !it.is_whitespace());
510 let end_line = if has_more_text_on_end_line {
511 range.end.line.saturating_sub(1)
516 lsp_types::FoldingRange {
517 start_line: range.start.line,
518 start_character: None,
524 lsp_types::FoldingRange {
525 start_line: range.start.line,
526 start_character: Some(range.start.character),
527 end_line: range.end.line,
528 end_character: Some(range.end.character),
534 pub(crate) fn url(snap: &GlobalStateSnapshot, file_id: FileId) -> lsp_types::Url {
535 snap.file_id_to_url(file_id)
538 /// Returns a `Url` object from a given path, will lowercase drive letters if present.
539 /// This will only happen when processing windows paths.
541 /// When processing non-windows path, this is essentially the same as `Url::from_file_path`.
542 pub(crate) fn url_from_abs_path(path: &Path) -> lsp_types::Url {
543 assert!(path.is_absolute());
544 let url = lsp_types::Url::from_file_path(path).unwrap();
545 match path.components().next() {
546 Some(path::Component::Prefix(prefix))
547 if matches!(prefix.kind(), path::Prefix::Disk(_) | path::Prefix::VerbatimDisk(_)) =>
549 // Need to lowercase driver letter
554 let driver_letter_range = {
555 let (scheme, drive_letter, _rest) = match url.as_str().splitn(3, ':').collect_tuple() {
559 let start = scheme.len() + ':'.len_utf8();
560 start..(start + drive_letter.len())
563 // Note: lowercasing the `path` itself doesn't help, the `Url::parse`
564 // machinery *also* canonicalizes the drive letter. So, just massage the
566 let mut url = url.into_string();
567 url[driver_letter_range].make_ascii_lowercase();
568 lsp_types::Url::parse(&url).unwrap()
571 pub(crate) fn optional_versioned_text_document_identifier(
572 snap: &GlobalStateSnapshot,
574 ) -> lsp_types::OptionalVersionedTextDocumentIdentifier {
575 let url = url(snap, file_id);
576 let version = snap.url_file_version(&url);
577 lsp_types::OptionalVersionedTextDocumentIdentifier { uri: url, version }
580 pub(crate) fn location(
581 snap: &GlobalStateSnapshot,
583 ) -> Result<lsp_types::Location> {
584 let url = url(snap, frange.file_id);
585 let line_index = snap.file_line_index(frange.file_id)?;
586 let range = range(&line_index, frange.range);
587 let loc = lsp_types::Location::new(url, range);
591 /// Perefer using `location_link`, if the client has the cap.
592 pub(crate) fn location_from_nav(
593 snap: &GlobalStateSnapshot,
594 nav: NavigationTarget,
595 ) -> Result<lsp_types::Location> {
596 let url = url(snap, nav.file_id);
597 let line_index = snap.file_line_index(nav.file_id)?;
598 let range = range(&line_index, nav.full_range);
599 let loc = lsp_types::Location::new(url, range);
603 pub(crate) fn location_link(
604 snap: &GlobalStateSnapshot,
605 src: Option<FileRange>,
606 target: NavigationTarget,
607 ) -> Result<lsp_types::LocationLink> {
608 let origin_selection_range = match src {
610 let line_index = snap.file_line_index(src.file_id)?;
611 let range = range(&line_index, src.range);
616 let (target_uri, target_range, target_selection_range) = location_info(snap, target)?;
617 let res = lsp_types::LocationLink {
618 origin_selection_range,
621 target_selection_range,
627 snap: &GlobalStateSnapshot,
628 target: NavigationTarget,
629 ) -> Result<(lsp_types::Url, lsp_types::Range, lsp_types::Range)> {
630 let line_index = snap.file_line_index(target.file_id)?;
632 let target_uri = url(snap, target.file_id);
633 let target_range = range(&line_index, target.full_range);
634 let target_selection_range =
635 target.focus_range.map(|it| range(&line_index, it)).unwrap_or(target_range);
636 Ok((target_uri, target_range, target_selection_range))
639 pub(crate) fn goto_definition_response(
640 snap: &GlobalStateSnapshot,
641 src: Option<FileRange>,
642 targets: Vec<NavigationTarget>,
643 ) -> Result<lsp_types::GotoDefinitionResponse> {
644 if snap.config.location_link() {
647 .map(|nav| location_link(snap, src, nav))
648 .collect::<Result<Vec<_>>>()?;
651 let locations = targets
654 location(snap, FileRange { file_id: nav.file_id, range: nav.focus_or_full_range() })
656 .collect::<Result<Vec<_>>>()?;
661 pub(crate) fn text_document_edit(
662 snap: &GlobalStateSnapshot,
665 ) -> Result<lsp_types::TextDocumentEdit> {
666 let text_document = optional_versioned_text_document_identifier(snap, file_id);
667 let line_index = snap.file_line_index(file_id)?;
669 edit.into_iter().map(|it| lsp_types::OneOf::Left(text_edit(&line_index, it))).collect();
670 Ok(lsp_types::TextDocumentEdit { text_document, edits })
673 pub(crate) fn snippet_text_document_edit(
674 snap: &GlobalStateSnapshot,
678 ) -> Result<lsp_ext::SnippetTextDocumentEdit> {
679 let text_document = optional_versioned_text_document_identifier(snap, file_id);
680 let line_index = snap.file_line_index(file_id)?;
681 let edits = edit.into_iter().map(|it| snippet_text_edit(&line_index, is_snippet, it)).collect();
682 Ok(lsp_ext::SnippetTextDocumentEdit { text_document, edits })
685 pub(crate) fn snippet_text_document_ops(
686 snap: &GlobalStateSnapshot,
687 file_system_edit: FileSystemEdit,
688 ) -> Vec<lsp_ext::SnippetDocumentChangeOperation> {
689 let mut ops = Vec::new();
690 match file_system_edit {
691 FileSystemEdit::CreateFile { dst, initial_contents } => {
692 let uri = snap.anchored_path(&dst);
693 let create_file = lsp_types::ResourceOp::Create(lsp_types::CreateFile {
698 ops.push(lsp_ext::SnippetDocumentChangeOperation::Op(create_file));
699 if !initial_contents.is_empty() {
701 lsp_types::OptionalVersionedTextDocumentIdentifier { uri, version: None };
702 let text_edit = lsp_ext::SnippetTextEdit {
703 range: lsp_types::Range::default(),
704 new_text: initial_contents,
705 insert_text_format: Some(lsp_types::InsertTextFormat::PlainText),
708 lsp_ext::SnippetTextDocumentEdit { text_document, edits: vec![text_edit] };
709 ops.push(lsp_ext::SnippetDocumentChangeOperation::Edit(edit_file));
712 FileSystemEdit::MoveFile { src, dst } => {
713 let old_uri = snap.file_id_to_url(src);
714 let new_uri = snap.anchored_path(&dst);
715 let rename_file = lsp_types::ResourceOp::Rename(lsp_types::RenameFile {
721 ops.push(lsp_ext::SnippetDocumentChangeOperation::Op(rename_file))
727 pub(crate) fn snippet_workspace_edit(
728 snap: &GlobalStateSnapshot,
729 source_change: SourceChange,
730 ) -> Result<lsp_ext::SnippetWorkspaceEdit> {
731 let mut document_changes: Vec<lsp_ext::SnippetDocumentChangeOperation> = Vec::new();
732 for op in source_change.file_system_edits {
733 let ops = snippet_text_document_ops(snap, op);
734 document_changes.extend_from_slice(&ops);
736 for (file_id, edit) in source_change.source_file_edits {
737 let edit = snippet_text_document_edit(&snap, source_change.is_snippet, file_id, edit)?;
738 document_changes.push(lsp_ext::SnippetDocumentChangeOperation::Edit(edit));
741 lsp_ext::SnippetWorkspaceEdit { changes: None, document_changes: Some(document_changes) };
745 pub(crate) fn workspace_edit(
746 snap: &GlobalStateSnapshot,
747 source_change: SourceChange,
748 ) -> Result<lsp_types::WorkspaceEdit> {
749 assert!(!source_change.is_snippet);
750 snippet_workspace_edit(snap, source_change).map(|it| it.into())
753 impl From<lsp_ext::SnippetWorkspaceEdit> for lsp_types::WorkspaceEdit {
754 fn from(snippet_workspace_edit: lsp_ext::SnippetWorkspaceEdit) -> lsp_types::WorkspaceEdit {
755 lsp_types::WorkspaceEdit {
757 document_changes: snippet_workspace_edit.document_changes.map(|changes| {
758 lsp_types::DocumentChanges::Operations(
761 .map(|change| match change {
762 lsp_ext::SnippetDocumentChangeOperation::Op(op) => {
763 lsp_types::DocumentChangeOperation::Op(op)
765 lsp_ext::SnippetDocumentChangeOperation::Edit(edit) => {
766 lsp_types::DocumentChangeOperation::Edit(
767 lsp_types::TextDocumentEdit {
768 text_document: edit.text_document,
773 lsp_types::OneOf::Left(lsp_types::TextEdit {
775 new_text: edit.new_text,
786 change_annotations: None,
791 pub(crate) fn call_hierarchy_item(
792 snap: &GlobalStateSnapshot,
793 target: NavigationTarget,
794 ) -> Result<lsp_types::CallHierarchyItem> {
795 let name = target.name.to_string();
796 let detail = target.description.clone();
797 let kind = target.kind.map(symbol_kind).unwrap_or(lsp_types::SymbolKind::Function);
798 let (uri, range, selection_range) = location_info(snap, target)?;
799 Ok(lsp_types::CallHierarchyItem {
811 pub(crate) fn code_action_kind(kind: AssistKind) -> lsp_types::CodeActionKind {
813 AssistKind::None | AssistKind::Generate => lsp_types::CodeActionKind::EMPTY,
814 AssistKind::QuickFix => lsp_types::CodeActionKind::QUICKFIX,
815 AssistKind::Refactor => lsp_types::CodeActionKind::REFACTOR,
816 AssistKind::RefactorExtract => lsp_types::CodeActionKind::REFACTOR_EXTRACT,
817 AssistKind::RefactorInline => lsp_types::CodeActionKind::REFACTOR_INLINE,
818 AssistKind::RefactorRewrite => lsp_types::CodeActionKind::REFACTOR_REWRITE,
822 pub(crate) fn unresolved_code_action(
823 snap: &GlobalStateSnapshot,
824 code_action_params: lsp_types::CodeActionParams,
827 ) -> Result<lsp_ext::CodeAction> {
828 assert!(assist.source_change.is_none());
829 let res = lsp_ext::CodeAction {
830 title: assist.label.to_string(),
831 group: assist.group.filter(|_| snap.config.code_action_group()).map(|gr| gr.0),
832 kind: Some(code_action_kind(assist.id.1)),
835 data: Some(lsp_ext::CodeActionData {
836 id: format!("{}:{}", assist.id.0, index.to_string()),
843 pub(crate) fn resolved_code_action(
844 snap: &GlobalStateSnapshot,
846 ) -> Result<lsp_ext::CodeAction> {
847 let change = assist.source_change.unwrap();
848 let res = lsp_ext::CodeAction {
849 edit: Some(snippet_workspace_edit(snap, change)?),
850 title: assist.label.to_string(),
851 group: assist.group.filter(|_| snap.config.code_action_group()).map(|gr| gr.0),
852 kind: Some(code_action_kind(assist.id.1)),
859 pub(crate) fn runnable(
860 snap: &GlobalStateSnapshot,
862 ) -> Result<lsp_ext::Runnable> {
863 let config = snap.config.runnables();
864 let spec = CargoTargetSpec::for_file(snap, runnable.nav.file_id)?;
865 let workspace_root = spec.as_ref().map(|it| it.workspace_root.clone());
866 let target = spec.as_ref().map(|s| s.target.clone());
867 let (cargo_args, executable_args) =
868 CargoTargetSpec::runnable_args(snap, spec, &runnable.kind, &runnable.cfg)?;
869 let label = runnable.label(target);
870 let location = location_link(snap, None, runnable.nav)?;
872 Ok(lsp_ext::Runnable {
874 location: Some(location),
875 kind: lsp_ext::RunnableKind::Cargo,
876 args: lsp_ext::CargoRunnable {
877 workspace_root: workspace_root.map(|it| it.into()),
878 override_cargo: config.override_cargo,
880 cargo_extra_args: config.cargo_extra_args,
887 pub(crate) fn code_lens(
888 snap: &GlobalStateSnapshot,
889 annotation: Annotation,
890 ) -> Result<lsp_types::CodeLens> {
891 match annotation.kind {
892 AnnotationKind::Runnable { debug, runnable: run } => {
893 let line_index = snap.file_line_index(run.nav.file_id)?;
894 let annotation_range = range(&line_index, annotation.range);
896 let action = run.action();
897 let r = runnable(&snap, run)?;
899 let command = if debug {
900 command::debug_single(&r)
902 let title = action.run_title.to_string();
903 command::run_single(&r, &title)
906 Ok(lsp_types::CodeLens { range: annotation_range, command: Some(command), data: None })
908 AnnotationKind::HasImpls { position: file_position, data } => {
909 let line_index = snap.file_line_index(file_position.file_id)?;
910 let annotation_range = range(&line_index, annotation.range);
911 let url = url(snap, file_position.file_id);
913 let position = position(&line_index, file_position.offset);
915 let id = lsp_types::TextDocumentIdentifier { uri: url.clone() };
917 let doc_pos = lsp_types::TextDocumentPositionParams::new(id, position);
919 let goto_params = lsp_types::request::GotoImplementationParams {
920 text_document_position_params: doc_pos,
921 work_done_progress_params: Default::default(),
922 partial_result_params: Default::default(),
925 let command = data.map(|ranges| {
926 let locations: Vec<lsp_types::Location> = ranges
928 .filter_map(|target| {
931 FileRange { file_id: target.file_id, range: target.full_range },
937 command::show_references(
938 implementation_title(locations.len()),
945 Ok(lsp_types::CodeLens {
946 range: annotation_range,
948 data: Some(to_value(lsp_ext::CodeLensResolveData::Impls(goto_params)).unwrap()),
951 AnnotationKind::HasReferences { position: file_position, data } => {
952 let line_index = snap.file_line_index(file_position.file_id)?;
953 let annotation_range = range(&line_index, annotation.range);
954 let url = url(snap, file_position.file_id);
956 let position = position(&line_index, file_position.offset);
958 let id = lsp_types::TextDocumentIdentifier { uri: url.clone() };
960 let doc_pos = lsp_types::TextDocumentPositionParams::new(id, position);
962 let command = data.map(|ranges| {
963 let locations: Vec<lsp_types::Location> =
964 ranges.into_iter().filter_map(|range| location(snap, range).ok()).collect();
966 command::show_references(
967 reference_title(locations.len()),
974 Ok(lsp_types::CodeLens {
975 range: annotation_range,
977 data: Some(to_value(lsp_ext::CodeLensResolveData::References(doc_pos)).unwrap()),
983 pub(crate) mod command {
984 use ide::{FileRange, NavigationTarget};
985 use serde_json::to_value;
988 global_state::GlobalStateSnapshot,
990 to_proto::{location, location_link},
993 pub(crate) fn show_references(
995 uri: &lsp_types::Url,
996 position: lsp_types::Position,
997 locations: Vec<lsp_types::Location>,
998 ) -> lsp_types::Command {
999 // We cannot use the 'editor.action.showReferences' command directly
1000 // because that command requires vscode types which we convert in the handler
1001 // on the client side.
1003 lsp_types::Command {
1005 command: "rust-analyzer.showReferences".into(),
1006 arguments: Some(vec![
1007 to_value(uri).unwrap(),
1008 to_value(position).unwrap(),
1009 to_value(locations).unwrap(),
1014 pub(crate) fn run_single(runnable: &lsp_ext::Runnable, title: &str) -> lsp_types::Command {
1015 lsp_types::Command {
1016 title: title.to_string(),
1017 command: "rust-analyzer.runSingle".into(),
1018 arguments: Some(vec![to_value(runnable).unwrap()]),
1022 pub(crate) fn debug_single(runnable: &lsp_ext::Runnable) -> lsp_types::Command {
1023 lsp_types::Command {
1024 title: "Debug".into(),
1025 command: "rust-analyzer.debugSingle".into(),
1026 arguments: Some(vec![to_value(runnable).unwrap()]),
1030 pub(crate) fn goto_location(
1031 snap: &GlobalStateSnapshot,
1032 nav: &NavigationTarget,
1033 ) -> Option<lsp_types::Command> {
1034 let value = if snap.config.location_link() {
1035 let link = location_link(snap, None, nav.clone()).ok()?;
1036 to_value(link).ok()?
1038 let range = FileRange { file_id: nav.file_id, range: nav.focus_or_full_range() };
1039 let location = location(snap, range).ok()?;
1040 to_value(location).ok()?
1043 Some(lsp_types::Command {
1044 title: nav.name.to_string(),
1045 command: "rust-analyzer.gotoLocation".into(),
1046 arguments: Some(vec![value]),
1050 pub(crate) fn trigger_parameter_hints() -> lsp_types::Command {
1051 lsp_types::Command {
1052 title: "triggerParameterHints".into(),
1053 command: "editor.action.triggerParameterHints".into(),
1059 pub(crate) fn implementation_title(count: usize) -> String {
1061 "1 implementation".into()
1063 format!("{} implementations", count)
1067 pub(crate) fn reference_title(count: usize) -> String {
1069 "1 reference".into()
1071 format!("{} references", count)
1075 pub(crate) fn markup_content(markup: Markup) -> lsp_types::MarkupContent {
1076 let value = crate::markdown::format_docs(markup.as_str());
1077 lsp_types::MarkupContent { kind: lsp_types::MarkupKind::Markdown, value }
1080 pub(crate) fn rename_error(err: RenameError) -> crate::LspError {
1081 crate::LspError { code: lsp_server::ErrorCode::InvalidParams as i32, message: err.to_string() }
1089 use ide_db::helpers::{
1090 insert_use::{InsertUseConfig, PrefixKind},
1097 fn test_completion_with_ref() {
1100 fn foo(arg: &Foo) {}
1106 let (offset, text) = test_utils::extract_offset(fixture);
1107 let line_index = LineIndex {
1108 index: Arc::new(ide::LineIndex::new(&text)),
1109 endings: LineEndings::Unix,
1110 encoding: OffsetEncoding::Utf16,
1112 let (analysis, file_id) = Analysis::from_single_file(text);
1113 let completions: Vec<(String, Option<String>)> = analysis
1115 &ide::CompletionConfig {
1116 enable_postfix_completions: true,
1117 enable_imports_on_the_fly: true,
1118 add_call_parenthesis: true,
1119 add_call_argument_snippets: true,
1120 snippet_cap: SnippetCap::new(true),
1121 insert_use: InsertUseConfig {
1123 prefix_kind: PrefixKind::Plain,
1127 ide_db::base_db::FilePosition { file_id, offset },
1132 .filter(|c| c.label().ends_with("arg"))
1133 .map(|c| completion_item(&line_index, c))
1134 .flat_map(|comps| comps.into_iter().map(|c| (c.label, c.sort_text)))
1136 expect_test::expect![[r#"
1152 .assert_debug_eq(&completions);
1156 fn conv_fold_line_folding_only_fixup() {
1157 let text = r#"mod a;
1169 let (analysis, file_id) = Analysis::from_single_file(text.to_string());
1170 let folds = analysis.folding_ranges(file_id).unwrap();
1171 assert_eq!(folds.len(), 4);
1173 let line_index = LineIndex {
1174 index: Arc::new(ide::LineIndex::new(&text)),
1175 endings: LineEndings::Unix,
1176 encoding: OffsetEncoding::Utf16,
1178 let converted: Vec<lsp_types::FoldingRange> =
1179 folds.into_iter().map(|it| folding_range(&text, &line_index, true, it)).collect();
1181 let expected_lines = [(0, 2), (4, 10), (5, 6), (7, 9)];
1182 assert_eq!(converted.len(), expected_lines.len());
1183 for (folding_range, (start_line, end_line)) in converted.iter().zip(expected_lines.iter()) {
1184 assert_eq!(folding_range.start_line, *start_line);
1185 assert_eq!(folding_range.start_character, None);
1186 assert_eq!(folding_range.end_line, *end_line);
1187 assert_eq!(folding_range.end_character, None);
1191 // `Url` is not able to parse windows paths on unix machines.
1193 #[cfg(target_os = "windows")]
1194 fn test_lowercase_drive_letter_with_drive() {
1195 let url = url_from_abs_path(Path::new("C:\\Test"));
1196 assert_eq!(url.to_string(), "file:///c:/Test");
1200 #[cfg(target_os = "windows")]
1201 fn test_drive_without_colon_passthrough() {
1202 let url = url_from_abs_path(Path::new(r#"\\localhost\C$\my_dir"#));
1203 assert_eq!(url.to_string(), "file://localhost/C$/my_dir");