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

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

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

47
48
#include "breakpoint.h"
#include "breakhandler.h"
49
#include "breakwindow.h"
50
#include "consolewindow.h"
51
#include "disassembleragent.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
100
#include <qt4projectmanager/qt4projectmanagerconstants.h>

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>
con's avatar
con committed
110

111
112
#include <qml/scriptconsole.h>

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

126
127
#include <climits>

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

138
139
140
141
142
143
144
145
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
146
    \internal
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
*/

/*!
    \class Debugger::DebuggerEngine

    \brief Base class of a debugger engine.

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

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

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

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

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

\endcode */
hjk's avatar
hjk committed
273

274
275
276
/* 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
277

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


318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
/*!
    \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}
340
341
342



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

355
\endcode */
356

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

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

con's avatar
con committed
365
366
367
368

namespace Debugger {
namespace Constants {

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

371
372
373
374
375
376
377
378
379
const char * const STARTEXTERNAL            = "Debugger.StartExternal";
const char * const ATTACHEXTERNAL           = "Debugger.AttachExternal";
const char * const ATTACHCORE               = "Debugger.AttachCore";
const char * const ATTACHTCF                = "Debugger.AttachTcf";
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
380
const char * const RUN_TO_LINE              = "Debugger.RunToLine";
381
const char * const RUN_TO_SELECTED_FUNCTION = "Debugger.RunToSelectedFunction";
hjk's avatar
hjk committed
382
const char * const JUMP_TO_LINE             = "Debugger.JumpToLine";
383
384
385
386
387
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";
388
389
// Don't add '1' to the string as it shows up in the shortcut dialog.
const char * const ADD_TO_WATCH1            = "Debugger.AddToWatch";
390
391
392
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
393

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
394
#ifdef Q_WS_MAC
395
396
397
398
399
400
401
402
403
404
405
406
407
408
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
409
#else
410
411
412
413
414
415
416
417
418
419
420
421
422
423
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
424
425
426
427
428
#endif

} // namespace Constants


429
430
431
432
433
434
435
436
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.

437
void addCdbOptionPages(QList<IOptionsPage*> *opts);
438
439
440
void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
441

442
443
444
445
#ifdef WITH_LLDB
void addLldbOptionPages(QList<IOptionsPage*> *opts);
#endif

hjk's avatar
hjk committed
446
static SessionManager *sessionManager()
447
{
hjk's avatar
hjk committed
448
    return ProjectExplorerPlugin::instance()->session();
449
450
}

451
452
453
454
455
456
457
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

458
459
460
461
462
463
464
static Abi abiOfBinary(const QString &fileName)
{
    QList<Abi> abis = Abi::abisOfBinary(fileName);
    if (abis.isEmpty())
        return Abi();
    return abis.at(0);
}
465
466
467
468
469
470
471
472
473
474
475
476
477

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
    DummyEngine() : DebuggerEngine(DebuggerStartParameters()) {}
478
479
480
481
482
483
484
485
486
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
    unsigned debuggerCapabilities() const { return 0; }
    bool acceptsBreakpoint(BreakpointId) const { return false; }
487
    bool acceptsDebuggerCommands() const { return false; }
488
489
};

490
491
492
493
494
495
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

496
class DebugMode : public IMode
hjk's avatar
hjk committed
497
498
{
public:
hjk's avatar
hjk committed
499
    DebugMode() : m_widget(0) { setObjectName(QLatin1String("DebugMode")); }
hjk's avatar
hjk committed
500

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

    // IMode
hjk's avatar
hjk committed
509
510
511
512
513
514
515
516
517
    QString displayName() const { return DebuggerPlugin::tr("Debug"); }
    QIcon icon() const { return QIcon(__(":/fancyactionbar/images/mode_Debug.png")); }
    int priority() const { return P_MODE_DEBUG; }
    QWidget *widget();
    QString id() const { return MODE_DEBUG; }
    QString type() const { return CC::MODE_EDIT_TYPE; }
    Context context() const
        { return Context(CC::C_EDITORMANAGER, C_DEBUGMODE, CC::C_NAVIGATION_PANE); }
    QString contextHelpId() const { return QString(); }
518
519
private:
    QWidget *m_widget;
520
};
hjk's avatar
hjk committed
521

522

523
524
525
526
527
528
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

529
static TextEditor::ITextEditor *currentTextEditor()
530
{
531
532
533
534
535
    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
536

537
538
539
540
541
542
543
544
545
546
547
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;
}
548

549
550
///////////////////////////////////////////////////////////////////////
//
551
// DebuggerPluginPrivate
552
553
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
554

555
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
556

557
558
559
560
561
562
563
564
565
566
567
568
569
570
/*!
    \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.
*/

