Modulehooks-exe-3.18Haskell2010

Distribution.Client.SetupHooks.CallHooksExe

7 values

Packagehooks-exe-3.18
Exports7
LanguageHaskell2010
LicenceBSD-3-Clause
SourceCallHooksExe.hs

valuecallHooksExe

:: HookIO inputs outputs
=> Verbosity
-> FilePath
path to hooks executable
-> String
name of the hook to run
-> inputs
argument to the hook
-> IO outputs

Call an external hooks executable in order to execute a Cabal Setup hook.

valueexternalSetupHooks :: Verbosity -> FilePath -> SetupHooks

Construct a SetupHooks that runs the hooks of the external hooks executable at the given path through the CLI.

This should only be used at the final step of compiling a package, when we have all the hooks in hand. The SetupHooks that are returned by this function cannot be combined with any other SetupHooks; they must directly be used to build the package.

valueexternalSetupHooksABI :: Verbosity -> FilePath -> IO HooksVersion

The ABI of an external hooks executable.

This information is used to handshake before further communication, in order to avoid a cascade of errors with mismatched Binary instances.

valuebuildTypeSetupHooks

:: Verbosity
-> Maybe (SymbolicPath CWD ('Dir Pkg))
-> SymbolicPath Pkg ('Dir Dist)
-> BuildType
-> SetupHooks

The SetupHooks associated to a particular BuildType.

*Warning:** for build-type: Hooks, this does not include the pre-build hooks. Those can be retrieved with buildTypePreBuildHooks.

valuebuildTypePreBuildHooks

:: VerbosityHandles
-> Maybe (SymbolicPath CWD ('Dir Pkg))
-> SymbolicPath Pkg ('Dir Dist)
-> BuildType
-> PreBuildComponentInputs
-> IO [MonitorFilePath]

The pre-build hooks obtained by communication with an external hooks executable.

valuerunExternalPreBuildRules

:: VerbosityHandles
-> FilePath
path to external hooks executable
-> PreBuildComponentInputs
-> IO [MonitorFilePath]

Run pre-build rules coming from an external hooks executable at the given filepath.

Note that executeRulesUserOrSystem handles recompilation checking, only re-running rules that are stale.

valuehooksProgFilePath

:: Maybe (SymbolicPath CWD ('Dir Pkg))
-> SymbolicPath Pkg ('Dir Dist)
-> FilePath

The path to the external hooks executable.