debuggerplugin.cpp 110 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
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
con's avatar
con committed
9
** No Commercial Usage
10
**
con's avatar
con committed
11 12 13 14
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
15
**
16
** GNU Lesser General Public License Usage
17
**
18 19 20 21 22 23
** Alternatively, 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.
24
**
con's avatar
con committed
25 26 27 28 29 30
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
con's avatar
con committed
31
**
32
**************************************************************************/
hjk's avatar
hjk committed
33

con's avatar
con committed
34 35
#include "debuggerplugin.h"

Friedemann Kleint's avatar
Friedemann Kleint committed
36
#include "debuggerstartparameters.h"
37
#include "debuggeractions.h"
con's avatar
con committed
38
#include "debuggerconstants.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

47 48
#include "breakpoint.h"
#include "breakhandler.h"
49
#include "breakwindow.h"
50
#include "consolewindow.h"
51
#include "disassembleragent.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"
hjk's avatar
hjk committed
69
#include "gdb/gdboptionspage.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/uniqueidmanager.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 <cplusplus/ModelManagerInterface.h>
hjk's avatar
hjk committed
89

90 91
#include <extensionsystem/pluginmanager.h>

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

98 99
#include <qt4projectmanager/qt4projectmanagerconstants.h>

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

#include <utils/qtcassert.h>
105
#include <utils/savedaction.h>
106
#include <utils/styledbar.h>
107
#include <utils/proxyaction.h>
con's avatar
con committed
108

109 110
#include <qml/scriptconsole.h>

111
#include <QtCore/QTimer>
112 113
#include <QtCore/QtPlugin>
#include <QtGui/QComboBox>
114
#include <QtGui/QDockWidget>
115
#include <QtGui/QFileDialog>
hjk's avatar
hjk committed
116
#include <QtGui/QMenu>
117
#include <QtGui/QMessageBox>
118 119 120
#include <QtGui/QPushButton>
#include <QtGui/QTextBlock>
#include <QtGui/QTextCursor>
121
#include <QtGui/QToolButton>
hjk's avatar
hjk committed
122
#include <QtGui/QTreeWidget>
con's avatar
con committed
123

124 125
#include <climits>

126 127 128 129 130 131 132 133 134 135
#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

136 137 138 139 140 141 142 143
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
144
    \internal
145 146 147 148 149 150 151 152 153 154 155 156 157 158 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
*/

/*!
    \class Debugger::DebuggerEngine

    \brief Base class of a debugger engine.

    Note: the Debugger process itself and any helper processes like
    gdbserver, the trk client etc are referred to as 'Engine',
    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
271

272 273 274
/* 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
275

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


316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
/*!
    \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}
338 339 340



341 342 343 344 345 346 347 348 349 350 351
                GdbEngine::setupInferior()
                          +
            (calls *Adapter->prepareInferior())
                          |      |
                          |      `---> handlePrepareInferiorFailed()
                          |                   +
                          |             {notifyInferiorSetupFailed}
                          |
                handleInferiorPrepared()
                          +
                {notifyInferiorSetupOk}
352

353
\endcode */
354

con's avatar
con committed
355
using namespace Core;
hjk's avatar
hjk committed
356
using namespace Debugger::Constants;
con's avatar
con committed
357
using namespace ProjectExplorer;
hjk's avatar
hjk committed
358
using namespace TextEditor;
con's avatar
con committed
359

hjk's avatar
hjk committed
360 361 362
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
363 364 365 366

