Options.Declarative

Declarative options parser

Command type

class IsCmd c

Command class

Minimal complete definition

runCmd

Instances

IsCmd Group

Defined in Options.Declarative

Methods

getCmdHelp :: Group -> String

getOptDescr :: Group -> [OptDescr (String, String)]

getUsageHeader :: Group -> String -> String

getUsageFooter :: Group -> String -> String

runCmd :: Group -> [String] -> Maybe String -> [(String, String)] -> [String] -> [String] -> IO ()

(KnownSymbol placeholder, ArgRead a, IsCmd c) => IsCmd (Arg placeholder [a] -> c)

Defined in Options.Declarative

Methods

getCmdHelp :: (Arg placeholder [a] -> c) -> String

getOptDescr :: (Arg placeholder [a] -> c) -> [OptDescr (String, String)]

getUsageHeader :: (Arg placeholder [a] -> c) -> String -> String

getUsageFooter :: (Arg placeholder [a] -> c) -> String -> String

runCmd :: (Arg placeholder [a] -> c) -> [String] -> Maybe String -> [(String, String)] -> [String] -> [String] -> IO ()

(KnownSymbol placeholder, IsCmd c) => IsCmd (Arg placeholder String -> c)

Defined in Options.Declarative

Methods

getCmdHelp :: (Arg placeholder String -> c) -> String

getOptDescr :: (Arg placeholder String -> c) -> [OptDescr (String, String)]

getUsageHeader :: (Arg placeholder String -> c) -> String -> String

getUsageFooter :: (Arg placeholder String -> c) -> String -> String

runCmd :: (Arg placeholder String -> c) -> [String] -> Maybe String -> [(String, String)] -> [String] -> [String] -> IO ()

(KnownSymbol placeholder, ArgRead a, IsCmd c) => IsCmd (Arg placeholder a -> c)

Defined in Options.Declarative

Methods

getCmdHelp :: (Arg placeholder a -> c) -> String

getOptDescr :: (Arg placeholder a -> c) -> [OptDescr (String, String)]

getUsageHeader :: (Arg placeholder a -> c) -> String -> String

getUsageFooter :: (Arg placeholder a -> c) -> String -> String

runCmd :: (Arg placeholder a -> c) -> [String] -> Maybe String -> [(String, String)] -> [String] -> [String] -> IO ()

(KnownSymbol shortNames, KnownSymbols longNames, KnownSymbol placeholder, KnownSymbol help, ArgRead a, IsCmd c) => IsCmd (Flag shortNames longNames placeholder help a -> c)

Defined in Options.Declarative

Methods

getCmdHelp :: (Flag shortNames longNames placeholder help a -> c) -> String

getOptDescr :: (Flag shortNames longNames placeholder help a -> c) -> [OptDescr (String, String)]

getUsageHeader :: (Flag shortNames longNames placeholder help a -> c) -> String -> String

getUsageFooter :: (Flag shortNames longNames placeholder help a -> c) -> String -> String

runCmd :: (Flag shortNames longNames placeholder help a -> c) -> [String] -> Maybe String -> [(String, String)] -> [String] -> [String] -> IO ()

KnownSymbol help => IsCmd (Cmd help ())

Defined in Options.Declarative

Methods

getCmdHelp :: Cmd help () -> String

getOptDescr :: Cmd help () -> [OptDescr (String, String)]

getUsageHeader :: Cmd help () -> String -> String

getUsageFooter :: Cmd help () -> String -> String

runCmd :: Cmd help () -> [String] -> Maybe String -> [(String, String)] -> [String] -> [String] -> IO ()

data Cmd (help :: Symbol) a

Command

Instances

Monad (Cmd help)

Defined in Options.Declarative

Methods

(>>=) :: Cmd help a -> (a -> Cmd help b) -> Cmd help b

(>>) :: Cmd help a -> Cmd help b -> Cmd help b

return :: a -> Cmd help a

Functor (Cmd help)

Defined in Options.Declarative

Methods

fmap :: (a -> b) -> Cmd help a -> Cmd help b

(<$) :: a -> Cmd help b -> Cmd help a

MonadFix (Cmd help)

Defined in Options.Declarative

Methods

mfix :: (a -> Cmd help a) -> Cmd help a

MonadFail (Cmd help)

Defined in Options.Declarative

Methods

fail :: String -> Cmd help a

Applicative (Cmd help)

Defined in Options.Declarative

Methods

pure :: a -> Cmd help a

(<*>) :: Cmd help (a -> b) -> Cmd help a -> Cmd help b

liftA2 :: (a -> b -> c) -> Cmd help a -> Cmd help b -> Cmd help c

(*>) :: Cmd help a -> Cmd help b -> Cmd help b

(<*) :: Cmd help a -> Cmd help b -> Cmd help a

MonadIO (Cmd help)

Defined in Options.Declarative

Methods

