Distribution.Types.Flag

Package flag

data PackageFlag

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

• flagName :: FlagName
• flagDescription :: String
• flagDefault :: Bool
• flagManual :: Bool

Instances

Structured PackageFlag

Defined in Distribution.Types.Flag

Methods

structure :: Proxy PackageFlag -> Structure

structureHash' :: Tagged PackageFlag MD5

Data PackageFlag

Defined in Distribution.Types.Flag

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PackageFlag -> c PackageFlag

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PackageFlag

toConstr :: PackageFlag -> Constr

dataTypeOf :: PackageFlag -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PackageFlag)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PackageFlag)

gmapT :: (forall b. Data b => b -> b) -> PackageFlag -> PackageFlag

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PackageFlag -> r

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PackageFlag -> r

gmapQ :: (forall d. Data d => d -> u) -> PackageFlag -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> PackageFlag -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PackageFlag -> m PackageFlag

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageFlag -> m PackageFlag

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PackageFlag -> m PackageFlag

Generic PackageFlag

Defined in Distribution.Types.Flag

Associated Types

type Rep PackageFlag :: Type -> Type

Methods

from :: PackageFlag -> Rep PackageFlag x

to :: Rep PackageFlag x -> PackageFlag

Show PackageFlag

Defined in Distribution.Types.Flag

Methods

showsPrec :: Int -> PackageFlag -> ShowS

show :: PackageFlag -> String

showList :: [PackageFlag] -> ShowS

Binary PackageFlag

Defined in Distribution.Types.Flag

Methods

put :: PackageFlag -> Put

get :: Get PackageFlag

putList :: [PackageFlag] -> Put

NFData PackageFlag

Defined in Distribution.Types.Flag

Methods

rnf :: PackageFlag -> ()

Eq PackageFlag

Defined in Distribution.Types.Flag

Methods

(==) :: PackageFlag -> PackageFlag -> Bool

(/=) :: PackageFlag -> PackageFlag -> Bool

type Rep PackageFlag

Defined in Distribution.Types.Flag

