debuggerplugin.cpp 120 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2
3
4
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.nokia.com)
con's avatar
con committed
8
**
9
**
10
** GNU Lesser General Public License Usage
11
**
hjk's avatar
hjk committed
12
13
14
15
16
17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21
22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23
24
25
26
27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
Tobias Hunger's avatar
Tobias Hunger committed
29
** Nokia at info@qt.nokia.com.
con's avatar
con committed
30
**
31
**************************************************************************/
hjk's avatar
hjk committed
32

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

Friedemann Kleint's avatar
Friedemann Kleint committed
35
#include "debuggerstartparameters.h"
36
#include "debuggeractions.h"
con's avatar
con committed
37
#include "debuggerconstants.h"
38
#include "debuggerinternalconstants.h"
39
#include "debuggercore.h"
40
41
#include "debuggerdialogs.h"
#include "debuggerengine.h"
42
#include "debuggermainwindow.h"
con's avatar
con committed
43
#include "debuggerrunner.h"
44
#include "debuggerruncontrolfactory.h"
45
#include "debuggerstringutils.h"
46
#include "memoryagent.h"
47
48
#include "breakpoint.h"
#include "breakhandler.h"
49
#include "breakwindow.h"
50
#include "consolewindow.h"
51
#include "disassemblerlines.h"
52
#include "logwindow.h"
53
#include "moduleswindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
54
#include "moduleshandler.h"
55
56
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
57
#include "stackhandler.h"
58
59
60
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
61
#include "watchhandler.h"
62
#include "watchwindow.h"
hjk's avatar
hjk committed
63
#include "watchutils.h"
64
#include "debuggertooltipmanager.h"
65

66
67
#include "snapshothandler.h"
#include "threadshandler.h"
68
#include "commonoptionspage.h"
con's avatar
con committed
69

70
#include <coreplugin/actionmanager/actionmanager.h>
71
72
#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/command.h>
73
#include <coreplugin/uniqueidmanager.h>
74
#include <coreplugin/imode.h>
con's avatar
con committed
75
#include <coreplugin/coreconstants.h>
76
#include <coreplugin/dialogs/ioptionspage.h>
con's avatar
con committed
77
#include <coreplugin/editormanager/editormanager.h>
hjk's avatar
hjk committed
78
#include <coreplugin/findplaceholder.h>
79
#include <coreplugin/icontext.h>
con's avatar
con committed
80
#include <coreplugin/icore.h>
81
#include <coreplugin/imode.h>
82
#include <coreplugin/icorelistener.h>
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

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

89
90
#include <extensionsystem/pluginmanager.h>

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

99
#include <qtsupport/qtsupportconstants.h>
100

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

#include <utils/qtcassert.h>
106
#include <utils/savedaction.h>
107
#include <utils/styledbar.h>
108
#include <utils/proxyaction.h>
109
#include <utils/statuslabel.h>
110
#include <utils/fileutils.h>
con's avatar
con committed
111

112
113
#include <qml/scriptconsole.h>

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

128
129
#include <climits>

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

140
141
142
143
144
145
146
147
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
148
    \internal
149
150
151
152
153
154
155
156
*/

/*!
    \class Debugger::DebuggerEngine

    \brief Base class of a debugger engine.

    Note: the Debugger process itself and any helper processes like
Pawel Polanski's avatar
Pawel Polanski committed
157
    gdbserver, the CODA client etc are referred to as 'Engine',
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
    whereas the debugged process is referred to as 'Inferior'.

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

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

    The engines are responsible for local roll-back to the last
    acknowledged state before calling notify*Failed. I.e. before calling
    notifyEngineSetupFailed() any process started during setupEngine()
    so far must be terminated.
    \code

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

\endcode */
hjk's avatar
hjk committed
275

