Moduleoptparse-applicative-0.18.1.0Haskell98

Options.Applicative.Types

26 types
17 values

Packageoptparse-applicative-0.18.1.0
Exports43
LanguageHaskell98
LicenceBSD-3-Clause
SourceTypes.hs

datadata ParseError

Constructors

ErrorMsg String
InfoMsg String
ShowHelpText (Maybe String)
UnknownError
MissingError IsCmdStart SomeParser
ExpectsArgError String
UnexpectedError String SomeParser

Instances2Semigroup, Monoid

Semigroup ParseErrorDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Monoid ParseErrorDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

datadata ParserInfo a

A full description for a runnable Parser for a program.

Constructors

ParserInfo
- 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
- infoPolicy :: ArgPolicy
  allow regular options and flags to occur after arguments (default: InterspersePolicy)

Instances1Functor

Functor ParserInfoDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

datadata ParserPrefs

Global preferences for a top-level Parser.

Constructors

ParserPrefs
- 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)
- prefShowHelpOnEmpty :: Bool
  show the help text for a command or subcommand if it fails with no input (default: False)
- prefBacktrack :: Backtracking
  backtrack to parent parser when a subcommand fails (default: Backtrack)
- prefColumns :: Int
  number of columns in the terminal, used to format the help page (default: 80)
- prefHelpLongEquals :: Bool
  when displaying long names in usage and help, use an = sign for long names, rather than a single space (default: False)
- prefHelpShowGlobal :: Bool
  when displaying subparsers' usage help, show parent options under a "global options" section (default: False)
- prefTabulateFill :: Int
  Indentation width for tables

Instances2Eq, Show

Eq ParserPrefsDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Show ParserPrefsDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

datadata Option a

A single option of a parser.

Constructors

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

Instances2Functor, Show

Functor OptionDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Show (Option a)Defined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

datadata OptName

Constructors

OptShort !Char
OptLong !String

Instances3Eq, Ord, Show

Eq OptNameDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Ord OptNameDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Show OptNameDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

valueisShortName :: OptName -> Bool

valueisLongName :: OptName -> Bool

datadata OptReader a

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

Constructors

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

Instances1Functor

Functor OptReaderDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

datadata OptProperties

Specification for an individual parser option.

Constructors

OptProperties
- propVisibility :: OptVisibility
  whether this flag is shown in 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
- propShowGlobal :: Bool
  whether the option is presented in global options text
- propDescMod :: Maybe (Doc -> Doc)
  a function to run over the brief description

Instances1Show

Show OptPropertiesDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

datadata 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

Instances3Eq, Ord, Show

Eq OptVisibilityDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Ord OptVisibilityDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Show OptVisibilityDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

datadata Backtracking

Backtrack NoBacktrack SubparserInline

Instances2Eq, Show

Eq BacktrackingDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Show BacktrackingDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

newtypenewtype ReadM a

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

Constructors

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

Instances6Monad, Functor, MonadFail, Applicative, Alternative, MonadPlus

Monad ReadMDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Functor ReadMDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
MonadFail ReadMDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Applicative ReadMDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Alternative ReadMDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
MonadPlus ReadMDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

valuereaderAsk :: ReadM String

Return the value being read.

valuereaderAbort :: ParseError -> ReadM a

Abort option reader by exiting with a ParseError.

valuereaderError :: String -> ReadM a

Abort option reader by exiting with an error message.

datadata CReader a

Constructors

CReader
- crCompleter :: Completer
- crReader :: ReadM a

Instances1Functor

Functor CReaderDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

datadata Parser a

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)

Instances3Functor, Applicative, Alternative

Functor ParserDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Applicative ParserDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Alternative ParserDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

newtypenewtype ParserM r

Constructors

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

Instances3Monad, Functor, Applicative

Monad ParserMDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Functor ParserMDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Applicative ParserMDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

newtypenewtype Completer

A shell complete function.

Constructors

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

Instances2Semigroup, Monoid

