summaryrefslogtreecommitdiffstats
path: root/udkapi/com/sun/star/script/XDebugging.idl
blob: e1d04b9f79b0e57ccbe697a7e2681db28ad52acf (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_script_XDebugging_idl__
#define __com_sun_star_script_XDebugging_idl__

#include <com/sun/star/uno/XInterface.idl>

#include <com/sun/star/script/ContextInformation.idl>


//=============================================================================

 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
 */
published 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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */