debuggerplugin.cpp 113 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
44
#include "breakpoint.h"
#include "breakhandler.h"
45
#include "breakwindow.h"
46
#include "consolewindow.h"
47
#include "logwindow.h"
48
49
50
#include "moduleswindow.h"
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
51
#include "stackhandler.h"
52
53
54
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
55
#include "watchhandler.h"
56
#include "watchwindow.h"
hjk's avatar
hjk committed
57
#include "watchutils.h"
58

59
60
#include "snapshothandler.h"
#include "threadshandler.h"
con's avatar
con committed
61

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

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

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

85
86
#include <extensionsystem/pluginmanager.h>

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

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

#include <utils/qtcassert.h>
100
#include <utils/savedaction.h>
101
#include <utils/styledbar.h>
con's avatar
con committed
102

103
104
#include <qml/scriptconsole.h>

105
#include <QtCore/QTimer>
106
107
#include <QtCore/QtPlugin>
#include <QtGui/QComboBox>
108
#include <QtGui/QDockWidget>
109
#include <QtGui/QFileDialog>
hjk's avatar
hjk committed
110
#include <QtGui/QMenu>
111
#include <QtGui/QMessageBox>
112
#include <QtGui/QToolButton>
con's avatar
con committed
113

114
115
#include <climits>

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


245
246
247
/* 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
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
275
276
277
278
279
280
281
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
282
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
283
284
285


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




319

con's avatar
con committed
320
using namespace Core;
hjk's avatar
hjk committed
321
322
using namespace Debugger::Constants;
using namespace Debugger::Internal;
con's avatar
con committed
323
using namespace ProjectExplorer;
hjk's avatar
hjk committed
324
using namespace TextEditor;
con's avatar
con committed
325

hjk's avatar
hjk committed
326
327
328
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
329
330
331
332

namespace Debugger {
namespace Constants {

333
334
const char * const M_DEBUG_START_DEBUGGING = "QtCreator.Menu.Debug.StartDebugging";

con's avatar
con committed
335
336
const char * const STARTEXTERNAL        = "Debugger.StartExternal";
const char * const ATTACHEXTERNAL       = "Debugger.AttachExternal";
337
const char * const ATTACHCORE           = "Debugger.AttachCore";
hjk's avatar
hjk committed
338
const char * const ATTACHTCF            = "Debugger.AttachTcf";
339
const char * const ATTACHREMOTE         = "Debugger.AttachRemote";
340
const char * const DETACH               = "Debugger.Detach";
con's avatar
con committed
341

342
343
const char * const RUN_TO_LINE1         = "Debugger.RunToLine1";
const char * const RUN_TO_LINE2         = "Debugger.RunToLine2";
con's avatar
con committed
344
const char * const RUN_TO_FUNCTION      = "Debugger.RunToFunction";
345
346
const char * const JUMP_TO_LINE1        = "Debugger.JumpToLine1";
const char * const JUMP_TO_LINE2        = "Debugger.JumpToLine2";
347
const char * const RETURN_FROM_FUNCTION = "Debugger.ReturnFromFunction";
348
const char * const SNAPSHOT             = "Debugger.Snapshot";
con's avatar
con committed
349
350
351
const char * const TOGGLE_BREAK         = "Debugger.ToggleBreak";
const char * const BREAK_BY_FUNCTION    = "Debugger.BreakByFunction";
const char * const BREAK_AT_MAIN        = "Debugger.BreakAtMain";
352
353
const char * const ADD_TO_WATCH1        = "Debugger.AddToWatch1";
const char * const ADD_TO_WATCH2        = "Debugger.AddToWatch2";
354
const char * const OPERATE_BY_INSTRUCTION  = "Debugger.OperateByInstruction";
355
356
const char * const FRAME_UP             = "Debugger.FrameUp";
const char * const FRAME_DOWN           = "Debugger.FrameDown";
con's avatar
con committed
357

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

} // namespace Constants
} // namespace Debugger


394

hjk's avatar
hjk committed
395
static SessionManager *sessionManager()
396
{
hjk's avatar
hjk committed
397
    return ProjectExplorerPlugin::instance()->session();
398
399
}

400
401
402
403
404
static QSettings *settings()
{
    return ICore::instance()->settings();
}

405
406
407
408
409
410
411
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
// Retrieve file name and line and optionally address
// from the data set on the text editor context menu action.
static bool positionFromContextActionData(const QObject *sender,
                                          QString *fileName,
                                          int *lineNumber,
                                          quint64 *address = 0)
{
    if (const QAction *action = qobject_cast<const QAction *>(sender)) {
        const QVariantList data = action->data().toList();
        if (data.size() >= (address ? 3 : 2)) {
            *fileName = data.front().toString();
            *lineNumber = data.at(1).toInt();
            if (address)
                *address = data.at(2).toULongLong();
            return true;
        }
    }
    return false;
}

432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
namespace Debugger {
namespace Internal {

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

void addGdbOptionPages(QList<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) {}
452
    void clear();
453
454

    quint64 attachPid;
455
    QString attachTarget;  // core file name or  server:port
456
    // Event handle for attaching to crashed Windows processes.
457
458
459
    quint64 winCrashEvent;
};

460
461
462
463
464
void AttachRemoteParameters::clear()
{
    attachPid = winCrashEvent = 0;
    attachTarget.clear();
}
465

466
467
468
469
470
471
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

hjk's avatar
hjk committed
472
473
474
class DebugMode : public Core::BaseMode
{
public:
475
476
    DebugMode(QObject *parent = 0) : BaseMode(parent)
    {
477
        setDisplayName(QCoreApplication::translate("Debugger::Internal::DebugMode", "Debug"));
478
        setType(Core::Constants::MODE_EDIT_TYPE);
479
        setId(MODE_DEBUG);
480
        setIcon(QIcon(__(":/fancyactionbar/images/mode_Debug.png")));
481
482
        setPriority(P_MODE_DEBUG);
    }
hjk's avatar
hjk committed
483

484
485
486
487
488
489
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        EditorManager::instance()->setParent(0);
    }
};
hjk's avatar
hjk committed
490

491

con's avatar
con committed
492
493
494
495
496
497
///////////////////////////////////////////////////////////////////////
//
// LocationMark
//
///////////////////////////////////////////////////////////////////////

498
// Used in "real" editors
499
class LocationMark : public TextEditor::BaseTextMark
con's avatar
con committed
500
501
502
503
{
public:
    LocationMark(const QString &fileName, int linenumber)
        : BaseTextMark(fileName, linenumber)
504
    {}
con's avatar
con committed
505

506
    QIcon icon() const { return DebuggerPlugin::instance()->locationMarkIcon(); }
con's avatar
con committed
507
508
    void updateLineNumber(int /*lineNumber*/) {}
    void updateBlock(const QTextBlock & /*block*/) {}
