summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/script/XDebugging.idl
blob: 44de68452c348dc4213f8b640b80135bdc6636e5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
/*************************************************************************
 *
 *  $RCSfile: XDebugging.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: mi $ $Date: 2002-10-03 12:44:18 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_script_XDebugging_idl__ 
#define __com_sun_star_script_XDebugging_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_script_ContextInformation_idl__ 
#include <com/sun/star/script/ContextInformation.idl> 
#endif 
 
 
//============================================================================= 
 
 module com {  module sun {  module star {  module script {  
 
//============================================================================= 
 
// DocMerge from xml: interface com::sun::star::script::XDebugging
/** makes it possible to set breakpoints in an interpreter.

    @deprecated
 */
interface XDebugging: com::sun::star::uno::XInterface
{ 
    //------------------------------------------------------------------------- 
    /** returns the source code line where the breakpoint was set.  
                 
                <p>The value can differ from the parameter 
                <var>nSourceCodeLine</var> when this is not a valid line to 
                place it.  -1 indicates that the breakpoint cannot be set at 
                this position.
     */
    long setBreakPoint( [in] string aModuleName, 
             [in] long nSourceCodeLine, 
             [in] boolean bOn ); 
 
    //------------------------------------------------------------------------- 
    /** clears all breakpoints in the module set by "setBreakPoint".
     */
    void clearAllBreakPoints( [in] string aModuleName ); 
 
    //------------------------------------------------------------------------- 
    /** Evaluates an expression.

        @returns the value of the expression as string.

        @param 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.
     */
    string eval( [in] string aSourceCode, 
             [in] short nCallStackPos ); 
 
    //------------------------------------------------------------------------- 
    /** Returns the engine's stack trace of the current execute position. Line break is the delimiter.
     */
    sequence<string> getStackTrace(); 
 
    //------------------------------------------------------------------------- 
    /** returns more detailed information about a specified stack frame. 
                 
         @param nCallStackPos 
                specifies the position in the call stack for the 
                variables that should be delivered.
     */
    com::sun::star::script::ContextInformation getContextInformation( [in] short nCallStackPos ); 
 
    //------------------------------------------------------------------------- 
    /** returns the value of the variable at the given stack position.
     */
    string dumpVariable( [in] string aVariableName, 
             [in] short nCallStackPos ); 
 
    //------------------------------------------------------------------------- 
    /** sets the value of the specified variable within the specified
        stack frame.
     */
    void setVariable( [in] string aVariableName, 
             [in] string aValue, 
             [in] short nCallStackPos ); 
 
    //------------------------------------------------------------------------- 
    /** returns whether the given variable exists within the specified stack frame.
     */
    boolean isVariable( [in] string aVariableName, 
             [in] short nCallStackPos ); 
 
    //------------------------------------------------------------------------- 
    /** stops the execution of the interpreter. 
        
        <p>To continue with the execution, call <method>XDebugging::doContinue</method>.
     */
    void stop(); 
 
    //------------------------------------------------------------------------- 
    /** executes the next and only the next statement.
        
        <p>If the next statement is a function call, the function is
        executed completely.</p>
     */
    void stepOver(); 
 
    //------------------------------------------------------------------------- 
    /** executes the next and only the next statement.
        
        <p>If the next statement is a function call, only the function 
        entered.</p>
     */
    void stepIn(); 
 
    //------------------------------------------------------------------------- 
    /** executes the program until the next return from this stack frame.
     */
    void stepOut(); 
 
    //------------------------------------------------------------------------- 
    /** continues the program execution.
     */
    void doContinue(); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
#endif