gecko-dev/toolkit/actors/FindBarChild.jsm
Kris Maglione e930b89c34 Bug 1514594: Part 3 - Change ChromeUtils.import API.
***
Bug 1514594: Part 3a - Change ChromeUtils.import to return an exports object; not pollute global. r=mccr8

This changes the behavior of ChromeUtils.import() to return an exports object,
rather than a module global, in all cases except when `null` is passed as a
second argument, and changes the default behavior not to pollute the global
scope with the module's exports. Thus, the following code written for the old
model:

  ChromeUtils.import("resource://gre/modules/Services.jsm");

is approximately the same as the following, in the new model:

  var {Services} = ChromeUtils.import("resource://gre/modules/Services.jsm");

Since the two behaviors are mutually incompatible, this patch will land with a
scripted rewrite to update all existing callers to use the new model rather
than the old.
***
Bug 1514594: Part 3b - Mass rewrite all JS code to use the new ChromeUtils.import API. rs=Gijs

This was done using the followng script:

https://bitbucket.org/kmaglione/m-c-rewrites/src/tip/processors/cu-import-exports.jsm
***
Bug 1514594: Part 3c - Update ESLint plugin for ChromeUtils.import API changes. r=Standard8

Differential Revision: https://phabricator.services.mozilla.com/D16747
***
Bug 1514594: Part 3d - Remove/fix hundreds of duplicate imports from sync tests. r=Gijs

Differential Revision: https://phabricator.services.mozilla.com/D16748
***
Bug 1514594: Part 3e - Remove no-op ChromeUtils.import() calls. r=Gijs

Differential Revision: https://phabricator.services.mozilla.com/D16749
***
Bug 1514594: Part 3f.1 - Cleanup various test corner cases after mass rewrite. r=Gijs
***
Bug 1514594: Part 3f.2 - Cleanup various non-test corner cases after mass rewrite. r=Gijs

Differential Revision: https://phabricator.services.mozilla.com/D16750

--HG--
extra : rebase_source : 359574ee3064c90f33bf36c2ebe3159a24cc8895
extra : histedit_source : b93c8f42808b1599f9122d7842d2c0b3e656a594%2C64a3a4e3359dc889e2ab2b49461bab9e27fc10a7
2019-01-17 10:18:31 -08:00

98 lines
3.0 KiB
JavaScript

/* vim: set ts=2 sw=2 sts=2 et 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";
var EXPORTED_SYMBOLS = ["FindBarChild"];
const {ActorChild} = ChromeUtils.import("resource://gre/modules/ActorChild.jsm");
const {Services} = ChromeUtils.import("resource://gre/modules/Services.jsm");
const {XPCOMUtils} = ChromeUtils.import("resource://gre/modules/XPCOMUtils.jsm");
ChromeUtils.defineModuleGetter(this, "BrowserUtils",
"resource://gre/modules/BrowserUtils.jsm");
class FindBarChild extends ActorChild {
constructor(dispatcher) {
super(dispatcher);
this._findKey = null;
XPCOMUtils.defineLazyProxy(this, "FindBarContent", () => {
let tmp = {};
ChromeUtils.import("resource://gre/modules/FindBarContent.jsm", tmp);
return new tmp.FindBarContent(this.mm);
}, {inQuickFind: false, inPassThrough: false});
}
/**
* Check whether this key event will start the findbar in the parent,
* in which case we should pass any further key events to the parent to avoid
* them being lost.
* @param aEvent the key event to check.
*/
eventMatchesFindShortcut(aEvent) {
if (!this._findKey) {
this._findKey = Services.cpmm.sharedData.get("Findbar:Shortcut");
if (!this._findKey) {
return false;
}
}
for (let k in this._findKey) {
if (this._findKey[k] != aEvent[k]) {
return false;
}
}
return true;
}
handleEvent(event) {
if (event.type == "keypress") {
this.onKeypress(event);
}
}
onKeypress(event) {
let {FindBarContent} = this;
if (!FindBarContent.inPassThrough &&
this.eventMatchesFindShortcut(event)) {
return FindBarContent.start(event);
}
// disable FAYT in about:blank to prevent FAYT opening unexpectedly.
let location = this.content.location.href;
if (location == "about:blank") {
return null;
}
if (event.ctrlKey || event.altKey || event.metaKey || event.defaultPrevented ||
!BrowserUtils.mimeTypeIsTextBased(this.content.document.contentType) ||
!BrowserUtils.canFindInPage(location)) {
return null;
}
if (FindBarContent.inPassThrough || FindBarContent.inQuickFind) {
return FindBarContent.onKeypress(event);
}
if (event.charCode && BrowserUtils.shouldFastFind(event.target)) {
let key = String.fromCharCode(event.charCode);
if ((key == "/" || key == "'") && FindBarChild.manualFAYT) {
return FindBarContent.startQuickFind(event);
}
if (key != " " && FindBarChild.findAsYouType) {
return FindBarContent.startQuickFind(event, true);
}
}
return null;
}
}
XPCOMUtils.defineLazyPreferenceGetter(FindBarChild, "findAsYouType",
"accessibility.typeaheadfind");
XPCOMUtils.defineLazyPreferenceGetter(FindBarChild, "manualFAYT",
"accessibility.typeaheadfind.manual");