debuggerplugin.cpp 129 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
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
29
** 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 "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/abi.h>
con's avatar
con committed
94
#include <projectexplorer/projectexplorerconstants.h>
95 96 97
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/projectexplorersettings.h>
#include <projectexplorer/project.h>
con's avatar
con committed
98
#include <projectexplorer/session.h>
99
#include <projectexplorer/target.h>
100 101
#include <projectexplorer/toolchain.h>
#include <projectexplorer/toolchainmanager.h>
hjk's avatar
hjk committed
102

103
#include <qtsupport/qtsupportconstants.h>
104

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

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

116
#include <qml/qmljsscriptconsole.h>
117

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

132 133
#include <climits>

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

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

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

/*!
    \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
161
    gdbserver, the CODA client etc are referred to as 'Engine',
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 278
    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
279

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

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


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



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

361
\endcode */
362

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

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

con's avatar
con committed
371 372 373 374

namespace Debugger {
namespace Constants {

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

} // namespace Constants


410 411
namespace Internal {

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

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

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

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

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

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

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

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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

492 493 494 495 496 497
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

520

521 522 523 524 525 526
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

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

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

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

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

569
class DebuggerPluginPrivate : public DebuggerCore
570 571
{
    Q_OBJECT
572

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

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

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

586 587 588 589 590 591 592 593 594 595
    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);
    }

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

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

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

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

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

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

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

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

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

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

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

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

707
    void editorOpened(Core::IEditor *editor);
708
    void updateBreakMenuItem(Core::IEditor *editor);
709
    void setBusyCursor(bool busy);
710 711 712
    void requestMark(TextEditor::ITextEditor *editor,
                     int lineNumber,
                     TextEditor::ITextEditor::MarkRequestKind kind);
713 714
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
715

716 717 718
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
719 720 721 722
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
723
    void onModeChanged(Core::IMode *mode);
724
    void onCoreAboutToOpen();
725
    void showSettingsDialog();
726
    void updateDebugWithoutDeployMenu();
727

728
    void debugProject();
729
    void debugProjectWithoutDeploy();
730
    void debugProjectBreakMain();
731
    void startExternalApplication();
732
    void startRemoteCdbSession();
733
    void startRemoteApplication();
734 735
    bool queryRemoteParameters(DebuggerStartParameters &sp, bool useScript);
    void attachRemoteApplication();
736
    void attachToQmlPort();
737
    void startRemoteEngine();
738
    void attachExternalApplication();
739
    Q_SLOT void attachExternalApplication(ProjectExplorer::RunControl *rc);
740
    void runScheduled();
741
    void attachCore();
742
    void attachRemote(const QString &spec);
743

744
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
745
    void languagesChanged();
746
    void showStatusMessage(const QString &msg, int timeout = -1);
747
    void openMemoryEditor();
748

749 750 751
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

    void showQtDumperLibraryWarning(const QString &details);
hjk's avatar
hjk committed
752
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
753
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
754
        { return mainWindow()->isDockVisible(objectName); }
755 756

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

759 760
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
761
    DebuggerLanguages activeLanguages() const;
762 763
    unsigned enabledEngines() const { return m_cmdLineEnabledEngines; }
    QString debuggerForAbi(const Abi &abi, DebuggerEngineType et = NoEngineType) const;
764 765 766
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
767

768 769 770 771 772
    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;
773

ck's avatar
ck committed
774
    DebuggerRunControl *createDebugger(const DebuggerStartParameters &sp,
hjk's avatar
hjk committed
775 776
        RunConfiguration *rc = 0);
    void startDebugger(RunControl *runControl);
777
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
778 779 780

    void dumpLog();
    void cleanupViews();
781
    void setInitialState();
782 783 784 785

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

    void updateState(DebuggerEngine *engine);
786
    void updateWatchersWindow();
787
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
788 789 790 791

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
792

793
    void executeDebuggerCommand(const QString &command);
794
    void evaluateExpression(const QString &expression);
795
    void coreShutdown();
796

hjk's avatar
hjk committed
797
public slots:
798
    void updateDebugActions();
799 800 801

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

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

