BlowTorch
 All Classes Namespaces Files Functions Variables Enumerator Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
org.keplerproject.luajava.LuaState Class Reference

Public Member Functions

int getStateId ()
 
synchronized void close ()
 
synchronized boolean isClosed ()
 
long getCPtrPeer ()
 
LuaState newThread ()
 
int getTop ()
 
void setTop (int idx)
 
void pushValue (int idx)
 
void remove (int idx)
 
void insert (int idx)
 
void replace (int idx)
 
int checkStack (int sz)
 
void xmove (LuaState to, int n)
 
boolean isNumber (int idx)
 
boolean isString (int idx)
 
boolean isFunction (int idx)
 
boolean isCFunction (int idx)
 
boolean isUserdata (int idx)
 
boolean isTable (int idx)
 
boolean isBoolean (int idx)
 
boolean isNil (int idx)
 
boolean isThread (int idx)
 
boolean isNone (int idx)
 
boolean isNoneOrNil (int idx)
 
int type (int idx)
 
String typeName (int tp)
 
int equal (int idx1, int idx2)
 
int rawequal (int idx1, int idx2)
 
int lessthan (int idx1, int idx2)
 
double toNumber (int idx)
 
int toInteger (int idx)
 
boolean toBoolean (int idx)
 
String toString (int idx)
 
byte[] toBytes (int idx)
 
int strLen (int idx)
 
int objLen (int idx)
 
LuaState toThread (int idx)
 
void pushNil ()
 
void pushNumber (double db)
 
void pushInteger (int integer)
 
void pushString (String str)
 
void pushString (byte[] bytes)
 
void pushBoolean (boolean bool)
 
void getTable (int idx)
 
void getField (int idx, String k)
 
void rawGet (int idx)
 
void rawGetI (int idx, int n)
 
void createTable (int narr, int nrec)
 
void newTable ()
 
int getMetaTable (int idx)
 
void getFEnv (int idx)
 
void setTable (int idx)
 
void setField (int idx, String k)
 
void rawSet (int idx)
 
void rawSetI (int idx, int n)
 
int setMetaTable (int idx)
 
int setFEnv (int idx)
 
void call (int nArgs, int nResults)
 
int pcall (int nArgs, int nResults, int errFunc)
 
int yield (int nResults)
 
int resume (int nArgs)
 
int status ()
 
int gc (int what, int data)
 
int getGcCount ()
 
int next (int idx)
 
int error ()
 
void concat (int n)
 
int LdoFile (String fileName)
 
int LdoString (String str)
 
int LgetMetaField (int obj, String e)
 
int LcallMeta (int obj, String e)
 
int Ltyperror (int nArg, String tName)
 
int LargError (int numArg, String extraMsg)
 
String LcheckString (int numArg)
 
String LoptString (int numArg, String def)
 
double LcheckNumber (int numArg)
 
double LoptNumber (int numArg, double def)
 
int LcheckInteger (int numArg)
 
int LoptInteger (int numArg, int def)
 
void LcheckStack (int sz, String msg)
 
void LcheckType (int nArg, int t)
 
void LcheckAny (int nArg)
 
int LnewMetatable (String tName)
 
void LgetMetatable (String tName)
 
void Lwhere (int lvl)
 
int Lref (int t)
 
void LunRef (int t, int ref)
 
int LgetN (int t)
 
void LsetN (int t, int n)
 
int LloadFile (String fileName)
 
int LloadString (String s)
 
int LloadBuffer (byte[] buff, String name)
 
String Lgsub (String s, String p, String r)
 
String LfindTable (int idx, String fname, int szhint)
 
void pop (int n)
 
synchronized void getGlobal (String global)
 
synchronized void setGlobal (String name)
 
void openBase ()
 
void openTable ()
 
void openIo ()
 
void openOs ()
 
void openString ()
 
void openMath ()
 
void openDebug ()
 
void openPackage ()
 
void openLibs ()
 
Object getObjectFromUserdata (int idx) throws LuaException
 
boolean isObject (int idx)
 
void pushJavaObject (Object obj)
 
void pushJavaFunction (JavaFunction func) throws LuaException
 
boolean isJavaFunction (int idx)
 
void pushObjectValue (Object obj) throws LuaException
 
synchronized Object toJavaObject (int idx) throws LuaException
 
LuaObject getLuaObject (String globalName)
 
