Safe Haskell | Safe |
---|---|
Language | Haskell98 |
Synopsis
- data Mod f a = Mod (f a -> f a) (DefaultProp a) (OptProperties -> OptProperties)
- class HasName f where
- class HasCompleter f where
- modCompleter :: (Completer -> Completer) -> f a -> f a
- class HasValue f where
- hasValueDummy :: f a -> ()
- class HasMetavar f where
- hasMetavarDummy :: f a -> ()
- data OptionFields a = OptionFields {
- optNames :: [OptName]
- optCompleter :: Completer
- optNoArgError :: String -> ParseError
- data FlagFields a = FlagFields {
- flagNames :: [OptName]
- flagActive :: a
- data CommandFields a = CommandFields {
- cmdCommands :: [(String, ParserInfo a)]
- cmdGroup :: Maybe String
- data ArgumentFields a = ArgumentFields {}
- data DefaultProp a = DefaultProp (Maybe a) (Maybe (a -> String))
- optionMod :: (OptProperties -> OptProperties) -> Mod f a
- fieldMod :: (f a -> f a) -> Mod f a
- baseProps :: OptProperties
- mkCommand :: Mod CommandFields a -> (Maybe String, [String], String -> Maybe (ParserInfo a))
- mkParser :: DefaultProp a -> (OptProperties -> OptProperties) -> OptReader a -> Parser a
- mkOption :: DefaultProp a -> (OptProperties -> OptProperties) -> OptReader a -> Option a
- mkProps :: DefaultProp a -> (OptProperties -> OptProperties) -> OptProperties
- internal :: Mod f a
Internals
An option modifier.
Option modifiers are values that represent a modification of the properties of an option.
The type parameter a
is the return type of the option, while f
is a
record containing its properties (e.g. OptionFields
for regular options,
FlagFields
for flags, etc...).
An option modifier consists of 3 elements:
- A field modifier, of the form
f a -> f a
. These are essentially (compositions of) setters for some of the properties supported byf
. - An optional default value and function to display it.
- A property modifier, of the form
OptProperties -> OptProperties
. This is just like the field modifier, but for properties applicable to any option.
Modifiers are instances of Monoid
, and can be composed as such.
One rarely needs to deal with modifiers directly, as most of the times it is
sufficient to pass them to builders (such as strOption
or flag
) to
create options (see Builder
).
Mod (f a -> f a) (DefaultProp a) (OptProperties -> OptProperties) |
Instances
HasName FlagFields # | |
Defined in Options.Applicative.Builder.Internal name :: OptName -> FlagFields a -> FlagFields a # | |
HasName OptionFields # | |
Defined in Options.Applicative.Builder.Internal name :: OptName -> OptionFields a -> OptionFields a # |
class HasCompleter f where #
modCompleter :: (Completer -> Completer) -> f a -> f a #
Instances
HasCompleter ArgumentFields # | |
Defined in Options.Applicative.Builder.Internal modCompleter :: (Completer -> Completer) -> ArgumentFields a -> ArgumentFields a # | |
HasCompleter OptionFields # | |
Defined in Options.Applicative.Builder.Internal modCompleter :: (Completer -> Completer) -> OptionFields a -> OptionFields a # |
hasValueDummy :: f a -> () #
Instances
HasValue ArgumentFields # | |
Defined in Options.Applicative.Builder.Internal hasValueDummy :: ArgumentFields a -> () # | |
HasValue OptionFields # | |
Defined in Options.Applicative.Builder.Internal hasValueDummy :: OptionFields a -> () # |
class HasMetavar f where #
hasMetavarDummy :: f a -> () #
Instances
HasMetavar ArgumentFields # | |
Defined in Options.Applicative.Builder.Internal hasMetavarDummy :: ArgumentFields a -> () # | |
HasMetavar CommandFields # | |
Defined in Options.Applicative.Builder.Internal hasMetavarDummy :: CommandFields a -> () # | |
HasMetavar OptionFields # | |
Defined in Options.Applicative.Builder.Internal hasMetavarDummy :: OptionFields a -> () # |
data OptionFields a #
OptionFields | |
|
Instances
HasMetavar OptionFields # | |
Defined in Options.Applicative.Builder.Internal hasMetavarDummy :: OptionFields a -> () # | |
HasValue OptionFields # | |
Defined in Options.Applicative.Builder.Internal hasValueDummy :: OptionFields a -> () # | |
HasCompleter OptionFields # | |
Defined in Options.Applicative.Builder.Internal modCompleter :: (Completer -> Completer) -> OptionFields a -> OptionFields a # | |
HasName OptionFields # | |
Defined in Options.Applicative.Builder.Internal name :: OptName -> OptionFields a -> OptionFields a # |
data FlagFields a #
FlagFields | |
|
Instances
HasName FlagFields # | |
Defined in Options.Applicative.Builder.Internal name :: OptName -> FlagFields a -> FlagFields a # |
data CommandFields a #
CommandFields | |
|
Instances
HasMetavar CommandFields # | |
Defined in Options.Applicative.Builder.Internal hasMetavarDummy :: CommandFields a -> () # |
data ArgumentFields a #
Instances
HasMetavar ArgumentFields # | |
Defined in Options.Applicative.Builder.Internal hasMetavarDummy :: ArgumentFields a -> () # | |
HasValue ArgumentFields # | |
Defined in Options.Applicative.Builder.Internal hasValueDummy :: ArgumentFields a -> () # | |
HasCompleter ArgumentFields # | |
Defined in Options.Applicative.Builder.Internal modCompleter :: (Completer -> Completer) -> ArgumentFields a -> ArgumentFields a # |
data DefaultProp a #
DefaultProp (Maybe a) (Maybe (a -> String)) |
Instances
Semigroup (DefaultProp a) # | |
Defined in Options.Applicative.Builder.Internal (<>) :: DefaultProp a -> DefaultProp a -> DefaultProp a # sconcat :: NonEmpty (DefaultProp a) -> DefaultProp a # stimes :: Integral b => b -> DefaultProp a -> DefaultProp a # | |
Monoid (DefaultProp a) # | |
Defined in Options.Applicative.Builder.Internal mempty :: DefaultProp a # mappend :: DefaultProp a -> DefaultProp a -> DefaultProp a # mconcat :: [DefaultProp a] -> DefaultProp a # |
optionMod :: (OptProperties -> OptProperties) -> Mod f a #
Base default properties.
mkCommand :: Mod CommandFields a -> (Maybe String, [String], String -> Maybe (ParserInfo a)) #
mkParser :: DefaultProp a -> (OptProperties -> OptProperties) -> OptReader a -> Parser a #
mkOption :: DefaultProp a -> (OptProperties -> OptProperties) -> OptReader a -> Option a #
mkProps :: DefaultProp a -> (OptProperties -> OptProperties) -> OptProperties #