debuggerplugin.cpp 117 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
**
con's avatar
con committed
9
** No Commercial Usage
10
**
con's avatar
con committed
11
12
13
14
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
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
**
con's avatar
con committed
25
26
27
28
29
30
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
con's avatar
con committed
31
**
32
**************************************************************************/
hjk's avatar
hjk committed
33

con's avatar
con committed
34
35
#include "debuggerplugin.h"

36
#include "debuggeractions.h"
con's avatar
con committed
37
#include "debuggerconstants.h"
38
#include "debuggercore.h"
39
40
#include "debuggerdialogs.h"
#include "debuggerengine.h"
41
#include "debuggermainwindow.h"
con's avatar
con committed
42
#include "debuggerrunner.h"
43
#include "debuggerstringutils.h"
44
45
#include "debuggertooltip.h"

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

63
64
#include "snapshothandler.h"
#include "threadshandler.h"
hjk's avatar
hjk committed
65
#include "gdb/gdboptionspage.h"
con's avatar
con committed
66

67
#include "ui_commonoptionspage.h"
hjk's avatar
hjk committed
68
#include "ui_dumperoptionpage.h"
69

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

con's avatar
con committed
87
#include <cppeditor/cppeditorconstants.h>
88
#include <cplusplus/ModelManagerInterface.h>
hjk's avatar
hjk committed
89

90
91
#include <extensionsystem/pluginmanager.h>

92
#include <projectexplorer/project.h>
93
#include <projectexplorer/projectexplorer.h>
con's avatar
con committed
94
95
#include <projectexplorer/projectexplorerconstants.h>
#include <projectexplorer/session.h>
96
#include <projectexplorer/target.h>
97
#include <projectexplorer/toolchaintype.h>
hjk's avatar
hjk committed
98

99
100
#include <qt4projectmanager/qt4projectmanagerconstants.h>

hjk's avatar
hjk committed
101
#include <texteditor/basetexteditor.h>
102
#include <texteditor/fontsettings.h>
103
#include <texteditor/texteditorsettings.h>
hjk's avatar
hjk committed
104
105

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

109
110
#include <qml/scriptconsole.h>

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

124
125
#include <climits>

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


