debuggerplugin.cpp 119 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
** Commercial Usage
10
**
11 12 13 14
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
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
**
25
** If you are unsure which license is appropriate for your use, please
hjk's avatar
hjk committed
26
** contact the sales department at http://qt.nokia.com/contact.
con's avatar
con committed
27
**
28
**************************************************************************/
hjk's avatar
hjk committed
29

con's avatar
con committed
30 31
#include "debuggerplugin.h"

32
#include "debuggeractions.h"
33
#include "debuggeragents.h"
con's avatar
con committed
34
#include "debuggerconstants.h"
35
#include "debuggercore.h"
36 37 38
#include "debuggerdialogs.h"
#include "debuggerengine.h"
#include "debuggermainwindow.h"
con's avatar
con committed
39
#include "debuggerrunner.h"
40
#include "debuggerstringutils.h"
41
#include "debuggertooltip.h"
42
#include "debuggeruiswitcher.h"
43

44 45
#include "breakpoint.h"
#include "breakhandler.h"
46
#include "breakwindow.h"
47
#include "consolewindow.h"
48
#include "logwindow.h"
49 50 51
#include "moduleswindow.h"
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
52
#include "stackhandler.h"
53 54 55
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
56
#include "watchhandler.h"
57
#include "watchwindow.h"
hjk's avatar
hjk committed
58
#include "watchutils.h"
59

60 61
#include "snapshothandler.h"
#include "threadshandler.h"
hjk's avatar
hjk committed
62
#include "gdb/gdboptionspage.h"
con's avatar
con committed
63

64
#include "ui_commonoptionspage.h"
hjk's avatar
hjk committed
65
#include "ui_dumperoptionpage.h"
66

67
#include <coreplugin/actionmanager/actionmanager.h>
68 69
#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/command.h>
70
#include <coreplugin/uniqueidmanager.h>
hjk's avatar
hjk committed
71
#include <coreplugin/basemode.h>
con's avatar
con committed
72
#include <coreplugin/coreconstants.h>
73
#include <coreplugin/dialogs/ioptionspage.h>
con's avatar
con committed
74
#include <coreplugin/editormanager/editormanager.h>
hjk's avatar
hjk committed
75
#include <coreplugin/findplaceholder.h>
76
#include <coreplugin/icontext.h>
con's avatar
con committed
77
#include <coreplugin/icore.h>
78
#include <coreplugin/imode.h>
79
#include <coreplugin/icorelistener.h>
80
#include <coreplugin/manhattanstyle.h>
hjk's avatar
hjk committed
81
#include <coreplugin/minisplitter.h>
con's avatar
con committed
82
#include <coreplugin/modemanager.h>
hjk's avatar
hjk committed
83

con's avatar
con committed
84
#include <cppeditor/cppeditorconstants.h>
85
#include <cpptools/cppmodelmanagerinterface.h>
hjk's avatar
hjk committed
86

87 88
#include <extensionsystem/pluginmanager.h>

89
#include <projectexplorer/project.h>
90
#include <projectexplorer/projectexplorer.h>
con's avatar
con committed
91 92
#include <projectexplorer/projectexplorerconstants.h>
#include <projectexplorer/session.h>
93
#include <projectexplorer/target.h>
94
#include <projectexplorer/toolchaintype.h>
hjk's avatar
hjk committed
95

96 97
#include <qt4projectmanager/qt4projectmanagerconstants.h>

hjk's avatar
hjk committed
98
#include <texteditor/basetexteditor.h>
con's avatar
con committed
99
#include <texteditor/basetextmark.h>
100
#include <texteditor/fontsettings.h>
101
#include <texteditor/texteditorsettings.h>
hjk's avatar
hjk committed
102 103

#include <utils/qtcassert.h>
104
#include <utils/savedaction.h>
105
#include <utils/styledbar.h>
con's avatar
con committed
106

107 108
#include <qml/scriptconsole.h>

