<!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\RParser class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="parle-parser.validate.html">Parle\Parser::validate</a></div>
<div class="next" style="text-align: right; float: right;"><a href="parle-rparser.advance.html">Parle\RParser::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-rparser" class="reference">
<h1 class="title">The Parle\RParser class</h1>
<div class="partintro"><p class="verinfo">(PECL parle >= 0.7.0)</p>
<div class="section" id="parle-rparser.intro">
<h2 class="title">Introduction</h2>
<p class="para">
Parser class. Rules can be defined on the fly. Once finalized, a <a href="class.parle-rlexer.html" class="classname">Parle\RLexer</a> instance is required to deliver the token stream.
</p>
</div>
<div class="section" id="parle-rparser.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">Parle\RParser</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-rparser.html#parle-rparser.constants.action-error"><var class="varname">ACTION_ERROR</var></a></var>
<span class="initializer"> = 0</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.parle-rparser.html#parle-rparser.constants.action-shift"><var class="varname">ACTION_SHIFT</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-rparser.html#parle-rparser.constants.action-reduce"><var class="varname">ACTION_REDUCE</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-rparser.html#parle-rparser.constants.action-goto"><var class="varname">ACTION_GOTO</var></a></var>
<span class="initializer"> = 3</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.parle-rparser.html#parle-rparser.constants.action-accept"><var class="varname">ACTION_ACCEPT</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-rparser.html#parle-rparser.constants.error-syntax"><var class="varname">ERROR_SYNTAX</var></a></var>
<span class="initializer"> = 0</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.parle-rparser.html#parle-rparser.constants.error-non-associative"><var class="varname">ERROR_NON_ASSOCIATIVE</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-rparser.html#parle-rparser.constants.error-unkown-token"><var class="varname">ERROR_UNKOWN_TOKEN</var></a></var>
<span class="initializer"> = 2</span>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<span class="type">integer</span>
<var class="varname"><a href="class.parle-rparser.html#parle-rparser.props.action">$<var class="varname">action</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-rparser.html#parle-rparser.props.reduceId">$<var class="varname">reduceId</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-rparser.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-rparser.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-rparser.consume.html" class="methodname">consume</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span>
, <span class="methodparam"><span class="type"><span class="type Parle\RLexer">Parle\RLexer</span></span> <code class="parameter">$rlexer</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="parle-rparser.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\ErrorInfo</span> <span class="methodname"><a href="parle-rparser.errorinfo.html" class="methodname">errorInfo</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-rparser.left.html" class="methodname">left</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$tok</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="parle-rparser.nonassoc.html" class="methodname">nonassoc</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$tok</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="parle-rparser.precedence.html" class="methodname">precedence</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$tok</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="parle-rparser.push.html" class="methodname">push</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">$rule</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="parle-rparser.reset.html" class="methodname">reset</a></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$tokenId</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="parle-rparser.right.html" class="methodname">right</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$tok</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="parle-rparser.sigil.html" class="methodname">sigil</a></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$idx</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="parle-rparser.token.html" class="methodname">token</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$tok</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">int</span> <span class="methodname"><a href="parle-rparser.tokenid.html" class="methodname">tokenId</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$tok</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="parle-rparser.trace.html" class="methodname">trace</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="parle-rparser.validate.html" class="methodname">validate</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span>
, <span class="methodparam"><span class="type"><span class="type Parle\RLexer">Parle\RLexer</span></span> <code class="parameter">$lexer</code></span>
)</div>
}</div>
</div>
<div class="section" id="parle-rparser.constants">
<h2 class="title">Predefined Constants</h2>
<dl>
<dt id="parle-rparser.constants.action-error"><strong><code>Parle\RParser::ACTION_ERROR</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="parle-rparser.constants.action-shift"><strong><code>Parle\RParser::ACTION_SHIFT</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="parle-rparser.constants.action-reduce"><strong><code>Parle\RParser::ACTION_REDUCE</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="parle-rparser.constants.action-goto"><strong><code>Parle\RParser::ACTION_GOTO</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="parle-rparser.constants.action-accept"><strong><code>Parle\RParser::ACTION_ACCEPT</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="parle-rparser.constants.error-syntax"><strong><code>Parle\RParser::ERROR_SYNTAX</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="parle-rparser.constants.error-non-associative"><strong><code>Parle\RParser::ERROR_NON_ASSOCIATIVE</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="parle-rparser.constants.error-unkown-token"><strong><code>Parle\RParser::ERROR_UNKOWN_TOKEN</code></strong></dt>
<dd>
<p class="para"/>
</dd>
</dl>
</div>
<div class="section" id="parle-rparser.props">
<h2 class="title">Properties</h2>
<dl>
<dt id="parle-rparser.props.action"><var class="varname"><var class="varname">action</var></var></dt>
<dd>
<p class="para">Current parser action that matches one of the action class constants, readonly.</p>
</dd>
<dt id="parle-rparser.props.reduceId"><var class="varname"><var class="varname">reduceId</var></var></dt>
<dd>
<p class="para">Grammar rule id just processed in the reduce action. The value corresponds either to a token or to a production id. Readonly.</p>
</dd>
</dl>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="parle-rparser.advance.html">Parle\RParser::advance</a> — Process next parser rule</li><li><a href="parle-rparser.build.html">Parle\RParser::build</a> — Finalize the grammar rules</li><li><a href="parle-rparser.consume.html">Parle\RParser::consume</a> — Consume the data for processing</li><li><a href="parle-rparser.dump.html">Parle\RParser::dump</a> — Dump the grammar</li><li><a href="parle-rparser.errorinfo.html">Parle\RParser::errorInfo</a> — Retrieve the error information</li><li><a href="parle-rparser.left.html">Parle\RParser::left</a> — Declare a token with left-associativity</li><li><a href="parle-rparser.nonassoc.html">Parle\RParser::nonassoc</a> — Declare a token with no associativity</li><li><a href="parle-rparser.precedence.html">Parle\RParser::precedence</a> — Declare a precedence rule</li><li><a href="parle-rparser.push.html">Parle\RParser::push</a> — Add a grammar rule</li><li><a href="parle-rparser.reset.html">Parle\RParser::reset</a> — Reset parser state</li><li><a href="parle-rparser.right.html">Parle\RParser::right</a> — Declare a token with right-associativity</li><li><a href="parle-rparser.sigil.html">Parle\RParser::sigil</a> — Retrieve a matching part of a rule</li><li><a href="parle-rparser.token.html">Parle\RParser::token</a> — Declare a token</li><li><a href="parle-rparser.tokenid.html">Parle\RParser::tokenId</a> — Get token id</li><li><a href="parle-rparser.trace.html">Parle\RParser::trace</a> — Trace the parser operation</li><li><a href="parle-rparser.validate.html">Parle\RParser::validate</a> — Validate input</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="parle-parser.validate.html">Parle\Parser::validate</a></div>
<div class="next" style="text-align: right; float: right;"><a href="parle-rparser.advance.html">Parle\RParser::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>
