gecko-dev/browser/modules/ZoomUI.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

121 lines
4.3 KiB
JavaScript

// -*- indent-tabs-mode: nil; js-indent-level: 2 -*-
/* 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 = [ "ZoomUI" ];
const {Services} = ChromeUtils.import("resource://gre/modules/Services.jsm");
var ZoomUI = {
init(aWindow) {
aWindow.addEventListener("EndSwapDocShells", onEndSwapDocShells, true);
aWindow.addEventListener("FullZoomChange", onZoomChange);
aWindow.addEventListener("TextZoomChange", onZoomChange);
aWindow.addEventListener("unload", () => {
aWindow.removeEventListener("EndSwapDocShells", onEndSwapDocShells, true);
aWindow.removeEventListener("FullZoomChange", onZoomChange);
aWindow.removeEventListener("TextZoomChange", onZoomChange);
}, {once: true});
},
};
function fullZoomLocationChangeObserver(aSubject, aTopic) {
// If the tab was the last one in its window and has been dragged to another
// window, the original browser's window will be unavailable here. Since that
// window is closing, we can just ignore this notification.
if (!aSubject.ownerGlobal) {
return;
}
updateZoomUI(aSubject, false);
}
Services.obs.addObserver(fullZoomLocationChangeObserver, "browser-fullZoom:location-change");
function onEndSwapDocShells(event) {
updateZoomUI(event.originalTarget);
}
function onZoomChange(event) {
let browser;
if (event.target.nodeType == event.target.DOCUMENT_NODE) {
// In non-e10s, the event is dispatched on the contentDocument
// so we need to jump through some hoops to get to the <xul:browser>.
let topDoc = event.target.defaultView.top.document;
if (!topDoc.documentElement) {
// In some events, such as loading synthetic documents, the
// documentElement will be null and we won't be able to find
// an associated browser.
return;
}
browser = topDoc.ownerGlobal.docShell.chromeEventHandler;
} else {
browser = event.originalTarget;
}
updateZoomUI(browser, true);
}
/**
* Updates zoom controls.
*
* @param {object} aBrowser The browser that the zoomed content resides in.
* @param {boolean} aAnimate Should be True for all cases unless the zoom
* change is related to tab switching. Optional
*/
function updateZoomUI(aBrowser, aAnimate = false) {
let win = aBrowser.ownerGlobal;
if (!win.gBrowser || win.gBrowser.selectedBrowser != aBrowser) {
return;
}
let appMenuZoomReset = win.document.getElementById("appMenu-zoomReset-button");
let customizableZoomControls = win.document.getElementById("zoom-controls");
let customizableZoomReset = win.document.getElementById("zoom-reset-button");
let urlbarZoomButton = win.document.getElementById("urlbar-zoom-button");
let zoomFactor = Math.round(win.ZoomManager.zoom * 100);
// Hide urlbar zoom button if zoom is at 100% or the customizable control is
// in the toolbar.
urlbarZoomButton.hidden =
(zoomFactor == 100 ||
(customizableZoomControls &&
customizableZoomControls.getAttribute("cui-areatype") == "toolbar"));
let label = win.gNavigatorBundle.getFormattedString("zoom-button.label", [zoomFactor]);
if (appMenuZoomReset) {
appMenuZoomReset.setAttribute("label", label);
}
if (customizableZoomReset) {
customizableZoomReset.setAttribute("label", label);
}
if (!urlbarZoomButton.hidden) {
if (aAnimate) {
urlbarZoomButton.setAttribute("animate", "true");
} else {
urlbarZoomButton.removeAttribute("animate");
}
urlbarZoomButton.setAttribute("label", label);
}
}
const {CustomizableUI} = ChromeUtils.import("resource:///modules/CustomizableUI.jsm");
let customizationListener = {};
customizationListener.onWidgetAdded =
customizationListener.onWidgetRemoved =
customizationListener.onWidgetMoved = function(aWidgetId) {
if (aWidgetId == "zoom-controls") {
for (let window of CustomizableUI.windows) {
updateZoomUI(window.gBrowser.selectedBrowser);
}
}
};
customizationListener.onWidgetReset =
customizationListener.onWidgetUndoMove = function(aWidgetNode) {
if (aWidgetNode.id == "zoom-controls") {
updateZoomUI(aWidgetNode.ownerGlobal.gBrowser.selectedBrowser);
}
};
CustomizableUI.addListener(customizationListener);