debuggerplugin.cpp 132 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"
70
#include "gdb/startgdbserverdialog.h"
con's avatar
con committed
71

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

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

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

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

108
#include <qtsupport/qtsupportconstants.h>
109

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

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

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

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

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

146 147
#endif // WITH_TESTS

148 149
#include <climits>

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

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

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

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

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

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


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



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

377
\endcode */
378

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

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

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

namespace Debugger {
namespace Constants {

} // namespace Constants


395 396
namespace Internal {

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

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

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

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


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

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

427 428 429 430

namespace Debugger {
namespace Internal {

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

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

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

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

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

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

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

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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

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

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

514 515 516 517 518 519
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

542 543 544 545 546 547
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

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

    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
564 565
}

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

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

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

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

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

612
class DebuggerPluginPrivate : public DebuggerCore
613 614
{
    Q_OBJECT
615

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

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

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

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

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

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

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

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

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

    void breakpointDisableMarginActionTriggered()
    {
        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, false);
707 708
    }

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

715

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

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

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

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

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

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

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

772
    void debugProject();
773
    void debugProjectWithoutDeploy();
774
    void debugProjectBreakMain();
775
    void startExternalApplication();
776
    void startRemoteCdbSession();
777 778
    void startRemoteProcess();
    void startRemoteServer();
hjk's avatar
hjk committed
779
    //bool queryRemoteParameters(DebuggerStartParameters &sp, bool useScript);
780
    void attachToRemoteServer();
hjk's avatar
hjk committed
781
    void attachToRunningApplication();
782
    void attachToQmlPort();
783
    void startRemoteEngine();
784
    void attachExternalApplication();
hjk's avatar
hjk committed
785
    Q_SLOT void attachExternalApplication(ProjectExplorer::RunControl *rc);
786
    void runScheduled();
787
    void attachCore();
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);