debuggerplugin.cpp 121 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2
3
4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2010 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
#include "debuggerplugin.h"

32
#include "debuggeractions.h"
33
#include "debuggeragents.h"
con's avatar
con committed
34
#include "debuggerconstants.h"
35
#include "debuggercore.h"
36
37
38
#include "debuggerdialogs.h"
#include "debuggerengine.h"
#include "debuggermainwindow.h"
con's avatar
con committed
39
#include "debuggerrunner.h"
40
#include "debuggerstringutils.h"
41
#include "debuggertooltip.h"
42
#include "debuggeruiswitcher.h"
43

44
45
#include "breakpoint.h"
#include "breakhandler.h"
46
#include "breakwindow.h"
47
#include "consolewindow.h"
48
#include "logwindow.h"
49
50
51
#include "moduleswindow.h"
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
52
#include "stackhandler.h"
53
54
55
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
56
#include "watchhandler.h"
57
#include "watchwindow.h"
hjk's avatar
hjk committed
58
#include "watchutils.h"
59

60
61
#include "snapshothandler.h"
#include "threadshandler.h"
hjk's avatar
hjk committed
62
#include "gdb/gdboptionspage.h"
con's avatar
con committed
63

64
#include "ui_commonoptionspage.h"
hjk's avatar
hjk committed
65
#include "ui_dumperoptionpage.h"
66

67
#include <coreplugin/actionmanager/actionmanager.h>
68
69
#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/command.h>
70
#include <coreplugin/uniqueidmanager.h>
hjk's avatar
hjk committed
71
#include <coreplugin/basemode.h>
con's avatar
con committed
72
#include <coreplugin/coreconstants.h>
73
#include <coreplugin/dialogs/ioptionspage.h>
con's avatar
con committed
74
#include <coreplugin/editormanager/editormanager.h>
hjk's avatar
hjk committed
75
#include <coreplugin/findplaceholder.h>
76
#include <coreplugin/icontext.h>
con's avatar
con committed
77
#include <coreplugin/icore.h>
78
#include <coreplugin/imode.h>
79
#include <coreplugin/icorelistener.h>
80
#include <coreplugin/manhattanstyle.h>
hjk's avatar
hjk committed
81
#include <coreplugin/minisplitter.h>
con's avatar
con committed
82
#include <coreplugin/modemanager.h>
hjk's avatar
hjk committed
83

con's avatar
con committed
84
#include <cppeditor/cppeditorconstants.h>
85
#include <cpptools/cppmodelmanagerinterface.h>
hjk's avatar
hjk committed
86

87
88
#include <extensionsystem/pluginmanager.h>

89
#include <projectexplorer/project.h>
90
#include <projectexplorer/projectexplorer.h>
con's avatar
con committed
91
92
#include <projectexplorer/projectexplorerconstants.h>
#include <projectexplorer/session.h>
93
#include <projectexplorer/target.h>
94
#include <projectexplorer/toolchaintype.h>
hjk's avatar
hjk committed
95

96
97
#include <qt4projectmanager/qt4projectmanagerconstants.h>

hjk's avatar
hjk committed
98
#include <texteditor/basetexteditor.h>
con's avatar
con committed
99
#include <texteditor/basetextmark.h>
100
#include <texteditor/fontsettings.h>
101
#include <texteditor/texteditorsettings.h>
hjk's avatar
hjk committed
102
103

#include <utils/qtcassert.h>
104
#include <utils/savedaction.h>
105
#include <utils/styledbar.h>
con's avatar
con committed
106

107
108
#include <qml/scriptconsole.h>

109
#include <QtCore/QTimer>
110
111
#include <QtCore/QtPlugin>
#include <QtGui/QComboBox>
112
#include <QtGui/QDockWidget>
113
#include <QtGui/QFileDialog>
hjk's avatar
hjk committed
114
#include <QtGui/QMenu>
115
#include <QtGui/QMessageBox>
116
117
118
#include <QtGui/QPushButton>
#include <QtGui/QTextBlock>
#include <QtGui/QTextCursor>
119
#include <QtGui/QToolButton>
con's avatar
con committed
120

121
122
#include <climits>

123
124
125
126
127
128
129
130
131
132
133
#define DEBUG_STATE 1
#ifdef DEBUG_STATE
//#   define STATE_DEBUG(s)
//    do { QString msg; QTextStream ts(&msg); ts << s;
//      showMessage(msg, LogDebug); } while (0)
#   define STATE_DEBUG(s) do { qDebug() << s; } while(0)
#else
#   define STATE_DEBUG(s)
#endif

