blob: 6acf340fb7113c09967c5e8a7aa622b129ca13a9 [file] [log] [blame]
/*
* Copyright (C) 2012 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
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "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 THE COPYRIGHT
* OWNER 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.
*/
/**
* @implements {Bindings.DebuggerSourceMapping}
* @unrestricted
*/
Bindings.ResourceScriptMapping = class {
/**
* @param {!SDK.DebuggerModel} debuggerModel
* @param {!Workspace.Workspace} workspace
* @param {!Bindings.NetworkMapping} networkMapping
* @param {!Bindings.DebuggerWorkspaceBinding} debuggerWorkspaceBinding
*/
constructor(debuggerModel, workspace, networkMapping, debuggerWorkspaceBinding) {
this._target = debuggerModel.target();
this._debuggerModel = debuggerModel;
this._networkMapping = networkMapping;
this._debuggerWorkspaceBinding = debuggerWorkspaceBinding;
/** @type {!Set<!Workspace.UISourceCode>} */
this._boundUISourceCodes = new Set();
/** @type {!Map.<!Workspace.UISourceCode, !Bindings.ResourceScriptFile>} */
this._uiSourceCodeToScriptFile = new Map();
this._eventListeners = [
debuggerModel.addEventListener(SDK.DebuggerModel.Events.GlobalObjectCleared, this._debuggerReset, this),
workspace.addEventListener(Workspace.Workspace.Events.UISourceCodeAdded, this._uiSourceCodeAdded, this),
workspace.addEventListener(Workspace.Workspace.Events.UISourceCodeRemoved, this._uiSourceCodeRemoved, this)
];
}
/**
* @override
* @param {!SDK.DebuggerModel.Location} rawLocation
* @return {?Workspace.UILocation}
*/
rawLocationToUILocation(rawLocation) {
var debuggerModelLocation = /** @type {!SDK.DebuggerModel.Location} */ (rawLocation);
var script = debuggerModelLocation.script();
if (!script)
return null;
var uiSourceCode = this._workspaceUISourceCodeForScript(script);
if (!uiSourceCode)
return null;
var scriptFile = this.scriptFile(uiSourceCode);
if (scriptFile &&
((scriptFile.hasDivergedFromVM() && !scriptFile.isMergingToVM()) || scriptFile.isDivergingFromVM()))
return null;
var lineNumber = debuggerModelLocation.lineNumber - (script.isInlineScriptWithSourceURL() ? script.lineOffset : 0);
var columnNumber = debuggerModelLocation.columnNumber || 0;
if (script.isInlineScriptWithSourceURL() && !lineNumber && columnNumber)
columnNumber -= script.columnOffset;
return uiSourceCode.uiLocation(lineNumber, columnNumber);
}
/**
* @override
* @param {!Workspace.UISourceCode} uiSourceCode
* @param {number} lineNumber
* @param {number} columnNumber
* @return {?SDK.DebuggerModel.Location}
*/
uiLocationToRawLocation(uiSourceCode, lineNumber, columnNumber) {
var scripts = this._scriptsForUISourceCode(uiSourceCode);
console.assert(scripts.length);
var script = scripts[scripts.length - 1];
if (script.isInlineScriptWithSourceURL())
return this._debuggerModel.createRawLocation(
script, lineNumber + script.lineOffset, lineNumber ? columnNumber : columnNumber + script.columnOffset);
return this._debuggerModel.createRawLocation(script, lineNumber, columnNumber);
}
/**
* @param {!SDK.Script} script
*/
addScript(script) {
if (script.isAnonymousScript())
return;
this._debuggerWorkspaceBinding.pushSourceMapping(script, this);
var uiSourceCode = this._workspaceUISourceCodeForScript(script);
if (!uiSourceCode)
return;
this._bindUISourceCodeToScripts(uiSourceCode, [script]);
}
/**
* @override
* @return {boolean}
*/
isIdentity() {
return true;
}
/**
* @override
* @param {!Workspace.UISourceCode} uiSourceCode
* @param {number} lineNumber
* @return {boolean}
*/
uiLineHasMapping(uiSourceCode, lineNumber) {
return true;
}
/**
* @param {!Workspace.UISourceCode} uiSourceCode
* @return {?Bindings.ResourceScriptFile}
*/
scriptFile(uiSourceCode) {
return this._uiSourceCodeToScriptFile.get(uiSourceCode) || null;
}
/**
* @param {!Workspace.UISourceCode} uiSourceCode
* @param {?Bindings.ResourceScriptFile} scriptFile
*/
_setScriptFile(uiSourceCode, scriptFile) {
if (scriptFile)
this._uiSourceCodeToScriptFile.set(uiSourceCode, scriptFile);
else
this._uiSourceCodeToScriptFile.remove(uiSourceCode);
}
/**
* @param {!Common.Event} event
*/
_uiSourceCodeAdded(event) {
var uiSourceCode = /** @type {!Workspace.UISourceCode} */ (event.data);
if (uiSourceCode.isFromServiceProject())
return;
var scripts = this._scriptsForUISourceCode(uiSourceCode);
if (!scripts.length)
return;
this._bindUISourceCodeToScripts(uiSourceCode, scripts);
}
/**
* @param {!Common.Event} event
*/
_uiSourceCodeRemoved(event) {
var uiSourceCode = /** @type {!Workspace.UISourceCode} */ (event.data);
if (uiSourceCode.isFromServiceProject() || !this._boundUISourceCodes.has(uiSourceCode))
return;
this._unbindUISourceCode(uiSourceCode);
}
/**
* @param {!Workspace.UISourceCode} uiSourceCode
*/
_updateLocations(uiSourceCode) {
var scripts = this._scriptsForUISourceCode(uiSourceCode);
if (!scripts.length)
return;
for (var i = 0; i < scripts.length; ++i)
this._debuggerWorkspaceBinding.updateLocations(scripts[i]);
}
/**
* @param {!SDK.Script} script
* @return {?Workspace.UISourceCode}
*/
_workspaceUISourceCodeForScript(script) {
if (script.isAnonymousScript())
return null;
return this._networkMapping.uiSourceCodeForScriptURL(script.sourceURL, script);
}
/**
* @param {!Workspace.UISourceCode} uiSourceCode
* @return {!Array.<!SDK.Script>}
*/
_scriptsForUISourceCode(uiSourceCode) {
var target = Bindings.NetworkProject.targetForUISourceCode(uiSourceCode);
if (target !== this._debuggerModel.target())
return [];
return this._debuggerModel.scriptsForSourceURL(uiSourceCode.url());
}
/**
* @param {!Workspace.UISourceCode} uiSourceCode
* @param {!Array.<!SDK.Script>} scripts
*/
_bindUISourceCodeToScripts(uiSourceCode, scripts) {
console.assert(scripts.length);
// Due to different listeners order, a script file could be created just before uiSourceCode
// for the corresponding script was created. Check that we don't create scriptFile twice.
var boundScriptFile = this.scriptFile(uiSourceCode);
if (boundScriptFile && boundScriptFile._hasScripts(scripts))
return;
var scriptFile = new Bindings.ResourceScriptFile(this, uiSourceCode, scripts);
this._setScriptFile(uiSourceCode, scriptFile);
for (var i = 0; i < scripts.length; ++i)
this._debuggerWorkspaceBinding.updateLocations(scripts[i]);
this._debuggerWorkspaceBinding.setSourceMapping(this._target, uiSourceCode, this);
this._boundUISourceCodes.add(uiSourceCode);
}
/**
* @param {!Workspace.UISourceCode} uiSourceCode
*/
_unbindUISourceCode(uiSourceCode) {
var scriptFile = this.scriptFile(uiSourceCode);
if (scriptFile) {
scriptFile.dispose();
this._setScriptFile(uiSourceCode, null);
}
this._debuggerWorkspaceBinding.setSourceMapping(this._target, uiSourceCode, null);
this._boundUISourceCodes.delete(uiSourceCode);
}
_debuggerReset() {
for (var uiSourceCode of this._boundUISourceCodes.valuesArray())
this._unbindUISourceCode(uiSourceCode);
this._boundUISourceCodes.clear();
console.assert(!this._uiSourceCodeToScriptFile.size);
}
dispose() {
Common.EventTarget.removeEventListeners(this._eventListeners);
this._debuggerReset();
}
};
/**
* @unrestricted
*/
Bindings.ResourceScriptFile = class extends Common.Object {
/**
* @param {!Bindings.ResourceScriptMapping} resourceScriptMapping
* @param {!Workspace.UISourceCode} uiSourceCode
* @param {!Array.<!SDK.Script>} scripts
*/
constructor(resourceScriptMapping, uiSourceCode, scripts) {
super();
console.assert(scripts.length);
this._resourceScriptMapping = resourceScriptMapping;
this._uiSourceCode = uiSourceCode;
if (this._uiSourceCode.contentType().isScript())
this._script = scripts[scripts.length - 1];
this._uiSourceCode.addEventListener(
Workspace.UISourceCode.Events.WorkingCopyChanged, this._workingCopyChanged, this);
this._uiSourceCode.addEventListener(
Workspace.UISourceCode.Events.WorkingCopyCommitted, this._workingCopyCommitted, this);
}
/**
* @param {!Array.<!SDK.Script>} scripts
* @return {boolean}
*/
_hasScripts(scripts) {
return this._script && this._script === scripts[0];
}
/**
* @return {boolean}
*/
_isDiverged() {
if (this._uiSourceCode.isDirty())
return true;
if (!this._script)
return false;
if (typeof this._scriptSource === 'undefined')
return false;
var workingCopy = this._uiSourceCode.workingCopy();
// Match ignoring sourceURL.
if (!workingCopy.startsWith(this._scriptSource.trimRight()))
return true;
var suffix = this._uiSourceCode.workingCopy().substr(this._scriptSource.length);
return !!suffix.length && !suffix.match(SDK.Script.sourceURLRegex);
}
/**
* @param {!Common.Event} event
*/
_workingCopyChanged(event) {
this._update();
}
_workingCopyCommitted(event) {
if (this._uiSourceCode.project().type() === Workspace.projectTypes.Snippets)
return;
if (!this._script)
return;
var debuggerModel = this._resourceScriptMapping._debuggerModel;
var source = this._uiSourceCode.workingCopy();
debuggerModel.setScriptSource(this._script.scriptId, source, scriptSourceWasSet.bind(this));
/**
* @param {?string} error
* @param {!Protocol.Runtime.ExceptionDetails=} exceptionDetails
* @this {Bindings.ResourceScriptFile}
*/
function scriptSourceWasSet(error, exceptionDetails) {
if (!error && !exceptionDetails)
this._scriptSource = source;
this._update();
if (!error && !exceptionDetails)
return;
if (!exceptionDetails) {
Common.console.addMessage(
Common.UIString('LiveEdit failed: %s', error), Common.Console.MessageLevel.Warning);
return;
}
var messageText = Common.UIString('LiveEdit compile failed: %s', exceptionDetails.text);
this._uiSourceCode.addLineMessage(
Workspace.UISourceCode.Message.Level.Error, messageText, exceptionDetails.lineNumber,
exceptionDetails.columnNumber);
}
}
_update() {
if (this._isDiverged() && !this._hasDivergedFromVM)
this._divergeFromVM();
else if (!this._isDiverged() && this._hasDivergedFromVM)
this._mergeToVM();
}
_divergeFromVM() {
this._isDivergingFromVM = true;
this._resourceScriptMapping._updateLocations(this._uiSourceCode);
delete this._isDivergingFromVM;
this._hasDivergedFromVM = true;
this.dispatchEventToListeners(Bindings.ResourceScriptFile.Events.DidDivergeFromVM, this._uiSourceCode);
}
_mergeToVM() {
delete this._hasDivergedFromVM;
this._isMergingToVM = true;
this._resourceScriptMapping._updateLocations(this._uiSourceCode);
delete this._isMergingToVM;
this.dispatchEventToListeners(Bindings.ResourceScriptFile.Events.DidMergeToVM, this._uiSourceCode);
}
/**
* @return {boolean}
*/
hasDivergedFromVM() {
return this._hasDivergedFromVM;
}
/**
* @return {boolean}
*/
isDivergingFromVM() {
return this._isDivergingFromVM;
}
/**
* @return {boolean}
*/
isMergingToVM() {
return this._isMergingToVM;
}
checkMapping() {
if (!this._script || typeof this._scriptSource !== 'undefined') {
this._mappingCheckedForTest();
return;
}
this._script.requestContent().then(callback.bind(this));
/**
* @param {?string} source
* @this {Bindings.ResourceScriptFile}
*/
function callback(source) {
this._scriptSource = source;
this._update();
this._mappingCheckedForTest();
}
}
_mappingCheckedForTest() {
}
/**
* @return {?SDK.Target}
*/
target() {
if (!this._script)
return null;
return this._script.target();
}
dispose() {
this._uiSourceCode.removeEventListener(
Workspace.UISourceCode.Events.WorkingCopyChanged, this._workingCopyChanged, this);
this._uiSourceCode.removeEventListener(
Workspace.UISourceCode.Events.WorkingCopyCommitted, this._workingCopyCommitted, this);
}
/**
* @param {string} sourceMapURL
*/
addSourceMapURL(sourceMapURL) {
if (!this._script)
return;
this._script.addSourceMapURL(sourceMapURL);
}
/**
* @return {boolean}
*/
hasSourceMapURL() {
return this._script && !!this._script.sourceMapURL;
}
};
/** @enum {symbol} */
Bindings.ResourceScriptFile.Events = {
DidMergeToVM: Symbol('DidMergeToVM'),
DidDivergeFromVM: Symbol('DidDivergeFromVM'),
};