Stringify.js.html revision 7e71f5f40d4236c1bacc6b7fff644bafa8a81ac2
<html>
<head>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h3>json <span class="subtitle">3.00PR1</span></h3>
<p>
> Stringify.js (source view)
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form name="yui-classopts-form">
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> Show Private</span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> Show Protected</span>
<span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> Show Deprecated</span>
</form>
<div id="srcout">
<style>
#doc3 #classopts { display:none; }
</style>
<div class="highlight" ><pre><span class="c">/**</span>
<span class="c"> * @module json</span>
<span class="c"> * @class JSON</span>
<span class="c"> * @static</span>
<span class="c"> */</span>
<span class="k">var</span> <span class="nx">isA</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">Lang</span><span class="o">.</span><span class="nx">isArray</span><span class="o">;</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">JSON</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">JSON</span> <span class="o">||</span> <span class="o">{};</span>
<span class="nx">Y</span><span class="o">.</span><span class="nx">mix</span><span class="o">(</span><span class="nx">Y</span><span class="o">.</span><span class="nx">JSON</span><span class="o">,{</span>
<span class="c">/**</span>
<span class="c"> * Regex used to replace special characters in strings for JSON</span>
<span class="c"> * stringification.</span>
<span class="c"> * @property _SPECIAL_CHARS</span>
<span class="c"> * @type {RegExp}</span>
<span class="c"> * @static</span>
<span class="c"> * @private</span>
<span class="c"> */</span>
<span class="nx">_SPECIAL_CHARS</span> <span class="o">:</span> <span class="sr">/["\\\x00-\x1f\x7f-\x9f]/g</span><span class="o">,</span>
<span class="c">/**</span>
<span class="c"> * Character substitution map for common escapes and special characters.</span>
<span class="c"> * @property _CHARS</span>
<span class="c"> * @type {Object}</span>
<span class="c"> * @static</span>
<span class="c"> * @private</span>
<span class="c"> */</span>
<span class="nx">_CHARS</span> <span class="o">:</span> <span class="o">{</span>
<span class="s1">'\b'</span><span class="o">:</span> <span class="s1">'\\b'</span><span class="o">,</span>
<span class="s1">'\t'</span><span class="o">:</span> <span class="s1">'\\t'</span><span class="o">,</span>
<span class="s1">'\n'</span><span class="o">:</span> <span class="s1">'\\n'</span><span class="o">,</span>
<span class="s1">'\f'</span><span class="o">:</span> <span class="s1">'\\f'</span><span class="o">,</span>
<span class="s1">'\r'</span><span class="o">:</span> <span class="s1">'\\r'</span><span class="o">,</span>
<span class="s1">'"'</span> <span class="o">:</span> <span class="s1">'\\"'</span><span class="o">,</span>
<span class="s1">'\\'</span><span class="o">:</span> <span class="s1">'\\\\'</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Serializes a Date instance as a UTC date string. Used internally by</span>
<span class="c"> * stringify. Override this method if you need Dates serialized in a</span>
<span class="c"> * different format.</span>
<span class="c"> * @method dateToString</span>
<span class="c"> * @param d {Date} The Date to serialize</span>
<span class="c"> * @return {String} stringified Date in UTC format YYYY-MM-DDTHH:mm:SSZ</span>
<span class="c"> * @static</span>
<span class="c"> */</span>
<span class="nx">dateToString</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">d</span><span class="o">)</span> <span class="o">{</span>
<span class="k">function</span> <span class="nx">_zeroPad</span><span class="o">(</span><span class="nx">v</span><span class="o">)</span> <span class="o">{</span>
<span class="k">return</span> <span class="nx">v</span> <span class="o"><</span> <span class="m">10</span> <span class="o">?</span> <span class="s1">'0'</span> <span class="o">+</span> <span class="nx">v</span> <span class="o">:</span> <span class="nx">v</span><span class="o">;</span>
<span class="o">}</span>
<span class="k">return</span> <span class="s1">'"'</span> <span class="o">+</span> <span class="nx">d</span><span class="o">.</span><span class="nx">getUTCFullYear</span><span class="o">()</span> <span class="o">+</span> <span class="s1">'-'</span> <span class="o">+</span>
<span class="nx">_zeroPad</span><span class="o">(</span><span class="nx">d</span><span class="o">.</span><span class="nx">getUTCMonth</span><span class="o">()</span> <span class="o">+</span> <span class="m">1</span><span class="o">)</span> <span class="o">+</span> <span class="s1">'-'</span> <span class="o">+</span>
<span class="nx">_zeroPad</span><span class="o">(</span><span class="nx">d</span><span class="o">.</span><span class="nx">getUTCDate</span><span class="o">())</span> <span class="o">+</span> <span class="s1">'T'</span> <span class="o">+</span>
<span class="nx">_zeroPad</span><span class="o">(</span><span class="nx">d</span><span class="o">.</span><span class="nx">getUTCHours</span><span class="o">())</span> <span class="o">+</span> <span class="s1">':'</span> <span class="o">+</span>
<span class="nx">_zeroPad</span><span class="o">(</span><span class="nx">d</span><span class="o">.</span><span class="nx">getUTCMinutes</span><span class="o">())</span> <span class="o">+</span> <span class="s1">':'</span> <span class="o">+</span>
<span class="nx">_zeroPad</span><span class="o">(</span><span class="nx">d</span><span class="o">.</span><span class="nx">getUTCSeconds</span><span class="o">())</span> <span class="o">+</span> <span class="s1">'Z"'</span><span class="o">;</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Converts an arbitrary value to a JSON string representation.</span>
<span class="c"> * Cyclical object or array references are replaced with null.</span>
<span class="c"> * If a whitelist is provided, only matching object keys will be included.</span>
<span class="c"> * If a depth limit is provided, objects and arrays at that depth will</span>
<span class="c"> * be stringified as empty.</span>
<span class="c"> * @method stringify</span>
<span class="c"> * @param o {MIXED} any arbitrary object to convert to JSON string</span>
<span class="c"> * @param w {Array} (optional) whitelist of acceptable object keys to include</span>
<span class="c"> * @param d {number} (optional) depth limit to recurse objects/arrays (practical minimum 1)</span>
<span class="c"> * @return {string} JSON string representation of the input</span>
<span class="c"> * @static</span>
<span class="c"> * @public</span>
<span class="c"> */</span>
<span class="nx">stringify</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">o</span><span class="o">,</span><span class="nx">w</span><span class="o">,</span><span class="nx">d</span><span class="o">)</span> <span class="o">{</span>
<span class="k">var</span> <span class="nx">m</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">JSON</span><span class="o">.</span><span class="nx">_CHARS</span><span class="o">,</span>
<span class="nx">str_re</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">JSON</span><span class="o">.</span><span class="nx">_SPECIAL_CHARS</span><span class="o">,</span>
<span class="nx">rep</span> <span class="o">=</span> <span class="k">typeof</span> <span class="nx">w</span> <span class="o">===</span> <span class="s1">'function'</span> <span class="o">?</span> <span class="nx">w</span> <span class="o">:</span> <span class="kc">null</span><span class="o">,</span>
<span class="nx">pstack</span> <span class="o">=</span> <span class="o">[];</span> <span class="c">// Processing stack used for cyclical ref protection</span>
<span class="c"></span>
<span class="k">if</span> <span class="o">(</span><span class="nx">rep</span> <span class="o">||</span> <span class="k">typeof</span> <span class="nx">w</span> <span class="o">!==</span> <span class="s1">'object'</span><span class="o">)</span> <span class="o">{</span>
<span class="nx">w</span> <span class="o">=</span> <span class="kc">undefined</span><span class="o">;</span>
<span class="o">}</span>
<span class="c">// escape encode special characters</span>
<span class="c"></span> <span class="k">var</span> <span class="nx">_char</span> <span class="o">=</span> <span class="k">function</span> <span class="o">(</span><span class="nx">c</span><span class="o">)</span> <span class="o">{</span>
<span class="k">if</span> <span class="o">(!</span><span class="nx">m</span><span class="o">[</span><span class="nx">c</span><span class="o">])</span> <span class="o">{</span>
<span class="k">var</span> <span class="nx">a</span> <span class="o">=</span> <span class="nx">c</span><span class="o">.</span><span class="nx">charCodeAt</span><span class="o">();</span>
<span class="nx">m</span><span class="o">[</span><span class="nx">c</span><span class="o">]</span> <span class="o">=</span> <span class="s1">'\\u00'</span> <span class="o">+</span> <span class="nb">Math</span><span class="o">.</span><span class="nx">floor</span><span class="o">(</span><span class="nx">a</span> <span class="o">/</span> <span class="m">16</span><span class="o">).</span><span class="nx">toString</span><span class="o">(</span><span class="m">16</span><span class="o">)</span> <span class="o">+</span>
<span class="o">(</span><span class="nx">a</span> <span class="o">%</span> <span class="m">16</span><span class="o">).</span><span class="nx">toString</span><span class="o">(</span><span class="m">16</span><span class="o">);</span>
<span class="o">}</span>
<span class="k">return</span> <span class="nx">m</span><span class="o">[</span><span class="nx">c</span><span class="o">];</span>
<span class="o">};</span>
<span class="c">// Enclose the escaped string in double quotes</span>
<span class="c"></span> <span class="k">var</span> <span class="nx">_string</span> <span class="o">=</span> <span class="k">function</span> <span class="o">(</span><span class="nx">s</span><span class="o">)</span> <span class="o">{</span>
<span class="k">return</span> <span class="s1">'"'</span> <span class="o">+</span> <span class="nx">s</span><span class="o">.</span><span class="nx">replace</span><span class="o">(</span><span class="nx">str_re</span><span class="o">,</span> <span class="nx">_char</span><span class="o">)</span> <span class="o">+</span> <span class="s1">'"'</span><span class="o">;</span>
<span class="o">};</span>
<span class="c">// Use the configured date conversion</span>
<span class="c"></span> <span class="k">var</span> <span class="nx">_date</span> <span class="o">=</span> <span class="nx">Y</span><span class="o">.</span><span class="nx">JSON</span><span class="o">.</span><span class="nx">dateToString</span><span class="o">;</span>
<span class="c">// Worker function. Fork behavior on data type and recurse objects and</span>
<span class="c"></span> <span class="c">// arrays per the configured depth.</span>
<span class="c"></span> <span class="k">var</span> <span class="nx">_stringify</span> <span class="o">=</span> <span class="k">function</span> <span class="o">(</span><span class="nx">h</span><span class="o">,</span><span class="nx">key</span><span class="o">,</span><span class="nx">d</span><span class="o">)</span> <span class="o">{</span>
<span class="k">var</span> <span class="nx">o</span> <span class="o">=</span> <span class="k">typeof</span> <span class="nx">rep</span> <span class="o">===</span> <span class="s1">'function'</span> <span class="o">?</span> <span class="nx">rep</span><span class="o">.</span><span class="nx">call</span><span class="o">(</span><span class="nx">h</span><span class="o">,</span><span class="nx">key</span><span class="o">,</span><span class="nx">h</span><span class="o">[</span><span class="nx">key</span><span class="o">])</span> <span class="o">:</span> <span class="nx">h</span><span class="o">[</span><span class="nx">key</span><span class="o">],</span>
<span class="nx">t</span> <span class="o">=</span> <span class="k">typeof</span> <span class="nx">o</span><span class="o">,</span>
<span class="nx">i</span><span class="o">,</span><span class="nx">len</span><span class="o">,</span><span class="nx">j</span><span class="o">,</span> <span class="c">// array iteration</span>
<span class="c"></span> <span class="nx">k</span><span class="o">,</span><span class="nx">v</span><span class="o">,</span> <span class="c">// object iteration</span>
<span class="c"></span> <span class="nx">a</span><span class="o">;</span> <span class="c">// composition array for performance over string concat</span>
<span class="c"></span>
<span class="c">// String</span>
<span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">t</span> <span class="o">===</span> <span class="s1">'string'</span><span class="o">)</span> <span class="o">{</span>
<span class="k">return</span> <span class="nx">_string</span><span class="o">(</span><span class="nx">o</span><span class="o">);</span>
<span class="o">}</span>
<span class="c">// native boolean and Boolean instance</span>
<span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">t</span> <span class="o">===</span> <span class="s1">'boolean'</span> <span class="o">||</span> <span class="nx">o</span> <span class="k">instanceof</span> <span class="nb">Boolean</span><span class="o">)</span> <span class="o">{</span>
<span class="k">return</span> <span class="nb">String</span><span class="o">(</span><span class="nx">o</span><span class="o">);</span>
<span class="o">}</span>
<span class="c">// native number and Number instance</span>
<span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">t</span> <span class="o">===</span> <span class="s1">'number'</span> <span class="o">||</span> <span class="nx">o</span> <span class="k">instanceof</span> <span class="nb">Number</span><span class="o">)</span> <span class="o">{</span>
<span class="k">return</span> <span class="nb">isFinite</span><span class="o">(</span><span class="nx">o</span><span class="o">)</span> <span class="o">?</span> <span class="nb">String</span><span class="o">(</span><span class="nx">o</span><span class="o">)</span> <span class="o">:</span> <span class="s1">'null'</span><span class="o">;</span>
<span class="o">}</span>
<span class="c">// Date</span>
<span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">o</span> <span class="k">instanceof</span> <span class="nb">Date</span><span class="o">)</span> <span class="o">{</span>
<span class="k">return</span> <span class="nx">_date</span><span class="o">(</span><span class="nx">o</span><span class="o">);</span>
<span class="o">}</span>
<span class="c">// Object types</span>
<span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">t</span> <span class="o">===</span> <span class="s1">'object'</span><span class="o">)</span> <span class="o">{</span>
<span class="k">if</span> <span class="o">(!</span><span class="nx">o</span><span class="o">)</span> <span class="o">{</span>
<span class="k">return</span> <span class="s1">'null'</span><span class="o">;</span>
<span class="o">}</span>
<span class="c">// Check for cyclical references</span>
<span class="c"></span> <span class="k">for</span> <span class="o">(</span><span class="nx">i</span> <span class="o">=</span> <span class="nx">pstack</span><span class="o">.</span><span class="nx">length</span> <span class="o">-</span> <span class="m">1</span><span class="o">;</span> <span class="nx">i</span> <span class="o">>=</span> <span class="m">0</span><span class="o">;</span> <span class="o">--</span><span class="nx">i</span><span class="o">)</span> <span class="o">{</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">pstack</span><span class="o">[</span><span class="nx">i</span><span class="o">]</span> <span class="o">===</span> <span class="nx">o</span><span class="o">)</span> <span class="o">{</span>
<span class="k">return</span> <span class="s1">'null'</span><span class="o">;</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="c">// Add the object to the processing stack</span>
<span class="c"></span> <span class="nx">pstack</span><span class="o">[</span><span class="nx">pstack</span><span class="o">.</span><span class="nx">length</span><span class="o">]</span> <span class="o">=</span> <span class="nx">o</span><span class="o">;</span>
<span class="nx">a</span> <span class="o">=</span> <span class="o">[];</span>
<span class="c">// Only recurse if we're above depth config</span>
<span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">d</span> <span class="o">></span> <span class="m">0</span><span class="o">)</span> <span class="o">{</span>
<span class="c">// Array</span>
<span class="c"></span> <span class="k">if</span> <span class="o">(</span><span class="nx">isA</span><span class="o">(</span><span class="nx">o</span><span class="o">))</span> <span class="o">{</span>
<span class="k">for</span> <span class="o">(</span><span class="nx">i</span> <span class="o">=</span> <span class="nx">o</span><span class="o">.</span><span class="nx">length</span> <span class="o">-</span> <span class="m">1</span><span class="o">;</span> <span class="nx">i</span> <span class="o">>=</span> <span class="m">0</span><span class="o">;</span> <span class="o">--</span><span class="nx">i</span><span class="o">)</span> <span class="o">{</span>
<span class="nx">a</span><span class="o">[</span><span class="nx">i</span><span class="o">]</span> <span class="o">=</span> <span class="nx">_stringify</span><span class="o">(</span><span class="nx">o</span><span class="o">,</span><span class="nx">i</span><span class="o">,</span><span class="nx">d</span><span class="o">-</span><span class="m">1</span><span class="o">)</span> <span class="o">||</span> <span class="s1">'null'</span><span class="o">;</span>
<span class="o">}</span>
<span class="c">// Object</span>
<span class="c"></span> <span class="o">}</span> <span class="k">else</span> <span class="o">{</span>
<span class="c">// If whitelist provided, take only those keys</span>
<span class="c"></span> <span class="nx">k</span> <span class="o">=</span> <span class="nx">isA</span><span class="o">(</span><span class="nx">w</span><span class="o">)</span> <span class="o">?</span> <span class="nx">w</span> <span class="o">:</span> <span class="nx">Y</span><span class="o">.</span><span class="nb">Object</span><span class="o">.</span><span class="nx">keys</span><span class="o">(</span><span class="nx">w</span><span class="o">||</span><span class="nx">o</span><span class="o">);</span>
<span class="k">for</span> <span class="o">(</span><span class="nx">i</span> <span class="o">=</span> <span class="m">0</span><span class="o">,</span> <span class="nx">j</span> <span class="o">=</span> <span class="m">0</span><span class="o">,</span> <span class="nx">len</span> <span class="o">=</span> <span class="nx">k</span><span class="o">.</span><span class="nx">length</span><span class="o">;</span> <span class="nx">i</span> <span class="o"><</span> <span class="nx">len</span><span class="o">;</span> <span class="o">++</span><span class="nx">i</span><span class="o">)</span> <span class="o">{</span>
<span class="k">if</span> <span class="o">(</span><span class="k">typeof</span> <span class="nx">k</span><span class="o">[</span><span class="nx">i</span><span class="o">]</span> <span class="o">===</span> <span class="s1">'string'</span><span class="o">)</span> <span class="o">{</span>
<span class="nx">v</span> <span class="o">=</span> <span class="nx">_stringify</span><span class="o">(</span><span class="nx">o</span><span class="o">,</span><span class="nx">k</span><span class="o">[</span><span class="nx">i</span><span class="o">],</span><span class="nx">d</span><span class="o">-</span><span class="m">1</span><span class="o">);</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">v</span><span class="o">)</span> <span class="o">{</span>
<span class="nx">a</span><span class="o">[</span><span class="nx">j</span><span class="o">++]</span> <span class="o">=</span> <span class="nx">_string</span><span class="o">(</span><span class="nx">k</span><span class="o">[</span><span class="nx">i</span><span class="o">])</span> <span class="o">+</span> <span class="s1">':'</span> <span class="o">+</span> <span class="nx">v</span><span class="o">;</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="c">// remove the array from the stack</span>
<span class="c"></span> <span class="nx">pstack</span><span class="o">.</span><span class="nx">pop</span><span class="o">();</span>
<span class="k">return</span> <span class="nx">isA</span><span class="o">(</span><span class="nx">o</span><span class="o">)</span> <span class="o">?</span> <span class="s1">'['</span><span class="o">+</span><span class="nx">a</span><span class="o">.</span><span class="nx">join</span><span class="o">(</span><span class="s1">','</span><span class="o">)+</span><span class="s1">']'</span> <span class="o">:</span> <span class="s1">'{'</span><span class="o">+</span><span class="nx">a</span><span class="o">.</span><span class="nx">join</span><span class="o">(</span><span class="s1">','</span><span class="o">)+</span><span class="s1">'}'</span><span class="o">;</span>
<span class="o">}</span>
<span class="k">return</span> <span class="kc">undefined</span><span class="o">;</span> <span class="c">// invalid input</span>
<span class="c"></span> <span class="o">};</span>
<span class="c">// Default depth to POSITIVE_INFINITY</span>
<span class="c"></span> <span class="nx">d</span> <span class="o">=</span> <span class="nx">d</span> <span class="o">>=</span> <span class="m">0</span> <span class="o">?</span> <span class="nx">d</span> <span class="o">:</span> <span class="m">1</span><span class="o">/</span><span class="m">0</span><span class="o">;</span>
<span class="c">// process the input</span>
<span class="c"></span> <span class="k">return</span> <span class="nx">_stringify</span><span class="o">({</span><span class="s1">''</span><span class="o">:</span><span class="nx">o</span><span class="o">},</span><span class="s1">''</span><span class="o">,</span><span class="nx">d</span><span class="o">);</span>
<span class="o">}</span>
<span class="o">});</span>
</pre></div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div class="module">
<h4>Modules</h4>
<ul class="content">
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright © 2008 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>