debuggerplugin.cpp 139 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) 2012 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
**
10
** GNU Lesser General Public License Usage
11
**
hjk's avatar
hjk committed
12
13
14
15
16
17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21
22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23
24
25
26
27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
29
** Nokia at qt-info@nokia.com.
con's avatar
con committed
30
**
31
**************************************************************************/
hjk's avatar
hjk committed
32

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

Friedemann Kleint's avatar
Friedemann Kleint committed
35
#include "debuggerstartparameters.h"
36
#include "debuggeractions.h"
con's avatar
con committed
37
#include "debuggerconstants.h"
38
#include "debuggerinternalconstants.h"
39
#include "debuggercore.h"
40
41
#include "debuggerdialogs.h"
#include "debuggerengine.h"
42
#include "debuggermainwindow.h"
con's avatar
con committed
43
#include "debuggerrunner.h"
44
#include "debuggerruncontrolfactory.h"
45
#include "debuggerstringutils.h"
46
#include "memoryagent.h"
47
48
#include "breakpoint.h"
#include "breakhandler.h"
49
#include "breakwindow.h"
50
#include "qtmessagelogwindow.h"
51
#include "disassemblerlines.h"
52
#include "logwindow.h"
53
#include "moduleswindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
54
#include "moduleshandler.h"
55
56
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
57
#include "stackhandler.h"
58
59
60
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
61
#include "watchhandler.h"
62
#include "watchwindow.h"
hjk's avatar
hjk committed
63
#include "watchutils.h"
64
#include "debuggertooltipmanager.h"
65
#include "localsandwatcherswindow.h"
66

67
68
#include "snapshothandler.h"
#include "threadshandler.h"
69
#include "commonoptionspage.h"
con's avatar
con committed
70

71
#include <coreplugin/actionmanager/actionmanager.h>
72
73
#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/command.h>
74
#include <coreplugin/id.h>
75
#include <coreplugin/imode.h>
con's avatar
con committed
76
#include <coreplugin/coreconstants.h>
77
#include <coreplugin/dialogs/ioptionspage.h>
con's avatar
con committed
78
#include <coreplugin/editormanager/editormanager.h>
hjk's avatar
hjk committed
79
#include <coreplugin/findplaceholder.h>
80
#include <coreplugin/icontext.h>
con's avatar
con committed
81
#include <coreplugin/icore.h>
82
#include <coreplugin/imode.h>
83
#include <coreplugin/icorelistener.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 <cpptools/ModelManagerInterface.h>
hjk's avatar
hjk committed
89

90
#include <extensionsystem/pluginmanager.h>
91
#include <extensionsystem/invoker.h>
92

93
#include <projectexplorer/abi.h>
hjk's avatar
hjk committed
94
95
#include <projectexplorer/applicationrunconfiguration.h>
#include <projectexplorer/buildconfiguration.h>
con's avatar
con committed
96
#include <projectexplorer/projectexplorerconstants.h>
97
98
99
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/projectexplorersettings.h>
#include <projectexplorer/project.h>
con's avatar
con committed
100
#include <projectexplorer/session.h>
101
#include <projectexplorer/target.h>
102
103
#include <projectexplorer/toolchain.h>
#include <projectexplorer/toolchainmanager.h>
hjk's avatar
hjk committed
104

105
#include <qtsupport/qtsupportconstants.h>
106

hjk's avatar
hjk committed
107
#include <texteditor/basetexteditor.h>
108
#include <texteditor/fontsettings.h>
109
#include <texteditor/texteditorsettings.h>
hjk's avatar
hjk committed
110
111

#include <utils/qtcassert.h>
112
#include <utils/savedaction.h>
113
#include <utils/styledbar.h>
114
#include <utils/proxyaction.h>
115
#include <utils/statuslabel.h>
116
#include <utils/fileutils.h>
con's avatar
con committed
117

118
119
120
121
122
123
124
125
126
127
128
129
130
#include <QTimer>
#include <QtPlugin>
#include <QComboBox>
#include <QDockWidget>
#include <QFileDialog>
#include <QMenu>
#include <QMessageBox>
#include <QPushButton>
#include <QTextBlock>
#include <QTextCursor>
#include <QToolButton>
#include <QTreeWidget>
#include <QInputDialog>
con's avatar
con committed
131

