<?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.Parser</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> ::
Module Parser
</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.Parser-module.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module Parser</h1><p class="nomargin-top"><span class="codelink"><a href="Martel.Parser-pysrc.html">source code</a></span></p>
<p>Implement Martel parsers.</p>
<p>The classes in this module are used by other Martel modules and not
typically by external users.</p>
<p>There are two major parsers, 'Parser' and 'RecordParser.' The first
is the standard one, which parses the file as one string in memory then
generates the SAX events. The other reads a record at a time using a
RecordReader and generates events after each read. The generated event
callbacks are identical.</p>
<p>At some level, both parsers use "_do_callback" to convert
mxTextTools tags into SAX events.</p>
<p>XXX finish this documentation</p>
<p>XXX need a better way to get closer to the likely error position when
parsing.</p>
<p>XXX need to implement Locator</p>
<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></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">Classes</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Classes"
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">
<a href="Martel.Parser.ParserException-class.html" class="summary-name">ParserException</a><br />
used when a parse cannot be done
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Martel.Parser.ParserPositionException-class.html" class="summary-name">ParserPositionException</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Martel.Parser.ParserIncompleteException-class.html" class="summary-name">ParserIncompleteException</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Martel.Parser.ParserRecordException-class.html" class="summary-name">ParserRecordException</a><br />
used by the RecordParser when it can't read a record
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Martel.Parser.MartelAttributeList-class.html" class="summary-name">MartelAttributeList</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Martel.Parser.Parser-class.html" class="summary-name">Parser</a><br />
Parse the input data all in memory
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Martel.Parser.RecordParser-class.html" class="summary-name">RecordParser</a><br />
Parse the input data a record at a time
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="Martel.Parser.HeaderFooterParser-class.html" class="summary-name">HeaderFooterParser</a><br />
Header followed by 0 or more records followed by a footer
</td>
</tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></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">Functions</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Functions"
class="privatelink" onclick="toggle_private();"
>hide private</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.Parser-module.html#_do_callback" class="summary-sig-name" onclick="show_private();">_do_callback</a>(<span class="summary-sig-arg">s</span>,
<span class="summary-sig-arg">begin</span>,
<span class="summary-sig-arg">end</span>,
<span class="summary-sig-arg">taglist</span>,
<span class="summary-sig-arg">cont_handler</span>,
<span class="summary-sig-arg">attrlookup</span>)</span><br />
internal function to convert the tagtable into ContentHandler events</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Parser-pysrc.html#_do_callback">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.Parser-module.html#_do_dispatch_callback" class="summary-sig-name" onclick="show_private();">_do_dispatch_callback</a>(<span class="summary-sig-arg">s</span>,
<span class="summary-sig-arg">begin</span>,
<span class="summary-sig-arg">end</span>,
<span class="summary-sig-arg">taglist</span>,
<span class="summary-sig-arg">start_table_get</span>,
<span class="summary-sig-arg">cont_handler</span>,
<span class="summary-sig-arg">save_stack</span>,
<span class="summary-sig-arg">end_table_get</span>,
<span class="summary-sig-arg">attrlookup</span>)</span><br />
internal function to convert the tagtable into ContentHandler events</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Parser-pysrc.html#_do_dispatch_callback">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.Parser-module.html#_parse_elements" class="summary-sig-name" onclick="show_private();">_parse_elements</a>(<span class="summary-sig-arg">s</span>,
<span class="summary-sig-arg">tagtable</span>,
<span class="summary-sig-arg">cont_handler</span>,
<span class="summary-sig-arg">debug_level</span>,
<span class="summary-sig-arg">attrlookup</span>)</span><br />
parse the string with the tagtable and send the ContentHandler events</td>
<td align="right" valign="top">
<span class="codelink"><a href="Martel.Parser-pysrc.html#_parse_elements">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></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">Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Variables"
class="privatelink" onclick="toggle_private();"
>hide private</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">
<a name="_match_group"></a><span class="summary-name">_match_group</span> = <code title="{}"><code class="variable-group">{</code><code class="variable-group">}</code></code>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="_attribute_list"></a><span class="summary-name">_attribute_list</span> = <code title="{}">{}</code>
</td>
</tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></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">Function Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-FunctionDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="_do_callback"></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">_do_callback</span>(<span class="sig-arg">s</span>,
<span class="sig-arg">begin</span>,
<span class="sig-arg">end</span>,
<span class="sig-arg">taglist</span>,
<span class="sig-arg">cont_handler</span>,
<span class="sig-arg">attrlookup</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Martel.Parser-pysrc.html#_do_callback">source code</a></span>
</td>
</tr></table>
<p>internal function to convert the tagtable into ContentHandler
events</p>
<p>'s' is the input text 'begin' is the current position in the text
'end' is 1 past the last position of the text allowed to be parsed
'taglist' is the tag list from mxTextTools.parse 'cont_handler' is the
SAX ContentHandler 'attrlookup' is a dict mapping the encoded tag name to
the element info</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_do_dispatch_callback"></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">_do_dispatch_callback</span>(<span class="sig-arg">s</span>,
<span class="sig-arg">begin</span>,
<span class="sig-arg">end</span>,
<span class="sig-arg">taglist</span>,
<span class="sig-arg">start_table_get</span>,
<span class="sig-arg">cont_handler</span>,
<span class="sig-arg">save_stack</span>,
<span class="sig-arg">end_table_get</span>,
<span class="sig-arg">attrlookup</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Martel.Parser-pysrc.html#_do_dispatch_callback">source code</a></span>
</td>
</tr></table>
<p>internal function to convert the tagtable into ContentHandler
events</p>
<p>THIS IS A SPECIAL CASE FOR Dispatch.Dispatcher objects</p>
<p>'s' is the input text 'begin' is the current position in the text
'end' is 1 past the last position of the text allowed to be parsed
'taglist' is the tag list from mxTextTools.parse 'start_table_get' is the
Dispatcher._start_table 'cont_handler' is the Dispatcher 'end_table_get'
is the Dispatcher._end_table 'cont_handler' is the SAX ContentHandler
'attrlookup' is a dict mapping the encoded tag name to the element
info</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_parse_elements"></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">_parse_elements</span>(<span class="sig-arg">s</span>,
<span class="sig-arg">tagtable</span>,
<span class="sig-arg">cont_handler</span>,
<span class="sig-arg">debug_level</span>,
<span class="sig-arg">attrlookup</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Martel.Parser-pysrc.html#_parse_elements">source code</a></span>
</td>
</tr></table>
<p>parse the string with the tagtable and send the ContentHandler
events</p>
<p>Specifically, it sends the startElement, endElement and characters
events but not startDocument and endDocument.</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:29 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>