// Note: the Debugger process itself and any helper processes like
134
// gdbserver, the trk client etc are referred to as 'Engine',
135
136
// whereas the debugged process is referred to as 'Inferior'.
//
137
138
// Transitions marked by '---' are done in the individual engines.
// Transitions marked by '+-+' are done in the base DebuggerEngine.
hjk's avatar
hjk committed
139
// Transitions marked by '*' are done asynchronously.
hjk's avatar
hjk committed
140
// The GdbEngine->setupEngine() function is described in more detail below.
141
//
hjk's avatar
hjk committed
142
143
144
145
146
147
148
// The engines are responsible for local roll-back to the last
// acknowledged state before calling notify*Failed. I.e. before calling
// notifyEngineSetupFailed() any process started during setupEngine()
// so far must be terminated.
//
//
//
hjk's avatar
hjk committed
149
150
151
152
153
154
//                        DebuggerNotReady
//                               +
//                      EngineSetupRequested
//                               +
//                  (calls *Engine->setupEngine())
//                            |      |
155
//                            |      |
hjk's avatar
hjk committed
156
157
158
//                       {notify-  {notify-
//                        Engine-   Engine-
//                        SetupOk}  SetupFailed}
159
160
161
162
163
164
//                            +      +
//                            +      `+-+-+> EngineSetupFailed
//                            +                   +
//                            +    [calls RunControl->startFailed]
//                            +                   +
//                            +             DebuggerFinished
hjk's avatar
hjk committed
165
166
167
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
//                            v
//                      EngineSetupOk
//                            +
//             [calls RunControl->StartSuccessful]
//                            +
//                  InferiorSetupRequested
//                            +
//             (calls *Engine->setupInferior())
//                         |       |
//                         |       |
//                    {notify-   {notify-
//                     Inferior- Inferior-
//                     SetupOk}  SetupFailed}
//                         +       +
//                         +       ` +-+-> InferiorSetupFailed +-+-+-+-+-+->.
//                         +                                                +
//                         +                                                +
//                  EngineRunRequested                                      +
//                         +                                                +
//                 (calls *Engine->runEngine())                             +
//               /       |            |        \                            +
//             /         |            |          \                          +
//            | (core)   | (attach)   |           |                         +
//            |          |            |           |                         +
//      {notify-    {notifyER&- {notifyER&-  {notify-                       +
//      Inferior-     Inferior-   Inferior-  RunEngine-                     +
//     Unrunnable}     StopOk}     RunOk}     Failed}                       +
//           +           +            +           +                         +
//   InferiorUnrunnable  +     InferiorRunOk      +                         +
//                       +                        +                         +
//                InferiorStopOk            EngineRunFailed                 +
//                                                +                         v
//                                                 `-+-+-+-+-+-+-+-+-+-+-+>-+
//                                                                          +
hjk's avatar
hjk committed
199
//                                                                          +
Tobias Hunger's avatar
Tobias Hunger committed
200
//                       #Interrupt@InferiorRunOk#                           +
hjk's avatar
hjk committed
201
//                                  +                                       +
hjk's avatar
hjk committed
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
//                          InferiorStopRequested                           +
//  #SpontaneousStop                +                                       +
//   @InferiorRunOk#         (calls *Engine->                               +
//          +               interruptInferior())                            +
//      {notify-               |          |                                 +
//     Spontaneous-       {notify-    {notify-                              +
//      Inferior-          Inferior-   Inferior-                            +
//       StopOk}           StopOk}    StopFailed}                           +
//           +              +             +                                 +
//            +            +              +                                 +
//            InferiorStopOk              +                                 +
//                  +                     +                                 +
//                  +                    +                                  +
//                  +                   +                                   +
//        #Stop@InferiorUnrunnable#    +                                    +
//          #Creator Close Event#     +                                     +
//                       +           +                                      +
hjk's avatar
hjk committed
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
//                InferiorShutdownRequested                                 +
//                            +                                             +
//           (calls *Engine->shutdownInferior())                            +
//                         |        |                                       +
//                    {notify-   {notify-                                   +
//                     Inferior- Inferior-                                  +
//                  ShutdownOk}  ShutdownFailed}                            +
//                         +        +                                       +
//                         +        +                                       +
//  #Inferior exited#      +        +                                       +
//         |               +        +                                       +
//   {notifyInferior-      +        +                                       +
//      Exited}            +        +                                       +
//           +             +        +                                       +
//            +            +        +                                       +
//             +           +        +                                       +
//            InferiorShutdownOk InferiorShutdownFailed                     +
//                      *          *                                        +
//                  EngineShutdownRequested                                 +
//                            +                                             +
239
//           (calls *Engine->shutdownEngine())  <+-+-+-+-+-+-+-+-+-+-+-+-+-+'
hjk's avatar
hjk committed
240
241
242
//                         |        |
//                         |        |
//                    {notify-   {notify-
hjk's avatar
hjk committed
243
//                     Engine-    Engine-
hjk's avatar
hjk committed
244
245
246
//                  ShutdownOk}  ShutdownFailed}
//                         +       +
//            EngineShutdownOk  EngineShutdownFailed
hjk's avatar
hjk committed
247
248
//                         *       *
//                     DebuggerFinished
hjk's avatar
hjk committed
249
250
251
//


