debuggerplugin.cpp 122 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
#endif

} // namespace Constants


400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
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
419

hjk's avatar
hjk committed
420
static SessionManager *sessionManager()
421
{
hjk's avatar
hjk committed
422
    return ProjectExplorerPlugin::instance()->session();
423
424
}

425
426
427
428
429
430
431
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

432
433
// Retrieve file name and line and optionally address
// from the data set on the text editor context menu action.
434
435
static bool positionFromActionData(const QObject *sender,
    QString *fileName, int *lineNumber, quint64 *address)
436
{
437
438
439
440
441
442
    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();
443
    *address = data.at(2).toULongLong();
444
    return true;
445
446
}

447
448
449
struct AttachRemoteParameters
{
    AttachRemoteParameters() : attachPid(0), winCrashEvent(0) {}
450
    void clear();
451
452

    quint64 attachPid;
453
    QString attachTarget;  // core file name or  server:port
454
    // Event handle for attaching to crashed Windows processes.
455
456
457
    quint64 winCrashEvent;
};

458
459
460
461
462
void AttachRemoteParameters::clear()
{
    attachPid = winCrashEvent = 0;
    attachTarget.clear();
}
463

464
465
466
467
468
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

///////////////////////////////////////////////////////////////////////
//
// 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;
}


495
496
497
498
499
500
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

520

con's avatar
con committed
521
522
523
524
525
526
///////////////////////////////////////////////////////////////////////
//
// LocationMark
//
///////////////////////////////////////////////////////////////////////

527
// Used in "real" editors
528
class LocationMark : public TextEditor::BaseTextMark
con's avatar
con committed
529
530
531
532
{
public:
    LocationMark(const QString &fileName, int linenumber)
        : BaseTextMark(fileName, linenumber)
533
    {}
con's avatar
con committed
534

535
    QIcon icon() const { return debuggerCore()->locationMarkIcon(); }
con's avatar
con committed
536
537
    void updateLineNumber(int /*lineNumber*/) {}
    void updateBlock(const QTextBlock & /*block*/) {}
538
    void removedFromEditor() {}
con's avatar
con committed
539
540
};

541
542
543

///////////////////////////////////////////////////////////////////////
//
544
// CommonOptionsPage
545
546
547
//
///////////////////////////////////////////////////////////////////////

548
class CommonOptionsPage : public Core::IOptionsPage
549
550
{
public:
551
    CommonOptionsPage() {}
552
553

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

    QWidget *createPage(QWidget *parent);
hjk's avatar
hjk committed
566
    void apply() { m_group.apply(ICore::instance()->settings()); }
567
    void finish() { m_group.finish(); }
568
    virtual bool matches(const QString &s) const;
569
570

private:
571
    Ui::CommonOptionsPage m_ui;
572
    Utils::SavedActionSet m_group;
573
    QString m_searchKeywords;
574
575
};

576
QWidget *CommonOptionsPage::createPage(QWidget *parent)
577
578
579
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);
580
    m_group.clear();
581

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

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

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

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

642
643
644
static inline bool oxygenStyle()
{
    if (const ManhattanStyle *ms = qobject_cast<const ManhattanStyle *>(qApp->style()))
645
        return !qstrcmp("OxygenStyle", ms->baseStyle()->metaObject()->className());
646
647
648
    return false;
}

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

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

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

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

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

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

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

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

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

700
#ifdef QT_DEBUG
hjk's avatar
hjk committed
701
    m_group.insert(debuggerCore()->action(DebugDebuggingHelpers),
702
        m_ui.checkBoxDebugDebuggingHelpers);
703
704
705
#else
    m_ui.checkBoxDebugDebuggingHelpers->hide();
#endif
hjk's avatar
hjk committed
706
707
708
709

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

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

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

734

con's avatar
con committed
735
736
///////////////////////////////////////////////////////////////////////
//
737
// Argument parsing
con's avatar
con committed
738
739
740
//
///////////////////////////////////////////////////////////////////////

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

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

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

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

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

831
832
833
834
835
836
837

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

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

con's avatar
con committed
848

849
850
851
852
853
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
854

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

879
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
880
881


882
883
884
885
886
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
887

888
class DebuggerPluginPrivate : public DebuggerCore
889
890
{
    Q_OBJECT
891

892
893
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
894
    ~DebuggerPluginPrivate();
895

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

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

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

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

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

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

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

952
    void modulesDockToggled(bool on)
953
    {
954
        if (on && m_currentEngine->state() == InferiorStopOk)
955
956
            m_currentEngine->reloadModules();
    }
957

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

964
965
    void synchronizeBreakpoints()
    {
966
        showMessage("ATTEMPT SYNC", LogDebug);
967
968
969
970
971
972
973
974
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
            if (DebuggerRunControl *runControl = m_snapshotHandler->at(i)) {
                DebuggerEngine *engine = runControl->engine();
                engine->attemptBreakpointSynchronization();
            }
        }
    }

hjk's avatar
hjk committed
975
976
977
978
979
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
            if (DebuggerRunControl *runControl = m_snapshotHandler->at(i)) {
                DebuggerEngine *engine = runControl->engine();
980
                engine