| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Distribution.Types.Flag
Synopsis
- data PackageFlag = MkPackageFlag {}
- emptyFlag :: FlagName -> PackageFlag
- data FlagName
- mkFlagName :: String -> FlagName
- unFlagName :: FlagName -> String
- data FlagAssignment
- mkFlagAssignment :: [(FlagName, Bool)] -> FlagAssignment
- unFlagAssignment :: FlagAssignment -> [(FlagName, Bool)]
- lookupFlagAssignment :: FlagName -> FlagAssignment -> Maybe Bool
- insertFlagAssignment :: FlagName -> Bool -> FlagAssignment -> FlagAssignment
- diffFlagAssignment :: FlagAssignment -> FlagAssignment -> FlagAssignment
- findDuplicateFlagAssignments :: FlagAssignment -> [FlagName]
- nullFlagAssignment :: FlagAssignment -> Bool
- showFlagValue :: (FlagName, Bool) -> String
- dispFlagAssignment :: FlagAssignment -> Doc
- showFlagAssignment :: FlagAssignment -> String
- parsecFlagAssignment :: CabalParsing m => m FlagAssignment
- parsecFlagAssignmentNonEmpty :: CabalParsing m => m FlagAssignment
- legacyShowFlagAssignment :: FlagAssignment -> String
- legacyShowFlagAssignment' :: FlagAssignment -> [String]
- legacyParsecFlagAssignment :: CabalParsing m => m FlagAssignment
Package flag
data PackageFlag Source #
A flag can represent a feature to be included, or a way of linking a target against its dependencies, or in fact whatever you can think of.
Constructors
| MkPackageFlag | |
Fields
| |
Instances
emptyFlag :: FlagName -> PackageFlag Source #
A PackageFlag initialized with default parameters.
Flag name
A FlagName is the name of a user-defined configuration flag
Use mkFlagName and unFlagName to convert from/to a String.
This type is opaque since Cabal-2.0
Since: Cabal-2.0.0.2
Instances
mkFlagName :: String -> FlagName Source #
Construct a FlagName from a String
mkFlagName is the inverse to unFlagName
Note: No validations are performed to ensure that the resulting
FlagName is valid
Since: Cabal-2.0.0.2
Flag assignment
data FlagAssignment Source #
A FlagAssignment is a total or partial mapping of FlagNames to
Bool flag values. It represents the flags chosen by the user or
discovered during configuration. For example --flags=foo --flags=-bar
becomes [("foo", True), ("bar", False)]
TODO: Why we record the multiplicity of the flag?
Instances
mkFlagAssignment :: [(FlagName, Bool)] -> FlagAssignment Source #
Construct a FlagAssignment from a list of flag/value pairs.
If duplicate flags occur in the input list, the later entries in the list will take precedence.
Since: Cabal-2.2.0
unFlagAssignment :: FlagAssignment -> [(FlagName, Bool)] Source #
Deconstruct a FlagAssignment into a list of flag/value pairs.
null(findDuplicateFlagAssignmentsfa) ==> (mkFlagAssignment.unFlagAssignment) fa == fa
Since: Cabal-2.2.0
lookupFlagAssignment :: FlagName -> FlagAssignment -> Maybe Bool Source #
Lookup the value for a flag
Returns Nothing if the flag isn't contained in the FlagAssignment.
Since: Cabal-2.2.0
insertFlagAssignment :: FlagName -> Bool -> FlagAssignment -> FlagAssignment Source #
Insert or update the boolean value of a flag.
If the flag is already present in the FlagAssigment, the
value will be updated and the fact that multiple values have
been provided for that flag will be recorded so that a
warning can be generated later on.
Since: Cabal-2.2.0
diffFlagAssignment :: FlagAssignment -> FlagAssignment -> FlagAssignment Source #
Remove all flag-assignments from the first FlagAssignment that
are contained in the second FlagAssignment
NB/TODO: This currently only removes flag assignments which also match the value assignment! We should review the code which uses this operation to figure out if this it's not enough to only compare the flagnames without the values.
Since: Cabal-2.2.0
findDuplicateFlagAssignments :: FlagAssignment -> [FlagName] Source #
Find the FlagNames that have been listed more than once.
Since: Cabal-2.2.0
nullFlagAssignment :: FlagAssignment -> Bool Source #
Test whether FlagAssignment is empty.
Since: Cabal-2.2.0
dispFlagAssignment :: FlagAssignment -> Doc Source #
Pretty-prints a flag assignment.
showFlagAssignment :: FlagAssignment -> String Source #
Show flag assignment.
Since: Cabal-3.4.0.0
parsecFlagAssignment :: CabalParsing m => m FlagAssignment Source #
Parses a flag assignment.
parsecFlagAssignmentNonEmpty :: CabalParsing m => m FlagAssignment Source #
Parse a non-empty flag assignment
The flags have to explicitly start with minus or plus.
Since: Cabal-3.4.0.0
Legacy formats
legacyShowFlagAssignment :: FlagAssignment -> String Source #
We need this as far as we support custom setups older than 2.2.0.0
Since: Cabal-3.4.0.0
legacyShowFlagAssignment' :: FlagAssignment -> [String] Source #
Since: Cabal-3.4.0.0
legacyParsecFlagAssignment :: CabalParsing m => m FlagAssignment Source #
We need this as far as we support custom setups older than 2.2.0.0
Since: Cabal-3.4.0.0