debuggermanager.h 15.1 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
34
#include <utils/fancymainwindow.h>

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

QT_BEGIN_NAMESPACE
class QAction;
class QAbstractItemModel;
class QDockWidget;
45
class QLabel;
46
class QModelIndex;
47
class QPoint;
48
class QTimer;
con's avatar
con committed
49
class QWidget;
50
class QDebug;
con's avatar
con committed
51
52
QT_END_NAMESPACE

53
namespace Core {
54
55
class IOptionsPage;
} // namespace Core
56

57
namespace TextEditor {
58
class ITextEditor;
59
60
}

con's avatar
con committed
61
62
63
namespace Debugger {
namespace Internal {

64
65
66
67
68
typedef QLatin1Char _c;
typedef QLatin1String __;
inline QString _(const char *s) { return QString::fromLatin1(s); }
inline QString _(const QByteArray &ba) { return QString::fromLatin1(ba, ba.size()); }

con's avatar
con committed
69
class DebuggerOutputWindow;
70
class DebuggerRunControl;
con's avatar
con committed
71
72
73
74
class DebuggerPlugin;
class DebugMode;

class BreakHandler;
75
class BreakpointData;
con's avatar
con committed
76
77
class ModulesHandler;
class RegisterHandler;
78
class SourceFilesWindow;
79
struct StackFrame;
con's avatar
con committed
80
class StackHandler;
81
class Symbol;
con's avatar
con committed
82
83
class ThreadsHandler;
class WatchData;
84
class WatchHandler;
con's avatar
con committed
85
86
87
88
89
90
91
92
93

// Note: the Debugger process itself is referred to as 'Debugger',
// whereas the debugged process is referred to as 'Inferior' or 'Debuggee'.

//     DebuggerProcessNotReady
//          |
//     DebuggerProcessStartingUp
//          | <-------------------------------------.
//     DebuggerInferiorRunningRequested             |
94
95
96
//          |                                       |
//     DebuggerInferiorRunning                      |
//          |                                       |
con's avatar
con committed
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
//     DebuggerInferiorStopRequested                |
//          |                                       |
//     DebuggerInferiorStopped                      |
//          |                                       |
//          `---------------------------------------'
//
// Allowed actions:
//    [R] :  Run
//    [C] :  Continue
//    [N] :  Step, Next


enum DebuggerStatus
{
    DebuggerProcessNotReady,          // Debugger not started
    DebuggerProcessStartingUp,        // Debugger starting up

    DebuggerInferiorRunningRequested, // Debuggee requested to run
    DebuggerInferiorRunning,          // Debuggee running
    DebuggerInferiorStopRequested,    // Debuggee running, stop requested
    DebuggerInferiorStopped,          // Debuggee stopped
};

120
121
enum DebuggerStartMode
{
122
    NoStartMode,
123
124
125
126
127
128
129
    StartInternal,         // Start current start project's binary
    StartExternal,         // Start binary found in file system
    AttachExternal,        // Attach to running process by process id
    AttachCrashedExternal, // Attach to crashed process by process id
    AttachTcf,             // Attach to a running Target Communication Framework agent
    AttachCore,            // Attach to a core file
    StartRemote            // Start and attach to a remote process
130
131
};

132
133
134
135
enum LogChannel
{
    LogInput,   // Used for user input
    LogOutput,
136
    LogWarning,
137
138
    LogError,
    LogStatus,  // Used for status changed messages
139
    LogTime,  // Used for time stamp messages
140
141
142
143
    LogDebug,
    LogMisc    
};

144
class DebuggerStartParameters
145
{
146
public:
147
148
149
150
151
152
153
154
155
156
157
    DebuggerStartParameters();
    void clear();

    QString executable;
    QString coreFile;
    QStringList processArgs;
    QStringList environment;
    QString workingDir;
    QString buildDir;
    qint64 attachPID;
    bool useTerminal;
158
    QString crashParameter; // for AttachCrashedExternal
159
160
161
162
    // for remote debugging
    QString remoteChannel;
    QString remoteArchitecture;
    QString serverStartScript;
163
    int toolChainType;
164
165
166
167
};

QDebug operator<<(QDebug str, const DebuggerStartParameters &);

con's avatar
con committed
168
169
170
class IDebuggerEngine;
class GdbEngine;
class ScriptEngine;
171
class CdbDebugEngine;
172
struct CdbDebugEnginePrivate;
con's avatar
con committed
173

174
175
176
177
178
179
180
181
182
// Flags for initialization
enum DebuggerEngineTypeFlags {
    GdbEngineType = 0x1,
    ScriptEngineType = 0x2,
    CdbEngineType = 0x4,
    TcfEngineType = 0x8,
    AllEngineTypes = (GdbEngineType|ScriptEngineType|CdbEngineType|TcfEngineType)
};

con's avatar
con committed
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
// The construct below is not nice but enforces a bit of order. The
// DebuggerManager interfaces a lots of thing: The DebuggerPlugin,
// the DebuggerEngines, the RunMode, the handlers and views.
// Instead of making the whole interface public, we split in into
// smaller parts and grant friend access only to the classes that
// need it.


//
// IDebuggerManagerAccessForEngines
//

class IDebuggerManagerAccessForEngines
{
public:
    virtual ~IDebuggerManagerAccessForEngines() {}

private:
    // This is the part of the interface that's exclusively seen by the
202
    // debugger engines
203

204
205
    friend class CdbDebugEngine;
    friend class CdbDebugEventCallback;
206
    friend class CdbDumperHelper;
207
    friend class CdbExceptionLoggerEventCallback;
208
209
210
211
    friend class GdbEngine;
    friend class ScriptEngine;
    friend class TcfEngine;
    friend struct CdbDebugEnginePrivate;
con's avatar
con committed
212
213

