debuggerplugin.cpp 120 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.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
Tobias Hunger's avatar
Tobias Hunger committed
29
** Nokia at info@qt.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 "consolewindow.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 <cplusplus/ModelManagerInterface.h>
hjk's avatar
hjk committed
88

89 90
#include <extensionsystem/pluginmanager.h>

91
#include <projectexplorer/project.h>
92
#include <projectexplorer/projectexplorer.h>
con's avatar
con committed
93
#include <projectexplorer/projectexplorerconstants.h>
94
#include <projectexplorer/toolchainmanager.h>
95
#include <projectexplorer/toolchain.h>
con's avatar
con committed
96
#include <projectexplorer/session.h>
97
#include <projectexplorer/target.h>
98
#include <projectexplorer/abi.h>
hjk's avatar
hjk committed
99

100
#include <qtsupport/qtsupportconstants.h>
101

hjk's avatar
hjk committed
102
#include <texteditor/basetexteditor.h>
103
#include <texteditor/fontsettings.h>
104
#include <texteditor/texteditorsettings.h>
hjk's avatar
hjk committed
105 106

#include <utils/qtcassert.h>
107
#include <utils/savedaction.h>
108
#include <utils/styledbar.h>
109
#include <utils/proxyaction.h>
110
#include <utils/statuslabel.h>
111
#include <utils/fileutils.h>
con's avatar
con committed
112

113 114
#include <qml/scriptconsole.h>

115
#include <QtCore/QTimer>
116 117
#include <QtCore/QtPlugin>
#include <QtGui/QComboBox>
118
#include <QtGui/QDockWidget>
119
#include <QtGui/QFileDialog>
hjk's avatar
hjk committed
120
#include <QtGui/QMenu>
121
#include <QtGui/QMessageBox>
122 123 124
#include <QtGui/QPushButton>
#include <QtGui/QTextBlock>
#include <QtGui/QTextCursor>
125
#include <QtGui/QToolButton>
hjk's avatar
hjk committed
126
#include <QtGui/QTreeWidget>
127
#include <QtGui/QInputDialog>
con's avatar
con committed
128

129 130
#include <climits>

131 132 133 134 135 136 137 138 139 140
#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

141 142 143 144 145 146 147 148
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
149
    \internal
150 151 152 153 154 155 156 157
*/

/*!
    \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
158
    gdbserver, the CODA client etc are referred to as 'Engine',
159 160 161 162 163 164 165 166 167 168 169 170 171 172 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
    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
276

277 278 279
/* 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
280

281 282 283 284 285 286
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" ];
287
sg1:   InferiorSetupRequested -> InferiorSetupOk [ label="notifyInferiorSetupOk", style="dashed" ];
288
sg1:   InferiorSetupRequested -> InferiorSetupFailed [ label="notifyInferiorFailed", style="dashed" ];
289
sg1:   InferiorSetupOk -> EngineRunRequested
290 291 292 293 294 295 296 297 298 299 300 301 302 303
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
304 305
sg1:   InferiorStopOk -> InferiorShutdownRequested [ label="Close event" ];
sg1:   InferiorUnrunnable -> InferiorShutdownRequested [ label="Close event" ];
306 307
sg1:   InferiorShutdownRequested -> InferiorShutdownOk [ label= "Engine::shutdownInferior\nnotifyInferiorShutdownOk", style="dashed" ];
sg1:   InferiorShutdownRequested -> InferiorShutdownFailed [ label="Engine::shutdownInferior\nnotifyInferiorShutdownFailed", style="dashed" ];
308 309
sg1:   InferiorExited -> InferiorExitOk [ label="notifyInferiorExited", style="dashed"];
sg1:   InferiorExitOk -> InferiorShutdownOk
310 311 312 313 314 315 316 317
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
318
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
319 320


321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
/*!
    \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}
343 344 345



346 347 348 349 350 351 352 353 354 355 356
                GdbEngine::setupInferior()
                          +
            (calls *Adapter->prepareInferior())
                          |      |
                          |      `---> handlePrepareInferiorFailed()
                          |                   +
                          |             {notifyInferiorSetupFailed}
                          |
                handleInferiorPrepared()
                          +
                {notifyInferiorSetupOk}
357

358
\endcode */
359

