Feature: hover for variables

src/parser/model.ts

@@ -15,6 +15,8 @@ export interface Variable {
     character: number;
     method: Method;
     isGlobal: boolean;
+    comment: string;
+    full: string;
 }
 
 export class Label {

src/parser/parser.ts

@@ -133,6 +133,9 @@ export class Parser {
             }
         }
         for (const filePath of this.documentCache.keys()) {
+            if (filePath === document.uri.path) {
+                continue;
+            }
             for (const method of this.documentCache.get(filePath).methods) {
                 if (method.name.toLowerCase() === name) {
                     return method;
@@ -162,6 +165,9 @@ export class Parser {
             }
         }
         for (const filePath of this.documentCache.keys()) {
+            if (filePath === document.uri.path) {
+                continue;
+            }
             for (const label of this.documentCache.get(filePath).labels) {
                 if (label.name.toLowerCase() === name) {
                     return label;
@@ -170,6 +176,33 @@ export class Parser {
         }
     }
 
+    /**
+     * Returns the first variable whose name matches one in the global document cache.
+     * Searches the provided document before searching all other documents in no particular order.
+     */
+    public static async getVariableByName(
+        document: vscode.TextDocument,
+        name: string,
+    ) {
+        name = name.toLowerCase();
+        for (const variable of this.documentCache.get(document.uri.path)
+            .variables) {
+            if (variable.name.toLowerCase() === name) {
+                return variable;
+            }
+        }
+        for (const filePath of this.documentCache.keys()) {
+            if (filePath === document.uri.path) {
+                continue;
+            }
+            for (const variable of this.documentCache.get(filePath).variables) {
+                if (variable.name.toLowerCase() === name) {
+                    return variable;
+                }
+            }
+        }
+    }
+
     public static getAllRefByName(name: string): Ref[] {
         const refs = [];
         name = name.toLowerCase();
@@ -226,7 +259,8 @@ export class Parser {
         document: vscode.TextDocument,
         line: number,
     ): Variable | Variable[] {
-        const lineText = CodeUtil.purify(document.lineAt(line).text);
+        const original = document.lineAt(line).text;
+        const lineText = CodeUtil.purify(original);
 
         const defMatch = lineText.match(Parser.varDefPattern);
         if (defMatch) {
@@ -238,6 +272,8 @@ export class Parser {
                 method: null,
                 name: varName,
                 character: lineText.indexOf(varName),
+                comment: Parser.getRemarkByLine(document, line - 1),
+                full: original,
             };
         } else {
             const vars = [];
@@ -260,6 +296,8 @@ export class Parser {
                     method: null,
                     name: varName,
                     character: lineText.indexOf(commandMatchAll[index][0]),
+                    comment: Parser.getRemarkByLine(document, line - 1),
+                    full: original,
                 });
             }
             return vars;

src/providers/ahkHoverProvider.ts

@@ -56,6 +56,17 @@ export class AhkHoverProvider implements HoverProvider {
             return new Hover(contents);
         }
 
+        const variable = await Parser.getVariableByName(document, context.word);
+        if (variable) {
+            const contents = new MarkdownString('', true).appendCodeblock(
+                variable.full,
+            );
+            if (variable.comment) {
+                contents.appendText(variable.comment);
+            }
+            return new Hover(contents);
+        }
+
         return null;
     }