    // called from the engines after successful startup
214
    virtual void notifyInferiorStopRequested() = 0;
215
    virtual void notifyInferiorStopped() = 0;
con's avatar
con committed
216
217
218
    virtual void notifyInferiorRunningRequested() = 0;
    virtual void notifyInferiorRunning() = 0;
    virtual void notifyInferiorExited() = 0;
219
    virtual void notifyInferiorPidChanged(qint64) = 0;
con's avatar
con committed
220
221
222
223
224
225
226

    virtual ModulesHandler *modulesHandler() = 0;
    virtual BreakHandler *breakHandler() = 0;
    virtual RegisterHandler *registerHandler() = 0;
    virtual StackHandler *stackHandler() = 0;
    virtual ThreadsHandler *threadsHandler() = 0;
    virtual WatchHandler *watchHandler() = 0;
227
    virtual SourceFilesWindow *sourceFileWindow() = 0;
con's avatar
con committed
228

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
229
    virtual void showApplicationOutput(const QString &data) = 0;
230
231
    virtual void showDebuggerOutput(int channel, const QString &msg) = 0;
    virtual void showDebuggerInput(int channel, const QString &msg) = 0;
232

con's avatar
con committed
233
    virtual void reloadModules() = 0;
234
    virtual void reloadSourceFiles() = 0;
con's avatar
con committed
235
    virtual void reloadRegisters() = 0;
236
237
238

    virtual bool qtDumperLibraryEnabled() const = 0;
    virtual QString qtDumperLibraryName() const = 0;
239
    virtual QStringList qtDumperLibraryLocations() const = 0;
240
    virtual void showQtDumperLibraryWarning(const QString &details = QString()) = 0;
241
    virtual bool isReverseDebugging() const = 0;
242

243
244
245
    virtual qint64 inferiorPid() const = 0;

