wizards-1.0.2: High level, generic library for interrogative user interfaces

Safe HaskellTrustworthy
LanguageHaskell98

System.Console.Wizard

Contents

Synopsis

Wizards

newtype Wizard backend a Source #

A Wizard b a is a conversation with the user via back-end b that will result in a data type a, or may fail. A Wizard is made up of one or more "primitives" (see below), composed using the Applicative, Monad and Alternative instances. The Alternative instance is, as you might expect, a maybe-style cascade. If the first wizard fails, the next one is tried. mzero can be used to induce failure directly.

The Wizard constructor is exported here for use when developing backends, but it is better for end-users to simply pretend that Wizard is an opaque data type. Don't depend on this unless you have no other choice.

Wizards are, internally, just a maybe transformer over a free monad built from some coproduct of functors, each of which is a primitive action.

Constructors

Wizard (MaybeT (Free backend) a) 

Instances

Functor backend => Monad (Wizard backend) Source # 

Methods

(>>=) :: Wizard backend a -> (a -> Wizard backend b) -> Wizard backend b #

(>>) :: Wizard backend a -> Wizard backend b -> Wizard backend b #

return :: a -> Wizard backend a #

fail :: String -> Wizard backend a #

Functor backend => Functor (Wizard backend) Source # 

Methods

fmap :: (a -> b) -> Wizard backend a -> Wizard backend b #

(<$) :: a -> Wizard backend b -> Wizard backend a #

Functor backend => Applicative (Wizard backend) Source # 

Methods

pure :: a -> Wizard backend a #

(<*>) :: Wizard backend (a -> b) -> Wizard backend a -> Wizard backend b #

(*>) :: Wizard backend a -> Wizard backend b -> Wizard backend b #

(<*) :: Wizard backend a -> Wizard backend b -> Wizard backend a #

Functor backend => Alternative (Wizard backend) Source # 

Methods

empty :: Wizard backend a #

(<|>) :: Wizard backend a -> Wizard backend a -> Wizard backend a #

some :: Wizard backend a -> Wizard backend [a] #

many :: Wizard backend a -> Wizard backend [a] #

Functor backend => MonadPlus (Wizard backend) Source # 

Methods

mzero :: Wizard backend a #

mplus :: Wizard backend a -> Wizard backend a -> Wizard backend a #

type PromptString = String Source #

A string for a prompt

run :: (Functor f, Monad b, Run b f) => Wizard f a -> b (Maybe a) Source #

Run a wizard using some back-end.

class (Functor sub, Functor sup) => sub :<: sup Source #

Subsumption of two functors. You shouldn't define any of your own instances of this when writing back-ends, rely only on GeneralizedNewtypeDeriving.

Minimal complete definition

inj

Instances

Functor f => f :<: f Source # 

Methods

inj :: f a -> f a

ArbitraryIO :<: BasicIO Source # 

Methods

inj :: ArbitraryIO a -> BasicIO a

ArbitraryIO :<: Haskeline Source # 

Methods

inj :: ArbitraryIO a -> Haskeline a

Password :<: Haskeline Source # 

Methods

inj :: Password a -> Haskeline a

LinePrewritten :<: Haskeline Source # 

Methods

inj :: LinePrewritten a -> Haskeline a

Character :<: BasicIO Source # 

Methods

inj :: Character a -> BasicIO a

Character :<: Haskeline Source # 

Methods

inj :: Character a -> Haskeline a

Character :<: Pure Source # 

Methods

inj :: Character a -> Pure a

Line :<: BasicIO Source # 

Methods

inj :: Line a -> BasicIO a

Line :<: Haskeline Source # 

Methods

inj :: Line a -> Haskeline a

Line :<: Pure Source # 

Methods

inj :: Line a -> Pure a

OutputLn :<: BasicIO Source # 

Methods

inj :: OutputLn a -> BasicIO a

OutputLn :<: Haskeline Source # 

Methods

inj :: OutputLn a -> Haskeline a

OutputLn :<: Pure Source # 

Methods

inj :: OutputLn a -> Pure a

Output :<: BasicIO Source # 

Methods

inj :: Output a -> BasicIO a

Output :<: Haskeline Source # 

Methods

inj :: Output a -> Haskeline a

Output :<: Pure Source # 

Methods

inj :: Output a -> Pure a

WithSettings :<: Haskeline Source # 

Methods

inj :: WithSettings a -> Haskeline a

(Functor f, Functor g, Functor h, (:<:) f g) => f :<: ((:+:) h g) Source # 

Methods

inj :: f a -> (h :+: g) a

(Functor f, Functor g) => f :<: ((:+:) f g) Source # 

Methods

inj :: f a -> (f :+: g) a

data (f :+: g) w infixr 9 Source #

Coproduct of two functors

Instances

(Run b f, Run b g) => Run b ((:+:) f g) Source # 

Methods

runAlgebra :: (f :+: g) (b v) -> b v Source #

(Functor f, Functor g, Functor h, (:<:) f g) => f :<: ((:+:) h g) Source # 

