Copyright	© 2007–2012 Gracjan Polak 2012–2016 Ömer Sinan Ağacan 2017-2020 Albert Krewinkel
License	MIT
Maintainer	Albert Krewinkel <tarleb+hslua@zeitkraut.de>
Stability	beta
Portability	non-portable (depends on GHC)
Safe Haskell	None
Language	Haskell2010

Foreign.Lua.Core.Types

Contents

References

Description

The core Lua types, including mappings of Lua types to Haskell.

This module has mostly been moved to Types and currently re-exports that module. This module might be removed in the future.

Synopsis

newtype Lua a = Lua {
- unLua :: ReaderT LuaEnvironment IO a
}
data LuaEnvironment = LuaEnvironment {
- luaEnvErrorConversion :: ErrorConversion
- luaEnvState :: State
}
data ErrorConversion = ErrorConversion {
- errorToException :: forall a. State -> IO a
- addContextToException :: forall a. String -> Lua a -> Lua a
- alternative :: forall a. Lua a -> Lua a -> Lua a
- exceptionToError :: Lua NumResults -> Lua NumResults
}
errorConversion :: Lua ErrorConversion
newtype State = State (Ptr ())
type Reader = FunPtr (State -> Ptr () -> Ptr CSize -> IO (Ptr CChar))
liftLua :: (State -> IO a) -> Lua a
liftLua1 :: (State -> a -> IO b) -> a -> Lua b
state :: Lua State
runWithConverter :: ErrorConversion -> State -> Lua a -> IO a
unsafeRunWith :: State -> Lua a -> IO a
unsafeErrorConversion :: ErrorConversion
data GCCONTROL
- = GCSTOP
- | GCRESTART
- | GCCOLLECT
- | GCCOUNT
- | GCCOUNTB
- | GCSTEP
- | GCSETPAUSE
- | GCSETSTEPMUL
data Type
- = TypeNone
- | TypeNil
- | TypeBoolean
- | TypeLightUserdata
- | TypeNumber
- | TypeString
- | TypeTable
- | TypeFunction
- | TypeUserdata
- | TypeThread
newtype TypeCode = TypeCode {
- fromTypeCode :: CInt
}
fromType :: Type -> TypeCode
toType :: TypeCode -> Type
liftIO :: MonadIO m => IO a -> m a
type CFunction = FunPtr (State -> IO NumResults)
newtype LuaBool = LuaBool CInt
false :: LuaBool
true :: LuaBool
fromLuaBool :: LuaBool -> Bool
toLuaBool :: Bool -> LuaBool
newtype Integer = Integer Int64
newtype Number = Number Double
newtype StackIndex = StackIndex {
- fromStackIndex :: CInt
}
nth :: CInt -> StackIndex
nthFromBottom :: CInt -> StackIndex
nthFromTop :: CInt -> StackIndex
stackTop :: StackIndex
stackBottom :: StackIndex
top :: StackIndex
newtype NumArgs = NumArgs {
- fromNumArgs :: CInt
}
newtype NumResults = NumResults {
- fromNumResults :: CInt
}
data RelationalOperator
- = EQ
- | LT
- | LE
fromRelationalOperator :: RelationalOperator -> CInt
data Status
- = OK
- | Yield
- | ErrRun
- | ErrSyntax
- | ErrMem
- | ErrErr
- | ErrGcmm
- | ErrFile
newtype StatusCode = StatusCode CInt
toStatus :: StatusCode -> Status
data Reference
- = Reference CInt
- | RefNil
fromReference :: Reference -> CInt
toReference :: CInt -> Reference

Documentation

newtype Lua a Source #

A Lua computation. This is the base type used to run Lua programs of any kind. The Lua state is handled automatically, but can be retrieved via state.

Constructors

Lua
Fields unLua :: ReaderT LuaEnvironment IO a

Instances

