debuggerplugin.cpp 125 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>
hjk's avatar
hjk committed
120
#include <QtGui/QTreeWidget>
con's avatar
con committed
121

122
123
#include <climits>

124
125
126
127
128
129
130
131
132
133
134
#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
135
// gdbserver, the trk client etc are referred to as 'Engine',
136
137
// whereas the debugged process is referred to as 'Inferior'.
//
138
139
// Transitions marked by '---' are done in the individual engines.
// Transitions marked by '+-+' are done in the base DebuggerEngine.
hjk's avatar
hjk committed
140
// Transitions marked by '*' are done asynchronously.
hjk's avatar
hjk committed
141
// The GdbEngine->setupEngine() function is described in more detail below.
142
//
hjk's avatar
hjk committed
143
144
145
146
147
148
149
// 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
150
151
152
153
154
155
//                        DebuggerNotReady
//                               +
//                      EngineSetupRequested
//                               +
//                  (calls *Engine->setupEngine())
//                            |      |
156
//                            |      |
hjk's avatar
hjk committed
157
158
159
//                       {notify-  {notify-
//                        Engine-   Engine-
//                        SetupOk}  SetupFailed}
160
161
162
163
164
165
//                            +      +
//                            +      `+-+-+> EngineSetupFailed
//                            +                   +
//                            +    [calls RunControl->startFailed]
//                            +                   +
//                            +             DebuggerFinished
hjk's avatar
hjk committed
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
//                            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-                       +
191
//      Inferior-     Inferior-   Inferior-  EngineRun-                     +
hjk's avatar
hjk committed
192
193
194
195
196
197
198
199
//     Unrunnable}     StopOk}     RunOk}     Failed}                       +
//           +           +            +           +                         +
//   InferiorUnrunnable  +     InferiorRunOk      +                         +
//                       +                        +                         +
//                InferiorStopOk            EngineRunFailed                 +
//                                                +                         v
//                                                 `-+-+-+-+-+-+-+-+-+-+-+>-+
//                                                                          +
hjk's avatar
hjk committed
200
//                                                                          +
201
//                       #Interrupt@InferiorRunOk#                          +
hjk's avatar
hjk committed
202
//                                  +                                       +
hjk's avatar
hjk committed
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
//                          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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
//                InferiorShutdownRequested                                 +
//                            +                                             +
//           (calls *Engine->shutdownInferior())                            +
//                         |        |                                       +
//                    {notify-   {notify-                                   +
//                     Inferior- Inferior-                                  +
//                  ShutdownOk}  ShutdownFailed}                            +
//                         +        +                                       +
//                         +        +                                       +
//  #Inferior exited#      +        +                                       +
//         |               +        +                                       +
//   {notifyInferior-      +        +                                       +
//      Exited}            +        +                                       +
//           +             +        +                                       +
//            +            +        +                                       +
//             +           +        +                                       +
//            InferiorShutdownOk InferiorShutdownFailed                     +
//                      *          *                                        +
//                  EngineShutdownRequested                                 +
//                            +                                             +
240
//           (calls *Engine->shutdownEngine())  <+-+-+-+-+-+-+-+-+-+-+-+-+-+'
hjk's avatar
hjk committed
241
242
243
//                         |        |
//                         |        |
//                    {notify-   {notify-
hjk's avatar
hjk committed
244
//                     Engine-    Engine-
hjk's avatar
hjk committed
245
246
247
//                  ShutdownOk}  ShutdownFailed}
//                         +       +
//            EngineShutdownOk  EngineShutdownFailed
hjk's avatar
hjk committed
248
249
//                         *       *
//                     DebuggerFinished
hjk's avatar
hjk committed
250
251
252
//