hjk's avatar
hjk committed
132
#ifdef WITH_TESTS
133
134
135
#include <QTest>
#include <QSignalSpy>
#include <QTestEventLoop>
136
137
138
139

//#define WITH_BENCHMARK
#ifdef WITH_BENCHMARK
#include <valgrind/callgrind.h>
hjk's avatar
hjk committed
140
141
#endif

142
143
#endif // WITH_TESTS

144
145
#include <climits>

146
147
148
149
150
151
152
153
154
155
#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

156
157
158
159
160
161
162
163
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
164
    \internal
165
166
167
168
169
170
171
172
*/

/*!
    \class Debugger::DebuggerEngine

    \brief Base class of a debugger engine.

    Note: the Debugger process itself and any helper processes like
Pawel Polanski's avatar
Pawel Polanski committed
173
    gdbserver, the CODA client etc are referred to as 'Engine',
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
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
289
290
    whereas the debugged process is referred to as 'Inferior'.

    Transitions marked by '---' are done in the individual engines.
    Transitions marked by '+-+' are done in the base DebuggerEngine.
    Transitions marked by '*' are done asynchronously.

    The GdbEngine->setupEngine() function is described in more detail below.

    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.
    \code

                        DebuggerNotReady
                         progressmanager/progressmanager.cpp      +
                      EngineSetupRequested
                               +
                  (calls *Engine->setupEngine())
                            |      |
                            |      |
                       {notify-  {notify-
                        Engine-   Engine-
                        SetupOk}  SetupFailed}
                            +      +
                            +      `+-+-+> EngineSetupFailed
                            +                   +
                            +    [calls RunControl->startFailed]
                            +                   +
                            +             DebuggerFinished
                            v
                      EngineSetupOk
                            +
             [calls RunControl->StartSuccessful]
                            +
                  InferiorSetupRequested
                            +
             (calls *Engine->setupInferior())
                         |       |
                         |       |
                    {notify-   {notify-
                     Inferior- Inferior-
                     SetupOk}  SetupFailed}
                         +       +
                         +       ` +-+-> InferiorSetupFailed +-+-+-+-+-+->.
                         +                                                +
                  InferiorSetupOk                                         +
                         +                                                +
                  EngineRunRequested                                      +
                         +                                                +
                 (calls *Engine->runEngine())                             +
               /       |            |        \                            +
             /         |            |          \                          +
            | (core)   | (attach)   |           |                         +
            |          |            |           |                         +
      {notify-    {notifyER&- {notifyER&-  {notify-                       +
      Inferior-     Inferior-   Inferior-  EngineRun-                     +
     Unrunnable}     StopOk}     RunOk}     Failed}                       +
           +           +            +           +                         +
   InferiorUnrunnable  +     InferiorRunOk      +                         +
                       +                        +                         +
                InferiorStopOk            EngineRunFailed                 +
                                                +                         v
                                                 `-+-+-+-+-+-+-+-+-+-+-+>-+
                                                                          +
                                                                          +
                       #Interrupt@InferiorRunOk#                          +
                                  +                                       +
                          InferiorStopRequested                           +
  #SpontaneousStop                +                                       +
   @InferiorRunOk#         (calls *Engine->                               +
          +               interruptInferior())                            +
      {notify-               |          |                                 +
     Spontaneous-       {notify-    {notify-                              +
      Inferior-          Inferior-   Inferior-                            +
       StopOk}           StopOk}    StopFailed}                           +
           +              +             +                                 +
            +            +              +                                 +
            InferiorStopOk              +                                 +
                  +                     +                                 +
                  +                    +                                  +
                  +                   +                                   +
        #Stop@InferiorUnrunnable#    +                                    +
          #Creator Close Event#     +                                     +
                       +           +                                      +
                InferiorShutdownRequested                                 +
                            +                                             +
           (calls *Engine->shutdownInferior())                            +
                         |        |                                       +
                    {notify-   {notify-                                   +
                     Inferior- Inferior-                                  +
                  ShutdownOk}  ShutdownFailed}                            +
                         +        +                                       +
                         +        +                                       +
  #Inferior exited#      +        +                                       +
         |               +        +                                       +
   {notifyInferior-      +        +                                       +
      Exited}            +        +                                       +
           +             +        +                                       +
     InferiorExitOk      +        +                                       +
             +           +        +                                       +
            InferiorShutdownOk InferiorShutdownFailed                     +
                      *          *                                        +
                  EngineShutdownRequested                                 +
                            +                                             +
           (calls *Engine->shutdownEngine())  <+-+-+-+-+-+-+-+-+-+-+-+-+-+'
                         |        |
                         |        |
                    {notify-   {notify-
                     Engine-    Engine-
                  ShutdownOk}  ShutdownFailed}
                         +       +
            EngineShutdownOk  EngineShutdownFailed
                         *       *
                     DebuggerFinished

\endcode */
hjk's avatar
hjk committed
291