Monad Lua Source #
Instance details Defined in Foreign.Lua.Core.Types Methods (>>=) :: Lua a -> (a -> Lua b) -> Lua b # (>>) :: Lua a -> Lua b -> Lua b # return :: a -> Lua a # fail :: String -> Lua a #
Functor Lua Source #
Instance details Defined in Foreign.Lua.Core.Types Methods fmap :: (a -> b) -> Lua a -> Lua b # (<$) :: a -> Lua b -> Lua a #
Applicative Lua Source #
Instance details Defined in Foreign.Lua.Core.Types Methods pure :: a -> Lua a # (<>) :: Lua (a -> b) -> Lua a -> Lua b # liftA2 :: (a -> b -> c) -> Lua a -> Lua b -> Lua c # (>) :: Lua a -> Lua b -> Lua b # (<*) :: Lua a -> Lua b -> Lua a #
MonadIO Lua Source #
Instance details Defined in Foreign.Lua.Core.Types Methods liftIO :: IO a -> Lua a #
Alternative Lua Source #
Instance details Defined in Foreign.Lua.Core.Error Methods empty :: Lua a # (<\|>) :: Lua a -> Lua a -> Lua a # some :: Lua a -> Lua [a] # many :: Lua a -> Lua [a] #
MonadThrow Lua Source #
Instance details Defined in Foreign.Lua.Core.Types Methods throwM :: Exception e => e -> Lua a #
MonadCatch Lua Source #
Instance details Defined in Foreign.Lua.Core.Types Methods catch :: Exception e => Lua a -> (e -> Lua a) -> Lua a #
MonadMask Lua Source #
Instance details Defined in Foreign.Lua.Core.Types Methods mask :: ((forall a. Lua a -> Lua a) -> Lua b) -> Lua b # uninterruptibleMask :: ((forall a. Lua a -> Lua a) -> Lua b) -> Lua b # generalBracket :: Lua a -> (a -> ExitCase b -> Lua c) -> (a -> Lua b) -> Lua (b, c) #
ToHaskellFunction HaskellFunction Source #
Instance details Defined in Foreign.Lua.FunctionCalling Methods toHsFun :: StackIndex -> HaskellFunction -> Lua NumResults Source #
MonadReader LuaEnvironment Lua Source #
Instance details Defined in Foreign.Lua.Core.Types Methods ask :: Lua LuaEnvironment # local :: (LuaEnvironment -> LuaEnvironment) -> Lua a -> Lua a # reader :: (LuaEnvironment -> a) -> Lua a #
Peekable a => LuaCallFunc (Lua a) Source #
Instance details Defined in Foreign.Lua.FunctionCalling Methods callFunc' :: String -> Lua () -> NumArgs -> Lua a Source #
Pushable a => ToHaskellFunction (Lua a) Source #
Instance details Defined in Foreign.Lua.FunctionCalling Methods toHsFun :: StackIndex -> Lua a -> Lua NumResults Source #

data LuaEnvironment Source #

Environment in which Lua computations are evaluated.

Constructors

LuaEnvironment
Fields luaEnvErrorConversion :: ErrorConversion Functions for error and exception handling and conversion luaEnvState :: State Lua interpreter state

Instances

MonadReader LuaEnvironment Lua Source #
Instance details Defined in Foreign.Lua.Core.Types Methods ask :: Lua LuaEnvironment # local :: (LuaEnvironment -> LuaEnvironment) -> Lua a -> Lua a # reader :: (LuaEnvironment -> a) -> Lua a #

data ErrorConversion Source #

Define the ways in which exceptions and errors are handled.

Constructors

ErrorConversion

Fields

errorToException :: forall a. State -> IO a
Translate Lua errors to Haskell exceptions
addContextToException :: forall a. String -> Lua a -> Lua a
Add information on the current context to an exception.
alternative :: forall a. Lua a -> Lua a -> Lua a
Runs the second computation only if the first fails; returns the result of the first successful computation, if any.
exceptionToError :: Lua NumResults -> Lua NumResults
Translate Haskell exceptions to Lua errors

errorConversion :: Lua ErrorConversion Source #

Get the error-to-exception function.

newtype State Source #

An opaque structure that points to a thread and indirectly (through the thread) to the whole state of a Lua interpreter. The Lua library is fully reentrant: it has no global variables. All information about a state is accessible through this structure.

Synonym for lua_State *. See lua_State.

Constructors

State (Ptr ())

Instances

Eq State Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (==) :: State -> State -> Bool # (/=) :: State -> State -> Bool #
Generic State Source #
Instance details Defined in Foreign.Lua.Raw.Types Associated Types type Rep State :: Type -> Type # Methods from :: State -> Rep State x # to :: Rep State x -> State #
Pushable CFunction Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: CFunction -> Lua () 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 #
type Rep State Source #
Instance details Defined in Foreign.Lua.Raw.Types type Rep State = D1 (MetaData "State" "Foreign.Lua.Raw.Types" "hslua-1.2.0-7ZxTR96DywwFnuAhzzhkFV" True) (C1 (MetaCons "State" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Ptr ()))))

