debuggerplugin.cpp 137 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"
Tobias Hunger's avatar
Tobias Hunger committed
46
#include "debuggerprofileinformation.h"
47
#include "memoryagent.h"
48 49
#include "breakpoint.h"
#include "breakhandler.h"
50
#include "breakwindow.h"
51
#include "qtmessagelogwindow.h"
52
#include "disassemblerlines.h"
53
#include "logwindow.h"
54
#include "moduleswindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
55
#include "moduleshandler.h"
56 57
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
58
#include "stackhandler.h"
59 60 61
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
62
#include "watchhandler.h"
63
#include "watchwindow.h"
hjk's avatar
hjk committed
64
#include "watchutils.h"
65
#include "debuggertooltipmanager.h"
66
#include "localsandexpressionswindow.h"
hjk's avatar
hjk committed
67
#include "loadremotecoredialog.h"
68

69 70
#include "snapshothandler.h"
#include "threadshandler.h"
71
#include "commonoptionspage.h"
con's avatar
con committed
72

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

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

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

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

109
#include <qtsupport/qtsupportconstants.h>
110

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

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

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

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

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

147 148
#endif // WITH_TESTS

149 150
#include <climits>

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

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

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

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

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

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


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



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

378
\endcode */
379

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

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

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

namespace Debugger {
namespace Constants {

} // namespace Constants


396 397
namespace Internal {

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

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

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

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


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

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

428 429 430 431

namespace Debugger {
namespace Internal {

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

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

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

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

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

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

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

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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

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

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

515 516 517 518 519 520
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

543 544 545 546 547 548
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
549 550 551 552 553 554 555 556 557 558 559
void fillParameters(DebuggerStartParameters *sp, Core::Id id)
{
    Profile *profile = ProfileManager::instance()->find(id);
    QTC_ASSERT(profile, return);
    sp->sysRoot = SysRootProfileInformation::sysRoot(profile).toString();
    sp->debuggerCommand = DebuggerProfileInformation::debuggerCommand(profile).toString();
    ToolChain *tc = ToolChainProfileInformation::toolChain(profile);
    if (tc)
        sp->toolChainAbi = tc->targetAbi();
}

560
static TextEditor::ITextEditor *currentTextEditor()
561
{
hjk's avatar
hjk committed
562
    return qobject_cast<TextEditor::ITextEditor *>(Core::EditorManager::currentEditor());
563
}
con's avatar
con committed
564

565 566
static bool currentTextEditorPosition(ContextData *data)
{
567 568 569
    TextEditor::ITextEditor *textEditor = currentTextEditor();
    if (!textEditor)
        return false;
570 571 572
    const Core::IDocument *document = textEditor->document();
    QTC_ASSERT(document, return false);
    data->fileName = document->fileName();
573 574 575 576 577 578 579
    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();
580
    }
581
    return true;
582
}
583

584 585
///////////////////////////////////////////////////////////////////////
//
586
// DebuggerPluginPrivate
587 588
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
589

590
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
591

592 593 594 595 596 597 598 599 600 601 602 603 604 605
/*!
    \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.
*/

606
class DebuggerPluginPrivate : public DebuggerCore
607 608
{
    Q_OBJECT
609

610 611
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
612
    ~DebuggerPluginPrivate();
613

614
    bool initialize(const QStringList &arguments, QString *errorMessage);
615 616 617
    void extensionsInitialized();
    void aboutToShutdown();

618
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
619
    void disconnectEngine() { connectEngine(0); }
620
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
621
    DebuggerEngine *dummyEngine();
622

623 624 625 626 627 628 629 630 631 632
    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);
    }

633
public slots:
634 635 636 637 638 639
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

640 641 642 643
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
644

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

hjk's avatar
hjk committed
679
    void breakpointRemoveMarginActionTriggered()
680
    {
hjk's avatar
hjk committed
681 682
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
683
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
684
        m_breakHandler->removeBreakpoint(id);
hjk's avatar
hjk committed
685 686 687 688 689 690
     }

    void breakpointEnableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
691
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
692
        breakHandler()->setEnabled(id, true);
hjk's avatar
hjk committed
693 694 695 696 697 698
    }

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

703
    void updateWatchersHeader(int section, int, int newSize)
704 705
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
706
        m_returnWindow->header()->resizeSection(section, newSize);
707
    }