255
256
257
/* 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
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
290
291
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
292
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
293
294
295


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




329

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

hjk's avatar
hjk committed
335
336
337
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
338
339
340
341

namespace Debugger {
namespace Constants {

342
343
const char * const M_DEBUG_START_DEBUGGING = "QtCreator.Menu.Debug.StartDebugging";

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

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

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

} // namespace Constants


404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
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
423

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

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

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

440
441
// Retrieve file name and line and optionally address
// from the data set on the text editor context menu action.
442
443
static bool positionFromActionData(const QObject *sender,
    QString *fileName, int *lineNumber, quint64 *address)
444
{
445
446
447
448
449
450
    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();
451
    *address = data.at(2).toULongLong();
452
    return true;
453
454
}

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

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

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

472
473
474
475
476
477
478
479
480
481
482
483
484

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
    DummyEngine() : DebuggerEngine(DebuggerStartParameters()) {}
485
486
487
488
489
490
491
492
493
494
    ~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; }
495
496
497
498
499
500
501
502
503
};

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


504
505
506
507
508
509
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

510
class DebugMode : public IMode
hjk's avatar
hjk committed
511
512
{
public:
hjk's avatar
hjk committed
513
    DebugMode() : m_widget(0) { setObjectName(QLatin1String("DebugMode")); }
hjk's avatar
hjk committed
514

hjk's avatar
hjk committed
515
516
517
518
519
520
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        //EditorManager::instance()->setParent(0);
        delete m_widget;
    }
521
522

    // IMode
hjk's avatar
hjk committed
523
524
525
526
527
528
529
530
531
    QString displayName() const { return DebuggerPlugin::tr("Debug"); }
    QIcon icon() const { return QIcon(__(":/fancyactionbar/images/mode_Debug.png")); }
    int priority() const { return P_MODE_DEBUG; }
    QWidget *widget();
    QString id() const { return MODE_DEBUG; }
    QString type() const { return CC::MODE_EDIT_TYPE; }
    Context context() const
        { return Context(CC::C_EDITORMANAGER, C_DEBUGMODE, CC::C_NAVIGATION_PANE); }
    QString contextHelpId() const { return QString(); }
532
533
private:
    QWidget *m_widget;
534
};
hjk's avatar
hjk committed
535

536

537
538
///////////////////////////////////////////////////////////////////////
//
539
// CommonOptionsPage
540
541
542
//
///////////////////////////////////////////////////////////////////////

543
class CommonOptionsPage : public Core::IOptionsPage
544
545
{
public:
546
    CommonOptionsPage() {}
547
548

    // IOptionsPage
549
    QString id() const
hjk's avatar
hjk committed
550
        { return _(DEBUGGER_COMMON_SETTINGS_ID); }
551
    QString displayName() const
hjk's avatar
hjk committed
552
        { return QCoreApplication::translate("Debugger", DEBUGGER_COMMON_SETTINGS_NAME); }
553
    QString category() const
hjk's avatar
hjk committed
554
        { return _(DEBUGGER_SETTINGS_CATEGORY);  }
555
    QString displayCategory() const
hjk's avatar
hjk committed
556
        { return QCoreApplication::translate("Debugger", DEBUGGER_SETTINGS_TR_CATEGORY); }
557
558
    QIcon categoryIcon() const
        { return QIcon(QLatin1String(DEBUGGER_COMMON_SETTINGS_CATEGORY_ICON)); }
559
560

    QWidget *createPage(QWidget *parent);
hjk's avatar
hjk committed
561
    void apply() { m_group.apply(ICore::instance()->settings()); }
562
    void finish() { m_group.finish(); }
563
    virtual bool matches(const QString &s) const;
564
565

private:
566
    Ui::CommonOptionsPage m_ui;
567
    Utils::SavedActionSet m_group;
568
    QString m_searchKeywords;
569
570
};

571
QWidget *CommonOptionsPage::createPage(QWidget *parent)
572
573
574
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);
575
    m_group.clear();
576

hjk's avatar
hjk committed
577
    m_group.insert(debuggerCore()->action(ListSourceFiles),
578
        m_ui.checkBoxListSourceFiles);
hjk's avatar
hjk committed
579
    m_group.insert(debuggerCore()->action(UseAlternatingRowColors),
580
        m_ui.checkBoxUseAlternatingRowColors);
hjk's avatar
hjk committed
581
    m_group.insert(debuggerCore()->action(UseToolTipsInMainEditor),
582
        m_ui.checkBoxUseToolTipsInMainEditor);
hjk's avatar
hjk committed
583
    m_group.insert(debuggerCore()->action(CloseBuffersOnExit),
584
        m_ui.checkBoxCloseBuffersOnExit);
hjk's avatar
hjk committed
585
    m_group.insert(debuggerCore()->action(SwitchModeOnExit),
586
        m_ui.checkBoxSwitchModeOnExit);
hjk's avatar
hjk committed
587
588
589
590
591
592
    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),
593
        m_ui.spinBoxMaximalStackDepth);
hjk's avatar
hjk committed
594
595
596
597
598
599
600
    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);
601
#ifdef Q_OS_WIN
hjk's avatar
hjk committed
602
    Utils::SavedAction *registerAction = debuggerCore()->action(RegisterForPostMortem);
603
604
605
606
607
    m_group.insert(registerAction,
        m_ui.checkBoxRegisterForPostMortem);
    connect(registerAction, SIGNAL(toggled(bool)),
            m_ui.checkBoxRegisterForPostMortem, SLOT(setChecked(bool)));
#endif
608

609
    if (m_searchKeywords.isEmpty()) {
610
611
612
613
614
        QLatin1Char sep(' ');
        QTextStream(&m_searchKeywords)
                << sep << m_ui.checkBoxUseAlternatingRowColors->text()
                << sep << m_ui.checkBoxUseToolTipsInMainEditor->text()
                << sep << m_ui.checkBoxListSourceFiles->text()
615
#ifdef Q_OS_WIN
616
                << sep << m_ui.checkBoxRegisterForPostMortem->text()
617
#endif
618
619
620
621
                << sep << m_ui.checkBoxCloseBuffersOnExit->text()
                << sep << m_ui.checkBoxSwitchModeOnExit->text()
                << sep << m_ui.labelMaximalStackDepth->text()
                   ;
622
623
        m_searchKeywords.remove(QLatin1Char('&'));
    }
624
625
626
#ifndef Q_OS_WIN
    m_ui.checkBoxRegisterForPostMortem->setVisible(false);
#endif
627
628
629
    return w;
}

630
631
632
633
634
bool CommonOptionsPage::matches(const QString &s) const
{
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
}

hjk's avatar
hjk committed
635
636
///////////////////////////////////////////////////////////////////////
//
637
// DebuggingHelperOptionPage
hjk's avatar
hjk committed
638
639
640
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
641
static bool oxygenStyle()
642
{
hjk's avatar
hjk committed
643
644
    const ManhattanStyle *ms = qobject_cast<const ManhattanStyle *>(qApp->style());
    return ms && !qstrcmp("OxygenStyle", ms->baseStyle()->metaObject()->className());
645
646
}

647
class DebuggingHelperOptionPage : public Core::IOptionsPage
hjk's avatar
hjk committed
648
649
{
    Q_OBJECT // Needs tr-context.
hjk's avatar
hjk committed
650
public:
651
    DebuggingHelperOptionPage() {}
hjk's avatar
hjk committed
652
653

    // IOptionsPage
hjk's avatar
hjk committed
654
    QString id() const { return _("Z.DebuggingHelper"); }
655
    QString displayName() const { return tr("Debugging Helper"); }
hjk's avatar
hjk committed
656
    QString category() const { return _(DEBUGGER_SETTINGS_CATEGORY); }
657
658
659
660
    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
661
662

    QWidget *createPage(QWidget *parent);
hjk's avatar
hjk committed
663
    void apply() { m_group.apply(ICore::instance()->settings()); }
664
    void finish() { m_group.finish(); }
665
    virtual bool matches(const QString &s) const;
hjk's avatar
hjk committed
666
667

private:
668
    Ui::DebuggingHelperOptionPage m_ui;
669
    Utils::SavedActionSet m_group;
670
    QString m_searchKeywords;
hjk's avatar
hjk committed
671
672
};

673
QWidget *DebuggingHelperOptionPage::createPage(QWidget *parent)
hjk's avatar
hjk committed
674
675
676
677
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);

678
    m_ui.dumperLocationChooser->setExpectedKind(Utils::PathChooser::Command);
679
    m_ui.dumperLocationChooser->setPromptDialogTitle(tr("Choose DebuggingHelper Location"));
hjk's avatar
hjk committed
680
    m_ui.dumperLocationChooser->setInitialBrowsePathBackup(
hjk's avatar
hjk committed
681
        ICore::instance()->resourcePath() + "../../lib");
hjk's avatar
hjk committed
682

683
    m_group.clear();
hjk's avatar
hjk committed
684
    m_group.insert(debuggerCore()->action(UseDebuggingHelpers),
685
        m_ui.debuggingHelperGroupBox);
hjk's avatar
hjk committed
686
    m_group.insert(debuggerCore()->action(UseCustomDebuggingHelperLocation),
687
        m_ui.customLocationGroupBox);
hjk's avatar
hjk committed
688
    // Suppress Oxygen style's giving flat group boxes bold titles.
689
    if (oxygenStyle())
hjk's avatar
hjk committed
690
        m_ui.customLocationGroupBox->setStyleSheet(_("QGroupBox::title { font: ; }"));
691

hjk's avatar
hjk committed
692
    m_group.insert(debuggerCore()->action(CustomDebuggingHelperLocation),
693
        m_ui.dumperLocationChooser);
hjk's avatar
hjk committed
694

hjk's avatar
hjk committed
695
    m_group.insert(debuggerCore()->action(UseCodeModel),
696
        m_ui.checkBoxUseCodeModel);
697
698
699
    m_group.insert(debuggerCore()->action(ShowThreadNames),
        m_ui.checkBoxShowThreadNames);

700

hjk's avatar
hjk committed
701
702
#ifndef QT_DEBUG
#if 0
hjk's avatar
hjk committed
703
    cmd = am->registerAction(m_dumpLogAction,
hjk's avatar
hjk committed
704
        DUMP_LOG, globalcontext);
hjk's avatar
hjk committed
705
706
707
708
709
710
    //cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+D,Ctrl+L")));
    cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+Shift+F11")));
    mdebug->addAction(cmd);
#endif
#endif

711
712
713
714
715
    if (m_searchKeywords.isEmpty()) {
        QTextStream(&m_searchKeywords)
                << ' ' << m_ui.debuggingHelperGroupBox->title()
                << ' ' << m_ui.customLocationGroupBox->title()
                << ' ' << m_ui.dumperLocationLabel->text()
716
717
                << ' ' << m_ui.checkBoxUseCodeModel->text()
                << ' ' << m_ui.checkBoxShowThreadNames->text();
718
719
        m_searchKeywords.remove(QLatin1Char('&'));
    }
hjk's avatar
hjk committed
720
721
722
    return w;
}

723
bool DebuggingHelperOptionPage::matches(const QString &s) const
hjk's avatar
hjk committed
724
{
725
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
hjk's avatar
hjk committed
726
727
}

728

con's avatar
con committed
729
730
///////////////////////////////////////////////////////////////////////
//
731
// Argument parsing
con's avatar
con committed
732
733
734
//
///////////////////////////////////////////////////////////////////////

735
static QString msgParameterMissing(const QString &a)
736
737
738
739
{
    return DebuggerPlugin::tr("Option '%1' is missing the parameter.").arg(a);
}

740
static QString msgInvalidNumericParameter(const QString &a, const QString &number)
741
742
743
744
{
    return DebuggerPlugin::tr("The parameter '%1' of option '%2' is not a number.").arg(number, a);
}

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

808
    *errorMessage = DebuggerPlugin::tr("Invalid debugger option: %1").arg(option);
809
810
811
    return false;
}

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

829
830
831
832
833
834
835

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

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

con's avatar
con committed
846

847
848
///////////////////////////////////////////////////////////////////////
//
hjk's avatar
hjk committed
849
// Debugger Actions
850
851
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
852

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

877
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
878
879


880
881
882
883
884
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
885

886
class DebuggerPluginPrivate : public DebuggerCore
887
888
{
    Q_OBJECT
889

890
891
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
892
    ~DebuggerPluginPrivate();
893

894
    bool initialize(const QStringList &arguments, QString *errorMessage);
895
896
897
    void extensionsInitialized();
    void aboutToShutdown();

898
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
899
    void disconnectEngine() { connectEngine(0); }
900
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
901

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

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

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

    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);
940
941
    }

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

947
    void sourceFilesDockToggled(bool on)