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/uniqueidmanager.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>
con's avatar
con committed
95
#include <projectexplorer/session.h>
96
#include <projectexplorer/target.h>
97
#include <projectexplorer/abi.h>
hjk's avatar
hjk committed
98

99
#include <qtsupport/qtsupportconstants.h>
100

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

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

112 113
#include <qml/scriptconsole.h>

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

128 129
#include <climits>

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

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

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

/*!
    \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
157
    gdbserver, the CODA client etc are referred to as 'Engine',
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 272 273 274
    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
275

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

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


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



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

357
\endcode */
358

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

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

con's avatar
con committed
367 368 369 370

namespace Debugger {
namespace Constants {

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

} // namespace Constants


406 407
namespace Internal {

408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
// 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 {

429 430 431 432 433 434
// 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
static Abi anyAbiOfBinary(const QString &fileName)
457 458 459 460 461 462
{
    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(BreakpointModelId) 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
        setDisplayName(DebuggerPlugin::tr("Debug"));
        setIcon(QIcon(QLatin1String(":/fancyactionbar/images/mode_Debug.png")));
503
        setPriority(85);
504 505
        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
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
hjk's avatar
hjk committed
598 599
        const BreakpointMenuContextData data =
            action->data().value<BreakpointMenuContextData>();
600 601 602 603 604 605 606 607 608 609 610 611 612
        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
613
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
614 615 616 617 618 619 620 621
            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();
        }
622
        if (data.address)
623
            toggleBreakpointByAddress(data.address, message);
624
        else
625
            toggleBreakpointByFileAndLine(data.fileName, data.lineNumber, message);
626
    }
627

hjk's avatar
hjk committed
628
    void breakpointRemoveMarginActionTriggered()
629
    {
hjk's avatar
hjk committed
630 631
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
632
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
633
        m_breakHandler->removeBreakpoint(id);
hjk's avatar
hjk committed
634 635 636 637 638 639
     }

    void breakpointEnableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
640
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
641
        breakHandler()->setEnabled(id, true);
hjk's avatar
hjk committed
642 643 644 645 646 647
    }

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

652
    void updateWatchersHeader(int section, int, int newSize)
653 654 655
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
    }
656

657
    void sourceFilesDockToggled(bool on)
658
    {
659
        if (on && m_currentEngine->state() == InferiorStopOk)
660 661 662
            m_currentEngine->reloadSourceFiles();
    }

663
    void modulesDockToggled(bool on)
664
    {
665
        if (on && m_currentEngine->state() == InferiorStopOk)
666 667
            m_currentEngine->reloadModules();
    }
668

hjk's avatar
hjk committed
669
    void registerDockToggled(bool on)
670
    {
671
        if (on && m_currentEngine->state() == InferiorStopOk)
672 673
            m_currentEngine->reloadRegisters();
    }
674

675 676
    void synchronizeBreakpoints()
    {
677
        showMessage("ATTEMPT SYNC", LogDebug);
678
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
679
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
680 681 682 683
                engine->attemptBreakpointSynchronization();
        }
    }

hjk's avatar
hjk committed
684 685 686
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
687
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
688
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
689 690 691
        }
    }

692
    void editorOpened(Core::IEditor *editor);
693
    void updateBreakMenuItem(Core::IEditor *editor);
694 695 696 697
    void setBusyCursor(bool busy);
    void requestMark(TextEditor::ITextEditor *editor, int lineNumber);
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
698

699 700 701
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
702 703 704 705
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
706
    void onModeChanged(Core::IMode *mode);
707
    void onCoreAboutToOpen();
708
    void showSettingsDialog();
709

710
    void debugProject();
711
    void debugProjectBreakMain();
712
    void startExternalApplication();
713
    void startRemoteCdbSession();
714
    void startRemoteApplication();
715
    void startRemoteEngine();
716
    void attachExternalApplication();
717
    Q_SLOT void attachExternalApplication(ProjectExplorer::RunControl *rc);
718
    void runScheduled();
719
    void attachCore();
720
    void attachRemote(const QString &spec);
721

722
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
723
    void languagesChanged();
724
    void showStatusMessage(const QString &msg, int timeout = -1);
725
    void openMemoryEditor();
726

727 728 729
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

    void showQtDumperLibraryWarning(const QString &details);
hjk's avatar
hjk committed
730
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
731
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
732
        { return mainWindow()->isDockVisible(objectName); }
733 734

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

737 738
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
739
    DebuggerLanguages activeLanguages() const;
