debuggerplugin.cpp 127 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
#include "qml/qmlengine.h"
#include "qml/qmlcppengine.h"
67

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

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

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

91 92
#include <extensionsystem/pluginmanager.h>

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

102
#include <qtsupport/qtsupportconstants.h>
103

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

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

115
#include <qml/qmljsscriptconsole.h>
116

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

131 132
#include <climits>

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

143 144 145 146 147 148 149 150
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

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

/*!
    \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
160
    gdbserver, the CODA client etc are referred to as 'Engine',
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
    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
278

279 280 281
/* 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
282

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


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



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

360
\endcode */
361

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

hjk's avatar
hjk committed
367 368 369
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
370 371 372 373

namespace Debugger {
namespace Constants {

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

} // namespace Constants


409 410
namespace Internal {

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

432 433 434 435 436 437
// 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.

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

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

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

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

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

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
478
    DummyEngine() : DebuggerEngine(DebuggerStartParameters(), AnyLanguage) {}
479 480 481 482 483 484 485
    ~DummyEngine() {}

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

491 492 493 494 495 496
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

519

520 521 522 523 524 525
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

534 535 536 537 538 539 540 541 542 543 544
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;
}
545

546 547
///////////////////////////////////////////////////////////////////////
//
548
// DebuggerPluginPrivate
549 550
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
551

552
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
553

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

568
class DebuggerPluginPrivate : public DebuggerCore
569 570
{
    Q_OBJECT
571

572 573
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
574
    ~DebuggerPluginPrivate();
575

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

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

585 586 587 588 589 590 591 592 593 594
    void setThreads(const QStringList &list, int index)
    {
        const bool state = m_threadBox->blockSignals(true);
        m_threadBox->clear();
        foreach (const QString &item, list)
            m_threadBox->addItem(item);
        m_threadBox->setCurrentIndex(index);
        m_threadBox->blockSignals(state);
    }

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

602 603 604 605
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
606

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

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

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

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

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

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

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

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

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

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

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

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

723
    void debugProject();
724
    void debugProjectBreakMain();
725
    void startExternalApplication();
726
    void startRemoteCdbSession();
727
    void startRemoteApplication();
728 729
    bool queryRemoteParameters(DebuggerStartParameters &sp, bool useScript);
    void attachRemoteApplication();
730
    void attachToQmlPort();
731
    void startRemoteEngine();
732
    void attachExternalApplication();
733
    Q_SLOT void attachExternalApplication(ProjectExplorer::RunControl *rc);
734
    void runScheduled();
735
    void attachCore();
736
    void attachRemote(const QString &spec);
737

738
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
739
    void languagesChanged();
740
    void showStatusMessage(const QString &msg, int timeout = -1);
741
    void openMemoryEditor();
742

743 744 745
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

    void showQtDumperLibraryWarning(const QString &details);
hjk's avatar
hjk committed
746
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
747
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
748
        { return mainWindow()->isDockVisible(objectName); }
749 750

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

753 754
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
755
    DebuggerLanguages activeLanguages() const;
756 757
    unsigned enabledEngines() const { return m_cmdLineEnabledEngines; }
    QString debuggerForAbi(const Abi &abi, DebuggerEngineType et = NoEngineType) const;
758 759 760
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
761

762 763 764 765 766
    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;
767

ck's avatar
ck committed
768
    DebuggerRunControl *createDebugger(const DebuggerStartParameters &sp,
hjk's avatar
hjk committed
769 770
        RunConfiguration *rc = 0);
    void startDebugger(RunControl *runControl);
771
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
772 773 774

    void dumpLog();
    void cleanupViews();
775
    void setInitialState();
776 777 778 779

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

    void updateState(DebuggerEngine *engine);
780
    void updateWatchersWindow();
781
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
782 783 784 785

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
786

787
    void executeDebuggerCommand(const QString &command);
788
    void evaluateExpression(const QString &expression);
789
    void coreShutdown();
790

hjk's avatar
hjk committed
791
public slots:
792
    void updateDebugActions();
793 794 795

    void handleExecDetach()
    {
796
        currentEngine()->resetLocation();
797 798 799 800 801
        currentEngine()->detachDebugger();
    }

    void handleExecContinue()
    {
802
        currentEngine()->resetLocation();
803 804 805 806 807
        currentEngine()->continueInferior();
    }

    void handleExecInterrupt()
    {
808
        currentEngine()->resetLocation();
809 810 811 812 813
        currentEngine()->requestInterruptInferior();
    }

    void handleExecReset()
    {
814
        currentEngine()->resetLocation();
815 816
        currentEngine()->notifyEngineIll(); // FIXME: Check.
    }
hjk's avatar
hjk committed
817 818 819

    void handleExecStep()
    {
820 821 822 823 824 825 826 827 828
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeStepI();
            else
                currentEngine()->executeStep();
        }
hjk's avatar
hjk committed
829 830 831 832
    }