liftIO :: IO a -> Cmd help a

Alternative (Cmd help)

Defined in Options.Declarative

Methods

empty :: Cmd help a

(<|>) :: Cmd help a -> Cmd help a -> Cmd help a

some :: Cmd help a -> Cmd help [a]

many :: Cmd help a -> Cmd help [a]

MonadPlus (Cmd help)

Defined in Options.Declarative

Methods

mzero :: Cmd help a

mplus :: Cmd help a -> Cmd help a -> Cmd help a

MonadThrow (Cmd help)

Defined in Options.Declarative

Methods

throwM :: Exception e => e -> Cmd help a

MonadCatch (Cmd help)

Defined in Options.Declarative

Methods

catch :: Exception e => Cmd help a -> (e -> Cmd help a) -> Cmd help a

KnownSymbol help => IsCmd (Cmd help ())

Defined in Options.Declarative

Methods

getCmdHelp :: Cmd help () -> String

getOptDescr :: Cmd help () -> [OptDescr (String, String)]

getUsageHeader :: Cmd help () -> String -> String

getUsageFooter :: Cmd help () -> String -> String

runCmd :: Cmd help () -> [String] -> Maybe String -> [(String, String)] -> [String] -> [String] -> IO ()

logStr

Arguments

:: Int

Verbosity Level

-> String

Message

-> Cmd help ()

Output string when the verbosity level is greater than or equal to logLevel

getVerbosity :: Cmd help Int

Return the verbosity level ('--verbosity=n')

getLogger :: MonadIO m => Cmd a (Int -> String -> m ())

Retrieve the logger function

Argument definition tools

class Option a where

Command line option

Associated Types

type Value a :: *

Type of the argument' value

Methods

get :: a -> Value a

Get the argument' value

Instances

Option (Arg _a a)

Defined in Options.Declarative

Associated Types

type Value (Arg _a a)

Methods

get :: Arg _a a -> Value (Arg _a a)

ArgRead a => Option (Flag _a _b _c _d a)

Defined in Options.Declarative

Associated Types

type Value (Flag _a _b _c _d a)

Methods

get :: Flag _a _b _c _d a -> Value (Flag _a _b _c _d a)

data Flag (shortNames :: Symbol) (longNames :: [Symbol]) (placeholder :: Symbol) (help :: Symbol) a

Named argument

Instances

(KnownSymbol shortNames, KnownSymbols longNames, KnownSymbol placeholder, KnownSymbol help, ArgRead a, IsCmd c) => IsCmd (Flag shortNames longNames placeholder help a -> c)

Defined in Options.Declarative

Methods

getCmdHelp :: (Flag shortNames longNames placeholder help a -> c) -> String

getOptDescr :: (Flag shortNames longNames placeholder help a -> c) -> [OptDescr (String, String)]

getUsageHeader :: (Flag shortNames longNames placeholder help a -> c) -> String -> String

getUsageFooter :: (Flag shortNames longNames placeholder help a -> c) -> String -> String

runCmd :: (Flag shortNames longNames placeholder help a -> c) -> [String] -> Maybe String -> [(String, String)] -> [String] -> [String] -> IO ()

ArgRead a => Option (Flag _a _b _c _d a)

Defined in Options.Declarative

Associated Types

type Value (Flag _a _b _c _d a)

Methods

get :: Flag _a _b _c _d a -> Value (Flag _a _b _c _d a)

type Value (Flag _a _b _c _d a)

Defined in Options.Declarative

type Value (Flag _a _b _c _d a) = Unwrap a

data Arg (placeholder :: Symbol) a

Unnamed argument

Instances

(KnownSymbol placeholder, ArgRead a, IsCmd c) => IsCmd (Arg placeholder [a] -> c)

Defined in Options.Declarative

Methods

getCmdHelp :: (Arg placeholder [a] -> c) -> String

getOptDescr :: (Arg placeholder [a] -> c) -> [OptDescr (String, String)]

getUsageHeader :: (Arg placeholder [a] -> c) -> String -> String

getUsageFooter :: (Arg placeholder [a] -> c) -> String -> String

runCmd :: (Arg placeholder [a] -> c) -> [String] -> Maybe String -> [(String, String)] -> [String] -> [String] -> IO ()

(KnownSymbol placeholder, IsCmd c) => IsCmd (Arg placeholder String -> c)

Defined in Options.Declarative

Methods

getCmdHelp :: (Arg placeholder String -> c) -> String

getOptDescr :: (Arg placeholder String -> c) -> [OptDescr (String, String)]

getUsageHeader :: (Arg placeholder String -> c) -> String -> String

getUsageFooter :: (Arg placeholder String -> c) -> String -> String

runCmd :: (Arg placeholder String -> c) -> [String] -> Maybe String -> [(String, String)] -> [String] -> [String] -> IO ()

(KnownSymbol placeholder, ArgRead a, IsCmd c) => IsCmd (Arg placeholder a -> c)

