2
0

luci.jsonc.parser.html 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495
  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. <body>
  10. <div id="container">
  11. <div id="product">
  12. <div id="product_logo"></div>
  13. <div id="product_name"><big><b></b></big></div>
  14. <div id="product_description"></div>
  15. </div> <!-- id="product" -->
  16. <div id="main">
  17. <div id="navigation">
  18. <h1>LuaDoc</h1>
  19. <ul>
  20. <li><a href="../index.html">Index</a></li>
  21. </ul>
  22. <!-- Module list -->
  23. <h1>Modules</h1>
  24. <ul>
  25. <li>
  26. <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
  27. </li>
  28. <li>
  29. <a href="../modules/luci.http.html">luci.http</a>
  30. </li>
  31. <li>
  32. <a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
  33. </li>
  34. <li>
  35. <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
  36. </li>
  37. <li>
  38. <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
  39. </li>
  40. <li>
  41. <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
  42. </li>
  43. <li>
  44. <a href="../modules/luci.i18n.html">luci.i18n</a>
  45. </li>
  46. <li>
  47. <a href="../modules/luci.ip.html">luci.ip</a>
  48. </li>
  49. <li>
  50. <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
  51. </li>
  52. <li>
  53. <a href="../modules/luci.json.html">luci.json</a>
  54. </li>
  55. <li>
  56. <a href="../modules/luci.jsonc.html">luci.jsonc</a>
  57. </li>
  58. <li><strong>luci.jsonc.parser</strong></li>
  59. <li>
  60. <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
  61. </li>
  62. <li>
  63. <a href="../modules/luci.model.uci.html">luci.model.uci</a>
  64. </li>
  65. <li>
  66. <a href="../modules/luci.rpcc.html">luci.rpcc</a>
  67. </li>
  68. <li>
  69. <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
  70. </li>
  71. <li>
  72. <a href="../modules/luci.sys.html">luci.sys</a>
  73. </li>
  74. <li>
  75. <a href="../modules/luci.sys.init.html">luci.sys.init</a>
  76. </li>
  77. <li>
  78. <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
  79. </li>
  80. <li>
  81. <a href="../modules/luci.sys.net.html">luci.sys.net</a>
  82. </li>
  83. <li>
  84. <a href="../modules/luci.sys.process.html">luci.sys.process</a>
  85. </li>
  86. <li>
  87. <a href="../modules/luci.sys.user.html">luci.sys.user</a>
  88. </li>
  89. <li>
  90. <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
  91. </li>
  92. <li>
  93. <a href="../modules/luci.util.html">luci.util</a>
  94. </li>
  95. <li>
  96. <a href="../modules/nixio.html">nixio</a>
  97. </li>
  98. <li>
  99. <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
  100. </li>
  101. <li>
  102. <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
  103. </li>
  104. <li>
  105. <a href="../modules/nixio.File.html">nixio.File</a>
  106. </li>
  107. <li>
  108. <a href="../modules/nixio.README.html">nixio.README</a>
  109. </li>
  110. <li>
  111. <a href="../modules/nixio.Socket.html">nixio.Socket</a>
  112. </li>
  113. <li>
  114. <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
  115. </li>
  116. <li>
  117. <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
  118. </li>
  119. <li>
  120. <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
  121. </li>
  122. <li>
  123. <a href="../modules/nixio.bin.html">nixio.bin</a>
  124. </li>
  125. <li>
  126. <a href="../modules/nixio.bit.html">nixio.bit</a>
  127. </li>
  128. <li>
  129. <a href="../modules/nixio.crypto.html">nixio.crypto</a>
  130. </li>
  131. <li>
  132. <a href="../modules/nixio.fs.html">nixio.fs</a>
  133. </li>
  134. </ul>
  135. <!-- File list -->
  136. </div><!-- id="navigation" -->
  137. <div id="content">
  138. <h1>Object Instance <code>luci.jsonc.parser</code></h1>
  139. <p>
  140. LuCI JSON parser instance.
  141. A JSON parser instance is useful to parse JSON data chunk by chunk, without
  142. the need to assemble all data in advance.</p>
  143. <h2>Functions</h2>
  144. <table class="function_list">
  145. <tr>
  146. <td class="name" nowrap><a href="#parser.parse">parser:parse</a>&nbsp;(json)</td>
  147. <td class="summary">
  148. Parses one chunk of JSON data.</td>
  149. </tr>
  150. <tr>
  151. <td class="name" nowrap><a href="#parser.get">parser:get</a>&nbsp;()</td>
  152. <td class="summary">
  153. Convert parsed JSON data into Lua table.</td>
  154. </tr>
  155. <tr>
  156. <td class="name" nowrap><a href="#parser.set">parser:set</a>&nbsp;(data)</td>
  157. <td class="summary">
  158. Put Lua data into the parser.</td>
  159. </tr>
  160. <tr>
  161. <td class="name" nowrap><a href="#parser.sink">parser:sink</a>&nbsp;()</td>
  162. <td class="summary">
  163. Generate an ltn12-compatible sink.</td>
  164. </tr>
  165. <tr>
  166. <td class="name" nowrap><a href="#parser.stringify">parser:stringify</a>&nbsp;(pretty)</td>
  167. <td class="summary">
  168. Serialize current parser state as JSON.</td>
  169. </tr>
  170. </table>
  171. <br/>
  172. <br/>
  173. <h2><a name="functions"></a>Functions</h2>
  174. <dl class="function">
  175. <dt><a name="parser.parse"></a><strong>parser:parse</strong>&nbsp;(json)</dt>
  176. <dd>
  177. Parses one chunk of JSON data.
  178. <h3>Parameters</h3>
  179. <ul>
  180. <li>
  181. json: String containing the JSON fragment to parse
  182. </li>
  183. </ul>
  184. <h3>Usage:</h3>
  185. <pre>parser = luci.jsonc.new()
  186. while true do
  187. chunk = ... -- fetch a cunk of data, e.g. from a socket
  188. finish, errmsg = <b>parser.parse(chunk)</b>
  189. if finish == nil then
  190. error("Cannot parse JSON: " .. errmsg)
  191. end
  192. if finish == true then
  193. break
  194. end
  195. end</pre>
  196. <h3>Return value:</h3>
  197. <ul>
  198. <li><code>true</code> if a complete JSON object has been parsed and no further input is
  199. expected.</li>
  200. <li><code>false</code> if further input is required</li>
  201. <li><code>nil</code> if an error was encountered while parsing the current chunk.
  202. In this case a string describing the parse error is returned as second
  203. value.</li></ul>
  204. <h3>See also:</h3>
  205. <ul>
  206. <li><a href="#parser.get">
  207. parser:get
  208. </a>
  209. </ul>
  210. </dd>
  211. <dt><a name="parser.get"></a><strong>parser:get</strong>&nbsp;()</dt>
  212. <dd>
  213. Convert parsed JSON data into Lua table.
  214. <h3>Usage:</h3>
  215. <pre>parser = luci.jsonc.new()
  216. parser:parse('{ "example": "test" }')
  217. data = parser:get()
  218. print(data.example) -- "test"</pre>
  219. <h3>Return value:</h3>
  220. Parsed JSON object converted into a Lua table or <code>nil</code> if the parser
  221. didn't finish or encountered an error.
  222. <h3>See also:</h3>
  223. <ul>
  224. <li><a href="#parser.parse">
  225. parser:parse
  226. </a>
  227. </ul>
  228. </dd>
  229. <dt><a name="parser.set"></a><strong>parser:set</strong>&nbsp;(data)</dt>
  230. <dd>
  231. Put Lua data into the parser.
  232. <h3>Parameters</h3>
  233. <ul>
  234. <li>
  235. data: Lua data to put into the parser object. The data is converted to an
  236. internal JSON representation that can be dumped with <code>stringify()</code>.
  237. The conversion follows the rules described in <code>luci.jsonc.stringify</code>.
  238. </li>
  239. </ul>
  240. <h3>Usage:</h3>
  241. <pre>parser = luci.jsonc.new()
  242. parser:set({ "some", "data" })</pre>
  243. <h3>Return value:</h3>
  244. Nothing is returned.
  245. <h3>See also:</h3>
  246. <ul>
  247. <li><a href="#parser.stringify">
  248. parser:stringify
  249. </a>
  250. </ul>
  251. </dd>
  252. <dt><a name="parser.sink"></a><strong>parser:sink</strong>&nbsp;()</dt>
  253. <dd>
  254. Generate an ltn12-compatible sink.
  255. <h3>Usage:</h3>
  256. <pre>parser = luci.jsonc.new()
  257. ltn12.pump.all(ltn12.source.file(io.input()), parser:sink())
  258. print(parser:get())</pre>
  259. <h3>Return value:</h3>
  260. Returns a function that can be used as an ltn12 sink.
  261. </dd>
  262. <dt><a name="parser.stringify"></a><strong>parser:stringify</strong>&nbsp;(pretty)</dt>
  263. <dd>
  264. Serialize current parser state as JSON.
  265. <h3>Parameters</h3>
  266. <ul>
  267. <li>
  268. pretty: A boolean value indicating whether the resulting JSON should be pretty printed.
  269. </li>
  270. </ul>
  271. <h3>Usage:</h3>
  272. <pre>parser = luci.jsonc.new()
  273. parser:parse('{ "example": "test" }')
  274. print(parser:serialize()) -- '{"example":"test"}'</pre>
  275. <h3>Return value:</h3>
  276. Returns the serialized JSON data of this parser instance.
  277. </dd>
  278. </dl>
  279. </div> <!-- id="content" -->
  280. </div> <!-- id="main" -->
  281. <div id="about">
  282. <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>
  283. </div> <!-- id="about" -->
  284. </div> <!-- id="container" -->
  285. </body>
  286. </html>