Package com.prineside.luaj.lib

Class DebugLib

java.lang.Object

com.prineside.luaj.Varargs

com.prineside.luaj.LuaValue

com.prineside.luaj.LuaFunction

com.prineside.luaj.lib.LibFunction

com.prineside.luaj.lib.TwoArgFunction

com.prineside.luaj.lib.DebugLib

All Implemented Interfaces:

com.esotericsoftware.kryo.KryoSerializable

public class DebugLib
extends TwoArgFunction
implements com.esotericsoftware.kryo.KryoSerializable

Subclass of LibFunction which implements the lua standard debug library.

The debug library in luaj tries to emulate the behavior of the corresponding C-based lua library. To do this, it must maintain a separate stack of calls to LuaClosure and LibFunction instances. Especially when lua-to-java bytecode compiling is being used this cannot be done in all cases.

Typically, this library is included as part of a call to either

 
 Globals globals = JsePlatform.debugGlobals();
 System.out.println( globals.get("debug").get("traceback").call() );
  

To instantiate and use it directly, link it into your globals table via LuaValue.load(LuaValue) using code such as:

 
 Globals globals = new Globals();
 globals.load(new JseBaseLib());
 globals.load(new PackageLib());
 globals.load(new DebugLib());
 System.out.println( globals.get("debug").get("traceback").call() );
  

This library exposes the entire state of lua code, and provides method to see and modify all underlying lua values within a Java VM so should not be exposed to client code in a shared server environment.

See Also:

• LibFunction
• Lua 5.2 Debug Lib Reference

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DebugLib.CallFrame
static class	DebugLib.CallStack
static final class	DebugLib.debug
static final class	DebugLib.gethook
static final class	DebugLib.getinfo
static final class	DebugLib.getlocal
static final class	DebugLib.getmetatable
static final class	DebugLib.getregistry
static final class	DebugLib.getupvalue
static final class	DebugLib.getuservalue
static final class	DebugLib.sethook
static final class	DebugLib.setlocal
static final class	DebugLib.setmetatable
static final class	DebugLib.setupvalue
static final class	DebugLib.setuservalue
static final class	DebugLib.traceback
static final class	DebugLib.upvalueid
static final class	DebugLib.upvaluejoin

Nested classes/interfaces inherited from class com.prineside.luaj.LuaValue

LuaValue.NillableSerializer, LuaValue.None

Nested classes/interfaces inherited from class com.prineside.luaj.Varargs

Varargs.ArrayVarargs

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	CALLS
static boolean	TRACE

Fields inherited from class com.prineside.luaj.lib.LibFunction

name, opcode

Fields inherited from class com.prineside.luaj.LuaFunction

s_metatable

Fields inherited from class com.prineside.luaj.LuaValue

ADD, CONCAT, DIV, EMPTYSTRING, ENV, EQ, FALSE, INDEX, LE, LEN, LT, METATABLE, MINUSONE, MOD, MODE, MUL, NEWINDEX, NIL, NILLABLE_SERIALIZER, NILS, NONE, NOVALS, ONE, POW, SUB, TBOOLEAN, TFUNCTION, TINT, TLIGHTUSERDATA, TNIL, TNONE, TNUMBER, TOSTRING, TRUE, TSTRING, TTABLE, TTHREAD, TUSERDATA, TVALUE, TYPE_NAMES, UNM, ZERO

Constructor Summary

Constructors

Constructor	Description
DebugLib()

Method Summary

Modifier and Type	Method	Description
LuaValue	call(LuaValue modname, LuaValue env)	Perform one-time initialization on the library by creating a table containing the library functions, adding that table to the supplied environment, adding the table to package.loaded, and returning table as the return value.
DebugLib.CallStack	callstack()
DebugLib.CallFrame	getCallFrame(int level)
static com.prineside.luaj.lib.DebugLib.NameWhat	getobjname(Prototype p, int lastpc, int reg)
void	onCall(LuaClosure c, Varargs varargs, LuaValue[] stack)
void	onCall(LuaFunction f)
void	onInstruction(int pc, Varargs v, int top)
void	onReturn()
void	read(com.esotericsoftware.kryo.Kryo kryo, com.esotericsoftware.kryo.io.Input input)
String	traceback(int level)
void	write(com.esotericsoftware.kryo.Kryo kryo, com.esotericsoftware.kryo.io.Output output)

Methods inherited from class com.prineside.luaj.lib.TwoArgFunction

call, call, call, invoke

Methods inherited from class com.prineside.luaj.lib.LibFunction

bind, bind, call, newupe, newupl, newupn, tojstring

Methods inherited from class com.prineside.luaj.LuaFunction

checkfunction, classnamestub, getmetatable, isfunction, name, optfunction, strvalue, type, typename

Methods inherited from class com.prineside.luaj.LuaValue

