debuggerplugin.cpp 117 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
con's avatar
con committed
9
** No Commercial Usage
10
**
con's avatar
con committed
11 12 13 14
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
15
**
16
** GNU Lesser General Public License Usage
17
**
18 19 20 21 22 23
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24
**
con's avatar
con committed
25 26 27 28 29 30
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
con's avatar
con committed
31
**
32
**************************************************************************/
hjk's avatar
hjk committed
33

con's avatar
con committed
34 35
#include "debuggerplugin.h"

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

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

66 67
#include "snapshothandler.h"
#include "threadshandler.h"
hjk's avatar
hjk committed
68
#include "gdb/gdboptionspage.h"
con's avatar
con committed
69

70
#include "ui_commonoptionspage.h"
hjk's avatar
hjk committed
71
#include "ui_dumperoptionpage.h"
72

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

con's avatar
con committed
90
#include <cppeditor/cppeditorconstants.h>
91
#include <cplusplus/ModelManagerInterface.h>
hjk's avatar
hjk committed
92

93 94
#include <extensionsystem/pluginmanager.h>

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

103 104
#include <qt4projectmanager/qt4projectmanagerconstants.h>

hjk's avatar
hjk committed
105
#include <texteditor/basetexteditor.h>
106
#include <texteditor/fontsettings.h>
107
#include <texteditor/texteditorsettings.h>
hjk's avatar
hjk committed
108 109

#include <utils/qtcassert.h>
110
#include <utils/savedaction.h>
111
#include <utils/styledbar.h>
112
#include <utils/proxyaction.h>
con's avatar
con committed
113

114 115
#include <qml/scriptconsole.h>

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

129 130
#include <climits>

131 132 133 134 135 136 137 138 139 140
#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

141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
*/

/*!
    \class Debugger::DebuggerEngine

    \brief Base class of a debugger engine.

    Note: the Debugger process itself and any helper processes like
    gdbserver, the trk client etc are referred to as 'Engine',
    whereas the debugged process is referred to as 'Inferior'.

    Transitions marked by '---' are done in the individual engines.
    Transitions marked by '+-+' are done in the base DebuggerEngine.
    Transitions marked by '*' are done asynchronously.

    The GdbEngine->setupEngine() function is described in more detail below.

    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.
    \code

                        DebuggerNotReady
                         progressmanager/progressmanager.cpp      +
                      EngineSetupRequested
                               +
                  (calls *Engine->setupEngine())
                            |      |
                            |      |
                       {notify-  {notify-
                        Engine-   Engine-
                        SetupOk}  SetupFailed}
                            +      +
                            +      `+-+-+> EngineSetupFailed
                            +                   +
                            +    [calls RunControl->startFailed]
                            +                   +
                            +             DebuggerFinished
                            v
                      EngineSetupOk
                            +
             [calls RunControl->StartSuccessful]
                            +
                  InferiorSetupRequested
                            +
             (calls *Engine->setupInferior())
                         |       |
                         |       |
                    {notify-   {notify-
                     Inferior- Inferior-
                     SetupOk}  SetupFailed}
                         +       +
                         +       ` +-+-> InferiorSetupFailed +-+-+-+-+-+->.
                         +                                                +
                  InferiorSetupOk                                         +
                         +                                                +
                  EngineRunRequested                                      +
                         +                                                +
                 (calls *Engine->runEngine())                             +
               /       |            |        \                            +
             /         |            |          \                          +
            | (core)   | (attach)   |           |                         +
            |          |            |           |                         +
      {notify-    {notifyER&- {notifyER&-  {notify-                       +
      Inferior-     Inferior-   Inferior-  EngineRun-                     +
     Unrunnable}     StopOk}     RunOk}     Failed}                       +
           +           +            +           +                         +
   InferiorUnrunnable  +     InferiorRunOk      +                         +
                       +                        +                         +
                InferiorStopOk            EngineRunFailed                 +
                                                +                         v
                                                 `-+-+-+-+-+-+-+-+-+-+-+>-+
                                                                          +
                                                                          +
                       #Interrupt@InferiorRunOk#                          +
                                  +                                       +
                          InferiorStopRequested                           +
  #SpontaneousStop                +                                       +
   @InferiorRunOk#         (calls *Engine->                               +
          +               interruptInferior())                            +
      {notify-               |          |                                 +
     Spontaneous-       {notify-    {notify-                              +
      Inferior-          Inferior-   Inferior-                            +
       StopOk}           StopOk}    StopFailed}                           +
           +              +             +                                 +
            +            +              +                                 +
            InferiorStopOk              +                                 +
                  +                     +                                 +
                  +                    +                                  +
                  +                   +                                   +
        #Stop@InferiorUnrunnable#    +                                    +
          #Creator Close Event#     +                                     +
                       +           +                                      +
                InferiorShutdownRequested                                 +
                            +                                             +
           (calls *Engine->shutdownInferior())                            +
                         |        |                                       +
                    {notify-   {notify-                                   +
                     Inferior- Inferior-                                  +
                  ShutdownOk}  ShutdownFailed}                            +
                         +        +                                       +
                         +        +                                       +
  #Inferior exited#      +        +                                       +
         |               +        +                                       +
   {notifyInferior-      +        +                                       +
      Exited}            +        +                                       +
           +             +        +                                       +
     InferiorExitOk      +        +                                       +
             +           +        +                                       +
            InferiorShutdownOk InferiorShutdownFailed                     +
                      *          *                                        +
                  EngineShutdownRequested                                 +
                            +                                             +
           (calls *Engine->shutdownEngine())  <+-+-+-+-+-+-+-+-+-+-+-+-+-+'
                         |        |
                         |        |
                    {notify-   {notify-
                     Engine-    Engine-
                  ShutdownOk}  ShutdownFailed}
                         +       +
            EngineShutdownOk  EngineShutdownFailed
                         *       *
                     DebuggerFinished

\endcode */
hjk's avatar
hjk committed
275

