diff options
author | Matt A. Tobin <email@mattatobin.com> | 2022-02-12 13:53:59 -0600 |
---|---|---|
committer | Matt A. Tobin <email@mattatobin.com> | 2022-02-12 13:53:59 -0600 |
commit | c054e324210895e7e2c5b3e84437cba43f201ec8 (patch) | |
tree | 00735055ed5ee588f71e147c5ae27363349f1687 /dom/base/ConsoleAPIStorage.js | |
parent | 5da550a67c876bf06690439192db5bef2c54cb20 (diff) | |
download | palemoon-gre-c054e324210895e7e2c5b3e84437cba43f201ec8.tar.gz |
Prep for GRE
Diffstat (limited to 'dom/base/ConsoleAPIStorage.js')
-rw-r--r-- | dom/base/ConsoleAPIStorage.js | 158 |
1 files changed, 0 insertions, 158 deletions
diff --git a/dom/base/ConsoleAPIStorage.js b/dom/base/ConsoleAPIStorage.js deleted file mode 100644 index e3a982fa9..000000000 --- a/dom/base/ConsoleAPIStorage.js +++ /dev/null @@ -1,158 +0,0 @@ -/* 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"; - -let Cu = Components.utils; -let Ci = Components.interfaces; -let Cc = Components.classes; - -Cu.import("resource://gre/modules/XPCOMUtils.jsm"); -Cu.import("resource://gre/modules/Services.jsm"); - -// This constant tells how many messages to process in a single timer execution. -const MESSAGES_IN_INTERVAL = 1500 - -const STORAGE_MAX_EVENTS = 200; - -var _consoleStorage = new Map(); - -const CONSOLEAPISTORAGE_CID = Components.ID('{96cf7855-dfa9-4c6d-8276-f9705b4890f2}'); - -/** - * The ConsoleAPIStorage is meant to cache window.console API calls for later - * reuse by other components when needed. For example, the Web Console code can - * display the cached messages when it opens for the active tab. - * - * ConsoleAPI messages are stored as they come from the ConsoleAPI code, with - * all their properties. They are kept around until the inner window object that - * created the messages is destroyed. Messages are indexed by the inner window - * ID. - * - * Usage: - * Cu.import("resource://gre/modules/ConsoleAPIStorage.jsm"); - * - * // Get the cached events array for the window you want (use the inner - * // window ID). - * let events = ConsoleAPIStorage.getEvents(innerWindowID); - * events.forEach(function(event) { ... }); - * - * // Clear the events for the given inner window ID. - * ConsoleAPIStorage.clearEvents(innerWindowID); - */ -function ConsoleAPIStorageService() { - this.init(); -} - -ConsoleAPIStorageService.prototype = { - classID : CONSOLEAPISTORAGE_CID, - QueryInterface: XPCOMUtils.generateQI([Ci.nsIConsoleAPIStorage, - Ci.nsIObserver]), - classInfo: XPCOMUtils.generateCI({ - classID: CONSOLEAPISTORAGE_CID, - contractID: '@mozilla.org/consoleAPI-storage;1', - interfaces: [Ci.nsIConsoleAPIStorage, Ci.nsIObserver], - flags: Ci.nsIClassInfo.SINGLETON - }), - - observe: function CS_observe(aSubject, aTopic, aData) - { - if (aTopic == "xpcom-shutdown") { - Services.obs.removeObserver(this, "xpcom-shutdown"); - Services.obs.removeObserver(this, "inner-window-destroyed"); - Services.obs.removeObserver(this, "memory-pressure"); - } - else if (aTopic == "inner-window-destroyed") { - let innerWindowID = aSubject.QueryInterface(Ci.nsISupportsPRUint64).data; - this.clearEvents(innerWindowID + ""); - } - else if (aTopic == "memory-pressure") { - this.clearEvents(); - } - }, - - /** @private */ - init: function CS_init() - { - Services.obs.addObserver(this, "xpcom-shutdown", false); - Services.obs.addObserver(this, "inner-window-destroyed", false); - Services.obs.addObserver(this, "memory-pressure", false); - }, - - /** - * Get the events array by inner window ID or all events from all windows. - * - * @param string [aId] - * Optional, the inner window ID for which you want to get the array of - * cached events. - * @returns array - * The array of cached events for the given window. If no |aId| is - * given this function returns all of the cached events, from any - * window. - */ - getEvents: function CS_getEvents(aId) - { - if (aId != null) { - return (_consoleStorage.get(aId) || []).slice(0); - } - - let result = []; - - for (let [id, events] of _consoleStorage) { - result.push.apply(result, events); - } - - return result.sort(function(a, b) { - return a.timeStamp - b.timeStamp; - }); - }, - - /** - * Record an event associated with the given window ID. - * - * @param string aId - * The ID of the inner window for which the event occurred or "jsm" for - * messages logged from JavaScript modules.. - * @param object aEvent - * A JavaScript object you want to store. - */ - recordEvent: function CS_recordEvent(aId, aOuterId, aEvent) - { - if (!_consoleStorage.has(aId)) { - _consoleStorage.set(aId, []); - } - - let storage = _consoleStorage.get(aId); - storage.push(aEvent); - - // truncate - if (storage.length > STORAGE_MAX_EVENTS) { - storage.shift(); - } - - Services.obs.notifyObservers(aEvent, "console-api-log-event", aOuterId); - Services.obs.notifyObservers(aEvent, "console-storage-cache-event", aId); - }, - - /** - * Clear storage data for the given window. - * - * @param string [aId] - * Optional, the inner window ID for which you want to clear the - * messages. If this is not specified all of the cached messages are - * cleared, from all window objects. - */ - clearEvents: function CS_clearEvents(aId) - { - if (aId != null) { - _consoleStorage.delete(aId); - } - else { - _consoleStorage.clear(); - Services.obs.notifyObservers(null, "console-storage-reset", null); - } - }, -}; - -this.NSGetFactory = XPCOMUtils.generateNSGetFactory([ConsoleAPIStorageService]); |