summaryrefslogtreecommitdiff
path: root/doc/classes/JSON/Ext/Parser.html
blob: 1bde2ff460b85a19512d1a58ac6be488b525c64b (plain)
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
<?xml version="1.0" encoding="utf-8"?>
<!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" xml:lang="en" lang="en">
<head>
    <title>JSON::Ext::Parser</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <link rel="stylesheet" href="../../../css/reset.css" type="text/css" media="screen" />
    <link rel="stylesheet" href="../../../css/main.css" type="text/css" media="screen" />
    <script src="../../../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
    <script src="../../../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
    <script src="../../../js/main.js" type="text/javascript" charset="utf-8"></script>
</head>

<body>     
    <div class="banner">
        <h1>
            <span class="type">Class</span> 
            JSON::Ext::Parser 
            
                <span class="parent">&lt; 
                    
                    <a href="../../Object.html">Object</a>
                    
                </span>
            
        </h1>
        <ul class="files">
            
            <li><a href="../../../files/ext/json/ext/parser_c.html">ext/json/ext/parser.c</a></li>
            
        </ul>
    </div>
    <div id="bodyContent">
        <div id="content">
    
    <div class="description">
        <p>
This is the <a href="../../JSON.html">JSON</a> parser implemented as a C
extension. It can be configured to be used by setting
</p>
<pre>
 JSON.parser = JSON::Ext::Parser
</pre>
<p>
with the method parser= in <a href="../../JSON.html">JSON</a>.
</p>

    </div>
    

    

    
    

    
    
    <div class="sectiontitle">Methods</div>
    <dl class="methods">
    
        <dt>N</dt>
        <dd>
            <ul>
                
                <li><a href="#M000084">new</a></li>
                
            </ul>
        </dd>
    
        <dt>P</dt>
        <dd>
            <ul>
                
                <li><a href="#M000085">parse</a></li>
                
            </ul>
        </dd>
    
        <dt>S</dt>
        <dd>
            <ul>
                
                <li><a href="#M000086">source</a></li>
                
            </ul>
        </dd>
    
    </dl>
    

    

    

    

    

    

    
            <div class="sectiontitle">Class Public methods</div>
            
            <div class="method">
                <div class="title" id="M000084">
                    
                    <a name="M000084"></a><b> new(source, opts => {})
</b>
                    
                </div>
                
                <div class="description">
                  <p>
Creates a new <a href="Parser.html">JSON::Ext::Parser</a> instance for the
string <em>source</em>.
</p>
<p>
Creates a new <a href="Parser.html">JSON::Ext::Parser</a> instance for the
string <em>source</em>.
</p>
<p>
It will be configured by the <em>opts</em> hash. <em>opts</em> can have the
following keys:
</p>
<p>
<em>opts</em> can have the following keys:
</p>
<ul>
<li><b>max_nesting</b>: The maximum depth of nesting allowed in the parsed data
structures. Disable depth checking with :max_nesting => false|nil|0, it
defaults to 19.

</li>
<li><b>allow_nan</b>: If set to true, allow NaN, Infinity and -Infinity in
defiance of RFC 4627 to be parsed by the <a href="Parser.html">Parser</a>.
This option defaults to false.

</li>
<li><b>symbolize_names</b>: If set to true, returns symbols for the names
(keys) in a <a href="../../JSON.html">JSON</a> object. Otherwise strings
are returned, which is also the default.

</li>
<li><b>create_additions</b>: If set to false, the <a
href="Parser.html">Parser</a> doesn&#8217;t create additions even if a
matchin class and create_id was found. This option defaults to true.

</li>
<li><b>object_class</b>: Defaults to Hash

</li>
<li><b>array_class</b>: Defaults to Array

