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

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

54
#include "sessionengine.h"
55 56
#include "snapshothandler.h"
#include "threadshandler.h"
con's avatar
con committed
57

58
#include "ui_commonoptionspage.h"
hjk's avatar
hjk committed
59
#include "ui_dumperoptionpage.h"
60

61
#include <coreplugin/actionmanager/actionmanager.h>
62 63
#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/command.h>
hjk's avatar
hjk committed
64
#include <coreplugin/basemode.h>
con's avatar
con committed
65
#include <coreplugin/coreconstants.h>
66
#include <coreplugin/dialogs/ioptionspage.h>
con's avatar
con committed
67
#include <coreplugin/editormanager/editormanager.h>
hjk's avatar
hjk committed
68
#include <coreplugin/findplaceholder.h>
69
#include <coreplugin/icontext.h>
con's avatar
con committed
70
#include <coreplugin/icore.h>
71
#include <coreplugin/imode.h>
72
#include <coreplugin/icorelistener.h>
73
#include <coreplugin/manhattanstyle.h>
hjk's avatar
hjk committed
74
#include <coreplugin/minisplitter.h>
con's avatar
con committed
75
#include <coreplugin/modemanager.h>
hjk's avatar
hjk committed
76

con's avatar
con committed
77
#include <cppeditor/cppeditorconstants.h>
78
#include <cpptools/cppmodelmanagerinterface.h>
hjk's avatar
hjk committed
79

80 81
#include <extensionsystem/pluginmanager.h>

82
#include <projectexplorer/project.h>
83
#include <projectexplorer/projectexplorer.h>
con's avatar
con committed
84 85
#include <projectexplorer/projectexplorerconstants.h>
#include <projectexplorer/session.h>
86
#include <projectexplorer/target.h>
87
#include <projectexplorer/toolchaintype.h>
hjk's avatar
hjk committed
88 89

#include <texteditor/basetexteditor.h>
con's avatar
con committed
90
#include <texteditor/basetextmark.h>
91
#include <texteditor/fontsettings.h>
92
#include <texteditor/texteditorsettings.h>
hjk's avatar
hjk committed
93 94

#include <utils/qtcassert.h>
95
#include <utils/savedaction.h>
96
#include <utils/styledbar.h>
con's avatar
con committed
97

98 99
#include <qml/scriptconsole.h>

100
#include <QtCore/QTimer>
101 102
#include <QtCore/QtPlugin>
#include <QtGui/QComboBox>
103
#include <QtGui/QDockWidget>
104 105
#include <QtGui/QFileDialog>
#include <QtGui/QMessageBox>
106
#include <QtGui/QToolButton>
con's avatar
con committed
107

108 109
#include <climits>