type Rep PackageFlag = D1 ('MetaData "PackageFlag" "Distribution.Types.Flag" "Cabal-syntax-3.12.1.0-IdRA6VeQqeX5uBVqXABfjL" 'False) (C1 ('MetaCons "MkPackageFlag" '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 -> PackageFlag

A PackageFlag initialized with default parameters.

Flag name

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

Parsec FlagName

Defined in Distribution.Types.Flag

Methods

parsec :: CabalParsing m => m FlagName

Pretty FlagName

Defined in Distribution.Types.Flag

Methods

pretty :: FlagName -> Doc

prettyVersioned :: CabalSpecVersion -> FlagName -> Doc

Structured FlagName

Defined in Distribution.Types.Flag

Methods

structure :: Proxy FlagName -> Structure

structureHash' :: Tagged FlagName MD5

Data FlagName

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 :: forall r r'. (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

IsString FlagName

mkFlagName

Since: 2.0.0.2

Defined in Distribution.Types.Flag

Methods

fromString :: String -> FlagName

Generic FlagName

Defined in Distribution.Types.Flag

Associated Types

type Rep FlagName :: Type -> Type

Methods

from :: FlagName -> Rep FlagName x

to :: Rep FlagName x -> FlagName

Read FlagName

Defined in Distribution.Types.Flag

Methods

readsPrec :: Int -> ReadS FlagName

readList :: ReadS [FlagName]

readPrec :: ReadPrec FlagName

readListPrec :: ReadPrec [FlagName]

Show FlagName

Defined in Distribution.Types.Flag

Methods

showsPrec :: Int -> FlagName -> ShowS

show :: FlagName -> String

showList :: [FlagName] -> ShowS

Binary FlagName

Defined in Distribution.Types.Flag

Methods

put :: FlagName -> Put

get :: Get FlagName

putList :: [FlagName] -> Put

NFData FlagName

Defined in Distribution.Types.Flag

Methods

rnf :: FlagName -> ()

Eq FlagName

Defined in Distribution.Types.Flag

Methods

(==) :: FlagName -> FlagName -> Bool

(/=) :: FlagName -> FlagName -> Bool

Ord FlagName

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

type Rep FlagName

Defined in Distribution.Types.Flag

type Rep FlagName = D1 ('MetaData "FlagName" "Distribution.Types.Flag" "Cabal-syntax-3.12.1.0-IdRA6VeQqeX5uBVqXABfjL" '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

Flag assignment

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

TODO: Why we record the multiplicity of the flag?

Instances

Parsec FlagAssignment

>>> simpleParsec "" :: Maybe FlagAssignment
Just (fromList [])

>>> simpleParsec "+foo -bar" :: Maybe FlagAssignment
Just (fromList [(FlagName "bar",(1,False)),(FlagName "foo",(1,True))])

>>> simpleParsec "-none -any" :: Maybe FlagAssignment
Just (fromList [(FlagName "any",(1,False)),(FlagName "none",(1,False))])

>>> simpleParsec "+foo -foo +foo +foo" :: Maybe FlagAssignment
Just (fromList [(FlagName "foo",(4,True))])

>>> simpleParsec "+foo -bar baz" :: Maybe FlagAssignment
Nothing

Issue #7279 was fixed in Cabal-3.8

>>> explicitEitherParsec (parsecCommaList parsec) "+foo , -bar" :: Either String [FlagAssignment]
Right [fromList [(FlagName "foo",(1,True))],fromList [(FlagName "bar",(1,False))]]

>>> explicitEitherParsec (parsecCommaList parsecFlagAssignmentNonEmpty) "+foo , -bar" :: Either String [FlagAssignment]
Right [fromList [(FlagName "foo",(1,True))],fromList [(FlagName "bar",(1,False))]]

>>> simpleParsec "+foo+foo" :: Maybe FlagAssignment
Nothing

Since: 3.4.0.0

Defined in Distribution.Types.Flag

Methods

parsec :: CabalParsing m => m FlagAssignment

Pretty FlagAssignment

Since: 3.4.0.0

Defined in Distribution.Types.Flag

Methods

pretty :: FlagAssignment -> Doc

prettyVersioned :: CabalSpecVersion -> FlagAssignment -> Doc

Structured FlagAssignment

Defined in Distribution.Types.Flag

Methods

structure :: Proxy FlagAssignment -> Structure

structureHash' :: Tagged FlagAssignment MD5

Monoid FlagAssignment

Defined in Distribution.Types.Flag

Methods

mempty :: FlagAssignment

mappend :: FlagAssignment -> FlagAssignment -> FlagAssignment

mconcat :: [FlagAssignment] -> FlagAssignment

Semigroup FlagAssignment

Defined in Distribution.Types.Flag

Methods

(<>) :: FlagAssignment -> FlagAssignment -> FlagAssignment

sconcat :: NonEmpty FlagAssignment -> FlagAssignment

stimes :: Integral b => b -> FlagAssignment -> FlagAssignment

Generic FlagAssignment

Defined in Distribution.Types.Flag

Associated Types

type Rep FlagAssignment :: Type -> Type

Methods

from :: FlagAssignment -> Rep FlagAssignment x

to :: Rep FlagAssignment x -> FlagAssignment

Read FlagAssignment

Since: 2.2.0

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

Defined in Distribution.Types.Flag

Methods

showsPrec :: Int -> FlagAssignment -> ShowS

show :: FlagAssignment -> String

showList :: [FlagAssignment] -> ShowS

Binary FlagAssignment

Defined in Distribution.Types.Flag

Methods

put :: FlagAssignment -> Put

get :: Get FlagAssignment

putList :: [FlagAssignment] -> Put

NFData FlagAssignment

Defined in Distribution.Types.Flag

Methods

rnf :: FlagAssignment -> ()

Eq FlagAssignment

Defined in Distribution.Types.Flag

Methods

(==) :: FlagAssignment -> FlagAssignment -> Bool

(/=) :: FlagAssignment -> FlagAssignment -> Bool

Ord FlagAssignment

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

type Rep FlagAssignment

Defined in Distribution.Types.Flag

type Rep FlagAssignment = D1 ('MetaData "FlagAssignment" "Distribution.Types.Flag" "Cabal-syntax-3.12.1.0-IdRA6VeQqeX5uBVqXABfjL" '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 FlagAssignment, 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.

showFlagAssignment :: FlagAssignment -> String

Show flag assignment.

Since: 3.4.0.0

parsecFlagAssignment :: CabalParsing m => m FlagAssignment

Parses a flag assignment.

parsecFlagAssignmentNonEmpty :: CabalParsing m => m FlagAssignment

Parse a non-empty flag assignment

The flags have to explicitly start with minus or plus.

Since: 3.4.0.0

Legacy formats

legacyShowFlagAssignment :: FlagAssignment -> String

We need this as far as we support custom setups older than 2.2.0.0

Since: 3.4.0.0

legacyShowFlagAssignment' :: FlagAssignment -> [String]

Since: 3.4.0.0

legacyParsecFlagAssignment :: CabalParsing m => m FlagAssignment

We need this as far as we support custom setups older than 2.2.0.0

Since: 3.4.0.0