1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_script_XDebugging_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_script_XDebugging_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_script_ContextInformation_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/script/ContextInformation.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski//============================================================================= 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski module com { module sun { module star { module script { 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski//============================================================================= 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski// DocMerge from xml: interface com::sun::star::script::XDebugging 42*b1cdbd2cSJim Jagielski/** makes it possible to set breakpoints in an interpreter. 43*b1cdbd2cSJim Jagielski @deprecated 44*b1cdbd2cSJim Jagielski */ 45*b1cdbd2cSJim Jagielskipublished interface XDebugging: com::sun::star::uno::XInterface 46*b1cdbd2cSJim Jagielski{ 47*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 48*b1cdbd2cSJim Jagielski /** returns the source code line where the breakpoint was set. 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski <p>The value can differ from the parameter 51*b1cdbd2cSJim Jagielski <var>nSourceCodeLine</var> when this is not a valid line to 52*b1cdbd2cSJim Jagielski place it. -1 indicates that the breakpoint cannot be set at 53*b1cdbd2cSJim Jagielski this position. 54*b1cdbd2cSJim Jagielski */ 55*b1cdbd2cSJim Jagielski long setBreakPoint( [in] string aModuleName, 56*b1cdbd2cSJim Jagielski [in] long nSourceCodeLine, 57*b1cdbd2cSJim Jagielski [in] boolean bOn ); 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 60*b1cdbd2cSJim Jagielski /** clears all breakpoints in the module set by "setBreakPoint". 61*b1cdbd2cSJim Jagielski */ 62*b1cdbd2cSJim Jagielski void clearAllBreakPoints( [in] string aModuleName ); 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 65*b1cdbd2cSJim Jagielski /** Evaluates an expression. 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielski @returns the value of the expression as string. 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski @param CallStackPos Position in the call stack for which the expression 70*b1cdbd2cSJim Jagielski should be evaluated. 0 is the top/actual position in the call 71*b1cdbd2cSJim Jagielski in the call stack, 1 the next and so on. 72*b1cdbd2cSJim Jagielski */ 73*b1cdbd2cSJim Jagielski string eval( [in] string aSourceCode, 74*b1cdbd2cSJim Jagielski [in] short nCallStackPos ); 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 77*b1cdbd2cSJim Jagielski /** Returns the engine's stack trace of the current execute position. Line break is the delimiter. 78*b1cdbd2cSJim Jagielski */ 79*b1cdbd2cSJim Jagielski sequence<string> getStackTrace(); 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 82*b1cdbd2cSJim Jagielski /** returns more detailed information about a specified stack frame. 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski @param nCallStackPos 85*b1cdbd2cSJim Jagielski specifies the position in the call stack for the 86*b1cdbd2cSJim Jagielski variables that should be delivered. 87*b1cdbd2cSJim Jagielski */ 88*b1cdbd2cSJim Jagielski com::sun::star::script::ContextInformation getContextInformation( [in] short nCallStackPos ); 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 91*b1cdbd2cSJim Jagielski /** returns the value of the variable at the given stack position. 92*b1cdbd2cSJim Jagielski */ 93*b1cdbd2cSJim Jagielski string dumpVariable( [in] string aVariableName, 94*b1cdbd2cSJim Jagielski [in] short nCallStackPos ); 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 97*b1cdbd2cSJim Jagielski /** sets the value of the specified variable within the specified 98*b1cdbd2cSJim Jagielski stack frame. 99*b1cdbd2cSJim Jagielski */ 100*b1cdbd2cSJim Jagielski void setVariable( [in] string aVariableName, 101*b1cdbd2cSJim Jagielski [in] string aValue, 102*b1cdbd2cSJim Jagielski [in] short nCallStackPos ); 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 105*b1cdbd2cSJim Jagielski /** returns whether the given variable exists within the specified stack frame. 106*b1cdbd2cSJim Jagielski */ 107*b1cdbd2cSJim Jagielski boolean isVariable( [in] string aVariableName, 108*b1cdbd2cSJim Jagielski [in] short nCallStackPos ); 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 111*b1cdbd2cSJim Jagielski /** stops the execution of the interpreter. 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski <p>To continue with the execution, call <method>XDebugging::doContinue</method>. 114*b1cdbd2cSJim Jagielski */ 115*b1cdbd2cSJim Jagielski void stop(); 116*b1cdbd2cSJim Jagielski 117*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 118*b1cdbd2cSJim Jagielski /** executes the next and only the next statement. 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski <p>If the next statement is a function call, the function is 121*b1cdbd2cSJim Jagielski executed completely.</p> 122*b1cdbd2cSJim Jagielski */ 123*b1cdbd2cSJim Jagielski void stepOver(); 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 126*b1cdbd2cSJim Jagielski /** executes the next and only the next statement. 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski <p>If the next statement is a function call, only the function 129*b1cdbd2cSJim Jagielski entered.</p> 130*b1cdbd2cSJim Jagielski */ 131*b1cdbd2cSJim Jagielski void stepIn(); 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 134*b1cdbd2cSJim Jagielski /** executes the program until the next return from this stack frame. 135*b1cdbd2cSJim Jagielski */ 136*b1cdbd2cSJim Jagielski void stepOut(); 137*b1cdbd2cSJim Jagielski 138*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 139*b1cdbd2cSJim Jagielski /** continues the program execution. 140*b1cdbd2cSJim Jagielski */ 141*b1cdbd2cSJim Jagielski void doContinue(); 142*b1cdbd2cSJim Jagielski 143*b1cdbd2cSJim Jagielski}; 144*b1cdbd2cSJim Jagielski 145*b1cdbd2cSJim Jagielski//============================================================================= 146*b1cdbd2cSJim Jagielski 147*b1cdbd2cSJim Jagielski}; }; }; }; 148*b1cdbd2cSJim Jagielski 149*b1cdbd2cSJim Jagielski#endif 150