debuggerplugin.cpp 138 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 "localsandexpressionswindow.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 388 389 390

namespace Debugger {
namespace Constants {

} // namespace Constants


391 392
namespace Internal {

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

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

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

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


417 418 419 420
} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::BreakpointMenuContextData)
421 422
Q_DECLARE_METATYPE(Debugger::Internal::TestCallBack)

423 424 425 426

namespace Debugger {
namespace Internal {

427 428 429 430 431 432
// 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.

433
void addCdbOptionPages(QList<IOptionsPage*> *opts);
434 435 436
void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
437

438 439 440 441
#ifdef WITH_LLDB
void addLldbOptionPages(QList<IOptionsPage*> *opts);
#endif

hjk's avatar
hjk committed
442
static SessionManager *sessionManager()
443
{
hjk's avatar
hjk committed
444
    return ProjectExplorerPlugin::instance()->session();
445 446
}

447 448 449 450 451 452 453
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

454
static Abi anyAbiOfBinary(const QString &fileName)
455
{
Tobias Hunger's avatar
Tobias Hunger committed
456
    QList<Abi> abis = Abi::abisOfBinary(Utils::FileName::fromString(fileName));
457 458 459 460
    if (abis.isEmpty())
        return Abi();
    return abis.at(0);
}
461 462 463 464 465 466 467 468 469 470 471 472

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
473
    DummyEngine() : DebuggerEngine(DebuggerStartParameters(), AnyLanguage) {}
474 475 476 477 478 479 480
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
481
    bool hasCapability(unsigned cap) const;
482
    bool acceptsBreakpoint(BreakpointModelId) const { return false; }
483
    bool acceptsDebuggerCommands() const { return false; }
484 485
};

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

    // This is a Qml or unknown engine.
505
    return cap & AddWatcherCapability;
506 507
}

508 509 510 511 512 513
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

hjk's avatar
hjk committed
528 529 530 531 532 533
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        //EditorManager::instance()->setParent(0);
        delete m_widget;
    }
534
};
hjk's avatar
hjk committed
535

536 537 538 539 540 541
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

542
static TextEditor::ITextEditor *currentTextEditor()
543
{
hjk's avatar
hjk committed
544
    return qobject_cast<TextEditor::ITextEditor *>(Core::EditorManager::currentEditor());
545
}
con's avatar
con committed
546

547 548
static bool currentTextEditorPosition(ContextData *data)
{
549 550 551
    TextEditor::ITextEditor *textEditor = currentTextEditor();
    if (!textEditor)
        return false;
552 553 554
    const Core::IDocument *document = textEditor->document();
    QTC_ASSERT(document, return false);
    data->fileName = document->fileName();
555 556 557 558 559 560 561
    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();
562
    }
563
    return true;
564
}
565

566 567
///////////////////////////////////////////////////////////////////////
//
568
// DebuggerPluginPrivate
569 570
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
571

572
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
573

574 575 576 577 578 579 580 581 582 583 584 585 586 587
/*!
    \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.
*/

588
class DebuggerPluginPrivate : public DebuggerCore
589 590
{
    Q_OBJECT
591

592 593
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
594
    ~DebuggerPluginPrivate();
595

596
    bool initialize(const QStringList &arguments, QString *errorMessage);
597 598 599
    void extensionsInitialized();
    void aboutToShutdown();

600
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
601
    void disconnectEngine() { connectEngine(0); }
602
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
603
    DebuggerEngine *dummyEngine();
604

605 606 607 608 609 610 611 612 613 614
    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);
    }

615
public slots:
616 617 618 619 620 621
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

622 623 624 625
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
626

hjk's avatar
hjk committed
627
    void breakpointSetMarginActionTriggered()
628
    {
629 630
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
hjk's avatar
hjk committed
631 632
        const BreakpointMenuContextData data =
            action->data().value<BreakpointMenuContextData>();
633 634 635 636 637 638 639 640 641 642 643 644 645
        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
646
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
647 648 649 650 651 652 653 654
            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();
        }
655
        if (data.address)
656
            toggleBreakpointByAddress(data.address, message);
657
        else
658
            toggleBreakpointByFileAndLine(data.fileName, data.lineNumber, message);
659
    }
660

