Auto merge of #1295 - vhakulinen:hover-range, r=Xanewok

Implement range for hover response

Implement optional `range` property for `textDocument/hover` response: https://microsoft.github.io/language-server-protocol/specification#textDocument_hover

Author: bors

src/actions/hover.rs

@@ -18,13 +18,20 @@ use crate::server::ResponseError;
 use home;
 use racer;
 use rls_analysis::{Def, DefKind};
-use rls_span::{Column, Row, Span, ZeroIndexed};
+use rls_span::{Column, Range, Row, Span, ZeroIndexed};
 use rls_vfs::{self as vfs, Vfs};
 use rustfmt_nightly::NewlineStyle;
+use serde_derive::{Deserialize, Serialize};
 
 use log::*;
 use std::path::{Path, PathBuf};
 
+#[derive(Debug, Deserialize, Serialize, PartialEq, Eq)]
+pub struct Tooltip {
+    pub contents: Vec<MarkedString>,
+    pub range: Range<ZeroIndexed>,
+}
+
 /// Cleanup documentation code blocks. The `docs` are expected to have
 /// the preceding `///` or `//!` prefixes already trimmed away. Rust code
 /// blocks will ignore lines beginning with `#`. Code block annotations
@@ -878,7 +885,7 @@ fn format_method(rustfmt: Rustfmt, fmt_config: &FmtConfig, the_type: String) ->
 pub fn tooltip(
     ctx: &InitActionContext,
     params: &TextDocumentPositionParams,
-) -> Result<Vec<MarkedString>, ResponseError> {
+) -> Result<Tooltip, ResponseError> {
     let analysis = &ctx.analysis;
 
     let hover_file_path = parse_file_path!(&params.text_document.uri, "hover")?;
@@ -965,7 +972,7 @@ pub fn tooltip(
         Vec::default()
     };
     debug!("tooltip: contents.len: {}", contents.len());
-    Ok(contents)
+    Ok(Tooltip{ contents, range: hover_span.range })
 }
 
 #[cfg(test)]

src/actions/requests.rs

@@ -146,8 +146,8 @@ impl RequestAction for Hover {
         let tooltip = hover::tooltip(&ctx, &params)?;
 
         Ok(lsp_data::Hover {
-            contents: HoverContents::Array(tooltip),
-            range: None, // TODO: maybe add?
+            contents: HoverContents::Array(tooltip.contents),
+            range: Some(ls_util::rls_to_range(tooltip.range)),
         })
     }
 }

tests/tooltip.rs

@@ -103,7 +103,9 @@ impl Test {
         let doc_id = TextDocumentIdentifier::new(url);
         let position = Position::new(self.line - 1u64, self.col - 1u64);
         let params = TextDocumentPositionParams::new(doc_id, position);
-        let result = tooltip(&ctx, &params).map_err(|e| format!("tooltip error: {:?}", e));
+        let result = tooltip(&ctx, &params)
+            .map_err(|e| format!("tooltip error: {:?}", e))
+            .map(|v| v.contents);
 
         TestResult {
             test: self.clone(),