System.REPL.Types

Types used by other modules in the package.

The module contains the following exception hierarchy:

• SomeREPLError

  • SomeAskerError

    • AskerTypeError
    • AskerPredicateError
    • AskerInputAbortedError

  • SomeCommandError

    • MalformedParamsError
    • TooFewParamsError
    • TooManyParamsError
• NoConfigFileParseError

Documentation

type TypeError = SomeException

An error message indicating that a value wasn't able to be parsed.

type PredicateError = SomeException

An error message indicating that a value failed a predicate.

type PromptMsg = Text

A prompt.

type Predicate m a b = a -> m (Either PredicateError b)

A predicate which a value has to fulfil.

type Predicate' m a = Predicate m a a

A predicate which does not change the type of its input.

type Parser a = Text -> Either TypeError a

A parser which either returns a parsed value or an error message.

data Asker m a b

The description of an 'ask for user input'-action. The type parameters are the used monad (typically IO or ExceptT), the type of the read value and the type of the error that is thrown in case of failures.

The components are a prompt, a parser, and a predicate that the parsed value must fulfil. The predicate

• is monadic and
• can change the returned type (useful for adjoining additional information)

Constructors

Asker

Fields

• askerPrompt :: Text

  The prompt to be displayed to the user.

• askerParser :: Parser a

  The parser for the input value.

• askerPredicate :: Predicate m a b

  The predicate which the input, once read, must fulfill. The Left side is an error message.

type Asker' m a = Asker m a a

An Asker which does not convert its argument into a different type after parsing.

data SomeREPLError

Root of the exception hierarchy.

Constructors

Exception e => SomeREPLError e

Instances

Show SomeREPLError

Methods

showsPrec :: Int -> SomeREPLError -> ShowS

show :: SomeREPLError -> String

showList :: [SomeREPLError] -> ShowS

Exception SomeREPLError

Methods

toException :: SomeREPLError -> SomeException

fromException :: SomeException -> Maybe SomeREPLError

displayException :: SomeREPLError -> String

replErrorUpcast :: Exception a => a -> SomeException

replErrorDowncast :: Exception a => SomeException -> Maybe a

data SomeAskerError

Generic error related to Askers. Either the input was incorrect in some way, or the process was aborted by the user.

Constructors

Exception e => SomeAskerError e

Instances

Show SomeAskerError

Methods

showsPrec :: Int -> SomeAskerError -> ShowS

show :: SomeAskerError -> String

showList :: [SomeAskerError] -> ShowS

Exception SomeAskerError

Methods

toException :: SomeAskerError -> SomeException

fromException :: SomeException -> Maybe SomeAskerError

displayException :: SomeAskerError -> String

askerErrorUpcast :: Exception a => a -> SomeException

askerErrorDowncast :: Exception a => SomeException -> Maybe a

data AskerTypeError

The input could not be parsed.

Constructors

AskerTypeError SomeException

Instances

Show AskerTypeError

Methods

showsPrec :: Int -> AskerTypeError -> ShowS

show :: AskerTypeError -> String

showList :: [AskerTypeError] -> ShowS

Exception AskerTypeError

Methods

toException :: AskerTypeError -> SomeException

fromException :: SomeException -> Maybe AskerTypeError

displayException :: AskerTypeError -> String

data AskerPredicateError

The parsed value failed a predicate.

Constructors

AskerPredicateError SomeException

Instances

Show AskerPredicateError

Methods

showsPrec :: Int -> AskerPredicateError -> ShowS

show :: AskerPredicateError -> String

showList :: [AskerPredicateError] -> ShowS

Exception AskerPredicateError

Methods

toException :: AskerPredicateError -> SomeException

fromException :: SomeException -> Maybe AskerPredicateError

displayException :: AskerPredicateError -> String

data AskerInputAbortedError

The input for an Asker was aborted by the user.

Constructors

AskerInputAbortedError

Instances

Show AskerInputAbortedError

Methods

showsPrec :: Int -> AskerInputAbortedError -> ShowS