276
277
278
/* Here is a matching graph as a GraphViz graph. View it using
 * \code
grep "^sg1:" debuggerplugin.cpp | cut -c5- | dot -osg1.ps -Tps && gv sg1.ps
279

280
281
282
283
284
285
sg1: digraph DebuggerStates {
sg1:   DebuggerNotReady -> EngineSetupRequested
sg1:   EngineSetupRequested -> EngineSetupOk [ label="notifyEngineSetupOk", style="dashed" ];
sg1:   EngineSetupRequested -> EngineSetupFailed [ label= "notifyEngineSetupFailed", style="dashed"];
sg1:   EngineSetupFailed -> DebuggerFinished [ label= "RunControl::StartFailed" ];
sg1:   EngineSetupOk -> InferiorSetupRequested [ label= "RunControl::StartSuccessful" ];
286
sg1:   InferiorSetupRequested -> InferiorSetupOk [ label="notifyInferiorSetupOk", style="dashed" ];
287
sg1:   InferiorSetupRequested -> InferiorSetupFailed [ label="notifyInferiorFailed", style="dashed" ];
288
sg1:   InferiorSetupOk -> EngineRunRequested
289
290
291
292
293
294
295
296
297
298
299
300
301
302
sg1:   InferiorSetupFailed -> EngineShutdownRequested
sg1:   EngineRunRequested -> InferiorUnrunnable [ label="notifyInferiorUnrunnable", style="dashed" ];
sg1:   EngineRunRequested -> InferiorStopOk [ label="notifyEngineRunAndInferiorStopOk", style="dashed" ];
sg1:   EngineRunRequested -> InferiorRunOk [ label="notifyEngineRunAndInferiorRunOk", style="dashed" ];
sg1:   EngineRunRequested -> EngineRunFailed [ label="notifyEngineRunFailed", style="dashed" ];
sg1:   EngineRunFailed -> EngineShutdownRequested
sg1:   InferiorRunOk -> InferiorStopOk [ label="SpontaneousStop\nnotifyInferiorSpontaneousStop", style="dashed" ];
sg1:   InferiorRunOk -> InferiorStopRequested [ label="User stop\nEngine::interruptInferior", style="dashed"];
sg1:   InferiorStopRequested -> InferiorStopOk [ label="notifyInferiorStopOk", style="dashed" ];
sg1:   InferiorStopRequested -> InferiorShutdownRequested  [ label="notifyInferiorStopFailed", style="dashed" ];
sg1:   InferiorStopOk -> InferiorRunRequested [ label="User\nEngine::continueInferior" ];
sg1:   InferiorRunRequested -> InferiorRunOk [ label="notifyInferiorRunOk", style="dashed"];
sg1:   InferiorRunRequested -> InferiorRunFailed [ label="notifyInferiorRunFailed", style="dashed"];
sg1:   InferiorRunFailed -> InferiorStopOk
303
304
sg1:   InferiorStopOk -> InferiorShutdownRequested [ label="Close event" ];
sg1:   InferiorUnrunnable -> InferiorShutdownRequested [ label="Close event" ];
305
306
sg1:   InferiorShutdownRequested -> InferiorShutdownOk [ label= "Engine::shutdownInferior\nnotifyInferiorShutdownOk", style="dashed" ];
sg1:   InferiorShutdownRequested -> InferiorShutdownFailed [ label="Engine::shutdownInferior\nnotifyInferiorShutdownFailed", style="dashed" ];
307
308
sg1:   InferiorExited -> InferiorExitOk [ label="notifyInferiorExited", style="dashed"];
sg1:   InferiorExitOk -> InferiorShutdownOk
309
310
311
312
313
314
315
316
sg1:   InferiorShutdownOk -> EngineShutdownRequested
sg1:   InferiorShutdownFailed -> EngineShutdownRequested
sg1:   EngineShutdownRequested -> EngineShutdownOk [ label="Engine::shutdownEngine\nnotifyEngineShutdownOk", style="dashed" ];
sg1:   EngineShutdownRequested -> EngineShutdownFailed  [ label="Engine::shutdownEngine\nnotifyEngineShutdownFailed", style="dashed" ];
sg1:   EngineShutdownOk -> DebuggerFinished  [ style = "dotted" ];
sg1:   EngineShutdownFailed  -> DebuggerFinished [ style = "dotted" ];
sg1: }
* \endcode */
hjk's avatar
hjk committed
317
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
318
319


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

    GdbEngine specific startup. All happens in EngineSetupRequested state:

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

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

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



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

