6e4f4ac7bd
We used to rely on the TabActor a lot in /toolkit/devtools/server/actors/highlighter. This object was being passed around to various highlighter classes, helper classes and functions. It was a useful way to get access to the window the highlighters are shown, listen to DOM events in that window, and also listen to tabActor's will-navigate events. Using this object isn't the best idea because it assumes the debugger server is started and attached to a tab, which makes re-using highlighters outside of this context impossible (or harder). Plus we wanted to get rid of the tabActor reference in gcli command contexts. This change introduces a HighlighterEnvironment that fulfills the requirements above without relying on a tabActor. It needs to be initialized either with a tabActor, when we have one (when using the highlighter from the inspector panel), or with a window (which is what gcli commands will use). This change also fixes the highlight command and the rulers command (which didn't work well with e10s either).
96 lines
3.3 KiB
JavaScript
96 lines
3.3 KiB
JavaScript
/* 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 EventEmitter = require("devtools/toolkit/event-emitter");
|
|
const eventEmitter = new EventEmitter();
|
|
const events = require("sdk/event/core");
|
|
|
|
const l10n = require("gcli/l10n");
|
|
require("devtools/server/actors/inspector");
|
|
const { RulersHighlighter, HighlighterEnvironment } =
|
|
require("devtools/server/actors/highlighter");
|
|
|
|
const highlighters = new WeakMap();
|
|
let isRulersVisible = false;
|
|
|
|
exports.items = [
|
|
// The client rulers command is used to maintain the toolbar button state only
|
|
// and redirects to the server command to actually toggle the rulers (see
|
|
// rulers_server below).
|
|
{
|
|
name: "rulers",
|
|
runAt: "client",
|
|
description: l10n.lookup("rulersDesc"),
|
|
manual: l10n.lookup("rulersManual"),
|
|
buttonId: "command-button-rulers",
|
|
buttonClass: "command-button command-button-invertable",
|
|
tooltipText: l10n.lookup("rulersTooltip"),
|
|
state: {
|
|
isChecked: () => isRulersVisible,
|
|
onChange: (target, handler) => eventEmitter.on("changed", handler),
|
|
offChange: (target, handler) => eventEmitter.off("changed", handler)
|
|
},
|
|
exec: function*(args, context) {
|
|
let { target } = context.environment;
|
|
|
|
// Pipe the call to the server command.
|
|
let response = yield context.updateExec("rulers_server");
|
|
isRulersVisible = response.data;
|
|
eventEmitter.emit("changed", { target });
|
|
|
|
// Toggle off the button when the page navigates because the rulers are
|
|
// removed automatically by the RulersHighlighter on the server then.
|
|
let onNavigate = () => {
|
|
isRulersVisible = false;
|
|
eventEmitter.emit("changed", { target });
|
|
};
|
|
target.off("will-navigate", onNavigate);
|
|
target.once("will-navigate", onNavigate);
|
|
}
|
|
},
|
|
// The server rulers command is hidden by default, it's just used by the
|
|
// client command.
|
|
{
|
|
name: "rulers_server",
|
|
runAt: "server",
|
|
hidden: true,
|
|
exec: function(args, context) {
|
|
let env = context.environment;
|
|
|
|
// Calling the command again after the rulers have been shown once hides
|
|
// them.
|
|
if (highlighters.has(env.document)) {
|
|
let { highlighter, environment } = highlighters.get(env.document);
|
|
highlighter.destroy();
|
|
environment.destroy();
|
|
return false;
|
|
}
|
|
|
|
// Otherwise, display the rulers.
|
|
let environment = new HighlighterEnvironment();
|
|
environment.initFromWindow(env.window);
|
|
let highlighter = new RulersHighlighter(environment);
|
|
|
|
// Store the instance of the rulers highlighter for this document so we
|
|
// can hide it later.
|
|
highlighters.set(env.document, { highlighter, environment });
|
|
|
|
// Listen to the highlighter's destroy event which may happen if the
|
|
// window is refreshed or closed with the rulers shown.
|
|
events.once(highlighter, "destroy", () => {
|
|
if (highlighters.has(env.document)) {
|
|
let { environment } = highlighters.get(env.document);
|
|
environment.destroy();
|
|
highlighters.delete(env.document);
|
|
}
|
|
});
|
|
|
|
highlighter.show();
|
|
return true;
|
|
}
|
|
}
|
|
];
|