debuggerengine.h 8.9 KB
Newer Older
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
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** 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.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/

#ifndef DEBUGGER_DEBUGGERENGINE_H
#define DEBUGGER_DEBUGGERENGINE_H

#include "debugger_global.h"
#include "debuggerconstants.h"
#include "moduleshandler.h" // For 'Symbols'

#include <coreplugin/ssh/sshconnection.h> 

#include <QtCore/QObject>
#include <QtCore/QSharedPointer>
#include <QtCore/QStringList>

QT_BEGIN_NAMESPACE
class QDebug;
class QPoint;
QT_END_NAMESPACE

namespace TextEditor {
class ITextEditor;
}

namespace Core {
class IOptionsPage;
}

namespace Debugger {

class DebuggerRunControl;
class DebuggerPlugin;

class DEBUGGER_EXPORT DebuggerStartParameters
{
public:
    DebuggerStartParameters();
    void clear();

    QString executable;
    QString displayName;
    QString coreFile;
    QStringList processArgs;
    QStringList environment;
    QString workingDirectory;
    qint64 attachPID;
    bool useTerminal;
    bool breakAtMain;
    QString crashParameter; // for AttachCrashedExternal
    // for remote debugging
    QString remoteChannel;
    QString remoteArchitecture;
    QString symbolFileName;
    QString serverStartScript;
    QString sysRoot;
    QString debuggerCommand;
    int toolChainType;
    QByteArray remoteDumperLib;
    QString qtInstallPath;