LuaObject getLuaObject (LuaObject parent, String name) throws LuaException
 
LuaObject getLuaObject (LuaObject parent, Number name) throws LuaException
 
LuaObject getLuaObject (LuaObject parent, LuaObject name) throws LuaException
 
LuaObject getLuaObject (int index)
 

Static Public Member Functions

static Number convertLuaNumber (Double db, Class retType)
 

Static Public Attributes

final static Integer LUA_GLOBALSINDEX = new Integer(-10002)
 
final static Integer LUA_REGISTRYINDEX = new Integer(-10000)
 
final static Integer LUA_TNONE = new Integer(-1)
 
final static Integer LUA_TNIL = new Integer(0)
 
final static Integer LUA_TBOOLEAN = new Integer(1)
 
final static Integer LUA_TLIGHTUSERDATA = new Integer(2)
 
final static Integer LUA_TNUMBER = new Integer(3)
 
final static Integer LUA_TSTRING = new Integer(4)
 
final static Integer LUA_TTABLE = new Integer(5)
 
final static Integer LUA_TFUNCTION = new Integer(6)
 
final static Integer LUA_TUSERDATA = new Integer(7)
 
final static Integer LUA_TTHREAD = new Integer(8)
 
final static Integer LUA_MULTRET = new Integer(-1)
 
final static Integer LUA_ERRRUN = new Integer(1)
 
final static Integer LUA_YIELD = new Integer(2)
 
final static Integer LUA_ERRSYNTAX = new Integer(3)
 
final static Integer LUA_ERRMEM = new Integer(4)
 
final static Integer LUA_ERRERR = new Integer(5)
 
final static Integer LUA_GCSTOP = new Integer(0)
 
final static Integer LUA_GCRESTART = new Integer(1)
 
final static Integer LUA_GCCOLLECT = new Integer(2)
 
final static Integer LUA_GCCOUNT = new Integer(3)
 
final static Integer LUA_GCCOUNTB = new Integer(4)
 
final static Integer LUA_GCSTEP = new Integer(5)
 
final static Integer LUA_GCSETPAUSE = new Integer(6)
 
final static Integer LUA_GCSETSTEPMUL = new Integer(7)
 

Protected Member Functions

 LuaState (int stateId)
 
 LuaState (CPtr luaState)
 

Detailed Description

LuaState if the main class of LuaJava for the Java developer. LuaState is a mapping of most of Lua's C API functions. LuaState also provides many other functions that will be used to manipulate objects between Lua and Java.

Author
Thiago Ponte

Constructor & Destructor Documentation

org.keplerproject.luajava.LuaState.LuaState ( int  stateId)
protected

Constructor to instance a new LuaState and initialize it with LuaJava's functions

Parameters
stateId

Here is the caller graph for this function:

org.keplerproject.luajava.LuaState.LuaState ( CPtr  luaState)
protected

Receives a existing state and initializes it

Parameters
luaState

Here is the call graph for this function:

Member Function Documentation

void org.keplerproject.luajava.LuaState.call ( int  nArgs,
int  nResults 
)
int org.keplerproject.luajava.LuaState.checkStack ( int  sz)
synchronized void org.keplerproject.luajava.LuaState.close ( )

Closes state and removes the object from the LuaStateFactory

Here is the call graph for this function:

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.concat ( int  n)
static Number org.keplerproject.luajava.LuaState.convertLuaNumber ( Double  db,
Class  retType 
)
static

When you call a function in lua, it may return a number, and the number will be interpreted as a Double.
This function converts the number into a type specified by retType

Parameters
dblua number to be converted
retTypetype to convert to
Returns
The converted number

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.createTable ( int  narr,
int  nrec 
)
int org.keplerproject.luajava.LuaState.equal ( int  idx1,
int  idx2 
)
int org.keplerproject.luajava.LuaState.error ( )
int org.keplerproject.luajava.LuaState.gc ( int  what,
int  data 
)
long org.keplerproject.luajava.LuaState.getCPtrPeer ( )

Return the long representing the LuaState pointer

Returns
long

Here is the call graph for this function:

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.getFEnv ( int  idx)
void org.keplerproject.luajava.LuaState.getField ( int  idx,
String  k 
)

Here is the caller graph for this function:

int org.keplerproject.luajava.LuaState.getGcCount ( )
synchronized void org.keplerproject.luajava.LuaState.getGlobal ( String  global)

