-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Powerful and easy command-line option parser -- -- Lets library and application developers easily work with command-line -- options. @package options @version 1.2.1.2 module Options -- | Options are defined together in a single data type, which will be an -- instance of Options -- -- See defineOptions for details on defining instances of -- Options. class Options opts -- | Defines the structure and metadata of the options in this type, -- including their types, flag names, and documentation. -- -- Options with a basic type and a single flag name may be defined with -- simpleOption. Options with more complex requirements may be -- defined with defineOption. -- -- Non-option fields in the type may be set using applicative functions -- such as pure. -- -- Options may be included from another type by using a nested call to -- defineOptions. -- -- Library authors are encouraged to aggregate their options into a few -- top-level types, so application authors can include it easily in their -- own option definitions. defineOptions :: Options opts => DefineOptions opts -- | An options value containing only the default values for each option -- -- This is equivalent to the options value when parsing an empty argument -- list. defaultOptions :: Options opts => opts -- | Defines a new option in the current options type simpleOption :: SimpleOptionType a => String -> a -> String -> DefineOptions a data DefineOptions a class SimpleOptionType a simpleOptionType :: SimpleOptionType a => OptionType a data Subcommand cmdOpts action subcommand :: (Options cmdOpts, Options subcmdOpts) => String -> (cmdOpts -> subcmdOpts -> [String] -> action) -> Subcommand cmdOpts action -- | Either calls the given continuation, prints help text and calls -- exitSuccess, or prints an error and calls exitFailure. -- -- See runSubcommand for details on subcommand support. runCommand :: (MonadIO m, Options opts) => (opts -> [String] -> m a) -> m a -- | Used to run applications that are split into subcommands runSubcommand :: (Options opts, MonadIO m) => [Subcommand opts (m a)] -> m a -- | See parseOptions and parseSubcommand class Parsed a -- | Get the error that prevented options from being parsed from argv, or -- Nothing if no error was detected parsedError :: Parsed a => a -> Maybe String -- | Get a help message to show the user -- -- If the arguments included a help flag, this will be a message -- appropriate to that flag. Otherwise, it is a summary (equivalent to -- --help). -- -- This is always a non-empty string, regardless of whether the parse -- succeeded or failed. If you need to perform additional validation on -- the options value, this message can be displayed if validation fails. parsedHelp :: Parsed a => a -> String -- | See parseOptions data ParsedOptions opts -- | Get the options value that was parsed from argv, or Nothing -- if the arguments could not be converted into options -- -- Note: This function return Nothing if the user provided a -- help flag. To check whether an error occurred during parsing, check -- the value of parsedError. parsedOptions :: ParsedOptions opts -> Maybe opts -- | Get command-line arguments remaining after parsing options -- -- The arguments are unchanged from the original argument list, and have -- not been decoded or otherwise transformed. parsedArguments :: ParsedOptions opts -> [String] -- | Attempt to convert a list of command-line arguments into an options -- value parseOptions :: Options opts => [String] -> ParsedOptions opts -- | See parseSubcommand data ParsedSubcommand action -- | Get the subcommand action that was parsed from argv, or -- Nothing if the arguments could not be converted into a valid -- action -- -- Note: This function return Nothing if the user provided a -- help flag. To check whether an error occurred during parsing, check -- the value of parsedError. parsedSubcommand :: ParsedSubcommand action -> Maybe action -- | Attempt to convert a list of command-line arguments into a subcommand -- action parseSubcommand :: Options cmdOpts => [Subcommand cmdOpts action] -> [String] -> ParsedSubcommand action -- | An option's type determines how the option will be parsed, and which -- Haskell type the parsed value will be stored as -- -- There are many types available, covering most basic types and a few -- more advanced types. data OptionType val -- | Defines a new option in the current options type -- -- All options must have one or more flags. Options may also have -- a default value, a description, and a group. -- -- The flags are how the user specifies an option on the command -- line. Flags may be short or long. See -- optionShortFlags and optionLongFlags for details. -- -- 
--   defineOption optionType_word16 (\o -> o
--      { optionLongFlags = ["port"]
--      , optionDefault = 80
--      })
--
defineOption :: OptionType a -> (Option a -> Option a) -> DefineOptions a data Option a -- | Short flags are a single character. When entered by a user, they are -- preceded by a dash and possibly other short flags. -- -- Short flags must be a letter or a number. -- -- Example: An option with optionShortFlags = ['p'] may be set -- using: -- -- 
--   $ ./app -p 443
--   $ ./app -p443
--
optionShortFlags :: Option a -> [Char] -- | Long flags are multiple characters. When entered by a user, they are -- preceded by two dashes. -- -- Long flags may contain letters, numbers, '-', and -- '_'. -- -- Example: An option with optionLongFlags = ["port"] may be set -- using: -- -- 
--   $ ./app --port 443
--   $ ./app --port=443
--
optionLongFlags :: Option a -> [String] -- | Options may have a default value. This will be parsed as if the user -- had entered it on the command line. optionDefault :: Option a -> a -- | An option's description is used with the default implementation of -- --help. It should be a short string describing what the -- option does. optionDescription :: Option a -> String -- | Which group the option is in. See the "Option groups" section for -- details. optionGroup :: Option a -> Maybe Group data Group -- | Define an option group with the given name and title -- -- Use groupDescription to add additional descriptive text, if -- needed. group :: String -> String -> String -> Group groupName :: Group -> String -- | A short title for the group, which is used when printing -- --help output. groupTitle :: Group -> String -- | A description of the group, which is used when printing -- --help output. groupDescription :: Group -> String -- | Store an option as a Bool -- -- The option's value must be either "true" or "false". -- Boolean options are unary, which means that their value is optional -- when specified on the command line. optionType_bool :: OptionType Bool -- | Store an option value as a String -- -- The value is decoded to Unicode first, if needed. optionType_string :: OptionType String -- | Store an option as an Int -- -- The option value must be an integer n such that -- minBound <= n <= maxBound. optionType_int :: OptionType Int -- | Store an option as an Int8 -- -- The option value must be an integer n such that -- minBound <= n <= maxBound. optionType_int8 :: OptionType Int8 -- | Store an option as an Int16 -- -- The option value must be an integer n such that -- minBound <= n <= maxBound. optionType_int16 :: OptionType Int16 -- | Store an option as an Int32 -- -- The option value must be an integer n such that -- minBound <= n <= maxBound. optionType_int32 :: OptionType Int32 -- | Store an option as an Int64 -- -- The option value must be an integer n such that -- minBound <= n <= maxBound. optionType_int64 :: OptionType Int64 -- | Store an option as a Word -- -- The option value must be a positive integer n such that 0 -- <= n <= maxBound. optionType_word :: OptionType Word -- | Store an option as a Word8 -- -- The option value must be a positive integer n such that 0 -- <= n <= maxBound. optionType_word8 :: OptionType Word8 -- | Store an option as a Word16 -- -- The option value must be a positive integer n such that 0 -- <= n <= maxBound. optionType_word16 :: OptionType Word16 -- | Store an option as a Word32 -- -- The option value must be a positive integer n such that 0 -- <= n <= maxBound. optionType_word32 :: OptionType Word32 -- | Store an option as a Word64 -- -- The option value must be a positive integer n such that 0 -- <= n <= maxBound. optionType_word64 :: OptionType Word64 -- | Store an option as an Integer -- -- The option value must be an integer. There is no minimum or maximum -- value. optionType_integer :: OptionType Integer -- | Store an option as a Float -- -- The option value must be a number. Due to the imprecision of -- floating-point math, the stored value might not exactly match the -- user's input. If the user's input is out of range for the -- Float type, it will be stored as Infinity or -- -Infinity. optionType_float :: OptionType Float -- | Store an option as a Double -- -- The option value must be a number. Due to the imprecision of -- floating-point math, the stored value might not exactly match the -- user's input. If the user's input is out of range for the -- Double type, it will be stored as Infinity or -- -Infinity. optionType_double :: OptionType Double -- | Store an option as a Maybe of another type -- -- The value will be Nothing if the option is set to an empty -- string. optionType_maybe :: OptionType a -> OptionType (Maybe a) -- | Store an option as a list, using another option type for the elements -- -- The separator should be a character that will not occur within the -- values, such as a comma or semicolon. optionType_list :: Char -> OptionType a -> OptionType [a] -- | Store an option as a Set, using another option type -- for the elements -- -- The separator should be a character that will not occur within the -- values, such as a comma or semicolon. -- -- Duplicate elements in the input are permitted. optionType_set :: Ord a => Char -> OptionType a -> OptionType (Set a) -- | Store an option as a Map, using other option types for the keys -- and values -- -- The item separator is used to separate key/value pairs from each -- other. It should be a character that will not occur within either the -- keys or values. -- -- The value separator is used to separate the key from the value. It -- should be a character that will not occur within the keys. It may -- occur within the values. -- -- Duplicate keys in the input are permitted. The final value for each -- key is stored. optionType_map :: Ord k => Char -> Char -> OptionType k -> OptionType v -> OptionType (Map k v) -- | Store an option as one of a set of possible values -- -- This is a simplistic implementation, useful for quick scripts. For -- more possibilities, see optionType. optionType_enum :: (Bounded a, Enum a, Show a) => String -> OptionType a -- | Define a new option type with the given name, default, and behavior optionType :: String -> val -> (String -> Either String val) -> (val -> String) -> OptionType val -- | The name of this option type; used in --help output. optionTypeName :: OptionType val -> String -- | The default value for options of this type. This will be used if -- optionDefault is not set when defining the option. optionTypeDefault :: OptionType val -> val -- | Try to parse the given string to an option value. If parsing fails, an -- error message will be returned. optionTypeParse :: OptionType val -> String -> Either String val -- | Format the value for display; used in --help output. optionTypeShow :: OptionType val -> val -> String -- | If not Nothing, then options of this type may be set by a unary flag. -- The option will be parsed as if the given value were set. optionTypeUnary :: OptionType val -> Maybe val -- | If not Nothing, then options of this type may be set with repeated -- flags. Each flag will be parsed with optionTypeParse, and the -- resulting parsed values will be passed to this function for merger -- into the final value. optionTypeMerge :: OptionType val -> Maybe ([val] -> val) instance GHC.Show.Show Options.DeDupFlag instance GHC.Classes.Ord Options.DeDupFlag instance GHC.Classes.Eq Options.DeDupFlag instance Options.Parsed (Options.ParsedSubcommand a) instance Options.Parsed (Options.ParsedOptions a) instance Options.SimpleOptionType GHC.Types.Bool instance Options.SimpleOptionType GHC.Base.String instance Options.SimpleOptionType GHC.Num.Integer.Integer instance Options.SimpleOptionType GHC.Types.Int instance Options.SimpleOptionType GHC.Int.Int8 instance Options.SimpleOptionType GHC.Int.Int16 instance Options.SimpleOptionType GHC.Int.Int32 instance Options.SimpleOptionType GHC.Int.Int64 instance Options.SimpleOptionType GHC.Types.Word instance Options.SimpleOptionType GHC.Word.Word8 instance Options.SimpleOptionType GHC.Word.Word16 instance Options.SimpleOptionType GHC.Word.Word32 instance Options.SimpleOptionType GHC.Word.Word64 instance Options.SimpleOptionType GHC.Types.Float instance Options.SimpleOptionType GHC.Types.Double instance Options.SimpleOptionType a => Options.SimpleOptionType (GHC.Maybe.Maybe a) instance GHC.Base.Functor Options.DefineOptions instance GHC.Base.Applicative Options.DefineOptions