type Reader = FunPtr (State -> Ptr () -> Ptr CSize -> IO (Ptr CChar)) Source #

The reader function used by load. Every time it needs another piece of the chunk, lua_load calls the reader, passing along its data parameter. The reader must return a pointer to a block of memory with a new piece of the chunk and set size to the block size. The block must exist until the reader function is called again. To signal the end of the chunk, the reader must return NULL or set size to zero. The reader function may return pieces of any size greater than zero.

See lua_Reader.

liftLua :: (State -> IO a) -> Lua a Source #

Turn a function of typ Lua.State -> IO a into a monadic Lua operation.

liftLua1 :: (State -> a -> IO b) -> a -> Lua b Source #

Turn a function of typ Lua.State -> a -> IO b into a monadic Lua operation.

state :: Lua State Source #

Get the Lua state of this Lua computation.

runWithConverter :: ErrorConversion -> State -> Lua a -> IO a Source #

Run Lua computation with the given Lua state and error-to-exception converter. Any resulting exceptions are left unhandled.

unsafeRunWith :: State -> Lua a -> IO a Source #

Run the given operation, but crash if any Haskell exceptions occur.

unsafeErrorConversion :: ErrorConversion Source #

Unsafe ErrorConversion; no proper error handling is attempted, any error leads to a crash.

data GCCONTROL Source #

Enumeration used by gc function.

Constructors

GCSTOP
GCRESTART
GCCOLLECT
GCCOUNT
GCCOUNTB
GCSTEP
GCSETPAUSE
GCSETSTEPMUL

Instances

Enum GCCONTROL Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods succ :: GCCONTROL -> GCCONTROL # pred :: GCCONTROL -> GCCONTROL # toEnum :: Int -> GCCONTROL # fromEnum :: GCCONTROL -> Int # enumFrom :: GCCONTROL -> [GCCONTROL] # enumFromThen :: GCCONTROL -> GCCONTROL -> [GCCONTROL] # enumFromTo :: GCCONTROL -> GCCONTROL -> [GCCONTROL] # enumFromThenTo :: GCCONTROL -> GCCONTROL -> GCCONTROL -> [GCCONTROL] #
Eq GCCONTROL Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (==) :: GCCONTROL -> GCCONTROL -> Bool # (/=) :: GCCONTROL -> GCCONTROL -> Bool #
Ord GCCONTROL Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods compare :: GCCONTROL -> GCCONTROL -> Ordering # (<) :: GCCONTROL -> GCCONTROL -> Bool # (<=) :: GCCONTROL -> GCCONTROL -> Bool # (>) :: GCCONTROL -> GCCONTROL -> Bool # (>=) :: GCCONTROL -> GCCONTROL -> Bool # max :: GCCONTROL -> GCCONTROL -> GCCONTROL # min :: GCCONTROL -> GCCONTROL -> GCCONTROL #
Show GCCONTROL Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods showsPrec :: Int -> GCCONTROL -> ShowS # show :: GCCONTROL -> String # showList :: [GCCONTROL] -> ShowS #

data Type Source #

Enumeration used as type tag. See lua_type.

Constructors

TypeNone	non-valid stack index
TypeNil	type of lua's `nil` value
TypeBoolean	type of lua booleans
TypeLightUserdata	type of light userdata
TypeNumber	type of lua numbers. See `Number`
TypeString	type of lua string values
TypeTable	type of lua tables
TypeFunction	type of functions, either normal or `CFunction`
TypeUserdata	type of full user data
TypeThread	type of lua threads

Instances

Bounded Type Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods minBound :: Type # maxBound :: Type #
Enum Type Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods succ :: Type -> Type # pred :: Type -> Type # toEnum :: Int -> Type # fromEnum :: Type -> Int # enumFrom :: Type -> [Type] # enumFromThen :: Type -> Type -> [Type] # enumFromTo :: Type -> Type -> [Type] # enumFromThenTo :: Type -> Type -> Type -> [Type] #
Eq Type Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (==) :: Type -> Type -> Bool # (/=) :: Type -> Type -> Bool #
Ord Type Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods compare :: Type -> Type -> Ordering # (<) :: Type -> Type -> Bool # (<=) :: Type -> Type -> Bool # (>) :: Type -> Type -> Bool # (>=) :: Type -> Type -> Bool # max :: Type -> Type -> Type # min :: Type -> Type -> Type #
Show Type Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods showsPrec :: Int -> Type -> ShowS # show :: Type -> String # showList :: [Type] -> ShowS #