357
\endcode */
358

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

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

con's avatar
con committed
367
368
369
370

namespace Debugger {
namespace Constants {

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

373
374
375
376
377
378
379
380
const char * const STARTEXTERNAL            = "Debugger.StartExternal";
const char * const ATTACHEXTERNAL           = "Debugger.AttachExternal";
const char * const ATTACHCORE               = "Debugger.AttachCore";
const char * const ATTACHREMOTE             = "Debugger.AttachRemote";
const char * const ATTACHREMOTECDB          = "Debugger.AttachRemoteCDB";
const char * const STARTREMOTELLDB          = "Debugger.StartRemoteLLDB";
const char * const DETACH                   = "Debugger.Detach";

hjk's avatar
hjk committed
381
const char * const RUN_TO_LINE              = "Debugger.RunToLine";
382
const char * const RUN_TO_SELECTED_FUNCTION = "Debugger.RunToSelectedFunction";
hjk's avatar
hjk committed
383
const char * const JUMP_TO_LINE             = "Debugger.JumpToLine";
384
385
386
387
388
const char * const RETURN_FROM_FUNCTION     = "Debugger.ReturnFromFunction";
const char * const SNAPSHOT                 = "Debugger.Snapshot";
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
// Don't add '1' to the string as it shows up in the shortcut dialog.
const char * const ADD_TO_WATCH1            = "Debugger.AddToWatch";
391
392
393
const char * const ADD_TO_WATCH2            = "Debugger.AddToWatch2";
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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
const char * const STOP_KEY                     = "Shift+Ctrl+Y";
const char * const RESET_KEY                    = "Ctrl+Shift+F5";
const char * const STEP_KEY                     = "Ctrl+Shift+I";
const char * const STEPOUT_KEY                  = "Ctrl+Shift+T";
const char * const NEXT_KEY                     = "Ctrl+Shift+O";
const char * const REVERSE_KEY                  = "";
const char * const RUN_TO_LINE_KEY              = "Shift+F8";
const char * const RUN_TO_SELECTED_FUNCTION_KEY = "Ctrl+F6";
const char * const JUMP_TO_LINE_KEY             = "Ctrl+D,Ctrl+L";
const char * const TOGGLE_BREAK_KEY             = "F8";
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
412
413
414
415
416
417
418
419
420
421
422
423
424
const char * const STOP_KEY                     = "Shift+F5";
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";
const char * const REVERSE_KEY                  = "F12";
const char * const RUN_TO_LINE_KEY              = "";
const char * const RUN_TO_SELECTED_FUNCTION_KEY = "Ctrl+F6";
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";
const char * const SNAPSHOT_KEY                 = "Ctrl+D,Ctrl+S";
con's avatar
con committed
425
426
427
428
429
#endif

} // namespace Constants


430
431
namespace Internal {

432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
// To be passed through margin menu action's data
struct BreakpointMenuContextData : public ContextData
{
    enum Mode
    {
        Breakpoint,
        MessageTracePoint
    };

    BreakpointMenuContextData() : mode(Breakpoint) {}
    Mode mode;
};

} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::BreakpointMenuContextData)