276 277 278
/* 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
279

280 281 282 283 284 285
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" ];
286
sg1:   InferiorSetupRequested -> InferiorSetupOk [ label="notifyInferiorSetupOk", style="dashed" ];
287
sg1:   InferiorSetupRequested -> InferiorSetupFailed [ label="notifyInferiorFailed", style="dashed" ];
288
sg1:   InferiorSetupOk -> EngineRunRequested
289 290 291 292 293 294 295 296 297 298 299 300 301 302
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
303 304
sg1:   InferiorStopOk -> InferiorShutdownRequested [ label="Close event" ];
sg1:   InferiorUnrunnable -> InferiorShutdownRequested [ label="Close event" ];
305 306
sg1:   InferiorShutdownRequested -> InferiorShutdownOk [ label= "Engine::shutdownInferior\nnotifyInferiorShutdownOk", style="dashed" ];
sg1:   InferiorShutdownRequested -> InferiorShutdownFailed [ label="Engine::shutdownInferior\nnotifyInferiorShutdownFailed", style="dashed" ];
307 308
sg1:   InferiorExited -> InferiorExitOk [ label="notifyInferiorExited", style="dashed"];
sg1:   InferiorExitOk -> InferiorShutdownOk
309 310 311 312 313 314 315 316
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
317
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
318 319


320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
/*!
    \class Debugger::Internal::GdbEngine
    \brief Implementation of Debugger::Engine driving a gdb executable.

    GdbEngine specific startup. All happens in EngineSetupRequested state:

    Transitions marked by '---' are done in the individual adapters.

    Transitions marked by '+-+' are done in the GdbEngine.

    \code
                  GdbEngine::setupEngine()
                          +
            (calls *Adapter->startAdapter())
                          |      |
                          |      `---> handleAdapterStartFailed()
                          |                   +
                          |             {notifyEngineSetupFailed}
                          |
                 handleAdapterStarted()
                          +
                 {notifyEngineSetupOk}
342 343 344



345 346 347 348 349 350 351 352 353 354 355
                GdbEngine::setupInferior()
                          +
            (calls *Adapter->prepareInferior())
                          |      |
                          |      `---> handlePrepareInferiorFailed()
                          |                   +
                          |             {notifyInferiorSetupFailed}
                          |
                handleInferiorPrepared()
                          +
                {notifyInferiorSetupOk}
356

357
\endcode */
358

