ModuleCabal-3.18.1.0Haskell2010

Distribution.Simple.SetupHooks.Internal

Internal implementation module for SetupHooks.

Users of build-type: Hooks should import Distribution.Simple.SetupHooks instead.

26 types
17 values

PackageCabal-3.18.1.0
Exports43
LanguageHaskell2010
LicenceBSD-3-Clause
SourceInternal.hs

The setup hooks datatype

2 declarations

datadata SetupHooks

Hooks into the cabal build phases.

Usage:

In your .cabal file, declare build-type: Hooks (with a cabal-version greater than or equal to 3.14),
In your .cabal file, include a custom-setup stanza which declares the dependencies of your SetupHooks module; this will usually contain a dependency on the Cabal-hooks package.
Provide a SetupHooks.hs module next to your .cabal file; it must export setupHooks :: SetupHooks.

Constructors

SetupHooks
- configureHooks :: ConfigureHooks
  Hooks into the configure phase.
- buildHooks :: BuildHooks
  Hooks into the build phase.
  These hooks are relevant to any build-like phase, such as repl or haddock.
- installHooks :: InstallHooks
  Hooks into the copy/install phase.

Instances2Semigroup, Monoid

Semigroup SetupHooksDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
SetupHooks can be combined monoidally. This is useful to combine setup hooks defined by another package with your own package-specific hooks.
Warning: this Semigroup instance is not commutative.
Monoid SetupHooksDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal

valuenoSetupHooks :: SetupHooks

Empty hooks.

Configure hooks

2 declarations

datadata ConfigureHooks

Configure-time hooks.

Order of execution:

preConfPackageHook,
configure the package,
postConfPackageHook,
preConfComponentHook,
configure the components.

Constructors

ConfigureHooks
- preConfPackageHook :: Maybe PreConfPackageHook
  Package-wide pre-configure hook. See PreConfPackageHook.
- postConfPackageHook :: Maybe PostConfPackageHook
  Package-wide post-configure hook. See PostConfPackageHook.
- preConfComponentHook :: Maybe PreConfComponentHook
  Per-component pre-configure hook. See PreConfComponentHook.

Instances2Semigroup, Monoid

Semigroup ConfigureHooksDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Monoid ConfigureHooksDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal

valuenoConfigureHooks :: ConfigureHooks

Empty configure phase hooks.

Per-package configure hooks

datadata PreConfPackageInputs

Inputs to the package-wide pre-configure step.

Constructors

PreConfPackageInputs
- configFlags :: ConfigFlags
- localBuildConfig :: LocalBuildConfig
  Warning: the ProgramDb in the withPrograms field will not contain any unconfigured programs.
- compiler :: Compiler
- platform :: Platform

Instances5Show, Generic, Binary, Structured, Rep