252
253
254
/* Here is a matching graph as a GraphViz graph. View it using
 * \code
grep "^sg1:" debuggerplugin.cpp | cut -c5- | dot -osg1.ps -Tps && gv sg1.ps
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
287
288
sg1: digraph DebuggerStates {
sg1:   DebuggerNotReady -> EngineSetupRequested
sg1:   EngineSetupRequested -> EngineSetupOk [ label="notifyEngineSetupOk", style="dashed" ];
sg1:   EngineSetupRequested -> EngineSetupFailed [ label= "notifyEngineSetupFailed", style="dashed"];
sg1:   EngineSetupFailed -> DebuggerFinished [ label= "RunControl::StartFailed" ];
sg1:   EngineSetupOk -> InferiorSetupRequested [ label= "RunControl::StartSuccessful" ];
sg1:   InferiorSetupRequested -> InferiorSetupFailed [ label="notifyInferiorFailed", style="dashed" ];
sg1:   InferiorSetupRequested -> EngineRunRequested [ label="notifyInferiorSetupOk", style="dashed" ];
sg1:   InferiorSetupFailed -> EngineShutdownRequested
sg1:   EngineRunRequested -> InferiorUnrunnable [ label="notifyInferiorUnrunnable", style="dashed" ];
sg1:   EngineRunRequested -> InferiorStopOk [ label="notifyEngineRunAndInferiorStopOk", style="dashed" ];
sg1:   EngineRunRequested -> InferiorRunOk [ label="notifyEngineRunAndInferiorRunOk", style="dashed" ];
sg1:   EngineRunRequested -> EngineRunFailed [ label="notifyEngineRunFailed", style="dashed" ];
sg1:   EngineRunFailed -> EngineShutdownRequested
sg1:   InferiorRunOk -> InferiorStopOk [ label="SpontaneousStop\nnotifyInferiorSpontaneousStop", style="dashed" ];
sg1:   InferiorRunOk -> InferiorStopRequested [ label="User stop\nEngine::interruptInferior", style="dashed"];
sg1:   InferiorStopRequested -> InferiorStopOk [ label="notifyInferiorStopOk", style="dashed" ];
sg1:   InferiorStopRequested -> InferiorShutdownRequested  [ label="notifyInferiorStopFailed", style="dashed" ];
sg1:   InferiorStopOk -> InferiorRunRequested [ label="User\nEngine::continueInferior" ];
sg1:   InferiorRunRequested -> InferiorRunOk [ label="notifyInferiorRunOk", style="dashed"];
sg1:   InferiorRunRequested -> InferiorRunFailed [ label="notifyInferiorRunFailed", style="dashed"];
sg1:   InferiorRunFailed -> InferiorStopOk
sg1:   InferiorShutdownRequested -> InferiorShutdownOk [ label= "Engine::shutdownInferior\nnotifyInferiorShutdownOk", style="dashed" ];
sg1:   InferiorShutdownRequested -> InferiorShutdownFailed [ label="Engine::shutdownInferior\nnotifyInferiorShutdownFailed", style="dashed" ];
sg1:   InferiorExited -> InferiorShutdownOk [ label="notifyInferiorExited", style="dashed"];
sg1:   InferiorShutdownOk -> EngineShutdownRequested
sg1:   InferiorShutdownFailed -> EngineShutdownRequested
sg1:   EngineShutdownRequested -> EngineShutdownOk [ label="Engine::shutdownEngine\nnotifyEngineShutdownOk", style="dashed" ];
sg1:   EngineShutdownRequested -> EngineShutdownFailed  [ label="Engine::shutdownEngine\nnotifyEngineShutdownFailed", style="dashed" ];
sg1:   EngineShutdownOk -> DebuggerFinished  [ style = "dotted" ];
sg1:   EngineShutdownFailed  -> DebuggerFinished [ style = "dotted" ];
sg1: }
* \endcode */
hjk's avatar
hjk committed
289
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
290
291
292


// GdbEngine specific startup. All happens in EngineSetupRequested state
293
//
294
295
// Transitions marked by '---' are done in the individual adapters.
// Transitions marked by '+-+' are done in the GdbEngine.
hjk's avatar
hjk committed
296
//
hjk's avatar
hjk committed
297
//                  GdbEngine::setupEngine()
298
299
300
301
302
//                          +
//            (calls *Adapter->startAdapter())
//                          |      |
//                          |      `---> handleAdapterStartFailed()
//                          |                   +
hjk's avatar
hjk committed
303
//                          |             {notifyEngineSetupFailed}
304
305
306
//                          |
//                 handleAdapterStarted()
//                          +
hjk's avatar
hjk committed
307
308
309
310
311
//                 {notifyEngineSetupOk}
//
//
//
//                GdbEngine::setupInferior()
312
//                          +
313
314
//            (calls *Adapter->prepareInferior())
//                          |      |
hjk's avatar
hjk committed
315
//                          |      `---> handlePrepareInferiorFailed()
316
//                          |                   +
hjk's avatar
hjk committed
317
//                          |             {notifyInferiorSetupFailed}
318
//                          |
hjk's avatar
hjk committed
319
//                handleInferiorPrepared()
320
//                          +
321
//                {notifyInferiorSetupOk}
322
323
324
325




326

con's avatar
con committed
327
using namespace Core;
hjk's avatar
hjk committed
328
using namespace Debugger::Constants;
con's avatar
con committed
329
using namespace ProjectExplorer;
hjk's avatar
hjk committed
330
using namespace TextEditor;
con's avatar
con committed
331

hjk's avatar
hjk committed
332
333
334
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
335
336
337
338

