mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-26 19:55:39 +00:00
e930b89c34
*** 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
100 lines
3.0 KiB
JavaScript
100 lines
3.0 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/. */
|
|
|
|
"use strict";
|
|
|
|
/**
|
|
* An API which allows Marionette to handle localized content.
|
|
*
|
|
* The localization (https://mzl.la/2eUMjyF) of UI elements in Gecko
|
|
* based applications is done via entities and properties. For static
|
|
* values entities are used, which are located in .dtd files. Whereby for
|
|
* dynamically updated content the values come from .property files. Both
|
|
* types of elements can be identifed via a unique id, and the translated
|
|
* content retrieved.
|
|
*/
|
|
|
|
const {Services} = ChromeUtils.import("resource://gre/modules/Services.jsm");
|
|
const {XPCOMUtils} = ChromeUtils.import("resource://gre/modules/XPCOMUtils.jsm");
|
|
|
|
XPCOMUtils.defineLazyGlobalGetters(this, ["DOMParser"]);
|
|
XPCOMUtils.defineLazyGetter(this, "domParser", () => new DOMParser());
|
|
|
|
const {NoSuchElementError} =
|
|
ChromeUtils.import("chrome://marionette/content/error.js");
|
|
|
|
this.EXPORTED_SYMBOLS = ["l10n"];
|
|
|
|
/** @namespace */
|
|
this.l10n = {};
|
|
|
|
/**
|
|
* Retrieve the localized string for the specified entity id.
|
|
*
|
|
* Example:
|
|
* localizeEntity(["chrome://branding/locale/brand.dtd"], "brandShortName")
|
|
*
|
|
* @param {Array.<string>} urls
|
|
* Array of .dtd URLs.
|
|
* @param {string} id
|
|
* The ID of the entity to retrieve the localized string for.
|
|
*
|
|
* @return {string}
|
|
* The localized string for the requested entity.
|
|
*/
|
|
l10n.localizeEntity = function(urls, id) {
|
|
// Build a string which contains all possible entity locations
|
|
let locations = [];
|
|
urls.forEach((url, index) => {
|
|
locations.push(`<!ENTITY % dtd_${index} SYSTEM "${url}">%dtd_${index};`);
|
|
});
|
|
|
|
// Use the DOM parser to resolve the entity and extract its real value
|
|
let header = `<?xml version="1.0"?><!DOCTYPE elem [${locations.join("")}]>`;
|
|
let elem = `<elem id="elementID">&${id};</elem>`;
|
|
let doc = domParser.parseFromString(header + elem, "text/xml");
|
|
let element = doc.querySelector("elem[id='elementID']");
|
|
|
|
if (element === null) {
|
|
throw new NoSuchElementError(`Entity with id='${id}' hasn't been found`);
|
|
}
|
|
|
|
return element.textContent;
|
|
};
|
|
|
|
/**
|
|
* Retrieve the localized string for the specified property id.
|
|
*
|
|
* Example:
|
|
*
|
|
* localizeProperty(
|
|
* ["chrome://global/locale/findbar.properties"], "FastFind");
|
|
*
|
|
* @param {Array.<string>} urls
|
|
* Array of .properties URLs.
|
|
* @param {string} id
|
|
* The ID of the property to retrieve the localized string for.
|
|
*
|
|
* @return {string}
|
|
* The localized string for the requested property.
|
|
*/
|
|
l10n.localizeProperty = function(urls, id) {
|
|
let property = null;
|
|
|
|
for (let url of urls) {
|
|
let bundle = Services.strings.createBundle(url);
|
|
try {
|
|
property = bundle.GetStringFromName(id);
|
|
break;
|
|
} catch (e) {}
|
|
}
|
|
|
|
if (property === null) {
|
|
throw new NoSuchElementError(
|
|
`Property with ID '${id}' hasn't been found`);
|
|
}
|
|
|
|
return property;
|
|
};
|