forked from lloyd/yajl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathyajl__tree_8h.html
633 lines (603 loc) · 34.7 KB
/
yajl__tree_8h.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
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
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
<!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_tree.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">2.0.0</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>
<li><a href="examples.html"><span>Examples</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="#define-members">Defines</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_tree.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__tree_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__val__s.html">yajl_val_s</a></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#a6b608d94afd51babb28475955c1654c2">YAJL_NUMBER_INT_VALID</a>   0x01</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#a7d4c94d04c85385a9650bde767a8311f">YAJL_NUMBER_DOUBLE_VALID</a>   0x02</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#a839db27ecbbb8d61a699cedbd932132e">YAJL_IS_STRING</a>(v)   (((v) != NULL) && ((v)->type == yajl_t_string))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#ad1736311b9fac2b19c7726a9dbeb1b39">YAJL_IS_NUMBER</a>(v)   (((v) != NULL) && ((v)->type == yajl_t_number))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#a38d048c002ffeeb26afb1a85d4e66ab8">YAJL_IS_INTEGER</a>(v)   (YAJL_IS_NUMBER(v) && ((v)->u.flags & YAJL_NUMBER_INT_VALID))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#a2f5b941466aa6fd3b0b1dff5dbb242c2">YAJL_IS_DOUBLE</a>(v)   (YAJL_IS_NUMBER(v) && ((v)->u.flags & YAJL_NUMBER_DOUBLE_VALID))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#addf75553e77877995e78e93644921833">YAJL_IS_OBJECT</a>(v)   (((v) != NULL) && ((v)->type == yajl_t_object))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#addecd3327906b07a57fb12a67e5dc635">YAJL_IS_ARRAY</a>(v)   (((v) != NULL) && ((v)->type == yajl_t_array ))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#ae330b2efd9dbe5746b0d5e6f20cda930">YAJL_IS_TRUE</a>(v)   (((v) != NULL) && ((v)->type == yajl_t_true ))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#a51bc6ecfe5df8a24e7a5c47cec94981b">YAJL_IS_FALSE</a>(v)   (((v) != NULL) && ((v)->type == yajl_t_false ))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#aa7d4861ba8a7b71943d948368e02c3da">YAJL_IS_NULL</a>(v)   (((v) != NULL) && ((v)->type == yajl_t_null ))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#a2fe1773db524ee1efdad7eb97ce12c18">YAJL_GET_STRING</a>(v)   (YAJL_IS_STRING(v) ? (v)->u.string : NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#acfdffbd514aefd7a2921dbd18b0d8c2c">YAJL_GET_NUMBER</a>(v)   ((v)->u.number.r)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#aa3c2643d3f2b63376dce65fa25e96a93">YAJL_GET_DOUBLE</a>(v)   ((v)->u.number.d)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#a69e47497b26e291bbe11d43d53b8b016">YAJL_GET_INTEGER</a>(v)   ((v)->u.number.i)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#a8f25bc66f657ade894dd6aa0839726f1">YAJL_GET_OBJECT</a>(v)   (YAJL_IS_OBJECT(v) ? &(v)->u.object : NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#a4224514d7e9a5cd43acbe94de5ce9000">YAJL_GET_ARRAY</a>(v)   (YAJL_IS_ARRAY(v) ? &(v)->u.array : NULL)</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 <a class="el" href="structyajl__val__s.html">yajl_val_s</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#af4f7cb7f0a0f42f6f3d2d2563a4c171c">yajl_val</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__tree_8h.html#ae95a1d5a195e8bd22a96f69cbf4e7c91">yajl_type</a> { <br/>
  <a class="el" href="yajl__tree_8h.html#ae95a1d5a195e8bd22a96f69cbf4e7c91a8e1c9361f16919197409a226dcad7c65">yajl_t_string</a> = 1,
