← Back to branch summary

~ubuntu-branches/ubuntu/precise/pyparsing/precise-updates

« back to all changes in this revision

Viewing changes to htmldoc/pyparsing.pyparsing.Forward-class.html

  • Committer: Bazaar Package Importer
  • Author(s): Kevin Coyner
  • Date: 2008-02-24 18:14:15 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080224181415-9x0hjya3ca3590z1
Tags: 1.4.11-2
Reinstate release 1.4.10-2 changes, which I inadvertently omitted.

Show diffs side-by-side

added added

removed removed

Lines of Context:
htmldoc/pyparsing.pyparsing.Forward-class.html
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
          "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>pyparsing.pyparsing.Forward</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
 
8
</head>
 
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
10
      alink="#204080">
 
11
 
 
12
<!-- =========== START OF NAVBAR =========== -->
 
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
14
  <tr valign="center">
 
15
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="pyparsing.pyparsing-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
16
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
17
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
18
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
19
    <th class="navbar" align="right" width="100%">
 
20
      <table border="0" cellpadding="0" cellspacing="0">
 
21
      <tr><th class="navbar" align="center">
 
22
        <p class="nomargin">
 
23
          pyparsing
 
24
      </p></th></tr></table>
 
25
    </th>
 
26
  </tr>
 
27
</table>
 
28
<table width="100%" cellpadding="0" cellspacing="0">
 
29
  <tr valign="top">
 
30
    <td width="100%">
 
31
      <font size="-1"><b class="breadcrumbs">
 
32
        Package&nbsp;pyparsing ::
 
33
        <a href="pyparsing.pyparsing-module.html">Module&nbsp;pyparsing</a> ::
 
34
        Class&nbsp;Forward
 
35
      </b></font></br>
 
36
    </td>
 
37
    <td><table cellpadding="0" cellspacing="0">
 
38
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="pyparsing.pyparsing.Forward-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
39
    </table></td>
 
40
</tr></table>
 
41
 
 
42
<!-- =========== START OF CLASS DESCRIPTION =========== -->
 
43
<h2 class="class">Type Forward</h2>
 
44
 
 
45
<pre class="base-tree">
 
46
     <a href="__builtin__.object-class.html"><code>object</code></a> --+        
 
47
              |        
 
48
  <a href="pyparsing.pyparsing.ParserElement-class.html"><code>ParserElement</code></a> --+    
 
49
                  |    
 
50
<a href="pyparsing.pyparsing.ParseElementEnhance-class.html"><code>ParseElementEnhance</code></a> --+
 
51
                      |
 
52
                     <b>Forward</b>
 
53
</pre><br />
 
54
 
 
55
<hr/>
 
56
 
 
57
<p>Forward declaration of an expression to be defined later - used for 
 
58
recursive grammars, such as algebraic infix notation. When the expression 
 
59
is known, it is assigned to the Forward variable using the '&lt;&lt;' 
 
60
operator.</p>
 
61
Note: take care when assigning to Forward not to overlook precedence 
 
62
of operators. Specifically, '|' has a lower precedence than '&lt;&lt;', 
 
63
so that:
 
64
<pre class="literalblock">
 
65
  fwdExpr &lt;&lt; a | b | c
 
66
</pre>
 
67
will actually be evaluated as:
 
68
<pre class="literalblock">
 
69
  (fwdExpr &lt;&lt; a) | b | c
 
70
</pre>
 
71
thereby leaving b and c out as parseable alternatives. It is 
 
72
recommended that you explicitly group the values inserted into the 
 
73
Forward:
 
74
<pre class="literalblock">
 
75
  fwdExpr &lt;&lt; (a | b | c)
 
76
</pre>
 
77
<hr/>
 
78
 
 
79
 
 
80
<!-- =========== START OF METHOD SUMMARY =========== -->
 
81
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
82
<tr bgcolor="#70b0f0" class="summary">
 
83
  <th colspan="2">Method Summary</th></tr>
 
84
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
85
  <td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
 
86
          <span class=summary-sig-arg>other</span>)</span></code>
 
87
</td></tr>
 
