171 lines
13 KiB
HTML
171 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
|
|
<title>ejson Library</title>
|
|
<link rel="stylesheet" href="base.css">
|
|
<link rel="stylesheet" href="menu.css">
|
|
</head>
|
|
<body>
|
|
<div class="navbar navbar-fixed-top">
|
|
<div class="container">
|
|
<h1><a href="index.html">ejson library</a></h1>
|
|
<h4><a href="http://github.com/heeroyui/ejson/"> [ sources ]</a></h4>
|
|
<h3>API:</h3> <div id="menu">
|
|
<ul class="niveau1">
|
|
<li><a href="namespace_ejson.html">ejson</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<h3>Tutorials:</h3><div id="menu">
|
|
<ul class="niveau1"><li><a href="tutorial_000_Build.html">Build</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_001_Read.html">Read</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_002_Write.html">Write</a></li>
|
|
</ul></div>
|
|
<br/><h3>Associate libraries:</h3><div id="menu">
|
|
<ul class="niveau1"><li><a href="../ewol/index.html">ewol</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../egami/index.html">egami</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../ege/index.html">ege</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../esvg/index.html">esvg</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../etk/index.html">etk</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../exml/index.html">exml</a></li>
|
|
</ul></div>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
</div>
|
|
</div>
|
|
<div class="container" id="content">
|
|
<h1>class: ejson::Document</h1><hr/><h2>Description:</h2>
|
|
|
|
<br/><br/>
|
|
<h2>Constructor and Destructor:</h2>
|
|
<pre>
|
|
+ <a class="code-function" href="#3811">Document</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-function" href="#3812">~Document</a> ();<br/></pre>
|
|
<br/>
|
|
<h2>Synopsis:</h2>
|
|
<pre>
|
|
+ <span class="code-type" >bool</span> <a class="code-function" href="#3813">parse</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_data</span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#3815">generate</a> (<a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_data</span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#3817">load</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_file</span>);<br/>+ <span class="code-type" >bool</span> <a class="code-function" href="#3819">store</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_file</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3821">display</a> ();<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3826">displayErrorWhenDetected</a> ();<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3827">notDisplayErrorWhenDetected</a> ();<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3828">createError</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_data</span>,<br/> size_t <span class="code-argument">_pos</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="class_ejson__filePos.html">ejson::filePos</a> & <span class="code-argument">_filePos</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_comment</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#3833">displayError</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#3834">iParse</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_data</span>,<br/> size_t & <span class="code-argument">_pos</span>,<br/> <a class="code-type" href="class_ejson__filePos.html">ejson::filePos</a> & <span class="code-argument">_filePos</span>,<br/> <a class="code-type" href="class_ejson__Document.html">ejson::Document</a> & <span class="code-argument">_doc</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#3839">iGenerate</a> (<a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_data</span>,<br/> size_t <span class="code-argument">_indent</span>) <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
<br/>
|
|
<h2>Object Hierarchy:<h2>
|
|
<pre>
|
|
+<a href="class_ejson__Value.html">ejson::Value</a><br/> +--> +<a href="class_ejson__Object.html">ejson::Object</a><br/> +--> ejson::Document<br/></pre>
|
|
<h2>Detail:</h2>
|
|
<a id="3811"/><a id="3812"/><h3>Document</h3><pre>
|
|
+ <span class="code-function">Document</span> ();<br/></pre>
|
|
Constructor<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3813"/><h3>~Document</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~Document</span> ();<br/></pre>
|
|
Destructor<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3815"/><h3>parse</h3><pre>
|
|
+ <span class="code-type" >bool</span> <span class="code-function">parse</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_data</span>);<br/></pre>
|
|
parse a string that contain an XML<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_data</span> </td><td> Data to parse</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>false : An error occured<br/>true : Parsing is OK</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="3817"/><h3>generate</h3><pre>
|
|
+ <span class="code-type" >bool</span> <span class="code-function">generate</span> (<a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_data</span>);<br/></pre>
|
|
generate a string that contain the created XML<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [output]:</b></td><td><span class="code-argument">_data</span> </td><td> Data where the xml is stored</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>false : An error occured<br/>true : Parsing is OK</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="3819"/><h3>load</h3><pre>
|
|
+ <span class="code-type" >bool</span> <span class="code-function">load</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_file</span>);<br/></pre>
|
|
Load the file that might contain the xml<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_file</span> </td><td> Filename of the xml (compatible with etk FSNode naming)</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>false : An error occured<br/>true : Parsing is OK</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="3821"/><h3>store</h3><pre>
|
|
+ <span class="code-type" >bool</span> <span class="code-function">store</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_file</span>);<br/></pre>
|
|
Store the Xml in the file<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_file</span> </td><td> Filename of the xml (compatible with etk FSNode naming)</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>false : An error occured<br/>true : Parsing is OK</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="3826"/><h3>display</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">display</span> ();<br/></pre>
|
|
Display the Document on console<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3827"/><h3>displayErrorWhenDetected</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">displayErrorWhenDetected</span> ();<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3828"/><h3>notDisplayErrorWhenDetected</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">notDisplayErrorWhenDetected</span> ();<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3833"/><h3>createError</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">createError</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_data</span>,<br/> size_t <span class="code-argument">_pos</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="class_ejson__filePos.html">ejson::filePos</a> & <span class="code-argument">_filePos</span>,<br/> <span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_comment</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3834"/><h3>displayError</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">displayError</span> ();<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="3839"/><h3>iParse</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">iParse</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_data</span>,<br/> size_t & <span class="code-argument">_pos</span>,<br/> <a class="code-type" href="class_ejson__filePos.html">ejson::filePos</a> & <span class="code-argument">_filePos</span>,<br/> <a class="code-type" href="class_ejson__Document.html">ejson::Document</a> & <span class="code-argument">_doc</span>);<br/></pre>
|
|
parse the Current node [pure VIRUAL]<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_data</span> </td><td> data string to parse.</td></tr>
|
|
<td><b>Parameter [input] [output]:</b></td><td><span class="code-argument">_pos</span> </td><td> position in the string to start parse, return the position end of parsing.</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_caseSensitive</span> </td><td> Request a parsion of element that is not case sensitive (all element is in low case)</td></tr>
|
|
<td><b>Parameter [input] [output]:</b></td><td><span class="code-argument">file</span> </td><td> parsing position (line x col x)</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>false if an error occured.</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<h3>iGenerate</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">iGenerate</span> (<a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_data</span>,<br/> size_t <span class="code-argument">_indent</span>) <span class="code-storage-keyword">const</span>;<br/></pre>
|
|
generate a string with the tree of the xml<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input] [output]:</b></td><td><span class="code-argument">_data</span> </td><td> string where to add the elements</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">current</span> </td><td> indentation of the file</td></tr>
|
|
<tr><td><b>Return: </b></td><td></td><td>false if an error occured.</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
</div>
|
|
<script>
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
|
ga('create', 'UA-46753803-1', 'heeroyui.github.io');
|
|
ga('send', 'pageview');
|
|
</script>
|
|
</body>
|
|
</html>
|