org.apache.bsf.debug.jsdi
Interface JsEngine
public
interface
JsEngine
extends Remote
Represents a remote engine as seen from the debugger.
It matches the notion of global object in JavaScript
specification. In other words, a JsEngine is an
execution context rather than an explicit engine.
This also means that a JsEngine is not multi-threaded,
there is only one execution being carried.
Hence, there is only one stack of JsContext for a
JsEngine. The stack is only accesible if the engine is
in a callback mode to the debugger, that is, the
execution is stopped at a breakpoint or after a stepping
order has completed.
Method Summary |
Object | eval(String docname, String fnOrScript, int lineno)
Allow the debugger to evaluate an expression
within the current context. |
JsContext | getContext(int depth)
Returns the JsContext at a certain depth.
|
int | getContextCount()
Returns the count of JsContext on the current stack.
|
JsCallbacks | getDebugger()
Return the current debugger. |
JsObject | getGlobalObject()
Any execution in JavaScript happen with respect to a
global object, sort of the top-level name space for
properties. |
String | getThread()
Returns name of the thread currently running in the engine |
String | getThreadGroup()
Returns name of the ThreadGroup of the thread currently running in the engine |
JsObject | getUndefinedValue()
As per ECMA specification, each JavaScript execution
defines a unique object for the undefined value. |
boolean | isSuspended() |
boolean | poll()
Allows the client debugger to poll the connection. |
void | run()
Stepping commands:
run: resume execution until it finishes or a breakpoint is hit.
stepIn: steps to the next statement, considering callee's statement if any.
stepOut: steps until the current JsContext exits.
stepOver: steps to the next statement within the same JsContext. |
void | setDebugger(JsCallbacks debugger)
Set the associated debugger. |
void | stepIn() |
void | stepOut() |
void | stepOver() |
public Object eval(String docname, String fnOrScript, int lineno)
Allow the debugger to evaluate an expression
within the current context.
Returns the JsContext at a certain depth.
Depth zero is the top of the stack, that is,
the inner execution context.
This is a valid call only if the engine is stopped
in a callback to the debugger (breakpoint or stepping
completed).
public int getContextCount()
Returns the count of JsContext on the current stack.
This is a valid call only if the engine is stopped
in a callback to the debugger (breakpoint or stepping
completed).
Return the current debugger.
Returns: the debugger, or null if none is attached.
Any execution in JavaScript happen with respect to a
global object, sort of the top-level name space for
properties. This is global object return by this call.
public String getThread()
Returns name of the thread currently running in the engine
public String getThreadGroup()
Returns name of the ThreadGroup of the thread currently running in the engine
As per ECMA specification, each JavaScript execution
defines a unique object for the undefined value.
public boolean isSuspended()
public boolean poll()
Allows the client debugger to poll the connection.
public void run()
Stepping commands:
run: resume execution until it finishes or a breakpoint is hit.
stepIn: steps to the next statement, considering callee's statement if any.
stepOut: steps until the current JsContext exits.
stepOver: steps to the next statement within the same JsContext.
Set the associated debugger.
Parameters: debugger the debugger to be used on callbacks from
the engine.
public void stepIn()
public void stepOut()
public void stepOver()