76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Provides Y.JSON.stringify method for converting objects to JSON strings.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @module json
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @submodule json-stringify
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass Native = (_toStr.call(_JSON) === '[object JSON]' && _JSON),
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // Regex used to capture characters that need escaping before enclosing
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // their containing string in quotes.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass _SPECIAL = /[\x00-\x07\x0b\x0e-\x1f\x7f-\x9f\u00ad\u0600-\u0604\u070f\u17b4\u17b5\u200c-\u200f\u2028-\u202f\u2060-\u206f\ufeff\ufff0-\uffff]/g,
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // Character substitution map for common escapes and special characters.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass [/\\/g, '\\\\'],
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass _COMMON_LENGTH = _COMMON.length,
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // In-process optimization for special character escapes that haven't yet
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // been promoted to _COMMON
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // Per-char counter to determine if it's worth fast tracking a special
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // character escape sequence.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass// Utility function used to determine how to serialize a variable.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glassfunction _type(o) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass var t = typeof o;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass return _allowable[t] || // number, string, boolean, undefined
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass _allowable[_toStr.call(o)] || // Number, String, Boolean, Date
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass (o ? OBJECT : NULL) : // object, array, null, misc natives
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass// Escapes a special character to a safe Unicode representation
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glassfunction _char(c) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass _CHAR[c] = '\\u'+('0000'+(+(c.charCodeAt(0))).toString(16)).slice(-4);
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // === to avoid this conditional for the remainder of the current operation
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass// Enclose escaped strings in quotes
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glassfunction _string(s) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // Preprocess the string against common characters to avoid function
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // overhead associated with replacement via function.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // original function replace for the not-as-common set of chars
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass return QUOTE + s.replace(_SPECIAL, _char) + QUOTE;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass// Adds the provided space to the beginning of every line in the input string
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass// JavaScript implementation of stringify (see API declaration of stringify)
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass format = _toStr.call(space).match(/String|Number/) || [],
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // Ensure whitelist keys are unique (bug 2110391)
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass tmp[w[i]] = true;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // Per the spec, strings are truncated to 10 characters and numbers
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // are converted to that number of spaces (max 10)
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass new Array(Math.min(Math.max(0,space),10)+1).join(" ") :
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // Per the ECMA 5 spec, toJSON is applied before the replacer is
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // called. Also per the spec, Date.prototype.toJSON has been added, so
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // Date instances should be serialized prior to exposure to the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // replacer. I disagree with this decision, but the spec is the spec.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass if (isObject(value) && isFunction(value.toJSON)) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass } else if (t === DATE) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass switch (t) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass case DATE : // intentional fallthrough. Pre-replacer Dates are
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // serialized in the toJSON stage. Dates here would
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // have been produced by the replacer.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass case OBJECT : break;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass case NUMBER : return isFinite(value) ? value+EMPTY : NULL;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass default : return undefined;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // Check for cyclical references in nested objects
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass throw new Error("JSON.stringify. Cyclical reference");
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // Add the object to the processing stack
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass } else { // Object
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // If whitelist provided, take only those keys
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass for (k in keys) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // remove the array from the stack
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass OPEN_A + CR + _indent(a.join(COMMA_CR), space) + CR + CLOSE_A :
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass OPEN_O + CR + _indent(a.join(COMMA_CR), space) + CR + CLOSE_O;
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass // process the input
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass// Double check basic native functionality. This is primarily to catch broken
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass// early JSON API implementations in Firefox 3.1 beta1 and beta2.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass } catch ( e ) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Leverage native JSON stringify if the browser has a native
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * implementation. In general, this is a good idea. See the Known Issues
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * section in the JSON user guide for caveats. The default value is true
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * for browsers with native JSON support.
10d8bafc5c24f3a4285cf6060a1935ba5cfc4b85Luke Smith * @property useNativeStringify
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type Boolean
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @default true
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * Serializes a Date instance as a UTC date string. Used internally by
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * stringify. Override this method if you need Dates serialized in a
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * different format.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method dateToString
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param d {Date} The Date to serialize
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @return {String} stringified Date in UTC format YYYY-MM-DDTHH:mm:SSZ
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @deprecated Use a replacer function
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass dateToString : function (d) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass function _zeroPad(v) {
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <p>Converts an arbitrary value to a JSON string representation.</p>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <p>Objects with cyclical references will trigger an exception.</p>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <p>If a whitelist is provided, only matching object keys will be
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * included. Alternately, a replacer function may be passed as the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * second parameter. This function is executed on every value in the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * input, and its return value will be used in place of the original value.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * This is useful to serialize specialized objects or class instances.</p>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <p>If a positive integer or non-empty string is passed as the third
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * parameter, the output will be formatted with carriage returns and
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * indentation for readability. If a String is passed (such as "\t") it
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * will be used once for each indentation level. If a number is passed,
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * that number of spaces will be used.</p>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @method stringify
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param o {MIXED} any arbitrary value to convert to JSON string
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param w {Array|Function} (optional) whitelist of acceptable object
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * keys to include, or a replacer function to modify the
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * raw value before serialization
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @param ind {Number|String} (optional) indentation character or depth of
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * spaces to format the output.
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @return {string} JSON string representation of the input
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <p>Number of occurrences of a special character within a single call to
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * stringify that should trigger promotion of that character to a dedicated
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * preprocess step for future calls. This is only used in environments
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * that don't support native JSON, or when useNativeStringify is set to
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * false.</p>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <p>So, if set to 50 and an object is passed to stringify that includes
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * strings containing the special character \x07 more than 50 times,
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * subsequent calls to stringify will process object strings through a
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * faster serialization path for \x07 before using the generic, slower,
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * replacement process for all special characters.</p>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <p>To prime the preprocessor cache, set this value to 1, then call
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <code>Y.JSON.stringify("<em>(all special characters to
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * cache)</em>");</code>, then return this setting to a more conservative
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * value.</p>
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * <p>Special characters \ " \b \t \n \f \r are already cached.</p>
10d8bafc5c24f3a4285cf6060a1935ba5cfc4b85Luke Smith * @property charCacheThreshold
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @default 100
76ca635d61eb3f9fb7c9d788a44fa8b1690aa138Dav Glass * @type {Number}