    virtual QSharedPointer<DebuggerStartParameters> startParameters() const = 0;
con's avatar
con committed
246
247
248
249
250
251
252
};


//
// DebuggerManager
//

253
class DebuggerManager : public QObject, public IDebuggerManagerAccessForEngines
con's avatar
con committed
254
255
256
257
{
    Q_OBJECT

public:
258
    DebuggerManager();
259
    QList<Core::IOptionsPage*> initializeEngines(unsigned enabledTypeFlags);
260

con's avatar
con committed
261
262
263
    ~DebuggerManager();

    IDebuggerManagerAccessForEngines *engineInterface();
264
    Core::Utils::FancyMainWindow *mainWindow() const { return m_mainWindow; }
265
    QLabel *statusLabel() const { return m_statusLabel; }
266
    IDebuggerEngine *currentEngine() const { return m_engine; }
con's avatar
con committed
267
268

public slots:
269
270
    void startNewDebugger(DebuggerRunControl *runControl,
        const QSharedPointer<DebuggerStartParameters> &startParameters);
271
272
273
274
275
276
    void exitDebugger();

    virtual QSharedPointer<DebuggerStartParameters> startParameters() const;
    virtual qint64 inferiorPid() const;

    void setQtDumperLibraryName(const QString &dl); // Run Control
277
    void setQtDumperLibraryLocations(const QStringList &dl);
con's avatar
con committed
278
279
280
281
282
283

    void setSimpleDockWidgetArrangement();

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

284
    void gotoLocation(const StackFrame &frame, bool setLocationMarker);
285
    void fileOpen(const QString &file);
con's avatar
con committed
286
287
288
289
290
291
292
293
294
    void resetLocation();

    void interruptDebuggingRequest();

    void jumpToLineExec();
    void runToLineExec();
    void runToFunctionExec();
    void toggleBreakpoint();
    void breakByFunction(const QString &functionName);
295
    void breakByFunctionMain();
con's avatar
con committed
296
297
298
299
300
301
302
303
    void setBreakpoint(const QString &fileName, int lineNumber);
    void activateFrame(int index);
    void selectThread(int index);

    void stepExec();
    void stepOutExec();
    void nextExec();
    void continueExec();
304
    void detachDebugger();
con's avatar
con committed
305
306

    void addToWatchWindow();
307
    void updateWatchData(const WatchData &data);
308

con's avatar
con committed
309
    void sessionLoaded();
310
    void aboutToUnloadSession();
con's avatar
con committed
311
    void aboutToSaveSession();
312
313
    QVariant sessionValue(const QString &name);
    void setSessionValue(const QString &name, const QVariant &value);
con's avatar
con committed
314

315
    void assignValueInDebugger();
con's avatar
con committed
316
    void assignValueInDebugger(const QString &expr, const QString &value);
317
318

    void executeDebuggerCommand();
con's avatar
con committed
319
320
    void executeDebuggerCommand(const QString &command);

321
322
    void watchPoint();

323
    void showStatusMessage(const QString &msg, int timeout = -1); // -1 forever
con's avatar
con committed
324
325

private slots:
326
327
    void showDebuggerOutput(int channel, const QString &msg);
    void showDebuggerInput(int channel, const QString &msg);
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
328
    void showApplicationOutput(const QString &data);
con's avatar
con committed
329

330
331
332
    void reloadSourceFiles();
    void sourceFilesDockToggled(bool on);

con's avatar
con committed
333
334
335
336
337
338
339
340
    void reloadModules();
    void modulesDockToggled(bool on);
    void loadSymbols(const QString &moduleName);
    void loadAllSymbols();

    void reloadRegisters();
    void registerDockToggled(bool on);
    void setStatus(int status);
341
    void clearStatusMessage();
342
    void attemptBreakpointSynchronization();
343
    void reloadFullStack();
344
    void stepByInstructionTriggered();
con's avatar
con committed
345
346
347
348

private:
    //
    // Implementation of IDebuggerManagerAccessForEngines
349
    //
con's avatar
con committed
350
351
352
353
354
355
    ModulesHandler *modulesHandler() { return m_modulesHandler; }
    BreakHandler *breakHandler() { return m_breakHandler; }
    RegisterHandler *registerHandler() { return m_registerHandler; }
    StackHandler *stackHandler() { return m_stackHandler; }
    ThreadsHandler *threadsHandler() { return m_threadsHandler; }
    WatchHandler *watchHandler() { return m_watchHandler; }
356
    SourceFilesWindow *sourceFileWindow() { return m_sourceFilesWindow; }
357

con's avatar
con committed
358
359
    void notifyInferiorStopped();
    void notifyInferiorRunningRequested();
360
    void notifyInferiorStopRequested();
con's avatar
con committed
361
362
    void notifyInferiorRunning();
    void notifyInferiorExited();
363
    void notifyInferiorPidChanged(qint64);
con's avatar
con committed
364

365
    void cleanupViews();
con's avatar
con committed
366
367
368
369

    //
    // Implementation of IDebuggerManagerAccessForDebugMode
    //
370
    QWidget *threadsWindow() const { return m_threadsWindow; }
con's avatar
con committed
371

372
373
    virtual bool qtDumperLibraryEnabled() const;
    virtual QString qtDumperLibraryName() const;
374
    virtual QStringList qtDumperLibraryLocations() const;
375
    virtual void showQtDumperLibraryWarning(const QString &details = QString());
376
    virtual bool isReverseDebugging() const;
377

378
    //
con's avatar
con committed
379
    // internal implementation
380
    //
con's avatar
con committed
381
382
383
384
385
    Q_SLOT void loadSessionData();
    Q_SLOT void saveSessionData();
    Q_SLOT void dumpLog();

public:
386
    // stuff in this block should be made private by moving it to
con's avatar
con committed
387
388
389
    // one of the interfaces
    QAbstractItemModel *threadsModel();
    int status() const { return m_status; }
390
391
    DebuggerStartMode startMode() const;
    DebuggerRunControl *runControl() const { return m_runControl; }
con's avatar
con committed
392

393
394
    QList<Symbol> moduleSymbols(const QString &moduleName);

con's avatar
con committed
395
396
397
398
399
400
401
signals:
    void debuggingFinished();
    void inferiorPidChanged(qint64 pid);
    void statusChanged(int newstatus);
    void debugModeRequested();
    void previousModeRequested();
    void statusMessageRequested(const QString &msg, int timeout); // -1 for 'forever'
402
    void gotoLocationRequested(const StackFrame &frame, bool setLocationMarker);
con's avatar
con committed
403
404
405
406
407
408
    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
409
    void applicationOutputAvailable(const QString &output);
con's avatar
con committed
410
411

private:
412
    void init();
hjk's avatar
hjk committed
413
    void runTest(const QString &fileName);
hjk's avatar
hjk committed
414
    Q_SLOT void createNewDock(QWidget *widget);
con's avatar
con committed
415
416
417
418

    void shutdown();

    void toggleBreakpoint(const QString &fileName, int lineNumber);
419
420
    void toggleBreakpointEnabled(const QString &fileName, int lineNumber);
    BreakpointData *findBreakpoint(const QString &fileName, int lineNumber);
421
    void setToolTipExpression(const QPoint &mousePos, TextEditor::ITextEditor *editor, int cursorPos);
con's avatar
con committed
422

423
    QSharedPointer<DebuggerStartParameters> m_startParameters;
424
    DebuggerRunControl *m_runControl;
425
    QString m_dumperLib;
426
    QStringList m_dumperLibLocations;
427
428
    qint64 m_inferiorPid;

con's avatar
con committed
429
430

    /// Views
431
    Core::Utils::FancyMainWindow *m_mainWindow;
432
    QLabel *m_statusLabel;
con's avatar
con committed
433
434
435
436
437
    QDockWidget *m_breakDock;
    QDockWidget *m_modulesDock;
    QDockWidget *m_outputDock;
    QDockWidget *m_registerDock;
    QDockWidget *m_stackDock;
438
    QDockWidget *m_sourceFilesDock;
con's avatar
con committed
439
440
441
442
443
444
445
446
447
    QDockWidget *m_threadsDock;
    QDockWidget *m_watchDock;

    BreakHandler *m_breakHandler;
    ModulesHandler *m_modulesHandler;
    RegisterHandler *m_registerHandler;
    StackHandler *m_stackHandler;
    ThreadsHandler *m_threadsHandler;
    WatchHandler *m_watchHandler;
448
    SourceFilesWindow *m_sourceFilesWindow;
con's avatar
con committed
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463

    /// Actions
    friend class DebuggerPlugin;
    QAction *m_continueAction;
    QAction *m_stopAction;
    QAction *m_resetAction; // FIXME: Should not be needed in a stable release
    QAction *m_stepAction;
    QAction *m_stepOutAction;
    QAction *m_runToLineAction;
    QAction *m_runToFunctionAction;
    QAction *m_jumpToLineAction;
    QAction *m_nextAction;
    QAction *m_watchAction;
    QAction *m_breakAction;
    QAction *m_sepAction;
464
    //QActio *m_stepByInstructionAction;
465
    QAction *m_reverseDirectionAction;
con's avatar
con committed
466
467

    QWidget *m_breakWindow;
468
    QWidget *m_localsWindow;
con's avatar
con committed
469
470
    QWidget *m_registerWindow;
    QWidget *m_modulesWindow;
471
    //QWidget *m_tooltipWindow;
con's avatar
con committed
472
473
    QWidget *m_stackWindow;
    QWidget *m_threadsWindow;
474
    QWidget *m_watchersWindow;
con's avatar
con committed
475
476
477
478
    DebuggerOutputWindow *m_outputWindow;

    int m_status;
    bool m_busy;
479
480
    QTimer *m_statusTimer;
    QString m_lastPermanentStatusMessage;
con's avatar
con committed
481
482
483
484
485
486
487
488
489

    IDebuggerEngine *engine();
    IDebuggerEngine *m_engine;
};

} // namespace Internal
} // namespace Debugger

#endif // DEBUGGER_DEBUGGERMANAGER_H