namespace Debugger {
namespace Constants {

339
340
const char * const M_DEBUG_START_DEBUGGING = "QtCreator.Menu.Debug.StartDebugging";

con's avatar
con committed
341
342
const char * const STARTEXTERNAL        = "Debugger.StartExternal";
const char * const ATTACHEXTERNAL       = "Debugger.AttachExternal";
343
const char * const ATTACHCORE           = "Debugger.AttachCore";
hjk's avatar
hjk committed
344
const char * const ATTACHTCF            = "Debugger.AttachTcf";
345
const char * const ATTACHREMOTE         = "Debugger.AttachRemote";
346
const char * const ATTACHREMOTECDB      = "Debugger.AttachRemoteCDB";
347
const char * const DETACH               = "Debugger.Detach";
con's avatar
con committed
348

349
350
const char * const RUN_TO_LINE1         = "Debugger.RunToLine1";
const char * const RUN_TO_LINE2         = "Debugger.RunToLine2";
con's avatar
con committed
351
const char * const RUN_TO_FUNCTION      = "Debugger.RunToFunction";
352
353
const char * const JUMP_TO_LINE1        = "Debugger.JumpToLine1";
const char * const JUMP_TO_LINE2        = "Debugger.JumpToLine2";
354
const char * const RETURN_FROM_FUNCTION = "Debugger.ReturnFromFunction";
355
const char * const SNAPSHOT             = "Debugger.Snapshot";
con's avatar
con committed
356
357
358
const char * const TOGGLE_BREAK         = "Debugger.ToggleBreak";
const char * const BREAK_BY_FUNCTION    = "Debugger.BreakByFunction";
const char * const BREAK_AT_MAIN        = "Debugger.BreakAtMain";
359
360
const char * const ADD_TO_WATCH1        = "Debugger.AddToWatch1";
const char * const ADD_TO_WATCH2        = "Debugger.AddToWatch2";
361
const char * const OPERATE_BY_INSTRUCTION  = "Debugger.OperateByInstruction";
362
363
const char * const FRAME_UP             = "Debugger.FrameUp";
const char * const FRAME_DOWN           = "Debugger.FrameDown";
con's avatar
con committed
364

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
365
#ifdef Q_WS_MAC
con's avatar
con committed
366
const char * const STOP_KEY                 = "Shift+Ctrl+Y";
con's avatar
con committed
367
const char * const RESET_KEY                = "Ctrl+Shift+F5";
con's avatar
con committed
368
369
370
const char * const STEP_KEY                 = "Ctrl+Shift+I";
const char * const STEPOUT_KEY              = "Ctrl+Shift+T";
const char * const NEXT_KEY                 = "Ctrl+Shift+O";
371
const char * const REVERSE_KEY              = "";
con's avatar
con committed
372
373
const char * const RUN_TO_LINE_KEY          = "Shift+F8";
const char * const RUN_TO_FUNCTION_KEY      = "Ctrl+F6";
374
const char * const JUMP_TO_LINE_KEY         = "Ctrl+D,Ctrl+L";
con's avatar
con committed
375
const char * const TOGGLE_BREAK_KEY         = "F8";
376
377
378
379
const char * const BREAK_BY_FUNCTION_KEY    = "Ctrl+D,Ctrl+F";
const char * const BREAK_AT_MAIN_KEY        = "Ctrl+D,Ctrl+M";
const char * const ADD_TO_WATCH_KEY         = "Ctrl+D,Ctrl+W";
const char * const SNAPSHOT_KEY             = "Ctrl+D,Ctrl+S";
con's avatar
con committed
380
#else
381
const char * const STOP_KEY                 = "Shift+F5";
con's avatar
con committed
382
383
384
385
const char * const RESET_KEY                = "Ctrl+Shift+F5";
const char * const STEP_KEY                 = "F11";
const char * const STEPOUT_KEY              = "Shift+F11";
const char * const NEXT_KEY                 = "F10";
386
const char * const REVERSE_KEY              = "F12";
con's avatar
con committed
387
388
389
390
391
392
393
const char * const RUN_TO_LINE_KEY          = "";
const char * const RUN_TO_FUNCTION_KEY      = "";
const char * const JUMP_TO_LINE_KEY         = "";
const char * const TOGGLE_BREAK_KEY         = "F9";
const char * const BREAK_BY_FUNCTION_KEY    = "";
const char * const BREAK_AT_MAIN_KEY        = "";
const char * const ADD_TO_WATCH_KEY         = "Ctrl+Alt+Q";
394
const char * const SNAPSHOT_KEY             = "Ctrl+D,Ctrl+S";
con's avatar
con committed
395
396
397
398
399
400
#endif

} // namespace Constants
} // namespace Debugger


401

hjk's avatar
hjk committed
402
static SessionManager *sessionManager()
403
{
hjk's avatar
hjk committed
404
    return ProjectExplorerPlugin::instance()->session();
405
406
}

407
408
409
410
411
412
413
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
// Retrieve file name and line and optionally address
// from the data set on the text editor context menu action.
static bool positionFromContextActionData(const QObject *sender,
                                          QString *fileName,
                                          int *lineNumber,
                                          quint64 *address = 0)
{
    if (const QAction *action = qobject_cast<const QAction *>(sender)) {
        const QVariantList data = action->data().toList();
        if (data.size() >= (address ? 3 : 2)) {
            *fileName = data.front().toString();
            *lineNumber = data.at(1).toInt();
            if (address)
                *address = data.at(2).toULongLong();
            return true;
        }
    }
    return false;
}