show :: AskerInputAbortedError -> String

showList :: [AskerInputAbortedError] -> ShowS

Exception AskerInputAbortedError

Methods

toException :: AskerInputAbortedError -> SomeException

fromException :: SomeException -> Maybe AskerInputAbortedError

displayException :: AskerInputAbortedError -> String

data GenericTypeError

A generic type failure for use with Askers.

Constructors

GenericTypeError Text

Instances

Eq GenericTypeError

Methods

(==) :: GenericTypeError -> GenericTypeError -> Bool

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

Show GenericTypeError

Methods

showsPrec :: Int -> GenericTypeError -> ShowS

show :: GenericTypeError -> String

showList :: [GenericTypeError] -> ShowS

Exception GenericTypeError

Methods

toException :: GenericTypeError -> SomeException

fromException :: SomeException -> Maybe GenericTypeError

displayException :: GenericTypeError -> String

genericTypeError :: Text -> SomeException

Constructor for GenericTypeError which wraps the value into a SomeException.

data GenericPredicateError

A generic predicate failure for use with Askers.

Constructors

GenericPredicateError Text

Instances

Eq GenericPredicateError

Methods

(==) :: GenericPredicateError -> GenericPredicateError -> Bool

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

Show GenericPredicateError

Methods

showsPrec :: Int -> GenericPredicateError -> ShowS

show :: GenericPredicateError -> String

showList :: [GenericPredicateError] -> ShowS

Exception GenericPredicateError

Methods

toException :: GenericPredicateError -> SomeException

fromException :: SomeException -> Maybe GenericPredicateError

displayException :: GenericPredicateError -> String

genericPredicateError :: Text -> SomeException

Constructor for GenericTypeError which wraps the value into a SomeException.

newtype Verbatim

A verbatim Text whose Read instance simply returns the read string, as-is. This is useful for askers which ask for strings without quotes.

Constructors

Verbatim

Fields

• fromVerbatim :: Text

Instances

Read Verbatim

Read-instance for Verbatim. Wraps the given value into quotes and reads it a a Text.

Methods

readsPrec :: Int -> ReadS Verbatim

readList :: ReadS [Verbatim]

readPrec :: ReadPrec Verbatim

readListPrec :: ReadPrec [Verbatim]

data PathExistenceType

Indicates whether the target of a path exists and what form it has.

Constructors

IsDirectory

IsFile

DoesNotExist

Instances

Bounded PathExistenceType

Methods

minBound :: PathExistenceType

maxBound :: PathExistenceType

Enum PathExistenceType

Methods

succ :: PathExistenceType -> PathExistenceType

pred :: PathExistenceType -> PathExistenceType

toEnum :: Int -> PathExistenceType

fromEnum :: PathExistenceType -> Int

enumFrom :: PathExistenceType -> [PathExistenceType]

enumFromThen :: PathExistenceType -> PathExistenceType -> [PathExistenceType]

enumFromTo :: PathExistenceType -> PathExistenceType -> [PathExistenceType]

enumFromThenTo :: PathExistenceType -> PathExistenceType -> PathExistenceType -> [PathExistenceType]

Eq PathExistenceType

Methods

(==) :: PathExistenceType -> PathExistenceType -> Bool

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

Ord PathExistenceType

Methods

compare :: PathExistenceType -> PathExistenceType -> Ordering

(<) :: PathExistenceType -> PathExistenceType -> Bool

(<=) :: PathExistenceType -> PathExistenceType -> Bool

(>) :: PathExistenceType -> PathExistenceType -> Bool

(>=) :: PathExistenceType -> PathExistenceType -> Bool

max :: PathExistenceType -> PathExistenceType -> PathExistenceType

min :: PathExistenceType -> PathExistenceType -> PathExistenceType

Read PathExistenceType

Methods

readsPrec :: Int -> ReadS PathExistenceType

readList :: ReadS [PathExistenceType]

readPrec :: ReadPrec PathExistenceType

readListPrec :: ReadPrec [PathExistenceType]