292
293
294
/* 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
295

296
297
298
299
300
301
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" ];
302
sg1:   InferiorSetupRequested -> InferiorSetupOk [ label="notifyInferiorSetupOk", style="dashed" ];
303
sg1:   InferiorSetupRequested -> InferiorSetupFailed [ label="notifyInferiorFailed", style="dashed" ];
304
sg1:   InferiorSetupOk -> EngineRunRequested
305
306
307
308
309
310
311
312
313
314
315
316
317
318
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
319
320
sg1:   InferiorStopOk -> InferiorShutdownRequested [ label="Close event" ];
sg1:   InferiorUnrunnable -> InferiorShutdownRequested [ label="Close event" ];
321
322
sg1:   InferiorShutdownRequested -> InferiorShutdownOk [ label= "Engine::shutdownInferior\nnotifyInferiorShutdownOk", style="dashed" ];
sg1:   InferiorShutdownRequested -> InferiorShutdownFailed [ label="Engine::shutdownInferior\nnotifyInferiorShutdownFailed", style="dashed" ];
323
324
sg1:   InferiorExited -> InferiorExitOk [ label="notifyInferiorExited", style="dashed"];
sg1:   InferiorExitOk -> InferiorShutdownOk
325
326
327
328
329
330
331
332
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
333
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
334
335


336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
/*!
    \class Debugger::Internal::GdbEngine
    \brief Implementation of Debugger::Engine driving a gdb executable.

    GdbEngine specific startup. All happens in EngineSetupRequested state:

    Transitions marked by '---' are done in the individual adapters.

    Transitions marked by '+-+' are done in the GdbEngine.

    \code
                  GdbEngine::setupEngine()
                          +
            (calls *Adapter->startAdapter())
                          |      |
                          |      `---> handleAdapterStartFailed()
                          |                   +
                          |             {notifyEngineSetupFailed}
                          |
                 handleAdapterStarted()
                          +
                 {notifyEngineSetupOk}
358
359
360



361
362
363
364
365
366
367
368
369
370
371
                GdbEngine::setupInferior()
                          +
            (calls *Adapter->prepareInferior())
                          |      |
                          |      `---> handlePrepareInferiorFailed()
                          |                   +
                          |             {notifyInferiorSetupFailed}
                          |
                handleInferiorPrepared()
                          +
                {notifyInferiorSetupOk}
372

373
\endcode */
374

con's avatar
con committed
375
using namespace Core;
hjk's avatar
hjk committed
376
using namespace Debugger::Constants;
con's avatar
con committed
377
using namespace ProjectExplorer;
hjk's avatar
hjk committed
378
using namespace TextEditor;
379
using namespace ExtensionSystem;
con's avatar
con committed
380

hjk's avatar
hjk committed
381
382
383
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
384
385
386
387