hjk's avatar
hjk committed
661
    void breakpointRemoveMarginActionTriggered()
662
    {
hjk's avatar
hjk committed
663 664
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
665
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
666
        m_breakHandler->removeBreakpoint(id);
hjk's avatar
hjk committed
667 668 669 670 671 672
     }

    void breakpointEnableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
673
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
674
        breakHandler()->setEnabled(id, true);
hjk's avatar
hjk committed
675 676 677 678 679 680
    }

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

685
    void updateWatchersHeader(int section, int, int newSize)
686 687
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
688
        m_returnWindow->header()->resizeSection(section, newSize);
689
    }
690

691

692
    void sourceFilesDockToggled(bool on)
693
    {
694
        if (on && m_currentEngine->state() == InferiorStopOk)
695 696 697
            m_currentEngine->reloadSourceFiles();
    }

698
    void modulesDockToggled(bool on)
699
    {
700
        if (on && m_currentEngine->state() == InferiorStopOk)
701 702
            m_currentEngine->reloadModules();
    }
703

hjk's avatar
hjk committed
704
    void registerDockToggled(bool on)
705
    {
706
        if (on && m_currentEngine->state() == InferiorStopOk)
707 708
            m_currentEngine->reloadRegisters();
    }
709

710 711
    void synchronizeBreakpoints()
    {
712
        showMessage(QLatin1String("ATTEMPT SYNC"), LogDebug);
713
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
714
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
715 716 717 718
                engine->attemptBreakpointSynchronization();
        }
    }

hjk's avatar
hjk committed
719 720 721
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
722
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
723
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
724 725 726
        }
    }

727
    void editorOpened(Core::IEditor *editor);
728
    void updateBreakMenuItem(Core::IEditor *editor);
729
    void setBusyCursor(bool busy);
730 731 732
    void requestMark(TextEditor::ITextEditor *editor,
                     int lineNumber,
                     TextEditor::ITextEditor::MarkRequestKind kind);
733 734
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
735

736 737 738
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
739 740 741 742
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
743
    void onModeChanged(Core::IMode *mode);
744
    void onCoreAboutToOpen();
745
    void showSettingsDialog();
746
    void updateDebugWithoutDeployMenu();
747

748
    void debugProject();
749
    void debugProjectWithoutDeploy();
750
    void debugProjectBreakMain();
751
    void startExternalApplication();
752
    void startRemoteCdbSession();
753 754
    void startRemoteProcess();
    void startRemoteServer();
755
    bool queryRemoteParameters(DebuggerStartParameters &sp, bool useScript);
756
    void attachToRemoteServer();
757
    void attachToRemoteProcess();
758
    void attachToQmlPort();
759
    void startRemoteEngine();
760
    void attachExternalApplication();
Robert Loehning's avatar
Robert Loehning committed
761
    Q_SLOT void attachExternalApplication(ProjectExplorer::RunControl*rc);
762
    void runScheduled();
763
    void attachCore();
764
    void attachToRemoteServer(const QString &spec);
765

766
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
767
    void languagesChanged();
768
    void showStatusMessage(const QString &msg, int timeout = -1);
769
    void openMemoryEditor();
770

771 772 773
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

    void showQtDumperLibraryWarning(const QString &details);
hjk's avatar
hjk committed
774
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
775
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
776
        { return mainWindow()->isDockVisible(objectName); }
777 778

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

781 782
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
783
    DebuggerLanguages activeLanguages() const;
784 785
    unsigned enabledEngines() const { return m_cmdLineEnabledEngines; }
    QString debuggerForAbi(const Abi &abi, DebuggerEngineType et = NoEngineType) const;
786 787 788
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
789

790 791 792 793 794
    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;
795

ck's avatar
ck committed
796
    DebuggerRunControl *createDebugger(const DebuggerStartParameters &sp,
hjk's avatar
hjk committed
797 798
        RunConfiguration *rc = 0);
    void startDebugger(RunControl *runControl);
799
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
800 801 802

    void dumpLog();
    void cleanupViews();
803
    void setInitialState();
804 805 806 807

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

    void updateState(DebuggerEngine *engine);
808
    void updateWatchersWindow();
809
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
810 811 812 813

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
814

