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

#include "breakwindow.h"
45
#include "consolewindow.h"
46
#include "logwindow.h"
47 48 49 50 51 52 53 54
#include "moduleswindow.h"
#include "registerwindow.h"
#include "snapshotwindow.h"
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
#include "watchwindow.h"

55
#include "breakhandler.h"
56
#include "sessionengine.h"
57 58 59
#include "snapshothandler.h"
#include "threadshandler.h"
#include "watchutils.h"
60 61 62 63 64

#ifdef Q_OS_WIN
#  include "shared/peutils.h"
#endif

con's avatar
con committed
65

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

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

con's avatar
con committed
89
#include <cplusplus/ExpressionUnderCursor.h>
90
#include <cplusplus/CppDocument.h>
hjk's avatar
hjk committed
91

con's avatar
con committed
92
#include <cppeditor/cppeditorconstants.h>
93
#include <cpptools/cppmodelmanagerinterface.h>
hjk's avatar
hjk committed
94

95 96
#include <extensionsystem/pluginmanager.h>

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

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

111 112
//#include <qt4projectmanager/qt4projectmanagerconstants.h>

hjk's avatar
hjk committed
113
#include <utils/qtcassert.h>
114
#include <utils/savedaction.h>
115
#include <utils/styledbar.h>
con's avatar
con committed
116

117 118
#include <qml/scriptconsole.h>

119
#include <QtCore/QCoreApplication>
con's avatar
con committed
120
#include <QtCore/QDebug>
121 122
#include <QtCore/QDir>
#include <QtCore/QFileInfo>
con's avatar
con committed
123 124 125
#include <QtCore/QObject>
#include <QtCore/QPoint>
#include <QtCore/QSettings>
126 127
#include <QtCore/QTextStream>
#include <QtCore/QTime>
128
#include <QtCore/QTimer>
129
#include <QtCore/QVariant>
130
#include <QtCore/QtPlugin>
131
#include <QtCore/QScopedPointer>
hjk's avatar
hjk committed
132

133 134 135 136
#include <QtGui/QAbstractItemView>
#include <QtGui/QAction>
#include <QtGui/QApplication>
#include <QtGui/QComboBox>
137
#include <QtGui/QDockWidget>
138 139 140 141 142 143 144
#include <QtGui/QErrorMessage>
#include <QtGui/QFileDialog>
#include <QtGui/QHeaderView>
#include <QtGui/QLabel>
#include <QtGui/QLineEdit>
#include <QtGui/QMenu>
#include <QtGui/QMessageBox>
con's avatar
con committed
145
#include <QtGui/QPlainTextEdit>
146 147
#include <QtGui/QPushButton>
#include <QtGui/QStatusBar>
con's avatar
con committed
148 149
#include <QtGui/QTextBlock>
#include <QtGui/QTextCursor>
150
#include <QtGui/QToolButton>
151 152
#include <QtGui/QToolTip>
#include <QtGui/QTreeWidget>
con's avatar
con committed
153

154 155
#include <climits>