88
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
89
  <td><code><a name="__lshift__"></a><span class="summary-sig"><span class="summary-sig-name">__lshift__</span>(<span class=summary-sig-arg>self</span>,
 
90
          <span class=summary-sig-arg>other</span>)</span></code>
 
91
</td></tr>
 
92
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
93
  <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>
 
94
</td></tr>
 
95
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
96
  <td><code><span class="summary-sig"><a href="pyparsing.pyparsing.Forward-class.html#copy" class="summary-sig-name"><code>copy</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
97
<br />
 
98
Make a copy of this ParserElement.</td></tr>
 
99
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
100
  <td><code><span class="summary-sig"><a href="pyparsing.pyparsing.Forward-class.html#leaveWhitespace" class="summary-sig-name"><code>leaveWhitespace</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
101
<br />
 
102
Disables the skipping of whitespace before matching the characters in 
 
103
the ParserElement's defined pattern.</td></tr>
 
104
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
105
  <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>
 
106
</td></tr>
 
107
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
108
  <td><code><span class="summary-sig"><a href="pyparsing.pyparsing.Forward-class.html#validate" class="summary-sig-name"><code>validate</code></a>(<span class=summary-sig-arg>self</span>,
 
109
          <span class=summary-sig-arg>validateTrace</span>)</span></code>
 
110
<br />
 
111
Check defined expressions for valid structure, check for infinite 
 
112
recursive definitions.</td></tr>
 
113
  <tr><td colspan="2">
 
114
    <b>Inherited from <a href="pyparsing.pyparsing.ParseElementEnhance-class.html"><code>ParseElementEnhance</code></a>:</b>
 
115
      <a href="pyparsing.pyparsing.ParseElementEnhance-class.html#checkRecursion"><code>checkRecursion</code></a>, 
 
116
      <a href="pyparsing.pyparsing.ParseElementEnhance-class.html#ignore"><code>ignore</code></a>, 
 
117
      <a href="pyparsing.pyparsing.ParseElementEnhance-class.html#parseImpl"><code>parseImpl</code></a>
 
118
      <br />
 
119
    <b>Inherited from <a href="pyparsing.pyparsing.ParserElement-class.html"><code>ParserElement</code></a>:</b>
 
120
      <a href="pyparsing.pyparsing.ParserElement-class.html#__add__"><code>__add__</code></a>, 
 
121
      <a href="pyparsing.pyparsing.ParserElement-class.html#__and__"><code>__and__</code></a>, 
 
122
      <a href="pyparsing.pyparsing.ParserElement-class.html#__call__"><code>__call__</code></a>, 
 
123
      <a href="pyparsing.pyparsing.ParserElement-class.html#__eq__"><code>__eq__</code></a>, 
 
124
      <a href="pyparsing.pyparsing.ParserElement-class.html#__getattr__"><code>__getattr__</code></a>, 
 
125
      <a href="pyparsing.pyparsing.ParserElement-class.html#__invert__"><code>__invert__</code></a>, 
 
126
      <a href="pyparsing.pyparsing.ParserElement-class.html#__mul__"><code>__mul__</code></a>, 
 
127
      <a href="pyparsing.pyparsing.ParserElement-class.html#__or__"><code>__or__</code></a>, 
 
128
      <a href="pyparsing.pyparsing.ParserElement-class.html#__radd__"><code>__radd__</code></a>, 
 
129
      <a href="pyparsing.pyparsing.ParserElement-class.html#__rand__"><code>__rand__</code></a>, 
 
130
      <a href="pyparsing.pyparsing.ParserElement-class.html#__repr__"><code>__repr__</code></a>, 
 
131
      <a href="pyparsing.pyparsing.ParserElement-class.html#__req__"><code>__req__</code></a>, 
 
132
      <a href="pyparsing.pyparsing.ParserElement-class.html#__rmul__"><code>__rmul__</code></a>, 
 
133
      <a href="pyparsing.pyparsing.ParserElement-class.html#__ror__"><code>__ror__</code></a>, 
 
134
      <a href="pyparsing.pyparsing.ParserElement-class.html#__rxor__"><code>__rxor__</code></a>, 
 
135
      <a href="pyparsing.pyparsing.ParserElement-class.html#__xor__"><code>__xor__</code></a>, 
 
