debuggerplugin.cpp 121 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
#include "debuggerdialogs.h"
#include "debuggerengine.h"
38
#include "debuggermainwindow.h"
con's avatar
con committed
39
#include "debuggerrunner.h"
40
#include "debuggerstringutils.h"
41 42
#include "debuggertooltip.h"

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

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

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

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

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

86 87
#include <extensionsystem/pluginmanager.h>

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

95 96
#include <qt4projectmanager/qt4projectmanagerconstants.h>

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

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

106 107
#include <qml/scriptconsole.h>

108
#include <QtCore/QTimer>
109 110
#include <QtCore/QtPlugin>
#include <QtGui/QComboBox>
111
#include <QtGui/QDockWidget>
112
#include <QtGui/QFileDialog>
hjk's avatar
hjk committed
113
#include <QtGui/QMenu>
114
#include <QtGui/QMessageBox>
115 116 117
#include <QtGui/QPushButton>
#include <QtGui/QTextBlock>
#include <QtGui/QTextCursor>
118
#include <QtGui/QToolButton>
hjk's avatar
hjk committed
119
#include <QtGui/QTreeWidget>
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
//                            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-                       +
190
//      Inferior-     Inferior-   Inferior-  EngineRun-                     +
hjk's avatar
hjk committed
191 192 193 194 195 196 197 198
//     Unrunnable}     StopOk}     RunOk}     Failed}                       +
//           +           +            +           +                         +
//   InferiorUnrunnable  +     InferiorRunOk      +                         +
//                       +                        +                         +
//                InferiorStopOk            EngineRunFailed                 +
//                                                +                         v
//                                                 `-+-+-+-+-+-+-+-+-+-+-+>-+
//                                                                          +
hjk's avatar
hjk committed
199
//                                                                          +
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 ATTACHREMOTECDB      = "Debugger.AttachRemoteCDB";
347
const char * const STARTREMOTELLDB      = "Debugger.StartRemoteLLDB";
348
const char * const DETACH               = "Debugger.Detach";
con's avatar
con committed
349

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

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

} // namespace Constants


401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
namespace Cdb {
void addCdb2OptionPages(QList<Core::IOptionsPage*> *);
} // namespace Cdb


namespace Internal {

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

void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
#ifdef CDB_ENABLED
void addCdbOptionPages(QList<IOptionsPage*> *opts);
#endif
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
// Retrieve file name and line and optionally address
// from the data set on the text editor context menu action.
439 440
static bool positionFromActionData(const QObject *sender,
    QString *fileName, int *lineNumber, quint64 *address)
441
{
442 443 444 445 446 447
    const QAction *action = qobject_cast<const QAction *>(sender);
    QTC_ASSERT(action, return false);
    const QVariantList data = action->data().toList();
    QTC_ASSERT(data.size() == 3, return false);
    *fileName = data.front().toString();
    *lineNumber = data.at(1).toInt();
448
    *address = data.at(2).toULongLong();
449
    return true;
450 451
}

452 453 454
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 475 476 477 478 479 480 481

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
    DummyEngine() : DebuggerEngine(DebuggerStartParameters()) {}
482 483 484 485 486 487 488 489 490 491
    ~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; }
492 493 494 495 496 497 498 499 500
};

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


501 502 503 504 505 506
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

507
class DebugMode : public IMode
hjk's avatar
hjk committed
508 509
{
public:
510
    DebugMode() : m_widget(0) {  setObjectName(QLatin1String("DebugMode"));  }
hjk's avatar
hjk committed
511

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

    // IMode
hjk's avatar
hjk committed
516 517 518 519 520 521 522 523 524
    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(); }
525 526
private:
    QWidget *m_widget;
527
};
hjk's avatar
hjk committed
528

529

con's avatar
con committed
530 531 532 533 534 535
///////////////////////////////////////////////////////////////////////
//
// LocationMark
//
///////////////////////////////////////////////////////////////////////

536
// Used in "real" editors
537
class LocationMark : public TextEditor::BaseTextMark
con's avatar
con committed
538 539 540 541
{
public:
    LocationMark(const QString &fileName, int linenumber)
        : BaseTextMark(fileName, linenumber)
542
    {}
con's avatar
con committed
543

544
    QIcon icon() const { return debuggerCore()->locationMarkIcon(); }
con's avatar
con committed
545 546
    void updateLineNumber(int /*lineNumber*/) {}
    void updateBlock(const QTextBlock & /*block*/) {}
547
    void removedFromEditor() {}
con's avatar
con committed
548 549
};

550 551 552

///////////////////////////////////////////////////////////////////////
//
553
// CommonOptionsPage
554 555 556
//
///////////////////////////////////////////////////////////////////////

