1 //! Conversion of rust-analyzer specific types to lsp_types equivalents.
2 use ra_db::{FileId, FileRange};
4 Assist, CompletionItem, CompletionItemKind, Documentation, FileSystemEdit, Fold, FoldKind,
5 FunctionSignature, Highlight, HighlightModifier, HighlightTag, HighlightedRange, Indel,
6 InlayHint, InlayKind, InsertTextFormat, LineIndex, NavigationTarget, ReferenceAccess, Severity,
7 SourceChange, SourceFileEdit, TextEdit,
9 use ra_syntax::{SyntaxKind, TextRange, TextSize};
10 use ra_vfs::LineEndings;
12 use crate::{lsp_ext, semantic_tokens, world::WorldSnapshot, Result};
14 pub(crate) fn position(line_index: &LineIndex, offset: TextSize) -> lsp_types::Position {
15 let line_col = line_index.line_col(offset);
16 let line = u64::from(line_col.line);
17 let character = u64::from(line_col.col_utf16);
18 lsp_types::Position::new(line, character)
21 pub(crate) fn range(line_index: &LineIndex, range: TextRange) -> lsp_types::Range {
22 let start = position(line_index, range.start());
23 let end = position(line_index, range.end());
24 lsp_types::Range::new(start, end)
27 pub(crate) fn symbol_kind(syntax_kind: SyntaxKind) -> lsp_types::SymbolKind {
29 SyntaxKind::FN_DEF => lsp_types::SymbolKind::Function,
30 SyntaxKind::STRUCT_DEF => lsp_types::SymbolKind::Struct,
31 SyntaxKind::ENUM_DEF => lsp_types::SymbolKind::Enum,
32 SyntaxKind::ENUM_VARIANT => lsp_types::SymbolKind::EnumMember,
33 SyntaxKind::TRAIT_DEF => lsp_types::SymbolKind::Interface,
34 SyntaxKind::MACRO_CALL => lsp_types::SymbolKind::Function,
35 SyntaxKind::MODULE => lsp_types::SymbolKind::Module,
36 SyntaxKind::TYPE_ALIAS_DEF => lsp_types::SymbolKind::TypeParameter,
37 SyntaxKind::RECORD_FIELD_DEF => lsp_types::SymbolKind::Field,
38 SyntaxKind::STATIC_DEF => lsp_types::SymbolKind::Constant,
39 SyntaxKind::CONST_DEF => lsp_types::SymbolKind::Constant,
40 SyntaxKind::IMPL_DEF => lsp_types::SymbolKind::Object,
41 _ => lsp_types::SymbolKind::Variable,
45 pub(crate) fn document_highlight_kind(
46 reference_access: ReferenceAccess,
47 ) -> lsp_types::DocumentHighlightKind {
48 match reference_access {
49 ReferenceAccess::Read => lsp_types::DocumentHighlightKind::Read,
50 ReferenceAccess::Write => lsp_types::DocumentHighlightKind::Write,
54 pub(crate) fn diagnostic_severity(severity: Severity) -> lsp_types::DiagnosticSeverity {
56 Severity::Error => lsp_types::DiagnosticSeverity::Error,
57 Severity::WeakWarning => lsp_types::DiagnosticSeverity::Hint,
61 pub(crate) fn documentation(documentation: Documentation) -> lsp_types::Documentation {
62 let value = crate::markdown::format_docs(documentation.as_str());
63 let markup_content = lsp_types::MarkupContent { kind: lsp_types::MarkupKind::Markdown, value };
64 lsp_types::Documentation::MarkupContent(markup_content)
67 pub(crate) fn insert_text_format(
68 insert_text_format: InsertTextFormat,
69 ) -> lsp_types::InsertTextFormat {
70 match insert_text_format {
71 InsertTextFormat::Snippet => lsp_types::InsertTextFormat::Snippet,
72 InsertTextFormat::PlainText => lsp_types::InsertTextFormat::PlainText,
76 pub(crate) fn completion_item_kind(
77 completion_item_kind: CompletionItemKind,
78 ) -> lsp_types::CompletionItemKind {
79 match completion_item_kind {
80 CompletionItemKind::Keyword => lsp_types::CompletionItemKind::Keyword,
81 CompletionItemKind::Snippet => lsp_types::CompletionItemKind::Snippet,
82 CompletionItemKind::Module => lsp_types::CompletionItemKind::Module,
83 CompletionItemKind::Function => lsp_types::CompletionItemKind::Function,
84 CompletionItemKind::Struct => lsp_types::CompletionItemKind::Struct,
85 CompletionItemKind::Enum => lsp_types::CompletionItemKind::Enum,
86 CompletionItemKind::EnumVariant => lsp_types::CompletionItemKind::EnumMember,
87 CompletionItemKind::BuiltinType => lsp_types::CompletionItemKind::Struct,
88 CompletionItemKind::Binding => lsp_types::CompletionItemKind::Variable,
89 CompletionItemKind::Field => lsp_types::CompletionItemKind::Field,
90 CompletionItemKind::Trait => lsp_types::CompletionItemKind::Interface,
91 CompletionItemKind::TypeAlias => lsp_types::CompletionItemKind::Struct,
92 CompletionItemKind::Const => lsp_types::CompletionItemKind::Constant,
93 CompletionItemKind::Static => lsp_types::CompletionItemKind::Value,
94 CompletionItemKind::Method => lsp_types::CompletionItemKind::Method,
95 CompletionItemKind::TypeParam => lsp_types::CompletionItemKind::TypeParameter,
96 CompletionItemKind::Macro => lsp_types::CompletionItemKind::Method,
97 CompletionItemKind::Attribute => lsp_types::CompletionItemKind::EnumMember,
101 pub(crate) fn text_edit(
102 line_index: &LineIndex,
103 line_endings: LineEndings,
105 ) -> lsp_types::TextEdit {
106 let range = range(line_index, indel.delete);
107 let new_text = match line_endings {
108 LineEndings::Unix => indel.insert,
109 LineEndings::Dos => indel.insert.replace('\n', "\r\n"),
111 lsp_types::TextEdit { range, new_text }
114 pub(crate) fn snippet_text_edit(
115 line_index: &LineIndex,
116 line_endings: LineEndings,
119 ) -> lsp_ext::SnippetTextEdit {
120 let text_edit = text_edit(line_index, line_endings, indel);
121 let insert_text_format =
122 if is_snippet { Some(lsp_types::InsertTextFormat::Snippet) } else { None };
123 lsp_ext::SnippetTextEdit {
124 range: text_edit.range,
125 new_text: text_edit.new_text,
130 pub(crate) fn text_edit_vec(
131 line_index: &LineIndex,
132 line_endings: LineEndings,
134 ) -> Vec<lsp_types::TextEdit> {
135 text_edit.into_iter().map(|indel| self::text_edit(line_index, line_endings, indel)).collect()
138 pub(crate) fn snippet_text_edit_vec(
139 line_index: &LineIndex,
140 line_endings: LineEndings,
143 ) -> Vec<lsp_ext::SnippetTextEdit> {
146 .map(|indel| self::snippet_text_edit(line_index, line_endings, is_snippet, indel))
150 pub(crate) fn completion_item(
151 line_index: &LineIndex,
152 line_endings: LineEndings,
153 completion_item: CompletionItem,
154 ) -> lsp_types::CompletionItem {
155 let mut additional_text_edits = Vec::new();
156 let mut text_edit = None;
157 // LSP does not allow arbitrary edits in completion, so we have to do a
158 // non-trivial mapping here.
159 let source_range = completion_item.source_range();
160 for indel in completion_item.text_edit().iter() {
161 if indel.delete.contains_range(source_range) {
162 text_edit = Some(if indel.delete == source_range {
163 self::text_edit(line_index, line_endings, indel.clone())
165 assert!(source_range.end() == indel.delete.end());
166 let range1 = TextRange::new(indel.delete.start(), source_range.start());
167 let range2 = source_range;
168 let indel1 = Indel::replace(range1, String::new());
169 let indel2 = Indel::replace(range2, indel.insert.clone());
170 additional_text_edits.push(self::text_edit(line_index, line_endings, indel1));
171 self::text_edit(line_index, line_endings, indel2)
174 assert!(source_range.intersect(indel.delete).is_none());
175 let text_edit = self::text_edit(line_index, line_endings, indel.clone());
176 additional_text_edits.push(text_edit);
179 let text_edit = text_edit.unwrap();
181 let mut res = lsp_types::CompletionItem {
182 label: completion_item.label().to_string(),
183 detail: completion_item.detail().map(|it| it.to_string()),
184 filter_text: Some(completion_item.lookup().to_string()),
185 kind: completion_item.kind().map(completion_item_kind),
186 text_edit: Some(text_edit.into()),
187 additional_text_edits: Some(additional_text_edits),
188 documentation: completion_item.documentation().map(documentation),
189 deprecated: Some(completion_item.deprecated()),
193 if completion_item.score().is_some() {
194 res.preselect = Some(true);
195 // HACK: sort preselect items first
196 res.sort_text = Some(format!(" {}", completion_item.label()));
199 if completion_item.deprecated() {
200 res.tags = Some(vec![lsp_types::CompletionItemTag::Deprecated])
203 if completion_item.trigger_call_info() {
204 res.command = Some(lsp_types::Command {
205 title: "triggerParameterHints".into(),
206 command: "editor.action.triggerParameterHints".into(),
211 res.insert_text_format = Some(insert_text_format(completion_item.insert_text_format()));
216 pub(crate) fn signature_information(
217 signature: FunctionSignature,
219 ) -> lsp_types::SignatureInformation {
220 let (label, documentation, params) = if concise {
221 let mut params = signature.parameters;
222 if signature.has_self_param {
225 (params.join(", "), None, params)
227 (signature.to_string(), signature.doc.map(documentation), signature.parameters)
230 let parameters: Vec<lsp_types::ParameterInformation> = params
232 .map(|param| lsp_types::ParameterInformation {
233 label: lsp_types::ParameterLabel::Simple(param),
238 lsp_types::SignatureInformation { label, documentation, parameters: Some(parameters) }
241 pub(crate) fn inlay_int(line_index: &LineIndex, inlay_hint: InlayHint) -> lsp_ext::InlayHint {
243 label: inlay_hint.label.to_string(),
244 range: range(line_index, inlay_hint.range),
245 kind: match inlay_hint.kind {
246 InlayKind::ParameterHint => lsp_ext::InlayKind::ParameterHint,
247 InlayKind::TypeHint => lsp_ext::InlayKind::TypeHint,
248 InlayKind::ChainingHint => lsp_ext::InlayKind::ChainingHint,
253 pub(crate) fn semantic_tokens(
255 line_index: &LineIndex,
256 highlights: Vec<HighlightedRange>,
257 ) -> lsp_types::SemanticTokens {
258 let mut builder = semantic_tokens::SemanticTokensBuilder::default();
260 for highlight_range in highlights {
261 let (type_, mods) = semantic_token_type_and_modifiers(highlight_range.highlight);
262 let token_index = semantic_tokens::type_index(type_);
263 let modifier_bitset = mods.0;
265 for mut text_range in line_index.lines(highlight_range.range) {
266 if text[text_range].ends_with('\n') {
268 TextRange::new(text_range.start(), text_range.end() - TextSize::of('\n'));
270 let range = range(&line_index, text_range);
271 builder.push(range, token_index, modifier_bitset);
278 fn semantic_token_type_and_modifiers(
279 highlight: Highlight,
280 ) -> (lsp_types::SemanticTokenType, semantic_tokens::ModifierSet) {
281 let mut mods = semantic_tokens::ModifierSet::default();
282 let type_ = match highlight.tag {
283 HighlightTag::Struct => lsp_types::SemanticTokenType::STRUCT,
284 HighlightTag::Enum => lsp_types::SemanticTokenType::ENUM,
285 HighlightTag::Union => semantic_tokens::UNION,
286 HighlightTag::TypeAlias => semantic_tokens::TYPE_ALIAS,
287 HighlightTag::Trait => lsp_types::SemanticTokenType::INTERFACE,
288 HighlightTag::BuiltinType => semantic_tokens::BUILTIN_TYPE,
289 HighlightTag::SelfKeyword => semantic_tokens::SELF_KEYWORD,
290 HighlightTag::SelfType => lsp_types::SemanticTokenType::TYPE,
291 HighlightTag::Field => lsp_types::SemanticTokenType::PROPERTY,
292 HighlightTag::Function => lsp_types::SemanticTokenType::FUNCTION,
293 HighlightTag::Module => lsp_types::SemanticTokenType::NAMESPACE,
294 HighlightTag::Constant => {
295 mods |= semantic_tokens::CONSTANT;
296 mods |= lsp_types::SemanticTokenModifier::STATIC;
297 lsp_types::SemanticTokenType::VARIABLE
299 HighlightTag::Static => {
300 mods |= lsp_types::SemanticTokenModifier::STATIC;
301 lsp_types::SemanticTokenType::VARIABLE
303 HighlightTag::EnumVariant => semantic_tokens::ENUM_MEMBER,
304 HighlightTag::Macro => lsp_types::SemanticTokenType::MACRO,
305 HighlightTag::Local => lsp_types::SemanticTokenType::VARIABLE,
306 HighlightTag::TypeParam => lsp_types::SemanticTokenType::TYPE_PARAMETER,
307 HighlightTag::Lifetime => semantic_tokens::LIFETIME,
308 HighlightTag::ByteLiteral | HighlightTag::NumericLiteral => {
309 lsp_types::SemanticTokenType::NUMBER
311 HighlightTag::BoolLiteral => semantic_tokens::BOOLEAN,
312 HighlightTag::CharLiteral | HighlightTag::StringLiteral => {
313 lsp_types::SemanticTokenType::STRING
315 HighlightTag::Comment => lsp_types::SemanticTokenType::COMMENT,
316 HighlightTag::Attribute => semantic_tokens::ATTRIBUTE,
317 HighlightTag::Keyword => lsp_types::SemanticTokenType::KEYWORD,
318 HighlightTag::UnresolvedReference => semantic_tokens::UNRESOLVED_REFERENCE,
319 HighlightTag::FormatSpecifier => semantic_tokens::FORMAT_SPECIFIER,
322 for modifier in highlight.modifiers.iter() {
323 let modifier = match modifier {
324 HighlightModifier::Attribute => semantic_tokens::ATTRIBUTE_MODIFIER,
325 HighlightModifier::Definition => lsp_types::SemanticTokenModifier::DECLARATION,
326 HighlightModifier::ControlFlow => semantic_tokens::CONTROL_FLOW,
327 HighlightModifier::Mutable => semantic_tokens::MUTABLE,
328 HighlightModifier::Unsafe => semantic_tokens::UNSAFE,
336 pub(crate) fn folding_range(
338 line_index: &LineIndex,
339 line_folding_only: bool,
341 ) -> lsp_types::FoldingRange {
342 let kind = match fold.kind {
343 FoldKind::Comment => Some(lsp_types::FoldingRangeKind::Comment),
344 FoldKind::Imports => Some(lsp_types::FoldingRangeKind::Imports),
345 FoldKind::Mods | FoldKind::Block => None,
348 let range = range(line_index, fold.range);
350 if line_folding_only {
351 // Clients with line_folding_only == true (such as VSCode) will fold the whole end line
352 // even if it contains text not in the folding range. To prevent that we exclude
353 // range.end.line from the folding region if there is more text after range.end
355 let has_more_text_on_end_line = text[TextRange::new(fold.range.end(), TextSize::of(text))]
357 .take_while(|it| *it != '\n')
358 .any(|it| !it.is_whitespace());
360 let end_line = if has_more_text_on_end_line {
361 range.end.line.saturating_sub(1)
366 lsp_types::FoldingRange {
367 start_line: range.start.line,
368 start_character: None,
374 lsp_types::FoldingRange {
375 start_line: range.start.line,
376 start_character: Some(range.start.character),
377 end_line: range.end.line,
378 end_character: Some(range.end.character),
384 pub(crate) fn url(world: &WorldSnapshot, file_id: FileId) -> Result<lsp_types::Url> {
385 world.file_id_to_uri(file_id)
388 pub(crate) fn versioned_text_document_identifier(
389 world: &WorldSnapshot,
391 version: Option<i64>,
392 ) -> Result<lsp_types::VersionedTextDocumentIdentifier> {
393 let res = lsp_types::VersionedTextDocumentIdentifier { uri: url(world, file_id)?, version };
397 pub(crate) fn location(world: &WorldSnapshot, frange: FileRange) -> Result<lsp_types::Location> {
398 let url = url(world, frange.file_id)?;
399 let line_index = world.analysis().file_line_index(frange.file_id)?;
400 let range = range(&line_index, frange.range);
401 let loc = lsp_types::Location::new(url, range);
405 pub(crate) fn location_link(
406 world: &WorldSnapshot,
407 src: Option<FileRange>,
408 target: NavigationTarget,
409 ) -> Result<lsp_types::LocationLink> {
410 let origin_selection_range = match src {
412 let line_index = world.analysis().file_line_index(src.file_id)?;
413 let range = range(&line_index, src.range);
418 let (target_uri, target_range, target_selection_range) = location_info(world, target)?;
419 let res = lsp_types::LocationLink {
420 origin_selection_range,
423 target_selection_range,
429 world: &WorldSnapshot,
430 target: NavigationTarget,
431 ) -> Result<(lsp_types::Url, lsp_types::Range, lsp_types::Range)> {
432 let line_index = world.analysis().file_line_index(target.file_id())?;
434 let target_uri = url(world, target.file_id())?;
435 let target_range = range(&line_index, target.full_range());
436 let target_selection_range =
437 target.focus_range().map(|it| range(&line_index, it)).unwrap_or(target_range);
438 Ok((target_uri, target_range, target_selection_range))
441 pub(crate) fn goto_definition_response(
442 world: &WorldSnapshot,
443 src: Option<FileRange>,
444 targets: Vec<NavigationTarget>,
445 ) -> Result<lsp_types::GotoDefinitionResponse> {
446 if world.config.client_caps.location_link {
449 .map(|nav| location_link(world, src, nav))
450 .collect::<Result<Vec<_>>>()?;
453 let locations = targets
459 file_id: nav.file_id(),
460 range: nav.focus_range().unwrap_or(nav.range()),
464 .collect::<Result<Vec<_>>>()?;
469 pub(crate) fn snippet_text_document_edit(
470 world: &WorldSnapshot,
472 source_file_edit: SourceFileEdit,
473 ) -> Result<lsp_ext::SnippetTextDocumentEdit> {
474 let text_document = versioned_text_document_identifier(world, source_file_edit.file_id, None)?;
475 let line_index = world.analysis().file_line_index(source_file_edit.file_id)?;
476 let line_endings = world.file_line_endings(source_file_edit.file_id);
477 let edits = source_file_edit
480 .map(|it| snippet_text_edit(&line_index, line_endings, is_snippet, it))
482 Ok(lsp_ext::SnippetTextDocumentEdit { text_document, edits })
485 pub(crate) fn resource_op(
486 world: &WorldSnapshot,
487 file_system_edit: FileSystemEdit,
488 ) -> Result<lsp_types::ResourceOp> {
489 let res = match file_system_edit {
490 FileSystemEdit::CreateFile { source_root, path } => {
491 let uri = world.path_to_uri(source_root, &path)?;
492 lsp_types::ResourceOp::Create(lsp_types::CreateFile { uri, options: None })
494 FileSystemEdit::MoveFile { src, dst_source_root, dst_path } => {
495 let old_uri = world.file_id_to_uri(src)?;
496 let new_uri = world.path_to_uri(dst_source_root, &dst_path)?;
497 lsp_types::ResourceOp::Rename(lsp_types::RenameFile { old_uri, new_uri, options: None })
503 pub(crate) fn snippet_workspace_edit(
504 world: &WorldSnapshot,
505 source_change: SourceChange,
506 ) -> Result<lsp_ext::SnippetWorkspaceEdit> {
507 let mut document_changes: Vec<lsp_ext::SnippetDocumentChangeOperation> = Vec::new();
508 for op in source_change.file_system_edits {
509 let op = resource_op(&world, op)?;
510 document_changes.push(lsp_ext::SnippetDocumentChangeOperation::Op(op));
512 for edit in source_change.source_file_edits {
513 let edit = snippet_text_document_edit(&world, source_change.is_snippet, edit)?;
514 document_changes.push(lsp_ext::SnippetDocumentChangeOperation::Edit(edit));
517 lsp_ext::SnippetWorkspaceEdit { changes: None, document_changes: Some(document_changes) };
521 pub(crate) fn workspace_edit(
522 world: &WorldSnapshot,
523 source_change: SourceChange,
524 ) -> Result<lsp_types::WorkspaceEdit> {
525 assert!(!source_change.is_snippet);
526 snippet_workspace_edit(world, source_change).map(|it| it.into())
529 impl From<lsp_ext::SnippetWorkspaceEdit> for lsp_types::WorkspaceEdit {
530 fn from(snippet_workspace_edit: lsp_ext::SnippetWorkspaceEdit) -> lsp_types::WorkspaceEdit {
531 lsp_types::WorkspaceEdit {
533 document_changes: snippet_workspace_edit.document_changes.map(|changes| {
534 lsp_types::DocumentChanges::Operations(
537 .map(|change| match change {
538 lsp_ext::SnippetDocumentChangeOperation::Op(op) => {
539 lsp_types::DocumentChangeOperation::Op(op)
541 lsp_ext::SnippetDocumentChangeOperation::Edit(edit) => {
542 lsp_types::DocumentChangeOperation::Edit(
543 lsp_types::TextDocumentEdit {
544 text_document: edit.text_document,
548 .map(|edit| lsp_types::TextEdit {
550 new_text: edit.new_text,
564 pub fn call_hierarchy_item(
565 world: &WorldSnapshot,
566 target: NavigationTarget,
567 ) -> Result<lsp_types::CallHierarchyItem> {
568 let name = target.name().to_string();
569 let detail = target.description().map(|it| it.to_string());
570 let kind = symbol_kind(target.kind());
571 let (uri, range, selection_range) = location_info(world, target)?;
572 Ok(lsp_types::CallHierarchyItem { name, kind, tags: None, detail, uri, range, selection_range })
577 use test_utils::extract_ranges;
582 fn conv_fold_line_folding_only_fixup() {
583 let text = r#"<fold>mod a;
590 }</fold> else <fold>{
595 let (ranges, text) = extract_ranges(text, "fold");
596 assert_eq!(ranges.len(), 4);
598 Fold { range: ranges[0], kind: FoldKind::Mods },
599 Fold { range: ranges[1], kind: FoldKind::Block },
600 Fold { range: ranges[2], kind: FoldKind::Block },
601 Fold { range: ranges[3], kind: FoldKind::Block },
604 let line_index = LineIndex::new(&text);
605 let converted: Vec<lsp_types::FoldingRange> =
606 folds.into_iter().map(|it| folding_range(&text, &line_index, true, it)).collect();
608 let expected_lines = [(0, 2), (4, 10), (5, 6), (7, 9)];
609 assert_eq!(converted.len(), expected_lines.len());
610 for (folding_range, (start_line, end_line)) in converted.iter().zip(expected_lines.iter()) {
611 assert_eq!(folding_range.start_line, *start_line);
612 assert_eq!(folding_range.start_character, None);
613 assert_eq!(folding_range.end_line, *end_line);
614 assert_eq!(folding_range.end_character, None);
619 pub(crate) fn code_action(world: &WorldSnapshot, assist: Assist) -> Result<lsp_ext::CodeAction> {
620 let res = lsp_ext::CodeAction {
622 group: if world.config.client_caps.code_action_group { assist.group_label } else { None },
623 kind: Some(String::new()),
624 edit: Some(snippet_workspace_edit(world, assist.source_change)?),