namespace Debugger {
namespace Constants {

388
#ifdef Q_OS_MAC
hjk's avatar
hjk committed
389
390
391
392
393
394
395
396
397
398
399
400
401
402
const char STOP_KEY[]                     = "Shift+Ctrl+Y";
const char RESET_KEY[]                    = "Ctrl+Shift+F5";
const char STEP_KEY[]                     = "Ctrl+Shift+I";
const char STEPOUT_KEY[]                  = "Ctrl+Shift+T";
const char NEXT_KEY[]                     = "Ctrl+Shift+O";
const char REVERSE_KEY[]                  = "";
const char RUN_TO_LINE_KEY[]              = "Shift+F8";
const char RUN_TO_SELECTED_FUNCTION_KEY[] = "Ctrl+F6";
const char JUMP_TO_LINE_KEY[]             = "Ctrl+D,Ctrl+L";
const char TOGGLE_BREAK_KEY[]             = "F8";
const char BREAK_BY_FUNCTION_KEY[]        = "Ctrl+D,Ctrl+F";
const char BREAK_AT_MAIN_KEY[]            = "Ctrl+D,Ctrl+M";
const char ADD_TO_WATCH_KEY[]             = "Ctrl+D,Ctrl+W";
const char SNAPSHOT_KEY[]                 = "Ctrl+D,Ctrl+S";
con's avatar
con committed
403
#else
hjk's avatar
hjk committed
404
405
406
407
408
409
const char STOP_KEY[]                     = "Shift+F5";
const char RESET_KEY[]                    = "Ctrl+Shift+F5";
const char STEP_KEY[]                     = "F11";
const char STEPOUT_KEY[]                  = "Shift+F11";
const char NEXT_KEY[]                     = "F10";
const char REVERSE_KEY[]                  = "F12";
410
const char RUN_TO_LINE_KEY[]              = "Ctrl+F10";
hjk's avatar
hjk committed
411
412
413
414
415
416
417
const char RUN_TO_SELECTED_FUNCTION_KEY[] = "Ctrl+F6";
const char JUMP_TO_LINE_KEY[]             = "";
const char TOGGLE_BREAK_KEY[]             = "F9";
const char BREAK_BY_FUNCTION_KEY[]        = "";
const char BREAK_AT_MAIN_KEY[]            = "";
const char ADD_TO_WATCH_KEY[]             = "Ctrl+Alt+Q";
const char SNAPSHOT_KEY[]                 = "Ctrl+D,Ctrl+S";
con's avatar
con committed
418
419
420
421
422
#endif

} // namespace Constants


423
424
namespace Internal {

425
426
427
428
429
430
431
432
433
434
435
436
437
// To be passed through margin menu action's data
struct BreakpointMenuContextData : public ContextData
{
    enum Mode
    {
        Breakpoint,
        MessageTracePoint
    };

    BreakpointMenuContextData() : mode(Breakpoint) {}
    Mode mode;
};

438
439
440
441
442
443
444
445
446
447
448
struct TestCallBack
{
    TestCallBack() : receiver(0), slot(0) {}
    TestCallBack(QObject *ob, const char *s) : receiver(ob), slot(s) {}

    QObject *receiver;
    const char *slot;
    QVariant cookie;
};


449
450
451
452
} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::BreakpointMenuContextData)
453
454
Q_DECLARE_METATYPE(Debugger::Internal::TestCallBack)

455
456
457
458

namespace Debugger {
namespace Internal {

459
460
461
462
463
464
// 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.

465
void addCdbOptionPages(QList<IOptionsPage*> *opts);
466
467
468
void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
469

470
471
472
473
#ifdef WITH_LLDB
void addLldbOptionPages(QList<IOptionsPage*> *opts);
#endif

hjk's avatar
hjk committed
474
static SessionManager *sessionManager()
475
{
hjk's avatar
hjk committed
476
    return ProjectExplorerPlugin::instance()->session();
477
478
}

479
480
481
482
483
484
485
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

486
static Abi anyAbiOfBinary(const QString &fileName)
487
{
Tobias Hunger's avatar
Tobias Hunger committed
488
    QList<Abi> abis = Abi::abisOfBinary(Utils::FileName::fromString(fileName));
489
490
491
492
    if (abis.isEmpty())
        return Abi();
    return abis.at(0);
}
493
494
495
496
497
498
499
500
501
502
503
504

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
505
    DummyEngine() : DebuggerEngine(DebuggerStartParameters(), AnyLanguage) {}
506
507
508
509
510
511
512
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
513
    bool hasCapability(unsigned cap) const;
514
    bool acceptsBreakpoint(BreakpointModelId) const { return false; }
515
    bool acceptsDebuggerCommands() const { return false; }
516
517
};

518
bool DummyEngine::hasCapability(unsigned cap) const
519
520
{
    // This can only be a first approximation of what to expect when running.
521
    Project *project = ProjectExplorerPlugin::currentProject();
522
523
524
525
526
527
528
529
    if (!project)
        return 0;
    Target *target = project->activeTarget();
    QTC_ASSERT(target, return 0);
    RunConfiguration *activeRc = target->activeRunConfiguration();
    QTC_ASSERT(activeRc, return 0);

    // This is a non-started Cdb or Gdb engine:
530
    if (activeRc->debuggerAspect()->useCppDebugger())
531
        return cap & (WatchpointByAddressCapability
532
533
               | BreakConditionCapability
               | TracePointCapability
534
               | OperateByInstructionCapability);
535
536

    // This is a Qml or unknown engine.
537
    return cap & AddWatcherCapability;
538
539
}

540
541
542
543
544
545
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

546
class DebugMode : public IMode
hjk's avatar
hjk committed
547
548
{
public:
549
550
551
552
    DebugMode()
    {
        setObjectName(QLatin1String("DebugMode"));
        setContext(Context(CC::C_EDITORMANAGER, C_DEBUGMODE, CC::C_NAVIGATION_PANE));
553
554
        setDisplayName(DebuggerPlugin::tr("Debug"));
        setIcon(QIcon(QLatin1String(":/fancyactionbar/images/mode_Debug.png")));
555
        setPriority(85);
556
557
        setId(MODE_DEBUG);
        setType(CC::MODE_EDIT_TYPE);
558
    }
hjk's avatar
hjk committed
559

hjk's avatar
hjk committed
560
561
562
563
564
565
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        //EditorManager::instance()->setParent(0);
        delete m_widget;
    }
566
};
hjk's avatar
hjk committed
567