109
#include <QtCore/QTimer>
110 111
#include <QtCore/QtPlugin>
#include <QtGui/QComboBox>
112
#include <QtGui/QDockWidget>
113
#include <QtGui/QFileDialog>
hjk's avatar
hjk committed
114
#include <QtGui/QMenu>
115
#include <QtGui/QMessageBox>
116 117 118
#include <QtGui/QPushButton>
#include <QtGui/QTextBlock>
#include <QtGui/QTextCursor>
119
#include <QtGui/QToolButton>
con's avatar
con committed
120

121 122
#include <climits>

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


252 253 254
/* 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
255

256 257 258 259 260 261 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
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
289
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
290 291 292


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




326

con's avatar
con committed
327
using namespace Core;
hjk's avatar
hjk committed
328
using namespace Debugger::Constants;
con's avatar
con committed
329
using namespace ProjectExplorer;
hjk's avatar
hjk committed
330
using namespace TextEditor;
con's avatar
con committed
331

hjk's avatar
hjk committed
332 333 334
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
335 336 337 338

namespace Debugger {
namespace Constants {

339 340
const char * const M_DEBUG_START_DEBUGGING = "QtCreator.Menu.Debug.StartDebugging";

con's avatar
con committed
341 342
const char * const STARTEXTERNAL        = "Debugger.StartExternal";
const char * const ATTACHEXTERNAL       = "Debugger.AttachExternal";
343
const char * const ATTACHCORE           = "Debugger.AttachCore";
hjk's avatar
hjk committed
344
const char * const ATTACHTCF            = "Debugger.AttachTcf";
345
const char * const ATTACHREMOTE         = "Debugger.AttachRemote";
346
const char * const DETACH               = "Debugger.Detach";
con's avatar
con committed
347

348 349
const char * const RUN_TO_LINE1         = "Debugger.RunToLine1";
const char * const RUN_TO_LINE2         = "Debugger.RunToLine2";
con's avatar
con committed
350
const char * const RUN_TO_FUNCTION      = "Debugger.RunToFunction";
351 352
const char * const JUMP_TO_LINE1        = "Debugger.JumpToLine1";
const char * const JUMP_TO_LINE2        = "Debugger.JumpToLine2";
353
const char * const RETURN_FROM_FUNCTION = "Debugger.ReturnFromFunction";
354
const char * const SNAPSHOT             = "Debugger.Snapshot";
con's avatar
con committed
355 356 357
const char * const TOGGLE_BREAK         = "Debugger.ToggleBreak";
const char * const BREAK_BY_FUNCTION    = "Debugger.BreakByFunction";
const char * const BREAK_AT_MAIN        = "Debugger.BreakAtMain";
358 359
const char * const ADD_TO_WATCH1        = "Debugger.AddToWatch1";
const char * const ADD_TO_WATCH2        = "Debugger.AddToWatch2";
360
const char * const OPERATE_BY_INSTRUCTION  = "Debugger.OperateByInstruction";
361 362
const char * const FRAME_UP             = "Debugger.FrameUp";
const char * const FRAME_DOWN           = "Debugger.FrameDown";
con's avatar
con committed
363

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
364
#ifdef Q_WS_MAC
con's avatar
con committed
365
const char * const STOP_KEY                 = "Shift+Ctrl+Y";
con's avatar
con committed
366
const char * const RESET_KEY                = "Ctrl+Shift+F5";
con's avatar
con committed
367 368 369
const char * const STEP_KEY                 = "Ctrl+Shift+I";
const char * const STEPOUT_KEY              = "Ctrl+Shift+T";
const char * const NEXT_KEY                 = "Ctrl+Shift+O";
370
const char * const REVERSE_KEY              = "";
con's avatar
con committed
371 372
const char * const RUN_TO_LINE_KEY          = "Shift+F8";
const char * const RUN_TO_FUNCTION_KEY      = "Ctrl+F6";
373
const char * const JUMP_TO_LINE_KEY         = "Ctrl+D,Ctrl+L";
con's avatar
con committed
374
const char * const TOGGLE_BREAK_KEY         = "F8";
375 376 377 378
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
379
#else
380
const char * const STOP_KEY                 = "Shift+F5";
con's avatar
con committed
381 382 383 384
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";
385
const char * const REVERSE_KEY              = "F12";
con's avatar
con committed
386 387 388 389 390 391 392
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";
393
const char * const SNAPSHOT_KEY             = "Ctrl+D,Ctrl+S";
con's avatar
con committed
394 395 396 397 398 399
#endif

} // namespace Constants
} // namespace Debugger


400

hjk's avatar
hjk committed
401
static SessionManager *sessionManager()
402
{
hjk's avatar
hjk committed
403
    return ProjectExplorerPlugin::instance()->session();
404 405
}

406 407 408 409 410 411 412
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
// Retrieve file name and line and optionally address
// from the data set on the text editor context menu action.
static bool positionFromContextActionData(const QObject *sender,
                                          QString *fileName,
                                          int *lineNumber,
                                          quint64 *address = 0)
{
    if (const QAction *action = qobject_cast<const QAction *>(sender)) {
        const QVariantList data = action->data().toList();
        if (data.size() >= (address ? 3 : 2)) {
            *fileName = data.front().toString();
            *lineNumber = data.at(1).toInt();
            if (address)
                *address = data.at(2).toULongLong();
            return true;
        }
    }
    return false;
}

433
namespace Debugger {
434 435 436
namespace Cdb {
void addCdb2OptionPages(QList<Core::IOptionsPage*> *);
} // namespace Cdb
437 438 439 440 441 442 443 444
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.

hjk's avatar
hjk committed
445 446 447
void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
448
#ifdef CDB_ENABLED
hjk's avatar
hjk committed
449
void addCdbOptionPages(QList<IOptionsPage*> *opts);
450 451 452 453 454
#endif

struct AttachRemoteParameters
{
    AttachRemoteParameters() : attachPid(0), winCrashEvent(0) {}
455
    void clear();
456 457

    quint64 attachPid;
458
    QString attachTarget;  // core file name or  server:port
459
    // Event handle for attaching to crashed Windows processes.
460 461 462
    quint64 winCrashEvent;
};

463 464 465 466 467
void AttachRemoteParameters::clear()
{
    attachPid = winCrashEvent = 0;
    attachTarget.clear();
}
468

469 470 471 472 473 474
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
475 476 477
class DebugMode : public Core::BaseMode
{
public:
478 479
    DebugMode(QObject *parent = 0) : BaseMode(parent)
    {
480
        setDisplayName(QCoreApplication::translate("Debugger::Internal::DebugMode", "Debug"));
hjk's avatar
hjk committed
481
        setType(CC::MODE_EDIT_TYPE);
482
        setId(MODE_DEBUG);
483
        setIcon(QIcon(__(":/fancyactionbar/images/mode_Debug.png")));
484 485
        setPriority(P_MODE_DEBUG);
    }
hjk's avatar
hjk committed
486

487 488 489 490 491 492
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        EditorManager::instance()->setParent(0);
    }
};
hjk's avatar
hjk committed
493

494

con's avatar
con committed
495 496 497 498 499 500
///////////////////////////////////////////////////////////////////////
//
// LocationMark
//
///////////////////////////////////////////////////////////////////////

501
// Used in "real" editors
502
class LocationMark : public TextEditor::BaseTextMark
con's avatar
con committed
503 504 505 506
{
public:
    LocationMark(const QString &fileName, int linenumber)
        : BaseTextMark(fileName, linenumber)
507
    {}
con's avatar
con committed
508

509
    QIcon icon() const { return debuggerCore()->locationMarkIcon(); }
con's avatar
con committed
510 511
    void updateLineNumber(int /*lineNumber*/) {}
    void updateBlock(const QTextBlock & /*block*/) {}