509
    void removedFromEditor() {}
con's avatar
con committed
510
511
};

512
513
514

///////////////////////////////////////////////////////////////////////
//
515
// CommonOptionsPage
516
517
518
//
///////////////////////////////////////////////////////////////////////

519
class CommonOptionsPage : public Core::IOptionsPage
520
521
{
public:
522
    CommonOptionsPage() {}
523
524

    // IOptionsPage
525
    QString id() const
hjk's avatar
hjk committed
526
        { return _(DEBUGGER_COMMON_SETTINGS_ID); }
527
    QString displayName() const
hjk's avatar
hjk committed
528
        { return QCoreApplication::translate("Debugger", DEBUGGER_COMMON_SETTINGS_NAME); }
529
    QString category() const
hjk's avatar
hjk committed
530
        { return _(DEBUGGER_SETTINGS_CATEGORY);  }
531
    QString displayCategory() const
hjk's avatar
hjk committed
532
        { return QCoreApplication::translate("Debugger", DEBUGGER_SETTINGS_TR_CATEGORY); }
533
534
    QIcon categoryIcon() const
        { return QIcon(QLatin1String(DEBUGGER_COMMON_SETTINGS_CATEGORY_ICON)); }
535
536

    QWidget *createPage(QWidget *parent);
537
    void apply() { m_group.apply(settings()); }
538
    void finish() { m_group.finish(); }
539
    virtual bool matches(const QString &s) const;
540
541

private:
542
    Ui::CommonOptionsPage m_ui;
543
    Utils::SavedActionSet m_group;
544
    QString m_searchKeywords;
545
546
};