Here is the caller graph for this function:

LuaObject org.keplerproject.luajava.LuaState.getLuaObject ( String  globalName)

Creates a reference to an object in the variable globalName

Parameters
globalName
Returns
LuaObject

Here is the caller graph for this function:

LuaObject org.keplerproject.luajava.LuaState.getLuaObject ( LuaObject  parent,
String  name 
) throws LuaException

Creates a reference to an object inside another object

Parameters
parentThe Lua Table or Userdata that contains the Field.
nameThe name that index the field
Returns
LuaObject
Exceptions
LuaExceptionif parent is not a table or userdata

Here is the call graph for this function:

LuaObject org.keplerproject.luajava.LuaState.getLuaObject ( LuaObject  parent,
Number  name 
) throws LuaException

This constructor creates a LuaObject from a table that is indexed by a number.

Parameters
parentThe Lua Table or Userdata that contains the Field.
nameThe name (number) that index the field
Returns
LuaObject
Exceptions
LuaExceptionWhen the parent object isn't a Table or Userdata

Here is the call graph for this function:

LuaObject org.keplerproject.luajava.LuaState.getLuaObject ( LuaObject  parent,
LuaObject  name 
) throws LuaException

This constructor creates a LuaObject from a table that is indexed by any LuaObject.

Parameters
parentThe Lua Table or Userdata that contains the Field.
nameThe name (LuaObject) that index the field
Returns
LuaObject
Exceptions
LuaExceptionWhen the parent object isn't a Table or Userdata

Here is the call graph for this function:

LuaObject org.keplerproject.luajava.LuaState.getLuaObject ( int  index)

Creates a reference to an object in the index position of the stack

Parameters
indexposition on the stack
Returns
LuaObject
int org.keplerproject.luajava.LuaState.getMetaTable ( int  idx)
Object org.keplerproject.luajava.LuaState.getObjectFromUserdata ( int  idx) throws LuaException

Gets a Object from Lua

Parameters
idxindex of the lua stack
Returns
Object
Exceptions
LuaExceptionif the lua object does not represent a java object.

Here is the caller graph for this function:

int org.keplerproject.luajava.LuaState.getStateId ( )

Returns this state's index value.

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.getTable ( int  idx)

Here is the caller graph for this function:

int org.keplerproject.luajava.LuaState.getTop ( )

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.insert ( int  idx)
boolean org.keplerproject.luajava.LuaState.isBoolean ( int  idx)

Here is the caller graph for this function:

boolean org.keplerproject.luajava.LuaState.isCFunction ( int  idx)
synchronized boolean org.keplerproject.luajava.LuaState.isClosed ( )

Returns true if state is closed.

boolean org.keplerproject.luajava.LuaState.isFunction ( int  idx)

Here is the caller graph for this function:

boolean org.keplerproject.luajava.LuaState.isJavaFunction ( int  idx)

Returns whether a userdata contains a Java Function

Parameters
idxindex of the lua stack
Returns
boolean

Here is the caller graph for this function:

boolean org.keplerproject.luajava.LuaState.isNil ( int  idx)

Here is the caller graph for this function:

boolean org.keplerproject.luajava.LuaState.isNone ( int  idx)
boolean org.keplerproject.luajava.LuaState.isNoneOrNil ( int  idx)
boolean org.keplerproject.luajava.LuaState.isNumber ( int  idx)

Here is the caller graph for this function:

boolean org.keplerproject.luajava.LuaState.isObject ( int  idx)

Tells whether a lua index contains a java Object

Parameters
idxindex of the lua stack
Returns
boolean

Here is the caller graph for this function:

boolean org.keplerproject.luajava.LuaState.isString ( int  idx)

Here is the caller graph for this function:

boolean org.keplerproject.luajava.LuaState.isTable ( int  idx)

Here is the caller graph for this function:

boolean org.keplerproject.luajava.LuaState.isThread ( int  idx)
boolean org.keplerproject.luajava.LuaState.isUserdata ( int  idx)

Here is the caller graph for this function:

