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 409 410 411 412 413 414 415
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.

416
void addCdbOptionPages(QList<IOptionsPage*> *opts);
417 418 419
void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
420

421 422 423 424
#ifdef WITH_LLDB
void addLldbOptionPages(QList<IOptionsPage*> *opts);
#endif

hjk's avatar
hjk committed
425
static SessionManager *sessionManager()
426
{
hjk's avatar
hjk committed
427
    return ProjectExplorerPlugin::instance()->session();
428 429
}

430 431 432 433 434 435 436
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

437 438 439
struct AttachRemoteParameters
{
    AttachRemoteParameters() : attachPid(0), winCrashEvent(0) {}
440
    void clear();
441 442

    quint64 attachPid;
443
    QString attachTarget;  // core file name or  server:port
444
    // Event handle for attaching to crashed Windows processes.
445 446 447
    quint64 winCrashEvent;
};

448 449 450 451 452
void AttachRemoteParameters::clear()
{
    attachPid = winCrashEvent = 0;
    attachTarget.clear();
}
453

454 455 456 457 458 459 460 461 462 463 464 465 466

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
    DummyEngine() : DebuggerEngine(DebuggerStartParameters()) {}
467 468 469 470 471 472 473 474 475 476
    ~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; }
477 478 479 480 481 482 483 484 485
};

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


486 487 488 489 490 491
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

492
class DebugMode : public IMode
hjk's avatar
hjk committed
493 494
{
public:
hjk's avatar
hjk committed
495
    DebugMode() : m_widget(0) { setObjectName(QLatin1String("DebugMode")); }
hjk's avatar
hjk committed
496

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

    // IMode
hjk's avatar
hjk committed
505 506 507 508 509 510 511 512 513
    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(); }
514 515
private:
    QWidget *m_widget;
516
};
hjk's avatar
hjk committed
517

518

519 520
///////////////////////////////////////////////////////////////////////
//
521
// CommonOptionsPage
522 523 524
//
///////////////////////////////////////////////////////////////////////

525
class CommonOptionsPage : public Core::IOptionsPage
526 527
{
public:
528
    CommonOptionsPage() {}
529 530

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

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

private:
548
    Ui::CommonOptionsPage m_ui;
549
    Utils::SavedActionSet m_group;
550
    QString m_searchKeywords;
551 552
};

553
QWidget *CommonOptionsPage::createPage(QWidget *parent)
554 555 556
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);
557
    m_group.clear();
558

hjk's avatar
hjk committed
559
    m_group.insert(debuggerCore()->action(ListSourceFiles),
560
        m_ui.checkBoxListSourceFiles);
hjk's avatar
hjk committed
561
    m_group.insert(debuggerCore()->action(UseAlternatingRowColors),
562
        m_ui.checkBoxUseAlternatingRowColors);
hjk's avatar
hjk committed
563
    m_group.insert(debuggerCore()->action(UseToolTipsInMainEditor),
564
        m_ui.checkBoxUseToolTipsInMainEditor);
hjk's avatar
hjk committed
565
    m_group.insert(debuggerCore()->action(CloseBuffersOnExit),
566
        m_ui.checkBoxCloseBuffersOnExit);
hjk's avatar
hjk committed
567
    m_group.insert(debuggerCore()->action(SwitchModeOnExit),
568
        m_ui.checkBoxSwitchModeOnExit);
hjk's avatar
hjk committed
569 570 571 572 573 574
    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),
575
        m_ui.spinBoxMaximalStackDepth);
hjk's avatar
hjk committed
576 577 578 579 580 581 582
    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);
583
#ifdef Q_OS_WIN
hjk's avatar
hjk committed
584
    Utils::SavedAction *registerAction = debuggerCore()->action(RegisterForPostMortem);
585 586 587 588 589
    m_group.insert(registerAction,
        m_ui.checkBoxRegisterForPostMortem);
    connect(registerAction, SIGNAL(toggled(bool)),
            m_ui.checkBoxRegisterForPostMortem, SLOT(setChecked(bool)));
#endif
590

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

612 613 614 615 616
bool CommonOptionsPage::matches(const QString &s) const
{
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
}

hjk's avatar
hjk committed
617 618
///////////////////////////////////////////////////////////////////////
//
619
// DebuggingHelperOptionPage
hjk's avatar
hjk committed
620 621 622
//
///////////////////////////////////////////////////////////////////////

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

