Options.Applicative.Types

Documentation

data ParserInfo a

A full description for a runnable Parser for a program.

Constructors

ParserInfo

Fields

_infoParser :: Parser a

the option parser for the program

_infoDesc :: ParserDesc

description of the parser

Instances

Functor ParserInfo

data ParserDesc

Attributes that can be associated to a Parser.

Constructors

ParserDesc

Fields

_descFull :: Bool

whether the help text should contain full documentation

_descProg :: String

brief parser description

_descHeader :: String

header of the full parser description

_descFooter :: String

footer of the full parser description

_descFailureCode :: Int

exit code for a parser failure

data ParserPrefs

Global preferences for a top-level Parser.

Constructors

ParserPrefs

Fields

_prefMultiSuffix :: String

metavar suffix for multiple options

data Context where

Constructors

Context :: Maybe String -> ParserInfo a -> Context

NullContext :: Context

Instances

Monoid Context

type P = ErrorT String (Writer Context)

infoParser :: Lens (ParserInfo a) (Parser a)

infoDesc :: Lens (ParserInfo a) ParserDesc

infoFullDesc :: Lens (ParserInfo a) Bool

infoProgDesc :: Lens (ParserInfo a) String

infoHeader :: Lens (ParserInfo a) String

infoFooter :: Lens (ParserInfo a) String

infoFailureCode :: Lens (ParserInfo a) Int

descFull :: Lens ParserDesc Bool

descProg :: Lens ParserDesc String

descHeader :: Lens ParserDesc String

descFooter :: Lens ParserDesc String

descFailureCode :: Lens ParserDesc Int

data Option a

A single option of a parser.

Constructors

Option

Fields

_optMain :: OptReader a

reader for this option

_optProps :: OptProperties a

properties of this option

Instances

Functor Option

data OptName

Constructors

OptShort !Char

OptLong !String

Instances

Eq OptName

Ord OptName

data OptReader a

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

Constructors

OptReader [OptName] (String -> Maybe a)

option reader

FlagReader [OptName] !a

flag reader

ArgReader (String -> Maybe a)

argument reader

CmdReader [String] (String -> Maybe (ParserInfo a))

command reader

Instances

Functor OptReader

data OptProperties a

Specification for an individual parser option.

Constructors

OptProperties

Fields

_propDefault :: Maybe a

default value

_propVisibility :: OptVisibility

whether this flag is shown is the brief description

_propHelp :: String

help text for this option

_propMetaVar :: String

metavariable for this option

Instances

Functor OptProperties

data OptVisibility

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 Parser a where

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

data ParserFailure

Result after a parse error.

Constructors

ParserFailure

Fields

errMessage :: String -> 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

Constructors

OptHelpInfo

Fields

hinfoMulti :: Bool

hinfoDefault :: Bool

optMain :: Lens (Option a) (OptReader a)

optDefault :: Lens (Option a) (Maybe a)

optVisibility :: Lens (Option a) OptVisibility

optHelp :: Lens (Option a) String

optMetaVar :: Lens (Option a) String

propDefault :: Lens (OptProperties a) (Maybe a)

propVisibility :: Lens (OptProperties a) OptVisibility

propHelp :: Lens (OptProperties a) String

propMetaVar :: Lens (OptProperties a) String

prefMultiSuffix :: Lens ParserPrefs String