/**
* @license
* Copyright The Closure Library Authors.
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview Creates a string of a JSON object, properly indented for
* display.
*/
goog.provide('goog.format.JsonPrettyPrinter');
goog.provide('goog.format.JsonPrettyPrinter.SafeHtmlDelimiters');
goog.provide('goog.format.JsonPrettyPrinter.TextDelimiters');
goog.require('goog.html.SafeHtml');
goog.require('goog.json');
goog.require('goog.json.Serializer');
goog.require('goog.string');
goog.require('goog.string.format');
/**
* Formats a JSON object as a string, properly indented for display. Supports
* displaying the string as text or html. Users can also specify their own
* set of delimiters for different environments. For example, the JSON object:
*
* <code>{"a": 1, "b": {"c": null, "d": true, "e": [1, 2]}}</code>
*
* Will be displayed like this:
*
* <code>{
* "a": 1,
* "b": {
* "c": null,
* "d": true,
* "e": [
* 1,
* 2
* ]
* }
* }</code>
* @param {?goog.format.JsonPrettyPrinter.TextDelimiters=} opt_delimiters
* Container for the various strings to use to delimit objects, arrays,
* newlines, and other pieces of the output.
* @constructor
*/
goog.format.JsonPrettyPrinter = function(opt_delimiters) {
'use strict';
/**
* The set of characters to use as delimiters.
* @private @const {!goog.format.JsonPrettyPrinter.TextDelimiters}
*/
this.delimiters_ =
opt_delimiters || new goog.format.JsonPrettyPrinter.TextDelimiters();
/**
* Used to serialize property names and values.
* @private @const {!goog.json.Serializer}
*/
this.jsonSerializer_ = new goog.json.Serializer();
};
/**
* Formats a JSON object as a string, properly indented for display.
* @param {*} json The object to pretty print. It could be a JSON object, a
* string representing a JSON object, or any other type.
* @return {string} Returns a string of the JSON object, properly indented for
* display.
*/
goog.format.JsonPrettyPrinter.prototype.format = function(json) {
'use strict';
var buffer = this.format_(json);
var output = '';
for (var i = 0; i < buffer.length; i++) {
var item = buffer[i];
output += item instanceof goog.html.SafeHtml ?
goog.html.SafeHtml.unwrap(item) :
item;
}
return output;
};
/**
* Formats a JSON object as a SafeHtml, properly indented for display.
* @param {*} json The object to pretty print. It could be a JSON object, a
* string representing a JSON object, or any other type.
* @return {!goog.html.SafeHtml} A HTML code of the JSON object.
*/
goog.format.JsonPrettyPrinter.prototype.formatSafeHtml = function(json) {
'use strict';
return goog.html.SafeHtml.concat(this.format_(json));
};
/**
* Formats a JSON object and returns an output buffer.
* @param {*} json The object to pretty print.
* @return {!Array<string|!goog.html.SafeHtml>}
* @private
*/
goog.format.JsonPrettyPrinter.prototype.format_ = function(json) {
'use strict';
// If input is undefined, null, or empty, return an empty string.
if (json == null) {
return [];
}
if (typeof json === 'string') {
if (goog.string.isEmptyOrWhitespace(json)) {
return [];
}
// Try to coerce a string into a JSON object.
json = JSON.parse(json);
}
var outputBuffer = [];
this.printObject_(json, outputBuffer, 0);
return outputBuffer;
};
/**
* Formats a property value based on the type of the propery.
* @param {*} val The object to format.
* @param {!Array<string|!goog.html.SafeHtml>} outputBuffer The buffer to write
* the response to.
* @param {number} indent The number of spaces to indent each line of the
* output.
* @private
* @suppress {strictMissingProperties} Part of the go/strict_warnings_migration
*/
goog.format.JsonPrettyPrinter.prototype.printObject_ = function(
val, outputBuffer, indent) {
'use strict';
var typeOf = goog.typeOf(val);
switch (typeOf) {
case 'null':
case 'boolean':
case 'number':
case 'string':
// "null", "boolean", "number" and "string" properties are printed
// directly to the output.
this.printValue_(
/** @type {null|string|boolean|number} */ (val), typeOf,
outputBuffer);
break;
case 'array':
// Example of how an array looks when formatted
// (using the default delimiters):
// [
// 1,
// 2,
// 3
// ]
outputBuffer.push(this.delimiters_.arrayStart);
var i = 0;
// Iterate through the array and format each element.
for (i = 0; i < val.length; i++) {
if (i > 0) {
// There are multiple elements, add a comma to separate them.
outputBuffer.push(this.delimiters_.propertySeparator);
}
outputBuffer.push(this.delimiters_.lineBreak);
this.printSpaces_(indent + this.delimiters_.indent, outputBuffer);
this.printObject_(
val[i], outputBuffer, indent + this.delimiters_.indent);
}
// If there are no properties in this object, don't put a line break
// between the beginning "[" and ending "]", so the output of an empty
// array looks like <code>[]</code>.
if (i > 0) {
outputBuffer.push(this.delimiters_.lineBreak);
this.printSpaces_(indent, outputBuffer);
}
outputBuffer.push(this.delimiters_.arrayEnd);
break;
case 'object':
// Example of how an object looks when formatted
// (using the default delimiters):
// {
// "a": 1,
// "b": 2,
// "c": "3"
// }
outputBuffer.push(this.delimiters_.objectStart);
var propertyCount = 0;
// Iterate through the object and display each property.
for (var name in val) {
if (!val.hasOwnProperty(name)) {
continue;
}
if (propertyCount > 0) {
// There are multiple properties, add a comma to separate them.
outputBuffer.push(this.delimiters_.propertySeparator);
}
outputBuffer.push(this.delimiters_.lineBreak);
this.printSpaces_(indent + this.delimiters_.indent, outputBuffer);
this.printName_(name, outputBuffer);
outputBuffer.push(
this.delimiters_.nameValueSeparator, this.delimiters_.space);
this.printObject_(
val[name], outputBuffer, indent + this.delimiters_.indent);
propertyCount++;
}
// If there are no properties in this object, don't put a line break
// between the beginning "{" and ending "}", so the output of an empty
// object looks like <code>{}</code>.
if (propertyCount > 0) {
outputBuffer.push(this.delimiters_.lineBreak);
this.printSpaces_(indent, outputBuffer);
}
outputBuffer.push(this.delimiters_.objectEnd);
break;
// Other types, such as "function", aren't expected in JSON, and their
// behavior is undefined. In these cases, just print an empty string to the
// output buffer. This allows the pretty printer to continue while still
// outputing well-formed JSON.
default:
this.printValue_('', 'unknown', outputBuffer);
}
};
/**
* Prints a property name to the output.
* @param {string} name The property name.
* @param {!Array<string|!goog.html.SafeHtml>} outputBuffer The buffer to write
* the response to.
* @private
*/
goog.format.JsonPrettyPrinter.prototype.printName_ = function(
name, outputBuffer) {
'use strict';
outputBuffer.push(
this.delimiters_.formatName(this.jsonSerializer_.serialize(name)));
};
/**
* Prints a property name to the output.
* @param {string|boolean|number|null} val The property value.
* @param {string} typeOf The type of the value. Used to customize
* value-specific css in the display. This allows clients to distinguish
* between different types in css. For example, the client may define two
* classes: "goog-jsonprettyprinter-propertyvalue-string" and
* "goog-jsonprettyprinter-propertyvalue-number" to assign a different color
* to string and number values.
* @param {!Array<string|!goog.html.SafeHtml>} outputBuffer The buffer to write
* the response to.
* @private
*/
goog.format.JsonPrettyPrinter.prototype.printValue_ = function(
val, typeOf, outputBuffer) {
'use strict';
var value = this.jsonSerializer_.serialize(val);
outputBuffer.push(this.delimiters_.formatValue(value, typeOf));
};
/**
* Print a number of space characters to the output.
* @param {number} indent The number of spaces to indent the line.
* @param {!Array<string|!goog.html.SafeHtml>} outputBuffer The buffer to write
* the response to.
* @private
*/
goog.format.JsonPrettyPrinter.prototype.printSpaces_ = function(
indent, outputBuffer) {
'use strict';
outputBuffer.push(goog.string.repeat(this.delimiters_.space, indent));
};
/**
* A container for the delimiting characters used to display the JSON string
* to a text display. Each delimiter is a publicly accessible property of
* the object, which makes it easy to tweak delimiters to specific environments.
* @constructor
*/
goog.format.JsonPrettyPrinter.TextDelimiters = function() {};
/**
* Represents a space character in the output. Used to indent properties a
* certain number of spaces, and to separate property names from property
* values.
* @type {string}
*/
goog.format.JsonPrettyPrinter.TextDelimiters.prototype.space = ' ';
/**
* Represents a newline character in the output. Used to begin a new line.
* @type {string|!goog.html.SafeHtml}
*/
goog.format.JsonPrettyPrinter.TextDelimiters.prototype.lineBreak = '\n';
/**
* Represents the start of an object in the output.
* @type {string}
*/
goog.format.JsonPrettyPrinter.TextDelimiters.prototype.objectStart = '{';
/**
* Represents the end of an object in the output.
* @type {string}
*/
goog.format.JsonPrettyPrinter.TextDelimiters.prototype.objectEnd = '}';
/**
* Represents the start of an array in the output.
* @type {string}
*/
goog.format.JsonPrettyPrinter.TextDelimiters.prototype.arrayStart = '[';
/**
* Represents the end of an array in the output.
* @type {string}
*/
goog.format.JsonPrettyPrinter.TextDelimiters.prototype.arrayEnd = ']';
/**
* Represents the string used to separate properties in the output.
* @type {string}
*/
goog.format.JsonPrettyPrinter.TextDelimiters.prototype.propertySeparator = ',';
/**
* Represents the string used to separate property names from property values in
* the output.
* @type {string|!goog.html.SafeHtml}
*/
goog.format.JsonPrettyPrinter.TextDelimiters.prototype.nameValueSeparator = ':';
/**
* A string that's placed before a property name in the output. Useful for
* wrapping a property name in an html tag.
* @type {string}
*/
goog.format.JsonPrettyPrinter.TextDelimiters.prototype.preName = '';
/**
* A string that's placed after a property name in the output. Useful for
* wrapping a property name in an html tag.
* @type {string}
*/
goog.format.JsonPrettyPrinter.TextDelimiters.prototype.postName = '';
/**
* Formats a property name before adding it to the output.
* @param {string} name The property name.
* @return {string|!goog.html.SafeHtml}
*/
goog.format.JsonPrettyPrinter.TextDelimiters.prototype.formatName = function(
name) {
'use strict';
return this.preName + name + this.postName;
};
/**
* A string that's placed before a property value in the output. Useful for
* wrapping a property value in an html tag.
* @type {string}
*/
goog.format.JsonPrettyPrinter.TextDelimiters.prototype.preValue = '';
/**
* A string that's placed after a property value in the output. Useful for
* wrapping a property value in an html tag.
* @type {string}
*/
goog.format.JsonPrettyPrinter.TextDelimiters.prototype.postValue = '';
/**
* Formats a value before adding it to the output.
* @param {string} value The value.
* @param {string} typeOf The type of the value obtained by goog.typeOf.
* @return {string|!goog.html.SafeHtml}
*/
goog.format.JsonPrettyPrinter.TextDelimiters.prototype.formatValue = function(
value, typeOf) {
'use strict';
return goog.string.format(this.preValue, typeOf) + value + this.postValue;
};
/**
* Represents the number of spaces to indent each sub-property of the JSON.
* @type {number}
*/
goog.format.JsonPrettyPrinter.TextDelimiters.prototype.indent = 2;
/**
* A container for the delimiting characters used to display the JSON string
* to an HTML <code><pre></code> or <code><code></code> element.
* It escapes the names and values before they are added to the output.
* Use this class together with goog.format.JsonPrettyPrinter#formatSafeHtml.
* @constructor
* @extends {goog.format.JsonPrettyPrinter.TextDelimiters}
*/
goog.format.JsonPrettyPrinter.SafeHtmlDelimiters = function() {
'use strict';
goog.format.JsonPrettyPrinter.TextDelimiters.call(this);
};
goog.inherits(
goog.format.JsonPrettyPrinter.SafeHtmlDelimiters,
goog.format.JsonPrettyPrinter.TextDelimiters);
/** @override */
goog.format.JsonPrettyPrinter.SafeHtmlDelimiters.prototype.formatName =
function(name) {
'use strict';
var classes = goog.getCssName('goog-jsonprettyprinter-propertyname');
return goog.html.SafeHtml.create('span', {'class': classes}, name);
};
/** @override */
goog.format.JsonPrettyPrinter.SafeHtmlDelimiters.prototype.formatValue =
function(value, typeOf) {
'use strict';
var classes = this.getValueCssName(typeOf);
return goog.html.SafeHtml.create('span', {'class': classes}, value);
};
/**
* Return a class name for the given type.
* @param {string} typeOf The type of the value.
* @return {string}
* @protected
*/
goog.format.JsonPrettyPrinter.SafeHtmlDelimiters.prototype.getValueCssName =
function(typeOf) {
'use strict';
// This switch is needed because goog.getCssName requires a constant string.
switch (typeOf) {
case 'null':
return goog.getCssName('goog-jsonprettyprinter-propertyvalue-null');
case 'boolean':
return goog.getCssName('goog-jsonprettyprinter-propertyvalue-boolean');
case 'number':
return goog.getCssName('goog-jsonprettyprinter-propertyvalue-number');
case 'string':
return goog.getCssName('goog-jsonprettyprinter-propertyvalue-string');
case 'array':
return goog.getCssName('goog-jsonprettyprinter-propertyvalue-array');
case 'object':
return goog.getCssName('goog-jsonprettyprinter-propertyvalue-object');
default:
return goog.getCssName('goog-jsonprettyprinter-propertyvalue-unknown');
}
};
Codebase Browser
chromium