debuggerplugin.cpp 117 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
**
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"

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

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

63 64
#include "snapshothandler.h"
#include "threadshandler.h"
hjk's avatar
hjk committed
65
#include "gdb/gdboptionspage.h"
con's avatar
con committed
66

67
#include "ui_commonoptionspage.h"
hjk's avatar
hjk committed
68
#include "ui_dumperoptionpage.h"
69

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

con's avatar
con committed
87
#include <cppeditor/cppeditorconstants.h>
88
#include <cplusplus/ModelManagerInterface.h>
hjk's avatar
hjk committed
89

90 91
#include <extensionsystem/pluginmanager.h>

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

100 101
#include <qt4projectmanager/qt4projectmanagerconstants.h>

hjk's avatar
hjk committed
102
#include <texteditor/basetexteditor.h>
103
#include <texteditor/fontsettings.h>
104
#include <texteditor/texteditorsettings.h>
hjk's avatar
hjk committed
105 106

#include <utils/qtcassert.h>
107
#include <utils/savedaction.h>
108
#include <utils/styledbar.h>
con's avatar
con committed
109

110 111
#include <qml/scriptconsole.h>

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

125 126
#include <climits>

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


256 257 258
/* 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
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 289 290 291 292
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
293
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
294 295 296


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




330

con's avatar
con committed
331
using namespace Core;
hjk's avatar
hjk committed
332
using namespace Debugger::Constants;
con's avatar
con committed
333
using namespace ProjectExplorer;
hjk's avatar
hjk committed
334
using namespace TextEditor;
con's avatar
con committed
335

hjk's avatar
hjk committed
336 337 338
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
339 340 341 342

namespace Debugger {
namespace Constants {

343 344
const char * const M_DEBUG_START_DEBUGGING = "QtCreator.Menu.Debug.StartDebugging";

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

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

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

} // namespace Constants


405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
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);
421

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

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

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

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

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

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

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

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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


487 488 489 490 491 492
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

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

519

520 521
///////////////////////////////////////////////////////////////////////
//
522
// CommonOptionsPage
523 524 525
//
///////////////////////////////////////////////////////////////////////

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

683

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

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

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

711

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

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

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

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

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

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

812 813 814 815 816 817 818

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

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

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

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

851 852 853
namespace Debugger {
namespace Internal {

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

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


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

887
class DebuggerPluginPrivate : public DebuggerCore
888 889
{
    Q_OBJECT
890

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

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

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

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

hjk's avatar
hjk committed
909
    void breakpointSetMarginActionTriggered()
910
    {
911 912 913 914 915 916 917
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
        const ContextData data = action->data().value<ContextData>();
        if (data.address)
            toggleBreakpointByAddress(data.address);
        else
            toggleBreakpointByFileAndLine(data.fileName, data.lineNumber);
918
    }