twisted.xish.xpathparser.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</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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;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&nbsp;twisted</a> ::
        <a href="twisted.xish.html">Package&nbsp;xish</a> ::
        Module&nbsp;xpathparser
      </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>&nbsp;|&nbsp;<a href="twisted.xish.xpathparser.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
    </table></td>
</tr></table>

<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.xish.xpathparser</h2>

<p>Run time libraries needed to run parsers generated by Yapps.</p>
This module defines parse-time exception classes, a scanner class, a 
base class for parsers produced by Yapps, and a context class that keeps 
track of the parse stack.
<hr/>

<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
  <th colspan="2">Classes</th></tr>
<tr><td width="15%">
  <b><a href="twisted.xish.xpathparser.Context.html"><code>Context</code></a></b></td>
  <td>Class to represent the parser's call stack.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.xish.xpathparser.Parser.html"><code>Parser</code></a></b></td>
  <td>Base class for Yapps-generated parsers.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.xish.xpathparser.Scanner.html"><code>Scanner</code></a></b></td>
  <td>Yapps scanner.</td></tr>
<tr><td width="15%">
  <b><a href="twisted.xish.xpathparser.XPathParser.html"><code>XPathParser</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.xish.xpathparser.XPathParserScanner.html"><code>XPathParserScanner</code></a></b></td>
  <td>&nbsp;</td></tr>
</table><br />


<!-- =========== START OF EXCEPTIONS =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
  <th colspan="2">Exceptions</th></tr>
<tr><td width="15%">
  <b><a href="twisted.xish.xpathparser.NoMoreTokens.html"><code>NoMoreTokens</code></a></b></td>
  <td>Another exception object, for when we run out of tokens</td></tr>
<tr><td width="15%">
  <b><a href="twisted.xish.xpathparser.SyntaxError.html"><code>SyntaxError</code></a></b></td>
  <td>When we run into an unexpected token, this is the exception to use</td></tr>
</table><br />


<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
  <th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="parse"></a><span class="summary-sig"><span class="summary-sig-name">parse</span>(<span class=summary-sig-arg>rule</span>,
          <span class=summary-sig-arg>text</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.xish.xpathparser.html#print_error" class="summary-sig-name"><code>print_error</code></a>(<span class=summary-sig-arg>input</span>,
          <span class=summary-sig-arg>err</span>,
          <span class=summary-sig-arg>scanner</span>)</span></code>
<br />
Print error messages, the parser stack, and the input text -- for 
human-readable error messages.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.xish.xpathparser.html#print_line_with_pointer" class="summary-sig-name"><code>print_line_with_pointer</code></a>(<span class=summary-sig-arg>text</span>,
          <span class=summary-sig-arg>p</span>)</span></code>
<br />
Print the line of 'text' that includes position 'p', along with a 
second line with a single caret (^) at position p</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="wrap_error_reporter"></a><span class="summary-sig"><span class="summary-sig-name">wrap_error_reporter</span>(<span class=summary-sig-arg>parser</span>,
          <span class=summary-sig-arg>rule</span>)</span></code>
</td></tr>
</table><br />


<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
  <th colspan="2">Function Details</th></tr>
</table>

<a name="print_error"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">print_error</span>(<span class=sig-arg>input</span>,
          <span class=sig-arg>err</span>,
          <span class=sig-arg>scanner</span>)</span>
  </h3>
  Print error messages, the parser stack, and the input text -- for 
  human-readable error messages.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="print_line_with_pointer"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">print_line_with_pointer</span>(<span class=sig-arg>text</span>,
          <span class=sig-arg>p</span>)</span>
  </h3>
  Print the line of 'text' that includes position 'p', along with a 
  second line with a single caret (^) at position p
  <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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;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:37 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>