BishBosh.Input.CommandLineOption

AUTHOR

Dr. Alistair Ward

DESCRIPTION

To facilitate processing of command-line options.

Types

Type-synonyms

type Flag = String

Synonym.

Data-types

data CommandLineOption options

The sum-type of categories of command-line option.

Constants

longFlagPrefix :: Flag

The prefix used to denote the long form of a command-line flag.

Functions

categorise :: [CommandLineOption options] -> CategorisedCommandLineOptions options

• Partition a list of CommandLineOptions according to their data-constructor.
• N.B.: preserves the order of all specifications sharing a data-constructor.

getArgs

Arguments

:: [Flag]

The list acceptible abbreviations for the required flag, each preceded by "--".

-> [String]

The command-line arguments to search.

-> [String]

The matching argument-values.

• Return the list of arguments extracted from the specified command-line, which match the specified flag.
• CAVEAT: All unique abbreviations must also be supplied. Doesn't cope with short flags preceded by -.

readArg :: Read a => String -> a

Parse the specified string, returning the specified explanatory error-message on failure.

readBoundedIntegral :: Integral i => String -> i

Reads a bounded integral value from the command-line, guarding against overflow.

Constructors

mkConfigLocationParameter :: FilePath -> CommandLineOption options

Constructor.

mkIOAction :: IOAction -> CommandLineOption options

Constructor.

mkContextualIOAction :: ContextualIOAction options -> CommandLineOption options

Constructor.

mkOptionsMutator :: OptionsMutator options -> CommandLineOption options

Constructor.