debuggerplugin.cpp 117 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
con's avatar
con committed
9
** No Commercial Usage
10
**
con's avatar
con committed
11 12 13 14
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
15
**
16
** GNU Lesser General Public License Usage
17
**
18 19 20 21 22 23
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24
**
con's avatar
con committed
25 26 27 28 29 30
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
con's avatar
con committed
31
**
32
**************************************************************************/
hjk's avatar
hjk committed
33

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

Friedemann Kleint's avatar
Friedemann Kleint committed
36
#include "debuggerstartparameters.h"
37
#include "debuggeractions.h"
con's avatar
con committed
38
#include "debuggerconstants.h"
39
#include "debuggercore.h"
40 41
#include "debuggerdialogs.h"
#include "debuggerengine.h"
42
#include "debuggermainwindow.h"
con's avatar
con committed
43
#include "debuggerrunner.h"
44
#include "debuggerruncontrolfactory.h"
45
#include "debuggerstringutils.h"
46 47
#include "debuggertooltip.h"

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

66 67
#include "snapshothandler.h"
#include "threadshandler.h"
hjk's avatar
hjk committed
68
#include "gdb/gdboptionspage.h"
con's avatar
con committed
69

70
#include "ui_commonoptionspage.h"
hjk's avatar
hjk committed
71
#include "ui_dumperoptionpage.h"
72

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

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

93 94
#include <extensionsystem/pluginmanager.h>

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

103 104
#include <qt4projectmanager/qt4projectmanagerconstants.h>

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>
con's avatar
con committed
112

113 114
#include <qml/scriptconsole.h>

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

128 129
#include <climits>

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