110 111 112 113 114 115 116 117 118 119 120
#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
121
// gdbserver, the trk client etc are referred to as 'Engine',
122 123
// whereas the debugged process is referred to as 'Inferior'.
//
124 125
// Transitions marked by '---' are done in the individual engines.
// Transitions marked by '+-+' are done in the base DebuggerEngine.
hjk's avatar
hjk committed
126
// Transitions marked by '*' are done asynchronously.
hjk's avatar
hjk committed
127
// The GdbEngine->setupEngine() function is described in more detail below.
128
//
hjk's avatar
hjk committed
129 130 131 132 133 134 135
// 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
136 137 138 139 140 141
//                        DebuggerNotReady
//                               +
//                      EngineSetupRequested
//                               +
//                  (calls *Engine->setupEngine())
//                            |      |
142
//                            |      |
hjk's avatar
hjk committed
143 144 145
//                       {notify-  {notify-
//                        Engine-   Engine-
//                        SetupOk}  SetupFailed}
146 147 148 149 150 151
//                            +      +
//                            +      `+-+-+> EngineSetupFailed
//                            +                   +
//                            +    [calls RunControl->startFailed]
//                            +                   +
//                            +             DebuggerFinished
hjk's avatar
hjk committed
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
//                            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
186 187
//                                                                          +
//                       #Interupt@InferiorRunOk#                           +
hjk's avatar
hjk committed
188
//                                  +                                       +
hjk's avatar
hjk committed
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
//                          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
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
//                InferiorShutdownRequested                                 +
//                            +                                             +
//           (calls *Engine->shutdownInferior())                            +
//                         |        |                                       +
//                    {notify-   {notify-                                   +
//                     Inferior- Inferior-                                  +
//                  ShutdownOk}  ShutdownFailed}                            +
//                         +        +                                       +
//                         +        +                                       +
//  #Inferior exited#      +        +                                       +
//         |               +        +                                       +
//   {notifyInferior-      +        +                                       +
//      Exited}            +        +                                       +
//           +             +        +                                       +
//            +            +        +                                       +
//             +           +        +                                       +
//            InferiorShutdownOk InferiorShutdownFailed                     +
//                      *          *                                        +
//                  EngineShutdownRequested                                 +
//                            +                                             +
//           (calls *Engine->shutdownEngine())  <+-+-+-+-+-+-+-+-+-+-+-+-+-+' 
//                         |        |                                        
228
//                         |        |                                        
hjk's avatar
hjk committed
229
//                    {notify-   {notify-                                    
hjk's avatar
hjk committed
230
//                     Engine-    Engine-
hjk's avatar
hjk committed
231 232 233 234 235
//                  ShutdownOk}  ShutdownFailed}                             
//                         +       +                                         
//            EngineShutdownOk  EngineShutdownFailed                         
//                         *       *
//                     DebuggerFinished
236 237 238
/* 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
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
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
273
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
274 275 276


// GdbEngine specific startup. All happens in EngineSetupRequested state
277
//
278 279
// Transitions marked by '---' are done in the individual adapters.
// Transitions marked by '+-+' are done in the GdbEngine.
hjk's avatar
hjk committed
280
//
hjk's avatar
hjk committed
281
//                  GdbEngine::setupEngine()
282 283 284 285 286
//                          +
//            (calls *Adapter->startAdapter())
//                          |      |
//                          |      `---> handleAdapterStartFailed()
//                          |                   +
hjk's avatar
hjk committed
287
//                          |             {notifyEngineSetupFailed}
288 289 290
//                          |
//                 handleAdapterStarted()
//                          +
hjk's avatar
hjk committed
291 292 293 294 295 296
//                 {notifyEngineSetupOk}
//
//
//
//                GdbEngine::setupInferior()
//                          +      
297 298
//            (calls *Adapter->prepareInferior())
//                          |      |
hjk's avatar
hjk committed
299
//                          |      `---> handlePrepareInferiorFailed()
300
//                          |                   +
hjk's avatar
hjk committed
301
//                          |             {notifyInferiorSetupFailed}
302
//                          |
hjk's avatar
hjk committed
303
//                handleInferiorPrepared()
304
//                          +
hjk's avatar
hjk committed
305
//                {notifyInferiorSetupOk}  
306 307 308 309




310

con's avatar
con committed
311
using namespace Core;
hjk's avatar
hjk committed
312 313
using namespace Debugger::Constants;
using namespace Debugger::Internal;
con's avatar
con committed
314
using namespace ProjectExplorer;
hjk's avatar
hjk committed
315
using namespace TextEditor;
con's avatar
con committed
316

hjk's avatar
hjk committed
317 318 319
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
320 321 322 323

namespace Debugger {
namespace Constants {

324 325
const char * const M_DEBUG_START_DEBUGGING = "QtCreator.Menu.Debug.StartDebugging";

con's avatar
con committed
326 327
const char * const STARTEXTERNAL        = "Debugger.StartExternal";
const char * const ATTACHEXTERNAL       = "Debugger.AttachExternal";
328
const char * const ATTACHCORE           = "Debugger.AttachCore";
hjk's avatar
hjk committed
329
const char * const ATTACHTCF            = "Debugger.AttachTcf";
330
const char * const ATTACHREMOTE         = "Debugger.AttachRemote";
331
const char * const DETACH               = "Debugger.Detach";
con's avatar
con committed
332

333 334
const char * const RUN_TO_LINE1         = "Debugger.RunToLine1";
const char * const RUN_TO_LINE2         = "Debugger.RunToLine2";
con's avatar
con committed
335
const char * const RUN_TO_FUNCTION      = "Debugger.RunToFunction";
336 337
const char * const JUMP_TO_LINE1        = "Debugger.JumpToLine1";
const char * const JUMP_TO_LINE2        = "Debugger.JumpToLine2";
338
const char * const RETURN_FROM_FUNCTION = "Debugger.ReturnFromFunction";
339
const char * const SNAPSHOT             = "Debugger.Snapshot";
con's avatar
con committed
340 341 342
const char * const TOGGLE_BREAK         = "Debugger.ToggleBreak";
const char * const BREAK_BY_FUNCTION    = "Debugger.BreakByFunction";
const char * const BREAK_AT_MAIN        = "Debugger.BreakAtMain";
343 344
const char * const ADD_TO_WATCH1        = "Debugger.AddToWatch1";
const char * const ADD_TO_WATCH2        = "Debugger.AddToWatch2";
345
const char * const OPERATE_BY_INSTRUCTION  = "Debugger.OperateByInstruction";
346 347
const char * const FRAME_UP             = "Debugger.FrameUp";
const char * const FRAME_DOWN           = "Debugger.FrameDown";
con's avatar
con committed
348

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
349
#ifdef Q_WS_MAC
con's avatar
con committed
350
const char * const STOP_KEY                 = "Shift+Ctrl+Y";
con's avatar
con committed
351
const char * const RESET_KEY                = "Ctrl+Shift+F5";
con's avatar
con committed
352 353 354
const char * const STEP_KEY                 = "Ctrl+Shift+I";
const char * const STEPOUT_KEY              = "Ctrl+Shift+T";
const char * const NEXT_KEY                 = "Ctrl+Shift+O";
355
const char * const REVERSE_KEY              = "";
con's avatar
con committed
356 357
const char * const RUN_TO_LINE_KEY          = "Shift+F8";
const char * const RUN_TO_FUNCTION_KEY      = "Ctrl+F6";
358
const char * const JUMP_TO_LINE_KEY         = "Ctrl+D,Ctrl+L";
con's avatar
con committed
359
const char * const TOGGLE_BREAK_KEY         = "F8";
360 361 362 363
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
364
#else
365
const char * const STOP_KEY                 = "Shift+F5";
con's avatar
con committed
366 367 368 369
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";
370
const char * const REVERSE_KEY              = "F12";
con's avatar
con committed
371 372 373 374 375 376 377
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";
378
const char * const SNAPSHOT_KEY             = "Ctrl+D,Ctrl+S";
con's avatar
con committed
379 380 381 382 383 384
#endif

} // namespace Constants
} // namespace Debugger


385

hjk's avatar
hjk committed
386
static SessionManager *sessionManager()
387
{
hjk's avatar
hjk committed
388
    return ProjectExplorerPlugin::instance()->session();
389 390
}

391 392 393 394 395
static QSettings *settings()
{
    return ICore::instance()->settings();
}

396 397 398 399 400 401 402
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

403 404 405
namespace Debugger {
namespace Internal {

hjk's avatar
hjk committed
406 407
static const char *Role = "ROLE";

408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
// 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) {}
425
    void clear();
426 427

    quint64 attachPid;
428 429
    QString attachTarget;  // core file name or  server:port
    // Event handle for attaching to crashed Windows processes. 
430 431 432
    quint64 winCrashEvent;
};

433 434 435 436 437
void AttachRemoteParameters::clear()
{
    attachPid = winCrashEvent = 0;
    attachTarget.clear();
}
438

439 440 441 442 443 444
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
445 446 447
class DebugMode : public Core::BaseMode
{
public:
448 449
    DebugMode(QObject *parent = 0) : BaseMode(parent)
    {
450
        setDisplayName(QCoreApplication::translate("Debugger::Internal::DebugMode", "Debug"));
451
        setType(Core::Constants::MODE_EDIT_TYPE);
452
        setId(MODE_DEBUG);
453
        setIcon(QIcon(__(":/fancyactionbar/images/mode_Debug.png")));
454 455
        setPriority(P_MODE_DEBUG);
    }
hjk's avatar
hjk committed
456

457 458 459 460 461 462
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        EditorManager::instance()->setParent(0);
    }
};
hjk's avatar
hjk committed
463

con's avatar
con committed
464 465 466 467 468 469
///////////////////////////////////////////////////////////////////////
//
// LocationMark
//
///////////////////////////////////////////////////////////////////////

470
// Used in "real" editors
471
class LocationMark : public TextEditor::BaseTextMark
con's avatar
con committed
472 473 474 475
{
public:
    LocationMark(const QString &fileName, int linenumber)
        : BaseTextMark(fileName, linenumber)
476
    {}
con's avatar
con committed
477

478
    QIcon icon() const { return DebuggerPlugin::instance()->locationMarkIcon(); }
con's avatar
con committed
479 480
    void updateLineNumber(int /*lineNumber*/) {}
    void updateBlock(const QTextBlock & /*block*/) {}
