debuggerplugin.cpp 115 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 29
** If you have questions regarding the use of this file, please contact
** 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 "debuggercore.h"
39 40
#include "debuggerdialogs.h"
#include "debuggerengine.h"
41
#include "debuggermainwindow.h"
con's avatar
con committed
42
#include "debuggerrunner.h"
43
#include "debuggerruncontrolfactory.h"
44
#include "debuggerstringutils.h"
45

46 47
#include "breakpoint.h"
#include "breakhandler.h"
48
#include "breakwindow.h"
49
#include "consolewindow.h"
50
#include "disassemblerlines.h"
51
#include "logwindow.h"
52
#include "moduleswindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
53
#include "moduleshandler.h"
54 55
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
56
#include "stackhandler.h"
57 58 59
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
60
#include "watchhandler.h"
61
#include "watchwindow.h"
hjk's avatar
hjk committed
62
#include "watchutils.h"
63
#include "debuggertooltipmanager.h"
64

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

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

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

88 89
#include <extensionsystem/pluginmanager.h>

90
#include <projectexplorer/project.h>
91
#include <projectexplorer/projectexplorer.h>
con's avatar
con committed
92
#include <projectexplorer/projectexplorerconstants.h>
93
#include <projectexplorer/toolchainmanager.h>
con's avatar
con committed
94
#include <projectexplorer/session.h>
95
#include <projectexplorer/target.h>
96
#include <projectexplorer/abi.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>
108
#include <utils/statuslabel.h>
con's avatar
con committed
109

110 111
#include <qml/scriptconsole.h>

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

125 126
#include <climits>

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

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

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
145
    \internal
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 271
*/

/*!
    \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
272

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

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


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



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

354
\endcode */
355

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

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

con's avatar
con committed
364 365 366 367

namespace Debugger {
namespace Constants {

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

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 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
    ~DummyEngine() {}

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

488 489 490 491 492 493
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

516

517 518 519 520 521 522
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

531 532 533 534 535 536 537 538 539 540 541
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;
}
542

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

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

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

565
class DebuggerPluginPrivate : public DebuggerCore
566 567
{
    Q_OBJECT
568

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

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

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

582
public slots:
583 584 585 586 587 588
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

589 590 591 592
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
593

hjk's avatar
hjk committed
594
    void breakpointSetMarginActionTriggered()
595
    {
596 597 598 599 600 601 602
        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);
603
    }
604

hjk's avatar
hjk committed
605
    void breakpointRemoveMarginActionTriggered()
606
    {
hjk's avatar
hjk committed
607 608
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
609
        m_breakHandler->removeBreakpoint(act->data().toInt());
hjk's avatar
hjk committed
610 611 612 613 614 615 616 617 618 619 620 621 622 623
     }

    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);
624 625
    }

626
    void updateWatchersHeader(int section, int, int newSize)
627 628 629
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
    }
630

631
    void sourceFilesDockToggled(bool on)
632
    {
633
        if (on && m_currentEngine->state() == InferiorStopOk)
634 635 636
            m_currentEngine->reloadSourceFiles();
    }

637
    void modulesDockToggled(bool on)
638
    {
639
        if (on && m_currentEngine->state() == InferiorStopOk)
640 641
            m_currentEngine->reloadModules();
    }
642

hjk's avatar
hjk committed
643
    void registerDockToggled(bool on)
644
    {
645
        if (on && m_currentEngine->state() == InferiorStopOk)
646 647
            m_currentEngine->reloadRegisters();
    }
648

649 650
    void synchronizeBreakpoints()
    {
651
        showMessage("ATTEMPT SYNC", LogDebug);
652
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
653
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
654 655 656 657
                engine->attemptBreakpointSynchronization();
        }
    }

hjk's avatar
hjk committed
658 659 660
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
661
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
662
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
663 664 665
        }
    }

666
    void editorOpened(Core::IEditor *editor);
667
    void updateBreakMenuItem(Core::IEditor *editor);
668 669 670 671
    void setBusyCursor(bool busy);
    void requestMark(TextEditor::ITextEditor *editor, int lineNumber);
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
672

673 674 675
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
676 677
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber);
    void toggleBreakpointByAddress(quint64 address);
678
    void onModeChanged(Core::IMode *mode);
679
    void onCoreAboutToOpen();
680
    void showSettingsDialog();
681

682
    void debugProject();
683
    void startExternalApplication();
684
    void startRemoteCdbSession();
685
    void startRemoteApplication();
686
    void startRemoteEngine();
687
    void attachExternalApplication();
