Source code
Revision control
Copy as Markdown
Other Tools
/* 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
/* This is a JavaScript module (JSM) to be imported via
ChromeUtils.import() and acts as a singleton.
Only the following listed symbols will exposed on import, and only when
and where imported. */
const WEAVE_PREF_PREFIX = "services.sync.prefs.sync.";
/**
* Preference class constructor
*
* Initializes instance properties.
*/
export function Preference(props) {
Logger.AssertTrue(
"name" in props && "value" in props,
"Preference must have both name and value"
);
this.name = props.name;
this.value = props.value;
}
/**
* Preference instance methods
*/
Preference.prototype = {
/**
* Modify
*
* Sets the value of the preference this.name to this.value.
* Throws on error.
*
* @return nothing
*/
Modify() {
// Determine if this pref is actually something Weave even looks at.
let weavepref = WEAVE_PREF_PREFIX + this.name;
try {
let syncPref = Services.prefs.getBoolPref(weavepref);
if (!syncPref) {
Services.prefs.setBoolPref(weavepref, true);
}
} catch (e) {
Logger.AssertTrue(false, "Weave doesn't sync pref " + this.name);
}
// Modify the pref; throw an exception if the pref type is different
// than the value type specified in the test.
let prefType = Services.prefs.getPrefType(this.name);
switch (prefType) {
case Ci.nsIPrefBranch.PREF_INT:
Logger.AssertEqual(
typeof this.value,
"number",
"Wrong type used for preference value"
);
Services.prefs.setIntPref(this.name, this.value);
break;
case Ci.nsIPrefBranch.PREF_STRING:
Logger.AssertEqual(
typeof this.value,
"string",
"Wrong type used for preference value"
);
Services.prefs.setStringPref(this.name, this.value);
break;
case Ci.nsIPrefBranch.PREF_BOOL:
Logger.AssertEqual(
typeof this.value,
"boolean",
"Wrong type used for preference value"
);
Services.prefs.setBoolPref(this.name, this.value);
break;
}
},
/**
* Find
*
* Verifies that the preference this.name has the value
* this.value. Throws on error, or if the pref's type or value
* doesn't match.
*
* @return nothing
*/
Find() {
// Read the pref value.
let value;
try {
let prefType = Services.prefs.getPrefType(this.name);
switch (prefType) {
case Ci.nsIPrefBranch.PREF_INT:
value = Services.prefs.getIntPref(this.name);
break;
case Ci.nsIPrefBranch.PREF_STRING:
value = Services.prefs.getStringPref(this.name);
break;
case Ci.nsIPrefBranch.PREF_BOOL:
value = Services.prefs.getBoolPref(this.name);
break;
}
} catch (e) {
Logger.AssertTrue(false, "Error accessing pref " + this.name);
}
// Throw an exception if the current and expected values aren't of
// the same type, or don't have the same values.
Logger.AssertEqual(
typeof value,
typeof this.value,
"Value types don't match"
);
Logger.AssertEqual(value, this.value, "Preference values don't match");
},
};