/usr/share/doc/jaula/html/classJAULA_1_1Lexan.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 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 | <!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::Lexan 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_1Lexan.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle">
<div class="title">JAULA::Lexan Class Reference<div class="ingroups"><a class="el" href="group__jaula__lex.html">JAULA: JSON lexical analysis</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Lexical Analysis implementation.
<a href="classJAULA_1_1Lexan.html#details">More...</a></p>
<p><code>#include <<a class="el" href="jaula__lexan_8h_source.html">jaula_lexan.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for JAULA::Lexan:</div>
<div class="dyncontent">
<div class="center">
<img src="classJAULA_1_1Lexan.png" usemap="#JAULA::Lexan_map" alt=""/>
<map id="JAULA::Lexan_map" name="JAULA::Lexan_map">
</map>
</div></div>
<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:ab1caba888b3d145b7097e487013ebd19"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classJAULA_1_1Lexan__Error.html">Lexan_Error</a> const * </td><td class="memItemRight" valign="bottom"><a class="el" href="classJAULA_1_1Lexan.html#ab1caba888b3d145b7097e487013ebd19">getErrorReport</a> (void) const</td></tr>
<tr class="memdesc:ab1caba888b3d145b7097e487013ebd19"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves details for the last error detected. <a href="#ab1caba888b3d145b7097e487013ebd19">More...</a><br /></td></tr>
<tr class="separator:ab1caba888b3d145b7097e487013ebd19"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a29268ced7bd9569fd5744065f9045155"><td class="memItemLeft" align="right" valign="top">std::string const & </td><td class="memItemRight" valign="bottom"><a class="el" href="classJAULA_1_1Lexan.html#a29268ced7bd9569fd5744065f9045155">getTokenData</a> (void) const</td></tr>
<tr class="memdesc:a29268ced7bd9569fd5744065f9045155"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves last token associated data. <a href="#a29268ced7bd9569fd5744065f9045155">More...</a><br /></td></tr>
<tr class="separator:a29268ced7bd9569fd5744065f9045155"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2233f9051083cbd79ce4e052e235310f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classJAULA_1_1Lexan.html#a2233f9051083cbd79ce4e052e235310f">Lexan</a> (std::istream &in_stream, bool comments_allowed=false)</td></tr>
<tr class="memdesc:a2233f9051083cbd79ce4e052e235310f"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a2233f9051083cbd79ce4e052e235310f">More...</a><br /></td></tr>
<tr class="separator:a2233f9051083cbd79ce4e052e235310f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af199e41cdb2ef2fd75df4c3e95ae1e26"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classJAULA_1_1Lexan.html#af199e41cdb2ef2fd75df4c3e95ae1e26">LexerError</a> (const char *detail)</td></tr>
<tr class="memdesc:af199e41cdb2ef2fd75df4c3e95ae1e26"><td class="mdescLeft"> </td><td class="mdescRight">Error report. <a href="#af199e41cdb2ef2fd75df4c3e95ae1e26">More...</a><br /></td></tr>
<tr class="separator:af199e41cdb2ef2fd75df4c3e95ae1e26"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7d5716c5d9aa608450c7e071949797bc"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classJAULA_1_1Lexan.html#a7d5716c5d9aa608450c7e071949797bc">yylex</a> ()</td></tr>
<tr class="memdesc:a7d5716c5d9aa608450c7e071949797bc"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves tokens from the input. <a href="#a7d5716c5d9aa608450c7e071949797bc">More...</a><br /></td></tr>
<tr class="separator:a7d5716c5d9aa608450c7e071949797bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1433c372f691a6e094daa2882b54e7c"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classJAULA_1_1Lexan.html#ad1433c372f691a6e094daa2882b54e7c">~Lexan</a> ()</td></tr>
<tr class="memdesc:ad1433c372f691a6e094daa2882b54e7c"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ad1433c372f691a6e094daa2882b54e7c">More...</a><br /></td></tr>
<tr class="separator:ad1433c372f691a6e094daa2882b54e7c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ab6fd9d2bcbe87877adc80fe312197565"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classJAULA_1_1Lexan.html#ab6fd9d2bcbe87877adc80fe312197565">commented</a></td></tr>
<tr class="memdesc:ab6fd9d2bcbe87877adc80fe312197565"><td class="mdescLeft"> </td><td class="mdescRight">Flag for extending language to accept # comments. <a href="#ab6fd9d2bcbe87877adc80fe312197565">More...</a><br /></td></tr>
<tr class="separator:ab6fd9d2bcbe87877adc80fe312197565"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a67e8a2258884aee7a5fef0374214a217"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classJAULA_1_1Lexan__Error.html">Lexan_Error</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classJAULA_1_1Lexan.html#a67e8a2258884aee7a5fef0374214a217">pErrorReport</a></td></tr>
<tr class="memdesc:a67e8a2258884aee7a5fef0374214a217"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the last exception detected. <a href="#a67e8a2258884aee7a5fef0374214a217">More...</a><br /></td></tr>
<tr class="separator:a67e8a2258884aee7a5fef0374214a217"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a394a69dc50b5062bfea1b569f6263475"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classJAULA_1_1Lexan.html#a394a69dc50b5062bfea1b569f6263475">tokenData</a></td></tr>
<tr class="memdesc:a394a69dc50b5062bfea1b569f6263475"><td class="mdescLeft"> </td><td class="mdescRight">Container for the token associated data. <a href="#a394a69dc50b5062bfea1b569f6263475">More...</a><br /></td></tr>
<tr class="separator:a394a69dc50b5062bfea1b569f6263475"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Lexical Analysis implementation. </p>
<dl class="section user"><dt></dt><dd>This class implements the lexical analysis for JSON 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="a2233f9051083cbd79ce4e052e235310f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2233f9051083cbd79ce4e052e235310f">◆ </a></span>Lexan()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">JAULA::Lexan::Lexan </td>
<td>(</td>
<td class="paramtype">std::istream & </td>
<td class="paramname"><em>in_stream</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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">in_stream</td><td>stream for the input data to analyze</td></tr>
<tr><td class="paramname">comments_allowed</td><td>flag to extend basic format and allow for hash symbol '#' starting comments in input.</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Description</dt><dd>Creates a lexical analysis instance for the specified input stream. </dd></dl>
</div>
</div>
<a id="ad1433c372f691a6e094daa2882b54e7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1433c372f691a6e094daa2882b54e7c">◆ </a></span>~Lexan()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual JAULA::Lexan::~Lexan </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab1caba888b3d145b7097e487013ebd19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1caba888b3d145b7097e487013ebd19">◆ </a></span>getErrorReport()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classJAULA_1_1Lexan__Error.html">Lexan_Error</a> const* JAULA::Lexan::getErrorReport </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves details for the last error detected. </p>
<dl class="section return"><dt>Returns</dt><dd>a pointer to an instance containing the details for the last error detected during the lexical analysis process or a null pointer in case no error have ocurred during the lexical analysis so far. </dd></dl>
</div>
</div>
<a id="a29268ced7bd9569fd5744065f9045155"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29268ced7bd9569fd5744065f9045155">◆ </a></span>getTokenData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string const& JAULA::Lexan::getTokenData </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves last token associated data. </p>
<dl class="section return"><dt>Returns</dt><dd>the data associated for the last token returned from <a class="el" href="classJAULA_1_1Lexan.html#a7d5716c5d9aa608450c7e071949797bc" title="Retrieves tokens from the input. ">yylex()</a> in case there is such kind of data (token corresponds to a property name or a single value) or undefined otherwise. </dd></dl>
</div>
</div>
<a id="af199e41cdb2ef2fd75df4c3e95ae1e26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af199e41cdb2ef2fd75df4c3e95ae1e26">◆ </a></span>LexerError()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void JAULA::Lexan::LexerError </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>detail</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Error report. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">detail</td><td>Text for the error received</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Description</dt><dd>This method is a callback used by the analysis routines to indicate an error condition.</dd></dl>
<dl class="section user"><dt></dt><dd>Its current implementation consists of generating the exception instance to be retrieved by <a class="el" href="classJAULA_1_1Lexan.html#ab1caba888b3d145b7097e487013ebd19" title="Retrieves details for the last error detected. ">getErrorReport()</a>. </dd></dl>
</div>
</div>
<a id="a7d5716c5d9aa608450c7e071949797bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7d5716c5d9aa608450c7e071949797bc">◆ </a></span>yylex()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int JAULA::Lexan::yylex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves tokens from the input. </p>
<dl class="section return"><dt>Returns</dt><dd>the code for a token read or 0 if the end of data has been reached. </dd></dl>
<p class="reference">Referenced by <a class="el" href="classJAULA_1_1Parser.html#a24cecaf6c3836a5036603dc9b079e4f9">JAULA::Parser::parseStream()</a>.</p>
</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a id="ab6fd9d2bcbe87877adc80fe312197565"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6fd9d2bcbe87877adc80fe312197565">◆ </a></span>commented</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool JAULA::Lexan::commented</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Flag for extending language to accept # comments. </p>
</div>
</div>
<a id="a67e8a2258884aee7a5fef0374214a217"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67e8a2258884aee7a5fef0374214a217">◆ </a></span>pErrorReport</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_1Lexan__Error.html">Lexan_Error</a>* JAULA::Lexan::pErrorReport</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pointer to the last exception detected. </p>
</div>
</div>
<a id="a394a69dc50b5062bfea1b569f6263475"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a394a69dc50b5062bfea1b569f6263475">◆ </a></span>tokenData</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string JAULA::Lexan::tokenData</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Container for the token associated data. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="jaula__lexan_8h_source.html">jaula_lexan.h</a></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 $ -->
|