con's avatar
con committed
359
using namespace Core;
hjk's avatar
hjk committed
360
using namespace Debugger::Constants;
con's avatar
con committed
361
using namespace ProjectExplorer;
hjk's avatar
hjk committed
362
using namespace TextEditor;
con's avatar
con committed
363

hjk's avatar
hjk committed
364 365 366
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
367 368 369 370

namespace Debugger {
namespace Constants {

371 372
const char * const M_DEBUG_START_DEBUGGING = "QtCreator.Menu.Debug.StartDebugging";

con's avatar
con committed
373 374
const char * const STARTEXTERNAL        = "Debugger.StartExternal";
const char * const ATTACHEXTERNAL       = "Debugger.AttachExternal";
375
const char * const ATTACHCORE           = "Debugger.AttachCore";
hjk's avatar
hjk committed
376
const char * const ATTACHTCF            = "Debugger.AttachTcf";
377
const char * const ATTACHREMOTE         = "Debugger.AttachRemote";
378
const char * const ATTACHREMOTECDB      = "Debugger.AttachRemoteCDB";
379
const char * const STARTREMOTELLDB      = "Debugger.StartRemoteLLDB";
380
const char * const DETACH               = "Debugger.Detach";
con's avatar
con committed
381

382 383
const char * const RUN_TO_LINE1         = "Debugger.RunToLine1";
const char * const RUN_TO_LINE2         = "Debugger.RunToLine2";
con's avatar
con committed
384
const char * const RUN_TO_FUNCTION      = "Debugger.RunToFunction";
385 386
const char * const JUMP_TO_LINE1        = "Debugger.JumpToLine1";
const char * const JUMP_TO_LINE2        = "Debugger.JumpToLine2";
387
const char * const RETURN_FROM_FUNCTION = "Debugger.ReturnFromFunction";
388
const char * const SNAPSHOT             = "Debugger.Snapshot";
con's avatar
con committed
389 390 391
const char * const TOGGLE_BREAK         = "Debugger.ToggleBreak";
const char * const BREAK_BY_FUNCTION    = "Debugger.BreakByFunction";
const char * const BREAK_AT_MAIN        = "Debugger.BreakAtMain";
392 393
const char * const ADD_TO_WATCH1        = "Debugger.AddToWatch1";
const char * const ADD_TO_WATCH2        = "Debugger.AddToWatch2";
394
const char * const OPERATE_BY_INSTRUCTION  = "Debugger.OperateByInstruction";
395 396
const char * const FRAME_UP             = "Debugger.FrameUp";
const char * const FRAME_DOWN           = "Debugger.FrameDown";
con's avatar
con committed
397

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
398
#ifdef Q_WS_MAC
con's avatar
con committed
399
const char * const STOP_KEY                 = "Shift+Ctrl+Y";
con's avatar
con committed
400
const char * const RESET_KEY                = "Ctrl+Shift+F5";
con's avatar
con committed
401 402 403
const char * const STEP_KEY                 = "Ctrl+Shift+I";
const char * const STEPOUT_KEY              = "Ctrl+Shift+T";
const char * const NEXT_KEY                 = "Ctrl+Shift+O";
404
const char * const REVERSE_KEY              = "";
con's avatar
con committed
405 406
const char * const RUN_TO_LINE_KEY          = "Shift+F8";
const char * const RUN_TO_FUNCTION_KEY      = "Ctrl+F6";
407
const char * const JUMP_TO_LINE_KEY         = "Ctrl+D,Ctrl+L";
con's avatar
con committed
408
const char * const TOGGLE_BREAK_KEY         = "F8";
409 410 411 412
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
413
#else
414
const char * const STOP_KEY                 = "Shift+F5";
con's avatar
con committed
415 416 417 418
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";
419
const char * const REVERSE_KEY              = "F12";
con's avatar
con committed
420 421 422 423 424 425 426
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";
427
const char * const SNAPSHOT_KEY             = "Ctrl+D,Ctrl+S";
con's avatar
con committed
428 429 430 431 432
#endif

} // namespace Constants


433 434 435 436 437 438 439 440
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.

441
void addCdbOptionPages(QList<IOptionsPage*> *opts);
442 443 444
void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
445

446 447 448 449
#ifdef WITH_LLDB
void addLldbOptionPages(QList<IOptionsPage*> *opts);
#endif

hjk's avatar
hjk committed
450
static SessionManager *sessionManager()
451
{
hjk's avatar
hjk committed
452
    return ProjectExplorerPlugin::instance()->session();
453 454
}

455 456 457 458 459 460 461
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

462 463 464
struct AttachRemoteParameters
{
    AttachRemoteParameters() : attachPid(0), winCrashEvent(0) {}
465
    void clear();
466 467