</li>
</ul>

                </div>
                
                
                
                
                <div class="sourcecode">
                    <p class="source-link">
                        Source: <a href="javascript:toggleSource('M000084_source')" id="l_M000084_source">show</a>
                        
                    </p>
                    <div id="M000084_source" class="dyn-source">
                        <pre>static VALUE cParser_initialize(int argc, VALUE *argv, VALUE self)
{
    char *ptr;
    long len;
    VALUE source, opts;
    GET_PARSER;
    rb_scan_args(argc, argv, &quot;11&quot;, &amp;source, &amp;opts);
    source = convert_encoding(StringValue(source));
    ptr = RSTRING_PTR(source);
    len = RSTRING_LEN(source);
    if (!NIL_P(opts)) {
        opts = rb_convert_type(opts, T_HASH, &quot;Hash&quot;, &quot;to_hash&quot;);
        if (NIL_P(opts)) {
            rb_raise(rb_eArgError, &quot;opts needs to be like a hash&quot;);
        } else {
            VALUE tmp = ID2SYM(i_max_nesting);
            if (option_given_p(opts, tmp)) {
                VALUE max_nesting = rb_hash_aref(opts, tmp);
                if (RTEST(max_nesting)) {
                    Check_Type(max_nesting, T_FIXNUM);
                    json-&gt;max_nesting = FIX2INT(max_nesting);
                } else {
                    json-&gt;max_nesting = 0;
                }
            } else {
                json-&gt;max_nesting = 19;
            }
            tmp = ID2SYM(i_allow_nan);
            if (option_given_p(opts, tmp)) {
                VALUE allow_nan = rb_hash_aref(opts, tmp);
                json-&gt;allow_nan = RTEST(allow_nan) ? 1 : 0;
            } else {
                json-&gt;allow_nan = 0;
            }
            tmp = ID2SYM(i_symbolize_names);
            if (option_given_p(opts, tmp)) {
                VALUE symbolize_names = rb_hash_aref(opts, tmp);
                json-&gt;symbolize_names = RTEST(symbolize_names) ? 1 : 0;
            } else {
                json-&gt;symbolize_names = 0;
            }
            tmp = ID2SYM(i_create_additions);
            if (option_given_p(opts, tmp)) {
                VALUE create_additions = rb_hash_aref(opts, tmp);
                if (RTEST(create_additions)) {
                    json-&gt;create_id = rb_funcall(mJSON, i_create_id, 0);
                } else {
                    json-&gt;create_id = Qnil;
                }
            } else {
                json-&gt;create_id = rb_funcall(mJSON, i_create_id, 0);
            }
            tmp = ID2SYM(i_object_class);
            if (option_given_p(opts, tmp)) {
                json-&gt;object_class = rb_hash_aref(opts, tmp);
            } else {
                json-&gt;object_class = Qnil;
            }
            tmp = ID2SYM(i_array_class);
            if (option_given_p(opts, tmp)) {
                json-&gt;array_class = rb_hash_aref(opts, tmp);
            } else {
                json-&gt;array_class = Qnil;
            }
        }
    } else {
        json-&gt;max_nesting = 19;
        json-&gt;allow_nan = 0;
        json-&gt;create_id = rb_funcall(mJSON, i_create_id, 0);
        json-&gt;object_class = Qnil;
        json-&gt;array_class = Qnil;
    }
    json-&gt;current_nesting = 0;
    json-&gt;len = len;
    json-&gt;source = ptr;
    json-&gt;Vsource = source;
    return self;
}</pre>
                    </div>
                </div>
                
            </div>
            
            <div class="sectiontitle">Instance Public methods</div>
            
            <div class="method">
                <div class="title" id="M000085">
                    
                    <a name="M000085"></a><b> parse()
</b>
                    
                </div>
                
                <div class="description">
                  <p>
