/usr/share/doc/libghc-cabal-doc/html/src/Distribution-Simple-UserHooks.html is in libghc-cabal-doc 1.24.1.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 | <?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://code.haskell.org/~malcolm/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'>-- License : BSD3</span>
<a name="line-6"></a><span class='hs-comment'>--</span>
<a name="line-7"></a><span class='hs-comment'>-- Maintainer : cabal-devel@haskell.org</span>
<a name="line-8"></a><span class='hs-comment'>-- Portability : portable</span>
<a name="line-9"></a><span class='hs-comment'>--</span>
<a name="line-10"></a><span class='hs-comment'>-- This defines the API that @Setup.hs@ scripts can use to customise the way</span>
<a name="line-11"></a><span class='hs-comment'>-- the build works. This module just defines the 'UserHooks' type. The</span>
<a name="line-12"></a><span class='hs-comment'>-- predefined sets of hooks that implement the @Simple@, @Make@ and @Configure@</span>
<a name="line-13"></a><span class='hs-comment'>-- build systems are defined in "Distribution.Simple". The 'UserHooks' is a big</span>
<a name="line-14"></a><span class='hs-comment'>-- record of functions. There are 3 for each action, a pre, post and the action</span>
<a name="line-15"></a><span class='hs-comment'>-- itself. There are few other miscellaneous hooks, ones to extend the set of</span>
<a name="line-16"></a><span class='hs-comment'>-- programs and preprocessors and one to override the function used to read the</span>
<a name="line-17"></a><span class='hs-comment'>-- @.cabal@ file.</span>
<a name="line-18"></a><span class='hs-comment'>--</span>
<a name="line-19"></a><span class='hs-comment'>-- This hooks type is widely agreed to not be the right solution. Partly this</span>
<a name="line-20"></a><span class='hs-comment'>-- is because changes to it usually break custom @Setup.hs@ files and yet many</span>
<a name="line-21"></a><span class='hs-comment'>-- internal code changes do require changes to the hooks. For example we cannot</span>
<a name="line-22"></a><span class='hs-comment'>-- pass any extra parameters to most of the functions that implement the</span>
<a name="line-23"></a><span class='hs-comment'>-- various phases because it would involve changing the types of the</span>
<a name="line-24"></a><span class='hs-comment'>-- corresponding hook. At some point it will have to be replaced.</span>
<a name="line-25"></a>
<a name="line-26"></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-27"></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-28"></a> <span class='hs-varid'>emptyUserHooks</span><span class='hs-layout'>,</span>
<a name="line-29"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-30"></a>
<a name="line-31"></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-32"></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>
<a name="line-33"></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>
<a name="line-34"></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>
<a name="line-35"></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-36"></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>
<a name="line-37"></a>
<a name="line-38"></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-39"></a>
<a name="line-40"></a><a name="UserHooks"></a><span class='hs-comment'>-- | Hooks allow authors to add specific functionality before and after a</span>
<a name="line-41"></a><a name="UserHooks"></a><span class='hs-comment'>-- command is run, and also to specify additional preprocessors.</span>
<a name="line-42"></a><a name="UserHooks"></a><span class='hs-comment'>--</span>
<a name="line-43"></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-44"></a><a name="UserHooks"></a><span class='hs-comment'>-- understand users needs. Setup files that depend on this interface may</span>
<a name="line-45"></a><a name="UserHooks"></a><span class='hs-comment'>-- break in future releases.</span>
<a name="line-46"></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-47"></a>
<a name="line-48"></a> <span class='hs-comment'>-- | Used for @.\/setup test@</span>
<a name="line-49"></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-50"></a> <span class='hs-comment'>-- | Read the description file</span>
<a name="line-51"></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-52"></a> <span class='hs-comment'>-- | Custom preprocessors in addition to and overriding 'knownSuffixHandlers'.</span>
<a name="line-53"></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-54"></a> <span class='hs-comment'>-- | These programs are detected at configure time. Arguments for them are</span>
<a name="line-55"></a> <span class='hs-comment'>-- added to the configure command.</span>
<a name="line-56"></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-57"></a>
<a name="line-58"></a> <span class='hs-comment'>-- |Hook to run before configure command</span>
<a name="line-59"></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-60"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during configure.</span>
<a name="line-61"></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-62"></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-63"></a> <span class='hs-comment'>-- |Hook to run after configure command</span>
<a name="line-64"></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-65"></a>
<a name="line-66"></a> <span class='hs-comment'>-- |Hook to run before build command. Second arg indicates verbosity level.</span>
<a name="line-67"></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-68"></a>
<a name="line-69"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during build.</span>
<a name="line-70"></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-71"></a> <span class='hs-comment'>-- |Hook to run after build command. Second arg indicates verbosity level.</span>
<a name="line-72"></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-73"></a>
<a name="line-74"></a> <span class='hs-comment'>-- |Hook to run before repl command. Second arg indicates verbosity level.</span>
<a name="line-75"></a> <span class='hs-varid'>preRepl</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ReplFlags</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-76"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during interpretation.</span>
<a name="line-77"></a> <span class='hs-varid'>replHook</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'>ReplFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</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-78"></a> <span class='hs-comment'>-- |Hook to run after repl command. Second arg indicates verbosity level.</span>
<a name="line-79"></a> <span class='hs-varid'>postRepl</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ReplFlags</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-80"></a>
<a name="line-81"></a> <span class='hs-comment'>-- |Hook to run before clean command. Second arg indicates verbosity level.</span>
<a name="line-82"></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-83"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during clean.</span>
<a name="line-84"></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-85"></a> <span class='hs-comment'>-- |Hook to run after clean command. Second arg indicates verbosity level.</span>
<a name="line-86"></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-87"></a>
<a name="line-88"></a> <span class='hs-comment'>-- |Hook to run before copy command</span>
<a name="line-89"></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-90"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during copy.</span>
<a name="line-91"></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-92"></a> <span class='hs-comment'>-- |Hook to run after copy command</span>
<a name="line-93"></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-94"></a>
<a name="line-95"></a> <span class='hs-comment'>-- |Hook to run before install command</span>
<a name="line-96"></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-97"></a>
<a name="line-98"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during install.</span>
<a name="line-99"></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-100"></a> <span class='hs-comment'>-- |Hook to run after install command. postInst should be run</span>
<a name="line-101"></a> <span class='hs-comment'>-- on the target, not on the build machine.</span>
<a name="line-102"></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-103"></a>
<a name="line-104"></a> <span class='hs-comment'>-- |Hook to run before sdist command. Second arg indicates verbosity level.</span>
<a name="line-105"></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-106"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during sdist.</span>
<a name="line-107"></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-108"></a> <span class='hs-comment'>-- |Hook to run after sdist command. Second arg indicates verbosity level.</span>
<a name="line-109"></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-110"></a>
<a name="line-111"></a> <span class='hs-comment'>-- |Hook to run before register command</span>
<a name="line-112"></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-113"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during registration.</span>
<a name="line-114"></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-115"></a> <span class='hs-comment'>-- |Hook to run after register command</span>
<a name="line-116"></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-117"></a>
<a name="line-118"></a> <span class='hs-comment'>-- |Hook to run before unregister command</span>
<a name="line-119"></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-120"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during unregistration.</span>
<a name="line-121"></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-122"></a> <span class='hs-comment'>-- |Hook to run after unregister command</span>
<a name="line-123"></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-124"></a>
<a name="line-125"></a> <span class='hs-comment'>-- |Hook to run before hscolour command. Second arg indicates verbosity level.</span>
<a name="line-126"></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-127"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during hscolour.</span>
<a name="line-128"></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-129"></a> <span class='hs-comment'>-- |Hook to run after hscolour command. Second arg indicates verbosity level.</span>
<a name="line-130"></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-131"></a>
<a name="line-132"></a> <span class='hs-comment'>-- |Hook to run before haddock command. Second arg indicates verbosity level.</span>
<a name="line-133"></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-134"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during haddock.</span>
<a name="line-135"></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-136"></a> <span class='hs-comment'>-- |Hook to run after haddock command. Second arg indicates verbosity level.</span>
<a name="line-137"></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-138"></a>
<a name="line-139"></a> <span class='hs-comment'>-- |Hook to run before test command.</span>
<a name="line-140"></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-141"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during test.</span>
<a name="line-142"></a> <span class='hs-varid'>testHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</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-143"></a> <span class='hs-comment'>-- |Hook to run after test command.</span>
<a name="line-144"></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><span class='hs-layout'>,</span>
<a name="line-145"></a>
<a name="line-146"></a> <span class='hs-comment'>-- |Hook to run before bench command.</span>
<a name="line-147"></a> <span class='hs-varid'>preBench</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>BenchmarkFlags</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-148"></a> <span class='hs-comment'>-- |Over-ride this hook to get different behavior during bench.</span>
<a name="line-149"></a> <span class='hs-varid'>benchHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</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'>BenchmarkFlags</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-150"></a> <span class='hs-comment'>-- |Hook to run after bench command.</span>
<a name="line-151"></a> <span class='hs-varid'>postBench</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Args</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>BenchmarkFlags</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-152"></a> <span class='hs-layout'>}</span>
<a name="line-153"></a>
<a name="line-154"></a><span class='hs-comment'>{-# DEPRECATED runTests "Please use the new testing interface instead!" #-}</span>
<a name="line-155"></a>
<a name="line-156"></a><a name="emptyUserHooks"></a><span class='hs-comment'>-- |Empty 'UserHooks' which do nothing.</span>
<a name="line-157"></a><span class='hs-definition'>emptyUserHooks</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>UserHooks</span>
<a name="line-158"></a><span class='hs-definition'>emptyUserHooks</span>
<a name="line-159"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>UserHooks</span> <span class='hs-layout'>{</span>
<a name="line-160"></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-161"></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-162"></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-163"></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-164"></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-165"></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-166"></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-167"></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-168"></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-169"></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-170"></a> <span class='hs-varid'>preRepl</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>
<a name="line-171"></a> <span class='hs-varid'>replHook</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>\</span><span class='hs-keyword'>_</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><span class='hs-layout'>,</span>
<a name="line-172"></a> <span class='hs-varid'>postRepl</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-173"></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-174"></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-175"></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-176"></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-177"></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-178"></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-179"></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-180"></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-181"></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-182"></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-183"></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-184"></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-185"></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-186"></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-187"></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-188"></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-189"></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-190"></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-191"></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-192"></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-193"></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-194"></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-195"></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-196"></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-197"></a> <span class='hs-varid'>preTest</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>rn'</span><span class='hs-layout'>,</span>
<a name="line-198"></a> <span class='hs-varid'>testHook</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>\</span><span class='hs-keyword'>_</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'>postTest</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span><span class='hs-layout'>,</span>
<a name="line-200"></a> <span class='hs-varid'>preBench</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>rn'</span><span class='hs-layout'>,</span>
<a name="line-201"></a> <span class='hs-varid'>benchHook</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>\</span><span class='hs-keyword'>_</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'>postBench</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ru</span>
<a name="line-203"></a> <span class='hs-layout'>}</span>
<a name="line-204"></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-205"></a> <span class='hs-varid'>rn'</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>
<a name="line-206"></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>
|