namespace Debugger {
namespace Internal {

453
454
455
456
457
458
// 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.

459
void addCdbOptionPages(QList<IOptionsPage*> *opts);
460
461
462
void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
463

464
465
466
467
#ifdef WITH_LLDB
void addLldbOptionPages(QList<IOptionsPage*> *opts);
#endif

hjk's avatar
hjk committed
468
static SessionManager *sessionManager()
469
{
hjk's avatar
hjk committed
470
    return ProjectExplorerPlugin::instance()->session();
471
472
}

473
474
475
476
477
478
479
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

480
static Abi anyAbiOfBinary(const QString &fileName)
481
482
483
484
485
486
{
    QList<Abi> abis = Abi::abisOfBinary(fileName);
    if (abis.isEmpty())
        return Abi();
    return abis.at(0);
}
487
488
489
490
491
492
493
494
495
496
497
498
499

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
    DummyEngine() : DebuggerEngine(DebuggerStartParameters()) {}
500
501
502
503
504
505
506
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
507
    unsigned debuggerCapabilities() const { return AddWatcherCapability; }
508
    bool acceptsBreakpoint(BreakpointModelId) const { return false; }
509
    bool acceptsDebuggerCommands() const { return false; }
510
511
};

512
513
514
515
516
517
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

518
class DebugMode : public IMode
hjk's avatar
hjk committed
519
520
{
public:
521
522
523
524
    DebugMode()
    {
        setObjectName(QLatin1String("DebugMode"));
        setContext(Context(CC::C_EDITORMANAGER, C_DEBUGMODE, CC::C_NAVIGATION_PANE));
525
526
527
528
529
        setDisplayName(DebuggerPlugin::tr("Debug"));
        setIcon(QIcon(QLatin1String(":/fancyactionbar/images/mode_Debug.png")));
        setPriority(P_MODE_DEBUG);
        setId(MODE_DEBUG);
        setType(CC::MODE_EDIT_TYPE);
530
    }
hjk's avatar
hjk committed
531

hjk's avatar
hjk committed
532
533
534
535
536
537
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        //EditorManager::instance()->setParent(0);
        delete m_widget;
    }
538
};
hjk's avatar
hjk committed
539

540

541
542
543
544
545
546
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

547
static TextEditor::ITextEditor *currentTextEditor()
548
{
549
550
551
552
553
    if (const Core::EditorManager *editorManager = Core::EditorManager::instance())
            if (Core::IEditor *editor = editorManager->currentEditor())
                return qobject_cast<TextEditor::ITextEditor*>(editor);
    return 0;
}
con's avatar
con committed
554

555
556
557
558
559
560
561
562
563
564
565
static bool currentTextEditorPosition(ContextData *data)
{
    if (TextEditor::ITextEditor *textEditor = currentTextEditor()) {
        if (const Core::IFile *file = textEditor->file()) {
            data->fileName = file->fileName();
            data->lineNumber = textEditor->currentLine();
            return true;
        }
    }
    return false;
}
566

567
568
///////////////////////////////////////////////////////////////////////
//
569
// DebuggerPluginPrivate
570
571
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
572

573
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
574

575
576
577
578
579
580
581
582
583
584
585
586
587
588
/*!
    \class Debugger::Internal::DebuggerCore

    This is the "internal" interface of the debugger plugin that's
    used by debugger views and debugger engines. The interface is
    implemented in DebuggerPluginPrivate.
*/

/*!
    \class Debugger::Internal::DebuggerPluginPrivate

    Implementation of DebuggerCore.
*/