156 157 158 159 160 161 162 163 164 165 166
#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
167
// gdbserver, the trk client etc are referred to as 'Engine',
168 169
// whereas the debugged process is referred to as 'Inferior'.
//
170 171
// Transitions marked by '---' are done in the individual engines.
// Transitions marked by '+-+' are done in the base DebuggerEngine.
hjk's avatar
hjk committed
172
// Transitions marked by '*' are done asynchronously.
hjk's avatar
hjk committed
173
// The GdbEngine->setupEngine() function is described in more detail below.
174
//
175 176 177 178 179 180 181
// 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
182 183 184 185 186 187
//                        DebuggerNotReady
//                               +
//                      EngineSetupRequested
//                               +
//                  (calls *Engine->setupEngine())
//                            |      |
188
//                            |      |
hjk's avatar
hjk committed
189 190 191
//                       {notify-  {notify-
//                        Engine-   Engine-
//                        SetupOk}  SetupFailed}
192 193 194 195 196 197
//                            +      +
//                            +      `+-+-+> EngineSetupFailed
//                            +                   +
//                            +    [calls RunControl->startFailed]
//                            +                   +
//                            +             DebuggerFinished
hjk's avatar
hjk committed
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
//                            v
//                      EngineSetupOk
//                            +
//             [calls RunControl->StartSuccessful]
//                            +
//                  InferiorSetupRequested
//                            +
//             (calls *Engine->setupInferior())
//                         |       |
//                         |       |
//                    {notify-   {notify-
//                     Inferior- Inferior-
//                     SetupOk}  SetupFailed}
//                         +       +
//                         +       ` +-+-> InferiorSetupFailed +-+-+-+-+-+->.
//                         +                                                +
//                         +                                                +
//                  EngineRunRequested                                      +
//                         +                                                +
//                 (calls *Engine->runEngine())                             +
//               /       |            |        \                            +
//             /         |            |          \                          +
//            | (core)   | (attach)   |           |                         +
//            |          |            |           |                         +
//      {notify-    {notifyER&- {notifyER&-  {notify-                       +
//      Inferior-     Inferior-   Inferior-  RunEngine-                     +
//     Unrunnable}     StopOk}     RunOk}     Failed}                       +
//           +           +            +           +                         +
//   InferiorUnrunnable  +     InferiorRunOk      +                         +
//                       +                        +                         +
//                InferiorStopOk            EngineRunFailed                 +
//                                                +                         v
//                                                 `-+-+-+-+-+-+-+-+-+-+-+>-+
//                                                                          +
hjk's avatar
hjk committed
232 233
//                                                                          +
//                       #Interupt@InferiorRunOk#                           +
hjk's avatar
hjk committed
234
//                                  +                                       +
hjk's avatar
hjk committed
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
//                          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
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
//                InferiorShutdownRequested                                 +
//                            +                                             +
//           (calls *Engine->shutdownInferior())                            +
//                         |        |                                       +
//                    {notify-   {notify-                                   +
//                     Inferior- Inferior-                                  +
//                  ShutdownOk}  ShutdownFailed}                            +
//                         +        +                                       +
//                         +        +                                       +
//  #Inferior exited#      +        +                                       +
//         |               +        +                                       +
//   {notifyInferior-      +        +                                       +
//      Exited}            +        +                                       +
//           +             +        +                                       +
//            +            +        +                                       +
//             +           +        +                                       +
//            InferiorShutdownOk InferiorShutdownFailed                     +
//                      *          *                                        +
//                  EngineShutdownRequested                                 +
//                            +                                             +
//           (calls *Engine->shutdownEngine())  <+-+-+-+-+-+-+-+-+-+-+-+-+-+' 
//                         |        |                                        
274
//                         |        |                                        
hjk's avatar
hjk committed
275
//                    {notify-   {notify-                                    
hjk's avatar
hjk committed
276
//                     Engine-    Engine-
hjk's avatar
hjk committed
277 278 279 280 281
//                  ShutdownOk}  ShutdownFailed}                             
//                         +       +                                         
//            EngineShutdownOk  EngineShutdownFailed                         
//                         *       *
//                     DebuggerFinished
282 283 284
/* 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
285

286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
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
319
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
320 321 322


// GdbEngine specific startup. All happens in EngineSetupRequested state
323
//
324 325
// Transitions marked by '---' are done in the individual adapters.
// Transitions marked by '+-+' are done in the GdbEngine.
hjk's avatar
hjk committed
326
//
hjk's avatar
hjk committed
327
//                  GdbEngine::setupEngine()
328 329 330 331 332
//                          +
//            (calls *Adapter->startAdapter())
//                          |      |
//                          |      `---> handleAdapterStartFailed()
//                          |                   +
hjk's avatar
hjk committed
333
//                          |             {notifyEngineSetupFailed}
334 335 336
//                          |
//                 handleAdapterStarted()
//                          +
hjk's avatar
hjk committed
337 338 339 340 341 342
//                 {notifyEngineSetupOk}
//
//
//
//                GdbEngine::setupInferior()
//                          +      
343 344
//            (calls *Adapter->prepareInferior())
//                          |      |
hjk's avatar
hjk committed
345
//                          |      `---> handlePrepareInferiorFailed()
346
//                          |                   +
hjk's avatar
hjk committed
347
//                          |             {notifyInferiorSetupFailed}
348
//                          |
hjk's avatar
hjk committed
349
//                handleInferiorPrepared()
350
//                          +
hjk's avatar
hjk committed
351
//                {notifyInferiorSetupOk}  
352 353 354 355




356

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

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

con's avatar
con committed
366 367 368 369

namespace Debugger {
namespace Constants {

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

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

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

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

} // namespace Constants
} // namespace Debugger


431

hjk's avatar
hjk committed
432
static SessionManager *sessionManager()
433
{
hjk's avatar
hjk committed
434
    return ProjectExplorerPlugin::instance()->session();
435 436
}

437 438 439 440 441
static QSettings *settings()
{
    return ICore::instance()->settings();
}

442 443 444 445 446 447 448
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

449 450 451
namespace Debugger {
namespace Internal {

hjk's avatar
hjk committed
452 453
static const char *Role = "ROLE";

454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
// 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<Core::IOptionsPage*> *opts);
void addScriptOptionPages(QList<Core::IOptionsPage*> *opts);
void addTcfOptionPages(QList<Core::IOptionsPage*> *opts);
#ifdef CDB_ENABLED
void addCdbOptionPages(QList<Core::IOptionsPage*> *opts);
#endif


struct AttachRemoteParameters
{
    AttachRemoteParameters() : attachPid(0), winCrashEvent(0) {}
471
    void clear();
472 473

    quint64 attachPid;
474 475
    QString attachTarget;  // core file name or  server:port
    // Event handle for attaching to crashed Windows processes. 
476 477 478
    quint64 winCrashEvent;
};

479 480 481 482 483
void AttachRemoteParameters::clear()
{
    attachPid = winCrashEvent = 0;
    attachTarget.clear();
}
484

485 486 487 488 489 490
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
491 492 493
class DebugMode : public Core::BaseMode
{
public:
494 495
    DebugMode(QObject *parent = 0) : BaseMode(parent)
    {
496
        setDisplayName(QCoreApplication::translate("Debugger::Internal::DebugMode", "Debug"));
497
        setType(Core::Constants::MODE_EDIT_TYPE);
498
        setId(MODE_DEBUG);
499
        setIcon(QIcon(__(":/fancyactionbar/images/mode_Debug.png")));
500 501
        setPriority(P_MODE_DEBUG);
    }
hjk's avatar
hjk committed
502

503 504 505 506 507 508
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        EditorManager::instance()->setParent(0);
    }
};
hjk's avatar
hjk committed
509

con's avatar
con committed
510 511 512 513 514 515
///////////////////////////////////////////////////////////////////////
//
// LocationMark
//
///////////////////////////////////////////////////////////////////////

516
// Used in "real" editors
517
class LocationMark : public TextEditor::BaseTextMark
con's avatar
con committed
518 519 520 521
{
public:
    LocationMark(const QString &fileName, int linenumber)
        : BaseTextMark(fileName, linenumber)
522
    {}
con's avatar
con committed
523

524
    QIcon icon() const { return DebuggerPlugin::instance()->locationMarkIcon(); }
con's avatar
con committed
525 526
    void updateLineNumber(int /*lineNumber*/) {}
    void updateBlock(const QTextBlock & /*block*/) {}