// Note: the Debugger process itself and any helper processes like
141
// gdbserver, the trk client etc are referred to as 'Engine',
142 143
// whereas the debugged process is referred to as 'Inferior'.
//
144 145
// Transitions marked by '---' are done in the individual engines.
// Transitions marked by '+-+' are done in the base DebuggerEngine.
hjk's avatar
hjk committed
146
// Transitions marked by '*' are done asynchronously.
hjk's avatar
hjk committed
147
// The GdbEngine->setupEngine() function is described in more detail below.
148
//
hjk's avatar
hjk committed
149 150 151 152 153 154 155
// 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.
//
//
//
hjk's avatar
hjk committed
156 157 158 159 160 161
//                        DebuggerNotReady
//                               +
//                      EngineSetupRequested
//                               +
//                  (calls *Engine->setupEngine())
//                            |      |
162
//                            |      |
hjk's avatar
hjk committed
163 164 165
//                       {notify-  {notify-
//                        Engine-   Engine-
//                        SetupOk}  SetupFailed}
166 167 168 169 170 171
//                            +      +
//                            +      `+-+-+> EngineSetupFailed
//                            +                   +
//                            +    [calls RunControl->startFailed]
//                            +                   +
//                            +             DebuggerFinished
hjk's avatar
hjk committed
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
//                            v
//                      EngineSetupOk
//                            +
//             [calls RunControl->StartSuccessful]
//                            +
//                  InferiorSetupRequested
//                            +
//             (calls *Engine->setupInferior())
//                         |       |
//                         |       |
//                    {notify-   {notify-
//                     Inferior- Inferior-
//                     SetupOk}  SetupFailed}
//                         +       +
//                         +       ` +-+-> InferiorSetupFailed +-+-+-+-+-+->.
//                         +                                                +
//                         +                                                +
//                  EngineRunRequested                                      +
//                         +                                                +
//                 (calls *Engine->runEngine())                             +
//               /       |            |        \                            +
//             /         |            |          \                          +
//            | (core)   | (attach)   |           |                         +
//            |          |            |           |                         +
//      {notify-    {notifyER&- {notifyER&-  {notify-                       +
197
//      Inferior-     Inferior-   Inferior-  EngineRun-                     +
hjk's avatar
hjk committed
198 199 200 201 202 203 204 205
//     Unrunnable}     StopOk}     RunOk}     Failed}                       +
//           +           +            +           +                         +
//   InferiorUnrunnable  +     InferiorRunOk      +                         +
//                       +                        +                         +
//                InferiorStopOk            EngineRunFailed                 +
//                                                +                         v
//                                                 `-+-+-+-+-+-+-+-+-+-+-+>-+
//                                                                          +
hjk's avatar
hjk committed
206
//                                                                          +
207
//                       #Interrupt@InferiorRunOk#                          +
hjk's avatar
hjk committed
208
//                                  +                                       +
hjk's avatar
hjk committed
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
//                          InferiorStopRequested                           +
//  #SpontaneousStop                +                                       +
//   @InferiorRunOk#         (calls *Engine->                               +
//          +               interruptInferior())                            +
//      {notify-               |          |                                 +
//     Spontaneous-       {notify-    {notify-                              +
//      Inferior-          Inferior-   Inferior-                            +
//       StopOk}           StopOk}    StopFailed}                           +
//           +              +             +                                 +
//            +            +              +                                 +
//            InferiorStopOk              +                                 +
//                  +                     +                                 +
//                  +                    +                                  +
//                  +                   +                                   +
//        #Stop@InferiorUnrunnable#    +                                    +
//          #Creator Close Event#     +                                     +
//                       +           +                                      +
hjk's avatar
hjk committed
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
//                InferiorShutdownRequested                                 +
//                            +                                             +
//           (calls *Engine->shutdownInferior())                            +
//                         |        |                                       +
//                    {notify-   {notify-                                   +
//                     Inferior- Inferior-                                  +
//                  ShutdownOk}  ShutdownFailed}                            +
//                         +        +                                       +
//                         +        +                                       +
//  #Inferior exited#      +        +                                       +
//         |               +        +                                       +
//   {notifyInferior-      +        +                                       +
//      Exited}            +        +                                       +
//           +             +        +                                       +
//            +            +        +                                       +
//             +           +        +                                       +
//            InferiorShutdownOk InferiorShutdownFailed                     +
//                      *          *                                        +
//                  EngineShutdownRequested                                 +
//                            +                                             +
246
//           (calls *Engine->shutdownEngine())  <+-+-+-+-+-+-+-+-+-+-+-+-+-+'
hjk's avatar
hjk committed
247 248 249
//                         |        |
//                         |        |
//                    {notify-   {notify-
hjk's avatar
hjk committed
250
//                     Engine-    Engine-
hjk's avatar
hjk committed
251 252 253
//                  ShutdownOk}  ShutdownFailed}
//                         +       +
//            EngineShutdownOk  EngineShutdownFailed
hjk's avatar
hjk committed
254 255
//                         *       *
//                     DebuggerFinished
hjk's avatar
hjk committed
256 257 258
//


