twisted.xish.xpathparser.Scanner.html [plain text]
<?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>twisted.xish.xpathparser.Scanner</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="twisted.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">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</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">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.xish.html">Package xish</a> ::
<a href="twisted.xish.xpathparser.html">Module xpathparser</a> ::
Class Scanner
</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="twisted.xish.xpathparser.Scanner.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class Scanner</h2>
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="twisted.xish.xpathparser.XPathParserScanner.html"><code>XPathParserScanner</code></a></dd></dl>
<hr/>
<p>Yapps scanner.</p>
The Yapps scanner can work in context sensitive or context insensitive
modes. The token(i) method is used to retrieve the i-th token. It takes a
restrict set that limits the set of tokens it is allowed to return. In
context sensitive mode, this restrict set guides the scanner. In context
insensitive mode, there is no restriction (the set is always the full set
of tokens).
<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><span class="summary-sig"><a href="twisted.xish.xpathparser.Scanner.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>patterns</span>,
<span class=summary-sig-arg>ignore</span>,
<span class=summary-sig-arg>input</span>)</span></code>
<br />
Initialize the scanner.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.xpathparser.Scanner.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Print the last 10 tokens that have been scanned in</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.xpathparser.Scanner.html#get_char_pos" class="summary-sig-name"><code>get_char_pos</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Get the current char position in the input text.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.xpathparser.Scanner.html#get_column_number" class="summary-sig-name"><code>get_column_number</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Get the column number of the current position in the input text.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.xpathparser.Scanner.html#get_input_scanned" class="summary-sig-name"><code>get_input_scanned</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Get the portion of the input that has been tokenized.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.xpathparser.Scanner.html#get_input_unscanned" class="summary-sig-name"><code>get_input_unscanned</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Get the portion of the input that has not yet been tokenized.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.xpathparser.Scanner.html#get_line_number" class="summary-sig-name"><code>get_line_number</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Get the line number of the current position in the input text.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.xpathparser.Scanner.html#get_prev_char_pos" class="summary-sig-name"><code>get_prev_char_pos</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>i</span>)</span></code>
<br />
Get the previous position (one token back) in the input text.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.xpathparser.Scanner.html#get_token_pos" class="summary-sig-name"><code>get_token_pos</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Get the current token position in the input text.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.xpathparser.Scanner.html#scan" class="summary-sig-name"><code>scan</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>restrict</span>)</span></code>
<br />
Should scan another token and add it to the list, self.tokens, and add
the restriction to self.restrictions</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.xish.xpathparser.Scanner.html#token" class="summary-sig-name"><code>token</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>i</span>,
<span class=summary-sig-arg>restrict</span>)</span></code>
<br />
Get the i'th token in the input.</td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>patterns</span>,
<span class=sig-arg>ignore</span>,
<span class=sig-arg>input</span>)</span>
<br /><i>(Constructor)</i>
</h3>
<pre class="literalblock">
Initialize the scanner.
Parameters:
patterns : [(terminal, uncompiled regex), ...] or None
ignore : [terminal,...]
input : string
If patterns is None, we assume that the subclass has
defined self.patterns : [(terminal, compiled regex), ...].
Note that the patterns parameter expects uncompiled regexes,
whereas the self.patterns field expects compiled regexes.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="__repr__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__repr__</span>(<span class=sig-arg>self</span>)</span>
<br /><i>(Representation operator)</i>
</h3>
Print the last 10 tokens that have been scanned in
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="get_char_pos"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_char_pos</span>(<span class=sig-arg>self</span>)</span>
</h3>
Get the current char position in the input text.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="get_column_number"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_column_number</span>(<span class=sig-arg>self</span>)</span>
</h3>
Get the column number of the current position in the input text.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="get_input_scanned"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_input_scanned</span>(<span class=sig-arg>self</span>)</span>
</h3>
Get the portion of the input that has been tokenized.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="get_input_unscanned"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_input_unscanned</span>(<span class=sig-arg>self</span>)</span>
</h3>
Get the portion of the input that has not yet been tokenized.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="get_line_number"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_line_number</span>(<span class=sig-arg>self</span>)</span>
</h3>
Get the line number of the current position in the input text.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="get_prev_char_pos"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_prev_char_pos</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>i</span>=<span class=sig-default>None</span>)</span>
</h3>
Get the previous position (one token back) in the input text.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="get_token_pos"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">get_token_pos</span>(<span class=sig-arg>self</span>)</span>
</h3>
Get the current token position in the input text.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="scan"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">scan</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>restrict</span>)</span>
</h3>
Should scan another token and add it to the list, self.tokens, and
add the restriction to self.restrictions
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="token"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">token</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>i</span>,
<span class=sig-arg>restrict</span>=<span class=sig-default>None</span>)</span>
</h3>
<p>Get the i'th token in the input.</p>
<p>If i is one past the end, then scan for another token.</p>
<p>Args:</p>
restrict : [token, ...] or None; if restrict is None, then any token
is allowed. You may call token(i) more than once. However, the restrict
set may never be larger than what was passed in on the first call to
token(i).
<dl><dt></dt><dd>
</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="twisted.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">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</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.0 on Sat May 15 20:07:36 2004</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>