434
namespace Debugger {
435
436
437
namespace Cdb {
void addCdb2OptionPages(QList<Core::IOptionsPage*> *);
} // namespace Cdb
438
439
440
441
442
443
444
445
namespace Internal {

// FIXME: Outdated?
// The createCdbEngine function takes a list of options pages it can add to.
// This allows for having a "enabled" toggle on the page independently
// of the engine. That's good for not enabling the related ActiveX control
// unnecessarily.

hjk's avatar
hjk committed
446
447
448
void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
449
#ifdef CDB_ENABLED
hjk's avatar
hjk committed
450
void addCdbOptionPages(QList<IOptionsPage*> *opts);
451
452
453
454
455
#endif

struct AttachRemoteParameters
{
    AttachRemoteParameters() : attachPid(0), winCrashEvent(0) {}
456
    void clear();
457
458

    quint64 attachPid;
459
    QString attachTarget;  // core file name or  server:port
460
    // Event handle for attaching to crashed Windows processes.
461
462
463
    quint64 winCrashEvent;
};

464
465
466
467
468
void AttachRemoteParameters::clear()
{
    attachPid = winCrashEvent = 0;
    attachTarget.clear();
}
469

470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500

///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
    DummyEngine() : DebuggerEngine(DebuggerStartParameters()) {}
    virtual ~DummyEngine() {}

    virtual void setupEngine() {}
    virtual void setupInferior() {}
    virtual void runEngine() {}
    virtual void shutdownEngine() {}
    virtual void shutdownInferior() {}
    virtual void executeDebuggerCommand(const QString &) {}
    virtual unsigned debuggerCapabilities() const { return 0; }
};

static DebuggerEngine *dummyEngine()
{
    static DummyEngine dummy;
    return &dummy;
}


501
502
503
504
505
506
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
507
508
509
class DebugMode : public Core::BaseMode
{
public:
510
511
    DebugMode(QObject *parent = 0) : BaseMode(parent)
    {
512
        setDisplayName(QCoreApplication::translate("Debugger::Internal::DebugMode", "Debug"));
hjk's avatar
hjk committed
513
        setType(CC::MODE_EDIT_TYPE);
514
        setId(MODE_DEBUG);
515
        setIcon(QIcon(__(":/fancyactionbar/images/mode_Debug.png")));
516
517
        setPriority(P_MODE_DEBUG);
    }
hjk's avatar
hjk committed
518

519
520
521
522
523
524
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        EditorManager::instance()->setParent(0);
    }
};
hjk's avatar
hjk committed
525

526

con's avatar
con committed
527
528
529
530
531
532
///////////////////////////////////////////////////////////////////////
//
// LocationMark
//
///////////////////////////////////////////////////////////////////////

533
// Used in "real" editors
534
class LocationMark : public TextEditor::BaseTextMark
con's avatar
con committed
535
536
537
538
{
public:
    LocationMark(const QString &fileName, int linenumber)
        : BaseTextMark(fileName, linenumber)
539
    {}
con's avatar
con committed
540

541
    QIcon icon() const { return debuggerCore()->locationMarkIcon(); }
con's avatar
con committed
542
543
    void updateLineNumber(int /*lineNumber*/) {}
    void updateBlock(const QTextBlock & /*block*/) {}
544
    void removedFromEditor() {}
con's avatar
con committed
545
546
};

547
548
549

///////////////////////////////////////////////////////////////////////
//
550
// CommonOptionsPage
551
552
553
//
///////////////////////////////////////////////////////////////////////

554
class CommonOptionsPage : public Core::IOptionsPage
555
556
{
public:
557
    CommonOptionsPage() {}
558
559

    // IOptionsPage
560
    QString id() const
hjk's avatar
hjk committed
561
        { return _(DEBUGGER_COMMON_SETTINGS_ID); }
562
    QString displayName() const
hjk's avatar
hjk committed
563
        { return QCoreApplication::translate("Debugger", DEBUGGER_COMMON_SETTINGS_NAME); }
564
    QString category() const
hjk's avatar
hjk committed
565
        { return _(DEBUGGER_SETTINGS_CATEGORY);  }
566
    QString displayCategory() const
hjk's avatar
hjk committed
567
        { return QCoreApplication::translate("Debugger", DEBUGGER_SETTINGS_TR_CATEGORY); }
568
569
    QIcon categoryIcon() const
        { return QIcon(QLatin1String(DEBUGGER_COMMON_SETTINGS_CATEGORY_ICON)); }
570
571

    QWidget *createPage(QWidget *parent);
hjk's avatar
hjk committed
572
    void apply() { m_group.apply(ICore::instance()->settings()); }
573
    void finish() { m_group.finish(); }
574
    virtual bool matches(const QString &s) const;
575
576

private:
577
    Ui::CommonOptionsPage m_ui;
578
    Utils::SavedActionSet m_group;
579
    QString m_searchKeywords;
580
581
};

582
QWidget *CommonOptionsPage::createPage(QWidget *parent)
583
584
585
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);
586
    m_group.clear();
587

hjk's avatar
hjk committed
588
    m_group.insert(debuggerCore()->action(ListSourceFiles),
589
        m_ui.checkBoxListSourceFiles);
hjk's avatar
hjk committed
590
    m_group.insert(debuggerCore()->action(UseAlternatingRowColors),
591
        m_ui.checkBoxUseAlternatingRowColors);