<a class="el" href="yajl__tree_8h.html#ae95a1d5a195e8bd22a96f69cbf4e7c91abde225a86bb95920a5e1126990634571">yajl_t_number</a> = 2,
<a class="el" href="yajl__tree_8h.html#ae95a1d5a195e8bd22a96f69cbf4e7c91a033cfb2d466cd549f7cc51a9ba5992f2">yajl_t_object</a> = 3,
<a class="el" href="yajl__tree_8h.html#ae95a1d5a195e8bd22a96f69cbf4e7c91ab04a6b795fc500d54a3e507571de200e">yajl_t_array</a> = 4,
<br/>
  <a class="el" href="yajl__tree_8h.html#ae95a1d5a195e8bd22a96f69cbf4e7c91a898367bbd0042414c0ba1a266e3a0423">yajl_t_true</a> = 5,
<a class="el" href="yajl__tree_8h.html#ae95a1d5a195e8bd22a96f69cbf4e7c91a7a517c35ce7754fb57b3e000676b10f9">yajl_t_false</a> = 6,
<a class="el" href="yajl__tree_8h.html#ae95a1d5a195e8bd22a96f69cbf4e7c91ab1bde75d9a3a9f386fdd37262d8d9b25">yajl_t_null</a> = 7,
<a class="el" href="yajl__tree_8h.html#ae95a1d5a195e8bd22a96f69cbf4e7c91a9f219b51253c2cb0e278cc4ad55b211e">yajl_t_any</a> = 8
<br/>
}</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 <a class="el" href="structyajl__val__s.html">yajl_val</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#a6a04342e825859a3e9d52df93e9d112a">yajl_tree_parse</a> (const char *input, char *error_buffer, size_t error_buffer_size)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">YAJL_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#a83b59f411e80404aad35ae7071c4ecf8">yajl_tree_free</a> (<a class="el" href="structyajl__val__s.html">yajl_val</a> v)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">YAJL_API <a class="el" href="structyajl__val__s.html">yajl_val</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="yajl__tree_8h.html#a534c427581fac81ee828c28367dbe90d">yajl_tree_get</a> (<a class="el" href="structyajl__val__s.html">yajl_val</a> parent, const char **path, <a class="el" href="yajl__tree_8h.html#ae95a1d5a195e8bd22a96f69cbf4e7c91">yajl_type</a> type)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Parses JSON data and returns the data in tree form.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Florian Forster </dd></dl>
<dl class="date"><dt><b>Date:</b></dt><dd>August 2010</dd></dl>
<p>This interface makes quick parsing and extraction of smallish JSON docs trivial:</p>
<div class="fragment"><pre class="fragment"><span class="comment">/*</span>
<span class="comment"> * Copyright (c) 2011, Lloyd Hilaiel <[email protected]></span>
<span class="comment"> *</span>
<span class="comment"> * Permission to use, copy, modify, and/or distribute this software for any</span>
<span class="comment"> * purpose with or without fee is hereby granted, provided that the above</span>
<span class="comment"> * copyright notice and this permission notice appear in all copies.</span>
<span class="comment"> *</span>
<span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span>
<span class="comment"> * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span>
<span class="comment"> * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span>
<span class="comment"> * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span>
<span class="comment"> * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span>
<span class="comment"> * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span>
<span class="comment"> * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span>
<span class="comment"> */</span>
<span class="preprocessor">#include <stdio.h></span>
<span class="preprocessor">#include <string.h></span>
<span class="preprocessor">#include "yajl/yajl_tree.h"</span>
<span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> fileData[65536];
<span class="keywordtype">int</span>
main(<span class="keywordtype">void</span>)
{
<span class="keywordtype">size_t</span> rd;
yajl_val node;
<span class="keywordtype">char</span> errbuf[1024];
<span class="comment">/* null plug buffers */</span>
fileData[0] = errbuf[0] = 0;
<span class="comment">/* read the entire config file */</span>
rd = fread((<span class="keywordtype">void</span> *) fileData, 1, <span class="keyword">sizeof</span>(fileData) - 1, stdin);
<span class="comment">/* file read error handling */</span>
<span class="keywordflow">if</span> (rd == 0 && !feof(stdin)) {
fprintf(stderr, <span class="stringliteral">"error encountered on file read\n"</span>);
<span class="keywordflow">return</span> 1;
} <span class="keywordflow">else</span> <span class="keywordflow">if</span> (rd >= <span class="keyword">sizeof</span>(fileData) - 1) {
fprintf(stderr, <span class="stringliteral">"config file too big\n"</span>);
<span class="keywordflow">return</span> 1;
}
<span class="comment">/* we have the whole config file in memory. let's parse it ... */</span>
node = <a class="code" href="yajl__tree_8h.html#a6a04342e825859a3e9d52df93e9d112a">yajl_tree_parse</a>((<span class="keyword">const</span> <span class="keywordtype">char</span> *) fileData, errbuf, <span class="keyword">sizeof</span>(errbuf));
<span class="comment">/* parse error handling */</span>
<span class="keywordflow">if</span> (node == NULL) {
fprintf(stderr, <span class="stringliteral">"parse_error: "</span>);
<span class="keywordflow">if</span> (strlen(errbuf)) fprintf(stderr, <span class="stringliteral">" %s"</span>, errbuf);
<span class="keywordflow">else</span> fprintf(stderr, <span class="stringliteral">"unknown error"</span>);
fprintf(stderr, <span class="stringliteral">"\n"</span>);
<span class="keywordflow">return</span> 1;
}
<span class="comment">/* ... and extract a nested value from the config file */</span>
{
<span class="keyword">const</span> <span class="keywordtype">char</span> * path[] = { <span class="stringliteral">"Logging"</span>, <span class="stringliteral">"timeFormat"</span>, (<span class="keyword">const</span> <span class="keywordtype">char</span> *) 0 };
yajl_val v = <a class="code" href="yajl__tree_8h.html#a534c427581fac81ee828c28367dbe90d">yajl_tree_get</a>(node, path, <a class="code" href="yajl__tree_8h.html#ae95a1d5a195e8bd22a96f69cbf4e7c91a8e1c9361f16919197409a226dcad7c65">yajl_t_string</a>);
<span class="keywordflow">if</span> (v) printf(<span class="stringliteral">"%s/%s: %s\n"</span>, path[0], path[1], <a class="code" href="yajl__tree_8h.html#a2fe1773db524ee1efdad7eb97ce12c18">YAJL_GET_STRING</a>(v));
<span class="keywordflow">else</span> printf(<span class="stringliteral">"no such node: %s/%s\n"</span>, path[0], path[1]);
}
<a class="code" href="yajl__tree_8h.html#a83b59f411e80404aad35ae7071c4ecf8">yajl_tree_free</a>(node);
<span class="keywordflow">return</span> 0;
}
</pre></div> </div><hr/><h2>Define Documentation</h2>
<a class="anchor" id="a4224514d7e9a5cd43acbe94de5ce9000"></a><!-- doxytag: member="yajl_tree.h::YAJL_GET_ARRAY" ref="a4224514d7e9a5cd43acbe94de5ce9000" args="(v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define YAJL_GET_ARRAY</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v</td><td>)</td>
<td>   (YAJL_IS_ARRAY(v) ? &(v)->u.array : NULL)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a pointer to a yajl_val_array or NULL if the value is not an object. </p>
</div>
</div>
<a class="anchor" id="aa3c2643d3f2b63376dce65fa25e96a93"></a><!-- doxytag: member="yajl_tree.h::YAJL_GET_DOUBLE" ref="aa3c2643d3f2b63376dce65fa25e96a93" args="(v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define YAJL_GET_DOUBLE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v</td><td>)</td>
<td>   ((v)->u.number.d)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the double representation of a number. You should check type first, perhaps using YAJL_IS_DOUBLE </p>
</div>
</div>
<a class="anchor" id="a69e47497b26e291bbe11d43d53b8b016"></a><!-- doxytag: member="yajl_tree.h::YAJL_GET_INTEGER" ref="a69e47497b26e291bbe11d43d53b8b016" args="(v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define YAJL_GET_INTEGER</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v</td><td>)</td>
<td>   ((v)->u.number.i)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the 64bit (long long) integer representation of a number. You should check type first, perhaps using YAJL_IS_INTEGER </p>
</div>
</div>
<a class="anchor" id="acfdffbd514aefd7a2921dbd18b0d8c2c"></a><!-- doxytag: member="yajl_tree.h::YAJL_GET_NUMBER" ref="acfdffbd514aefd7a2921dbd18b0d8c2c" args="(v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define YAJL_GET_NUMBER</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v</td><td>)</td>
<td>   ((v)->u.number.r)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the string representation of a number. You should check type first, perhaps using YAJL_IS_NUMBER </p>
</div>
</div>
<a class="anchor" id="a8f25bc66f657ade894dd6aa0839726f1"></a><!-- doxytag: member="yajl_tree.h::YAJL_GET_OBJECT" ref="a8f25bc66f657ade894dd6aa0839726f1" args="(v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define YAJL_GET_OBJECT</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v</td><td>)</td>
<td>   (YAJL_IS_OBJECT(v) ? &(v)->u.object : NULL)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a pointer to a yajl_val_object or NULL if the value is not an object. </p>
</div>
</div>
<a class="anchor" id="a2fe1773db524ee1efdad7eb97ce12c18"></a><!-- doxytag: member="yajl_tree.h::YAJL_GET_STRING" ref="a2fe1773db524ee1efdad7eb97ce12c18" args="(v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define YAJL_GET_STRING</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v</td><td>)</td>
<td>   (YAJL_IS_STRING(v) ? (v)->u.string : NULL)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Given a yajl_val_string return a ptr to the bare string it contains, or NULL if the value is not a string. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example_2parse_config_8c-example.html#a4">example/parse_config.c</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="addecd3327906b07a57fb12a67e5dc635"></a><!-- doxytag: member="yajl_tree.h::YAJL_IS_ARRAY" ref="addecd3327906b07a57fb12a67e5dc635" args="(v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define YAJL_IS_ARRAY</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v</td><td>)</td>
<td>   (((v) != NULL) && ((v)->type == yajl_t_array ))</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a2f5b941466aa6fd3b0b1dff5dbb242c2"></a><!-- doxytag: member="yajl_tree.h::YAJL_IS_DOUBLE" ref="a2f5b941466aa6fd3b0b1dff5dbb242c2" args="(v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define YAJL_IS_DOUBLE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v</td><td>)</td>
<td>   (YAJL_IS_NUMBER(v) && ((v)->u.flags & YAJL_NUMBER_DOUBLE_VALID))</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a51bc6ecfe5df8a24e7a5c47cec94981b"></a><!-- doxytag: member="yajl_tree.h::YAJL_IS_FALSE" ref="a51bc6ecfe5df8a24e7a5c47cec94981b" args="(v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define YAJL_IS_FALSE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v</td><td>)</td>
<td>   (((v) != NULL) && ((v)->type == yajl_t_false ))</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a38d048c002ffeeb26afb1a85d4e66ab8"></a><!-- doxytag: member="yajl_tree.h::YAJL_IS_INTEGER" ref="a38d048c002ffeeb26afb1a85d4e66ab8" args="(v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define YAJL_IS_INTEGER</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v</td><td>)</td>
<td>   (YAJL_IS_NUMBER(v) && ((v)->u.flags & YAJL_NUMBER_INT_VALID))</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa7d4861ba8a7b71943d948368e02c3da"></a><!-- doxytag: member="yajl_tree.h::YAJL_IS_NULL" ref="aa7d4861ba8a7b71943d948368e02c3da" args="(v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define YAJL_IS_NULL</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v</td><td>)</td>
<td>   (((v) != NULL) && ((v)->type == yajl_t_null ))</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad1736311b9fac2b19c7726a9dbeb1b39"></a><!-- doxytag: member="yajl_tree.h::YAJL_IS_NUMBER" ref="ad1736311b9fac2b19c7726a9dbeb1b39" args="(v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define YAJL_IS_NUMBER</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v</td><td>)</td>
<td>   (((v) != NULL) && ((v)->type == yajl_t_number))</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="addf75553e77877995e78e93644921833"></a><!-- doxytag: member="yajl_tree.h::YAJL_IS_OBJECT" ref="addf75553e77877995e78e93644921833" args="(v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define YAJL_IS_OBJECT</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v</td><td>)</td>
<td>   (((v) != NULL) && ((v)->type == yajl_t_object))</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a839db27ecbbb8d61a699cedbd932132e"></a><!-- doxytag: member="yajl_tree.h::YAJL_IS_STRING" ref="a839db27ecbbb8d61a699cedbd932132e" args="(v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define YAJL_IS_STRING</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v</td><td>)</td>
<td>   (((v) != NULL) && ((v)->type == yajl_t_string))</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae330b2efd9dbe5746b0d5e6f20cda930"></a><!-- doxytag: member="yajl_tree.h::YAJL_IS_TRUE" ref="ae330b2efd9dbe5746b0d5e6f20cda930" args="(v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define YAJL_IS_TRUE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">v</td><td>)</td>
<td>   (((v) != NULL) && ((v)->type == yajl_t_true ))</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a7d4c94d04c85385a9650bde767a8311f"></a><!-- doxytag: member="yajl_tree.h::YAJL_NUMBER_DOUBLE_VALID" ref="a7d4c94d04c85385a9650bde767a8311f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define YAJL_NUMBER_DOUBLE_VALID   0x02</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a6b608d94afd51babb28475955c1654c2"></a><!-- doxytag: member="yajl_tree.h::YAJL_NUMBER_INT_VALID" ref="a6b608d94afd51babb28475955c1654c2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define YAJL_NUMBER_INT_VALID   0x01</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="af4f7cb7f0a0f42f6f3d2d2563a4c171c"></a><!-- doxytag: member="yajl_tree.h::yajl_val" ref="af4f7cb7f0a0f42f6f3d2d2563a4c171c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structyajl__val__s.html">yajl_val_s</a>* <a class="el" href="structyajl__val__s.html">yajl_val</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A pointer to a node in the parse tree </p>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="ae95a1d5a195e8bd22a96f69cbf4e7c91"></a><!-- doxytag: member="yajl_tree.h::yajl_type" ref="ae95a1d5a195e8bd22a96f69cbf4e7c91" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="yajl__tree_8h.html#ae95a1d5a195e8bd22a96f69cbf4e7c91">yajl_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>possible data types that a <a class="el" href="structyajl__val__s.html">yajl_val_s</a> can hold </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ae95a1d5a195e8bd22a96f69cbf4e7c91a8e1c9361f16919197409a226dcad7c65"></a><!-- doxytag: member="yajl_t_string" ref="ae95a1d5a195e8bd22a96f69cbf4e7c91a8e1c9361f16919197409a226dcad7c65" args="" -->yajl_t_string</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae95a1d5a195e8bd22a96f69cbf4e7c91abde225a86bb95920a5e1126990634571"></a><!-- doxytag: member="yajl_t_number" ref="ae95a1d5a195e8bd22a96f69cbf4e7c91abde225a86bb95920a5e1126990634571" args="" -->yajl_t_number</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae95a1d5a195e8bd22a96f69cbf4e7c91a033cfb2d466cd549f7cc51a9ba5992f2"></a><!-- doxytag: member="yajl_t_object" ref="ae95a1d5a195e8bd22a96f69cbf4e7c91a033cfb2d466cd549f7cc51a9ba5992f2" args="" -->yajl_t_object</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae95a1d5a195e8bd22a96f69cbf4e7c91ab04a6b795fc500d54a3e507571de200e"></a><!-- doxytag: member="yajl_t_array" ref="ae95a1d5a195e8bd22a96f69cbf4e7c91ab04a6b795fc500d54a3e507571de200e" args="" -->yajl_t_array</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae95a1d5a195e8bd22a96f69cbf4e7c91a898367bbd0042414c0ba1a266e3a0423"></a><!-- doxytag: member="yajl_t_true" ref="ae95a1d5a195e8bd22a96f69cbf4e7c91a898367bbd0042414c0ba1a266e3a0423" args="" -->yajl_t_true</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae95a1d5a195e8bd22a96f69cbf4e7c91a7a517c35ce7754fb57b3e000676b10f9"></a><!-- doxytag: member="yajl_t_false" ref="ae95a1d5a195e8bd22a96f69cbf4e7c91a7a517c35ce7754fb57b3e000676b10f9" args="" -->yajl_t_false</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae95a1d5a195e8bd22a96f69cbf4e7c91ab1bde75d9a3a9f386fdd37262d8d9b25"></a><!-- doxytag: member="yajl_t_null" ref="ae95a1d5a195e8bd22a96f69cbf4e7c91ab1bde75d9a3a9f386fdd37262d8d9b25" args="" -->yajl_t_null</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ae95a1d5a195e8bd22a96f69cbf4e7c91a9f219b51253c2cb0e278cc4ad55b211e"></a><!-- doxytag: member="yajl_t_any" ref="ae95a1d5a195e8bd22a96f69cbf4e7c91a9f219b51253c2cb0e278cc4ad55b211e" args="" -->yajl_t_any</em> </td><td>
<p>The any type isn't valid for <a class="el" href="structyajl__val__s.html#a5286ed2abc22873bc8c077097f7ea150">yajl_val_s.type</a>, but can be used as an argument to routines like <a class="el" href="yajl__tree_8h.html#a534c427581fac81ee828c28367dbe90d">yajl_tree_get()</a>. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a83b59f411e80404aad35ae7071c4ecf8"></a><!-- doxytag: member="yajl_tree.h::yajl_tree_free" ref="a83b59f411e80404aad35ae7071c4ecf8" args="(yajl_val v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">YAJL_API void yajl_tree_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structyajl__val__s.html">yajl_val</a> </td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free a parse tree returned by "yajl_tree_parse".</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">v</td><td>Pointer to a JSON value returned by "yajl_tree_parse". Passing NULL is valid and results in a no-op. </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example_2parse_config_8c-example.html#a5">example/parse_config.c</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a534c427581fac81ee828c28367dbe90d"></a><!-- doxytag: member="yajl_tree.h::yajl_tree_get" ref="a534c427581fac81ee828c28367dbe90d" args="(yajl_val parent, const char **path, yajl_type type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">YAJL_API <a class="el" href="structyajl__val__s.html">yajl_val</a> yajl_tree_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structyajl__val__s.html">yajl_val</a> </td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="yajl__tree_8h.html#ae95a1d5a195e8bd22a96f69cbf4e7c91">yajl_type</a> </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Access a nested value inside a tree.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">parent</td><td>the node under which you'd like to extract values. </td></tr>
<tr><td class="paramname">path</td><td>A null terminated array of strings, each the name of an object key </td></tr>
<tr><td class="paramname">type</td><td>the yajl_type of the object you seek, or yajl_t_any if any will do.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the found value, or NULL if we came up empty.</dd></dl>
<p>Future Ideas: it'd be nice to move path to a string and implement support for a teeny tiny micro language here, so you can extract array elements, do things like .first and .last, even .length. Inspiration from JSONPath and css selectors? No it wouldn't be fast, but that's not what this API is about. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example_2parse_config_8c-example.html#a2">example/parse_config.c</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6a04342e825859a3e9d52df93e9d112a"></a><!-- doxytag: member="yajl_tree.h::yajl_tree_parse" ref="a6a04342e825859a3e9d52df93e9d112a" args="(const char *input, char *error_buffer, size_t error_buffer_size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">YAJL_API <a class="el" href="structyajl__val__s.html">yajl_val</a> yajl_tree_parse </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>error_buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>error_buffer_size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse a string.</p>
<p>Parses an null-terminated string containing JSON data and returns a pointer to the top-level value (root of the parse tree).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td>Pointer to a null-terminated utf8 string containing JSON data. </td></tr>
<tr><td class="paramname">error_buffer</td><td>Pointer to a buffer in which an error message will be stored if <em>yajl_tree_parse</em> fails, or <code>NULL</code>. The buffer will be initialized before parsing, so its content will be destroyed even if <em>yajl_tree_parse</em> succeeds. </td></tr>
<tr><td class="paramname">error_buffer_size</td><td>Size of the memory area pointed to by <em>error_buffer_size</em>. If <em>error_buffer_size</em> is <code>NULL</code>, this argument is ignored.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to the top-level value or <code>NULL</code> on error. The memory pointed to must be freed using <em>yajl_tree_free</em>. In case of an error, a null terminated message describing the error in more detail is stored in <em>error_buffer</em> if it is not <code>NULL</code>. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example_2parse_config_8c-example.html#a1">example/parse_config.c</a>.</dd>
</dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Apr 25 2011 13:04:10 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>