crates/rust-analyzer/src/to_proto.rs

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