-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | Command line argument processing -- -- This library provides an easy way to define command line parsers. Most -- users will want to use the System.Console.CmdArgs.Implicit -- module, whose documentation contains an example. -- -- @package cmdargs @version 0.2 -- | A module to deal with verbosity, how 'chatty' a program should be. -- This module defines the Verbosity data type, along with -- functions for manipulating a global verbosity value. module System.Console.CmdArgs.Verbosity -- | The verbosity data type data Verbosity -- | Only output essential messages (typically errors) Quiet :: Verbosity -- | Output normal messages (typically errors and warnings) Normal :: Verbosity -- | Output lots of messages (typically errors, warnings and status -- updates) Loud :: Verbosity -- | Set the global verbosity. setVerbosity :: Verbosity -> IO () -- | Get the global verbosity. Initially Normal before any calls -- to setVerbosity. getVerbosity :: IO Verbosity -- | Used to test if warnings should be output to the user. True -- if the verbosity is set to Normal or Loud (when -- --quiet is not specified). isNormal :: IO Bool -- | Used to test if status updates should be output to the user. -- True if the verbosity is set to Loud (when -- --verbose is specified). isLoud :: IO Bool -- | An action to perform if the verbosity is normal or higher, based on -- isNormal. whenNormal :: IO () -> IO () -- | An action to perform if the verbosity is loud, based on isLoud. whenLoud :: IO () -> IO () instance Typeable Verbosity instance Eq Verbosity instance Ord Verbosity instance Bounded Verbosity instance Enum Verbosity instance Show Verbosity instance Read Verbosity instance Data Verbosity -- | This module provides default values for many types. To use the default -- value simply write def. module System.Console.CmdArgs.Default -- | Class for default values. class Default a def :: (Default a) => a instance (Default a1, Default a2, Default a3, Default a4, Default a5, Default a6, Default a7, Default a8, Default a9, Default a10) => Default (a1, a2, a3, a4, a5, a6, a7, a8, a9, a10) instance (Default a1, Default a2, Default a3, Default a4, Default a5, Default a6, Default a7, Default a8, Default a9) => Default (a1, a2, a3, a4, a5, a6, a7, a8, a9) instance (Default a1, Default a2, Default a3, Default a4, Default a5, Default a6, Default a7, Default a8) => Default (a1, a2, a3, a4, a5, a6, a7, a8) instance (Default a1, Default a2, Default a3, Default a4, Default a5, Default a6, Default a7) => Default (a1, a2, a3, a4, a5, a6, a7) instance (Default a1, Default a2, Default a3, Default a4, Default a5, Default a6) => Default (a1, a2, a3, a4, a5, a6) instance (Default a1, Default a2, Default a3, Default a4, Default a5) => Default (a1, a2, a3, a4, a5) instance (Default a1, Default a2, Default a3, Default a4) => Default (a1, a2, a3, a4) instance (Default a1, Default a2, Default a3) => Default (a1, a2, a3) instance (Default a1, Default a2) => Default (a1, a2) instance Default (Maybe a) instance Default [a] instance Default Double instance Default Float instance Default Integer instance Default Int instance Default Bool instance Default () -- | A module to represent text with very basic formatting. Values are of -- type [Text] and shown with showText. -- -- As an example of the formatting: -- -- 
--   [Line "Cooking for hungry people."
--   ,Line "Welcome to my cookery recipe program, I sure hope you enjoy using it!"
--   ,Line ""
--   ,Cols ["Omlette","  A tasty eggy treat."]
--   ,Cols ["  -m"," --mushrooms","  Some mushrooms, or in fact any other ingredients you have in the cupboards"]
--   ,Cols ["  -e"," --eggs", "  But always you need eggs"]
--   ,Line ""
--   ,Cols ["Spagetti Bolognaise", "  An Italian delight."]
--   ,Cols ["  -s"," --spagetti","  The first word in the name"]
--   ,Cols ["  -b"," --bolognaise","  The second word in the name"]
--   ,Cols ["  -d"," --dolmio","  The magic ingredient!"]
--   ,Line ""
--   ,Line "    The author of this program explicitly disclaims any liability for poisoning people who get their recipes off the internet."]
--
-- -- With putStrLn (showText (Wrap 50) demo) gives: -- -- 
--   Cooking for hungry people.
--   Welcome to my cookery recipe program, I sure hope
--   you enjoy using it!
--   
--   Omlette              A tasty eggy treat.
--     -m --mushrooms   Some mushrooms, or in fact
--                      any other ingredients you have
--                      in the cupboards
--     -e --eggs        But always you need eggs
--   
--   Spagetti Bolognaise  An Italian delight.
--     -s --spagetti    The first word in the name
--     -b --bolognaise  The second word in the name
--     -d --dolmio      The magic ingredient!
--   
--       The author of this program explicitly
--       disclaims any liability for poisoning people
--       who get their recipes off the internet.
--
module System.Console.CmdArgs.Text -- | How to output the text. data TextFormat -- | Display as HTML. HTML :: TextFormat -- | Display as text wrapped at a certain width (see defaultWrap). Wrap :: Int -> TextFormat -- | Wrap with the default width of 80 characters. defaultWrap :: TextFormat -- | The data type representing some text, typically used as -- [Text]. The formatting is described by: -- -- data Text Line :: String -> Text Cols :: [String] -> Text -- | Show some text using the given formatting. showText :: TextFormat -> [Text] -> String instance Read TextFormat instance Show TextFormat instance Eq TextFormat instance Ord TextFormat instance Show Text instance Default TextFormat -- | This module constructs command lines. You may either use the helper -- functions (flagNone, flagOpt, mode etc.) or -- construct the type directly. These types are intended to give all the -- necessary power to the person constructing a command line parser. -- -- For people constructing simpler command line parsers, the module -- System.Console.CmdArgs.Implicit may be more appropriate. module System.Console.CmdArgs.Explicit -- | Process a list of flags (usually obtained from getArgs) with -- a mode. Returns Left and an error message if the command line -- fails to parse, or Right and the associated value. process :: Mode a -> [String] -> Either String a -- | Process a list of flags (usually obtained from getArgs) with -- a mode. Displays an error and exits with failure if the command line -- fails to parse, or returns the associated value. Implemeneted in terms -- of process. processValue :: Mode a -> [String] -> a -- | Process the flags obtained by getArgs with a mode. Displays -- an error and exits with failure if the command line fails to parse, or -- returns the associated value. Implemented in terms of process. processArgs :: Mode a -> IO a -- | A name, either the name of a flag (--foo) or the name -- of a mode. type Name = String -- | A help message that goes with either a flag or a mode. type Help = String -- | The type of a flag, i.e. --foo=TYPE. type FlagHelp = String -- | Parse a boolean, accepts as True: true yes on enabled 1. parseBool :: String -> Maybe Bool -- | A group of items (modes or flags). The items are treated as a list, -- but the group structure is used when displaying the help message. data Group a Group :: [a] -> [a] -> [(Help, [a])] -> Group a -- | Normal items. groupUnnamed :: Group a -> [a] -- | Items that are hidden (not displayed in the help message). groupHiden :: Group a -> [a] -- | Items that have been grouped, along with a description of each group. groupNamed :: Group a -> [(Help, [a])] -- | Convert a group into a list. fromGroup :: Group a -> [a] -- | Convert a list into a group, placing all fields in -- groupUnnamed. toGroup :: [a] -> Group a -- | A mode. Each mode has three main features: -- -- data Mode a Mode :: Group (Mode a) -> [Name] -> a -> (a -> Either String a) -> Help -> [String] -> Maybe (Arg a) -> Group (Flag a) -> Mode a -- | The available sub-modes modeGroupModes :: Mode a -> Group (Mode a) -- | The names assigned to this mode modeNames :: Mode a -> [Name] -- | Value to start with modeValue :: Mode a -> a modeCheck :: Mode a -> a -> Either String a -- | Help text modeHelp :: Mode a -> Help -- | A longer help suffix displayed after a mode modeHelpSuffix :: Mode a -> [String] -- | An unnamed argument modeArgs :: Mode a -> Maybe (Arg a) -- | Groups of flags modeGroupFlags :: Mode a -> Group (Flag a) -- | Extract the modes from a Mode modeModes :: Mode a -> [Mode a] -- | Extract the flags from a Mode modeFlags :: Mode a -> [Flag a] -- | The FlagInfo type has the following meaning: -- -- 
--                FlagReq     FlagOpt      FlagOptRare/FlagNone
--   -xfoo        -x=foo      -x=foo       -x= -foo
--   -x foo       -x=foo      -x foo       -x= foo
--   -x=foo       -x=foo      -x=foo       -x=foo
--   --xx foo     --xx=foo    --xx foo     --xx foo
--   --xx=foo     --xx=foo    --xx=foo     --xx=foo
--
data FlagInfo -- | Required argument FlagReq :: FlagInfo -- | Optional argument FlagOpt :: String -> FlagInfo -- | Optional argument that requires an = before the value FlagOptRare :: String -> FlagInfo -- | No argument FlagNone :: FlagInfo -- | Extract the value from inside a FlagOpt or FlagOptRare, -- or raises an error. fromFlagOpt :: FlagInfo -> String -- | A function to take a string, and a value, and either produce an error -- message (Left), or a modified value (Right). type Update a = String -> a -> Either String a -- | A flag, consisting of a list of flag names and other information. data Flag a Flag :: [Name] -> FlagInfo -> Update a -> FlagHelp -> Help -> Flag a -- | The names for the flag. flagNames :: Flag a -> [Name] -- | Information about a flag's arguments. flagInfo :: Flag a -> FlagInfo -- | The way of processing a flag. flagValue :: Flag a -> Update a -- | The type of data for the flag argument, i.e. FILE/DIR/EXT flagType :: Flag a -> FlagHelp -- | The help message associated with this flag. flagHelp :: Flag a -> Help -- | An unnamed argument. data Arg a Arg :: Update a -> FlagHelp -> Arg a -- | A way of processing the argument. argValue :: Arg a -> Update a -- | The type of data for the argument, i.e. FILE/DIR/EXT argType :: Arg a -> FlagHelp -- | Check that a mode is well formed. checkMode :: Mode a -> Maybe String -- | Change the underlying type of a Mode structure. remap :: (a -> b) -> (b -> (a, a -> b)) -> Mode a -> Mode b -- | Create a mode with a name, an initial value, some help text, a way of -- processing arguments and a list of flags. mode :: Name -> a -> Help -> Arg a -> [Flag a] -> Mode a -- | Create a list of modes, with a program name, an initial value, some -- help text and the child modes. modes :: String -> a -> Help -> [Mode a] -> Mode a -- | Create a flag taking no argument value, with a list of flag names, an -- update function and some help text. flagNone :: [Name] -> (a -> a) -> Help -> Flag a -- | Create a flag taking an optional argument value, with an optional -- value, a list of flag names, an update function, the type of the -- argument and some help text. flagOpt :: String -> [Name] -> Update a -> FlagHelp -> Help -> Flag a -- | Create a flag taking a required argument value, with a list of flag -- names, an update function, the type of the argument and some help -- text. flagReq :: [Name] -> Update a -> FlagHelp -> Help -> Flag a -- | Create an argument flag, with an update function and the type of the -- argument. flagArg :: Update a -> FlagHelp -> Arg a -- | Create a boolean flag, with a list of flag names, an update function -- and some help text. flagBool :: [Name] -> (Bool -> a -> a) -> Help -> Flag a -- | Create a help flag triggered by -?/--help. flagHelpSimple :: (a -> a) -> Flag a -- | Create a help flag triggered by -?/--help. The user -- may optionally modify help by specifying the format, such as: -- -- 
--   --help=all          - help for all modes
--   --help=html         - help in HTML format
--   --help=100          - wrap the text at 100 characters
--   --help=100,one      - full text wrapped at 100 characters
--
flagHelpFormat :: (HelpFormat -> TextFormat -> a -> a) -> Flag a -- | Create a version flag triggered by -V/--version. flagVersion :: (a -> a) -> Flag a -- | Create verbosity flags triggered by -v/--verbose and -- -q/--quiet flagsVerbosity :: (Verbosity -> a -> a) -> [Flag a] -- | Specify the format to output the help. data HelpFormat -- | Equivalent to HelpFormatAll if there is not too much text, -- otherwise HelpFormatOne. HelpFormatDefault :: HelpFormat -- | Display only the first mode. HelpFormatOne :: HelpFormat -- | Display all modes. HelpFormatAll :: HelpFormat -- | Generate a help message from a mode. helpText :: HelpFormat -> Mode a -> [Text] -- | This provides a compatiblity wrapper to the -- System.Console.GetOpt module in base. That module is -- essentially a Haskell port of the GNU getopt library. -- -- Changes: The changes from GetOpt are listed in the -- documentation for each function. module System.Console.CmdArgs.GetOpt -- | Given a help text and a list of option descriptions, generate a -- Mode. convert :: String -> [OptDescr a] -> Mode ([a], [String]) -- | Process the command-line, and return the list of values that matched -- (and those that didn't). The arguments are: -- -- -- -- getOpt returns a triple consisting of the option arguments, a -- list of non-options, and a list of error messages. -- -- Changes: The list of errors will contain at most one entry, and -- if an error is present then the other two lists will be empty. getOpt :: ArgOrder a -> [OptDescr a] -> [String] -> ([a], [String], [String]) -- | Changes: This is exactly the same as getOpt, but the 3rd -- element of the tuple (second last) will be an empty list. getOpt' :: ArgOrder a -> [OptDescr a] -> [String] -> ([a], [String], [String], [String]) -- | Return a string describing the usage of a command, derived from the -- header (first argument) and the options described by the second -- argument. usageInfo :: String -> [OptDescr a] -> String -- | What to do with options following non-options. -- -- Changes: Only Permute is allowed, both -- RequireOrder and ReturnInOrder have been removed. data ArgOrder a Permute :: ArgOrder a -- | Each OptDescr describes a single option/flag. -- -- The arguments to Option are: -- -- data OptDescr a Option :: [Char] -> [String] -> (ArgDescr a) -> String -> OptDescr a -- | Describes whether an option takes an argument or not, and if so how -- the argument is injected into a value of type a. data ArgDescr a -- | no argument expected NoArg :: a -> ArgDescr a -- | option requires argument ReqArg :: (String -> a) -> String -> ArgDescr a -- | optional argument OptArg :: (Maybe String -> a) -> String -> ArgDescr a -- | This module provides simple command line argument processing. The main -- function of interest is cmdArgs. A simple example is: -- -- 
--   data Sample = Sample {hello :: String} deriving (Show, Data, Typeable)
--
-- -- sample = Sample{hello = def &= help -- "World argument" &= opt "world"} -- &= summary "Sample v1" -- -- 
--   main = print =<< cmdArgs sample
--
-- -- Attributes are used to control a number of behaviours: -- -- -- -- -- -- Warning: Values created with annotations are not pure - the -- first time they are used they will include the annotations, but -- subsequently they will not. To capture the annotations, so they can be -- used multiple times, use cmdArgsMode. module System.Console.CmdArgs.Implicit -- | Take annotated records and run the corresponding command line. -- Shortcut for cmdArgsRun . cmdArgsMode. cmdArgs :: (Data a) => a -> IO a -- | Take annotated records and turn them in to a Mode value, that -- can make use of the System.Console.CmdArgs.Explicit functions -- (i.e. process). -- -- Annotated records are impure, and will only contain annotations on -- their first use. The result of this function is pure, and can be -- reused. cmdArgsMode :: (Data a) => a -> Mode (CmdArgs a) -- | Run a Mode structure. This function reads the command line arguments -- and then performs as follows: -- -- cmdArgsRun :: Mode (CmdArgs a) -> IO a -- | Perform the necessary actions dictated by a CmdArgs structure. -- -- cmdArgsApply :: CmdArgs a -> IO a -- | A structure to store the additional data relating to --help, -- --version, --quiet and --verbose. data CmdArgs a CmdArgs :: a -> Maybe String -> Maybe String -> Maybe Verbosity -> CmdArgsPrivate -> CmdArgs a -- | The underlying value being wrapped. cmdArgsValue :: CmdArgs a -> a -- | Just if --help is given, then gives the help message -- for display. cmdArgsHelp :: CmdArgs a -> Maybe String -- | Just if --verion is given, then gives the version -- message for display. cmdArgsVersion :: CmdArgs a -> Maybe String -- | Just if --quiet or --verbose is given, then -- gives the verbosity to use. cmdArgsVerbosity :: CmdArgs a -> Maybe Verbosity -- | Private: Only exported due to Haddock limitations. cmdArgsPrivate :: CmdArgs a -> CmdArgsPrivate -- | Add an annotation to a value. Note that if the value is evaluated more -- than once the annotation will only be available the first time. (&=) :: (Data a) => a -> Ann -> a -- | Modes: "I want a program with multiple modes, like darcs or cabal." -- -- Takes a list of modes, and creates a mode which includes them all. If -- you want one of the modes to be chosen by default, see auto. -- -- 
--   data Modes = Mode1 | Mode2 | Mode3 deriving Data
--   cmdArgs $ modes [Mode1,Mode2,Mode3]
--
modes :: (Data a) => [a] -> a -- | Flag: "I want several different flags to set this one field to -- different values." -- -- This annotation takes a type which is an enumeration, and provides -- multiple separate flags to set the field to each value. -- -- 
--   data State = On | Off deriving Data
--   data Mode = Mode {state :: State}
--   cmdArgs $ Mode {state = enum [On &= help "Turn on",Off &= help "Turn off"]}
--     --on   Turn on
--     --off  Turn off
--
enum :: (Data a) => [a] -> a -- | Flag: "I want users to be able to omit the value for this flag." -- -- Make the value of a flag optional. If --flag is given, it -- will be treated as --flag=this_argument. -- -- 
--   {hello = def &= opt "foo"}
--     -h --hello[=VALUE]    (default=foo)
--
opt :: (Show a, Typeable a) => a -> Ann -- | Flag: "For this flag, users need to give something of type ..." -- -- The the type of a flag's value, usually upper case. Only used for the -- help message. Commonly the type will be FILE (typFile) -- or DIR (typDir). -- -- 
--   {hello = def &= typ "MESSAGE"}
--     -h --hello=MESSAGE
--
typ :: String -> Ann -- | Flag: "Users must give a file for this flag's value." -- -- Alias for typ FILE. typFile :: Ann -- | Flag: "Users must give a directory for this flag's value." -- -- Alias for typ DIR. typDir :: Ann -- | Flag/Mode: "The help message is ..." -- -- Descriptive text used in the help output. -- -- 
--   {hello = def &= help "Help message"}
--     -h --hello=VALUE      Help message
--
help :: String -> Ann -- | Flag: "Use this flag name for this field." -- -- Add flags which trigger this option. -- -- 
--   {hello = def &= name "foo"}
--     -h --hello --foo=VALUE
--
name :: String -> Ann -- | Flag: "Put non-flag arguments here." -- -- 
--   {hello = def &= args}
--
args :: Ann -- | Flag: "Put the nth non-flag argument here." -- -- This field should be used to store a particular argument position -- (0-based). -- -- 
--   {hello = def &= argPos 0}
--
argPos :: Int -> Ann -- | Flag/Mode: "Give these flags/modes a group name in the help output." -- -- This mode will be used for all following modes/flags, until the next -- groupname. -- -- 
--   {hello = def &= groupname "Welcomes"}
--   Welcomes
--     -h --hello=VALUE
--
groupname :: String -> Ann -- | Mode: "A longer description of this mode is ..." -- -- Suffix to be added to the help message. -- -- 
--   Sample{..} &= details ["More details on the website www.example.org"]
--
details :: [String] -> Ann -- | Modes: "My program name/version/copyright is ..." -- -- One line summary of the entire program, the first line of -- --help and the only line of --version. -- -- 
--   Sample{..} &= summary "CmdArgs v0.0, (C) Neil Mitchell 1981"
--
summary :: String -> Ann -- | Mode: "If the user doesn't give a mode, use this one." -- -- This mode is the default. If no mode is specified and a mode has this -- attribute then that mode is selected, otherwise an error is raised. -- -- 
--   modes [Mode1{..}, Mode2{..} &= auto, Mode3{..}]
--
auto :: Ann -- | Modes: "My program executable is named ..." -- -- This is the name of the program executable. Only used in the help -- message. Defaults to the type of the mode. -- -- 
--   Sample{..} &= program "sample"
--
program :: String -> Ann -- | Flag: "Don't guess any names for this field." -- -- A field should not have any flag names guessed for it. All flag names -- must be specified by flag. -- -- 
--   {hello = def &= explicit &= flag "foo"}
--     --foo=VALUE
--
explicit :: Ann -- | Modes: "My program needs verbosity flags." -- -- Add --verbose and --quiet flags. verbosity :: Ann -- | The general type of annotations that can be associated with a value. data Ann -- | A mode. Each mode has three main features: -- -- data Mode a -- | The Data class comprehends a fundamental primitive -- gfoldl for folding over constructor applications, say terms. -- This primitive can be instantiated in several ways to map over the -- immediate subterms of a term; see the gmap combinators later -- in this class. Indeed, a generic programmer does not necessarily need -- to use the ingenious gfoldl primitive but rather the intuitive -- gmap combinators. The gfoldl primitive is completed by -- means to query top-level constructors, to turn constructor -- representations into proper terms, and to list all possible datatype -- constructors. This completion allows us to serve generic programming -- scenarios like read, show, equality, term generation. -- -- The combinators gmapT, gmapQ, gmapM, etc are all -- provided with default definitions in terms of gfoldl, leaving -- open the opportunity to provide datatype-specific definitions. (The -- inclusion of the gmap combinators as members of class -- Data allows the programmer or the compiler to derive -- specialised, and maybe more efficient code per datatype. Note: -- gfoldl is more higher-order than the gmap combinators. -- This is subject to ongoing benchmarking experiments. It might turn out -- that the gmap combinators will be moved out of the class -- Data.) -- -- Conceptually, the definition of the gmap combinators in terms -- of the primitive gfoldl requires the identification of the -- gfoldl function arguments. Technically, we also need to -- identify the type constructor c for the construction of the -- result type from the folded term type. -- -- In the definition of gmapQx combinators, we use -- phantom type constructors for the c in the type of -- gfoldl because the result type of a query does not involve the -- (polymorphic) type of the term argument. In the definition of -- gmapQl we simply use the plain constant type constructor -- because gfoldl is left-associative anyway and so it is readily -- suited to fold a left-associative binary operation over the immediate -- subterms. In the definition of gmapQr, extra effort is needed. We use -- a higher-order accumulation trick to mediate between left-associative -- constructor application vs. right-associative binary operation (e.g., -- (:)). When the query is meant to compute a value of type -- r, then the result type withing generic folding is r -- -> r. So the result of folding is a function to which we -- finally pass the right unit. -- -- With the -XDeriveDataTypeable option, GHC can generate -- instances of the Data class automatically. For example, given -- the declaration -- -- data T a b = C1 a b | C2 deriving (Typeable, Data) -- -- GHC will generate an instance that is equivalent to -- -- instance (Data a, Data b) => Data (T a b) where gfoldl k z (C1 -- a b) = z C1 `k` a `k` b gfoldl k z C2 = z C2 gunfold k z c = case -- constrIndex c of 1 -> k (k (z C1)) 2 -> z C2 toConstr (C1 _ _) = -- con_C1 toConstr C2 = con_C2 dataTypeOf _ = ty_T con_C1 = mkConstr ty_T -- "C1" [] Prefix con_C2 = mkConstr ty_T "C2" [] Prefix ty_T = mkDataType -- "Module.T" [con_C1, con_C2] -- -- This is suitable for datatypes that are exported transparently. class (Typeable a) => Data a -- | The class Typeable allows a concrete representation of a type -- to be calculated. class Typeable a -- | This module re-exports the implicit command line parser. module System.Console.CmdArgs