fune/devtools/client/shared/widgets/tooltip/EventTooltipHelper.js
Tom Tromey ea788b5b50 Bug 1333352 - use client-side source map service in markup view event bubble; r=jdescottes
MozReview-Commit-ID: D8bF5kkHp2p

--HG--
extra : rebase_source : 88ff42bbedbd844dee3360c132f40ec8188aa692
2017-05-12 14:34:26 -06:00

319 lines
10 KiB
JavaScript

/* -*- indent-tabs-mode: nil; js-indent-level: 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 {LocalizationHelper} = require("devtools/shared/l10n");
const L10N = new LocalizationHelper("devtools/client/locales/inspector.properties");
const Editor = require("devtools/client/sourceeditor/editor");
const beautify = require("devtools/shared/jsbeautify/beautify");
const XHTML_NS = "http://www.w3.org/1999/xhtml";
const CONTAINER_WIDTH = 500;
/**
* Set the content of a provided HTMLTooltip instance to display a list of event
* listeners, with their event type, capturing argument and a link to the code
* of the event handler.
*
* @param {HTMLTooltip} tooltip
* The tooltip instance on which the event details content should be set
* @param {Array} eventListenerInfos
* A list of event listeners
* @param {Toolbox} toolbox
* Toolbox used to select debugger panel
*/
function setEventTooltip(tooltip, eventListenerInfos, toolbox) {
let eventTooltip = new EventTooltip(tooltip, eventListenerInfos, toolbox);
eventTooltip.init();
}
function EventTooltip(tooltip, eventListenerInfos, toolbox) {
this._tooltip = tooltip;
this._eventListenerInfos = eventListenerInfos;
this._toolbox = toolbox;
this._eventEditors = new WeakMap();
// Used in tests: add a reference to the EventTooltip instance on the HTMLTooltip.
this._tooltip.eventTooltip = this;
this._headerClicked = this._headerClicked.bind(this);
this._debugClicked = this._debugClicked.bind(this);
this.destroy = this.destroy.bind(this);
}
EventTooltip.prototype = {
init: function () {
let config = {
mode: Editor.modes.js,
lineNumbers: false,
lineWrapping: true,
readOnly: true,
styleActiveLine: true,
extraKeys: {},
theme: "mozilla markup-view"
};
let doc = this._tooltip.doc;
this.container = doc.createElementNS(XHTML_NS, "div");
this.container.className = "devtools-tooltip-events-container";
const sourceMapService = this._toolbox.sourceMapURLService;
for (let listener of this._eventListenerInfos) {
let phase = listener.capturing ? "Capturing" : "Bubbling";
let level = listener.DOM0 ? "DOM0" : "DOM2";
// Create this early so we can refer to it from a closure, below.
let content = doc.createElementNS(XHTML_NS, "div");
// Header
let header = doc.createElementNS(XHTML_NS, "div");
header.className = "event-header devtools-toolbar";
this.container.appendChild(header);
if (!listener.hide.debugger) {
let debuggerIcon = doc.createElementNS(XHTML_NS, "img");
debuggerIcon.className = "event-tooltip-debugger-icon";
debuggerIcon.setAttribute("src",
"chrome://devtools/skin/images/tool-debugger.svg");
let openInDebugger = L10N.getStr("eventsTooltip.openInDebugger");
debuggerIcon.setAttribute("title", openInDebugger);
header.appendChild(debuggerIcon);
} else {
let debuggerDiv = doc.createElementNS(XHTML_NS, "div");
debuggerDiv.className = "event-tooltip-debugger-spacer";
header.appendChild(debuggerDiv);
}
if (!listener.hide.type) {
let eventTypeLabel = doc.createElementNS(XHTML_NS, "span");
eventTypeLabel.className = "event-tooltip-event-type";
eventTypeLabel.textContent = listener.type;
eventTypeLabel.setAttribute("title", listener.type);
header.appendChild(eventTypeLabel);
}
let filename = doc.createElementNS(XHTML_NS, "span");
filename.className = "event-tooltip-filename devtools-monospace";
let text = listener.origin;
let title = text;
if (listener.hide.filename) {
text = L10N.getStr("eventsTooltip.unknownLocation");
title = L10N.getStr("eventsTooltip.unknownLocationExplanation");
} else if (sourceMapService) {
const location = this._parseLocation(text);
if (location) {
sourceMapService.originalPositionFor(location.url, location.line)
.then((originalLocation) => {
if (originalLocation) {
const { sourceUrl, line } = originalLocation;
let newURI = sourceUrl + ":" + line;
filename.textContent = newURI;
filename.setAttribute("title", newURI);
let eventEditor = this._eventEditors.get(content);
eventEditor.uri = newURI;
}
// This is emitted for testing.
this._tooltip.emit("event-tooltip-source-map-ready");
});
}
}
filename.textContent = text;
filename.setAttribute("title", title);
header.appendChild(filename);
let attributesContainer = doc.createElementNS(XHTML_NS, "div");
attributesContainer.className = "event-tooltip-attributes-container";
header.appendChild(attributesContainer);
if (!listener.hide.capturing) {
let attributesBox = doc.createElementNS(XHTML_NS, "div");
attributesBox.className = "event-tooltip-attributes-box";
attributesContainer.appendChild(attributesBox);
let capturing = doc.createElementNS(XHTML_NS, "span");
capturing.className = "event-tooltip-attributes";
capturing.textContent = phase;
capturing.setAttribute("title", phase);
attributesBox.appendChild(capturing);
}
if (listener.tags) {
for (let tag of listener.tags.split(",")) {
let attributesBox = doc.createElementNS(XHTML_NS, "div");
attributesBox.className = "event-tooltip-attributes-box";
attributesContainer.appendChild(attributesBox);
let tagBox = doc.createElementNS(XHTML_NS, "span");
tagBox.className = "event-tooltip-attributes";
tagBox.textContent = tag;
tagBox.setAttribute("title", tag);
attributesBox.appendChild(tagBox);
}
}
if (!listener.hide.dom0) {
let attributesBox = doc.createElementNS(XHTML_NS, "div");
attributesBox.className = "event-tooltip-attributes-box";
attributesContainer.appendChild(attributesBox);
let dom0 = doc.createElementNS(XHTML_NS, "span");
dom0.className = "event-tooltip-attributes";
dom0.textContent = level;
dom0.setAttribute("title", level);
attributesBox.appendChild(dom0);
}
// Content
let editor = new Editor(config);
this._eventEditors.set(content, {
editor: editor,
handler: listener.handler,
uri: listener.origin,
dom0: listener.DOM0,
native: listener.native,
appended: false,
});
content.className = "event-tooltip-content-box";
this.container.appendChild(content);
this._addContentListeners(header);
}
this._tooltip.setContent(this.container, {width: CONTAINER_WIDTH});
this._tooltip.on("hidden", this.destroy);
},
_addContentListeners: function (header) {
header.addEventListener("click", this._headerClicked);
},
_headerClicked: function (event) {
if (event.target.classList.contains("event-tooltip-debugger-icon")) {
this._debugClicked(event);
event.stopPropagation();
return;
}
let doc = this._tooltip.doc;
let header = event.currentTarget;
let content = header.nextElementSibling;
if (content.hasAttribute("open")) {
content.removeAttribute("open");
} else {
let contentNodes = doc.querySelectorAll(".event-tooltip-content-box");
for (let node of contentNodes) {
if (node !== content) {
node.removeAttribute("open");
}
}
content.setAttribute("open", "");
let eventEditor = this._eventEditors.get(content);
if (eventEditor.appended) {
return;
}
let {editor, handler} = eventEditor;
let iframe = doc.createElementNS(XHTML_NS, "iframe");
iframe.setAttribute("style", "width: 100%; height: 100%; border-style: none;");
editor.appendTo(content, iframe).then(() => {
let tidied = beautify.js(handler, { "indent_size": 2 });
editor.setText(tidied);
eventEditor.appended = true;
let container = header.parentElement.getBoundingClientRect();
if (header.getBoundingClientRect().top < container.top) {
header.scrollIntoView(true);
} else if (content.getBoundingClientRect().bottom > container.bottom) {
content.scrollIntoView(false);
}
this._tooltip.emit("event-tooltip-ready");
});
}
},
_debugClicked: function (event) {
let header = event.currentTarget;
let content = header.nextElementSibling;
let {uri} = this._eventEditors.get(content);
let location = this._parseLocation(uri);
if (location) {
// Save a copy of toolbox as it will be set to null when we hide the tooltip.
let toolbox = this._toolbox;
this._tooltip.hide();
toolbox.viewSourceInDebugger(location.url, location.line);
}
},
/**
* Parse URI and return {url, line}; or return null if it can't be parsed.
*/
_parseLocation: function (uri) {
if (uri && uri !== "?") {
uri = uri.replace(/"/g, "");
let matches = uri.match(/(.*):(\d+$)/);
if (matches) {
return {
url: matches[1],
line: parseInt(matches[2], 10),
};
}
return {url: uri, line: 1};
}
return null;
},
destroy: function () {
if (this._tooltip) {
this._tooltip.off("hidden", this.destroy);
let boxes = this.container.querySelectorAll(".event-tooltip-content-box");
for (let box of boxes) {
let {editor} = this._eventEditors.get(box);
editor.destroy();
}
this._eventEditors = null;
this._tooltip.eventTooltip = null;
}
let headerNodes = this.container.querySelectorAll(".event-header");
for (let node of headerNodes) {
node.removeEventListener("click", this._headerClicked);
}
let sourceNodes = this.container.querySelectorAll(".event-tooltip-debugger-icon");
for (let node of sourceNodes) {
node.removeEventListener("click", this._debugClicked);
}
this._eventListenerInfos = this._toolbox = this._tooltip = null;
}
};
module.exports.setEventTooltip = setEventTooltip;