con's avatar
con committed
360
using namespace Core;
hjk's avatar
hjk committed
361
using namespace Debugger::Constants;
con's avatar
con committed
362
using namespace ProjectExplorer;
hjk's avatar
hjk committed
363
using namespace TextEditor;
con's avatar
con committed
364

hjk's avatar
hjk committed
365 366 367
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
368 369 370 371

namespace Debugger {
namespace Constants {

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
372
#ifdef Q_WS_MAC
hjk's avatar
hjk committed
373 374 375 376 377 378 379 380 381 382 383 384 385 386
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
387
#else
hjk's avatar
hjk committed
388 389 390 391 392 393 394 395 396 397 398 399 400 401
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";
const char RUN_TO_LINE_KEY[]              = "";
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
402 403 404 405 406
#endif

} // namespace Constants


407 408
namespace Internal {

409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
// To be passed through margin menu action's data
struct BreakpointMenuContextData : public ContextData
{
    enum Mode
    {
        Breakpoint,
        MessageTracePoint
    };

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

} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::BreakpointMenuContextData)

namespace Debugger {
namespace Internal {

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

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

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

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

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

457
static Abi anyAbiOfBinary(const QString &fileName)
458 459 460 461 462 463
{
    QList<Abi> abis = Abi::abisOfBinary(fileName);
    if (abis.isEmpty())
        return Abi();
    return abis.at(0);
}
464 465 466 467 468 469 470 471 472 473 474 475 476

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
    DummyEngine() : DebuggerEngine(DebuggerStartParameters()) {}
477 478 479 480 481 482 483
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
484
    unsigned debuggerCapabilities() const { return AddWatcherCapability; }
485
    bool acceptsBreakpoint(BreakpointModelId) const { return false; }
486
    bool acceptsDebuggerCommands() const { return false; }
487 488
};

489 490 491 492 493 494
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

495
class DebugMode : public IMode
hjk's avatar
hjk committed
496 497
{
public:
498 499 500 501
    DebugMode()
    {
        setObjectName(QLatin1String("DebugMode"));
        setContext(Context(CC::C_EDITORMANAGER, C_DEBUGMODE, CC::C_NAVIGATION_PANE));
502 503
        setDisplayName(DebuggerPlugin::tr("Debug"));
        setIcon(QIcon(QLatin1String(":/fancyactionbar/images/mode_Debug.png")));
504
        setPriority(85);
505 506
        setId(MODE_DEBUG);
        setType(CC::MODE_EDIT_TYPE);
507
    }
hjk's avatar
hjk committed
508

hjk's avatar
hjk committed
509 510 511 512 513 514
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        //EditorManager::instance()->setParent(0);
        delete m_widget;
    }
515
};
hjk's avatar
hjk committed
516

517

518 519 520 521 522 523
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

524
static TextEditor::ITextEditor *currentTextEditor()
525
{
526 527 528 529 530
    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
531

532 533 534 535 536 537 538 539 540 541 542
static bool currentTextEditorPosition(ContextData *data)
{
    if (TextEditor::ITextEditor *textEditor = currentTextEditor()) {
        if (const Core::IFile *file = textEditor->file()) {
            data->fileName = file->fileName();
            data->lineNumber = textEditor->currentLine();
            return true;
        }
    }
    return false;
}
543

544 545
///////////////////////////////////////////////////////////////////////
//
546
// DebuggerPluginPrivate
547 548
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
549

550
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
551

552 553 554 555 556 557 558 559 560 561 562 563 564 565
/*!
    \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.
*/

566
class DebuggerPluginPrivate : public DebuggerCore
567 568
{
    Q_OBJECT
569

570 571
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
572
    ~DebuggerPluginPrivate();
573

574
    bool initialize(const QStringList &arguments, QString *errorMessage);
575 576 577
    void extensionsInitialized();
    void aboutToShutdown();

578
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
579
    void disconnectEngine() { connectEngine(0); }
580
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
581
    DebuggerEngine *dummyEngine();
582

583 584 585 586 587 588 589 590 591 592
    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);
    }

593
public slots:
594 595 596 597 598 599
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

600 601 602 603
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
604

hjk's avatar
hjk committed
605
    void breakpointSetMarginActionTriggered()
606
    {
607 608
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
hjk's avatar
hjk committed
609 610
        const BreakpointMenuContextData data =
            action->data().value<BreakpointMenuContextData>();
611 612 613 614 615 616 617 618 619 620 621 622 623
        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
624
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
625 626 627 628 629 630 631 632
            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();
        }
633
        if (data.address)
634
            toggleBreakpointByAddress(data.address, message);
635
        else
636
            toggleBreakpointByFileAndLine(data.fileName, data.lineNumber, message);
637
    }
