gecko-dev/dom/manifest/ValueExtractor.jsm
Boris Zbarsky 9de72a3ac6 Bug 1557793 part 2. Stop using [array] in nsIStringBundle. r=Pike
Differential Revision: https://phabricator.services.mozilla.com/D34196

--HG--
extra : moz-landing-system : lando
2019-06-11 15:51:51 +00:00

77 lines
2.8 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 https://mozilla.org/MPL/2.0/. */
/*
* Helper functions extract values from manifest members
* and reports conformance violations.
*/
/* globals Components*/
"use strict";
const {XPCOMUtils} = ChromeUtils.import("resource://gre/modules/XPCOMUtils.jsm");
XPCOMUtils.defineLazyGlobalGetters(this, ["InspectorUtils"]);
function ValueExtractor(aConsole, aBundle) {
this.console = aConsole;
this.domBundle = aBundle;
}
ValueExtractor.prototype = {
// This function takes a 'spec' object and destructures
// it to extract a value. If the value is of th wrong type, it
// warns the developer and returns undefined.
// expectType: is the type of a JS primitive (string, number, etc.)
// object: is the object from which to extract the value.
// objectName: string used to construct the developer warning.
// property: the name of the property being extracted.
// trim: boolean, if the value should be trimmed (used by string type).
extractValue({expectedType, object, objectName, property, trim}) {
const value = object[property];
const isArray = Array.isArray(value);
// We need to special-case "array", as it's not a JS primitive.
const type = (isArray) ? "array" : typeof value;
if (type !== expectedType) {
if (type !== "undefined") {
this.console.warn(this.domBundle.formatStringFromName("ManifestInvalidType",
[objectName, property, expectedType]));
}
return undefined;
}
// Trim string and returned undefined if the empty string.
const shouldTrim = expectedType === "string" && value && trim;
if (shouldTrim) {
return value.trim() || undefined;
}
return value;
},
extractColorValue(spec) {
const value = this.extractValue(spec);
let color;
if (InspectorUtils.isValidCSSColor(value)) {
const rgba = InspectorUtils.colorToRGBA(value);
color = "#" + ((rgba.r << 16) |
(rgba.g << 8) |
rgba.b).toString(16);
} else if (value) {
this.console.warn(this.domBundle.formatStringFromName("ManifestInvalidCSSColor",
[spec.property, value]));
}
return color;
},
extractLanguageValue(spec) {
let langTag;
const value = this.extractValue(spec);
if (value !== undefined) {
try {
langTag = Intl.getCanonicalLocales(value)[0];
} catch (err) {
console.warn(this.domBundle.formatStringFromName("ManifestLangIsInvalid",
[spec.property, value]));
}
}
return langTag;
},
};
var EXPORTED_SYMBOLS = ["ValueExtractor"]; // jshint ignore:line