polyparse-1.1: docs/haddock/Text-ParserCombinators-Poly-State.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.Poly.State</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/Poly/State.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.Poly.State</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
><DD
><DL
><DT
><A HREF="#2"
>basic parsers
</A
></DT
><DT
><A HREF="#3"
>State-handling
</A
></DT
><DT
><A HREF="#4"
>Re-parsing
</A
></DT
></DL
></DD
><DT
><A HREF="#5"
>Re-export all more general combinators.
</A
></DT
></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 -> [t] -> (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-Poly-State.html#t%3AParser"
>Parser</A
> s t a -> s -> [t] -> (Either String a, s, [t])</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Asatisfy"
>satisfy</A
> :: (t -> Bool) -> <A HREF="Text-ParserCombinators-Poly-State.html#t%3AParser"
>Parser</A
> s t t</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AstUpdate"
>stUpdate</A
> :: (s -> s) -> <A HREF="Text-ParserCombinators-Poly-State.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 -> a) -> <A HREF="Text-ParserCombinators-Poly-State.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-Poly-State.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] -> <A HREF="Text-ParserCombinators-Poly-State.html#t%3AParser"
>Parser</A
> s t ()</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
>module <A HREF="Text-ParserCombinators-Poly-Base.html"
>Text.ParserCombinators.Poly.Base</A
></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/Poly/State.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 -> [t] -> (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-Poly-State.html#t%3AParser"
>Parser</A
> s t)</TD
></TR
><TR
><TD CLASS="decl"
>Monad (<A HREF="Text-ParserCombinators-Poly-State.html#t%3AParser"
>Parser</A
> s t)</TD
></TR
><TR
><TD CLASS="decl"
><A HREF="Text-ParserCombinators-Poly-Base.html#t%3APolyParse"
>PolyParse</A
> (<A HREF="Text-ParserCombinators-Poly-State.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-Poly-State.html#t%3AParser"
>Parser</A
> s t a -> s -> [t] -> (Either String a, s, [t])</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/Poly/State.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="section2"
><A NAME="2"
>basic parsers
</A
></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 -> Bool) -> <A HREF="Text-ParserCombinators-Poly-State.html#t%3AParser"
>Parser</A
> s t t</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/Poly/State.html#satisfy"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="3"
>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 -> s) -> <A HREF="Text-ParserCombinators-Poly-State.html#t%3AParser"
>Parser</A
> s t ()</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/Poly/State.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 -> a) -> <A HREF="Text-ParserCombinators-Poly-State.html#t%3AParser"
>Parser</A
> s t a</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/Poly/State.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-Poly-State.html#t%3AParser"
>Parser</A
> s t s</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/Poly/State.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="4"
>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] -> <A HREF="Text-ParserCombinators-Poly-State.html#t%3AParser"
>Parser</A
> s t ()</TD
><TD CLASS="declbut"
><A HREF="src/Text/ParserCombinators/Poly/State.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="section1"
><A NAME="5"
>Re-export all more general combinators.
</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
>module <A HREF="Text-ParserCombinators-Poly-Base.html"
>Text.ParserCombinators.Poly.Base</A
></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
>