589
class DebuggerPluginPrivate : public DebuggerCore
590
591
{
    Q_OBJECT
592

593
594
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
595
    ~DebuggerPluginPrivate();
596

597
    bool initialize(const QStringList &arguments, QString *errorMessage);
598
599
600
    void extensionsInitialized();
    void aboutToShutdown();

601
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
602
    void disconnectEngine() { connectEngine(0); }
603
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
604
    DebuggerEngine *dummyEngine();
605

606
public slots:
607
608
609
610
611
612
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

613
614
615
616
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
617

hjk's avatar
hjk committed
618
    void breakpointSetMarginActionTriggered()
619
    {
620
621
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
        QString message;
        if (data.mode == BreakpointMenuContextData::MessageTracePoint) {
            if (data.address) {
                //: Message tracepoint: Address hit.
                message = tr("0x%1 hit").arg(data.address, 0, 16);
            } else {
                //: Message tracepoint: %1 file, %2 line %3 function hit.
                message = tr("%1:%2 %3() hit").arg(QFileInfo(data.fileName).fileName()).
                        arg(data.lineNumber).
                        arg(cppFunctionAt(data.fileName, data.lineNumber));
            }
            QInputDialog dialog; // Create wide input dialog.
            dialog.setWindowFlags(dialog.windowFlags()
                                  & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
            dialog.resize(600, dialog.height());
            dialog.setWindowTitle(tr("Add Message Tracepoint"));
            dialog.setLabelText (tr("Message:"));
            dialog.setTextValue(message);
            if (dialog.exec() != QDialog::Accepted || dialog.textValue().isEmpty())
                return;
            message = dialog.textValue();
        }
645
        if (data.address)
646
            toggleBreakpointByAddress(data.address, message);
647
        else
648
            toggleBreakpointByFileAndLine(data.fileName, data.lineNumber, message);
649
    }
650

hjk's avatar
hjk committed
651
    void breakpointRemoveMarginActionTriggered()
652
    {
hjk's avatar
hjk committed
653
654
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
655
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
656
        m_breakHandler->removeBreakpoint(id);
hjk's avatar
hjk committed
657
658
659
660
661
662
     }

    void breakpointEnableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
663
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
664
        breakHandler()->setEnabled(id, true);
hjk's avatar
hjk committed
665
666
667
668
669
670
    }

    void breakpointDisableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
671
        BreakpointModelId id = act->data().value<BreakpointModelId>();;
hjk's avatar
hjk committed
672
        breakHandler()->setEnabled(id, false);
673
674
    }

675
    void updateWatchersHeader(int section, int, int newSize)
676
677
678
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
    }
679

680
    void sourceFilesDockToggled(bool on)
681
    {
682
        if (on && m_currentEngine->state() == InferiorStopOk)
683
684
685
            m_currentEngine->reloadSourceFiles();
    }

686
    void modulesDockToggled(bool on)
687
    {
688
        if (on && m_currentEngine->state() == InferiorStopOk)
689
690
            m_currentEngine->reloadModules();
    }
691

hjk's avatar
hjk committed
692
    void registerDockToggled(bool on)
693
    {
694
        if (on && m_currentEngine->state() == InferiorStopOk)
695
696
            m_currentEngine->reloadRegisters();
    }
697

698
699
    void synchronizeBreakpoints()
    {
700
        showMessage("ATTEMPT SYNC", LogDebug);
701
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
702
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
703
704
705
706
                engine->attemptBreakpointSynchronization();
        }
    }

hjk's avatar
hjk committed
707
708
709
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
710
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
711
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
712
713
714
        }
    }

715
    void editorOpened(Core::IEditor *editor);
716
    void updateBreakMenuItem(Core::IEditor *editor);
717
718
719
720
    void setBusyCursor(bool busy);
    void requestMark(TextEditor::ITextEditor *editor, int lineNumber);
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
721

722
723
724
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
725
726
727
728
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
729
    void onModeChanged(Core::IMode *mode);
730
    void onCoreAboutToOpen();
731
    void showSettingsDialog();
732

733
    void debugProject();
734
    void debugProjectBreakMain();
735
    void startExternalApplication();
736
    void startRemoteCdbSession();
737
    void startRemoteApplication();
738
    void startRemoteEngine();
739
    void attachExternalApplication();
740
    Q_SLOT void attachExternalApplication(ProjectExplorer::RunControl *rc);
741
    void runScheduled();
742
    void attachCore();
743
    void attachRemote(const QString &spec);
744

745
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
746
    void languagesChanged();
747
    void showStatusMessage(const QString &msg, int timeout = -1);
748
    void openMemoryEditor();
749

750
751
752
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

    void showQtDumperLibraryWarning(const QString &details);
hjk's avatar
hjk committed
753
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
754
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
755
        { return mainWindow()->isDockVisible(objectName); }
756
757

    bool hasSnapshots() const { return m_snapshotHandler->size(); }
hjk's avatar
hjk committed
758
    void createNewDock(QWidget *widget);