568
569
570
571
572
573
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

574
static TextEditor::ITextEditor *currentTextEditor()
575
{
hjk's avatar
hjk committed
576
    return qobject_cast<TextEditor::ITextEditor *>(Core::EditorManager::currentEditor());
577
}
con's avatar
con committed
578

579
580
static bool currentTextEditorPosition(ContextData *data)
{
581
582
583
    TextEditor::ITextEditor *textEditor = currentTextEditor();
    if (!textEditor)
        return false;
584
585
586
    const Core::IDocument *document = textEditor->document();
    QTC_ASSERT(document, return false);
    data->fileName = document->fileName();
587
588
589
590
591
592
593
    if (textEditor->property("DisassemblerView").toBool()) {
        int lineNumber = textEditor->currentLine();
        QString line = textEditor->contents()
            .section(QLatin1Char('\n'), lineNumber - 1, lineNumber - 1);
        data->address = DisassemblerLine::addressFromDisassemblyLine(line);
    } else {
        data->lineNumber = textEditor->currentLine();
594
    }
595
    return true;
596
}
597

598
599
///////////////////////////////////////////////////////////////////////
//
600
// DebuggerPluginPrivate
601
602
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
603

604
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
605

606
607
608
609
610
611
612
613
614
615
616
617
618
619
/*!
    \class Debugger::Internal::DebuggerCore

    This is the "internal" interface of the debugger plugin that's
    used by debugger views and debugger engines. The interface is
    implemented in DebuggerPluginPrivate.
*/

/*!
    \class Debugger::Internal::DebuggerPluginPrivate

    Implementation of DebuggerCore.
*/