571
class DebuggerPluginPrivate : public DebuggerCore
572
573
{
    Q_OBJECT
574

575
576
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
577
    ~DebuggerPluginPrivate();
578

579
    bool initialize(const QStringList &arguments, QString *errorMessage);
580
581
582
    void extensionsInitialized();
    void aboutToShutdown();

583
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
584
    void disconnectEngine() { connectEngine(0); }
585
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
586
    DebuggerEngine *dummyEngine();
587

588
public slots:
589
590
591
592
593
594
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

595
596
597
598
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
599

hjk's avatar
hjk committed
600
    void breakpointSetMarginActionTriggered()
601
    {
602
603
604
605
606
607
608
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
        const ContextData data = action->data().value<ContextData>();
        if (data.address)
            toggleBreakpointByAddress(data.address);
        else
            toggleBreakpointByFileAndLine(data.fileName, data.lineNumber);
609
    }
610

hjk's avatar
hjk committed
611
    void breakpointRemoveMarginActionTriggered()
612
    {
hjk's avatar
hjk committed
613
614
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
615
        m_breakHandler->removeBreakpoint(act->data().toInt());
hjk's avatar
hjk committed
616
617
618
619
620
621
622
623
624
625
626
627
628
629
     }

    void breakpointEnableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
        breakHandler()->setEnabled(act->data().toInt(), true);
    }

    void breakpointDisableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
        breakHandler()->setEnabled(act->data().toInt(), false);
630
631
    }

632
    void updateWatchersHeader(int section, int, int newSize)
633
634
635
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
    }
636

637
    void sourceFilesDockToggled(bool on)
638
    {
639
        if (on && m_currentEngine->state() == InferiorStopOk)
640
641
642
            m_currentEngine->reloadSourceFiles();
    }

643
    void modulesDockToggled(bool on)
644
    {
645
        if (on && m_currentEngine->state() == InferiorStopOk)
646
647
            m_currentEngine->reloadModules();
    }
648

hjk's avatar
hjk committed
649
    void registerDockToggled(bool on)
650
    {
651
        if (on && m_currentEngine->state() == InferiorStopOk)
652
653
            m_currentEngine->reloadRegisters();
    }
654

655
656
    void synchronizeBreakpoints()
    {
657
        showMessage("ATTEMPT SYNC", LogDebug);
658
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
659
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
660
661
662
663
                engine->attemptBreakpointSynchronization();
        }
    }

hjk's avatar
hjk committed
664
665
666
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
667
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
668
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
669
670
671
        }
    }

672
    void editorOpened(Core::IEditor *editor);
673
    void updateBreakMenuItem(Core::IEditor *editor);
674
675
676
677
    void setBusyCursor(bool busy);
    void requestMark(TextEditor::ITextEditor *editor, int lineNumber);
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
678

679
680
681
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
682
683
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber);
    void toggleBreakpointByAddress(quint64 address);
684
    void onModeChanged(Core::IMode *mode);
685
    void onCoreAboutToOpen();
686
    void showSettingsDialog();
687

688
    void debugProject();
689
    void startExternalApplication();
690
    void startRemoteCdbSession();
691
    void startRemoteApplication();
692
    void startRemoteEngine();
693
    void attachExternalApplication();
694
    void attachExternalApplication(qint64 pid, const QString &binary,
695
696
                                   const ProjectExplorer::Abi &abi = ProjectExplorer::Abi(),
                                   const QString &debuggerCommand = QString());
697
    void runScheduled();
698
    void attachCore();
699
700
701
    void attachCore(const QString &core, const QString &exeFileName,
                    const ProjectExplorer::Abi &abi = ProjectExplorer::Abi(),
                    const QString &debuggerCommand = QString());
702
    void attachRemote(const QString &spec);
703
    void attachRemoteTcf();
704

705
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
706
    void languagesChanged();
707
    void showStatusMessage(const QString &msg, int timeout = -1);
708
    void openMemoryEditor();
709

710
711
712
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

    void showQtDumperLibraryWarning(const QString &details);
hjk's avatar
hjk committed
713
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
714
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
715
        { return mainWindow()->isDockVisible(objectName); }
716
717

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

720
721
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
722
    DebuggerLanguages activeLanguages() const;
723
724
    unsigned enabledEngines() const { return m_cmdLineEnabledEngines; }
    QString debuggerForAbi(const Abi &abi, DebuggerEngineType et = NoEngineType) const;
725
726
727
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
728

729
730
731
732
733
    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;
734

ck's avatar
ck committed
735
    DebuggerRunControl *createDebugger(const DebuggerStartParameters &sp,
hjk's avatar
hjk committed
736
737
        RunConfiguration *rc = 0);
    void startDebugger(RunControl *runControl);