Show PreConfPackageInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Generic PreConfPackageInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Binary PreConfPackageInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Structured PreConfPackageInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
type Rep PreConfPackageInputs = D1 ('MetaData "PreConfPackageInputs" "Distribution.Simple.SetupHooks.Internal" "Cabal-3.18.1.0-cd98" 'False) (C1 ('MetaCons "PreConfPackageInputs" 'PrefixI 'True) ((S1 ('MetaSel ('Just "configFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ConfigFlags) :*: S1 ('MetaSel ('Just "localBuildConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LocalBuildConfig)) :*: (S1 ('MetaSel ('Just "compiler") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Compiler) :*: S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Platform))))Defined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal

datadata PreConfPackageOutputs

Outputs of the package-wide pre-configure step.

Prefer using noPreConfPackageOutputs and overriding the fields you care about, to avoid depending on implementation details of this datatype.

Constructors

PreConfPackageOutputs
- buildOptions :: BuildOptions
- extraConfiguredProgs :: ConfiguredProgs

Instances5Show, Generic, Binary, Structured, Rep

Show PreConfPackageOutputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Generic PreConfPackageOutputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Binary PreConfPackageOutputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Structured PreConfPackageOutputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
type Rep PreConfPackageOutputs = D1 ('MetaData "PreConfPackageOutputs" "Distribution.Simple.SetupHooks.Internal" "Cabal-3.18.1.0-cd98" 'False) (C1 ('MetaCons "PreConfPackageOutputs" 'PrefixI 'True) (S1 ('MetaSel ('Just "buildOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BuildOptions) :*: S1 ('MetaSel ('Just "extraConfiguredProgs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ConfiguredProgs)))Defined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal

valuenoPreConfPackageOutputs :: PreConfPackageInputs -> PreConfPackageOutputs

Use this smart constructor to declare an empty set of changes by the package-wide pre-configure hook, and override the fields you care about.

Use this rather than PreConfPackageOutputs to avoid relying on internal implementation details of the latter.

typetype PreConfPackageHook = PreConfPackageInputs -> IO PreConfPackageOutputs

datadata PostConfPackageInputs

Inputs to the package-wide post-configure step.

Constructors

PostConfPackageInputs
- localBuildConfig :: LocalBuildConfig
- packageBuildDescr :: PackageBuildDescr

Instances5Show, Generic, Binary, Structured, Rep

Show PostConfPackageInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Generic PostConfPackageInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Binary PostConfPackageInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Structured PostConfPackageInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
type Rep PostConfPackageInputs = D1 ('MetaData "PostConfPackageInputs" "Distribution.Simple.SetupHooks.Internal" "Cabal-3.18.1.0-cd98" 'False) (C1 ('MetaCons "PostConfPackageInputs" 'PrefixI 'True) (S1 ('MetaSel ('Just "localBuildConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LocalBuildConfig) :*: S1 ('MetaSel ('Just "packageBuildDescr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageBuildDescr)))Defined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal

typetype PostConfPackageHook = PostConfPackageInputs -> IO ()

Package-wide post-configure step.

Perform side effects. Last opportunity for any package-wide logic; any subsequent hooks work per-component.

Per-component configure hooks

datadata PreConfComponentInputs

Inputs to the per-component pre-configure step.

Constructors

PreConfComponentInputs
- localBuildConfig :: LocalBuildConfig
- packageBuildDescr :: PackageBuildDescr
- component :: Component

Instances5Show, Generic, Binary, Structured, Rep

Show PreConfComponentInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Generic PreConfComponentInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Binary PreConfComponentInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Structured PreConfComponentInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
type Rep PreConfComponentInputs = D1 ('MetaData "PreConfComponentInputs" "Distribution.Simple.SetupHooks.Internal" "Cabal-3.18.1.0-cd98" 'False) (C1 ('MetaCons "PreConfComponentInputs" 'PrefixI 'True) (S1 ('MetaSel ('Just "localBuildConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LocalBuildConfig) :*: (S1 ('MetaSel ('Just "packageBuildDescr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageBuildDescr) :*: S1 ('MetaSel ('Just "component") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Component))))Defined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal

datadata PreConfComponentOutputs

Outputs of the per-component pre-configure step.

Prefer using noPreComponentOutputs and overriding the fields you care about, to avoid depending on implementation details of this datatype.

Constructors

PreConfComponentOutputs
- componentDiff :: ComponentDiff

Instances5Show, Generic, Binary, Structured, Rep

Show PreConfComponentOutputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Generic PreConfComponentOutputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Binary PreConfComponentOutputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Structured PreConfComponentOutputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
type Rep PreConfComponentOutputs = D1 ('MetaData "PreConfComponentOutputs" "Distribution.Simple.SetupHooks.Internal" "Cabal-3.18.1.0-cd98" 'False) (C1 ('MetaCons "PreConfComponentOutputs" 'PrefixI 'True) (S1 ('MetaSel ('Just "componentDiff") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentDiff)))Defined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal

valuenoPreConfComponentOutputs

:: PreConfComponentInputs
-> PreConfComponentOutputs

Use this smart constructor to declare an empty set of changes by a per-component pre-configure hook, and override the fields you care about.

Use this rather than PreConfComponentOutputs to avoid relying on internal implementation details of the latter.

typetype PreConfComponentHook = PreConfComponentInputs -> IO PreConfComponentOutputs

Per-component pre-configure step.

For each component of the package, this hook can perform side effects, and return a diff to the passed in component, e.g. to declare additional autogenerated modules.

newtypenewtype ComponentDiff

A diff to a Cabal Component, that gets combined monoidally into an existing Component.

Constructors

ComponentDiff
- componentDiff :: Component

Instances4Show, Semigroup, Binary, Structured

Show ComponentDiffDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Semigroup ComponentDiffDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Binary ComponentDiffDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Structured ComponentDiffDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal

valueemptyComponentDiff :: ComponentName -> ComponentDiff

valuebuildInfoComponentDiff :: ComponentName -> BuildInfo -> ComponentDiff

typetype LibraryDiff = Library

typetype ForeignLibDiff = ForeignLib

typetype ExecutableDiff = Executable

typetype TestSuiteDiff = TestSuite

typetype BenchmarkDiff = Benchmark

typetype BuildInfoDiff = BuildInfo

Build hooks

6 declarations

datadata BuildHooks

Build-time hooks.

Constructors

BuildHooks
- preBuildComponentRules :: Maybe PreBuildComponentRules
  Per-component fine-grained pre-build rules.
- postBuildComponentHook :: Maybe PostBuildComponentHook
  Per-component post-build hook.

Instances2Semigroup, Monoid

Semigroup BuildHooksDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Monoid BuildHooksDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal

valuenoBuildHooks :: BuildHooks

Empty build hooks.

datadata BuildingWhat

What kind of build phase are we doing/hooking into?

Is this a normal build, or is it perhaps for running an interactive session or Haddock?

Constructors

BuildNormal BuildFlags
A normal build.
BuildRepl ReplFlags
Build steps for an interactive session.
BuildHaddock HaddockFlags
Build steps for generating documentation.
BuildHscolour HscolourFlags
Build steps for Hscolour.

Instances5Show, Generic, Binary, Structured, Rep

Show BuildingWhatDefined in Cabal-3.18.1.0 · Distribution.Simple.Setup
Generic BuildingWhatDefined in Cabal-3.18.1.0 · Distribution.Simple.Setup
Binary BuildingWhatDefined in Cabal-3.18.1.0 · Distribution.Simple.Setup
Structured BuildingWhatDefined in Cabal-3.18.1.0 · Distribution.Simple.Setup
type Rep BuildingWhat = D1 ('MetaData "BuildingWhat" "Distribution.Simple.Setup" "Cabal-3.18.1.0-cd98" 'False) ((C1 ('MetaCons "BuildNormal" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BuildFlags)) :+: C1 ('MetaCons "BuildRepl" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ReplFlags))) :+: (C1 ('MetaCons "BuildHaddock" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HaddockFlags)) :+: C1 ('MetaCons "BuildHscolour" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HscolourFlags))))Defined in Cabal-3.18.1.0 · Distribution.Simple.Setup

valuebuildingWhatVerbosity :: BuildingWhat -> VerbosityFlags

valuebuildingWhatWorkingDir

:: BuildingWhat
-> Maybe (SymbolicPath CWD ('Dir Pkg))

valuebuildingWhatDistPref :: BuildingWhat -> SymbolicPath Pkg ('Dir Dist)

Pre-build rules

datadata PreBuildComponentInputs

Constructors

PreBuildComponentInputs
- buildingWhat :: BuildingWhat
  what kind of build phase are we hooking into?
- localBuildInfo :: LocalBuildInfo
  information about the package
- targetInfo :: TargetInfo
  information about an individual component

Instances5Show, Generic, Binary, Structured, Rep

Show PreBuildComponentInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Generic PreBuildComponentInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Binary PreBuildComponentInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Structured PreBuildComponentInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
type Rep PreBuildComponentInputs = D1 ('MetaData "PreBuildComponentInputs" "Distribution.Simple.SetupHooks.Internal" "Cabal-3.18.1.0-cd98" 'False) (C1 ('MetaCons "PreBuildComponentInputs" 'PrefixI 'True) (S1 ('MetaSel ('Just "buildingWhat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BuildingWhat) :*: (S1 ('MetaSel ('Just "localBuildInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LocalBuildInfo) :*: S1 ('MetaSel ('Just "targetInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TargetInfo))))Defined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal

typetype PreBuildComponentRules = Rules PreBuildComponentInputs

Post-build hook

datadata PostBuildComponentInputs

Constructors

PostBuildComponentInputs
- buildFlags :: BuildFlags
- localBuildInfo :: LocalBuildInfo
- targetInfo :: TargetInfo

Instances5Show, Generic, Binary, Structured, Rep

Show PostBuildComponentInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Generic PostBuildComponentInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Binary PostBuildComponentInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Structured PostBuildComponentInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
type Rep PostBuildComponentInputs = D1 ('MetaData "PostBuildComponentInputs" "Distribution.Simple.SetupHooks.Internal" "Cabal-3.18.1.0-cd98" 'False) (C1 ('MetaCons "PostBuildComponentInputs" 'PrefixI 'True) (S1 ('MetaSel ('Just "buildFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BuildFlags) :*: (S1 ('MetaSel ('Just "localBuildInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LocalBuildInfo) :*: S1 ('MetaSel ('Just "targetInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TargetInfo))))Defined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal

typetype PostBuildComponentHook = PostBuildComponentInputs -> IO ()

Install hooks

4 declarations

datadata InstallHooks

Copy/install hooks.

Constructors

InstallHooks
- installComponentHook :: Maybe InstallComponentHook
  Per-component install hook.

Instances2Semigroup, Monoid

Semigroup InstallHooksDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Monoid InstallHooksDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal

valuenoInstallHooks :: InstallHooks

Empty copy/install hooks.

datadata InstallComponentInputs

Constructors

InstallComponentInputs
- copyFlags :: CopyFlags
- localBuildInfo :: LocalBuildInfo
- targetInfo :: TargetInfo

Instances5Show, Generic, Binary, Structured, Rep

Show InstallComponentInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Generic InstallComponentInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Binary InstallComponentInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
Structured InstallComponentInputsDefined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal
type Rep InstallComponentInputs = D1 ('MetaData "InstallComponentInputs" "Distribution.Simple.SetupHooks.Internal" "Cabal-3.18.1.0-cd98" 'False) (C1 ('MetaCons "InstallComponentInputs" 'PrefixI 'True) (S1 ('MetaSel ('Just "copyFlags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CopyFlags) :*: (S1 ('MetaSel ('Just "localBuildInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LocalBuildInfo) :*: S1 ('MetaSel ('Just "targetInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TargetInfo))))Defined in Cabal-3.18.1.0 · Distribution.Simple.SetupHooks.Internal

typetype InstallComponentHook = InstallComponentInputs -> IO ()

A per-component install hook, which can only perform side effects (e.g. copying files).

Internals

0 declarations

Per-component hook utilities

valueapplyComponentDiffs

:: Verbosity
-> Component -> IO (Maybe ComponentDiff)
-> PackageDescription
-> IO PackageDescription

valueforComponents_

:: Applicative m
=> PackageDescription
-> Component -> m ()
-> m ()

Executing build rules

valueexecuteRules

:: Verbosity
-> LocalBuildInfo
-> TargetInfo
-> Map RuleId Rule
-> IO ()

Run all pre-build rules.

This function should only be called internally within Cabal, as it is used to implement the (legacy) Setup.hs interface. The build tool (e.g. cabal-install or hls) should instead go through the separate hooks executable, which allows us to only rerun the out-of-date rules (instead of running all of these rules at once).

valueexecuteRulesUserOrSystem

:: (Binary (RuleData userOrSystem), Structured (RuleData userOrSystem), Eq (RuleData userOrSystem))
=> SScope userOrSystem
-> RuleId -> RuleDynDepsCmd userOrSystem -> IO (Maybe ([Dependency], ByteString))
-> RuleId -> RuleExecCmd userOrSystem -> IO ()
-> Verbosity
-> LocalBuildInfo
-> TargetInfo
-> Map RuleId (RuleData userOrSystem)
-> IO ()

Like executeRules, except it can be used when communicating with an external hooks executable.

HookedBuildInfo compatibility code

valuehookedBuildInfoComponents :: HookedBuildInfo -> Set ComponentName

valuehookedBuildInfoComponentDiff_maybe