debuggerplugin.cpp 136 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
**
Eike Ziller's avatar
Eike Ziller committed
7
** Contact: http://www.qt-project.org/
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
**
29
**************************************************************************/
hjk's avatar
hjk committed
30

con's avatar
con committed
31
32
#include "debuggerplugin.h"

Friedemann Kleint's avatar
Friedemann Kleint committed
33
#include "debuggerstartparameters.h"
34
#include "debuggeractions.h"
con's avatar
con committed
35
#include "debuggerconstants.h"
36
#include "debuggerinternalconstants.h"
37
#include "debuggercore.h"
38
39
#include "debuggerdialogs.h"
#include "debuggerengine.h"
40
#include "debuggermainwindow.h"
con's avatar
con committed
41
#include "debuggerrunner.h"
42
#include "debuggerruncontrolfactory.h"
43
#include "debuggerstringutils.h"
Tobias Hunger's avatar
Tobias Hunger committed
44
#include "debuggerprofileinformation.h"
45
#include "memoryagent.h"
46
47
#include "breakpoint.h"
#include "breakhandler.h"
48
#include "breakwindow.h"
49
#include "qtmessagelogwindow.h"
50
#include "disassemblerlines.h"
51
#include "logwindow.h"
52
#include "moduleswindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
53
#include "moduleshandler.h"
54
55
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
56
#include "stackhandler.h"
57
58
59
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
60
#include "watchhandler.h"
61
#include "watchwindow.h"
hjk's avatar
hjk committed
62
#include "watchutils.h"
63
#include "debuggertooltipmanager.h"
64
#include "localsandexpressionswindow.h"
65
#include "loadcoredialog.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>
Tobias Hunger's avatar
Tobias Hunger committed
101
102
#include <projectexplorer/profileinformation.h>
#include <projectexplorer/profilemanager.h>
103
#include <projectexplorer/target.h>
104
105
#include <projectexplorer/toolchain.h>
#include <projectexplorer/toolchainmanager.h>
hjk's avatar
hjk committed
106

107
#include <qtsupport/qtsupportconstants.h>
108

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

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

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

hjk's avatar
hjk committed
135
#ifdef WITH_TESTS
136
137
138
#include <QTest>
#include <QSignalSpy>
#include <QTestEventLoop>
139
140
141
142

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

145
146
#endif // WITH_TESTS

147
148
#include <climits>

149
150
151
152
153
154
155
156
157
158
#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

159
160
161
162
163
164
165
166
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
167
    \internal
168
169
170
171
172
173
174
175
*/

/*!
    \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
176
    gdbserver, the CODA client etc are referred to as 'Engine',
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
291
292
293
    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
294

295
296
297
/* 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
298

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


339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
/*!
    \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}
361
362
363



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

376
\endcode */
377

con's avatar
con committed
378
using namespace Core;
hjk's avatar
hjk committed
379
using namespace Debugger::Constants;
con's avatar
con committed
380
using namespace ProjectExplorer;
hjk's avatar
hjk committed
381
using namespace TextEditor;
382
using namespace ExtensionSystem;
con's avatar
con committed
383

hjk's avatar
hjk committed
384
385
386
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
387
388
389
390
391
392
393