newtype TypeCode Source #

Integer code used to encode the type of a lua value.

Constructors

TypeCode
Fields fromTypeCode :: CInt

Instances

Eq TypeCode Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (==) :: TypeCode -> TypeCode -> Bool # (/=) :: TypeCode -> TypeCode -> Bool #
Ord TypeCode Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods compare :: TypeCode -> TypeCode -> Ordering # (<) :: TypeCode -> TypeCode -> Bool # (<=) :: TypeCode -> TypeCode -> Bool # (>) :: TypeCode -> TypeCode -> Bool # (>=) :: TypeCode -> TypeCode -> Bool # max :: TypeCode -> TypeCode -> TypeCode # min :: TypeCode -> TypeCode -> TypeCode #
Show TypeCode Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods showsPrec :: Int -> TypeCode -> ShowS # show :: TypeCode -> String # showList :: [TypeCode] -> ShowS #

fromType :: Type -> TypeCode Source #

Convert a lua Type to a type code which can be passed to the C API.

toType :: TypeCode -> Type Source #

Convert numerical code to lua type.

liftIO :: MonadIO m => IO a -> m a #

Lift a computation from the IO monad.

type CFunction = FunPtr (State -> IO NumResults) Source #

Type for C functions.

In order to communicate properly with Lua, a C function must use the following protocol, which defines the way parameters and results are passed: a C function receives its arguments from Lua in its stack in direct order (the first argument is pushed first). So, when the function starts, gettop returns the number of arguments received by the function. The first argument (if any) is at index 1 and its last argument is at index gettop. To return values to Lua, a C function just pushes them onto the stack, in direct order (the first result is pushed first), and returns the number of results. Any other value in the stack below the results will be properly discarded by Lua. Like a Lua function, a C function called by Lua can also return many results.

See lua_CFunction.

newtype LuaBool Source #

Boolean value returned by a Lua C API function. This is a CInt and interpreted as False iff the value is 0, True otherwise.

Constructors

LuaBool CInt

Instances

Eq LuaBool Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (==) :: LuaBool -> LuaBool -> Bool # (/=) :: LuaBool -> LuaBool -> Bool #
Show LuaBool Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods showsPrec :: Int -> LuaBool -> ShowS # show :: LuaBool -> String # showList :: [LuaBool] -> ShowS #
Storable LuaBool Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods sizeOf :: LuaBool -> Int # alignment :: LuaBool -> Int # peekElemOff :: Ptr LuaBool -> Int -> IO LuaBool # pokeElemOff :: Ptr LuaBool -> Int -> LuaBool -> IO () # peekByteOff :: Ptr b -> Int -> IO LuaBool # pokeByteOff :: Ptr b -> Int -> LuaBool -> IO () # peek :: Ptr LuaBool -> IO LuaBool # poke :: Ptr LuaBool -> LuaBool -> IO () #

false :: LuaBool Source #

Lua representation of the value interpreted as false.

true :: LuaBool Source #

Generic Lua representation of a value interpreted as being true.

fromLuaBool :: LuaBool -> Bool Source #

Convert a LuaBool to a Haskell Bool.

toLuaBool :: Bool -> LuaBool Source #

Convert a Haskell Bool to a LuaBool.

newtype Integer Source #

The type of integers in Lua.

By default this type is Int64, but that can be changed to different values in lua. (See LUA_INT_TYPE in luaconf.h.)

See lua_Integer.

Constructors

Integer Int64

Instances