638

hjk's avatar
hjk committed
639
    void breakpointRemoveMarginActionTriggered()
640
    {
hjk's avatar
hjk committed
641 642
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
643
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
644
        m_breakHandler->removeBreakpoint(id);
hjk's avatar
hjk committed
645 646 647 648 649 650
     }

    void breakpointEnableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
651
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
652
        breakHandler()->setEnabled(id, true);
hjk's avatar
hjk committed
653 654 655 656 657 658
    }

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

663
    void updateWatchersHeader(int section, int, int newSize)
664 665 666
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
    }
667

668
    void sourceFilesDockToggled(bool on)
669
    {
670
        if (on && m_currentEngine->state() == InferiorStopOk)
671 672 673
            m_currentEngine->reloadSourceFiles();
    }

674
    void modulesDockToggled(bool on)
675
    {
676
        if (on && m_currentEngine->state() == InferiorStopOk)
677 678
            m_currentEngine->reloadModules();
    }
679

hjk's avatar
hjk committed
680
    void registerDockToggled(bool on)
681
    {
682
        if (on && m_currentEngine->state() == InferiorStopOk)
683 684
            m_currentEngine->reloadRegisters();
    }
685

686 687
    void synchronizeBreakpoints()
    {
688
        showMessage("ATTEMPT SYNC", LogDebug);
689
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
690
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
691 692 693 694
                engine->attemptBreakpointSynchronization();
        }
    }

hjk's avatar
hjk committed
695 696 697
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
698
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
699
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
700 701 702
        }
    }

703
    void editorOpened(Core::IEditor *editor);
704
    void updateBreakMenuItem(Core::IEditor *editor);
705 706 707 708
    void setBusyCursor(bool busy);
    void requestMark(TextEditor::ITextEditor *editor, int lineNumber);
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
709

710 711 712
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
713 714 715 716
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
717
    void onModeChanged(Core::IMode *mode);
718
    void onCoreAboutToOpen();
719
    void showSettingsDialog();
720

721
    void debugProject();
722
    void debugProjectBreakMain();
723
    void startExternalApplication();
724
    void startRemoteCdbSession();
725
    void startRemoteApplication();
726
    void startRemoteEngine();
727
    void attachExternalApplication();
728
    Q_SLOT void attachExternalApplication(ProjectExplorer::RunControl *rc);
729
    void runScheduled();
730
    void attachCore();
731
    void attachRemote(const QString &spec);
732

733
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
734
    void languagesChanged();
735
    void showStatusMessage(const QString &msg, int timeout = -1);
736
    void openMemoryEditor();
737

738 739 740
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

    void showQtDumperLibraryWarning(const QString &details);
hjk's avatar
hjk committed
741
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
742
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
743
        { return mainWindow()->isDockVisible(objectName); }
744 745

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

748 749
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
750
    DebuggerLanguages activeLanguages() const;
751 752
    unsigned enabledEngines() const { return m_cmdLineEnabledEngines; }
    QString debuggerForAbi(const Abi &abi, DebuggerEngineType et = NoEngineType) const;
753 754 755
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
756

757 758 759 760 761
    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;
762

ck's avatar
ck committed
763
    DebuggerRunControl *createDebugger(const DebuggerStartParameters &sp,
hjk's avatar
hjk committed
764 765
        RunConfiguration *rc = 0);
    void startDebugger(RunControl *runControl);
766
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
767 768 769

    void dumpLog();
    void cleanupViews();
770
    void setInitialState();
771 772 773 774

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

    void updateState(DebuggerEngine *engine);
775
    void updateWatchersWindow();
