Safe Haskell	Safe
Language	Haskell2010

Cartel.Betsy

Description

Public interface for Betsy, the Cartel flag maker. Simply re-exports safe bindings from Cartel.Betsy.Internal.

Synopsis

Documentation

data FlagName Source #

The name of a flag. Only makeFlag creates flags; it will return a FlagName to you. You can then use that FlagName in a conditional using flag.

Instances

Eq FlagName Source #
Methods (==) :: FlagName -> FlagName -> Bool # (/=) :: FlagName -> FlagName -> Bool #
Ord FlagName Source #
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 #
Show FlagName Source #
Methods showsPrec :: Int -> FlagName -> ShowS # show :: FlagName -> String # showList :: [FlagName] -> ShowS #
Renderable FlagName Source #
Methods render :: FlagName -> String Source #

flagNameHead :: FlagName -> Char Source #

flagNameTail :: FlagName -> String Source #

data FlagOpts Source #

Options for flags, except for the flag's name.

Constructors

FlagOpts
Fields flagDescription :: String A one-line description of what the flag does; this is optional. flagDefault :: Bool Is this flag on or off by default? flagManual :: Bool If a flag is manual, Cabal will not change its value. If a flag is not manual, Cabal will change its value automatically to attempt to satisfy the package's dependencies.

Instances

Eq FlagOpts Source #
Methods (==) :: FlagOpts -> FlagOpts -> Bool # (/=) :: FlagOpts -> FlagOpts -> Bool #
Ord FlagOpts Source #
Methods compare :: FlagOpts -> FlagOpts -> Ordering # (<) :: FlagOpts -> FlagOpts -> Bool # (<=) :: FlagOpts -> FlagOpts -> Bool # (>) :: FlagOpts -> FlagOpts -> Bool # (>=) :: FlagOpts -> FlagOpts -> Bool # max :: FlagOpts -> FlagOpts -> FlagOpts # min :: FlagOpts -> FlagOpts -> FlagOpts #
Show FlagOpts Source #
Methods showsPrec :: Int -> FlagOpts -> ShowS # show :: FlagOpts -> String # showList :: [FlagOpts] -> ShowS #
RenderableIndented FlagOpts Source #
Methods renderIndented :: FlagOpts -> Reader Level String Source #

data Flag Source #

The name of a flag, paired with its options.

Constructors

Flag FlagName FlagOpts

Instances

Eq Flag Source #
Methods (==) :: Flag -> Flag -> Bool # (/=) :: Flag -> Flag -> Bool #
Ord Flag Source #
Methods compare :: Flag -> Flag -> Ordering # (<) :: Flag -> Flag -> Bool # (<=) :: Flag -> Flag -> Bool # (>) :: Flag -> Flag -> Bool # (>=) :: Flag -> Flag -> Bool # max :: Flag -> Flag -> Flag # min :: Flag -> Flag -> Flag #
Show Flag Source #
Methods showsPrec :: Int -> Flag -> ShowS # show :: Flag -> String # showList :: [Flag] -> ShowS #
RenderableIndented Flag Source #
Methods renderIndented :: Flag -> Reader Level String Source #

data Betsy m a Source #

Computations that can create and use Cabal flags. Use of this type, along with the defaultMain function ensures that any FlagName you use has been properly set up by using makeFlag. That way, you don't use flags in a flag without actually declaring the flag. When defaultMain creates your Cabal file, it will print the necessary Flag sections.

Betsy is parameterized on a type, m. When this type is a monad, Betsy is also a monad, allowing you to use use the usual monad combinators and do notation. Betsy is also a monad transformer.

Instances

MonadTrans Betsy Source #
Methods lift :: Monad m => m a -> Betsy m a #
Monad m => Monad (Betsy m) Source #
Methods (>>=) :: Betsy m a -> (a -> Betsy m b) -> Betsy m b # (>>) :: Betsy m a -> Betsy m b -> Betsy m b # return :: a -> Betsy m a # fail :: String -> Betsy m a #
Functor m => Functor (Betsy m) Source #
Methods fmap :: (a -> b) -> Betsy m a -> Betsy m b # (<$) :: a -> Betsy m b -> Betsy m a #
(Monad m, Functor m) => Applicative (Betsy m) Source #
Methods pure :: a -> Betsy m a # (<>) :: Betsy m (a -> b) -> Betsy m a -> Betsy m b # (>) :: Betsy m a -> Betsy m b -> Betsy m b # (<*) :: Betsy m a -> Betsy m b -> Betsy m a #
MonadIO m => MonadIO (Betsy m) Source #
Methods liftIO :: IO a -> Betsy m a #

data Error Source #

Errors that may result from running a Betsy computation.

Constructors

DuplicateFlag FlagName	The user requested creation of a duplicate flag.
Failed String	`fail` was invoked.
EmptyFlagName	The user requested creation of a flag with an empty name.

Instances

Eq Error Source #
Methods (==) :: Error -> Error -> Bool # (/=) :: Error -> Error -> Bool #
Ord Error Source #
Methods compare :: Error -> Error -> Ordering # (<) :: Error -> Error -> Bool # (<=) :: Error -> Error -> Bool # (>) :: Error -> Error -> Bool # (>=) :: Error -> Error -> Bool # max :: Error -> Error -> Error # min :: Error -> Error -> Error #
Show Error Source #
Methods showsPrec :: Int -> Error -> ShowS # show :: Error -> String # showList :: [Error] -> ShowS #
RenderableIndented Error Source #
Methods renderIndented :: Error -> Reader Level String Source #

runBetsy Source #

Arguments

:: Betsy m a
-> m (Either Error (a, [Flag]))	Returns `Left` if the making of a flag failed. Otherwise, returns the result of the computation, along with a list of all flags made.

makeFlag Source #

Arguments

:: Applicative m
=> NonEmptyString	Name of flag
-> FlagOpts	Options for the flag
-> Betsy m FlagName	This operation will fail if there is already a flag with the name you gave.

Creates new flags.

currentFlags :: Applicative f => Betsy f [Flag] Source #

Returns a list of all flags made so far.