aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/qml/v4vm/debugging.h
blob: b337f41c5191b03c3d7dbb65b9ec5d6a2b791c5d (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
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the V4VM module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef DEBUGGING_H
#define DEBUGGING_H

#include "qv4global.h"
#include "qv4engine.h"
#include "qv4context.h"

#include <QHash>

QT_BEGIN_NAMESPACE

namespace QQmlJS {

namespace V4IR {
struct BasicBlock;
struct Function;
} // namespace IR

namespace Debugging {

class Debugger;

struct FunctionDebugInfo { // TODO: use opaque d-pointers here
    QString name;
    unsigned startLine, startColumn;

    FunctionDebugInfo(V4IR::Function *function):
        startLine(0), startColumn(0)
    {
        if (function->name)
            name = *function->name;
    }

    void setSourceLocation(unsigned line, unsigned column)
    { startLine = line; startColumn = column; }
};

class FunctionState
{
public:
    FunctionState(VM::ExecutionContext *context);
    virtual ~FunctionState();

    virtual VM::Value *argument(unsigned idx);
    virtual VM::Value *local(unsigned idx);
    virtual VM::Value *temp(unsigned idx) = 0;

    VM::ExecutionContext *context() const
    { return _context; }

    Debugger *debugger() const
    { return _context->engine->debugger; }

private:
    VM::ExecutionContext *_context;
};

struct CallInfo
{
    VM::ExecutionContext *context;
    VM::FunctionObject *function;
    FunctionState *state;

    CallInfo(VM::ExecutionContext *context = 0, VM::FunctionObject *function = 0, FunctionState *state = 0)
        : context(context)
        , function(function)
        , state(state)
    {}
};

class Q_V4_EXPORT Debugger
{
public:
    Debugger(VM::ExecutionEngine *_engine);
    ~Debugger();

public: // compile-time interface
    void addFunction(V4IR::Function *function);
    void setSourceLocation(V4IR::Function *function, unsigned line, unsigned column);
    void mapFunction(VM::Function *vmf, V4IR::Function *irf);

public: // run-time querying interface
    FunctionDebugInfo *debugInfo(VM::FunctionObject *function) const;
    QString name(VM::FunctionObject *function) const;

public: // execution hooks
    void aboutToCall(VM::FunctionObject *function, VM::ExecutionContext *context);
    void justLeft(VM::ExecutionContext *context);
    void enterFunction(FunctionState *state);
    void leaveFunction(FunctionState *state);
    void aboutToThrow(const VM::Value &value);

public: // debugging hooks
    FunctionState *currentState() const;
    const char *currentArg(unsigned idx) const;
    const char *currentLocal(unsigned idx) const;
    const char *currentTemp(unsigned idx) const;
    void printStackTrace() const;

private:
    int callIndex(VM::ExecutionContext *context);
    V4IR::Function *irFunction(VM::Function *vmf) const;

private: // TODO: use opaque d-pointers here
    VM::ExecutionEngine *_engine;
    QHash<V4IR::Function *, FunctionDebugInfo *> _functionInfo;
    QHash<VM::Function *, V4IR::Function *> _vmToIr;
    QVector<CallInfo> _callStack;
};

} // namespace Debugging
} // namespace QQmlJS

QT_END_NAMESPACE

#endif // DEBUGGING_H