Copyright | © 2007–2012 Gracjan Polak 2012–2016 Ömer Sinan Ağacan 2017 Albert Krewinkel |
---|---|
License | MIT |
Maintainer | Albert Krewinkel <tarleb+hslua@zeitkraut.de> |
Stability | beta |
Portability | ForeignFunctionInterface, GeneralizedNewtypeDeriving |
Safe Haskell | None |
Language | Haskell98 |
The core Lua types, including mappings of Lua types to Haskell.
- newtype LuaState = LuaState (Ptr ())
- type CFunction = FunPtr (LuaState -> IO NumResults)
- newtype LuaInteger = LuaInteger Int64
- newtype LuaNumber = LuaNumber Double
- newtype LuaBool = LuaBool CInt
- fromLuaBool :: LuaBool -> Bool
- toLuaBool :: Bool -> LuaBool
- data Type
- newtype TypeCode = TypeCode {
- fromTypeCode :: CInt
- fromType :: Type -> TypeCode
- toType :: TypeCode -> Type
- data RelationalOperator
- fromRelationalOperator :: RelationalOperator -> CInt
- data Status
- toStatus :: StatusCode -> Status
- newtype StatusCode = StatusCode CInt
- type Failable a = CInt
- data GCCONTROL
- newtype StackIndex = StackIndex {}
- newtype NumArgs = NumArgs {
- fromNumArgs :: CInt
- newtype NumResults = NumResults {}
Documentation
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.
type CFunction = FunPtr (LuaState -> 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,
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
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 LuaInteger Source #
The type of integers in Lua.
By default this type is
, but that can be changed to different
values in lua. (See Int64
LUA_INT_TYPE
in luaconf.h
.)
See lua_Integer.
The type of floats in Lua.
By default this type is
, but that can be changed in Lua to a
single float or a long double. (See Double
LUA_FLOAT_TYPE
in luaconf.h
.)
See lua_Number.
Type of Lua values
Enumeration used as type tag. See lua_type.
TypeNone | non-valid stack index |
TypeNil | type of lua's |
TypeBoolean | type of lua booleans |
TypeLightUserdata | type of light userdata |
TypeNumber | type of lua numbers. See |
TypeString | type of lua string values |
TypeTable | type of lua tables |
TypeFunction | type of functions, either normal or |
TypeUserdata | type of full user data |
TypeThread | type of lua threads |
Integer code used to encode the type of a lua value.
fromType :: Type -> TypeCode Source #
Convert a lua Type to a type code which can be passed to the C API.
Relational Operator
data RelationalOperator Source #
Lua comparison operations.
fromRelationalOperator :: RelationalOperator -> CInt Source #
Convert relation operator to its C representation.
Status
Lua status values.
toStatus :: StatusCode -> Status Source #
Convert C integer constant to
.LuaStatus
newtype StatusCode Source #
Integer code used to signal the status of a thread or computation.
See
.Status
type Failable a = CInt Source #
Value or an error, using the convention that value below zero indicate an error. Values greater than zero are used verbatim. The phantom type is currently used for documentation only and has no effect.
Gargabe Collection Control
Enumeration used by gc
function.
newtype StackIndex Source #
A stack index
The number of arguments expected a function.
newtype NumResults Source #
The number of results returned by a function call.