namespace Debugger {
namespace Constants {

367 368
const char * const M_DEBUG_START_DEBUGGING = "QtCreator.Menu.Debug.StartDebugging";

369 370 371 372 373 374 375 376 377
const char * const STARTEXTERNAL            = "Debugger.StartExternal";
const char * const ATTACHEXTERNAL           = "Debugger.AttachExternal";
const char * const ATTACHCORE               = "Debugger.AttachCore";
const char * const ATTACHTCF                = "Debugger.AttachTcf";
const char * const ATTACHREMOTE             = "Debugger.AttachRemote";
const char * const ATTACHREMOTECDB          = "Debugger.AttachRemoteCDB";
const char * const STARTREMOTELLDB          = "Debugger.StartRemoteLLDB";
const char * const DETACH                   = "Debugger.Detach";

hjk's avatar
hjk committed
378
const char * const RUN_TO_LINE              = "Debugger.RunToLine";
379
const char * const RUN_TO_SELECTED_FUNCTION = "Debugger.RunToSelectedFunction";
hjk's avatar
hjk committed
380
const char * const JUMP_TO_LINE             = "Debugger.JumpToLine";
381 382 383 384 385
const char * const RETURN_FROM_FUNCTION     = "Debugger.ReturnFromFunction";
const char * const SNAPSHOT                 = "Debugger.Snapshot";
const char * const TOGGLE_BREAK             = "Debugger.ToggleBreak";
const char * const BREAK_BY_FUNCTION        = "Debugger.BreakByFunction";
const char * const BREAK_AT_MAIN            = "Debugger.BreakAtMain";
386 387
// Don't add '1' to the string as it shows up in the shortcut dialog.
const char * const ADD_TO_WATCH1            = "Debugger.AddToWatch";
388 389 390
const char * const ADD_TO_WATCH2            = "Debugger.AddToWatch2";
const char * const FRAME_UP                 = "Debugger.FrameUp";
const char * const FRAME_DOWN               = "Debugger.FrameDown";
con's avatar
con committed
391

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

} // namespace Constants


427 428 429 430 431 432 433 434
namespace Internal {

// 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.

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

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

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

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

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

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
    unsigned debuggerCapabilities() const { return 0; }
    bool acceptsBreakpoint(BreakpointId) const { return false; }
485
    bool acceptsDebuggerCommands() const { return false; }
486 487 488 489 490 491 492 493 494
};

static DebuggerEngine *dummyEngine()
{
    static DummyEngine dummy;
    return &dummy;
}


495 496 497 498 499 500
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

501
class DebugMode : public IMode
hjk's avatar
hjk committed
502 503
{
public:
hjk's avatar
hjk committed
504
    DebugMode() : m_widget(0) { setObjectName(QLatin1String("DebugMode")); }
hjk's avatar
hjk committed
505

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

    // IMode
hjk's avatar
hjk committed
514 515 516 517 518 519 520 521 522
    QString displayName() const { return DebuggerPlugin::tr("Debug"); }
    QIcon icon() const { return QIcon(__(":/fancyactionbar/images/mode_Debug.png")); }
    int priority() const { return P_MODE_DEBUG; }
    QWidget *widget();
    QString id() const { return MODE_DEBUG; }
    QString type() const { return CC::MODE_EDIT_TYPE; }
    Context context() const
        { return Context(CC::C_EDITORMANAGER, C_DEBUGMODE, CC::C_NAVIGATION_PANE); }
    QString contextHelpId() const { return QString(); }
523 524
private:
    QWidget *m_widget;
525
};
hjk's avatar
hjk committed
526

527

528 529 530 531 532 533
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
class ContextData
{
public:
    ContextData() : lineNumber(0), address(0) {}

public:
    QString fileName;
    int lineNumber;
    quint64 address;
};

} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::ContextData)
con's avatar
con committed
549

550

551 552
///////////////////////////////////////////////////////////////////////
//
553
// DebuggerPluginPrivate
554 555
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
556

