<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Agda.Syntax.Parser</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Agda-Syntax-Parser.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Agda-Syntax-Parser.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">Agda-2.3.2.1: A dependently typed functional programming language and proof assistant</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr></table><p class="caption">Agda.Syntax.Parser</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Types
</a></li><li><a href="#g:2">Parse functions
</a></li><li><a href="#g:3">Parsers
</a></li><li><a href="#g:4">Parse errors
</a></li></ul></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:Parser">Parser</a> a</li><li class="src short"><a href="#v:parse">parse</a> :: <a href="Agda-Syntax-Parser.html#t:Parser">Parser</a> a -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/System-IO.html#t:IO">IO</a> a</li><li class="src short"><a href="#v:parseLiterate">parseLiterate</a> :: <a href="Agda-Syntax-Parser.html#t:Parser">Parser</a> a -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/System-IO.html#t:IO">IO</a> a</li><li class="src short"><a href="#v:parsePosString">parsePosString</a> :: <a href="Agda-Syntax-Parser.html#t:Parser">Parser</a> a -> <a href="Agda-Syntax-Position.html#t:Position">Position</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/System-IO.html#t:IO">IO</a> a</li><li class="src short"><a href="#v:parseFile-39-">parseFile'</a> :: <a href="Agda-Syntax-Parser.html#t:Parser">Parser</a> a -> <a href="Agda-Utils-FileName.html#t:AbsolutePath">AbsolutePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/System-IO.html#t:IO">IO</a> a</li><li class="src short"><a href="#v:moduleParser">moduleParser</a> :: <a href="Agda-Syntax-Parser.html#t:Parser">Parser</a> <a href="Agda-Syntax-Concrete.html#t:Module">Module</a></li><li class="src short"><a href="#v:exprParser">exprParser</a> :: <a href="Agda-Syntax-Parser.html#t:Parser">Parser</a> <a href="Agda-Syntax-Concrete.html#t:Expr">Expr</a></li><li class="src short"><a href="#v:tokensParser">tokensParser</a> :: <a href="Agda-Syntax-Parser.html#t:Parser">Parser</a> [<a href="Agda-Syntax-Parser-Tokens.html#t:Token">Token</a>]</li><li class="src short"><span class="keyword">data</span> <a href="#t:ParseError">ParseError</a> = <a href="#v:ParseError">ParseError</a> {<ul class="subs"><li><a href="#v:errPos">errPos</a> :: <a href="Agda-Syntax-Position.html#t:Position">Position</a></li><li><a href="#v:errInput">errInput</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a></li><li><a href="#v:errPrevToken">errPrevToken</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a></li><li><a href="#v:errMsg">errMsg</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a></li></ul>}</li></ul></div><div id="interface"><h1 id="g:1">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Parser" class="def">Parser</a> a <a href="src/Agda-Syntax-Parser.html#Parser" class="link">Source</a></p><div class="doc"><p>Wrapped Parser type.
</p></div></div><h1 id="g:2">Parse functions
</h1><div class="top"><p class="src"><a name="v:parse" class="def">parse</a> :: <a href="Agda-Syntax-Parser.html#t:Parser">Parser</a> a -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/System-IO.html#t:IO">IO</a> a<a href="src/Agda-Syntax-Parser.html#parse" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:parseLiterate" class="def">parseLiterate</a> :: <a href="Agda-Syntax-Parser.html#t:Parser">Parser</a> a -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/System-IO.html#t:IO">IO</a> a<a href="src/Agda-Syntax-Parser.html#parseLiterate" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:parsePosString" class="def">parsePosString</a> :: <a href="Agda-Syntax-Parser.html#t:Parser">Parser</a> a -> <a href="Agda-Syntax-Position.html#t:Position">Position</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/System-IO.html#t:IO">IO</a> a<a href="src/Agda-Syntax-Parser.html#parsePosString" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:parseFile-39-" class="def">parseFile'</a> :: <a href="Agda-Syntax-Parser.html#t:Parser">Parser</a> a -> <a href="Agda-Utils-FileName.html#t:AbsolutePath">AbsolutePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/System-IO.html#t:IO">IO</a> a<a href="src/Agda-Syntax-Parser.html#parseFile%27" class="link">Source</a></p></div><h1 id="g:3">Parsers
</h1><div class="top"><p class="src"><a name="v:moduleParser" class="def">moduleParser</a> :: <a href="Agda-Syntax-Parser.html#t:Parser">Parser</a> <a href="Agda-Syntax-Concrete.html#t:Module">Module</a><a href="src/Agda-Syntax-Parser.html#moduleParser" class="link">Source</a></p><div class="doc"><p>Parses a module.
</p></div></div><div class="top"><p class="src"><a name="v:exprParser" class="def">exprParser</a> :: <a href="Agda-Syntax-Parser.html#t:Parser">Parser</a> <a href="Agda-Syntax-Concrete.html#t:Expr">Expr</a><a href="src/Agda-Syntax-Parser.html#exprParser" class="link">Source</a></p><div class="doc"><p>Parses an expression.
</p></div></div><div class="top"><p class="src"><a name="v:tokensParser" class="def">tokensParser</a> :: <a href="Agda-Syntax-Parser.html#t:Parser">Parser</a> [<a href="Agda-Syntax-Parser-Tokens.html#t:Token">Token</a>]<a href="src/Agda-Syntax-Parser.html#tokensParser" class="link">Source</a></p><div class="doc"><p>Gives the parsed token stream (including comments).
</p></div></div><h1 id="g:4">Parse errors
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ParseError" class="def">ParseError</a> <a href="src/Agda-Syntax-Parser-Monad.html#ParseError" class="link">Source</a></p><div class="doc"><p>What you get if parsing fails.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ParseError" class="def">ParseError</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:errPos" class="def">errPos</a> :: <a href="Agda-Syntax-Position.html#t:Position">Position</a></dt><dd class="doc"><p>where the error occured
</p></dd><dt class="src"><a name="v:errInput" class="def">errInput</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a></dt><dd class="doc"><p>the remaining input
</p></dd><dt class="src"><a name="v:errPrevToken" class="def">errPrevToken</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a></dt><dd class="doc"><p>the previous token
</p></dd><dt class="src"><a name="v:errMsg" class="def">errMsg</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-String.html#t:String">String</a></dt><dd class="doc"><p>hopefully an explanation
of what happened
</p></dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:ParseError" class="caption collapser" onclick="toggleSection('i:ParseError')">Instances</p><div id="section.i:ParseError" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Text-Show.html#t:Show">Show</a> <a href="Agda-Syntax-Parser.html#t:ParseError">ParseError</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> <a href="Agda-Syntax-Parser.html#t:ParseError">ParseError</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.5.1.0/Control-Exception-Base.html#t:Exception">Exception</a> <a href="Agda-Syntax-Parser.html#t:ParseError">ParseError</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Agda-Syntax-Position.html#t:HasRange">HasRange</a> <a href="Agda-Syntax-Parser.html#t:ParseError">ParseError</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/mtl-2.1.2/Control-Monad-Error-Class.html#t:MonadError">MonadError</a> <a href="Agda-Syntax-Parser.html#t:ParseError">ParseError</a> <a href="Agda-Syntax-Parser-Monad.html#t:Parser">Parser</a></td><td class="doc empty"> </td></tr></table></div></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.11.0</p></div></body></html>