136
      <a href="pyparsing.pyparsing.ParserElement-class.html#addParseAction"><code>addParseAction</code></a>, 
 
137
      <a href="pyparsing.pyparsing.ParserElement-class.html#enablePackrat"><code>enablePackrat</code></a>, 
 
138
      <a href="pyparsing.pyparsing.ParserElement-class.html#getException"><code>getException</code></a>, 
 
139
      <a href="pyparsing.pyparsing.ParserElement-class.html#parseFile"><code>parseFile</code></a>, 
 
140
      <a href="pyparsing.pyparsing.ParserElement-class.html#parseString"><code>parseString</code></a>, 
 
141
      <a href="pyparsing.pyparsing.ParserElement-class.html#parseWithTabs"><code>parseWithTabs</code></a>, 
 
142
      <a href="pyparsing.pyparsing.ParserElement-class.html#postParse"><code>postParse</code></a>, 
 
143
      <a href="pyparsing.pyparsing.ParserElement-class.html#preParse"><code>preParse</code></a>, 
 
144
      <a href="pyparsing.pyparsing.ParserElement-class.html#resetCache"><code>resetCache</code></a>, 
 
145
      <a href="pyparsing.pyparsing.ParserElement-class.html#scanString"><code>scanString</code></a>, 
 
146
      <a href="pyparsing.pyparsing.ParserElement-class.html#searchString"><code>searchString</code></a>, 
 
147
      <a href="pyparsing.pyparsing.ParserElement-class.html#setBreak"><code>setBreak</code></a>, 
 
148
      <a href="pyparsing.pyparsing.ParserElement-class.html#setDebug"><code>setDebug</code></a>, 
 
149
      <a href="pyparsing.pyparsing.ParserElement-class.html#setDebugActions"><code>setDebugActions</code></a>, 
 
150
      <a href="pyparsing.pyparsing.ParserElement-class.html#setDefaultWhitespaceChars"><code>setDefaultWhitespaceChars</code></a>, 
 
151
      <a href="pyparsing.pyparsing.ParserElement-class.html#setFailAction"><code>setFailAction</code></a>, 
 
152
      <a href="pyparsing.pyparsing.ParserElement-class.html#setName"><code>setName</code></a>, 
 
153
      <a href="pyparsing.pyparsing.ParserElement-class.html#setParseAction"><code>setParseAction</code></a>, 
 
154
      <a href="pyparsing.pyparsing.ParserElement-class.html#setResultsName"><code>setResultsName</code></a>, 
 
155
      <a href="pyparsing.pyparsing.ParserElement-class.html#setWhitespaceChars"><code>setWhitespaceChars</code></a>, 
 
156
      <a href="pyparsing.pyparsing.ParserElement-class.html#suppress"><code>suppress</code></a>, 
 
157
      <a href="pyparsing.pyparsing.ParserElement-class.html#transformString"><code>transformString</code></a>, 
 
158
      <a href="pyparsing.pyparsing.ParserElement-class.html#tryParse"><code>tryParse</code></a>
 
159
      <br />
 
160
    <b>Inherited from <a href="__builtin__.object-class.html"><code>object</code></a>:</b>
 
161
      <a href="__builtin__.object-class.html#__delattr__"><code>__delattr__</code></a>, 
 
162
      <a href="__builtin__.object-class.html#__getattribute__"><code>__getattribute__</code></a>, 
 
163
      <a href="__builtin__.object-class.html#__hash__"><code>__hash__</code></a>, 
 
164
      <a href="__builtin__.object-class.html#__new__"><code>__new__</code></a>, 
 
165
      <a href="__builtin__.object-class.html#__reduce__"><code>__reduce__</code></a>, 
 
166
      <a href="__builtin__.object-class.html#__reduce_ex__"><code>__reduce_ex__</code></a>, 
 
167
      <a href="__builtin__.object-class.html#__setattr__"><code>__setattr__</code></a>
 
168
    </td></tr>
 
169
</table><br />
 
170
 
 
171
 
 
172
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
 
173
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
174
<tr bgcolor="#70b0f0" class="summary">
 
175
  <th colspan="2">Class Variable Summary</th></tr>
 
