<!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>Language.Haskell.Exts</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_Language-Haskell-Exts.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Language-Haskell-Exts.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">haskell-src-exts-1.10.2: Manipulating Haskell source: abstract syntax, lexer, parser, and pretty-printer</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable</td></tr><tr><th>Stability</th><td>stable</td></tr><tr><th>Maintainer</th><td>Niklas Broberg, d00nibro@chalmers.se</td></tr></table><p class="caption">Language.Haskell.Exts</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Re-exported modules
</a></li><li><a href="#g:2">Parsing of Haskell source files
</a></li><li><a href="#g:3">Read extensions declared in LANGUAGE pragmas
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>An umbrella module for the various functionality
of the package. Also provides some convenient
functionality for dealing directly with source files.
</p></div></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">module <a href="Language-Haskell-Exts-Syntax.html">Language.Haskell.Exts.Syntax</a></li><li class="src short">module <a href="Language-Haskell-Exts-Build.html">Language.Haskell.Exts.Build</a></li><li class="src short">module <a href="Language-Haskell-Exts-Parser.html">Language.Haskell.Exts.Parser</a></li><li class="src short">module <a href="Language-Haskell-Exts-Pretty.html">Language.Haskell.Exts.Pretty</a></li><li class="src short">module <a href="Language-Haskell-Exts-Extension.html">Language.Haskell.Exts.Extension</a></li><li class="src short">module <a href="Language-Haskell-Exts-Fixity.html">Language.Haskell.Exts.Fixity</a></li><li class="src short">module <a href="Language-Haskell-Exts-Comments.html">Language.Haskell.Exts.Comments</a></li><li class="src short"><a href="#v:parseFile">parseFile</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Language-Haskell-Exts-Parser.html#t:ParseResult">ParseResult</a> <a href="Language-Haskell-Exts-Syntax.html#t:Module">Module</a>)</li><li class="src short"><a href="#v:parseFileWithMode">parseFileWithMode</a> :: <a href="Language-Haskell-Exts-Parser.html#t:ParseMode">ParseMode</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Language-Haskell-Exts-Parser.html#t:ParseResult">ParseResult</a> <a href="Language-Haskell-Exts-Syntax.html#t:Module">Module</a>)</li><li class="src short"><a href="#v:parseFileWithExts">parseFileWithExts</a> :: [<a href="Language-Haskell-Exts-Extension.html#t:Extension">Extension</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Language-Haskell-Exts-Parser.html#t:ParseResult">ParseResult</a> <a href="Language-Haskell-Exts-Syntax.html#t:Module">Module</a>)</li><li class="src short"><a href="#v:parseFileWithComments">parseFileWithComments</a> :: <a href="Language-Haskell-Exts-Parser.html#t:ParseMode">ParseMode</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Language-Haskell-Exts-Parser.html#t:ParseResult">ParseResult</a> (<a href="Language-Haskell-Exts-Syntax.html#t:Module">Module</a>, [<a href="Language-Haskell-Exts-Comments.html#t:Comment">Comment</a>]))</li><li class="src short"><a href="#v:parseFileContents">parseFileContents</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Language-Haskell-Exts-Parser.html#t:ParseResult">ParseResult</a> <a href="Language-Haskell-Exts-Syntax.html#t:Module">Module</a></li><li class="src short"><a href="#v:parseFileContentsWithMode">parseFileContentsWithMode</a> :: <a href="Language-Haskell-Exts-Parser.html#t:ParseMode">ParseMode</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Language-Haskell-Exts-Parser.html#t:ParseResult">ParseResult</a> <a href="Language-Haskell-Exts-Syntax.html#t:Module">Module</a></li><li class="src short"><a href="#v:parseFileContentsWithExts">parseFileContentsWithExts</a> :: [<a href="Language-Haskell-Exts-Extension.html#t:Extension">Extension</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Language-Haskell-Exts-Parser.html#t:ParseResult">ParseResult</a> <a href="Language-Haskell-Exts-Syntax.html#t:Module">Module</a></li><li class="src short"><a href="#v:parseFileContentsWithComments">parseFileContentsWithComments</a> :: <a href="Language-Haskell-Exts-Parser.html#t:ParseMode">ParseMode</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Language-Haskell-Exts-Parser.html#t:ParseResult">ParseResult</a> (<a href="Language-Haskell-Exts-Syntax.html#t:Module">Module</a>, [<a href="Language-Haskell-Exts-Comments.html#t:Comment">Comment</a>])</li><li class="src short"><a href="#v:readExtensions">readExtensions</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> [<a href="Language-Haskell-Exts-Extension.html#t:Extension">Extension</a>]</li></ul></div><div id="interface"><h1 id="g:1">Re-exported modules
</h1><div class="top"><p class="src">module <a href="Language-Haskell-Exts-Syntax.html">Language.Haskell.Exts.Syntax</a></p></div><div class="top"><p class="src">module <a href="Language-Haskell-Exts-Build.html">Language.Haskell.Exts.Build</a></p></div><div class="top"><p class="src">module <a href="Language-Haskell-Exts-Parser.html">Language.Haskell.Exts.Parser</a></p></div><div class="top"><p class="src">module <a href="Language-Haskell-Exts-Pretty.html">Language.Haskell.Exts.Pretty</a></p></div><div class="top"><p class="src">module <a href="Language-Haskell-Exts-Extension.html">Language.Haskell.Exts.Extension</a></p></div><div class="top"><p class="src">module <a href="Language-Haskell-Exts-Fixity.html">Language.Haskell.Exts.Fixity</a></p></div><div class="top"><p class="src">module <a href="Language-Haskell-Exts-Comments.html">Language.Haskell.Exts.Comments</a></p></div><h1 id="g:2">Parsing of Haskell source files
</h1><div class="top"><p class="src"><a name="v:parseFile" class="def">parseFile</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Language-Haskell-Exts-Parser.html#t:ParseResult">ParseResult</a> <a href="Language-Haskell-Exts-Syntax.html#t:Module">Module</a>)<a href="src/Language-Haskell-Exts.html#parseFile" class="link">Source</a></p><div class="doc"><p>Parse a source file on disk, using the default parse mode.
</p></div></div><div class="top"><p class="src"><a name="v:parseFileWithMode" class="def">parseFileWithMode</a> :: <a href="Language-Haskell-Exts-Parser.html#t:ParseMode">ParseMode</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Language-Haskell-Exts-Parser.html#t:ParseResult">ParseResult</a> <a href="Language-Haskell-Exts-Syntax.html#t:Module">Module</a>)<a href="src/Language-Haskell-Exts.html#parseFileWithMode" class="link">Source</a></p><div class="doc"><p>Parse a source file on disk, supplying a custom parse mode.
</p></div></div><div class="top"><p class="src"><a name="v:parseFileWithExts" class="def">parseFileWithExts</a> :: [<a href="Language-Haskell-Exts-Extension.html#t:Extension">Extension</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Language-Haskell-Exts-Parser.html#t:ParseResult">ParseResult</a> <a href="Language-Haskell-Exts-Syntax.html#t:Module">Module</a>)<a href="src/Language-Haskell-Exts.html#parseFileWithExts" class="link">Source</a></p><div class="doc"><p>Parse a source file on disk, with an extra set of extensions to know about
on top of what the file itself declares.
</p></div></div><div class="top"><p class="src"><a name="v:parseFileWithComments" class="def">parseFileWithComments</a> :: <a href="Language-Haskell-Exts-Parser.html#t:ParseMode">ParseMode</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="Language-Haskell-Exts-Parser.html#t:ParseResult">ParseResult</a> (<a href="Language-Haskell-Exts-Syntax.html#t:Module">Module</a>, [<a href="Language-Haskell-Exts-Comments.html#t:Comment">Comment</a>]))<a href="src/Language-Haskell-Exts.html#parseFileWithComments" class="link">Source</a></p><div class="doc"><p>Parse a source file on disk, supplying a custom parse mode, and retaining comments.
</p></div></div><div class="top"><p class="src"><a name="v:parseFileContents" class="def">parseFileContents</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Language-Haskell-Exts-Parser.html#t:ParseResult">ParseResult</a> <a href="Language-Haskell-Exts-Syntax.html#t:Module">Module</a><a href="src/Language-Haskell-Exts.html#parseFileContents" class="link">Source</a></p><div class="doc"><p>Parse a source file from a string using the default parse mode.
</p></div></div><div class="top"><p class="src"><a name="v:parseFileContentsWithMode" class="def">parseFileContentsWithMode</a> :: <a href="Language-Haskell-Exts-Parser.html#t:ParseMode">ParseMode</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Language-Haskell-Exts-Parser.html#t:ParseResult">ParseResult</a> <a href="Language-Haskell-Exts-Syntax.html#t:Module">Module</a><a href="src/Language-Haskell-Exts.html#parseFileContentsWithMode" class="link">Source</a></p><div class="doc"><p>Parse a source file from a string using a custom parse mode.
</p></div></div><div class="top"><p class="src"><a name="v:parseFileContentsWithExts" class="def">parseFileContentsWithExts</a> :: [<a href="Language-Haskell-Exts-Extension.html#t:Extension">Extension</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Language-Haskell-Exts-Parser.html#t:ParseResult">ParseResult</a> <a href="Language-Haskell-Exts-Syntax.html#t:Module">Module</a><a href="src/Language-Haskell-Exts.html#parseFileContentsWithExts" class="link">Source</a></p><div class="doc"><p>Parse a source file from a string, with an extra set of extensions to know about
on top of what the file itself declares.
</p></div></div><div class="top"><p class="src"><a name="v:parseFileContentsWithComments" class="def">parseFileContentsWithComments</a> :: <a href="Language-Haskell-Exts-Parser.html#t:ParseMode">ParseMode</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="Language-Haskell-Exts-Parser.html#t:ParseResult">ParseResult</a> (<a href="Language-Haskell-Exts-Syntax.html#t:Module">Module</a>, [<a href="Language-Haskell-Exts-Comments.html#t:Comment">Comment</a>])<a href="src/Language-Haskell-Exts.html#parseFileContentsWithComments" class="link">Source</a></p><div class="doc"><p>Parse a source file from a string using a custom parse mode and retaining comments.
</p></div></div><h1 id="g:3">Read extensions declared in LANGUAGE pragmas
</h1><div class="top"><p class="src"><a name="v:readExtensions" class="def">readExtensions</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> [<a href="Language-Haskell-Exts-Extension.html#t:Extension">Extension</a>]<a href="src/Language-Haskell-Exts.html#readExtensions" class="link">Source</a></p><div class="doc"><p>Gather the extensions declared in LANGUAGE pragmas
at the top of the file. Returns <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> if the
parse of the pragmas fails.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
