<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>Distribution/Simple/UserHooks.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-2"></a><span class='hs-comment'>-- |</span>
<a name="line-3"></a><span class='hs-comment'>-- Module : Distribution.Simple.UserHooks</span>
<a name="line-4"></a><span class='hs-comment'>-- Copyright : Isaac Jones 2003-2005</span>
<a name="line-5"></a><span class='hs-comment'>--</span>
<a name="line-6"></a><span class='hs-comment'>-- Maintainer : cabal-devel@haskell.org</span>
<a name="line-7"></a><span class='hs-comment'>-- Portability : portable</span>
<a name="line-8"></a><span class='hs-comment'>--</span>
<a name="line-9"></a><span class='hs-comment'>-- This defines the API that @Setup.hs@ scripts can use to customise the way</span>
<a name="line-10"></a><span class='hs-comment'>-- the build works. This module just defines the 'UserHooks' type. The</span>
<a name="line-11"></a><span class='hs-comment'>-- predefined sets of hooks that implement the @Simple@, @Make@ and @Configure@</span>
<a name="line-12"></a><span class='hs-comment'>-- build systems are defined in "Distribution.Simple". The 'UserHooks' is a big</span>
<a name="line-13"></a><span class='hs-comment'>-- record of functions. There are 3 for each action, a pre, post and the action</span>
<a name="line-14"></a><span class='hs-comment'>-- itself. There are few other miscellaneous hooks, ones to extend the set of</span>
<a name="line-15"></a><span class='hs-comment'>-- programs and preprocessors and one to override the function used to read the</span>
<a name="line-16"></a><span class='hs-comment'>-- @.cabal@ file.</span>
<a name="line-17"></a><span class='hs-comment'>--</span>
<a name="line-18"></a><span class='hs-comment'>-- This hooks type is widely agreed to not be the right solution. Partly this</span>
<a name="line-19"></a><span class='hs-comment'>-- is because changes to it usually break custom @Setup.hs@ files and yet many</span>
<a name="line-20"></a><span class='hs-comment'>-- internal code changes do require changes to the hooks. For example we cannot</span>
<a name="line-21"></a><span class='hs-comment'>-- pass any extra parameters to most of the functions that implement the</span>
<a name="line-22"></a><span class='hs-comment'>-- various phases because it would involve changing the types of the</span>
<a name="line-23"></a><span class='hs-comment'>-- corresponding hook. At some point it will have to be replaced.</span>
<a name="line-24"></a>
<a name="line-25"></a><span class='hs-comment'>{- All rights reserved.
<a name="line-26"></a>
<a name="line-27"></a>Redistribution and use in source and binary forms, with or without
<a name="line-28"></a>modification, are permitted provided that the following conditions are
<a name="line-29"></a>met:
<a name="line-30"></a>
<a name="line-31"></a> * Redistributions of source code must retain the above copyright
<a name="line-32"></a> notice, this list of conditions and the following disclaimer.
<a name="line-33"></a>
<a name="line-34"></a> * Redistributions in binary form must reproduce the above
<a name="line-35"></a> copyright notice, this list of conditions and the following
<a name="line-36"></a> disclaimer in the documentation and/or other materials provided
<a name="line-37"></a> with the distribution.
<a name="line-38"></a>
<a name="line-39"></a> * Neither the name of Isaac Jones nor the names of other
<a name="line-40"></a> contributors may be used to endorse or promote products derived
<a name="line-41"></a> from this software without specific prior written permission.
<a name="line-42"></a>
<a name="line-43"></a>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
<a name="line-44"></a>"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
<a name="line-45"></a>LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
<a name="line-46"></a>A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
<a name="line-47"></a>OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
<a name="line-48"></a>SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
<a name="line-49"></a>LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
<a name="line-50"></a>DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
<a name="line-51"></a>THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
<a name="line-52"></a>(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
<a name="line-53"></a>OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -}</span>
<a name="line-54"></a>
<a name="line-55"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Distribution</span><span class='hs-varop'>.</span><span class='hs-conid'>Simple</span><span class='hs-varop'>.</span><span class='hs-conid'>UserHooks</span> <span class='hs-layout'>(</span>
<a name="line-56"></a> <span class='hs-conid'>UserHooks</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>Args</span><span class='hs-layout'>,</span>
<a name="line-57"></a> <span class='hs-varid'>emptyUserHooks</span><span class='hs-layout'>,</span>
<a name="line-58"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-59"></a>
<a name="line-60"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Distribution</span><span class='hs-varop'>.</span><span class='hs-conid'>PackageDescription</span>
<a name="line-61"></a> <span class='hs-layout'>(</span><span class='hs-conid'>PackageDescription</span><span class='hs-layout'>,</span> <span class='hs-conid'>GenericPackageDescription</span><span class='hs-layout'>,</span>
<a name="line-62"></a> <span class='hs-conid'>HookedBuildInfo</span><span class='hs-layout'>,</span> <span class='hs-varid'>emptyHookedBuildInfo</span><span class='hs-layout'>)</span>
<a name="line-63"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Distribution</span><span class='hs-varop'>.</span><span class='hs-conid'>Simple</span><span class='hs-varop'>.</span><span class='hs-conid'>Program</span> <span class='hs-layout'>(</span><span class='hs-conid'>Program</span><span class='hs-layout'>)</span>
<a name="line-64"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Distribution</span><span class='hs-varop'>.</span><span class='hs-conid'>Simple</span><span class='hs-varop'>.</span><span class='hs-conid'>Command</span> <span class='hs-layout'>(</span><span class='hs-varid'>noExtraFlags</span><span class='hs-layout'>)</span>
<a name="line-65"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Distribution</span><span class='hs-varop'>.</span><span class='hs-conid'>Simple</span><span class='hs-varop'>.</span><span class='hs-conid'>PreProcess</span> <span class='hs-layout'>(</span><span class='hs-conid'>PPSuffixHandler</span><span class='hs-layout'>)</span>
<a name="line-66"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Distribution</span><span class='hs-varop'>.</span><span class='hs-conid'>Simple</span><span class='hs-varop'>.</span><span class='hs-conid'>Setup</span>
<a name="line-67"></a> <span class='hs-layout'>(</span><span class='hs-conid'>ConfigFlags</span><span class='hs-layout'>,</span> <span class='hs-conid'>BuildFlags</span><span class='hs-layout'>,</span> <span class='hs-conid'>CleanFlags</span><span class='hs-layout'>,</span> <span class='hs-conid'>CopyFlags</span><span class='hs-layout'>,</span>
<a name="line-68"></a> <span class='hs-conid'>InstallFlags</span><span class='hs-layout'>,</span> <span class='hs-conid'>SDistFlags</span><span class='hs-layout'>,</span> <span class='hs-conid'>RegisterFlags</span><span class='hs-layout'>,</span> <span class='hs-conid'>HscolourFlags</span><span class='hs-layout'>,</span>
<a name="line-69"></a> <span class='hs-conid'>HaddockFlags</span><span class='hs-layout'>,</span> <span class='hs-conid'>TestFlags</span><span class='hs-layout'>)</span>
<a name="line-70"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Distribution</span><span class='hs-varop'>.</span><span class='hs-conid'>Simple</span><span class='hs-varop'>.</span><span class='hs-conid'>LocalBuildInfo</span> <span class='hs-layout'>(</span><span class='hs-conid'>LocalBuildInfo</span><span class='hs-layout'>)</span>
<a name="line-71"></a>
<a name="line-72"></a><a name="Args"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span>
<a name="line-73"></a>
<a name="line-74"></a><a name="UserHooks"></a><span class='hs-comment'>-- | Hooks allow authors to add specific functionality before and after a</span>
<a name="line-75"></a><a name="UserHooks"></a><span class='hs-comment'>-- command is run, and also to specify additional preprocessors.</span>
<a name="line-76"></a><a name="UserHooks"></a><span class='hs-comment'>--</span>
<a name="line-77"></a><a name="UserHooks"></a><span class='hs-comment'>-- * WARNING: The hooks interface is under rather constant flux as we try to</span>
<a name="line-78"></a><a name="UserHooks"></a><span class='hs-comment'>-- understand users needs. Setup files that depend on this interface may</span>
<a name="line-79"></a><a name="UserHooks"></a><span class='hs-comment'>-- break in future releases.</span>
<a name="line-80"></a><a name="UserHooks"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>UserHooks</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>UserHooks</span> <span class='hs-layout'>{</span>
<a name="line-81"></a>
<a name="line-82"></a> <span class='hs-comment'>-- | Used for @.\/setup test@</span>
<a name="line-83"></a> <span class='hs-varid'>runTests</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Bool</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-84"></a> <span class='hs-comment'>-- | Read the description file</span>
<a name="line-85"></a> <span class='hs-varid'>readDesc</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>GenericPackageDescription</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-86"></a> <span class='hs-comment'>-- | Custom preprocessors in addition to and overriding 'knownSuffixHandlers'.</span>
<a name="line-87"></a> <span class='hs-varid'>hookedPreProcessors</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span> <span class='hs-conid'>PPSuffixHandler</span> <span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span>
<a name="line-88"></a> <span class='hs-comment'>-- | These programs are detected at configure time. Arguments for them are</span>
<a name="line-89"></a> <span class='hs-comment'>-- added to the configure command.</span>
<a name="line-90"></a> <span class='hs-varid'>hookedPrograms</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Program</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span>
<a name="line-91"></a>
<a name="line-92"></a> <span class='hs-comment'>-- |Hook to run before configure command</span>
<a name="line-93"></a> <span class='hs-varid'>preConf</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ConfigFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>HookedBuildInfo</span><span class='hs-layout'>,</span>
<a name="line-94"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during configure.</span>
<a name="line-95"></a> <span class='hs-varid'>confHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>GenericPackageDescription</span><span class='hs-layout'>,</span> <span class='hs-conid'>HookedBuildInfo</span><span class='hs-layout'>)</span>
<a name="line-96"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ConfigFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>LocalBuildInfo</span><span class='hs-layout'>,</span>
<a name="line-97"></a> <span class='hs-comment'>-- |Hook to run after configure command</span>
<a name="line-98"></a> <span class='hs-varid'>postConf</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ConfigFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-99"></a>
<a name="line-100"></a> <span class='hs-comment'>-- |Hook to run before build command. Second arg indicates verbosity level.</span>
<a name="line-101"></a> <span class='hs-varid'>preBuild</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>BuildFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>HookedBuildInfo</span><span class='hs-layout'>,</span>
<a name="line-102"></a>
<a name="line-103"></a> <span class='hs-comment'>-- |Over-ride this hook to gbet different behavior during build.</span>
<a name="line-104"></a> <span class='hs-varid'>buildHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>UserHooks</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>BuildFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-105"></a> <span class='hs-comment'>-- |Hook to run after build command. Second arg indicates verbosity level.</span>
<a name="line-106"></a> <span class='hs-varid'>postBuild</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>BuildFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-107"></a>
<a name="line-108"></a> <span class='hs-comment'>-- |Hook to run before clean command. Second arg indicates verbosity level.</span>
<a name="line-109"></a> <span class='hs-varid'>preClean</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>CleanFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>HookedBuildInfo</span><span class='hs-layout'>,</span>
<a name="line-110"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during clean.</span>
<a name="line-111"></a> <span class='hs-varid'>cleanHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>()</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>UserHooks</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>CleanFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-112"></a> <span class='hs-comment'>-- |Hook to run after clean command. Second arg indicates verbosity level.</span>
<a name="line-113"></a> <span class='hs-varid'>postClean</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>CleanFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>()</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-114"></a>
<a name="line-115"></a> <span class='hs-comment'>-- |Hook to run before copy command</span>
<a name="line-116"></a> <span class='hs-varid'>preCopy</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>CopyFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>HookedBuildInfo</span><span class='hs-layout'>,</span>
<a name="line-117"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during copy.</span>
<a name="line-118"></a> <span class='hs-varid'>copyHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>UserHooks</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>CopyFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-119"></a> <span class='hs-comment'>-- |Hook to run after copy command</span>
<a name="line-120"></a> <span class='hs-varid'>postCopy</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>CopyFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-121"></a>
<a name="line-122"></a> <span class='hs-comment'>-- |Hook to run before install command</span>
<a name="line-123"></a> <span class='hs-varid'>preInst</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>InstallFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>HookedBuildInfo</span><span class='hs-layout'>,</span>
<a name="line-124"></a>
<a name="line-125"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during install.</span>
<a name="line-126"></a> <span class='hs-varid'>instHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>UserHooks</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>InstallFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-127"></a> <span class='hs-comment'>-- |Hook to run after install command. postInst should be run</span>
<a name="line-128"></a> <span class='hs-comment'>-- on the target, not on the build machine.</span>
<a name="line-129"></a> <span class='hs-varid'>postInst</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>InstallFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-130"></a>
<a name="line-131"></a> <span class='hs-comment'>-- |Hook to run before sdist command. Second arg indicates verbosity level.</span>
<a name="line-132"></a> <span class='hs-varid'>preSDist</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SDistFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>HookedBuildInfo</span><span class='hs-layout'>,</span>
<a name="line-133"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during sdist.</span>
<a name="line-134"></a> <span class='hs-varid'>sDistHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>UserHooks</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SDistFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-135"></a> <span class='hs-comment'>-- |Hook to run after sdist command. Second arg indicates verbosity level.</span>
<a name="line-136"></a> <span class='hs-varid'>postSDist</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SDistFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-137"></a>
<a name="line-138"></a> <span class='hs-comment'>-- |Hook to run before register command</span>
<a name="line-139"></a> <span class='hs-varid'>preReg</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>RegisterFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>HookedBuildInfo</span><span class='hs-layout'>,</span>
<a name="line-140"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during registration.</span>
<a name="line-141"></a> <span class='hs-varid'>regHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>UserHooks</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>RegisterFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-142"></a> <span class='hs-comment'>-- |Hook to run after register command</span>
<a name="line-143"></a> <span class='hs-varid'>postReg</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>RegisterFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-144"></a>
<a name="line-145"></a> <span class='hs-comment'>-- |Hook to run before unregister command</span>
<a name="line-146"></a> <span class='hs-varid'>preUnreg</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>RegisterFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>HookedBuildInfo</span><span class='hs-layout'>,</span>
<a name="line-147"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during registration.</span>
<a name="line-148"></a> <span class='hs-varid'>unregHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>UserHooks</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>RegisterFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-149"></a> <span class='hs-comment'>-- |Hook to run after unregister command</span>
<a name="line-150"></a> <span class='hs-varid'>postUnreg</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>RegisterFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-151"></a>
<a name="line-152"></a> <span class='hs-comment'>-- |Hook to run before hscolour command. Second arg indicates verbosity level.</span>
<a name="line-153"></a> <span class='hs-varid'>preHscolour</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>HscolourFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>HookedBuildInfo</span><span class='hs-layout'>,</span>
<a name="line-154"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during hscolour.</span>
<a name="line-155"></a> <span class='hs-varid'>hscolourHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>UserHooks</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>HscolourFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-156"></a> <span class='hs-comment'>-- |Hook to run after hscolour command. Second arg indicates verbosity level.</span>
<a name="line-157"></a> <span class='hs-varid'>postHscolour</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>HscolourFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-158"></a>
<a name="line-159"></a> <span class='hs-comment'>-- |Hook to run before haddock command. Second arg indicates verbosity level.</span>
<a name="line-160"></a> <span class='hs-varid'>preHaddock</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>HaddockFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>HookedBuildInfo</span><span class='hs-layout'>,</span>
<a name="line-161"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during haddock.</span>
<a name="line-162"></a> <span class='hs-varid'>haddockHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>UserHooks</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>HaddockFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-163"></a> <span class='hs-comment'>-- |Hook to run after haddock command. Second arg indicates verbosity level.</span>
<a name="line-164"></a> <span class='hs-varid'>postHaddock</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>HaddockFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-165"></a>
<a name="line-166"></a> <span class='hs-comment'>-- |Hook to run before test command.</span>
<a name="line-167"></a> <span class='hs-varid'>preTest</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>TestFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>HookedBuildInfo</span><span class='hs-layout'>,</span>
<a name="line-168"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during test.</span>
<a name="line-169"></a> <span class='hs-varid'>testHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>UserHooks</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>TestFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>,</span>
<a name="line-170"></a> <span class='hs-comment'>-- |Hook to run after test command.</span>
<a name="line-171"></a> <span class='hs-varid'>postTest</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>TestFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>PackageDescription</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>LocalBuildInfo</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-172"></a> <span class='hs-layout'>}</span>
<a name="line-173"></a>
<a name="line-174"></a><span class='hs-comment'>{-# DEPRECATED runTests "Please use the new testing interface instead!" #-}</span>
<a name="line-175"></a>
<a name="line-176"></a><a name="emptyUserHooks"></a><span class='hs-comment'>-- |Empty 'UserHooks' which do nothing.</span>
<a name="line-177"></a><span class='hs-definition'>emptyUserHooks</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>UserHooks</span>
<a name="line-178"></a><span class='hs-definition'>emptyUserHooks</span>
<a name="line-179"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>UserHooks</span> <span class='hs-layout'>{</span>
<a name="line-180"></a> <span class='hs-varid'>runTests</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-181"></a> <span class='hs-varid'>readDesc</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span><span class='hs-layout'>,</span>
<a name="line-182"></a> <span class='hs-varid'>hookedPreProcessors</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>[]</span><span class='hs-layout'>,</span>
<a name="line-183"></a> <span class='hs-varid'>hookedPrograms</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>[]</span><span class='hs-layout'>,</span>
<a name="line-184"></a> <span class='hs-varid'>preConf</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>rn</span><span class='hs-layout'>,</span>
<a name="line-185"></a> <span class='hs-varid'>confHook</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>error</span> <span class='hs-str'>"No local build info generated during configure. Over-ride empty configure hook."</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-186"></a> <span class='hs-varid'>postConf</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-187"></a> <span class='hs-varid'>preBuild</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>rn</span><span class='hs-layout'>,</span>
<a name="line-188"></a> <span class='hs-varid'>buildHook</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-189"></a> <span class='hs-varid'>postBuild</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-190"></a> <span class='hs-varid'>preClean</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>rn</span><span class='hs-layout'>,</span>
<a name="line-191"></a> <span class='hs-varid'>cleanHook</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-192"></a> <span class='hs-varid'>postClean</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-193"></a> <span class='hs-varid'>preCopy</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>rn</span><span class='hs-layout'>,</span>
<a name="line-194"></a> <span class='hs-varid'>copyHook</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-195"></a> <span class='hs-varid'>postCopy</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-196"></a> <span class='hs-varid'>preInst</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>rn</span><span class='hs-layout'>,</span>
<a name="line-197"></a> <span class='hs-varid'>instHook</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-198"></a> <span class='hs-varid'>postInst</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-199"></a> <span class='hs-varid'>preSDist</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>rn</span><span class='hs-layout'>,</span>
<a name="line-200"></a> <span class='hs-varid'>sDistHook</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-201"></a> <span class='hs-varid'>postSDist</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-202"></a> <span class='hs-varid'>preReg</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>rn</span><span class='hs-layout'>,</span>
<a name="line-203"></a> <span class='hs-varid'>regHook</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-204"></a> <span class='hs-varid'>postReg</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-205"></a> <span class='hs-varid'>preUnreg</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>rn</span><span class='hs-layout'>,</span>
<a name="line-206"></a> <span class='hs-varid'>unregHook</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-207"></a> <span class='hs-varid'>postUnreg</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-208"></a> <span class='hs-varid'>preHscolour</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>rn</span><span class='hs-layout'>,</span>
<a name="line-209"></a> <span class='hs-varid'>hscolourHook</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-210"></a> <span class='hs-varid'>postHscolour</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-211"></a> <span class='hs-varid'>preHaddock</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>rn</span><span class='hs-layout'>,</span>
<a name="line-212"></a> <span class='hs-varid'>haddockHook</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-213"></a> <span class='hs-varid'>postHaddock</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-214"></a> <span class='hs-varid'>preTest</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>\</span><span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-varid'>emptyHookedBuildInfo</span><span class='hs-layout'>,</span> <span class='hs-comment'>-- same as rn, but without</span>
<a name="line-215"></a> <span class='hs-comment'>-- noExtraFlags</span>
<a name="line-216"></a> <span class='hs-varid'>testHook</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-217"></a> <span class='hs-varid'>postTest</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span>
<a name="line-218"></a> <span class='hs-layout'>}</span>
<a name="line-219"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>rn</span> <span class='hs-varid'>args</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>noExtraFlags</span> <span class='hs-varid'>args</span> <span class='hs-varop'>>></span> <span class='hs-varid'>return</span> <span class='hs-varid'>emptyHookedBuildInfo</span>
<a name="line-220"></a> <span class='hs-varid'>ru</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span>
</pre></body>
</html>