688
    void attachExternalApplication(qint64 pid, const QString &binary,
689 690
                                   const ProjectExplorer::Abi &abi = ProjectExplorer::Abi(),
                                   const QString &debuggerCommand = QString());
691
    void runScheduled();
692
    void attachCore();
693 694 695
    void attachCore(const QString &core, const QString &exeFileName,
                    const ProjectExplorer::Abi &abi = ProjectExplorer::Abi(),
                    const QString &debuggerCommand = QString());
696
    void attachRemote(const QString &spec);
697

698
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
699
    void languagesChanged();
700
    void showStatusMessage(const QString &msg, int timeout = -1);
701
    void openMemoryEditor();
702

703 704 705
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

    void showQtDumperLibraryWarning(const QString &details);
hjk's avatar
hjk committed
706
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
707
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
708
        { return mainWindow()->isDockVisible(objectName); }
709 710

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

713 714
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
715
    DebuggerLanguages activeLanguages() const;
716 717
    unsigned enabledEngines() const { return m_cmdLineEnabledEngines; }
    QString debuggerForAbi(const Abi &abi, DebuggerEngineType et = NoEngineType) const;
718 719 720
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
721

722 723 724 725 726
    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;
727

ck's avatar
ck committed
728
    DebuggerRunControl *createDebugger(const DebuggerStartParameters &sp,
hjk's avatar
hjk committed
729 730
        RunConfiguration *rc = 0);
    void startDebugger(RunControl *runControl);
731
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
732 733 734

    void dumpLog();
    void cleanupViews();
735
    void setInitialState();
736 737 738 739

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

    void updateState(DebuggerEngine *engine);
740
    void updateWatchersWindow();
741
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
742 743 744 745

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
746

747
    void executeDebuggerCommand(const QString &command);
hjk's avatar
hjk committed
748
    void scriptExpressionEntered(const QString &expression);
749
    void coreShutdown();
750

hjk's avatar
hjk committed
751
public slots:
752
    void updateDebugActions();
753 754 755

    void handleExecDetach()
    {
756
        currentEngine()->resetLocation();
757 758 759 760 761
        currentEngine()->detachDebugger();
    }

    void handleExecContinue()
    {
762
        currentEngine()->resetLocation();
763 764 765 766 767
        currentEngine()->continueInferior();
    }

    void handleExecInterrupt()
    {
768
        currentEngine()->resetLocation();
769 770 771 772 773
        currentEngine()->requestInterruptInferior();
    }

    void handleExecReset()
    {
774
        currentEngine()->resetLocation();
775 776
        currentEngine()->notifyEngineIll(); // FIXME: Check.
    }
hjk's avatar
hjk committed
777 778 779

    void handleExecStep()
    {
780
        currentEngine()->resetLocation();
781
        if (boolSetting(OperateByInstruction))
hjk's avatar
hjk committed
782 783 784 785 786 787 788
            currentEngine()->executeStepI();
        else
            currentEngine()->executeStep();
    }

    void handleExecNext()
    {
789
        currentEngine()->resetLocation();
790
        if (boolSetting(OperateByInstruction))
hjk's avatar
hjk committed
791 792 793 794 795
            currentEngine()->executeNextI();
        else
            currentEngine()->executeNext();
    }

796 797
    void handleExecStepOut()
    {
798
        currentEngine()->resetLocation();
799 800 801 802 803
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
804
        currentEngine()->resetLocation();
805 806
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
807 808 809 810

    void handleExecJumpToLine()
    {
        //removeTooltip();
811
        currentEngine()->resetLocation();
812 813 814
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeJumpToLine(data);
hjk's avatar
hjk committed
815 816 817 818 819
    }

    void handleExecRunToLine()
    {
        //removeTooltip();
820
        currentEngine()->resetLocation();
821 822 823
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeRunToLine(data);
hjk's avatar
hjk committed
824 825
    }

826
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
827
    {
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
        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;
                }
            }
        }

852 853 854 855 856 857
        if (functionName.isEmpty()) {
            showStatusMessage(tr("No function selected."));
        } else {
            showStatusMessage(tr("Running to function \"%1\".")
                .arg(functionName));
            currentEngine()->resetLocation();
858
            currentEngine()->executeRunToFunction(functionName);
859
        }
hjk's avatar
hjk committed
860 861
    }

862 863 864 865
    void slotEditBreakpoint()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
hjk's avatar
hjk committed
866 867 868
        const BreakpointId id = act->data().toInt();
        QTC_ASSERT(id > 0, return);
        BreakWindow::editBreakpoint(id, mainWindow());
