1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
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"/-->
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" -->
27 <li><a href=
"../index.html">Index
</a></li>
38 <a href=
"../modules/luci.dispatcher.html">luci.dispatcher
</a>
42 <a href=
"../modules/luci.http.html">luci.http
</a>
46 <a href=
"../modules/luci.http.conditionals.html">luci.http.conditionals
</a>
50 <a href=
"../modules/luci.http.date.html">luci.http.date
</a>
54 <a href=
"../modules/luci.http.mime.html">luci.http.mime
</a>
58 <a href=
"../modules/luci.i18n.html">luci.i18n
</a>
62 <a href=
"../modules/luci.ip.html">luci.ip
</a>
66 <a href=
"../modules/luci.ip.cidr.html">luci.ip.cidr
</a>
70 <a href=
"../modules/luci.json.html">luci.json
</a>
74 <a href=
"../modules/luci.jsonc.html">luci.jsonc
</a>
77 <li><strong>luci.jsonc.parser
</strong></li>
80 <a href=
"../modules/luci.model.ipkg.html">luci.model.ipkg
</a>
84 <a href=
"../modules/luci.model.uci.html">luci.model.uci
</a>
88 <a href=
"../modules/luci.rpcc.html">luci.rpcc
</a>
92 <a href=
"../modules/luci.rpcc.ruci.html">luci.rpcc.ruci
</a>
96 <a href=
"../modules/luci.sys.html">luci.sys
</a>
100 <a href=
"../modules/luci.sys.init.html">luci.sys.init
</a>
104 <a href=
"../modules/luci.sys.iptparser.html">luci.sys.iptparser
</a>
108 <a href=
"../modules/luci.sys.net.html">luci.sys.net
</a>
112 <a href=
"../modules/luci.sys.process.html">luci.sys.process
</a>
116 <a href=
"../modules/luci.sys.user.html">luci.sys.user
</a>
120 <a href=
"../modules/luci.sys.wifi.html">luci.sys.wifi
</a>
124 <a href=
"../modules/luci.util.html">luci.util
</a>
128 <a href=
"../modules/nixio.html">nixio
</a>
132 <a href=
"../modules/nixio.CHANGELOG.html">nixio.CHANGELOG
</a>
136 <a href=
"../modules/nixio.CryptoHash.html">nixio.CryptoHash
</a>
140 <a href=
"../modules/nixio.File.html">nixio.File
</a>
144 <a href=
"../modules/nixio.README.html">nixio.README
</a>
148 <a href=
"../modules/nixio.Socket.html">nixio.Socket
</a>
152 <a href=
"../modules/nixio.TLSContext.html">nixio.TLSContext
</a>
156 <a href=
"../modules/nixio.TLSSocket.html">nixio.TLSSocket
</a>
160 <a href=
"../modules/nixio.UnifiedIO.html">nixio.UnifiedIO
</a>
164 <a href=
"../modules/nixio.bin.html">nixio.bin
</a>
168 <a href=
"../modules/nixio.bit.html">nixio.bit
</a>
172 <a href=
"../modules/nixio.crypto.html">nixio.crypto
</a>
176 <a href=
"../modules/nixio.fs.html">nixio.fs
</a>
191 </div><!-- id="navigation" -->
195 <h1>Object Instance
<code>luci.jsonc.parser
</code></h1>
198 LuCI JSON parser instance.
199 A JSON parser instance is useful to parse JSON data chunk by chunk, without
200 the need to assemble all data in advance.
</p>
209 <table class=
"function_list">
212 <td class=
"name" nowrap
><a href=
"#parser.parse">parser:parse
</a> (json)
</td>
215 Parses one chunk of JSON data.
</td>
219 <td class=
"name" nowrap
><a href=
"#parser.get">parser:get
</a> ()
</td>
222 Convert parsed JSON data into Lua table.
</td>
226 <td class=
"name" nowrap
><a href=
"#parser.set">parser:set
</a> (data)
</td>
229 Put Lua data into the parser.
</td>
233 <td class=
"name" nowrap
><a href=
"#parser.sink">parser:sink
</a> ()
</td>
236 Generate an ltn12-compatible sink.
</td>
240 <td class=
"name" nowrap
><a href=
"#parser.stringify">parser:stringify
</a> (pretty)
</td>
243 Serialize current parser state as JSON.
</td>
257 <h2><a name=
"functions"></a>Functions
</h2>
258 <dl class=
"function">
262 <dt><a name=
"parser.parse"></a><strong>parser:parse
</strong> (json)
</dt>
266 Parses one chunk of JSON data.
274 json: String containing the JSON fragment to parse
283 <pre>parser = luci.jsonc.new()
286 chunk = ... -- fetch a cunk of data, e.g. from a socket
287 finish, errmsg =
<b>parser.parse(chunk)
</b>
289 if finish == nil then
290 error(
"Cannot parse JSON: " .. errmsg)
293 if finish == true then
300 <h3>Return value:
</h3>
302 <li><code>true
</code> if a complete JSON object has been parsed and no further input is
304 <li><code>false
</code> if further input is required
</li>
305 <li><code>nil
</code> if an error was encountered while parsing the current chunk.
306 In this case a string describing the parse error is returned as second
314 <li><a href=
"#parser.get">
325 <dt><a name=
"parser.get"></a><strong>parser:get
</strong> ()
</dt>
329 Convert parsed JSON data into Lua table.
337 <pre>parser = luci.jsonc.new()
338 parser:parse('{
"example":
"test" }')
341 print(data.example) --
"test"</pre>
345 <h3>Return value:
</h3>
346 Parsed JSON object converted into a Lua table or
<code>nil
</code> if the parser
347 didn't finish or encountered an error.
354 <li><a href=
"#parser.parse">
365 <dt><a name=
"parser.set"></a><strong>parser:set
</strong> (data)
</dt>
369 Put Lua data into the parser.
377 data: Lua data to put into the parser object. The data is converted to an
378 internal JSON representation that can be dumped with
<code>stringify()
</code>.
379 The conversion follows the rules described in
<code>luci.jsonc.stringify
</code>.
388 <pre>parser = luci.jsonc.new()
389 parser:set({
"some",
"data" })
</pre>
393 <h3>Return value:
</h3>
401 <li><a href=
"#parser.stringify">
412 <dt><a name=
"parser.sink"></a><strong>parser:sink
</strong> ()
</dt>
416 Generate an ltn12-compatible sink.
424 <pre>parser = luci.jsonc.new()
425 ltn12.pump.all(ltn12.source.file(io.input()), parser:sink())
426 print(parser:get())
</pre>
430 <h3>Return value:
</h3>
431 Returns a function that can be used as an ltn12 sink.
440 <dt><a name=
"parser.stringify"></a><strong>parser:stringify
</strong> (pretty)
</dt>
444 Serialize current parser state as JSON.
452 pretty: A boolean value indicating whether the resulting JSON should be pretty printed.
461 <pre>parser = luci.jsonc.new()
462 parser:parse('{
"example":
"test" }')
463 print(parser:serialize()) -- '{
"example":
"test"}'
</pre>
467 <h3>Return value:
</h3>
468 Returns the serialized JSON data of this parser instance.
481 </div> <!-- id="content" -->
483 </div> <!-- id="main" -->
486 <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>
487 </div> <!-- id="about" -->
489 </div> <!-- id="container" -->