lua-2.3.2: Lua, an embeddable scripting language
Copyright© 2007–2012 Gracjan Polak;
© 2012–2016 Ömer Sinan Ağacan;
© 2017-2023 Albert Krewinkel
LicenseMIT
MaintainerAlbert Krewinkel <tarleb@hslua.org>
Stabilitybeta
PortabilityForeignFunctionInterface
Safe HaskellSafe-Inferred
LanguageHaskell2010

Lua.Constants

Description

Lua constants

Synopsis

Version and copyright information

pattern LUA_VERSION :: String Source #

Lua version information in the form "Lua MAJOR.MINOR".

pattern LUA_RELEASE :: String Source #

Lua version information in the form "Lua MAJOR.MINOR.RELEASE".

pattern LUA_COPYRIGHT :: String Source #

Lua copyright information; includes the Lua release

Special values

pattern LUA_MULTRET :: NumResults Source #

Option for multiple returns in lua_pcall.

Pseudo-indices

pattern LUA_REGISTRYINDEX :: StackIndex Source #

Stack index of the Lua registry.

Basic types

pattern LUA_TNONE :: TypeCode Source #

Non-valid stack index

pattern LUA_TNIL :: TypeCode Source #

Type of Lua's nil value

pattern LUA_TBOOLEAN :: TypeCode Source #

Type of Lua booleans

pattern LUA_TLIGHTUSERDATA :: TypeCode Source #

Type of light userdata

pattern LUA_TNUMBER :: TypeCode Source #

Type of Lua numbers. See Number

pattern LUA_TSTRING :: TypeCode Source #

Type of Lua string values

pattern LUA_TTABLE :: TypeCode Source #

Type of Lua tables

pattern LUA_TFUNCTION :: TypeCode Source #

Type of functions, either normal or CFunction

pattern LUA_TUSERDATA :: TypeCode Source #

Type of full user data

pattern LUA_TTHREAD :: TypeCode Source #

Type of Lua threads

Status codes

pattern LUA_OK :: StatusCode Source #

Success.

pattern LUA_YIELD :: StatusCode Source #

Yielding / suspended coroutine.

pattern LUA_ERRRUN :: StatusCode Source #

A runtime error.

pattern LUA_ERRSYNTAX :: StatusCode Source #

A syntax error.

pattern LUA_ERRMEM :: StatusCode Source #

Memory allocation error. For such errors, Lua does not call the message handler.

pattern LUA_ERRERR :: StatusCode Source #

Error while running the message handler.

pattern LUA_ERRFILE :: StatusCode Source #

File related error (e.g., the file cannot be opened or read).

Relational operator codes

pattern LUA_OPEQ :: OPCode Source #

Compares for equality (==)

pattern LUA_OPLT :: OPCode Source #

Compares for less than (<)

pattern LUA_OPLE :: OPCode Source #

Compares for less or equal (<=)

Codes for arithmetic operations

pattern LUA_OPADD :: ArithOPCode Source #

Performs addition (+).

pattern LUA_OPSUB :: ArithOPCode Source #

Performs subtraction (-)

pattern LUA_OPMUL :: ArithOPCode Source #

Performs multiplication (*)

pattern LUA_OPDIV :: ArithOPCode Source #

Performs float division (/)

pattern LUA_OPIDIV :: ArithOPCode Source #

Performs floor division (//)

pattern LUA_OPMOD :: ArithOPCode Source #

Performs modulo (%)

pattern LUA_OPPOW :: ArithOPCode Source #

Performs exponentiation (^)

pattern LUA_OPUNM :: ArithOPCode Source #

Performs mathematical negation (unary -)

pattern LUA_OPBNOT :: ArithOPCode Source #

Performs bitwise NOT (~)

pattern LUA_OPBAND :: ArithOPCode Source #

Performs bitwise AND (&)

pattern LUA_OPBOR :: ArithOPCode Source #

Performs bitwise OR (|)

pattern LUA_OPBXOR :: ArithOPCode Source #

Performs bitwise exclusive OR (~)

pattern LUA_OPSHL :: ArithOPCode Source #

Performs left shift (<<)

pattern LUA_OPSHR :: ArithOPCode Source #

Performs right shift (>>)

Garbage-collection options

pattern LUA_GCSTOP :: GCCode Source #

Stops the garbage collector.

pattern LUA_GCRESTART :: GCCode Source #

Restarts the garbage collector.

pattern LUA_GCCOLLECT :: GCCode Source #

Performs a full garbage-collection cycle.

pattern LUA_GCCOUNT :: GCCode Source #

Returns the current amount of memory (in Kbytes) in use by Lua.

pattern LUA_GCCOUNTB :: GCCode Source #

Returns the remainder of dividing the current amount of bytes of memory in use by Lua by 1024.

pattern LUA_GCSTEP :: GCCode Source #

Performs an incremental step of garbage collection.

pattern LUA_GCSETPAUSE :: GCCode Source #

Sets data as the new value for the pause of the collector (see §2.5) and returns the previous value of the pause.

pattern LUA_GCSETSTEPMUL :: GCCode Source #

Sets data as the new value for the step multiplier of the collector (see §2.5) and returns the previous value of the step multiplier.

pattern LUA_GCISRUNNING :: GCCode Source #

Returns a boolean that tells whether the collector is running (i.e., not stopped).

pattern LUA_GCGEN :: GCCode Source #

Changes the collector to generational mode.

pattern LUA_GCINC :: GCCode Source #

Changes the collector to incremental mode.

Predefined references

pattern LUA_REFNIL :: CInt Source #

Value signaling that no reference was created.

pattern LUA_NOREF :: CInt Source #

Value signaling that no reference was found.

Boolean

pattern TRUE :: LuaBool Source #

Value which Lua usually uses as True.

pattern FALSE :: LuaBool Source #

Value which Lua usually uses as False.