869 870 871 872
    }

    void slotRunToLine()
    {
873 874 875
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
        const ContextData data = action->data().value<ContextData>();
876
        currentEngine()->executeRunToLine(data);
877 878 879 880
    }

    void slotJumpToLine()
    {
881 882 883
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
        const ContextData data = action->data().value<ContextData>();
884
        currentEngine()->executeJumpToLine(data);
885 886
    }

hjk's avatar
hjk committed
887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
    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()
    {
917
        currentEngine()->exitDebugger();
hjk's avatar
hjk committed
918 919 920 921 922 923 924 925 926 927 928 929
    }

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

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

930
    void handleOperateByInstructionTriggered(bool operateByInstructionTriggered)
hjk's avatar
hjk committed
931
    {
932 933 934
        // Go to source only if we have the file.
        if (currentEngine()->stackHandler()->currentIndex() >= 0) {
            const StackFrame frame = currentEngine()->stackHandler()->currentFrame();
935 936 937
            if (operateByInstructionTriggered || frame.isUsable()) {
                currentEngine()->gotoLocation(Location(frame, true));
            }
938
        }
hjk's avatar
hjk committed
939 940
    }

941
    bool isActiveDebugLanguage(int lang) const
hjk's avatar
hjk committed
942
    {
943
        return m_mainWindow->activeDebugLanguages() & lang;
hjk's avatar
hjk committed
944 945
    }

946 947 948 949 950 951 952 953
    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
954 955 956 957
    Utils::SavedAction *action(int code) const;
    bool boolSetting(int code) const;
    QString stringSetting(int code) const;

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

960 961 962 963 964 965
    bool parseArgument(QStringList::const_iterator &it,
        const QStringList::const_iterator &cend,
        unsigned *enabledEngines, QString *errorMessage);
    bool parseArguments(const QStringList &args,
        unsigned *enabledEngines, QString *errorMessage);

966
    DebuggerToolTipManager *toolTipManager() const { return m_toolTipManager; }
967
    virtual QSharedPointer<GlobalDebuggerOptions> globalDebuggerOptions() const { return m_globalDebuggerOptions; }
968

969
public:
970
    DebuggerMainWindow *m_mainWindow;
971 972 973
    DebuggerRunControlFactory *m_debuggerRunControlFactory;

    QString m_previousMode;
974
    QList<DebuggerStartParameters> m_scheduledStarts;
975

976
    Utils::ProxyAction *m_visibleDebugAction;
977
    QAction *m_debugAction;
978 979
    QAction *m_startExternalAction;
    QAction *m_startRemoteAction;
980
    QAction *m_startRemoteCdbAction;
981
    QAction *m_startRemoteLldbAction;
982 983 984
    QAction *m_attachExternalAction;
    QAction *m_attachCoreAction;
    QAction *m_detachAction;
985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
    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;

1004 1005
    QToolButton *m_reverseToolButton;

1006
    QIcon m_startIcon;
1007
    QIcon m_exitIcon;
1008
    QIcon m_continueIcon;
1009 1010 1011
    QIcon m_interruptIcon;
    QIcon m_locationMarkIcon;

1012
    Utils::StatusLabel *m_statusLabel;
1013 1014 1015
    QComboBox *m_threadBox;

    BreakWindow *m_breakWindow;
1016
    BreakHandler *m_breakHandler;
1017
    //ConsoleWindow *m_consoleWindow;
1018 1019 1020 1021 1022 1023 1024 1025 1026
    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;
1027
    LogWindow *m_logWindow;
1028
    ScriptConsole *m_scriptConsoleWindow;
1029 1030 1031 1032

    bool m_busy;
    QString m_lastPermanentStatusMessage;

1033
    mutable CPlusPlus::Snapshot m_codeModelSnapshot;
1034 1035
    DebuggerPlugin *m_plugin;

1036
    SnapshotHandler *m_snapshotHandler;
1037
    bool m_shuttingDown;
hjk's avatar
hjk committed
1038
    DebuggerEngine *m_currentEngine;
hjk's avatar
hjk committed
1039 1040 1041
    DebuggerSettings *m_debuggerSettings;
    QSettings *m_coreSettings;
    bool m_gdbBinariesChanged;
1042
    uint m_cmdLineEnabledEngines;
1043
    QStringList m_arguments;
1044
    DebuggerToolTipManager *m_toolTipManager;
1045
    CommonOptionsPage *m_commonOptionsPage;
1046
    DummyEngine *m_dummyEngine;