| Copyright | © 2007–2012 Gracjan Polak 2012–2016 Ömer Sinan Ağacan 2017-2019 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
Description
The core Lua types, including mappings of Lua types to Haskell.
- newtype Lua a = Lua {}
- 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
- runWith :: State -> Lua a -> IO a
- data GCCONTROL
- data Type
- newtype TypeCode = TypeCode {
- fromTypeCode :: CInt
- fromType :: Type -> TypeCode
- toType :: TypeCode -> Type
- liftIO :: MonadIO m => forall a. 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 {}
- nthFromBottom :: CInt -> StackIndex
- nthFromTop :: CInt -> StackIndex
- stackTop :: StackIndex
- stackBottom :: StackIndex
- newtype NumArgs = NumArgs {
- fromNumArgs :: CInt
- newtype NumResults = NumResults {}
- data RelationalOperator
- fromRelationalOperator :: RelationalOperator -> CInt
- data Status
- newtype StatusCode = StatusCode CInt
- toStatus :: StatusCode -> Status
- data Reference
- fromReference :: Reference -> CInt
- toReference :: CInt -> Reference
Documentation
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
Instances
| Monad Lua # | |
| Functor Lua # | |
| Applicative Lua # | |
| MonadIO Lua # | |
| MonadThrow Lua # | |
| MonadCatch Lua # | |
| MonadMask Lua # | |
| ToHaskellFunction HaskellFunction # | |
| MonadReader State Lua # | |
| Peekable a => LuaCallFunc (Lua a) # | |
| Pushable a => ToHaskellFunction (Lua a) # | |
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 Reader = FunPtr (State -> Ptr () -> Ptr CSize -> IO (Ptr CChar)) #
The reader function used by lua_loadNULL 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 #
Turn a function of typ Lua.State -> IO a into a monadic lua operation.
liftLua1 :: (State -> a -> IO b) -> a -> Lua b #
Turn a function of typ Lua.State -> a -> IO b into a monadic lua operation.
runWith :: State -> Lua a -> IO a #
Run lua computation with custom lua state. Errors are left unhandled, the caller of this function is responsible to catch lua errors.
Enumeration used by gc function.
Constructors
| GCSTOP | |
| GCRESTART | |
| GCCOLLECT | |
| GCCOUNT | |
| GCCOUNTB | |
| GCSTEP | |
| GCSETPAUSE | |
| GCSETSTEPMUL |
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
| |
type CFunction = FunPtr (State -> 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.
The type of integers in Lua.
By default this type is Int64LUA_INT_TYPE in luaconf.h.)
See lua_Integer.
The type of floats in Lua.
By default this type is DoubleLUA_FLOAT_TYPE in luaconf.h.)
See lua_Number.
nthFromBottom :: CInt -> StackIndex #
Stack index of the nth element from the bottom of the stack.
nthFromTop :: CInt -> StackIndex #
Stack index of the nth element from the top of the stack.
stackTop :: StackIndex #
Top of the stack
Bottom of the stack
The number of arguments expected a function.
Constructors
| NumArgs | |
Fields
| |
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
fromRelationalOperator :: RelationalOperator -> CInt #
Convert relation operator to its C representation.
Lua status values.
newtype StatusCode #
Integer code used to signal the status of a thread or computation.
See Status
Constructors
| StatusCode CInt |
Instances
toStatus :: StatusCode -> Status #
Convert C integer constant to LuaStatus
References
Reference to a stored value.
fromReference :: Reference -> CInt #
Convert a reference to its C representation.
toReference :: CInt -> Reference #
Create a reference from its C representation.