hjk's avatar
hjk committed
592
    m_group.insert(debuggerCore()->action(UseToolTipsInMainEditor),
593
        m_ui.checkBoxUseToolTipsInMainEditor);
hjk's avatar
hjk committed
594
    m_group.insert(debuggerCore()->action(CloseBuffersOnExit),
595
        m_ui.checkBoxCloseBuffersOnExit);
hjk's avatar
hjk committed
596
    m_group.insert(debuggerCore()->action(SwitchModeOnExit),
597
        m_ui.checkBoxSwitchModeOnExit);
hjk's avatar
hjk committed
598
599
600
601
602
603
    m_group.insert(debuggerCore()->action(AutoDerefPointers), 0);
    m_group.insert(debuggerCore()->action(UseToolTipsInLocalsView), 0);
    m_group.insert(debuggerCore()->action(UseToolTipsInBreakpointsView), 0);
    m_group.insert(debuggerCore()->action(UseAddressInBreakpointsView), 0);
    m_group.insert(debuggerCore()->action(UseAddressInStackView), 0);
    m_group.insert(debuggerCore()->action(MaximalStackDepth),
604
        m_ui.spinBoxMaximalStackDepth);
hjk's avatar
hjk committed
605
606
607
608
609
610
611
    m_group.insert(debuggerCore()->action(ShowStdNamespace), 0);
    m_group.insert(debuggerCore()->action(ShowQtNamespace), 0);
    m_group.insert(debuggerCore()->action(SortStructMembers), 0);
    m_group.insert(debuggerCore()->action(LogTimeStamps), 0);
    m_group.insert(debuggerCore()->action(VerboseLog), 0);
    m_group.insert(debuggerCore()->action(BreakOnThrow), 0);
    m_group.insert(debuggerCore()->action(BreakOnCatch), 0);
612
#ifdef Q_OS_WIN
hjk's avatar
hjk committed
613
    Utils::SavedAction *registerAction = debuggerCore()->action(RegisterForPostMortem);
614
615
616
617
618
    m_group.insert(registerAction,
        m_ui.checkBoxRegisterForPostMortem);
    connect(registerAction, SIGNAL(toggled(bool)),
            m_ui.checkBoxRegisterForPostMortem, SLOT(setChecked(bool)));
#endif
619

620
    if (m_searchKeywords.isEmpty()) {
621
622
        QTextStream(&m_searchKeywords) << ' '
                << m_ui.checkBoxListSourceFiles->text()
623
624
                << ' ' << m_ui.checkBoxUseAlternatingRowColors->text()
                << ' ' << m_ui.checkBoxUseToolTipsInMainEditor->text()
625
626
627
#ifdef Q_OS_WIN
                << ' ' << m_ui.checkBoxRegisterForPostMortem->text()
#endif
628
629
630
                << ' ' << m_ui.labelMaximalStackDepth->text();
        m_searchKeywords.remove(QLatin1Char('&'));
    }
631
632
633
#ifndef Q_OS_WIN
    m_ui.checkBoxRegisterForPostMortem->setVisible(false);
#endif
634
635
636
    return w;
}

637
638
639
640
641
bool CommonOptionsPage::matches(const QString &s) const
{
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
}

hjk's avatar
hjk committed
642
643
///////////////////////////////////////////////////////////////////////
//
644
// DebuggingHelperOptionPage
hjk's avatar
hjk committed
645
646
647
//
///////////////////////////////////////////////////////////////////////

648
649
650
static inline bool oxygenStyle()
{
    if (const ManhattanStyle *ms = qobject_cast<const ManhattanStyle *>(qApp->style()))
651
        return !qstrcmp("OxygenStyle", ms->baseStyle()->metaObject()->className());
652
653
654
    return false;
}

655
class DebuggingHelperOptionPage : public Core::IOptionsPage
hjk's avatar
hjk committed
656
657
{
    Q_OBJECT // Needs tr-context.
hjk's avatar
hjk committed
658
public:
659
    DebuggingHelperOptionPage() {}
hjk's avatar
hjk committed
660
661

    // IOptionsPage
hjk's avatar
hjk committed
662
    QString id() const { return _("Z.DebuggingHelper"); }
663
    QString displayName() const { return tr("Debugging Helper"); }
hjk's avatar
hjk committed
664
    QString category() const { return _(DEBUGGER_SETTINGS_CATEGORY); }
665
666
667
668
    QString displayCategory() const
    { return QCoreApplication::translate("Debugger", DEBUGGER_SETTINGS_TR_CATEGORY); }
    QIcon categoryIcon() const
    { return QIcon(QLatin1String(DEBUGGER_COMMON_SETTINGS_CATEGORY_ICON)); }
hjk's avatar
hjk committed
669
670

    QWidget *createPage(QWidget *parent);
hjk's avatar
hjk committed
671
    void apply() { m_group.apply(ICore::instance()->settings()); }
672
    void finish() { m_group.finish(); }
673
    virtual bool matches(const QString &s) const;
hjk's avatar
hjk committed
674
675

private:
676
    Ui::DebuggingHelperOptionPage m_ui;
677
    Utils::SavedActionSet m_group;
678
    QString m_searchKeywords;
hjk's avatar
hjk committed
679
680
};

681
QWidget *DebuggingHelperOptionPage::createPage(QWidget *parent)
hjk's avatar
hjk committed
682
683
684
685
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);