557
class CommonOptionsPage : public Core::IOptionsPage
558 559
{
public:
560
    CommonOptionsPage() {}
561 562

    // IOptionsPage
563
    QString id() const
hjk's avatar
hjk committed
564
        { return _(DEBUGGER_COMMON_SETTINGS_ID); }
565
    QString displayName() const
hjk's avatar
hjk committed
566
        { return QCoreApplication::translate("Debugger", DEBUGGER_COMMON_SETTINGS_NAME); }
567
    QString category() const
hjk's avatar
hjk committed
568
        { return _(DEBUGGER_SETTINGS_CATEGORY);  }
569
    QString displayCategory() const
hjk's avatar
hjk committed
570
        { return QCoreApplication::translate("Debugger", DEBUGGER_SETTINGS_TR_CATEGORY); }
571 572
    QIcon categoryIcon() const
        { return QIcon(QLatin1String(DEBUGGER_COMMON_SETTINGS_CATEGORY_ICON)); }
573 574

    QWidget *createPage(QWidget *parent);
hjk's avatar
hjk committed
575
    void apply() { m_group.apply(ICore::instance()->settings()); }
576
    void finish() { m_group.finish(); }
577
    virtual bool matches(const QString &s) const;
578 579

private:
580
    Ui::CommonOptionsPage m_ui;
581
    Utils::SavedActionSet m_group;
582
    QString m_searchKeywords;
583 584
};

585
QWidget *CommonOptionsPage::createPage(QWidget *parent)
586 587 588
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);
589
    m_group.clear();
590

hjk's avatar
hjk committed
591
    m_group.insert(debuggerCore()->action(ListSourceFiles),
592
        m_ui.checkBoxListSourceFiles);
hjk's avatar
hjk committed
593
    m_group.insert(debuggerCore()->action(UseAlternatingRowColors),
594
        m_ui.checkBoxUseAlternatingRowColors);
hjk's avatar
hjk committed
595
    m_group.insert(debuggerCore()->action(UseToolTipsInMainEditor),
596
        m_ui.checkBoxUseToolTipsInMainEditor);
hjk's avatar
hjk committed
597
    m_group.insert(debuggerCore()->action(CloseBuffersOnExit),
598
        m_ui.checkBoxCloseBuffersOnExit);
hjk's avatar
hjk committed
599
    m_group.insert(debuggerCore()->action(SwitchModeOnExit),
600
        m_ui.checkBoxSwitchModeOnExit);
hjk's avatar
hjk committed
601 602 603 604 605 606
    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),
607
        m_ui.spinBoxMaximalStackDepth);
hjk's avatar
hjk committed
608 609 610 611 612 613 614
    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);
615
#ifdef Q_OS_WIN
hjk's avatar
hjk committed
616
    Utils::SavedAction *registerAction = debuggerCore()->action(RegisterForPostMortem);
617 618 619 620 621
    m_group.insert(registerAction,
        m_ui.checkBoxRegisterForPostMortem);
    connect(registerAction, SIGNAL(toggled(bool)),
            m_ui.checkBoxRegisterForPostMortem, SLOT(setChecked(bool)));
#endif
622

623
    if (m_searchKeywords.isEmpty()) {
624 625 626 627 628
        QLatin1Char sep(' ');
        QTextStream(&m_searchKeywords)
                << sep << m_ui.checkBoxUseAlternatingRowColors->text()
                << sep << m_ui.checkBoxUseToolTipsInMainEditor->text()
                << sep << m_ui.checkBoxListSourceFiles->text()
629
#ifdef Q_OS_WIN
630
                << sep << m_ui.checkBoxRegisterForPostMortem->text()
631
#endif
632 633 634 635
                << sep << m_ui.checkBoxCloseBuffersOnExit->text()
                << sep << m_ui.checkBoxSwitchModeOnExit->text()
                << sep << m_ui.labelMaximalStackDepth->text()
                   ;
636 637
        m_searchKeywords.remove(QLatin1Char('&'));
    }
638 639 640
#ifndef Q_OS_WIN
    m_ui.checkBoxRegisterForPostMortem->setVisible(false);
#endif
641 642 643
    return w;
}

644 645 646 647 648
bool CommonOptionsPage::matches(const QString &s) const
{
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
}

hjk's avatar
hjk committed
649 650
///////////////////////////////////////////////////////////////////////
//
651
// DebuggingHelperOptionPage
hjk's avatar
hjk committed
652 653 654
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
655
static bool oxygenStyle()
656
{
hjk's avatar
hjk committed
657 658
    const ManhattanStyle *ms = qobject_cast<const ManhattanStyle *>(qApp->style());
    return ms && !qstrcmp("OxygenStyle", ms->baseStyle()->metaObject()->className());
659 660
}