815
    void executeDebuggerCommand(const QString &command, DebuggerLanguages languages);
816
    bool evaluateScriptExpression(const QString &expression);
817
    void coreShutdown();
818

hjk's avatar
hjk committed
819 820
#ifdef WITH_TESTS
public slots:
821
    void testLoadProject(const QString &proFile, const TestCallBack &cb);
hjk's avatar
hjk committed
822
    void testProjectLoaded(ProjectExplorer::Project *project);
823 824 825 826
    void testUnloadProject();
    void testFinished();

    void testRunProject(const DebuggerStartParameters &sp, const TestCallBack &cb);
hjk's avatar
hjk committed
827
    void testRunControlFinished();
828 829 830 831 832 833 834 835 836

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

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

837 838
    void testBenchmark1();

839 840 841 842
public:
    bool m_testSuccess;
    QList<TestCallBack> m_testCallbacks;

hjk's avatar
hjk committed
843 844
#endif

hjk's avatar
hjk committed
845
public slots:
846
    void updateDebugActions();
847 848 849

    void handleExecDetach()
    {
850
        currentEngine()->resetLocation();
851 852 853 854 855
        currentEngine()->detachDebugger();
    }

    void handleExecContinue()
    {
856
        currentEngine()->resetLocation();
857 858 859 860 861
        currentEngine()->continueInferior();
    }

    void handleExecInterrupt()
    {
862
        currentEngine()->resetLocation();
863 864 865
        currentEngine()->requestInterruptInferior();
    }

866
    void handleAbort()
867
    {
868
        currentEngine()->resetLocation();
869
        currentEngine()->abortDebugger();
870
    }
hjk's avatar
hjk committed
871 872 873

    void handleExecStep()
    {
874 875 876 877 878 879 880 881 882
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeStepI();
            else
                currentEngine()->executeStep();
        }
hjk's avatar
hjk committed
883 884 885 886
    }

    void handleExecNext()
    {
887 888 889 890 891 892 893 894 895
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeNextI();
            else
                currentEngine()->executeNext();
        }
hjk's avatar
hjk committed
896 897
    }

898 899
    void handleExecStepOut()
    {
900
        currentEngine()->resetLocation();
901 902 903 904 905
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
906
        currentEngine()->resetLocation();
907 908
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
909 910 911 912

    void handleExecJumpToLine()
    {
        //removeTooltip();
913
        currentEngine()->resetLocation();
914 915 916
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeJumpToLine(data);
hjk's avatar
hjk committed
917 918 919 920 921
    }

    void handleExecRunToLine()
    {
        //removeTooltip();
922
        currentEngine()->resetLocation();
923 924 925
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeRunToLine(data);
hjk's avatar
hjk committed
926 927
    }

928
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
929
    {
930 931 932 933 934 935 936 937 938 939
        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();
940
            foreach (const QString &str, line.trimmed().split(QLatin1Char('('))) {
941 942 943 944 945 946 947 948 949 950 951 952 953
                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;
                }
            }
        }

954 955 956 957 958 959
        if (functionName.isEmpty()) {
            showStatusMessage(tr("No function selected."));
        } else {
            showStatusMessage(tr("Running to function \"%1\".")
                .arg(functionName));
            currentEngine()->resetLocation();
960
            currentEngine()->executeRunToFunction(functionName);
961
        }
hjk's avatar
hjk committed
962 963
    }

964 965 966 967
    void slotEditBreakpoint()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
968
        const BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
969
        QTC_ASSERT(id > 0, return);
hjk's avatar
hjk committed
970
        BreakTreeView::editBreakpoint(id, mainWindow());
971 972 973 974
    }

    void slotRunToLine()
    {
975 976
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
977
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
978
        currentEngine()->executeRunToLine(data);
979 980 981 982
    }

    void slotJumpToLine()
    {
983 984
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
985
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
986
        currentEngine()->executeJumpToLine(data);
987 988
    }

989 990 991 992 993 994 995 996 997
    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
998 999 1000
    void handleAddToWatchWindow()
    {
        // Requires a selection, but that's the only case we want anyway.
hjk's avatar
hjk committed
1001
        IEditor *editor = EditorManager::currentEditor();
hjk's avatar
hjk committed
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
        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