parle.parser.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<reference xml:id="class.parle-parser" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The Parle\Parser class</title>
 <titleabbrev>Parle\Parser</titleabbrev>

 <partintro>

<!-- {{{ Parle\Parser intro -->
  <section xml:id="parle-parser.intro">
   &reftitle.intro;
   <para>
    Parser class. Rules can be defined on the fly. Once finalized, a <classname>Parle\Lexer</classname> instance is required to deliver the token stream.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="parle-parser.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>Parle\Parser</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>Parle\Parser</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="parle-parser.constants.action-error">Parle\Parser::ACTION_ERROR</varname>
     <initializer>0</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="parle-parser.constants.action-shift">Parle\Parser::ACTION_SHIFT</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="parle-parser.constants.action-reduce">Parle\Parser::ACTION_REDUCE</varname>
     <initializer>2</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="parle-parser.constants.action-goto">Parle\Parser::ACTION_GOTO</varname>
     <initializer>3</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="parle-parser.constants.action-accept">Parle\Parser::ACTION_ACCEPT</varname>
     <initializer>4</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="parle-parser.constants.error-syntax">Parle\Parser::ERROR_SYNTAX</varname>
     <initializer>0</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="parle-parser.constants.error-non-associative">Parle\Parser::ERROR_NON_ASSOCIATIVE</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="parle-parser.constants.error-unknown-token">Parle\Parser::ERROR_UNKNOWN_TOKEN</varname>
     <initializer>2</initializer>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>int</type>
     <varname linkend="parle-parser.props.action">action</varname>
     <initializer>0</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>int</type>
     <varname linkend="parle-parser.props.reduceId">reduceId</varname>
     <initializer>0</initializer>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.parle-parser')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
   </classsynopsis>
<!-- }}} -->

  </section>

<!-- {{{ Parle\Parser constants -->
  <section xml:id="parle-parser.constants">
   &reftitle.constants;
   <variablelist>

    <varlistentry xml:id="parle-parser.constants.action-error">
     <term><constant>Parle\Parser::ACTION_ERROR</constant></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="parle-parser.constants.action-shift">
     <term><constant>Parle\Parser::ACTION_SHIFT</constant></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="parle-parser.constants.action-reduce">
     <term><constant>Parle\Parser::ACTION_REDUCE</constant></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="parle-parser.constants.action-goto">
     <term><constant>Parle\Parser::ACTION_GOTO</constant></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="parle-parser.constants.action-accept">
     <term><constant>Parle\Parser::ACTION_ACCEPT</constant></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="parle-parser.constants.error-syntax">
     <term><constant>Parle\Parser::ERROR_SYNTAX</constant></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="parle-parser.constants.error-non-associative">
     <term><constant>Parle\Parser::ERROR_NON_ASSOCIATIVE</constant></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="parle-parser.constants.error-unknown-token">
     <term><constant>Parle\Parser::ERROR_UNKNOWN_TOKEN</constant></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>

   </variablelist>
  </section>
<!-- }}} -->

<!-- {{{ Parle\Parser properties -->
  <section xml:id="parle-parser.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="parle-parser.props.action">
     <term><varname>action</varname></term>
     <listitem>
      <para>Current parser action that matches one of the action class constants, readonly.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="parle-parser.props.reduceId">
     <term><varname>reduceId</varname></term>
     <listitem>
      <para>Grammar rule id just processed in the reduce action. The value corresponds either to a token or to a production id. Readonly.</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->

 </partintro>

 <!--&reference.parle.entities.parle-parser;-->
 &reference.parle.parle.entities.parser;

</reference>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->