481
    void removedFromEditor() {}
con's avatar
con committed
482 483
};

484 485 486

///////////////////////////////////////////////////////////////////////
//
487
// CommonOptionsPage
488 489 490
//
///////////////////////////////////////////////////////////////////////

491
class CommonOptionsPage : public Core::IOptionsPage
492 493
{
public:
494
    CommonOptionsPage() {}
495 496

    // IOptionsPage
497
    QString id() const
hjk's avatar
hjk committed
498
        { return _(DEBUGGER_COMMON_SETTINGS_ID); }
499
    QString displayName() const
hjk's avatar
hjk committed
500
        { return QCoreApplication::translate("Debugger", DEBUGGER_COMMON_SETTINGS_NAME); }
501
    QString category() const
hjk's avatar
hjk committed
502
        { return _(DEBUGGER_SETTINGS_CATEGORY);  }
503
    QString displayCategory() const
hjk's avatar
hjk committed
504
        { return QCoreApplication::translate("Debugger", DEBUGGER_SETTINGS_TR_CATEGORY); }
505 506
    QIcon categoryIcon() const
        { return QIcon(QLatin1String(DEBUGGER_COMMON_SETTINGS_CATEGORY_ICON)); }
507 508

    QWidget *createPage(QWidget *parent);
509
    void apply() { m_group.apply(settings()); }
510
    void finish() { m_group.finish(); }
511
    virtual bool matches(const QString &s) const;
512 513

private:
514
    Ui::CommonOptionsPage m_ui;
515
    Utils::SavedActionSet m_group;
516
    QString m_searchKeywords;
517 518
};

