Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: script ::

interface XDebugging

Base Interface
com::sun::star::uno::XInterface

Description
makes it possible to set breakpoints in an interpreter.


Methods' Summary

setBreakPoint
clearAllBreakPoints clears all breakpoints in the module set by "setBreakPoint".
eval
getStackTrace Return the engine's stack trace of the current execute position. Line break is the delimiter.
getContextInformation
dumpVariable returns the value of the variable at the given stack position.
setVariable sets the value of the specified variable within the specified stack frame.
isVariable
stop stops the execution of the interpreter.
stepOver executes the next and only the next statement.
stepIn executes the next and only the next statement.
stepOut executes the program until the next return from this stack frame.
doContinue continues the program execution.

Methods' Details

setBreakPoint
 
long
setBreakPoint(
[ in ] string aModuleName,
[ in ] long nSourceCodeLine,
[ in ] boolean bOn );

Returns
the source code line where the breakpoint was set.

The value can differ from the parameter nSourceCodeLine when this is not a valid line to place it. -1 indicates that the breakpoint cannot be set at this position.

clearAllBreakPoints
 
void
clearAllBreakPoints(
[ in ] string aModuleName );

Description
clears all breakpoints in the module set by "setBreakPoint".
eval
 
string
eval(
[ in ] string aSourceCode,
[ in ] short nCallStackPos );

Description
Parameter CallStackPos
Position in the call stack for which the expression should be evaluated. 0 is the top/actual position in the call in the call stack, 1 the next and so on.
getStackTrace
 
sequence< string >
getStackTrace();
Description
Return the engine's stack trace of the current execute position. Line break is the delimiter.
getContextInformation
 
com::sun::star::script::ContextInformation
getContextInformation(
[ in ] short nCallStackPos );

Returns
more detailed information about a specified stack frame.
Parameter nCallStackPos
specifies the position in the call stack for the variables that should be delivered.
dumpVariable
 
string
dumpVariable(
[ in ] string aVariableName,
[ in ] short nCallStackPos );

Description
returns the value of the variable at the given stack position.
setVariable
 
void
setVariable(
[ in ] string aVariableName,
[ in ] string aValue,
[ in ] short nCallStackPos );

Description
sets the value of the specified variable within the specified stack frame.
isVariable
 
boolean
isVariable(
[ in ] string aVariableName,
[ in ] short nCallStackPos );

Returns
whether the given variable exists within the specified stack frame.
stop
 
void
stop();
Description
stops the execution of the interpreter.

To continue with the execution, call XDebugging::doContinue .

stepOver
 
void
stepOver();
Description
executes the next and only the next statement.

If the next statement is a function call, the function is executed completely.

stepIn
 
void
stepIn();
Description
executes the next and only the next statement.

If the next statement is a function call, only the function entered.

stepOut
 
void
stepOut();
Description
executes the program until the next return from this stack frame.
doContinue
 
void
doContinue();
Description
continues the program execution.

Top of Page