debuggerplugin.cpp 116 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>
112
#include <utils/proxyaction.h>
con's avatar
con committed
113

114 115
#include <qml/scriptconsole.h>

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

129 130
#include <climits>

131 132 133 134 135 136 137 138 139 140 141
#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
142
// gdbserver, the trk client etc are referred to as 'Engine',
143 144
// whereas the debugged process is referred to as 'Inferior'.
//
145 146
// Transitions marked by '---' are done in the individual engines.
// Transitions marked by '+-+' are done in the base DebuggerEngine.
hjk's avatar
hjk committed
147
// Transitions marked by '*' are done asynchronously.
hjk's avatar
hjk committed
148
// The GdbEngine->setupEngine() function is described in more detail below.
149
//
hjk's avatar
hjk committed
150 151 152 153 154 155 156
// 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
157 158 159 160 161 162
//                        DebuggerNotReady
//                               +
//                      EngineSetupRequested
//                               +
//                  (calls *Engine->setupEngine())
//                            |      |
163
//                            |      |
hjk's avatar
hjk committed
164 165 166
//                       {notify-  {notify-
//                        Engine-   Engine-
//                        SetupOk}  SetupFailed}
167 168 169 170 171 172
//                            +      +
//                            +      `+-+-+> EngineSetupFailed
//                            +                   +
//                            +    [calls RunControl->startFailed]
//                            +                   +
//                            +             DebuggerFinished
hjk's avatar
hjk committed
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
//                            v
//                      EngineSetupOk
//                            +
//             [calls RunControl->StartSuccessful]
//                            +
//                  InferiorSetupRequested
//                            +
//             (calls *Engine->setupInferior())
//                         |       |
//                         |       |
//                    {notify-   {notify-
//                     Inferior- Inferior-
//                     SetupOk}  SetupFailed}
//                         +       +
//                         +       ` +-+-> InferiorSetupFailed +-+-+-+-+-+->.
//                         +                                                +
hjk's avatar
hjk committed
189
//                  InferiorSetupOk                                         +
hjk's avatar
hjk committed
190 191 192 193 194 195 196 197 198
//                         +                                                +
//                  EngineRunRequested                                      +
//                         +                                                +
//                 (calls *Engine->runEngine())                             +
//               /       |            |        \                            +
//             /         |            |          \                          +
//            | (core)   | (attach)   |           |                         +
//            |          |            |           |                         +
//      {notify-    {notifyER&- {notifyER&-  {notify-                       +
199
//      Inferior-     Inferior-   Inferior-  EngineRun-                     +
hjk's avatar
hjk committed
200 201 202 203 204 205 206 207
//     Unrunnable}     StopOk}     RunOk}     Failed}                       +
//           +           +            +           +                         +
//   InferiorUnrunnable  +     InferiorRunOk      +                         +
//                       +                        +                         +
//                InferiorStopOk            EngineRunFailed                 +
//                                                +                         v
//                                                 `-+-+-+-+-+-+-+-+-+-+-+>-+
//                                                                          +
hjk's avatar
hjk committed
208
//                                                                          +
209
//                       #Interrupt@InferiorRunOk#                          +
hjk's avatar
hjk committed
210
//                                  +                                       +
hjk's avatar
hjk committed
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
//                          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
228 229 230 231 232 233 234 235 236 237 238 239 240 241
//                InferiorShutdownRequested                                 +
//                            +                                             +
//           (calls *Engine->shutdownInferior())                            +
//                         |        |                                       +
//                    {notify-   {notify-                                   +
//                     Inferior- Inferior-                                  +
//                  ShutdownOk}  ShutdownFailed}                            +
//                         +        +                                       +
//                         +        +                                       +
//  #Inferior exited#      +        +                                       +
//         |               +        +                                       +
//   {notifyInferior-      +        +                                       +
//      Exited}            +        +                                       +
//           +             +        +                                       +
hjk's avatar
hjk committed
242
//     InferiorExitOk      +        +                                       +
hjk's avatar
hjk committed
243 244 245 246 247
//             +           +        +                                       +
//            InferiorShutdownOk InferiorShutdownFailed                     +
//                      *          *                                        +
//                  EngineShutdownRequested                                 +
//                            +                                             +
248
//           (calls *Engine->shutdownEngine())  <+-+-+-+-+-+-+-+-+-+-+-+-+-+'
hjk's avatar
hjk committed
249 250 251
//                         |        |
//                         |        |
//                    {notify-   {notify-
hjk's avatar
hjk committed
252
//                     Engine-    Engine-
hjk's avatar
hjk committed
253 254 255
//                  ShutdownOk}  ShutdownFailed}
//                         +       +
//            EngineShutdownOk  EngineShutdownFailed
hjk's avatar
hjk committed
256 257
//                         *       *
//                     DebuggerFinished
hjk's avatar
hjk committed
258 259 260
//