519
QWidget *CommonOptionsPage::createPage(QWidget *parent)
520 521 522
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);
523
    m_group.clear();
524

525
    m_group.insert(theDebuggerAction(ListSourceFiles),
526
        m_ui.checkBoxListSourceFiles);
527
    m_group.insert(theDebuggerAction(UseAlternatingRowColors),
528
        m_ui.checkBoxUseAlternatingRowColors);
529
    m_group.insert(theDebuggerAction(UseToolTipsInMainEditor),
530
        m_ui.checkBoxUseToolTipsInMainEditor);
531 532 533 534
    m_group.insert(theDebuggerAction(CloseBuffersOnExit),
        m_ui.checkBoxCloseBuffersOnExit);
    m_group.insert(theDebuggerAction(SwitchModeOnExit),
        m_ui.checkBoxSwitchModeOnExit);
535
    m_group.insert(theDebuggerAction(AutoDerefPointers), 0);
536 537 538 539
    m_group.insert(theDebuggerAction(UseToolTipsInLocalsView), 0);
    m_group.insert(theDebuggerAction(UseToolTipsInBreakpointsView), 0);
    m_group.insert(theDebuggerAction(UseAddressInBreakpointsView), 0);
    m_group.insert(theDebuggerAction(UseAddressInStackView), 0);
540
    m_group.insert(theDebuggerAction(MaximalStackDepth),
541
        m_ui.spinBoxMaximalStackDepth);
542 543
    m_group.insert(theDebuggerAction(ShowStdNamespace), 0);
    m_group.insert(theDebuggerAction(ShowQtNamespace), 0);
544
    m_group.insert(theDebuggerAction(SortStructMembers), 0);
545
    m_group.insert(theDebuggerAction(LogTimeStamps), 0);
546
    m_group.insert(theDebuggerAction(VerboseLog), 0);
547 548
    m_group.insert(theDebuggerAction(BreakOnThrow), 0);
    m_group.insert(theDebuggerAction(BreakOnCatch), 0);
549 550 551 552 553 554 555
#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
556

557
    if (m_searchKeywords.isEmpty()) {
558 559
        QTextStream(&m_searchKeywords) << ' '
                << m_ui.checkBoxListSourceFiles->text()
560 561
                << ' ' << m_ui.checkBoxUseAlternatingRowColors->text()
                << ' ' << m_ui.checkBoxUseToolTipsInMainEditor->text()
562 563 564
#ifdef Q_OS_WIN
                << ' ' << m_ui.checkBoxRegisterForPostMortem->text()
#endif
565 566 567
                << ' ' << m_ui.labelMaximalStackDepth->text();
        m_searchKeywords.remove(QLatin1Char('&'));
    }
