debuggermanager.h 14.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
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
#ifndef DEBUGGER_DEBUGGERMANAGER_H
#define DEBUGGER_DEBUGGERMANAGER_H

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

QT_BEGIN_NAMESPACE
class QAction;
class QAbstractItemModel;
class QDockWidget;
42
class QLabel;
con's avatar
con committed
43
class QMainWindow;
44
class QPoint;
45
class QTimer;
con's avatar
con committed
46
47
48
class QWidget;
QT_END_NAMESPACE

49
namespace Core {
50
51
class IOptionsPage;
} // namespace Core
52

53
54
55
56
namespace TextEditor {
    class ITextEditor;
}

con's avatar
con committed
57
58
59
namespace Debugger {
namespace Internal {

60
61
62
63
64
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
65
class DebuggerOutputWindow;
66
class DebuggerRunControl;
con's avatar
con committed
67
68
69
70
71
72
73
74
75
76
class DebuggerPlugin;
class DebugMode;

class BreakHandler;
class DisassemblerHandler;
class ModulesHandler;
class RegisterHandler;
class StackHandler;
class ThreadsHandler;
class WatchHandler;
77
class SourceFilesWindow;
con's avatar
con committed
78
79
class WatchData;
class BreakpointData;
80
class Symbol;
con's avatar
con committed
81
82
83
84
85
86
87
88
89

// 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
90
91
92
//          |                                       | 
//     DebuggerInferiorRunning                      | 
//          |                                       |  
con's avatar
con committed
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
//     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
};

117
118
enum DebuggerStartMode
{
119
120
121
122
123
124
    StartInternal,   // Start current start project's binary
    StartExternal,   // Start binary found in file system
    AttachExternal,  // Attach to running process
    AttachTcf,       // Attach to a running Target Communication Framework agent
    AttachCore,      // Attach to a core file
    StartRemote      // Start and attach to a remote process
125
126
};

con's avatar
con committed
127
128
129
class IDebuggerEngine;
class GdbEngine;
class ScriptEngine;
130
class CdbDebugEngine;
131
struct CdbDebugEnginePrivate;
con's avatar
con committed
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

// 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
152
    // debugger engines
153
154
    friend class CdbDebugEngine;
    friend class CdbDebugEventCallback;
155
    friend class CdbDumperHelper;
156
    friend class CdbExceptionLoggerEventCallback;
157
158
159
160
    friend class GdbEngine;
    friend class ScriptEngine;
    friend class TcfEngine;
    friend struct CdbDebugEnginePrivate;
con's avatar
con committed
161
162

    // called from the engines after successful startup
163
    virtual void notifyInferiorStopRequested() = 0;
con's avatar
con committed
164
165
166
167
168
169
170
171
172
173
174
175
176
    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;
177
    virtual SourceFilesWindow *sourceFileWindow() = 0;
con's avatar
con committed
178

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
179
    virtual void showApplicationOutput(const QString &data) = 0;
180
181
    virtual void showDebuggerOutput(const QString &prefix, const QString &msg) = 0;
    virtual void showDebuggerInput(const QString &prefix, const QString &msg) = 0;
182
    
con's avatar
con committed
183
184
    virtual void reloadDisassembler() = 0;
    virtual void reloadModules() = 0;
185
    virtual void reloadSourceFiles() = 0;
con's avatar
con committed
186
    virtual void reloadRegisters() = 0;
187
188
189
190
191

    virtual bool qtDumperLibraryEnabled() const = 0;
    virtual QString qtDumperLibraryName() const = 0;
    virtual void showQtDumperLibraryWarning(const QString &details = QString()) = 0;

con's avatar
con committed
192
193
194
195
196
197
198
199
};


//
// DebuggerManager
//

class DebuggerManager : public QObject,
hjk's avatar
hjk committed
200
    public IDebuggerManagerAccessForEngines
con's avatar
con committed
201
202
203
204
{
    Q_OBJECT

public:
205
206
207
    DebuggerManager();
    QList<Core::IOptionsPage*> initializeEngines(const QStringList &arguments);

con's avatar
con committed
208
209
210
211
    ~DebuggerManager();

    IDebuggerManagerAccessForEngines *engineInterface();
    QMainWindow *mainWindow() const { return m_mainWindow; }
212
    QLabel *statusLabel() const { return m_statusLabel; }
con's avatar
con committed
213
214

public slots:
215
    void startNewDebugger(DebuggerRunControl *runControl);
con's avatar
con committed
216
217
218
219
    void exitDebugger(); 

    void setSimpleDockWidgetArrangement();
    void setLocked(bool locked);
220
    void dockActionTriggered();
221
    void modeVisibilityChanged(bool visible);
con's avatar
con committed
222
223
224
225
226
227
228
229
230

    void setBusyCursor(bool on);
    void queryCurrentTextEditor(QString *fileName, int *lineNumber, QObject **ed);
    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);
231
    void fileOpen(const QString &file);
con's avatar
con committed
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
    void resetLocation();

    void interruptDebuggingRequest();

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

    void stepExec();
    void stepOutExec();
    void nextExec();
    void stepIExec();
    void nextIExec();
    void continueExec();
253
    void detachDebugger();
con's avatar
con committed
254
255
256
257
258

    void addToWatchWindow();
    void updateWatchModel();
    
    void sessionLoaded();
259
    void sessionUnloaded();
con's avatar
con committed
260
261
    void aboutToSaveSession();

262
    void assignValueInDebugger();
con's avatar
con committed
263
    void assignValueInDebugger(const QString &expr, const QString &value);