527
    void removedFromEditor() {}
con's avatar
con committed
528 529
};

530 531 532

///////////////////////////////////////////////////////////////////////
//
533
// CommonOptionsPage
534 535 536
//
///////////////////////////////////////////////////////////////////////

537
class CommonOptionsPage : public Core::IOptionsPage
538 539
{
public:
540
    CommonOptionsPage() {}
541 542

    // IOptionsPage
543
    QString id() const
hjk's avatar
hjk committed
544
        { return _(DEBUGGER_COMMON_SETTINGS_ID); }
545
    QString displayName() const
hjk's avatar
hjk committed
546
        { return QCoreApplication::translate("Debugger", DEBUGGER_COMMON_SETTINGS_NAME); }
547
    QString category() const
hjk's avatar
hjk committed
548
        { return _(DEBUGGER_SETTINGS_CATEGORY);  }
549
    QString displayCategory() const
hjk's avatar
hjk committed
550
        { return QCoreApplication::translate("Debugger", DEBUGGER_SETTINGS_TR_CATEGORY); }
551 552
    QIcon categoryIcon() const
        { return QIcon(QLatin1String(DEBUGGER_COMMON_SETTINGS_CATEGORY_ICON)); }
553 554

    QWidget *createPage(QWidget *parent);
555
    void apply() { m_group.apply(settings()); }
556
    void finish() { m_group.finish(); }
557
    virtual bool matches(const QString &s) const;
558 559

private:
560
    Ui::CommonOptionsPage m_ui;
561
    Utils::SavedActionSet m_group;
562
    QString m_searchKeywords;
563 564
};