620
class DebuggerPluginPrivate : public DebuggerCore
621
622
{
    Q_OBJECT
623

624
625
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
626
    ~DebuggerPluginPrivate();
627

628
    bool initialize(const QStringList &arguments, QString *errorMessage);
629
630
631
    void extensionsInitialized();
    void aboutToShutdown();

632
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
633
    void disconnectEngine() { connectEngine(0); }
634
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
635
    DebuggerEngine *dummyEngine();
636

637
638
639
640
641
642
643
644
645
646
    void setThreads(const QStringList &list, int index)
    {
        const bool state = m_threadBox->blockSignals(true);
        m_threadBox->clear();
        foreach (const QString &item, list)
            m_threadBox->addItem(item);
        m_threadBox->setCurrentIndex(index);
        m_threadBox->blockSignals(state);
    }

647
public slots:
648
649
650
651
652
653
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

654
655
656
657
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
658

hjk's avatar
hjk committed
659
    void breakpointSetMarginActionTriggered()
660
    {
661
662
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
hjk's avatar
hjk committed
663
664
        const BreakpointMenuContextData data =
            action->data().value<BreakpointMenuContextData>();
665
666
667
668
669
670
671
672
673
674
675
676
677
        QString message;
        if (data.mode == BreakpointMenuContextData::MessageTracePoint) {
            if (data.address) {
                //: Message tracepoint: Address hit.
                message = tr("0x%1 hit").arg(data.address, 0, 16);
            } else {
                //: Message tracepoint: %1 file, %2 line %3 function hit.
                message = tr("%1:%2 %3() hit").arg(QFileInfo(data.fileName).fileName()).
                        arg(data.lineNumber).
                        arg(cppFunctionAt(data.fileName, data.lineNumber));
            }
            QInputDialog dialog; // Create wide input dialog.
            dialog.setWindowFlags(dialog.windowFlags()
hjk's avatar
hjk committed
678
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
679
680
681
682
683
684
685
686
            dialog.resize(600, dialog.height());
            dialog.setWindowTitle(tr("Add Message Tracepoint"));
            dialog.setLabelText (tr("Message:"));
            dialog.setTextValue(message);
            if (dialog.exec() != QDialog::Accepted || dialog.textValue().isEmpty())
                return;
            message = dialog.textValue();
        }
687
        if (data.address)
688
            toggleBreakpointByAddress(data.address, message);
689
        else
690
            toggleBreakpointByFileAndLine(data.fileName, data.lineNumber, message);
691
    }
692

hjk's avatar
hjk committed
693
    void breakpointRemoveMarginActionTriggered()
694
    {
hjk's avatar
hjk committed
695
696
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
697
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
698
        m_breakHandler->removeBreakpoint(id);
hjk's avatar
hjk committed
699
700
701
702
703
704
     }

    void breakpointEnableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
705
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
706
        breakHandler()->setEnabled(id, true);
hjk's avatar
hjk committed
707
708
709
710
711
712
    }

    void breakpointDisableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
713
        BreakpointModelId id = act->data().value<BreakpointModelId>();;
hjk's avatar
hjk committed
714
        breakHandler()->setEnabled(id, false);
715
716
    }

717
    void updateWatchersHeader(int section, int, int newSize)
718
719
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
720
        m_returnWindow->header()->resizeSection(section, newSize);
721
    }
722

723

724
    void sourceFilesDockToggled(bool on)
725
    {
726
        if (on && m_currentEngine->state() == InferiorStopOk)
727
728
729
            m_currentEngine->reloadSourceFiles();
    }

730
    void modulesDockToggled(bool on)
731
    {
732
        if (on && m_currentEngine->state() == InferiorStopOk)
733
734
            m_currentEngine->reloadModules();
    }
735

hjk's avatar
hjk committed
736
    void registerDockToggled(bool on)
737
    {
738
        if (on && m_currentEngine->state() == InferiorStopOk)
739
740
            m_currentEngine->reloadRegisters();
    }
741

742
743
    void synchronizeBreakpoints()
    {
744
        showMessage(QLatin1String("ATTEMPT SYNC"), LogDebug);
745
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
746
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
747
748
749
750
                engine->attemptBreakpointSynchronization();
        }
    }

hjk's avatar
hjk committed
751
752
753
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
754
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
755
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
756
757
758
        }
    }

759
    void editorOpened(Core::IEditor *editor);
760
    void updateBreakMenuItem(Core::IEditor *editor);
761
    void setBusyCursor(bool busy);
762
763
764
    void requestMark(TextEditor::ITextEditor *editor,
                     int lineNumber,
                     TextEditor::ITextEditor::MarkRequestKind kind);
765
766
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
767

768
769
770
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
771
772
773
774
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
775
    void onModeChanged(Core::IMode *mode);
776
    void onCoreAboutToOpen();
777
    void showSettingsDialog();
778
    void updateDebugWithoutDeployMenu();
779

780
    void debugProject();
781
    void debugProjectWithoutDeploy();
782
    void debugProjectBreakMain();
783
    void startExternalApplication();
784
    void startRemoteCdbSession();
785
786
    void startRemoteProcess();
    void startRemoteServer();
787
    bool queryRemoteParameters(DebuggerStartParameters &sp, bool useScript);
788
    void attachToRemoteServer();
789
    void attachToRemoteProcess();
790
    void attachToQmlPort();
791
    void startRemoteEngine();
792
    void attachExternalApplication();
Robert Loehning's avatar
Robert Loehning committed
793
    Q_SLOT void attachExternalApplication(ProjectExplorer::RunControl*rc);
794
    void runScheduled();
795
    void attachCore();
796
    void attachToRemoteServer(const QString &spec);
