Sophie: ghc-Cabal-devel-1.8.0.6-8.6.fc14 i686

ghc-Cabal-devel-1.8.0.6-8.6.fc14.i686.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.Simple.Program.Db</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-Simple-Program-Db.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.8.0.6: 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.Simple.Program.Db</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"
>The collection of configured programs we can run
</A
></DT
><DD
><DL
><DT
><A HREF="#2"
>Query and manipulate the program db
</A
></DT
><DT
><A HREF="#3"
>Query and manipulate the program db
</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"
><P
>This provides a <TT
><A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TT
> type which holds configured and not-yet
 configured programs. It is the parameter to lots of actions elsewhere in
 Cabal that need to look up and run programs. If we had a Cabal monad,
 the <TT
><A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TT
> would probably be a reader or state component of it.
</P
><P
>One nice thing about using it is that any program that is
 registered with Cabal will get some &quot;configure&quot; and &quot;.cabal&quot;
 helpers like --with-foo-args --foo-path= and extra-foo-args.
</P
><P
>There's also a hook for adding programs in a Setup.lhs script.  See
 hookedPrograms in Distribution.Simple.UserHooks.  This gives a
 hook user the ability to get the above flags and such so that they
 don't have to write all the PATH logic inside Setup.lhs.
</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"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AProgramDb"
>ProgramDb</A
> </TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AemptyProgramDb"
>emptyProgramDb</A
> :: <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AdefaultProgramDb"
>defaultProgramDb</A
> :: <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3ArestoreProgramDb"
>restoreProgramDb</A
> :: [<A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
>] -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AaddKnownProgram"
>addKnownProgram</A
> :: <A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AaddKnownPrograms"
>addKnownPrograms</A
> :: [<A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
>] -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AlookupKnownProgram"
>lookupKnownProgram</A
> :: <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="../base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AknownPrograms"
>knownPrograms</A
> :: <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; [(<A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
>, <A HREF="../base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Distribution-Simple-Program-Types.html#t%3AConfiguredProgram"
>ConfiguredProgram</A
>)]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AuserSpecifyPath"
>userSpecifyPath</A
> :: <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AuserSpecifyPaths"
>userSpecifyPaths</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
>)] -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AuserMaybeSpecifyPath"
>userMaybeSpecifyPath</A
> :: <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="../base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AuserSpecifyArgs"
>userSpecifyArgs</A
> :: <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; [<A HREF="Distribution-Simple-Program-Types.html#t%3AProgArg"
>ProgArg</A
>] -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AuserSpecifyArgss"
>userSpecifyArgss</A
> :: [(<A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>, [<A HREF="Distribution-Simple-Program-Types.html#t%3AProgArg"
>ProgArg</A
>])] -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AuserSpecifiedArgs"
>userSpecifiedArgs</A
> :: <A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; [<A HREF="Distribution-Simple-Program-Types.html#t%3AProgArg"
>ProgArg</A
>]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AlookupProgram"
>lookupProgram</A
> :: <A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="../base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Distribution-Simple-Program-Types.html#t%3AConfiguredProgram"
>ConfiguredProgram</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AupdateProgram"
>updateProgram</A
> :: <A HREF="Distribution-Simple-Program-Types.html#t%3AConfiguredProgram"
>ConfiguredProgram</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AconfigureProgram"
>configureProgram</A
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AconfigureAllKnownPrograms"
>configureAllKnownPrograms</A
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AreconfigurePrograms"
>reconfigurePrograms</A
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; [(<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
>)] -&gt; [(<A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>, [<A HREF="Distribution-Simple-Program-Types.html#t%3AProgArg"
>ProgArg</A
>])] -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3ArequireProgram"
>requireProgram</A
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="Distribution-Simple-Program-Types.html#t%3AConfiguredProgram"
>ConfiguredProgram</A
>, <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
>)</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3ArequireProgramVersion"
>requireProgramVersion</A
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
> -&gt; <A HREF="Distribution-Version.html#t%3AVersionRange"
>VersionRange</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="Distribution-Simple-Program-Types.html#t%3AConfiguredProgram"
>ConfiguredProgram</A
>, <A HREF="Distribution-Version.html#t%3AVersion"
>Version</A
>, <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</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"
>The collection of configured programs we can run
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:ProgramDb"
><A NAME="t%3AProgramDb"
></A
></A
><B
>ProgramDb</B
>  </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
><P
>The configuration is a collection of information about programs. It
 contains information both about configured programs and also about programs
 that we are yet to configure.
