Text-ParserCombinators-PolyState.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Text.ParserCombinators.PolyState</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock.js" TYPE="text/javascript"
></SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>polyparse</TD
><TD CLASS="topbut"
><A HREF="src/Text/ParserCombinators/PolyState.html"
>Source code</A
></TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Text.ParserCombinators.PolyState</FONT
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="section4"
><B
>Contents</B
></TD
></TR
><TR
><TD
><DL
><DT
><A HREF="#1"
>The Parser datatype
</A
></DT
><DT
><A HREF="#2"
>Combinators:
</A
></DT
><DD
><DL
><DT
><A HREF="#3"
>Primitives
</A
></DT
><DT
><A HREF="#4"
>Error-handling
</A
></DT
><DT
><A HREF="#5"
>Choices
</A
></DT
><DT
><A HREF="#6"
>Sequences
</A
></DT
><DT
><A HREF="#7"
>State-handling
</A
></DT
><DT
><A HREF="#8"
>Re-parsing
</A
></DT
></DL
></DD
></DL
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>newtype</SPAN
> <A HREF="#t%3AParser"
>Parser</A
> s t a = <A HREF="#v%3AP"
>P</A
> (s -&gt; [t] -&gt; (EitherE String a, s, [t]))</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3ArunParser"
>runParser</A
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; s -&gt; [t] -&gt; (Either String a, s, [t])</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AfailBad"
>failBad</A
> :: String -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Acommit"
>commit</A
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Anext"
>next</A
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t t</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Asatisfy"
>satisfy</A
> :: (t -&gt; Bool) -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t t</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aapply"
>apply</A
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t (a -&gt; b) -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t b</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Adiscard"
>discard</A
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t b -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AadjustErr"
>adjustErr</A
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; (String -&gt; String) -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AadjustErrBad"
>adjustErrBad</A
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; (String -&gt; String) -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aindent"
>indent</A
> :: Int -&gt; String -&gt; String</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AonFail"
>onFail</A
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AoneOf"
>oneOf</A
> :: [<A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a] -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AoneOf%27"
>oneOf'</A
> :: [(String, <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a)] -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aexactly"
>exactly</A
> :: Int -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t [a]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Amany"
>many</A
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t [a]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Amany1"
>many1</A
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t [a]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsepBy"
>sepBy</A
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t sep -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t [a]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsepBy1"
>sepBy1</A
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t sep -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t [a]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AbracketSep"
>bracketSep</A
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t bra -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t sep -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t ket -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t [a]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Abracket"
>bracket</A
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t bra -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t ket -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AmanyFinally"
>manyFinally</A
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t z -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t [a]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AstUpdate"
>stUpdate</A
> :: (s -&gt; s) -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t ()</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AstQuery"
>stQuery</A
> :: (s -&gt; a) -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AstGet"
>stGet</A
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t s</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Areparse"
>reparse</A
> :: [t] -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t ()</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="1"
>The Parser datatype
</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>newtype</SPAN
> <A NAME="t%3AParser"
></A
><B
>Parser</B
> s t a</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#Parser"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>The <TT
>Parser</TT
> datatype is a fairly generic parsing monad with error
   reporting and a running state.  It can be used for arbitrary token
   types, not just String input.
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v%3AP"
></A
><B
>P</B
> (s -&gt; [t] -&gt; (EitherE String a, s, [t]))</TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:Parser')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:Parser" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
>Functor (<A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t)</TD
></TR
><TR
><TD CLASS="decl"
>Monad (<A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t)</TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3ArunParser"
></A
><B
>runParser</B
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; s -&gt; [t] -&gt; (Either String a, s, [t])</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#runParser"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Apply a parser to an initial state and input token sequence.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AfailBad"
></A
><B
>failBad</B
> :: String -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#failBad"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>When a simple fail is not strong enough, use failBad for emphasis.
   An emphasised (severe) error can propagate out through choice operators.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3Acommit"
></A
><B
>commit</B
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#commit"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Commit is a way of raising the severity of any errors found within
   its argument.  Used in the middle of a parser definition, it means that
   any operations prior to commitment fail softly, but after commitment,
   they fail hard.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="2"