557 558 559
namespace Debugger {
namespace Internal {

560
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
561

562 563 564 565 566 567 568 569 570 571 572 573 574 575
/*!
    \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.
*/

576
class DebuggerPluginPrivate : public DebuggerCore
577 578
{
    Q_OBJECT
579

580 581
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
582
    ~DebuggerPluginPrivate();
583

584
    bool initialize(const QStringList &arguments, QString *errorMessage);
585 586 587
    void extensionsInitialized();
    void aboutToShutdown();

588
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
589
    void disconnectEngine() { connectEngine(0); }
590
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
591

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

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

hjk's avatar
hjk committed
605
    void breakpointSetMarginActionTriggered()
606
    {
607 608 609 610 611 612 613
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
        const ContextData data = action->data().value<ContextData>();
        if (data.address)
            toggleBreakpointByAddress(data.address);
        else
            toggleBreakpointByFileAndLine(data.fileName, data.lineNumber);
614
    }
615

hjk's avatar
hjk committed
616
    void breakpointRemoveMarginActionTriggered()
617
    {
hjk's avatar
hjk committed
618 619
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
620
        m_breakHandler->removeBreakpoint(act->data().toInt());
hjk's avatar
hjk committed
621 622 623 624 625 626 627 628 629 630 631 632 633 634
     }

    void breakpointEnableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
        breakHandler()->setEnabled(act->data().toInt(), true);
    }

    void breakpointDisableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
        breakHandler()->setEnabled(act->data().toInt(), false);
635 636
    }

637
    void updateWatchersHeader(int section, int, int newSize)
638 639 640
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
    }
641

642
    void sourceFilesDockToggled(bool on)
643
    {
644
        if (on && m_currentEngine->state() == InferiorStopOk)
645 646 647
            m_currentEngine->reloadSourceFiles();
    }

648
    void modulesDockToggled(bool on)
649
    {
650
        if (on && m_currentEngine->state() == InferiorStopOk)
651 652
            m_currentEngine->reloadModules();
    }
653

hjk's avatar
hjk committed
654
    void registerDockToggled(bool on)
655
    {
656
        if (on && m_currentEngine->state() == InferiorStopOk)
657 658
            m_currentEngine->reloadRegisters();
    }
659

660 661
    void synchronizeBreakpoints()
    {
662
        showMessage("ATTEMPT SYNC", LogDebug);
663
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
664
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
665 666 667 668
                engine->attemptBreakpointSynchronization();
        }
    }

hjk's avatar
hjk committed
669 670 671
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
672
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
673
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
674 675 676
        }
    }

677
    void editorOpened(Core::IEditor *editor);
678
    void updateBreakMenuItem(Core::IEditor *editor);
679 680 681 682
    void setBusyCursor(bool busy);
    void requestMark(TextEditor::ITextEditor *editor, int lineNumber);
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
683

684 685 686
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
687 688
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber);
    void toggleBreakpointByAddress(quint64 address);
689
    void onModeChanged(Core::IMode *mode);
690
    void onCoreAboutToOpen();
691
    void showSettingsDialog();
692

693
    void debugProject();
694
    void startExternalApplication();
695
    void startRemoteCdbSession();
696
    void startRemoteApplication();
697
    void startRemoteEngine();
698
    void attachExternalApplication();
699 700
    void attachExternalApplication(qint64 pid, const QString &binary);
    void runScheduled();
701 702
    void attachCore();
    void attachCore(const QString &core, const QString &exeFileName);
703
    void attachRemote(const QString &spec);
704
    void attachRemoteTcf();
705

706
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
707
    void languagesChanged();
708
    void showStatusMessage(const QString &msg, int timeout = -1);
709
    void openMemoryEditor();
710

711 712 713
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

    void showQtDumperLibraryWarning(const QString &details);
hjk's avatar
hjk committed
714
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
715
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
716
        { return mainWindow()->isDockVisible(objectName); }
717 718

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

721 722
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
723
    DebuggerLanguages activeLanguages() const;
724
    QString gdbBinaryForAbi(const Abi &abi) const;
725 726 727
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
728

729 730 731 732 733
    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;
734

ck's avatar
ck committed
735
    DebuggerRunControl *createDebugger(const DebuggerStartParameters &sp,
hjk's avatar
hjk committed
736 737
        RunConfiguration *rc = 0);
    void startDebugger(RunControl *runControl);