    quint64 attachPid;
468
    QString attachTarget;  // core file name or  server:port
469
    // Event handle for attaching to crashed Windows processes.
470 471 472
    quint64 winCrashEvent;
};

473 474 475 476 477
void AttachRemoteParameters::clear()
{
    attachPid = winCrashEvent = 0;
    attachTarget.clear();
}
478

479 480 481 482 483 484 485 486 487 488 489 490 491

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
    DummyEngine() : DebuggerEngine(DebuggerStartParameters()) {}
492 493 494 495 496 497 498 499 500 501
    ~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; }
502 503 504 505 506 507 508 509 510
};

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


511 512 513 514 515 516
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

517
class DebugMode : public IMode
hjk's avatar
hjk committed
518 519
{
public:
hjk's avatar
hjk committed
520
    DebugMode() : m_widget(0) { setObjectName(QLatin1String("DebugMode")); }
hjk's avatar
hjk committed
521

hjk's avatar
hjk committed
522 523 524 525 526 527
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        //EditorManager::instance()->setParent(0);
        delete m_widget;
    }
528 529

    // IMode
hjk's avatar
hjk committed
530 531 532 533 534 535 536 537 538
    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(); }
539 540
private:
    QWidget *m_widget;
541
};
hjk's avatar
hjk committed
542

543

544 545
///////////////////////////////////////////////////////////////////////
//
546
// CommonOptionsPage
547 548 549
//
///////////////////////////////////////////////////////////////////////

550
class CommonOptionsPage : public Core::IOptionsPage
551 552
{
public:
553
    CommonOptionsPage() {}
554 555

    // IOptionsPage
556
    QString id() const
hjk's avatar
hjk committed
557
        { return _(DEBUGGER_COMMON_SETTINGS_ID); }
558
    QString displayName() const
hjk's avatar
hjk committed
559
        { return QCoreApplication::translate("Debugger", DEBUGGER_COMMON_SETTINGS_NAME); }
560
    QString category() const
hjk's avatar
hjk committed
561
        { return _(DEBUGGER_SETTINGS_CATEGORY);  }
562
    QString displayCategory() const
hjk's avatar
hjk committed
563
        { return QCoreApplication::translate("Debugger", DEBUGGER_SETTINGS_TR_CATEGORY); }
564 565
    QIcon categoryIcon() const
        { return QIcon(QLatin1String(DEBUGGER_COMMON_SETTINGS_CATEGORY_ICON)); }
566 567

    QWidget *createPage(QWidget *parent);
hjk's avatar
hjk committed
568
    void apply() { m_group.apply(ICore::instance()->settings()); }
569
    void finish() { m_group.finish(); }
570
    virtual bool matches(const QString &s) const;
571 572

private:
573
    Ui::CommonOptionsPage m_ui;
574
    Utils::SavedActionSet m_group;
575
    QString m_searchKeywords;
576 577
};