797

798
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
799
    void languagesChanged();
800
    void showStatusMessage(const QString &msg, int timeout = -1);
801
    void openMemoryEditor();
802

803
804
805
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

    void showQtDumperLibraryWarning(const QString &details);
hjk's avatar
hjk committed
806
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
807
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
808
        { return mainWindow()->isDockVisible(objectName); }
809
810

    bool hasSnapshots() const { return m_snapshotHandler->size(); }
hjk's avatar
hjk committed
811
    void createNewDock(QWidget *widget);
812

813
814
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
815
    DebuggerLanguages activeLanguages() const;
816
817
    unsigned enabledEngines() const { return m_cmdLineEnabledEngines; }
    QString debuggerForAbi(const Abi &abi, DebuggerEngineType et = NoEngineType) const;
818
819
820
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
821

822
823
824
825
826
    BreakHandler *breakHandler() const { return m_breakHandler; }
    SnapshotHandler *snapshotHandler() const { return m_snapshotHandler; }

    void setConfigValue(const QString &name, const QVariant &value);
    QVariant configValue(const QString &name) const;
827

ck's avatar
ck committed
828
    DebuggerRunControl *createDebugger(const DebuggerStartParameters &sp,
hjk's avatar
hjk committed
829
830
        RunConfiguration *rc = 0);
    void startDebugger(RunControl *runControl);
831
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
832
833
834

    void dumpLog();
    void cleanupViews();
835
    void setInitialState();
836
837
838
839

    void fontSettingsChanged(const TextEditor::FontSettings &settings);

    void updateState(DebuggerEngine *engine);
840
    void updateWatchersWindow();
841
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
842
843
844
845

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
846

847
    void executeDebuggerCommand(const QString &command, DebuggerLanguages languages);
848
    bool evaluateScriptExpression(const QString &expression);
849
    void coreShutdown();
850

hjk's avatar
hjk committed
851
852
#ifdef WITH_TESTS
public slots:
853
    void testLoadProject(const QString &proFile, const TestCallBack &cb);
hjk's avatar
hjk committed
854
    void testProjectLoaded(ProjectExplorer::Project *project);
855
856
857
858
    void testUnloadProject();
    void testFinished();

    void testRunProject(const DebuggerStartParameters &sp, const TestCallBack &cb);
hjk's avatar
hjk committed
859
    void testRunControlFinished();
860
861
862
863
864
865
866
867
868

    void testPythonDumpers1();
    void testPythonDumpers2();
    void testPythonDumpers3();

    void testStateMachine1();
    void testStateMachine2();
    void testStateMachine3();

869
870
    void testBenchmark1();

871
872
873
874
public:
    bool m_testSuccess;
    QList<TestCallBack> m_testCallbacks;

hjk's avatar
hjk committed
875
876
#endif

hjk's avatar
hjk committed
877
public slots:
878
    void updateDebugActions();
879
880
881

    void handleExecDetach()
    {
882
        currentEngine()->resetLocation();
883
884
885
886
887
        currentEngine()->detachDebugger();
    }

    void handleExecContinue()
    {
888
        currentEngine()->resetLocation();
889
890
891
892
893
        currentEngine()->continueInferior();
    }

    void handleExecInterrupt()
    {
894
        currentEngine()->resetLocation();
895
896
897
        currentEngine()->requestInterruptInferior();
    }

898
    void handleAbort()
899
    {
900
        currentEngine()->resetLocation();
901
        currentEngine()->abortDebugger();
902
    }
hjk's avatar
hjk committed
903
904
905

    void handleExecStep()
    {
906
907
908
909
910
911
912
913
914
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeStepI();
            else
                currentEngine()->executeStep();
        }
hjk's avatar
hjk committed
915
916
917
918
    }

    void handleExecNext()
    {
919
920
921
922
923
924
925
926
927
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeNextI();
            else
                currentEngine()->executeNext();
        }
hjk's avatar
hjk committed
928
929
    }