629
class DebuggingHelperOptionPage : public Core::IOptionsPage
hjk's avatar
hjk committed
630 631
{
    Q_OBJECT // Needs tr-context.
hjk's avatar
hjk committed
632
public:
633
    DebuggingHelperOptionPage() {}
hjk's avatar
hjk committed
634 635

    // IOptionsPage
hjk's avatar
hjk committed
636
    QString id() const { return _("Z.DebuggingHelper"); }
637
    QString displayName() const { return tr("Debugging Helper"); }
hjk's avatar
hjk committed
638
    QString category() const { return _(DEBUGGER_SETTINGS_CATEGORY); }
639 640 641 642
    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
643 644

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

private:
650
    Ui::DebuggingHelperOptionPage m_ui;
651
    Utils::SavedActionSet m_group;
652
    QString m_searchKeywords;
hjk's avatar
hjk committed
653 654
};

655
QWidget *DebuggingHelperOptionPage::createPage(QWidget *parent)
hjk's avatar
hjk committed
656 657 658 659
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);

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

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

hjk's avatar
hjk committed
674
    m_group.insert(debuggerCore()->action(CustomDebuggingHelperLocation),
675
        m_ui.dumperLocationChooser);
hjk's avatar
hjk committed
676

hjk's avatar
hjk committed
677
    m_group.insert(debuggerCore()->action(UseCodeModel),
678
        m_ui.checkBoxUseCodeModel);
679 680 681
    m_group.insert(debuggerCore()->action(ShowThreadNames),
        m_ui.checkBoxShowThreadNames);

682

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

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

705
bool DebuggingHelperOptionPage::matches(const QString &s) const
hjk's avatar
hjk committed
706
{
707
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
hjk's avatar
hjk committed
708 709
}

710

con's avatar
con committed
711 712
///////////////////////////////////////////////////////////////////////
//
713
// Argument parsing
con's avatar
con committed
714 715 716
//
///////////////////////////////////////////////////////////////////////

717
static QString msgParameterMissing(const QString &a)
718 719 720 721
{
    return DebuggerPlugin::tr("Option '%1' is missing the parameter.").arg(a);
}

722
static QString msgInvalidNumericParameter(const QString &a, const QString &number)
723 724 725 726
{
    return DebuggerPlugin::tr("The parameter '%1' of option '%2' is not a number.").arg(number, a);
}

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

790
    *errorMessage = DebuggerPlugin::tr("Invalid debugger option: %1").arg(option);
791 792 793
    return false;
}

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

811 812 813 814 815 816 817

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

hjk's avatar
hjk committed
818
static bool isDebuggable(IEditor *editor)
819
{
820 821
    // 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
822 823
    //   IFile *file = editor->file();
    //   return !(file && file->mimeType() == "application/x-qml");
824
    // Nowadays, even Qml is debuggable.
hjk's avatar
hjk committed
825
    return editor;
826 827
}

828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
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
843

844 845
///////////////////////////////////////////////////////////////////////
//
hjk's avatar
hjk committed
846
// Debugger Actions
847 848
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
849

850 851 852
namespace Debugger {
namespace Internal {

853 854 855
struct DebuggerActions
{
    QAction *continueAction;
856
    QAction *exitAction; // on the application output button if "Stop" is possible
857 858
    QAction *interruptAction; // on the fat debug button if "Pause" is possible
    QAction *undisturbableAction; // on the fat debug button if nothing can be done
859 860 861
    QAction *resetAction; // FIXME: Should not be needed in a stable release
    QAction *stepAction;
    QAction *stepOutAction;
862
    QAction *runToLineAction; // Debug menu
863
    QAction *runToFunctionAction;
864
    QAction *jumpToLineAction; // in the Debug menu
865 866
    QAction *returnFromFunctionAction;
    QAction *nextAction;
867
    //QAction *snapshotAction;
868 869 870 871 872 873 874 875
    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
876

877
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
878 879


880 881 882 883 884
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
885

886
class DebuggerPluginPrivate : public DebuggerCore
887 888
{
    Q_OBJECT
889

890 891
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
892
    ~DebuggerPluginPrivate();
893

894
    bool initialize(const QStringList &arguments, QString *errorMessage);
895 896 897
    void extensionsInitialized();
    void aboutToShutdown();

898
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
899
    void disconnectEngine() { connectEngine(0); }
900
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
901

902
public slots:
903 904 905 906
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
907

hjk's avatar
hjk committed
908
    void breakpointSetMarginActionTriggered()