257 lines
14 KiB
HTML
257 lines
14 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::RegExp</h1>
|
|
<br/>
|
|
<h2>Synopsis:</h2>
|
|
<pre>
|
|
+ <a class="code-function" href="#RegExp">RegExp</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/u32string/" class="code-type">std::u32string</a> & <span class="code-argument">_exp</span>);<br>+ <a class="code-function" href="#RegExp">RegExp</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_exp</span>);<br>+ ~<a class="code-function" href="#RegExp">RegExp</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setRegExp">setRegExp</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_exp</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#setRegExp">setRegExp</a> (<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/u32string/" class="code-type">std::u32string</a> & <span class="code-argument">_regexp</span>);<br>+ <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> <a class="code-function" href="#getRegExp">getRegExp</a> (<span class="code-type">void</span>);<br>+ <span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/u32string/" class="code-type">std::u32string</a> & <a class="code-function" href="#getURegExp">getURegExp</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#getStatus">getStatus</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#process">process</a> (<span class="code-storage-keyword">const</span> CLASS_TYPE & <span class="code-argument">_SearchIn</span>,<br/> <span class="code-type">int64_t</span> <span class="code-argument">_startPos</span>,<br/> <span class="code-type">int64_t</span> <span class="code-argument">_endPos</span>,<br/> <span class="code-type">char32_t</span> <span class="code-argument">_escapeChar</span>);<br>+ <span class="code-type">bool</span> <a class="code-function" href="#processOneElement">processOneElement</a> (<span class="code-storage-keyword">const</span> CLASS_TYPE & <span class="code-argument">_SearchIn</span>,<br/> <span class="code-type">int64_t</span> <span class="code-argument">_startPos</span>,<br/> <span class="code-type">int64_t</span> <span class="code-argument">_endPos</span>,<br/> <span class="code-type">char32_t</span> <span class="code-argument">_escapeChar</span>);<br>+ <span class="code-type">int64_t</span> <a class="code-function" href="#start">start</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">int64_t</span> <a class="code-function" href="#stop">stop</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#display">display</a> (<span class="code-type">void</span>);<br>+ <span class="code-type">void</span> <a class="code-function" href="#drawColoredRegEx">drawColoredRegEx</a> (<span class="code-type">void</span>);<br>- <span class="code-type">bool</span> <a class="code-function" href="#checkGoodPosition">checkGoodPosition</a> (<span class="code-storage-keyword">const</span> std::vector<<span class="code-type">char32_t</span>> & <span class="code-argument">_tmpExp</span>,<br/> <span class="code-type">int64_t</span> & <span class="code-argument">_pos</span>);<br>- <span class="code-type">bool</span> <a class="code-function" href="#checkGoodPosition">checkGoodPosition</a> (<span class="code-storage-keyword">const</span> std::vector<<span class="code-type">char32_t</span>> & <span class="code-argument">_tmpExp</span>);<br></pre>
|
|
|
|
|
|
<h2>Detail:<h2>
|
|
<h3>etk::<a id="RegExp">RegExp</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-function">RegExp</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/u32string/" class="code-type">std::u32string</a> & <span class="code-argument">_exp</span>);</pre>
|
|
<br/>
|
|
Constructor
|
|
<br/><ul>
|
|
<b>Parameter [input] [output]:</b> <span class="code-argument">_exp</span> Regular expression to parse
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3>etk::<a id="RegExp">RegExp</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-function">RegExp</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_exp</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3>etk::~<a id="RegExp">RegExp</a> ()</h3>
|
|
|
|
<pre>
|
|
~<span class="code-function">RegExp</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Destructor
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setRegExp">setRegExp</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setRegExp</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> & <span class="code-argument">_exp</span>);</pre>
|
|
<br/>
|
|
Set a new regular expression matching
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_exp</span> the new expression to search
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="setRegExp">setRegExp</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">setRegExp</span>(<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/u32string/" class="code-type">std::u32string</a> & <span class="code-argument">_regexp</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getRegExp">getRegExp</a> ()</h3>
|
|
|
|
<pre>
|
|
<a href="http://www.cplusplus.com/reference/string/string/" class="code-type">std::string</a> <span class="code-function">getRegExp</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Get the regular expression string
|
|
<br/><ul>
|
|
<b>Return:</b> the string representing the RegExp
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getURegExp">getURegExp</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-storage-keyword">const</span> <a href="http://www.cplusplus.com/reference/string/u32string/" class="code-type">std::u32string</a> & <span class="code-function">getURegExp</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="getStatus">getStatus</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">getStatus</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Get the status if the regular expression parsing
|
|
<br/><ul>
|
|
<b>Return:</b> true : the regExp is correctly parsed
|
|
<br/><b>Return:</b> false : an error occcured (check log ...)
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="process">process</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">process</span>(<span class="code-storage-keyword">const</span> CLASS_TYPE & <span class="code-argument">_SearchIn</span>,
|
|
<span class="code-type">int64_t</span> <span class="code-argument">_startPos</span>,
|
|
<span class="code-type">int64_t</span> <span class="code-argument">_endPos</span>,
|
|
<span class="code-type">char32_t</span> <span class="code-argument">_escapeChar</span>);</pre>
|
|
<br/>
|
|
process the seach of the regular expression in a defined class type
|
|
<br/><ul>
|
|
<b>Parameter [input]:</b> <span class="code-argument">_SearchIn</span> table of element to seach in
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_startPos</span> start position to search
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_endPos</span> end position to search
|
|
<br/><b>Parameter [input]:</b> <span class="code-argument">_escapeChar</span> special char that remove other char real type
|
|
<br/><b>Return:</b> true : find something, false otherwise
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="processOneElement">processOneElement</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">processOneElement</span>(<span class="code-storage-keyword">const</span> CLASS_TYPE & <span class="code-argument">_SearchIn</span>,
|
|
<span class="code-type">int64_t</span> <span class="code-argument">_startPos</span>,
|
|
<span class="code-type">int64_t</span> <span class="code-argument">_endPos</span>,
|
|
<span class="code-type">char32_t</span> <span class="code-argument">_escapeChar</span>);</pre>
|
|
<br/>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="start">start</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">int64_t</span> <span class="code-function">start</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Get the expression start position detected
|
|
<br/><ul>
|
|
<b>Return:</b> position of the start regExp
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="stop">stop</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">int64_t</span> <span class="code-function">stop</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Get the expression stop position detected
|
|
<br/><ul>
|
|
<b>Return:</b> position of the stop regExp
|
|
<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">void</span>);</pre>
|
|
<br/>
|
|
Display the reg Exp
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="drawColoredRegEx">drawColoredRegEx</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">void</span> <span class="code-function">drawColoredRegEx</span>(<span class="code-type">void</span>);</pre>
|
|
<br/>
|
|
Just display the regExp in color ...
|
|
<br/><br/>
|
|
|
|
<hr/>
|
|
<h3><a id="checkGoodPosition">checkGoodPosition</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">checkGoodPosition</span>(<span class="code-storage-keyword">const</span> std::vector<<span class="code-type">char32_t</span>> & <span class="code-argument">_tmpExp</span>,
|
|
<span class="code-type">int64_t</span> & <span class="code-argument">_pos</span>);</pre>
|
|
<br/>
|
|
<ul>
|
|
<b>Parameter [input] [output]:</b> <span class="code-argument"></span>
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
<h3><a id="checkGoodPosition">checkGoodPosition</a> ()</h3>
|
|
|
|
<pre>
|
|
<span class="code-type">bool</span> <span class="code-function">checkGoodPosition</span>(<span class="code-storage-keyword">const</span> std::vector<<span class="code-type">char32_t</span>> & <span class="code-argument">_tmpExp</span>);</pre>
|
|
<br/>
|
|
<ul>
|
|
<b>Parameter [input] [output]:</b> <span class="code-argument"></span>
|
|
<br/></ul>
|
|
<br/>
|
|
|
|
<hr/>
|
|
</div>
|
|
</body>
|
|
</html>
|