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.
Synopsis
- 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 => 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
- nthFromBottom :: CInt -> StackIndex
- nthFromTop :: CInt -> StackIndex
- stackTop :: StackIndex
- stackBottom :: StackIndex
- newtype NumArgs = NumArgs {
- fromNumArgs :: CInt
- newtype NumResults = NumResults {
- fromNumResults :: CInt
- 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 Source # | |
Functor Lua Source # | |
Applicative Lua Source # | |
MonadCatch Lua Source # | |
Defined in Foreign.Lua.Core.Types | |
MonadMask Lua Source # | |
MonadThrow Lua Source # | |
Defined in Foreign.Lua.Core.Types | |
MonadIO Lua Source # | |
Defined in Foreign.Lua.Core.Types | |
Alternative Lua | |
ToHaskellFunction HaskellFunction Source # | |
Defined in Foreign.Lua.FunctionCalling Methods toHsFun :: StackIndex -> HaskellFunction -> Lua NumResults Source # | |
MonadReader State Lua Source # | |
Peekable a => LuaCallFunc (Lua a) Source # | |
Pushable a => ToHaskellFunction (Lua a) Source # | |
Defined in Foreign.Lua.FunctionCalling Methods toHsFun :: StackIndex -> Lua a -> Lua NumResults 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 # | |
Generic State Source # | |
Pushable CFunction Source # | |
Peekable CFunction Source # | |
Defined in Foreign.Lua.Types.Peekable | |
Peekable State Source # | |
Defined in Foreign.Lua.Types.Peekable | |
MonadReader State Lua Source # | |
type Rep State Source # | |
Defined in Foreign.Lua.Core.Types type Rep State = D1 (MetaData "State" "Foreign.Lua.Core.Types" "hslua-1.0.3.1-5FrYYD1vdeH8CPf36FBRHx" 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
. 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 lua_load
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.
runWith :: State -> Lua a -> IO a Source #
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 |
Instances
Enum GCCONTROL Source # | |
Defined in Foreign.Lua.Core.Types | |
Eq GCCONTROL Source # | |
Ord GCCONTROL Source # | |
Defined in Foreign.Lua.Core.Types | |
Show GCCONTROL Source # | |
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
|
fromType :: Type -> TypeCode Source #
Convert a lua Type to a type code which can be passed to the C API.
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,
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.
Boolean value returned by a Lua C API function. This is a
and
interpreted as CInt
iff the value is False
0
,
otherwise.True
Constructors
LuaBool CInt |
Instances
Eq LuaBool Source # | |
Show LuaBool Source # | |
Storable LuaBool Source # | |
Defined in Foreign.Lua.Core.Types Methods peekElemOff :: Ptr LuaBool -> Int -> IO LuaBool pokeElemOff :: Ptr LuaBool -> Int -> LuaBool -> IO () peekByteOff :: Ptr b -> Int -> IO LuaBool pokeByteOff :: Ptr b -> Int -> LuaBool -> IO () |
fromLuaBool :: LuaBool -> Bool Source #
Convert a
to a Haskell LuaBool
.Bool
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.
Constructors
Integer Int64 |
Instances
Bounded Integer Source # | |
Defined in Foreign.Lua.Core.Types | |
Enum Integer Source # | |
Defined in Foreign.Lua.Core.Types | |
Eq Integer Source # | |
Integral Integer Source # | |
Defined in Foreign.Lua.Core.Types | |
Num Integer Source # | |
Ord Integer Source # | |
Real Integer Source # | |
Defined in Foreign.Lua.Core.Types Methods toRational :: Integer -> Rational | |
Show Integer Source # | |
Pushable Integer Source # | |
Peekable Integer Source # | |
Defined in Foreign.Lua.Types.Peekable |
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.
Constructors
Number Double |
Instances
Eq Number Source # | |
Floating Number Source # | |
Fractional Number Source # | |
Defined in Foreign.Lua.Core.Types | |
Num Number Source # | |
Ord Number Source # | |
Real Number Source # | |
Defined in Foreign.Lua.Core.Types Methods toRational :: Number -> Rational | |
RealFloat Number Source # | |
Defined in Foreign.Lua.Core.Types Methods floatRadix :: Number -> Integer floatDigits :: Number -> Int floatRange :: Number -> (Int, Int) decodeFloat :: Number -> (Integer, Int) encodeFloat :: Integer -> Int -> Number significand :: Number -> Number scaleFloat :: Int -> Number -> Number isInfinite :: Number -> Bool isDenormalized :: Number -> Bool isNegativeZero :: Number -> Bool | |
RealFrac Number Source # | |
Show Number Source # | |
Pushable Number Source # | |
Peekable Number Source # | |
Defined in Foreign.Lua.Types.Peekable |
newtype StackIndex Source #
A stack index
Constructors
StackIndex | |
Fields
|
Instances
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
The number of arguments expected a function.
Constructors
NumArgs | |
Fields
|
newtype NumResults Source #
The number of results returned by a function call.
Constructors
NumResults | |
Fields
|
Instances
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 # | |
Defined in Foreign.Lua.Core.Types Methods (==) :: RelationalOperator -> RelationalOperator -> Bool (/=) :: RelationalOperator -> RelationalOperator -> Bool | |
Ord RelationalOperator Source # | |
Defined in Foreign.Lua.Core.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 # | |
Defined in Foreign.Lua.Core.Types Methods showsPrec :: Int -> RelationalOperator -> ShowS show :: RelationalOperator -> String showList :: [RelationalOperator] -> ShowS |
fromRelationalOperator :: RelationalOperator -> CInt Source #
Convert relation operator to its C representation.
Lua status values.
newtype StatusCode Source #
Integer code used to signal the status of a thread or computation.
See
.Status
Constructors
StatusCode CInt |
Instances
Eq StatusCode Source # | |
Defined in Foreign.Lua.Core.Types |
toStatus :: StatusCode -> Status Source #
Convert C integer constant to
.LuaStatus
References
fromReference :: Reference -> CInt Source #
Convert a reference to its C representation.
toReference :: CInt -> Reference Source #
Create a reference from its C representation.