DevTools: "Jump between editing locations" experiment

Source/devtools/front_end/SourcesPanel.js

 /*
  * Copyright (C) 2008 Apple Inc. All Rights Reserved.
  * Copyright (C) 2011 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.
  *
  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 importScript("BreakpointsSidebarPane.js");
 importScript("CallStackSidebarPane.js");
+importScript("SimpleHistoryManager.js");
+importScript("EditingLocationHistoryManager.js");
 importScript("FilePathScoreFunction.js");
 importScript("FilteredItemSelectionDialog.js");
 importScript("UISourceCodeFrame.js");
 importScript("JavaScriptSourceFrame.js");
 importScript("CSSSourceFrame.js");
 importScript("NavigatorOverlayController.js");
 importScript("NavigatorView.js");
 importScript("RevisionHistoryView.js");
 importScript("ScopeChainSidebarPane.js");
 importScript("SourcesNavigator.js");
@@ skipping 22 matching lines @@
     WebInspector.settings.showEditorInDrawer = WebInspector.settings.createSetting("showEditorInDrawer", true);
 
     this._workspace = workspaceForTest || WebInspector.workspace;
 
     /**
      * @return {!WebInspector.View}
      * @this {WebInspector.SourcesPanel}
      */
     function viewGetter()
     {
-        return this.visibleView;
+        return this;
     }
     WebInspector.GoToLineDialog.install(this, viewGetter.bind(this));
 
     var helpSection = WebInspector.shortcutsScreen.section(WebInspector.UIString("Sources Panel"));
     this.debugToolbar = this._createDebugToolbar();
 
     const initialDebugSidebarWidth = 225;
     const minimumDebugSidebarWidthPercent = 0.5;
     this.createSidebarView(this.element, WebInspector.SidebarView.SidebarPosition.End, initialDebugSidebarWidth);
     this.splitView.element.id = "scripts-split-view";
@@ skipping 52 matching lines @@
     this.sidebarPanes.jsBreakpoints = new WebInspector.JavaScriptBreakpointsSidebarPane(WebInspector.breakpointManager, this._showSourceLocation.bind(this));
     this.sidebarPanes.domBreakpoints = WebInspector.domBreakpointsSidebarPane.createProxy(this);
     this.sidebarPanes.xhrBreakpoints = new WebInspector.XHRBreakpointsSidebarPane();
     this.sidebarPanes.eventListenerBreakpoints = new WebInspector.EventListenerBreakpointsSidebarPane();
 
     if (Capabilities.canInspectWorkers && !WebInspector.WorkerManager.isWorkerFrontend()) {
         WorkerAgent.enable();
         this.sidebarPanes.workerList = new WebInspector.WorkersSidebarPane(WebInspector.workerManager);
     }
 
+    /**
+     * @this {WebInspector.SourcesPanel}
+     */
+    function currentSourceFrame()
+    {
+        var uiSourceCode = this.currentUISourceCode();
+        if (!uiSourceCode)
+            return null;
+        return this._sourceFramesByUISourceCode.get(uiSourceCode);
+    }
+    this._historyManager = new WebInspector.EditingLocationHistoryManager(this, currentSourceFrame.bind(this));
+
     this.sidebarPanes.callstack.registerShortcuts(this.registerShortcuts.bind(this));
     this.registerShortcuts(WebInspector.SourcesPanelDescriptor.ShortcutKeys.GoToMember, this._showOutlineDialog.bind(this));
     this.registerShortcuts(WebInspector.SourcesPanelDescriptor.ShortcutKeys.ToggleBreakpoint, this._toggleBreakpoint.bind(this));
 
     this._extensionSidebarPanes = [];
 
     this._toggleFormatSourceButton = new WebInspector.StatusBarButton(WebInspector.UIString("Pretty print"), "sources-toggle-pretty-print-status-bar-item");
     this._toggleFormatSourceButton.toggled = false;
     this._toggleFormatSourceButton.addEventListener("click", this._toggleFormatSource, this);
 