547
QWidget *CommonOptionsPage::createPage(QWidget *parent)
548
549
550
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);
551
    m_group.clear();
552

553
    m_group.insert(theDebuggerAction(ListSourceFiles),
554
        m_ui.checkBoxListSourceFiles);
555
    m_group.insert(theDebuggerAction(UseAlternatingRowColors),
556
        m_ui.checkBoxUseAlternatingRowColors);
557
    m_group.insert(theDebuggerAction(UseToolTipsInMainEditor),
558
        m_ui.checkBoxUseToolTipsInMainEditor);
559
560
561
562
    m_group.insert(theDebuggerAction(CloseBuffersOnExit),
        m_ui.checkBoxCloseBuffersOnExit);
    m_group.insert(theDebuggerAction(SwitchModeOnExit),
        m_ui.checkBoxSwitchModeOnExit);
563
    m_group.insert(theDebuggerAction(AutoDerefPointers), 0);
564
565
566
567
    m_group.insert(theDebuggerAction(UseToolTipsInLocalsView), 0);
    m_group.insert(theDebuggerAction(UseToolTipsInBreakpointsView), 0);
    m_group.insert(theDebuggerAction(UseAddressInBreakpointsView), 0);
    m_group.insert(theDebuggerAction(UseAddressInStackView), 0);
568
    m_group.insert(theDebuggerAction(MaximalStackDepth),
569
        m_ui.spinBoxMaximalStackDepth);
570
571
    m_group.insert(theDebuggerAction(ShowStdNamespace), 0);
    m_group.insert(theDebuggerAction(ShowQtNamespace), 0);
572
    m_group.insert(theDebuggerAction(SortStructMembers), 0);
573
    m_group.insert(theDebuggerAction(LogTimeStamps), 0);
574
    m_group.insert(theDebuggerAction(VerboseLog), 0);
575
576
    m_group.insert(theDebuggerAction(BreakOnThrow), 0);
    m_group.insert(theDebuggerAction(BreakOnCatch), 0);
577
578
579
580
581
582
583
#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
584

585
    if (m_searchKeywords.isEmpty()) {
586
587
        QTextStream(&m_searchKeywords) << ' '
                << m_ui.checkBoxListSourceFiles->text()
588
589
                << ' ' << m_ui.checkBoxUseAlternatingRowColors->text()
                << ' ' << m_ui.checkBoxUseToolTipsInMainEditor->text()
590
591
592
#ifdef Q_OS_WIN
                << ' ' << m_ui.checkBoxRegisterForPostMortem->text()
#endif
593
594
595
                << ' ' << m_ui.labelMaximalStackDepth->text();
        m_searchKeywords.remove(QLatin1Char('&'));
    }
596
597
598
#ifndef Q_OS_WIN
    m_ui.checkBoxRegisterForPostMortem->setVisible(false);
#endif
599
600
601
    return w;
}

602
603
604
605
606
bool CommonOptionsPage::matches(const QString &s) const
{
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
}

hjk's avatar
hjk committed
607
608
///////////////////////////////////////////////////////////////////////
//
609
// DebuggingHelperOptionPage
hjk's avatar
hjk committed
610
611
612
//
///////////////////////////////////////////////////////////////////////

613
614
615
static inline bool oxygenStyle()
{
    if (const ManhattanStyle *ms = qobject_cast<const ManhattanStyle *>(qApp->style()))
616
        return !qstrcmp("OxygenStyle", ms->baseStyle()->metaObject()->className());
617
618
619
    return false;
}

620
class DebuggingHelperOptionPage : public Core::IOptionsPage
621
622
{   // Needs tr - context
    Q_OBJECT
hjk's avatar
hjk committed
623
public:
624
    DebuggingHelperOptionPage() {}
hjk's avatar
hjk committed
625
626

    // IOptionsPage
hjk's avatar
hjk committed
627
    QString id() const { return _("Z.DebuggingHelper"); }
628
    QString displayName() const { return tr("Debugging Helper"); }
hjk's avatar
hjk committed
629
    QString category() const { return _(DEBUGGER_SETTINGS_CATEGORY); }
630
631
632
633
    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
634
635

    QWidget *createPage(QWidget *parent);
636
    void apply() { m_group.apply(settings()); }
637
    void finish() { m_group.finish(); }
638
    virtual bool matches(const QString &s) const;
hjk's avatar
hjk committed
639
640

private:
641
    Ui::DebuggingHelperOptionPage m_ui;
642
    Utils::SavedActionSet m_group;
643
    QString m_searchKeywords;
hjk's avatar
hjk committed
644
645
};

