HsLua.Classes

Convenience module which re-exports all classes and utility functions provided by the hslua-classes package.

Receiving values from Lua stack (Lua → Haskell)

class Peekable a where

A value that can be read from the Lua stack.

Methods

peek :: PeekError e => StackIndex -> LuaE e a

Check if at index n there is a convertible Lua value and if so return it. Throws a Exception otherwise.

Instances

Peekable Bool

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e Bool

Peekable Double

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e Double

Peekable Float

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e Float

Peekable Int

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e Int

Peekable Integer

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e Integer

Peekable ()

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e ()

Peekable ByteString

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e ByteString

Peekable ByteString

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e ByteString

Peekable Text

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e Text

Peekable Number

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e Number

Peekable Integer

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e Integer

Peekable CFunction

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e CFunction

Peekable State

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e State

Peekable [Char]

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e [Char]

Peekable a => Peekable [a]

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e [a]

Peekable (Ptr a)

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e (Ptr a)

(Ord a, Peekable a) => Peekable (Set a)

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e (Set a)

Peekable a => Peekable (Optional a)

Defined in HsLua.Class.Util

Methods

peek :: PeekError e => StackIndex -> LuaE e (Optional a)

(Peekable a, Peekable b) => Peekable (a, b)

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e (a, b)

(Ord a, Peekable a, Peekable b) => Peekable (Map a b)

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e (Map a b)

(Peekable a, Peekable b, Peekable c) => Peekable (a, b, c)

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e (a, b, c)

(Peekable a, Peekable b, Peekable c, Peekable d) => Peekable (a, b, c, d)

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e => StackIndex -> LuaE e (a, b, c, d)

(Peekable a, Peekable b, Peekable c, Peekable d, Peekable e) => Peekable (a, b, c, d, e)

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e0 => StackIndex -> LuaE e0 (a, b, c, d, e)

(Peekable a, Peekable b, Peekable c, Peekable d, Peekable e, Peekable f) => Peekable (a, b, c, d, e, f)

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e0 => StackIndex -> LuaE e0 (a, b, c, d, e, f)

(Peekable a, Peekable b, Peekable c, Peekable d, Peekable e, Peekable f, Peekable g) => Peekable (a, b, c, d, e, f, g)

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e0 => StackIndex -> LuaE e0 (a, b, c, d, e, f, g)

(Peekable a, Peekable b, Peekable c, Peekable d, Peekable e, Peekable f, Peekable g, Peekable h) => Peekable (a, b, c, d, e, f, g, h)

Defined in HsLua.Class.Peekable

Methods

peek :: PeekError e0 => StackIndex -> LuaE e0 (a, b, c, d, e, f, g, h)

peekEither :: (PeekError e, Peekable a) => StackIndex -> LuaE e (Either e a)

Try to convert the value at the given stack index to a Haskell value. Returns Left with the error on failure.

peekList :: (PeekError e, Peekable a) => StackIndex -> LuaE e [a]

Read a table into a list

peekKeyValuePairs :: (Peekable a, Peekable b, PeekError e) => StackIndex -> LuaE e [(a, b)]

Read a table into a list of pairs.

Pushing values to Lua stack (Haskell → Lua)

class Pushable a where

A value that can be pushed to the Lua stack.

Methods

push :: LuaError e => a -> LuaE e ()

Pushes a value onto Lua stack, casting it into meaningfully nearest Lua type.

Instances

Pushable Bool

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => Bool -> LuaE e ()

Pushable Double

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => Double -> LuaE e ()

Pushable Float

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => Float -> LuaE e ()

Pushable Int

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => Int -> LuaE e ()

Pushable Integer

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => Integer -> LuaE e ()

Pushable ()

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => () -> LuaE e ()

Pushable ByteString

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => ByteString -> LuaE e ()

Pushable ByteString

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => ByteString -> LuaE e ()

Pushable Text

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => Text -> LuaE e ()

Pushable Number

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => Number -> LuaE e ()

Pushable Integer

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => Integer -> LuaE e ()

Pushable CFunction

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => CFunction -> LuaE e ()

Pushable [Char]

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => [Char] -> LuaE e ()

Pushable a => Pushable [a]

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => [a] -> LuaE e ()

Pushable (Ptr a)

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => Ptr a -> LuaE e ()

Pushable a => Pushable (Set a)

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => Set a -> LuaE e ()

Pushable a => Pushable (Optional a)

Defined in HsLua.Class.Util

Methods

push :: LuaError e => Optional a -> LuaE e ()