759

760
761
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
762
    DebuggerLanguages activeLanguages() const;
763
764
    unsigned enabledEngines() const { return m_cmdLineEnabledEngines; }
    QString debuggerForAbi(const Abi &abi, DebuggerEngineType et = NoEngineType) const;
765
766
767
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
768

769
770
771
772
773
    BreakHandler *breakHandler() const { return m_breakHandler; }
    SnapshotHandler *snapshotHandler() const { return m_snapshotHandler; }

    void setConfigValue(const QString &name, const QVariant &value);
    QVariant configValue(const QString &name) const;
774

ck's avatar
ck committed
775
    DebuggerRunControl *createDebugger(const DebuggerStartParameters &sp,
hjk's avatar
hjk committed
776
777
        RunConfiguration *rc = 0);
    void startDebugger(RunControl *runControl);
778
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
779
780
781

    void dumpLog();
    void cleanupViews();
782
    void setInitialState();
783
784
785
786

    void fontSettingsChanged(const TextEditor::FontSettings &settings);

    void updateState(DebuggerEngine *engine);
787
    void updateWatchersWindow();
788
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
789
790
791
792

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
793

794
    void executeDebuggerCommand(const QString &command);
hjk's avatar
hjk committed
795
    void scriptExpressionEntered(const QString &expression);
796
    void coreShutdown();
797

hjk's avatar
hjk committed
798
public slots:
799
    void updateDebugActions();
800
801
802

    void handleExecDetach()
    {
803
        currentEngine()->resetLocation();
804
805
806
807
808
        currentEngine()->detachDebugger();
    }

    void handleExecContinue()
    {
809
        currentEngine()->resetLocation();
810
811
812
813
814
        currentEngine()->continueInferior();
    }

    void handleExecInterrupt()
    {
815
        currentEngine()->resetLocation();
816
817
818
819
820
        currentEngine()->requestInterruptInferior();
    }

    void handleExecReset()
    {
821
        currentEngine()->resetLocation();
822
823
        currentEngine()->notifyEngineIll(); // FIXME: Check.
    }
hjk's avatar
hjk committed
824
825
826

    void handleExecStep()
    {
827
828
829
830
831
832
833
834
835
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeStepI();
            else
                currentEngine()->executeStep();
        }
hjk's avatar
hjk committed
836
837
838
839
    }

    void handleExecNext()
    {
840
841
842
843
844
845
846
847
848
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeNextI();
            else
                currentEngine()->executeNext();
        }
hjk's avatar
hjk committed
849
850
    }

851
852
    void handleExecStepOut()
    {
853
        currentEngine()->resetLocation();
854
855
856
857
858
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
859
        currentEngine()->resetLocation();
860
861
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
862
863
864
865

    void handleExecJumpToLine()
    {
        //removeTooltip();
866
        currentEngine()->resetLocation();
867
868
869
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeJumpToLine(data);
hjk's avatar
hjk committed
870
871
872
873
874
    }

    void handleExecRunToLine()
    {
        //removeTooltip();
875
        currentEngine()->resetLocation();
876
877
878
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeRunToLine(data);
hjk's avatar
hjk committed
879
880
    }

881
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
882
    {
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
        ITextEditor *textEditor = currentTextEditor();
        QTC_ASSERT(textEditor, return);
        QPlainTextEdit *ed = qobject_cast<QPlainTextEdit*>(textEditor->widget());
        if (!ed)
            return;
        QTextCursor cursor = ed->textCursor();
        QString functionName = cursor.selectedText();
        if (functionName.isEmpty()) {
            const QTextBlock block = cursor.block();
            const QString line = block.text();
            foreach (const QString &str, line.trimmed().split('(')) {
                QString a;
                for (int i = str.size(); --i >= 0; ) {
                    if (!str.at(i).isLetterOrNumber())
                        break;
                    a = str.at(i) + a;
                }
                if (!a.isEmpty()) {
                    functionName = a;
                    break;
                }
            }
        }

907
908
909
910
911
912
        if (functionName.isEmpty()) {
            showStatusMessage(tr("No function selected."));
        } else {
            showStatusMessage(tr("Running to function \"%1\".")
                .arg(functionName));
            currentEngine()->resetLocation();
913
            currentEngine()->executeRunToFunction(functionName);
914
        }
hjk's avatar
hjk committed
915
916
    }

917
918
919
920
    void slotEditBreakpoint()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
921
        const BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
922
923
        QTC_ASSERT(id > 0, return);
        BreakWindow::editBreakpoint(id, mainWindow());
924
925
926
927
    }

    void slotRunToLine()
    {
928
929
930
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
        const ContextData data = action->data().value<ContextData>();
931
        currentEngine()->executeRunToLine(data);
932
933
934
935
    }

    void slotJumpToLine()
    {
936
937
938
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
        const ContextData data = action->data().value<ContextData>();
939
        currentEngine()->executeJumpToLine(data);
940
941
    }