738
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
739 740 741

    void dumpLog();
    void cleanupViews();
742
    void setInitialState();
743 744 745 746

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

    void updateState(DebuggerEngine *engine);
747
    void updateWatchersWindow();
748
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
749 750 751 752 753 754

    void clearStatusMessage();

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
755

756
    void executeDebuggerCommand(const QString &command);
hjk's avatar
hjk committed
757
    void scriptExpressionEntered(const QString &expression);
758
    void coreShutdown();
759

hjk's avatar
hjk committed
760
public slots:
761
    void updateDebugActions();
762 763 764

    void handleExecDetach()
    {
765
        currentEngine()->resetLocation();
766 767 768 769 770
        currentEngine()->detachDebugger();
    }

    void handleExecContinue()
    {
771
        currentEngine()->resetLocation();
772 773 774 775 776
        currentEngine()->continueInferior();
    }

    void handleExecInterrupt()
    {
777
        currentEngine()->resetLocation();
778 779 780 781 782
        currentEngine()->requestInterruptInferior();
    }

    void handleExecReset()
    {
783
        currentEngine()->resetLocation();
784 785
        currentEngine()->notifyEngineIll(); // FIXME: Check.
    }
hjk's avatar
hjk committed
786 787 788

    void handleExecStep()
    {
789
        currentEngine()->resetLocation();
790
        if (boolSetting(OperateByInstruction))
hjk's avatar
hjk committed
791 792 793 794 795 796 797
            currentEngine()->executeStepI();
        else
            currentEngine()->executeStep();
    }

    void handleExecNext()
    {
798
        currentEngine()->resetLocation();
799
        if (boolSetting(OperateByInstruction))
hjk's avatar
hjk committed
800 801 802 803 804
            currentEngine()->executeNextI();
        else
            currentEngine()->executeNext();
    }

805 806
    void handleExecStepOut()
    {
807
        currentEngine()->resetLocation();
808 809 810 811 812
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
813
        currentEngine()->resetLocation();
814 815
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
816 817 818 819

    void handleExecJumpToLine()
    {
        //removeTooltip();
820
        currentEngine()->resetLocation();
821 822 823 824
        QString fileName;
        int lineNumber;
        if (currentTextEditorPosition(&fileName, &lineNumber))
            currentEngine()->executeJumpToLine(fileName, lineNumber);
hjk's avatar
hjk committed
825 826 827 828 829
    }

    void handleExecRunToLine()
    {
        //removeTooltip();
830
        currentEngine()->resetLocation();
831 832 833 834
        QString fileName;
        int lineNumber;
        if (currentTextEditorPosition(&fileName, &lineNumber))
            currentEngine()->executeRunToLine(fileName, lineNumber);
hjk's avatar
hjk committed
835 836
    }

837
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
838
    {
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
        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;
                }
            }
        }

863 864 865 866 867 868
        if (functionName.isEmpty()) {
            showStatusMessage(tr("No function selected."));
        } else {
            showStatusMessage(tr("Running to function \"%1\".")
                .arg(functionName));
            currentEngine()->resetLocation();
869
            currentEngine()->executeRunToFunction(functionName);
870
        }
hjk's avatar
hjk committed
871 872
    }

873 874 875 876
    void slotEditBreakpoint()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
hjk's avatar
hjk committed
877 878 879
        const BreakpointId id = act->data().toInt();
        QTC_ASSERT(id > 0, return);
        BreakWindow::editBreakpoint(id, mainWindow());
880 881 882 883
    }

    void slotRunToLine()
    {
884 885 886 887
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
        const ContextData data = action->data().value<ContextData>();
        currentEngine()->executeRunToLine(data.fileName, data.lineNumber);
888 889 890 891
    }

    void slotJumpToLine()
    {
892 893 894 895
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
        const ContextData data = action->data().value<ContextData>();
        currentEngine()->executeJumpToLine(data.fileName, data.lineNumber);
896 897
    }