661
class DebuggingHelperOptionPage : public Core::IOptionsPage
hjk's avatar
hjk committed
662 663
{
    Q_OBJECT // Needs tr-context.
hjk's avatar
hjk committed
664
public:
665
    DebuggingHelperOptionPage() {}
hjk's avatar
hjk committed
666 667

    // IOptionsPage
hjk's avatar
hjk committed
668
    QString id() const { return _("Z.DebuggingHelper"); }
669
    QString displayName() const { return tr("Debugging Helper"); }
hjk's avatar
hjk committed
670
    QString category() const { return _(DEBUGGER_SETTINGS_CATEGORY); }
671 672 673 674
    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
675 676

    QWidget *createPage(QWidget *parent);
hjk's avatar
hjk committed
677
    void apply() { m_group.apply(ICore::instance()->settings()); }
678
    void finish() { m_group.finish(); }
679
    virtual bool matches(const QString &s) const;
hjk's avatar
hjk committed
680 681

private:
682
    Ui::DebuggingHelperOptionPage m_ui;
683
    Utils::SavedActionSet m_group;
684
    QString m_searchKeywords;
hjk's avatar
hjk committed
685 686
};

687
QWidget *DebuggingHelperOptionPage::createPage(QWidget *parent)
hjk's avatar
hjk committed
688 689 690 691
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);

692
    m_ui.dumperLocationChooser->setExpectedKind(Utils::PathChooser::Command);
693
    m_ui.dumperLocationChooser->setPromptDialogTitle(tr("Choose DebuggingHelper Location"));
hjk's avatar
hjk committed
694
    m_ui.dumperLocationChooser->setInitialBrowsePathBackup(
hjk's avatar
hjk committed
695
        ICore::instance()->resourcePath() + "../../lib");
hjk's avatar
hjk committed
696

697
    m_group.clear();
hjk's avatar
hjk committed
698
    m_group.insert(debuggerCore()->action(UseDebuggingHelpers),
699
        m_ui.debuggingHelperGroupBox);
hjk's avatar
hjk committed
700
    m_group.insert(debuggerCore()->action(UseCustomDebuggingHelperLocation),
701
        m_ui.customLocationGroupBox);
hjk's avatar
hjk committed
702
    // Suppress Oxygen style's giving flat group boxes bold titles.
703
    if (oxygenStyle())
hjk's avatar
hjk committed
704
        m_ui.customLocationGroupBox->setStyleSheet(_("QGroupBox::title { font: ; }"));
705

hjk's avatar
hjk committed
706
    m_group.insert(debuggerCore()->action(CustomDebuggingHelperLocation),
707
        m_ui.dumperLocationChooser);
hjk's avatar
hjk committed
708

hjk's avatar
hjk committed
709
    m_group.insert(debuggerCore()->action(UseCodeModel),
710 711
        m_ui.checkBoxUseCodeModel);

hjk's avatar
hjk committed
712 713
#ifndef QT_DEBUG
#if 0
hjk's avatar
hjk committed
714
    cmd = am->registerAction(m_dumpLogAction,
hjk's avatar
hjk committed
715
        DUMP_LOG, globalcontext);
hjk's avatar
hjk committed
716 717 718 719 720 721
    //cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+D,Ctrl+L")));
    cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+Shift+F11")));
    mdebug->addAction(cmd);
#endif
#endif

722 723 724 725 726
    if (m_searchKeywords.isEmpty()) {
        QTextStream(&m_searchKeywords)
                << ' ' << m_ui.debuggingHelperGroupBox->title()
                << ' ' << m_ui.customLocationGroupBox->title()
                << ' ' << m_ui.dumperLocationLabel->text()
727
                << ' ' << m_ui.checkBoxUseCodeModel->text();
728 729
        m_searchKeywords.remove(QLatin1Char('&'));
    }
hjk's avatar
hjk committed
730 731 732
    return w;
}

733
bool DebuggingHelperOptionPage::matches(const QString &s) const
hjk's avatar
hjk committed
734
{
735
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
hjk's avatar
hjk committed
736 737
}

738

con's avatar
con committed
739 740
///////////////////////////////////////////////////////////////////////
//
741
// Argument parsing
con's avatar
con committed
742 743 744
//
///////////////////////////////////////////////////////////////////////

745
static QString msgParameterMissing(const QString &a)
746 747 748 749
{
    return DebuggerPlugin::tr("Option '%1' is missing the parameter.").arg(a);
}

