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

data Flag #

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 flagName :: FlagName flagDescription :: String flagDefault :: Bool flagManual :: Bool

Instances

Eq Flag #
Instance details Defined in Distribution.Types.Flag Methods (==) :: Flag -> Flag -> Bool # (/=) :: Flag -> Flag -> Bool #
Data Flag #
Instance details 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 # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Flag # toConstr :: Flag -> Constr # dataTypeOf :: Flag -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Flag) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Flag) # gmapT :: (forall b. Data b => b -> b) -> Flag -> Flag # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Flag -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Flag -> r # gmapQ :: (forall d. Data d => d -> u) -> Flag -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Flag -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Flag -> m Flag # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Flag -> m Flag # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Flag -> m Flag #
Show Flag #
Instance details Defined in Distribution.Types.Flag Methods showsPrec :: Int -> Flag -> ShowS # show :: Flag -> String # showList :: [Flag] -> ShowS #
Generic Flag #
Instance details Defined in Distribution.Types.Flag Associated Types type Rep Flag :: * -> * # Methods from :: Flag -> Rep Flag x # to :: Rep Flag x -> Flag #
Binary Flag #
Instance details Defined in Distribution.Types.Flag Methods put :: Flag -> Put # get :: Get Flag # putList :: [Flag] -> Put #
NFData Flag #
Instance details Defined in Distribution.Types.Flag Methods rnf :: Flag -> () #
Structured Flag #
Instance details Defined in Distribution.Types.Flag Methods structure :: Proxy Flag -> Structure # structureHash' :: Tagged Flag MD5
type Rep Flag #
Instance details Defined in Distribution.Types.Flag type Rep Flag = D1 (MetaData "Flag" "Distribution.Types.Flag" "Cabal-3.3.0.0-inplace" 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))))

emptyFlag :: FlagName -> Flag #

A Flag initialized with default parameters.

data FlagName #

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

Eq FlagName #
Instance details Defined in Distribution.Types.Flag Methods (==) :: FlagName -> FlagName -> Bool # (/=) :: FlagName -> FlagName -> Bool #
Data FlagName #
Instance details Defined in Distribution.Types.Flag Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FlagName -> c FlagName # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FlagName # toConstr :: FlagName -> Constr # dataTypeOf :: FlagName -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c FlagName) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FlagName) # gmapT :: (forall b. Data b => b -> b) -> FlagName -> FlagName # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FlagName -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FlagName -> r # gmapQ :: (forall d. Data d => d -> u) -> FlagName -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> FlagName -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> FlagName -> m FlagName # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FlagName -> m FlagName # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FlagName -> m FlagName #
Ord FlagName #
Instance details Defined in Distribution.Types.Flag Methods compare :: FlagName -> FlagName -> Ordering # (<) :: FlagName -> FlagName -> Bool # (<=) :: FlagName -> FlagName -> Bool # (>) :: FlagName -> FlagName -> Bool # (>=) :: FlagName -> FlagName -> Bool # max :: FlagName -> FlagName -> FlagName # min :: FlagName -> FlagName -> FlagName #
Read FlagName #
Instance details Defined in Distribution.Types.Flag Methods readsPrec :: Int -> ReadS FlagName # readList :: ReadS [FlagName] # readPrec :: ReadPrec FlagName # readListPrec :: ReadPrec [FlagName] #
Show FlagName #
Instance details Defined in Distribution.Types.Flag Methods showsPrec :: Int -> FlagName -> ShowS # show :: FlagName -> String # showList :: [FlagName] -> ShowS #
IsString FlagName #	`mkFlagName` Since: 2.0.0.2
Instance details Defined in Distribution.Types.Flag Methods fromString :: String -> FlagName #
Generic FlagName #
Instance details Defined in Distribution.Types.Flag Associated Types type Rep FlagName :: * -> * # Methods from :: FlagName -> Rep FlagName x # to :: Rep FlagName x -> FlagName #
Binary FlagName #
Instance details Defined in Distribution.Types.Flag Methods put :: FlagName -> Put # get :: Get FlagName # putList :: [FlagName] -> Put #
NFData FlagName #
Instance details Defined in Distribution.Types.Flag Methods rnf :: FlagName -> () #
Structured FlagName #
Instance details Defined in Distribution.Types.Flag Methods structure :: Proxy FlagName -> Structure # structureHash' :: Tagged FlagName MD5
Pretty FlagName #
Instance details Defined in Distribution.Types.Flag Methods pretty :: FlagName -> Doc # prettyVersioned :: CabalSpecVersion -> FlagName -> Doc #
Parsec FlagName #
Instance details Defined in Distribution.Types.Flag Methods parsec :: CabalParsing m => m FlagName #
type Rep FlagName #
Instance details Defined in Distribution.Types.Flag type Rep FlagName = D1 (MetaData "FlagName" "Distribution.Types.Flag" "Cabal-3.3.0.0-inplace" True) (C1 (MetaCons "FlagName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ShortText)))

mkFlagName :: String -> FlagName #

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

unFlagName :: FlagName -> String #

Convert FlagName to String

Since: 2.0.0.2

data FlagAssignment #

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)]