Bounded Integer Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods minBound :: Integer # maxBound :: Integer #
Enum Integer Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods succ :: Integer -> Integer # pred :: Integer -> Integer # toEnum :: Int -> Integer # fromEnum :: Integer -> Int # enumFrom :: Integer -> [Integer] # enumFromThen :: Integer -> Integer -> [Integer] # enumFromTo :: Integer -> Integer -> [Integer] # enumFromThenTo :: Integer -> Integer -> Integer -> [Integer] #
Eq Integer Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (==) :: Integer -> Integer -> Bool # (/=) :: Integer -> Integer -> Bool #
Integral Integer Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods quot :: Integer -> Integer -> Integer # rem :: Integer -> Integer -> Integer # div :: Integer -> Integer -> Integer # mod :: Integer -> Integer -> Integer # quotRem :: Integer -> Integer -> (Integer, Integer) # divMod :: Integer -> Integer -> (Integer, Integer) # toInteger :: Integer -> Integer0 #
Num Integer Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (+) :: Integer -> Integer -> Integer # (-) :: Integer -> Integer -> Integer # (*) :: Integer -> Integer -> Integer # negate :: Integer -> Integer # abs :: Integer -> Integer # signum :: Integer -> Integer # fromInteger :: Integer0 -> Integer #
Ord Integer Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods compare :: Integer -> Integer -> Ordering # (<) :: Integer -> Integer -> Bool # (<=) :: Integer -> Integer -> Bool # (>) :: Integer -> Integer -> Bool # (>=) :: Integer -> Integer -> Bool # max :: Integer -> Integer -> Integer # min :: Integer -> Integer -> Integer #
Real Integer Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods toRational :: Integer -> Rational #
Show Integer Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods showsPrec :: Int -> Integer -> ShowS # show :: Integer -> String # showList :: [Integer] -> ShowS #
Pushable Integer Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: Integer -> Lua () Source #
Peekable Integer Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua Integer Source #

newtype Number Source #

The type of floats in Lua.

By default this type is Double, but that can be changed in Lua to a single float or a long double. (See LUA_FLOAT_TYPE in luaconf.h.)

See lua_Number.

Constructors

Number Double

Instances

Eq Number Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (==) :: Number -> Number -> Bool # (/=) :: Number -> Number -> Bool #
Floating Number Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods pi :: Number # exp :: Number -> Number # log :: Number -> Number # sqrt :: Number -> Number # (**) :: Number -> Number -> Number # logBase :: Number -> Number -> Number # sin :: Number -> Number # cos :: Number -> Number # tan :: Number -> Number # asin :: Number -> Number # acos :: Number -> Number # atan :: Number -> Number # sinh :: Number -> Number # cosh :: Number -> Number # tanh :: Number -> Number # asinh :: Number -> Number # acosh :: Number -> Number # atanh :: Number -> Number # log1p :: Number -> Number # expm1 :: Number -> Number # log1pexp :: Number -> Number # log1mexp :: Number -> Number #
Fractional Number Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (/) :: Number -> Number -> Number # recip :: Number -> Number # fromRational :: Rational -> Number #
Num Number Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (+) :: Number -> Number -> Number # (-) :: Number -> Number -> Number # (*) :: Number -> Number -> Number # negate :: Number -> Number # abs :: Number -> Number # signum :: Number -> Number # fromInteger :: Integer -> Number #
Ord Number Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods compare :: Number -> Number -> Ordering # (<) :: Number -> Number -> Bool # (<=) :: Number -> Number -> Bool # (>) :: Number -> Number -> Bool # (>=) :: Number -> Number -> Bool # max :: Number -> Number -> Number # min :: Number -> Number -> Number #
Real Number Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods toRational :: Number -> Rational #
RealFloat Number Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods floatRadix :: Number -> Integer # floatDigits :: Number -> Int # floatRange :: Number -> (Int, Int) # decodeFloat :: Number -> (Integer, Int) # encodeFloat :: Integer -> Int -> Number # exponent :: Number -> Int # significand :: Number -> Number # scaleFloat :: Int -> Number -> Number # isNaN :: Number -> Bool # isInfinite :: Number -> Bool # isDenormalized :: Number -> Bool # isNegativeZero :: Number -> Bool # isIEEE :: Number -> Bool # atan2 :: Number -> Number -> Number #
RealFrac Number Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods properFraction :: Integral b => Number -> (b, Number) # truncate :: Integral b => Number -> b # round :: Integral b => Number -> b # ceiling :: Integral b => Number -> b # floor :: Integral b => Number -> b #
Show Number Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods showsPrec :: Int -> Number -> ShowS # show :: Number -> String # showList :: [Number] -> ShowS #
Pushable Number Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: Number -> Lua () Source #
Peekable Number Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua Number Source #

newtype StackIndex Source #

A stack index