750
static QString msgInvalidNumericParameter(const QString &a, const QString &number)
751 752 753 754
{
    return DebuggerPlugin::tr("The parameter '%1' of option '%2' is not a number.").arg(number, a);
}

755
static bool parseArgument(QStringList::const_iterator &it,
756 757 758
    const QStringList::const_iterator &cend,
    AttachRemoteParameters *attachRemoteParameters,
    unsigned *enabledEngines, QString *errorMessage)
759 760 761
{
    const QString &option = *it;
    // '-debug <pid>'
762 763
    // '-debug <corefile>'
    // '-debug <server:port>'
hjk's avatar
hjk committed
764
    if (*it == _("-debug")) {
765 766 767 768 769 770
        ++it;
        if (it == cend) {
            *errorMessage = msgParameterMissing(*it);
            return false;
        }
        bool ok;
771
        attachRemoteParameters->attachPid = it->toULongLong(&ok);
772 773
        if (!ok)
            attachRemoteParameters->attachTarget = *it;
774 775
        return true;
    }
776 777
    // -wincrashevent <event-handle>. A handle used for
    // a handshake when attaching to a crashed Windows process.
hjk's avatar
hjk committed
778
    if (*it == _("-wincrashevent")) {
779 780 781 782 783 784
        ++it;
        if (it == cend) {
            *errorMessage = msgParameterMissing(*it);
            return false;
        }
        bool ok;
785
        attachRemoteParameters->winCrashEvent = it->toULongLong(&ok);
786 787 788 789 790 791
        if (!ok) {
            *errorMessage = msgInvalidNumericParameter(option, *it);
            return false;
        }
        return true;
    }
hjk's avatar
hjk committed
792
    // Engine disabling.
hjk's avatar
hjk committed
793
    if (option == _("-disable-cdb")) {
794
        *enabledEngines &= ~Debugger::CdbEngineType;
795 796
        return true;
    }
hjk's avatar
hjk committed
797
    if (option == _("-disable-gdb")) {
798
        *enabledEngines &= ~Debugger::GdbEngineType;
799 800
        return true;
    }
801 802 803 804
    if (option == _("-disable-qmldb")) {
        *enabledEngines &= ~Debugger::QmlEngineType;
        return true;
    }
hjk's avatar
hjk committed
805
    if (option == _("-disable-sdb")) {
806
        *enabledEngines &= ~Debugger::ScriptEngineType;
807 808
        return true;
    }
809
    if (option == _("-disable-tcf")) {
hjk's avatar
hjk committed
810 811 812
        *enabledEngines &= ~TcfEngineType;
        return true;
    }
813 814 815 816
    if (option == _("-disable-lldb")) {
        *enabledEngines &= ~LldbEngineType;
        return true;
    }
817

818
    *errorMessage = DebuggerPlugin::tr("Invalid debugger option: %1").arg(option);
819 820 821
    return false;
}

822
static bool parseArguments(const QStringList &args,
823
   AttachRemoteParameters *attachRemoteParameters,
hjk's avatar
hjk committed
824
   unsigned *enabledEngines, QString *errorMessage)
825
{
826
    attachRemoteParameters->clear();
827 828
    const QStringList::const_iterator cend = args.constEnd();
    for (QStringList::const_iterator it = args.constBegin(); it != cend; ++it)
829
        if (!parseArgument(it, cend, attachRemoteParameters, enabledEngines, errorMessage))
830 831
            return false;
    if (Debugger::Constants::Internal::debug)
832
        qDebug().nospace() << args << "engines=0x"
833 834
            << QString::number(*enabledEngines, 16)
            << " pid" << attachRemoteParameters->attachPid
835
            << " target" << attachRemoteParameters->attachTarget << '\n';
836 837 838
    return true;
}

839 840 841 842 843 844 845

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

hjk's avatar
hjk committed
846
static bool isDebuggable(IEditor *editor)
847
{
848 849
    // 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
850 851
    //   IFile *file = editor->file();
    //   return !(file && file->mimeType() == "application/x-qml");
852
    // Nowadays, even Qml is debuggable.
hjk's avatar
hjk committed
853
    return editor;
854 855
}

con's avatar
con committed
856

857 858
///////////////////////////////////////////////////////////////////////
//
hjk's avatar
hjk committed
859
// Debugger Actions
860 861
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
862

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

887
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
888 889


890 891 892 893 894
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
895

896
class DebuggerPluginPrivate : public DebuggerCore
897 898
{
    Q_OBJECT
899

900 901
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
902
    ~DebuggerPluginPrivate();
903

904
    bool initialize(const QStringList &arguments, QString *errorMessage);
905
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
906
    void disconnectEngine() { connectEngine(0); }
907
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
908