Foreign.Lua.Raw.Types

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

Documentation

newtype State

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

Defined in Foreign.Lua.Raw.Types

Methods

(==) :: State -> State -> Bool

(/=) :: State -> State -> Bool

Generic State

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

Defined in Foreign.Lua.Types.Pushable

Methods

push :: CFunction -> Lua ()

Peekable CFunction

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua CFunction

Peekable State

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua State

type Rep State

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))

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.

data GCCONTROL

Enumeration used by gc function.

Constructors

GCSTOP

GCRESTART

GCCOLLECT

GCCOUNT

GCCOUNTB

GCSTEP

GCSETPAUSE

GCSETSTEPMUL

Instances

Enum GCCONTROL

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

Defined in Foreign.Lua.Raw.Types

Methods

(==) :: GCCONTROL -> GCCONTROL -> Bool

(/=) :: GCCONTROL -> GCCONTROL -> Bool

Ord GCCONTROL

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

Defined in Foreign.Lua.Raw.Types

Methods

showsPrec :: Int -> GCCONTROL -> ShowS

show :: GCCONTROL -> String

showList :: [GCCONTROL] -> ShowS

data Type

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

Defined in Foreign.Lua.Raw.Types

Methods

minBound :: Type

maxBound :: Type

Enum Type

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

Defined in Foreign.Lua.Raw.Types

Methods

(==) :: Type -> Type -> Bool

(/=) :: Type -> Type -> Bool

Ord Type

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

Defined in Foreign.Lua.Raw.Types

Methods

showsPrec :: Int -> Type -> ShowS

show :: Type -> String

showList :: [Type] -> ShowS

newtype TypeCode

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

Constructors

TypeCode

Fields

• fromTypeCode :: CInt

Instances

Eq TypeCode

Defined in Foreign.Lua.Raw.Types

Methods

(==) :: TypeCode -> TypeCode -> Bool

(/=) :: TypeCode -> TypeCode -> Bool

Ord TypeCode

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

Defined in Foreign.Lua.Raw.Types

Methods

showsPrec :: Int -> TypeCode -> ShowS

show :: TypeCode -> String

showList :: [TypeCode] -> ShowS

fromType :: Type -> TypeCode

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

toType :: TypeCode -> Type

Convert numerical code to lua type.

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, 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

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

Defined in Foreign.Lua.Raw.Types

Methods

(==) :: LuaBool -> LuaBool -> Bool

(/=) :: LuaBool -> LuaBool -> Bool

Show LuaBool

Defined in Foreign.Lua.Raw.Types

Methods

showsPrec :: Int -> LuaBool -> ShowS

show :: LuaBool -> String

showList :: [LuaBool] -> ShowS

Storable LuaBool

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

Lua representation of the value interpreted as false.

true :: LuaBool

Generic Lua representation of a value interpreted as being true.

fromLuaBool :: LuaBool -> Bool

Convert a LuaBool to a Haskell Bool.

toLuaBool :: Bool -> LuaBool

Convert a Haskell Bool to a LuaBool.

newtype Integer

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

Defined in Foreign.Lua.Raw.Types

Methods

minBound :: Integer

maxBound :: Integer

Enum Integer

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

Defined in Foreign.Lua.Raw.Types

Methods

(==) :: Integer -> Integer -> Bool

(/=) :: Integer -> Integer -> Bool

Integral Integer

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

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

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

Defined in Foreign.Lua.Raw.Types

Methods

toRational :: Integer -> Rational

Show Integer

Defined in Foreign.Lua.Raw.Types

Methods

showsPrec :: Int -> Integer -> ShowS

show :: Integer -> String

showList :: [Integer] -> ShowS

Pushable Integer

Defined in Foreign.Lua.Types.Pushable

Methods

push :: Integer -> Lua ()

Peekable Integer

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua Integer

newtype Number

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

Defined in Foreign.Lua.Raw.Types

Methods

