<?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.HeaderFooter</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 HeaderFooter </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.HeaderFooter-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class HeaderFooter</h1><p class="nomargin-top"><span class="codelink"><a href="Martel.Expression-pysrc.html#HeaderFooter">source code</a></span></p> <pre class="base-tree"> <a href="Martel.Expression.Expression-class.html">Expression</a> --+ | <a href="Martel.Expression.PassThrough-class.html">PassThrough</a> --+ | <strong class="uidshort">HeaderFooter</strong> </pre> <hr /> <!-- ==================== 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 href="Martel.Expression.HeaderFooter-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">format_name</span>, <span class="summary-sig-arg">attrs</span>, <span class="summary-sig-arg">header_expression</span>, <span class="summary-sig-arg">make_header_reader</span>, <span class="summary-sig-arg">header_args</span>, <span class="summary-sig-arg">record_expression</span>, <span class="summary-sig-arg">make_record_reader</span>, <span class="summary-sig-arg">record_args</span>, <span class="summary-sig-arg">footer_expression</span>, <span class="summary-sig-arg">make_footer_reader</span>, <span class="summary-sig-arg">footer_args</span>)</span><br /> (expression)</td> <td align="right" valign="top"> <span class="codelink"><a href="Martel.Expression-pysrc.html#HeaderFooter.__init__">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 href="Martel.Expression.HeaderFooter-class.html#copy" class="summary-sig-name">copy</a>(<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#HeaderFooter.copy">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.HeaderFooter-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#HeaderFooter._modify_leaves">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 href="Martel.Expression.HeaderFooter-class.html#make_parser" class="summary-sig-name">make_parser</a>(<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#HeaderFooter.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 href="Martel.Expression.HeaderFooter-class.html#make_iterator" class="summary-sig-name">make_iterator</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">tag</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#HeaderFooter.make_iterator">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 href="Martel.Expression.HeaderFooter-class.html#group_names" class="summary-sig-name">group_names</a>(<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#HeaderFooter.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 href="Martel.Expression.HeaderFooter-class.html#_find_groups" class="summary-sig-name" onclick="show_private();">_find_groups</a>(<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#HeaderFooter._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 href="Martel.Expression.HeaderFooter-class.html#features" class="summary-sig-name">features</a>(<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#HeaderFooter.features">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="Martel.Expression.PassThrough-class.html">PassThrough</a></code></b>: <code><a href="Martel.Expression.PassThrough-class.html#__str__">__str__</a></code> </p> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="Martel.Expression.PassThrough-class.html">PassThrough</a></code></b> (private): <code><a href="Martel.Expression.PassThrough-class.html#_select_names" onclick="show_private();">_select_names</a></code> </p></div> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="Martel.Expression.Expression-class.html">Expression</a></code></b>: <code><a href="Martel.Expression.Expression-class.html#__add__">__add__</a></code>, <code><a href="Martel.Expression.Expression-class.html#__or__">__or__</a></code> </p> </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="__init__"></a> <div> <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">__init__</span>(<span class="sig-arg">self</span>, <span class="sig-arg">format_name</span>, <span class="sig-arg">attrs</span>, <span class="sig-arg">header_expression</span>, <span class="sig-arg">make_header_reader</span>, <span class="sig-arg">header_args</span>, <span class="sig-arg">record_expression</span>, <span class="sig-arg">make_record_reader</span>, <span class="sig-arg">record_args</span>, <span class="sig-arg">footer_expression</span>, <span class="sig-arg">make_footer_reader</span>, <span class="sig-arg">footer_args</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Martel.Expression-pysrc.html#HeaderFooter.__init__">source code</a></span> </td> </tr></table> <p>(expression)</p> <p>Match the given subexpression. This class should not be used directly. It is meant for generating specialized parsers which read a record at a time.</p> <dl class="fields"> <dt>Overrides: <a href="Martel.Expression.PassThrough-class.html#__init__">PassThrough.__init__</a> <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="copy"></a> <div> <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">copy</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Martel.Expression-pysrc.html#HeaderFooter.copy">source code</a></span> </td> </tr></table> <p>do a deep copy on this Expression tree</p> <dl class="fields"> <dt>Overrides: <a href="Martel.Expression.Expression-class.html#copy">Expression.copy</a> <dd><em class="note">(inherited documentation)</em></dd> </dt> </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#HeaderFooter._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"> <dt>Overrides: <a href="Martel.Expression.Expression-class.html#_modify_leaves" onclick="show_private();">Expression._modify_leaves</a> <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="make_parser"></a> <div> <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">make_parser</span>(<span class="sig-arg">self</span>, <span class="sig-arg">debug_level</span>=<span class="sig-default">0</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Martel.Expression-pysrc.html#HeaderFooter.make_parser">source code</a></span> </td> </tr></table> <p>create a SAX compliant parser for this regexp</p> <dl class="fields"> <dt>Overrides: <a href="Martel.Expression.Expression-class.html#make_parser">Expression.make_parser</a> <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="make_iterator"></a> <div> <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">make_iterator</span>(<span class="sig-arg">self</span>, <span class="sig-arg">tag</span>, <span class="sig-arg">debug_level</span>=<span class="sig-default">0</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Martel.Expression-pysrc.html#HeaderFooter.make_iterator">source code</a></span> </td> </tr></table> <p>create an iterator for this regexp; the 'tag' defines a record</p> <dl class="fields"> <dt>Overrides: <a href="Martel.Expression.Expression-class.html#make_iterator">Expression.make_iterator</a> </dt> </dl> </td></tr></table> </div> <a name="group_names"></a> <div> <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">group_names</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Martel.Expression-pysrc.html#HeaderFooter.group_names">source code</a></span> </td> </tr></table> <p>the list of group names used by this Expression and its children</p> <dl class="fields"> <dt>Overrides: <a href="Martel.Expression.Expression-class.html#group_names">Expression.group_names</a> <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="_find_groups"></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">_find_groups</span>(<span class="sig-arg">self</span>, <span class="sig-arg">tag</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Martel.Expression-pysrc.html#HeaderFooter._find_groups">source code</a></span> </td> </tr></table> <p>return a list of all groups matching the given tag</p> <dl class="fields"> <dt>Overrides: <a href="Martel.Expression.Expression-class.html#_find_groups" onclick="show_private();">Expression._find_groups</a> <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="features"></a> <div> <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">features</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Martel.Expression-pysrc.html#HeaderFooter.features">source code</a></span> </td> </tr></table> <p>return a list of all features</p> <dl class="fields"> <dt>Overrides: <a href="Martel.Expression.Expression-class.html#features">Expression.features</a> </dt> </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>