Safe Haskell	None
Language	GHC2021

Futhark.Util.Options

Description

Common code for parsing command line options based on getopt.

Synopsis

type FunOptDescr cfg = OptDescr (Either (IO ()) (cfg -> cfg))
mainWithOptions :: cfg -> [FunOptDescr cfg] -> String -> ([String] -> cfg -> Maybe (IO ())) -> String -> [String] -> IO ()
commonOptions :: String -> String -> [FunOptDescr cfg] -> [FunOptDescr cfg]
optionsError :: String -> IO ()
data OptDescr a = Option [Char] [String] (ArgDescr a) String
getOpt' :: ArgOrder a -> [OptDescr a] -> [String] -> ([a], [String], [String], [String])
data ArgOrder a
- = RequireOrder
- | Permute
- | ReturnInOrder (String -> a)
usageInfo :: String -> [OptDescr a] -> String
data ArgDescr a
- = NoArg a
- | ReqArg (String -> a) String
- | OptArg (Maybe String -> a) String
getOpt :: ArgOrder a -> [OptDescr a] -> [String] -> ([a], [String], [String])

Documentation

type FunOptDescr cfg = OptDescr (Either (IO ()) (cfg -> cfg)) Source #

A command line option that either purely updates a configuration, or performs an IO action (and stops).

mainWithOptions :: cfg -> [FunOptDescr cfg] -> String -> ([String] -> cfg -> Maybe (IO ())) -> String -> [String] -> IO () Source #

Generate a main action that parses the given command line options (while always adding commonOptions).

Common definitions for -v and -h, given the list of all other options.

optionsError :: String -> IO () Source #

Terminate the program with this error message (but don't report it as an ICE, as happens with error).

Constructors

Option [Char] [String] (ArgDescr a) String

Instances details

Functor OptDescr
Instance details Defined in System.Console.GetOpt Methods fmap :: (a -> b) -> OptDescr a -> OptDescr b (<$) :: a -> OptDescr b -> OptDescr a

getOpt' :: ArgOrder a -> [OptDescr a] -> [String] -> ([a], [String], [String], [String]) #

Constructors

Instances details

Functor ArgOrder
Instance details Defined in System.Console.GetOpt Methods fmap :: (a -> b) -> ArgOrder a -> ArgOrder b (<$) :: a -> ArgOrder b -> ArgOrder a

usageInfo :: String -> [OptDescr a] -> String #

Constructors

Instances details

Functor ArgDescr
Instance details Defined in System.Console.GetOpt Methods fmap :: (a -> b) -> ArgDescr a -> ArgDescr b (<$) :: a -> ArgDescr b -> ArgDescr a

getOpt :: ArgOrder a -> [OptDescr a] -> [String] -> ([a], [String], [String]) #