feat: Completed the client side implementation of rust-analyzer/hoverRange

alexfertel · alexfertel · commit 18644720eb80 · 2021-07-27T18:29:22.000-04:00
diff --git a/crates/rust-analyzer/src/handlers.rs b/crates/rust-analyzer/src/handlers.rs
@@ -867,28 +867,40 @@ pub(crate) fn handle_signature_help(
 
 pub(crate) fn handle_hover(
     snap: GlobalStateSnapshot,
-    params: lsp_ext::HoverParams,
+    params: lsp_types::HoverParams,
 ) -> Result<Option<lsp_ext::Hover>> {
     let _p = profile::span("handle_hover");
+    let position = from_proto::file_position(&snap, params.text_document_position_params)?;
+    let info = match snap.analysis.hover(&snap.config.hover(), position)? {
+        None => return Ok(None),
+        Some(info) => info,
+    };
+
+    let line_index = snap.file_line_index(position.file_id)?;
+    let range = to_proto::range(&line_index, info.range);
+    let hover = lsp_ext::Hover {
+        hover: lsp_types::Hover {
+            contents: HoverContents::Markup(to_proto::markup_content(info.info.markup)),
+            range: Some(range),
+        },
+        actions: prepare_hover_actions(&snap, &info.info.actions),
+    };
+
+    Ok(Some(hover))
+}
+
+pub(crate) fn handle_hover_range(
+    snap: GlobalStateSnapshot,
+    params: lsp_ext::HoverRangeParams,
+) -> Result<Option<lsp_ext::Hover>> {
+    let _p = profile::span("handle_hover_range");
     let file_id = from_proto::file_id(&snap, &params.text_document.uri)?;
     let range = from_proto::file_range(&snap, params.text_document, params.range)?;
 
-    let info = if range.range.is_empty() {
-        // It's a hover over a position
-        match snap
-            .analysis
-            .hover(&snap.config.hover(), FilePosition { file_id, offset: range.range.start() })?
-        {
-            None => return Ok(None),
-            Some(info) => info,
-        }
-    } else {
-        // It's a hover over a range
-        log::info!("Triggered range hover");
-        match snap.analysis.hover_range(&snap.config.hover(), range)? {
-            None => return Ok(None),
-            Some(info) => info,
-        }
+    log::info!("Triggered range hover");
+    let info = match snap.analysis.hover_range(&snap.config.hover(), range)? {
+        None => return Ok(None),
+        Some(info) => info,
     };
 
     let line_index = snap.file_line_index(range.file_id)?;
diff --git a/crates/rust-analyzer/src/lsp_ext.rs b/crates/rust-analyzer/src/lsp_ext.rs
@@ -376,14 +376,22 @@ pub struct SnippetTextEdit {
 pub enum HoverRequest {}
 
 impl Request for HoverRequest {
-    type Params = HoverParams;
+    type Params = lsp_types::HoverParams;
     type Result = Option<Hover>;
     const METHOD: &'static str = "textDocument/hover";
 }
 
+pub enum HoverRangeRequest {}
+
+impl Request for HoverRangeRequest {
+    type Params = HoverRangeParams;
+    type Result = Option<Hover>;
+    const METHOD: &'static str = "rust-analyzer/hoverRange";
+}
+
 #[derive(Deserialize, Serialize, Debug)]
 #[serde(rename_all = "camelCase")]
-pub struct HoverParams {
+pub struct HoverRangeParams {
     pub text_document: TextDocumentIdentifier,
     pub range: Range,
 }
diff --git a/crates/rust-analyzer/src/main_loop.rs b/crates/rust-analyzer/src/main_loop.rs
@@ -542,6 +542,7 @@ impl GlobalState {
             .on::<lsp_ext::CodeActionRequest>(handlers::handle_code_action)
             .on::<lsp_ext::CodeActionResolveRequest>(handlers::handle_code_action_resolve)
             .on::<lsp_ext::HoverRequest>(handlers::handle_hover)
+            .on::<lsp_ext::HoverRangeRequest>(handlers::handle_hover_range)
             .on::<lsp_ext::ExternalDocs>(handlers::handle_open_docs)
             .on::<lsp_ext::OpenCargoToml>(handlers::handle_open_cargo_toml)
             .on::<lsp_ext::MoveItem>(handlers::handle_move_item)
diff --git a/editors/code/src/client.ts b/editors/code/src/client.ts
@@ -56,21 +56,67 @@ export function createClient(serverPath: string, workspace: Workspace, extraEnv:
         traceOutputChannel,
         middleware: {
             async provideHover(document: vscode.TextDocument, position: vscode.Position, token: vscode.CancellationToken, _next: lc.ProvideHoverSignature) {
-                return client.sendRequest(lc.HoverRequest.type, client.code2ProtocolConverter.asTextDocumentPositionParams(document, position), token).then(
-                    (result) => {
-                        const hover = client.protocol2CodeConverter.asHover(result);
-                        if (hover) {
+                const editor = vscode.window.activeTextEditor;
+                const selection = editor?.selection;
+                return selection?.contains(position)
+                  ? client
+                      .sendRequest(
+                        ra.hoverRange,
+                        {
+                          textDocument:
+                            client.code2ProtocolConverter.asTextDocumentIdentifier(
+                              document
+                            ),
+                          range: client.code2ProtocolConverter.asRange(
+                            editor?.selection
+                          ),
+                        },
+                        token
+                      )
+                      .then(
+                        (result) =>
+                          client.protocol2CodeConverter.asHover(result),
+                        (error) => {
+                          client.handleFailedRequest(
+                            lc.HoverRequest.type,
+                            undefined,
+                            error,
+                            null
+                          );
+                          return Promise.resolve(null);
+                        }
+                      )
+                  : client
+                      .sendRequest(
+                        lc.HoverRequest.type,
+                        client.code2ProtocolConverter.asTextDocumentPositionParams(
+                          document,
+                          position
+                        ),
+                        token
+                      )
+                      .then(
+                        (result) => {
+                          const hover =
+                            client.protocol2CodeConverter.asHover(result);
+                          if (hover) {
                             const actions = (<any>result).actions;
                             if (actions) {
-                                hover.contents.push(renderHoverActions(actions));
+                              hover.contents.push(renderHoverActions(actions));
                             }
+                          }
+                          return hover;
+                        },
+                        (error) => {
+                          client.handleFailedRequest(
+                            lc.HoverRequest.type,
+                            token,
+                            error,
+                            null
+                          );
+                          return Promise.resolve(null);
                         }
-                        return hover;
-                    },
-                    (error) => {
-                        client.handleFailedRequest(lc.HoverRequest.type, token, error, null);
-                        return Promise.resolve(null);
-                    });
+                      );
             },
             // Using custom handling of CodeActions to support action groups and snippet edits.
             // Note that this means we have to re-implement lazy edit resolving ourselves as well.
diff --git a/editors/code/src/commands.ts b/editors/code/src/commands.ts
@@ -116,6 +116,30 @@ export function matchingBrace(ctx: Ctx): Cmd {
     };
 }
 
+export function hoverRange(ctx: Ctx): Cmd {
+    return async () => {
+        const editor = ctx.activeRustEditor;
+        const client = ctx.client;
+        if (!editor || !client) return;
+
+        client
+        .sendRequest(ra.hoverRange, {
+            textDocument: client.code2ProtocolConverter.asTextDocumentIdentifier(
+                editor.document
+            ),
+            range: client.code2ProtocolConverter.asRange(editor.selection),
+        })
+        .then(
+            (result) => client.protocol2CodeConverter.asHover(result),
+            (error) => {
+                client.handleFailedRequest(lc.HoverRequest.type, undefined, error, null);
+                return Promise.resolve(null);
+            }
+        );
+    };
+}
+
+
 export function joinLines(ctx: Ctx): Cmd {
     return async () => {
         const editor = ctx.activeRustEditor;
diff --git a/editors/code/src/lsp_ext.ts b/editors/code/src/lsp_ext.ts
@@ -19,6 +19,13 @@ export const serverStatus = new lc.NotificationType<ServerStatusParams>("experim
 
 export const reloadWorkspace = new lc.RequestType0<null, void>("rust-analyzer/reloadWorkspace");
 
+export const hoverRange = new lc.RequestType<HoverRangeParams, lc.Hover | null, void>("rust-analyzer/hoverRange");
+
+export interface HoverRangeParams {
+    textDocument: lc.TextDocumentIdentifier;
+    range: lc.Range;
+}
+
 export interface SyntaxTreeParams {
     textDocument: lc.TextDocumentIdentifier;
     range: lc.Range | null;
diff --git a/editors/code/src/main.ts b/editors/code/src/main.ts
@@ -118,6 +118,7 @@ async function initCommonContext(context: vscode.ExtensionContext, ctx: Ctx) {
     ctx.registerCommand('reloadWorkspace', commands.reloadWorkspace);
     ctx.registerCommand('matchingBrace', commands.matchingBrace);
     ctx.registerCommand('joinLines', commands.joinLines);
+    ctx.registerCommand('hoverRange', commands.hoverRange);
     ctx.registerCommand('parentModule', commands.parentModule);
     ctx.registerCommand('syntaxTree', commands.syntaxTree);
     ctx.registerCommand('viewHir', commands.viewHir);
