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

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

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

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

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

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

104
#include <qtsupport/qtsupportconstants.h>
105

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

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

117 118 119 120 121 122 123 124 125 126 127 128 129
#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
130

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

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

141 142
#endif // WITH_TESTS

143 144
#include <climits>

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

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

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

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

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

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


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



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

372
\endcode */
373

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

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

con's avatar
con committed
383 384 385 386

namespace Debugger {
namespace Constants {

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

} // namespace Constants


422 423
namespace Internal {

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

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

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

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


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

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

454 455 456 457

namespace Debugger {
namespace Internal {

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

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

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

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

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

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

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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

517
bool DummyEngine::hasCapability(unsigned cap) const
518 519
{
    // This can only be a first approximation of what to expect when running.
520
    Project *project = ProjectExplorerPlugin::currentProject();
521 522 523 524 525 526 527 528
    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:
529
    if (activeRc->debuggerAspect()->useCppDebugger())
530
        return cap & (WatchpointByAddressCapability
531 532
               | BreakConditionCapability
               | TracePointCapability
533
               | OperateByInstructionCapability);
534 535

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

539 540 541 542 543 544
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

567 568 569 570 571 572
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

573
static TextEditor::ITextEditor *currentTextEditor()
574
{
575 576 577 578 579
    if (const Core::EditorManager *editorManager = Core::EditorManager::instance())
            if (Core::IEditor *editor = editorManager->currentEditor())
                return qobject_cast<TextEditor::ITextEditor*>(editor);
    return 0;
}
con's avatar
con committed
580

581 582
static bool currentTextEditorPosition(ContextData *data)
{
583 584 585
    TextEditor::ITextEditor *textEditor = currentTextEditor();
    if (!textEditor)
        return false;
586 587 588
    const Core::IDocument *document = textEditor->document();
    QTC_ASSERT(document, return false);
    data->fileName = document->fileName();
589 590 591 592 593 594 595
    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();
596
    }
597
    return true;
598
}
599

600 601
///////////////////////////////////////////////////////////////////////
//
602
// DebuggerPluginPrivate
603 604
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
605

606
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
607

608 609 610 611 612 613 614 615 616 617 618 619 620 621
/*!
    \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.
*/

622
class DebuggerPluginPrivate : public DebuggerCore
623 624
{
    Q_OBJECT
625

626 627
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
628
    ~DebuggerPluginPrivate();
629

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

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

639 640 641 642 643 644 645 646 647 648
    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);
    }

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

656 657 658 659
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
660

hjk's avatar
hjk committed
661
    void breakpointSetMarginActionTriggered()
662
    {
663 664
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
hjk's avatar
hjk committed
665 666
        const BreakpointMenuContextData data =
            action->data().value<BreakpointMenuContextData>();
667 668 669 670 671 672 673 674 675 676 677 678 679
        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
680
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
681 682 683 684 685 686 687 688
            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();
        }
689
        if (data.address)
690
            toggleBreakpointByAddress(data.address, message);
691
        else
692
            toggleBreakpointByFileAndLine(data.fileName, data.lineNumber, message);
693
    }
694

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

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

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

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

725

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

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

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

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

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

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

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

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

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

805 806 807
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

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

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

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

    bool isReverseDebugging() const;
823

824 825 826 827 828
    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;
829

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

    void dumpLog();
    void cleanupViews();
837
    void setInitialState();
838 839 840 841

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

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

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
848

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

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

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

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

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

871 872
    void testBenchmark1();

873 874 875 876
public:
    bool m_testSuccess;
    QList<TestCallBack> m_testCallbacks;

hjk's avatar
hjk committed
877 878
#endif

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

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

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

    void handleExecInterrupt()
    {
896
        currentEngine()->resetLocation();
897 898 899
        currentEngine()->requestInterruptInferior();
    }

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

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

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

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

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

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

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

962
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
963
    {
964 965 966 967 968 969 970 971 972 973
        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();
974
            foreach (const QString &str, line.trimmed().split(QLatin1Char('('))) {
975 976 977 978 979 980 981 982 983 984 985 986 987
                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;
                }
            }
        }

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

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

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

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