debuggermanager.h 10.5 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2
3
4
**
** This file is part of Qt Creator
**
5
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
** Commercial Usage
10
**
11
12
13
14
** 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.
15
**
16
** GNU Lesser General Public License Usage
17
**
18
19
20
21
22
23
** 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.
24
**
25
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30
31
32
#ifndef DEBUGGER_DEBUGGERMANAGER_H
#define DEBUGGER_DEBUGGERMANAGER_H

33
#include "debugger_global.h"
hjk's avatar
hjk committed
34
35
#include "debuggerconstants.h"

con's avatar
con committed
36
#include <QtCore/QObject>
37
#include <QtCore/QSharedPointer>
con's avatar
con committed
38
39
40
41
#include <QtCore/QStringList>
#include <QtCore/QVariant>

QT_BEGIN_NAMESPACE
42
class QAbstractItemModel;
con's avatar
con committed
43
class QAction;
44
class QDebug;
con's avatar
con committed
45
class QDockWidget;
46
class QLabel;
47
class QMessageBox;
48
49
class QPoint;
class QVariant;
con's avatar
con committed
50
51
QT_END_NAMESPACE

52
namespace Core {
53
class IOptionsPage;
54
}
55
56
57
namespace Utils {
class FancyMainWindow;
}
58

59
namespace TextEditor {
60
class ITextEditor;
61
62
}

63
64
65
66
namespace CPlusPlus {
    class Snapshot;
}

