Safe Haskell	Safe-Infered

Options.Applicative.Types

Synopsis

Documentation

data ParserInfo a Source

A full description for a runnable Parser for a program.

Constructors

ParserInfo
Fields infoParser :: Parser a the option parser for the program infoFullDesc :: Bool whether the help text should contain full documentation infoProgDesc :: String brief parser description infoHeader :: String header of the full parser description infoFooter :: String footer of the full parser description infoFailureCode :: Int exit code for a parser failure

Instances

Functor ParserInfo

data ParserPrefs Source

Global preferences for a top-level Parser.

Constructors

ParserPrefs
Fields prefMultiSuffix :: String metavar suffix for multiple options prefDisambiguate :: Bool automatically disambiguate abbreviations

Instances

MonadP Completion
MonadP P

data Option a Source

A single option of a parser.

Constructors

Option
Fields optMain :: OptReader a reader for this option optProps :: OptProperties properties of this option

Instances

Functor Option

data OptName Source

Constructors

OptShort !Char
OptLong !String

Instances

Eq OptName
Ord OptName

data OptReader a Source

An OptReader defines whether an option matches an command line argument.

Constructors

OptReader [OptName] (CReader a)	option reader
FlagReader [OptName] !a	flag reader
ArgReader (CReader a)	argument reader
CmdReader [String] (String -> Maybe (ParserInfo a))	command reader

Instances

Functor OptReader

data OptProperties Source

Specification for an individual parser option.

Constructors

OptProperties
Fields propVisibility :: OptVisibility whether this flag is shown is the brief description propHelp :: String help text for this option propMetaVar :: String metavariable for this option propShowDefault :: Maybe String what to show in the help text as the default

data OptVisibility Source

Visibility of an option in the help text.

Constructors

Internal	does not appear in the help text at all
Hidden	only visible in the full description
Visible	visible both in the full and brief descriptions

Instances

Eq OptVisibility
Ord OptVisibility

data CReader a Source

Constructors

CReader
Fields crCompleter :: Completer crReader :: String -> Maybe a

Instances

Functor CReader

data Parser a whereSource

A Parser a is an option parser returning a value of type a.

Constructors

NilP :: Maybe a -> Parser a
OptP :: Option a -> Parser a
MultP :: Parser (a -> b) -> Parser a -> Parser b
AltP :: Parser a -> Parser a -> Parser a
BindP :: Parser a -> (a -> Parser b) -> Parser b

Instances

Functor Parser
Applicative Parser
Alternative Parser

newtype ParserM r Source

Constructors

ParserM
Fields runParserM :: forall x. (r -> Parser x) -> Parser x

Instances

Monad ParserM
Functor ParserM
Applicative ParserM

newtype Completer Source

Constructors

Completer
Fields runCompleter :: String -> IO [String]

Instances

Monoid Completer

data ParserFailure Source

Result after a parse error.

Constructors

ParserFailure
Fields errMessage :: String -> IO String Function which takes the program name as input and returns an error message errExitCode :: ExitCode Exit code to use for this error

Instances

Error ParserFailure

data OptHelpInfo Source

Constructors

OptHelpInfo
Fields hinfoMulti :: Bool hinfoDefault :: Bool

data OptTree a Source

Constructors

Leaf a
MultNode [OptTree a]
AltNode [OptTree a]

Instances

Functor OptTree
Show a => Show (OptTree a)

fromM :: ParserM a -> Parser aSource

oneM :: Parser a -> ParserM aSource

manyM :: Parser a -> ParserM [a]Source

optVisibility :: Option a -> OptVisibility Source

optMetaVar :: Option a -> String Source

optHelp :: Option a -> String Source

optShowDefault :: Option a -> Maybe String Source