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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22  module com {  module sun {  module star {  module script {
  23
  24 /** makes it possible to set breakpoints in an interpreter.
  25     @deprecated
  26  */
  27 published interface XDebugging: com::sun::star::uno::XInterface
  28 {
  29     /** returns the source code line where the breakpoint was set.
  30
  31                 <p>The value can differ from the parameter
  32                 <var>nSourceCodeLine</var> when this is not a valid line to
  33                 place it.  -1 indicates that the breakpoint cannot be set at
  34                 this position.
  35      */
  36     long setBreakPoint( [in] string aModuleName,
  37              [in] long nSourceCodeLine,
  38              [in] boolean bOn );
  39
  40     /** clears all breakpoints in the module set by "setBreakPoint".
  41      */
  42     void clearAllBreakPoints( [in] string aModuleName );
  43
  44     /** Evaluates an expression.
  45
  46         @param aSourceCode the expression to be evaluated.
  47
  48         @param nCallStackPos Position in the call stack for which the expression
  49                     should be evaluated. 0 is the top/actual position in the call
  50                     in the call stack, 1 the next and so on.
  51
  52         @returns the value of the expression as string.
  53      */
  54     string eval( [in] string aSourceCode,
  55              [in] short nCallStackPos );
  56
  57     /** Returns the engine's stack trace of the current execute position. Line break is the delimiter.
  58      */
  59     sequence<string> getStackTrace();
  60
  61     /** returns more detailed information about a specified stack frame.
  62
  63          @param nCallStackPos
  64                 specifies the position in the call stack for the
  65                 variables that should be delivered.
  66      */
  67     com::sun::star::script::ContextInformation getContextInformation( [in] short nCallStackPos );
  68
  69     /** returns the value of the variable at the given stack position.
  70      */
  71     string dumpVariable( [in] string aVariableName,
  72              [in] short nCallStackPos );
  73
  74     /** sets the value of the specified variable within the specified
  75         stack frame.
  76      */
  77     void setVariable( [in] string aVariableName,
  78              [in] string aValue,
  79              [in] short nCallStackPos );
  80
  81     /** returns whether the given variable exists within the specified stack frame.
  82      */
  83     boolean isVariable( [in] string aVariableName,
  84              [in] short nCallStackPos );
  85
  86     /** stops the execution of the interpreter.
  87
  88         <p>To continue with the execution, call XDebugging::doContinue().
  89      */
  90     void stop();
  91
  92     /** executes the next and only the next statement.
  93
  94         <p>If the next statement is a function call, the function is
  95         executed completely.</p>
  96      */
  97     void stepOver();
  98
  99     /** executes the next and only the next statement.
 100
 101         <p>If the next statement is a function call, only the function
 102         entered.</p>
 103      */
 104     void stepIn();
 105
 106     /** executes the program until the next return from this stack frame.
 107      */
 108     void stepOut();
 109
 110     /** continues the program execution.
 111      */
 112     void doContinue();
 113
 114 };
 115
 116
 117 }; }; }; };
 118
 119 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */