doc/modules/luci.jsonc.parser.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   2    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html>
   4 <head>
   5     <title>Reference</title>
   6     <link rel="stylesheet" href="../luadoc.css" type="text/css" />
   7         <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
   8 </head>
   9
  10 <body>
  11 <div id="container">
  12
  13 <div id="product">
  14         <div id="product_logo"></div>
  15         <div id="product_name"><big><b></b></big></div>
  16         <div id="product_description"></div>
  17 </div> <!-- id="product" -->
  18
  19 <div id="main">
  20
  21 <div id="navigation">
  22
  23
  24 <h1>LuaDoc</h1>
  25 <ul>
  26
  27         <li><a href="../index.html">Index</a></li>
  28
  29 </ul>
  30
  31
  32 <!-- Module list -->
  33
  34 <h1>Modules</h1>
  35 <ul>
  36
  37         <li>
  38                 <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
  39         </li>
  40
  41         <li>
  42                 <a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
  43         </li>
  44
  45         <li>
  46                 <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
  47         </li>
  48
  49         <li>
  50                 <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
  51         </li>
  52
  53         <li>
  54                 <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
  55         </li>
  56
  57         <li>
  58                 <a href="../modules/luci.i18n.html">luci.i18n</a>
  59         </li>
  60
  61         <li>
  62                 <a href="../modules/luci.ip.html">luci.ip</a>
  63         </li>
  64
  65         <li>
  66                 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
  67         </li>
  68
  69         <li>
  70                 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
  71         </li>
  72
  73         <li><strong>luci.jsonc.parser</strong></li>
  74
  75         <li>
  76                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
  77         </li>
  78
  79         <li>
  80                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
  81         </li>
  82
  83         <li>
  84                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
  85         </li>
  86
  87         <li>
  88                 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
  89         </li>
  90
  91         <li>
  92                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
  93         </li>
  94
  95         <li>
  96                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
  97         </li>
  98
  99         <li>
 100                 <a href="../modules/nixio.html">nixio</a>
 101         </li>
 102
 103         <li>
 104                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 105         </li>
 106
 107         <li>
 108                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 109         </li>
 110
 111         <li>
 112                 <a href="../modules/nixio.File.html">nixio.File</a>
 113         </li>
 114
 115         <li>
 116                 <a href="../modules/nixio.README.html">nixio.README</a>
 117         </li>
 118
 119         <li>
 120                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 121         </li>
 122
 123         <li>
 124                 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
 125         </li>
 126
 127         <li>
 128                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 129         </li>
 130
 131         <li>
 132                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 133         </li>
 134
 135         <li>
 136                 <a href="../modules/nixio.bin.html">nixio.bin</a>
 137         </li>
 138
 139         <li>
 140                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 141         </li>
 142
 143         <li>
 144                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
 145         </li>
 146
 147         <li>
 148                 <a href="../modules/nixio.fs.html">nixio.fs</a>
 149         </li>
 150
 151 </ul>
 152
 153
 154
 155 <!-- File list -->
 156
 157
 158
 159
 160
 161
 162
 163 </div><!-- id="navigation" -->
 164
 165 <div id="content">
 166
 167 <h1>Object Instance <code>luci.jsonc.parser</code></h1>
 168
 169 <p>
 170  LuCI JSON parser instance.
 171  A JSON parser instance is useful to parse JSON data chunk by chunk, without
 172  the need to assemble all data in advance.</p>
 173
 174
 175
 176
 177
 178
 179
 180 <h2>Functions</h2>
 181 <table class="function_list">
 182
 183         <tr>
 184         <td class="name" nowrap><a href="#parser.parse">parser:parse</a>&nbsp;(json)</td>
 185         <td class="summary">
 186
 187 Parses one chunk of JSON data.</td>
 188         </tr>
 189
 190         <tr>
 191         <td class="name" nowrap><a href="#parser.get">parser:get</a>&nbsp;()</td>
 192         <td class="summary">
 193
 194 Convert parsed JSON data into Lua table.</td>
 195         </tr>
 196
 197         <tr>
 198         <td class="name" nowrap><a href="#parser.set">parser:set</a>&nbsp;(data)</td>
 199         <td class="summary">
 200
 201 Put Lua data into the parser.</td>
 202         </tr>
 203
 204         <tr>
 205         <td class="name" nowrap><a href="#parser.stringify">parser:stringify</a>&nbsp;(pretty)</td>
 206         <td class="summary">
 207
 208 Serialize current parser state as JSON.</td>
 209         </tr>
 210
 211 </table>
 212
 213
 214
 215
 216
 217
 218 <br/>
 219 <br/>
 220
 221
 222 <h2><a name="functions"></a>Functions</h2>
 223 <dl class="function">
 224
 225
 226
 227 <dt><a name="parser.parse"></a><strong>parser:parse</strong>&nbsp;(json)</dt>
 228 <dd>
 229
 230
 231 Parses one chunk of JSON data.
 232
 233
 234
 235 <h3>Parameters</h3>
 236 <ul>
 237
 238         <li>
 239           json: String containing the JSON fragment to parse
 240         </li>
 241
 242 </ul>
 243
 244
 245
 246
 247 <h3>Usage:</h3>
 248 <pre>parser = luci.jsonc.new()
 249
 250 while true do
 251         chunk = ...  -- fetch a cunk of data, e.g. from a socket
 252         finish, errmsg = <b>parser.parse(chunk)</b>
 253
 254         if finish == nil then
 255                 error("Cannot parse JSON: " .. errmsg)
 256         end
 257
 258         if finish == true then
 259                 break
 260         end
 261 end</pre>
 262
 263
 264
 265 <h3>Return value:</h3>
 266 <ul>
 267         <li><code>true</code> if a complete JSON object has been parsed and no further input is
 268             expected.</li>
 269         <li><code>false</code> if further input is required</li>
 270         <li><code>nil</code> if an error was encountered while parsing the current chunk.
 271             In this case a string describing the parse error is returned as second
 272             value.</li></ul>
 273
 274
 275
 276 <h3>See also:</h3>
 277 <ul>
 278
 279         <li><a href="#parser.get">
 280                 parser:get
 281         </a>
 282
 283 </ul>
 284
 285 </dd>
 286
 287
 288
 289
 290 <dt><a name="parser.get"></a><strong>parser:get</strong>&nbsp;()</dt>
 291 <dd>
 292
 293
 294 Convert parsed JSON data into Lua table.
 295
 296
 297
 298
 299
 300
 301 <h3>Usage:</h3>
 302 <pre>parser = luci.jsonc.new()
 303 parser:parse('{ "example": "test" }')
 304
 305 data = parser:get()
 306 print(data.example)  -- "test"</pre>
 307
 308
 309
 310 <h3>Return value:</h3>
 311 Parsed JSON object converted into a Lua table or <code>nil</code> if the parser
 312         didn't finish or encountered an error.
 313
 314
 315
 316 <h3>See also:</h3>
 317 <ul>
 318
 319         <li><a href="#parser.parse">
 320                 parser:parse
 321         </a>
 322
 323 </ul>
 324
 325 </dd>
 326
 327
 328
 329
 330 <dt><a name="parser.set"></a><strong>parser:set</strong>&nbsp;(data)</dt>
 331 <dd>
 332
 333
 334 Put Lua data into the parser.
 335
 336
 337
 338 <h3>Parameters</h3>
 339 <ul>
 340
 341         <li>
 342           data: Lua data to put into the parser object. The data is converted to an
 343         internal JSON representation that can be dumped with <code>stringify()</code>.
 344         The conversion follows the rules described in <code>luci.jsonc.stringify</code>.
 345         </li>
 346
 347 </ul>
 348
 349
 350
 351
 352 <h3>Usage:</h3>
 353 <pre>parser = luci.jsonc.new()
 354 parser:set({ "some", "data" })</pre>
 355
 356
 357
 358 <h3>Return value:</h3>
 359 Nothing is returned.
 360
 361
 362
 363 <h3>See also:</h3>
 364 <ul>
 365
 366         <li><a href="#parser.stringify">
 367                 parser:stringify
 368         </a>
 369
 370 </ul>
 371
 372 </dd>
 373
 374
 375
 376
 377 <dt><a name="parser.stringify"></a><strong>parser:stringify</strong>&nbsp;(pretty)</dt>
 378 <dd>
 379
 380
 381 Serialize current parser state as JSON.
 382
 383
 384
 385 <h3>Parameters</h3>
 386 <ul>
 387
 388         <li>
 389           pretty: A boolean value indicating whether the resulting JSON should be pretty printed.
 390         </li>
 391
 392 </ul>
 393
 394
 395
 396
 397 <h3>Usage:</h3>
 398 <pre>parser = luci.jsonc.new()
 399 parser:parse('{ "example": "test" }')
 400 print(parser:serialize())  -- '{"example":"test"}'</pre>
 401
 402
 403
 404 <h3>Return value:</h3>
 405 Returns the serialized JSON data of this parser instance.
 406
 407
 408
 409 </dd>
 410
 411
 412 </dl>
 413
 414
 415
 416
 417
 418 </div> <!-- id="content" -->
 419
 420 </div> <!-- id="main" -->
 421
 422 <div id="about">
 423         <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
 424 </div> <!-- id="about" -->
 425
 426 </div> <!-- id="container" -->
 427 </body>
 428 </html>