740 741
    unsigned enabledEngines() const { return m_cmdLineEnabledEngines; }
    QString debuggerForAbi(const Abi &abi, DebuggerEngineType et = NoEngineType) const;
742 743 744
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
745

746 747 748 749 750
    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;
751

ck's avatar
ck committed
752
    DebuggerRunControl *createDebugger(const DebuggerStartParameters &sp,
hjk's avatar
hjk committed
753 754
        RunConfiguration *rc = 0);
    void startDebugger(RunControl *runControl);
755
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
756 757 758

    void dumpLog();
    void cleanupViews();
759
    void setInitialState();
760 761 762 763

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

    void updateState(DebuggerEngine *engine);
764
    void updateWatchersWindow();
765
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
766 767 768 769

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
770

771
    void executeDebuggerCommand(const QString &command);
hjk's avatar
hjk committed
772
    void scriptExpressionEntered(const QString &expression);
773
    void coreShutdown();
774

hjk's avatar
hjk committed
775
public slots:
776
    void updateDebugActions();
777 778 779

    void handleExecDetach()
    {
780
        currentEngine()->resetLocation();
781 782 783 784 785
        currentEngine()->detachDebugger();
    }

    void handleExecContinue()
    {
786
        currentEngine()->resetLocation();
787 788 789 790 791
        currentEngine()->continueInferior();
    }

    void handleExecInterrupt()
    {
792
        currentEngine()->resetLocation();
793 794 795 796 797
        currentEngine()->requestInterruptInferior();
    }

    void handleExecReset()
    {
798
        currentEngine()->resetLocation();
799 800
        currentEngine()->notifyEngineIll(); // FIXME: Check.
    }
hjk's avatar
hjk committed
801 802 803

    void handleExecStep()
    {
804 805 806 807 808 809 810 811 812
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeStepI();
            else
                currentEngine()->executeStep();
        }
hjk's avatar
hjk committed
813 814 815 816
    }

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

828 829
    void handleExecStepOut()
    {
830
        currentEngine()->resetLocation();
831 832 833 834 835
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
836
        currentEngine()->resetLocation();
837 838
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
839 840 841 842

    void handleExecJumpToLine()
    {
        //removeTooltip();
843
        currentEngine()->resetLocation();
844 845 846
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeJumpToLine(data);
hjk's avatar
hjk committed
847 848 849 850 851
    }

    void handleExecRunToLine()
    {
        //removeTooltip();
852
        currentEngine()->resetLocation();
853 854 855
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeRunToLine(data);
hjk's avatar
hjk committed
856 857
    }

858
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
859
    {
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
        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;
                }
            }
        }

884 885 886 887 888 889
        if (functionName.isEmpty()) {
            showStatusMessage(tr("No function selected."));
        } else {
            showStatusMessage(tr("Running to function \"%1\".")
                .arg(functionName));
            currentEngine()->resetLocation();
890
            currentEngine()->executeRunToFunction(functionName);
891
        }
hjk's avatar
hjk committed
892 893
    }

894 895 896 897
    void slotEditBreakpoint()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
898
        const BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
899 900
        QTC_ASSERT(id > 0, return);
        BreakWindow::editBreakpoint(id, mainWindow());
901 902 903 904
    }

    void slotRunToLine()
    {
905 906 907
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
        const ContextData data = action->data().value<ContextData>();
908
        currentEngine()->executeRunToLine(data);
909 910 911 912
    }

    void slotJumpToLine()
    {
913 914 915
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
        const ContextData data = action->data().value<ContextData>();
916
        currentEngine()->executeJumpToLine(data);
917 918
    }

hjk's avatar
hjk committed
919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
    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()
    {
949
        currentEngine()->exitDebugger();
hjk's avatar
hjk committed
950 951 952 953 954 955 956 957 958 959 960 961
    }

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

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

962
    void handleOperateByInstructionTriggered(bool operateByInstructionTriggered)
hjk's avatar
hjk committed
963
    {
964 965 966
        // Go to source only if we have the file.
        if (currentEngine()->stackHandler()->currentIndex() >= 0) {
            const StackFrame frame = currentEngine()->stackHandler()->currentFrame();
967 968 969
            if (operateByInstructionTriggered || frame.isUsable()) {
                currentEngine()->gotoLocation(Location(frame, true));
            }
970
        }
hjk's avatar
hjk committed
971 972
    }

973
    bool isActiveDebugLanguage(int lang) const
hjk's avatar
hjk committed
974
    {
975
        return m_mainWindow->activeDebugLanguages() & lang;
hjk's avatar
hjk committed
<