Merge pull request #3847 from jeffkenton/master

Use Tern jump-to-definition search for quickeditt

Author: Narciso Jaramillo

src/editor/EditorManager.js

@@ -214,7 +214,7 @@ define(function (require, exports, module) {
     function registerInlineEditProvider(provider) {
         _inlineEditProviders.push(provider);
     }
-    
+
     /**
      * Registers a new inline docs provider. When Quick Docs is invoked each registered provider is
      * asked if it wants to provide inline docs given the current editor and cursor location.

src/editor/MultiRangeInlineEditor.js

@@ -126,13 +126,13 @@ define(function (require, exports, module) {
         this.$editorsDiv.on("mousewheel.MultiRangeInlineEditor", function (e) {
             e.stopPropagation();
         });
-        
+
         // Outer container for border-left and scrolling
         this.$relatedContainer = $(window.document.createElement("div")).addClass("related-container");
 
         // List "selection" highlight
         this.$selectedMarker = $(window.document.createElement("div")).appendTo(this.$relatedContainer).addClass("selection");
-        
+
         // Inner container
         this.$related = $(window.document.createElement("div")).appendTo(this.$relatedContainer).addClass("related");
 
@@ -165,8 +165,10 @@ define(function (require, exports, module) {
         // select the first range
         self.setSelectedIndex(0);
 
-        // attach to main container
-        this.$htmlContent.append(this.$relatedContainer).append(this.$editorsDiv);
+        if (this._ranges.length > 1) {      // attach to main container
+            this.$htmlContent.append(this.$relatedContainer);
+        }
+        this.$htmlContent.append(this.$editorsDiv);
 
         // Listen for clicks directly on us, so we can set focus back to the editor
         var clickHandler = this._onClick.bind(this);

src/extensions/default/JavaScriptCodeHints/ScopeManager.js

@@ -403,6 +403,14 @@ define(function (require, exports, module) {
         }
     }
 
+    /**
+     * @param {string} file a relative path
+     * @return {string} returns the path we resolved when we tried to parse the file, or undefined
+     */
+    function getResolvedPath(file) {
+        return resolvedFiles[file];
+    }
+
     /**
      * Get a Promise for the definition from TernJS, for the file & offset passed in.
      * @return {jQuery.Promise} - a promise that will resolve to definition when
@@ -453,9 +461,8 @@ define(function (require, exports, module) {
 
         var $deferredJump = getPendingRequest(file, offset, MessageIds.TERN_JUMPTODEF_MSG);
 
-//        pendingTernRequests[file] = null;
-        
         if ($deferredJump) {
+            response.fullPath = getResolvedPath(response.resultFile);
             $deferredJump.resolveWith(null, [response]);
         }
     }
@@ -624,14 +631,6 @@ define(function (require, exports, module) {
         }
     }
 
-    /**
-     * @param {string} file a relative path
-     * @return {string} returns the path we resolved when we tried to parse the file, or undefined
-     */
-    function getResolvedPath(file) {
-        return resolvedFiles[file];
-    }
-
     /**
      * Handle a request from the worker for text of a file
      *

src/extensions/default/JavaScriptCodeHints/main.js

@@ -591,9 +591,22 @@ define(function (require, exports, module) {
             }
         }
 
+        /*
+         * Helper for QuickEdit jump-to-definition request.
+         */
+        function quickEditHelper() {
+            var offset     = session.getOffset(),
+                response   = ScopeManager.requestJumptoDef(session, session.editor.document, offset);
+
+            return response;
+        }
+
         // Register command handler
         CommandManager.register(Strings.CMD_JUMPTO_DEFINITION, JUMPTO_DEFINITION, handleJumpToDefinition);
 
+        // Register quickEditHelper.
+        brackets._jsCodeHintsHelper = quickEditHelper;
+  
         // Add the menu item
         var menu = Menus.getMenu(Menus.AppMenuBar.NAVIGATE_MENU);
         if (menu) {

src/extensions/default/JavaScriptCodeHints/tern-worker.js

@@ -143,6 +143,7 @@ importScripts("thirdparty/requirejs/require.js");
 
         var request = buildRequest(dir, file, "definition", offset, text);
         request.query.lineCharPositions = true;
+        // request.query.typeOnly = true;       // FIXME: tern doesn't work exactly right yet.
         ternServer.request(request, function (error, data) {
             if (error) {
                 _log("Error returned from Tern 'definition' request: " + error);

src/extensions/default/JavaScriptQuickEdit/main.js

@@ -32,6 +32,7 @@ define(function (require, exports, module) {
     var MultiRangeInlineEditor  = brackets.getModule("editor/MultiRangeInlineEditor").MultiRangeInlineEditor,
         FileIndexManager        = brackets.getModule("project/FileIndexManager"),
         EditorManager           = brackets.getModule("editor/EditorManager"),
+        DocumentManager         = brackets.getModule("document/DocumentManager"),
         JSUtils                 = brackets.getModule("language/JSUtils"),
         PerfUtils               = brackets.getModule("utils/PerfUtils");
 
@@ -103,26 +104,71 @@ define(function (require, exports, module) {
      *      or null if we're not going to provide anything.
      */
     function _createInlineEditor(hostEditor, functionName) {
+        // Use Tern jump-to-definition helper, if it's available, to find InlineEditor target.
+        var helper = brackets._jsCodeHintsHelper;
+        if (helper === null) {
+            return null;
+        }
+
         var result = new $.Deferred();
         PerfUtils.markStart(PerfUtils.JAVASCRIPT_INLINE_CREATE);
-        
-        _findInProject(functionName).done(function (functions) {
-            if (functions && functions.length > 0) {
-                var jsInlineEditor = new MultiRangeInlineEditor(functions);
-                jsInlineEditor.load(hostEditor);
-                
-                PerfUtils.addMeasurement(PerfUtils.JAVASCRIPT_INLINE_CREATE);
-                result.resolve(jsInlineEditor);
-            } else {
-                // No matching functions were found
-                PerfUtils.addMeasurement(PerfUtils.JAVASCRIPT_INLINE_CREATE);
+
+        var response = helper();
+        if (response.hasOwnProperty("promise")) {
+            response.promise.done(function (jumpResp) {
+                var resolvedPath = jumpResp.fullPath;
+                if (resolvedPath) {
+
+                    // Tern doesn't always return entire function extent.
+                    // Use QuickEdit search now that we know which file to look at.
+                    var fileInfos = [];
+                    fileInfos.push({name: jumpResp.resultFile, fullPath: resolvedPath});
+                    JSUtils.findMatchingFunctions(functionName, fileInfos)
+                        .done(function (functions) {
+                            if (functions && functions.length > 0) {
+                                var jsInlineEditor = new MultiRangeInlineEditor(functions);
+                                jsInlineEditor.load(hostEditor);
+                                
+                                PerfUtils.addMeasurement(PerfUtils.JAVASCRIPT_INLINE_CREATE);
+                                result.resolve(jsInlineEditor);
+                            } else {
+                                // No matching functions were found
+                                PerfUtils.addMeasurement(PerfUtils.JAVASCRIPT_INLINE_CREATE);
+                                result.reject();
+                            }
+                        })
+                        .fail(function () {
+                            PerfUtils.addMeasurement(PerfUtils.JAVASCRIPT_INLINE_CREATE);
+                            result.reject();
+                        });
+
+                } else {        // no result from Tern.  Fall back to _findInProject().
+
+                    _findInProject(functionName).done(function (functions) {
+                        if (functions && functions.length > 0) {
+                            var jsInlineEditor = new MultiRangeInlineEditor(functions);
+                            jsInlineEditor.load(hostEditor);
+                            
+                            PerfUtils.addMeasurement(PerfUtils.JAVASCRIPT_INLINE_CREATE);
+                            result.resolve(jsInlineEditor);
+                        } else {
+                            // No matching functions were found
+                            PerfUtils.addMeasurement(PerfUtils.JAVASCRIPT_INLINE_CREATE);
+                            result.reject();
+                        }
+                    }).fail(function () {
+                        PerfUtils.finalizeMeasurement(PerfUtils.JAVASCRIPT_INLINE_CREATE);
+                        result.reject();
+                    });
+                }
+
+            }).fail(function () {
+                PerfUtils.finalizeMeasurement(PerfUtils.JAVASCRIPT_INLINE_CREATE);
                 result.reject();
-            }
-        }).fail(function () {
-            PerfUtils.finalizeMeasurement(PerfUtils.JAVASCRIPT_INLINE_CREATE);
-            result.reject();
-        });
-        
+            });
+
+        }
+
         return result.promise();
     }
 
@@ -147,14 +193,14 @@ define(function (require, exports, module) {
         if (sel.start.line !== sel.end.line) {
             return null;
         }
-        
+
         // Always use the selection start for determining the function name. The pos
         // parameter is usually the selection end.        
         var functionName = _getFunctionName(hostEditor, sel.start);
         if (!functionName) {
             return null;
         }
-        
+
         return _createInlineEditor(hostEditor, functionName);
     }