<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>The Parle\RLexer class</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="parle-lexer.reset.html">Parle\Lexer::reset</a></div> <div class="next" style="text-align: right; float: right;"><a href="parle-rlexer.advance.html">Parle\RLexer::advance</a></div> <div class="up"><a href="book.parle.html">Parle</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="class.parle-rlexer" class="reference"> <h1 class="title">The Parle\RLexer class</h1> <div class="partintro"><p class="verinfo">(PECL parle >= 0.5.1)</p> <div class="section" id="parle-rlexer.intro"> <h2 class="title">Introduction</h2> <p class="para"> Multistate lexer class. Lexemes can be defined on the fly. If the particular lexer instance is meant to be used with <a href="class.parle-rparser.html" class="classname">Parle\RParser</a>, the token IDs need to be taken from there. Otherwise, arbitrary token IDs can be supplied. Note, that <a href="class.parle-parser.html" class="classname">Parle\Parser</a> is not compatible with this lexer. </p> </div> <div class="section" id="parle-rlexer.synopsis"> <h2 class="title">Class synopsis</h2> <div class="classsynopsis"> <div class="ooclass"></div> <div class="classsynopsisinfo"> <span class="ooclass"> <strong class="classname">Parle\RLexer</strong> </span> {</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Constants */</div> <div class="fieldsynopsis"> <span class="modifier">const</span> <span class="type">integer</span> <var class="fieldsynopsis_varname"><a href="class.parle-rlexer.html#parle-rlexer.constants.flag-regex-icase"><var class="varname">ICASE</var></a></var> <span class="initializer"> = 1</span> ;</div> <div class="fieldsynopsis"> <span class="modifier">const</span> <span class="type">integer</span> <var class="fieldsynopsis_varname"><a href="class.parle-rlexer.html#parle-rlexer.constants.flag-regex-dot-not-lf"><var class="varname">DOT_NOT_LF</var></a></var> <span class="initializer"> = 2</span> ;</div> <div class="fieldsynopsis"> <span class="modifier">const</span> <span class="type">integer</span> <var class="fieldsynopsis_varname"><a href="class.parle-rlexer.html#parle-rlexer.constants.flag-regex-dot-not-cr-lf"><var class="varname">DOT_NOT_CRLF</var></a></var> <span class="initializer"> = 4</span> ;</div> <div class="fieldsynopsis"> <span class="modifier">const</span> <span class="type">integer</span> <var class="fieldsynopsis_varname"><a href="class.parle-rlexer.html#parle-rlexer.constants.flag-regex-skip-ws"><var class="varname">SKIP_WS</var></a></var> <span class="initializer"> = 8</span> ;</div> <div class="fieldsynopsis"> <span class="modifier">const</span> <span class="type">integer</span> <var class="fieldsynopsis_varname"><a href="class.parle-rlexer.html#parle-rlexer.constants.flag-regex-match-zero-len"><var class="varname">MATCH_ZERO_LEN</var></a></var> <span class="initializer"> = 16</span> ;</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div> <div class="fieldsynopsis"> <span class="modifier">public</span> <span class="type">boolean</span> <var class="varname"><a href="class.parle-rlexer.html#parle-rlexer.props.bol">$<var class="varname">bol</var></a></var> <span class="initializer"> = <strong><code>FALSE</code></strong></span> ;</div> <div class="fieldsynopsis"> <span class="modifier">public</span> <span class="type">integer</span> <var class="varname"><a href="class.parle-rlexer.html#parle-rlexer.props.flags">$<var class="varname">flags</var></a></var> <span class="initializer"> = 0</span> ;</div> <div class="fieldsynopsis"> <span class="modifier">public</span> <span class="type">integer</span> <var class="varname"><a href="class.parle-rlexer.html#parle-rlexer.props.state">$<var class="varname">state</var></a></var> <span class="initializer"> = 0</span> ;</div> <div class="fieldsynopsis"> <span class="modifier">public</span> <span class="type">integer</span> <var class="varname"><a href="class.parle-rlexer.html#parle-rlexer.props.marker">$<var class="varname">marker</var></a></var> <span class="initializer"> = 0</span> ;</div> <div class="fieldsynopsis"> <span class="modifier">public</span> <span class="type">integer</span> <var class="varname"><a href="class.parle-rlexer.html#parle-rlexer.props.cursor">$<var class="varname">cursor</var></a></var> <span class="initializer"> = 0</span> ;</div> <div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="parle-rlexer.advance.html" class="methodname">advance</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="parle-rlexer.build.html" class="methodname">build</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="parle-rlexer.callout.html" class="methodname">callout</a></span> ( <span class="methodparam"><span class="type">int</span> <code class="parameter">$id</code></span> , <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="parle-rlexer.consume.html" class="methodname">consume</a></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="parle-rlexer.dump.html" class="methodname">dump</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">Parle\Token</span> <span class="methodname"><a href="parle-rlexer.gettoken.html" class="methodname">getToken</a></span> ( <span class="methodparam">void</span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="parle-rlexer.insertmacro.html" class="methodname">insertMacro</a></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$regex</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="parle-rlexer.push.html" class="methodname">push</a></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$regex</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$id</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="parle-rlexer.push.html" class="methodname">push</a></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$state</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$regex</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$id</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$newState</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="parle-rlexer.push.html" class="methodname">push</a></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$state</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$regex</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$newState</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="parle-rlexer.pushstate.html" class="methodname">pushState</a></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$state</code></span> )</div> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="parle-rlexer.reset.html" class="methodname">reset</a></span> ( <span class="methodparam"><span class="type">int</span> <code class="parameter">$pos</code></span> )</div> }</div> </div> <div class="section" id="parle-rlexer.constants"> <h2 class="title">Predefined Constants</h2> <dl> <dt id="parle-rlexer.constants.flag-regex-icase"><strong><code>Parle\RLexer::ICASE</code></strong></dt> <dd> <p class="para"/> </dd> <dt id="parle-rlexer.constants.flag-regex-dot-not-lf"><strong><code>Parle\RLexer::DOT_NOT_LF</code></strong></dt> <dd> <p class="para"/> </dd> <dt id="parle-rlexer.constants.flag-regex-dot-not-cr-lf"><strong><code>Parle\RLexer::DOT_NOT_CRLF</code></strong></dt> <dd> <p class="para"/> </dd> <dt id="parle-rlexer.constants.flag-regex-skip-ws"><strong><code>Parle\RLexer::SKIP_WS</code></strong></dt> <dd> <p class="para"/> </dd> <dt id="parle-rlexer.constants.flag-regex-match-zero-len"><strong><code>Parle\RLexer::MATCH_ZERO_LEN</code></strong></dt> <dd> <p class="para"/> </dd> </dl> </div> <div class="section" id="parle-rlexer.props"> <h2 class="title">Properties</h2> <dl> <dt id="parle-rlexer.props.bol"><var class="varname"><var class="varname">bol</var></var></dt> <dd> <p class="para">Start of input flag.</p> </dd> <dt id="parle-rlexer.props.flags"><var class="varname"><var class="varname">flags</var></var></dt> <dd> <p class="para">Lexer flags.</p> </dd> <dt id="parle-rlexer.props.state"><var class="varname"><var class="varname">state</var></var></dt> <dd> <p class="para">Current lexer state, readonly.</p> </dd> <dt id="parle-rlexer.props.marker"><var class="varname"><var class="varname">marker</var></var></dt> <dd> <p class="para">Position of the latest token match, readonly.</p> </dd> <dt id="parle-rlexer.props.cursor"><var class="varname"><var class="varname">cursor</var></var></dt> <dd> <p class="para">Current input offset, readonly.</p> </dd> </dl> </div> </div> <h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="parle-rlexer.advance.html">Parle\RLexer::advance</a> — Process next lexer rule</li><li><a href="parle-rlexer.build.html">Parle\RLexer::build</a> — Finalize the lexer rule set</li><li><a href="parle-rlexer.callout.html">Parle\RLexer::callout</a> — Define token callback</li><li><a href="parle-rlexer.consume.html">Parle\RLexer::consume</a> — Pass the data for processing</li><li><a href="parle-rlexer.dump.html">Parle\RLexer::dump</a> — Dump the state machine</li><li><a href="parle-rlexer.gettoken.html">Parle\RLexer::getToken</a> — Retrieve the current token</li><li><a href="parle-rlexer.insertmacro.html">Parle\RLexer::insertMacro</a> — Insert regex macro</li><li><a href="parle-rlexer.push.html">Parle\RLexer::push</a> — Add a lexer rule</li><li><a href="parle-rlexer.pushstate.html">Parle\RLexer::pushState</a> — Push a new start state</li><li><a href="parle-rlexer.reset.html">Parle\RLexer::reset</a> — Reset lexer</li></ul> </div> <hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="parle-lexer.reset.html">Parle\Lexer::reset</a></div> <div class="next" style="text-align: right; float: right;"><a href="parle-rlexer.advance.html">Parle\RLexer::advance</a></div> <div class="up"><a href="book.parle.html">Parle</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>