mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-01 06:35:42 +00:00
acf2f9d4dd
No functional changes. MozReview-Commit-ID: 25cWAnpRB9H --HG-- extra : rebase_source : c8b14bf47a476488568f54d3640b51bbeed5b04b
99 lines
3.0 KiB
JavaScript
99 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 {classes: Cc, interfaces: Ci, utils: Cu} = Components;
|
|
|
|
Cu.import("resource://gre/modules/Services.jsm");
|
|
Cu.import("resource://gre/modules/XPCOMUtils.jsm");
|
|
|
|
XPCOMUtils.defineLazyServiceGetter(
|
|
this, "domParser", "@mozilla.org/xmlextras/domparser;1", "nsIDOMParser");
|
|
|
|
Cu.import("chrome://marionette/content/error.js");
|
|
|
|
this.EXPORTED_SYMBOLS = ["l10n"];
|
|
|
|
this.l10n = {};
|
|
|
|
/**
|
|
* Retrieve the localized string for the specified entity id.
|
|
*
|
|
* Example:
|
|
* localizeEntity(["chrome://global/locale/about.dtd"], "about.version")
|
|
*
|
|
* @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) {
|
|
// Add xhtml11.dtd to prevent missing entity errors with XHTML files
|
|
urls.push("resource:///res/dtd/xhtml11.dtd");
|
|
|
|
// 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;
|
|
};
|