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 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 r a

Specification for an individual parser option.

Constructors

Option

option continuation

Fields

_optMain :: OptReader r

reader for this option

_optDefault :: Maybe a

default value

_optShow :: Bool

whether this flag is shown is the brief description

_optHelp :: String

help text for this option

_optMetaVar :: String

metavariable for this option

_optCont :: r -> P (Parser a)

Instances

Functor (Option r)

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

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

Constructors

NilP :: a -> Parser a

ConsP :: Option r (a -> b) -> Parser a -> Parser b

Instances

Functor Parser

Applicative 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

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

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

optShow :: Lens (Option r a) Bool

optHelp :: Lens (Option r a) String

optMetaVar :: Lens (Option r a) String

optCont :: Lens (Option r a) (r -> P (Parser a))