| Copyright | © 2007–2012 Gracjan Polak; © 2012–2016 Ömer Sinan Ağacan; © 2017-2021 Albert Krewinkel |
|---|---|
| License | MIT |
| Maintainer | Albert Krewinkel <tarleb+hslua@zeitkraut.de> |
| Stability | beta |
| Portability | non-portable (depends on GHC) |
| Safe Haskell | None |
| Language | Haskell2010 |
HsLua.Classes
Description
Convenience module which re-exports all classes and utility functions provided by the hslua-classes package.
Synopsis
- class Peekable a where
- peek :: PeekError e => StackIndex -> LuaE e a
- peekEither :: (PeekError e, Peekable a) => StackIndex -> LuaE e (Either e a)
- peekList :: (PeekError e, Peekable a) => StackIndex -> LuaE e [a]
- peekKeyValuePairs :: (Peekable a, Peekable b, PeekError e) => StackIndex -> LuaE e [(a, b)]
- class Pushable a where
- pushList :: (LuaError e, Pushable a) => [a] -> LuaE e ()
- class PeekError e => Exposable e a where
- partialApply :: StackIndex -> a -> LuaE e NumResults
- toHaskellFunction :: forall e a. Exposable e a => a -> HaskellFunction e
- invoke :: forall e a. Invokable e a => Name -> a
- registerHaskellFunction :: Exposable e a => Name -> a -> LuaE e ()
- raiseError :: (PeekError e, Pushable a) => a -> LuaE e NumResults
- newtype Optional a = Optional {
- fromOptional :: Maybe a
- popValue :: (PeekError e, Peekable a) => LuaE e a
Receiving values from Lua stack (Lua → Haskell)
class Peekable a where Source #
A value that can be read from the Lua stack.
Methods
peek :: PeekError e => StackIndex -> LuaE e a Source #
Check if at index n there is a convertible Lua value and if so return
it. Throws a Exception
Instances
peekEither :: (PeekError e, Peekable a) => StackIndex -> LuaE e (Either e a) Source #
Try to convert the value at the given stack index to a Haskell value.
Returns Left with the error on failure.
peekKeyValuePairs :: (Peekable a, Peekable b, PeekError e) => StackIndex -> LuaE e [(a, b)] Source #
Read a table into a list of pairs.
Pushing values to Lua stack (Haskell → Lua)
class Pushable a where Source #
A value that can be pushed to the Lua stack.
Methods
push :: LuaError e => a -> LuaE e () Source #
Pushes a value onto Lua stack, casting it into meaningfully nearest Lua type.
Instances
pushList :: (LuaError e, Pushable a) => [a] -> LuaE e () Source #
Push list as numerically indexed table.
Calling Functions
class PeekError e => Exposable e a where Source #
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
Methods
partialApply :: StackIndex -> a -> LuaE e NumResults Source #
Helper function, called by toHaskellFunction
Instances
| PeekError e => Exposable e (HaskellFunction e) Source # | |
Defined in HsLua.Class.Exposable Methods partialApply :: StackIndex -> HaskellFunction e -> LuaE e NumResults Source # | |
| (Peekable a, Exposable e b) => Exposable e (a -> b) Source # | |
Defined in HsLua.Class.Exposable Methods partialApply :: StackIndex -> (a -> b) -> LuaE e NumResults Source # | |
| (PeekError e, Pushable a) => Exposable e (LuaE e a) Source # | |
Defined in HsLua.Class.Exposable Methods partialApply :: StackIndex -> LuaE e a -> LuaE e NumResults Source # | |
toHaskellFunction :: forall e a. Exposable e a => a -> HaskellFunction e Source #
Convert a Haskell function to a function type directly exposable to Lua. Any Haskell function can be converted provided that:
Any Exception
Important: this does not catch exceptions other than
Exception
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 Source #
Invoke a Lua function. Use as:
v <- invoke "proc" "abc" (1::Int) (5.0::Double)
registerHaskellFunction :: Exposable e a => Name -> a -> LuaE e () Source #
Imports a Haskell function and registers it at global name.
Utility functions and types
raiseError :: (PeekError e, Pushable a) => a -> LuaE e NumResults Source #
Raise a Lua error, using the given value as the error object.
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
| |