tooltips (the last sync thing I know of) are now async \o/ refs #27

Also starts work on ref #52. Will be removing "messages.ts" as its almost redundant in the new mechanism.

Author: basarat

lib/globals.ts

@@ -10,3 +10,7 @@
 
 /// <reference path="./node_modules/views/views.d.ts"/>
 /// <reference path="./typings/atompromise.d.ts"/>
+
+interface Function{
+    name?: string; // exists for named function on node / atom / "good" browsers ;)
+}

lib/main/atom/tooltipManager.js

@@ -1,8 +1,7 @@
-var programManager = require('../lang/programManager');
 var atomUtils = require('./atomUtils');
+var parent = require('../../worker/parent');
 var path = require('path');
 var fs = require('fs');
-var ts = require('typescript');
 var emissary = require('emissary');
 var Subscriber = emissary.Subscriber;
 var TooltipView = require('views/tooltip');
@@ -16,7 +15,6 @@ function attach(editorView) {
     if (!fs.existsSync(filePath)) {
         return;
     }
-    var program = programManager.getOrCreateProgram(filePath);
     var scroll = editorView.find('.scroll-view');
     var subscriber = new Subscriber();
     var exprTypeTimeout = null;
@@ -46,18 +44,18 @@ function attach(editorView) {
         };
         exprTypeTooltip = new TooltipView(tooltipRect);
         var position = atomUtils.getEditorPositionForBufferPosition(editor, bufferPt);
-        var info = program.languageService.getQuickInfoAtPosition(filePath, position);
-        if (!info) {
-            hideExpressionType();
-        }
-        else {
-            var displayName = ts.displayPartsToString(info.displayParts || []);
-            var documentation = ts.displayPartsToString(info.documentation || []);
-            var message = "<b>" + displayName + "</b>";
-            if (documentation)
-                message = message + ("<br/><i>" + documentation + "</i>");
-            exprTypeTooltip.updateText(message);
-        }
+        parent.quickInfo({ filePath: filePath, position: position }).then(function (resp) {
+            if (!resp.valid) {
+                hideExpressionType();
+            }
+            else {
+                var message = "<b>" + resp.name + "</b>";
+                if (resp.comment)
+                    message = message + ("<br/><i>" + resp.comment + "</i>");
+                if (exprTypeTooltip)
+                    exprTypeTooltip.updateText(message);
+            }
+        });
     }
     function deactivate() {
         subscriber.unsubscribe();

lib/main/atom/tooltipManager.ts

@@ -1,10 +1,10 @@
 ///ts:ref=globals
 /// <reference path="../../globals.ts"/> ///ts:ref:generated
 
-///ts:import=programManager
-import programManager = require('../lang/programManager'); ///ts:import:generated
 ///ts:import=atomUtils
 import atomUtils = require('./atomUtils'); ///ts:import:generated
+///ts:import=parent
+import parent = require('../../worker/parent'); ///ts:import:generated
 
 import path = require('path');
 import fs = require('fs');
@@ -26,8 +26,6 @@ export function attach(editorView: any) {
         return;
     }
 
-    var program = programManager.getOrCreateProgram(filePath);
-
     var scroll = editorView.find('.scroll-view');
     var subscriber = new Subscriber();
     var exprTypeTimeout = null;
@@ -65,18 +63,19 @@ export function attach(editorView: any) {
         };
         exprTypeTooltip = new TooltipView(tooltipRect);
 
+        var position = atomUtils.getEditorPositionForBufferPosition(editor, bufferPt);
         // Actually make the program manager query
-        var position = atomUtils.getEditorPositionForBufferPosition(editor,bufferPt);
-        var info = program.languageService.getQuickInfoAtPosition(filePath, position);
-        if (!info) {
-            hideExpressionType();
-        } else {
-            var displayName = ts.displayPartsToString(info.displayParts || []);
-            var documentation = ts.displayPartsToString(info.documentation || []);
-            var message = `<b>${displayName}</b>`;
-            if(documentation) message = message + `<br/><i>${documentation}</i>`;
-            exprTypeTooltip.updateText(message);
-        }
+        parent.quickInfo({ filePath, position }).then((resp) => {
+            if (!resp.valid) {
+                hideExpressionType();
+            }
+            else {
+                var message = `<b>${resp.name}</b>`;
+                if (resp.comment) message = message + `<br/><i>${resp.comment}</i>`;
+                // Sorry about this "if". It's in the code I copied so I guess its there for a reason
+                if (exprTypeTooltip) exprTypeTooltip.updateText(message);
+            }
+        });
     }
 
 