Parses the current <a href="../../JSON.html">JSON</a> text <em>source</em>
and returns the complete data structure as a result.
</p>

                </div>
                
                
                
                
                <div class="sourcecode">
                    <p class="source-link">
                        Source: <a href="javascript:toggleSource('M000085_source')" id="l_M000085_source">show</a>
                        
                    </p>
                    <div id="M000085_source" class="dyn-source">
                        <pre>static VALUE cParser_parse(VALUE self)
{
    char *p, *pe;
    int cs = EVIL;
    VALUE result = Qnil;
    GET_PARSER;

    
#line 1701 &quot;parser.c&quot;
        {
        cs = JSON_start;
        }

#line 698 &quot;parser.rl&quot;
    p = json-&gt;source;
    pe = p + json-&gt;len;
    
#line 1710 &quot;parser.c&quot;
        {
        if ( p == pe )
                goto _test_eof;
        switch ( cs )
        {
st1:
        if ( ++p == pe )
                goto _test_eof1;
case 1:
        switch( (*p) ) {
                case 13: goto st1;
                case 32: goto st1;
                case 47: goto st2;
                case 91: goto tr3;
                case 123: goto tr4;
        }
        if ( 9 &lt;= (*p) &amp;&amp; (*p) &lt;= 10 )
                goto st1;
        goto st0;
st0:
cs = 0;
        goto _out;
st2:
        if ( ++p == pe )
                goto _test_eof2;
case 2:
        switch( (*p) ) {
                case 42: goto st3;
                case 47: goto st5;
        }
        goto st0;
st3:
        if ( ++p == pe )
                goto _test_eof3;
case 3:
        if ( (*p) == 42 )
                goto st4;
        goto st3;
st4:
        if ( ++p == pe )
                goto _test_eof4;
case 4:
        switch( (*p) ) {
                case 42: goto st4;
                case 47: goto st1;
        }
        goto st3;
st5:
        if ( ++p == pe )
                goto _test_eof5;
case 5:
        if ( (*p) == 10 )
                goto st1;
        goto st5;
tr3:
#line 506 &quot;parser.rl&quot;
        {
        char *np;
        json-&gt;current_nesting = 1;
        np = JSON_parse_array(json, p, pe, &amp;result);
        if (np == NULL) { p--; {p++; cs = 10; goto _out;} } else {p = (( np))-1;}
    }
        goto st10;
tr4:
#line 499 &quot;parser.rl&quot;
        {
        char *np;
        json-&gt;current_nesting = 1;
        np = JSON_parse_object(json, p, pe, &amp;result);
        if (np == NULL) { p--; {p++; cs = 10; goto _out;} } else {p = (( np))-1;}
    }
        goto st10;
st10:
        if ( ++p == pe )
                goto _test_eof10;
case 10:
#line 1787 &quot;parser.c&quot;
        switch( (*p) ) {
                case 13: goto st10;
                case 32: goto st10;
                case 47: goto st6;
        }
        if ( 9 &lt;= (*p) &amp;&amp; (*p) &lt;= 10 )
                goto st10;
        goto st0;
st6:
        if ( ++p == pe )
                goto _test_eof6;
case 6:
        switch( (*p) ) {
                case 42: goto st7;
                case 47: goto st9;
        }
        goto st0;
st7:
        if ( ++p == pe )
                goto _test_eof7;
case 7:
        if ( (*p) == 42 )
                goto st8;
        goto st7;
st8:
        if ( ++p == pe )
                goto _test_eof8;
case 8:
        switch( (*p) ) {
                case 42: goto st8;
                case 47: goto st10;
        }
        goto st7;
st9:
        if ( ++p == pe )
                goto _test_eof9;
case 9:
        if ( (*p) == 10 )
                goto st10;
        goto st9;
        }
        _test_eof1: cs = 1; goto _test_eof; 
        _test_eof2: cs = 2; goto _test_eof; 
        _test_eof3: cs = 3; goto _test_eof; 
        _test_eof4: cs = 4; goto _test_eof; 
        _test_eof5: cs = 5; goto _test_eof; 
        _test_eof10: cs = 10; goto _test_eof; 
        _test_eof6: cs = 6; goto _test_eof; 
        _test_eof7: cs = 7; goto _test_eof; 
        _test_eof8: cs = 8; goto _test_eof; 
        _test_eof9: cs = 9; goto _test_eof; 

        _test_eof: {}
        _out: {}
        }

#line 701 &quot;parser.rl&quot;

    if (cs &gt;= JSON_first_final &amp;&amp; p == pe) {
        return result;
    } else {
        rb_raise(eParserError, &quot;%u: unexpected token at '%s'&quot;, __LINE__, p);
        return Qnil;
    }
}</pre>
                    </div>
                </div>
                
            </div>
            
            <div class="method">
                <div class="title" id="M000086">
                    
                    <a name="M000086"></a><b> source()
</b>
                    
                </div>
                
                <div class="description">
                  <p>
Returns a copy of the current <em>source</em> string, that was used to
construct this <a href="Parser.html">Parser</a>.
</p>

                </div>
                
                
                
                
                <div class="sourcecode">
                    <p class="source-link">
                        Source: <a href="javascript:toggleSource('M000086_source')" id="l_M000086_source">show</a>
                        
                    </p>
                    <div id="M000086_source" class="dyn-source">
                        <pre>static VALUE cParser_source(VALUE self)
{
    GET_PARSER;
    return rb_str_dup(json-&gt;Vsource);
}</pre>
                    </div>
                </div>
                
            </div>
            
</div>
    </div>
  </body>
</html>