568 569 570
#ifndef Q_OS_WIN
    m_ui.checkBoxRegisterForPostMortem->setVisible(false);
#endif
571 572 573
    return w;
}

574 575 576 577 578
bool CommonOptionsPage::matches(const QString &s) const
{
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
}

hjk's avatar
hjk committed
579 580
///////////////////////////////////////////////////////////////////////
//
581
// DebuggingHelperOptionPage
hjk's avatar
hjk committed
582 583 584
//
///////////////////////////////////////////////////////////////////////

585 586 587
static inline bool oxygenStyle()
{
    if (const ManhattanStyle *ms = qobject_cast<const ManhattanStyle *>(qApp->style()))
588
        return !qstrcmp("OxygenStyle", ms->baseStyle()->metaObject()->className());
589 590 591
    return false;
}

592
class DebuggingHelperOptionPage : public Core::IOptionsPage
593 594
{   // Needs tr - context
    Q_OBJECT
hjk's avatar
hjk committed
595
public:
596
    DebuggingHelperOptionPage() {}
hjk's avatar
hjk committed
597 598

    // IOptionsPage
hjk's avatar
hjk committed
599
    QString id() const { return _("Z.DebuggingHelper"); }
600
    QString displayName() const { return tr("Debugging Helper"); }
hjk's avatar
hjk committed
601
    QString category() const { return _(DEBUGGER_SETTINGS_CATEGORY); }
602 603 604 605
    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
606 607

    QWidget *createPage(QWidget *parent);
608
    void apply() { m_group.apply(settings()); }
609
    void finish() { m_group.finish(); }
610
    virtual bool matches(const QString &s) const;
hjk's avatar
hjk committed
611 612

private:
613
    Ui::DebuggingHelperOptionPage m_ui;
614
    Utils::SavedActionSet m_group;
615
    QString m_searchKeywords;
hjk's avatar
hjk committed
616 617
};

618
QWidget *DebuggingHelperOptionPage::createPage(QWidget *parent)
hjk's avatar
hjk committed
619 620 621 622
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);

623
    m_ui.dumperLocationChooser->setExpectedKind(Utils::PathChooser::Command);
624
    m_ui.dumperLocationChooser->setPromptDialogTitle(tr("Choose DebuggingHelper Location"));
hjk's avatar
hjk committed
625 626
    m_ui.dumperLocationChooser->setInitialBrowsePathBackup(
        Core::ICore::instance()->resourcePath() + "../../lib");
hjk's avatar
hjk committed
627

628
    m_group.clear();
629
    m_group.insert(theDebuggerAction(UseDebuggingHelpers),
630
        m_ui.debuggingHelperGroupBox);
631
    m_group.insert(theDebuggerAction(UseCustomDebuggingHelperLocation),
632
        m_ui.customLocationGroupBox);
hjk's avatar
hjk committed
633
    // Suppress Oxygen style's giving flat group boxes bold titles.
634
    if (oxygenStyle())
hjk's avatar
hjk committed
635
        m_ui.customLocationGroupBox->setStyleSheet(_("QGroupBox::title { font: ; }"));
636

637
    m_group.insert(theDebuggerAction(CustomDebuggingHelperLocation),
638
        m_ui.dumperLocationChooser);
hjk's avatar
hjk committed
639

640 641 642
    m_group.insert(theDebuggerAction(UseCodeModel),
        m_ui.checkBoxUseCodeModel);

643
#ifdef QT_DEBUG
644 645
    m_group.insert(theDebuggerAction(DebugDebuggingHelpers),
        m_ui.checkBoxDebugDebuggingHelpers);
646 647 648
#else
    m_ui.checkBoxDebugDebuggingHelpers->hide();
#endif
hjk's avatar
hjk committed
649 650 651 652

#ifndef QT_DEBUG
#if 0
    cmd = am->registerAction(m_manager->m_dumpLogAction,
hjk's avatar
hjk committed
653
        DUMP_LOG, globalcontext);
hjk's avatar
hjk committed
654 655 656 657 658 659
    //cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+D,Ctrl+L")));
    cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+Shift+F11")));
    mdebug->addAction(cmd);
#endif
#endif