hjk's avatar
hjk committed
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
    void handleAddToWatchWindow()
    {
        // Requires a selection, but that's the only case we want anyway.
        EditorManager *editorManager = EditorManager::instance();
        if (!editorManager)
            return;
        IEditor *editor = editorManager->currentEditor();
        if (!editor)
            return;
        ITextEditor *textEditor = qobject_cast<ITextEditor*>(editor);
        if (!textEditor)
            return;
        QTextCursor tc;
        QPlainTextEdit *ptEdit = qobject_cast<QPlainTextEdit*>(editor->widget());
        if (ptEdit)
            tc = ptEdit->textCursor();
        QString exp;
        if (tc.hasSelection()) {
            exp = tc.selectedText();
        } else {
            int line, column;
            exp = cppExpressionAt(textEditor, tc.position(), &line, &column);
        }
        if (exp.isEmpty())
            return;
        currentEngine()->watchHandler()->watchExpression(exp);
    }

    void handleExecExit()
    {
972
        currentEngine()->exitDebugger();
hjk's avatar
hjk committed
973
974
975
976
977
978
979
980
981
982
983
984
    }

    void handleFrameDown()
    {
        currentEngine()->frameDown();
    }

    void handleFrameUp()
    {
        currentEngine()->frameUp();
    }

985
    void handleOperateByInstructionTriggered(bool operateByInstructionTriggered)
hjk's avatar
hjk committed
986
    {
987
988
989
        // Go to source only if we have the file.
        if (currentEngine()->stackHandler()->currentIndex() >= 0) {
            const StackFrame frame = currentEngine()->stackHandler()->currentFrame();
990
991
992
            if (operateByInstructionTriggered || frame.isUsable()) {
                currentEngine()->gotoLocation(Location(frame, true));
            }
993
        }
hjk's avatar
hjk committed
994
995
    }

996
    bool isActiveDebugLanguage(int lang) const
hjk's avatar
hjk committed
997
    {
998
        return m_mainWindow->activeDebugLanguages() & lang;
hjk's avatar
hjk committed
999
1000
    }

1001
1002
1003
1004
1005
1006
1007
1008
    QVariant sessionValue(const QString &name);
    void setSessionValue(const QString &name, const QVariant &value);
    QIcon locationMarkIcon() const { return m_locationMarkIcon; }

    void openTextEditor(const QString &titlePattern0, const QString &contents);
    void clearCppCodeModelSnapshot();
    void showMessage(const QString &msg, int channel, int timeout = -1);

hjk's avatar
hjk committed
1009
1010
1011
1012
    Utils::SavedAction *action(int code) const;
    bool boolSetting(int code) const;
    QString stringSetting(int code) const;

hjk's avatar
hjk committed
1013
1014
    void showModuleSymbols(const QString &moduleName, const Symbols &symbols);

1015
1016
1017
1018
1019
1020
    bool parseArgument(QStringList::const_iterator &it,
        const QStringList::const_iterator &cend,
        unsigned *enabledEngines, QString *errorMessage);
    bool parseArguments(const QStringList &args,
        unsigned *enabledEngines, QString *errorMessage);