738
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
739
740
741

    void dumpLog();
    void cleanupViews();
742
    void setInitialState();
743
744
745
746

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

    void updateState(DebuggerEngine *engine);
747
    void updateWatchersWindow();
748
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
749
750
751
752

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
753

754
    void executeDebuggerCommand(const QString &command);
hjk's avatar
hjk committed
755
    void scriptExpressionEntered(const QString &expression);
756
    void coreShutdown();
757

hjk's avatar
hjk committed
758
public slots:
759
    void updateDebugActions();
760
761
762

    void handleExecDetach()
    {
763
        currentEngine()->resetLocation();
764
765
766
767
768
        currentEngine()->detachDebugger();
    }

    void handleExecContinue()
    {
769
        currentEngine()->resetLocation();
770
771
772
773
774
        currentEngine()->continueInferior();
    }

    void handleExecInterrupt()
    {
775
        currentEngine()->resetLocation();
776
777
778
779
780
        currentEngine()->requestInterruptInferior();
    }

    void handleExecReset()
    {
781
        currentEngine()->resetLocation();
782
783
        currentEngine()->notifyEngineIll(); // FIXME: Check.
    }
hjk's avatar
hjk committed
784
785
786

    void handleExecStep()
    {
787
        currentEngine()->resetLocation();
788
        if (boolSetting(OperateByInstruction))
hjk's avatar
hjk committed
789
790
791
792
793
794
795
            currentEngine()->executeStepI();
        else
            currentEngine()->executeStep();
    }

    void handleExecNext()
    {
796
        currentEngine()->resetLocation();
797
        if (boolSetting(OperateByInstruction))
hjk's avatar
hjk committed
798
799
800
801
802
            currentEngine()->executeNextI();
        else
            currentEngine()->executeNext();
    }

803
804
    void handleExecStepOut()
    {
805
        currentEngine()->resetLocation();
806
807
808
809
810
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
811
        currentEngine()->resetLocation();
812
813
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
814
815
816
817

    void handleExecJumpToLine()
    {
        //removeTooltip();
818
        currentEngine()->resetLocation();
819
820
821
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeJumpToLine(data);
hjk's avatar
hjk committed
822
823
824
825
826
    }

    void handleExecRunToLine()
    {
        //removeTooltip();
827
        currentEngine()->resetLocation();
828
829
830
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeRunToLine(data);
hjk's avatar
hjk committed
831
832
    }

833
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
834
    {
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
        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;
                }
            }
        }

859
860
861
862
863
864
        if (functionName.isEmpty()) {
            showStatusMessage(tr("No function selected."));
        } else {
            showStatusMessage(tr("Running to function \"%1\".")
                .arg(functionName));
            currentEngine()->resetLocation();
865
            currentEngine()->executeRunToFunction(functionName);
866
        }
hjk's avatar
hjk committed
867
868
    }

869
870
871
872
    void slotEditBreakpoint()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
hjk's avatar
hjk committed
873
874
875
        const BreakpointId id = act->data().toInt();
        QTC_ASSERT(id > 0, return);
        BreakWindow::editBreakpoint(id, mainWindow());
876
877
878
879
    }

    void slotRunToLine()
    {
880
881
882
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
        const ContextData data = action->data().value<ContextData>();
883
        currentEngine()->executeRunToLine(data);
884
885
886
887
    }

    void slotJumpToLine()
    {
888
889
890
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
        const ContextData data = action->data().value<ContextData>();
891
        currentEngine()->executeJumpToLine(data);
892
893
    }

hjk's avatar
hjk committed
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
    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()
    {
924
        currentEngine()->exitDebugger();
hjk's avatar
hjk committed
925
926
927
928
929
930
931
932
933
934
935
936
    }

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

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

937
    void handleOperateByInstructionTriggered(bool operateByInstructionTriggered)
hjk's avatar
hjk committed
938
    {
939
940
941
        // Go to source only if we have the file.
        if (currentEngine()->stackHandler()->currentIndex() >= 0) {
            const StackFrame frame = currentEngine()->stackHandler()->currentFrame();
942
943
944
            if (operateByInstructionTriggered || frame.isUsable()) {
                currentEngine()->gotoLocation(Location(frame, true));
            }
945
        }
hjk's avatar
hjk committed
946
947
    }

948
    bool isActiveDebugLanguage(int lang) const
hjk's avatar
hjk committed
949
    {
950
        return m_mainWindow->activeDebugLanguages() & lang;
hjk's avatar
hjk committed
951
952
    }

953
954
955
956
957
958
959
960
    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
961
962
963
964
    Utils::SavedAction *action(int code) const;
    bool boolSetting(int code) const;
    QString stringSetting(int code) const;

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