</P
><P
>The idea is that we start from a collection of unconfigured programs and one
 by one we try to configure them at which point we move them into the
 configured collection. For unconfigured programs we record not just the
 <TT
><A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
></TT
> but also any user-provided arguments and location for the program.
</P
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:ProgramDb')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:ProgramDb" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="../base-4.2.0.2/Text-Read.html#t%3ARead"
>Read</A
> <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../base-4.2.0.2/Text-Show.html#t%3AShow"
>Show</A
> <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:emptyProgramDb"
><A NAME="v%3AemptyProgramDb"
></A
></A
><B
>emptyProgramDb</B
> :: <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:defaultProgramDb"
><A NAME="v%3AdefaultProgramDb"
></A
></A
><B
>defaultProgramDb</B
> :: <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:restoreProgramDb"
><A NAME="v%3ArestoreProgramDb"
></A
></A
><B
>restoreProgramDb</B
> :: [<A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
>] -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="doc"
><P
>The Read/Show instance does not preserve all the unconfigured Programs
 because <TT
><A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
></TT
> is not in Read/Show because it contains functions. So to
 fully restore a deserialised <TT
><A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TT
> use this function to add
 back all the known <TT
><A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
></TT
>s.
</P
><UL
><LI
> It does not add the default programs, but you probably want them, use
   <TT
><A HREF="Distribution-Simple-Program-Builtin.html#v%3AbuiltinPrograms"
>builtinPrograms</A
></TT
> in addition to any extra you might need.
</LI
></UL
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="2"
><A NAME="2"
>Query and manipulate the program db
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:addKnownProgram"
><A NAME="v%3AaddKnownProgram"
></A
></A
><B
>addKnownProgram</B
> :: <A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="doc"
>Add a known program that we may configure later
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:addKnownPrograms"
><A NAME="v%3AaddKnownPrograms"
></A
></A
><B
>addKnownPrograms</B
> :: [<A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
>] -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:lookupKnownProgram"
><A NAME="v%3AlookupKnownProgram"
></A
></A
><B
>lookupKnownProgram</B
> :: <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="../base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:knownPrograms"
><A NAME="v%3AknownPrograms"
></A
></A
><B
>knownPrograms</B
> :: <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; [(<A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
>, <A HREF="../base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Distribution-Simple-Program-Types.html#t%3AConfiguredProgram"
>ConfiguredProgram</A
>)]</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:userSpecifyPath"
><A NAME="v%3AuserSpecifyPath"
></A
></A
><B
>userSpecifyPath</B
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
>Program name
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
><TD CLASS="rdoc"
>user-specified path to the program
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="ndoc" COLSPAN="2"
>User-specify this path.  Basically override any path information
 for this program in the configuration. If it's not a known
 program ignore it.
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:userSpecifyPaths"
><A NAME="v%3AuserSpecifyPaths"
></A
></A
><B
>userSpecifyPaths</B
> :: [(<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
>)] -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="doc"
>Like <TT
><A HREF="Distribution-Simple-Program-Db.html#v%3AuserSpecifyPath"
>userSpecifyPath</A
></TT
> but for a list of progs and their paths.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:userMaybeSpecifyPath"
><A NAME="v%3AuserMaybeSpecifyPath"
></A
></A
><B
>userMaybeSpecifyPath</B
> :: <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="../base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:userSpecifyArgs"
><A NAME="v%3AuserSpecifyArgs"
></A
></A
><B
>userSpecifyArgs</B
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
>Program name
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; [<A HREF="Distribution-Simple-Program-Types.html#t%3AProgArg"
>ProgArg</A
>]</TD
><TD CLASS="rdoc"
>user-specified args
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="ndoc" COLSPAN="2"
>User-specify the arguments for this program.  Basically override
 any args information for this program in the configuration. If it's
 not a known program, ignore it..
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:userSpecifyArgss"
><A NAME="v%3AuserSpecifyArgss"
></A
></A
><B
>userSpecifyArgss</B
> :: [(<A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>, [<A HREF="Distribution-Simple-Program-Types.html#t%3AProgArg"
>ProgArg</A
>])] -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="doc"
>Like <TT
><A HREF="Distribution-Simple-Program-Db.html#v%3AuserSpecifyPath"
>userSpecifyPath</A
></TT
> but for a list of progs and their args.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:userSpecifiedArgs"
><A NAME="v%3AuserSpecifiedArgs"
></A
></A
><B
>userSpecifiedArgs</B
> :: <A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; [<A HREF="Distribution-Simple-Program-Types.html#t%3AProgArg"
>ProgArg</A
>]</TD
></TR
><TR
><TD CLASS="doc"
>Get any extra args that have been previously specified for a program.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:lookupProgram"
><A NAME="v%3AlookupProgram"
></A
></A
><B
>lookupProgram</B
> :: <A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="../base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Distribution-Simple-Program-Types.html#t%3AConfiguredProgram"
>ConfiguredProgram</A
></TD
></TR
><TR
><TD CLASS="doc"
>Try to find a configured program
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:updateProgram"
><A NAME="v%3AupdateProgram"
></A
></A
><B
>updateProgram</B
> :: <A HREF="Distribution-Simple-Program-Types.html#t%3AConfiguredProgram"
>ConfiguredProgram</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="doc"
>Update a configured program in the database.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="3"
><A NAME="3"
>Query and manipulate the program db
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:configureProgram"
><A NAME="v%3AconfigureProgram"
></A
></A
><B
>configureProgram</B
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Try to configure a specific program. If the program is already included in
 the colleciton of unconfigured programs then we use any user-supplied
 location and arguments. If the program gets configured sucessfully it gets
 added to the configured collection.