646
QWidget *DebuggingHelperOptionPage::createPage(QWidget *parent)
hjk's avatar
hjk committed
647
648
649
650
{
    QWidget *w = new QWidget(parent);
    m_ui.setupUi(w);

651
    m_ui.dumperLocationChooser->setExpectedKind(Utils::PathChooser::Command);
652
    m_ui.dumperLocationChooser->setPromptDialogTitle(tr("Choose DebuggingHelper Location"));
hjk's avatar
hjk committed
653
654
    m_ui.dumperLocationChooser->setInitialBrowsePathBackup(
        Core::ICore::instance()->resourcePath() + "../../lib");
hjk's avatar
hjk committed
655

656
    m_group.clear();
657
    m_group.insert(theDebuggerAction(UseDebuggingHelpers),
658
        m_ui.debuggingHelperGroupBox);
659
    m_group.insert(theDebuggerAction(UseCustomDebuggingHelperLocation),
660
        m_ui.customLocationGroupBox);
hjk's avatar
hjk committed
661
    // Suppress Oxygen style's giving flat group boxes bold titles.
662
    if (oxygenStyle())
hjk's avatar
hjk committed
663
        m_ui.customLocationGroupBox->setStyleSheet(_("QGroupBox::title { font: ; }"));
664

665
    m_group.insert(theDebuggerAction(CustomDebuggingHelperLocation),
666
        m_ui.dumperLocationChooser);
hjk's avatar
hjk committed
667

668
669
670
    m_group.insert(theDebuggerAction(UseCodeModel),
        m_ui.checkBoxUseCodeModel);

671
#ifdef QT_DEBUG
672
673
    m_group.insert(theDebuggerAction(DebugDebuggingHelpers),
        m_ui.checkBoxDebugDebuggingHelpers);
674
675
676
#else
    m_ui.checkBoxDebugDebuggingHelpers->hide();
#endif
hjk's avatar
hjk committed
677
678
679
680

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

688
689
690
691
692
693
    if (m_searchKeywords.isEmpty()) {
        QTextStream(&m_searchKeywords)
                << ' ' << m_ui.debuggingHelperGroupBox->title()
                << ' ' << m_ui.customLocationGroupBox->title()
                << ' ' << m_ui.dumperLocationLabel->text()
                << ' ' << m_ui.checkBoxUseCodeModel->text()
694
                << ' ' << m_ui.checkBoxDebugDebuggingHelpers->text();
695
696
        m_searchKeywords.remove(QLatin1Char('&'));
    }
hjk's avatar
hjk committed
697
698
699
    return w;
}

700
bool DebuggingHelperOptionPage::matches(const QString &s) const
hjk's avatar
hjk committed
701
{
702
    return m_searchKeywords.contains(s, Qt::CaseInsensitive);
hjk's avatar
hjk committed
703
704
}

705

con's avatar
con committed
706
707
///////////////////////////////////////////////////////////////////////
//
708
// Argument parsing
con's avatar
con committed
709
710
711
//
///////////////////////////////////////////////////////////////////////

712
static QString msgParameterMissing(const QString &a)
713
714
715
716
{
    return DebuggerPlugin::tr("Option '%1' is missing the parameter.").arg(a);
}

717
static QString msgInvalidNumericParameter(const QString &a, const QString &number)
718
719
720
721
{
    return DebuggerPlugin::tr("The parameter '%1' of option '%2' is not a number.").arg(number, a);
}

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

781
    *errorMessage = DebuggerPlugin::tr("Invalid debugger option: %1").arg(option);
782
783
784
    return false;
}

785
static bool parseArguments(const QStringList &args,
786
   AttachRemoteParameters *attachRemoteParameters,
hjk's avatar
hjk committed
787
   unsigned *enabledEngines, QString *errorMessage)