@@ skipping 136 matching lines @@
     },
 
     /**
      * @param {!Array.<!WebInspector.UISourceCode>} uiSourceCodes
      */
     _removeUISourceCodes: function(uiSourceCodes)
     {
         for (var i = 0; i < uiSourceCodes.length; ++i) {
             this._navigator.removeUISourceCode(uiSourceCodes[i]);
             this._removeSourceFrame(uiSourceCodes[i]);
+            this._historyManager.removeHistoryForSourceCode(uiSourceCodes[i]);
         }
         this._editorContainer.removeUISourceCodes(uiSourceCodes);
     },
 
     _consoleCommandEvaluatedInSelectedCallFrame: function(event)
     {
         this.sidebarPanes.scopechain.update(WebInspector.debuggerModel.selectedCallFrame());
     },
 
     _debuggerPaused: function()
@@ skipping 196 matching lines @@
     },
 
     /**
      * @param {!WebInspector.UISourceCode} uiSourceCode
      * @param {number=} lineNumber
      * @param {number=} columnNumber
      * @param {boolean=} forceShowInPanel
      */
     _showSourceLocation: function(uiSourceCode, lineNumber, columnNumber, forceShowInPanel)
     {
+        if (uiSourceCode === this._currentUISourceCode && typeof lineNumber === "number") {

[vsevik, 2014/01/15 16:19:05]

This looks redundant.
Please remove these lines unless you could show a test that fails without them!

[lushnikov, 2014/01/16 17:10:29]

Done.

+            this.highlightPosition(lineNumber, columnNumber);
+            return;
+        }
         this._showEditor(forceShowInPanel);
         var sourceFrame = this._showFile(uiSourceCode);
         if (typeof lineNumber === "number")
             sourceFrame.highlightPosition(lineNumber, columnNumber);
         sourceFrame.focus();
-
+        this._historyManager.updateCurrentState();
         WebInspector.notifications.dispatchEventToListeners(WebInspector.UserMetrics.UserAction, {
             action: WebInspector.UserMetrics.UserActionNames.OpenSourceLink,
             url: uiSourceCode.originURL(),
             lineNumber: lineNumber
         });
     },
 
     /**
      * @param {!WebInspector.UISourceCode} uiSourceCode
      * @return {!WebInspector.SourceFrame}
      */
     _showFile: function(uiSourceCode)

[vsevik, 2014/01/16 12:24:26]

I think you should move your calls out of this method and make them one level
above instead.
This would better address your needs.

[lushnikov, 2014/01/16 17:10:29]

Done.

     {
         var sourceFrame = this._getOrCreateSourceFrame(uiSourceCode);
         if (this._currentUISourceCode === uiSourceCode)
             return sourceFrame;
+
+        this._historyManager.updateCurrentState();

[vsevik, 2014/01/15 16:19:05]

You wrap incorrect line with your calls here and this would not work with
switching files through navigator (test).

[lushnikov, 2014/01/16 17:10:29]

Moved these lines out of the method

         this._currentUISourceCode = uiSourceCode;
         if (!uiSourceCode.project().isServiceProject())
             this._navigator.revealUISourceCode(uiSourceCode, true);
+        this._historyManager.pushNewState();
+
         this._editorContainer.showFile(uiSourceCode);
         this._updateScriptViewStatusBarItems();
 
         if (this._currentUISourceCode.project().type() === WebInspector.projectTypes.Snippets)
             this._runSnippetButton.element.classList.remove("hidden");
         else
             this._runSnippetButton.element.classList.add("hidden");
 
         return sourceFrame;
     },
@@ skipping 14 matching lines @@
             break;
         case WebInspector.resourceTypes.Stylesheet:
             sourceFrame = new WebInspector.CSSSourceFrame(uiSourceCode);
             break;
         default:
             sourceFrame = new WebInspector.UISourceCodeFrame(uiSourceCode);
         break;
         }
         sourceFrame.setHighlighterType(uiSourceCode.highlighterType());
         this._sourceFramesByUISourceCode.put(uiSourceCode, sourceFrame);