512
    void removedFromEditor() {}
con's avatar
con committed
513 514
};

515 516 517

///////////////////////////////////////////////////////////////////////
//
518
// CommonOptionsPage
519 520 521
//
///////////////////////////////////////////////////////////////////////

522
class CommonOptionsPage : public Core::IOptionsPage
523 524
{
public:
525
    CommonOptionsPage() {}
526 527

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

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

private:
545
    Ui::CommonOptionsPage m_ui;
546
    Utils::SavedActionSet m_group;
547
    QString m_searchKeywords;
548 549
};

550
QWidget *CommonOptionsPage::createPage(QWidget *parent)
551 552 553
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);
554
    m_group.clear();
555

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

588
    if (m_searchKeywords.isEmpty()) {
589 590
        QTextStream(&m_searchKeywords) << ' '
                << m_ui.checkBoxListSourceFiles->text()
591 592
                << ' ' << m_ui.checkBoxUseAlternatingRowColors->text()
                << ' ' << m_ui.checkBoxUseToolTipsInMainEditor->text()
593 594 595
#ifdef Q_OS_WIN
                << ' ' << m_ui.checkBoxRegisterForPostMortem->text()
#endif
596 597 598
                << ' ' << m_ui.labelMaximalStackDepth->text();
        m_searchKeywords.remove(QLatin1Char('&'));
    }
