System.Console.ArgParser.BaseType

Base types shared by several EasyConsole modules.

Documentation

type Arg = String

Simple command line arg

type Args = [Arg]

List of args provided

type Flags = Map Arg Args

Flag collection with corresponding args

type NiceArgs = (Args, Flags)

Structured args to be parsed. Pair of (positionnal arguments, flag arguments)

type ParseResult a = Either String a

Type representing the result of the parse. Right val in case of success or Left msg if there was an error.

data ParamDescr

Data structure describing a parameter

Constructors

ParamDescr

Fields

argUsageFmt :: String -> String

Short description of the parameter format

argCategory :: String

Category of parameter (optional/mandatory)

argFormat :: String -> String

Format of the parameter to provide

argDescr :: String

Description of the parameter

argMetaVar :: String

Description of the parameter in the usage

argUsage :: ParamDescr -> String

Returns a short description of the input format of a parameter.

getArgFormat :: ParamDescr -> String

Returns a long description of the input format of a parameter.

data Parser a

A parser actual function

Constructors

Parser (NiceArgs -> (ParseResult a, NiceArgs))

Instances

Functor Parser

Applicative Parser

data ParserSpec a

Represent a full parameter spec

Constructors

ParserSpec

Fields

getParserParams :: [ParamDescr]

getParserFun :: Parser a

Instances

Functor ParserSpec

Applicative ParserSpec

ParamSpec ParserSpec

type SpecialAction a = CmdLnInterface a -> NiceArgs -> ParseResult a

A special action with more possibilities. The full arg list will be provided, with the command line spec itself.

type SpecialFlag a = (ParserSpec Bool, SpecialAction a)

A special parser allowing to perform standard actions. Used for versionhelpsubparsers.

data CmdLnInterface a

A command line application, with a parser and a description

Constructors

CmdLnInterface

Fields

cmdArgParser :: ParserSpec a

The argument parser

specialFlags :: [SpecialFlag a]

The special flags

getAppName :: String

The application name. Usally the binary name.

getAppVersion :: Maybe String

Optional application version

getAppDescr :: Maybe String

Optional description

getAppEpilog :: Maybe String

Optional epilog