565
QWidget *CommonOptionsPage::createPage(QWidget *parent)
566 567 568
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);
569
    m_group.clear();
570

571
    m_group.insert(theDebuggerAction(ListSourceFiles),
572
        m_ui.checkBoxListSourceFiles);
573
    m_group.insert(theDebuggerAction(UseAlternatingRowColors),
574
        m_ui.checkBoxUseAlternatingRowColors);
575
    m_group.insert(theDebuggerAction(UseToolTipsInMainEditor),
576
        m_ui.checkBoxUseToolTipsInMainEditor);
577 578 579 580
    m_group.insert(theDebuggerAction(CloseBuffersOnExit),
        m_ui.checkBoxCloseBuffersOnExit);
    m_group.insert(theDebuggerAction(SwitchModeOnExit),
        m_ui.checkBoxSwitchModeOnExit);
581
    m_group.insert(theDebuggerAction(AutoDerefPointers), 0);
582 583 584 585
    m_group.insert(theDebuggerAction(UseToolTipsInLocalsView), 0);
    m_group.insert(theDebuggerAction(UseToolTipsInBreakpointsView), 0);
    m_group.insert(theDebuggerAction(UseAddressInBreakpointsView), 0);
    m_group.insert(theDebuggerAction(UseAddressInStackView), 0);
586
    m_group.insert(theDebuggerAction(MaximalStackDepth),
587
        m_ui.spinBoxMaximalStackDepth);
588 589
    m_group.insert(theDebuggerAction(ShowStdNamespace), 0);
    m_group.insert(theDebuggerAction(ShowQtNamespace), 0);
590
    m_group.insert(theDebuggerAction(SortStructMembers), 0);
591
    m_group.insert(theDebuggerAction(LogTimeStamps), 0);
592
    m_group.insert(theDebuggerAction(VerboseLog), 0);
593 594
    m_group.insert(theDebuggerAction(BreakOnThrow), 0);
    m_group.insert(theDebuggerAction(BreakOnCatch), 0);
595 596 597 598 599 600 601
#ifdef Q_OS_WIN
    Utils::SavedAction *registerAction = theDebuggerAction(RegisterForPostMortem);
    m_group.insert(registerAction,
        m_ui.checkBoxRegisterForPostMortem);
    connect(registerAction, SIGNAL(toggled(bool)),
            m_ui.checkBoxRegisterForPostMortem, SLOT(setChecked(bool)));
#endif
602

603
    if (m_searchKeywords.isEmpty()) {
604 605
        QTextStream(&m_searchKeywords) << ' '
                << m_ui.checkBoxListSourceFiles->text()
606 607
                << ' ' << m_ui.checkBoxUseAlternatingRowColors->text()
                << ' ' << m_ui.checkBoxUseToolTipsInMainEditor->text()
608 609 610
#ifdef Q_OS_WIN
                << ' ' << m_ui.checkBoxRegisterForPostMortem->text()
#endif
611 612 613
                << ' ' << m_ui.labelMaximalStackDepth->text();
        m_searchKeywords.remove(QLatin1Char('&'));
    }
614 615 616
#ifndef Q_OS_WIN
    m_ui.checkBoxRegisterForPostMortem->setVisible(false);
#endif
617 618 619
    return w;
}

620 621 622 623 624
bool CommonOptionsPage::matches(const QString &s) const
{
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
}

hjk's avatar
hjk committed
625 626
///////////////////////////////////////////////////////////////////////
//
627
// DebuggingHelperOptionPage
hjk's avatar
hjk committed
628 629 630
//
///////////////////////////////////////////////////////////////////////

631 632 633
static inline bool oxygenStyle()
{
    if (const ManhattanStyle *ms = qobject_cast<const ManhattanStyle *>(qApp->style()))
634
        return !qstrcmp("OxygenStyle", ms->baseStyle()->metaObject()->className());
635 636 637
    return false;
}