967
968
969
970
971
972
    bool parseArgument(QStringList::const_iterator &it,
        const QStringList::const_iterator &cend,
        unsigned *enabledEngines, QString *errorMessage);
    bool parseArguments(const QStringList &args,
        unsigned *enabledEngines, QString *errorMessage);

973
    DebuggerToolTipManager *toolTipManager() const { return m_toolTipManager; }
974
    virtual QSharedPointer<GlobalDebuggerOptions> globalDebuggerOptions() const { return m_globalDebuggerOptions; }
975

976
public:
977
    DebuggerMainWindow *m_mainWindow;
978
979
980
    DebuggerRunControlFactory *m_debuggerRunControlFactory;

    QString m_previousMode;
981
    QList<DebuggerStartParameters> m_scheduledStarts;
982

983
    Utils::ProxyAction *m_visibleDebugAction;
984
    QAction *m_debugAction;
985
986
    QAction *m_startExternalAction;
    QAction *m_startRemoteAction;
987
    QAction *m_startRemoteCdbAction;
988
    QAction *m_startRemoteLldbAction;
989
990
991
992
    QAction *m_attachExternalAction;
    QAction *m_attachCoreAction;
    QAction *m_attachTcfAction;
    QAction *m_detachAction;
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
    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;

1012
1013
    QToolButton *m_reverseToolButton;

1014
    QIcon m_startIcon;
1015
    QIcon m_exitIcon;
1016
    QIcon m_continueIcon;
1017
1018
1019
    QIcon m_interruptIcon;
    QIcon m_locationMarkIcon;

1020
    Utils::StatusLabel *m_statusLabel;
1021
1022
1023
    QComboBox *m_threadBox;

    BreakWindow *m_breakWindow;
1024
    BreakHandler *m_breakHandler;
1025
    //ConsoleWindow *m_consoleWindow;
1026
1027
1028
1029
1030
1031
1032
1033
1034
    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;
1035
    LogWindow *m_logWindow;
1036
    ScriptConsole *m_scriptConsoleWindow;
1037
1038
1039
1040

    bool m_busy;
    QString m_lastPermanentStatusMessage;

1041
    mutable CPlusPlus::Snapshot m_codeModelSnapshot;
1042
1043
    DebuggerPlugin *m_plugin;

1044
    SnapshotHandler *m_snapshotHandler;
1045
    bool m_shuttingDown;
hjk's avatar
hjk committed
1046
    DebuggerEngine *m_currentEngine;
hjk's avatar
hjk committed
1047
1048
1049
    DebuggerSettings *m_debuggerSettings;
    QSettings *m_coreSettings;
    bool m_gdbBinariesChanged;
1050
    uint m_cmdLineEnabledEngines;
1051
    QStringList m_arguments;
1052
    DebuggerToolTipManager *m_toolTipManager;
1053
    CommonOptionsPage *m_commonOptionsPage;
1054
    DummyEngine *m_dummyEngine;
1055
    const QSharedPointer<GlobalDebuggerOptions> m_globalDebuggerOptions;
1056
1057
};

1058
DebuggerPluginPrivate::DebuggerPluginPrivate(DebuggerPlugin *plugin) :
1059
    m_toolTipManager(new DebuggerToolTipManager(this)),
1060
1061
    m_dummyEngine(0),
    m_globalDebuggerOptions(new GlobalDebuggerOptions)
1062
{
1063
1064
    qRegisterMetaType<WatchData>("WatchData");
    qRegisterMetaType<ContextData>("ContextData");
1065
    qRegisterMetaType<DebuggerStartParameters>("DebuggerStartParameters");
1066

1067
1068
1069
    QTC_ASSERT(!theDebuggerCore, /**/);
    theDebuggerCore = this;

1070
1071
    m_plugin = plugin;

1072
    m_startRemoteCdbAction = 0;
hjk's avatar
hjk committed
1073
    m_shuttingDown = false;
1074
1075
1076
1077
    m_statusLabel = 0;
    m_threadBox = 0;

    m_breakWindow = 0;
1078
    m_breakHandler = 0;
1079
1080
1081
1082
1083
1084
1085
1086
1087
    m_returnWindow = 0;
    m_localsWindow = 0;
    m_watchersWindow = 0;
    m_registerWindow = 0;
    m_modulesWindow = 0;
    m_snapshotWindow = 0;
    m_sourceFilesWindow = 0;
    m_stackWindow = 0;
    m_threadsWindow = 0;
1088
    m_logWindow = 0;
1089
    m_scriptConsoleWindow = 0;
1090

1091
    m_mainWindow = 0;
1092
    m_snapshotHandler = 0