con's avatar
con committed
67
68
69
70
71
72
73
namespace Debugger {
namespace Internal {

class DebuggerOutputWindow;
class DebuggerPlugin;

class BreakHandler;
74
class BreakpointData;
con's avatar
con committed
75
76
class ModulesHandler;
class RegisterHandler;
77
class SourceFilesWindow;
78
struct StackFrame;
con's avatar
con committed
79
class StackHandler;
80
class Symbol;
81
class SnapshotHandler;
con's avatar
con committed
82
83
class ThreadsHandler;
class WatchData;
84
class WatchHandler;
85
86
87
88
class IDebuggerEngine;
class GdbEngine;
class ScriptEngine;
class CdbDebugEngine;
89
class CdbDebugEnginePrivate;
90
struct DebuggerManagerActions;
91
92
93
class DebuggerPlugin;
class CdbDebugEventCallback;
class CdbDumperHelper;
94
class CdbDumperInitThread;
95
96
97
class CdbExceptionLoggerEventCallback;
class GdbEngine;
class CdbDebugEngine;
98
class CdbDebugEnginePrivate;
99
} // namespace Internal
con's avatar
con committed
100

101
class DEBUGGER_EXPORT DebuggerStartParameters
102
{
103
public:
104
105
106
107
108
109
110
111
112
113
114
    DebuggerStartParameters();
    void clear();

    QString executable;
    QString coreFile;
    QStringList processArgs;
    QStringList environment;
    QString workingDir;
    QString buildDir;
    qint64 attachPID;
    bool useTerminal;
115
    QString crashParameter; // for AttachCrashedExternal
116
117
    // for remote debugging
    QString remoteChannel;
118
    int remoteChannelType;
119
    QString remoteArchitecture;
120
    QString symbolFileName;
121
    QString serverStartScript;
122
    QString sysRoot;
ck's avatar
ck committed
123
    QString debuggerCommand;
124
    int toolChainType;
ck's avatar
ck committed
125
    QString remoteDumperLib;
hjk's avatar
hjk committed
126
    QString qtInstallPath;
hjk's avatar
hjk committed
127
128
129

    QString dumperLibrary;
    QStringList dumperLibraryLocations;
hjk's avatar
hjk committed
130
    DebuggerStartMode startMode;
131
132
};

hjk's avatar
hjk committed
133
typedef QSharedPointer<DebuggerStartParameters> DebuggerStartParametersPtr;
134
135

DEBUGGER_EXPORT QDebug operator<<(QDebug str, const DebuggerStartParameters &);
136
137

// Flags for initialization
hjk's avatar
hjk committed
138
139
140
141
142
143
enum DebuggerEngineTypeFlags
{
    GdbEngineType     = 0x01,
    ScriptEngineType  = 0x02,
    CdbEngineType     = 0x04,
    AllEngineTypes = GdbEngineType
144
145
        | ScriptEngineType
        | CdbEngineType
146
147
};

hjk's avatar
hjk committed
148
QDebug operator<<(QDebug d, DebuggerState state);
con's avatar
con committed
149
150

//
hjk's avatar
hjk committed
151
// DebuggerManager
con's avatar
con committed
152
153
//

154
155
struct DebuggerManagerPrivate;

156
class DEBUGGER_EXPORT DebuggerManager : public QObject
con's avatar
con committed
157
{
hjk's avatar
hjk committed
158
    Q_OBJECT
con's avatar
con committed
159

hjk's avatar
hjk committed
160
161
162
public:
    DebuggerManager();
    ~DebuggerManager();
163

164
165
166
167
    friend class Internal::IDebuggerEngine;
    friend class Internal::DebuggerPlugin;
    friend class Internal::CdbDebugEventCallback;
    friend class Internal::CdbDumperHelper;
168
    friend class Internal::CdbDumperInitThread;
169
170
171
172
    friend class Internal::CdbExceptionLoggerEventCallback;
    friend class Internal::GdbEngine;
    friend class Internal::ScriptEngine;
    friend class Internal::CdbDebugEngine;
173
    friend class Internal::CdbDebugEnginePrivate;
con's avatar
con committed
174

175
    DebuggerState state() const;
176
    QList<Core::IOptionsPage*> initializeEngines(unsigned enabledTypeFlags);
177

178
    Utils::FancyMainWindow *mainWindow() const;
179
    QLabel *statusLabel() const;
180
    Internal::IDebuggerEngine *currentEngine() const;
con's avatar
con committed
181

182
183
    DebuggerStartParametersPtr startParameters() const;
    qint64 inferiorPid() const;
hjk's avatar
hjk committed
184

185
186
    QMessageBox *showMessageBox(int icon, const QString &title, const QString &text,
        int buttons = 0);
187

188
189
    bool debuggerActionsEnabled() const;

190
191
192
193
194
    bool checkDebugConfiguration(int toolChain,
                                 QString *errorMessage,
                                 QString *settingsCategory = 0,
                                 QString *settingsPage = 0) const;

195
196
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

197
198
    static DebuggerManager *instance();

con's avatar
con committed
199
public slots:
hjk's avatar
hjk committed
200
    void startNewDebugger(const DebuggerStartParametersPtr &sp);
201
202
    void exitDebugger();

con's avatar
con committed
203
204
205
206
207
    void setSimpleDockWidgetArrangement();

    void setBusyCursor(bool on);
    void queryCurrentTextEditor(QString *fileName, int *lineNumber, QObject **ed);

208
    void gotoLocation(const Debugger::Internal::StackFrame &frame, bool setLocationMarker);
209
    void fileOpen(const QString &file);
con's avatar
con committed
210
211
212
213
214
215
216
217
218
    void resetLocation();

    void interruptDebuggingRequest();

    void jumpToLineExec();
    void runToLineExec();
    void runToFunctionExec();
    void toggleBreakpoint();
    void breakByFunction(const QString &functionName);
219
    void breakByFunctionMain();
con's avatar
con committed
220
221
222
    void setBreakpoint(const QString &fileName, int lineNumber);
    void activateFrame(int index);
    void selectThread(int index);
223
224
    void activateSnapshot(int index);
    void removeSnapshot(int index);
con's avatar
con committed
225
226
227
228
229

    void stepExec();
    void stepOutExec();
    void nextExec();
    void continueExec();
230
    void detachDebugger();
231
    void makeSnapshot();
con's avatar
con committed
232
233

    void addToWatchWindow();
234
    void updateWatchData(const Debugger::Internal::WatchData &data);
235

con's avatar
con committed
236
    void sessionLoaded();
237
    void aboutToUnloadSession();
con's avatar
con committed
238
    void aboutToSaveSession();
239
240
    QVariant sessionValue(const QString &name);
    void setSessionValue(const QString &name, const QVariant &value);
con's avatar
con committed
241

242
    void assignValueInDebugger();
con's avatar
con committed
243
    void assignValueInDebugger(const QString &expr, const QString &value);
244
245

    void executeDebuggerCommand();
con's avatar
con committed
246
247
    void executeDebuggerCommand(const QString &command);

248
    void watchPoint();
249
    void setRegisterValue(int nr, const QString &value);
250

251
    void showStatusMessage(const QString &msg, int timeout = -1); // -1 forever
252
    void clearCppCodeModelSnapshot();
con's avatar
con committed
253

254
255
    static const char *stateName(int s);

256
public slots: // FIXME
hjk's avatar
hjk committed
257
258
    void showDebuggerOutput(const QString &msg)
        { showDebuggerOutput(LogDebug, msg); }
Friedemann Kleint's avatar
Friedemann Kleint committed
259
260
   void ensureLogVisible();

hjk's avatar
hjk committed
261
//private slots:  // FIXME
262
263
    void showDebuggerOutput(int channel, const QString &msg);
    void showDebuggerInput(int channel, const QString &msg);
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
264
    void showApplicationOutput(const QString &data);
con's avatar
con committed
265

266
267
268
    void reloadSourceFiles();
    void sourceFilesDockToggled(bool on);

con's avatar
con committed
269
270
271
272
273
274
275
    void reloadModules();
    void modulesDockToggled(bool on);
    void loadSymbols(const QString &moduleName);
    void loadAllSymbols();

    void reloadRegisters();
    void registerDockToggled(bool on);
276
    void clearStatusMessage();
277
    void attemptBreakpointSynchronization();
278
    void reloadFullStack();
279
    void operateByInstructionTriggered();
hjk's avatar
hjk committed
280
    void startFailed();
con's avatar
con committed
281
282

private:
283
284
285
286
287
288
    Internal::ModulesHandler *modulesHandler() const;
    Internal::BreakHandler *breakHandler() const;
    Internal::RegisterHandler *registerHandler() const;
    Internal::StackHandler *stackHandler() const;
    Internal::ThreadsHandler *threadsHandler() const;
    Internal::WatchHandler *watchHandler() const;
289
    Internal::SnapshotHandler *snapshotHandler() const;
290
    Internal::SourceFilesWindow *sourceFileWindow() const;
291
    QWidget *threadsWindow() const;
292

293
    Internal::DebuggerManagerActions debuggerManagerActions() const;
294

con's avatar
con committed
295
296
297
    void notifyInferiorStopped();
    void notifyInferiorRunning();
    void notifyInferiorExited();
298
    void notifyInferiorPidChanged(qint64);
con's avatar
con committed
299

300
    void cleanupViews();
con's avatar
con committed
301

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
302
    void setState(DebuggerState state, bool forced = false);
hjk's avatar
hjk committed
303

304
    //
con's avatar
con committed
305
    // internal implementation
306
    //
307
308
309
310
311
312
313
    bool qtDumperLibraryEnabled() const;
    QString qtDumperLibraryName() const;
    QStringList qtDumperLibraryLocations() const;
    void showQtDumperLibraryWarning(const QString &details = QString());
    bool isReverseDebugging() const;
    QAbstractItemModel *threadsModel();

con's avatar
con committed
314
315
316
317
318
    Q_SLOT void loadSessionData();
    Q_SLOT void saveSessionData();
    Q_SLOT void dumpLog();

public:
319
    // stuff in this block should be made private by moving it to
con's avatar
con committed
320
    // one of the interfaces
321
    QList<Internal::Symbol> moduleSymbols(const QString &moduleName);
322

con's avatar
con committed
323
324
325
signals:
    void debuggingFinished();
    void inferiorPidChanged(qint64 pid);
hjk's avatar
hjk committed
326
    void stateChanged(int newstatus);
con's avatar
con committed
327
328
329
    void debugModeRequested();
    void previousModeRequested();
    void statusMessageRequested(const QString &msg, int timeout); // -1 for 'forever'
330
    void gotoLocationRequested(const QString &file, int line, bool setLocationMarker);
con's avatar
con committed
331
332
333
334
335
336
    void resetLocationRequested();
    void currentTextEditorRequested(QString *fileName, int *lineNumber, QObject **ob);
    void sessionValueRequested(const QString &name, QVariant *value);
    void setSessionValueRequested(const QString &name, const QVariant &value);
    void configValueRequested(const QString &name, QVariant *value);
    void setConfigValueRequested(const QString &name, const QVariant &value);
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
337
    void applicationOutputAvailable(const QString &output);
338
339
    void emitShowOutput(int channel, const QString &output);
    void emitShowInput(int channel, const QString &input);
con's avatar
con committed
340
341

private:
342
    void init();
hjk's avatar
hjk committed
343
    void runTest(const QString &fileName);
hjk's avatar
hjk committed
344
    Q_SLOT void createNewDock(QWidget *widget);
con's avatar
con committed
345
346
347
348

    void shutdown();

    void toggleBreakpoint(const QString &fileName, int lineNumber);
349
    void toggleBreakpointEnabled(const QString &fileName, int lineNumber);
350
    Internal::BreakpointData *findBreakpoint(const QString &fileName, int lineNumber);
hjk's avatar
hjk committed
351
352
    void setToolTipExpression(const QPoint &mousePos,
        TextEditor::ITextEditor *editor, int cursorPos);
con's avatar
con committed
353

354
    DebuggerManagerPrivate *d;
con's avatar
con committed
355
356
357
358
359
};

} // namespace Debugger

#endif // DEBUGGER_DEBUGGERMANAGER_H