Safe Haskell	Safe-Inferred
Language	Haskell98

Options.Applicative.Types

Synopsis

Documentation

data ParseError Source

Constructors

ErrorMsg String
InfoMsg String
ShowHelpText
UnknownError
MissingError (OptTree (Chunk Doc))

Instances

Show ParseError
Monoid ParseError

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 :: Chunk Doc: brief parser description
infoHeader :: Chunk Doc: header of the full parser description
infoFooter :: Chunk Doc: footer of the full parser description
infoFailureCode :: Int: exit code for a parser failure
infoIntersperse :: Bool: allow regular options and flags to occur after arguments (default: True)

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 (default: False)
prefShowHelpOnError :: Bool: always show help text on parse errors (default: False)
prefBacktrack :: Bool: backtrack to parent parser when a subcommand fails (default: True)
prefColumns :: Int: number of columns in the terminal, used to format the help page (default: 80)

Instances

Eq ParserPrefs
Show ParserPrefs

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
Show (Option a)

data OptName Source

Constructors

OptShort !Char
OptLong !String

Instances

Eq OptName
Ord OptName
Show OptName

data OptReader a Source

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

Constructors

OptReader [OptName] (CReader a) ParseError	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 :: Chunk Doc help text for this option propMetaVar :: String metavariable for this option propShowDefault :: Maybe String what to show in the help text as the default

Instances

Show OptProperties

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
Show OptVisibility

newtype ReadM a Source

A newtype over 'ReaderT String Except', used by option readers.

Constructors

ReadM
Fields unReadM :: ReaderT String (Except ParseError) a

Instances

Alternative ReadM
Monad ReadM
Functor ReadM
MonadPlus ReadM
Applicative ReadM

readerAsk :: ReadM String Source

Return the value being read.

readerAbort :: ParseError -> ReadM a Source

Abort option reader by exiting with a ParseError.

readerError :: String -> ReadM a Source

Abort option reader by exiting with an error message.

data CReader a Source

Constructors

CReader
Fields crCompleter :: Completer crReader :: ReadM a

Instances

Functor CReader

data Parser a Source

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

Constructors

NilP (Maybe a)
OptP (Option a)
forall x . MultP (Parser (x -> a)) (Parser x)
AltP (Parser a) (Parser a)
forall x . BindP (Parser x) (x -> Parser a)

Instances

Alternative Parser
Functor Parser
Applicative 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

mkCompleter :: (String -> IO [String]) -> Completer Source

newtype CompletionResult Source

Constructors

CompletionResult
Fields execCompletion :: String -> IO String

Instances

Show CompletionResult

newtype ParserFailure h Source

Constructors

ParserFailure
Fields execFailure :: String -> (h, ExitCode, Int)

Instances

Functor ParserFailure
Show h => Show (ParserFailure h)

data ParserResult a Source

Result of execParserPure.

Constructors

Success a
Failure (ParserFailure ParserHelp)
CompletionInvoked CompletionResult

Instances

Monad ParserResult
Functor ParserResult
Applicative ParserResult
Show a => Show (ParserResult a)

overFailure :: (ParserHelp -> ParserHelp) -> ParserResult a -> ParserResult a Source

type Args = [String] Source

data ArgPolicy Source

Constructors

SkipOpts
AllowOpts

Instances

Eq ArgPolicy
Show ArgPolicy

data OptHelpInfo Source

Constructors

OptHelpInfo
Fields hinfoMulti :: Bool hinfoDefault :: Bool

Instances

Eq OptHelpInfo
Show OptHelpInfo

data OptTree a Source

Constructors

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

Instances

Show a => Show (OptTree a)

data ParserHelp Source

Constructors

ParserHelp
Fields helpError :: Chunk Doc helpHeader :: Chunk Doc helpUsage :: Chunk Doc helpBody :: Chunk Doc helpFooter :: Chunk Doc

Instances

Show ParserHelp
Monoid ParserHelp

fromM :: ParserM a -> Parser a Source

oneM :: Parser a -> ParserM a Source

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

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

optVisibility :: Option a -> OptVisibility Source

optMetaVar :: Option a -> String Source

optHelp :: Option a -> Chunk Doc Source

optShowDefault :: Option a -> Maybe String Source