259 260 261
/* 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
262

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
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" ];
sg1:   InferiorSetupRequested -> InferiorSetupFailed [ label="notifyInferiorFailed", style="dashed" ];
sg1:   InferiorSetupRequested -> EngineRunRequested [ label="notifyInferiorSetupOk", style="dashed" ];
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
sg1:   InferiorShutdownRequested -> InferiorShutdownOk [ label= "Engine::shutdownInferior\nnotifyInferiorShutdownOk", style="dashed" ];
sg1:   InferiorShutdownRequested -> InferiorShutdownFailed [ label="Engine::shutdownInferior\nnotifyInferiorShutdownFailed", style="dashed" ];
sg1:   InferiorExited -> InferiorShutdownOk [ label="notifyInferiorExited", style="dashed"];
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
296
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
297 298 299


// GdbEngine specific startup. All happens in EngineSetupRequested state
300
//
301 302
// Transitions marked by '---' are done in the individual adapters.
// Transitions marked by '+-+' are done in the GdbEngine.
hjk's avatar
hjk committed
303
//
hjk's avatar
hjk committed
304
//                  GdbEngine::setupEngine()
305 306 307 308 309
//                          +
//            (calls *Adapter->startAdapter())
//                          |      |
//                          |      `---> handleAdapterStartFailed()
//                          |                   +
hjk's avatar
hjk committed
310
//                          |             {notifyEngineSetupFailed}
311 312 313
//                          |
//                 handleAdapterStarted()
//                          +
hjk's avatar
hjk committed
314 315 316 317 318
//                 {notifyEngineSetupOk}
//
//
//
//                GdbEngine::setupInferior()
319
//                          +
320 321
//            (calls *Adapter->prepareInferior())
//                          |      |
hjk's avatar
hjk committed
322
//                          |      `---> handlePrepareInferiorFailed()
323
//                          |                   +
hjk's avatar
hjk committed
324
//                          |             {notifyInferiorSetupFailed}
325
//                          |
hjk's avatar
hjk committed
326
//                handleInferiorPrepared()
327
//                          +
328
//                {notifyInferiorSetupOk}
329 330 331 332




333

con's avatar
con committed
334
using namespace Core;
hjk's avatar
hjk committed
335
using namespace Debugger::Constants;
con's avatar
con committed
336
using namespace ProjectExplorer;
hjk's avatar
hjk committed
337
using namespace TextEditor;
con's avatar
con committed
338

hjk's avatar
hjk committed
339 340 341
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
342 343 344 345

namespace Debugger {
namespace Constants {

346 347
const char * const M_DEBUG_START_DEBUGGING = "QtCreator.Menu.Debug.StartDebugging";

con's avatar
con committed
348 349
const char * const STARTEXTERNAL        = "Debugger.StartExternal";
const char * const ATTACHEXTERNAL       = "Debugger.AttachExternal";
350
const char * const ATTACHCORE           = "Debugger.AttachCore";
hjk's avatar
hjk committed
351
const char * const ATTACHTCF            = "Debugger.AttachTcf";
352
const char * const ATTACHREMOTE         = "Debugger.AttachRemote";
353
const char * const ATTACHREMOTECDB      = "Debugger.AttachRemoteCDB";
354
const char * const STARTREMOTELLDB      = "Debugger.StartRemoteLLDB";
355
const char * const DETACH               = "Debugger.Detach";
con's avatar
con committed
356

357 358
const char * const RUN_TO_LINE1         = "Debugger.RunToLine1";
const char * const RUN_TO_LINE2         = "Debugger.RunToLine2";
con's avatar
con committed
359
const char * const RUN_TO_FUNCTION      = "Debugger.RunToFunction";
360 361
const char * const JUMP_TO_LINE1        = "Debugger.JumpToLine1";
const char * const JUMP_TO_LINE2        = "Debugger.JumpToLine2";
362
const char * const RETURN_FROM_FUNCTION = "Debugger.ReturnFromFunction";
363
const char * const SNAPSHOT             = "Debugger.Snapshot";
con's avatar
con committed
364 365 366
const char * const TOGGLE_BREAK         = "Debugger.ToggleBreak";
const char * const BREAK_BY_FUNCTION    = "Debugger.BreakByFunction";
const char * const BREAK_AT_MAIN        = "Debugger.BreakAtMain";
367 368
const char * const ADD_TO_WATCH1        = "Debugger.AddToWatch1";
const char * const ADD_TO_WATCH2        = "Debugger.AddToWatch2";
369
const char * const OPERATE_BY_INSTRUCTION  = "Debugger.OperateByInstruction";
370 371
const char * const FRAME_UP             = "Debugger.FrameUp";
const char * const FRAME_DOWN           = "Debugger.FrameDown";
con's avatar
con committed
372

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
373
#ifdef Q_WS_MAC
con's avatar
con committed
374
const char * const STOP_KEY                 = "Shift+Ctrl+Y";
con's avatar
con committed
375
const char * const RESET_KEY                = "Ctrl+Shift+F5";
con's avatar
con committed
376 377 378
const char * const STEP_KEY                 = "Ctrl+Shift+I";
const char * const STEPOUT_KEY              = "Ctrl+Shift+T";
const char * const NEXT_KEY                 = "Ctrl+Shift+O";
379
const char * const REVERSE_KEY              = "";
con's avatar
con committed
380 381
const char * const RUN_TO_LINE_KEY          = "Shift+F8";
const char * const RUN_TO_FUNCTION_KEY      = "Ctrl+F6";
382
const char * const JUMP_TO_LINE_KEY         = "Ctrl+D,Ctrl+L";
con's avatar
con committed
383
const char * const TOGGLE_BREAK_KEY         = "F8";
384 385 386 387
const char * const BREAK_BY_FUNCTION_KEY    = "Ctrl+D,Ctrl+F";
const char * const BREAK_AT_MAIN_KEY        = "Ctrl+D,Ctrl+M";
const char * const ADD_TO_WATCH_KEY         = "Ctrl+D,Ctrl+W";
const char * const SNAPSHOT_KEY             = "Ctrl+D,Ctrl+S";
con's avatar
con committed
388
#else
389
const char * const STOP_KEY                 = "Shift+F5";
con's avatar
con committed
390 391 392 393
const char * const RESET_KEY                = "Ctrl+Shift+F5";
const char * const STEP_KEY                 = "F11";
const char * const STEPOUT_KEY              = "Shift+F11";
const char * const NEXT_KEY                 = "F10";
394
const char * const REVERSE_KEY              = "F12";
con's avatar
con committed
395 396 397 398 399 400 401
const char * const RUN_TO_LINE_KEY          = "";
const char * const RUN_TO_FUNCTION_KEY      = "";
const char * const JUMP_TO_LINE_KEY         = "";
const char * const TOGGLE_BREAK_KEY         = "F9";
const char * const BREAK_BY_FUNCTION_KEY    = "";
const char * const BREAK_AT_MAIN_KEY        = "";
const char * const ADD_TO_WATCH_KEY         = "Ctrl+Alt+Q";
402
const char * const SNAPSHOT_KEY             = "Ctrl+D,Ctrl+S";
con's avatar
con committed
403 404 405 406 407
#endif

} // namespace Constants


408
namespace Internal {
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
void addCdb2OptionPages(QList<Core::IOptionsPage*> *);
} // namespace Cdb


namespace Internal {

// FIXME: Outdated?
// The createCdbEngine function takes a list of options pages it can add to.
// This allows for having a "enabled" toggle on the page independently
// of the engine. That's good for not enabling the related ActiveX control
// unnecessarily.

void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
424

425 426 427 428
#ifdef WITH_LLDB
void addLldbOptionPages(QList<IOptionsPage*> *opts);
#endif

hjk's avatar
hjk committed
429
static SessionManager *sessionManager()
430
{
hjk's avatar
hjk committed
431
    return ProjectExplorerPlugin::instance()->session();
432 433
}

434 435 436 437 438 439 440
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

441 442 443
struct AttachRemoteParameters
{
    AttachRemoteParameters() : attachPid(0), winCrashEvent(0) {}
444
    void clear();
445 446

    quint64 attachPid;
447
    QString attachTarget;  // core file name or  server:port
448
    // Event handle for attaching to crashed Windows processes.
449 450 451
    quint64 winCrashEvent;
};

452 453 454 455 456
void AttachRemoteParameters::clear()
{
    attachPid = winCrashEvent = 0;
    attachTarget.clear();
}
457

458 459 460 461 462 463 464 465 466 467 468 469 470

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
    DummyEngine() : DebuggerEngine(DebuggerStartParameters()) {}
471 472 473 474 475 476 477 478 479 480
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
    void executeDebuggerCommand(const QString &) {}
    unsigned debuggerCapabilities() const { return 0; }
    bool acceptsBreakpoint(BreakpointId) const { return false; }
481 482 483 484 485 486 487 488 489
};

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


490 491 492 493 494 495
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

496
class DebugMode : public IMode
hjk's avatar
hjk committed
497 498
{
public:
hjk's avatar
hjk committed
499
    DebugMode() : m_widget(0) { setObjectName(QLatin1String("DebugMode")); }
hjk's avatar
hjk committed
500

hjk's avatar
hjk committed
501 502 503 504 505 506
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        //EditorManager::instance()->setParent(0);
        delete m_widget;
    }
507 508

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

522

523 524
///////////////////////////////////////////////////////////////////////
//
525
// CommonOptionsPage
526 527 528
//
///////////////////////////////////////////////////////////////////////

529
class CommonOptionsPage : public Core::IOptionsPage
530 531
{
public:
532
    CommonOptionsPage() {}
533 534

    // IOptionsPage
535
    QString id() const
hjk's avatar
hjk committed
536
        { return _(DEBUGGER_COMMON_SETTINGS_ID); }
537
    QString displayName() const
hjk's avatar
hjk committed
538
        { return QCoreApplication::translate("Debugger", DEBUGGER_COMMON_SETTINGS_NAME); }
539
    QString category() const
hjk's avatar
hjk committed
540
        { return _(DEBUGGER_SETTINGS_CATEGORY);  }
541
    QString displayCategory() const
hjk's avatar
hjk committed
542
        { return QCoreApplication::translate("Debugger", DEBUGGER_SETTINGS_TR_CATEGORY); }
543 544
    QIcon categoryIcon() const
        { return QIcon(QLatin1String(DEBUGGER_COMMON_SETTINGS_CATEGORY_ICON)); }
545 546

    QWidget *createPage(QWidget *parent);
hjk's avatar
hjk committed
547
    void apply() { m_group.apply(ICore::instance()->settings()); }
548
    void finish() { m_group.finish(); }
549
    virtual bool matches(const QString &s) const;
550 551

private:
552
    Ui::CommonOptionsPage m_ui;
553
    Utils::SavedActionSet m_group;
554
    QString m_searchKeywords;
555 556
};

557
QWidget *CommonOptionsPage::createPage(QWidget *parent)
558 559 560
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);
561
    m_group.clear();
562

hjk's avatar
hjk committed
563
    m_group.insert(debuggerCore()->action(ListSourceFiles),
564
        m_ui.checkBoxListSourceFiles);
hjk's avatar
hjk committed
565
    m_group.insert(debuggerCore()->action(UseAlternatingRowColors),
566
        m_ui.checkBoxUseAlternatingRowColors);
hjk's avatar
hjk committed
567
    m_group.insert(debuggerCore()->action(UseToolTipsInMainEditor),
568
        m_ui.checkBoxUseToolTipsInMainEditor);
hjk's avatar
hjk committed
569
    m_group.insert(debuggerCore()->action(CloseBuffersOnExit),
570
        m_ui.checkBoxCloseBuffersOnExit);
hjk's avatar
hjk committed
571
    m_group.insert(debuggerCore()->action(SwitchModeOnExit),
572
        m_ui.checkBoxSwitchModeOnExit);
hjk's avatar
hjk committed
573 574 575 576 577 578
    m_group.insert(debuggerCore()->action(AutoDerefPointers), 0);
    m_group.insert(debuggerCore()->action(UseToolTipsInLocalsView), 0);
    m_group.insert(debuggerCore()->action(UseToolTipsInBreakpointsView), 0);
    m_group.insert(debuggerCore()->action(UseAddressInBreakpointsView), 0);
    m_group.insert(debuggerCore()->action(UseAddressInStackView), 0);
    m_group.insert(debuggerCore()->action(MaximalStackDepth),
579
        m_ui.spinBoxMaximalStackDepth);
hjk's avatar
hjk committed
580 581 582 583 584 585 586
    m_group.insert(debuggerCore()->action(ShowStdNamespace), 0);
    m_group.insert(debuggerCore()->action(ShowQtNamespace), 0);
    m_group.insert(debuggerCore()->action(SortStructMembers), 0);
    m_group.insert(debuggerCore()->action(LogTimeStamps), 0);
    m_group.insert(debuggerCore()->action(VerboseLog), 0);
    m_group.insert(debuggerCore()->action(BreakOnThrow), 0);
    m_group.insert(debuggerCore()->action(BreakOnCatch), 0);
587
#ifdef Q_OS_WIN
hjk's avatar
hjk committed
588
    Utils::SavedAction *registerAction = debuggerCore()->action(RegisterForPostMortem);
589 590 591 592 593
    m_group.insert(registerAction,
        m_ui.checkBoxRegisterForPostMortem);
    connect(registerAction, SIGNAL(toggled(bool)),
            m_ui.checkBoxRegisterForPostMortem, SLOT(setChecked(bool)));
#endif
594

595
    if (m_searchKeywords.isEmpty()) {
596 597 598 599 600
        QLatin1Char sep(' ');
        QTextStream(&m_searchKeywords)
                << sep << m_ui.checkBoxUseAlternatingRowColors->text()
                << sep << m_ui.checkBoxUseToolTipsInMainEditor->text()
                << sep << m_ui.checkBoxListSourceFiles->text()
601
#ifdef Q_OS_WIN
602
                << sep << m_ui.checkBoxRegisterForPostMortem->text()
603
#endif
604 605 606 607
                << sep << m_ui.checkBoxCloseBuffersOnExit->text()
                << sep << m_ui.checkBoxSwitchModeOnExit->text()
                << sep << m_ui.labelMaximalStackDepth->text()
                   ;
608 609
        m_searchKeywords.remove(QLatin1Char('&'));
    }
610 611 612
#ifndef Q_OS_WIN
    m_ui.checkBoxRegisterForPostMortem->setVisible(false);
#endif
613 614 615
    return w;
}

616 617 618 619 620
bool CommonOptionsPage::matches(const QString &s) const
{
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
}

hjk's avatar
hjk committed
621 622
///////////////////////////////////////////////////////////////////////
//
623
// DebuggingHelperOptionPage
hjk's avatar
hjk committed
624 625 626
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
627
static bool oxygenStyle()
628
{
hjk's avatar
hjk committed
629 630
    const ManhattanStyle *ms = qobject_cast<const ManhattanStyle *>(qApp->style());
    return ms && !qstrcmp("OxygenStyle", ms->baseStyle()->metaObject()->className());
631 632
}

633
class DebuggingHelperOptionPage : public Core::IOptionsPage
hjk's avatar
hjk committed
634 635
{
    Q_OBJECT // Needs tr-context.
hjk's avatar
hjk committed
636
public:
637
    DebuggingHelperOptionPage() {}
hjk's avatar
hjk committed
638 639

    // IOptionsPage
hjk's avatar
hjk committed
640
    QString id() const { return _("Z.DebuggingHelper"); }
641
    QString displayName() const { return tr("Debugging Helper"); }
hjk's avatar
hjk committed
642
    QString category() const { return _(DEBUGGER_SETTINGS_CATEGORY); }
643 644 645 646
    QString displayCategory() const
    { return QCoreApplication::translate("Debugger", DEBUGGER_SETTINGS_TR_CATEGORY); }
    QIcon categoryIcon() const
    { return QIcon(QLatin1String(DEBUGGER_COMMON_SETTINGS_CATEGORY_ICON)); }
hjk's avatar
hjk committed
647 648

    QWidget *createPage(QWidget *parent);
hjk's avatar
hjk committed
649
    void apply() { m_group.apply(ICore::instance()->settings()); }
650
    void finish() { m_group.finish(); }
651
    virtual bool matches(const QString &s) const;
hjk's avatar
hjk committed
652 653

private:
654
    Ui::DebuggingHelperOptionPage m_ui;
655
    Utils::SavedActionSet m_group;
656
    QString m_searchKeywords;
hjk's avatar
hjk committed
657 658
};

659
QWidget *DebuggingHelperOptionPage::createPage(QWidget *parent)
hjk's avatar
hjk committed
660 661 662 663
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);

664
    m_ui.dumperLocationChooser->setExpectedKind(Utils::PathChooser::Command);
665
    m_ui.dumperLocationChooser->setPromptDialogTitle(tr("Choose DebuggingHelper Location"));
hjk's avatar
hjk committed
666
    m_ui.dumperLocationChooser->setInitialBrowsePathBackup(
hjk's avatar
hjk committed
667
        ICore::instance()->resourcePath() + "../../lib");
hjk's avatar
hjk committed
668

669
    m_group.clear();
hjk's avatar
hjk committed
670
    m_group.insert(debuggerCore()->action(UseDebuggingHelpers),
671
        m_ui.debuggingHelperGroupBox);
hjk's avatar
hjk committed
672
    m_group.insert(debuggerCore()->action(UseCustomDebuggingHelperLocation),
673
        m_ui.customLocationGroupBox);
hjk's avatar
hjk committed
674
    // Suppress Oxygen style's giving flat group boxes bold titles.
675
    if (oxygenStyle())
hjk's avatar
hjk committed
676
        m_ui.customLocationGroupBox->setStyleSheet(_("QGroupBox::title { font: ; }"));
677

hjk's avatar
hjk committed
678
    m_group.insert(debuggerCore()->action(CustomDebuggingHelperLocation),
679
        m_ui.dumperLocationChooser);
hjk's avatar
hjk committed
680

hjk's avatar
hjk committed
681
    m_group.insert(debuggerCore()->action(UseCodeModel),
682
        m_ui.checkBoxUseCodeModel);
683 684 685
    m_group.insert(debuggerCore()->action(ShowThreadNames),
        m_ui.checkBoxShowThreadNames);

686

hjk's avatar
hjk committed
687 688
#ifndef QT_DEBUG
#if 0
hjk's avatar
hjk committed
689
    cmd = am->registerAction(m_dumpLogAction,
hjk's avatar
hjk committed
690
        DUMP_LOG, globalcontext);
hjk's avatar
hjk committed
691 692 693 694 695 696
    //cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+D,Ctrl+L")));
    cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+Shift+F11")));
    mdebug->addAction(cmd);
#endif
#endif

697 698 699 700 701
    if (m_searchKeywords.isEmpty()) {
        QTextStream(&m_searchKeywords)
                << ' ' << m_ui.debuggingHelperGroupBox->title()
                << ' ' << m_ui.customLocationGroupBox->title()
                << ' ' << m_ui.dumperLocationLabel->text()
702 703
                << ' ' << m_ui.checkBoxUseCodeModel->text()
                << ' ' << m_ui.checkBoxShowThreadNames->text();
704 705
        m_searchKeywords.remove(QLatin1Char('&'));
    }
hjk's avatar
hjk committed
706 707 708
    return w;
}

709
bool DebuggingHelperOptionPage::matches(const QString &s) const
hjk's avatar
hjk committed
710
{
711
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
hjk's avatar
hjk committed
712 713
}

714

con's avatar
con committed
715 716
///////////////////////////////////////////////////////////////////////
//
717
// Argument parsing
con's avatar
con committed
718 719 720
//
///////////////////////////////////////////////////////////////////////

721
static QString msgParameterMissing(const QString &a)
722 723 724 725
{
    return DebuggerPlugin::tr("Option '%1' is missing the parameter.").arg(a);
}

726
static QString msgInvalidNumericParameter(const QString &a, const QString &number)
727 728 729 730
{
    return DebuggerPlugin::tr("The parameter '%1' of option '%2' is not a number.").arg(number, a);
}

731
static bool parseArgument(QStringList::const_iterator &it,
732 733 734
    const QStringList::const_iterator &cend,
    AttachRemoteParameters *attachRemoteParameters,
    unsigned *enabledEngines, QString *errorMessage)
735 736 737
{
    const QString &option = *it;
    // '-debug <pid>'
738 739
    // '-debug <corefile>'
    // '-debug <server:port>'
hjk's avatar
hjk committed
740
    if (*it == _("-debug")) {
741 742 743 744 745 746
        ++it;
        if (it == cend) {
            *errorMessage = msgParameterMissing(*it);
            return false;
        }
        bool ok;
747
        attachRemoteParameters->attachPid = it->toULongLong(&ok);
748 749
        if (!ok)
            attachRemoteParameters->attachTarget = *it;
750 751
        return true;
    }
752 753
    // -wincrashevent <event-handle>. A handle used for
    // a handshake when attaching to a crashed Windows process.
hjk's avatar
hjk committed
754
    if (*it == _("-wincrashevent")) {
755 756 757 758 759 760
        ++it;
        if (it == cend) {
            *errorMessage = msgParameterMissing(*it);
            return false;
        }
        bool ok;
761
        attachRemoteParameters->winCrashEvent = it->toULongLong(&ok);
762 763 764 765 766 767
        if (!ok) {
            *errorMessage = msgInvalidNumericParameter(option, *it);
            return false;
        }
        return true;
    }
hjk's avatar
hjk committed
768
    // Engine disabling.
hjk's avatar
hjk committed
769
    if (option == _("-disable-cdb")) {
770
        *enabledEngines &= ~CdbEngineType;
771 772
        return true;
    }
hjk's avatar
hjk committed
773
    if (option == _("-disable-gdb")) {
774
        *enabledEngines &= ~GdbEngineType;
775 776
        return true;
    }
777
    if (option == _("-disable-qmldb")) {
778
        *enabledEngines &= ~QmlEngineType;
779 780
        return true;
    }
hjk's avatar
hjk committed
781
    if (option == _("-disable-sdb")) {
782
        *enabledEngines &= ~ScriptEngineType;
783 784
        return true;
    }
785
    if (option == _("-disable-tcf")) {
hjk's avatar
hjk committed
786 787 788
        *enabledEngines &= ~TcfEngineType;
        return true;
    }
789 790 791 792
    if (option == _("-disable-lldb")) {
        *enabledEngines &= ~LldbEngineType;
        return true;
    }
793

794
    *errorMessage = DebuggerPlugin::tr("Invalid debugger option: %1").arg(option);
795 796 797
    return false;
}

798
static bool parseArguments(const QStringList &args,
799
   AttachRemoteParameters *attachRemoteParameters,
hjk's avatar
hjk committed
800
   unsigned *enabledEngines, QString *errorMessage)
801
{
802
    attachRemoteParameters->clear();
803 804
    const QStringList::const_iterator cend = args.constEnd();
    for (QStringList::const_iterator it = args.constBegin(); it != cend; ++it)
805
        if (!parseArgument(it, cend, attachRemoteParameters, enabledEngines, errorMessage))
806
            return false;
807
    if (Constants::Internal::debug)
808
        qDebug().nospace() << args << "engines=0x"
809 810
            << QString::number(*enabledEngines, 16)
            << " pid" << attachRemoteParameters->attachPid
811
            << " target" << attachRemoteParameters->attachTarget << '\n';
812 813 814
    return true;
}

815 816 817 818 819 820 821

///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
822
static bool isDebuggable(IEditor *editor)
823
{
824 825
    // Only blacklist Qml. Whitelisting would fail on C++ code in files
    // with strange names, more harm would be done this way.
hjk's avatar
hjk committed
826 827
    //   IFile *file = editor->file();
    //   return !(file && file->mimeType() == "application/x-qml");
828
    // Nowadays, even Qml is debuggable.
hjk's avatar
hjk committed
829
    return editor;
830 831
}

832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
class ContextData
{
public:
    ContextData() : lineNumber(0), address(0) {}

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

} // namespace Internal
} // namespace Debugger

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

848 849
///////////////////////////////////////////////////////////////////////
//
hjk's avatar
hjk committed
850
// Debugger Actions
851 852
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
853

854 855 856
namespace Debugger {
namespace Internal {

857 858 859
struct DebuggerActions
{
    QAction *continueAction;
860
    QAction *exitAction; // on the application output button if "Stop" is possible
861 862
    QAction *interruptAction; // on the fat debug button if "Pause" is possible
    QAction *undisturbableAction; // on the fat debug button if nothing can be done
863 864 865
    QAction *resetAction; // FIXME: Should not be needed in a stable release
    QAction *stepAction;
    QAction *stepOutAction;
866
    QAction *runToLineAction; // Debug menu
867
    QAction *runToFunctionAction;
868
    QAction *jumpToLineAction; // in the Debug menu
869 870
    QAction *returnFromFunctionAction;
    QAction *nextAction;
871
    //QAction *snapshotAction;
872 873 874 875 876 877 878 879
    QAction *watchAction1; // in the Debug menu
    QAction *watchAction2; // in the text editor context menu
    QAction *breakAction;
    QAction *sepAction;
    QAction *reverseDirectionAction;
    QAction *frameUpAction;
    QAction *frameDownAction;
};
con's avatar
con committed
880

881
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
882 883


884 885 886 887 888
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
889

890
class DebuggerPluginPrivate : public DebuggerCore
891 892
{
    Q_OBJECT
893

894 895
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
896
    ~DebuggerPluginPrivate();
897

898
    bool initialize(const QStringList &arguments, QString *errorMessage);
899 900 901
    void extensionsInitialized();
    void aboutToShutdown();

902
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
903
    void disconnectEngine() { connectEngine(0); }
904
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
905

906
public slots:
907 908 909 910
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
911

hjk's avatar
hjk committed
912
    void breakpointSetMarginActionTriggered()