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
/* All top-level definitions here are exports. */
/* eslint no-unused-vars: [2, {"vars": "local"}] */
import { loader } from "resource://devtools/shared/loader/Loader.sys.mjs";
const gStringBundle = Services.strings.createBundle(PROPERTIES_URL);
const lazy = {};
loader.lazyRequireGetter(
lazy,
"Menu",
"resource://devtools/client/framework/menu.js"
);
loader.lazyRequireGetter(
lazy,
"MenuItem",
"resource://devtools/client/framework/menu-item.js"
);
const PREF_AT_RULES_SIDEBAR = "devtools.styleeditor.showAtRulesSidebar";
const PREF_ORIG_SOURCES = "devtools.source-map.client-service.enabled";
/**
* Returns a localized string with the given key name from the string bundle.
*
* @param name
* @param ...rest
* Optional arguments to format in the string.
* @return string
*/
export function getString(name) {
try {
if (arguments.length == 1) {
return gStringBundle.GetStringFromName(name);
}
const rest = Array.prototype.slice.call(arguments, 1);
return gStringBundle.formatStringFromName(name, rest);
} catch (ex) {
console.error(ex);
throw new Error(
"L10N error. '" + name + "' is missing from " + PROPERTIES_URL
);
}
}
/**
* Retrieve or set the text content of an element.
*
* @param DOMElement root
* The element to use for querySelector.
* @param string selector
* Selector string for the element to get/set the text content.
* @param string textContent
* Optional text to set.
* @return string
* Text content of matching element or null if there were no element
* matching selector.
*/
export function text(root, selector, textContent) {
const element = root.querySelector(selector);
if (!element) {
return null;
}
if (textContent === undefined) {
return element.textContent;
}
element.textContent = textContent;
return textContent;
}
/**
* Show file picker and return the file user selected.
*
* @param mixed file
* Optional nsIFile or string representing the filename to auto-select.
* @param boolean toSave
* If true, the user is selecting a filename to save.
* @param nsIWindow parentWindow
* Optional parent window. If null the parent window of the file picker
* will be the window of the attached input element.
* @param callback
* The callback method, which will be called passing in the selected
* file or null if the user did not pick one.
* @param AString suggestedFilename
* The suggested filename when toSave is true.
*/
export function showFilePicker(
path,
toSave,
parentWindow,
callback,
suggestedFilename
) {
if (typeof path == "string") {
try {
if (Services.io.extractScheme(path) == "file") {
const uri = Services.io.newURI(path);
const file = uri.QueryInterface(Ci.nsIFileURL).file;
callback(file);
return;
}
} catch (ex) {
callback(null);
return;
}
try {
const file = Cc["@mozilla.org/file/local;1"].createInstance(Ci.nsIFile);
file.initWithPath(path);
callback(file);
return;
} catch (ex) {
callback(null);
return;
}
}
if (path) {
// "path" is an nsIFile
callback(path);
return;
}
const fp = Cc["@mozilla.org/filepicker;1"].createInstance(Ci.nsIFilePicker);
const mode = toSave ? fp.modeSave : fp.modeOpen;
const key = toSave ? "saveStyleSheet" : "importStyleSheet";
const fpCallback = function (result) {
if (result == Ci.nsIFilePicker.returnCancel) {
callback(null);
} else {
callback(fp.file);
}
};
if (toSave && suggestedFilename) {
fp.defaultString = suggestedFilename;
}
fp.init(parentWindow.browsingContext, getString(key + ".title"), mode);
fp.appendFilter(getString(key + ".filter"), "*.css");
fp.appendFilters(fp.filterAll);
fp.open(fpCallback);
}
/**
* Returns a Popup Menu for the Options ("gear") Button
* @param {function} toggleOrigSources
* To toggle the original source pref
* @param {function} toggleAtRulesSidebar
* To toggle the pref to show at-rules side bar
* @return {object} popupMenu
* A Menu object holding the MenuItems
*/
export function optionsPopupMenu(toggleOrigSources, toggleAtRulesSidebar) {
const popupMenu = new lazy.Menu();
popupMenu.append(
new lazy.MenuItem({
id: "options-origsources",
label: getString("showOriginalSources.label"),
accesskey: getString("showOriginalSources.accesskey"),
type: "checkbox",
checked: Services.prefs.getBoolPref(PREF_ORIG_SOURCES),
click: () => toggleOrigSources(),
})
);
popupMenu.append(
new lazy.MenuItem({
id: "options-show-at-rules",
label: getString("showAtRulesSidebar.label"),
accesskey: getString("showAtRulesSidebar.accesskey"),
type: "checkbox",
checked: Services.prefs.getBoolPref(PREF_AT_RULES_SIDEBAR),
click: () => toggleAtRulesSidebar(),
})
);
return popupMenu;
}