>Combinators:
</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="3"
>Primitives
</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3Anext"
></A
><B
>next</B
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t t</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#next"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>One token
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3Asatisfy"
></A
><B
>satisfy</B
> :: (t -&gt; Bool) -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t t</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#satisfy"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>One token satifying a predicate
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3Aapply"
></A
><B
>apply</B
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t (a -&gt; b) -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t b</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#apply"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Apply a parsed function to a parsed value
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3Adiscard"
></A
><B
>discard</B
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t b -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#discard"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><TT
>x <TT
><A HREF="Text-ParserCombinators-PolyState.html#v%3Adiscard"
>discard</A
></TT
> y</TT
> parses both x and y, but discards the result of y
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="4"
>Error-handling
</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AadjustErr"
></A
><B
>adjustErr</B
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; (String -&gt; String) -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#adjustErr"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><TT
>p <TT
><A HREF="Text-ParserCombinators-PolyState.html#v%3AadjustErr"
>adjustErr</A
></TT
> f</TT
> applies the transformation <TT
>f</TT
> to any error message
   generated in <TT
>p</TT
>, having no effect if <TT
>p</TT
> succeeds.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AadjustErrBad"
></A
><B
>adjustErrBad</B
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; (String -&gt; String) -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#adjustErrBad"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><TT
>adjustErrBad</TT
> is just like <TT
>adjustErr</TT
> except it also raises the
   severity of the error.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3Aindent"
></A
><B
>indent</B
> :: Int -&gt; String -&gt; String</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#indent"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Helper for formatting error messages: indents all lines by a fixed amount.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="5"
>Choices
</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AonFail"
></A
><B
>onFail</B
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#onFail"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><TT
>p <TT
><A HREF="Text-ParserCombinators-PolyState.html#v%3AonFail"
>onFail</A
></TT
> q</TT
> means parse p unless p fails in which case parse q instead.
   Can be chained together to give multiple attempts to parse something.
   (Note that q could itself be a failing parser, e.g. to change the error
   message from that defined in p to something different.)
   However, a severe failure in p cannot be ignored.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AoneOf"
></A
><B
>oneOf</B
> :: [<A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a] -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#oneOf"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Parse the first alternative in the list that succeeds.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AoneOf%27"
></A
><B
>oneOf'</B
> :: [(String, <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a)] -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#oneOf%27"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Parse the first alternative that succeeds, but if none succeed,
   report only the severe errors, and if none of those, then report
   all the soft errors.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="6"
>Sequences
</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3Aexactly"
></A
><B
>exactly</B
> :: Int -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t [a]</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#exactly"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>'exactly n p' parses a precise number of items, n, using the parser
   p, in sequence.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3Amany"
></A
><B
>many</B
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t [a]</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#many"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>'many p' parses a list of elements with individual parser p.
   Cannot fail, since an empty list is a valid return value.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3Amany1"
></A
><B
>many1</B
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t [a]</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#many1"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Parse a non-empty list of items.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AsepBy"
></A
><B
>sepBy</B
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t sep -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t [a]</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#sepBy"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Parse a list of items separated by discarded junk.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AsepBy1"
></A
><B
>sepBy1</B
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t sep -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t [a]</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#sepBy1"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Parse a non-empty list of items separated by discarded junk.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AbracketSep"
></A
><B
>bracketSep</B
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t bra -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t sep -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t ket -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t [a]</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#bracketSep"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Parse a list of items, discarding the start, end, and separator
   items.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3Abracket"
></A
><B
>bracket</B
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t bra -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t ket -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#bracket"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Parse a bracketed item, discarding the brackets.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AmanyFinally"
></A
><B
>manyFinally</B
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t z -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t [a]</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#manyFinally"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>'manyFinally e t' parses a possibly-empty sequence of e's,
   terminated by a t.  Any parse failures could be due either to
   a badly-formed terminator or a badly-formed element, so raise
   both possible errors.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="7"
>State-handling
</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AstUpdate"
></A
><B
>stUpdate</B
> :: (s -&gt; s) -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t ()</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#stUpdate"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Update the internal state.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AstQuery"
></A
><B
>stQuery</B
> :: (s -&gt; a) -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t a</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#stQuery"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Query the internal state.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3AstGet"
></A
><B
>stGet</B
> :: <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t s</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#stGet"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Deliver the entire internal state.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="8"
>Re-parsing
</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v%3Areparse"
></A
><B
>reparse</B
> :: [t] -&gt; <A HREF="Text-ParserCombinators-PolyState.html#t%3AParser"
>Parser</A
> s t ()</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/PolyState.html#reparse"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Push some tokens back onto the front of the input stream and reparse.
   This is useful e.g. for recursively expanding macros.  When the
   user-parser recognises a macro use, it can lookup the macro
   expansion from the parse state, lex it, and then stuff the
   lexed expansion back down into the parser.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 0.8</TD
></TR
></TABLE
></BODY
></HTML
>