<?xml version="1.0" encoding="ascii"?>
<!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>Martel.Expression.Expression</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="Martel-module.html">Package Martel</a> ::
<a href="Martel.Expression-module.html">Module Expression</a> ::
Class Expression
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="Martel.Expression.Expression-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Expression</h1><p class="nomargin-top"><span class="codelink"><a href="Martel.Expression-pysrc.html#Expression">source code</a></span></p>
<dl><dt>Known Subclasses:</dt>
<dd>
<ul class="subclass-list">
<li><a href="Martel.Expression.ExpressionList-class.html">ExpressionList</a></li><li>, <a href="Martel.Expression.Any-class.html">Any</a></li><li>, <a href="Martel.Expression.AnyEol-class.html">AnyEol</a></li><li>, <a href="Martel.Expression.Assert-class.html">Assert</a></li><li>, <a href="Martel.Expression.AtBeginning-class.html">AtBeginning</a></li><li>, <a href="Martel.Expression.AtEnd-class.html">AtEnd</a></li><li>, <a href="Martel.Expression.Debug-class.html">Debug</a></li><li>, <a href="Martel.Expression.Dot-class.html">Dot</a></li><li>, <a href="Martel.Expression.PassThrough-class.html">PassThrough</a></li><li>, <a href="Martel.Expression.Group-class.html">Group</a></li><li>, <a href="Martel.Expression.GroupRef-class.html">GroupRef</a></li><li>, <a href="Martel.Expression.Literal-class.html">Literal</a></li><li>, <a href="Martel.Expression.MaxRepeat-class.html">MaxRepeat</a></li><li>, <a href="Martel.Expression.NullOp-class.html">NullOp</a></li><li>, <a href="Martel.Expression.Str-class.html">Str</a></li> </ul>
</dd></dl>
<hr />
<p>Base class for nodes in the Expression tree</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__add__"></a><span class="summary-sig-name">__add__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
returns an Expression to match this Expression then the other one</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Expression-pysrc.html#Expression.__add__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__or__"></a><span class="summary-sig-name">__or__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
returns an Expression matching this Expression or (if that fails) the
other one</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Expression-pysrc.html#Expression.__or__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="group_names"></a><span class="summary-sig-name">group_names</span>(<span class="summary-sig-arg">self</span>)</span><br />
the list of group names used by this Expression and its children</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Expression-pysrc.html#Expression.group_names">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_find_groups"></a><span class="summary-sig-name">_find_groups</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">tag</span>)</span><br />
return a list of all groups matching the given tag</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Expression-pysrc.html#Expression._find_groups">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="features"></a><span class="summary-sig-name">features</span>(<span class="summary-sig-arg">self</span>)</span><br />
return a list of all features</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Expression-pysrc.html#Expression.features">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Martel.Expression.Expression-class.html#_select_names" class="summary-sig-name" onclick="show_private();">_select_names</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">names</span>)</span><br />
internal function used by 'select_names'.</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Expression-pysrc.html#Expression._select_names">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="copy"></a><span class="summary-sig-name">copy</span>(<span class="summary-sig-arg">self</span>)</span><br />
do a deep copy on this Expression tree</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Expression-pysrc.html#Expression.copy">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__str__"></a><span class="summary-sig-name">__str__</span>(<span class="summary-sig-arg">self</span>)</span><br />
the corresponding pattern string</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Expression-pysrc.html#Expression.__str__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="make_parser"></a><span class="summary-sig-name">make_parser</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">debug_level</span>=<span class="summary-sig-default">0</span>)</span><br />
create a SAX compliant parser for this regexp</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Expression-pysrc.html#Expression.make_parser">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="make_iterator"></a><span class="summary-sig-name">make_iterator</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">tag</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">record</code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">debug_level</span>=<span class="summary-sig-default">0</span>)</span><br />
create an iterator for this regexp; the 'tag' defines a record</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Expression-pysrc.html#Expression.make_iterator">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="Martel.Expression.Expression-class.html#_modify_leaves" class="summary-sig-name" onclick="show_private();">_modify_leaves</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">func</span>)</span><br />
internal function for manipulating the leaves of an expression</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Expression-pysrc.html#Expression._modify_leaves">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="_select_names"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_select_names</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">names</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Martel.Expression-pysrc.html#Expression._select_names">source code</a></span>
</td>
</tr></table>
<p>internal function used by 'select_names'.</p>
<p>Don't call this function. Will likely be removed in future
versions.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_modify_leaves"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_modify_leaves</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">func</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Martel.Expression-pysrc.html#Expression._modify_leaves">source code</a></span>
</td>
</tr></table>
<p>internal function for manipulating the leaves of an expression</p>
<p>This really needs to be some sort of visit pattern, but I'm not sure
the best way to do it. THIS METHOD MAY CHANGE.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Mon Sep 15 09:26:39 2008
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