namespace Debugger {
namespace Constants {

} // namespace Constants


394
395
namespace Internal {

396
397
398
399
400
401
402
403
404
405
406
407
408
// To be passed through margin menu action's data
struct BreakpointMenuContextData : public ContextData
{
    enum Mode
    {
        Breakpoint,
        MessageTracePoint
    };

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

409
410
411
412
413
414
415
416
417
418
419
struct TestCallBack
{
    TestCallBack() : receiver(0), slot(0) {}
    TestCallBack(QObject *ob, const char *s) : receiver(ob), slot(s) {}

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


420
421
422
423
} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::BreakpointMenuContextData)
424
425
Q_DECLARE_METATYPE(Debugger::Internal::TestCallBack)

426
427
428
429

namespace Debugger {
namespace Internal {

430
431
432
433
434
435
// 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.

436
void addCdbOptionPages(QList<IOptionsPage*> *opts);
437
438
439
void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
440

441
442
443
444
#ifdef WITH_LLDB
void addLldbOptionPages(QList<IOptionsPage*> *opts);
#endif

hjk's avatar
hjk committed
445
static SessionManager *sessionManager()
446
{
hjk's avatar
hjk committed
447
    return ProjectExplorerPlugin::instance()->session();
448
449
}

450
451
452
453
454
455
456
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

457
458
static void setProxyAction(Utils::ProxyAction *proxy, const char *id)
{
hjk's avatar
hjk committed
459
    proxy->setAction(ActionManager::command(id)->action());
460
461
462
463
}

static QToolButton *toolButton(const char *id)
{
hjk's avatar
hjk committed
464
    return toolButton(ActionManager::command(id)->action());
465
466
}

467
468
469
470
471
472
473
474
475
476
477
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
478
    DummyEngine() : DebuggerEngine(DebuggerStartParameters(), AnyLanguage) {}
479
480
481
482
483
484
485
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
486
    bool hasCapability(unsigned cap) const;
487
    bool acceptsBreakpoint(BreakpointModelId) const { return false; }
488
    bool acceptsDebuggerCommands() const { return false; }
489
490
};

491
bool DummyEngine::hasCapability(unsigned cap) const
492
493
{
    // This can only be a first approximation of what to expect when running.
494
    Project *project = ProjectExplorerPlugin::currentProject();
495
496
497
498
499
500
501
502
    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:
503
    if (activeRc->debuggerAspect()->useCppDebugger())
504
        return cap & (WatchpointByAddressCapability
505
506
               | BreakConditionCapability
               | TracePointCapability
507
               | OperateByInstructionCapability);
508
509

    // This is a Qml or unknown engine.
510
    return cap & AddWatcherCapability;
511
512
}

513
514
515
516
517
518
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

519
class DebugMode : public IMode
hjk's avatar
hjk committed
520
521
{
public:
522
523
524
525
    DebugMode()
    {
        setObjectName(QLatin1String("DebugMode"));
        setContext(Context(CC::C_EDITORMANAGER, C_DEBUGMODE, CC::C_NAVIGATION_PANE));
526
527
        setDisplayName(DebuggerPlugin::tr("Debug"));
        setIcon(QIcon(QLatin1String(":/fancyactionbar/images/mode_Debug.png")));
528
        setPriority(85);
529
530
        setId(MODE_DEBUG);
        setType(CC::MODE_EDIT_TYPE);
531
    }
hjk's avatar
hjk committed
532

hjk's avatar
hjk committed
533
534
535
536
537
538
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        //EditorManager::instance()->setParent(0);
        delete m_widget;
    }
539
};
hjk's avatar
hjk committed
540

541
542
543
544
545
546
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
547
void fillParameters(DebuggerStartParameters *sp, Id id)
hjk's avatar
hjk committed
548
549
550
551
552
{
    Profile *profile = ProfileManager::instance()->find(id);
    QTC_ASSERT(profile, return);
    sp->sysRoot = SysRootProfileInformation::sysRoot(profile).toString();
    sp->debuggerCommand = DebuggerProfileInformation::debuggerCommand(profile).toString();
553

hjk's avatar
hjk committed
554
555
556
    ToolChain *tc = ToolChainProfileInformation::toolChain(profile);
    if (tc)
        sp->toolChainAbi = tc->targetAbi();
557
558
559
560
561
562

    IDevice::ConstPtr device = DeviceProfileInformation::device(profile);
    if (device) {
        sp->connParams = device->sshParameters();
        sp->remoteChannel = QString("%1:%2").arg(sp->connParams.host).arg(sp->connParams.port);
    }
hjk's avatar
hjk committed
563
564
}

565
static TextEditor::ITextEditor *currentTextEditor()
566
{
hjk's avatar
hjk committed
567
    return qobject_cast<TextEditor::ITextEditor *>(EditorManager::currentEditor());
568
}
con's avatar
con committed
569

570
571
static bool currentTextEditorPosition(ContextData *data)
{
572
573
574
    TextEditor::ITextEditor *textEditor = currentTextEditor();
    if (!textEditor)
        return false;
hjk's avatar
hjk committed
575
    const IDocument *document = textEditor->document();
576
577
    QTC_ASSERT(document, return false);
    data->fileName = document->fileName();
578
579
580
581
582
583
584
    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();
585
    }
586
    return true;
587
}
588

589
590
///////////////////////////////////////////////////////////////////////
//
591
// DebuggerPluginPrivate
592
593
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
594

595
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
596

597
598
599
600
601
602
603
604
605
606
607
608
609
610
/*!
    \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.
*/

611
class DebuggerPluginPrivate : public DebuggerCore
612
613
{
    Q_OBJECT
614

615
616
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
617
    ~DebuggerPluginPrivate();
618

619
    bool initialize(const QStringList &arguments, QString *errorMessage);
620
621
622
    void extensionsInitialized();
    void aboutToShutdown();

623
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
624
    void disconnectEngine() { connectEngine(0); }
625
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
626
    DebuggerEngine *dummyEngine();
627

628
629
630
631
632
633
634
635
636
637
    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);
    }