    QString dumperLibrary;
    QStringList dumperLibraryLocations;
ck's avatar
ck committed
90
    Core::SshConnectionParameters connParams;
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
    DebuggerStartMode startMode;
};

DEBUGGER_EXPORT QDebug operator<<(QDebug str, const DebuggerStartParameters &);
DEBUGGER_EXPORT QDebug operator<<(QDebug str, DebuggerState state);

namespace Internal {

class DisassemblerViewAgent;
class MemoryViewAgent;
class Symbol;
class WatchData;
class BreakHandler;
class ModulesHandler;
class RegisterHandler;
class StackHandler;
class StackFrame;
class SnapshotHandler;
class SourceFilesHandler;
class ThreadsHandler;
class WatchHandler;

class DebuggerEnginePrivate;

115
116
// FIXME: DEBUGGER_EXPORT?
class DEBUGGER_EXPORT DebuggerEngine : public QObject
117
118
119
120
121
122
123
124
{
    Q_OBJECT

public:
    DebuggerEngine(const DebuggerStartParameters &sp);
    virtual ~DebuggerEngine();

    virtual void shutdown() {}
Friedemann Kleint's avatar
Friedemann Kleint committed
125
126
    virtual void setToolTipExpression(const QPoint & /* mousePos */,
            TextEditor::ITextEditor * /* editor */, int /* cursorPos */) { }
127
    void initializeFromTemplate(DebuggerEngine *other);
hjk's avatar
hjk committed
128
129

    virtual void updateWatchData(const WatchData & /* data */) { }
130
    void startDebugger(DebuggerRunControl *runControl);
hjk's avatar
hjk committed
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
    virtual bool isSessionEngine() const { return false; }

    virtual void watchPoint(const QPoint &) {}
    virtual void fetchMemory(MemoryViewAgent *, QObject *,
            quint64 addr, quint64 length);
    virtual void fetchDisassembler(DisassemblerViewAgent *) {}
    virtual void activateFrame(int index) { Q_UNUSED(index); }

    virtual void reloadModules() {}
    virtual void loadSymbols(const QString &moduleName)
        { Q_UNUSED(moduleName); }
    virtual void loadAllSymbols() {}
    virtual void requestModuleSymbols(const QString &moduleName)
        { Q_UNUSED(moduleName); }

    virtual void reloadRegisters() {}
    virtual void reloadSourceFiles() {}
    virtual void reloadFullStack() {}

    virtual void setRegisterValue(int regnr, const QString &value);
    virtual void addOptionPages(QList<Core::IOptionsPage*> *) const {}
    virtual unsigned debuggerCapabilities() const { return 0; }

    virtual bool isSynchroneous() const { return false; }
    virtual QString qtNamespace() const { return QString(); }

    virtual void makeSnapshot() {}
    virtual void activateSnapshot(int index) { Q_UNUSED(index); }

    virtual void attemptBreakpointSynchronization() {}
    virtual void selectThread(int index) { Q_UNUSED(index); }

    virtual void assignValueInDebugger(const QString &expr, const QString &value)
        { Q_UNUSED(expr); Q_UNUSED(value); }

protected:
    virtual void setupEngine() {}
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
    virtual void exitDebugger() {}
    virtual void detachDebugger() {}
    virtual void executeStep() {}
    virtual void executeStepOut()  {}
    virtual void executeNext() {}
    virtual void executeStepI() {}
    virtual void executeNextI() {}
    virtual void executeReturn() {}

    virtual void continueInferior() {}
    virtual void interruptInferior() {}

    virtual void executeRunToLine(const QString &fileName, int lineNumber)
        { Q_UNUSED(fileName); Q_UNUSED(lineNumber); }
    virtual void executeRunToFunction(const QString &functionName)
        { Q_UNUSED(functionName); }
    virtual void executeJumpToLine(const QString &fileName, int lineNumber)
        { Q_UNUSED(fileName); Q_UNUSED(lineNumber); }
    virtual void executeDebuggerCommand(const QString &command)
        { Q_UNUSED(command); }

    virtual void frameUp();
    virtual void frameDown();

public:
    DebuggerPlugin *plugin() const;
    const DebuggerStartParameters &startParameters() const;
    DebuggerStartParameters &startParameters();

    ModulesHandler *modulesHandler() const;
    BreakHandler *breakHandler() const;
    RegisterHandler *registerHandler() const;
    StackHandler *stackHandler() const;
    ThreadsHandler *threadsHandler() const;
    WatchHandler *watchHandler() const;
    SnapshotHandler *snapshotHandler() const;
    SourceFilesHandler *sourceFilesHandler() const;

    QAbstractItemModel *commandModel() const;
    QAbstractItemModel *modulesModel() const;
    QAbstractItemModel *breakModel() const;
    QAbstractItemModel *registerModel() const;
    QAbstractItemModel *stackModel() const;
    QAbstractItemModel *threadsModel() const;
    QAbstractItemModel *localsModel() const;
    QAbstractItemModel *watchersModel() const;
    QAbstractItemModel *returnModel() const;
    QAbstractItemModel *snapshotModel() const;
    QAbstractItemModel *sourceFilesModel() const;

218
    void handleFinished();
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
    bool debuggerActionsEnabled() const;
    static bool debuggerActionsEnabled(DebuggerState state);
    void showModuleSymbols(const QString &moduleName, const Symbols &symbols);

    void breakByFunction(const QString &functionName);
    void breakByFunctionMain();
    
    void executeStepX();
    void executeStepOutX();
    void executeStepNextX();
    void executeReturnX();

    DebuggerState state() const;

    // Dumper stuff (common to cdb and gdb).
    bool qtDumperLibraryEnabled() const;
    QString qtDumperLibraryName() const;
    QStringList qtDumperLibraryLocations() const;
    void showQtDumperLibraryWarning(const QString &details = QString());

    static const char *stateName(int s);

    void notifyInferiorPid(qint64 pid);
    qint64 inferiorPid() const;
    bool isReverseDebugging() const;
244
    void handleCommand(int role, const QVariant &value);
245

246
247
248
249
    // Convenience
    void showMessage(const QString &msg, int channel = LogDebug, int timeout = -1) const;
    void showStatusMessage(const QString &msg, int timeout = -1) const;

250
251
252
253
254
    void resetLocation();
    void openFile(const QString &fileName, int lineNumber = -1);
    void gotoLocation(const QString &fileName, int lineNumber, bool setMarker);
    void gotoLocation(const StackFrame &frame, bool setMarker);
    void raiseApplication();
255
    virtual void quitDebugger() { exitDebugger(); } // called by DebuggerRunControl
256
257

protected:
258
259
    void notifyEngineSetupOk();
    void notifyEngineSetupFailed();
260

hjk's avatar
hjk committed
261
262
263
    void notifyInferiorSetupOk();
    void notifyInferiorSetupFailed();

264
265
266
267
268
269
    void notifyInferiorRunning();
    void notifyInferiorStopped();

    // Called to initiate shutdown.
    void notifyInferiorIll();

hjk's avatar
hjk committed
270
271
272
    virtual void setupInferior();
    virtual void runEngine();

hjk's avatar
hjk committed
273
274
275
//private: // FIXME. State transitions 
    void setState(DebuggerState state, bool forced = false);

hjk's avatar
hjk committed
276
277
278
279
private:
    void executeRunToLine();
    void executeRunToFunction();
    void executeJumpToLine();
hjk's avatar
hjk committed
280
    void addToWatchWindow();
hjk's avatar
hjk committed
281

hjk's avatar
hjk committed
282
    friend class DebuggerEnginePrivate;
283
284
285
286
287
288
289
    DebuggerEnginePrivate *d;
};

} // namespace Internal
} // namespace Debugger

#endif // DEBUGGER_DEBUGGERENGINE_H