LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XDebugging Interface Referencepublished

makes it possible to set breakpoints in an interpreter. More...

import"XDebugging.idl";

Inheritance diagram for XDebugging:
XInterface

Public Member Functions

long setBreakPoint ([in] string aModuleName, [in] long nSourceCodeLine, [in] boolean bOn)
 returns the source code line where the breakpoint was set. More...
 
void clearAllBreakPoints ([in] string aModuleName)
 clears all breakpoints in the module set by "setBreakPoint". More...
 
string eval ([in] string aSourceCode, [in] short nCallStackPos)
 Evaluates an expression. More...
 
sequence< string > getStackTrace ()
 Returns the engine's stack trace of the current execute position. More...
 
com::sun::star::script::ContextInformation getContextInformation ([in] short nCallStackPos)
 returns more detailed information about a specified stack frame. More...
 
string dumpVariable ([in] string aVariableName, [in] short nCallStackPos)
 returns the value of the variable at the given stack position. More...
 
void setVariable ([in] string aVariableName, [in] string aValue, [in] short nCallStackPos)
 sets the value of the specified variable within the specified stack frame. More...
 
boolean isVariable ([in] string aVariableName, [in] short nCallStackPos)
 returns whether the given variable exists within the specified stack frame. More...
 
void stop ()
 stops the execution of the interpreter. More...
 
void stepOver ()
 executes the next and only the next statement. More...
 
void stepIn ()
 executes the next and only the next statement. More...
 
void stepOut ()
 executes the program until the next return from this stack frame. More...
 
void doContinue ()
 continues the program execution. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

makes it possible to set breakpoints in an interpreter.

Deprecated:

Member Function Documentation

void clearAllBreakPoints ( [in] string  aModuleName)

clears all breakpoints in the module set by "setBreakPoint".

void doContinue ( )

continues the program execution.

string dumpVariable ( [in] string  aVariableName,
[in] short  nCallStackPos 
)

returns the value of the variable at the given stack position.

string eval ( [in] string  aSourceCode,
[in] short  nCallStackPos 
)

Evaluates an expression.

Parameters
aSourceCodethe expression to be evaluated.
nCallStackPosPosition 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.
Returns
the value of the expression as string.
com::sun::star::script::ContextInformation getContextInformation ( [in] short  nCallStackPos)

returns more detailed information about a specified stack frame.

Parameters
nCallStackPosspecifies the position in the call stack for the variables that should be delivered.
sequence<string> getStackTrace ( )

Returns the engine's stack trace of the current execute position.

Line break is the delimiter.

boolean isVariable ( [in] string  aVariableName,
[in] short  nCallStackPos 
)

returns whether the given variable exists within the specified stack frame.

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.

void setVariable ( [in] string  aVariableName,
[in] string  aValue,
[in] short  nCallStackPos 
)

sets the value of the specified variable within the specified stack frame.

void stepIn ( )

executes the next and only the next statement.

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

void stepOut ( )

executes the program until the next return from this stack frame.

void stepOver ( )

executes the next and only the next statement.

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

void stop ( )

stops the execution of the interpreter.

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


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