638
public slots:
639
640
641
642
643
644
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

645
646
647
648
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
649

hjk's avatar
hjk committed
650
    void breakpointSetMarginActionTriggered()
651
    {
652
653
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
hjk's avatar
hjk committed
654
655
        const BreakpointMenuContextData data =
            action->data().value<BreakpointMenuContextData>();
656
657
658
659
660
661
662
663
664
665
666
667
668
        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
669
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
670
671
672
673
674
675
676
677
            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();
        }
678
        if (data.address)
679
            toggleBreakpointByAddress(data.address, message);
680
        else
681
            toggleBreakpointByFileAndLine(data.fileName, data.lineNumber, message);
682
    }
683

hjk's avatar
hjk committed
684
    void breakpointRemoveMarginActionTriggered()
685
    {
hjk's avatar
hjk committed
686
687
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
688
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
689
        m_breakHandler->removeBreakpoint(id);
hjk's avatar
hjk committed
690
691
692
693
694
695
     }

    void breakpointEnableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
696
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
697
        breakHandler()->setEnabled(id, true);
hjk's avatar
hjk committed
698
699
700
701
702
703
    }

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

708
    void updateWatchersHeader(int section, int, int newSize)
709
710
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
711
        m_returnWindow->header()->resizeSection(section, newSize);
712
    }
713

714

715
    void sourceFilesDockToggled(bool on)
716
    {
717
        if (on && m_currentEngine->state() == InferiorStopOk)
718
719
720
            m_currentEngine->reloadSourceFiles();
    }

721
    void modulesDockToggled(bool on)
722
    {
723
        if (on && m_currentEngine->state() == InferiorStopOk)
724
725
            m_currentEngine->reloadModules();
    }
726

hjk's avatar
hjk committed
727
    void registerDockToggled(bool on)
728
    {
729
        if (on && m_currentEngine->state() == InferiorStopOk)
730
731
            m_currentEngine->reloadRegisters();
    }
732

733
734
    void synchronizeBreakpoints()
    {
735
        showMessage(QLatin1String("ATTEMPT SYNC"), LogDebug);
736
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
737
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
738
739
740
741
                engine->attemptBreakpointSynchronization();
        }
    }

hjk's avatar
hjk committed
742
743
744
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
745
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
746
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
747
748
749
        }
    }

750
    void editorOpened(Core::IEditor *editor);
751
    void updateBreakMenuItem(Core::IEditor *editor);
752
    void setBusyCursor(bool busy);
753
754
755
    void requestMark(TextEditor::ITextEditor *editor,
                     int lineNumber,
                     TextEditor::ITextEditor::MarkRequestKind kind);
756
757
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
758

759
760
761
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
762
763
764
765
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
766
    void onModeChanged(Core::IMode *mode);
767
    void onCoreAboutToOpen();
768
    void showSettingsDialog();
769
    void updateDebugWithoutDeployMenu();
770

771
    void debugProject();
772
    void debugProjectWithoutDeploy();
773
    void debugProjectBreakMain();
774
    void startExternalApplication();
775
    void startRemoteCdbSession();
776
777
    void startRemoteProcess();
    void startRemoteServer();
hjk's avatar
hjk committed
778
    //bool queryRemoteParameters(DebuggerStartParameters &sp, bool useScript);
779
    void attachToRemoteServer();
780
    void attachToRemoteProcess();
781
    void attachToQmlPort();
782
    void startRemoteEngine();
783
    void attachExternalApplication();
hjk's avatar
hjk committed
784
    Q_SLOT void attachExternalApplication(ProjectExplorer::RunControl *rc);
785
    void runScheduled();
786
    void attachCore();
787
    void attachToRemoteServer(const QString &spec);
788

789
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
790
    void languagesChanged();
791
    void showStatusMessage(const QString &msg, int timeout = -1);
792
    void openMemoryEditor();
793

794
795
796
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

    void showQtDumperLibraryWarning(const QString &details);
hjk's avatar
hjk committed
797
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
798
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
799
        { return mainWindow()->isDockVisible(objectName); }
800
801

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

804
805
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
806
    DebuggerLanguages activeLanguages() const;
807
    unsigned enabledEngines() const { return m_cmdLineEnabledEngines; }
hjk's avatar
hjk committed
808
//    QString debuggerForAbi(const Abi &abi, DebuggerEngineType et = NoEngineType) const;
809
810
811
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
812

813
814
815
816
817
    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;
818

ck's avatar
ck committed
819
    DebuggerRunControl *createDebugger(const DebuggerStartParameters &sp,
hjk's avatar
hjk committed
820
821
        RunConfiguration *rc = 0);
    void startDebugger(RunControl *runControl);