264
265

    void executeDebuggerCommand();
con's avatar
con committed
266
267
    void executeDebuggerCommand(const QString &command);

268
    void showStatusMessage(const QString &msg, int timeout = -1); // -1 forever
con's avatar
con committed
269
270
271
272

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
273
    void showApplicationOutput(const QString &data);
con's avatar
con committed
274
275
276
277

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

278
279
280
    void reloadSourceFiles();
    void sourceFilesDockToggled(bool on);

con's avatar
con committed
281
282
283
284
285
286
287
288
    void reloadModules();
    void modulesDockToggled(bool on);
    void loadSymbols(const QString &moduleName);
    void loadAllSymbols();

    void reloadRegisters();
    void registerDockToggled(bool on);
    void setStatus(int status);
289
    void clearStatusMessage();
290
    void attemptBreakpointSynchronization();
291
    void reloadFullStack();
con's avatar
con committed
292
293
294
295
296
297
298
299
300
301
302
303

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; }
304
    SourceFilesWindow *sourceFileWindow() { return m_sourceFilesWindow; }
305

con's avatar
con committed
306
307
    void notifyInferiorStopped();
    void notifyInferiorRunningRequested();
308
    void notifyInferiorStopRequested();
con's avatar
con committed
309
310
311
312
313
314
315
316
317
    void notifyInferiorRunning();
    void notifyInferiorExited();
    void notifyInferiorPidChanged(int);

    void cleanupViews(); 

    //
    // Implementation of IDebuggerManagerAccessForDebugMode
    //
318
    QWidget *threadsWindow() const { return m_threadsWindow; }
con's avatar
con committed
319
320
    QList<QDockWidget*> dockWidgets() const { return m_dockWidgets; }

321
322
323
324
    virtual bool qtDumperLibraryEnabled() const;
    virtual QString qtDumperLibraryName() const;
    virtual void showQtDumperLibraryWarning(const QString &details = QString());

con's avatar
con committed
325
326
327
328
329
330
331
332
333
334
335
336
    //    
    // 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; }
337
338
    DebuggerStartMode startMode() const;
    DebuggerRunControl *runControl() const { return m_runControl; }
con's avatar
con committed
339

340
341
    QList<Symbol> moduleSymbols(const QString &moduleName);

con's avatar
con committed
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
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
357
    void applicationOutputAvailable(const QString &output);
con's avatar
con committed
358
359
360
361

public:
    // FIXME: make private
    QString m_executable;
362
    QString m_coreFile;
con's avatar
con committed
363
364
365
366
    QStringList m_environment;
    QString m_workingDir;
    QString m_buildDir;
    QStringList m_processArgs;
hjk's avatar
hjk committed
367
    QString m_dumperLib;
con's avatar
con committed
368
    int m_attachedPID;
369
    bool m_useTerminal;
370
    // for remote debugging
371
372
    QString m_remoteChannel;
    QString m_remoteArchitecture;
373
    QString m_serverStartScript;
con's avatar
con committed
374
375

private:
376
    void init();
hjk's avatar
hjk committed
377
    void runTest(const QString &fileName);
con's avatar
con committed
378
    QDockWidget *createDockForWidget(QWidget *widget);
hjk's avatar
hjk committed
379
    Q_SLOT void createNewDock(QWidget *widget);
380
381
382
    void updateDockWidget(QDockWidget *dockWidget);
    Q_SLOT void onDockVisibilityChange(bool visible);
    Q_SLOT void onTopLevelChanged();
con's avatar
con committed
383
384
385
386

    void shutdown();

    void toggleBreakpoint(const QString &fileName, int lineNumber);
387
388
    void toggleBreakpointEnabled(const QString &fileName, int lineNumber);
    BreakpointData *findBreakpoint(const QString &fileName, int lineNumber);
389
    void setToolTipExpression(const QPoint &mousePos, TextEditor::ITextEditor *editor, int cursorPos);
con's avatar
con committed
390

391
    DebuggerRunControl *m_runControl;
con's avatar
con committed
392
393
394

    /// Views
    QMainWindow *m_mainWindow;
395
    QLabel *m_statusLabel;
con's avatar
con committed
396
397
398
399
400
401
    QDockWidget *m_breakDock;
    QDockWidget *m_disassemblerDock;
    QDockWidget *m_modulesDock;
    QDockWidget *m_outputDock;
    QDockWidget *m_registerDock;
    QDockWidget *m_stackDock;
402
    QDockWidget *m_sourceFilesDock;
con's avatar
con committed
403
404
405
    QDockWidget *m_threadsDock;
    QDockWidget *m_watchDock;
    QList<QDockWidget*> m_dockWidgets;
406
    QList<bool> m_dockWidgetActiveState;
407
408
    bool m_locked;
    bool m_handleDockVisibilityChanges;
con's avatar
con committed
409
410
411
412
413
414
415
416

    BreakHandler *m_breakHandler;
    DisassemblerHandler *m_disassemblerHandler;
    ModulesHandler *m_modulesHandler;
    RegisterHandler *m_registerHandler;
    StackHandler *m_stackHandler;
    ThreadsHandler *m_threadsHandler;
    WatchHandler *m_watchHandler;
417
    SourceFilesWindow *m_sourceFilesWindow;
con's avatar
con committed
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450

    /// 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_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;
451
452
    QTimer *m_statusTimer;
    QString m_lastPermanentStatusMessage;
con's avatar
con committed
453
454
455
456
457
458
459
460
461

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

} // namespace Internal
} // namespace Debugger

#endif // DEBUGGER_DEBUGGERMANAGER_H