-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | An enum-text based toolkit for optparse-applicative
--   
--   Please see the README on GitHub at
--   <a>https://github.com/cdornan/optparse-enum#readme</a>
@package optparse-enum
@version 1.0.0.0

module Text.Enum.Optparse

-- | making an IO parser
parseIO :: ParserDetails -> Parser a -> IO a

-- | making an IO parser, specifying the arguments
parseIOWithArgs :: ParserDetails -> Parser a -> [String] -> IO a

-- | making a functional parser
pureParse :: ParserDetails -> Parser a -> [String] -> Maybe a

-- | a testing helper
testCLI :: Show a => ParserDetails -> Parser a -> [String] -> IO ()
data ParserDetails
ParserDetails :: String -> String -> String -> ParserDetails
[_pd_desc] :: ParserDetails -> String
[_pd_header] :: ParserDetails -> String
[_pd_footer] :: ParserDetails -> String

-- | given a <a>Parser</a> makes up a corresponding <tt>ParserInfo</tt>
mkParserInfo :: ParserDetails -> Parser a -> ParserInfo a
type MetaVar = String " name of a meta variable to be used in the docs"
type HelpText = String " help text"
type FlagName = String " name of a flag (will be forced to lower case)"
type FlagChar = Char " charcter used for a short flag"

-- | parsing an <a>EnumText</a> argument
enumArgP :: forall a. EnumText a => MetaVar -> Parser a

-- | pasring a <a>TextParsable</a> argument
argP :: TextParsable a => MetaVar -> HelpText -> Parser a

-- | pasring an <a>TextParsable</a> argument, the parser being passed
--   explicitly
argP' :: (Text -> Either String a) -> MetaVar -> String -> Parser a

-- | parsing an <a>EnumText</a> option
enumOptP :: forall a. EnumText a => FlagChar -> MetaVar -> Parser a

-- | parsing a <a>TextParsable</a> option
optP :: TextParsable a => FlagChar -> FlagName -> HelpText -> Parser a

-- | generate mutually exclusive switches based on <a>EnumText</a>
--   <tt>a</tt>
enumSwitchesP :: EnumText a => Parser a

-- | generate mutually exclusive switches based on <a>EnumText</a>
--   <tt>a</tt>, with some short swich options as specified by the argument
--   function
shortEnumSwitchesP :: forall a. EnumText a => (a -> Maybe FlagChar) -> Parser a
instance GHC.Show.Show Text.Enum.Optparse.ParserDetails