686
    m_ui.dumperLocationChooser->setExpectedKind(Utils::PathChooser::Command);
687
    m_ui.dumperLocationChooser->setPromptDialogTitle(tr("Choose DebuggingHelper Location"));
hjk's avatar
hjk committed
688
    m_ui.dumperLocationChooser->setInitialBrowsePathBackup(
hjk's avatar
hjk committed
689
        ICore::instance()->resourcePath() + "../../lib");
hjk's avatar
hjk committed
690

691
    m_group.clear();
hjk's avatar
hjk committed
692
    m_group.insert(debuggerCore()->action(UseDebuggingHelpers),
693
        m_ui.debuggingHelperGroupBox);
hjk's avatar
hjk committed
694
    m_group.insert(debuggerCore()->action(UseCustomDebuggingHelperLocation),
695
        m_ui.customLocationGroupBox);
hjk's avatar
hjk committed
696
    // Suppress Oxygen style's giving flat group boxes bold titles.
697
    if (oxygenStyle())
hjk's avatar
hjk committed
698
        m_ui.customLocationGroupBox->setStyleSheet(_("QGroupBox::title { font: ; }"));
699

hjk's avatar
hjk committed
700
    m_group.insert(debuggerCore()->action(CustomDebuggingHelperLocation),
701
        m_ui.dumperLocationChooser);
hjk's avatar
hjk committed
702

hjk's avatar
hjk committed
703
    m_group.insert(debuggerCore()->action(UseCodeModel),
704
705
        m_ui.checkBoxUseCodeModel);

706
#ifdef QT_DEBUG
hjk's avatar
hjk committed
707
    m_group.insert(debuggerCore()->action(DebugDebuggingHelpers),
708
        m_ui.checkBoxDebugDebuggingHelpers);
709
710
711
#else
    m_ui.checkBoxDebugDebuggingHelpers->hide();
#endif
hjk's avatar
hjk committed
712
713
714
715

#ifndef QT_DEBUG
#if 0
    cmd = am->registerAction(m_manager->m_dumpLogAction,
hjk's avatar
hjk committed
716
        DUMP_LOG, globalcontext);
hjk's avatar
hjk committed
717
718
719
720
721
722
    //cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+D,Ctrl+L")));
    cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+Shift+F11")));
    mdebug->addAction(cmd);
#endif
#endif

723
724
725
726
727
728
    if (m_searchKeywords.isEmpty()) {
        QTextStream(&m_searchKeywords)
                << ' ' << m_ui.debuggingHelperGroupBox->title()
                << ' ' << m_ui.customLocationGroupBox->title()
                << ' ' << m_ui.dumperLocationLabel->text()
                << ' ' << m_ui.checkBoxUseCodeModel->text()
729
                << ' ' << m_ui.checkBoxDebugDebuggingHelpers->text();
730
731
        m_searchKeywords.remove(QLatin1Char('&'));
    }
hjk's avatar
hjk committed
732
733
734
    return w;
}

735
bool DebuggingHelperOptionPage::matches(const QString &s) const
hjk's avatar
hjk committed
736
{
737
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
hjk's avatar
hjk committed
738
739
}

740

con's avatar
con committed
741
742
///////////////////////////////////////////////////////////////////////
//
743
// Argument parsing
con's avatar
con committed
744
745
746
//
///////////////////////////////////////////////////////////////////////

747
static QString msgParameterMissing(const QString &a)
748
749
750
751
{
    return DebuggerPlugin::tr("Option '%1' is missing the parameter.").arg(a);
}

752
static QString msgInvalidNumericParameter(const QString &a, const QString &number)
753
754
755
756
{
    return DebuggerPlugin::tr("The parameter '%1' of option '%2' is not a number.").arg(number, a);
}

757
static bool parseArgument(QStringList::const_iterator &it,
758
759
760
    const QStringList::const_iterator &cend,
    AttachRemoteParameters *attachRemoteParameters,
    unsigned *enabledEngines, QString *errorMessage)
761
762
763
{
    const QString &option = *it;
    // '-debug <pid>'
764
765
    // '-debug <corefile>'
    // '-debug <server:port>'
hjk's avatar
hjk committed
766
    if (*it == _("-debug")) {
767
768
769
770
771
772
        ++it;
        if (it == cend) {
            *errorMessage = msgParameterMissing(*it);
            return false;
        }
        bool ok;
773
        attachRemoteParameters->attachPid = it->toULongLong(&ok);
774
775
        if (!ok)
            attachRemoteParameters->attachTarget = *it;
776
777
        return true;
    }
778
779
    // -wincrashevent <event-handle>. A handle used for
    // a handshake when attaching to a crashed Windows process.
hjk's avatar
hjk committed
780
    if (*it == _("-wincrashevent")) {
781
782
783
784
785
786
        ++it;
        if (it == cend) {
            *errorMessage = msgParameterMissing(*it);
            return false;
        }
        bool ok;
787
        attachRemoteParameters->winCrashEvent = it->toULongLong(&ok);
788
789
790
791
792
793
        if (!ok) {
            *errorMessage = msgInvalidNumericParameter(option, *it);
            return false;
        }
        return true;
    }
hjk's avatar
hjk committed
794
    // Engine disabling.
hjk's avatar
hjk committed
795
    if (option == _("-disable-cdb")) {
796
        *enabledEngines &= ~Debugger::CdbEngineType;
797
798
        return true;
    }
hjk's avatar
hjk committed
799
    if (option == _("-disable-gdb")) {
800
        *enabledEngines &= ~Debugger::GdbEngineType;
801
802
        return true;
    }
803
804
805
806
    if (option == _("-disable-qmldb")) {
        *enabledEngines &= ~Debugger::QmlEngineType;
        return true;
    }
hjk's avatar
hjk committed
807
    if (option == _("-disable-sdb")) {
808
        *enabledEngines &= ~Debugger::ScriptEngineType;
809
810
        return true;
    }
811
    if (option == _("-disable-tcf")) {
hjk's avatar
hjk committed
812
813
814
        *enabledEngines &= ~TcfEngineType;
        return true;
    }
815

816
    *errorMessage = DebuggerPlugin::tr("Invalid debugger option: %1").arg(option);
817
818
819
    return false;
}

