Sophie: ghc-0:6.10.4-1mdv2010.0 i586

ghc-6.10.4-1mdv2010.0.i586.rpm

<!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
>Distribution.PackageDescription.Parse</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_Distribution-PackageDescription-Parse.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"
>Cabal-1.6.0.3: A framework for packaging Haskell software</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"
>Distribution.PackageDescription.Parse</FONT
></TD
><TD ALIGN="right"
><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="infohead"
>Portability</TD
><TD CLASS="infoval"
>portable</TD
></TR
><TR
><TD CLASS="infohead"
>Maintainer</TD
><TD CLASS="infoval"
>cabal-devel@haskell.org</TD
></TR
></TABLE
></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"
>Package descriptions
</A
></DT
><DD
><DL
><DT
><A HREF="#2"
>Parsing
</A
></DT
><DT
><A HREF="#3"
>Supplementary build information
</A
></DT
></DL
></DD
></DL
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
>This defined parsers and partial pretty printers for the <TT
>.cabal</TT
> format.
 Some of the complexity in this module is due to the fact that we have to be
 backwards compatible with old <TT
>.cabal</TT
> files, so there's code to translate
 into the newer structure.
</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%3AreadPackageDescription"
>readPackageDescription</A
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Distribution-PackageDescription.html#t%3AGenericPackageDescription"
>GenericPackageDescription</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AwritePackageDescription"
>writePackageDescription</A
> :: <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
> -&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AparsePackageDescription"
>parsePackageDescription</A
> :: <A HREF="../base/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="Distribution-PackageDescription-Parse.html#t%3AParseResult"
>ParseResult</A
> <A HREF="Distribution-PackageDescription.html#t%3AGenericPackageDescription"
>GenericPackageDescription</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AshowPackageDescription"
>showPackageDescription</A
> :: <A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
> -&gt; <A HREF="../base/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AParseResult"
>ParseResult</A
> a </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
>= <A HREF="#v%3AParseFailed"
>ParseFailed</A
> <A HREF="Distribution-ParseUtils.html#t%3APError"
>PError</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AParseOk"
>ParseOk</A
> [<A HREF="Distribution-ParseUtils.html#t%3APWarning"
>PWarning</A
>] a</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AFieldDescr"
>FieldDescr</A
> a = <A HREF="#v%3AFieldDescr"
>FieldDescr</A
> {<TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="recfield"
><A HREF="#v%3AfieldName"
>fieldName</A
> :: <A HREF="../base/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AfieldGet"
>fieldGet</A
> :: a -&gt; <A HREF="../pretty/Text-PrettyPrint-HughesPJ.html#t%3ADoc"
>Doc</A
></TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AfieldSet"
>fieldSet</A
> :: <A HREF="Distribution-PackageDescription-Parse.html#t%3ALineNo"
>LineNo</A
> -&gt; <A HREF="../base/Data-Char.html#t%3AString"
>String</A
> -&gt; a -&gt; <A HREF="Distribution-PackageDescription-Parse.html#t%3AParseResult"
>ParseResult</A
> a</TD
></TR
></TABLE
>}</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>type</SPAN
> <A HREF="#t%3ALineNo"
>LineNo</A
> = <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AreadHookedBuildInfo"
>readHookedBuildInfo</A
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Distribution-PackageDescription.html#t%3AHookedBuildInfo"
>HookedBuildInfo</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AparseHookedBuildInfo"
>parseHookedBuildInfo</A
> :: <A HREF="../base/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="Distribution-PackageDescription-Parse.html#t%3AParseResult"
>ParseResult</A
> <A HREF="Distribution-PackageDescription.html#t%3AHookedBuildInfo"
>HookedBuildInfo</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AwriteHookedBuildInfo"
>writeHookedBuildInfo</A
> :: <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="Distribution-PackageDescription.html#t%3AHookedBuildInfo"
>HookedBuildInfo</A
> -&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AshowHookedBuildInfo"
>showHookedBuildInfo</A
> :: <A HREF="Distribution-PackageDescription.html#t%3AHookedBuildInfo"
>HookedBuildInfo</A
> -&gt; <A HREF="../base/Data-Char.html#t%3AString"
>String</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"
><A NAME="1"
>Package descriptions
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:readPackageDescription"
><A NAME="v%3AreadPackageDescription"
></A
></A
><B
>readPackageDescription</B
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Distribution-PackageDescription.html#t%3AGenericPackageDescription"
>GenericPackageDescription</A
></TD
></TR
><TR
><TD CLASS="doc"
>Parse the given package file.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:writePackageDescription"
><A NAME="v%3AwritePackageDescription"
></A
></A
><B
>writePackageDescription</B
> :: <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
> -&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:parsePackageDescription"
><A NAME="v%3AparsePackageDescription"
></A
></A
><B
>parsePackageDescription</B
> :: <A HREF="../base/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="Distribution-PackageDescription-Parse.html#t%3AParseResult"
>ParseResult</A
> <A HREF="Distribution-PackageDescription.html#t%3AGenericPackageDescription"
>GenericPackageDescription</A
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Parses the given file into a <TT
><A HREF="Distribution-PackageDescription.html#t%3AGenericPackageDescription"
>GenericPackageDescription</A
></TT
>.
</P
><P
>In Cabal 1.2 the syntax for package descriptions was changed to a format
 with sections and possibly indented property descriptions.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:showPackageDescription"