Defined in Options.Declarative

Methods

getCmdHelp :: (Arg placeholder a -> c) -> String

getOptDescr :: (Arg placeholder a -> c) -> [OptDescr (String, String)]

getUsageHeader :: (Arg placeholder a -> c) -> String -> String

getUsageFooter :: (Arg placeholder a -> c) -> String -> String

runCmd :: (Arg placeholder a -> c) -> [String] -> Maybe String -> [(String, String)] -> [String] -> [String] -> IO ()

Option (Arg _a a)

Defined in Options.Declarative

Associated Types

type Value (Arg _a a)

Methods

get :: Arg _a a -> Value (Arg _a a)

type Value (Arg _a a)

Defined in Options.Declarative

type Value (Arg _a a) = a

Defining argument types

class ArgRead a where

Command line option's annotated types

Minimal complete definition

Nothing

Associated Types

type Unwrap a :: *

Type of the argument

type Unwrap a = a

Methods

unwrap :: a -> Unwrap a

Get the argument's value

default unwrap :: a ~ Unwrap a => a -> Unwrap a

argRead :: [String] -> Maybe a

Argument parser

default argRead :: Read a => [String] -> Maybe a

needArg :: Proxy a -> Bool

Indicate this argument is mandatory

Instances

ArgRead Bool

Defined in Options.Declarative

Associated Types

type Unwrap Bool

Methods

unwrap :: Bool -> Unwrap Bool

argRead :: [String] -> Maybe Bool

needArg :: Proxy Bool -> Bool

ArgRead Double

Defined in Options.Declarative

Associated Types

type Unwrap Double

Methods

unwrap :: Double -> Unwrap Double

argRead :: [String] -> Maybe Double

needArg :: Proxy Double -> Bool

ArgRead Int

Defined in Options.Declarative

Associated Types

type Unwrap Int

Methods

unwrap :: Int -> Unwrap Int

argRead :: [String] -> Maybe Int

needArg :: Proxy Int -> Bool

ArgRead Integer

Defined in Options.Declarative

Associated Types

type Unwrap Integer

Methods

unwrap :: Integer -> Unwrap Integer

argRead :: [String] -> Maybe Integer

needArg :: Proxy Integer -> Bool

ArgRead String

Defined in Options.Declarative

Associated Types

type Unwrap String

Methods

unwrap :: String -> Unwrap String

argRead :: [String] -> Maybe String

needArg :: Proxy String -> Bool

ArgRead a => ArgRead [a]

Defined in Options.Declarative

Associated Types

type Unwrap [a]

Methods

unwrap :: [a] -> Unwrap [a]

argRead :: [String] -> Maybe [a]

needArg :: Proxy [a] -> Bool

ArgRead a => ArgRead (Maybe a)

Defined in Options.Declarative

Associated Types

type Unwrap (Maybe a)

Methods

unwrap :: Maybe a -> Unwrap (Maybe a)

argRead :: [String] -> Maybe (Maybe a)

needArg :: Proxy (Maybe a) -> Bool

(KnownSymbol defaultValue, ArgRead a) => ArgRead (Def defaultValue a)

Defined in Options.Declarative

Associated Types

type Unwrap (Def defaultValue a)

Methods

unwrap :: Def defaultValue a -> Unwrap (Def defaultValue a)

argRead :: [String] -> Maybe (Def defaultValue a)

needArg :: Proxy (Def defaultValue a) -> Bool

data Def (defaultValue :: Symbol) a

The argument which has default value

Instances

(KnownSymbol defaultValue, ArgRead a) => ArgRead (Def defaultValue a)

Defined in Options.Declarative

Associated Types

type Unwrap (Def defaultValue a)

Methods

unwrap :: Def defaultValue a -> Unwrap (Def defaultValue a)

argRead :: [String] -> Maybe (Def defaultValue a)

needArg :: Proxy (Def defaultValue a) -> Bool

type Unwrap (Def defaultValue a)

Defined in Options.Declarative

type Unwrap (Def defaultValue a) = Unwrap a

Subcommands support

data Group

Command group

Constructors

Group

Fields

• groupHelp :: String
• groupCmds :: [SubCmd]

Instances

IsCmd Group

Defined in Options.Declarative

Methods

getCmdHelp :: Group -> String

getOptDescr :: Group -> [OptDescr (String, String)]

getUsageHeader :: Group -> String -> String

getUsageFooter :: Group -> String -> String

runCmd :: Group -> [String] -> Maybe String -> [(String, String)] -> [String] -> [String] -> IO ()

data SubCmd

Sub command

subCmd :: IsCmd c => String -> c -> SubCmd

Make a sub command

Run a command

run :: IsCmd c => String -> Maybe String -> c -> IO ()

Run a command with specifying program name and version

run_ :: IsCmd c => c -> IO ()

Run a command