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
"use strict";
// Make this available to both AMD and CJS environments
define(function (require, exports, module) {
// Dependencies
const PropTypes = require("devtools/client/shared/vendor/react-prop-types");
const { span } = require("devtools/client/shared/vendor/react-dom-factories");
const {
wrapRender,
ellipsisElement,
} = require("devtools/client/shared/components/reps/reps/rep-utils");
const PropRep = require("devtools/client/shared/components/reps/reps/prop-rep");
const {
MODE,
} = require("devtools/client/shared/components/reps/reps/constants");
const DEFAULT_TITLE = "Object";
/**
* Renders an object. An object is represented by a list of its
* properties enclosed in curly brackets.
*/
ObjectRep.propTypes = {
object: PropTypes.object.isRequired,
mode: PropTypes.oneOf(Object.values(MODE)),
title: PropTypes.string,
shouldRenderTooltip: PropTypes.bool,
};
function ObjectRep(props) {
const object = props.object;
const { shouldRenderTooltip = true } = props;
if (props.mode === MODE.TINY) {
const tinyModeItems = [];
if (getTitle(props) !== DEFAULT_TITLE) {
tinyModeItems.push(getTitleElement(props));
} else {
tinyModeItems.push(
span(
{
className: "objectLeftBrace",
},
"{"
),
Object.keys(object).length ? ellipsisElement : null,
span(
{
className: "objectRightBrace",
},
"}"
)
);
}
return span(
{
className: "objectBox objectBox-object",
title: shouldRenderTooltip ? getTitle(props) : null,
},
...tinyModeItems
);
}
const propsArray = safePropIterator(props, object);
return span(
{
className: "objectBox objectBox-object",
title: shouldRenderTooltip ? getTitle(props) : null,
},
getTitleElement(props),
span(
{
className: "objectLeftBrace",
},
" { "
),
...propsArray,
span(
{
className: "objectRightBrace",
},
" }"
)
);
}
function getTitleElement(props) {
return span({ className: "objectTitle" }, getTitle(props));
}
function getTitle(props) {
return props.title || DEFAULT_TITLE;
}
function safePropIterator(props, object, max) {
max = typeof max === "undefined" ? 3 : max;
try {
return propIterator(props, object, max);
} catch (err) {
console.error(err);
}
return [];
}
function propIterator(props, object, max) {
if (Object.prototype.toString.call(object) === "[object Generator]") {
object = Object.getPrototypeOf(object);
}
const elements = [];
const unimportantProperties = [];
let propertiesNumber = 0;
const propertiesNames = Object.keys(object);
const pushPropRep = (name, value) => {
elements.push(
PropRep({
...props,
key: name,
mode: MODE.TINY,
name,
object: value,
equal: ": ",
})
);
propertiesNumber++;
if (propertiesNumber < propertiesNames.length) {
elements.push(", ");
}
};
try {
for (const name of propertiesNames) {
if (propertiesNumber >= max) {
break;
}
let value;
try {
value = object[name];
} catch (exc) {
continue;
}
// Object members with non-empty values are preferred since it gives the
// user a better overview of the object.
if (isInterestingProp(value)) {
pushPropRep(name, value);
} else {
// If the property is not important, put its name on an array for later
// use.
unimportantProperties.push(name);
}
}
} catch (err) {
console.error(err);
}
if (propertiesNumber < max) {
for (const name of unimportantProperties) {
if (propertiesNumber >= max) {
break;
}
let value;
try {
value = object[name];
} catch (exc) {
continue;
}
pushPropRep(name, value);
}
}
if (propertiesNumber < propertiesNames.length) {
elements.push(ellipsisElement);
}
return elements;
}
function isInterestingProp(value) {
const type = typeof value;
return type == "boolean" || type == "number" || (type == "string" && value);
}
function supportsObject(object, noGrip = false) {
return noGrip;
}
// Exports from this module
module.exports = {
rep: wrapRender(ObjectRep),
supportsObject,
};
});