638
class DebuggingHelperOptionPage : public Core::IOptionsPage
639 640
{   // Needs tr - context
    Q_OBJECT
hjk's avatar
hjk committed
641
public:
642
    DebuggingHelperOptionPage() {}
hjk's avatar
hjk committed
643 644

    // IOptionsPage
hjk's avatar
hjk committed
645
    QString id() const { return _("Z.DebuggingHelper"); }
646
    QString displayName() const { return tr("Debugging Helper"); }
hjk's avatar
hjk committed
647
    QString category() const { return _(DEBUGGER_SETTINGS_CATEGORY); }
648 649 650 651
    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
652 653

    QWidget *createPage(QWidget *parent);
654
    void apply() { m_group.apply(settings()); }
655
    void finish() { m_group.finish(); }
656
    virtual bool matches(const QString &s) const;
hjk's avatar
hjk committed
657 658

private:
659
    Ui::DebuggingHelperOptionPage m_ui;
660
    Utils::SavedActionSet m_group;
661
    QString m_searchKeywords;
hjk's avatar
hjk committed
662 663
};

664
QWidget *DebuggingHelperOptionPage::createPage(QWidget *parent)
hjk's avatar
hjk committed
665 666 667 668
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);

669
    m_ui.dumperLocationChooser->setExpectedKind(Utils::PathChooser::Command);
670
    m_ui.dumperLocationChooser->setPromptDialogTitle(tr("Choose DebuggingHelper Location"));
hjk's avatar
hjk committed
671 672
    m_ui.dumperLocationChooser->setInitialBrowsePathBackup(
        Core::ICore::instance()->resourcePath() + "../../lib");
hjk's avatar
hjk committed
673

674
    m_group.clear();
675
    m_group.insert(theDebuggerAction(UseDebuggingHelpers),
676
        m_ui.debuggingHelperGroupBox);
677
    m_group.insert(theDebuggerAction(UseCustomDebuggingHelperLocation),
678
        m_ui.customLocationGroupBox);
hjk's avatar
hjk committed
679
    // Suppress Oxygen style's giving flat group boxes bold titles.
680
    if (oxygenStyle())
hjk's avatar
hjk committed
681
        m_ui.customLocationGroupBox->setStyleSheet(_("QGroupBox::title { font: ; }"));
682

683
    m_group.insert(theDebuggerAction(CustomDebuggingHelperLocation),
684
        m_ui.dumperLocationChooser);
hjk's avatar
hjk committed
685

686 687 688
    m_group.insert(theDebuggerAction(UseCodeModel),
        m_ui.checkBoxUseCodeModel);

689
#ifdef QT_DEBUG
690 691
    m_group.insert(theDebuggerAction(DebugDebuggingHelpers),
        m_ui.checkBoxDebugDebuggingHelpers);
692 693 694
#else
    m_ui.checkBoxDebugDebuggingHelpers->hide();
#endif
hjk's avatar
hjk committed
695 696 697 698

#ifndef QT_DEBUG
#if 0
    cmd = am->registerAction(m_manager->m_dumpLogAction,
hjk's avatar
hjk committed
699
        DUMP_LOG, globalcontext);
hjk's avatar
hjk committed
700 701 702 703 704 705
    //cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+D,Ctrl+L")));
    cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+Shift+F11")));
    mdebug->addAction(cmd);
#endif
#endif

706 707 708 709 710 711
    if (m_searchKeywords.isEmpty()) {
        QTextStream(&m_searchKeywords)
                << ' ' << m_ui.debuggingHelperGroupBox->title()
                << ' ' << m_ui.customLocationGroupBox->title()
                << ' ' << m_ui.dumperLocationLabel->text()
                << ' ' << m_ui.checkBoxUseCodeModel->text()
712
                << ' ' << m_ui.checkBoxDebugDebuggingHelpers->text();
713 714
        m_searchKeywords.remove(QLatin1Char('&'));
    }
hjk's avatar
hjk committed
715 716 717
    return w;
}

718
bool DebuggingHelperOptionPage::matches(const QString &s) const
hjk's avatar
hjk committed
719
{
720
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
hjk's avatar
hjk committed
721 722
}

723

con's avatar
con committed
724 725
///////////////////////////////////////////////////////////////////////
//
726
// Argument parsing
con's avatar
con committed
727 728 729
//
///////////////////////////////////////////////////////////////////////

730
static QString msgParameterMissing(const QString &a)
731 732 733 734
{
    return DebuggerPlugin::tr("Option '%1' is missing the parameter.").arg(a);
}

