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 completion_item(
139 line_index: &LineIndex,
140 line_endings: LineEndings,
141 completion_item: CompletionItem,
142 ) -> lsp_types::CompletionItem {
143 let mut additional_text_edits = Vec::new();
144 let mut text_edit = None;
145 // LSP does not allow arbitrary edits in completion, so we have to do a
146 // non-trivial mapping here.
147 let source_range = completion_item.source_range();
148 for indel in completion_item.text_edit().iter() {
149 if indel.delete.contains_range(source_range) {
150 text_edit = Some(if indel.delete == source_range {
151 self::text_edit(line_index, line_endings, indel.clone())
153 assert!(source_range.end() == indel.delete.end());
154 let range1 = TextRange::new(indel.delete.start(), source_range.start());
155 let range2 = source_range;
156 let indel1 = Indel::replace(range1, String::new());
157 let indel2 = Indel::replace(range2, indel.insert.clone());
158 additional_text_edits.push(self::text_edit(line_index, line_endings, indel1));
159 self::text_edit(line_index, line_endings, indel2)
162 assert!(source_range.intersect(indel.delete).is_none());
163 let text_edit = self::text_edit(line_index, line_endings, indel.clone());
164 additional_text_edits.push(text_edit);
167 let text_edit = text_edit.unwrap();
169 let mut res = lsp_types::CompletionItem {
170 label: completion_item.label().to_string(),
171 detail: completion_item.detail().map(|it| it.to_string()),
172 filter_text: Some(completion_item.lookup().to_string()),
173 kind: completion_item.kind().map(completion_item_kind),
174 text_edit: Some(text_edit.into()),
175 additional_text_edits: Some(additional_text_edits),
176 documentation: completion_item.documentation().map(documentation),
177 deprecated: Some(completion_item.deprecated()),
181 if completion_item.score().is_some() {
182 res.preselect = Some(true);
183 // HACK: sort preselect items first
184 res.sort_text = Some(format!(" {}", completion_item.label()));
187 if completion_item.deprecated() {
188 res.tags = Some(vec![lsp_types::CompletionItemTag::Deprecated])
191 if completion_item.trigger_call_info() {
192 res.command = Some(lsp_types::Command {
193 title: "triggerParameterHints".into(),
194 command: "editor.action.triggerParameterHints".into(),
199 res.insert_text_format = Some(insert_text_format(completion_item.insert_text_format()));
204 pub(crate) fn signature_information(
205 signature: FunctionSignature,
207 ) -> lsp_types::SignatureInformation {
208 let (label, documentation, params) = if concise {
209 let mut params = signature.parameters;
210 if signature.has_self_param {
213 (params.join(", "), None, params)
215 (signature.to_string(), signature.doc.map(documentation), signature.parameters)
218 let parameters: Vec<lsp_types::ParameterInformation> = params
220 .map(|param| lsp_types::ParameterInformation {
221 label: lsp_types::ParameterLabel::Simple(param),
226 lsp_types::SignatureInformation { label, documentation, parameters: Some(parameters) }
229 pub(crate) fn inlay_int(line_index: &LineIndex, inlay_hint: InlayHint) -> lsp_ext::InlayHint {
231 label: inlay_hint.label.to_string(),
232 range: range(line_index, inlay_hint.range),
233 kind: match inlay_hint.kind {
234 InlayKind::ParameterHint => lsp_ext::InlayKind::ParameterHint,
235 InlayKind::TypeHint => lsp_ext::InlayKind::TypeHint,
236 InlayKind::ChainingHint => lsp_ext::InlayKind::ChainingHint,
241 pub(crate) fn semantic_tokens(
243 line_index: &LineIndex,
244 highlights: Vec<HighlightedRange>,
245 ) -> lsp_types::SemanticTokens {
246 let mut builder = semantic_tokens::SemanticTokensBuilder::default();
248 for highlight_range in highlights {
249 let (type_, mods) = semantic_token_type_and_modifiers(highlight_range.highlight);
250 let token_index = semantic_tokens::type_index(type_);
251 let modifier_bitset = mods.0;
253 for mut text_range in line_index.lines(highlight_range.range) {
254 if text[text_range].ends_with('\n') {
256 TextRange::new(text_range.start(), text_range.end() - TextSize::of('\n'));
258 let range = range(&line_index, text_range);
259 builder.push(range, token_index, modifier_bitset);
266 fn semantic_token_type_and_modifiers(
267 highlight: Highlight,
268 ) -> (lsp_types::SemanticTokenType, semantic_tokens::ModifierSet) {
269 let mut mods = semantic_tokens::ModifierSet::default();
270 let type_ = match highlight.tag {
271 HighlightTag::Struct => lsp_types::SemanticTokenType::STRUCT,
272 HighlightTag::Enum => lsp_types::SemanticTokenType::ENUM,
273 HighlightTag::Union => semantic_tokens::UNION,
274 HighlightTag::TypeAlias => semantic_tokens::TYPE_ALIAS,
275 HighlightTag::Trait => lsp_types::SemanticTokenType::INTERFACE,
276 HighlightTag::BuiltinType => semantic_tokens::BUILTIN_TYPE,
277 HighlightTag::SelfType => lsp_types::SemanticTokenType::TYPE,
278 HighlightTag::Field => lsp_types::SemanticTokenType::PROPERTY,
279 HighlightTag::Function => lsp_types::SemanticTokenType::FUNCTION,
280 HighlightTag::Module => lsp_types::SemanticTokenType::NAMESPACE,
281 HighlightTag::Constant => {
282 mods |= semantic_tokens::CONSTANT;
283 mods |= lsp_types::SemanticTokenModifier::STATIC;
284 lsp_types::SemanticTokenType::VARIABLE
286 HighlightTag::Static => {
287 mods |= lsp_types::SemanticTokenModifier::STATIC;
288 lsp_types::SemanticTokenType::VARIABLE
290 HighlightTag::EnumVariant => semantic_tokens::ENUM_MEMBER,
291 HighlightTag::Macro => lsp_types::SemanticTokenType::MACRO,
292 HighlightTag::Local => lsp_types::SemanticTokenType::VARIABLE,
293 HighlightTag::TypeParam => lsp_types::SemanticTokenType::TYPE_PARAMETER,
294 HighlightTag::Lifetime => semantic_tokens::LIFETIME,
295 HighlightTag::ByteLiteral | HighlightTag::NumericLiteral => {
296 lsp_types::SemanticTokenType::NUMBER
298 HighlightTag::CharLiteral | HighlightTag::StringLiteral => {
299 lsp_types::SemanticTokenType::STRING
301 HighlightTag::Comment => lsp_types::SemanticTokenType::COMMENT,
302 HighlightTag::Attribute => semantic_tokens::ATTRIBUTE,
303 HighlightTag::Keyword => lsp_types::SemanticTokenType::KEYWORD,
304 HighlightTag::UnresolvedReference => semantic_tokens::UNRESOLVED_REFERENCE,
305 HighlightTag::FormatSpecifier => semantic_tokens::FORMAT_SPECIFIER,
308 for modifier in highlight.modifiers.iter() {
309 let modifier = match modifier {
310 HighlightModifier::Attribute => semantic_tokens::ATTRIBUTE_MODIFIER,
311 HighlightModifier::Definition => lsp_types::SemanticTokenModifier::DECLARATION,
312 HighlightModifier::ControlFlow => semantic_tokens::CONTROL_FLOW,
313 HighlightModifier::Mutable => semantic_tokens::MUTABLE,
314 HighlightModifier::Unsafe => semantic_tokens::UNSAFE,
322 pub(crate) fn folding_range(
324 line_index: &LineIndex,
325 line_folding_only: bool,
327 ) -> lsp_types::FoldingRange {
328 let kind = match fold.kind {
329 FoldKind::Comment => Some(lsp_types::FoldingRangeKind::Comment),
330 FoldKind::Imports => Some(lsp_types::FoldingRangeKind::Imports),
331 FoldKind::Mods | FoldKind::Block => None,
334 let range = range(line_index, fold.range);
336 if line_folding_only {
337 // Clients with line_folding_only == true (such as VSCode) will fold the whole end line
338 // even if it contains text not in the folding range. To prevent that we exclude
339 // range.end.line from the folding region if there is more text after range.end
341 let has_more_text_on_end_line = text[TextRange::new(fold.range.end(), TextSize::of(text))]
343 .take_while(|it| *it != '\n')
344 .any(|it| !it.is_whitespace());
346 let end_line = if has_more_text_on_end_line {
347 range.end.line.saturating_sub(1)
352 lsp_types::FoldingRange {
353 start_line: range.start.line,
354 start_character: None,
360 lsp_types::FoldingRange {
361 start_line: range.start.line,
362 start_character: Some(range.start.character),
363 end_line: range.end.line,
364 end_character: Some(range.end.character),
370 pub(crate) fn url(world: &WorldSnapshot, file_id: FileId) -> Result<lsp_types::Url> {
371 world.file_id_to_uri(file_id)
374 pub(crate) fn versioned_text_document_identifier(
375 world: &WorldSnapshot,
377 version: Option<i64>,
378 ) -> Result<lsp_types::VersionedTextDocumentIdentifier> {
379 let res = lsp_types::VersionedTextDocumentIdentifier { uri: url(world, file_id)?, version };
383 pub(crate) fn location(world: &WorldSnapshot, frange: FileRange) -> Result<lsp_types::Location> {
384 let url = url(world, frange.file_id)?;
385 let line_index = world.analysis().file_line_index(frange.file_id)?;
386 let range = range(&line_index, frange.range);
387 let loc = lsp_types::Location::new(url, range);
391 pub(crate) fn location_link(
392 world: &WorldSnapshot,
394 target: NavigationTarget,
395 ) -> Result<lsp_types::LocationLink> {
396 let src_location = location(world, src)?;
397 let (target_uri, target_range, target_selection_range) = location_info(world, target)?;
398 let res = lsp_types::LocationLink {
399 origin_selection_range: Some(src_location.range),
402 target_selection_range,
408 world: &WorldSnapshot,
409 target: NavigationTarget,
410 ) -> Result<(lsp_types::Url, lsp_types::Range, lsp_types::Range)> {
411 let line_index = world.analysis().file_line_index(target.file_id())?;
413 let target_uri = url(world, target.file_id())?;
414 let target_range = range(&line_index, target.full_range());
415 let target_selection_range =
416 target.focus_range().map(|it| range(&line_index, it)).unwrap_or(target_range);
417 Ok((target_uri, target_range, target_selection_range))
420 pub(crate) fn goto_definition_response(
421 world: &WorldSnapshot,
423 targets: Vec<NavigationTarget>,
424 ) -> Result<lsp_types::GotoDefinitionResponse> {
425 if world.config.client_caps.location_link {
428 .map(|nav| location_link(world, src, nav))
429 .collect::<Result<Vec<_>>>()?;
432 let locations = targets
438 file_id: nav.file_id(),
439 range: nav.focus_range().unwrap_or(nav.range()),
443 .collect::<Result<Vec<_>>>()?;
448 pub(crate) fn snippet_text_document_edit(
449 world: &WorldSnapshot,
451 source_file_edit: SourceFileEdit,
452 ) -> Result<lsp_ext::SnippetTextDocumentEdit> {
453 let text_document = versioned_text_document_identifier(world, source_file_edit.file_id, None)?;
454 let line_index = world.analysis().file_line_index(source_file_edit.file_id)?;
455 let line_endings = world.file_line_endings(source_file_edit.file_id);
456 let edits = source_file_edit
459 .map(|it| snippet_text_edit(&line_index, line_endings, is_snippet, it))
461 Ok(lsp_ext::SnippetTextDocumentEdit { text_document, edits })
464 pub(crate) fn resource_op(
465 world: &WorldSnapshot,
466 file_system_edit: FileSystemEdit,
467 ) -> Result<lsp_types::ResourceOp> {
468 let res = match file_system_edit {
469 FileSystemEdit::CreateFile { source_root, path } => {
470 let uri = world.path_to_uri(source_root, &path)?;
471 lsp_types::ResourceOp::Create(lsp_types::CreateFile { uri, options: None })
473 FileSystemEdit::MoveFile { src, dst_source_root, dst_path } => {
474 let old_uri = world.file_id_to_uri(src)?;
475 let new_uri = world.path_to_uri(dst_source_root, &dst_path)?;
476 lsp_types::ResourceOp::Rename(lsp_types::RenameFile { old_uri, new_uri, options: None })
482 pub(crate) fn snippet_workspace_edit(
483 world: &WorldSnapshot,
484 source_change: SourceChange,
485 ) -> Result<lsp_ext::SnippetWorkspaceEdit> {
486 let mut document_changes: Vec<lsp_ext::SnippetDocumentChangeOperation> = Vec::new();
487 for op in source_change.file_system_edits {
488 let op = resource_op(&world, op)?;
489 document_changes.push(lsp_ext::SnippetDocumentChangeOperation::Op(op));
491 for edit in source_change.source_file_edits {
492 let edit = snippet_text_document_edit(&world, source_change.is_snippet, edit)?;
493 document_changes.push(lsp_ext::SnippetDocumentChangeOperation::Edit(edit));
496 lsp_ext::SnippetWorkspaceEdit { changes: None, document_changes: Some(document_changes) };
500 pub(crate) fn workspace_edit(
501 world: &WorldSnapshot,
502 source_change: SourceChange,
503 ) -> Result<lsp_types::WorkspaceEdit> {
504 assert!(!source_change.is_snippet);
505 snippet_workspace_edit(world, source_change).map(|it| it.into())
508 impl From<lsp_ext::SnippetWorkspaceEdit> for lsp_types::WorkspaceEdit {
509 fn from(snippet_workspace_edit: lsp_ext::SnippetWorkspaceEdit) -> lsp_types::WorkspaceEdit {
510 lsp_types::WorkspaceEdit {
512 document_changes: snippet_workspace_edit.document_changes.map(|changes| {
513 lsp_types::DocumentChanges::Operations(
516 .map(|change| match change {
517 lsp_ext::SnippetDocumentChangeOperation::Op(op) => {
518 lsp_types::DocumentChangeOperation::Op(op)
520 lsp_ext::SnippetDocumentChangeOperation::Edit(edit) => {
521 lsp_types::DocumentChangeOperation::Edit(
522 lsp_types::TextDocumentEdit {
523 text_document: edit.text_document,
527 .map(|edit| lsp_types::TextEdit {
529 new_text: edit.new_text,
543 pub fn call_hierarchy_item(
544 world: &WorldSnapshot,
545 target: NavigationTarget,
546 ) -> Result<lsp_types::CallHierarchyItem> {
547 let name = target.name().to_string();
548 let detail = target.description().map(|it| it.to_string());
549 let kind = symbol_kind(target.kind());
550 let (uri, range, selection_range) = location_info(world, target)?;
551 Ok(lsp_types::CallHierarchyItem { name, kind, tags: None, detail, uri, range, selection_range })
556 use test_utils::extract_ranges;
561 fn conv_fold_line_folding_only_fixup() {
562 let text = r#"<fold>mod a;
569 }</fold> else <fold>{
574 let (ranges, text) = extract_ranges(text, "fold");
575 assert_eq!(ranges.len(), 4);
577 Fold { range: ranges[0], kind: FoldKind::Mods },
578 Fold { range: ranges[1], kind: FoldKind::Block },
579 Fold { range: ranges[2], kind: FoldKind::Block },
580 Fold { range: ranges[3], kind: FoldKind::Block },
583 let line_index = LineIndex::new(&text);
584 let converted: Vec<lsp_types::FoldingRange> =
585 folds.into_iter().map(|it| folding_range(&text, &line_index, true, it)).collect();
587 let expected_lines = [(0, 2), (4, 10), (5, 6), (7, 9)];
588 assert_eq!(converted.len(), expected_lines.len());
589 for (folding_range, (start_line, end_line)) in converted.iter().zip(expected_lines.iter()) {
590 assert_eq!(folding_range.start_line, *start_line);
591 assert_eq!(folding_range.start_character, None);
592 assert_eq!(folding_range.end_line, *end_line);
593 assert_eq!(folding_range.end_character, None);
598 pub(crate) fn code_action(world: &WorldSnapshot, assist: Assist) -> Result<lsp_ext::CodeAction> {
599 let res = lsp_ext::CodeAction {
601 group: if world.config.client_caps.code_action_group { assist.group_label } else { None },
602 kind: Some(String::new()),
603 edit: Some(snippet_workspace_edit(world, assist.source_change)?),