822
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
823
824
825

    void dumpLog();
    void cleanupViews();
826
    void setInitialState();
827
828
829
830

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

    void updateState(DebuggerEngine *engine);
hjk's avatar
hjk committed
831
    void updateWatchersWindow(bool showWatch, bool showReturn);
832
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
833
834
835
836

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
837

838
    void executeDebuggerCommand(const QString &command, DebuggerLanguages languages);
839
    bool evaluateScriptExpression(const QString &expression);
840
    void coreShutdown();
841

hjk's avatar
hjk committed
842
843
#ifdef WITH_TESTS
public slots:
844
    void testLoadProject(const QString &proFile, const TestCallBack &cb);
hjk's avatar
hjk committed
845
    void testProjectLoaded(ProjectExplorer::Project *project);
846
847
848
849
    void testUnloadProject();
    void testFinished();

    void testRunProject(const DebuggerStartParameters &sp, const TestCallBack &cb);
hjk's avatar
hjk committed
850
    void testRunControlFinished();
851
852
853
854
855
856
857
858
859

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

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

860
861
    void testBenchmark1();

862
863
864
865
public:
    bool m_testSuccess;
    QList<TestCallBack> m_testCallbacks;

hjk's avatar
hjk committed
866
867
#endif

hjk's avatar
hjk committed
868
public slots:
869
    void updateDebugActions();
870
871
872

    void handleExecDetach()
    {
873
        currentEngine()->resetLocation();
874
875
876
877
878
        currentEngine()->detachDebugger();
    }

    void handleExecContinue()
    {
879
        currentEngine()->resetLocation();
880
881
882
883
884
        currentEngine()->continueInferior();
    }

    void handleExecInterrupt()
    {
885
        currentEngine()->resetLocation();
886
887
888
        currentEngine()->requestInterruptInferior();
    }

889
    void handleAbort()
890
    {
891
        currentEngine()->resetLocation();
892
        currentEngine()->abortDebugger();
893
    }
hjk's avatar
hjk committed
894
895
896

    void handleExecStep()
    {
897
898
899
900
901
902
903
904
905
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeStepI();
            else
                currentEngine()->executeStep();
        }
hjk's avatar
hjk committed
906
907
908
909
    }

    void handleExecNext()
    {
910
911
912
913
914
915
916
917
918
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeNextI();
            else
                currentEngine()->executeNext();
        }
hjk's avatar
hjk committed
919
920
    }

921
922
    void handleExecStepOut()
    {
923
        currentEngine()->resetLocation();
924
925
926
927
928
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
929
        currentEngine()->resetLocation();
930
931
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
932
933
934
935

    void handleExecJumpToLine()
    {
        //removeTooltip();
936
        currentEngine()->resetLocation();
937
938
939
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeJumpToLine(data);
hjk's avatar
hjk committed
940
941
942
943
944
    }

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

951
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
952
    {
953
954
955
956
957
958
959
960
961
962
        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();
963
            foreach (const QString &str, line.trimmed().split(QLatin1Char('('))) {
964
965
966
967
968
969
970
971
972
973
974
975
976
                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;
                }
            }
        }

977
978
979
980
981
982
        if (functionName.isEmpty()) {
            showStatusMessage(tr("No function selected."));
        } else {
            showStatusMessage(tr("Running to function \"%1\".")
                .arg(functionName));
            currentEngine()->resetLocation();
983
            currentEngine()->executeRunToFunction(functionName);
984
        }
hjk's avatar
hjk committed
985
986
    }

987
988
989
990
    void slotEditBreakpoint()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
991
        const BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
992
        QTC_ASSERT(id > 0, return);
hjk's avatar
hjk committed
993
        BreakTreeView::editBreakpoint(id, mainWindow());
994
995
996
997
    }

    void slotRunToLine()
    {
998
999
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
1000
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
1001
        currentEngine()->executeRunToLine(data);
1002
1003
1004
1005
    }

    void slotJumpToLine()
    {
1006
1007
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
1008
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
1009
        currentEngine()->executeJumpToLine(data);
1010
1011
    }

1012
1013
1014
1015
1016
1017
1018
1019
1020
    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
1021
1022
1023
    void handleAddToWatchWindow()
    {
        // Requires a selection, but that's the only case we want anyway.
hjk's avatar
hjk committed
1024
        IEditor *editor = EditorManager::currentEditor();
hjk's avatar
hjk committed
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
        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()
    {
1048
        currentEngine()->exitDebugger();
hjk's avatar
hjk committed
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
    }

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

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

1061
    void handleOperateByInstructionTriggered(bool operateByInstructionTriggered)