578
QWidget *CommonOptionsPage::createPage(QWidget *parent)
579 580 581
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);
582
    m_group.clear();
583

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

616
    if (m_searchKeywords.isEmpty()) {
617 618 619 620 621
        QLatin1Char sep(' ');
        QTextStream(&m_searchKeywords)
                << sep << m_ui.checkBoxUseAlternatingRowColors->text()
                << sep << m_ui.checkBoxUseToolTipsInMainEditor->text()
                << sep << m_ui.checkBoxListSourceFiles->text()
622
#ifdef Q_OS_WIN
623
                << sep << m_ui.checkBoxRegisterForPostMortem->text()
624
#endif
625 626 627 628
                << sep << m_ui.checkBoxCloseBuffersOnExit->text()
                << sep << m_ui.checkBoxSwitchModeOnExit->text()
                << sep << m_ui.labelMaximalStackDepth->text()
                   ;
629 630
        m_searchKeywords.remove(QLatin1Char('&'));
    }
631 632 633
#ifndef Q_OS_WIN
    m_ui.checkBoxRegisterForPostMortem->setVisible(false);
#endif
634 635 636
    return w;
}

637 638 639 640 641
bool CommonOptionsPage::matches(const QString &s) const
{
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
}

hjk's avatar
hjk committed
642 643
///////////////////////////////////////////////////////////////////////
//
644
// DebuggingHelperOptionPage
hjk's avatar
hjk committed
645 646 647
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
648
static bool oxygenStyle()
649
{
hjk's avatar
hjk committed
650 651
    const ManhattanStyle *ms = qobject_cast<const ManhattanStyle *>(qApp->style());
    return ms && !qstrcmp("OxygenStyle", ms->baseStyle()->metaObject()->className());
652 653
}

654
class DebuggingHelperOptionPage : public Core::IOptionsPage
hjk's avatar
hjk committed
655 656
{
    Q_OBJECT // Needs tr-context.
hjk's avatar
hjk committed
657
public:
658
    DebuggingHelperOptionPage() {}
hjk's avatar
hjk committed
659 660

    // IOptionsPage
hjk's avatar
hjk committed
661
    QString id() const { return _("Z.DebuggingHelper"); }
662
    QString displayName() const { return tr("Debugging Helper"); }
hjk's avatar
hjk committed
663
    QString category() const { return _(DEBUGGER_SETTINGS_CATEGORY); }
664 665 666 667
    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
668 669

    QWidget *createPage(QWidget *parent);
hjk's avatar
hjk committed
670
    void apply() { m_group.apply(ICore::instance()->settings()); }
671
    void finish() { m_group.finish(); }
672
    virtual bool matches(const QString &s) const;
hjk's avatar
hjk committed
673 674

private:
675
    Ui::DebuggingHelperOptionPage m_ui;
676
    Utils::SavedActionSet m_group;
677
    QString m_searchKeywords;
hjk's avatar
hjk committed
678 679
};

680
QWidget *DebuggingHelperOptionPage::createPage(QWidget *parent)
hjk's avatar
hjk committed
681 682 683 684
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);

685
    m_ui.dumperLocationChooser->setExpectedKind(Utils::PathChooser::Command);
686
    m_ui.dumperLocationChooser->setPromptDialogTitle(tr("Choose DebuggingHelper Location"));
hjk's avatar
hjk committed
687
    m_ui.dumperLocationChooser->setInitialBrowsePathBackup(
hjk's avatar
hjk committed
688
        ICore::instance()->resourcePath() + "../../lib");
