Safe Haskell	None
Language	Haskell2010

Options.Declarative

Contents

Command type
Argument definition tools
Defining argment types
Subcommands support
Run a command

Description

Declarative options parser

Synopsis

class IsCmd c
data Cmd (help :: Symbol) a
logStr :: Int -> String -> Cmd help ()
getVerbosity :: Cmd help Int
getLogger :: MonadIO m => Cmd a (Int -> String -> m ())
class Option a where
- type Value a :: *
- get :: a -> Value a
data Flag (shortNames :: Symbol) (longNames :: [Symbol]) (placeholder :: Symbol) (help :: Symbol) a
data Arg (placeholder :: Symbol) a
class ArgRead a where
- type Unwrap a :: *
- unwrap :: a -> Unwrap a
- argRead :: Maybe String -> Maybe a
- needArg :: Proxy a -> Bool
data Def (defaultValue :: Symbol) a
data Group = Group {
- groupHelp :: String
- groupCmds :: [SubCmd]
}
data SubCmd
subCmd :: IsCmd c => String -> c -> SubCmd
run :: IsCmd c => String -> Maybe String -> c -> IO ()
run_ :: IsCmd c => c -> IO ()

Command type

class IsCmd c Source #

Command class

Minimal complete definition

runCmd

Instances

IsCmd Group Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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 ()) Source #
Instance details 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 Source #

Command

Instances

Monad (Cmd help) Source #
Instance details 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 # fail :: String -> Cmd help a #
Functor (Cmd help) Source #
Instance details Defined in Options.Declarative Methods fmap :: (a -> b) -> Cmd help a -> Cmd help b # (<$) :: a -> Cmd help b -> Cmd help a #
Applicative (Cmd help) Source #
Instance details 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) Source #
Instance details Defined in Options.Declarative Methods liftIO :: IO a -> Cmd help a #
KnownSymbol help => IsCmd (Cmd help ()) Source #
Instance details 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 Source #

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 Source #

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

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

Retrieve the logger function

Argument definition tools

class Option a where Source #

Command line option

Associated Types

type Value a :: * Source #

Type of the argument' value

Methods

get :: a -> Value a Source #

Get the argument' value

Instances

Option (Arg _a a) Source #
Instance details Defined in Options.Declarative Associated Types type Value (Arg _a a) :: Type Source # Methods get :: Arg _a a -> Value (Arg _a a) Source #
ArgRead a => Option (Flag _a _b _c _d a) Source #
Instance details Defined in Options.Declarative Associated Types type Value (Flag _a _b _c _d a) :: Type Source # Methods get :: Flag _a _b _c _d a -> Value (Flag _a _b _c _d a) Source #

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

Named argument

Instances

(KnownSymbol shortNames, KnownSymbols longNames, KnownSymbol placeholder, KnownSymbol help, ArgRead a, IsCmd c) => IsCmd (Flag shortNames longNames placeholder help a -> c) Source #
Instance details 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) Source #
Instance details Defined in Options.Declarative Associated Types type Value (Flag _a _b _c _d a) :: Type Source # Methods get :: Flag _a _b _c _d a -> Value (Flag _a _b _c _d a) Source #
type Value (Flag _a _b _c _d a) Source #
Instance details Defined in Options.Declarative type Value (Flag _a _b _c _d a) = Unwrap a

data Arg (placeholder :: Symbol) a Source #

Unnamed argument

Instances

(KnownSymbol placeholder, ArgRead a, IsCmd c) => IsCmd (Arg placeholder [a] -> c) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Options.Declarative Associated Types type Value (Arg _a a) :: Type Source # Methods get :: Arg _a a -> Value (Arg _a a) Source #
type Value (Arg _a a) Source #
Instance details Defined in Options.Declarative type Value (Arg _a a) = a

Defining argment types

class ArgRead a where Source #

Command line option's annotated types

Minimal complete definition

Nothing

Associated Types

type Unwrap a :: * Source #

Type of the argument

Methods

unwrap :: a -> Unwrap a Source #

Get the argument's value

unwrap :: a ~ Unwrap a => a -> Unwrap a Source #

Get the argument's value

argRead :: Maybe String -> Maybe a Source #

Argument parser

argRead :: Read a => Maybe String -> Maybe a Source #

Argument parser

needArg :: Proxy a -> Bool Source #

Indicate this argument is mandatory

Instances

ArgRead Bool Source #
Instance details Defined in Options.Declarative Associated Types type Unwrap Bool :: Type Source # Methods unwrap :: Bool -> Unwrap Bool Source # argRead :: Maybe String -> Maybe Bool Source # needArg :: Proxy Bool -> Bool Source #
ArgRead Double Source #
Instance details Defined in Options.Declarative Associated Types type Unwrap Double :: Type Source # Methods unwrap :: Double -> Unwrap Double Source # argRead :: Maybe String -> Maybe Double Source # needArg :: Proxy Double -> Bool Source #
ArgRead Int Source #
Instance details Defined in Options.Declarative Associated Types type Unwrap Int :: Type Source # Methods unwrap :: Int -> Unwrap Int Source # argRead :: Maybe String -> Maybe Int Source # needArg :: Proxy Int -> Bool Source #
ArgRead Integer Source #
Instance details Defined in Options.Declarative Associated Types type Unwrap Integer :: Type Source # Methods unwrap :: Integer -> Unwrap Integer Source # argRead :: Maybe String -> Maybe Integer Source # needArg :: Proxy Integer -> Bool Source #
ArgRead String Source #
Instance details Defined in Options.Declarative Associated Types type Unwrap String :: Type Source # Methods unwrap :: String -> Unwrap String Source # argRead :: Maybe String -> Maybe String Source # needArg :: Proxy String -> Bool Source #
ArgRead a => ArgRead (Maybe a) Source #
Instance details Defined in Options.Declarative Associated Types type Unwrap (Maybe a) :: Type Source # Methods unwrap :: Maybe a -> Unwrap (Maybe a) Source # argRead :: Maybe String -> Maybe (Maybe a) Source # needArg :: Proxy (Maybe a) -> Bool Source #
(KnownSymbol defaultValue, ArgRead a) => ArgRead (Def defaultValue a) Source #
Instance details Defined in Options.Declarative Associated Types type Unwrap (Def defaultValue a) :: Type Source # Methods unwrap :: Def defaultValue a -> Unwrap (Def defaultValue a) Source # argRead :: Maybe String -> Maybe (Def defaultValue a) Source # needArg :: Proxy (Def defaultValue a) -> Bool Source #

data Def (defaultValue :: Symbol) a Source #

The argument which has defalut value

Instances

(KnownSymbol defaultValue, ArgRead a) => ArgRead (Def defaultValue a) Source #
Instance details Defined in Options.Declarative Associated Types type Unwrap (Def defaultValue a) :: Type Source # Methods unwrap :: Def defaultValue a -> Unwrap (Def defaultValue a) Source # argRead :: Maybe String -> Maybe (Def defaultValue a) Source # needArg :: Proxy (Def defaultValue a) -> Bool Source #
type Unwrap (Def defaultValue a) Source #
Instance details Defined in Options.Declarative type Unwrap (Def defaultValue a) = Unwrap a

Subcommands support

data Group Source #

Command group

Constructors

Group
Fields groupHelp :: String groupCmds :: [SubCmd]

Instances

IsCmd Group Source #
Instance details 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 Source #

Sub command

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

Make a sub command

Run a command

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

Run a command with specifying program name and version

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

Run a command