From fb0f49611a6953c1215d35baa8b40390f9fcdb7a Mon Sep 17 00:00:00 2001
From: jtuu <joona.tuukkanen@gmail.com>
Date: Wed, 29 Apr 2020 07:14:21 +0300
Subject: [PATCH] Show instruction documentation on hover over.

---
 FEATURES.md                               |  2 +-
 src/quest_editor/stores/AsmEditorStore.ts | 78 ++++++++++++++++++++++-
 2 files changed, 78 insertions(+), 2 deletions(-)

diff --git a/FEATURES.md b/FEATURES.md
index 0d2b825b..f4ed0e08 100644
--- a/FEATURES.md
+++ b/FEATURES.md
@@ -131,7 +131,7 @@ Features that are in ***bold italics*** are planned but not yet implemented.
     - ***Invalid label references***
     - ***Mark all duplicate labels (the first one is not marked at the moment)***
 - Instruction parameter hints
-- ***Show instruction documentation on hover over***
+- Show instruction documentation on hover over
 - ***Show reserved register usage on hover over***
 - ***When saving, ask user whether to really save when asm contains errors***
 - ***Theme selection***
diff --git a/src/quest_editor/stores/AsmEditorStore.ts b/src/quest_editor/stores/AsmEditorStore.ts
index 6ea9f4f7..f1fb4724 100644
--- a/src/quest_editor/stores/AsmEditorStore.ts
+++ b/src/quest_editor/stores/AsmEditorStore.ts
@@ -1,4 +1,11 @@
-import { editor, languages, MarkerSeverity, MarkerTag, Position } from "monaco-editor";
+import {
+    editor,
+    languages,
+    MarkerSeverity,
+    MarkerTag,
+    Position,
+    IMarkdownString,
+} from "monaco-editor";
 import { AssemblyAnalyser } from "../scripting/AssemblyAnalyser";
 import { Disposer } from "../../core/observable/Disposer";
 import { SimpleUndo } from "../../core/undo/SimpleUndo";
@@ -18,6 +25,7 @@ import CompletionList = languages.CompletionList;
 import IMarkerData = editor.IMarkerData;
 import SignatureHelpResult = languages.SignatureHelpResult;
 import LocationLink = languages.LocationLink;
+import Hover = languages.Hover;
 import IModelContentChange = editor.IModelContentChange;
 
 const assembly_analyser = new AssemblyAnalyser();
@@ -85,6 +93,74 @@ languages.registerDefinitionProvider("psoasm", {
     },
 });
 
+languages.registerHoverProvider("psoasm", {
+    async provideHover(model: ITextModel, position: Position): Promise<Hover | undefined> {
+        const help = await assembly_analyser.provide_signature_help(
+            model.uri,
+            position.lineNumber,
+            position.column,
+        );
+
+        if (!help) {
+            return;
+        }
+
+        const sig = help.signatures[help.activeSignature];
+        const param = sig.parameters[help.activeParameter];
+
+        if (!sig || !sig.documentation) {
+            return;
+        }
+
+        const contents: IMarkdownString[] = [];
+
+        // Instruction signature. Parameter highlighted if possible.
+        if (param && Array.isArray(param.label)) {
+            // TODO: Figure out how to underline this instead of bolding
+            // to make it match the look of the signature help.
+            contents.push({
+                value:
+                    sig.label.slice(0, param.label[0]) +
+                    "__" +
+                    sig.label.slice(param.label[0], param.label[1]) +
+                    "__" +
+                    sig.label.slice(param.label[1]),
+            });
+        } else {
+            contents.push({
+                value: sig.label,
+            });
+        }
+
+        // Put the parameter doc and the instruction doc
+        // in the same string to match the look of the signature help.
+        let doc = "";
+
+        // Parameter doc.
+        if (param && param.documentation) {
+            doc =
+                typeof param.documentation === "string"
+                    ? param.documentation
+                    : param.documentation.value;
+
+            // TODO: Figure out how add an empty line here
+            // to make it match the look of the signature help.
+            doc += "\n\n";
+        }
+
+        // Instruction doc.
+        doc += typeof sig.documentation === "string" ? sig.documentation : sig.documentation.value;
+
+        contents.push({
+            value: doc,
+        });
+
+        return {
+            contents,
+        };
+    },
+});
+
 export class AsmEditorStore extends Store {
     private readonly model_disposer = this.disposable(new Disposer());
     private readonly _model: WritableProperty<ITextModel | undefined> = property(undefined);