+        this._historyManager.trackSourceFrameCursorJumps(sourceFrame);
         return sourceFrame;
     },
 
     /**
      * @param {!WebInspector.UISourceCode} uiSourceCode
      * @return {!WebInspector.SourceFrame}
      */
     _getOrCreateSourceFrame: function(uiSourceCode)
     {
         return this._sourceFramesByUISourceCode.get(uiSourceCode) || this._createSourceFrame(uiSourceCode);
@@ skipping 96 matching lines @@
         this.sidebarPanes.scopechain.update(callFrame);
         this.sidebarPanes.watchExpressions.refreshExpressions();
         this.sidebarPanes.callstack.setSelectedCallFrame(callFrame);
         callFrame.createLiveLocation(this._executionLineChanged.bind(this));
     },
 
     _editorClosed: function(event)
     {
         this._navigatorController.hideNavigatorOverlay();
         var uiSourceCode = /** @type {!WebInspector.UISourceCode} */ (event.data);
+        this._historyManager.removeHistoryForSourceCode(uiSourceCode);
 
         if (this._currentUISourceCode === uiSourceCode)
             delete this._currentUISourceCode;
 
         // SourcesNavigator does not need to update on EditorClosed.
         this._updateScriptViewStatusBarItems();
         this._searchableView.resetSearch();
     },
 
     _editorSelected: function(event)
     {
-        var uiSourceCode = /** @type {!WebInspector.UISourceCode} */ (event.data);
+        var uiSourceCode = /** @type {!WebInspector.UISourceCode} */ (event.data.currentFile);
+        if (!event.data.userGesture)
+            this._historyManager.readOnlyLock();

[vsevik, 2014/01/16 12:24:26]

Can we remove these?

[lushnikov, 2014/01/16 17:10:29]

Not really; test fails.

         var sourceFrame = this._showFile(uiSourceCode);
+        if (!event.data.userGesture)
+            this._historyManager.releaseReadOnlyLock();
+
         this._navigatorController.hideNavigatorOverlay();
         if (!this._navigatorController.isNavigatorPinned())
             sourceFrame.focus();
         this._searchableView.setCanReplace(!!sourceFrame && sourceFrame.canEditSource());
         this._searchableView.resetSearch();
     },
 
     _sourceSelected: function(event)
     {
         var uiSourceCode = /** @type {!WebInspector.UISourceCode} */ (event.data.uiSourceCode);
@@ skipping 439 matching lines @@
     /**
      * @param {string} query
      * @param {string} text
      */
     replaceAllWith: function(query, text)
     {
         var view = /** @type {!WebInspector.SourceFrame} */ (this.visibleView);
         view.replaceAllWith(query, text);
     },
 
+    /**
+     * @param {!KeyboardEvent} event
+     */
+    handleShortcut: function(event)

[vsevik, 2014/01/15 16:19:05]

Please register and handle this shortcuts on the panel (just like we do for
other sources panel shortcuts)

[lushnikov, 2014/01/16 17:10:29]

Done.

+    {
+        if (this._historyManager.handleShortcut(event)) {
+            event.handled = true;
+            return;
+        }
+        WebInspector.Panel.prototype.handleShortcut.call(this, event);
+    },
+
     _onKeyDown: function(event)
     {
         if (event.keyCode !== WebInspector.KeyboardShortcut.Keys.CtrlOrMeta.code)
             return;
         if (!this._paused || !this._executionSourceFrame)
             return;
         var stepIntoMarkup = this._executionSourceFrame.stepIntoMarkup();
         if (stepIntoMarkup)
             stepIntoMarkup.startIteratingSelection();
     },
@@ skipping 450 matching lines @@
     },
 
     /**
      * @param {number} line
      * @param {number=} column
      */
     highlightPosition: function(line, column)
     {
         if (!this.canHighlightPosition())
             return;
+        this._historyManager.updateCurrentState();
         this.visibleView.highlightPosition(line, column);
+        this._historyManager.pushNewState();
     },
 
     /**
      * @param {string} id
      * @param {!WebInspector.SidebarPane} pane
      */
     addExtensionSidebarPane: function(id, pane)
     {
         this._extensionSidebarPanes.push(pane);
         this._extensionSidebarPanesContainer.addPane(pane);
@@ skipping 82 matching lines @@
 WebInspector.DrawerEditorView = function()
 {
     WebInspector.View.call(this);
     this.element.id = "drawer-editor-view";
     this.element.classList.add("vbox");
 }
 
 WebInspector.DrawerEditorView.prototype = {
     __proto__: WebInspector.View.prototype
 }