660 661 662 663 664 665
    if (m_searchKeywords.isEmpty()) {
        QTextStream(&m_searchKeywords)
                << ' ' << m_ui.debuggingHelperGroupBox->title()
                << ' ' << m_ui.customLocationGroupBox->title()
                << ' ' << m_ui.dumperLocationLabel->text()
                << ' ' << m_ui.checkBoxUseCodeModel->text()
666
                << ' ' << m_ui.checkBoxDebugDebuggingHelpers->text();
667 668
        m_searchKeywords.remove(QLatin1Char('&'));
    }
hjk's avatar
hjk committed
669 670 671
    return w;
}

672
bool DebuggingHelperOptionPage::matches(const QString &s) const
hjk's avatar
hjk committed
673
{
674
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
hjk's avatar
hjk committed
675 676
}

677

con's avatar
con committed
678 679
///////////////////////////////////////////////////////////////////////
//
680
// Argument parsing
con's avatar
con committed
681 682 683
//
///////////////////////////////////////////////////////////////////////

684
static QString msgParameterMissing(const QString &a)
685 686 687 688
{
    return DebuggerPlugin::tr("Option '%1' is missing the parameter.").arg(a);
}

689
static QString msgInvalidNumericParameter(const QString &a, const QString &number)
690 691 692 693
{
    return DebuggerPlugin::tr("The parameter '%1' of option '%2' is not a number.").arg(number, a);
}

694
static bool parseArgument(QStringList::const_iterator &it,
695 696 697
    const QStringList::const_iterator &cend,
    AttachRemoteParameters *attachRemoteParameters,
    unsigned *enabledEngines, QString *errorMessage)
698 699 700
{
    const QString &option = *it;
    // '-debug <pid>'
701 702
    // '-debug <corefile>'
    // '-debug <server:port>'
hjk's avatar
hjk committed
703
    if (*it == _("-debug")) {
704 705 706 707 708 709
        ++it;
        if (it == cend) {
            *errorMessage = msgParameterMissing(*it);
            return false;
        }
        bool ok;
710
        attachRemoteParameters->attachPid = it->toULongLong(&ok);
711 712
        if (!ok)
            attachRemoteParameters->attachTarget = *it;
713 714
        return true;
    }
715 716
    // -wincrashevent <event-handle>. A handle used for
    // a handshake when attaching to a crashed Windows process.
hjk's avatar
hjk committed
717
    if (*it == _("-wincrashevent")) {
718 719 720 721 722 723
        ++it;
        if (it == cend) {
            *errorMessage = msgParameterMissing(*it);
            return false;
        }
        bool ok;
724
        attachRemoteParameters->winCrashEvent = it->toULongLong(&ok);
725 726 727 728 729 730
        if (!ok) {
            *errorMessage = msgInvalidNumericParameter(option, *it);
            return false;
        }
        return true;
    }
hjk's avatar
hjk committed
731
    // Engine disabling.
hjk's avatar
hjk committed
732
    if (option == _("-disable-cdb")) {
733
        *enabledEngines &= ~Debugger::CdbEngineType;
734 735
        return true;
    }
hjk's avatar
hjk committed
736
    if (option == _("-disable-gdb")) {
737
        *enabledEngines &= ~Debugger::GdbEngineType;
738 739
        return true;
    }
740 741 742 743
    if (option == _("-disable-qmldb")) {
        *enabledEngines &= ~Debugger::QmlEngineType;
        return true;
    }
hjk's avatar
hjk committed
744
    if (option == _("-disable-sdb")) {
745
        *enabledEngines &= ~Debugger::ScriptEngineType;
746 747
        return true;
    }
748
    if (option == _("-disable-tcf")) {
hjk's avatar
hjk committed
749 750 751
        *enabledEngines &= ~TcfEngineType;
        return true;
    }
752

753
    *errorMessage = DebuggerPlugin::tr("Invalid debugger option: %1").arg(option);
754 755 756
    return false;
}

757
static bool parseArguments(const QStringList &args,
758
   AttachRemoteParameters *attachRemoteParameters,
hjk's avatar
hjk committed
759
   unsigned *enabledEngines, QString *errorMessage)
760
{
761
    attachRemoteParameters->clear();
762 763
    const QStringList::const_iterator cend = args.constEnd();
    for (QStringList::const_iterator it = args.constBegin(); it != cend; ++it)
764
        if (!parseArgument(it, cend, attachRemoteParameters, enabledEngines, errorMessage))
765 766
            return false;
    if (Debugger::Constants::Internal::debug)
767
        qDebug().nospace() << args << "engines=0x"
768 769
            << QString::number(*enabledEngines, 16)
            << " pid" << attachRemoteParameters->attachPid
770
            << " target" << attachRemoteParameters->attachTarget << '\n';
771 772 773
    return true;
}

