Jukebox.Options

Documentation

data Annotated d p a

Constructors

Annotated

Fields

• descr :: d
• parser :: p a

Instances

Functor p => Functor (Annotated d p)

Defined in Jukebox.Options

Methods

fmap :: (a -> b) -> Annotated d p a -> Annotated d p b

(<$) :: a -> Annotated d p b -> Annotated d p a

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

Defined in Jukebox.Options

Methods

pure :: a -> Annotated d p a

(<*>) :: Annotated d p (a -> b) -> Annotated d p a -> Annotated d p b

liftA2 :: (a -> b -> c) -> Annotated d p a -> Annotated d p b -> Annotated d p c

(*>) :: Annotated d p a -> Annotated d p b -> Annotated d p b

(<*) :: Annotated d p a -> Annotated d p b -> Annotated d p a

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

Defined in Jukebox.Options

Methods

(<>) :: Annotated d p a -> Annotated d p a -> Annotated d p a

sconcat :: NonEmpty (Annotated d p a) -> Annotated d p a

stimes :: Integral b => b -> Annotated d p a -> Annotated d p a

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

Defined in Jukebox.Options

Methods

mempty :: Annotated d p a

mappend :: Annotated d p a -> Annotated d p a -> Annotated d p a

mconcat :: [Annotated d p a] -> Annotated d p a

type ArgParser = Annotated [String] SeqParser

data SeqParser a

Constructors

SeqParser

Fields

• args :: Int
• consume :: [String] -> Either Error a

Instances

Functor SeqParser

Defined in Jukebox.Options

Methods

fmap :: (a -> b) -> SeqParser a -> SeqParser b

(<$) :: a -> SeqParser b -> SeqParser a

Applicative SeqParser

Defined in Jukebox.Options

Methods

pure :: a -> SeqParser a

(<*>) :: SeqParser (a -> b) -> SeqParser a -> SeqParser b

liftA2 :: (a -> b -> c) -> SeqParser a -> SeqParser b -> SeqParser c

(*>) :: SeqParser a -> SeqParser b -> SeqParser b

(<*) :: SeqParser a -> SeqParser b -> SeqParser a

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

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

argFile :: ArgParser FilePath

argFiles :: ArgParser [FilePath]

argName :: ArgParser String

argNums :: ArgParser [Int]

argOption :: [(String, a)] -> ArgParser a

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

argOptionWith :: String -> String -> String -> [String] -> (String -> Maybe a) -> ArgParser a

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

type OptionParser = Annotated [Flag] ParParser

data Flag

Constructors

Flag

Fields

• flagName :: String
• flagGroup :: String
• flagMode :: FlagMode
• flagHelp :: [String]
• flagArgs :: String

Instances

Eq Flag

Defined in Jukebox.Options

Methods

(==) :: Flag -> Flag -> Bool

(/=) :: Flag -> Flag -> Bool

Show Flag

Defined in Jukebox.Options

Methods

showsPrec :: Int -> Flag -> ShowS

show :: Flag -> String

showList :: [Flag] -> ShowS

data FlagMode

Constructors

NormalMode

ExpertMode

HiddenMode

Instances

Eq FlagMode

Defined in Jukebox.Options

Methods

(==) :: FlagMode -> FlagMode -> Bool

(/=) :: FlagMode -> FlagMode -> Bool

Show FlagMode

Defined in Jukebox.Options

Methods

showsPrec :: Int -> FlagMode -> ShowS

show :: FlagMode -> String

showList :: [FlagMode] -> ShowS

flagExpert :: Flag -> Bool

data ParParser a

Constructors

ParParser

Fields

• val :: IO a
• peek :: [String] -> ParseResult a

Instances

Functor ParParser

Defined in Jukebox.Options

Methods

fmap :: (a -> b) -> ParParser a -> ParParser b

(<$) :: a -> ParParser b -> ParParser a

Applicative ParParser

Defined in Jukebox.Options

Methods

pure :: a -> ParParser a

(<*>) :: ParParser (a -> b) -> ParParser a -> ParParser b

liftA2 :: (a -> b -> c) -> ParParser a -> ParParser b -> ParParser c

(*>) :: ParParser a -> ParParser b -> ParParser b

(<*) :: ParParser a -> ParParser b -> ParParser a

data ParseResult a

Constructors

Yes Int (ParParser a)

No (ParParser a)

Error Error

Instances

Functor ParseResult

Defined in Jukebox.Options

Methods

fmap :: (a -> b) -> ParseResult a -> ParseResult b

(<$) :: a -> ParseResult b -> ParseResult a

Applicative ParseResult

Defined in Jukebox.Options

Methods

pure :: a -> ParseResult a

(<*>) :: ParseResult (a -> b) -> ParseResult a -> ParseResult b

liftA2 :: (a -> b -> c) -> ParseResult a -> ParseResult b -> ParseResult c

(*>) :: ParseResult a -> ParseResult b -> ParseResult b

(<*) :: ParseResult a -> ParseResult b -> ParseResult a

data Error

Constructors

Mistake String

Usage ExitCode [String]

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

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

primFlag :: String -> [String] -> (String -> Bool) -> (a -> a -> Either Error a) -> a -> ArgParser (String -> a) -> OptionParser a

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

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

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

filenames :: OptionParser [String]

io :: IO a -> OptionParser a

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

expert :: OptionParser a -> OptionParser a

hidden :: OptionParser a -> OptionParser a

version :: String -> OptionParser a -> OptionParser a

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

printError :: String -> String -> IO a

help :: String -> String -> OptionParser a -> OptionParser a

usageText :: String -> String -> [String]

helpText :: Bool -> String -> String -> OptionParser a -> [String]

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

parseCommandLine :: String -> OptionParser a -> IO a

parseCommandLineWithExtraArgs :: [String] -> String -> OptionParser a -> IO a

parseCommandLineWithArgs :: String -> [String] -> String -> OptionParser a -> IO a