261 262 263
/* 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
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 296 297
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
298
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
299 300 301


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




335

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

hjk's avatar
hjk committed
341 342 343
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
344 345 346 347

namespace Debugger {
namespace Constants {

348 349
const char * const M_DEBUG_START_DEBUGGING = "QtCreator.Menu.Debug.StartDebugging";

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

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
375
#ifdef Q_WS_MAC
con's avatar
con committed
376
const char * const STOP_KEY                 = "Shift+Ctrl+Y";
con's avatar
con committed
377
const char * const RESET_KEY                = "Ctrl+Shift+F5";
con's avatar
con committed
378 379 380
const char * const STEP_KEY                 = "Ctrl+Shift+I";
const char * const STEPOUT_KEY              = "Ctrl+Shift+T";
const char * const NEXT_KEY                 = "Ctrl+Shift+O";
381
const char * const REVERSE_KEY              = "";
con's avatar
con committed
382 383
const char * const RUN_TO_LINE_KEY          = "Shift+F8";
const char * const RUN_TO_FUNCTION_KEY      = "Ctrl+F6";
384
const char * const JUMP_TO_LINE_KEY         = "Ctrl+D,Ctrl+L";
con's avatar
con committed
385
const char * const TOGGLE_BREAK_KEY         = "F8";
386 387 388 389
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
390
#else
391
const char * const STOP_KEY                 = "Shift+F5";
con's avatar
con committed
392 393 394 395
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";
396
const char * const REVERSE_KEY              = "F12";
con's avatar
con committed
397 398 399 400 401 402 403
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";
404
const char * const SNAPSHOT_KEY             = "Ctrl+D,Ctrl+S";
con's avatar
con committed
405 406 407 408 409
#endif

} // namespace Constants


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

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

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

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

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

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

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

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

456 457 458 459 460 461 462 463 464 465 466 467 468

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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


488 489 490 491 492 493
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

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

520

521 522
///////////////////////////////////////////////////////////////////////
//
523
// CommonOptionsPage
524 525 526
//
///////////////////////////////////////////////////////////////////////

527
class CommonOptionsPage : public Core::IOptionsPage
528 529
{
public:
530
    CommonOptionsPage() {}
531 532

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

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

private:
550
    Ui::CommonOptionsPage m_ui;
551
    Utils::SavedActionSet m_group;
552
    QString m_searchKeywords;
553 554
};

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

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

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

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

hjk's avatar
hjk committed
619 620
///////////////////////////////////////////////////////////////////////
//
621
// DebuggingHelperOptionPage
hjk's avatar
hjk committed
622 623 624
//
///////////////////////////////////////////////////////////////////////

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

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

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

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

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

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

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

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

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

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

684

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

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

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

712

con's avatar
con committed
713 714
///////////////////////////////////////////////////////////////////////
//
715
// Argument parsing
con's avatar
con committed
716 717 718
//
///////////////////////////////////////////////////////////////////////

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

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

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

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

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

813 814 815 816 817 818 819

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

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

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

846 847
///////////////////////////////////////////////////////////////////////
//
hjk's avatar
hjk committed
848
// Debugger Actions
849 850
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
851

852 853 854
namespace Debugger {
namespace Internal {

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

879
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
880 881


882 883 884 885 886
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
887

888
class DebuggerPluginPrivate : public DebuggerCore
889 890
{
    Q_OBJECT
891

892 893
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
894
    ~DebuggerPluginPrivate();
895

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

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