776
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
777 778 779 780

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
781

782
    void executeDebuggerCommand(const QString &command);
hjk's avatar
hjk committed
783
    void scriptExpressionEntered(const QString &expression);
784
    void coreShutdown();
785

hjk's avatar
hjk committed
786
public slots:
787
    void updateDebugActions();
788 789 790

    void handleExecDetach()
    {
791
        currentEngine()->resetLocation();
792 793 794 795 796
        currentEngine()->detachDebugger();
    }

    void handleExecContinue()
    {
797
        currentEngine()->resetLocation();
798 799 800 801 802
        currentEngine()->continueInferior();
    }

    void handleExecInterrupt()
    {
803
        currentEngine()->resetLocation();
804 805 806 807 808
        currentEngine()->requestInterruptInferior();
    }

    void handleExecReset()
    {
809
        currentEngine()->resetLocation();
810 811
        currentEngine()->notifyEngineIll(); // FIXME: Check.
    }
hjk's avatar
hjk committed
812 813 814

    void handleExecStep()
    {
815 816 817 818 819 820 821 822 823
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeStepI();
            else
                currentEngine()->executeStep();
        }
hjk's avatar
hjk committed
824 825 826 827
    }

    void handleExecNext()
    {
828 829 830 831 832 833 834 835 836
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeNextI();
            else
                currentEngine()->executeNext();
        }
hjk's avatar
hjk committed
837 838
    }

839 840
    void handleExecStepOut()
    {
841
        currentEngine()->resetLocation();
842 843 844 845 846
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
847
        currentEngine()->resetLocation();
848 849
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
850 851 852 853

    void handleExecJumpToLine()
    {
        //removeTooltip();
854
        currentEngine()->resetLocation();
855 856 857
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeJumpToLine(data);
hjk's avatar
hjk committed
858 859 860 861 862
    }

    void handleExecRunToLine()
    {
        //removeTooltip();
863
        currentEngine()->resetLocation();
864 865 866
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeRunToLine(data);
hjk's avatar
hjk committed
867 868
    }

869
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
870
    {
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
        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();
            foreach (const QString &str, line.trimmed().split('(')) {
                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;
                }
            }
        }

895 896 897 898 899 900
        if (functionName.isEmpty()) {
            showStatusMessage(tr("No function selected."));
        } else {
            showStatusMessage(tr("Running to function \"%1\".")
                .arg(functionName));
            currentEngine()->resetLocation();
901
            currentEngine()->executeRunToFunction(functionName);
902
        }
hjk's avatar
hjk committed
903 904
    }

905 906 907 908
    void slotEditBreakpoint()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
909
        const BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
910 911
        QTC_ASSERT(id > 0, return);
        BreakWindow::editBreakpoint(id, mainWindow());
912 913 914 915
    }

    void slotRunToLine()
    {
916 917
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
918
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
919
        currentEngine()->executeRunToLine(data);
920 921 922 923
    }

    void slotJumpToLine()
    {
924 925
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
926
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
927
        currentEngine()->executeJumpToLine(data);
928 929
    }

hjk's avatar
hjk committed
930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
    void handleAddToWatchWindow()
    {
        // Requires a selection, but that's the only case we want anyway.
        EditorManager *editorManager = EditorManager::instance();
        if (!editorManager)
            return;
        IEditor *editor = editorManager->currentEditor();
        if (!editor)
            return;
        ITextEditor *textEditor = qobject_cast<ITextEditor*>(editor);
        if (!textEditor)
            return;
        QTextCursor tc;
        QPlainTextEdit *ptEdit = qobject_cast<QPlainTextEdit*>(editor->widget());
        if (ptEdit)
            tc = ptEdit->textCursor();
        QString exp;
        if (tc.hasSelection()) {
            exp = tc.selectedText();
        } else {
            int line, column;
            exp = cppExpressionAt(textEditor, tc.position(), &line, &column);
        }
        if (exp.isEmpty())
            return;
        currentEngine()->watchHandler()->watchExpression(exp);
    }

    void handleExecExit()
    {
960
        currentEngine()->exitDebugger();
hjk's avatar
hjk committed
961 962 963 964 965 966 967 968 969 970 971 972
    }

    void handleFrameDown()
    {
        currentEngine()->frameDown();
    }

    void handleFrameUp()
    {
        currentEngine()->frameUp();
    }