599 600 601
#ifndef Q_OS_WIN
    m_ui.checkBoxRegisterForPostMortem->setVisible(false);
#endif
602 603 604
    return w;
}

605 606 607 608 609
bool CommonOptionsPage::matches(const QString &s) const
{
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
}

hjk's avatar
hjk committed
610 611
///////////////////////////////////////////////////////////////////////
//
612
// DebuggingHelperOptionPage
hjk's avatar
hjk committed
613 614 615
//
///////////////////////////////////////////////////////////////////////

616 617 618
static inline bool oxygenStyle()
{
    if (const ManhattanStyle *ms = qobject_cast<const ManhattanStyle *>(qApp->style()))
619
        return !qstrcmp("OxygenStyle", ms->baseStyle()->metaObject()->className());
620 621 622
    return false;
}

623
class DebuggingHelperOptionPage : public Core::IOptionsPage
hjk's avatar
hjk committed
624 625
{
    Q_OBJECT // Needs tr-context.
hjk's avatar
hjk committed
626
public:
627
    DebuggingHelperOptionPage() {}
hjk's avatar
hjk committed
628 629

    // IOptionsPage
hjk's avatar
hjk committed
630
    QString id() const { return _("Z.DebuggingHelper"); }
631
    QString displayName() const { return tr("Debugging Helper"); }
hjk's avatar
hjk committed
632
    QString category() const { return _(DEBUGGER_SETTINGS_CATEGORY); }
633 634 635 636
    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
637 638

    QWidget *createPage(QWidget *parent);
hjk's avatar
hjk committed
639
    void apply() { m_group.apply(ICore::instance()->settings()); }
640
    void finish() { m_group.finish(); }
641
    virtual bool matches(const QString &s) const;
hjk's avatar
hjk committed
642 643

private:
644
    Ui::DebuggingHelperOptionPage m_ui;
645
    Utils::SavedActionSet m_group;
646
    QString m_searchKeywords;
hjk's avatar
hjk committed
647 648
};

649
QWidget *DebuggingHelperOptionPage::createPage(QWidget *parent)
hjk's avatar
hjk committed
650 651 652 653
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);

654
    m_ui.dumperLocationChooser->setExpectedKind(Utils::PathChooser::Command);
655
    m_ui.dumperLocationChooser->setPromptDialogTitle(tr("Choose DebuggingHelper Location"));
hjk's avatar
hjk committed
656
    m_ui.dumperLocationChooser->setInitialBrowsePathBackup(
hjk's avatar
hjk committed
657
        ICore::instance()->resourcePath() + "../../lib");
hjk's avatar
hjk committed
658

659
    m_group.clear();
hjk's avatar
hjk committed
660
    m_group.insert(debuggerCore()->action(UseDebuggingHelpers),
661
        m_ui.debuggingHelperGroupBox);
hjk's avatar
hjk committed
662
    m_group.insert(debuggerCore()->action(UseCustomDebuggingHelperLocation),
663
        m_ui.customLocationGroupBox);
hjk's avatar
hjk committed
664
    // Suppress Oxygen style's giving flat group boxes bold titles.