    void handleExecNext()
    {
833 834 835 836 837 838 839 840 841
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeNextI();
            else
                currentEngine()->executeNext();
        }
hjk's avatar
hjk committed
842 843
    }

844 845
    void handleExecStepOut()
    {
846
        currentEngine()->resetLocation();
847 848 849 850 851
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
852
        currentEngine()->resetLocation();
853 854
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
855 856 857 858

    void handleExecJumpToLine()
    {
        //removeTooltip();
859
        currentEngine()->resetLocation();
860 861 862
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeJumpToLine(data);
hjk's avatar
hjk committed
863 864 865 866 867
    }

    void handleExecRunToLine()
    {
        //removeTooltip();
868
        currentEngine()->resetLocation();
869 870 871
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeRunToLine(data);
hjk's avatar
hjk committed
872 873
    }

874
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
875
    {
876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899
        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;
                }
            }
        }

900 901 902 903 904 905
        if (functionName.isEmpty()) {
            showStatusMessage(tr("No function selected."));
        } else {
            showStatusMessage(tr("Running to function \"%1\".")
                .arg(functionName));
            currentEngine()->resetLocation();
906
            currentEngine()->executeRunToFunction(functionName);
907
        }
hjk's avatar
hjk committed
908 909
    }

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

    void slotRunToLine()
    {
921 922
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
923
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
924
        currentEngine()->executeRunToLine(data);
925 926 927 928
    }

    void slotJumpToLine()
    {
929 930
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
931
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
932
        currentEngine()->executeJumpToLine(data);
933 934
    }

hjk's avatar
hjk committed
935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
    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()
    {
965
        currentEngine()->exitDebugger();
hjk's avatar
hjk committed
966 967 968 969 970 971 972 973 974 975 976 977
    }

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

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

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

989
    bool isActiveDebugLanguage(int lang) const
hjk's avatar
hjk committed
990
    {
991
        return m_mainWindow->activeDebugLanguages() & lang;
hjk's avatar
hjk committed
992 993
    }

994 995 996 997 998 999 1000 1001
    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
1002 1003 1004 1005
    Utils::SavedAction *action(int code) const;
    bool boolSetting(int code) const;
    QString stringSetting(int code) const;

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

1008 1009 1010 1011 1012 1013
    bool parseArgument(QStringList::const_iterator &it,
        const QStringList::const_iterator &cend,
        unsigned *enabledEngines, QString *errorMessage);
    bool parseArguments(const QStringList &args,
        unsigned *enabledEngines, QString *errorMessage);

1014
    DebuggerToolTipManager *toolTipManager() const { return m_toolTipManager; }
1015
    virtual QSharedPointer<GlobalDebuggerOptions> globalDebuggerOptions() const { return m_globalDebuggerOptions; }
1016

1017 1018 1019
    // FIXME: Remove.
    void maybeEnrichParameters(DebuggerStartParameters *sp);

1020
public:
1021
    DebuggerMainWindow *m_mainWindow;
1022 1023 1024
    DebuggerRunControlFactory *m_debuggerRunControlFactory;

    QString m_previousMode;
1025
    QList<DebuggerStartParameters> m_scheduledStarts;
1026

hjk's avatar
hjk committed
1027 1028 1029
    Utils::ProxyAction *m_visibleStartAction;
    Utils::ProxyAction *m_hiddenStopAction;
    QAction *m_startAction;
1030 1031
    QAction *m_startExternalAction;
    QAction *m_startRemoteAction;
1032
    QAction *m_attachToQmlPortAction;
1033
    QAction *m_attachRemoteAction;
1034
    QAction *m_startRemoteCdbAction;
1035
    QAction *m_startRemoteLldbAction;
1036 1037 1038
    QAction *m_attachExternalAction;
    QAction *m_attachCoreAction;
    QAction *m_detachAction;
hjk's avatar