Semigroup CompleterDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Monoid CompleterDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

valuemkCompleter :: (String -> IO [String]) -> Completer

Smart constructor for a Completer

newtypenewtype CompletionResult

Constructors

CompletionResult
- execCompletion :: String -> IO String

Instances1Show

Show CompletionResultDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

newtypenewtype ParserFailure h

Constructors

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

Instances2Functor, Show

Functor ParserFailureDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Show h => Show (ParserFailure h)Defined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

datadata ParserResult a

Result of execParserPure.

Constructors

Success a
Failure (ParserFailure ParserHelp)
CompletionInvoked CompletionResult

Instances4Monad, Functor, Applicative, Show

Monad ParserResultDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Functor ParserResultDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Applicative ParserResultDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Show a => Show (ParserResult a)Defined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

valueoverFailure

typetype Args = [String]

datadata ArgPolicy

Policy for how to handle options within the parse

Constructors

Intersperse
The default policy, options and arguments can be interspersed. A -- option can be passed to ensure all following commands are treated as arguments.
NoIntersperse
Options must all come before arguments, once a single positional argument or subcommand is parsed, all remaining arguments are treated as positionals. A -- option can be passed if the first positional one needs starts with -.
AllPositionals
No options are parsed at all, all arguments are treated as positionals. Is the policy used after -- is encountered.
ForwardOptions
Options and arguments can be interspersed, but if a given option is not found, it is treated as a positional argument. This is sometimes useful if one is passing through most options to another tool, but are supplying just a few of their own options.

Instances3Eq, Ord, Show

Eq ArgPolicyDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Ord ArgPolicyDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Show ArgPolicyDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

newtypenewtype ArgumentReachability

Constructors

ArgumentReachability
- argumentIsUnreachable :: Bool
  If the result is a positional, if it can't be accessed in the current parser position ( first arg )

Instances2Eq, Show

Eq ArgumentReachabilityDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Show ArgumentReachabilityDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

datadata AltNodeType

This type encapsulates whether an AltNode of an OptTree should be displayed with brackets around it.

MarkDefault NoDefault

Instances2Eq, Show

Eq AltNodeTypeDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types
Show AltNodeTypeDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

datadata OptTree a

Constructors

Leaf a
MultNode [OptTree a]
AltNode AltNodeType [OptTree a]
BindNode (OptTree a)

Instances1Show

Show a => Show (OptTree a)Defined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

datadata ParserHelp

Constructors

ParserHelp
- helpError :: Chunk Doc
- helpSuggestions :: Chunk Doc
- helpHeader :: Chunk Doc
- helpUsage :: Chunk Doc
- helpDescription :: Chunk Doc
- helpBody :: Chunk Doc
- helpGlobals :: Chunk Doc
- helpFooter :: Chunk Doc

Instances3Show, Semigroup, Monoid

Show ParserHelpDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Help.Types
Semigroup ParserHelpDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Help.Types
Monoid ParserHelpDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Help.Types

datadata SomeParser

Constructors

forall a. SomeParser (Parser a)

datadata Context

Subparser context, containing the name of the subparser and its parser info. Used by parserFailure to display relevant usage information when parsing inside a subparser fails.

Constructors

forall a. Context String (ParserInfo a)

datadata IsCmdStart

CmdStart CmdCont

Instances1Show

Show IsCmdStartDefined in optparse-applicative-0.18.1.0 · Options.Applicative.Types

valuefromM :: ParserM a -> Parser a

valueoneM :: Parser a -> ParserM a

valuemanyM :: Parser a -> ParserM [a]

valuesomeM :: Parser a -> ParserM [a]

valuefilterOptional :: OptTree a -> OptTree a

valueoptVisibility :: Option a -> OptVisibility

valueoptMetaVar :: Option a -> String

valueoptHelp :: Option a -> Chunk Doc

valueoptShowDefault :: Option a -> Maybe String

valueoptDescMod :: Option a -> Maybe (Doc -> Doc)