788
{
789
    attachRemoteParameters->clear();
790
791
    const QStringList::const_iterator cend = args.constEnd();
    for (QStringList::const_iterator it = args.constBegin(); it != cend; ++it)
792
        if (!parseArgument(it, cend, attachRemoteParameters, enabledEngines, errorMessage))
793
794
            return false;
    if (Debugger::Constants::Internal::debug)
795
        qDebug().nospace() << args << "engines=0x"
796
797
            << QString::number(*enabledEngines, 16)
            << " pid" << attachRemoteParameters->attachPid
798
            << " target" << attachRemoteParameters->attachTarget << '\n';
799
800
801
    return true;
}

802
803
804
805
806
807
808
809

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

static bool isDebuggable(Core::IEditor *editor)
810
{
811
812
813
814
815
816
817
818
    // 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;
819
820
}

con's avatar
con committed
821

822
823
824
825
826
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
827

828
829
830
struct DebuggerActions
{
    QAction *continueAction;
831
832
833
    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
834
835
836
    QAction *resetAction; // FIXME: Should not be needed in a stable release
    QAction *stepAction;
    QAction *stepOutAction;
837
    QAction *runToLineAction; // Debug menu
838
    QAction *runToFunctionAction;
839
    QAction *jumpToLineAction; // in the Debug menu
840
841
    QAction *returnFromFunctionAction;
    QAction *nextAction;
842
    //QAction *snapshotAction;
843
844
845
846
847
848
849
850
    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
851

852
} // namespace Internal
con's avatar
con committed
853

854
using namespace Debugger::Internal;
con's avatar
con committed
855

856
857
858
859
860
///////////////////////////////////////////////////////////////////////
//
// DebuggerPluginPrivate
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
861

862
863
864
class DebuggerPluginPrivate : public QObject
{
    Q_OBJECT
865

866
867
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
868

869
    bool initialize(const QStringList &arguments, QString *errorMessage);
870
    void connectEngine(DebuggerEngine *engine, bool notify = true);
hjk's avatar
hjk committed
871
    void disconnectEngine() { connectEngine(0); }
872
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
873

874
public slots:
875
876
877
878
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896

    void breakpointSetRemoveMarginActionTriggered()
    {
        QString fileName;
        int lineNumber;
        quint64 address;
        if (positionFromContextActionData(sender(), &fileName, &lineNumber, &address))
            m_breakHandler->toggleBreakpoint(fileName, lineNumber, address);
     }

    void breakpointEnableDisableMarginActionTriggered()
    {
        QString fileName;
        int lineNumber;
        if (positionFromContextActionData(sender(), &fileName, &lineNumber))
            m_breakHandler->toggleBreakpointEnabled(fileName, lineNumber);
    }

897
    void updateWatchersHeader(int section, int, int newSize)
898
899
900
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
    }
901

902
    void sourceFilesDockToggled(bool on)
903
904
905
906
907
    {
        if (on)
            m_currentEngine->reloadSourceFiles();
    }

908
    void modulesDockToggled(bool on)
909
910
911
912
    {
        if (on)
            m_currentEngine->reloadModules();
    }
913

hjk's avatar
hjk committed
914
    void registerDockToggled(bool on)
915
    {
916
        if (on)
917
918
            m_currentEngine->reloadRegisters();
    }
919

920
921
922
923
924
925
926
927
928
929
    void synchronizeBreakpoints()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
            if (DebuggerRunControl *runControl = m_snapshotHandler->at(i)) {
                DebuggerEngine *engine = runControl->engine();
                engine->attemptBreakpointSynchronization();
            }
        }
    }

hjk's avatar
hjk committed
930
931
932
933
934
935
936
937
938
939
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
            if (DebuggerRunControl *runControl = m_snapshotHandler->at(i)) {
                DebuggerEngine *engine = runControl->engine();
                engine->watchHandler()->synchronizeWatchers();
            }
        }
    }

940
    void setSimpleDockWidgetArrangement(Debugger::DebuggerLanguages activeLanguages);
941

942
943
944
945
946
947
948
    void editorOpened(Core::IEditor *editor);
    void editorAboutToClose(Core::IEditor *editor);
    void setBusyCursor(bool busy);
    void requestMark(<