diff options
author | Moonchild <mcwerewolf@wolfbeast.com> | 2019-03-13 07:49:07 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-03-13 07:49:07 +0100 |
commit | bf0413359245579e9509146d42cd5547e35da695 (patch) | |
tree | 8218d4f60d9eccacbf42df8cb88094a082d401b4 /application/basilisk/components/webextensions/ext-commands.js | |
parent | 51b821b3fdc5a7eab2369cb6a6680598a6264b08 (diff) | |
parent | 709bc24e9110eba12f94cfcb8db00a8338ac4098 (diff) | |
download | UXP-bf0413359245579e9509146d42cd5547e35da695.tar UXP-bf0413359245579e9509146d42cd5547e35da695.tar.gz UXP-bf0413359245579e9509146d42cd5547e35da695.tar.lz UXP-bf0413359245579e9509146d42cd5547e35da695.tar.xz UXP-bf0413359245579e9509146d42cd5547e35da695.zip |
Merge pull request #998 from MoonchildProductions/master
Merge master into Sync-weave
Diffstat (limited to 'application/basilisk/components/webextensions/ext-commands.js')
-rw-r--r-- | application/basilisk/components/webextensions/ext-commands.js | 264 |
1 files changed, 0 insertions, 264 deletions
diff --git a/application/basilisk/components/webextensions/ext-commands.js b/application/basilisk/components/webextensions/ext-commands.js deleted file mode 100644 index b6e7ab3d1..000000000 --- a/application/basilisk/components/webextensions/ext-commands.js +++ /dev/null @@ -1,264 +0,0 @@ -/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */ -/* vim: set sts=2 sw=2 et tw=80: */ -"use strict"; - -Cu.import("resource://devtools/shared/event-emitter.js"); -Cu.import("resource://gre/modules/ExtensionUtils.jsm"); - -var { - EventManager, - PlatformInfo, -} = ExtensionUtils; - -const XUL_NS = "http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul"; - -// WeakMap[Extension -> CommandList] -var commandsMap = new WeakMap(); - -function CommandList(manifest, extension) { - this.extension = extension; - this.id = makeWidgetId(extension.id); - this.windowOpenListener = null; - - // Map[{String} commandName -> {Object} commandProperties] - this.commands = this.loadCommandsFromManifest(manifest); - - // WeakMap[Window -> <xul:keyset>] - this.keysetsMap = new WeakMap(); - - this.register(); - EventEmitter.decorate(this); -} - -CommandList.prototype = { - /** - * Registers the commands to all open windows and to any which - * are later created. - */ - register() { - for (let window of WindowListManager.browserWindows()) { - this.registerKeysToDocument(window); - } - - this.windowOpenListener = (window) => { - if (!this.keysetsMap.has(window)) { - this.registerKeysToDocument(window); - } - }; - - WindowListManager.addOpenListener(this.windowOpenListener); - }, - - /** - * Unregisters the commands from all open windows and stops commands - * from being registered to windows which are later created. - */ - unregister() { - for (let window of WindowListManager.browserWindows()) { - if (this.keysetsMap.has(window)) { - this.keysetsMap.get(window).remove(); - } - } - - WindowListManager.removeOpenListener(this.windowOpenListener); - }, - - /** - * Creates a Map from commands for each command in the manifest.commands object. - * - * @param {Object} manifest The manifest JSON object. - * @returns {Map<string, object>} - */ - loadCommandsFromManifest(manifest) { - let commands = new Map(); - // For Windows, chrome.runtime expects 'win' while chrome.commands - // expects 'windows'. We can special case this for now. - let os = PlatformInfo.os == "win" ? "windows" : PlatformInfo.os; - for (let [name, command] of Object.entries(manifest.commands)) { - let suggested_key = command.suggested_key || {}; - let shortcut = suggested_key[os] || suggested_key.default; - shortcut = shortcut ? shortcut.replace(/\s+/g, "") : null; - commands.set(name, { - description: command.description, - shortcut, - }); - } - return commands; - }, - - /** - * Registers the commands to a document. - * @param {ChromeWindow} window The XUL window to insert the Keyset. - */ - registerKeysToDocument(window) { - let doc = window.document; - let keyset = doc.createElementNS(XUL_NS, "keyset"); - keyset.id = `ext-keyset-id-${this.id}`; - this.commands.forEach((command, name) => { - if (command.shortcut) { - let keyElement = this.buildKey(doc, name, command.shortcut); - keyset.appendChild(keyElement); - } - }); - doc.documentElement.appendChild(keyset); - this.keysetsMap.set(window, keyset); - }, - - /** - * Builds a XUL Key element and attaches an onCommand listener which - * emits a command event with the provided name when fired. - * - * @param {Document} doc The XUL document. - * @param {string} name The name of the command. - * @param {string} shortcut The shortcut provided in the manifest. - * @see https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XUL/key - * - * @returns {Document} The newly created Key element. - */ - buildKey(doc, name, shortcut) { - let keyElement = this.buildKeyFromShortcut(doc, shortcut); - - // We need to have the attribute "oncommand" for the "command" listener to fire, - // and it is currently ignored when set to the empty string. - keyElement.setAttribute("oncommand", "//"); - - /* eslint-disable mozilla/balanced-listeners */ - // We remove all references to the key elements when the extension is shutdown, - // therefore the listeners for these elements will be garbage collected. - keyElement.addEventListener("command", (event) => { - if (name == "_execute_page_action") { - let win = event.target.ownerDocument.defaultView; - pageActionFor(this.extension).triggerAction(win); - } else if (name == "_execute_browser_action") { - let win = event.target.ownerDocument.defaultView; - browserActionFor(this.extension).triggerAction(win); - } else { - TabManager.for(this.extension) - .addActiveTabPermission(TabManager.activeTab); - this.emit("command", name); - } - }); - /* eslint-enable mozilla/balanced-listeners */ - - return keyElement; - }, - - /** - * Builds a XUL Key element from the provided shortcut. - * - * @param {Document} doc The XUL document. - * @param {string} shortcut The shortcut provided in the manifest. - * - * @see https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XUL/key - * @returns {Document} The newly created Key element. - */ - buildKeyFromShortcut(doc, shortcut) { - let keyElement = doc.createElementNS(XUL_NS, "key"); - - let parts = shortcut.split("+"); - - // The key is always the last element. - let chromeKey = parts.pop(); - - // The modifiers are the remaining elements. - keyElement.setAttribute("modifiers", this.getModifiersAttribute(parts)); - - if (/^[A-Z]$/.test(chromeKey)) { - // We use the key attribute for all single digits and characters. - keyElement.setAttribute("key", chromeKey); - } else { - keyElement.setAttribute("keycode", this.getKeycodeAttribute(chromeKey)); - keyElement.setAttribute("event", "keydown"); - } - - return keyElement; - }, - - /** - * Determines the corresponding XUL keycode from the given chrome key. - * - * For example: - * - * input | output - * --------------------------------------- - * "PageUP" | "VK_PAGE_UP" - * "Delete" | "VK_DELETE" - * - * @param {string} chromeKey The chrome key (e.g. "PageUp", "Space", ...) - * @returns {string} The constructed value for the Key's 'keycode' attribute. - */ - getKeycodeAttribute(chromeKey) { - if (/[0-9]/.test(chromeKey)) { - return `VK_${chromeKey}`; - } - return `VK${chromeKey.replace(/([A-Z])/g, "_$&").toUpperCase()}`; - }, - - /** - * Determines the corresponding XUL modifiers from the chrome modifiers. - * - * For example: - * - * input | output - * --------------------------------------- - * ["Ctrl", "Shift"] | "accel shift" - * ["MacCtrl"] | "control" - * - * @param {Array} chromeModifiers The array of chrome modifiers. - * @returns {string} The constructed value for the Key's 'modifiers' attribute. - */ - getModifiersAttribute(chromeModifiers) { - let modifiersMap = { - "Alt": "alt", - "Command": "accel", - "Ctrl": "accel", - "MacCtrl": "control", - "Shift": "shift", - }; - return Array.from(chromeModifiers, modifier => { - return modifiersMap[modifier]; - }).join(" "); - }, -}; - - -/* eslint-disable mozilla/balanced-listeners */ -extensions.on("manifest_commands", (type, directive, extension, manifest) => { - commandsMap.set(extension, new CommandList(manifest, extension)); -}); - -extensions.on("shutdown", (type, extension) => { - let commandsList = commandsMap.get(extension); - if (commandsList) { - commandsList.unregister(); - commandsMap.delete(extension); - } -}); -/* eslint-enable mozilla/balanced-listeners */ - -extensions.registerSchemaAPI("commands", "addon_parent", context => { - let {extension} = context; - return { - commands: { - getAll() { - let commands = commandsMap.get(extension).commands; - return Promise.resolve(Array.from(commands, ([name, command]) => { - return ({ - name, - description: command.description, - shortcut: command.shortcut, - }); - })); - }, - onCommand: new EventManager(context, "commands.onCommand", fire => { - let listener = (eventName, commandName) => { - fire(commandName); - }; - commandsMap.get(extension).on("command", listener); - return () => { - commandsMap.get(extension).off("command", listener); - }; - }).api(), - }, - }; -}); |