int org.keplerproject.luajava.LuaState.LargError ( int  numArg,
String  extraMsg 
)
int org.keplerproject.luajava.LuaState.LcallMeta ( int  obj,
String  e 
)
void org.keplerproject.luajava.LuaState.LcheckAny ( int  nArg)
int org.keplerproject.luajava.LuaState.LcheckInteger ( int  numArg)
double org.keplerproject.luajava.LuaState.LcheckNumber ( int  numArg)
void org.keplerproject.luajava.LuaState.LcheckStack ( int  sz,
String  msg 
)
String org.keplerproject.luajava.LuaState.LcheckString ( int  numArg)
void org.keplerproject.luajava.LuaState.LcheckType ( int  nArg,
int  t 
)
int org.keplerproject.luajava.LuaState.LdoFile ( String  fileName)
int org.keplerproject.luajava.LuaState.LdoString ( String  str)
int org.keplerproject.luajava.LuaState.lessthan ( int  idx1,
int  idx2 
)
String org.keplerproject.luajava.LuaState.LfindTable ( int  idx,
String  fname,
int  szhint 
)
int org.keplerproject.luajava.LuaState.LgetMetaField ( int  obj,
String  e 
)
void org.keplerproject.luajava.LuaState.LgetMetatable ( String  tName)
int org.keplerproject.luajava.LuaState.LgetN ( int  t)
String org.keplerproject.luajava.LuaState.Lgsub ( String  s,
String  p,
String  r 
)
int org.keplerproject.luajava.LuaState.LloadBuffer ( byte[]  buff,
String  name 
)

Here is the caller graph for this function:

int org.keplerproject.luajava.LuaState.LloadFile ( String  fileName)

Here is the caller graph for this function:

int org.keplerproject.luajava.LuaState.LloadString ( String  s)

Here is the caller graph for this function:

int org.keplerproject.luajava.LuaState.LnewMetatable ( String  tName)
int org.keplerproject.luajava.LuaState.LoptInteger ( int  numArg,
int  def 
)
double org.keplerproject.luajava.LuaState.LoptNumber ( int  numArg,
double  def 
)
String org.keplerproject.luajava.LuaState.LoptString ( int  numArg,
String  def 
)
int org.keplerproject.luajava.LuaState.Lref ( int  t)
void org.keplerproject.luajava.LuaState.LsetN ( int  t,
int  n 
)
int org.keplerproject.luajava.LuaState.Ltyperror ( int  nArg,
String  tName 
)
void org.keplerproject.luajava.LuaState.LunRef ( int  t,
int  ref 
)

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.Lwhere ( int  lvl)
void org.keplerproject.luajava.LuaState.newTable ( )

Here is the caller graph for this function:

LuaState org.keplerproject.luajava.LuaState.newThread ( )

Here is the call graph for this function:

int org.keplerproject.luajava.LuaState.next ( int  idx)
int org.keplerproject.luajava.LuaState.objLen ( int  idx)
void org.keplerproject.luajava.LuaState.openBase ( )
void org.keplerproject.luajava.LuaState.openDebug ( )
void org.keplerproject.luajava.LuaState.openIo ( )
void org.keplerproject.luajava.LuaState.openLibs ( )

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.openMath ( )
void org.keplerproject.luajava.LuaState.openOs ( )
void org.keplerproject.luajava.LuaState.openPackage ( )
void org.keplerproject.luajava.LuaState.openString ( )
void org.keplerproject.luajava.LuaState.openTable ( )
int org.keplerproject.luajava.LuaState.pcall ( int  nArgs,
int  nResults,
int  errFunc 
)

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.pop ( int  n)

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.pushBoolean ( boolean  bool)

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.pushInteger ( int  integer)
void org.keplerproject.luajava.LuaState.pushJavaFunction ( JavaFunction  func) throws LuaException

Pushes a JavaFunction into the state stack

Parameters
func

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.pushJavaObject ( Object  obj)

Pushes a Java Object into the lua stack.
This function does not check if the object is from a class that could be represented by a lua type. Eg: java.lang.String could be a lua string.

Parameters
objObject to be pushed into lua

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.pushNil ( )

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.pushNumber ( double  db)

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.pushObjectValue ( Object  obj) throws LuaException

Pushes into the stack any object value.
This function checks if the object could be pushed as a lua type, if not pushes the java object.

Parameters
obj

