debuggermanager.h 15 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
8
**
** Contact:  Qt Software Information (qt-info@nokia.com)
**
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
26
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30
31
32
33
34
35
36
37
38
39
40
41
42
#ifndef DEBUGGER_DEBUGGERMANAGER_H
#define DEBUGGER_DEBUGGERMANAGER_H

#include <QtCore/QByteArray>
#include <QtCore/QObject>
#include <QtCore/QPoint>
#include <QtCore/QStringList>
#include <QtCore/QVariant>

QT_BEGIN_NAMESPACE
class QAction;
class QAbstractItemModel;
class QDockWidget;
43
class QLabel;
con's avatar
con committed
44
45
46
class QMainWindow;
class QModelIndex;
class QSplitter;
47
class QTimer;
con's avatar
con committed
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
class QWidget;
QT_END_NAMESPACE

namespace Debugger {
namespace Internal {

class DebuggerOutputWindow;
class DebuggerPlugin;
class DebugMode;

class BreakHandler;
class DisassemblerHandler;
class ModulesHandler;
class RegisterHandler;
class StackHandler;
class ThreadsHandler;
class WatchHandler;
65
class SourceFilesWindow;
con's avatar
con committed
66
67
68
69
70
71
72
73
74
75
76
77
class WatchData;
class BreakpointData;


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

//     DebuggerProcessNotReady
//          |
//     DebuggerProcessStartingUp
//          | <-------------------------------------.
//     DebuggerInferiorRunningRequested             |
hjk's avatar
hjk committed
78
79
80
//          |                                       | 
//     DebuggerInferiorRunning                      | 
//          |                                       |  
con's avatar
con committed
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
//     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
};

105
106
107
108
109
110
111
112
enum DebuggerStartMode
{
    StartInternal,                    // Start current start project's binary
    StartExternal,                    // Start binary found in file system
    AttachExternal,                   // Attach to running process
    AttachCore                        // Attach to a core file
};

con's avatar
con committed
113
114
115
class IDebuggerEngine;
class GdbEngine;
class ScriptEngine;
116
class CdbDebugEngine;
117
struct CdbDebugEnginePrivate;
con's avatar
con committed
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

// 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
138
    // debugger engines
con's avatar
con committed
139
    friend class GdbEngine;
140
141
    friend class CdbDebugEngine;
    friend class CdbDebugEventCallback;
con's avatar
con committed
142
    friend class ScriptEngine;
143
    friend struct CdbDebugEnginePrivate;
con's avatar
con committed
144
145

    // called from the engines after successful startup
146
    virtual void notifyInferiorStopRequested() = 0;
con's avatar
con committed
147
148
149
150
151
152
153
154
155
156
157
158
159
    virtual void notifyInferiorStopped() = 0; 
    virtual void notifyInferiorRunningRequested() = 0;
    virtual void notifyInferiorRunning() = 0;
    virtual void notifyInferiorExited() = 0;
    virtual void notifyInferiorPidChanged(int) = 0;

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
162
    virtual void showApplicationOutput(const QString &data) = 0;
con's avatar
con committed
163
164
165
    virtual bool skipKnownFrames() const = 0;
    virtual bool debugDumpers() const = 0;
    virtual bool useCustomDumpers() const = 0;
166
    
167
    virtual bool wantsSourceFileList() const = 0;
168
169
170
171
    virtual bool wantsAllPluginBreakpoints() const = 0;
    virtual bool wantsSelectedPluginBreakpoints() const = 0;
    virtual bool wantsNoPluginBreakpoints() const = 0;
    virtual QString selectedPluginBreakpointsPattern() const = 0;
con's avatar
con committed
172
173
174

    virtual void reloadDisassembler() = 0;
    virtual void reloadModules() = 0;
175
    virtual void reloadSourceFiles() = 0;
con's avatar
con committed
176
177
178
179
    virtual void reloadRegisters() = 0;
};


180
181
182
183
184
185
186
187
//
// DebuggerSettings
//

class DebuggerSettings
{
public:
    DebuggerSettings();
188
    QString dump();
189
190
191
192
193
194
195
196
197
198
199

public:
    QString m_gdbCmd;
    QString m_gdbEnv;
    bool m_autoRun;
    bool m_autoQuit;

    bool m_useCustomDumpers;
    bool m_skipKnownFrames;
    bool m_debugDumpers;
    bool m_useToolTips;
200
    bool m_listSourceFiles;
201
202

    QString m_scriptFile;
203
204
205
206
207

    bool m_pluginAllBreakpoints;
    bool m_pluginSelectedBreakpoints;
    bool m_pluginNoBreakpoints;
    QString m_pluginSelectedBreakpointsPattern;
208
209
};

con's avatar
con committed
210
211
212
213
214
//
// DebuggerManager
//