774 775 776 777 778 779 780 781

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

static bool isDebuggable(Core::IEditor *editor)
782
{
783 784 785 786 787 788 789 790
    // 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;
791 792
}

793
static TextEditor::ITextEditor *currentTextEditor()
con's avatar
con committed
794
{
795 796 797 798 799 800
    EditorManager *editorManager = EditorManager::instance();
    if (!editorManager)
        return 0;
    Core::IEditor *editor = editorManager->currentEditor();
    return qobject_cast<ITextEditor*>(editor);
}
con's avatar
con committed
801

802 803 804 805 806
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
807

808 809 810
struct DebuggerActions
{
    QAction *continueAction;
811 812 813
    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
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
    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
833

834
} // namespace Internal
con's avatar
con committed
835

836
using namespace Debugger::Internal;
con's avatar
con committed
837

838 839 840 841 842
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
843

844 845 846
class DebuggerPluginPrivate : public QObject
{
    Q_OBJECT
847

848 849
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
850

851 852
    bool initialize(const QStringList &arguments, QString *errorMessage);
    void notifyCurrentEngine(int role, const QVariant &value = QVariant());
853
    void connectEngine(DebuggerEngine *engine, bool notify = true);
854
    void disconnectEngine() { connectEngine(m_sessionEngine); }
855

856 857 858
public slots:
    void updateWatchersHeader(int section, int, int newSize)
        { m_watchersWindow->header()->resizeSection(section, newSize); }
859

860
    void sourceFilesDockToggled(bool on)
hjk's avatar
hjk committed
861
        { if (on) notifyCurrentEngine(RequestReloadSourceFilesRole); }
862
    void modulesDockToggled(bool on)
hjk's avatar
hjk committed
863 864 865
        { if (on) notifyCurrentEngine(RequestReloadModulesRole); }
    void registerDockToggled(bool on)
        { if (on) notifyCurrentEngine(RequestReloadRegistersRole); }
866

867
    void onAction();
868
    void setSimpleDockWidgetArrangement(const Debugger::DebuggerLanguages &activeLanguages);
869

870 871 872 873 874 875 876
    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);
877

878 879 880 881 882 883
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
    void toggleBreakpoint(const QString &fileName, int lineNumber);
    void onModeChanged(Core::IMode *mode);
    void showSettingsDialog();
884

885 886 887 888 889
    void startExternalApplication();
    void startRemoteApplication();
    void attachExternalApplication();
    void attachExternalApplication
        (qint64 pid, const QString &binary, const QString &crashParameter);
890
    bool attachCmdLine();
891 892
    void attachCore();
    void attachCore(const QString &core, const QString &exeFileName);
893
    void attachRemote(const QString &spec);
894
    void attachRemoteTcf();
895

896
    void enableReverseDebuggingTriggered(const QVariant &value);
897
    void languagesChanged(const Debugger::DebuggerLanguages &languages);
898
    void showStatusMessage(const QString &msg, int timeout = -1);
899
    void openMemoryEditor();
900 901 902 903 904

    DebuggerMainWindow *mainWindow()
        { return qobject_cast<DebuggerMainWindow*>
            (DebuggerUISwitcher::instance()->mainWindow()); }

905 906
    inline void setConfigValue(const QString &name, const QVariant &value);
    inline QVariant configValue(const QString &name) const;
907

ck's avatar
ck committed
908
    DebuggerRunControl *createDebugger(const DebuggerStartParameters &sp,
hjk's avatar
hjk committed
909 910
        RunConfiguration *rc = 0);
    void startDebugger(RunControl *runControl);
911
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
912 913 914

    void dumpLog();
    void cleanupViews();
915
    void setInitialState();
916 917 918 919 920

    void fontSettingsChanged(const TextEditor::FontSettings &settings);
    DebuggerState state() const { return m_state; }

    void updateState(DebuggerEngine *engine);
921
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
922 923 924 925 926 927 928 929

    void gotoLocation(const QString &file, int line, bool setMarker);

    void clearStatusMessage();

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
930 931

    void executeDebuggerCommand();
hjk's avatar
hjk committed
932
    void scriptExpressionEntered(const QString &expression);
933
    void coreShutdown();
934

935 936 937