<?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <title>parserFwk.pyparsing.Forward</title> <link rel="stylesheet" href="epydoc.css" type="text/css"></link> </head> <body bgcolor="white" text="black" link="blue" vlink="#204080" alink="#204080"> <!-- =========== START OF NAVBAR =========== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="center"> <th class="navbar"> <a class="navbar" href="parserFwk.pyparsing-module.html">Home</a> </th> <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th> <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th> <th class="navbar"> <a class="navbar" href="help.html">Help</a> </th> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center"> <p class="nomargin"> pyparsing </p></th></tr></table> </th> </tr> </table> <table width="100%" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="100%"> <font size="-1"><b class="breadcrumbs"> Package parserFwk :: <a href="parserFwk.pyparsing-module.html">Module pyparsing</a> :: Class Forward </b></font></br> </td> <td><table cellpadding="0" cellspacing="0"> <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="parserFwk.pyparsing.Forward-class.html" target="_top">no frames</a>]</font></td></tr> </table></td> </tr></table> <!-- =========== START OF CLASS DESCRIPTION =========== --> <h2 class="class">Type Forward</h2> <pre class="base-tree"> <a href="__builtin__.object-class.html"><code>object</code></a> --+ | <a href="parserFwk.pyparsing.ParserElement-class.html"><code>ParserElement</code></a> --+ | <a href="parserFwk.pyparsing.ParseElementEnhance-class.html"><code>ParseElementEnhance</code></a> --+ | <b>Forward</b> </pre><br /> <hr/> <p>Forward declaration of an expression to be defined later - used for recursive grammars, such as algebraic infix notation. When the expression is known, it is assigned to the Forward variable using the '<<' operator.</p> Note: take care when assigning to Forward to not overlook precedence of operators. Specifically, '|' has a lower precedence than '<<', so that: <pre class="literalblock"> fwdExpr << a | b | c </pre> will actually be evaluated as: <pre class="literalblock"> (fwdExpr << a) | b | c </pre> thereby leaving b and c out as parseable alternatives. It is recommended that you explicitly group the values inserted into the Forward: <pre class="literalblock"> fwdExpr << (a | b | c) </pre> <hr/> <!-- =========== START OF METHOD SUMMARY =========== --> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="summary"> <th colspan="2">Method Summary</th></tr> <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> <td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>, <span class=summary-sig-arg>other</span>)</span></code> </td></tr> <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> <td><code><a name="__lshift__"></a><span class="summary-sig"><span class="summary-sig-name">__lshift__</span>(<span class=summary-sig-arg>self</span>, <span class=summary-sig-arg>other</span>)</span></code> </td></tr> <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> <td><code><a name="__str__"></a><span class="summary-sig"><span class="summary-sig-name">__str__</span>(<span class=summary-sig-arg>self</span>)</span></code> </td></tr> <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> <td><code><span class="summary-sig"><a href="parserFwk.pyparsing.Forward-class.html#leaveWhitespace" class="summary-sig-name"><code>leaveWhitespace</code></a>(<span class=summary-sig-arg>self</span>)</span></code> <br /> Disables the skipping of whitespace before matching the characters in the ParserElement's defined pattern.</td></tr> <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> <td><code><a name="streamline"></a><span class="summary-sig"><span class="summary-sig-name">streamline</span>(<span class=summary-sig-arg>self</span>)</span></code> </td></tr> <tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td> <td><code><span class="summary-sig"><a href="parserFwk.pyparsing.Forward-class.html#validate" class="summary-sig-name"><code>validate</code></a>(<span class=summary-sig-arg>self</span>, <span class=summary-sig-arg>validateTrace</span>)</span></code> <br /> Check defined expressions for valid structure, check for infinite recursive definitions.</td></tr> <tr><td colspan="2"> <b>Inherited from <a href="parserFwk.pyparsing.ParseElementEnhance-class.html"><code>ParseElementEnhance</code></a>:</b> <a href="parserFwk.pyparsing.ParseElementEnhance-class.html#checkRecursion"><code>checkRecursion</code></a>, <a href="parserFwk.pyparsing.ParseElementEnhance-class.html#ignore"><code>ignore</code></a>, <a href="parserFwk.pyparsing.ParseElementEnhance-class.html#parseImpl"><code>parseImpl</code></a> <br /> <b>Inherited from <a href="parserFwk.pyparsing.ParserElement-class.html"><code>ParserElement</code></a>:</b> <a href="parserFwk.pyparsing.ParserElement-class.html#__add__"><code>__add__</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#__and__"><code>__and__</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#__invert__"><code>__invert__</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#__or__"><code>__or__</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#__radd__"><code>__radd__</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#__rand__"><code>__rand__</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#__repr__"><code>__repr__</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#__ror__"><code>__ror__</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#__rxor__"><code>__rxor__</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#__xor__"><code>__xor__</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#copy"><code>copy</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#enablePackrat"><code>enablePackrat</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#parseFile"><code>parseFile</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#parseString"><code>parseString</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#parseWithTabs"><code>parseWithTabs</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#postParse"><code>postParse</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#preParse"><code>preParse</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#resetCache"><code>resetCache</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#scanString"><code>scanString</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#searchString"><code>searchString</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#setDebug"><code>setDebug</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#setDebugActions"><code>setDebugActions</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#setDefaultWhitespaceChars"><code>setDefaultWhitespaceChars</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#setName"><code>setName</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#setParseAction"><code>setParseAction</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#setResultsName"><code>setResultsName</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#setWhitespaceChars"><code>setWhitespaceChars</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#skipIgnorables"><code>skipIgnorables</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#suppress"><code>suppress</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#transformString"><code>transformString</code></a>, <a href="parserFwk.pyparsing.ParserElement-class.html#tryParse"><code>tryParse</code></a> <br /> <b>Inherited from <a href="__builtin__.object-class.html"><code>object</code></a>:</b> <a href="__builtin__.object-class.html#__delattr__"><code>__delattr__</code></a>, <a href="__builtin__.object-class.html#__getattribute__"><code>__getattribute__</code></a>, <a href="__builtin__.object-class.html#__hash__"><code>__hash__</code></a>, <a href="__builtin__.object-class.html#__new__"><code>__new__</code></a>, <a href="__builtin__.object-class.html#__reduce__"><code>__reduce__</code></a>, <a href="__builtin__.object-class.html#__reduce_ex__"><code>__reduce_ex__</code></a>, <a href="__builtin__.object-class.html#__setattr__"><code>__setattr__</code></a> </td></tr> </table><br /> <!-- =========== START OF CLASS VARIABLE SUMMARY =========== --> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="summary"> <th colspan="2">Class Variable Summary</th></tr> <tr><td colspan="2"> <b>Inherited from <a href="parserFwk.pyparsing.ParserElement-class.html"><code>ParserElement</code></a>:</b> <a href="parserFwk.pyparsing.ParserElement-class.html#DEFAULT_WHITE_CHARS"><code>DEFAULT_WHITE_CHARS</code></a> </td></tr> </table><br /> <!-- =========== START OF INSTANCE METHOD DETAILS =========== --> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="details"> <th colspan="2">Instance Method Details</th></tr> </table> <a name="leaveWhitespace"></a> <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> <h3><span class="sig"><span class="sig-name">leaveWhitespace</span>(<span class=sig-arg>self</span>)</span> </h3> Disables the skipping of whitespace before matching the characters in the ParserElement's defined pattern. This is normally only used internally by the pyparsing module, but may be needed in some whitespace-sensitive grammars. <dl><dt></dt><dd> <dl><dt><b>Overrides:</b></dt> <dd><a href="parserFwk.pyparsing.ParseElementEnhance-class.html#leaveWhitespace"><code>parserFwk.pyparsing.ParseElementEnhance.leaveWhitespace</code></a> <i>(inherited documentation)</i> </dd> </dl> </dd></dl> </td></tr></table> <a name="validate"></a> <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td> <h3><span class="sig"><span class="sig-name">validate</span>(<span class=sig-arg>self</span>, <span class=sig-arg>validateTrace</span>=<span class=sig-default>[]</span>)</span> </h3> Check defined expressions for valid structure, check for infinite recursive definitions. <dl><dt></dt><dd> <dl><dt><b>Overrides:</b></dt> <dd><a href="parserFwk.pyparsing.ParseElementEnhance-class.html#validate"><code>parserFwk.pyparsing.ParseElementEnhance.validate</code></a> <i>(inherited documentation)</i> </dd> </dl> </dd></dl> </td></tr></table> <br /> <!-- =========== START OF NAVBAR =========== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="center"> <th class="navbar"> <a class="navbar" href="parserFwk.pyparsing-module.html">Home</a> </th> <th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th> <th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th> <th class="navbar"> <a class="navbar" href="help.html">Help</a> </th> <th class="navbar" align="right" width="100%"> <table border="0" cellpadding="0" cellspacing="0"> <tr><th class="navbar" align="center"> <p class="nomargin"> pyparsing </p></th></tr></table> </th> </tr> </table> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr> <td align="left"><font size="-2">Generated by Epydoc 2.1 on Fri Mar 31 23:37:57 2006</font></td> <td align="right"><a href="http://epydoc.sourceforge.net" ><font size="-2">http://epydoc.sf.net</font></a></td> </tr> </table> </body> </html>