class DebuggerManager : public QObject,
hjk's avatar
hjk committed
215
    public IDebuggerManagerAccessForEngines
con's avatar
con committed
216
217
218
219
220
221
222
223
224
{
    Q_OBJECT

public:
    DebuggerManager();
    ~DebuggerManager();

    IDebuggerManagerAccessForEngines *engineInterface();
    QMainWindow *mainWindow() const { return m_mainWindow; }
225
    QLabel *statusLabel() const { return m_statusLabel; }
226
    DebuggerSettings *settings() { return &m_settings; }
con's avatar
con committed
227
228
229
230

    enum DebuggerType { GdbDebugger, ScriptDebugger, WinDebugger };

public slots:
231
    bool startNewDebugger(DebuggerStartMode mode);
con's avatar
con committed
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
    void exitDebugger(); 

    void setSimpleDockWidgetArrangement();
    void setLocked(bool locked);
    void dockToggled(bool on);

    void setBusyCursor(bool on);
    void queryCurrentTextEditor(QString *fileName, int *lineNumber, QObject **ed);
    void querySessionValue(const QString &name, QVariant *value);
    void setSessionValue(const QString &name, const QVariant &value);
    QVariant configValue(const QString &name);
    void queryConfigValue(const QString &name, QVariant *value);
    void setConfigValue(const QString &name, const QVariant &value);
    QVariant sessionValue(const QString &name);

    void gotoLocation(const QString &file, int line, bool setLocationMarker);
248
    void fileOpen(const QString &file);
con's avatar
con committed
249
250
251
252
253
    void resetLocation();

    void interruptDebuggingRequest();
    void startExternalApplication();
    void attachExternalApplication();
254
    void attachCore();
con's avatar
con committed
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286

    void jumpToLineExec();
    void runToLineExec();
    void runToFunctionExec();
    void toggleBreakpoint();
    void breakByFunction();
    void breakByFunction(const QString &functionName);
    void setBreakpoint(const QString &fileName, int lineNumber);
    void watchExpression(const QString &expression);
    void breakAtMain();
    void activateFrame(int index);
    void selectThread(int index);

    void stepExec();
    void stepOutExec();
    void nextExec();
    void stepIExec();
    void nextIExec();
    void continueExec();

    void addToWatchWindow();
    void updateWatchModel();
    void removeWatchExpression(const QString &iname);
    void expandChildren(const QModelIndex &idx);
    void collapseChildren(const QModelIndex &idx);
    
    void sessionLoaded();
    void aboutToSaveSession();

    void assignValueInDebugger(const QString &expr, const QString &value);
    void executeDebuggerCommand(const QString &command);

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

289
290
291
292
    void setUseCustomDumpers(bool on);
    void setDebugDumpers(bool on);
    void setSkipKnownFrames(bool on);

con's avatar
con committed
293
294
295
private slots:
    void showDebuggerOutput(const QString &prefix, const QString &msg);
    void showDebuggerInput(const QString &prefix, const QString &msg);
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
296
    void showApplicationOutput(const QString &data);
con's avatar
con committed
297
298
299
300

    void reloadDisassembler();
    void disassemblerDockToggled(bool on);

301
302
303
    void reloadSourceFiles();
    void sourceFilesDockToggled(bool on);

con's avatar
con committed
304
305
306
307
308
309
310
311
    void reloadModules();
    void modulesDockToggled(bool on);
    void loadSymbols(const QString &moduleName);
    void loadAllSymbols();

    void reloadRegisters();
    void registerDockToggled(bool on);
    void setStatus(int status);
312
    void clearStatusMessage();
313
    void attemptBreakpointSynchronization();
con's avatar
con committed
314
315
316
317
318
319
320
321
322
323
324
325

private:
    //
    // Implementation of IDebuggerManagerAccessForEngines
    // 
    DisassemblerHandler *disassemblerHandler() { return m_disassemblerHandler; }
    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; }
326
    SourceFilesWindow *sourceFileWindow() { return m_sourceFilesWindow; }
327

con's avatar
con committed
328
329
330
    bool skipKnownFrames() const;
    bool debugDumpers() const;
    bool useCustomDumpers() const;
331
332
    bool wantsSourceFileList() const
        { return m_settings.m_listSourceFiles; }
333
334
335
336
337
338
339
340
    bool wantsAllPluginBreakpoints() const
        { return m_settings.m_pluginAllBreakpoints; }
    bool wantsSelectedPluginBreakpoints() const
        { return m_settings.m_pluginSelectedBreakpoints; }
    bool wantsNoPluginBreakpoints() const
        { return m_settings.m_pluginNoBreakpoints; }
    QString selectedPluginBreakpointsPattern() const
        { return m_settings.m_pluginSelectedBreakpointsPattern; }