930
931
    void handleExecStepOut()
    {
932
        currentEngine()->resetLocation();
933
934
935
936
937
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
938
        currentEngine()->resetLocation();
939
940
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
941
942
943
944

    void handleExecJumpToLine()
    {
        //removeTooltip();
945
        currentEngine()->resetLocation();
946
947
948
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeJumpToLine(data);
hjk's avatar
hjk committed
949
950
951
952
953
    }

    void handleExecRunToLine()
    {
        //removeTooltip();
954
        currentEngine()->resetLocation();
955
956
957
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeRunToLine(data);
hjk's avatar
hjk committed
958
959
    }

960
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
961
    {
962
963
964
965
966
967
968
969
970
971
        ITextEditor *textEditor = currentTextEditor();
        QTC_ASSERT(textEditor, return);
        QPlainTextEdit *ed = qobject_cast<QPlainTextEdit*>(textEditor->widget());
        if (!ed)
            return;
        QTextCursor cursor = ed->textCursor();
        QString functionName = cursor.selectedText();
        if (functionName.isEmpty()) {
            const QTextBlock block = cursor.block();
            const QString line = block.text();
972
            foreach (const QString &str, line.trimmed().split(QLatin1Char('('))) {
973
974
975
976
977
978
979
980
981
982
983
984
985
                QString a;
                for (int i = str.size(); --i >= 0; ) {
                    if (!str.at(i).isLetterOrNumber())
                        break;
                    a = str.at(i) + a;
                }
                if (!a.isEmpty()) {
                    functionName = a;
                    break;
                }
            }
        }

986
987
988
989
990
991
        if (functionName.isEmpty()) {
            showStatusMessage(tr("No function selected."));
        } else {
            showStatusMessage(tr("Running to function \"%1\".")
                .arg(functionName));
            currentEngine()->resetLocation();
992
            currentEngine()->executeRunToFunction(functionName);
993
        }
hjk's avatar
hjk committed
994
995
    }

996
997
998
999
    void slotEditBreakpoint()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
1000
        const BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
1001
        QTC_ASSERT(id > 0, return);
hjk's avatar
hjk committed
1002
        BreakTreeView::editBreakpoint(id, mainWindow());
1003
1004
1005
1006
    }

    void slotRunToLine()
    {
1007
1008
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
1009
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
1010
        currentEngine()->executeRunToLine(data);
1011
1012
1013
1014
    }

    void slotJumpToLine()
    {
1015
1016
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
1017
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
1018
        currentEngine()->executeJumpToLine(data);
1019
1020
    }

1021
1022
1023
1024
1025
1026
1027
1028
1029
    void slotDisassembleFunction()
    {
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
        const StackFrame frame = action->data().value<StackFrame>();
        QTC_ASSERT(!frame.function.isEmpty(), return);
        currentEngine()->openDisassemblerView(Location(frame));
    }

hjk's avatar
hjk committed
1030
1031
1032
    void handleAddToWatchWindow()
    {
        // Requires a selection, but that's the only case we want anyway.
hjk's avatar
hjk committed
1033
        IEditor *editor = EditorManager::currentEditor();
hjk's avatar
hjk committed
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
        if (!editor)
            return;
        ITextEditor *textEditor = qobject_cast<ITextEditor*>(editor);
        if (!textEditor)
            return;
        QTextCursor tc;
        QPlainTextEdit *ptEdit = qobject_cast<QPlainTextEdit*>(editor->widget());
        if (ptEdit)
            tc = ptEdit->textCursor();
        QString exp;
        if (tc.hasSelection()) {
            exp = tc.selectedText();
        } else {
            int line, column;
            exp = cppExpressionAt(textEditor, tc.position(), &line, &column);
        }
        if (exp.isEmpty())
            return;
        currentEngine()->watchHandler()->watchExpression(exp);
    }

    void handleExecExit()
    {
1057
        currentEngine()->exitDebugger();
hjk's avatar
hjk committed
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
    }

    void handleFrameDown()
    {
        currentEngine()->frameDown();
    }

    void handleFrameUp()
    {
        currentEngine()->frameUp();
    }

1070
    void handleOperateByInstructionTriggered(bool operateByInstructionTriggered)
hjk's avatar
hjk committed
1071
    {
1072
1073
1074
        // Go to source only if we have the file.
        if (currentEngine()->stackHandler()->currentIndex() >= 0) {
            const StackFrame frame = currentEngine()->stackHandler()->currentFrame();
1075
1076
1077
            if (operateByInstructionTriggered || frame.isUsable()) {
                currentEngine()->gotoLocation(Location(frame, true));
            }
1078
        }
hjk's avatar
hjk committed