udkapi/com/sun/star/script/XDebugging.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDebugging.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_script_XDebugging_idl__
  31 #define __com_sun_star_script_XDebugging_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_script_ContextInformation_idl__
  38 #include <com/sun/star/script/ContextInformation.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module script {
  45
  46 //=============================================================================
  47
  48 // DocMerge from xml: interface com::sun::star::script::XDebugging
  49 /** makes it possible to set breakpoints in an interpreter.
  50     @deprecated
  51  */
  52 published interface XDebugging: com::sun::star::uno::XInterface
  53 {
  54     //-------------------------------------------------------------------------
  55     /** returns the source code line where the breakpoint was set.
  56
  57                 <p>The value can differ from the parameter
  58                 <var>nSourceCodeLine</var> when this is not a valid line to
  59                 place it.  -1 indicates that the breakpoint cannot be set at
  60                 this position.
  61      */
  62     long setBreakPoint( [in] string aModuleName,
  63              [in] long nSourceCodeLine,
  64              [in] boolean bOn );
  65
  66     //-------------------------------------------------------------------------
  67     /** clears all breakpoints in the module set by "setBreakPoint".
  68      */
  69     void clearAllBreakPoints( [in] string aModuleName );
  70
  71     //-------------------------------------------------------------------------
  72     /** Evaluates an expression.
  73
  74         @returns the value of the expression as string.
  75
  76         @param CallStackPos     Position in the call stack for which the expression
  77                     should be evaluated. 0 is the top/actual position in the call
  78                     in the call stack, 1 the next and so on.
  79      */
  80     string eval( [in] string aSourceCode,
  81              [in] short nCallStackPos );
  82
  83     //-------------------------------------------------------------------------
  84     /** Returns the engine's stack trace of the current execute position. Line break is the delimiter.
  85      */
  86     sequence<string> getStackTrace();
  87
  88     //-------------------------------------------------------------------------
  89     /** returns more detailed information about a specified stack frame.
  90
  91          @param nCallStackPos
  92                 specifies the position in the call stack for the
  93                 variables that should be delivered.
  94      */
  95     com::sun::star::script::ContextInformation getContextInformation( [in] short nCallStackPos );
  96
  97     //-------------------------------------------------------------------------
  98     /** returns the value of the variable at the given stack position.
  99      */
 100     string dumpVariable( [in] string aVariableName,
 101              [in] short nCallStackPos );
 102
 103     //-------------------------------------------------------------------------
 104     /** sets the value of the specified variable within the specified
 105         stack frame.
 106      */
 107     void setVariable( [in] string aVariableName,
 108              [in] string aValue,
 109              [in] short nCallStackPos );
 110
 111     //-------------------------------------------------------------------------
 112     /** returns whether the given variable exists within the specified stack frame.
 113      */
 114     boolean isVariable( [in] string aVariableName,
 115              [in] short nCallStackPos );
 116
 117     //-------------------------------------------------------------------------
 118     /** stops the execution of the interpreter.
 119
 120         <p>To continue with the execution, call <method>XDebugging::doContinue</method>.
 121      */
 122     void stop();
 123
 124     //-------------------------------------------------------------------------
 125     /** executes the next and only the next statement.
 126
 127         <p>If the next statement is a function call, the function is
 128         executed completely.</p>
 129      */
 130     void stepOver();
 131
 132     //-------------------------------------------------------------------------
 133     /** executes the next and only the next statement.
 134
 135         <p>If the next statement is a function call, only the function
 136         entered.</p>
 137      */
 138     void stepIn();
 139
 140     //-------------------------------------------------------------------------
 141     /** executes the program until the next return from this stack frame.
 142      */
 143     void stepOut();
 144
 145     //-------------------------------------------------------------------------
 146     /** continues the program execution.
 147      */
 148     void doContinue();
 149
 150 };
 151
 152 //=============================================================================
 153
 154 }; }; }; };
 155
 156 #endif