253
254
255
/* 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
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
289
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
290
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
291
292
293


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




327

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

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

con's avatar
con committed
336
337
338
339

namespace Debugger {
namespace Constants {

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

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

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
367
#ifdef Q_WS_MAC
con's avatar
con committed
368
const char * const STOP_KEY                 = "Shift+Ctrl+Y";
con's avatar
con committed
369
const char * const RESET_KEY                = "Ctrl+Shift+F5";
con's avatar
con committed
370
371
372
const char * const STEP_KEY                 = "Ctrl+Shift+I";
const char * const STEPOUT_KEY              = "Ctrl+Shift+T";
const char * const NEXT_KEY                 = "Ctrl+Shift+O";
373
const char * const REVERSE_KEY              = "";
con's avatar
con committed
374
375
const char * const RUN_TO_LINE_KEY          = "Shift+F8";
const char * const RUN_TO_FUNCTION_KEY      = "Ctrl+F6";
376
const char * const JUMP_TO_LINE_KEY         = "Ctrl+D,Ctrl+L";
con's avatar
con committed
377
const char * const TOGGLE_BREAK_KEY         = "F8";
378
379
380
381
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
382
#else
383
const char * const STOP_KEY                 = "Shift+F5";
con's avatar
con committed
384
385
386
387
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";
388
const char * const REVERSE_KEY              = "F12";
con's avatar
con committed
389
390
391
392
393
394
395
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";
396
const char * const SNAPSHOT_KEY             = "Ctrl+D,Ctrl+S";
con's avatar
con committed
397
398
399
400
401
#endif

} // namespace Constants


402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
namespace Cdb {
void addCdb2OptionPages(QList<Core::IOptionsPage*> *);
} // namespace Cdb


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.

void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
#ifdef CDB_ENABLED
void addCdbOptionPages(QList<IOptionsPage*> *opts);
#endif
421

422
423
424
425
#ifdef WITH_LLDB
void addLldbOptionPages(QList<IOptionsPage*> *opts);
#endif

hjk's avatar
hjk committed
426
static SessionManager *sessionManager()
427
{
hjk's avatar
hjk committed
428
    return ProjectExplorerPlugin::instance()->session();
429
430
}

431
432
433
434
435
436
437
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

438
439
// Retrieve file name and line and optionally address
// from the data set on the text editor context menu action.
440
441
static bool positionFromActionData(const QObject *sender,
    QString *fileName, int *lineNumber, quint64 *address)
442
{
443
444
445
446
447
448
    const QAction *action = qobject_cast<const QAction *>(sender);
    QTC_ASSERT(action, return false);
    const QVariantList data = action->data().toList();
    QTC_ASSERT(data.size() == 3, return false);
    *fileName = data.front().toString();
    *lineNumber = data.at(1).toInt();
449
    *address = data.at(2).toULongLong();
450
    return true;
451
452
}

453
454
455
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

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
    DummyEngine() : DebuggerEngine(DebuggerStartParameters()) {}
483
484
485
486
487
488
489
490
491
492
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
    void executeDebuggerCommand(const QString &) {}
    unsigned debuggerCapabilities() const { return 0; }
    bool acceptsBreakpoint(BreakpointId) const { return false; }
493
494
495
496
497
498
499
500
501
};

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


502
503
504
505
506
507
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

527

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

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

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

548
549
550

///////////////////////////////////////////////////////////////////////
//
551
// CommonOptionsPage
552
553
554
//
///////////////////////////////////////////////////////////////////////

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

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

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

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

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

hjk's avatar
hjk committed
589
    m_group.insert(debuggerCore()->action(ListSourceFiles),
590
        m_ui.checkBoxListSourceFiles);
hjk's avatar
hjk committed
591
    m_group.insert(debuggerCore()->action(UseAlternatingRowColors),
592
        m_ui.checkBoxUseAlternatingRowColors);
hjk's avatar
hjk committed
593
    m_group.insert(debuggerCore()->action(UseToolTipsInMainEditor),
594
        m_ui.checkBoxUseToolTipsInMainEditor);
hjk's avatar
hjk committed
595
    m_group.insert(debuggerCore()->action(CloseBuffersOnExit),
596
        m_ui.checkBoxCloseBuffersOnExit);
hjk's avatar
hjk committed
597
    m_group.insert(debuggerCore()->action(SwitchModeOnExit),
598
        m_ui.checkBoxSwitchModeOnExit);
hjk's avatar
hjk committed
599
600
601
602
603
604
    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),
605
        m_ui.spinBoxMaximalStackDepth);
hjk's avatar
hjk committed
606
607
608
609
610
611
612
    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);
613
#ifdef Q_OS_WIN
hjk's avatar
hjk committed
614
    Utils::SavedAction *registerAction = debuggerCore()->action(RegisterForPostMortem);
615
616
617
618
619
    m_group.insert(registerAction,
        m_ui.checkBoxRegisterForPostMortem);
    connect(registerAction, SIGNAL(toggled(bool)),
            m_ui.checkBoxRegisterForPostMortem, SLOT(setChecked(bool)));
#endif
620

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

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

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

hjk's avatar
hjk committed
649
static bool oxygenStyle()
650
{
hjk's avatar
hjk committed
651
652
    const ManhattanStyle *ms = qobject_cast<const ManhattanStyle *>(qApp->style());
    return ms && !qstrcmp("OxygenStyle", ms->baseStyle()->metaObject()->className());
653
654
}

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);

hjk's avatar
hjk committed
706
707
708
#ifndef QT_DEBUG
#if 0
    cmd = am->registerAction(m_manager->m_dumpLogAction,
hjk's avatar
hjk committed
709
        DUMP_LOG, globalcontext);
hjk's avatar
hjk committed
710
711
712
713
714
715
    //cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+D,Ctrl+L")));
    cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+Shift+F11")));
    mdebug->addAction(cmd);
#endif
#endif

716
717
718
719
720
    if (m_searchKeywords.isEmpty()) {
        QTextStream(&m_searchKeywords)
                << ' ' << m_ui.debuggingHelperGroupBox->title()
                << ' ' << m_ui.customLocationGroupBox->title()
                << ' ' << m_ui.dumperLocationLabel->text()
721
                << ' ' << m_ui.checkBoxUseCodeModel->text();
722
723
        m_searchKeywords.remove(QLatin1Char('&'));
    }
hjk's avatar
hjk committed
724
725
726
    return w;
}

727
bool DebuggingHelperOptionPage::matches(const QString &s) const
hjk's avatar
hjk committed
728
{
729
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
hjk's avatar
hjk committed
730
731
}

732

con's avatar
con committed
733
734
///////////////////////////////////////////////////////////////////////
//
735
// Argument parsing
con's avatar
con committed
736
737
738
//
///////////////////////////////////////////////////////////////////////

739
static QString msgParameterMissing(const QString &a)
740
741
742
743
{
    return DebuggerPlugin::tr("Option '%1' is missing the parameter.").arg(a);
}

744
static QString msgInvalidNumericParameter(const QString &a, const QString &number)
745
746
747
748
{
    return DebuggerPlugin::tr("The parameter '%1' of option '%2' is not a number.").arg(number, a);
}

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

812
    *errorMessage = DebuggerPlugin::tr("Invalid debugger option: %1").arg(option);
813
814
815
    return false;
}

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

833
834
835
836
837
838
839

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

hjk's avatar
hjk committed
840
static bool isDebuggable(IEditor *editor)
841
{
842
843
    // 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
844
845
    //   IFile *file = editor->file();
    //   return !(file && file->mimeType() == "application/x-qml");
846
    // Nowadays, even Qml is debuggable.
hjk's avatar
hjk committed
847
    return editor;
848
849
}

con's avatar
con committed
850

851
852
///////////////////////////////////////////////////////////////////////
//
hjk's avatar
hjk committed
853
// Debugger Actions
854
855
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
856

857
858
859
struct DebuggerActions
{
    QAction *continueAction;
860
    QAction *exitAction; // on the application output button if "Stop" is possible
861
862
    QAction *interruptAction; // on the fat debug button if "Pause" is possible
    QAction *undisturbableAction; // on the fat debug button if nothing can be done
863
864
865
    QAction *resetAction; // FIXME: Should not be needed in a stable release
    QAction *stepAction;
    QAction *stepOutAction;
866
    QAction *runToLineAction; // Debug menu
867
    QAction *runToFunctionAction;
868
    QAction *jumpToLineAction; // in the Debug menu
869
870
    QAction *returnFromFunctionAction;
    QAction *nextAction;
871
    //QAction *snapshotAction;
872
873
874
875
876
877
878
879
    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
880

881
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
882
883


884
885
886
887
888
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
889

890
class DebuggerPluginPrivate : public DebuggerCore
891
892
{
    Q_OBJECT
893

894
895
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
896
    ~DebuggerPluginPrivate();
897

898
    bool initialize(const QStringList &arguments, QString *errorMessage);
899
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
900
    void disconnectEngine() { connectEngine(0); }
901
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
902

903
public slots:
904
905
906
907
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
908

hjk's avatar
hjk committed
909
    void breakpointSetMarginActionTriggered()
910
911
912
913
    {
        QString fileName;
        int lineNumber;
        quint64 address;
914
915
916
917
918
919
        if (positionFromActionData(sender(), &fileName, &lineNumber, &address)) {
            if (address)
                toggleBreakpointByAddress(address);
            else
                toggleBreakpointByFileAndLine(fileName, lineNumber);
        }
920
    }
921

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)
957
958
            m_currentEngine->reloadModules();
    }
959

hjk's avatar
hjk committed
960
    void registerDockToggled(bool on)
961
    {
962
        if (on && m_currentEngine->state() == InferiorStopOk)
963
964
            m_currentEngine->reloadRegisters();
    }
965

966
967
    void synchronizeBreakpoints()
    {