Safe Haskell | Safe |
---|---|
Language | Haskell2010 |
Synopsis
- class HasLong o (attr :: [OptAttr]) where
- class HasShort o (attr :: [OptAttr]) where
- class HasHelp o (attr :: [OptAttr]) where
- class HasMetavar o (attr :: [OptAttr]) where
- optMetavar :: String -> o attr a -> o attr a
- class HasEnvVar o (attr :: [OptAttr]) where
- class HasDefault o (attr :: [OptAttr]) where
- optDefault :: NotInAttrs OptOptional attr "optDefault" "optOptional" => a -> o attr a -> o (OptDefault ': attr) a
- class HasOptional o (attr :: [OptAttr]) where
- optOptional :: NotInAttrs OptDefault attr "optOptional" "optDefault" => o attr a -> o (OptOptional ': attr) (Maybe a)
- class IsOpt o (attr :: [OptAttr]) where
- option :: OptReader a -> OptionOpt '[] a
- optionWith :: OptReader a -> (OptionOpt '[] a -> OptionOpt attr b) -> Opt b
- flag :: a -> a -> FlagOpt '[] a
- flagWith :: a -> a -> (FlagOpt '[] a -> FlagOpt attr b) -> Opt b
- switch :: FlagOpt '[] Bool
- switchWith :: (FlagOpt '[] Bool -> FlagOpt attr Bool) -> Opt Bool
- switch' :: FlagOpt '[] Bool
- switchWith' :: (FlagOpt '[] Bool -> FlagOpt attr Bool) -> Opt Bool
- argument :: OptReader a -> ArgumentOpt '[] a
- argumentWith :: OptReader a -> (ArgumentOpt '[] a -> ArgumentOpt attr b) -> Opt b
- parseWith :: (String -> Maybe a) -> String -> Either String a
- readParser :: Read a => OptReader a
- strParser :: IsString s => String -> Either String s
- boolParser :: String -> Either String Bool
- type QuoteSym (s :: Symbol) = (Text "`" :<>: Text s) :<>: Text "`"
- type family NotInAttrs (x :: k) (xs :: [k]) (l :: Symbol) (r :: Symbol) :: Constraint where ...
Documentation
class HasHelp o (attr :: [OptAttr]) where Source #
Instances
HasHelp ArgumentOpt a Source # | |
Defined in Options.Harg.Construct optHelp :: String -> ArgumentOpt a a0 -> ArgumentOpt a a0 Source # | |
HasHelp FlagOpt a Source # | |
HasHelp OptionOpt a Source # | |
class HasMetavar o (attr :: [OptAttr]) where Source #
optMetavar :: String -> o attr a -> o attr a Source #
Add a metavar
metavar to an option, to be
displayed as the meta-parameter next to long/short modifiers
Instances
HasMetavar ArgumentOpt a Source # | |
Defined in Options.Harg.Construct optMetavar :: String -> ArgumentOpt a a0 -> ArgumentOpt a a0 Source # | |
HasMetavar OptionOpt a Source # | |
Defined in Options.Harg.Construct |
class HasEnvVar o (attr :: [OptAttr]) where Source #
optEnvVar :: String -> o attr a -> o attr a Source #
Specify an environment variable to lookup for an option
Instances
HasEnvVar ArgumentOpt a Source # | |
Defined in Options.Harg.Construct optEnvVar :: String -> ArgumentOpt a a0 -> ArgumentOpt a a0 Source # | |
HasEnvVar FlagOpt a Source # | |
HasEnvVar OptionOpt a Source # | |
class HasDefault o (attr :: [OptAttr]) where Source #
optDefault :: NotInAttrs OptOptional attr "optDefault" "optOptional" => a -> o attr a -> o (OptDefault ': attr) a Source #
Add a default value to an option. Cannot be used in conjuction with
optOptional
.
Instances
HasDefault ArgumentOpt a Source # | |
Defined in Options.Harg.Construct optDefault :: NotInAttrs OptOptional a "optDefault" "optOptional" => a0 -> ArgumentOpt a a0 -> ArgumentOpt (OptDefault ': a) a0 Source # | |
HasDefault OptionOpt a Source # | |
Defined in Options.Harg.Construct optDefault :: NotInAttrs OptOptional a "optDefault" "optOptional" => a0 -> OptionOpt a a0 -> OptionOpt (OptDefault ': a) a0 Source # |
class HasOptional o (attr :: [OptAttr]) where Source #
Class for options that can be optional. Cannot be used in
conjunction with HasDefault
. Note that this will turn a parser for a
into a parser for Maybe a
, modifying the reader function appropriately.
For example:
someOpt :: Opt (Maybe Int) someOpt = optionWith readParser ( optLong "someopt" . optOptional )
optOptional :: NotInAttrs OptDefault attr "optOptional" "optDefault" => o attr a -> o (OptOptional ': attr) (Maybe a) Source #
Specify that an option is optional. This will convert an Opt a
to an
Opt (Maybe a)
Instances
HasOptional ArgumentOpt a Source # | |
Defined in Options.Harg.Construct optOptional :: NotInAttrs OptDefault a "optOptional" "optDefault" => ArgumentOpt a a0 -> ArgumentOpt (OptOptional ': a) (Maybe a0) Source # | |
HasOptional OptionOpt a Source # | |
Defined in Options.Harg.Construct optOptional :: NotInAttrs OptDefault a "optOptional" "optDefault" => OptionOpt a a0 -> OptionOpt (OptOptional ': a) (Maybe a0) Source # |
class IsOpt o (attr :: [OptAttr]) where Source #
Class to convert an intermediate option type into Opt
. Instances
should set the appropriate _optType
.
:: a | Default value |
-> a | Active value |
-> FlagOpt '[] a |
Create a flag parser, equivalent to option
. The
first argument is the default value (returned when the flag modifier is
absent), and the second is the active value (returned when the flag
modifier is present). The result can then be used with toOpt
to convert
into the global Opt
type.
someFlag :: Opt Int someFlag = toOpt ( flag 0 1 & optLong "someflag" & optHelp "Some flag" )
switch :: FlagOpt '[] Bool Source #
A flag
parser, specialized to Bool
. The parser (e.g. when parsing
an environment variable) will accept true
and false
, but case
insensitive, rather than using the Read
instance for Bool
. The
default value is False
, and the active value is True
.
someSwitch :: Opt Bool someSwitch = toOpt ( switch & optLong "someswitch" & optHelp "Some switch" )
argument :: OptReader a -> ArgumentOpt '[] a Source #
argumentWith :: OptReader a -> (ArgumentOpt '[] a -> ArgumentOpt attr b) -> Opt b Source #
readParser :: Read a => OptReader a Source #
A parser that uses the Read
instance to parse into a type.
strParser :: IsString s => String -> Either String s Source #
A parser that returns a string. Any type that has an instance of
IsString
will work, and this parser always succeeds.
boolParser :: String -> Either String Bool Source #
A parser that returns a Bool
. This will succeed for the strings
true
and false
in a case-insensitive manner.
type QuoteSym (s :: Symbol) = (Text "`" :<>: Text s) :<>: Text "`" Source #
Wrap a symbol in quotes, for pretty printing in type errors.
type family NotInAttrs (x :: k) (xs :: [k]) (l :: Symbol) (r :: Symbol) :: Constraint where ... Source #
Check if x
is not an element of the type-level list xs
. If it is
print the appropriate error message using l
and r
for clarity.
NotInAttrs _ '[] _ _ = () | |
NotInAttrs x (x ': _) l r = TypeError (((QuoteSym l :<>: Text " and ") :<>: QuoteSym r) :<>: Text " cannot be mixed in an option definition.") | |
NotInAttrs x (y ': xs) l r = NotInAttrs x xs l r |