add, add, add, and, arg, arg1, argerror, argerror, aritherror, aritherror, arithmt, arithmtwith, assert_, buffer, call, callmt, cBool, cDouble, cFloat, checkboolean, checkclosure, checkdouble, checkglobals, checkint, checkjstring, checklong, checkmetatag, checknotnil, checknumber, checknumber, checkstring, checktable, checkthread, checkuserdata, checkuserdata, cInt, cNcDouble, cNcFloat, cNcInt, cObject, compareerror, compareerror, comparemt, concat, concat, concatmt, concatTo, concatTo, concatTo, cRegObject, cVarargs, cVarargs, cVarargs, cVarargs, cVarargs, cVarargs, cVarargs, cVarargs, div, div, div, divInto, eq, eq_b, eqmtcall, equals, error, get, get, get, gettable, gt, gt, gt, gt_b, gt_b, gt_b, gteq, gteq, gteq, gteq_b, gteq_b, gteq_b, illegal, inext, initupvalue1, invoke, invoke, invoke, invokemethod, invokemethod, invokemethod, invokemethod, isboolean, isclosure, isint, isinttype, islong, isnil, isnumber, isRegObject, isstring, istable, isthread, isuserdata, isuserdata, isvalidkey, len, lenerror, length, listOf, listOf, load, lt, lt, lt, lt_b, lt_b, lt_b, lteq, lteq, lteq, lteq_b, lteq_b, lteq_b, markAsConst, metatableOf, metatag, method, method, method, method, method, method, mod, mod, mod, modFrom, mul, mul, mul, narg, neg, neq, neq_b, next, not, onInvoke, optboolean, optclosure, optdouble, optint, optjstring, optlong, optnumber, optstring, opttable, optthread, optuserdata, optuserdata, optvalue, or, pow, pow, pow, powWith, powWith, presize, raweq, raweq, raweq, raweq, raweq, rawget, rawget, rawget, rawlen, rawset, rawset, rawset, rawset, rawset, rawset, rawset, rawsetlist, set, set, set, set, set, set, set, setmetatable, settable, strcmp, strcmp, strongvalue, sub, sub, sub, subargs, subFrom, subFrom, tableOf, tableOf, tableOf, tableOf, tableOf, tableOf, tailcallOf, testfor_b, toboolean, tobyte, tochar, todouble, tofloat, toint, tolong, tonumber, toshort, tostring, toString, touserdata, touserdata, typerror, unimplemented, userdataOf, userdataOf, valueOf, valueOf, valueOf, valueOf, valueOf, valueOf

Methods inherited from class com.prineside.luaj.Varargs

argcheck, checkboolean, checkclosure, checkdouble, checkfunction, checkint, checkjstring, checklong, checknotnil, checknumber, checkstring, checktable, checkthread, checkuserdata, checkuserdata, checkvalue, dealias, eval, isfunction, isnil, isnoneornil, isnumber, isstring, istable, isTailcall, isthread, isuserdata, isvalue, optboolean, optclosure, optdouble, optfunction, optint, optjstring, optlong, optnumber, optstring, opttable, optthread, optuserdata, optuserdata, optvalue, toboolean, tobyte, tochar, todouble, tofloat, toint, tojstring, tolong, toshort, touserdata, touserdata, type

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

CALLS

public static boolean CALLS

TRACE

public static boolean TRACE

Constructor Details

DebugLib

public DebugLib()

Method Details

write

public void write(com.esotericsoftware.kryo.Kryo kryo,
 com.esotericsoftware.kryo.io.Output output)

Specified by:

write in interface com.esotericsoftware.kryo.KryoSerializable

Overrides:

write in class LibFunction

read

public void read(com.esotericsoftware.kryo.Kryo kryo,
 com.esotericsoftware.kryo.io.Input input)

Specified by:

read in interface com.esotericsoftware.kryo.KryoSerializable

Overrides:

read in class LibFunction

call

public LuaValue call(LuaValue modname,
 LuaValue env)

Perform one-time initialization on the library by creating a table containing the library functions, adding that table to the supplied environment, adding the table to package.loaded, and returning table as the return value.

Specified by:

call in class TwoArgFunction

Parameters:

modname - the module name supplied if this is loaded via 'require'.

env - the environment to load into, which must be a Globals instance.

Returns:

First return value (this(arg1,arg2)), or LuaValue.NIL if there were none.

See Also:

• LuaValue.call()
• LuaValue.call(LuaValue)
• LuaValue.call(LuaValue, LuaValue, LuaValue)
• LuaValue.invoke(LuaValue, Varargs)
• LuaValue.method(String,LuaValue,LuaValue)
• LuaValue.method(LuaValue,LuaValue,LuaValue)

onCall

public void onCall(LuaFunction f)

onCall

public void onCall(LuaClosure c,
 Varargs varargs,
 LuaValue[] stack)

onInstruction

public void onInstruction(int pc,
 Varargs v,
 int top)

onReturn

public void onReturn()

traceback

public String traceback(int level)

getCallFrame

public DebugLib.CallFrame getCallFrame(int level)

callstack

public DebugLib.CallStack callstack()

getobjname

public static com.prineside.luaj.lib.DebugLib.NameWhat getobjname(Prototype p,
 int lastpc,
 int reg)