665
    if (oxygenStyle())
hjk's avatar
hjk committed
666
        m_ui.customLocationGroupBox->setStyleSheet(_("QGroupBox::title { font: ; }"));
667

hjk's avatar
hjk committed
668
    m_group.insert(debuggerCore()->action(CustomDebuggingHelperLocation),
669
        m_ui.dumperLocationChooser);
hjk's avatar
hjk committed
670

hjk's avatar
hjk committed
671
    m_group.insert(debuggerCore()->action(UseCodeModel),
672 673
        m_ui.checkBoxUseCodeModel);

674
#ifdef QT_DEBUG
hjk's avatar
hjk committed
675
    m_group.insert(debuggerCore()->action(DebugDebuggingHelpers),
676
        m_ui.checkBoxDebugDebuggingHelpers);
677 678 679
#else
    m_ui.checkBoxDebugDebuggingHelpers->hide();
#endif
hjk's avatar
hjk committed
680 681 682 683

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

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

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

708

con's avatar
con committed
709 710
///////////////////////////////////////////////////////////////////////
//
711
// Argument parsing
con's avatar
con committed
712 713 714
//
///////////////////////////////////////////////////////////////////////

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

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

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

784
    *errorMessage = DebuggerPlugin::tr("Invalid debugger option: %1").arg(option);
785 786 787
    return false;
}

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

805 806 807 808 809 810 811

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

hjk's avatar
hjk committed
812
static bool isDebuggable(IEditor *editor)
813
{
814 815
    // 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
816 817
    //   IFile *file = editor->file();
    //   return !(file && file->mimeType() == "application/x-qml");
818
    // Nowadays, even Qml is debuggable.
hjk's avatar
hjk committed
819
    return editor;
820 821
}

con's avatar
con committed
822

823 824 825 826 827
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
828

829 830 831
struct DebuggerActions
{
    QAction *continueAction;
832
    QAction *exitAction; // on the application output button if "Stop" is possible
833 834
    QAction *interruptAction; // on the fat debug button if "Pause" is possible
    QAction *undisturbableAction; // on the fat debug button if nothing can be done
835 836 837
    QAction *resetAction; // FIXME: Should not be needed in a stable release
    QAction *stepAction;
    QAction *stepOutAction;
838
    QAction *runToLineAction; // Debug menu
839
    QAction *runToFunctionAction;
840
    QAction *jumpToLineAction; // in the Debug menu
841 842
    QAction *returnFromFunctionAction;
    QAction *nextAction;
843
    //QAction *snapshotAction;
844 845 846 847 848 849 850 851
    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
852

853
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
854 855


856 857 858 859 860
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
861

862
class DebuggerPluginPrivate : public DebuggerCore
863 864
{
    Q_OBJECT
865

866 867
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
868
    ~DebuggerPluginPrivate();
869

870
    bool initialize(const QStringList &arguments, QString *errorMessage);
871
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
872
    void disconnectEngine() { connectEngine(0); }
873
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
874

875
public slots:
876 877 878 879
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
880

hjk's avatar
hjk committed
881
    void breakpointSetMarginActionTriggered()
882 883 884 885 886 887 888 889
    {
        QString fileName;
        int lineNumber;
        quint64 address;
        if (positionFromContextActionData(sender(), &fileName, &lineNumber, &address))
            m_breakHandler->toggleBreakpoint(fileName, lineNumber, address);
     }

hjk's avatar
hjk committed
890
    void breakpointRemoveMarginActionTriggered()
891
    {
hjk's avatar
hjk committed
892 893
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
894
        m_breakHandler->removeBreakpoint(act->data().toInt());
hjk's avatar
hjk committed
895 896 897 898 899 900 901 902 903 904 905 906 907 908
     }

    void breakpointEnableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
        breakHandler()->setEnabled(act->data().toInt(), true);
    }

    void breakpointDisableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
        breakHandler()->setEnabled(act->data().toInt(), false);
909 910
    }

911
    void updateWatchersHeader(int section, int, int newSize)
hjk's avatar