lib/main/lang/programManager.js

@@ -206,3 +206,16 @@ function getCompletionsAtPosition(filePath, position, prefix) {
     });
 }
 exports.getCompletionsAtPosition = getCompletionsAtPosition;
+function quickInfo(query) {
+    var program = getOrCreateProgram(query.filePath);
+    var info = program.languageService.getQuickInfoAtPosition(query.filePath, query.position);
+    if (!info)
+        return { valid: false };
+    else
+        return {
+            valid: true,
+            name: ts.displayPartsToString(info.displayParts || []),
+            comment: ts.displayPartsToString(info.documentation || []),
+        };
+}
+exports.quickInfo = quickInfo;

lib/main/lang/programManager.ts

@@ -281,3 +281,23 @@ export function getCompletionsAtPosition(filePath: string, position: number, pre
         };
     });
 }
+
+export interface QuickInfoResponse {
+    valid: boolean; // Do we have a valid response for this query
+    name?: string;
+    comment?: string;
+}
+export interface QuickInfoQuery {
+    filePath: string;
+    position: number;
+}
+export function quickInfo(query: QuickInfoQuery): QuickInfoResponse {
+    var program = getOrCreateProgram(query.filePath);
+    var info = program.languageService.getQuickInfoAtPosition(query.filePath, query.position);
+    if (!info) return { valid: false };
+    else return {
+        valid: true,
+        name: ts.displayPartsToString(info.displayParts || []),
+        comment: ts.displayPartsToString(info.documentation || []),
+    }
+}

lib/worker/parent.js

@@ -1,4 +1,5 @@
 var messages = require('./messages');
+var programManager = require('../main/lang/programManager');
 var childprocess = require('child_process');
 var os = require('os');
 var exec = childprocess.exec;
@@ -99,3 +100,4 @@ exports.getErrorsForFile = function (data) { return query(messages.getErrorsForF
 exports.getCompletionsAtPosition = function (data) { return query(messages.getCompletionsAtPosition, data); };
 exports.getErrorsForFileFiltered = function (data) { return query(messages.getErrorsForFileFiltered, data); };
 exports.build = function (data) { return query(messages.build, data); };
+exports.quickInfo = function (data) { return query(programManager.quickInfo.name, data); };

lib/worker/parent.ts

@@ -3,6 +3,8 @@
 
 ///ts:import=messages
 import messages = require('./messages'); ///ts:import:generated
+///ts:import=programManager
+import programManager = require('../main/lang/programManager'); ///ts:import:generated
 
 import childprocess = require('child_process');
 import os = require('os');
@@ -127,7 +129,9 @@ function showError(error?: Error) {
 }
 
 /////////////////////////////////////// END INFRASTRUCTURE ////////////////////////////////////////////////////
-
+// Infrastructure note
+// This could be simplified if there was a way in TypeScript to capture the type information for first argument / return values
+// But there isn't as far as I know. TODO: I do have other cunning ideas though
 
 export var echo: Exec<messages.EchoQuery, messages.EchoResponse>
     = (data) => query(messages.echo, data);
@@ -146,3 +150,6 @@ export var getErrorsForFileFiltered: Exec<messages.GetErrorsForFileFilteredQuery
 
 export var build: Exec<messages.BuildQuery, messages.BuildResponse>
     = (data) => query(messages.build, data);
+
+export var quickInfo: Exec<programManager.QuickInfoQuery,programManager.QuickInfoResponse>
+    = (data) => query(programManager.quickInfo.name, data);

lib/worker/workerProcess.js

@@ -51,3 +51,7 @@ responders[messages.build] = function (data) {
         outputs: programManager.getOrCreateProgram(data.filePath).build()
     };
 };
+function addToResponders(func) {
+    responders[func.name] = func;
+}
+addToResponders(programManager.quickInfo);

lib/worker/workerProcess.ts

@@ -72,3 +72,9 @@ responders[messages.build] = (data: messages.BuildQuery): messages.BuildResponse
         outputs: programManager.getOrCreateProgram(data.filePath).build()
     };
 }
+
+function addToResponders<Query, Response>(func: (query: Query) => Response) {
+    responders[func.name] = func;
+}
+
+addToResponders(programManager.quickInfo);