Show PathExistenceType

Methods

showsPrec :: Int -> PathExistenceType -> ShowS

show :: PathExistenceType -> String

showList :: [PathExistenceType] -> ShowS

data PathRootDoesNotExist

Indicates that no part of a path exists.

Constructors

PathRootDoesNotExist FilePath

Instances

Eq PathRootDoesNotExist

Methods

(==) :: PathRootDoesNotExist -> PathRootDoesNotExist -> Bool

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

Show PathRootDoesNotExist

Methods

showsPrec :: Int -> PathRootDoesNotExist -> ShowS

show :: PathRootDoesNotExist -> String

showList :: [PathRootDoesNotExist] -> ShowS

Exception PathRootDoesNotExist

Methods

toException :: PathRootDoesNotExist -> SomeException

fromException :: SomeException -> Maybe PathRootDoesNotExist

displayException :: PathRootDoesNotExist -> String

data PathIsNotWritable

Indicates that the last existing portion of a path is not writable.

Constructors

PathIsNotWritable FilePath

Instances

Eq PathIsNotWritable

Methods

(==) :: PathIsNotWritable -> PathIsNotWritable -> Bool

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

Show PathIsNotWritable

Methods

showsPrec :: Int -> PathIsNotWritable -> ShowS

show :: PathIsNotWritable -> String

showList :: [PathIsNotWritable] -> ShowS

Exception PathIsNotWritable

Methods

toException :: PathIsNotWritable -> SomeException

fromException :: SomeException -> Maybe PathIsNotWritable

displayException :: PathIsNotWritable -> String

data SomeCommandError

Generic error related to command execution.

Constructors

Exception e => SomeCommandError e

Instances

Show SomeCommandError

Methods

showsPrec :: Int -> SomeCommandError -> ShowS

show :: SomeCommandError -> String

showList :: [SomeCommandError] -> ShowS

Exception SomeCommandError

Methods

toException :: SomeCommandError -> SomeException

fromException :: SomeException -> Maybe SomeCommandError

displayException :: SomeCommandError -> String

commandErrorUpcast :: Exception a => a -> SomeException

commandErrorDowncast :: Exception a => SomeException -> Maybe a

data MalformedParamsError

The input of a command was malformed and could not be interpreted. I.e. the input contained inadmissible characters, or quotes were mismatched. The Text argument contains the parser error.

Constructors

MalformedParamsError Text

Instances

Eq MalformedParamsError

Methods

(==) :: MalformedParamsError -> MalformedParamsError -> Bool

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

Ord MalformedParamsError

Methods

compare :: MalformedParamsError -> MalformedParamsError -> Ordering

(<) :: MalformedParamsError -> MalformedParamsError -> Bool

(<=) :: MalformedParamsError -> MalformedParamsError -> Bool

(>) :: MalformedParamsError -> MalformedParamsError -> Bool

(>=) :: MalformedParamsError -> MalformedParamsError -> Bool

max :: MalformedParamsError -> MalformedParamsError -> MalformedParamsError

min :: MalformedParamsError -> MalformedParamsError -> MalformedParamsError

Show MalformedParamsError

Methods

showsPrec :: Int -> MalformedParamsError -> ShowS

show :: MalformedParamsError -> String

showList :: [MalformedParamsError] -> ShowS

Exception MalformedParamsError

Methods

toException :: MalformedParamsError -> SomeException

fromException :: SomeException -> Maybe MalformedParamsError

displayException :: MalformedParamsError -> String

data TooManyParamsError

Too many parameters were given to a command. The first value is the maximum, the second the actual number.

Constructors

TooManyParamsError Int Int

Instances

Eq TooManyParamsError

Methods

(==) :: TooManyParamsError -> TooManyParamsError -> Bool

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

Ord TooManyParamsError

Methods

compare :: TooManyParamsError -> TooManyParamsError -> Ordering

(<) :: TooManyParamsError -> TooManyParamsError -> Bool

(<=) :: TooManyParamsError -> TooManyParamsError -> Bool

