summaryrefslogtreecommitdiff
path: root/doc/classes/JSON/Ext/Parser.html
blob: 7d0bf27bdab26be873b0686e47c6ae1047ce8a65 (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
<?xml version="1.0" encoding="iso-8859-1"?>
<!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>Class: JSON::Ext::Parser</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Class</strong></td>
          <td class="class-name-in-header">JSON::Ext::Parser</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../../../files/ext/json/ext/parser_c.html">
                ext/json/ext/parser.c
                </a>
        <br />
            </td>
        </tr>

        <tr class="top-aligned-row">
            <td><strong>Parent:</strong></td>
            <td>
                <a href="../../Object.html">
                Object
               </a>
            </td>
        </tr>
        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">

    <div id="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>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000140">new</a>&nbsp;&nbsp;
      <a href="#M000141">parse</a>&nbsp;&nbsp;
      <a href="#M000142">source</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->

    <div id="section">





      


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Class methods</h3>

      <div id="method-M000140" class="method-detail">
        <a name="M000140"></a>

        <div class="method-heading">
          <a href="Parser.src/M000140.html" target="Code" class="method-signature"
            onclick="popupCode('Parser.src/M000140.html');return false;">
          <span class="method-name"> new(source, opts => {})<br />
</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Creates a <a href="Parser.html#M000140">new</a> <a
href="Parser.html">JSON::Ext::Parser</a> instance for the string <em><a
href="Parser.html#M000142">source</a></em>.
</p>
<p>
Creates a <a href="Parser.html#M000140">new</a> <a
href="Parser.html">JSON::Ext::Parser</a> instance for the string <em><a
href="Parser.html#M000142">source</a></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 =&gt; 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>create_additions</b>: If set to false, the <a
href="Parser.html">Parser</a> doesn&#8216;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>

      <h3 class="section-bar">Public Instance methods</h3>

      <div id="method-M000141" class="method-detail">
        <a name="M000141"></a>

        <div class="method-heading">
          <a href="Parser.src/M000141.html" target="Code" class="method-signature"
            onclick="popupCode('Parser.src/M000141.html');return false;">
          <span class="method-name"> parse()<br />
</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Parses the current <a href="../../JSON.html">JSON</a> text <em><a
href="Parser.html#M000142">source</a></em> and returns the complete data
structure as a result.
</p>
        </div>
      </div>

      <div id="method-M000142" class="method-detail">
        <a name="M000142"></a>

        <div class="method-heading">
          <a href="Parser.src/M000142.html" target="Code" class="method-signature"
            onclick="popupCode('Parser.src/M000142.html');return false;">
          <span class="method-name"> source()<br />
</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Returns a copy of the current <em><a
href="Parser.html#M000142">source</a></em> string, that was used to
construct this <a href="Parser.html">Parser</a>.
</p>
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>