820
static bool parseArguments(const QStringList &args,
821
   AttachRemoteParameters *attachRemoteParameters,
hjk's avatar
hjk committed
822
   unsigned *enabledEngines, QString *errorMessage)
823
{
824
    attachRemoteParameters->clear();
825
826
    const QStringList::const_iterator cend = args.constEnd();
    for (QStringList::const_iterator it = args.constBegin(); it != cend; ++it)
827
        if (!parseArgument(it, cend, attachRemoteParameters, enabledEngines, errorMessage))
828
829
            return false;
    if (Debugger::Constants::Internal::debug)
830
        qDebug().nospace() << args << "engines=0x"
831
832
            << QString::number(*enabledEngines, 16)
            << " pid" << attachRemoteParameters->attachPid
833
            << " target" << attachRemoteParameters->attachTarget << '\n';
834
835
836
    return true;
}

837
838
839
840
841
842
843

///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
844
static bool isDebuggable(IEditor *editor)
845
{
846
847
    // Only blacklist Qml. Whitelisting would fail on C++ code in files
    // with strange names, more harm would be done this way.
hjk's avatar
hjk committed
848
849
    //   IFile *file = editor->file();
    //   return !(file && file->mimeType() == "application/x-qml");
850
    // Nowadays, even Qml is debuggable.
hjk's avatar
hjk committed
851
    return editor;
852
853
}

con's avatar
con committed
854

855
856
857
858
859
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
860

861
862
863
struct DebuggerActions
{
    QAction *continueAction;
864
    QAction *exitAction; // on the application output button if "Stop" is possible
865
866
    QAction *interruptAction; // on the fat debug button if "Pause" is possible
    QAction *undisturbableAction; // on the fat debug button if nothing can be done
867
868
869
    QAction *resetAction; // FIXME: Should not be needed in a stable release
    QAction *stepAction;
    QAction *stepOutAction;
870
    QAction *runToLineAction; // Debug menu
871
    QAction *runToFunctionAction;
872
    QAction *jumpToLineAction; // in the Debug menu
873
874
    QAction *returnFromFunctionAction;
    QAction *nextAction;
875
    //QAction *snapshotAction;
876
877
878
879
880
881
882
883
    QAction *watchAction1; // in the Debug menu
    QAction *watchAction2; // in the text editor context menu
    QAction *breakAction;
    QAction *sepAction;
    QAction *reverseDirectionAction;
    QAction *frameUpAction;
    QAction *frameDownAction;
};
con's avatar
con committed
884

885
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
886
887


888
889
890
891
892
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
893

894
class DebuggerPluginPrivate : public DebuggerCore
895
896
{
    Q_OBJECT
897

898
899
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
900
    ~DebuggerPluginPrivate();
901

902
    bool initialize(const QStringList &arguments, QString *errorMessage);
903
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
904
    void disconnectEngine() { connectEngine(0); }
905
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
906

907
public slots:
908
909
910
911
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
912

hjk's avatar
hjk committed
913
    void breakpointSetMarginActionTriggered()
914
915
916
917
918
919
920
921
    {
        QString fileName;
        int lineNumber;
        quint64 address;
        if (positionFromContextActionData(sender(), &fileName, &lineNumber, &address))
            m_breakHandler->toggleBreakpoint(fileName, lineNumber, address);
     }

hjk's avatar
hjk committed
922
    void breakpointRemoveMarginActionTriggered()
923
    {
hjk's avatar
hjk committed
924
925
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
926
        m_breakHandler->removeBreakpoint(act->data().toInt());
hjk's avatar
hjk committed
927
928
929
930
931
932
933
934
935
936
937
938
939
940
     }

    void breakpointEnableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
        breakHandler()->setEnabled(act->data().toInt(), true);
    }

    void breakpointDisableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
        breakHandler()->setEnabled(act->data().toInt(), false);
941
942
    }

943
    void updateWatchersHeader(int section, int, int newSize)
944
945
946
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
    }
947

948
    void sourceFilesDockToggled(bool on)
949
    {
950
        if (on && m_currentEngine->state() == InferiorStopOk)
951
952
953
            m_currentEngine->reloadSourceFiles();
    }

954
    void modulesDockToggled(bool on)
955
    {
956
        if (on && m_currentEngine->state() == InferiorStopOk)