/usr/share/doc/jaula/html/classJAULA_1_1Parser.html is in libjaula-doc 1.4.0-5build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>jaula API Reference: JAULA::Parser Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">jaula API Reference
 <span id="projectnumber">version 1.4.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classJAULA_1_1Parser.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">JAULA::Parser Class Reference<div class="ingroups"><a class="el" href="group__jaula__parse.html">JAULA: JSON data parser</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>JSON Data <a class="el" href="classJAULA_1_1Parser.html" title="JSON Data Parser. ">Parser</a>.
<a href="classJAULA_1_1Parser.html#details">More...</a></p>
<p><code>#include <<a class="el" href="jaula__parse_8h_source.html">jaula_parse.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classJAULA_1_1Parser_1_1Value__Parser.html">Value_Parser</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">JSON <a class="el" href="classJAULA_1_1Value.html" title="Base class for handling values. ">Value</a> <a class="el" href="classJAULA_1_1Parser.html" title="JSON Data Parser. ">Parser</a>. <a href="classJAULA_1_1Parser_1_1Value__Parser.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4be52fa703c14a711aa34ef32080f70e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classJAULA_1_1Parser.html#a4be52fa703c14a711aa34ef32080f70e">Parser</a> (void)</td></tr>
<tr class="memdesc:a4be52fa703c14a711aa34ef32080f70e"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a4be52fa703c14a711aa34ef32080f70e">More...</a><br /></td></tr>
<tr class="separator:a4be52fa703c14a711aa34ef32080f70e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad8bde22e6943713306cf7cda7231e9bb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classJAULA_1_1Parser.html#ad8bde22e6943713306cf7cda7231e9bb">~Parser</a> (void)</td></tr>
<tr class="memdesc:ad8bde22e6943713306cf7cda7231e9bb"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ad8bde22e6943713306cf7cda7231e9bb">More...</a><br /></td></tr>
<tr class="separator:ad8bde22e6943713306cf7cda7231e9bb"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a24cecaf6c3836a5036603dc9b079e4f9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classJAULA_1_1Value__Complex.html">Value_Complex</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classJAULA_1_1Parser.html#a24cecaf6c3836a5036603dc9b079e4f9">parseStream</a> (std::istream &inpStream, bool comments_allowed=false, bool full_read=true) throw (Exception)</td></tr>
<tr class="memdesc:a24cecaf6c3836a5036603dc9b079e4f9"><td class="mdescLeft"> </td><td class="mdescRight">Parses JSON data from a stream. <a href="#a24cecaf6c3836a5036603dc9b079e4f9">More...</a><br /></td></tr>
<tr class="separator:a24cecaf6c3836a5036603dc9b079e4f9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>JSON Data <a class="el" href="classJAULA_1_1Parser.html" title="JSON Data Parser. ">Parser</a>. </p>
<dl class="section user"><dt></dt><dd>This class implements the JSON parser itself as specified by RFC 4627.</dd></dl>
<dl class="section author"><dt>Author</dt><dd>Kombo Morongo <a href="#" onclick="location.href='mai'+'lto:'+'mor'+'on'+'go6'+'66'+'@gm'+'ai'+'l.c'+'om'; return false;">moron<span style="display: none;">.nosp@m.</span>go66<span style="display: none;">.nosp@m.</span>6@gma<span style="display: none;">.nosp@m.</span>il.c<span style="display: none;">.nosp@m.</span>om</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a4be52fa703c14a711aa34ef32080f70e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4be52fa703c14a711aa34ef32080f70e">◆ </a></span>Parser()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">JAULA::Parser::Parser </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a id="ad8bde22e6943713306cf7cda7231e9bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8bde22e6943713306cf7cda7231e9bb">◆ </a></span>~Parser()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">JAULA::Parser::~Parser </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a24cecaf6c3836a5036603dc9b079e4f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24cecaf6c3836a5036603dc9b079e4f9">◆ </a></span>parseStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classJAULA_1_1Value__Complex.html">Value_Complex</a> * JAULA::Parser::parseStream </td>
<td>(</td>
<td class="paramtype">std::istream & </td>
<td class="paramname"><em>inpStream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>comments_allowed</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>full_read</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
<tr>
<td align="right">throw </td><td>(</td><td colspan="2"><a class="el" href="classJAULA_1_1Exception.html">Exception</a></td>
</tr>
<tr>
<td align="right"></td><td>)</td><td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Parses JSON data from a stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">inpStream</td><td>stream from where to read the data to parse.</td></tr>
<tr><td class="paramname">comments_allowed</td><td>flag that if it is true means that the input can contain comments that begin with the hash '#' symbol and ends with eoln (as in bash). If it is false, it means that no comments are allowed in the input and if present will be considered as a syntax error.</td></tr>
<tr><td class="paramname">full_read</td><td>flag that if it is true means that the parser must analyze the input stream until the end of file is although it already had got a full array or object from it. In this situation, as JSON specification expects just only one array or object per input, any further data that is not a space for the syntax (or a comment if comments are allowed) will launch a syntax error exception.</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt></dt><dd>If this flag is false, the parser will stop once a full array or object is taken from the input and, on exit, the stream will point to the start of the remaining data.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to memory taken from the heap containing a complex value (array or object) with all the data from the stream parsed on individual / nested items.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classJAULA_1_1Exception.html" title="Base class for error handling exceptions. ">Exception</a></td><td>An exception will be thrown as soon as a lexical or syntax error is found analyzing the stream. The result of printing the exception through a stream is a human readable text explaining the error found and an approximation of the error line where occurred.</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Description</dt><dd>This method is the entry point for the JSON parser.</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>As this method returns a pointer to memory from the heap, it is up to the user to free it when it is no longer needed in order to avoid leaks. </dd></dl>
<p class="reference">References <a class="el" href="classJAULA_1_1Exception.html#a5a8a30a5c52dbda332d7a6cee79a7476">JAULA::Exception::addOrigin()</a>, <a class="el" href="classJAULA_1_1Parser_1_1Value__Parser.html#a5a2a1f978b794f68ce0bbeb7e2e695ee">JAULA::Parser::Value_Parser::parseValue()</a>, and <a class="el" href="classJAULA_1_1Lexan.html#a7d5716c5d9aa608450c7e071949797bc">JAULA::Lexan::yylex()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="jaula__parse_8h_source.html">jaula_parse.h</a></li>
<li>jaula_parse.cc</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- svn info -->
<!-- $Author: morongo $ -->
<!-- $Date: 2009-01-11 17:17:03 +0100 (dom, 11 ene 2009) $ -->
<!-- $HeadURL: https://jaula.svn.sourceforge.net/svnroot/jaula/tags/jaula-1.4.0/doc/api_footer.html $ -->
<!-- $Revision: 45 $ -->
<div>
<p><hr/></p>
<p style="text-align : center;"><a
href="http://morongo.homelinux.net/jaula/docs"
target="_parent"
title="JAULA Project Documentation Page">Back to
<acronym title="JSON Analysis User Library Acronym">JAULA</acronym>
Project Documentation Page</a>.</p>
<p style="text-align : center;"><a
href="http://morongo.homelinux.net/jaula"
target="_parent"
title="JAULA Project Home Page">Go to
<acronym title="JSON Analysis User Library Acronym">JAULA</acronym>
Project Home Page</a>.</p>
</div>
<div>
<p><hr/></p>
<p>Copyright (c) 2007, 2008, 2009 <a href="http://sourceforge.net/users/morongo"
target="_parent" title="Morongo at SourceForge">Kombo Morongo</a>.</p>
<p>Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled <a
href="main.html" target="_parent"
>"GNU Free Documentation License"</a>.</p>
<!--<div style="float : left; width : 250px; margin-right : 5px;">-->
<div style="float : left;">
<address style="text-align: center;"><p><small>API Reference Generated for jaula by
</small></p></address>
<div style="width : 100px; margin-left: auto; margin-right : auto;">
<a href="http://www.doxygen.org/index.html" target="_parent"
><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>
</div>
</div>
<!--<div style="float : right; width : 150px; margin-left : 5px;">-->
<div style="float : right;">
<address style="text-align: center;"><p><small>jaula project hosted by
</small></p></address>
<div style="width: 125px; margin-left: auto; margin-right : auto;">
<a href="http://sourceforge.net" target="_parent"
>SourceForge.net</a>
</div>
</div>
</div>
<!-- $Id: api_footer.html 45 2009-01-11 16:17:03Z morongo $ -->
|