hjk's avatar
hjk committed
689

690
    m_group.clear();
hjk's avatar
hjk committed
691
    m_group.insert(debuggerCore()->action(UseDebuggingHelpers),
692
        m_ui.debuggingHelperGroupBox);
hjk's avatar
hjk committed
693
    m_group.insert(debuggerCore()->action(UseCustomDebuggingHelperLocation),
694
        m_ui.customLocationGroupBox);
hjk's avatar
hjk committed
695
    // Suppress Oxygen style's giving flat group boxes bold titles.
696
    if (oxygenStyle())
hjk's avatar
hjk committed
697
        m_ui.customLocationGroupBox->setStyleSheet(_("QGroupBox::title { font: ; }"));
698

hjk's avatar
hjk committed
699
    m_group.insert(debuggerCore()->action(CustomDebuggingHelperLocation),
700
        m_ui.dumperLocationChooser);
hjk's avatar
hjk committed
701

hjk's avatar
hjk committed
702
    m_group.insert(debuggerCore()->action(UseCodeModel),
703
        m_ui.checkBoxUseCodeModel);
704 705 706
    m_group.insert(debuggerCore()->action(ShowThreadNames),
        m_ui.checkBoxShowThreadNames);

707

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

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

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

735

con's avatar
con committed
736 737
///////////////////////////////////////////////////////////////////////
//
738
// Argument parsing
con's avatar
con committed
739 740 741
//
///////////////////////////////////////////////////////////////////////

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

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

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

815
    *errorMessage = DebuggerPlugin::tr("Invalid debugger option: %1").arg(option);
816 817 818
    return false;
}

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

836 837 838 839 840 841 842

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

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

853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
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
868

869 870
///////////////////////////////////////////////////////////////////////
//
hjk's avatar
hjk committed
871
// Debugger Actions
872 873
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
874

875 876 877
namespace Debugger {
namespace Internal {

878 879 880
struct DebuggerActions
{
    QAction *continueAction;
881
    QAction *exitAction; // on the application output button if "Stop" is possible
882 883
    QAction *interruptAction; // on the fat debug button if "Pause" is possible
    QAction *undisturbableAction; // on the fat debug button if nothing can be done
884 885 886
    QAction *resetAction; // FIXME: Should not be needed in a stable release
    QAction *stepAction;
    QAction *stepOutAction;
887
    QAction *runToLineAction; // Debug menu
888
    QAction *runToFunctionAction;
889
    QAction *jumpToLineAction; // in the Debug menu
890 891
    QAction *returnFromFunctionAction;
    QAction *nextAction;
892
    //QAction *snapshotAction;
893 894 895 896 897 898 899 900
    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
901

902
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
903 904


905 906 907 908 909
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
910

911
class DebuggerPluginPrivate : public DebuggerCore
912 913
{
    Q_OBJECT
914

915 916
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
917
    ~DebuggerPluginPrivate();
918

919
    bool initialize(const QStringList &arguments, QString *errorMessage);
920 921 922
    void extensionsInitialized();
    void aboutToShutdown();

923
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
924
    void disconnectEngine() { connectEngine(0); }
925
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
926

927
public slots:
928 929 930 931
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
932

hjk's avatar
hjk committed
933
    void breakpointSetMarginActionTriggered()
934
    {
935 936 937 938 939 940 941
        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);
942
    }
943

hjk's avatar
hjk committed
944
    void breakpointRemoveMarginActionTriggered()
945
    {
hjk's avatar
hjk committed
946 947
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
948
        m_breakHandler->removeBreakpoint(act->data().toInt());
hjk's avatar
hjk committed
949 950 951 952 953 954 955 956 957 958 959 960 961 962
     }

    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);
963 964
    }

965
    void updateWatchersHeader(int section, int, int newSize)
966 967