| 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 |
Foreign.Lua.Api.Types
Description
The core Lua types, including mappings of Lua types to Haskell.
Synopsis
- 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 {}
- nthFromTop :: CInt -> StackIndex
- nthFromBottom :: CInt -> StackIndex
- stackTop :: StackIndex
- stackBottom :: 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.
Instances
| Eq LuaState # | |
| FromLuaStack CFunction # | |
Defined in Foreign.Lua.Types.FromLuaStack Methods peek :: StackIndex -> Lua CFunction # | |
| FromLuaStack LuaState # | |
Defined in Foreign.Lua.Types.FromLuaStack Methods peek :: StackIndex -> Lua LuaState # | |
| ToLuaStack CFunction # | |
Defined in Foreign.Lua.Types.ToLuaStack | |
| MonadReader LuaState Lua # | |
type CFunction = FunPtr (LuaState -> IO NumResults) #
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,
gettopgettop. 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 #
The type of integers in Lua.
By default this type is Int64LUA_INT_TYPE in luaconf.h.)
See lua_Integer.
Constructors
| LuaInteger Int64 |
Instances
The type of floats in Lua.
By default this type is DoubleLUA_FLOAT_TYPE in luaconf.h.)
See lua_Number.
Instances
Boolean value returned by a Lua C API function. This is a CIntFalse0, True
Instances
| Eq LuaBool # | |
| Storable LuaBool # | |
Type of Lua values
Enumeration used as type tag. See lua_type.
Constructors
| 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.
Constructors
| TypeCode | |
Fields
| |
Relational Operator
data RelationalOperator #
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 # | |
Defined in Foreign.Lua.Api.Types Methods (==) :: RelationalOperator -> RelationalOperator -> Bool # (/=) :: RelationalOperator -> RelationalOperator -> Bool # | |
| Ord RelationalOperator # | |
Defined in Foreign.Lua.Api.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 # | |
Defined in Foreign.Lua.Api.Types Methods showsPrec :: Int -> RelationalOperator -> ShowS # show :: RelationalOperator -> String # showList :: [RelationalOperator] -> ShowS # | |
fromRelationalOperator :: RelationalOperator -> CInt #
Convert relation operator to its C representation.
Status
Lua status values.
toStatus :: StatusCode -> Status #
Convert C integer constant to LuaStatus
newtype StatusCode #
Integer code used to signal the status of a thread or computation.
See Status
Constructors
| StatusCode CInt |
Instances
| Eq StatusCode # | |
Defined in Foreign.Lua.Api.Types | |
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.
Constructors
| GCSTOP | |
| GCRESTART | |
| GCCOLLECT | |
| GCCOUNT | |
| GCCOUNTB | |
| GCSTEP | |
| GCSETPAUSE | |
| GCSETSTEPMUL |
Instances
| Enum GCCONTROL # | |
Defined in Foreign.Lua.Api.Types Methods succ :: GCCONTROL -> GCCONTROL # pred :: GCCONTROL -> GCCONTROL # fromEnum :: GCCONTROL -> Int # enumFrom :: GCCONTROL -> [GCCONTROL] # enumFromThen :: GCCONTROL -> GCCONTROL -> [GCCONTROL] # enumFromTo :: GCCONTROL -> GCCONTROL -> [GCCONTROL] # enumFromThenTo :: GCCONTROL -> GCCONTROL -> GCCONTROL -> [GCCONTROL] # | |
| Eq GCCONTROL # | |
| Ord GCCONTROL # | |
| Show GCCONTROL # | |
newtype StackIndex #
A stack index
Constructors
| StackIndex | |
Fields | |
Instances
nthFromTop :: CInt -> StackIndex #
Stack index of the nth element from the top of the stack.
nthFromBottom :: CInt -> StackIndex #
Stack index of the nth element from the bottom of the stack.
stackTop :: StackIndex #
Top of the stack
Bottom of the stack
The number of arguments expected a function.
Constructors
| NumArgs | |
Fields
| |
newtype NumResults #
The number of results returned by a function call.
Constructors
| NumResults | |
Fields | |