crates/rust-analyzer/src/to_proto.rs

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