708

709

710
    void sourceFilesDockToggled(bool on)
711
    {
712
        if (on && m_currentEngine->state() == InferiorStopOk)
713 714 715
            m_currentEngine->reloadSourceFiles();
    }

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

hjk's avatar
hjk committed
722
    void registerDockToggled(bool on)
723
    {
724
        if (on && m_currentEngine->state() == InferiorStopOk)
725 726
            m_currentEngine->reloadRegisters();
    }
727

728 729
    void synchronizeBreakpoints()
    {
730
        showMessage(QLatin1String("ATTEMPT SYNC"), LogDebug);
731
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
732
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
733 734 735 736
                engine->attemptBreakpointSynchronization();
        }
    }

hjk's avatar
hjk committed
737 738 739
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
740
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
741
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
742 743 744
        }
    }

745
    void editorOpened(Core::IEditor *editor);
746
    void updateBreakMenuItem(Core::IEditor *editor);
747
    void setBusyCursor(bool busy);
748 749 750
    void requestMark(TextEditor::ITextEditor *editor,
                     int lineNumber,
                     TextEditor::ITextEditor::MarkRequestKind kind);
751 752
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
753

754 755 756
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
757 758 759 760
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
761
    void onModeChanged(Core::IMode *mode);
762
    void onCoreAboutToOpen();
763
    void showSettingsDialog();
764
    void updateDebugWithoutDeployMenu();
765

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

785
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
786
    void languagesChanged();
787
    void showStatusMessage(const QString &msg, int timeout = -1);
788
    void openMemoryEditor();
789

790 791 792
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

    void showQtDumperLibraryWarning(const QString &details);
hjk's avatar
hjk committed
793
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
794
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
795
        { return mainWindow()->isDockVisible(objectName); }
796 797

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

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

    bool isReverseDebugging() const;
808

809 810 811 812 813
    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;
814

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

    void dumpLog();
    void cleanupViews();
822
    void setInitialState();
823 824 825 826

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

    void updateState(DebuggerEngine *engine);
hjk's avatar
hjk committed
827
    void updateWatchersWindow(bool showWatch, bool showReturn);
828
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
829 830 831 832

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
833

834
    void executeDebuggerCommand(const QString &command, DebuggerLanguages languages);
835
    bool evaluateScriptExpression(const QString &expression);
836
    void coreShutdown();
837

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

    void testRunProject(const DebuggerStartParameters &sp, const TestCallBack &cb);
hjk's avatar
hjk committed
846
    void testRunControlFinished();
847 848 849 850 851 852 853 854 855

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

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

856 857
    void testBenchmark1();

858 859 860 861
public:
    bool m_testSuccess;
    QList<TestCallBack> m_testCallbacks;

hjk's avatar
hjk committed
862 863
#endif

hjk's avatar
hjk committed
864
public slots:
865
    void updateDebugActions();
866 867 868

    void handleExecDetach()
    {
869
        currentEngine()->resetLocation();
870 871 872 873 874
        currentEngine()->detachDebugger();
    }

    void handleExecContinue()
    {
875
        currentEngine()->resetLocation();
876 877 878 879 880
        currentEngine()->continueInferior();
    }

    void handleExecInterrupt()
    {
881
        currentEngine()->resetLocation();
882 883 884
        currentEngine()->requestInterruptInferior();
    }

885
    void handleAbort()
886
    {
887
        currentEngine()->resetLocation();
888
        currentEngine()->abortDebugger();
889
    }
hjk's avatar
hjk committed
890 891 892

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

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

917 918
    void handleExecStepOut()
    {
919
        currentEngine()->resetLocation();
920 921 922 923 924
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
925
        currentEngine()->resetLocation();
926 927
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
928 929 930 931

    void handleExecJumpToLine()
    {
        //removeTooltip();
932
        currentEngine()->resetLocation();
933 934 935
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeJumpToLine(data);
hjk's avatar
hjk committed
936 937 938 939 940
    }

    void handleExecRunToLine()
    {
        //removeTooltip();
941
        currentEngine()->resetLocation();
942 943 944
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeRunToLine(data);
hjk's avatar
hjk committed
945 946
    }

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

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

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

    void slotRunToLine()
    {
994 995
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
996
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
997
        currentEngine()->executeRunToLine(data);