(==) :: Number -> Number -> Bool

(/=) :: Number -> Number -> Bool

Floating Number

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

Defined in Foreign.Lua.Raw.Types

Methods

(/) :: Number -> Number -> Number

recip :: Number -> Number

fromRational :: Rational -> Number

Num Number

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

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

Defined in Foreign.Lua.Raw.Types

Methods

toRational :: Number -> Rational

RealFloat Number

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

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

Defined in Foreign.Lua.Raw.Types

Methods

showsPrec :: Int -> Number -> ShowS

show :: Number -> String

showList :: [Number] -> ShowS

Pushable Number

Defined in Foreign.Lua.Types.Pushable

Methods

push :: Number -> Lua ()

Peekable Number

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua Number

newtype StackIndex

A stack index

Constructors

StackIndex

Fields

• fromStackIndex :: CInt

Instances

Enum StackIndex

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

Defined in Foreign.Lua.Raw.Types

Methods

(==) :: StackIndex -> StackIndex -> Bool

(/=) :: StackIndex -> StackIndex -> Bool

Num StackIndex

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

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

Defined in Foreign.Lua.Raw.Types

Methods

showsPrec :: Int -> StackIndex -> ShowS

show :: StackIndex -> String

showList :: [StackIndex] -> ShowS

newtype NumArgs

The number of arguments consumed curing a function call.

Constructors

NumArgs

Fields

• fromNumArgs :: CInt

Instances

Eq NumArgs

Defined in Foreign.Lua.Raw.Types

Methods

(==) :: NumArgs -> NumArgs -> Bool

(/=) :: NumArgs -> NumArgs -> Bool

Num NumArgs

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

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

Defined in Foreign.Lua.Raw.Types

Methods

showsPrec :: Int -> NumArgs -> ShowS

show :: NumArgs -> String

showList :: [NumArgs] -> ShowS

newtype NumResults

The number of results returned by a function call.

Constructors

NumResults

Fields

• fromNumResults :: CInt

Instances

Eq NumResults

Defined in Foreign.Lua.Raw.Types

Methods

(==) :: NumResults -> NumResults -> Bool

(/=) :: NumResults -> NumResults -> Bool

Num NumResults

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

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

Defined in Foreign.Lua.Raw.Types

Methods

showsPrec :: Int -> NumResults -> ShowS

show :: NumResults -> String

showList :: [NumResults] -> ShowS

Pushable CFunction

Defined in Foreign.Lua.Types.Pushable

Methods

push :: CFunction -> Lua ()

Peekable CFunction

Defined in Foreign.Lua.Types.Peekable

Methods

peek :: StackIndex -> Lua CFunction

ToHaskellFunction HaskellFunction

Defined in Foreign.Lua.FunctionCalling

Methods

toHsFun :: StackIndex -> HaskellFunction -> Lua NumResults

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.Raw.Types

Methods

(==) :: RelationalOperator -> RelationalOperator -> Bool

(/=) :: RelationalOperator -> RelationalOperator -> Bool

Ord RelationalOperator

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

Defined in Foreign.Lua.Raw.Types

Methods

showsPrec :: Int -> RelationalOperator -> ShowS

show :: RelationalOperator -> String

showList :: [RelationalOperator] -> ShowS

fromRelationalOperator :: RelationalOperator -> CInt

Convert relation operator to its C representation.

data Status

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

Defined in Foreign.Lua.Raw.Types

Methods

(==) :: Status -> Status -> Bool

(/=) :: Status -> Status -> Bool

Show Status

Defined in Foreign.Lua.Raw.Types

Methods

showsPrec :: Int -> Status -> ShowS

show :: Status -> String

showList :: [Status] -> ShowS

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.Raw.Types

Methods

(==) :: StatusCode -> StatusCode -> Bool

(/=) :: StatusCode -> StatusCode -> Bool

Storable StatusCode

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

Convert C integer constant to Status.