Safe Haskell	None
Language	Haskell2010

Distribution.Simple.SetupHooks.Rule

Contents

Rules
Internals

Description

Internal module that defines fine-grained rules for setup hooks. Users should import SetupHooks instead.

Synopsis

type Rule = RuleData 'User
data RuleData (scope :: Scope) = Rule {
- ruleCommands :: !(RuleCmds scope)
- staticDependencies :: ![Dependency]
- results :: !(NonEmpty Location)
}
data RuleId = RuleId {
- ruleNameSpace :: !RulesNameSpace
- ruleName :: !ShortText
}
staticRule :: Typeable arg => Command arg (IO ()) -> [Dependency] -> NonEmpty Location -> Rule
dynamicRule :: (Typeable depsArg, Typeable depsRes, Typeable arg) => StaticPtr (Dict (Binary depsRes, Show depsRes, Eq depsRes)) -> Command depsArg (IO ([Dependency], depsRes)) -> Command arg (depsRes -> IO ()) -> [Dependency] -> NonEmpty Location -> Rule
data RuleCommands (scope :: Scope) (deps :: Scope -> Type -> Type -> Type) (ruleCmd :: Scope -> Type -> Type -> Type) where
- StaticRuleCommand :: forall arg (deps :: Scope -> Type -> Type -> Type) (ruleCmd :: Scope -> Type -> Type -> Type) (scope :: Scope). If (scope == 'System) (arg ~ ByteString) () => {..} -> RuleCommands scope deps ruleCmd
- DynamicRuleCommands :: forall depsArg depsRes arg (deps :: Scope -> Type -> Type -> Type) (ruleCmd :: Scope -> Type -> Type -> Type) (scope :: Scope). If (scope == 'System) (depsArg ~ ByteString, depsRes ~ ByteString, arg ~ ByteString) () => {..} -> RuleCommands scope deps ruleCmd
type Command = CommandData 'User
data CommandData (scope :: Scope) arg res = Command {
- actionPtr :: !(Static scope (arg -> res))
- actionArg :: !(ScopedArgument scope arg)
- cmdInstances :: !(Static scope (Dict (Binary arg, Show arg)))
}
runCommand :: Command args res -> res
mkCommand :: StaticPtr (Dict (Binary arg, Show arg)) -> StaticPtr (arg -> res) -> arg -> Command arg res
data Dict c where
- Dict :: forall c. c => Dict c
type RuleCmds (scope :: Scope) = RuleCommands scope DynDepsCmd CommandData
type RuleDynDepsCmd (scope :: Scope) = RuleCommands scope DynDepsCmd (NoCmd :: Scope -> Type -> Type -> Type)
type RuleExecCmd (scope :: Scope) = RuleCommands scope (DepsRes :: Scope -> Type -> Type -> Type) CommandData
newtype DynDepsCmd (scope :: Scope) depsArg depsRes = DynDepsCmd {
- dynDepsCmd :: CommandData scope depsArg (IO ([Dependency], depsRes))
}
newtype DepsRes (scope :: Scope) (depsArg :: k) depsRes = DepsRes {
- depsRes :: ScopedArgument scope depsRes
}
ruleDepsCmd :: forall (scope :: Scope). RuleCmds scope -> RuleDynDepsCmd scope
runRuleDynDepsCmd :: RuleDynDepsCmd 'User -> Maybe (IO ([Dependency], ByteString))
ruleExecCmd :: forall (scope :: Scope). SScope scope -> RuleCmds scope -> Maybe ByteString -> RuleExecCmd scope
runRuleExecCmd :: RuleExecCmd 'User -> IO ()
newtype Rules env = Rules {
- runRules :: env -> RulesM ()
}
data Dependency
- = RuleDependency !RuleOutput
- | FileDependency !Location
data RuleOutput = RuleOutput {
- outputOfRule :: !RuleId
- outputIndex :: !Word
}
rules :: StaticPtr label -> (env -> RulesM ()) -> Rules env
noRules :: RulesM ()
data Location where
- Location :: forall baseDir. {..} -> Location
location :: Location -> SymbolicPath Pkg 'File
data MonitorFilePath
- = MonitorFile {
  - monitorKindFile :: !MonitorKindFile
  - monitorKindDir :: !MonitorKindDir
  - monitorPath :: !FilePath
  }
- | MonitorFileGlob {
  - monitorKindFile :: !MonitorKindFile
  - monitorKindDir :: !MonitorKindDir
  - monitorPathGlob :: !RootedGlob
  }
data MonitorKindFile
- = FileExists
- | FileModTime
- | FileHashed
- | FileNotExists
data MonitorKindDir
- = DirExists
- | DirModTime
- | DirNotExists
type RulesM a = RulesT IO a
newtype RulesT (m :: Type -> Type) a = RulesT {
- runRulesT :: ReaderT RulesEnv (StateT (Map RuleId Rule) (WriterT [MonitorFilePath] m)) a
}
data RulesEnv = RulesEnv {
- rulesEnvVerbosity :: !Verbosity
- rulesEnvNameSpace :: !RulesNameSpace
}
computeRules :: Verbosity -> env -> Rules env -> IO (Map RuleId Rule, [MonitorFilePath])
data Scope
- = User
- | System
data SScope (scope :: Scope) where
- SUser :: SScope 'User
- SSystem :: SScope 'System
data family Static (scope :: Scope) :: Type -> Type
type RuleBinary = RuleData 'System
ruleBinary :: Rule -> RuleBinary

Rules

Rule

type Rule = RuleData 'User Source #

data RuleData (scope :: Scope) Source #

A rule consists of:

an action to run to execute the rule,
a description of the rule inputs and outputs.

Use staticRule or dynamicRule to construct a rule, overriding specific fields, rather than directly using the Rule constructor.

Constructors

Rule	Please use the `staticRule` or `dynamicRule` smart constructors instead of this constructor, in order to avoid relying on internal implementation details.
Fields ruleCommands :: !(RuleCmds scope) To run this rule, which `Command`s should we execute? staticDependencies :: ![Dependency] Static dependencies of this rule. results :: !(NonEmpty Location) Results of this rule.

Instances

Instances details

Show RuleBinary Source #

Trimmed down Show instance, mostly for error messages.

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

showsPrec :: Int -> RuleBinary -> ShowS #

show :: RuleBinary -> String #

showList :: [RuleBinary] -> ShowS #

Binary (RuleData 'System) Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

put :: RuleData 'System -> Put #

get :: Get (RuleData 'System) #

putList :: [RuleData 'System] -> Put #

Binary (RuleData 'User) Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

put :: RuleData 'User -> Put #

get :: Get (RuleData 'User) #

putList :: [RuleData 'User] -> Put #

Eq (RuleData 'System) Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

(==) :: RuleData 'System -> RuleData 'System -> Bool #

(/=) :: RuleData 'System -> RuleData 'System -> Bool #

Eq (RuleData 'User) Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

(==) :: RuleData 'User -> RuleData 'User -> Bool #

(/=) :: RuleData 'User -> RuleData 'User -> Bool #

Generic (RuleData scope) Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Associated Types

type Rep (RuleData scope)

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

type Rep (RuleData scope) = D1 ('MetaData "RuleData" "Distribution.Simple.SetupHooks.Rule" "Cabal-3.16.0.0-inplace" 'False) (C1 ('MetaCons "Rule" 'PrefixI 'True) (S1 ('MetaSel ('Just "ruleCommands") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (RuleCmds scope)) :*: (S1 ('MetaSel ('Just "staticDependencies") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Dependency]) :*: S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (NonEmpty Location)))))

Methods

from :: RuleData scope -> Rep (RuleData scope) x #

to :: Rep (RuleData scope) x -> RuleData scope #

Show (RuleData 'User) Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

showsPrec :: Int -> RuleData 'User -> ShowS #

show :: RuleData 'User -> String #

showList :: [RuleData 'User] -> ShowS #

type Rep (RuleData scope) Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

data RuleId Source #

A unique identifier for a Rule.

Constructors

RuleId
Fields ruleNameSpace :: !RulesNameSpace ruleName :: !ShortText

Instances

Instances details

Structured RuleId Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

structure :: Proxy RuleId -> Structure Source #

structureHash' :: Tagged RuleId MD5

Binary RuleId Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

put :: RuleId -> Put #

get :: Get RuleId #

putList :: [RuleId] -> Put #

Eq RuleId Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

(==) :: RuleId -> RuleId -> Bool #

(/=) :: RuleId -> RuleId -> Bool #

Ord RuleId Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

compare :: RuleId -> RuleId -> Ordering #

(<) :: RuleId -> RuleId -> Bool #

(<=) :: RuleId -> RuleId -> Bool #

(>) :: RuleId -> RuleId -> Bool #

(>=) :: RuleId -> RuleId -> Bool #

max :: RuleId -> RuleId -> RuleId #

min :: RuleId -> RuleId -> RuleId #

Generic RuleId Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Associated Types

type Rep RuleId
Instance details Defined in Distribution.Simple.SetupHooks.Rule type Rep RuleId

Methods

from :: RuleId -> Rep RuleId x #

to :: Rep RuleId x -> RuleId #

Show RuleId Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

showsPrec :: Int -> RuleId -> ShowS #

show :: RuleId -> String #

showList :: [RuleId] -> ShowS #

type Rep RuleId Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

type Rep RuleId

staticRule :: Typeable arg => Command arg (IO ()) -> [Dependency] -> NonEmpty Location -> Rule Source #

A rule with static dependencies.

Prefer using this smart constructor instead of Rule whenever possible.

dynamicRule :: (Typeable depsArg, Typeable depsRes, Typeable arg) => StaticPtr (Dict (Binary depsRes, Show depsRes, Eq depsRes)) -> Command depsArg (IO ([Dependency], depsRes)) -> Command arg (depsRes -> IO ()) -> [Dependency] -> NonEmpty Location -> Rule Source #

A rule with dynamic dependencies.

Prefer using this smart constructor instead of Rule whenever possible.

Commands

data RuleCommands (scope :: Scope) (deps :: Scope -> Type -> Type -> Type) (ruleCmd :: Scope -> Type -> Type -> Type) where Source #

Commands to execute a rule:

for a rule with static dependencies, a single command,
for a rule with dynamic dependencies, a command for computing dynamic dependencies, and a command for executing the rule.

Constructors

StaticRuleCommand	A rule with statically-known dependencies.
Fields :: forall arg (deps :: Scope -> Type -> Type -> Type) (ruleCmd :: Scope -> Type -> Type -> Type) (scope :: Scope). If (scope == 'System) (arg ~ ByteString) () => { staticRuleCommand :: !(ruleCmd scope arg (IO ())) The command to execute the rule. , staticRuleArgRep :: !(If (scope == 'System) SomeTypeRep (TypeRep arg)) A `TypeRep` for `arg`. } -> RuleCommands scope deps ruleCmd
DynamicRuleCommands
Fields :: forall depsArg depsRes arg (deps :: Scope -> Type -> Type -> Type) (ruleCmd :: Scope -> Type -> Type -> Type) (scope :: Scope). If (scope == 'System) (depsArg ~ ByteString, depsRes ~ ByteString, arg ~ ByteString) () => { dynamicRuleInstances :: !(Static scope (Dict (Binary depsRes, Show depsRes, Eq depsRes))) A rule with dynamic dependencies, which consists of two parts: a dynamic dependency computation, that returns additional edges to be added to the build graph together with an additional piece of data, the command to execute the rule itself, which receives the additional piece of data returned by the dependency computation. , dynamicDeps :: !(deps scope depsArg depsRes) A dynamic dependency computation. The resulting dependencies will be injected into the build graph, and the result of the computation will be passed on to the command that executes the rule. , dynamicRuleCommand :: !(ruleCmd scope arg (depsRes -> IO ())) The command to execute the rule. It will receive the result of the dynamic dependency computation. , dynamicRuleTypeRep :: !(If (scope == 'System) SomeTypeRep (TypeRep (depsArg, depsRes, arg))) A `TypeRep` for the triple `(depsArg,depsRes,arg)`. } -> RuleCommands scope deps ruleCmd

Instances

Instances details

(forall res. Binary (ruleCmd 'System ByteString res), Binary (deps 'System ByteString ByteString)) => Binary (RuleCommands 'System deps ruleCmd) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods put :: RuleCommands 'System deps ruleCmd -> Put # get :: Get (RuleCommands 'System deps ruleCmd) # putList :: [RuleCommands 'System deps ruleCmd] -> Put #
(forall arg res. Binary (ruleCmd 'User arg res), forall depsArg depsRes. Binary depsRes => Binary (deps 'User depsArg depsRes)) => Binary (RuleCommands 'User deps ruleCmd) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods put :: RuleCommands 'User deps ruleCmd -> Put # get :: Get (RuleCommands 'User deps ruleCmd) # putList :: [RuleCommands 'User deps ruleCmd] -> Put #
(forall res. Eq (ruleCmd 'System ByteString res), Eq (deps 'System ByteString ByteString)) => Eq (RuleCommands 'System deps ruleCmd) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods (==) :: RuleCommands 'System deps ruleCmd -> RuleCommands 'System deps ruleCmd -> Bool # (/=) :: RuleCommands 'System deps ruleCmd -> RuleCommands 'System deps ruleCmd -> Bool #
(forall arg res. Eq (ruleCmd 'User arg res), forall depsArg depsRes. Eq depsRes => Eq (deps 'User depsArg depsRes)) => Eq (RuleCommands 'User deps ruleCmd) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods (==) :: RuleCommands 'User deps ruleCmd -> RuleCommands 'User deps ruleCmd -> Bool # (/=) :: RuleCommands 'User deps ruleCmd -> RuleCommands 'User deps ruleCmd -> Bool #
(forall arg res. Show (ruleCmd 'User arg res), forall depsArg depsRes. Show depsRes => Show (deps 'User depsArg depsRes)) => Show (RuleCommands 'User deps ruleCmd) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods showsPrec :: Int -> RuleCommands 'User deps ruleCmd -> ShowS # show :: RuleCommands 'User deps ruleCmd -> String # showList :: [RuleCommands 'User deps ruleCmd] -> ShowS #

type Command = CommandData 'User Source #

A command consists of a statically-known action together with a (possibly dynamic) argument to that action.

For example, the action can consist of running an executable (such as happy or c2hs), while the argument consists of the variable component of the command, e.g. the specific file to run happy on.

data CommandData (scope :: Scope) arg res Source #

Internal datatype used for commands, both for the Hooks API (Command) and for the build system.

Constructors

Command
Fields actionPtr :: !(Static scope (arg -> res)) The (statically-known) action to execute. actionArg :: !(ScopedArgument scope arg) The (possibly dynamic) argument to pass to the action. cmdInstances :: !(Static scope (Dict (Binary arg, Show arg))) Static evidence that the argument can be serialised and deserialised.

Instances

Instances details

arg ~ ByteString => Binary (CommandData 'System arg res) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods put :: CommandData 'System arg res -> Put # get :: Get (CommandData 'System arg res) # putList :: [CommandData 'System arg res] -> Put #
Binary (CommandData 'User arg res) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods put :: CommandData 'User arg res -> Put # get :: Get (CommandData 'User arg res) # putList :: [CommandData 'User arg res] -> Put #
arg ~ ByteString => Eq (CommandData 'System arg res) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods (==) :: CommandData 'System arg res -> CommandData 'System arg res -> Bool # (/=) :: CommandData 'System arg res -> CommandData 'System arg res -> Bool #
Eq (CommandData 'User arg res) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods (==) :: CommandData 'User arg res -> CommandData 'User arg res -> Bool # (/=) :: CommandData 'User arg res -> CommandData 'User arg res -> Bool #
Show (CommandData 'User arg res) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods showsPrec :: Int -> CommandData 'User arg res -> ShowS # show :: CommandData 'User arg res -> String # showList :: [CommandData 'User arg res] -> ShowS #

runCommand :: Command args res -> res Source #

Run a Command.

mkCommand :: StaticPtr (Dict (Binary arg, Show arg)) -> StaticPtr (arg -> res) -> arg -> Command arg res Source #

Construct a command.

Prefer using this smart constructor instead of Command whenever possible.

data Dict c where Source #

A wrapper used to pass evidence of a constraint as an explicit value.

Constructors

Dict :: forall c. c => Dict c

Helpers for executing commands

type RuleCmds (scope :: Scope) = RuleCommands scope DynDepsCmd CommandData Source #

Both the rule command and the (optional) dynamic dependency command.

type RuleDynDepsCmd (scope :: Scope) = RuleCommands scope DynDepsCmd (NoCmd :: Scope -> Type -> Type -> Type) Source #

Only the (optional) dynamic dependency command.

type RuleExecCmd (scope :: Scope) = RuleCommands scope (DepsRes :: Scope -> Type -> Type -> Type) CommandData Source #

The rule command together with the result of the (optional) dynamic dependency computation.

newtype DynDepsCmd (scope :: Scope) depsArg depsRes Source #

A dynamic dependency command.

Constructors

DynDepsCmd
Fields dynDepsCmd :: CommandData scope depsArg (IO ([Dependency], depsRes))

Instances

Instances details

(arg ~ ByteString, depsRes ~ ByteString) => Binary (DynDepsCmd 'System arg depsRes) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods put :: DynDepsCmd 'System arg depsRes -> Put # get :: Get (DynDepsCmd 'System arg depsRes) # putList :: [DynDepsCmd 'System arg depsRes] -> Put #
Binary (DynDepsCmd 'User depsArg depsRes) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods put :: DynDepsCmd 'User depsArg depsRes -> Put # get :: Get (DynDepsCmd 'User depsArg depsRes) # putList :: [DynDepsCmd 'User depsArg depsRes] -> Put #
(arg ~ ByteString, depsRes ~ ByteString) => Eq (DynDepsCmd 'System arg depsRes) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods (==) :: DynDepsCmd 'System arg depsRes -> DynDepsCmd 'System arg depsRes -> Bool # (/=) :: DynDepsCmd 'System arg depsRes -> DynDepsCmd 'System arg depsRes -> Bool #
Eq (DynDepsCmd 'User depsArg depsRes) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods (==) :: DynDepsCmd 'User depsArg depsRes -> DynDepsCmd 'User depsArg depsRes -> Bool # (/=) :: DynDepsCmd 'User depsArg depsRes -> DynDepsCmd 'User depsArg depsRes -> Bool #
Show (DynDepsCmd 'User depsArg depsRes) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods showsPrec :: Int -> DynDepsCmd 'User depsArg depsRes -> ShowS # show :: DynDepsCmd 'User depsArg depsRes -> String # showList :: [DynDepsCmd 'User depsArg depsRes] -> ShowS #

newtype DepsRes (scope :: Scope) (depsArg :: k) depsRes Source #

The result of a dynamic dependency computation.

Constructors

DepsRes
Fields depsRes :: ScopedArgument scope depsRes

Instances

Instances details

Binary (ScopedArgument scope depsRes) => Binary (DepsRes scope depsArg depsRes) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods put :: DepsRes scope depsArg depsRes -> Put # get :: Get (DepsRes scope depsArg depsRes) # putList :: [DepsRes scope depsArg depsRes] -> Put #
Eq depsRes => Eq (DepsRes scope depsArg depsRes) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods (==) :: DepsRes scope depsArg depsRes -> DepsRes scope depsArg depsRes -> Bool # (/=) :: DepsRes scope depsArg depsRes -> DepsRes scope depsArg depsRes -> Bool #
Ord depsRes => Ord (DepsRes scope depsArg depsRes) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods compare :: DepsRes scope depsArg depsRes -> DepsRes scope depsArg depsRes -> Ordering # (<) :: DepsRes scope depsArg depsRes -> DepsRes scope depsArg depsRes -> Bool # (<=) :: DepsRes scope depsArg depsRes -> DepsRes scope depsArg depsRes -> Bool # (>) :: DepsRes scope depsArg depsRes -> DepsRes scope depsArg depsRes -> Bool # (>=) :: DepsRes scope depsArg depsRes -> DepsRes scope depsArg depsRes -> Bool # max :: DepsRes scope depsArg depsRes -> DepsRes scope depsArg depsRes -> DepsRes scope depsArg depsRes # min :: DepsRes scope depsArg depsRes -> DepsRes scope depsArg depsRes -> DepsRes scope depsArg depsRes #
Show depsRes => Show (DepsRes scope depsArg depsRes) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods showsPrec :: Int -> DepsRes scope depsArg depsRes -> ShowS # show :: DepsRes scope depsArg depsRes -> String # showList :: [DepsRes scope depsArg depsRes] -> ShowS #

ruleDepsCmd :: forall (scope :: Scope). RuleCmds scope -> RuleDynDepsCmd scope Source #

Project out the (optional) dependency computation command, so that it can be serialised without serialising anything else.

runRuleDynDepsCmd :: RuleDynDepsCmd 'User -> Maybe (IO ([Dependency], ByteString)) Source #

Obtain the (optional) IO action that computes dynamic dependencies.

ruleExecCmd :: forall (scope :: Scope). SScope scope -> RuleCmds scope -> Maybe ByteString -> RuleExecCmd scope Source #

Project out the command for running the rule, passing in the result of the dependency computation if there was one.

runRuleExecCmd :: RuleExecCmd 'User -> IO () Source #

Obtain the IO action that executes a rule.

Collections of rules

newtype Rules env Source #

A collection of Rules.

Use the rules smart constructor instead of directly using the Rules constructor.

Rules are registered using registerRule,
Monitored files or directories are declared using addRuleMonitors; a change in these will trigger the recomputation of all rules.

The env type parameter represents an extra argument, which usually consists of information known to Cabal such as LocalBuildInfo and ComponentLocalBuildInfo.

Constructors

Rules
Fields runRules :: env -> RulesM ()

Instances

Instances details

Monoid (Rules env) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods mempty :: Rules env # mappend :: Rules env -> Rules env -> Rules env # mconcat :: [Rules env] -> Rules env #
Semigroup (Rules env) Source #	Warning: this `Semigroup` instance is not commutative.
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods (<>) :: Rules env -> Rules env -> Rules env # sconcat :: NonEmpty (Rules env) -> Rules env # stimes :: Integral b => b -> Rules env -> Rules env #

data Dependency Source #

A dependency of a rule.

Constructors

RuleDependency !RuleOutput

A dependency on an output of another rule.

FileDependency !Location

A direct dependency on a file at a particular location on disk.

This should not be used for files that are generated by other rules; use RuleDependency instead.

Instances

Instances details

Structured Dependency Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

structure :: Proxy Dependency -> Structure Source #

structureHash' :: Tagged Dependency MD5

Binary Dependency Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

put :: Dependency -> Put #

get :: Get Dependency #

putList :: [Dependency] -> Put #

Eq Dependency Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

(==) :: Dependency -> Dependency -> Bool #

(/=) :: Dependency -> Dependency -> Bool #

Ord Dependency Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

compare :: Dependency -> Dependency -> Ordering #

(<) :: Dependency -> Dependency -> Bool #

(<=) :: Dependency -> Dependency -> Bool #

(>) :: Dependency -> Dependency -> Bool #

(>=) :: Dependency -> Dependency -> Bool #

max :: Dependency -> Dependency -> Dependency #

min :: Dependency -> Dependency -> Dependency #

Generic Dependency Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Associated Types

type Rep Dependency

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

type Rep Dependency = D1 ('MetaData "Dependency" "Distribution.Simple.SetupHooks.Rule" "Cabal-3.16.0.0-inplace" 'False) (C1 ('MetaCons "RuleDependency" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RuleOutput)) :+: C1 ('MetaCons "FileDependency" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Location)))

Methods

from :: Dependency -> Rep Dependency x #

to :: Rep Dependency x -> Dependency #

Show Dependency Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

showsPrec :: Int -> Dependency -> ShowS #

show :: Dependency -> String #

showList :: [Dependency] -> ShowS #

type Rep Dependency Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

data RuleOutput Source #

A reference to an output of another rule.

Constructors

RuleOutput
Fields outputOfRule :: !RuleId which rule's outputs are we referring to? outputIndex :: !Word which particular output of that rule?

Instances

Instances details

Structured RuleOutput Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

structure :: Proxy RuleOutput -> Structure Source #

structureHash' :: Tagged RuleOutput MD5

Binary RuleOutput Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

put :: RuleOutput -> Put #

get :: Get RuleOutput #

putList :: [RuleOutput] -> Put #

Eq RuleOutput Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

(==) :: RuleOutput -> RuleOutput -> Bool #

(/=) :: RuleOutput -> RuleOutput -> Bool #

Ord RuleOutput Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

compare :: RuleOutput -> RuleOutput -> Ordering #

(<) :: RuleOutput -> RuleOutput -> Bool #

(<=) :: RuleOutput -> RuleOutput -> Bool #

(>) :: RuleOutput -> RuleOutput -> Bool #

(>=) :: RuleOutput -> RuleOutput -> Bool #

max :: RuleOutput -> RuleOutput -> RuleOutput #

min :: RuleOutput -> RuleOutput -> RuleOutput #

Generic RuleOutput Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Associated Types

type Rep RuleOutput

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

type Rep RuleOutput = D1 ('MetaData "RuleOutput" "Distribution.Simple.SetupHooks.Rule" "Cabal-3.16.0.0-inplace" 'False) (C1 ('MetaCons "RuleOutput" 'PrefixI 'True) (S1 ('MetaSel ('Just "outputOfRule") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RuleId) :*: S1 ('MetaSel ('Just "outputIndex") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word)))

Methods

from :: RuleOutput -> Rep RuleOutput x #

to :: Rep RuleOutput x -> RuleOutput #

Show RuleOutput Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

Methods

showsPrec :: Int -> RuleOutput -> ShowS #

show :: RuleOutput -> String #

showList :: [RuleOutput] -> ShowS #

type Rep RuleOutput Source #

Instance details

Defined in Distribution.Simple.SetupHooks.Rule

rules Source #

Arguments

:: StaticPtr label	unique label for this collection of rules
-> (env -> RulesM ())	the computation of rules
-> Rules env

Construct a collection of rules with a given label.

A label for the rules can be constructed using the static keyword, using the StaticPointers extension. NB: separate calls to rules should have different labels.

Example usage:

myRules :: Rules env
myRules = rules (static ()) $ \ env -> do { .. } -- use the monadic API here

noRules :: RulesM () Source #

An empty collection of rules.

Rule inputs/outputs

data Location where Source #

A (fully resolved) location of a dependency or result of a rule, consisting of a base directory and of a file path relative to that base directory path.

In practice, this will be something like Location dir (moduleNameSymbolicPath mod . "hs"), where:

for a file dependency, dir is one of the Cabal search directories,
for an output, dir is a directory such as autogenComponentModulesDir or componentBuildDir.

Constructors

Location
Fields :: forall baseDir. { locationBaseDir :: !(SymbolicPath Pkg ('Dir baseDir)) Base directory. , locationRelPath :: !(RelativePath baseDir 'File) File path relative to base directory (including file extension). } -> Location

Instances

Instances details

Structured Location Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods structure :: Proxy Location -> Structure Source # structureHash' :: Tagged Location MD5
Binary Location Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods put :: Location -> Put # get :: Get Location # putList :: [Location] -> Put #
Eq Location Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods (==) :: Location -> Location -> Bool # (/=) :: Location -> Location -> Bool #
Ord Location Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods compare :: Location -> Location -> Ordering # (<) :: Location -> Location -> Bool # (<=) :: Location -> Location -> Bool # (>) :: Location -> Location -> Bool # (>=) :: Location -> Location -> Bool # max :: Location -> Location -> Location # min :: Location -> Location -> Location #
Show Location Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods showsPrec :: Int -> Location -> ShowS # show :: Location -> String # showList :: [Location] -> ShowS #

location :: Location -> SymbolicPath Pkg 'File Source #

Get a (relative or absolute) un-interpreted path to a Location.

File/directory monitoring

data MonitorFilePath Source #

A description of a file (or set of files) to monitor for changes.

Where file paths are relative they are relative to a common directory (e.g. project root), not necessarily the process current directory.

Constructors

MonitorFile
Fields monitorKindFile :: !MonitorKindFile monitorKindDir :: !MonitorKindDir monitorPath :: !FilePath
MonitorFileGlob
Fields monitorKindFile :: !MonitorKindFile monitorKindDir :: !MonitorKindDir monitorPathGlob :: !RootedGlob

Instances

Instances details

Structured MonitorFilePath Source #

Instance details

Defined in Distribution.Simple.FileMonitor.Types

Methods

structure :: Proxy MonitorFilePath -> Structure Source #

structureHash' :: Tagged MonitorFilePath MD5

Binary MonitorFilePath Source #

Instance details

Defined in Distribution.Simple.FileMonitor.Types

Methods

put :: MonitorFilePath -> Put #

get :: Get MonitorFilePath #

putList :: [MonitorFilePath] -> Put #

Eq MonitorFilePath Source #

Instance details

Defined in Distribution.Simple.FileMonitor.Types

Methods

(==) :: MonitorFilePath -> MonitorFilePath -> Bool #

(/=) :: MonitorFilePath -> MonitorFilePath -> Bool #

Generic MonitorFilePath Source #

Instance details

Defined in Distribution.Simple.FileMonitor.Types

Associated Types

type Rep MonitorFilePath

Instance details

Defined in Distribution.Simple.FileMonitor.Types

type Rep MonitorFilePath = D1 ('MetaData "MonitorFilePath" "Distribution.Simple.FileMonitor.Types" "Cabal-3.16.0.0-inplace" 'False) (C1 ('MetaCons "MonitorFile" 'PrefixI 'True) (S1 ('MetaSel ('Just "monitorKindFile") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MonitorKindFile) :*: (S1 ('MetaSel ('Just "monitorKindDir") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MonitorKindDir) :*: S1 ('MetaSel ('Just "monitorPath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 FilePath))) :+: C1 ('MetaCons "MonitorFileGlob" 'PrefixI 'True) (S1 ('MetaSel ('Just "monitorKindFile") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MonitorKindFile) :*: (S1 ('MetaSel ('Just "monitorKindDir") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MonitorKindDir) :*: S1 ('MetaSel ('Just "monitorPathGlob") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RootedGlob))))

Methods

from :: MonitorFilePath -> Rep MonitorFilePath x #

to :: Rep MonitorFilePath x -> MonitorFilePath #

Show MonitorFilePath Source #

Instance details

Defined in Distribution.Simple.FileMonitor.Types

Methods

showsPrec :: Int -> MonitorFilePath -> ShowS #

show :: MonitorFilePath -> String #

showList :: [MonitorFilePath] -> ShowS #

type Rep MonitorFilePath Source #

Instance details

Defined in Distribution.Simple.FileMonitor.Types

data MonitorKindFile Source #

Constructors

FileExists
FileModTime
FileHashed
FileNotExists

Instances

Instances details

Structured MonitorKindFile Source #

Instance details

Defined in Distribution.Simple.FileMonitor.Types

Methods

structure :: Proxy MonitorKindFile -> Structure Source #

structureHash' :: Tagged MonitorKindFile MD5

Binary MonitorKindFile Source #

Instance details

Defined in Distribution.Simple.FileMonitor.Types

Methods

put :: MonitorKindFile -> Put #

get :: Get MonitorKindFile #

putList :: [MonitorKindFile] -> Put #

Eq MonitorKindFile Source #

Instance details

Defined in Distribution.Simple.FileMonitor.Types

Methods

(==) :: MonitorKindFile -> MonitorKindFile -> Bool #

(/=) :: MonitorKindFile -> MonitorKindFile -> Bool #

Generic MonitorKindFile Source #

Instance details

Defined in Distribution.Simple.FileMonitor.Types

Associated Types

type Rep MonitorKindFile

Instance details

Defined in Distribution.Simple.FileMonitor.Types

type Rep MonitorKindFile = D1 ('MetaData "MonitorKindFile" "Distribution.Simple.FileMonitor.Types" "Cabal-3.16.0.0-inplace" 'False) ((C1 ('MetaCons "FileExists" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FileModTime" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "FileHashed" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FileNotExists" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: MonitorKindFile -> Rep MonitorKindFile x #

to :: Rep MonitorKindFile x -> MonitorKindFile #

Show MonitorKindFile Source #

Instance details

Defined in Distribution.Simple.FileMonitor.Types

Methods

showsPrec :: Int -> MonitorKindFile -> ShowS #

show :: MonitorKindFile -> String #

showList :: [MonitorKindFile] -> ShowS #

type Rep MonitorKindFile Source #

Instance details

Defined in Distribution.Simple.FileMonitor.Types

data MonitorKindDir Source #

Constructors

DirExists
DirModTime
DirNotExists

Instances

Instances details

Structured MonitorKindDir Source #

Instance details

Defined in Distribution.Simple.FileMonitor.Types

Methods

structure :: Proxy MonitorKindDir -> Structure Source #

structureHash' :: Tagged MonitorKindDir MD5

Binary MonitorKindDir Source #

Instance details

Defined in Distribution.Simple.FileMonitor.Types

Methods

put :: MonitorKindDir -> Put #

get :: Get MonitorKindDir #

putList :: [MonitorKindDir] -> Put #

Eq MonitorKindDir Source #

Instance details

Defined in Distribution.Simple.FileMonitor.Types

Methods

(==) :: MonitorKindDir -> MonitorKindDir -> Bool #

(/=) :: MonitorKindDir -> MonitorKindDir -> Bool #

Generic MonitorKindDir Source #

Instance details

Defined in Distribution.Simple.FileMonitor.Types

Associated Types

type Rep MonitorKindDir

Instance details

Defined in Distribution.Simple.FileMonitor.Types

type Rep MonitorKindDir = D1 ('MetaData "MonitorKindDir" "Distribution.Simple.FileMonitor.Types" "Cabal-3.16.0.0-inplace" 'False) (C1 ('MetaCons "DirExists" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DirModTime" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DirNotExists" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: MonitorKindDir -> Rep MonitorKindDir x #

to :: Rep MonitorKindDir x -> MonitorKindDir #

Show MonitorKindDir Source #

Instance details

Defined in Distribution.Simple.FileMonitor.Types

Methods

showsPrec :: Int -> MonitorKindDir -> ShowS #

show :: MonitorKindDir -> String #

showList :: [MonitorKindDir] -> ShowS #

type Rep MonitorKindDir Source #

Instance details

Defined in Distribution.Simple.FileMonitor.Types

Monadic API for generation of `ActionId`

type RulesM a = RulesT IO a Source #

Monad for constructing rules.

newtype RulesT (m :: Type -> Type) a Source #

Monad transformer for defining rules. Usually wraps the IO monad, allowing IO actions to be performed using liftIO.

Constructors

RulesT
Fields runRulesT :: ReaderT RulesEnv (StateT (Map RuleId Rule) (WriterT [MonitorFilePath] m)) a

Instances

Instances details

MonadTrans RulesT Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods lift :: Monad m => m a -> RulesT m a Source #
Monad m => Applicative (RulesT m) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods pure :: a -> RulesT m a # (<>) :: RulesT m (a -> b) -> RulesT m a -> RulesT m b # liftA2 :: (a -> b -> c) -> RulesT m a -> RulesT m b -> RulesT m c # (>) :: RulesT m a -> RulesT m b -> RulesT m b # (<*) :: RulesT m a -> RulesT m b -> RulesT m a #
Functor m => Functor (RulesT m) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods fmap :: (a -> b) -> RulesT m a -> RulesT m b # (<$) :: a -> RulesT m b -> RulesT m a #
Monad m => Monad (RulesT m) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods (>>=) :: RulesT m a -> (a -> RulesT m b) -> RulesT m b # (>>) :: RulesT m a -> RulesT m b -> RulesT m b # return :: a -> RulesT m a #
MonadFix m => MonadFix (RulesT m) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods mfix :: (a -> RulesT m a) -> RulesT m a #
MonadIO m => MonadIO (RulesT m) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods liftIO :: IO a -> RulesT m a #

data RulesEnv Source #

The environment within the monadic API.

Constructors

RulesEnv
Fields rulesEnvVerbosity :: !Verbosity rulesEnvNameSpace :: !RulesNameSpace

computeRules :: Verbosity -> env -> Rules env -> IO (Map RuleId Rule, [MonitorFilePath]) Source #

Internal function: run the monadic Rules computations in order to obtain all the Rules with their RuleIds.

Internals

data Scope Source #

Rules are defined with rich types by the package.

The build system only has a limited view of these; most data consists of opaque ByteStrings.

The Scope data-type describes which side of this divide we are on.

Constructors

User	User space (with rich types).
System	Build-system space (manipulation of raw data).

data SScope (scope :: Scope) where Source #

Constructors

SUser :: SScope 'User
SSystem :: SScope 'System

data family Static (scope :: Scope) :: Type -> Type Source #

A static pointer (in user scope) or its key (in system scope).

Instances

Instances details

Binary (Static 'System fnTy) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods put :: Static 'System fnTy -> Put # get :: Get (Static 'System fnTy) # putList :: [Static 'System fnTy] -> Put #
Binary (Static 'User fnTy) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods put :: Static 'User fnTy -> Put # get :: Get (Static 'User fnTy) # putList :: [Static 'User fnTy] -> Put #
Eq (Static 'System fnTy) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods (==) :: Static 'System fnTy -> Static 'System fnTy -> Bool # (/=) :: Static 'System fnTy -> Static 'System fnTy -> Bool #
Eq (Static 'User fnTy) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods (==) :: Static 'User fnTy -> Static 'User fnTy -> Bool # (/=) :: Static 'User fnTy -> Static 'User fnTy -> Bool #
Ord (Static 'System fnTy) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods compare :: Static 'System fnTy -> Static 'System fnTy -> Ordering # (<) :: Static 'System fnTy -> Static 'System fnTy -> Bool # (<=) :: Static 'System fnTy -> Static 'System fnTy -> Bool # (>) :: Static 'System fnTy -> Static 'System fnTy -> Bool # (>=) :: Static 'System fnTy -> Static 'System fnTy -> Bool # max :: Static 'System fnTy -> Static 'System fnTy -> Static 'System fnTy # min :: Static 'System fnTy -> Static 'System fnTy -> Static 'System fnTy #
Ord (Static 'User fnTy) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods compare :: Static 'User fnTy -> Static 'User fnTy -> Ordering # (<) :: Static 'User fnTy -> Static 'User fnTy -> Bool # (<=) :: Static 'User fnTy -> Static 'User fnTy -> Bool # (>) :: Static 'User fnTy -> Static 'User fnTy -> Bool # (>=) :: Static 'User fnTy -> Static 'User fnTy -> Bool # max :: Static 'User fnTy -> Static 'User fnTy -> Static 'User fnTy # min :: Static 'User fnTy -> Static 'User fnTy -> Static 'User fnTy #
Show (Static 'System fnTy) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods showsPrec :: Int -> Static 'System fnTy -> ShowS # show :: Static 'System fnTy -> String # showList :: [Static 'System fnTy] -> ShowS #
Show (Static 'User fnTy) Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule Methods showsPrec :: Int -> Static 'User fnTy -> ShowS # show :: Static 'User fnTy -> String # showList :: [Static 'User fnTy] -> ShowS #
newtype Static 'System fnTy Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule newtype Static 'System fnTy = SystemStatic { userStaticKey :: StaticKey }
newtype Static 'User fnTy Source #
Instance details Defined in Distribution.Simple.SetupHooks.Rule newtype Static 'User fnTy = UserStatic { userStaticPtr :: StaticPtr fnTy }

type RuleBinary = RuleData 'System Source #

ruleBinary :: Rule -> RuleBinary Source #

Rules

Rule

Instances

Instances

Commands

Instances

Instances

Helpers for executing commands

Instances

Instances

Collections of rules

Instances

Instances

Instances

Rule inputs/outputs

Instances

File/directory monitoring

Instances

Instances

Instances

Monadic API for generation of ActionId

Instances

Internals

Instances

Monadic API for generation of `ActionId`