/
_j_s_o_n_kit_8h_source.html
345 lines (327 loc) · 30.4 KB
/
_j_s_o_n_kit_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Nimbus: src/JSONKit/src/JSONKit.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-24278774-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div id="page">
<div style="position:relative">
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<a style="float: right;margin-right:20px;margin-top:20px" href='http://www.pledgie.com/campaigns/15519'><img alt='Click here to support Nimbus development and make a donation at www.pledgie.com !' src='http://www.pledgie.com/campaigns/15519.png?skin_name=chrome' border='0' /></a>
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Nimbus
 <span id="projectnumber">0.7.0 - <a href="http://github.com/jverkoey/nimbus">Nimbus is proudly hosted on Github</a></span>
</div>
<div id="projectbrief">An iOS framework whose growth is bounded by O(documentation).</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.4-20110629 -->
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('_j_s_o_n_kit_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">src/JSONKit/src/JSONKit.h</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">//</span>
<a name="l00002"></a>00002 <span class="comment">// JSONKit.h</span>
<a name="l00003"></a>00003 <span class="comment">// http://github.com/johnezang/JSONKit</span>
<a name="l00004"></a>00004 <span class="comment">// Dual licensed under either the terms of the BSD License, or alternatively</span>
<a name="l00005"></a>00005 <span class="comment">// under the terms of the Apache License, Version 2.0, as specified below.</span>
<a name="l00006"></a>00006 <span class="comment">//</span>
<a name="l00007"></a>00007
<a name="l00008"></a>00008 <span class="comment">/*</span>
<a name="l00009"></a>00009 <span class="comment"> Copyright (c) 2011, John Engelhart</span>
<a name="l00010"></a>00010 <span class="comment"> </span>
<a name="l00011"></a>00011 <span class="comment"> All rights reserved.</span>
<a name="l00012"></a>00012 <span class="comment"> </span>
<a name="l00013"></a>00013 <span class="comment"> Redistribution and use in source and binary forms, with or without</span>
<a name="l00014"></a>00014 <span class="comment"> modification, are permitted provided that the following conditions are met:</span>
<a name="l00015"></a>00015 <span class="comment"> </span>
<a name="l00016"></a>00016 <span class="comment"> * Redistributions of source code must retain the above copyright</span>
<a name="l00017"></a>00017 <span class="comment"> notice, this list of conditions and the following disclaimer.</span>
<a name="l00018"></a>00018 <span class="comment"> </span>
<a name="l00019"></a>00019 <span class="comment"> * Redistributions in binary form must reproduce the above copyright</span>
<a name="l00020"></a>00020 <span class="comment"> notice, this list of conditions and the following disclaimer in the</span>
<a name="l00021"></a>00021 <span class="comment"> documentation and/or other materials provided with the distribution.</span>
<a name="l00022"></a>00022 <span class="comment"> </span>
<a name="l00023"></a>00023 <span class="comment"> * Neither the name of the Zang Industries nor the names of its</span>
<a name="l00024"></a>00024 <span class="comment"> contributors may be used to endorse or promote products derived from</span>
<a name="l00025"></a>00025 <span class="comment"> this software without specific prior written permission.</span>
<a name="l00026"></a>00026 <span class="comment"> </span>
<a name="l00027"></a>00027 <span class="comment"> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span>
<a name="l00028"></a>00028 <span class="comment"> "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span>
<a name="l00029"></a>00029 <span class="comment"> LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span>
<a name="l00030"></a>00030 <span class="comment"> A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span>
<a name="l00031"></a>00031 <span class="comment"> OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span>
<a name="l00032"></a>00032 <span class="comment"> SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED</span>
<a name="l00033"></a>00033 <span class="comment"> TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</span>
<a name="l00034"></a>00034 <span class="comment"> PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF</span>
<a name="l00035"></a>00035 <span class="comment"> LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</span>
<a name="l00036"></a>00036 <span class="comment"> NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span>
<a name="l00037"></a>00037 <span class="comment"> SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
<a name="l00038"></a>00038 <span class="comment">*/</span>
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="comment">/*</span>
<a name="l00041"></a>00041 <span class="comment"> Copyright 2011 John Engelhart</span>
<a name="l00042"></a>00042 <span class="comment"> </span>
<a name="l00043"></a>00043 <span class="comment"> Licensed under the Apache License, Version 2.0 (the "License");</span>
<a name="l00044"></a>00044 <span class="comment"> you may not use this file except in compliance with the License.</span>
<a name="l00045"></a>00045 <span class="comment"> You may obtain a copy of the License at</span>
<a name="l00046"></a>00046 <span class="comment"> </span>
<a name="l00047"></a>00047 <span class="comment"> http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00048"></a>00048 <span class="comment"> </span>
<a name="l00049"></a>00049 <span class="comment"> Unless required by applicable law or agreed to in writing, software</span>
<a name="l00050"></a>00050 <span class="comment"> distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00051"></a>00051 <span class="comment"> WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00052"></a>00052 <span class="comment"> See the License for the specific language governing permissions and</span>
<a name="l00053"></a>00053 <span class="comment"> limitations under the License.</span>
<a name="l00054"></a>00054 <span class="comment">*/</span>
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="preprocessor">#include <stddef.h></span>
<a name="l00057"></a>00057 <span class="preprocessor">#include <stdint.h></span>
<a name="l00058"></a>00058 <span class="preprocessor">#include <limits.h></span>
<a name="l00059"></a>00059 <span class="preprocessor">#include <TargetConditionals.h></span>
<a name="l00060"></a>00060 <span class="preprocessor">#include <AvailabilityMacros.h></span>
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="preprocessor">#ifdef __OBJC__</span>
<a name="l00063"></a>00063 <span class="preprocessor"></span><span class="preprocessor">#import <Foundation/NSArray.h></span>
<a name="l00064"></a>00064 <span class="preprocessor">#import <Foundation/NSData.h></span>
<a name="l00065"></a>00065 <span class="preprocessor">#import <Foundation/NSDictionary.h></span>
<a name="l00066"></a>00066 <span class="preprocessor">#import <Foundation/NSError.h></span>
<a name="l00067"></a>00067 <span class="preprocessor">#import <Foundation/NSObjCRuntime.h></span>
<a name="l00068"></a>00068 <span class="preprocessor">#import <Foundation/NSString.h></span>
<a name="l00069"></a>00069 <span class="preprocessor">#endif // __OBJC__</span>
<a name="l00070"></a>00070 <span class="preprocessor"></span>
<a name="l00071"></a>00071 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00072"></a>00072 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00073"></a>00073 <span class="preprocessor">#endif</span>
<a name="l00074"></a>00074 <span class="preprocessor"></span>
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="comment">// For Mac OS X < 10.5.</span>
<a name="l00077"></a>00077 <span class="preprocessor">#ifndef NSINTEGER_DEFINED</span>
<a name="l00078"></a>00078 <span class="preprocessor"></span><span class="preprocessor">#define NSINTEGER_DEFINED</span>
<a name="l00079"></a>00079 <span class="preprocessor"></span><span class="preprocessor">#if defined(__LP64__) || defined(NS_BUILD_32_LIKE_64)</span>
<a name="l00080"></a>00080 <span class="preprocessor"></span><span class="keyword">typedef</span> <span class="keywordtype">long</span> NSInteger;
<a name="l00081"></a>00081 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> NSUInteger;
<a name="l00082"></a>00082 <span class="preprocessor">#define NSIntegerMin LONG_MIN</span>
<a name="l00083"></a>00083 <span class="preprocessor"></span><span class="preprocessor">#define NSIntegerMax LONG_MAX</span>
<a name="l00084"></a>00084 <span class="preprocessor"></span><span class="preprocessor">#define NSUIntegerMax ULONG_MAX</span>
<a name="l00085"></a>00085 <span class="preprocessor"></span><span class="preprocessor">#else // defined(__LP64__) || defined(NS_BUILD_32_LIKE_64)</span>
<a name="l00086"></a>00086 <span class="preprocessor"></span><span class="keyword">typedef</span> <span class="keywordtype">int</span> NSInteger;
<a name="l00087"></a>00087 <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> NSUInteger;
<a name="l00088"></a>00088 <span class="preprocessor">#define NSIntegerMin INT_MIN</span>
<a name="l00089"></a>00089 <span class="preprocessor"></span><span class="preprocessor">#define NSIntegerMax INT_MAX</span>
<a name="l00090"></a>00090 <span class="preprocessor"></span><span class="preprocessor">#define NSUIntegerMax UINT_MAX</span>
<a name="l00091"></a>00091 <span class="preprocessor"></span><span class="preprocessor">#endif // defined(__LP64__) || defined(NS_BUILD_32_LIKE_64)</span>
<a name="l00092"></a>00092 <span class="preprocessor"></span><span class="preprocessor">#endif // NSINTEGER_DEFINED</span>
<a name="l00093"></a>00093 <span class="preprocessor"></span>
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="preprocessor">#ifndef _JSONKIT_H_</span>
<a name="l00096"></a>00096 <span class="preprocessor"></span><span class="preprocessor">#define _JSONKIT_H_</span>
<a name="l00097"></a>00097 <span class="preprocessor"></span>
<a name="l00098"></a>00098 <span class="preprocessor">#if defined(__GNUC__) && (__GNUC__ >= 4) && defined(__APPLE_CC__) && (__APPLE_CC__ >= 5465)</span>
<a name="l00099"></a>00099 <span class="preprocessor"></span><span class="preprocessor">#define JK_DEPRECATED_ATTRIBUTE __attribute__((deprecated))</span>
<a name="l00100"></a>00100 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00101"></a>00101 <span class="preprocessor"></span><span class="preprocessor">#define JK_DEPRECATED_ATTRIBUTE</span>
<a name="l00102"></a>00102 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00103"></a>00103 <span class="preprocessor"></span>
<a name="l00104"></a>00104 <span class="preprocessor">#define JSONKIT_VERSION_MAJOR 1</span>
<a name="l00105"></a>00105 <span class="preprocessor"></span><span class="preprocessor">#define JSONKIT_VERSION_MINOR 4</span>
<a name="l00106"></a>00106 <span class="preprocessor"></span>
<a name="l00107"></a>00107 <span class="keyword">typedef</span> NSUInteger JKFlags;
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="comment">/*</span>
<a name="l00110"></a>00110 <span class="comment"> JKParseOptionComments : Allow C style // and /_* ... *_/ (without a _, obviously) comments in JSON.</span>
<a name="l00111"></a>00111 <span class="comment"> JKParseOptionUnicodeNewlines : Allow Unicode recommended (?:\r\n|[\n\v\f\r\x85\p{Zl}\p{Zp}]) newlines.</span>
<a name="l00112"></a>00112 <span class="comment"> JKParseOptionLooseUnicode : Normally the decoder will stop with an error at any malformed Unicode.</span>
<a name="l00113"></a>00113 <span class="comment"> This option allows JSON with malformed Unicode to be parsed without reporting an error.</span>
<a name="l00114"></a>00114 <span class="comment"> Any malformed Unicode is replaced with \uFFFD, or "REPLACEMENT CHARACTER".</span>
<a name="l00115"></a>00115 <span class="comment"> */</span>
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="keyword">enum</span> {
<a name="l00118"></a>00118 JKParseOptionNone = 0,
<a name="l00119"></a>00119 JKParseOptionStrict = 0,
<a name="l00120"></a>00120 JKParseOptionComments = (1 << 0),
<a name="l00121"></a>00121 JKParseOptionUnicodeNewlines = (1 << 1),
<a name="l00122"></a>00122 JKParseOptionLooseUnicode = (1 << 2),
<a name="l00123"></a>00123 JKParseOptionPermitTextAfterValidJSON = (1 << 3),
<a name="l00124"></a>00124 JKParseOptionValidFlags = (JKParseOptionComments | JKParseOptionUnicodeNewlines | JKParseOptionLooseUnicode | JKParseOptionPermitTextAfterValidJSON),
<a name="l00125"></a>00125 };
<a name="l00126"></a>00126 <span class="keyword">typedef</span> JKFlags JKParseOptionFlags;
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="keyword">enum</span> {
<a name="l00129"></a>00129 JKSerializeOptionNone = 0,
<a name="l00130"></a>00130 JKSerializeOptionPretty = (1 << 0),
<a name="l00131"></a>00131 JKSerializeOptionEscapeUnicode = (1 << 1),
<a name="l00132"></a>00132 JKSerializeOptionEscapeForwardSlashes = (1 << 4),
<a name="l00133"></a>00133 JKSerializeOptionValidFlags = (JKSerializeOptionPretty | JKSerializeOptionEscapeUnicode | JKSerializeOptionEscapeForwardSlashes),
<a name="l00134"></a>00134 };
<a name="l00135"></a>00135 <span class="keyword">typedef</span> JKFlags JKSerializeOptionFlags;
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="preprocessor">#ifdef __OBJC__</span>
<a name="l00138"></a>00138 <span class="preprocessor"></span>
<a name="l00139"></a>00139 <span class="keyword">typedef</span> <span class="keyword">struct </span>JKParseState JKParseState; <span class="comment">// Opaque internal, private type.</span>
<a name="l00140"></a>00140
<a name="l00141"></a>00141 <span class="comment">// As a general rule of thumb, if you use a method that doesn't accept a JKParseOptionFlags argument, it defaults to JKParseOptionStrict</span>
<a name="l00142"></a>00142
<a name="l00143"></a>00143 <span class="keyword">@interface </span>JSONDecoder : NSObject {
<a name="l00144"></a>00144 JKParseState *parseState;
<a name="l00145"></a>00145 }
<a name="l00146"></a>00146 + (id)decoder;
<a name="l00147"></a>00147 + (id)decoderWithParseOptions:(JKParseOptionFlags)parseOptionFlags;
<a name="l00148"></a>00148 - (id)initWithParseOptions:(JKParseOptionFlags)parseOptionFlags;
<a name="l00149"></a>00149 - (void)clearCache;
<a name="l00150"></a>00150
<a name="l00151"></a>00151 <span class="comment">// The parse... methods were deprecated in v1.4 in favor of the v1.4 objectWith... methods.</span>
<a name="l00152"></a>00152 - (id)parseUTF8String:(const <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *)string length:(<span class="keywordtype">size_t</span>)length JK_DEPRECATED_ATTRIBUTE; <span class="comment">// Deprecated in JSONKit v1.4. Use objectWithUTF8String:length: instead.</span>
<a name="l00153"></a>00153 - (id)parseUTF8String:(const <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *)string length:(<span class="keywordtype">size_t</span>)length error:(NSError **)error JK_DEPRECATED_ATTRIBUTE; <span class="comment">// Deprecated in JSONKit v1.4. Use objectWithUTF8String:length:error: instead.</span>
<a name="l00154"></a>00154 <span class="comment">// The NSData MUST be UTF8 encoded JSON.</span>
<a name="l00155"></a>00155 - (id)parseJSONData:(<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)jsonData JK_DEPRECATED_ATTRIBUTE; <span class="comment">// Deprecated in JSONKit v1.4. Use objectWithData: instead.</span>
<a name="l00156"></a>00156 - (id)parseJSONData:(<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)jsonData error:(NSError **)error JK_DEPRECATED_ATTRIBUTE; <span class="comment">// Deprecated in JSONKit v1.4. Use objectWithData:error: instead.</span>
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="comment">// Methods that return immutable collection objects.</span>
<a name="l00159"></a>00159 - (id)objectWithUTF8String:(const <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *)string length:(NSUInteger)length;
<a name="l00160"></a>00160 - (id)objectWithUTF8String:(const <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *)string length:(NSUInteger)length error:(NSError **)error;
<a name="l00161"></a>00161 <span class="comment">// The NSData MUST be UTF8 encoded JSON.</span>
<a name="l00162"></a>00162 - (id)objectWithData:(<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)jsonData;
<a name="l00163"></a>00163 - (id)objectWithData:(<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)jsonData error:(NSError **)error;
<a name="l00164"></a>00164
<a name="l00165"></a>00165 <span class="comment">// Methods that return mutable collection objects.</span>
<a name="l00166"></a>00166 - (id)mutableObjectWithUTF8String:(const <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *)string length:(NSUInteger)length;
<a name="l00167"></a>00167 - (id)mutableObjectWithUTF8String:(const <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *)string length:(NSUInteger)length error:(NSError **)error;
<a name="l00168"></a>00168 <span class="comment">// The NSData MUST be UTF8 encoded JSON.</span>
<a name="l00169"></a>00169 - (id)mutableObjectWithData:(<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)jsonData;
<a name="l00170"></a>00170 - (id)mutableObjectWithData:(<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)jsonData error:(NSError **)error;
<a name="l00171"></a>00171
<a name="l00172"></a>00172 <span class="keyword">@end</span>
<a name="l00173"></a>00173
<a name="l00175"></a>00175 <span class="preprocessor">#pragma mark Deserializing methods</span>
<a name="l00176"></a>00176 <span class="preprocessor"></span>
<a name="l00177"></a>00177
<a name="l00178"></a>00178 <span class="keyword">@interface </span><a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> (JSONKitDeserializing)
<a name="l00179"></a>00179 - (id)objectFromJSONString;
<a name="l00180"></a>00180 - (id)objectFromJSONStringWithParseOptions:(JKParseOptionFlags)parseOptionFlags;
<a name="l00181"></a>00181 - (id)objectFromJSONStringWithParseOptions:(JKParseOptionFlags)parseOptionFlags error:(NSError **)error;
<a name="l00182"></a>00182 - (id)mutableObjectFromJSONString;
<a name="l00183"></a>00183 - (id)mutableObjectFromJSONStringWithParseOptions:(JKParseOptionFlags)parseOptionFlags;
<a name="l00184"></a>00184 - (id)mutableObjectFromJSONStringWithParseOptions:(JKParseOptionFlags)parseOptionFlags error:(NSError **)error;
<a name="l00185"></a>00185 <span class="keyword">@end</span>
<a name="l00186"></a>00186
<a name="l00187"></a>00187 <span class="keyword">@interface </span><a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> (JSONKitDeserializing)
<a name="l00188"></a>00188 <span class="comment">// The NSData MUST be UTF8 encoded JSON.</span>
<a name="l00189"></a>00189 - (id)objectFromJSONData;
<a name="l00190"></a>00190 - (id)objectFromJSONDataWithParseOptions:(JKParseOptionFlags)parseOptionFlags;
<a name="l00191"></a>00191 - (id)objectFromJSONDataWithParseOptions:(JKParseOptionFlags)parseOptionFlags error:(NSError **)error;
<a name="l00192"></a>00192 - (id)mutableObjectFromJSONData;
<a name="l00193"></a>00193 - (id)mutableObjectFromJSONDataWithParseOptions:(JKParseOptionFlags)parseOptionFlags;
<a name="l00194"></a>00194 - (id)mutableObjectFromJSONDataWithParseOptions:(JKParseOptionFlags)parseOptionFlags error:(NSError **)error;
<a name="l00195"></a>00195 <span class="keyword">@end</span>
<a name="l00196"></a>00196
<a name="l00198"></a>00198 <span class="preprocessor">#pragma mark Serializing methods</span>
<a name="l00199"></a>00199 <span class="preprocessor"></span>
<a name="l00200"></a>00200
<a name="l00201"></a>00201 <span class="keyword">@interface </span><a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> (JSONKitSerializing)
<a name="l00202"></a>00202 <span class="comment">// Convenience methods for those that need to serialize the receiving NSString (i.e., instead of having to serialize a NSArray with a single NSString, you can "serialize to JSON" just the NSString).</span>
<a name="l00203"></a>00203 <span class="comment">// Normally, a string that is serialized to JSON has quotation marks surrounding it, which you may or may not want when serializing a single string, and can be controlled with includeQuotes:</span>
<a name="l00204"></a>00204 <span class="comment">// includeQuotes:YES `a "test"...` -> `"a \"test\"..."`</span>
<a name="l00205"></a>00205 <span class="comment">// includeQuotes:NO `a "test"...` -> `a \"test\"...`</span>
<a name="l00206"></a>00206 - (<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)JSONData; <span class="comment">// Invokes JSONDataWithOptions:JKSerializeOptionNone includeQuotes:YES</span>
<a name="l00207"></a>00207 - (<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)JSONDataWithOptions:(JKSerializeOptionFlags)serializeOptions includeQuotes:(BOOL)includeQuotes error:(NSError **)error;
<a name="l00208"></a>00208 - (<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)JSONString; <span class="comment">// Invokes JSONStringWithOptions:JKSerializeOptionNone includeQuotes:YES</span>
<a name="l00209"></a>00209 - (<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)JSONStringWithOptions:(JKSerializeOptionFlags)serializeOptions includeQuotes:(BOOL)includeQuotes error:(NSError **)error;
<a name="l00210"></a>00210 <span class="keyword">@end</span>
<a name="l00211"></a>00211
<a name="l00212"></a>00212 <span class="keyword">@interface </span>NSArray (JSONKitSerializing)
<a name="l00213"></a>00213 - (<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)JSONData;
<a name="l00214"></a>00214 - (<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)JSONDataWithOptions:(JKSerializeOptionFlags)serializeOptions error:(NSError **)error;
<a name="l00215"></a>00215 - (<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)JSONDataWithOptions:(JKSerializeOptionFlags)serializeOptions serializeUnsupportedClassesUsingDelegate:(<span class="keywordtype">id</span>)delegate selector:(<span class="keywordtype">SEL</span>)selector error:(NSError **)error;
<a name="l00216"></a>00216 - (<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)JSONString;
<a name="l00217"></a>00217 - (<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)JSONStringWithOptions:(JKSerializeOptionFlags)serializeOptions error:(NSError **)error;
<a name="l00218"></a>00218 - (<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)JSONStringWithOptions:(JKSerializeOptionFlags)serializeOptions serializeUnsupportedClassesUsingDelegate:(<span class="keywordtype">id</span>)delegate selector:(<span class="keywordtype">SEL</span>)selector error:(NSError **)error;
<a name="l00219"></a>00219 <span class="keyword">@end</span>
<a name="l00220"></a>00220
<a name="l00221"></a>00221 <span class="keyword">@interface </span>NSDictionary (JSONKitSerializing)
<a name="l00222"></a>00222 - (<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)JSONData;
<a name="l00223"></a>00223 - (<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)JSONDataWithOptions:(JKSerializeOptionFlags)serializeOptions error:(NSError **)error;
<a name="l00224"></a>00224 - (<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)JSONDataWithOptions:(JKSerializeOptionFlags)serializeOptions serializeUnsupportedClassesUsingDelegate:(<span class="keywordtype">id</span>)delegate selector:(<span class="keywordtype">SEL</span>)selector error:(NSError **)error;
<a name="l00225"></a>00225 - (<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)JSONString;
<a name="l00226"></a>00226 - (<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)JSONStringWithOptions:(JKSerializeOptionFlags)serializeOptions error:(NSError **)error;
<a name="l00227"></a>00227 - (<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)JSONStringWithOptions:(JKSerializeOptionFlags)serializeOptions serializeUnsupportedClassesUsingDelegate:(<span class="keywordtype">id</span>)delegate selector:(<span class="keywordtype">SEL</span>)selector error:(NSError **)error;
<a name="l00228"></a>00228 <span class="keyword">@end</span>
<a name="l00229"></a>00229
<a name="l00230"></a>00230 <span class="preprocessor">#ifdef __BLOCKS__</span>
<a name="l00231"></a>00231 <span class="preprocessor"></span>
<a name="l00232"></a>00232 <span class="keyword">@interface </span>NSArray (JSONKitSerializingBlockAdditions)
<a name="l00233"></a>00233 - (<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)JSONDataWithOptions:(JKSerializeOptionFlags)serializeOptions serializeUnsupportedClassesUsingBlock:(<span class="keywordtype">id</span>(^)(<span class="keywordtype">id</span> <span class="keywordtype">object</span>))block error:(NSError **)error;
<a name="l00234"></a>00234 - (<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)JSONStringWithOptions:(JKSerializeOptionFlags)serializeOptions serializeUnsupportedClassesUsingBlock:(<span class="keywordtype">id</span>(^)(<span class="keywordtype">id</span> <span class="keywordtype">object</span>))block error:(NSError **)error;
<a name="l00235"></a>00235 <span class="keyword">@end</span>
<a name="l00236"></a>00236
<a name="l00237"></a>00237 <span class="keyword">@interface </span>NSDictionary (JSONKitSerializingBlockAdditions)
<a name="l00238"></a>00238 - (<a class="code" href="class_n_s_data.html" title="For hashing raw data.">NSData</a> *)JSONDataWithOptions:(JKSerializeOptionFlags)serializeOptions serializeUnsupportedClassesUsingBlock:(<span class="keywordtype">id</span>(^)(<span class="keywordtype">id</span> <span class="keywordtype">object</span>))block error:(NSError **)error;
<a name="l00239"></a>00239 - (<a class="code" href="class_n_s_string.html" title="For manipulating NSStrings.">NSString</a> *)JSONStringWithOptions:(JKSerializeOptionFlags)serializeOptions serializeUnsupportedClassesUsingBlock:(<span class="keywordtype">id</span>(^)(<span class="keywordtype">id</span> <span class="keywordtype">object</span>))block error:(NSError **)error;
<a name="l00240"></a>00240 <span class="keyword">@end</span>
<a name="l00241"></a>00241
<a name="l00242"></a>00242 <span class="preprocessor">#endif</span>
<a name="l00243"></a>00243 <span class="preprocessor"></span>
<a name="l00244"></a>00244
<a name="l00245"></a>00245 <span class="preprocessor">#endif // __OBJC__</span>
<a name="l00246"></a>00246 <span class="preprocessor"></span>
<a name="l00247"></a>00247 <span class="preprocessor">#endif // _JSONKIT_H_</span>
<a name="l00248"></a>00248 <span class="preprocessor"></span>
<a name="l00249"></a>00249 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00250"></a>00250 <span class="preprocessor"></span>} <span class="comment">// extern "C"</span>
<a name="l00251"></a>00251 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>JSONKit.h</b> </li>
</div><!-- .fixedwidth -->
<span class="footer">Generated for Nimbus by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4-20110629 </span>
</ul>
</div>
</div> <!-- page -->
</body>
</html>