DevTools: wrap DebuggerAgent.Location with DebuggerModel.Location.

Source/devtools/front_end/DebuggerModel.js

 /*
  * Copyright (C) 2010 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:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 12 matching lines @@
  * 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.
  */
 
 /**
  * @constructor
- * @extends {WebInspector.Object}
+ * @extends {WebInspector.TargetAwareObject}
  * @param {!WebInspector.Target} target
  */
 WebInspector.DebuggerModel = function(target)
 {
+    WebInspector.TargetAwareObject.call(this, target);
+
     target.registerDebuggerDispatcher(new WebInspector.DebuggerDispatcher(this));
     this._agent = target.debuggerAgent();
-    this._target = target;
 
     /** @type {?WebInspector.DebuggerPausedDetails} */
     this._debuggerPausedDetails = null;
     /** @type {!Object.<string, !WebInspector.Script>} */
     this._scripts = {};
     /** @type {!StringMap.<!Array.<!WebInspector.Script>>} */
     this._scriptsBySourceURL = new StringMap();
 
     this._breakpointsActive = true;
 
@@ skipping 11 matching lines @@
  * Keep these in sync with WebCore::ScriptDebugServer
  *
  * @enum {string}
  */
 WebInspector.DebuggerModel.PauseOnExceptionsState = {
     DontPauseOnExceptions : "none",
     PauseOnAllExceptions : "all",
     PauseOnUncaughtExceptions: "uncaught"
 };
 
-/**
- * @constructor
- * @implements {WebInspector.RawLocation}
- * @param {string} scriptId
- * @param {number} lineNumber
- * @param {number} columnNumber
- */
-WebInspector.DebuggerModel.Location = function(scriptId, lineNumber, columnNumber)
-{
-    this.scriptId = scriptId;
-    this.lineNumber = lineNumber;
-    this.columnNumber = columnNumber;
-}
-
 WebInspector.DebuggerModel.Events = {
     DebuggerWasEnabled: "DebuggerWasEnabled",
     DebuggerWasDisabled: "DebuggerWasDisabled",
     DebuggerPaused: "DebuggerPaused",
     DebuggerResumed: "DebuggerResumed",
     ParsedScriptSource: "ParsedScriptSource",
     FailedToParseScriptSource: "FailedToParseScriptSource",
     BreakpointResolved: "BreakpointResolved",
     GlobalObjectCleared: "GlobalObjectCleared",
     CallFrameSelected: "CallFrameSelected",
@@ skipping 88 matching lines @@
         var enabled = WebInspector.settings.enableAsyncStackTraces.get();
         this._agent.setAsyncCallStackDepth(enabled ? maxAsyncStackChainDepth : 0);
     },
 
     _debuggerWasDisabled: function()
     {
         this._debuggerEnabled = false;
         this.dispatchEventToListeners(WebInspector.DebuggerModel.Events.DebuggerWasDisabled);
     },
 
-    /**
-     * @param {!WebInspector.DebuggerModel.Location} rawLocation
-     */
-    continueToLocation: function(rawLocation)
-    {
-        this._agent.continueToLocation(rawLocation);
-    },
-
     stepInto: function()
     {
         /**
          * @this {WebInspector.DebuggerModel}
          */
         function callback()
         {
             this._agent.stepInto();
         }
         this._agent.setOverlayMessage(undefined, callback.bind(this));
@@ skipping 35 matching lines @@
         this._agent.setOverlayMessage(undefined, callback.bind(this));
     },
 
     /**
      * @param {!WebInspector.DebuggerModel.Location} rawLocation
      * @param {string} condition
      * @param {function(?DebuggerAgent.BreakpointId, !Array.<!WebInspector.DebuggerModel.Location>):void=} callback
      */
     setBreakpointByScriptLocation: function(rawLocation, condition, callback)
     {
-        var script = this.scriptForId(rawLocation.scriptId);
+        var script = rawLocation.script();
         if (script.sourceURL)
             this.setBreakpointByURL(script.sourceURL, rawLocation.lineNumber, rawLocation.columnNumber, condition, callback);
         else
             this.setBreakpointBySourceId(rawLocation, condition, callback);
     },
 
     /**
      * @param {string} url
      * @param {number} lineNumber
      * @param {number=} columnNumber
      * @param {string=} condition
      * @param {function(?DebuggerAgent.BreakpointId, !Array.<!WebInspector.DebuggerModel.Location>)=} callback
      */
     setBreakpointByURL: function(url, lineNumber, columnNumber, condition, callback)
     {
         // Adjust column if needed.
         var minColumnNumber = 0;
         var scripts = this._scriptsBySourceURL.get(url) || [];
         for (var i = 0, l = scripts.length; i < l; ++i) {
             var script = scripts[i];
             if (lineNumber === script.lineOffset)
                 minColumnNumber = minColumnNumber ? Math.min(minColumnNumber, script.columnOffset) : script.columnOffset;
         }
         columnNumber = Math.max(columnNumber, minColumnNumber);
 
+        var target = this.target();
         /**
          * @param {?Protocol.Error} error
          * @param {!DebuggerAgent.BreakpointId} breakpointId
          * @param {!Array.<!DebuggerAgent.Location>} locations
          */
         function didSetBreakpoint(error, breakpointId, locations)
         {
             if (callback) {
-                var rawLocations = /** @type {!Array.<!WebInspector.DebuggerModel.Location>} */ (locations);
+                var rawLocations = locations.map(WebInspector.DebuggerModel.Location.fromPayload.bind(WebInspector.DebuggerModel.Location, target));
                 callback(error ? null : breakpointId, rawLocations);
             }
         }
         this._agent.setBreakpointByUrl(lineNumber, url, undefined, columnNumber, condition, undefined, didSetBreakpoint);
         WebInspector.userMetrics.ScriptsBreakpointSet.record();
     },
 
     /**
      * @param {!WebInspector.DebuggerModel.Location} rawLocation
      * @param {string} condition
      * @param {function(?DebuggerAgent.BreakpointId, !Array.<!WebInspector.DebuggerModel.Location>)=} callback
      */
     setBreakpointBySourceId: function(rawLocation, condition, callback)
     {
+        var target = this.target();
+
         /**
          * @param {?Protocol.Error} error
          * @param {!DebuggerAgent.BreakpointId} breakpointId
          * @param {!DebuggerAgent.Location} actualLocation
          */
         function didSetBreakpoint(error, breakpointId, actualLocation)
         {
             if (callback) {
-                var rawLocation = /** @type {!WebInspector.DebuggerModel.Location} */ (actualLocation);
-                callback(error ? null : breakpointId, [rawLocation]);
+                var location = WebInspector.DebuggerModel.Location.fromPayload(target, actualLocation);
+                callback(error ? null : breakpointId, [location]);
             }
         }
-        this._agent.setBreakpoint(rawLocation, condition, didSetBreakpoint);
+        this._agent.setBreakpoint(rawLocation.payload(), condition, didSetBreakpoint);
         WebInspector.userMetrics.ScriptsBreakpointSet.record();
     },
 
     /**
      * @param {!DebuggerAgent.BreakpointId} breakpointId
      * @param {function()=} callback
      */
     removeBreakpoint: function(breakpointId, callback)
     {
         this._agent.removeBreakpoint(breakpointId, innerCallback);
 
         /**
          * @param {?Protocol.Error} error
          */
         function innerCallback(error)
         {
             if (error)
                 console.error("Failed to remove breakpoint: " + error);
             if (callback)
                 callback();
         }
     },
 
     /**
      * @param {!DebuggerAgent.BreakpointId} breakpointId
      * @param {!DebuggerAgent.Location} location
      */
     _breakpointResolved: function(breakpointId, location)
     {
-        this.dispatchEventToListeners(WebInspector.DebuggerModel.Events.BreakpointResolved, {breakpointId: breakpointId, location: location});
+        this.dispatchEventToListeners(WebInspector.DebuggerModel.Events.BreakpointResolved, {breakpointId: breakpointId, location: WebInspector.DebuggerModel.Location.fromPayload(this.target(), location)});
     },
 
     _globalObjectCleared: function()
     {
         this._setDebuggerPausedDetails(null);
         this._reset();
         this.dispatchEventToListeners(WebInspector.DebuggerModel.Events.GlobalObjectCleared);
     },
 
     _reset: function()
@@ skipping 95 matching lines @@
 
     /**
      * @param {!Array.<!DebuggerAgent.CallFrame>} callFrames
      * @param {string} reason
      * @param {!Object|undefined} auxData
      * @param {!Array.<string>} breakpointIds
      * @param {!DebuggerAgent.StackTrace=} asyncStackTrace
      */
     _pausedScript: function(callFrames, reason, auxData, breakpointIds, asyncStackTrace)
     {
-        this._setDebuggerPausedDetails(new WebInspector.DebuggerPausedDetails(this._target, callFrames, reason, auxData, breakpointIds, asyncStackTrace));
+        this._setDebuggerPausedDetails(new WebInspector.DebuggerPausedDetails(this.target(), callFrames, reason, auxData, breakpointIds, asyncStackTrace));
     },
 
     _resumedScript: function()
     {
         this._setDebuggerPausedDetails(null);
         this.dispatchEventToListeners(WebInspector.DebuggerModel.Events.DebuggerResumed);
     },
 
     /**
      * @param {!DebuggerAgent.ScriptId} scriptId
      * @param {string} sourceURL
      * @param {number} startLine
      * @param {number} startColumn
      * @param {number} endLine
      * @param {number} endColumn
      * @param {boolean} isContentScript
      * @param {string=} sourceMapURL
      * @param {boolean=} hasSourceURL
      */
     _parsedScriptSource: function(scriptId, sourceURL, startLine, startColumn, endLine, endColumn, isContentScript, sourceMapURL, hasSourceURL)
     {
-        var script = new WebInspector.Script(scriptId, sourceURL, startLine, startColumn, endLine, endColumn, isContentScript, sourceMapURL, hasSourceURL);
+        var script = new WebInspector.Script(this.target(), scriptId, sourceURL, startLine, startColumn, endLine, endColumn, isContentScript, sourceMapURL, hasSourceURL);
         this._registerScript(script);
         this.dispatchEventToListeners(WebInspector.DebuggerModel.Events.ParsedScriptSource, script);
     },
 
     /**
      * @param {!WebInspector.Script} script
      */
     _registerScript: function(script)
     {
         this._scripts[script.scriptId] = script;
@@ skipping 11 matching lines @@
     /**
      * @param {!WebInspector.Script} script
      * @param {number} lineNumber
      * @param {number} columnNumber
      * @return {?WebInspector.DebuggerModel.Location}
      */
     createRawLocation: function(script, lineNumber, columnNumber)
     {
         if (script.sourceURL)
             return this.createRawLocationByURL(script.sourceURL, lineNumber, columnNumber)
-        return new WebInspector.DebuggerModel.Location(script.scriptId, lineNumber, columnNumber);
+        return new WebInspector.DebuggerModel.Location(this.target(), script.scriptId, lineNumber, columnNumber);
     },
 
     /**
      * @param {string} sourceURL
      * @param {number} lineNumber
      * @param {number} columnNumber
      * @return {?WebInspector.DebuggerModel.Location}
      */
     createRawLocationByURL: function(sourceURL, lineNumber, columnNumber)
     {
         var closestScript = null;
         var scripts = this._scriptsBySourceURL.get(sourceURL) || [];
         for (var i = 0, l = scripts.length; i < l; ++i) {
             var script = scripts[i];
             if (!closestScript)
                 closestScript = script;
             if (script.lineOffset > lineNumber || (script.lineOffset === lineNumber && script.columnOffset > columnNumber))
                 continue;
             if (script.endLine < lineNumber || (script.endLine === lineNumber && script.endColumn <= columnNumber))
                 continue;
             closestScript = script;
             break;
         }
-        return closestScript ? new WebInspector.DebuggerModel.Location(closestScript.scriptId, lineNumber, columnNumber) : null;
+        return closestScript ? new WebInspector.DebuggerModel.Location(this.target(), closestScript.scriptId, lineNumber, columnNumber) : null;
     },
 
     /**
      * @return {boolean}
      */
     isPaused: function()
     {
         return !!this.debuggerPausedDetails();
     },
 
@@ skipping 33 matching lines @@
          * @param {boolean=} wasThrown
          * @this {WebInspector.DebuggerModel}
          */
         function didEvaluate(result, wasThrown)
         {
             if (!result)
                 callback(null, false);
             else if (returnByValue)
                 callback(null, !!wasThrown, wasThrown ? null : result);
             else
-                callback(this._target.runtimeModel.createRemoteObject(result), !!wasThrown);
+                callback(this.target().runtimeModel.createRemoteObject(result), !!wasThrown);
 
             if (objectGroup === "console")
                 this.dispatchEventToListeners(WebInspector.DebuggerModel.Events.ConsoleCommandEvaluatedInSelectedCallFrame);
         }
 
         this.selectedCallFrame().evaluate(code, objectGroup, includeCommandLineAPI, doNotPauseOnExceptionsAndMuteConsole, returnByValue, generatePreview, didEvaluate.bind(this));
     },
 
     /**
      * @param {function(!Object)} callback
@@ skipping 11 matching lines @@
         function propertiesCollected(properties)
         {
             for (var i = 0; properties && i < properties.length; ++i)
                 result[properties[i].name] = true;
             if (--pendingRequests == 0)
                 callback(result);
         }
 
         for (var i = 0; i < selectedCallFrame.scopeChain.length; ++i) {
             var scope = selectedCallFrame.scopeChain[i];
-            var object = this._target.runtimeModel.createRemoteObject(scope.object);
+            var object = this.target().runtimeModel.createRemoteObject(scope.object);
             pendingRequests++;
             object.getAllProperties(false, propertiesCollected);
         }
     },
 
     /**
      * @param {boolean} active
      */
     setBreakpointsActive: function(active)
     {
@@ skipping 52 matching lines @@
 
     applySkipStackFrameSettings: function()
     {
         if (!WebInspector.experimentsSettings.frameworksDebuggingSupport.isEnabled())
             return;
         var settings = WebInspector.settings;
         var patternParameter = settings.skipStackFramesSwitch.get() ? settings.skipStackFramesPattern.get() : undefined;
         this._agent.skipStackFrames(patternParameter);
     },
 
-    __proto__: WebInspector.Object.prototype
+    /**
+     * @param {!WebInspector.RemoteObject} remoteObject
+     * @param {function(?DebuggerAgent.FunctionDetails)} callback
+     */
+    functionDetails: function(remoteObject, callback)
+    {
+        this._agent.getFunctionDetails(remoteObject.objectId, didGetDetails);
+
+        /**
+         * @param {?Protocol.Error} error
+         * @param {!DebuggerAgent.FunctionDetails} response
+         */
+        function didGetDetails(error, response)
+        {
+            if (error) {
+                console.error(error);
+                callback(null);
+                return;
+            }
+            callback(response);
+        }
+    },
+
+    __proto__: WebInspector.TargetAwareObject.prototype
 }
 
 WebInspector.DebuggerEventTypes = {
     JavaScriptPause: 0,
     JavaScriptBreakpoint: 1,
     NativeBreakpoint: 2
 };
 
 /**
  * @constructor
@@ skipping 66 matching lines @@
      * @param {!DebuggerAgent.Location} location
      */
     breakpointResolved: function(breakpointId, location)
     {
         this._debuggerModel._breakpointResolved(breakpointId, location);
     }
 }
 
 /**
  * @constructor
+ * @implements {WebInspector.RawLocation}
+ * @extends {WebInspector.TargetAware}
+ * @param {!WebInspector.Target} target
+ * @param {string} scriptId
+ * @param {number} lineNumber
+ * @param {number=} columnNumber
+ */
+WebInspector.DebuggerModel.Location = function(target, scriptId, lineNumber, columnNumber)
+{
+    WebInspector.TargetAware.call(this, target);
+    this._debuggerModel = target.debuggerModel;
+    this.scriptId = scriptId;
+    this.lineNumber = lineNumber;
+    this.columnNumber = columnNumber;
+}
+
+/**
+ * @param {!WebInspector.Target} target
+ * @param {!DebuggerAgent.Location} payload
+ */
+WebInspector.DebuggerModel.Location.fromPayload = function(target, payload)
+{
+    return new WebInspector.DebuggerModel.Location(target, payload.scriptId, payload.lineNumber, payload.columnNumber);
+}
+
+WebInspector.DebuggerModel.Location.prototype = {
+    /**
+     * @return {!DebuggerAgent.Location}
+     */
+    payload: function()
+    {
+        return { scriptId: this.scriptId, lineNumber: this.lineNumber, columnNumber: this.columnNumber };
+    },
+
+    /**
+     * @return {!WebInspector.Script}
+     */
+    script: function()
+    {
+        return this._debuggerModel.scriptForId(this.scriptId);
+    },
+
+    /**
+     * @param {function(!WebInspector.UILocation):(boolean|undefined)} updateDelegate
+     * @return {!WebInspector.Script.Location}
+     */
+    createLiveLocation: function(updateDelegate)
+    {
+        return this._debuggerModel.createLiveLocation(this, updateDelegate);
+    },
+
+    /**
+     * @return {?WebInspector.UILocation}
+     */
+    toUILocation: function()
+    {
+        return this._debuggerModel.rawLocationToUILocation(this);
+    },
+
+    continueToLocation: function()
+    {
+        this._debuggerModel._agent.continueToLocation(this.payload());
+    },
+
+    __proto__: WebInspector.TargetAware.prototype
+}
+
+/**
+ * @constructor
  * @extends {WebInspector.TargetAware}
  * @param {!WebInspector.Target} target
  * @param {!WebInspector.Script} script
  * @param {!DebuggerAgent.CallFrame} payload
  * @param {boolean=} isAsync
  */
 WebInspector.DebuggerModel.CallFrame = function(target, script, payload, isAsync)
 {
     WebInspector.TargetAware.call(this, target);
     this._debuggerAgent = target.debuggerModel._agent;
     this._script = script;
     this._payload = payload;
     /** @type {!Array.<!WebInspector.Script.Location>} */
-    this._locations = [];
+    this._liveLocations = [];
     this._isAsync = isAsync;
+    this._location = WebInspector.DebuggerModel.Location.fromPayload(target, payload.location);
 }
 
 /**
  * @param {!WebInspector.Target} target
  * @param {!Array.<!DebuggerAgent.CallFrame>} callFrames
  * @param {boolean=} isAsync
  * @return {!Array.<!WebInspector.DebuggerModel.CallFrame>}
  */
 WebInspector.DebuggerModel.CallFrame.fromPayloadArray = function(target, callFrames, isAsync)
 {
@@ skipping 61 matching lines @@
      * @return {string}
      */
     get functionName()
     {
         return this._payload.functionName;
     },
 
     /**
      * @return {!WebInspector.DebuggerModel.Location}
      */
-    get location()
+    location: function()
     {
-        var rawLocation = /** @type {!WebInspector.DebuggerModel.Location} */ (this._payload.location);
-        return rawLocation;
+        return this._location;
     },
 
     /**
      * @return {boolean}
      */
     isAsync: function()
     {
         return !!this._isAsync;
     },
 
@@ skipping 46 matching lines @@
         }
         this._debuggerAgent.restartFrame(this._payload.callFrameId, protocolCallback.bind(this));
     },
 
     /**
      * @param {function(!WebInspector.UILocation):(boolean|undefined)} updateDelegate
      * @return {!WebInspector.LiveLocation}
      */
     createLiveLocation: function(updateDelegate)
     {
-        var location = this._script.createLiveLocation(this.location, updateDelegate);
-        this._locations.push(location);
-        return location;
+        var liveLocation = this._location.createLiveLocation(updateDelegate);
+        this._liveLocations.push(liveLocation);
+        return liveLocation;
     },
 
     dispose: function()
     {
-        for (var i = 0; i < this._locations.length; ++i)
-            this._locations[i].dispose();
-        this._locations = [];
+        for (var i = 0; i < this._liveLocations.length; ++i)
+            this._liveLocations[i].dispose();
+        this._liveLocations = [];
     },
 
     __proto__: WebInspector.TargetAware.prototype
 }
 
 /**
  * @constructor
  * @param {!Array.<!WebInspector.DebuggerModel.CallFrame>} callFrames
  * @param {?WebInspector.DebuggerModel.StackTrace} asyncStackTrace
  * @param {string=} description
@@ skipping 71 matching lines @@
             this.asyncStackTrace.dispose();
     },
 
     __proto__: WebInspector.TargetAware.prototype
 }
 
 /**
  * @type {!WebInspector.DebuggerModel}
  */
 WebInspector.debuggerModel;