mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-26 19:55:39 +00:00
cd1a0703b1
MozReview-Commit-ID: 8uN2VBIyYyt --HG-- extra : rebase_source : 48902adf1dc5ac193d2b2719cf72b499a40e7d81
117 lines
3.4 KiB
JavaScript
117 lines
3.4 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/. */
|
|
|
|
/**
|
|
* @fileOverview
|
|
* This module contains utilities for interacting with DevTools
|
|
* from the child process.
|
|
*/
|
|
|
|
"use strict";
|
|
|
|
this.EXPORTED_SYMBOLS = ["ExtensionChildDevToolsUtils"];
|
|
|
|
const {classes: Cc, interfaces: Ci, utils: Cu, results: Cr} = Components;
|
|
|
|
Cu.import("resource://gre/modules/Services.jsm");
|
|
Cu.import("resource://gre/modules/XPCOMUtils.jsm");
|
|
|
|
XPCOMUtils.defineLazyModuleGetter(this, "EventEmitter",
|
|
"resource://gre/modules/EventEmitter.jsm");
|
|
|
|
// Create a variable to hold the cached ThemeChangeObserver which does not
|
|
// get created until a devtools context has been created.
|
|
let themeChangeObserver;
|
|
|
|
/**
|
|
* An observer that watches for changes to the devtools theme and provides
|
|
* that information to the devtools.panels.themeName API property, as well as
|
|
* emits events for the devtools.panels.onThemeChanged event. It also caches
|
|
* the current value of devtools.themeName.
|
|
*/
|
|
class ThemeChangeObserver extends EventEmitter {
|
|
constructor(themeName, onDestroyed) {
|
|
super();
|
|
this.themeName = themeName;
|
|
this.onDestroyed = onDestroyed;
|
|
this.contexts = new Set();
|
|
|
|
Services.cpmm.addMessageListener("Extension:DevToolsThemeChanged", this);
|
|
}
|
|
|
|
addContext(context) {
|
|
if (this.contexts.has(context)) {
|
|
throw new Error(
|
|
"addContext on the ThemeChangeObserver was called more than once" +
|
|
" for the context.");
|
|
}
|
|
|
|
context.callOnClose({
|
|
close: () => this.onContextClosed(context),
|
|
});
|
|
|
|
this.contexts.add(context);
|
|
}
|
|
|
|
onContextClosed(context) {
|
|
this.contexts.delete(context);
|
|
|
|
if (this.contexts.size === 0) {
|
|
this.destroy();
|
|
}
|
|
}
|
|
|
|
onThemeChanged(themeName) {
|
|
// Update the cached themeName and emit an event for the API.
|
|
this.themeName = themeName;
|
|
this.emit("themeChanged", themeName);
|
|
}
|
|
|
|
receiveMessage({name, data}) {
|
|
if (name === "Extension:DevToolsThemeChanged") {
|
|
this.onThemeChanged(data.themeName);
|
|
}
|
|
}
|
|
|
|
destroy() {
|
|
Services.cpmm.removeMessageListener("Extension:DevToolsThemeChanged", this);
|
|
this.onDestroyed();
|
|
this.onDestroyed = null;
|
|
this.contexts.clear();
|
|
this.contexts = null;
|
|
}
|
|
}
|
|
|
|
this.ExtensionChildDevToolsUtils = {
|
|
/**
|
|
* Creates an cached instance of the ThemeChangeObserver class and
|
|
* initializes it with the current themeName. This cached instance is
|
|
* destroyed when all of the contexts added to it are closed.
|
|
*
|
|
* @param {string} themeName The name of the current devtools theme.
|
|
* @param {DevToolsContextChild} context The newly created devtools page context.
|
|
*/
|
|
initThemeChangeObserver(themeName, context) {
|
|
if (!themeChangeObserver) {
|
|
themeChangeObserver = new ThemeChangeObserver(
|
|
themeName,
|
|
function() { themeChangeObserver = null; }
|
|
);
|
|
}
|
|
themeChangeObserver.addContext(context);
|
|
},
|
|
|
|
/**
|
|
* Returns the cached instance of ThemeChangeObserver.
|
|
*
|
|
* @returns {ThemeChangeObserver} The cached instance of ThemeChangeObserver.
|
|
*/
|
|
getThemeChangeObserver() {
|
|
if (!themeChangeObserver) {
|
|
throw new Error("A ThemeChangeObserver must be created before being retrieved.");
|
|
}
|
|
return themeChangeObserver;
|
|
},
|
|
};
|