(Pushable a, Pushable b) => Pushable (a, b)

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => (a, b) -> LuaE e ()

(Pushable a, Pushable b) => Pushable (Map a b)

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => Map a b -> LuaE e ()

(Pushable a, Pushable b, Pushable c) => Pushable (a, b, c)

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => (a, b, c) -> LuaE e ()

(Pushable a, Pushable b, Pushable c, Pushable d) => Pushable (a, b, c, d)

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e => (a, b, c, d) -> LuaE e ()

(Pushable a, Pushable b, Pushable c, Pushable d, Pushable e) => Pushable (a, b, c, d, e)

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e0 => (a, b, c, d, e) -> LuaE e0 ()

(Pushable a, Pushable b, Pushable c, Pushable d, Pushable e, Pushable f) => Pushable (a, b, c, d, e, f)

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e0 => (a, b, c, d, e, f) -> LuaE e0 ()

(Pushable a, Pushable b, Pushable c, Pushable d, Pushable e, Pushable f, Pushable g) => Pushable (a, b, c, d, e, f, g)

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e0 => (a, b, c, d, e, f, g) -> LuaE e0 ()

(Pushable a, Pushable b, Pushable c, Pushable d, Pushable e, Pushable f, Pushable g, Pushable h) => Pushable (a, b, c, d, e, f, g, h)

Defined in HsLua.Class.Pushable

Methods

push :: LuaError e0 => (a, b, c, d, e, f, g, h) -> LuaE e0 ()

pushList :: (LuaError e, Pushable a) => [a] -> LuaE e ()

Push list as numerically indexed table.

Calling Functions

class PeekError e => Exposable e a where

Operations and functions that can be pushed to the Lua stack. This is a helper function not intended to be used directly. Use the toHaskellFunction wrapper instead.

Methods

partialApply :: StackIndex -> a -> LuaE e NumResults

Helper function, called by toHaskellFunction. Should do a partial application of the argument at the given index to the underlying function. Recurses if necessary, causing further partial applications until the operation is a easily exposable to Lua.

Instances

PeekError e => Exposable e (HaskellFunction e)

Defined in HsLua.Class.Exposable

Methods

partialApply :: StackIndex -> HaskellFunction e -> LuaE e NumResults

(Peekable a, Exposable e b) => Exposable e (a -> b)

Defined in HsLua.Class.Exposable

Methods

partialApply :: StackIndex -> (a -> b) -> LuaE e NumResults

(PeekError e, Pushable a) => Exposable e (LuaE e a)

Defined in HsLua.Class.Exposable

Methods

partialApply :: StackIndex -> LuaE e a -> LuaE e NumResults

toHaskellFunction :: forall e a. Exposable e a => a -> HaskellFunction e

Convert a Haskell function to a function type directly exposable to Lua. Any Haskell function can be converted provided that:

• all arguments are instances of Peekable
• return type is Lua a, where a is an instance of Pushable

Any Exception will be converted to a string and returned as Lua error.

Important: this does not catch exceptions other than Exception; exception handling must be done by the converted Haskell function. Failure to do so will cause the program to crash.

E.g., the following code could be used to handle an Exception of type FooException, if that type is an instance of MonadCatch and Pushable:

toHaskellFunction (myFun `catchM` (\e -> raiseError (e :: FooException)))

invoke :: forall e a. Invokable e a => Name -> a

Invoke a Lua function. Use as:

v <- invoke "proc" "abc" (1::Int) (5.0::Double)

registerHaskellFunction :: Exposable e a => Name -> a -> LuaE e ()

Imports a Haskell function and registers it at global name.

Utility functions and types

raiseError :: (PeekError e, Pushable a) => a -> LuaE e NumResults

Raise a Lua error, using the given value as the error object.

newtype Optional a

Newtype wrapper intended to be used for optional Lua values. Nesting this type is strongly discouraged as missing values on inner levels are indistinguishable from missing values on an outer level; wrong values would be the likely result.

Constructors

Optional

Fields

• fromOptional :: Maybe a

Instances

Peekable a => Peekable (Optional a)

Defined in HsLua.Class.Util

Methods

peek :: PeekError e => StackIndex -> LuaE e (Optional a)

Pushable a => Pushable (Optional a)

Defined in HsLua.Class.Util

Methods

push :: LuaError e => Optional a -> LuaE e ()

Retrieving values

popValue :: (PeekError e, Peekable a) => LuaE e a

Get, then pop the value at the top of the stack. The pop operation is executed even if the retrieval operation failed.