735
static QString msgInvalidNumericParameter(const QString &a, const QString &number)
736 737 738 739
{
    return DebuggerPlugin::tr("The parameter '%1' of option '%2' is not a number.").arg(number, a);
}

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

799
    *errorMessage = DebuggerPlugin::tr("Invalid debugger option: %1").arg(option);
800 801 802
    return false;
}

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

820 821 822 823 824 825 826 827

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

static bool isDebuggable(Core::IEditor *editor)
828
{
829 830 831 832 833 834 835 836
    // Only blacklist Qml. Whitelisting would fail on C++ code in files
    // with strange names, more harm would be done this way.
    //Core::IFile *file = editor->file();
    //return !(file && file->mimeType() == "application/x-qml");

    // Nowadays, even Qml is debuggable.
    Q_UNUSED(editor);
    return true;
837 838
}

839
static TextEditor::ITextEditor *currentTextEditor()
con's avatar
con committed
840
{
841 842 843 844 845 846
    EditorManager *editorManager = EditorManager::instance();
    if (!editorManager)
        return 0;
    Core::IEditor *editor = editorManager->currentEditor();
    return qobject_cast<ITextEditor*>(editor);
}
con's avatar
con committed
847

848 849 850 851 852
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
853

854 855 856
struct DebuggerActions
{
    QAction *continueAction;
857 858 859
    QAction *stopAction; // on the application output button if "Stop" is possible
    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 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
    QAction *resetAction; // FIXME: Should not be needed in a stable release
    QAction *stepAction;
    QAction *stepOutAction;
    QAction *runToLineAction1; // in the Debug menu
    QAction *runToLineAction2; // in the text editor context menu
    QAction *runToFunctionAction;
    QAction *jumpToLineAction1; // in the Debug menu
    QAction *jumpToLineAction2; // in the text editor context menu
    QAction *returnFromFunctionAction;
    QAction *nextAction;
    QAction *snapshotAction;
    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
879

880
} // namespace Internal
con's avatar
con committed
881

882
using namespace Debugger::Internal;
con's avatar
con committed
883

884 885 886 887 888
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
889

890 891 892
class DebuggerPluginPrivate : public QObject
{
    Q_OBJECT
893

894 895
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
896

897 898
    bool initialize(const QStringList &arguments, QString *errorMessage);
    void notifyCurrentEngine(int role, const QVariant &value = QVariant());
899
    void connectEngine(DebuggerEngine *engine, bool notify = true);
900
    void disconnectEngine() { connectEngine(m_sessionEngine); }
901

902 903 904
public slots:
    void updateWatchersHeader(int section, int, int newSize)
        { m_watchersWindow->header()->resizeSection(section, newSize); }
905

906
    void sourceFilesDockToggled(bool on)
hjk's avatar
hjk committed
907
        { if (on) notifyCurrentEngine(RequestReloadSourceFilesRole); }
908
    void modulesDockToggled(bool on)
hjk's avatar
hjk committed
909 910 911
        { if (on) notifyCurrentEngine(RequestReloadModulesRole); }
    void registerDockToggled(bool on)
        { if (on) notifyCurrentEngine(RequestReloadRegistersRole); }
912

913
    void onAction();
914
    void setSimpleDockWidgetArrangement(const Debugger::DebuggerLanguages &activeLanguages);
915

916 917 918 919 920 921 922
    void editorOpened(Core::IEditor *editor);
    void editorAboutToClose(Core::IEditor *editor);
    void setBusyCursor(bool busy);
    void requestMark(TextEditor::ITextEditor *editor, int lineNumber);
    void showToolTip(TextEditor::ITextEditor *editor, const QPoint &pnt, int pos);
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
923

924 925 926 927 928 929
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
    void toggleBreakpoint(const QString &fileName, int lineNumber);
    void onModeChanged(Core::IMode *mode);
    void showSettingsDialog();
930

931 932 933 934 935
    void startExternalApplication();
    void startRemoteApplication();
    void attachExternalApplication();
    void attachExternalApplication
        (qint64 pid, const QString &binary, const QString &crashParameter);
936
    bool attachCmdLine();
937 938
    void attachCore();
    void attachCore(const QString &core, const QString &exeFileName);
939
    void attachRemote(const QString &spec);
940
    void attachRemoteTcf();
941

942
    void enableReverseDebuggingTriggered(const QVariant