Instances

Eq FlagAssignment #
Instance details Defined in Distribution.Types.Flag Methods (==) :: FlagAssignment -> FlagAssignment -> Bool # (/=) :: FlagAssignment -> FlagAssignment -> Bool #
Ord FlagAssignment #
Instance details Defined in Distribution.Types.Flag Methods compare :: FlagAssignment -> FlagAssignment -> Ordering # (<) :: FlagAssignment -> FlagAssignment -> Bool # (<=) :: FlagAssignment -> FlagAssignment -> Bool # (>) :: FlagAssignment -> FlagAssignment -> Bool # (>=) :: FlagAssignment -> FlagAssignment -> Bool # max :: FlagAssignment -> FlagAssignment -> FlagAssignment # min :: FlagAssignment -> FlagAssignment -> FlagAssignment #
Read FlagAssignment #	Since: 2.2.0
Instance details Defined in Distribution.Types.Flag Methods readsPrec :: Int -> ReadS FlagAssignment # readList :: ReadS [FlagAssignment] # readPrec :: ReadPrec FlagAssignment # readListPrec :: ReadPrec [FlagAssignment] #
Show FlagAssignment #	Since: 2.2.0
Instance details Defined in Distribution.Types.Flag Methods showsPrec :: Int -> FlagAssignment -> ShowS # show :: FlagAssignment -> String # showList :: [FlagAssignment] -> ShowS #
Generic FlagAssignment #
Instance details Defined in Distribution.Types.Flag Associated Types type Rep FlagAssignment :: * -> * # Methods from :: FlagAssignment -> Rep FlagAssignment x # to :: Rep FlagAssignment x -> FlagAssignment #
Semigroup FlagAssignment #
Instance details Defined in Distribution.Types.Flag Methods (<>) :: FlagAssignment -> FlagAssignment -> FlagAssignment # sconcat :: NonEmpty FlagAssignment -> FlagAssignment # stimes :: Integral b => b -> FlagAssignment -> FlagAssignment #
Monoid FlagAssignment #
Instance details Defined in Distribution.Types.Flag Methods mempty :: FlagAssignment # mappend :: FlagAssignment -> FlagAssignment -> FlagAssignment # mconcat :: [FlagAssignment] -> FlagAssignment #
Binary FlagAssignment #
Instance details Defined in Distribution.Types.Flag Methods put :: FlagAssignment -> Put # get :: Get FlagAssignment # putList :: [FlagAssignment] -> Put #
NFData FlagAssignment #
Instance details Defined in Distribution.Types.Flag Methods rnf :: FlagAssignment -> () #
Structured FlagAssignment #
Instance details Defined in Distribution.Types.Flag Methods structure :: Proxy FlagAssignment -> Structure # structureHash' :: Tagged FlagAssignment MD5
type Rep FlagAssignment #
Instance details Defined in Distribution.Types.Flag type Rep FlagAssignment = D1 (MetaData "FlagAssignment" "Distribution.Types.Flag" "Cabal-3.3.0.0-inplace" True) (C1 (MetaCons "FlagAssignment" PrefixI True) (S1 (MetaSel (Just "getFlagAssignment") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map FlagName (Int, Bool)))))

mkFlagAssignment :: [(FlagName, Bool)] -> FlagAssignment #

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)] #

Deconstruct a FlagAssignment into a list of flag/value pairs.

 null (findDuplicateFlagAssignments fa) ==> (mkFlagAssignment . unFlagAssignment) fa == fa

Since: 2.2.0

lookupFlagAssignment :: FlagName -> FlagAssignment -> Maybe Bool #

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 #

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 #

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] #

Find the FlagNames that have been listed more than once.

Since: 2.2.0

nullFlagAssignment :: FlagAssignment -> Bool #

Test whether FlagAssignment is empty.

Since: 2.2.0

showFlagValue :: (FlagName, Bool) -> String #

String representation of a flag-value pair.

dispFlagAssignment :: FlagAssignment -> Doc #

Pretty-prints a flag assignment.

parsecFlagAssignment :: CabalParsing m => m FlagAssignment #

Parses a flag assignment.