<?xml version="1.0" encoding="utf-8" ?> <!-- for emacs: -*- coding: utf-8 -*- -->
<!-- Apache may like this line in the file .htaccess: AddCharset utf-8 .html -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg-flat.dtd" >
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head><title>Parsing -- a framework for building parsers</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="___Analyzer.html">next</a> | previous | <a href="_nil.html">forward</a> | backward | up | top | <a href="master.html">index</a> | <a href="toc.html">toc</a> | <a href="http://www.math.uiuc.edu/Macaulay2/">Macaulay2 web site</a></div>
</td>
</tr>
</table>
<hr/>
<div><h1>Parsing -- a framework for building parsers</h1>
<div class="single"><h2>Description</h2>
<div><p><a href="index.html" title="a framework for building parsers">Parsing</a> is a package the provides a framework for building parsers. It introduces <a href="___Parser.html" title="the class of all parsers">Parser</a>, a type of function that parses a sequence of tokens, and <a href="___Analyzer.html" title="the class of all lexical analyzers">Analyzer</a>, a type of function that accepts input for the parser in its original form and separates it into a stream of tokens. A parser can be combined with an analyzer: see <a href="___Parser_sp_co_sp__Analyzer.html" title="combine a parser with a lexical analyzer to make a complete system">Parser : Analyzer</a>, to produce a complete system for accepting input and parsing it.</p>
<p>See the package <a href="../../Classic/html/index.html" title="a parser for classic Macaulay syntax">Classic</a> for a good example of the use of this framework.</p>
</div>
</div>
<div class="single"><h2>Author</h2>
<ul><li><div class="single"><a href="http://www.math.uiuc.edu/~dan/">Daniel R. Grayson (高单)</a><span> <<a href="mailto:dan@math.uiuc.edu">dan@math.uiuc.edu</a>></span></div>
</li>
</ul>
</div>
<div class="single"><h2>Version</h2>
This documentation describes version <b>1.0</b> of Parsing.</div>
<div class="single"><h2>Source code</h2>
The source code from which this documentation is derived is in the file <a href="../../../../Macaulay2/Parsing.m2">Parsing.m2</a>.</div>
<div class="single"><h2>Exports</h2>
<ul><li><div class="single">Types<ul><li><span><a href="___Analyzer.html" title="the class of all lexical analyzers">Analyzer</a> -- the class of all lexical analyzers</span></li>
<li><span><a href="___Parser.html" title="the class of all parsers">Parser</a> -- the class of all parsers</span></li>
</ul>
</div>
</li>
<li><div class="single">Functions<ul><li><span><a href="_and__P.html" title="parser conjunction">andP</a> -- parser conjunction</span></li>
<li><span><a href="_char__Analyzer.html" title="a lexical analyzer that provides characters from a string one at a time">charAnalyzer</a> -- a lexical analyzer that provides characters from a string one at a time</span></li>
<li><span><a href="_const__Parser.html" title="produce a parser that accepts a fixed string, one character at a time">constParser</a> -- produce a parser that accepts a fixed string, one character at a time</span></li>
<li><span><a href="_dead__Parser.html" title="a parser which accepts no tokens and is not in a terminal state">deadParser</a> -- a parser which accepts no tokens and is not in a terminal state</span></li>
<li><span><a href="_future__Parser.html" title="forward reference to a parser not defined yet">futureParser</a> -- forward reference to a parser not defined yet</span></li>
<li><span><a href="_letter__Parser.html" title="a parser that accepts a single letter and returns it">letterParser</a> -- a parser that accepts a single letter and returns it</span></li>
<li><span><a href="___N__N__Parser.html" title="a parser that accepts (and returns) a natural number, one character at a time">NNParser</a> -- a parser that accepts (and returns) a natural number, one character at a time</span></li>
<li><span><a href="_nonspace__Analyzer.html" title="a lexical analyzer that provides non-white-space characters from a string one at a time">nonspaceAnalyzer</a> -- a lexical analyzer that provides non-white-space characters from a string one at a time</span></li>
<li><span><a href="_null__Parser.html" title="a terminal parser that returns the value nil">nullParser</a> -- a terminal parser that returns the value nil</span></li>
<li><span><a href="_optional__Sign__Parser.html" title="a parser that accepts an optional plus sign or minus sign">optionalSignParser</a> -- a parser that accepts an optional plus sign or minus sign</span></li>
<li><span><a href="_opt__P.html" title="making a parser optional">optP</a> -- making a parser optional</span></li>
<li><span><a href="_or__P.html" title="parsing alternatives">orP</a> -- parsing alternatives</span></li>
<li><span><a href="___Q__Q__Parser.html" title="a parser that accepts (and returns) a rational number, one character at a time">QQParser</a> -- a parser that accepts (and returns) a rational number, one character at a time</span></li>
<li><span><a href="_terminal__Parser.html" title="produce a parser in a terminal state">terminalParser</a> -- produce a parser in a terminal state</span></li>
<li><span><a href="___Z__Z__Parser.html" title="a parser that accepts (and returns) an integer, one character at a time">ZZParser</a> -- a parser that accepts (and returns) an integer, one character at a time</span></li>
</ul>
</div>
</li>
<li><div class="single">Methods<ul><li><span>Parser @ Parser, see <span><a href="_and__P.html" title="parser conjunction">andP</a> -- parser conjunction</span></span></li>
<li><span>Parser @ String, see <span><a href="_and__P.html" title="parser conjunction">andP</a> -- parser conjunction</span></span></li>
<li><span>String @ Parser, see <span><a href="_and__P.html" title="parser conjunction">andP</a> -- parser conjunction</span></span></li>
<li><span><a href="___Function_sp_pc_sp__Parser.html" title="transform the value returned by a parser">Function % Parser</a> -- transform the value returned by a parser</span></li>
<li><span>Parser | Parser, see <span><a href="_or__P.html" title="parsing alternatives">orP</a> -- parsing alternatives</span></span></li>
<li><span>Parser | String, see <span><a href="_or__P.html" title="parsing alternatives">orP</a> -- parsing alternatives</span></span></li>
<li><span>String | Parser, see <span><a href="_or__P.html" title="parsing alternatives">orP</a> -- parsing alternatives</span></span></li>
<li><span><a href="___Parser_sp_co_sp__Analyzer.html" title="combine a parser with a lexical analyzer to make a complete system">Parser : Analyzer</a> -- combine a parser with a lexical analyzer to make a complete system</span></li>
</ul>
</div>
</li>
<li><div class="single">Symbols<ul><li><span><a href="_nil.html" title="a symbol a parser may return to indicate acceptance of the empty string of tokens">nil</a> -- a symbol a parser may return to indicate acceptance of the empty string of tokens</span></li>
</ul>
</div>
</li>
</ul>
</div>
<div><h3>Menu</h3>
<ul><li><span><a href="___Analyzer.html" title="the class of all lexical analyzers">Analyzer</a> -- the class of all lexical analyzers</span></li>
<li><span><a href="___Parser.html" title="the class of all parsers">Parser</a> -- the class of all parsers</span></li>
<li><span><a href="___Parser_sp_co_sp__Analyzer.html" title="combine a parser with a lexical analyzer to make a complete system">Parser : Analyzer</a> -- combine a parser with a lexical analyzer to make a complete system</span></li>
</ul>
</div>
</div>
</body>
</html>
