etk/etk__RegExpNode.html

184 lines
8.7 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>etk Library</title>
<link rel="stylesheet" href="base.css">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="container">
<h1>etk Library</h1>
<li>etk</li>
<ul>
<li><a href="etk__Archive.html">Archive</a></li>
<li><a href="etk__Archive__Content.html">Archive::Content</a></li>
<li><a href="etk__BaseNoise.html">BaseNoise</a></li>
<li><a href="etk__Buffer.html">Buffer</a></li>
<li><a href="etk__CCout.html">CCout</a></li>
<li><a href="etk__CEndl.html">CEndl</a></li>
<li><a href="etk__CStart.html">CStart</a></li>
<li><a href="etk__Color.html">Color</a></li>
<li><a href="etk__FSNode.html">FSNode</a></li>
<li><a href="etk__FSNodeRight.html">FSNodeRight</a></li>
<li><a href="etk__Hash.html">Hash</a></li>
<li><a href="etk__HashData.html">HashData</a></li>
<li><a href="etk__Matrix4.html">Matrix4</a></li>
<li><a href="etk__MessageFifo.html">MessageFifo</a></li>
<li><a href="etk__Mutex.html">Mutex</a></li>
<li><a href="etk__Noise.html">Noise</a></li>
<li><a href="etk__Plane.html">Plane</a></li>
<li><a href="etk__RegExp.html">RegExp</a></li>
<li><a href="etk__RegExpNode.html">RegExpNode</a></li>
<li><a href="etk__RegExpNodeBracket.html">RegExpNodeBracket</a></li>
<li><a href="etk__RegExpNodeDigit.html">RegExpNodeDigit</a></li>
<li><a href="etk__RegExpNodeDigitNot.html">RegExpNodeDigitNot</a></li>
<li><a href="etk__RegExpNodeDot.html">RegExpNodeDot</a></li>
<li><a href="etk__RegExpNodeEOL.html">RegExpNodeEOL</a></li>
<li><a href="etk__RegExpNodeLetter.html">RegExpNodeLetter</a></li>
<li><a href="etk__RegExpNodeLetterNot.html">RegExpNodeLetterNot</a></li>
<li><a href="etk__RegExpNodePThese.html">RegExpNodePThese</a></li>
<li><a href="etk__RegExpNodePTheseElem.html">RegExpNodePTheseElem</a></li>
<li><a href="etk__RegExpNodeSOL.html">RegExpNodeSOL</a></li>
<li><a href="etk__RegExpNodeValue.html">RegExpNodeValue</a></li>
<li><a href="etk__RegExpNodeWhiteSpace.html">RegExpNodeWhiteSpace</a></li>
<li><a href="etk__RegExpNodeWhiteSpaceNot.html">RegExpNodeWhiteSpaceNot</a></li>
<li><a href="etk__RegExpNodeWordChar.html">RegExpNodeWordChar</a></li>
<li><a href="etk__RegExpNodeWordCharNot.html">RegExpNodeWordCharNot</a></li>
<li><a href="etk__Semaphore.html">Semaphore</a></li>
<li><a href="etk__UChar.html">UChar</a></li>
<li><a href="etk__Vector2D.html">Vector2D</a></li>
<li><a href="etk__Vector3D.html">Vector3D</a></li>
<li><a href="etk__Vector4D.html">Vector4D</a></li>
<li><a href="etk__archive__Zip.html">archive::Zip</a></li>
<li><a href="etk__elementPos_ts.html">elementPos_ts</a></li>
</ul>
<li><a href="etk__FSNType.html">FSNType</a></li>
<li><a href="etk__logLevel.html">logLevel</a></li>
<li><a href="etk__regExpPrivateSection.html">regExpPrivateSection</a></li>
<li><a href="etk__seekNode.html">seekNode</a></li>
<li><a href="etk__typeNode.html">typeNode</a></li>
</ul>
<li>unicode</li>
<ul>
<li><a href="unicode__charset.html">charset</a></li>
</ul>
</div>
</div>
<div class="container" id="content">
<h1>Class: etk::RegExpNode</h1>
<br/>
<h2>Synopsis:</h2>
<pre>
+ <a class="code-function" href="#RegExpNode">RegExpNode</a> (<span class="code-type">void</span>);<br>+ ~<a class="code-function" href="#RegExpNode">RegExpNode</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">int32_t</span> <a class="code-function" href="#generate">generate</a> (<span class="code-storage-keyword">const</span> std::vector<<span class="code-type">char32_t</span>> & <span class="code-argument">_data</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#parse">parse</a> (<span class="code-storage-keyword">const</span> CLASS_TYPE & <span class="code-argument">_data</span>,<br/> <span class="code-type">int64_t</span> <span class="code-argument">_currentPos</span>,<br/> <span class="code-type">int64_t</span> <span class="code-argument">_lenMax</span>,<br/> <span class="code-type">int64_t</span> & <span class="code-argument">_findLen</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#display">display</a> (<span class="code-type">uint32_t</span> <span class="code-argument">_level</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setMult">setMult</a> (<span class="code-type">uint32_t</span> <span class="code-argument">_min</span>,<br/> <span class="code-type">uint32_t</span> <span class="code-argument">_max</span>);<br># <span class="code-type">uint32_t</span> <a class="code-function" href="#getMultMin">getMultMin</a> (<span class="code-type">void</span>);<br># <span class="code-type">uint32_t</span> <a class="code-function" href="#getMultMax">getMultMax</a> (<span class="code-type">void</span>);<br></pre>
<h2>Description:</h2>
/**
* @brief Node Elements for every-one
*/<h2>Detail:<h2>
<h3>etk::<a id="RegExpNode">RegExpNode</a> ()</h3>
<pre>
<span class="code-function">RegExpNode</span>(<span class="code-type">void</span>);</pre>
<br/>
Constructor
<br/><br/>
<hr/>
<h3>etk::~<a id="RegExpNode">RegExpNode</a> ()</h3>
<pre>
~<span class="code-function">RegExpNode</span>(<span class="code-type">void</span>);</pre>
<br/>
Destructor
<br/><br/>
<hr/>
<h3><a id="generate">generate</a> ()</h3>
<pre>
<span class="code-type">int32_t</span> <span class="code-function">generate</span>(<span class="code-storage-keyword">const</span> std::vector<<span class="code-type">char32_t</span>> & <span class="code-argument">_data</span>);</pre>
<br/>
Generate the regular expression with the current "converted string"
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_data</span> Property of the regexp
<br/><b>Return:</b> the number of element used
<br/></ul>
<br/>
<hr/>
<h3><a id="parse">parse</a> ()</h3>
<pre>
<span class="code-type">bool</span> <span class="code-function">parse</span>(<span class="code-storage-keyword">const</span> CLASS_TYPE & <span class="code-argument">_data</span>,
<span class="code-type">int64_t</span> <span class="code-argument">_currentPos</span>,
<span class="code-type">int64_t</span> <span class="code-argument">_lenMax</span>,
<span class="code-type">int64_t</span> & <span class="code-argument">_findLen</span>);</pre>
<br/>
Parse the current node
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_data</span> Data to parse (start pointer / or class that have access with operator[] )
<br/><b>Parameter [input]:</b> <span class="code-argument">_currentPos</span> Current parsing position.
<br/><b>Parameter [input]:</b> <span class="code-argument">_lenMax</span> Maximum position to parse the data (can be not hte end of the data due to the fact sometime we want to parse sub section).
<br/><b>Parameter [input]:</b> <span class="code-argument">_findLen</span> number of element parssed
<br/><b>Return:</b> true : Find something
<br/><b>Return:</b> false : Find nothing
<br/></ul>
<br/>
<hr/>
<h3><a id="display">display</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">display</span>(<span class="code-type">uint32_t</span> <span class="code-argument">_level</span>);</pre>
<br/>
Display the current node properties
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">level</span> of the node
<br/></ul>
<br/>
<hr/>
<h3><a id="setMult">setMult</a> ()</h3>
<pre>
<span class="code-type">void</span> <span class="code-function">setMult</span>(<span class="code-type">uint32_t</span> <span class="code-argument">_min</span>,
<span class="code-type">uint32_t</span> <span class="code-argument">_max</span>);</pre>
<br/>
Set the multiplicity of this Node.
<br/><ul>
<b>Parameter [input]:</b> <span class="code-argument">_min</span> The minimum appear time.
<br/><b>Parameter [input]:</b> <span class="code-argument">_max</span> The maximum appear time.
<br/></ul>
<br/>
<hr/>
<h3><a id="getMultMin">getMultMin</a> ()</h3>
<pre>
<span class="code-type">uint32_t</span> <span class="code-function">getMultMin</span>(<span class="code-type">void</span>);</pre>
<br/>
Get the minimum multiplicity.
<br/><ul>
<b>Return:</b> The minimum appear availlable.
<br/></ul>
<br/>
<hr/>
<h3><a id="getMultMax">getMultMax</a> ()</h3>
<pre>
<span class="code-type">uint32_t</span> <span class="code-function">getMultMax</span>(<span class="code-type">void</span>);</pre>
<br/>
Get the maximum multiplicity.
<br/><ul>
<b>Return:</b> The maximum appear availlable.
<br/></ul>
<br/>
<hr/>
</div>
</body>
</html>