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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
|
<!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>YAJL: yajl_parse.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">YAJL <span id="projectnumber">1.0.12</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">yajl_parse.h File Reference</div> </div>
</div>
<div class="contents">
<div class="textblock"><code>#include <yajl/yajl_common.h></code><br/>
</div>
<p><a href="yajl__parse_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structyajl__callbacks.html">yajl_callbacks</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structyajl__parser__config.html">yajl_parser_config</a></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct yajl_handle_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__parse_8h.html#acb85b92f3d7cb6f0743b4e68d0172323">yajl_handle</a></td></tr>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__parse_8h.html#a1d2bc7f4962c55436daaba61ffaf1f7d">yajl_status</a> { <a class="el" href="yajl__parse_8h.html#a1d2bc7f4962c55436daaba61ffaf1f7da67a2a1b5d684de357adb0e1ea444ffd7">yajl_status_ok</a>,
<a class="el" href="yajl__parse_8h.html#a1d2bc7f4962c55436daaba61ffaf1f7da44d6b8f18ecb5e30be3eb5b2f1f5717e">yajl_status_client_canceled</a>,
<a class="el" href="yajl__parse_8h.html#a1d2bc7f4962c55436daaba61ffaf1f7da88c7cd7b308d09c32dad74b47b9ae3f4">yajl_status_insufficient_data</a>,
<a class="el" href="yajl__parse_8h.html#a1d2bc7f4962c55436daaba61ffaf1f7daeea581fa9c967d34ad5f062ef59718fd">yajl_status_error</a>
}</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">YAJL_API const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__parse_8h.html#ae00bd26f1b98a1ed5c86a4480e7782aa">yajl_status_to_string</a> (<a class="el" href="yajl__parse_8h.html#a1d2bc7f4962c55436daaba61ffaf1f7d">yajl_status</a> code)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">YAJL_API <a class="el" href="yajl__parse_8h.html#acb85b92f3d7cb6f0743b4e68d0172323">yajl_handle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__parse_8h.html#ac5b76bd2683e48ea5cb97376a62bba46">yajl_alloc</a> (const <a class="el" href="structyajl__callbacks.html">yajl_callbacks</a> *callbacks, const <a class="el" href="structyajl__parser__config.html">yajl_parser_config</a> *config, const <a class="el" href="structyajl__alloc__funcs.html">yajl_alloc_funcs</a> *allocFuncs, void *ctx)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">YAJL_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__parse_8h.html#a9fc930b29358ec1e04bda35d8b73422e">yajl_free</a> (<a class="el" href="yajl__parse_8h.html#acb85b92f3d7cb6f0743b4e68d0172323">yajl_handle</a> handle)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">YAJL_API <a class="el" href="yajl__parse_8h.html#a1d2bc7f4962c55436daaba61ffaf1f7d">yajl_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__parse_8h.html#a6c05371a1532ade860db8b1ef8d31a61">yajl_parse</a> (<a class="el" href="yajl__parse_8h.html#acb85b92f3d7cb6f0743b4e68d0172323">yajl_handle</a> hand, const unsigned char *jsonText, unsigned int jsonTextLength)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">YAJL_API <a class="el" href="yajl__parse_8h.html#a1d2bc7f4962c55436daaba61ffaf1f7d">yajl_status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__parse_8h.html#acb0e5421a4bc2e9b9626f0514f11547f">yajl_parse_complete</a> (<a class="el" href="yajl__parse_8h.html#acb85b92f3d7cb6f0743b4e68d0172323">yajl_handle</a> hand)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">YAJL_API unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__parse_8h.html#aa4f26259fea6bb058b17828598532198">yajl_get_error</a> (<a class="el" href="yajl__parse_8h.html#acb85b92f3d7cb6f0743b4e68d0172323">yajl_handle</a> hand, int verbose, const unsigned char *jsonText, unsigned int jsonTextLength)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">YAJL_API unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__parse_8h.html#a341ea0f4cf8a70dc04c72a6256568b69">yajl_get_bytes_consumed</a> (<a class="el" href="yajl__parse_8h.html#acb85b92f3d7cb6f0743b4e68d0172323">yajl_handle</a> hand)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">YAJL_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__parse_8h.html#a12b6514e18f78fab0825b71465d511ea">yajl_free_error</a> (<a class="el" href="yajl__parse_8h.html#acb85b92f3d7cb6f0743b4e68d0172323">yajl_handle</a> hand, unsigned char *str)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Interface to YAJL's JSON parsing facilities. </p>
</div><hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="acb85b92f3d7cb6f0743b4e68d0172323"></a><!-- doxytag: member="yajl_parse.h::yajl_handle" ref="acb85b92f3d7cb6f0743b4e68d0172323" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct yajl_handle_t* <a class="el" href="yajl__parse_8h.html#acb85b92f3d7cb6f0743b4e68d0172323">yajl_handle</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>an opaque handle to a parser </p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="a1d2bc7f4962c55436daaba61ffaf1f7d"></a><!-- doxytag: member="yajl_parse.h::yajl_status" ref="a1d2bc7f4962c55436daaba61ffaf1f7d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="yajl__parse_8h.html#a1d2bc7f4962c55436daaba61ffaf1f7d">yajl_status</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>error codes returned from this interface </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a1d2bc7f4962c55436daaba61ffaf1f7da67a2a1b5d684de357adb0e1ea444ffd7"></a><!-- doxytag: member="yajl_status_ok" ref="a1d2bc7f4962c55436daaba61ffaf1f7da67a2a1b5d684de357adb0e1ea444ffd7" args="" -->yajl_status_ok</em> </td><td>
<p>no error was encountered </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a1d2bc7f4962c55436daaba61ffaf1f7da44d6b8f18ecb5e30be3eb5b2f1f5717e"></a><!-- doxytag: member="yajl_status_client_canceled" ref="a1d2bc7f4962c55436daaba61ffaf1f7da44d6b8f18ecb5e30be3eb5b2f1f5717e" args="" -->yajl_status_client_canceled</em> </td><td>
<p>a client callback returned zero, stopping the parse </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a1d2bc7f4962c55436daaba61ffaf1f7da88c7cd7b308d09c32dad74b47b9ae3f4"></a><!-- doxytag: member="yajl_status_insufficient_data" ref="a1d2bc7f4962c55436daaba61ffaf1f7da88c7cd7b308d09c32dad74b47b9ae3f4" args="" -->yajl_status_insufficient_data</em> </td><td>
<p>The parse cannot yet complete because more json input text is required, call yajl_parse with the next buffer of input text. (pertinent only when stream parsing) </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a1d2bc7f4962c55436daaba61ffaf1f7daeea581fa9c967d34ad5f062ef59718fd"></a><!-- doxytag: member="yajl_status_error" ref="a1d2bc7f4962c55436daaba61ffaf1f7daeea581fa9c967d34ad5f062ef59718fd" args="" -->yajl_status_error</em> </td><td>
<p>An error occured during the parse. Call yajl_get_error for more information about the encountered error </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ac5b76bd2683e48ea5cb97376a62bba46"></a><!-- doxytag: member="yajl_parse.h::yajl_alloc" ref="ac5b76bd2683e48ea5cb97376a62bba46" args="(const yajl_callbacks *callbacks, const yajl_parser_config *config, const yajl_alloc_funcs *allocFuncs, void *ctx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">YAJL_API <a class="el" href="yajl__parse_8h.html#acb85b92f3d7cb6f0743b4e68d0172323">yajl_handle</a> yajl_alloc </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structyajl__callbacks.html">yajl_callbacks</a> * </td>
<td class="paramname"><em>callbacks</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structyajl__parser__config.html">yajl_parser_config</a> * </td>
<td class="paramname"><em>config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structyajl__alloc__funcs.html">yajl_alloc_funcs</a> * </td>
<td class="paramname"><em>allocFuncs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>ctx</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>allocate a parser handle </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">callbacks</td><td>a yajl callbacks structure specifying the functions to call when different JSON entities are encountered in the input text. May be NULL, which is only useful for validation. </td></tr>
<tr><td class="paramname">config</td><td>configuration parameters for the parse. </td></tr>
<tr><td class="paramname">ctx</td><td>a context pointer that will be passed to callbacks. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9fc930b29358ec1e04bda35d8b73422e"></a><!-- doxytag: member="yajl_parse.h::yajl_free" ref="a9fc930b29358ec1e04bda35d8b73422e" args="(yajl_handle handle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">YAJL_API void yajl_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="yajl__parse_8h.html#acb85b92f3d7cb6f0743b4e68d0172323">yajl_handle</a> </td>
<td class="paramname"><em>handle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>free a parser handle </p>
</div>
</div>
<a class="anchor" id="a12b6514e18f78fab0825b71465d511ea"></a><!-- doxytag: member="yajl_parse.h::yajl_free_error" ref="a12b6514e18f78fab0825b71465d511ea" args="(yajl_handle hand, unsigned char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">YAJL_API void yajl_free_error </td>
<td>(</td>
<td class="paramtype"><a class="el" href="yajl__parse_8h.html#acb85b92f3d7cb6f0743b4e68d0172323">yajl_handle</a> </td>
<td class="paramname"><em>hand</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned char * </td>
<td class="paramname"><em>str</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>free an error returned from yajl_get_error </p>
</div>
</div>
<a class="anchor" id="a341ea0f4cf8a70dc04c72a6256568b69"></a><!-- doxytag: member="yajl_parse.h::yajl_get_bytes_consumed" ref="a341ea0f4cf8a70dc04c72a6256568b69" args="(yajl_handle hand)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">YAJL_API unsigned int yajl_get_bytes_consumed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="yajl__parse_8h.html#acb85b92f3d7cb6f0743b4e68d0172323">yajl_handle</a> </td>
<td class="paramname"><em>hand</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get the amount of data consumed from the last chunk passed to YAJL.</p>
<p>In the case of a successful parse this can help you understand if the entire buffer was consumed (which will allow you to handle "junk at end of input".</p>
<p>In the event an error is encountered during parsing, this function affords the client a way to get the offset into the most recent chunk where the error occured. 0 will be returned if no error was encountered. </p>
</div>
</div>
<a class="anchor" id="aa4f26259fea6bb058b17828598532198"></a><!-- doxytag: member="yajl_parse.h::yajl_get_error" ref="aa4f26259fea6bb058b17828598532198" args="(yajl_handle hand, int verbose, const unsigned char *jsonText, unsigned int jsonTextLength)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">YAJL_API unsigned char* yajl_get_error </td>
<td>(</td>
<td class="paramtype"><a class="el" href="yajl__parse_8h.html#acb85b92f3d7cb6f0743b4e68d0172323">yajl_handle</a> </td>
<td class="paramname"><em>hand</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>verbose</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>jsonText</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>jsonTextLength</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>get an error string describing the state of the parse.</p>
<p>If verbose is non-zero, the message will include the JSON text where the error occured, along with an arrow pointing to the specific char.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A dynamically allocated string will be returned which should be freed with yajl_free_error </dd></dl>
</div>
</div>
<a class="anchor" id="a6c05371a1532ade860db8b1ef8d31a61"></a><!-- doxytag: member="yajl_parse.h::yajl_parse" ref="a6c05371a1532ade860db8b1ef8d31a61" args="(yajl_handle hand, const unsigned char *jsonText, unsigned int jsonTextLength)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">YAJL_API <a class="el" href="yajl__parse_8h.html#a1d2bc7f4962c55436daaba61ffaf1f7d">yajl_status</a> yajl_parse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="yajl__parse_8h.html#acb85b92f3d7cb6f0743b4e68d0172323">yajl_handle</a> </td>
<td class="paramname"><em>hand</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>jsonText</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>jsonTextLength</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse some json! </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">hand</td><td>- a handle to the json parser allocated with yajl_alloc </td></tr>
<tr><td class="paramname">jsonText</td><td>- a pointer to the UTF8 json text to be parsed </td></tr>
<tr><td class="paramname">jsonTextLength</td><td>- the length, in bytes, of input text </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acb0e5421a4bc2e9b9626f0514f11547f"></a><!-- doxytag: member="yajl_parse.h::yajl_parse_complete" ref="acb0e5421a4bc2e9b9626f0514f11547f" args="(yajl_handle hand)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">YAJL_API <a class="el" href="yajl__parse_8h.html#a1d2bc7f4962c55436daaba61ffaf1f7d">yajl_status</a> yajl_parse_complete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="yajl__parse_8h.html#acb85b92f3d7cb6f0743b4e68d0172323">yajl_handle</a> </td>
<td class="paramname"><em>hand</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse any remaining buffered json. Since yajl is a stream-based parser, without an explicit end of input, yajl sometimes can't decide if content at the end of the stream is valid or not. For example, if "1" has been fed in, yajl can't know whether another digit is next or some character that would terminate the integer token.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">hand</td><td>- a handle to the json parser allocated with yajl_alloc </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae00bd26f1b98a1ed5c86a4480e7782aa"></a><!-- doxytag: member="yajl_parse.h::yajl_status_to_string" ref="ae00bd26f1b98a1ed5c86a4480e7782aa" args="(yajl_status code)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">YAJL_API const char* yajl_status_to_string </td>
<td>(</td>
<td class="paramtype"><a class="el" href="yajl__parse_8h.html#a1d2bc7f4962c55436daaba61ffaf1f7d">yajl_status</a> </td>
<td class="paramname"><em>code</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>attain a human readable, english, string for an error </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Apr 25 2011 13:06:32 for YAJL by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