    void handleExecInterrupt()
    {
814
        currentEngine()->resetLocation();
815 816 817
        currentEngine()->requestInterruptInferior();
    }

818
    void handleAbort()
819
    {
820
        currentEngine()->resetLocation();
821
        currentEngine()->abortDebugger();
822
    }
hjk's avatar
hjk committed
823 824 825

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

    void handleExecNext()
    {
839 840 841 842 843 844 845 846 847
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeNextI();
            else
                currentEngine()->executeNext();
        }
hjk's avatar
hjk committed
848 849
    }

850 851
    void handleExecStepOut()
    {
852
        currentEngine()->resetLocation();
853 854 855 856 857
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
858
        currentEngine()->resetLocation();
859 860
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
861 862 863 864

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

    void handleExecRunToLine()
    {
        //removeTooltip();
874
        currentEngine()->resetLocation();
875 876 877
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeRunToLine(data);
hjk's avatar
hjk committed
878 879
    }

880
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
881
    {
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
        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;
                }
            }
        }

906 907 908 909 910 911
        if (functionName.isEmpty()) {
            showStatusMessage(tr("No function selected."));
        } else {
            showStatusMessage(tr("Running to function \"%1\".")
                .arg(functionName));
            currentEngine()->resetLocation();
912
            currentEngine()->executeRunToFunction(functionName);
913
        }
hjk's avatar
hjk committed
914 915
    }

916 917 918 919
    void slotEditBreakpoint()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
920
        const BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
921 922
        QTC_ASSERT(id > 0, return);
        BreakWindow::editBreakpoint(id, mainWindow());
923 924 925 926
    }

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

    void slotJumpToLine()
    {
935 936
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
937
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
938
        currentEngine()->executeJumpToLine(data);
939 940
    }

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

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

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

984
    void handleOperateByInstructionTriggered(bool operateByInstructionTriggered)
hjk's avatar
hjk committed
985
    {
986 987 988
        // Go to source only if we have the file.
        if (currentEngine()->stackHandler()->currentIndex() >= 0) {
            const StackFrame frame = currentEngine()->stackHandler()->currentFrame();
989 990 991
            if (operateByInstructionTriggered || frame.isUsable()) {
                currentEngine()->gotoLocation(Location(frame, true));
            }
992
        }
hjk's avatar
hjk committed
993 994
    }

995
    bool isActiveDebugLanguage(int lang) const
hjk's avatar
hjk committed
996
    {
997
        return m_mainWindow->activeDebugLanguages() & lang;
hjk's avatar
hjk committed
998 999
    }

1000 1001 1002 1003 1004 1005 1006 1007
    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
1008 1009 1010 1011
    Utils::SavedAction *action(int code) const;
    bool boolSetting(int code) const;
    QString stringSetting(int code) const;

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

1014 1015 1016 1017 1018 1019
    bool parseArgument(QStringList::const_iterator &it,
        const QStringList::const_iterator &cend,
        unsigned *enabledEngines, QString *errorMessage);
    bool parseArguments(const QStringList &args,
        unsigned *enabledEngines, QString *errorMessage);

1020
    DebuggerToolTipManager *toolTipManager() const { return m_toolTipManager; }
1021
    virtual QSharedPointer<GlobalDebuggerOptions> globalDebuggerOptions() const { return m_globalDebuggerOptions; }
1022

1023 1024 1025
    // FIXME: Remove.
    void maybeEnrichParameters(DebuggerStartParameters *sp);

1026
public:
1027
    DebuggerMainWindow *m_mainWindow;
1028 1029 1030
    DebuggerRunControlFactory *m_debuggerRunControlFactory;

    QString m_previousMode;
1031
    QList<DebuggerStartParameters> m_scheduledStarts;
1032

hjk's avatar
hjk committed
1033 1034 1035
    Utils::ProxyAction *m_visibleStartAction;
    Utils::ProxyAction *m_hiddenStopAction;
    QAction *m_startAction;