Constructors

StackIndex
Fields fromStackIndex :: CInt

Instances

Enum StackIndex Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods succ :: StackIndex -> StackIndex # pred :: StackIndex -> StackIndex # toEnum :: Int -> StackIndex # fromEnum :: StackIndex -> Int # enumFrom :: StackIndex -> [StackIndex] # enumFromThen :: StackIndex -> StackIndex -> [StackIndex] # enumFromTo :: StackIndex -> StackIndex -> [StackIndex] # enumFromThenTo :: StackIndex -> StackIndex -> StackIndex -> [StackIndex] #
Eq StackIndex Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (==) :: StackIndex -> StackIndex -> Bool # (/=) :: StackIndex -> StackIndex -> Bool #
Num StackIndex Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (+) :: StackIndex -> StackIndex -> StackIndex # (-) :: StackIndex -> StackIndex -> StackIndex # (*) :: StackIndex -> StackIndex -> StackIndex # negate :: StackIndex -> StackIndex # abs :: StackIndex -> StackIndex # signum :: StackIndex -> StackIndex # fromInteger :: Integer -> StackIndex #
Ord StackIndex Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods compare :: StackIndex -> StackIndex -> Ordering # (<) :: StackIndex -> StackIndex -> Bool # (<=) :: StackIndex -> StackIndex -> Bool # (>) :: StackIndex -> StackIndex -> Bool # (>=) :: StackIndex -> StackIndex -> Bool # max :: StackIndex -> StackIndex -> StackIndex # min :: StackIndex -> StackIndex -> StackIndex #
Show StackIndex Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods showsPrec :: Int -> StackIndex -> ShowS # show :: StackIndex -> String # showList :: [StackIndex] -> ShowS #

nth :: CInt -> StackIndex Source #

Stack index of the nth element from the top of the stack.

nthFromBottom :: CInt -> StackIndex Source #

Stack index of the nth element from the bottom of the stack.

nthFromTop :: CInt -> StackIndex Source #

Stack index of the nth element from the top of the stack.

stackTop :: StackIndex Source #

Top of the stack

stackBottom :: StackIndex Source #

Bottom of the stack

top :: StackIndex Source #

Top of the stack

newtype NumArgs Source #

The number of arguments consumed curing a function call.

Constructors

NumArgs
Fields fromNumArgs :: CInt

Instances

Eq NumArgs Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (==) :: NumArgs -> NumArgs -> Bool # (/=) :: NumArgs -> NumArgs -> Bool #
Num NumArgs Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (+) :: NumArgs -> NumArgs -> NumArgs # (-) :: NumArgs -> NumArgs -> NumArgs # (*) :: NumArgs -> NumArgs -> NumArgs # negate :: NumArgs -> NumArgs # abs :: NumArgs -> NumArgs # signum :: NumArgs -> NumArgs # fromInteger :: Integer -> NumArgs #
Ord NumArgs Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods compare :: NumArgs -> NumArgs -> Ordering # (<) :: NumArgs -> NumArgs -> Bool # (<=) :: NumArgs -> NumArgs -> Bool # (>) :: NumArgs -> NumArgs -> Bool # (>=) :: NumArgs -> NumArgs -> Bool # max :: NumArgs -> NumArgs -> NumArgs # min :: NumArgs -> NumArgs -> NumArgs #
Show NumArgs Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods showsPrec :: Int -> NumArgs -> ShowS # show :: NumArgs -> String # showList :: [NumArgs] -> ShowS #

newtype NumResults Source #

The number of results returned by a function call.

Constructors

NumResults
Fields fromNumResults :: CInt

Instances