Here is the call graph for this function:

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.pushString ( String  str)

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.pushString ( byte[]  bytes)
void org.keplerproject.luajava.LuaState.pushValue ( int  idx)
int org.keplerproject.luajava.LuaState.rawequal ( int  idx1,
int  idx2 
)
void org.keplerproject.luajava.LuaState.rawGet ( int  idx)
void org.keplerproject.luajava.LuaState.rawGetI ( int  idx,
int  n 
)

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.rawSet ( int  idx)
void org.keplerproject.luajava.LuaState.rawSetI ( int  idx,
int  n 
)
void org.keplerproject.luajava.LuaState.remove ( int  idx)

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.replace ( int  idx)
int org.keplerproject.luajava.LuaState.resume ( int  nArgs)
int org.keplerproject.luajava.LuaState.setFEnv ( int  idx)
void org.keplerproject.luajava.LuaState.setField ( int  idx,
String  k 
)
synchronized void org.keplerproject.luajava.LuaState.setGlobal ( String  name)

Here is the caller graph for this function:

int org.keplerproject.luajava.LuaState.setMetaTable ( int  idx)
void org.keplerproject.luajava.LuaState.setTable ( int  idx)

Here is the caller graph for this function:

void org.keplerproject.luajava.LuaState.setTop ( int  idx)
int org.keplerproject.luajava.LuaState.status ( )
int org.keplerproject.luajava.LuaState.strLen ( int  idx)
boolean org.keplerproject.luajava.LuaState.toBoolean ( int  idx)

Here is the caller graph for this function:

byte [] org.keplerproject.luajava.LuaState.toBytes ( int  idx)

Here is the caller graph for this function:

int org.keplerproject.luajava.LuaState.toInteger ( int  idx)
synchronized Object org.keplerproject.luajava.LuaState.toJavaObject ( int  idx) throws LuaException

Function that returns a Java Object equivalent to the one in the given position of the Lua Stack.

Parameters
idxIndex in the Lua Stack
Returns
Java object equivalent to the Lua one

Here is the call graph for this function:

Here is the caller graph for this function:

double org.keplerproject.luajava.LuaState.toNumber ( int  idx)

Here is the caller graph for this function:

String org.keplerproject.luajava.LuaState.toString ( int  idx)

Here is the caller graph for this function:

LuaState org.keplerproject.luajava.LuaState.toThread ( int  idx)

Here is the call graph for this function:

int org.keplerproject.luajava.LuaState.type ( int  idx)

Here is the caller graph for this function:

String org.keplerproject.luajava.LuaState.typeName ( int  tp)
void org.keplerproject.luajava.LuaState.xmove ( LuaState  to,
int  n 
)
int org.keplerproject.luajava.LuaState.yield ( int  nResults)

Member Data Documentation

final static Integer org.keplerproject.luajava.LuaState.LUA_ERRERR = new Integer(5)
static

error while running the error handler function.

final static Integer org.keplerproject.luajava.LuaState.LUA_ERRMEM = new Integer(4)
static

memory allocation error. For such errors, Lua does not call the error handler function.

final static Integer org.keplerproject.luajava.LuaState.LUA_ERRRUN = new Integer(1)
static

a runtime error.

final static Integer org.keplerproject.luajava.LuaState.LUA_ERRSYNTAX = new Integer(3)
static

syntax error during pre-compilation.

final static Integer org.keplerproject.luajava.LuaState.LUA_GCCOLLECT = new Integer(2)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_GCCOUNT = new Integer(3)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_GCCOUNTB = new Integer(4)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_GCRESTART = new Integer(1)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_GCSETPAUSE = new Integer(6)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_GCSETSTEPMUL = new Integer(7)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_GCSTEP = new Integer(5)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_GCSTOP = new Integer(0)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_GLOBALSINDEX = new Integer(-10002)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_MULTRET = new Integer(-1)
static

Specifies that an unspecified (multiple) number of return arguments will be returned by a call.

final static Integer org.keplerproject.luajava.LuaState.LUA_REGISTRYINDEX = new Integer(-10000)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_TBOOLEAN = new Integer(1)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_TFUNCTION = new Integer(6)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_TLIGHTUSERDATA = new Integer(2)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_TNIL = new Integer(0)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_TNONE = new Integer(-1)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_TNUMBER = new Integer(3)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_TSTRING = new Integer(4)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_TTABLE = new Integer(5)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_TTHREAD = new Integer(8)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_TUSERDATA = new Integer(7)
static
final static Integer org.keplerproject.luajava.LuaState.LUA_YIELD = new Integer(2)
static

The documentation for this class was generated from the following file: