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

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

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

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

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

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

105
#include <qtsupport/qtsupportconstants.h>
106

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

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

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

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

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

142 143
#endif // WITH_TESTS

144 145
#include <climits>

146 147 148 149 150 151 152 153 154 155
#define DEBUG_STATE 1
#ifdef DEBUG_STATE
//#   define STATE_DEBUG(s)
//    do { QString msg; QTextStream ts(&msg); ts << s;
//      showMessage(msg, LogDebug); } while (0)
#   define STATE_DEBUG(s) do { qDebug() << s; } while(0)
#else
#   define STATE_DEBUG(s)
#endif

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

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

/*!
    \class Debugger::DebuggerEngine

    \brief Base class of a debugger engine.

    Note: the Debugger process itself and any helper processes like
Pawel Polanski's avatar
Pawel Polanski committed
173
    gdbserver, the CODA client etc are referred to as 'Engine',
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
    whereas the debugged process is referred to as 'Inferior'.

    Transitions marked by '---' are done in the individual engines.
    Transitions marked by '+-+' are done in the base DebuggerEngine.
    Transitions marked by '*' are done asynchronously.

    The GdbEngine->setupEngine() function is described in more detail below.

    The engines are responsible for local roll-back to the last
    acknowledged state before calling notify*Failed. I.e. before calling
    notifyEngineSetupFailed() any process started during setupEngine()
    so far must be terminated.
    \code

                        DebuggerNotReady
                         progressmanager/progressmanager.cpp      +
                      EngineSetupRequested
                               +
                  (calls *Engine->setupEngine())
                            |      |
                            |      |
                       {notify-  {notify-
                        Engine-   Engine-
                        SetupOk}  SetupFailed}
                            +      +
                            +      `+-+-+> EngineSetupFailed
                            +                   +
                            +    [calls RunControl->startFailed]
                            +                   +
                            +             DebuggerFinished
                            v
                      EngineSetupOk
                            +
             [calls RunControl->StartSuccessful]
                            +
                  InferiorSetupRequested
                            +
             (calls *Engine->setupInferior())
                         |       |
                         |       |
                    {notify-   {notify-
                     Inferior- Inferior-
                     SetupOk}  SetupFailed}
                         +       +
                         +       ` +-+-> InferiorSetupFailed +-+-+-+-+-+->.
                         +                                                +
                  InferiorSetupOk                                         +
                         +                                                +
                  EngineRunRequested                                      +
                         +                                                +
                 (calls *Engine->runEngine())                             +
               /       |            |        \                            +
             /         |            |          \                          +
            | (core)   | (attach)   |           |                         +
            |          |            |           |                         +
      {notify-    {notifyER&- {notifyER&-  {notify-                       +
      Inferior-     Inferior-   Inferior-  EngineRun-                     +
     Unrunnable}     StopOk}     RunOk}     Failed}                       +
           +           +            +           +                         +
   InferiorUnrunnable  +     InferiorRunOk      +                         +
                       +                        +                         +
                InferiorStopOk            EngineRunFailed                 +
                                                +                         v
                                                 `-+-+-+-+-+-+-+-+-+-+-+>-+
                                                                          +
                                                                          +
                       #Interrupt@InferiorRunOk#                          +
                                  +                                       +
                          InferiorStopRequested                           +
  #SpontaneousStop                +                                       +
   @InferiorRunOk#         (calls *Engine->                               +
          +               interruptInferior())                            +
      {notify-               |          |                                 +
     Spontaneous-       {notify-    {notify-                              +
      Inferior-          Inferior-   Inferior-                            +
       StopOk}           StopOk}    StopFailed}                           +
           +              +             +                                 +
            +            +              +                                 +
            InferiorStopOk              +                                 +
                  +                     +                                 +
                  +                    +                                  +
                  +                   +                                   +
        #Stop@InferiorUnrunnable#    +                                    +
          #Creator Close Event#     +                                     +
                       +           +                                      +
                InferiorShutdownRequested                                 +
                            +                                             +
           (calls *Engine->shutdownInferior())                            +
                         |        |                                       +
                    {notify-   {notify-                                   +
                     Inferior- Inferior-                                  +
                  ShutdownOk}  ShutdownFailed}                            +
                         +        +                                       +
                         +        +                                       +
  #Inferior exited#      +        +                                       +
         |               +        +                                       +
   {notifyInferior-      +        +                                       +
      Exited}            +        +                                       +
           +             +        +                                       +
     InferiorExitOk      +        +                                       +
             +           +        +                                       +
            InferiorShutdownOk InferiorShutdownFailed                     +
                      *          *                                        +
                  EngineShutdownRequested                                 +
                            +                                             +
           (calls *Engine->shutdownEngine())  <+-+-+-+-+-+-+-+-+-+-+-+-+-+'
                         |        |
                         |        |
                    {notify-   {notify-
                     Engine-    Engine-
                  ShutdownOk}  ShutdownFailed}
                         +       +
            EngineShutdownOk  EngineShutdownFailed
                         *       *
                     DebuggerFinished

\endcode */
hjk's avatar
hjk committed
291

292 293 294
/* Here is a matching graph as a GraphViz graph. View it using
 * \code
grep "^sg1:" debuggerplugin.cpp | cut -c5- | dot -osg1.ps -Tps && gv sg1.ps
295

296 297 298 299 300 301
sg1: digraph DebuggerStates {
sg1:   DebuggerNotReady -> EngineSetupRequested
sg1:   EngineSetupRequested -> EngineSetupOk [ label="notifyEngineSetupOk", style="dashed" ];
sg1:   EngineSetupRequested -> EngineSetupFailed [ label= "notifyEngineSetupFailed", style="dashed"];
sg1:   EngineSetupFailed -> DebuggerFinished [ label= "RunControl::StartFailed" ];
sg1:   EngineSetupOk -> InferiorSetupRequested [ label= "RunControl::StartSuccessful" ];
302
sg1:   InferiorSetupRequested -> InferiorSetupOk [ label="notifyInferiorSetupOk", style="dashed" ];
303
sg1:   InferiorSetupRequested -> InferiorSetupFailed [ label="notifyInferiorFailed", style="dashed" ];
304
sg1:   InferiorSetupOk -> EngineRunRequested
305 306 307 308 309 310 311 312 313 314 315 316 317 318
sg1:   InferiorSetupFailed -> EngineShutdownRequested
sg1:   EngineRunRequested -> InferiorUnrunnable [ label="notifyInferiorUnrunnable", style="dashed" ];
sg1:   EngineRunRequested -> InferiorStopOk [ label="notifyEngineRunAndInferiorStopOk", style="dashed" ];
sg1:   EngineRunRequested -> InferiorRunOk [ label="notifyEngineRunAndInferiorRunOk", style="dashed" ];
sg1:   EngineRunRequested -> EngineRunFailed [ label="notifyEngineRunFailed", style="dashed" ];
sg1:   EngineRunFailed -> EngineShutdownRequested
sg1:   InferiorRunOk -> InferiorStopOk [ label="SpontaneousStop\nnotifyInferiorSpontaneousStop", style="dashed" ];
sg1:   InferiorRunOk -> InferiorStopRequested [ label="User stop\nEngine::interruptInferior", style="dashed"];
sg1:   InferiorStopRequested -> InferiorStopOk [ label="notifyInferiorStopOk", style="dashed" ];
sg1:   InferiorStopRequested -> InferiorShutdownRequested  [ label="notifyInferiorStopFailed", style="dashed" ];
sg1:   InferiorStopOk -> InferiorRunRequested [ label="User\nEngine::continueInferior" ];
sg1:   InferiorRunRequested -> InferiorRunOk [ label="notifyInferiorRunOk", style="dashed"];
sg1:   InferiorRunRequested -> InferiorRunFailed [ label="notifyInferiorRunFailed", style="dashed"];
sg1:   InferiorRunFailed -> InferiorStopOk
319 320
sg1:   InferiorStopOk -> InferiorShutdownRequested [ label="Close event" ];
sg1:   InferiorUnrunnable -> InferiorShutdownRequested [ label="Close event" ];
321 322
sg1:   InferiorShutdownRequested -> InferiorShutdownOk [ label= "Engine::shutdownInferior\nnotifyInferiorShutdownOk", style="dashed" ];
sg1:   InferiorShutdownRequested -> InferiorShutdownFailed [ label="Engine::shutdownInferior\nnotifyInferiorShutdownFailed", style="dashed" ];
323 324
sg1:   InferiorExited -> InferiorExitOk [ label="notifyInferiorExited", style="dashed"];
sg1:   InferiorExitOk -> InferiorShutdownOk
325 326 327 328 329 330 331 332
sg1:   InferiorShutdownOk -> EngineShutdownRequested
sg1:   InferiorShutdownFailed -> EngineShutdownRequested
sg1:   EngineShutdownRequested -> EngineShutdownOk [ label="Engine::shutdownEngine\nnotifyEngineShutdownOk", style="dashed" ];
sg1:   EngineShutdownRequested -> EngineShutdownFailed  [ label="Engine::shutdownEngine\nnotifyEngineShutdownFailed", style="dashed" ];
sg1:   EngineShutdownOk -> DebuggerFinished  [ style = "dotted" ];
sg1:   EngineShutdownFailed  -> DebuggerFinished [ style = "dotted" ];
sg1: }
* \endcode */
hjk's avatar
hjk committed
333
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
334 335


336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
/*!
    \class Debugger::Internal::GdbEngine
    \brief Implementation of Debugger::Engine driving a gdb executable.

    GdbEngine specific startup. All happens in EngineSetupRequested state:

    Transitions marked by '---' are done in the individual adapters.

    Transitions marked by '+-+' are done in the GdbEngine.

    \code
                  GdbEngine::setupEngine()
                          +
            (calls *Adapter->startAdapter())
                          |      |
                          |      `---> handleAdapterStartFailed()
                          |                   +
                          |             {notifyEngineSetupFailed}
                          |
                 handleAdapterStarted()
                          +
                 {notifyEngineSetupOk}
358 359 360



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

373
\endcode */
374

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

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

con's avatar
con committed
384 385 386 387 388 389 390

namespace Debugger {
namespace Constants {

} // namespace Constants


391 392
namespace Internal {

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

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

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

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


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

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

423 424 425 426

namespace Debugger {
namespace Internal {

427 428 429 430 431 432
// FIXME: Outdated?
// The createCdbEngine function takes a list of options pages it can add to.
// This allows for having a "enabled" toggle on the page independently
// of the engine. That's good for not enabling the related ActiveX control
// unnecessarily.

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

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

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

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

454 455
static void setProxyAction(Utils::ProxyAction *proxy, const char *id)
{
Eike Ziller's avatar
Eike Ziller committed
456
    proxy->setAction(Core::ActionManager::command(id)->action());
457 458 459 460
}

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

464
static Abi anyAbiOfBinary(const QString &fileName)
465
{
Tobias Hunger's avatar
Tobias Hunger committed
466
    QList<Abi> abis = Abi::abisOfBinary(Utils::FileName::fromString(fileName));
467 468 469 470
    if (abis.isEmpty())
        return Abi();
    return abis.at(0);
}
471 472 473 474 475 476 477 478 479 480 481 482

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
483
    DummyEngine() : DebuggerEngine(DebuggerStartParameters(), AnyLanguage) {}
484 485 486 487 488 489 490
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
491
    bool hasCapability(unsigned cap) const;
492
    bool acceptsBreakpoint(BreakpointModelId) const { return false; }
493
    bool acceptsDebuggerCommands() const { return false; }
494 495
};

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

    // This is a Qml or unknown engine.
515
    return cap & AddWatcherCapability;
516 517
}

518 519 520 521 522 523
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

546 547 548 549 550 551
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

552
static TextEditor::ITextEditor *currentTextEditor()
553
{
hjk's avatar
hjk committed
554
    return qobject_cast<TextEditor::ITextEditor *>(Core::EditorManager::currentEditor());
555
}
con's avatar
con committed
556

557 558
static bool currentTextEditorPosition(ContextData *data)
{
559 560 561
    TextEditor::ITextEditor *textEditor = currentTextEditor();
    if (!textEditor)
        return false;
562 563 564
    const Core::IDocument *document = textEditor->document();
    QTC_ASSERT(document, return false);
    data->fileName = document->fileName();
565 566 567 568 569 570 571
    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();
572
    }
573
    return true;
574
}
575

576 577
///////////////////////////////////////////////////////////////////////
//
578
// DebuggerPluginPrivate
579 580
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
581

582
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
583

584 585 586 587 588 589 590 591 592 593 594 595 596 597
/*!
    \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.
*/

598
class DebuggerPluginPrivate : public DebuggerCore
599 600
{
    Q_OBJECT
601

602 603
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
604
    ~DebuggerPluginPrivate();
605

606
    bool initialize(const QStringList &arguments, QString *errorMessage);
607 608 609
    void extensionsInitialized();
    void aboutToShutdown();

610
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
611
    void disconnectEngine() { connectEngine(0); }
612
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
613
    DebuggerEngine *dummyEngine();
614

615 616 617 618 619 620 621 622 623 624
    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);
    }

625
public slots:
626 627 628 629 630 631
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

632 633 634 635
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
636

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

hjk's avatar
hjk committed
671
    void breakpointRemoveMarginActionTriggered()
672
    {
hjk's avatar
hjk committed
673 674
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
675
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
676
        m_breakHandler->removeBreakpoint(id);
hjk's avatar
hjk committed
677 678 679 680 681 682
     }

    void breakpointEnableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
683
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
684
        breakHandler()->setEnabled(id, true);
hjk's avatar
hjk committed
685 686 687 688 689 690
    }

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

695
    void updateWatchersHeader(int section, int, int newSize)
696 697
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
698
        m_returnWindow->header()->resizeSection(section, newSize);
699
    }
700

701

702
    void sourceFilesDockToggled(bool on)
703
    {
704
        if (on && m_currentEngine->state() == InferiorStopOk)
705 706 707
            m_currentEngine->reloadSourceFiles();
    }

708
    void modulesDockToggled(bool on)
709
    {
710
        if (on && m_currentEngine->state() == InferiorStopOk)
711 712
            m_currentEngine->reloadModules();
    }
713

hjk's avatar
hjk committed
714
    void registerDockToggled(bool on)
715
    {
716
        if (on && m_currentEngine->state() == InferiorStopOk)
717 718
            m_currentEngine->reloadRegisters();
    }
719

720 721
    void synchronizeBreakpoints()
    {
722
        showMessage(QLatin1String("ATTEMPT SYNC"), LogDebug);
723
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
724
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
725 726 727 728
                engine->attemptBreakpointSynchronization();
        }
    }

hjk's avatar
hjk committed
729 730 731
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
732
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
733
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
734 735 736
        }
    }

737
    void editorOpened(Core::IEditor *editor);
738
    void updateBreakMenuItem(Core::IEditor *editor);
739
    void setBusyCursor(bool busy);
740 741 742
    void requestMark(TextEditor::ITextEditor *editor,
                     int lineNumber,
                     TextEditor::ITextEditor::MarkRequestKind kind);
743 744
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
745

746 747 748
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
749 750 751 752
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
753
    void onModeChanged(Core::IMode *mode);
754
    void onCoreAboutToOpen();
755
    void showSettingsDialog();
756
    void updateDebugWithoutDeployMenu();
757

758
    void debugProject();
759
    void debugProjectWithoutDeploy();
760
    void debugProjectBreakMain();
761
    void startExternalApplication();
762
    void startRemoteCdbSession();
763 764
    void startRemoteProcess();
    void startRemoteServer();
765
    bool queryRemoteParameters(DebuggerStartParameters &sp, bool useScript);
766
    void attachToRemoteServer();
767
    void attachToRemoteProcess();
768
    void attachToQmlPort();
769
    void startRemoteEngine();
770
    void attachExternalApplication();
Robert Loehning's avatar
Robert Loehning committed
771
    Q_SLOT void attachExternalApplication(ProjectExplorer::RunControl*rc);
772
    void runScheduled();
773
    void attachCore();
774
    void attachToRemoteServer(const QString &spec);
775

776
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
777
    void languagesChanged();
778
    void showStatusMessage(const QString &msg, int timeout = -1);
779
    void openMemoryEditor();
780

781 782 783
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

    void showQtDumperLibraryWarning(const QString &details);
hjk's avatar
hjk committed
784
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
785
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
786
        { return mainWindow()->isDockVisible(objectName); }
787 788

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

791 792
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
793
    DebuggerLanguages activeLanguages() const;
794 795
    unsigned enabledEngines() const { return m_cmdLineEnabledEngines; }
    QString debuggerForAbi(const Abi &abi, DebuggerEngineType et = NoEngineType) const;
796 797 798
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
799

800 801 802 803 804
    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;
805

