Jukebox.Options

Documentation

data Annotated d p a

Constructors

Annotated

Fields

descr :: d

parser :: p a

Instances

Functor p => Functor (Annotated d p)

(Monoid d, Applicative p) => Applicative (Annotated d p)

(Monoid d, Monoid (p a)) => Monoid (Annotated d p a)

type ArgParser = Annotated ArgDesc SeqParser

type ArgDesc = String

data SeqParser a

Constructors

SeqParser

Fields

args :: Int

consume :: [String] -> Either Error a

Instances

Functor SeqParser

Applicative SeqParser

arg :: ArgDesc -> String -> (String -> Maybe a) -> ArgParser a

argNum :: (Read a, Num a) => ArgParser a

argFile :: ArgParser FilePath

argFiles :: ArgParser [FilePath]

argName :: ArgParser FilePath

argNums :: ArgParser [Int]

argOption :: [String] -> ArgParser String

argList :: [String] -> ArgParser [String]

argUsage :: ExitCode -> [String] -> ArgParser a

type OptionParser = Annotated [Flag] ParParser

data ParParser a

Constructors

ParParser

Fields

val :: IO a

peek :: [String] -> ParseResult a

Instances

Functor ParParser

Applicative ParParser

data ParseResult a

Constructors

Yes Int (ParParser a)

No (ParParser a)

Error Error

Instances

Functor ParseResult

Applicative ParseResult

data Error

Constructors

Mistake String

Usage ExitCode [String]

runPar :: ParParser a -> [String] -> Either Error (IO a)

awaitP :: (String -> Bool) -> a -> (String -> [String] -> ParseResult a) -> ParParser a

await :: String -> a -> ([String] -> ParseResult a) -> ParParser a

data Flag

Constructors

Flag

Fields

flagName :: String

flagGroup :: String

flagHelp :: [String]

flagArgs :: String

Instances

Eq Flag

Show Flag

flag :: String -> [String] -> a -> ArgParser a -> OptionParser a

manyFlags :: String -> [String] -> ArgParser a -> OptionParser [a]

filenames :: OptionParser [String]

io :: IO a -> OptionParser a

bool :: String -> [String] -> OptionParser Bool

inGroup :: String -> OptionParser a -> OptionParser a

type ToolParser = Annotated [Tool] PrefixParser

data Tool

Constructors

Tool

Fields

toolProgName :: String

toolName :: String

toolVersion :: String

toolHelp :: String

newtype PrefixParser a

Constructors

PrefixParser (String -> Maybe (Tool, ParParser a))

Instances

Functor PrefixParser

Monoid (PrefixParser a)

runPref :: PrefixParser a -> [String] -> Either Error (IO a)

tool :: Tool -> OptionParser a -> ToolParser a

getEffectiveArgs :: ToolParser a -> IO [String]

parseCommandLine :: Tool -> ToolParser a -> IO a

printHelp :: ExitCode -> [String] -> IO a

argError :: Tool -> String -> [String]

usageTool :: Tool -> String -> [String] -> String -> ToolParser a

versionTool :: Tool -> ToolParser a

helpTool :: Tool -> ToolParser a -> ToolParser a

help :: Tool -> OptionParser a -> [String]

greeting :: Tool -> String

usage :: Tool -> String -> [String]

justify :: String -> [String] -> [String]