<!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 >HeaderInfo</TITLE ><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css" ><SCRIPT SRC="haddock-util.js" TYPE="text/javascript" ></SCRIPT ><SCRIPT TYPE="text/javascript" >window.onload = function () {setSynopsis("mini_HeaderInfo.html")};</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" >ghc-6.12.3: The GHC API</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" >HeaderInfo</FONT ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" >Description</TD ></TR ><TR ><TD CLASS="doc" ><P >Parsing the top of a Haskell source file to get its module name, imports and options. </P ><P >(c) Simon Marlow 2005 (c) Lemmih 2006 </P ></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" ><A HREF="#v%3AgetImports" >getImports</A > :: <A HREF="HscTypes.html#t%3AGhcMonad" >GhcMonad</A > m => <A HREF="DynFlags.html#t%3ADynFlags" >DynFlags</A > -> <A HREF="StringBuffer.html#t%3AStringBuffer" >StringBuffer</A > -> <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath" >FilePath</A > -> <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath" >FilePath</A > -> m ([<A HREF="SrcLoc.html#t%3ALocated" >Located</A > (<A HREF="HsImpExp.html#t%3AImportDecl" >ImportDecl</A > <A HREF="RdrName.html#t%3ARdrName" >RdrName</A >)], [<A HREF="SrcLoc.html#t%3ALocated" >Located</A > (<A HREF="HsImpExp.html#t%3AImportDecl" >ImportDecl</A > <A HREF="RdrName.html#t%3ARdrName" >RdrName</A >)], <A HREF="SrcLoc.html#t%3ALocated" >Located</A > <A HREF="Module.html#t%3AModuleName" >ModuleName</A >)</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AgetOptionsFromFile" >getOptionsFromFile</A > :: <A HREF="DynFlags.html#t%3ADynFlags" >DynFlags</A > -> <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath" >FilePath</A > -> <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A > [<A HREF="SrcLoc.html#t%3ALocated" >Located</A > <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString" >String</A >]</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AgetOptions" >getOptions</A > :: <A HREF="DynFlags.html#t%3ADynFlags" >DynFlags</A > -> <A HREF="StringBuffer.html#t%3AStringBuffer" >StringBuffer</A > -> <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath" >FilePath</A > -> [<A HREF="SrcLoc.html#t%3ALocated" >Located</A > <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString" >String</A >]</TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AoptionsErrorMsgs" >optionsErrorMsgs</A > :: [<A HREF="../base-4.2.0.2/Data-Char.html#t%3AString" >String</A >] -> [<A HREF="SrcLoc.html#t%3ALocated" >Located</A > <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString" >String</A >] -> <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath" >FilePath</A > -> <A HREF="ErrUtils.html#t%3AMessages" >Messages</A ></TD ></TR ><TR ><TD CLASS="s8" ></TD ></TR ><TR ><TD CLASS="decl" ><A HREF="#v%3AcheckProcessArgsResult" >checkProcessArgsResult</A > :: <A HREF="MonadUtils.html#t%3AMonadIO" >MonadIO</A > m => [<A HREF="SrcLoc.html#t%3ALocated" >Located</A > <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString" >String</A >] -> m <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29" >()</A ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="section1" >Documentation</TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" ><A NAME="v:getImports" ><A NAME="v%3AgetImports" ></A ></A ><B >getImports</B ></TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="arg" >:: <A HREF="HscTypes.html#t%3AGhcMonad" >GhcMonad</A > m</TD ><TD CLASS="rdoc" ></TD ></TR ><TR ><TD CLASS="arg" >=> <A HREF="DynFlags.html#t%3ADynFlags" >DynFlags</A ></TD ><TD CLASS="rdoc" ></TD ></TR ><TR ><TD CLASS="arg" >-> <A HREF="StringBuffer.html#t%3AStringBuffer" >StringBuffer</A ></TD ><TD CLASS="rdoc" >Parse this. </TD ></TR ><TR ><TD CLASS="arg" >-> <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath" >FilePath</A ></TD ><TD CLASS="rdoc" >Filename the buffer came from. Used for reporting parse error locations. </TD ></TR ><TR ><TD CLASS="arg" >-> <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath" >FilePath</A ></TD ><TD CLASS="rdoc" >The original source filename (used for locations in the function result) </TD ></TR ><TR ><TD CLASS="arg" >-> m ([<A HREF="SrcLoc.html#t%3ALocated" >Located</A > (<A HREF="HsImpExp.html#t%3AImportDecl" >ImportDecl</A > <A HREF="RdrName.html#t%3ARdrName" >RdrName</A >)], [<A HREF="SrcLoc.html#t%3ALocated" >Located</A > (<A HREF="HsImpExp.html#t%3AImportDecl" >ImportDecl</A > <A HREF="RdrName.html#t%3ARdrName" >RdrName</A >)], <A HREF="SrcLoc.html#t%3ALocated" >Located</A > <A HREF="Module.html#t%3AModuleName" >ModuleName</A >)</TD ><TD CLASS="rdoc" >The source imports, normal imports, and the module name. </TD ></TR ><TR ><TD CLASS="ndoc" COLSPAN="2" ><P >Parse the imports of a source file. </P ><P >Throws a <TT ><A HREF="HscTypes.html#t%3ASourceError" >SourceError</A ></TT > if parsing fails. </P ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" ><A NAME="v:getOptionsFromFile" ><A NAME="v%3AgetOptionsFromFile" ></A ></A ><B >getOptionsFromFile</B ></TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="arg" >:: <A HREF="DynFlags.html#t%3ADynFlags" >DynFlags</A ></TD ><TD CLASS="rdoc" ></TD ></TR ><TR ><TD CLASS="arg" >-> <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath" >FilePath</A ></TD ><TD CLASS="rdoc" >Input file </TD ></TR ><TR ><TD CLASS="arg" >-> <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO" >IO</A > [<A HREF="SrcLoc.html#t%3ALocated" >Located</A > <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString" >String</A >]</TD ><TD CLASS="rdoc" >Parsed options, if any. </TD ></TR ><TR ><TD CLASS="ndoc" COLSPAN="2" ><P >Parse OPTIONS and LANGUAGE pragmas of the source file. </P ><P >Throws a <TT ><A HREF="HscTypes.html#t%3ASourceError" >SourceError</A ></TT > if flag parsing fails (including unsupported flags.) </P ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" ><A NAME="v:getOptions" ><A NAME="v%3AgetOptions" ></A ></A ><B >getOptions</B ></TD ></TR ><TR ><TD CLASS="body" ><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0" ><TR ><TD CLASS="arg" >:: <A HREF="DynFlags.html#t%3ADynFlags" >DynFlags</A ></TD ><TD CLASS="rdoc" ></TD ></TR ><TR ><TD CLASS="arg" >-> <A HREF="StringBuffer.html#t%3AStringBuffer" >StringBuffer</A ></TD ><TD CLASS="rdoc" >Input Buffer </TD ></TR ><TR ><TD CLASS="arg" >-> <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath" >FilePath</A ></TD ><TD CLASS="rdoc" >Source filename. Used for location info. </TD ></TR ><TR ><TD CLASS="arg" >-> [<A HREF="SrcLoc.html#t%3ALocated" >Located</A > <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString" >String</A >]</TD ><TD CLASS="rdoc" >Parsed options. </TD ></TR ><TR ><TD CLASS="ndoc" COLSPAN="2" ><P >Parse OPTIONS and LANGUAGE pragmas of the source file. </P ><P >Throws a <TT ><A HREF="HscTypes.html#t%3ASourceError" >SourceError</A ></TT > if flag parsing fails (including unsupported flags.) </P ></TD ></TR ></TABLE ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" ><A NAME="v:optionsErrorMsgs" ><A NAME="v%3AoptionsErrorMsgs" ></A ></A ><B >optionsErrorMsgs</B > :: [<A HREF="../base-4.2.0.2/Data-Char.html#t%3AString" >String</A >] -> [<A HREF="SrcLoc.html#t%3ALocated" >Located</A > <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString" >String</A >] -> <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath" >FilePath</A > -> <A HREF="ErrUtils.html#t%3AMessages" >Messages</A ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="decl" ><A NAME="v:checkProcessArgsResult" ><A NAME="v%3AcheckProcessArgsResult" ></A ></A ><B >checkProcessArgsResult</B > :: <A HREF="MonadUtils.html#t%3AMonadIO" >MonadIO</A > m => [<A HREF="SrcLoc.html#t%3ALocated" >Located</A > <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString" >String</A >] -> m <A HREF="../ghc-prim-0.2.0.0/GHC-Unit.html#t%3A%28%29" >()</A ></TD ></TR ><TR ><TD CLASS="doc" ><P >Complain about non-dynamic flags in OPTIONS pragmas. </P ><P >Throws a <TT ><A HREF="HscTypes.html#t%3ASourceError" >SourceError</A ></TT > if the input list is non-empty claiming that the input flags are unknown. </P ></TD ></TR ><TR ><TD CLASS="s15" ></TD ></TR ><TR ><TD CLASS="botbar" >Produced by <A HREF="http://www.haskell.org/haddock/" >Haddock</A > version 2.6.1</TD ></TR ></TABLE ></BODY ></HTML >