Foreign.Lua.FunctionCalling

Call haskell functions from Lua, and vice versa.

Documentation

class Peekable a where

A value that can be read from the Lua stack.

Methods

peek :: StackIndex -> Lua 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 Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua Bool

Peekable Double

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua Double

Peekable Float

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua Float

Peekable Int

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua Int

Peekable Integer

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua Integer

Peekable ()

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua ()

Peekable ByteString

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua ByteString

Peekable ByteString

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua ByteString

Peekable Text

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua Text

Peekable Number

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua Number

Peekable Integer

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua Integer

Peekable CFunction

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua CFunction

Peekable State

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua State

Peekable [Char]

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua [Char]

Peekable a => Peekable [a]

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua [a]

Peekable (Ptr a)

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua (Ptr a)

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

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua (Set a)

Peekable a => Peekable (Optional a)

Defined in Foreign.Lua.Util

Methods

peek :: StackIndex -> Lua (Optional a)

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

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua (a, b)

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

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua (Map a b)

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

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua (a, b, c)

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

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua (a, b, c, d)

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

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua (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 Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua (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 Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua (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 Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua (a, b, c, d, e, f, g, h)

class LuaCallFunc a where

Helper class used to make lua functions useable from haskell

Methods

callFunc' :: String -> Lua () -> NumArgs -> a

Instances

Peekable a => LuaCallFunc (Lua a)

Defined in Foreign.Lua.FunctionCalling

Methods

callFunc' :: String -> Lua () -> NumArgs -> Lua a

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

Defined in Foreign.Lua.FunctionCalling

Methods

callFunc' :: String -> Lua () -> NumArgs -> a -> b

class ToHaskellFunction 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

toHsFun :: StackIndex -> a -> Lua NumResults

Helper function, called by toHaskellFunction

Instances

ToHaskellFunction HaskellFunction

Defined in Foreign.Lua.FunctionCalling

Methods

toHsFun :: StackIndex -> HaskellFunction -> Lua NumResults

Pushable a => ToHaskellFunction (Lua a)

Defined in Foreign.Lua.FunctionCalling

Methods

toHsFun :: StackIndex -> Lua a -> Lua NumResults

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

Defined in Foreign.Lua.FunctionCalling

Methods

toHsFun :: StackIndex -> (a -> b) -> Lua NumResults

type HaskellFunction = Lua NumResults

Haskell function that can be called from Lua.

class Pushable a where

A value that can be pushed to the Lua stack.

Methods

push :: a -> Lua ()

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

Instances

Pushable Bool

Defined in Foreign.Lua.Types.Pushable

Methods

push :: Bool -> Lua ()

Pushable Double

Defined in Foreign.Lua.Types.Pushable

Methods

push :: Double -> Lua ()

Pushable Float

Defined in Foreign.Lua.Types.Pushable

Methods

push :: Float -> Lua ()

Pushable Int

Defined in Foreign.Lua.Types.Pushable

Methods

push :: Int -> Lua ()

Pushable Integer

Defined in Foreign.Lua.Types.Pushable

Methods

push :: Integer -> Lua ()

Pushable ()

Defined in Foreign.Lua.Types.Pushable

Methods

push :: () -> Lua ()

Pushable ByteString

Defined in Foreign.Lua.Types.Pushable

Methods

push :: ByteString -> Lua ()

Pushable ByteString

Defined in Foreign.Lua.Types.Pushable

Methods

push :: ByteString -> Lua ()

Pushable Text

Defined in Foreign.Lua.Types.Pushable

Methods

push :: Text -> Lua ()

Pushable Number

Defined in Foreign.Lua.Types.Pushable

Methods

push :: Number -> Lua ()

Pushable Integer

Defined in Foreign.Lua.Types.Pushable

Methods

push :: Integer -> Lua ()

Pushable CFunction

Defined in Foreign.Lua.Types.Pushable

Methods

push :: CFunction -> Lua ()

Pushable [Char]

Defined in Foreign.Lua.Types.Pushable

Methods

push :: [Char] -> Lua ()

Pushable a => Pushable [a]

Defined in Foreign.Lua.Types.Pushable

Methods

push :: [a] -> Lua ()

Pushable (Ptr a)

Defined in Foreign.Lua.Types.Pushable

Methods

push :: Ptr a -> Lua ()

Pushable a => Pushable (Set a)

Defined in Foreign.Lua.Types.Pushable

Methods

push :: Set a -> Lua ()

Pushable a => Pushable (Optional a)

Defined in Foreign.Lua.Util

Methods

push :: Optional a -> Lua ()

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

Defined in Foreign.Lua.Types.Pushable

Methods

push :: (a, b) -> Lua ()

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

Defined in Foreign.Lua.Types.Pushable

Methods

push :: Map a b -> Lua ()

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

Defined in Foreign.Lua.Types.Pushable

Methods

push :: (a, b, c) -> Lua ()

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

Defined in Foreign.Lua.Types.Pushable

Methods

push :: (a, b, c, d) -> Lua ()

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

Defined in Foreign.Lua.Types.Pushable

Methods

push :: (a, b, c, d, e) -> Lua ()

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

Defined in Foreign.Lua.Types.Pushable

Methods

push :: (a, b, c, d, e, f) -> Lua ()

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

Defined in Foreign.Lua.Types.Pushable

Methods

push :: (a, b, c, d, e, f, g) -> Lua ()

(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 Foreign.Lua.Types.Pushable

Methods

push :: (a, b, c, d, e, f, g, h) -> Lua ()

type PreCFunction = State -> IO NumResults

Type of raw Haskell functions that can be made into CFunctions.

toHaskellFunction :: ToHaskellFunction a => a -> HaskellFunction

Convert a Haskell function to Lua function. 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)))

callFunc :: LuaCallFunc a => String -> a

Call a Lua function. Use as:

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

freeCFunction :: CFunction -> Lua ()

Free function pointer created with newcfunction.

newCFunction :: ToHaskellFunction a => a -> Lua CFunction

Create new foreign Lua function. Function created can be called by Lua engine. Remeber to free the pointer with freecfunction.

pushHaskellFunction :: ToHaskellFunction a => a -> Lua ()

Pushes Haskell function as a callable userdata. All values created will be garbage collected. Use as:

pushHaskellFunction myfun
setglobal "myfun"

Error conditions should be indicated by raising a Lua Exception or by returning the result of error.

registerHaskellFunction :: ToHaskellFunction a => String -> a -> Lua ()

Imports a Haskell function and registers it at global name.