Eq NumResults Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (==) :: NumResults -> NumResults -> Bool # (/=) :: NumResults -> NumResults -> Bool #
Num NumResults Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (+) :: NumResults -> NumResults -> NumResults # (-) :: NumResults -> NumResults -> NumResults # (*) :: NumResults -> NumResults -> NumResults # negate :: NumResults -> NumResults # abs :: NumResults -> NumResults # signum :: NumResults -> NumResults # fromInteger :: Integer -> NumResults #
Ord NumResults Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods compare :: NumResults -> NumResults -> Ordering # (<) :: NumResults -> NumResults -> Bool # (<=) :: NumResults -> NumResults -> Bool # (>) :: NumResults -> NumResults -> Bool # (>=) :: NumResults -> NumResults -> Bool # max :: NumResults -> NumResults -> NumResults # min :: NumResults -> NumResults -> NumResults #
Show NumResults Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods showsPrec :: Int -> NumResults -> ShowS # show :: NumResults -> String # showList :: [NumResults] -> ShowS #
Pushable CFunction Source #
Instance details Defined in Foreign.Lua.Types.Pushable Methods push :: CFunction -> Lua () Source #
Peekable CFunction Source #
Instance details Defined in Foreign.Lua.Types.Peekable Methods peek :: StackIndex -> Lua CFunction Source #
ToHaskellFunction HaskellFunction Source #
Instance details Defined in Foreign.Lua.FunctionCalling Methods toHsFun :: StackIndex -> HaskellFunction -> Lua NumResults Source #

data RelationalOperator Source #

Lua comparison operations.

Constructors

EQ	Correponds to lua's equality (==) operator.
LT	Correponds to lua's strictly-lesser-than (<) operator
LE	Correponds to lua's lesser-or-equal (<=) operator

Instances

Eq RelationalOperator Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (==) :: RelationalOperator -> RelationalOperator -> Bool # (/=) :: RelationalOperator -> RelationalOperator -> Bool #
Ord RelationalOperator Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods compare :: RelationalOperator -> RelationalOperator -> Ordering # (<) :: RelationalOperator -> RelationalOperator -> Bool # (<=) :: RelationalOperator -> RelationalOperator -> Bool # (>) :: RelationalOperator -> RelationalOperator -> Bool # (>=) :: RelationalOperator -> RelationalOperator -> Bool # max :: RelationalOperator -> RelationalOperator -> RelationalOperator # min :: RelationalOperator -> RelationalOperator -> RelationalOperator #
Show RelationalOperator Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods showsPrec :: Int -> RelationalOperator -> ShowS # show :: RelationalOperator -> String # showList :: [RelationalOperator] -> ShowS #

fromRelationalOperator :: RelationalOperator -> CInt Source #

Convert relation operator to its C representation.

data Status Source #

Lua status values.

Constructors

OK	success
Yield	yielding / suspended coroutine
ErrRun	a runtime rror
ErrSyntax	syntax error during precompilation
ErrMem	memory allocation (out-of-memory) error.
ErrErr	error while running the message handler.
ErrGcmm	error while running a `__gc` metamethod.
ErrFile	opening or reading a file failed.

Instances

Eq Status Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (==) :: Status -> Status -> Bool # (/=) :: Status -> Status -> Bool #
Show Status Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods showsPrec :: Int -> Status -> ShowS # show :: Status -> String # showList :: [Status] -> ShowS #

newtype StatusCode Source #

Integer code used to signal the status of a thread or computation. See Status.

Constructors

StatusCode CInt

Instances

Eq StatusCode Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods (==) :: StatusCode -> StatusCode -> Bool # (/=) :: StatusCode -> StatusCode -> Bool #
Storable StatusCode Source #
Instance details Defined in Foreign.Lua.Raw.Types Methods sizeOf :: StatusCode -> Int # alignment :: StatusCode -> Int # peekElemOff :: Ptr StatusCode -> Int -> IO StatusCode # pokeElemOff :: Ptr StatusCode -> Int -> StatusCode -> IO () # peekByteOff :: Ptr b -> Int -> IO StatusCode # pokeByteOff :: Ptr b -> Int -> StatusCode -> IO () # peek :: Ptr StatusCode -> IO StatusCode # poke :: Ptr StatusCode -> StatusCode -> IO () #

toStatus :: StatusCode -> Status Source #

Convert C integer constant to Status.

References

data Reference Source #

Reference to a stored value.

Constructors

Reference CInt	Reference to a stored value
RefNil	Reference to a nil value

Instances

Eq Reference Source #
Instance details Defined in Foreign.Lua.Raw.Auxiliary Methods (==) :: Reference -> Reference -> Bool # (/=) :: Reference -> Reference -> Bool #
Show Reference Source #
Instance details Defined in Foreign.Lua.Raw.Auxiliary Methods showsPrec :: Int -> Reference -> ShowS # show :: Reference -> String # showList :: [Reference] -> ShowS #

fromReference :: Reference -> CInt Source #

Convert a reference to its C representation.

toReference :: CInt -> Reference Source #

Create a reference from its C representation.