Methods

inj :: f a -> (h :+: g) a

(Functor f, Functor g) => f :<: ((:+:) f g) Source # 

Methods

inj :: f a -> (f :+: g) a

(Functor g, Functor f) => Functor ((:+:) f g) Source # 

Methods

fmap :: (a -> b) -> (f :+: g) a -> (f :+: g) b #

(<$) :: a -> (f :+: g) b -> (f :+: g) a #

Primitives

Primitives are the basic building blocks for wizards. Use these functions to produce wizards that ask for input from the user, or output information.

data Line w Source #

Instances

Functor Line Source # 

Methods

fmap :: (a -> b) -> Line a -> Line b #

(<$) :: a -> Line b -> Line a #

Line :<: BasicIO Source # 

Methods

inj :: Line a -> BasicIO a

Line :<: Haskeline Source # 

Methods

inj :: Line a -> Haskeline a

Line :<: Pure Source # 

Methods

inj :: Line a -> Pure a

line :: Line :<: b => PromptString -> Wizard b String Source #

Read one line of input from the user. Cannot fail (but may throw exceptions, depending on the backend).

linePrewritten Source #

Arguments

:: LinePrewritten :<: b 
=> PromptString 
-> String

Text to the left of the cursor

-> String

Text to the right of the cursor

-> Wizard b String 

Read one line of input, with some default text already present, before and/or after the editing cursor.

data Password w Source #

Instances

Functor Password Source # 

Methods

fmap :: (a -> b) -> Password a -> Password b #

(<$) :: a -> Password b -> Password a #

Password :<: Haskeline Source # 

Methods

inj :: Password a -> Haskeline a

password Source #

Arguments

:: Password :<: b 
=> PromptString 
-> Maybe Char

Mask character, if any.

-> Wizard b String 

Read one line of password input, with an optional mask character.

data Character w Source #

Instances

character :: Character :<: b => PromptString -> Wizard b Char Source #

Read a single character only from input. Cannot fail (but may throw exceptions, depending on the backend).

data Output w Source #

Instances

Functor Output Source # 

Methods

fmap :: (a -> b) -> Output a -> Output b #

(<$) :: a -> Output b -> Output a #

Output :<: BasicIO Source # 

Methods

inj :: Output a -> BasicIO a

Output :<: Haskeline Source # 

Methods

inj :: Output a -> Haskeline a

Output :<: Pure Source # 

Methods

inj :: Output a -> Pure a

output :: Output :<: b => String -> Wizard b () Source #

Output a string. Does not fail.

data OutputLn w Source #

Instances

Functor OutputLn Source # 

Methods

fmap :: (a -> b) -> OutputLn a -> OutputLn b #

(<$) :: a -> OutputLn b -> OutputLn a #

OutputLn :<: BasicIO Source # 

Methods

inj :: OutputLn a -> BasicIO a

OutputLn :<: Haskeline Source # 

Methods

inj :: OutputLn a -> Haskeline a

OutputLn :<: Pure Source # 

Methods

inj :: OutputLn a -> Pure a

outputLn :: OutputLn :<: b => String -> Wizard b () Source #

Output a string followed by a newline. Does not fail.

Modifiers

Modifiers change the behaviour of existing wizards.

retry :: Functor b => Wizard b a -> Wizard b a Source #

Retry produces a wizard that will retry the entire conversation again if it fails. It is simply retry x = x <|> retry x.

retryMsg :: OutputLn :<: b => String -> Wizard b a -> Wizard b a Source #

Same as retry, except an error message can be specified.

defaultTo :: Functor b => Wizard b a -> a -> Wizard b a Source #

x `defaultTo` y will return y if x fails, e.g parseRead line `defaultTo` 0.

parser :: Functor b => (a -> Maybe c) -> Wizard b a -> Wizard b c Source #

Like fmap, except the function may be partial (Nothing causes the wizard to fail).

validator :: Functor b => (a -> Bool) -> Wizard b a -> Wizard b a Source #

validator p causes a wizard to fail if the output value does not satisfy the predicate p.

Convenience

nonEmpty :: Functor b => Wizard b [a] -> Wizard b [a] Source #

Simply validator (not . null), makes a wizard fail if it gets an empty string.

inRange :: (Ord a, Functor b) => (a, a) -> Wizard b a -> Wizard b a Source #

Makes a wizard fail if it gets an ordered quantity outside of the given range.

parseRead :: (Read a, Functor b) => Wizard b String -> Wizard b a Source #

Simply parser readP. Attaches a simple read parser to a Wizard.

Utility

liftMaybe :: Functor b => Maybe a -> Wizard b a Source #

Translate a maybe value into wizard success/failure.

ensure :: (a -> Bool) -> a -> Maybe a Source #

Ensures that a maybe value satisfies a given predicate.

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

A read-based parser for the parser modifier.

Orphan instances

(:<:) ArbitraryIO b => MonadIO (Wizard b) Source # 

Methods

liftIO :: IO a -> Wizard b a #