-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Utilities and combinators for parsing command line options -- -- Here is a simple example of an applicative option parser: -- -- 
--   data Sample = Sample
--     { hello :: String
--     , quiet :: Bool }
--   
--   sample :: Parser Sample
--   sample = Sample
--     <$> strOption
--         ( long "hello"
--        <> metavar "TARGET"
--        <> help "Target for the greeting" )
--     <*> switch
--         ( long "quiet"
--        <> help "Whether to be quiet" )
--
-- -- The parser is built using applicative style starting from a set of -- basic combinators. In this example, hello is defined as an -- option with a String argument, while quiet is -- a boolean flag (called switch). -- -- A parser can be used like this: -- -- 
--   greet :: Sample -> IO ()
--   greet (Sample h False) = putStrLn $ "Hello, " ++ h
--   greet _ = return ()
--   
--   main :: IO ()
--   main = execParser opts >>= greet
--     where
--       opts = info (helper <*> sample)
--         ( fullDesc
--        <> progDesc "Print a greeting for TARGET"
--        <> header "hello - a test for optparse-applicative" )
--
-- -- The greet function is the entry point of the program, while -- opts is a complete description of the program, used when -- generating a help text. The helper combinator takes any parser, -- and adds a help option to it (which always fails). -- -- The hello option in this example is mandatory (since it -- doesn't have a default value), so running the program without any -- argument will display a help text: -- -- 
--   hello - a test for optparse-applicative
--   
--   Usage: hello --hello TARGET [--quiet]
--     Print a greeting for TARGET
--   
--   Available options:
--     -h,--help                Show this help text
--     --hello TARGET           Target for the greeting
--     --quiet                  Whether to be quiet
--
-- -- containing a short usage summary, and a detailed list of options with -- descriptions. @package optparse-applicative @version 0.13.0.0 module Options.Applicative.Help.Pretty (.$.) :: Doc -> Doc -> Doc module Options.Applicative.Help.Chunk mappendWith :: Monoid a => a -> a -> a -> a -- | The free monoid on a semigroup a. newtype Chunk a Chunk :: Maybe a -> Chunk a [unChunk] :: Chunk a -> Maybe a -- | Given a semigroup structure on a, return a monoid structure -- on 'Chunk a'. -- -- Note that this is not the same as liftA2. chunked :: (a -> a -> a) -> Chunk a -> Chunk a -> Chunk a -- | Concatenate a list into a Chunk. listToChunk satisfies: -- -- 
--   isEmpty . listToChunk = null
--   listToChunk = mconcat . fmap pure
--
listToChunk :: Monoid a => [a] -> Chunk a -- | Concatenate two Chunks with a space in between. If one is -- empty, this just returns the other one. -- -- Unlike <+> for Doc, this operation has a unit -- element, namely the empty Chunk. (<<+>>) :: Chunk Doc -> Chunk Doc -> Chunk Doc -- | Concatenate two Chunks with a softline in between. This is -- exactly like <<+>>, but uses a softline instead of -- a space. (<>) :: Chunk Doc -> Chunk Doc -> Chunk Doc -- | Concatenate Chunks vertically. vcatChunks :: [Chunk Doc] -> Chunk Doc -- | Concatenate Chunks vertically separated by empty lines. vsepChunks :: [Chunk Doc] -> Chunk Doc -- | Whether a Chunk is empty. Note that something like 'pure -- mempty' is not considered an empty chunk, even though the underlying -- Doc is empty. isEmpty :: Chunk a -> Bool -- | Convert a String into a Chunk. This satisfies: -- -- 
--   isEmpty . stringChunk = null
--   extractChunk . stringChunk = string
--
stringChunk :: String -> Chunk Doc -- | Convert a paragraph into a Chunk. The resulting chunk is -- composed by the words of the original paragraph separated by -- softlines, so it will be automatically word-wrapped when rendering the -- underlying document. -- -- This satisfies: -- -- 
--   isEmpty . paragraph = null . words
--
paragraph :: String -> Chunk Doc -- | Part of a constrained comonad instance. -- -- This is the counit of the adjunction between Chunk and the -- forgetful functor from monoids to semigroups. It satisfies: -- -- 
--   extractChunk . pure = id
--   extractChunk . fmap pure = id
--
extractChunk :: Monoid a => Chunk a -> a -- | Display pairs of strings in a table. tabulate :: [(Doc, Doc)] -> Chunk Doc instance GHC.Show.Show a => GHC.Show.Show (Options.Applicative.Help.Chunk.Chunk a) instance GHC.Classes.Eq a => GHC.Classes.Eq (Options.Applicative.Help.Chunk.Chunk a) instance GHC.Base.Functor Options.Applicative.Help.Chunk.Chunk instance GHC.Base.Applicative Options.Applicative.Help.Chunk.Chunk instance GHC.Base.Alternative Options.Applicative.Help.Chunk.Chunk instance GHC.Base.Monad Options.Applicative.Help.Chunk.Chunk instance GHC.Base.MonadPlus Options.Applicative.Help.Chunk.Chunk instance GHC.Base.Monoid a => GHC.Base.Monoid (Options.Applicative.Help.Chunk.Chunk a) module Options.Applicative.Help.Types data ParserHelp ParserHelp :: Chunk Doc -> Chunk Doc -> Chunk Doc -> Chunk Doc -> Chunk Doc -> ParserHelp [helpError] :: ParserHelp -> Chunk Doc [helpHeader] :: ParserHelp -> Chunk Doc [helpUsage] :: ParserHelp -> Chunk Doc [helpBody] :: ParserHelp -> Chunk Doc [helpFooter] :: ParserHelp -> Chunk Doc -- | Convert a help text to String. renderHelp :: Int -> ParserHelp -> String instance GHC.Show.Show Options.Applicative.Help.Types.ParserHelp instance GHC.Base.Monoid Options.Applicative.Help.Types.ParserHelp instance Data.Semigroup.Semigroup Options.Applicative.Help.Types.ParserHelp module Options.Applicative.Types data ParseError ErrorMsg :: String -> ParseError InfoMsg :: String -> ParseError ShowHelpText :: ParseError UnknownError :: ParseError MissingError :: IsCmdStart -> SomeParser -> ParseError -- | A full description for a runnable Parser for a program. data ParserInfo a ParserInfo :: Parser a -> Bool -> Chunk Doc -> Chunk Doc -> Chunk Doc -> Int -> Bool -> ParserInfo a -- | the option parser for the program [infoParser] :: ParserInfo a -> Parser a -- | whether the help text should contain full documentation [infoFullDesc] :: ParserInfo a -> Bool -- | brief parser description [infoProgDesc] :: ParserInfo a -> Chunk Doc -- | header of the full parser description [infoHeader] :: ParserInfo a -> Chunk Doc -- | footer of the full parser description [infoFooter] :: ParserInfo a -> Chunk Doc -- | exit code for a parser failure [infoFailureCode] :: ParserInfo a -> Int -- | allow regular options and flags to occur after arguments (default: -- True) [infoIntersperse] :: ParserInfo a -> Bool -- | Global preferences for a top-level Parser. data ParserPrefs ParserPrefs :: String -> Bool -> Bool -> Bool -> Bool -> Int -> ParserPrefs -- | metavar suffix for multiple options [prefMultiSuffix] :: ParserPrefs -> String -- | automatically disambiguate abbreviations (default: False) [prefDisambiguate] :: ParserPrefs -> Bool -- | always show help text on parse errors (default: False) [prefShowHelpOnError] :: ParserPrefs -> Bool -- | show the help text for a command or subcommand if it fails with no -- input (default: False) [prefShowHelpOnEmpty] :: ParserPrefs -> Bool -- | backtrack to parent parser when a subcommand fails (default: True) [prefBacktrack] :: ParserPrefs -> Bool -- | number of columns in the terminal, used to format the help page -- (default: 80) [prefColumns] :: ParserPrefs -> Int -- | A single option of a parser. data Option a Option :: OptReader a -> OptProperties -> Option a -- | reader for this option [optMain] :: Option a -> OptReader a -- | properties of this option [optProps] :: Option a -> OptProperties data OptName OptShort :: !Char -> OptName OptLong :: !String -> OptName -- | An OptReader defines whether an option matches an command line -- argument. data OptReader a -- | option reader OptReader :: [OptName] -> (CReader a) -> ParseError -> OptReader a -- | flag reader FlagReader :: [OptName] -> !a -> OptReader a -- | argument reader ArgReader :: (CReader a) -> OptReader a -- | command reader CmdReader :: (Maybe String) -> [String] -> (String -> Maybe (ParserInfo a)) -> OptReader a -- | Specification for an individual parser option. data OptProperties OptProperties :: OptVisibility -> Chunk Doc -> String -> Maybe String -> OptProperties -- | whether this flag is shown is the brief description [propVisibility] :: OptProperties -> OptVisibility -- | help text for this option [propHelp] :: OptProperties -> Chunk Doc -- | metavariable for this option [propMetaVar] :: OptProperties -> String -- | what to show in the help text as the default [propShowDefault] :: OptProperties -> Maybe String -- | Visibility of an option in the help text. data OptVisibility -- | does not appear in the help text at all Internal :: OptVisibility -- | only visible in the full description Hidden :: OptVisibility -- | visible both in the full and brief descriptions Visible :: OptVisibility -- | A newtype over 'ReaderT String Except', used by option readers. newtype ReadM a ReadM :: ReaderT String (Except ParseError) a -> ReadM a [unReadM] :: ReadM a -> ReaderT String (Except ParseError) a -- | Return the value being read. readerAsk :: ReadM String -- | Abort option reader by exiting with a ParseError. readerAbort :: ParseError -> ReadM a -- | Abort option reader by exiting with an error message. readerError :: String -> ReadM a data CReader a CReader :: Completer -> ReadM a -> CReader a [crCompleter] :: CReader a -> Completer [crReader] :: CReader a -> ReadM a -- | A Parser a is an option parser returning a value of type -- a. data Parser a NilP :: (Maybe a) -> Parser a OptP :: (Option a) -> Parser a MultP :: (Parser (x -> a)) -> (Parser x) -> Parser a AltP :: (Parser a) -> (Parser a) -> Parser a BindP :: (Parser x) -> (x -> Parser a) -> Parser a newtype ParserM r ParserM :: (forall x. (r -> Parser x) -> Parser x) -> ParserM r [runParserM] :: ParserM r -> forall x. (r -> Parser x) -> Parser x newtype Completer Completer :: (String -> IO [String]) -> Completer [runCompleter] :: Completer -> String -> IO [String] mkCompleter :: (String -> IO [String]) -> Completer newtype CompletionResult CompletionResult :: (String -> IO String) -> CompletionResult [execCompletion] :: CompletionResult -> String -> IO String newtype ParserFailure h ParserFailure :: (String -> (h, ExitCode, Int)) -> ParserFailure h [execFailure] :: ParserFailure h -> String -> (h, ExitCode, Int) -- | Result of execParserPure. data ParserResult a Success :: a -> ParserResult a Failure :: (ParserFailure ParserHelp) -> ParserResult a CompletionInvoked :: CompletionResult -> ParserResult a overFailure :: (ParserHelp -> ParserHelp) -> ParserResult a -> ParserResult a type Args = [String] -- | Policy for how to handle options within the parse data ArgPolicy -- | Inputs beginning with - or `--` are treated as options or -- flags, and can be mixed with arguments. SkipOpts :: ArgPolicy -- | All input is treated as positional arguments. Used after a bare `--` -- input, and also with noIntersperse policy. AllowOpts :: ArgPolicy data OptHelpInfo OptHelpInfo :: Bool -> Bool -> OptHelpInfo [hinfoMulti] :: OptHelpInfo -> Bool [hinfoDefault] :: OptHelpInfo -> Bool data OptTree a Leaf :: a -> OptTree a MultNode :: [OptTree a] -> OptTree a AltNode :: [OptTree a] -> OptTree a data ParserHelp ParserHelp :: Chunk Doc -> Chunk Doc -> Chunk Doc -> Chunk Doc -> Chunk Doc -> ParserHelp [helpError] :: ParserHelp -> Chunk Doc [helpHeader] :: ParserHelp -> Chunk Doc [helpUsage] :: ParserHelp -> Chunk Doc [helpBody] :: ParserHelp -> Chunk Doc [helpFooter] :: ParserHelp -> Chunk Doc data SomeParser SomeParser :: (Parser a) -> SomeParser -- | 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. data Context Context :: String -> (ParserInfo a) -> Context data IsCmdStart CmdStart :: IsCmdStart CmdCont :: IsCmdStart fromM :: ParserM a -> Parser a oneM :: Parser a -> ParserM a manyM :: Parser a -> ParserM [a] someM :: Parser a -> ParserM [a] optVisibility :: Option a -> OptVisibility optMetaVar :: Option a -> String optHelp :: Option a -> Chunk Doc optShowDefault :: Option a -> Maybe String instance GHC.Show.Show a => GHC.Show.Show (Options.Applicative.Types.OptTree a) instance GHC.Show.Show Options.Applicative.Types.OptHelpInfo instance GHC.Classes.Eq Options.Applicative.Types.OptHelpInfo instance GHC.Show.Show Options.Applicative.Types.ArgPolicy instance GHC.Classes.Eq Options.Applicative.Types.ArgPolicy instance GHC.Show.Show a => GHC.Show.Show (Options.Applicative.Types.ParserResult a) instance GHC.Show.Show Options.Applicative.Types.OptProperties instance GHC.Show.Show Options.Applicative.Types.OptVisibility instance GHC.Classes.Ord Options.Applicative.Types.OptVisibility instance GHC.Classes.Eq Options.Applicative.Types.OptVisibility instance GHC.Show.Show Options.Applicative.Types.OptName instance GHC.Classes.Ord Options.Applicative.Types.OptName instance GHC.Classes.Eq Options.Applicative.Types.OptName instance GHC.Show.Show Options.Applicative.Types.ParserPrefs instance GHC.Classes.Eq Options.Applicative.Types.ParserPrefs instance GHC.Show.Show Options.Applicative.Types.IsCmdStart instance GHC.Base.Monoid Options.Applicative.Types.ParseError instance Data.Semigroup.Semigroup Options.Applicative.Types.ParseError instance GHC.Base.Functor Options.Applicative.Types.ParserInfo instance GHC.Show.Show (Options.Applicative.Types.Option a) instance GHC.Base.Functor Options.Applicative.Types.Option instance GHC.Base.Functor Options.Applicative.Types.ReadM instance GHC.Base.Applicative Options.Applicative.Types.ReadM instance GHC.Base.Alternative Options.Applicative.Types.ReadM instance GHC.Base.Monad Options.Applicative.Types.ReadM instance GHC.Base.MonadPlus Options.Applicative.Types.ReadM instance GHC.Base.Functor Options.Applicative.Types.CReader instance GHC.Base.Functor Options.Applicative.Types.OptReader instance GHC.Base.Functor Options.Applicative.Types.Parser instance GHC.Base.Applicative Options.Applicative.Types.Parser instance GHC.Base.Monad Options.Applicative.Types.ParserM instance GHC.Base.Functor Options.Applicative.Types.ParserM instance GHC.Base.Applicative Options.Applicative.Types.ParserM instance GHC.Base.Alternative Options.Applicative.Types.Parser instance GHC.Base.Monoid Options.Applicative.Types.Completer instance GHC.Show.Show Options.Applicative.Types.CompletionResult instance GHC.Show.Show h => GHC.Show.Show (Options.Applicative.Types.ParserFailure h) instance GHC.Base.Functor Options.Applicative.Types.ParserFailure instance GHC.Base.Functor Options.Applicative.Types.ParserResult instance GHC.Base.Applicative Options.Applicative.Types.ParserResult instance GHC.Base.Monad Options.Applicative.Types.ParserResult module Options.Applicative.Internal data P a class (Alternative m, MonadPlus m) => MonadP m enterContext :: MonadP m => String -> ParserInfo a -> m () exitContext :: MonadP m => m () getPrefs :: MonadP m => m ParserPrefs missingArgP :: MonadP m => ParseError -> Completer -> m a tryP :: MonadP m => m a -> m (Either ParseError a) errorP :: MonadP m => ParseError -> m a exitP :: MonadP m => IsCmdStart -> Parser b -> Maybe a -> m a data ParseError ErrorMsg :: String -> ParseError InfoMsg :: String -> ParseError ShowHelpText :: ParseError UnknownError :: ParseError MissingError :: IsCmdStart -> SomeParser -> ParseError uncons :: [a] -> Maybe (a, [a]) hoistMaybe :: MonadPlus m => Maybe a -> m a hoistEither :: MonadP m => Either ParseError a -> m a runReadM :: MonadP m => ReadM a -> String -> m a withReadM :: (String -> String) -> ReadM a -> ReadM a runP :: P a -> ParserPrefs -> (Either ParseError a, [Context]) data Completion a runCompletion :: Completion r -> ParserPrefs -> Maybe (Either SomeParser Completer) contextNames :: [Context] -> [String] data ListT m a takeListT :: Monad m => Int -> ListT m a -> ListT m a runListT :: Monad m => ListT m a -> m [a] data NondetT m a cut :: Monad m => NondetT m () () :: Monad m => NondetT m a -> NondetT m a -> NondetT m a disamb :: Monad m => Bool -> NondetT m a -> m (Maybe a) instance GHC.Base.Functor Options.Applicative.Internal.P instance GHC.Base.Applicative Options.Applicative.Internal.P instance GHC.Base.Alternative Options.Applicative.Internal.P instance GHC.Base.Monad Options.Applicative.Internal.P instance GHC.Base.MonadPlus Options.Applicative.Internal.P instance Options.Applicative.Internal.MonadP Options.Applicative.Internal.P instance GHC.Base.Functor Options.Applicative.Internal.ComplResult instance GHC.Base.Applicative Options.Applicative.Internal.ComplResult instance GHC.Base.Monad Options.Applicative.Internal.ComplResult instance GHC.Base.Functor Options.Applicative.Internal.Completion instance GHC.Base.Applicative Options.Applicative.Internal.Completion instance GHC.Base.Alternative Options.Applicative.Internal.Completion instance GHC.Base.Monad Options.Applicative.Internal.Completion instance GHC.Base.MonadPlus Options.Applicative.Internal.Completion instance Options.Applicative.Internal.MonadP Options.Applicative.Internal.Completion instance GHC.Base.Monad m => GHC.Base.Functor (Options.Applicative.Internal.ListT m) instance GHC.Base.Monad m => GHC.Base.Applicative (Options.Applicative.Internal.ListT m) instance GHC.Base.Monad m => GHC.Base.Monad (Options.Applicative.Internal.ListT m) instance GHC.Base.Monad m => GHC.Base.Alternative (Options.Applicative.Internal.ListT m) instance Control.Monad.Trans.Class.MonadTrans Options.Applicative.Internal.ListT instance GHC.Base.Monad m => GHC.Base.MonadPlus (Options.Applicative.Internal.ListT m) instance GHC.Base.Monad m => GHC.Base.Functor (Options.Applicative.Internal.NondetT m) instance GHC.Base.Monad m => GHC.Base.Applicative (Options.Applicative.Internal.NondetT m) instance GHC.Base.Monad m => GHC.Base.Monad (Options.Applicative.Internal.NondetT m) instance GHC.Base.Monad m => GHC.Base.MonadPlus (Options.Applicative.Internal.NondetT m) instance GHC.Base.Monad m => GHC.Base.Alternative (Options.Applicative.Internal.NondetT m) instance Control.Monad.Trans.Class.MonadTrans Options.Applicative.Internal.NondetT module Options.Applicative.Builder.Completer data Completer mkCompleter :: (String -> IO [String]) -> Completer listIOCompleter :: IO [String] -> Completer listCompleter :: [String] -> Completer bashCompleter :: String -> Completer module Options.Applicative.Common -- | A Parser a is an option parser returning a value of type -- a. data Parser a -- | Create a parser composed of a single option. liftOpt :: Option a -> Parser a showOption :: OptName -> String -- | A full description for a runnable Parser for a program. data ParserInfo a ParserInfo :: Parser a -> Bool -> Chunk Doc -> Chunk Doc -> Chunk Doc -> Int -> Bool -> ParserInfo a -- | the option parser for the program [infoParser] :: ParserInfo a -> Parser a -- | whether the help text should contain full documentation [infoFullDesc] :: ParserInfo a -> Bool -- | brief parser description [infoProgDesc] :: ParserInfo a -> Chunk Doc -- | header of the full parser description [infoHeader] :: ParserInfo a -> Chunk Doc -- | footer of the full parser description [infoFooter] :: ParserInfo a -> Chunk Doc -- | exit code for a parser failure [infoFailureCode] :: ParserInfo a -> Int -- | allow regular options and flags to occur after arguments (default: -- True) [infoIntersperse] :: ParserInfo a -> Bool -- | Global preferences for a top-level Parser. data ParserPrefs ParserPrefs :: String -> Bool -> Bool -> Bool -> Bool -> Int -> ParserPrefs -- | metavar suffix for multiple options [prefMultiSuffix] :: ParserPrefs -> String -- | automatically disambiguate abbreviations (default: False) [prefDisambiguate] :: ParserPrefs -> Bool -- | always show help text on parse errors (default: False) [prefShowHelpOnError] :: ParserPrefs -> Bool -- | show the help text for a command or subcommand if it fails with no -- input (default: False) [prefShowHelpOnEmpty] :: ParserPrefs -> Bool -- | backtrack to parent parser when a subcommand fails (default: True) [prefBacktrack] :: ParserPrefs -> Bool -- | number of columns in the terminal, used to format the help page -- (default: 80) [prefColumns] :: ParserPrefs -> Int runParserInfo :: MonadP m => ParserInfo a -> Args -> m a runParserFully :: MonadP m => ArgPolicy -> Parser a -> Args -> m a -- | Apply a Parser to a command line, and return a result and -- leftover arguments. This function returns an error if any parsing -- error occurs, or if any options are missing and don't have a default -- value. runParser :: MonadP m => ArgPolicy -> IsCmdStart -> Parser a -> Args -> m (a, Args) -- | The default value of a Parser. This function returns an error -- if any of the options don't have a default value. evalParser :: Parser a -> Maybe a -- | Map a polymorphic function over all the options of a parser, and -- collect the results in a list. mapParser :: (forall x. OptHelpInfo -> Option x -> b) -> Parser a -> [b] -- | Like mapParser, but collect the results in a tree structure. treeMapParser :: (forall x. OptHelpInfo -> Option x -> b) -> Parser a -> OptTree b optionNames :: OptReader a -> [OptName] instance GHC.Base.Monoid Options.Applicative.Common.MatchResult instance Data.Semigroup.Semigroup Options.Applicative.Common.MatchResult module Options.Applicative.Builder.Internal -- | An option modifier. -- -- Option modifiers are values that represent a modification of the -- properties of an option. -- -- The type parameter a is the return type of the option, while -- f is a record containing its properties (e.g. -- OptionFields for regular options, FlagFields for flags, -- etc...). -- -- An option modifier consists of 3 elements: -- -- -- -- Modifiers are instances of Monoid, and can be composed as such. -- -- You rarely need to deal with modifiers directly, as most of the times -- it is sufficient to pass them to builders (such as strOption -- or flag) to create options (see Builder). data Mod f a Mod :: (f a -> f a) -> (DefaultProp a) -> (OptProperties -> OptProperties) -> Mod f a class HasName f name :: HasName f => OptName -> f a -> f a class HasCompleter f modCompleter :: HasCompleter f => (Completer -> Completer) -> f a -> f a class HasValue f hasValueDummy :: HasValue f => f a -> () class HasMetavar f hasMetavarDummy :: HasMetavar f => f a -> () data OptionFields a OptionFields :: [OptName] -> Completer -> ParseError -> OptionFields a [optNames] :: OptionFields a -> [OptName] [optCompleter] :: OptionFields a -> Completer [optNoArgError] :: OptionFields a -> ParseError data FlagFields a FlagFields :: [OptName] -> a -> FlagFields a [flagNames] :: FlagFields a -> [OptName] [flagActive] :: FlagFields a -> a data CommandFields a CommandFields :: [(String, ParserInfo a)] -> Maybe String -> CommandFields a [cmdCommands] :: CommandFields a -> [(String, ParserInfo a)] [cmdGroup] :: CommandFields a -> Maybe String data ArgumentFields a ArgumentFields :: Completer -> ArgumentFields a [argCompleter] :: ArgumentFields a -> Completer data DefaultProp a DefaultProp :: (Maybe a) -> (Maybe (a -> String)) -> DefaultProp a optionMod :: (OptProperties -> OptProperties) -> Mod f a fieldMod :: (f a -> f a) -> Mod f a -- | Base default properties. baseProps :: OptProperties mkCommand :: Mod CommandFields a -> (Maybe String, [String], String -> Maybe (ParserInfo a)) mkParser :: DefaultProp a -> (OptProperties -> OptProperties) -> OptReader a -> Parser a mkOption :: DefaultProp a -> (OptProperties -> OptProperties) -> OptReader a -> Option a mkProps :: DefaultProp a -> (OptProperties -> OptProperties) -> OptProperties -- | Hide this option from the help text internal :: Mod f a instance Options.Applicative.Builder.Internal.HasName Options.Applicative.Builder.Internal.OptionFields instance Options.Applicative.Builder.Internal.HasName Options.Applicative.Builder.Internal.FlagFields instance Options.Applicative.Builder.Internal.HasCompleter Options.Applicative.Builder.Internal.OptionFields instance Options.Applicative.Builder.Internal.HasCompleter Options.Applicative.Builder.Internal.ArgumentFields instance Options.Applicative.Builder.Internal.HasValue Options.Applicative.Builder.Internal.OptionFields instance Options.Applicative.Builder.Internal.HasValue Options.Applicative.Builder.Internal.ArgumentFields instance Options.Applicative.Builder.Internal.HasMetavar Options.Applicative.Builder.Internal.OptionFields instance Options.Applicative.Builder.Internal.HasMetavar Options.Applicative.Builder.Internal.ArgumentFields instance Options.Applicative.Builder.Internal.HasMetavar Options.Applicative.Builder.Internal.CommandFields instance GHC.Base.Monoid (Options.Applicative.Builder.Internal.DefaultProp a) instance Data.Semigroup.Semigroup (Options.Applicative.Builder.Internal.DefaultProp a) instance GHC.Base.Monoid (Options.Applicative.Builder.Internal.Mod f a) instance Data.Semigroup.Semigroup (Options.Applicative.Builder.Internal.Mod f a) module Options.Applicative.Builder -- | Builder for a command parser. The command modifier can be used -- to specify individual commands. subparser :: Mod CommandFields a -> Parser a -- | Builder for a String argument. strArgument :: Mod ArgumentFields String -> Parser String -- | Builder for an argument parser. argument :: ReadM a -> Mod ArgumentFields a -> Parser a -- | Builder for a flag parser. -- -- A flag that switches from a "default value" to an "active value" when -- encountered. For a simple boolean value, use switch instead. flag :: a -> a -> Mod FlagFields a -> Parser a -- | Builder for a flag parser without a default value. -- -- Same as flag, but with no default value. In particular, this -- flag will never parse successfully by itself. -- -- It still makes sense to use it as part of a composite parser. For -- example -- -- 
--   length <$> many (flag' () (short 't'))
--
-- -- is a parser that counts the number of "-t" arguments on the command -- line. flag' :: a -> Mod FlagFields a -> Parser a -- | Builder for a boolean flag. -- -- 
--   switch = flag False True
--
switch :: Mod FlagFields Bool -> Parser Bool -- | An option that always fails. -- -- When this option is encountered, the option parser immediately aborts -- with the given parse error. If you simply want to output a message, -- use infoOption instead. abortOption :: ParseError -> Mod OptionFields (a -> a) -> Parser (a -> a) -- | An option that always fails and displays a message. infoOption :: String -> Mod OptionFields (a -> a) -> Parser (a -> a) -- | Builder for an option taking a String argument. strOption :: Mod OptionFields String -> Parser String -- | Builder for an option using the given reader. option :: ReadM a -> Mod OptionFields a -> Parser a -- | Same as option. -- | Deprecated: Use option instead nullOption :: ReadM a -> Mod OptionFields a -> Parser a -- | Specify a short name for an option. short :: HasName f => Char -> Mod f a -- | Specify a long name for an option. long :: HasName f => String -> Mod f a -- | Specify the help text for an option. help :: String -> Mod f a -- | Specify the help text for an option as a Doc value. helpDoc :: Maybe Doc -> Mod f a -- | Specify a default value for an option. -- -- Note: Because this modifier means the parser will never fail, -- do not use it with combinators such as some or many, as -- these combinators continue until a failure occurs. Careless use will -- thus result in a hang. value :: HasValue f => a -> Mod f a -- | Specify a function to show the default value for an option. showDefaultWith :: (a -> String) -> Mod f a -- | Show the default value for this option using its Show instance. showDefault :: Show a => Mod f a -- | Specify a metavariable for the argument. -- -- Metavariables have no effect on the actual parser, and only serve to -- specify the symbolic name for an argument to be displayed in the help -- text. metavar :: HasMetavar f => String -> Mod f a -- | Specify the error to display when no argument is provided to this -- option. noArgError :: ParseError -> Mod OptionFields a data ParseError ErrorMsg :: String -> ParseError InfoMsg :: String -> ParseError ShowHelpText :: ParseError UnknownError :: ParseError MissingError :: IsCmdStart -> SomeParser -> ParseError -- | Hide this option from the brief description. hidden :: Mod f a -- | Hide this option from the help text internal :: Mod f a -- | Add a command to a subparser option. command :: String -> ParserInfo a -> Mod CommandFields a -- | Add a description to a group of commands. commandGroup :: String -> Mod CommandFields a -- | Add a list of possible completion values. completeWith :: HasCompleter f => [String] -> Mod f a -- | Add a bash completion action. Common actions include file and -- directory. See -- http://www.gnu.org/software/bash/manual/html_node/Programmable-Completion-Builtins.html#Programmable-Completion-Builtins -- for a complete list. action :: HasCompleter f => String -> Mod f a -- | Add a completer to an argument. -- -- A completer is a function String -> IO String which, given a -- partial argument, returns all possible completions for that argument. completer :: HasCompleter f => Completer -> Mod f a -- | Trivial option modifier. idm :: Monoid m => m -- | An associative operation mappend :: Monoid a => a -> a -> a -- | Option reader based on the Read type class. auto :: Read a => ReadM a -- | String Option reader. str :: ReadM String -- | Convert a function in the Maybe monad to a reader. maybeReader :: (String -> Maybe a) -> ReadM a -- | Convert a function in the Either monad to a reader. eitherReader :: (String -> Either String a) -> ReadM a -- | Null Option reader. All arguments will fail validation. disabled :: ReadM a -- | Abort option reader by exiting with a ParseError. readerAbort :: ParseError -> ReadM a -- | Abort option reader by exiting with an error message. readerError :: String -> ReadM a -- | Modifier for ParserInfo. data InfoMod a -- | Show a full description in the help text of this parser. fullDesc :: InfoMod a -- | Only show a brief description in the help text of this parser. briefDesc :: InfoMod a -- | Specify a header for this parser. header :: String -> InfoMod a -- | Specify a header for this parser as a Doc value. headerDoc :: Maybe Doc -> InfoMod a -- | Specify a footer for this parser. footer :: String -> InfoMod a -- | Specify a footer for this parser as a Doc value. footerDoc :: Maybe Doc -> InfoMod a -- | Specify a short program description. progDesc :: String -> InfoMod a -- | Specify a short program description as a Doc value. progDescDoc :: Maybe Doc -> InfoMod a -- | Specify an exit code if a parse error occurs. failureCode :: Int -> InfoMod a -- | Disable parsing of regular options after arguments noIntersperse :: InfoMod a -- | Create a ParserInfo given a Parser and a modifier. info :: Parser a -> InfoMod a -> ParserInfo a data PrefsMod multiSuffix :: String -> PrefsMod disambiguate :: PrefsMod showHelpOnError :: PrefsMod showHelpOnEmpty :: PrefsMod noBacktrack :: PrefsMod columns :: Int -> PrefsMod prefs :: PrefsMod -> ParserPrefs -- | Default preferences. defaultPrefs :: ParserPrefs -- | An option modifier. -- -- Option modifiers are values that represent a modification of the -- properties of an option. -- -- The type parameter a is the return type of the option, while -- f is a record containing its properties (e.g. -- OptionFields for regular options, FlagFields for flags, -- etc...). -- -- An option modifier consists of 3 elements: -- -- -- -- Modifiers are instances of Monoid, and can be composed as such. -- -- You rarely need to deal with modifiers directly, as most of the times -- it is sufficient to pass them to builders (such as strOption -- or flag) to create options (see Builder). data Mod f a -- | A newtype over 'ReaderT String Except', used by option readers. data ReadM a data OptionFields a data FlagFields a data ArgumentFields a data CommandFields a instance GHC.Base.Monoid (Options.Applicative.Builder.InfoMod a) instance Data.Semigroup.Semigroup (Options.Applicative.Builder.InfoMod a) instance GHC.Base.Monoid Options.Applicative.Builder.PrefsMod instance Data.Semigroup.Semigroup Options.Applicative.Builder.PrefsMod -- | You don't need to import this module to enable bash completion. -- -- See the wiki for more information on bash completion. module Options.Applicative.BashCompletion bashCompletionParser :: ParserInfo a -> ParserPrefs -> Parser CompletionResult module Options.Applicative.Help.Core -- | Generate descriptions for commands. cmdDesc :: Parser a -> [(Maybe String, Chunk Doc)] -- | Generate a brief help text for a parser. briefDesc :: ParserPrefs -> Parser a -> Chunk Doc -- | Generate a brief help text for a parser, only including mandatory -- options and arguments. missingDesc :: ParserPrefs -> Parser a -> Chunk Doc fold_tree :: OptTree (Chunk Doc) -> Chunk Doc -- | Generate a full help text for a parser. fullDesc :: ParserPrefs -> Parser a -> Chunk Doc data ParserHelp ParserHelp :: Chunk Doc -> Chunk Doc -> Chunk Doc -> Chunk Doc -> Chunk Doc -> ParserHelp [helpError] :: ParserHelp -> Chunk Doc [helpHeader] :: ParserHelp -> Chunk Doc [helpUsage] :: ParserHelp -> Chunk Doc [helpBody] :: ParserHelp -> Chunk Doc [helpFooter] :: ParserHelp -> Chunk Doc errorHelp :: Chunk Doc -> ParserHelp headerHelp :: Chunk Doc -> ParserHelp usageHelp :: Chunk Doc -> ParserHelp bodyHelp :: Chunk Doc -> ParserHelp footerHelp :: Chunk Doc -> ParserHelp -- | Generate the help text for a program. parserHelp :: ParserPrefs -> Parser a -> ParserHelp -- | Generate option summary. parserUsage :: ParserPrefs -> Parser a -> String -> Doc module Options.Applicative.Help module Options.Applicative.Extra -- | A hidden "helper" option which always fails. helper :: Parser (a -> a) -- | Builder for a command parser with a "helper" option attached. Used in -- the same way as subparser, but includes a "--help|-h" inside -- the subcommand. hsubparser :: Mod CommandFields a -> Parser a -- | Run a program description. -- -- Parse command line arguments. Display help text and exit if any parse -- error occurs. execParser :: ParserInfo a -> IO a -- | Run a program description in pure code. -- -- This function behaves like execParser, but can be called from -- pure code. Note that, in case of errors, no message is displayed, and -- this function simply returns Nothing. -- -- If you need to keep track of error messages, use execParserPure -- instead. -- | Deprecated: Use execParserPure together with getParseResult -- instead execParserMaybe :: ParserInfo a -> [String] -> Maybe a -- | Run a program description with custom preferences. customExecParser :: ParserPrefs -> ParserInfo a -> IO a -- | Run a program description with custom preferences in pure code. -- -- See execParserMaybe for details. -- | Deprecated: Use execParserPure together with getParseResult -- instead customExecParserMaybe :: ParserPrefs -> ParserInfo a -> [String] -> Maybe a -- | The most general way to run a program description in pure code. execParserPure :: ParserPrefs -> ParserInfo a -> [String] -> ParserResult a -- | Extract the actual result from a ParserResult value. -- -- This function returns Nothing in case of errors. Possible error -- messages or completion actions are simply discarded. -- -- If you want to display error messages and invoke completion actions -- appropriately, use handleParseResult instead. getParseResult :: ParserResult a -> Maybe a -- | Handle ParserResult. handleParseResult :: ParserResult a -> IO a -- | Generate a ParserFailure from a ParseError in a given -- Context. -- -- This function can be used, for example, to show the help text for a -- parser: -- -- 
--   handleParseResult . Failure $ parserFailure pprefs pinfo ShowHelpText mempty
--
parserFailure :: ParserPrefs -> ParserInfo a -> ParseError -> [Context] -> ParserFailure ParserHelp renderFailure :: ParserFailure ParserHelp -> String -> (String, ExitCode) newtype ParserFailure h ParserFailure :: (String -> (h, ExitCode, Int)) -> ParserFailure h [execFailure] :: ParserFailure h -> String -> (h, ExitCode, Int) overFailure :: (ParserHelp -> ParserHelp) -> ParserResult a -> ParserResult a -- | Result of execParserPure. data ParserResult a Success :: a -> ParserResult a Failure :: (ParserFailure ParserHelp) -> ParserResult a CompletionInvoked :: CompletionResult -> ParserResult a -- | Global preferences for a top-level Parser. data ParserPrefs ParserPrefs :: String -> Bool -> Bool -> Bool -> Bool -> Int -> ParserPrefs -- | metavar suffix for multiple options [prefMultiSuffix] :: ParserPrefs -> String -- | automatically disambiguate abbreviations (default: False) [prefDisambiguate] :: ParserPrefs -> Bool -- | always show help text on parse errors (default: False) [prefShowHelpOnError] :: ParserPrefs -> Bool -- | show the help text for a command or subcommand if it fails with no -- input (default: False) [prefShowHelpOnEmpty] :: ParserPrefs -> Bool -- | backtrack to parent parser when a subcommand fails (default: True) [prefBacktrack] :: ParserPrefs -> Bool -- | number of columns in the terminal, used to format the help page -- (default: 80) [prefColumns] :: ParserPrefs -> Int newtype CompletionResult CompletionResult :: (String -> IO String) -> CompletionResult [execCompletion] :: CompletionResult -> String -> IO String module Options.Applicative -- | This module contains an arrow interface for option parsers, which -- allows to define and combine parsers using the arrow notation and -- arrow combinators. -- -- The arrow syntax is particularly useful to create parsers of nested -- structures, or records where the order of fields is different from the -- order in which the parsers should be applied. -- -- For example, an arguments parser often needs to be applied -- last, and that makes it inconvenient to use it for a field which is -- not the last one in a record. -- -- Using the arrow syntax and the functions in this module, one can -- write, e.g.: -- -- 
--   data Options = Options
--     { optArgs :: [String]
--     , optVerbose :: Bool }
--   
--   opts :: Parser Options
--   opts = runA $ proc () -> do
--     verbose <- asA (switch (short 'v')) -< ()
--     args <- asA (arguments str idm) -< ()
--     returnA -< Options args verbose
--
-- -- Parser arrows, created out of regular Parser values using the -- asA function, are arrows taking () as argument and -- returning the parsed value. module Options.Applicative.Arrows -- | For any Applicative functor f, A f is the -- Arrow instance associated to f. -- -- The A constructor can be used to convert a value of type f -- (a -> b) into an arrow. newtype A f a b A :: f (a -> b) -> A f a b [unA] :: A f a b -> f (a -> b) -- | Convert a value of type f a into an arrow taking () -- as argument. -- -- Applied to a value of type Parser, it turns it into an arrow -- that can be used inside an arrow command, or passed to arrow -- combinators. asA :: Applicative f => f a -> A f () a -- | Convert an arrow back to an applicative value. -- -- This function can be used to return a result of type Parser -- from an arrow command. runA :: Applicative f => A f () a -> f a -- | The type of arrows associated to the applicative Parser -- functor. type ParserA = A Parser instance GHC.Base.Applicative f => Control.Category.Category (Options.Applicative.Arrows.A f) instance GHC.Base.Applicative f => Control.Arrow.Arrow (Options.Applicative.Arrows.A f)