973
    void handleOperateByInstructionTriggered(bool operateByInstructionTriggered)
hjk's avatar
hjk committed
974
    {
975 976 977
        // Go to source only if we have the file.
        if (currentEngine()->stackHandler()->currentIndex() >= 0) {
            const StackFrame frame = currentEngine()->stackHandler()->currentFrame();
978 979 980
            if (operateByInstructionTriggered || frame.isUsable()) {
                currentEngine()->gotoLocation(Location(frame, true));
            }
981
        }
hjk's avatar
hjk committed
982 983
    }

984
    bool isActiveDebugLanguage(int lang) const
hjk's avatar
hjk committed
985
    {
986
        return m_mainWindow->activeDebugLanguages() & lang;
hjk's avatar
hjk committed
987 988
    }

989 990 991 992 993 994 995 996
    QVariant sessionValue(const QString &name);
    void setSessionValue(const QString &name, const QVariant &value);
    QIcon locationMarkIcon() const { return m_locationMarkIcon; }

    void openTextEditor(const QString &titlePattern0, const QString &contents);
    void clearCppCodeModelSnapshot();
    void showMessage(const QString &msg, int channel, int timeout = -1);

hjk's avatar
hjk committed
997 998 999 1000
    Utils::SavedAction *action(int code) const;
    bool boolSetting(int code) const;
    QString stringSetting(int code) const;

hjk's avatar
hjk committed
1001 1002
    void showModuleSymbols(const QString &moduleName, const Symbols &symbols);

1003 1004 1005 1006 1007 1008
    bool parseArgument(QStringList::const_iterator &it,
        const QStringList::const_iterator &cend,
        unsigned *enabledEngines, QString *errorMessage);
    bool parseArguments(const QStringList &args,
        unsigned *enabledEngines, QString *errorMessage);

1009
    DebuggerToolTipManager *toolTipManager() const { return m_toolTipManager; }
1010
    virtual QSharedPointer<GlobalDebuggerOptions> globalDebuggerOptions() const { return m_globalDebuggerOptions; }
1011

1012
public:
1013
    DebuggerMainWindow *m_mainWindow;
1014 1015 1016
    DebuggerRunControlFactory *m_debuggerRunControlFactory;

    QString m_previousMode;
1017
    QList<DebuggerStartParameters> m_scheduledStarts;
1018

hjk's avatar
hjk committed
1019 1020 1021
    Utils::ProxyAction *m_visibleStartAction;
    Utils::ProxyAction *m_hiddenStopAction;
    QAction *m_startAction;
1022 1023
    QAction *m_startExternalAction;
    QAction *m_startRemoteAction;
1024
    QAction *m_startRemoteCdbAction;
1025
    QAction *m_startRemoteLldbAction;
1026 1027 1028
    QAction *m_attachExternalAction;
    QAction *m_attachCoreAction;
    QAction *m_detachAction;
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
    QAction *m_continueAction;
    QAction *m_exitAction; // On application output button if "Stop" is possible
    QAction *m_interruptAction; // On the fat debug button if "Pause" is possible
    QAction *m_undisturbableAction; // On the fat debug button if nothing can be done
    QAction *m_resetAction;
    QAction *m_stepAction;
    QAction *m_stepOutAction;
    QAction *m_runToLineAction; // In the debug menu
    QAction *m_runToSelectedFunctionAction;
    QAction *m_jumpToLineAction; // In the Debug menu.
    QAction *m_returnFromFunctionAction;
    QAction *m_nextAction;
    QAction *m_watchAction1; // In the Debug menu.
    QAction *m_watchAction2; // In the text editor context menu.
    QAction *m_breakAction;
    QAction *m_reverseDirectionAction;
    QAction *m_frameUpAction;
    QAction *m_frameDownAction;

1048 1049
    QToolButton *m_reverseToolButton;

1050
    QIcon m_startIcon;
1051
    QIcon m_exitIcon;
1052
    QIcon m_continueIcon;
1053 1054 1055
    QIcon m_interruptIcon;
    QIcon m_locationMarkIcon;