Copyright	© 2007–2012 Gracjan Polak 2012–2016 Ömer Sinan Ağacan 2017-2018 Albert Krewinkel
License	MIT
Maintainer	Albert Krewinkel <tarleb+hslua@zeitkraut.de>
Stability	beta
Portability	FlexibleInstances, ForeignFunctionInterface, ScopedTypeVariables
Safe Haskell	None
Language	Haskell2010

Foreign.Lua.FunctionCalling

Description

Call haskell functions from Lua, and vice versa.

Synopsis

class Peekable a where
class LuaCallFunc a where
class ToHaskellFunction a where
type HaskellFunction = Lua NumResults
class Pushable a where
type PreCFunction = State -> IO NumResults
toHaskellFunction :: ToHaskellFunction a => a -> HaskellFunction
callFunc :: LuaCallFunc a => String -> a
freeCFunction :: CFunction -> Lua ()
newCFunction :: ToHaskellFunction a => a -> Lua CFunction
pushHaskellFunction :: ToHaskellFunction a => a -> Lua ()
registerHaskellFunction :: ToHaskellFunction a => String -> a -> Lua ()

Documentation

class Peekable a where Source #

A value that can be read from the Lua stack.

Minimal complete definition

peek

Methods

peek :: StackIndex -> Lua a Source #

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

Instances

Peekable Bool Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua Bool Source #
Peekable Double Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua Double Source #
Peekable Float Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua Float Source #
Peekable Int Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua Int Source #
Peekable Integer Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua Integer Source #
Peekable () Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua () Source #
Peekable ByteString Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua ByteString Source #
Peekable ByteString Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua ByteString Source #
Peekable Text Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua Text Source #
Peekable Number Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua Number Source #
Peekable Integer Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua Integer Source #
Peekable CFunction Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua CFunction Source #
Peekable State Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua State Source #
Peekable [Char] Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua [Char] Source #
Peekable a => Peekable [a] Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua [a] Source #
Peekable (Ptr a) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (Ptr a) Source #
(Ord a, Peekable a) => Peekable (Set a) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (Set a) Source #
Peekable a => Peekable (Optional a) Source #
Instance details Defined in Foreign.Lua.Util Methods peek :: StackIndex -> Lua (Optional a) Source #
(Peekable a, Peekable b) => Peekable (a, b) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (a, b) Source #
(Ord a, Peekable a, Peekable b) => Peekable (Map a b) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (Map a b) Source #
(Peekable a, Peekable b, Peekable c) => Peekable (a, b, c) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (a, b, c) Source #
(Peekable a, Peekable b, Peekable c, Peekable d) => Peekable (a, b, c, d) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (a, b, c, d) Source #
(Peekable a, Peekable b, Peekable c, Peekable d, Peekable e) => Peekable (a, b, c, d, e) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (a, b, c, d, e) Source #
(Peekable a, Peekable b, Peekable c, Peekable d, Peekable e, Peekable f) => Peekable (a, b, c, d, e, f) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (a, b, c, d, e, f) Source #
(Peekable a, Peekable b, Peekable c, Peekable d, Peekable e, Peekable f, Peekable g) => Peekable (a, b, c, d, e, f, g) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (a, b, c, d, e, f, g) Source #
(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) Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua (a, b, c, d, e, f, g, h) Source #

class LuaCallFunc a where Source #

Helper class used to make lua functions useable from haskell

Minimal complete definition

callFunc'

Methods

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

Instances

Peekable a => LuaCallFunc (Lua a) Source #
Instance details Defined in Foreign.Lua.FunctionCalling Methods callFunc' :: String -> Lua () -> NumArgs -> Lua a Source #
(Pushable a, LuaCallFunc b) => LuaCallFunc (a -> b) Source #
Instance details Defined in Foreign.Lua.FunctionCalling Methods callFunc' :: String -> Lua () -> NumArgs -> a -> b Source #

class ToHaskellFunction 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 wrapper instead.

Minimal complete definition

toHsFun

Methods

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

Helper function, called by toHaskellFunction

Instances

ToHaskellFunction HaskellFunction Source #
Instance details Defined in Foreign.Lua.FunctionCalling Methods toHsFun :: StackIndex -> HaskellFunction -> Lua NumResults Source #
Pushable a => ToHaskellFunction (Lua a) Source #
Instance details Defined in Foreign.Lua.FunctionCalling Methods toHsFun :: StackIndex -> Lua a -> Lua NumResults Source #
(Peekable a, ToHaskellFunction b) => ToHaskellFunction (a -> b) Source #
Instance details Defined in Foreign.Lua.FunctionCalling Methods toHsFun :: StackIndex -> (a -> b) -> Lua NumResults Source #

type HaskellFunction = Lua NumResults Source #

Haskell function that can be called from Lua.

class Pushable a where Source #

A value that can be pushed to the Lua stack.

Minimal complete definition

push

Methods

push :: a -> Lua () Source #

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

Instances

Pushable Bool Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: Bool -> Lua () Source #
Pushable Double Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: Double -> Lua () Source #
Pushable Float Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: Float -> Lua () Source #
Pushable Int Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: Int -> Lua () Source #
Pushable Integer Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: Integer -> Lua () Source #
Pushable () Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: () -> Lua () Source #
Pushable ByteString Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: ByteString -> Lua () Source #
Pushable ByteString Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: ByteString -> Lua () Source #
Pushable Text Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: Text -> Lua () Source #
Pushable Number Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: Number -> Lua () Source #
Pushable Integer Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: Integer -> Lua () Source #
Pushable CFunction Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: CFunction -> Lua () Source #
Pushable [Char] Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: [Char] -> Lua () Source #
Pushable a => Pushable [a] Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: [a] -> Lua () Source #
Pushable (Ptr a) Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: Ptr a -> Lua () Source #
Pushable a => Pushable (Set a) Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: Set a -> Lua () Source #
Pushable a => Pushable (Optional a) Source #
Instance details Defined in Foreign.Lua.Util Methods push :: Optional a -> Lua () Source #
(Pushable a, Pushable b) => Pushable (a, b) Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: (a, b) -> Lua () Source #
(Pushable a, Pushable b) => Pushable (Map a b) Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: Map a b -> Lua () Source #
(Pushable a, Pushable b, Pushable c) => Pushable (a, b, c) Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: (a, b, c) -> Lua () Source #
(Pushable a, Pushable b, Pushable c, Pushable d) => Pushable (a, b, c, d) Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: (a, b, c, d) -> Lua () Source #
(Pushable a, Pushable b, Pushable c, Pushable d, Pushable e) => Pushable (a, b, c, d, e) Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: (a, b, c, d, e) -> Lua () Source #
(Pushable a, Pushable b, Pushable c, Pushable d, Pushable e, Pushable f) => Pushable (a, b, c, d, e, f) Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: (a, b, c, d, e, f) -> Lua () Source #
(Pushable a, Pushable b, Pushable c, Pushable d, Pushable e, Pushable f, Pushable g) => Pushable (a, b, c, d, e, f, g) Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: (a, b, c, d, e, f, g) -> Lua () Source #
(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) Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: (a, b, c, d, e, f, g, h) -> Lua () Source #

type PreCFunction = State -> IO NumResults Source #

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

toHaskellFunction :: ToHaskellFunction a => a -> HaskellFunction Source #

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 Haskell exception will be converted to a string and returned as Lua error.

callFunc :: LuaCallFunc a => String -> a Source #

Call a Lua function. Use as:

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

freeCFunction :: CFunction -> Lua () Source #

Free function pointer created with newcfunction.

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

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 () Source #

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 () Source #

Imports a Haskell function and registers it at global name.