| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Distribution.Types.Flag
Synopsis
-
data
Flag
=
MkFlag
{
- flagName :: FlagName
- flagDescription :: String
- flagDefault :: Bool
- flagManual :: Bool
- emptyFlag :: FlagName -> Flag
- 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
- parsecFlagAssignment :: CabalParsing m => m FlagAssignment
Documentation
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
| MkFlag | |
|
Fields
|
|
Instances
| Eq Flag Source # | |
| Data Flag Source # | |
|
Defined in Distribution.Types.Flag Methods gfoldl :: ( forall d b. Data d => c (d -> b) -> d -> c b) -> ( forall g. g -> c g) -> Flag -> c Flag Source # gunfold :: ( forall b r. Data b => c (b -> r) -> c r) -> ( forall r. r -> c r) -> Constr -> c Flag Source # toConstr :: Flag -> Constr Source # dataTypeOf :: Flag -> DataType Source # dataCast1 :: Typeable t => ( forall d. Data d => c (t d)) -> Maybe (c Flag ) Source # dataCast2 :: Typeable t => ( forall d e. ( Data d, Data e) => c (t d e)) -> Maybe (c Flag ) Source # gmapT :: ( forall b. Data b => b -> b) -> Flag -> Flag Source # gmapQl :: (r -> r' -> r) -> r -> ( forall d. Data d => d -> r') -> Flag -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> ( forall d. Data d => d -> r') -> Flag -> r Source # gmapQ :: ( forall d. Data d => d -> u) -> Flag -> [u] Source # gmapQi :: Int -> ( forall d. Data d => d -> u) -> Flag -> u Source # gmapM :: Monad m => ( forall d. Data d => d -> m d) -> Flag -> m Flag Source # gmapMp :: MonadPlus m => ( forall d. Data d => d -> m d) -> Flag -> m Flag Source # gmapMo :: MonadPlus m => ( forall d. Data d => d -> m d) -> Flag -> m Flag Source # |
|
| Show Flag Source # | |
| Generic Flag Source # | |
| Binary Flag Source # | |
| NFData Flag Source # | |
|
Defined in Distribution.Types.Flag |
|
| Structured Flag Source # | |
|
Defined in Distribution.Types.Flag |
|
| type Rep Flag Source # | |
|
Defined in Distribution.Types.Flag
type
Rep
Flag
=
D1
('
MetaData
"Flag" "Distribution.Types.Flag" "Cabal-3.2.1.0-3w1fQQbNnuQ5xlFGwVXcPy" '
False
) (
C1
('
MetaCons
"MkFlag" '
PrefixI
'
True
) ((
S1
('
MetaSel
('
Just
"flagName") '
NoSourceUnpackedness
'
NoSourceStrictness
'
DecidedLazy
) (
Rec0
FlagName
)
:*:
S1
('
MetaSel
('
Just
"flagDescription") '
NoSourceUnpackedness
'
NoSourceStrictness
'
DecidedLazy
) (
Rec0
String
))
:*:
(
S1
('
MetaSel
('
Just
"flagDefault") '
NoSourceUnpackedness
'
NoSourceStrictness
'
DecidedLazy
) (
Rec0
Bool
)
:*:
S1
('
MetaSel
('
Just
"flagManual") '
NoSourceUnpackedness
'
NoSourceStrictness
'
DecidedLazy
) (
Rec0
Bool
))))
|
|
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: 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: 2.0.0.2
data FlagAssignment Source #
A
FlagAssignment
is a total or partial mapping of
FlagName
s 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)]
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: 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: 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: 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: 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: 2.2.0
findDuplicateFlagAssignments :: FlagAssignment -> [ FlagName ] Source #
Find the
FlagName
s that have been listed more than once.
Since: 2.2.0
nullFlagAssignment :: FlagAssignment -> Bool Source #
Test whether
FlagAssignment
is empty.
Since: 2.2.0
dispFlagAssignment :: FlagAssignment -> Doc Source #
Pretty-prints a flag assignment.
parsecFlagAssignment :: CabalParsing m => m FlagAssignment Source #
Parses a flag assignment.