176
  <tr><td colspan="2">
 
177
    <b>Inherited from <a href="pyparsing.pyparsing.ParserElement-class.html"><code>ParserElement</code></a>:</b>
 
178
      <a href="pyparsing.pyparsing.ParserElement-class.html#DEFAULT_WHITE_CHARS"><code>DEFAULT_WHITE_CHARS</code></a>
 
179
    </td></tr>
 
180
</table><br />
 
181
 
 
182
 
 
183
<!-- =========== START OF INSTANCE METHOD DETAILS =========== -->
 
184
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
185
<tr bgcolor="#70b0f0" class="details">
 
186
  <th colspan="2">Instance Method Details</th></tr>
 
187
</table>
 
188
 
 
189
<a name="copy"></a>
 
190
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
191
  <h3><span class="sig"><span class="sig-name">copy</span>(<span class=sig-arg>self</span>)</span>
 
192
  </h3>
 
193
  Make a copy of this ParserElement. Useful for defining different 
 
194
  parse actions for the same parsing pattern, using copies of the 
 
195
  original parse element.
 
196
  <dl><dt></dt><dd>
 
197
    <dl><dt><b>Overrides:</b></dt>
 
198
      <dd><a href="pyparsing.pyparsing.ParserElement-class.html#copy"><code>pyparsing.pyparsing.ParserElement.copy</code></a> <i>(inherited documentation)</i>
 
199
</dd>
 
200
    </dl>
 
201
  </dd></dl>
 
202
</td></tr></table>
 
203
 
 
204
<a name="leaveWhitespace"></a>
 
205
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
206
  <h3><span class="sig"><span class="sig-name">leaveWhitespace</span>(<span class=sig-arg>self</span>)</span>
 
207
  </h3>
 
208
  Disables the skipping of whitespace before matching the characters 
 
209
  in the ParserElement's defined pattern. This is normally only used 
 
210
  internally by the pyparsing module, but may be needed in some 
 
211
  whitespace-sensitive grammars.
 
212
  <dl><dt></dt><dd>
 
213
    <dl><dt><b>Overrides:</b></dt>
 
214
      <dd><a href="pyparsing.pyparsing.ParseElementEnhance-class.html#leaveWhitespace"><code>pyparsing.pyparsing.ParseElementEnhance.leaveWhitespace</code></a> <i>(inherited documentation)</i>
 
215
</dd>
 
216
    </dl>
 
217
  </dd></dl>
 
218
</td></tr></table>
 
219
 
 
220
<a name="validate"></a>
 
221
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
222
  <h3><span class="sig"><span class="sig-name">validate</span>(<span class=sig-arg>self</span>,
 
223
          <span class=sig-arg>validateTrace</span>=<span class=sig-default>[]</span>)</span>
 
224
  </h3>
 
225
  Check defined expressions for valid structure, check for infinite 
 
226
  recursive definitions.
 
227
  <dl><dt></dt><dd>
 
228
    <dl><dt><b>Overrides:</b></dt>
 
229
      <dd><a href="pyparsing.pyparsing.ParseElementEnhance-class.html#validate"><code>pyparsing.pyparsing.ParseElementEnhance.validate</code></a> <i>(inherited documentation)</i>
 
230
</dd>
 
231
    </dl>
 
232
  </dd></dl>
 
233
</td></tr></table>
 
234
<br />
 
235
 
 
236
 
 
237
<!-- =========== START OF NAVBAR =========== -->
 
238
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
239
  <tr valign="center">
 
240
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="pyparsing.pyparsing-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
241
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
242
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
243
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
244
    <th class="navbar" align="right" width="100%">
 
245
      <table border="0" cellpadding="0" cellspacing="0">
 
246
      <tr><th class="navbar" align="center">
 
247
        <p class="nomargin">
 
248
          pyparsing
 
249
      </p></th></tr></table>
 
250
    </th>
 
251
  </tr>
 
252
</table>
 
253
 
 
254
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
255
  <tr>
 
256
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Feb 10 18:01:06 2008</font></td>
 
257
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
258
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
259
  </tr>
 
260
</table>
 
261
</body>
 
262
</html>