con's avatar
con committed
341
342
343

    void notifyInferiorStopped();
    void notifyInferiorRunningRequested();
344
    void notifyInferiorStopRequested();
con's avatar
con committed
345
346
347
348
349
350
351
352
353
    void notifyInferiorRunning();
    void notifyInferiorExited();
    void notifyInferiorPidChanged(int);

    void cleanupViews(); 

    //
    // Implementation of IDebuggerManagerAccessForDebugMode
    //
354
    QWidget *threadsWindow() const { return m_threadsWindow; }
con's avatar
con committed
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
    QList<QDockWidget*> dockWidgets() const { return m_dockWidgets; }
    void createDockWidgets();

    //    
    // internal implementation
    //  
    Q_SLOT void loadSessionData();
    Q_SLOT void saveSessionData();
    Q_SLOT void dumpLog();

public:
    // stuff in this block should be made private by moving it to 
    // one of the interfaces
    QAbstractItemModel *threadsModel();
    int status() const { return m_status; }
370
    DebuggerStartMode startMode() const { return m_startMode; }
con's avatar
con committed
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386

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'
    void gotoLocationRequested(const QString &file, int line, bool setLocationMarker);
    void resetLocationRequested();
    void currentTextEditorRequested(QString *fileName, int *lineNumber, QObject **ob);
    void currentMainWindowRequested(QWidget **);
    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
387
    void applicationOutputAvailable(const QString &output);
388
    void settingsDialogRequested();
con's avatar
con committed
389
390
391
392

public:
    // FIXME: make private
    QString m_executable;
393
    QString m_coreFile;
con's avatar
con committed
394
395
396
397
398
    QStringList m_environment;
    QString m_workingDir;
    QString m_buildDir;
    QStringList m_processArgs;
    int m_attachedPID;
399
    bool m_useTerminal;
con's avatar
con committed
400
401
402
403
404

private:
    void init();
    void setDebuggerType(DebuggerType type);
    QDockWidget *createDockForWidget(QWidget *widget);
hjk's avatar
hjk committed
405
    Q_SLOT void createNewDock(QWidget *widget);
con's avatar
con committed
406
407
408
409
410
411

    void shutdown();

    void toggleBreakpoint(const QString &fileName, int lineNumber);
    void setToolTipExpression(const QPoint &pos, const QString &exp0);

412
    DebuggerStartMode m_startMode;
con's avatar
con committed
413
414
415
416
    DebuggerType m_debuggerType;

    /// Views
    QMainWindow *m_mainWindow;
417
    QLabel *m_statusLabel;
con's avatar
con committed
418
419
420
421
422
423
    QDockWidget *m_breakDock;
    QDockWidget *m_disassemblerDock;
    QDockWidget *m_modulesDock;
    QDockWidget *m_outputDock;
    QDockWidget *m_registerDock;
    QDockWidget *m_stackDock;
424
    QDockWidget *m_sourceFilesDock;
con's avatar
con committed
425
426
427
428
429
430
431
432
433
434
435
    QDockWidget *m_threadsDock;
    QDockWidget *m_watchDock;
    QList<QDockWidget*> m_dockWidgets;

    BreakHandler *m_breakHandler;
    DisassemblerHandler *m_disassemblerHandler;
    ModulesHandler *m_modulesHandler;
    RegisterHandler *m_registerHandler;
    StackHandler *m_stackHandler;
    ThreadsHandler *m_threadsHandler;
    WatchHandler *m_watchHandler;
436
    SourceFilesWindow *m_sourceFilesWindow;
con's avatar
con committed
437
438
439
440
441

    /// Actions
    friend class DebuggerPlugin;
    QAction *m_startExternalAction;
    QAction *m_attachExternalAction;
442
    QAction *m_attachCoreAction;
con's avatar
con committed
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
    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_breakByFunctionAction;
    QAction *m_breakAtMainAction;
    QAction *m_sepAction;
    QAction *m_stepIAction;
    QAction *m_nextIAction;

    QWidget *m_breakWindow;
    QWidget *m_disassemblerWindow;
    QWidget *m_localsWindow;
    QWidget *m_registerWindow;
    QWidget *m_modulesWindow;
    QWidget *m_tooltipWindow;
    QWidget *m_stackWindow;
    QWidget *m_threadsWindow;
    QWidget *m_watchersWindow;
    DebuggerOutputWindow *m_outputWindow;

    int m_status;
    bool m_busy;
473
474
    QTimer *m_statusTimer;
    QString m_lastPermanentStatusMessage;
con's avatar
con committed
475
476
477

    IDebuggerEngine *engine();
    IDebuggerEngine *m_engine;
478
    DebuggerSettings m_settings;
con's avatar
con committed
479
480
481
482
483
484
};

} // namespace Internal
} // namespace Debugger

#endif // DEBUGGER_DEBUGGERMANAGER_H