</P
><P
>Note that it is not a failure if the program cannot be configured. It's only
 a failure if the user supplied a location and the program could not be found
 at that location.
</P
><P
>The reason for it not being a failure at this stage is that we don't know up
 front all the programs we will need, so we try to configure them all.
 To verify that a program was actually sucessfully configured use
 <TT
><A HREF="Distribution-Simple-Program-Db.html#v%3ArequireProgram"
>requireProgram</A
></TT
>.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:configureAllKnownPrograms"
><A NAME="v%3AconfigureAllKnownPrograms"
></A
></A
><B
>configureAllKnownPrograms</B
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="doc"
>Try to configure all the known programs that have not yet been configured.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:reconfigurePrograms"
><A NAME="v%3AreconfigurePrograms"
></A
></A
><B
>reconfigurePrograms</B
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; [(<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
>)] -&gt; [(<A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>, [<A HREF="Distribution-Simple-Program-Types.html#t%3AProgArg"
>ProgArg</A
>])] -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
></TD
></TR
><TR
><TD CLASS="doc"
>reconfigure a bunch of programs given new user-specified args. It takes
 the same inputs as <TT
><A HREF="Distribution-Simple-Program-Db.html#v%3AuserSpecifyPath"
>userSpecifyPath</A
></TT
> and <TT
><A HREF="Distribution-Simple-Program-Db.html#v%3AuserSpecifyArgs"
>userSpecifyArgs</A
></TT
> and for all progs
 with a new path it calls <TT
><A HREF="Distribution-Simple-Program-Db.html#v%3AconfigureProgram"
>configureProgram</A
></TT
>.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:requireProgram"
><A NAME="v%3ArequireProgram"
></A
></A
><B
>requireProgram</B
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="Distribution-Simple-Program-Types.html#t%3AConfiguredProgram"
>ConfiguredProgram</A
>, <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
>)</TD
></TR
><TR
><TD CLASS="doc"
><P
>Check that a program is configured and available to be run.
</P
><P
>It raises an exception if the program could not be configured, otherwise
 it returns the configured program.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:requireProgramVersion"
><A NAME="v%3ArequireProgramVersion"
></A
></A
><B
>requireProgramVersion</B
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
> -&gt; <A HREF="Distribution-Version.html#t%3AVersionRange"
>VersionRange</A
> -&gt; <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="Distribution-Simple-Program-Types.html#t%3AConfiguredProgram"
>ConfiguredProgram</A
>, <A HREF="Distribution-Version.html#t%3AVersion"
>Version</A
>, <A HREF="Distribution-Simple-Program-Db.html#t%3AProgramDb"
>ProgramDb</A
>)</TD
></TR
><TR
><TD CLASS="doc"
><P
>Check that a program is configured and available to be run.
</P
><P
>Additionally check that the version of the program number is suitable and
 return it. For example you could require AnyVersion or
 <TT
>orLaterVersion (<TT
><A HREF="Distribution-Version.html#t%3AVersion"
>Version</A
></TT
> [1,0] [])</TT
>
</P
><P
>It raises an exception if the program could not be configured or the version
 is unsuitable, otherwise it returns the configured program and its version
 number.
</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
>