gecko/browser/devtools/debugger/CmdDebugger.jsm

607 lines
15 KiB
JavaScript

/* -*- Mode: javascript; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ft=javascript ts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
"use strict";
const { classes: Cc, interfaces: Ci, utils: Cu } = Components;
this.EXPORTED_SYMBOLS = [ ];
Cu.import("resource://gre/modules/devtools/gcli.jsm");
Cu.import('resource://gre/modules/XPCOMUtils.jsm');
XPCOMUtils.defineLazyModuleGetter(this, "gDevTools",
"resource:///modules/devtools/gDevTools.jsm");
XPCOMUtils.defineLazyModuleGetter(this, "console",
"resource://gre/modules/devtools/Console.jsm");
/**
* Utility to get access to the current breakpoint list
* @param dbg The debugger panel
* @returns an array of object, one for each breakpoint, where each breakpoint
* object has the following properties:
* - id: A unique identifier for the breakpoint. This is not designed to be
* shown to the user.
* - label: A unique string identifier designed to be user visible. In theory
* the label of a breakpoint could change
* - url: The URL of the source file
* - lineNumber: The line number of the breakpoint in the source file
* - lineText: The text of the line at the breakpoint
* - truncatedLineText: lineText truncated to MAX_LINE_TEXT_LENGTH
*/
function getAllBreakpoints(dbg) {
let breakpoints = [];
let sources = dbg.panelWin.DebuggerView.Sources;
let { trimUrlLength: tr } = dbg.panelWin.SourceUtils;
for (let source in sources) {
for (let { attachment: breakpoint } in source) {
breakpoints.push({
id: source.value + ":" + breakpoint.lineNumber,
label: source.label + ":" + breakpoint.lineNumber,
url: source.value,
lineNumber: breakpoint.lineNumber,
lineText: breakpoint.lineText,
truncatedLineText: tr(breakpoint.lineText, MAX_LINE_TEXT_LENGTH, "end")
});
}
}
return breakpoints;
}
/**
* 'break' command
*/
gcli.addCommand({
name: "break",
description: gcli.lookup("breakDesc"),
manual: gcli.lookup("breakManual")
});
/**
* 'break list' command
*/
gcli.addCommand({
name: "break list",
description: gcli.lookup("breaklistDesc"),
returnType: "breakpoints",
exec: function(args, context) {
let dbg = getPanel(context, "jsdebugger", { ensure_opened: true });
return dbg.then(function(dbg) {
return getAllBreakpoints(dbg);
});
}
});
gcli.addConverter({
from: "breakpoints",
to: "view",
exec: function(breakpoints, context) {
let dbg = getPanel(context, "jsdebugger");
if (dbg && breakpoints.length) {
return context.createView({
html: breakListHtml,
data: {
breakpoints: breakpoints,
onclick: context.update,
ondblclick: context.updateExec
}
});
} else {
return context.createView({
html: "<p>${message}</p>",
data: { message: gcli.lookup("breaklistNone") }
});
}
}
});
var breakListHtml = "" +
"<table>" +
" <thead>" +
" <th>Source</th>" +
" <th>Line</th>" +
" <th>Actions</th>" +
" </thead>" +
" <tbody>" +
" <tr foreach='breakpoint in ${breakpoints}'>" +
" <td class='gcli-breakpoint-label'>${breakpoint.label}</td>" +
" <td class='gcli-breakpoint-lineText'>" +
" ${breakpoint.truncatedLineText}" +
" </td>" +
" <td>" +
" <span class='gcli-out-shortcut'" +
" data-command='break del ${breakpoint.label}'" +
" onclick='${onclick}'" +
" ondblclick='${ondblclick}'>" +
" " + gcli.lookup("breaklistOutRemove") + "</span>" +
" </td>" +
" </tr>" +
" </tbody>" +
"</table>" +
"";
var MAX_LINE_TEXT_LENGTH = 30;
var MAX_LABEL_LENGTH = 20;
/**
* 'break add' command
*/
gcli.addCommand({
name: "break add",
description: gcli.lookup("breakaddDesc"),
manual: gcli.lookup("breakaddManual")
});
/**
* 'break add line' command
*/
gcli.addCommand({
name: "break add line",
description: gcli.lookup("breakaddlineDesc"),
params: [
{
name: "file",
type: {
name: "selection",
data: function(context) {
let dbg = getPanel(context, "jsdebugger");
if (dbg) {
return dbg.panelWin.DebuggerView.Sources.values;
}
return [];
}
},
description: gcli.lookup("breakaddlineFileDesc")
},
{
name: "line",
type: { name: "number", min: 1, step: 10 },
description: gcli.lookup("breakaddlineLineDesc")
}
],
returnType: "string",
exec: function(args, context) {
args.type = "line";
let dbg = getPanel(context, "jsdebugger");
if (!dbg) {
return gcli.lookup("debuggerStopped");
}
let deferred = context.defer();
let position = { url: args.file, line: args.line };
dbg.addBreakpoint(position, function(aBreakpoint, aError) {
if (aError) {
deferred.resolve(gcli.lookupFormat("breakaddFailed", [aError]));
return;
}
deferred.resolve(gcli.lookup("breakaddAdded"));
});
return deferred.promise;
}
});
/**
* 'break del' command
*/
gcli.addCommand({
name: "break del",
description: gcli.lookup("breakdelDesc"),
params: [
{
name: "breakpoint",
type: {
name: "selection",
lookup: function(context) {
let dbg = getPanel(context, "jsdebugger");
if (dbg == null) {
return [];
}
return getAllBreakpoints(dbg).map(breakpoint => {
return {
name: breakpoint.label,
value: breakpoint,
description: breakpoint.truncatedLineText
};
});
}
},
description: gcli.lookup("breakdelBreakidDesc")
}
],
returnType: "string",
exec: function(args, context) {
let dbg = getPanel(context, "jsdebugger");
if (!dbg) {
return gcli.lookup("debuggerStopped");
}
let breakpoint = dbg.getBreakpoint(
args.breakpoint.url, args.breakpoint.lineNumber);
if (breakpoint == null) {
return gcli.lookup("breakNotFound");
}
let deferred = context.defer();
try {
dbg.removeBreakpoint(breakpoint, function() {
deferred.resolve(gcli.lookup("breakdelRemoved"));
});
} catch (ex) {
console.error('Error removing breakpoint, already removed?', ex);
// If the debugger has been closed already, don't scare the user.
deferred.resolve(gcli.lookup("breakdelRemoved"));
}
return deferred.promise;
}
});
/**
* 'dbg' command
*/
gcli.addCommand({
name: "dbg",
description: gcli.lookup("dbgDesc"),
manual: gcli.lookup("dbgManual")
});
/**
* 'dbg open' command
*/
gcli.addCommand({
name: "dbg open",
description: gcli.lookup("dbgOpen"),
params: [],
exec: function(args, context) {
return gDevTools.showToolbox(context.environment.target, "jsdebugger")
.then(() => null);
}
});
/**
* 'dbg close' command
*/
gcli.addCommand({
name: "dbg close",
description: gcli.lookup("dbgClose"),
params: [],
exec: function(args, context) {
if (!getPanel(context, "jsdebugger"))
return;
return gDevTools.closeToolbox(context.environment.target)
.then(() => null);
}
});
/**
* 'dbg interrupt' command
*/
gcli.addCommand({
name: "dbg interrupt",
description: gcli.lookup("dbgInterrupt"),
params: [],
exec: function(args, context) {
let dbg = getPanel(context, "jsdebugger");
if (!dbg) {
return gcli.lookup("debuggerStopped");
}
let controller = dbg._controller;
let thread = controller.activeThread;
if (!thread.paused) {
thread.interrupt();
}
}
});
/**
* 'dbg continue' command
*/
gcli.addCommand({
name: "dbg continue",
description: gcli.lookup("dbgContinue"),
params: [],
exec: function(args, context) {
let dbg = getPanel(context, "jsdebugger");
if (!dbg) {
return gcli.lookup("debuggerStopped");
}
let controller = dbg._controller;
let thread = controller.activeThread;
if (thread.paused) {
thread.resume();
}
}
});
/**
* 'dbg step' command
*/
gcli.addCommand({
name: "dbg step",
description: gcli.lookup("dbgStepDesc"),
manual: gcli.lookup("dbgStepManual")
});
/**
* 'dbg step over' command
*/
gcli.addCommand({
name: "dbg step over",
description: gcli.lookup("dbgStepOverDesc"),
params: [],
exec: function(args, context) {
let dbg = getPanel(context, "jsdebugger");
if (!dbg) {
return gcli.lookup("debuggerStopped");
}
let controller = dbg._controller;
let thread = controller.activeThread;
if (thread.paused) {
thread.stepOver();
}
}
});
/**
* 'dbg step in' command
*/
gcli.addCommand({
name: 'dbg step in',
description: gcli.lookup("dbgStepInDesc"),
params: [],
exec: function(args, context) {
let dbg = getPanel(context, "jsdebugger");
if (!dbg) {
return gcli.lookup("debuggerStopped");
}
let controller = dbg._controller;
let thread = controller.activeThread;
if (thread.paused) {
thread.stepIn();
}
}
});
/**
* 'dbg step over' command
*/
gcli.addCommand({
name: 'dbg step out',
description: gcli.lookup("dbgStepOutDesc"),
params: [],
exec: function(args, context) {
let dbg = getPanel(context, "jsdebugger");
if (!dbg) {
return gcli.lookup("debuggerStopped");
}
let controller = dbg._controller;
let thread = controller.activeThread;
if (thread.paused) {
thread.stepOut();
}
}
});
/**
* 'dbg list' command
*/
gcli.addCommand({
name: "dbg list",
description: gcli.lookup("dbgListSourcesDesc"),
params: [],
returnType: "dom",
exec: function(args, context) {
let dbg = getPanel(context, "jsdebugger");
let doc = context.environment.chromeDocument;
if (!dbg) {
return gcli.lookup("debuggerClosed");
}
let sources = dbg._view.Sources.values;
let div = createXHTMLElement(doc, "div");
let ol = createXHTMLElement(doc, "ol");
sources.forEach(function(src) {
let li = createXHTMLElement(doc, "li");
li.textContent = src;
ol.appendChild(li);
});
div.appendChild(ol);
return div;
}
});
/**
* Define the 'dbg blackbox' and 'dbg unblackbox' commands.
*/
[
{
name: "blackbox",
clientMethod: "blackBox",
l10nPrefix: "dbgBlackBox"
},
{
name: "unblackbox",
clientMethod: "unblackBox",
l10nPrefix: "dbgUnBlackBox"
}
].forEach(function (cmd) {
const lookup = function (id) {
return gcli.lookup(cmd.l10nPrefix + id);
};
gcli.addCommand({
name: "dbg " + cmd.name,
description: lookup("Desc"),
params: [
{
name: "source",
type: {
name: "selection",
data: function (context) {
let dbg = getPanel(context, "jsdebugger");
return dbg
? [s for (s of dbg._view.Sources.values)]
: [];
}
},
description: lookup("SourceDesc"),
defaultValue: null
},
{
name: "glob",
type: "string",
description: lookup("GlobDesc"),
defaultValue: null
},
{
name: "invert",
type: "boolean",
description: lookup("InvertDesc")
}
],
returnType: "dom",
exec: function (args, context) {
const dbg = getPanel(context, "jsdebugger");
const doc = context.environment.chromeDocument;
if (!dbg) {
throw new Error(gcli.lookup("debuggerClosed"));
}
const { promise, resolve, reject } = context.defer();
const { activeThread } = dbg._controller;
const globRegExp = args.glob
? globToRegExp(args.glob)
: null;
// Filter the sources down to those that we will need to black box.
function shouldBlackBox(source) {
var value = globRegExp && globRegExp.test(source.url)
|| args.source && source.url == args.source;
return args.invert ? !value : value;
}
const toBlackBox = [s.attachment.source
for (s of dbg._view.Sources.items)
if (shouldBlackBox(s.attachment.source))];
// If we aren't black boxing any sources, bail out now.
if (toBlackBox.length === 0) {
const empty = createXHTMLElement(doc, "div");
empty.textContent = lookup("EmptyDesc");
return void resolve(empty);
}
// Send the black box request to each source we are black boxing. As we
// get responses, accumulate the results in `blackBoxed`.
const blackBoxed = [];
for (let source of toBlackBox) {
let { url } = source;
activeThread.source(source)[cmd.clientMethod](function ({ error }) {
if (error) {
blackBoxed.push(lookup("ErrorDesc") + " " + url);
} else {
blackBoxed.push(url);
}
if (toBlackBox.length === blackBoxed.length) {
displayResults();
}
});
}
// List the results for the user.
function displayResults() {
const results = doc.createElement("div");
results.textContent = lookup("NonEmptyDesc");
const list = createXHTMLElement(doc, "ul");
results.appendChild(list);
for (let result of blackBoxed) {
const item = createXHTMLElement(doc, "li");
item.textContent = result;
list.appendChild(item);
}
resolve(results);
}
return promise;
}
});
});
/**
* A helper to create xhtml namespaced elements
*/
function createXHTMLElement(document, tagname) {
return document.createElementNS("http://www.w3.org/1999/xhtml", tagname);
}
/**
* A helper to go from a command context to a debugger panel
*/
function getPanel(context, id, options = {}) {
if (context == null) {
return undefined;
}
let target = context.environment.target;
if (options.ensure_opened) {
return gDevTools.showToolbox(target, id).then(function(toolbox) {
return toolbox.getPanel(id);
});
} else {
let toolbox = gDevTools.getToolbox(target);
if (toolbox) {
return toolbox.getPanel(id);
} else {
return undefined;
}
}
}
/**
* Converts a glob to a regular expression
*/
function globToRegExp(glob) {
const reStr = glob
// Escape existing regular expression syntax
.replace(/\\/g, "\\\\")
.replace(/\//g, "\\/")
.replace(/\^/g, "\\^")
.replace(/\$/g, "\\$")
.replace(/\+/g, "\\+")
.replace(/\?/g, "\\?")
.replace(/\./g, "\\.")
.replace(/\(/g, "\\(")
.replace(/\)/g, "\\)")
.replace(/\=/g, "\\=")
.replace(/\!/g, "\\!")
.replace(/\|/g, "\\|")
.replace(/\{/g, "\\{")
.replace(/\}/g, "\\}")
.replace(/\,/g, "\\,")
.replace(/\[/g, "\\[")
.replace(/\]/g, "\\]")
.replace(/\-/g, "\\-")
// Turn * into the match everything wildcard
.replace(/\*/g, ".*")
return new RegExp("^" + reStr + "$");
}