GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8fef28d · 2026-11-02
ModuleCabal-3.18.1.0Haskell2010
Implementation of hooks executables for build-type: Hooks packages.
A hooks executable is a small program compiled from the SetupHooks.hs
module of a package with build-type: Hooks. Its main function is:
import Distribution.Simple.SetupHooks.HooksMain (hooksMain)
import SetupHooks (setupHooks)
main = hooksMain setupHookscabal-install communicates with the external hooks executable to implement
the hooks in a package with build-type: Hooks.
Create a hooks executable main given the package's SetupHooks.
The executable expects three command-line arguments:
A reference to an input communication handle (to read hook inputs from).
A reference to an output communication handle (to write hook outputs to).
The hook type to run.
The hook reads binary-encoded data from the input handle, runs the requested hook, and writes the binary-encoded result to the output handle.
The version of the Hooks API in use.
Used for handshake before beginning inter-process communication.
Eq HooksVersionDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.HooksMainOrd HooksVersionDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.HooksMainShow HooksVersionDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.HooksMainGeneric HooksVersionDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.HooksMainBinary HooksVersionDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.HooksMaintype Rep HooksVersion = D1 ('MetaData "HooksVersion"
"Distribution.Simple.SetupHooks.HooksMain"
"Cabal-3.18.1.0-2e60"
'False) (C1 ('MetaCons "HooksVersion"
'PrefixI 'True) (S1 ('MetaSel ('Just "hooksAPIVersion"
) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Version) :*: (S1 ('MetaSel ('Just "cabalABIHash"
) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MD5) :*: S1 ('MetaSel ('Just "hooksABIHash"
) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MD5))))Defined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.HooksMainThe version of the Hooks API built into this version of the Cabal library.
Used for handshake before beginning inter-process communication.
Tracks the parts of the Cabal API relevant to its binary interface.
Generic CabalABIDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.HooksMainStructured CabalABIDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.HooksMaintype Rep CabalABI = D1 ('MetaData "CabalABI"
"Distribution.Simple.SetupHooks.HooksMain"
"Cabal-3.18.1.0-2e60"
'False) (C1 ('MetaCons "CabalABI"
'PrefixI 'True) (S1 ('MetaSel ('Just "cabalLocalBuildInfo"
) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LocalBuildInfo)))Defined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.HooksMainTracks the parts of the Hooks API relevant to its binary interface.
Generic HooksABIDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.HooksMainStructured HooksABIDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.HooksMaintype Rep HooksABI = D1 ('MetaData "HooksABI"
"Distribution.Simple.SetupHooks.HooksMain"
"Cabal-3.18.1.0-2e60"
'False) (C1 ('MetaCons "HooksABI"
'PrefixI 'True) (S1 ('MetaSel ('Just "confHooks"
) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ((PreConfPackageInputs, PreConfPackageOutputs), PostConfPackageInputs, (PreConfComponentInputs, PreConfComponentOutputs))) :*: (S1 ('MetaSel ('Just "buildHooks"
) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PreBuildComponentInputs, (RuleId, Rule, RuleBinary), PostBuildComponentInputs)) :*: S1 ('MetaSel ('Just "installHooks"
) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InstallComponentInputs))))Defined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.HooksMain