ck's avatar
ck committed
806
    DebuggerRunControl *createDebugger(const DebuggerStartParameters &sp,
hjk's avatar
hjk committed
807 808
        RunConfiguration *rc = 0);
    void startDebugger(RunControl *runControl);
809
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
810 811 812

    void dumpLog();
    void cleanupViews();
813
    void setInitialState();
814 815 816 817

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

    void updateState(DebuggerEngine *engine);
hjk's avatar
hjk committed
818
    void updateWatchersWindow(bool showWatch, bool showReturn);
819
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
820 821 822 823

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
824

825
    void executeDebuggerCommand(const QString &command, DebuggerLanguages languages);
826
    bool evaluateScriptExpression(const QString &expression);
827
    void coreShutdown();
828

hjk's avatar
hjk committed
829 830
#ifdef WITH_TESTS
public slots:
831
    void testLoadProject(const QString &proFile, const TestCallBack &cb);
hjk's avatar
hjk committed
832
    void testProjectLoaded(ProjectExplorer::Project *project);
833 834 835 836
    void testUnloadProject();
    void testFinished();

    void testRunProject(const DebuggerStartParameters &sp, const TestCallBack &cb);
hjk's avatar
hjk committed
837
    void testRunControlFinished();
838 839 840 841 842 843 844 845 846

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

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

847 848
    void testBenchmark1();

849 850 851 852
public:
    bool m_testSuccess;
    QList<TestCallBack> m_testCallbacks;

hjk's avatar
hjk committed
853 854
#endif

hjk's avatar
hjk committed
855
public slots:
856
    void updateDebugActions();
857 858 859

    void handleExecDetach()
    {
860
        currentEngine()->resetLocation();
861 862 863 864 865
        currentEngine()->detachDebugger();
    }

    void handleExecContinue()
    {
866
        currentEngine()->resetLocation();
867 868 869 870 871
        currentEngine()->continueInferior();
    }

    void handleExecInterrupt()
    {
872
        currentEngine()->resetLocation();
873 874 875
        currentEngine()->requestInterruptInferior();
    }

876
    void handleAbort()
877
    {
878
        currentEngine()->resetLocation();
879
        currentEngine()->abortDebugger();
880
    }
hjk's avatar
hjk committed
881 882 883

    void handleExecStep()
    {
884 885 886 887 888 889 890 891 892
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeStepI();
            else
                currentEngine()->executeStep();
        }
hjk's avatar
hjk committed
893 894 895 896
    }

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

908 909
    void handleExecStepOut()
    {
910
        currentEngine()->resetLocation();
911 912 913 914 915
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
916
        currentEngine()->resetLocation();
917 918
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
919 920 921 922

    void handleExecJumpToLine()
    {
        //removeTooltip();
923
        currentEngine()->resetLocation();
924 925 926
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeJumpToLine(data);
hjk's avatar
hjk committed
927 928 929 930 931
    }

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

938
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
939
    {
940 941 942 943 944 945 946 947 948 949
        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();
950
            foreach (const QString &str, line.trimmed().split(QLatin1Char('('))) {
951 952 953 954 955 956 957 958 959 960 961 962 963
                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;
                }
            }
        }

964 965 966 967 968 969
        if (functionName.isEmpty()) {
            showStatusMessage(tr("No function selected."));
        } else {
            showStatusMessage(tr("Running to function \"%1\".")
                .arg(functionName));
            currentEngine()->resetLocation();
970
            currentEngine()->executeRunToFunction(functionName);
971
        }
hjk's avatar
hjk committed
972 973
    }

974 975 976 977
    void slotEditBreakpoint()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
978
        const BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
979
        QTC_ASSERT(id > 0, return);
hjk's avatar
hjk committed
980
        BreakTreeView::editBreakpoint(id, mainWindow());
981 982 983 984
    }

    void slotRunToLine()
    {
985 986
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
987
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
988
        currentEngine()->executeRunToLine(data);
989 990 991 992
    }

    void slotJumpToLine()
    {
993 994
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
995
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
996
        currentEngine()->executeJumpToLine(data);
997 998
    }

999 1000 1001 1002 1003 1004 1005 1006 1007
    void slotDisassembleFunction()
    {
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
        const StackFrame frame = action->data().value<StackFrame>();
        QTC_ASSERT(!frame.function.isEmpty(), return);
        currentEngine()->openDisassemblerView(Location(frame));
    }

hjk's avatar
hjk committed
1008 1009