hjk's avatar
hjk committed
898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
    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()
    {
928
        currentEngine()->exitDebugger();
hjk's avatar
hjk committed
929 930 931 932 933 934 935 936 937 938 939 940
    }

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

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

941
    void handleOperateByInstructionTriggered(bool operateByInstructionTriggered)
hjk's avatar
hjk committed
942
    {
943 944 945
        // Go to source only if we have the file.
        if (currentEngine()->stackHandler()->currentIndex() >= 0) {
            const StackFrame frame = currentEngine()->stackHandler()->currentFrame();
946 947 948
            if (operateByInstructionTriggered || frame.isUsable()) {
                currentEngine()->gotoLocation(Location(frame, true));
            }
949
        }
hjk's avatar
hjk committed
950 951
    }

952
    bool isActiveDebugLanguage(int lang) const
hjk's avatar
hjk committed
953
    {
954
        return m_mainWindow->activeDebugLanguages() & lang;
hjk's avatar
hjk committed
955 956
    }

957 958 959 960 961 962 963 964
    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
965 966 967 968
    Utils::SavedAction *action(int code) const;
    bool boolSetting(int code) const;
    QString stringSetting(int code) const;

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

971 972 973 974 975 976
    bool parseArgument(QStringList::const_iterator &it,
        const QStringList::const_iterator &cend,
        unsigned *enabledEngines, QString *errorMessage);
    bool parseArguments(const QStringList &args,
        unsigned *enabledEngines, QString *errorMessage);

977 978
    DebuggerToolTipManager *toolTipManager() const { return m_toolTipManager; }

979
public:
980
    DebuggerMainWindow *m_mainWindow;
981 982 983
    DebuggerRunControlFactory *m_debuggerRunControlFactory;

    QString m_previousMode;
984
    QList<DebuggerStartParameters> m_scheduledStarts;
985

986
    Utils::ProxyAction *m_visibleDebugAction;
987
    QAction *m_debugAction;
988 989
    QAction *m_startExternalAction;
    QAction *m_startRemoteAction;
990
    QAction *m_startRemoteCdbAction;
991
    QAction *m_startRemoteLldbAction;
992 993 994 995
    QAction *m_attachExternalAction;
    QAction *m_attachCoreAction;
    QAction *m_attachTcfAction;
    QAction *m_detachAction;
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
    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;

1015 1016
    QToolButton *m_reverseToolButton;

1017
    QIcon m_startIcon;
1018
    QIcon m_exitIcon;
1019
    QIcon m_continueIcon;
1020 1021 1022 1023 1024 1025 1026
    QIcon m_interruptIcon;
    QIcon m_locationMarkIcon;

    QLabel *m_statusLabel;
    QComboBox *m_threadBox;

    BreakWindow *m_breakWindow;
1027
    BreakHandler *m_breakHandler;
1028
    //ConsoleWindow *m_consoleWindow;
1029 1030 1031 1032 1033 1034 1035 1036 1037
    QTreeView *m_returnWindow;
    QTreeView *m_localsWindow;
    QTreeView *m_watchersWindow;
    QAbstractItemView *m_registerWindow;
    QAbstractItemView *m_modulesWindow;
    QAbstractItemView *m_snapshotWindow;
    SourceFilesWindow *m_sourceFilesWindow;
    QAbstractItemView *m_stackWindow;
    QAbstractItemView *m_threadsWindow;
1038
    LogWindow *m_logWindow;
1039
    ScriptConsole *m_scriptConsoleWindow;
1040 1041 1042 1043 1044

    bool m_busy;
    QTimer m_statusTimer;
    QString m_lastPermanentStatusMessage;

1045
    mutable CPlusPlus::Snapshot m_codeModelSnapshot;
1046 1047
    DebuggerPlugin *m_plugin;

1048
    SnapshotHandler *m_snapshotHandler;
1049
    bool m_shuttingDown;
hjk's avatar
hjk committed