><A NAME="v%3AshowPackageDescription"
></A
></A
><B
>showPackageDescription</B
> :: <A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
> -&gt; <A HREF="../base/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="2"
><A NAME="2"
>Parsing
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:ParseResult"
><A NAME="t%3AParseResult"
></A
></A
><B
>ParseResult</B
> a </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><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:ParseFailed"
><A NAME="v%3AParseFailed"
></A
></A
><B
>ParseFailed</B
> <A HREF="Distribution-ParseUtils.html#t%3APError"
>PError</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:ParseOk"
><A NAME="v%3AParseOk"
></A
></A
><B
>ParseOk</B
> [<A HREF="Distribution-ParseUtils.html#t%3APWarning"
>PWarning</A
>] a</TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:ParseResult')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:ParseResult" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="../base/Control-Monad.html#t%3AMonad"
>Monad</A
> <A HREF="Distribution-PackageDescription-Parse.html#t%3AParseResult"
>ParseResult</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../base/Text-Show.html#t%3AShow"
>Show</A
> a =&gt; <A HREF="../base/Text-Show.html#t%3AShow"
>Show</A
> (<A HREF="Distribution-PackageDescription-Parse.html#t%3AParseResult"
>ParseResult</A
> a)</TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:FieldDescr"
><A NAME="t%3AFieldDescr"
></A
></A
><B
>FieldDescr</B
> a </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>Field descriptor.  The parameter <TT
>a</TT
> parameterizes over where the field's
   value is stored in.
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="5" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:FieldDescr"
><A NAME="v%3AFieldDescr"
></A
></A
><B
>FieldDescr</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="body" COLSPAN="2"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:fieldName"
><A NAME="v%3AfieldName"
></A
></A
><B
>fieldName</B
> :: <A HREF="../base/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:fieldGet"
><A NAME="v%3AfieldGet"
></A
></A
><B
>fieldGet</B
> :: a -&gt; <A HREF="../pretty/Text-PrettyPrint-HughesPJ.html#t%3ADoc"
>Doc</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:fieldSet"
><A NAME="v%3AfieldSet"
></A
></A
><B
>fieldSet</B
> :: <A HREF="Distribution-PackageDescription-Parse.html#t%3ALineNo"
>LineNo</A
> -&gt; <A HREF="../base/Data-Char.html#t%3AString"
>String</A
> -&gt; a -&gt; <A HREF="Distribution-PackageDescription-Parse.html#t%3AParseResult"
>ParseResult</A
> a</TD
><TD CLASS="rdoc"
><TT
>fieldSet n str x</TT
> Parses the field value from the given input
 string <TT
>str</TT
> and stores the result in <TT
>x</TT
> if the parse was
 successful.  Otherwise, reports an error on line number <TT
>n</TT
>.
</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>type</SPAN
> <A NAME="t:LineNo"
><A NAME="t%3ALineNo"
></A
></A
><B
>LineNo</B
> = <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="3"
><A NAME="3"
>Supplementary build information
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:readHookedBuildInfo"
><A NAME="v%3AreadHookedBuildInfo"
></A
></A
><B
>readHookedBuildInfo</B
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Distribution-PackageDescription.html#t%3AHookedBuildInfo"
>HookedBuildInfo</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:parseHookedBuildInfo"
><A NAME="v%3AparseHookedBuildInfo"
></A
></A
><B
>parseHookedBuildInfo</B
> :: <A HREF="../base/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="Distribution-PackageDescription-Parse.html#t%3AParseResult"
>ParseResult</A
> <A HREF="Distribution-PackageDescription.html#t%3AHookedBuildInfo"
>HookedBuildInfo</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:writeHookedBuildInfo"
><A NAME="v%3AwriteHookedBuildInfo"
></A
></A
><B
>writeHookedBuildInfo</B
> :: <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="Distribution-PackageDescription.html#t%3AHookedBuildInfo"
>HookedBuildInfo</A
> -&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:showHookedBuildInfo"
><A NAME="v%3AshowHookedBuildInfo"
></A
></A
><B
>showHookedBuildInfo</B
> :: <A HREF="Distribution-PackageDescription.html#t%3AHookedBuildInfo"
>HookedBuildInfo</A
> -&gt; <A HREF="../base/Data-Char.html#t%3AString"
>String</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 2.4.2</TD
></TR
></TABLE
></BODY
></HTML
>