1021
    DebuggerToolTipManager *toolTipManager() const { return m_toolTipManager; }
1022
    virtual QSharedPointer<GlobalDebuggerOptions> globalDebuggerOptions() const { return m_globalDebuggerOptions; }
1023

1024
public:
1025
    DebuggerMainWindow *m_mainWindow;
1026
1027
1028
    DebuggerRunControlFactory *m_debuggerRunControlFactory;

    QString m_previousMode;
1029
    QList<DebuggerStartParameters> m_scheduledStarts;
1030

1031
    Utils::ProxyAction *m_visibleDebugAction;
1032
    QAction *m_debugAction;
1033
1034
    QAction *m_startExternalAction;
    QAction *m_startRemoteAction;
1035
    QAction *m_startRemoteCdbAction;
1036
    QAction *m_startRemoteLldbAction;
1037
1038
1039
    QAction *m_attachExternalAction;
    QAction *m_attachCoreAction;
    QAction *m_detachAction;
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
    QAction *m_continueAction;
    QAction *m_exitAction; // On application output button if "Stop" is possible
    QAction *m_interruptAction; // On the fat debug button if "Pause" is possible
    QAction *m_undisturbableAction; // On the fat debug button if nothing can be done
    QAction *m_resetAction;
    QAction *m_stepAction;
    QAction *m_stepOutAction;
    QAction *m_runToLineAction; // In the debug menu
    QAction *m_runToSelectedFunctionAction;
    QAction *m_jumpToLineAction; // In the Debug menu.
    QAction *m_returnFromFunctionAction;
    QAction *m_nextAction;
    QAction *m_watchAction1; // In the Debug menu.
    QAction *m_watchAction2; // In the text editor context menu.
    QAction *m_breakAction;
    QAction *m_reverseDirectionAction;
    QAction *m_frameUpAction;
    QAction *m_frameDownAction;

1059
1060
    QToolButton *m_reverseToolButton;

1061
    QIcon m_startIcon;
1062
    QIcon m_exitIcon;
1063
    QIcon m_continueIcon;
1064
1065
1066
    QIcon m_interruptIcon;
    QIcon m_locationMarkIcon;

1067
    Utils::StatusLabel *m_statusLabel;
1068
1069
1070
    QComboBox *m_threadBox;

    BreakWindow *m_breakWindow;
1071
    BreakHandler *m_breakHandler;
1072
    //ConsoleWindow *m_consoleWindow;
1073
1074
1075
1076
1077
1078
1079
1080
1081
    QTreeView *m_returnWindow;
    QTreeView *m_localsWindow;
    QTreeView *m_watchersWindow;
    QAbstractItemView *m_registerWindow;
    QAbstractItemView *m_modulesWindow;
    QAbstractItemView *m_snapshotWindow;
    SourceFilesWindow *m_sourceFilesWindow;
    QAbstractItemView *m_stackWindow;
    QAbstractItemView *m_threadsWindow;
1082
    LogWindow *m_logWindow;
1083
    ScriptConsole *m_scriptConsoleWindow;
1084
1085
1086
1087

    bool m_busy;
    QString m_lastPermanentStatusMessage;

1088
    mutable CPlusPlus::Snapshot m_codeModelSnapshot;
1089
1090
    DebuggerPlugin *m_plugin;

1091
    SnapshotHandler *m_snapshotHandler;
1092
    bool m_shuttingDown;
hjk's avatar
hjk committed
1093
    DebuggerEngine *m_currentEngine;
hjk's avatar
hjk committed
1094
1095
1096
    DebuggerSettings *m_debuggerSettings;
    QSettings *m_coreSettings;
    bool m_gdbBinariesChanged;
1097
    uint m_cmdLineEnabledEngines;
1098
    QStringList m_arguments;
1099
    DebuggerToolTipManager *m_toolTipManager;
1100
    CommonOptionsPage *m_commonOptionsPage;