(>) :: TooManyParamsError -> TooManyParamsError -> Bool

(>=) :: TooManyParamsError -> TooManyParamsError -> Bool

max :: TooManyParamsError -> TooManyParamsError -> TooManyParamsError

min :: TooManyParamsError -> TooManyParamsError -> TooManyParamsError

Show TooManyParamsError

Methods

showsPrec :: Int -> TooManyParamsError -> ShowS

show :: TooManyParamsError -> String

showList :: [TooManyParamsError] -> ShowS

Exception TooManyParamsError

Methods

toException :: TooManyParamsError -> SomeException

fromException :: SomeException -> Maybe TooManyParamsError

displayException :: TooManyParamsError -> String

data TooFewParamsError

Too few parameters were given to a command. The first value is the minium, the second the actual number.

Constructors

TooFewParamsError Int Int

Instances

Eq TooFewParamsError

Methods

(==) :: TooFewParamsError -> TooFewParamsError -> Bool

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

Ord TooFewParamsError

Methods

compare :: TooFewParamsError -> TooFewParamsError -> Ordering

(<) :: TooFewParamsError -> TooFewParamsError -> Bool

(<=) :: TooFewParamsError -> TooFewParamsError -> Bool

(>) :: TooFewParamsError -> TooFewParamsError -> Bool

(>=) :: TooFewParamsError -> TooFewParamsError -> Bool

max :: TooFewParamsError -> TooFewParamsError -> TooFewParamsError

min :: TooFewParamsError -> TooFewParamsError -> TooFewParamsError

Show TooFewParamsError

Methods

showsPrec :: Int -> TooFewParamsError -> ShowS

show :: TooFewParamsError -> String

showList :: [TooFewParamsError] -> ShowS

Exception TooFewParamsError

Methods

toException :: TooFewParamsError -> SomeException

fromException :: SomeException -> Maybe TooFewParamsError

displayException :: TooFewParamsError -> String

data Command m i a

A REPL command, possibly with parameters.

Constructors

Command

Fields

• commandName :: Text

  The short name of the command. Purely informative.

• commandTest :: i -> Bool

  Returns whether the first part of an input (the command name) matches a the command. defCommandTest is appropriate for most cases.

• commandDesc :: Text

  A description of the command.

• runPartialCommand :: [i] -> m (a, [i])

  Runs the command with the input text as parameter, returning the unconsumed input.

Instances

Functor m => Functor (Command m i)

Methods

fmap :: (a -> b) -> Command m i a -> Command m i b

(<$) :: a -> Command m i b -> Command m i a

Monad m => Apply (Command m i)

Methods

(<.>) :: Command m i (a -> b) -> Command m i a -> Command m i b

(.>) :: Command m i a -> Command m i b -> Command m i b

(<.) :: Command m i a -> Command m i b -> Command m i a

Monad m => Bind (Command m i)

Methods

(>>-) :: Command m i a -> (a -> Command m i b) -> Command m i b

join :: Command m i (Command m i a) -> Command m i a

data NoConfigFileParseError

Indicates that some string was not able to be parsed.

Constructors

NoConfigFileParseError Text

Instances

Eq NoConfigFileParseError

Methods

(==) :: NoConfigFileParseError -> NoConfigFileParseError -> Bool

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

Read NoConfigFileParseError

Methods

readsPrec :: Int -> ReadS NoConfigFileParseError

readList :: ReadS [NoConfigFileParseError]

readPrec :: ReadPrec NoConfigFileParseError

readListPrec :: ReadPrec [NoConfigFileParseError]

Show NoConfigFileParseError

Methods

showsPrec :: Int -> NoConfigFileParseError -> ShowS

show :: NoConfigFileParseError -> String

showList :: [NoConfigFileParseError] -> ShowS

Exception NoConfigFileParseError

Methods

toException :: NoConfigFileParseError -> SomeException

fromException :: SomeException -> Maybe NoConfigFileParseError

displayException :: NoConfigFileParseError -> String