debuggerplugin.cpp 116 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>
con's avatar
con committed
109

110
111
#include <qml/scriptconsole.h>

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

125
126
#include <climits>

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

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

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
145
    \internal
146
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
*/

/*!
    \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
272

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

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


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



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

354
\endcode */
355

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

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

con's avatar
con committed
364
365
366
367

namespace Debugger {
namespace Constants {

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

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

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

} // namespace Constants


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

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

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

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

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

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

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
    unsigned debuggerCapabilities() const { return 0; }
    bool acceptsBreakpoint(BreakpointId) const { return false; }
486
    bool acceptsDebuggerCommands() const { return false; }
487
488
489
490
491
492
493
494
495
};

static DebuggerEngine *dummyEngine()
{
    static DummyEngine dummy;
    return &dummy;
}


496
497
498
499
500
501
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

502
class DebugMode : public IMode
hjk's avatar
hjk committed
503
504
{
public:
hjk's avatar
hjk committed
505
    DebugMode() : m_widget(0) { setObjectName(QLatin1String("DebugMode")); }
hjk's avatar
hjk committed
506

hjk's avatar
hjk committed
507
508
509
510
511
512
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        //EditorManager::instance()->setParent(0);
        delete m_widget;
    }
513
514

    // IMode
hjk's avatar
hjk committed
515
516
517
518
519
520
521
522
523
    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(); }
524
525
private:
    QWidget *m_widget;
526
};
hjk's avatar
hjk committed
527

528

529
530
531
532
533
534
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

535
static TextEditor::ITextEditor *currentTextEditor()
536
{
537
538
539
540
541
    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
542

543
544
545
546
547
548
549
550
551
552
553
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;
}
554

555
556
///////////////////////////////////////////////////////////////////////
//
557
// DebuggerPluginPrivate
558
559
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
560

561
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
562

563
564
565
566
567
568
569
570
571
572
573
574
575
576
/*!
    \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.
*/

577
class DebuggerPluginPrivate : public DebuggerCore
578
579
{
    Q_OBJECT
580

581
582
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
583
    ~DebuggerPluginPrivate();
584

585
    bool initialize(const QStringList &arguments, QString *errorMessage);
586
587
588
    void extensionsInitialized();
    void aboutToShutdown();

589
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
590
    void disconnectEngine() { connectEngine(0); }
591
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
592

593
public slots:
594
595
596
597
598
599
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

600
601
602
603
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
604

hjk's avatar
hjk committed
605
    void breakpointSetMarginActionTriggered()
606
    {
607
608
609
610
611
612
613
        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);
614
    }
615

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

    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);
635
636
    }

637
    void updateWatchersHeader(int section, int, int newSize)
638
639
640
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
    }
641

642
    void sourceFilesDockToggled(bool on)
643
    {
644
        if (on && m_currentEngine->state() == InferiorStopOk)
645
646
647
            m_currentEngine->reloadSourceFiles();
    }

648
    void modulesDockToggled(bool on)
649
    {
650
        if (on && m_currentEngine->state() == InferiorStopOk)
651
652
            m_currentEngine->reloadModules();
    }
653

hjk's avatar
hjk committed
654
    void registerDockToggled(bool on)
655
    {
656
        if (on && m_currentEngine->state() == InferiorStopOk)
657
658
            m_currentEngine->reloadRegisters();
    }
659

660
661
    void synchronizeBreakpoints()
    {
662
        showMessage("ATTEMPT SYNC", LogDebug);
663
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
664
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
665
666
667
668
                engine->attemptBreakpointSynchronization();
        }
    }

hjk's avatar
hjk committed
669
670
671
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
672
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
673
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
674
675
676
        }
    }

677
    void editorOpened(Core::IEditor *editor);
678
    void updateBreakMenuItem(Core::IEditor *editor);
679
680
681
682
    void setBusyCursor(bool busy);
    void requestMark(TextEditor::ITextEditor *editor, int lineNumber);
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
683

684
685
686
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
687
688
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber);
    void toggleBreakpointByAddress(quint64 address);
689
    void onModeChanged(Core::IMode *mode);
690
    void onCoreAboutToOpen();
691
    void showSettingsDialog();
692

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

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

712
713
714
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

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

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

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

    bool isReverseDebugging() const;
730

731
732
733
734
735
    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;
736

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

    void dumpLog();
    void cleanupViews();
744
    void setInitialState();
745
746
747
748

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

    void updateState(DebuggerEngine *engine);
749
    void updateWatchersWindow();
750
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
751
752
753
754
755
756

    void clearStatusMessage();

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
757

758
    void executeDebuggerCommand(const QString &command);
hjk's avatar
hjk committed
759
    void scriptExpressionEntered(const QString &expression);
760
    void coreShutdown();
761

hjk's avatar
hjk committed
762
public slots:
763
    void updateDebugActions();
764
765
766

    void handleExecDetach()
    {
767
        currentEngine()->resetLocation();
768
769
770
771
772
        currentEngine()->detachDebugger();
    }

    void handleExecContinue()
    {
773
        currentEngine()->resetLocation();
774
775
776
777
778
        currentEngine()->continueInferior();
    }

    void handleExecInterrupt()
    {
779
        currentEngine()->resetLocation();
780
781
782
783
784
        currentEngine()->requestInterruptInferior();
    }

    void handleExecReset()
    {
785
        currentEngine()->resetLocation();
786
787
        currentEngine()->notifyEngineIll(); // FIXME: Check.
    }
hjk's avatar
hjk committed
788
789
790

    void handleExecStep()
    {
791
        currentEngine()->resetLocation();
792
        if (boolSetting(OperateByInstruction))
hjk's avatar
hjk committed
793
794
795
796
797
798
799
            currentEngine()->executeStepI();
        else
            currentEngine()->executeStep();
    }

    void handleExecNext()
    {
800
        currentEngine()->resetLocation();
801
        if (boolSetting(OperateByInstruction))
hjk's avatar
hjk committed
802
803
804
805
806
            currentEngine()->executeNextI();
        else
            currentEngine()->executeNext();
    }

807
808
    void handleExecStepOut()
    {
809
        currentEngine()->resetLocation();
810
811
812
813
814
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
815
        currentEngine()->resetLocation();
816
817
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
818
819
820
821

    void handleExecJumpToLine()
    {
        //removeTooltip();
822
        currentEngine()->resetLocation();
823
824
825
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeJumpToLine(data);
hjk's avatar
hjk committed
826
827
828
829
830
    }

    void handleExecRunToLine()
    {
        //removeTooltip();
831
        currentEngine()->resetLocation();
832
833
834
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeRunToLine(data);
hjk's avatar
hjk committed
835
836
    }

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

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

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

    void slotRunToLine()
    {
884
885
886
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
        const ContextData data = action->data().value<ContextData>();
887
        currentEngine()->executeRunToLine(data);
888
889
890
891
    }

    void slotJumpToLine()
    {
892
893
894
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
        const ContextData data = action->data().value<ContextData>();
895
        currentEngine()->executeJumpToLine(data);
896
897
    }

hjk's avatar
hjk committed
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
924
925
926
927
    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()
    {
928
        currentEngine()->exitDebugger();
hjk's avatar
hjk committed
929
930
931
932
933
934
935
936
937
938
939
940
    }

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

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

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

952
    bool isActiveDebugLanguage(int lang) const
hjk's avatar
hjk committed
953
    {
954
        return m_mainWindow->activeDebugLanguages() & lang;
hjk's avatar
hjk committed
955
956
    }

957
958
959
960
961
962
963
964
    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
965
966
967
968
    Utils::SavedAction *action(int code) const;
    bool boolSetting(int code) const;
    QString stringSetting(int code) const;

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

971
972
973
974
975
976
    bool parseArgument(QStringList::const_iterator &it,
        const QStringList::const_iterator &cend,
        unsigned *enabledEngines, QString *errorMessage);
    bool parseArguments(const QStringList &args,
        unsigned *enabledEngines, QString *errorMessage);

977
978
    DebuggerToolTipManager *toolTipManager() const { return m_toolTipManager; }

979
public:
980
    DebuggerMainWindow *m_mainWindow;
981
982
983
    DebuggerRunControlFactory *m_debuggerRunControlFactory;

    QString m_previousMode;
984
    QList<DebuggerStartParameters> m_scheduledStarts;
985

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

1015
1016
    QToolButton *m_reverseToolButton;

1017
    QIcon m_startIcon;
1018
    QIcon m_exitIcon;
1019
    QIcon m_continueIcon;
1020
1021
1022
1023
1024
1025
1026
    QIcon m_interruptIcon;
    QIcon m_locationMarkIcon;

    QLabel *m_statusLabel;
    QComboBox *m_threadBox;

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

    bool m_busy;
    QTimer m_statusTimer;
    QString m_lastPermanentStatusMessage;

1045
    mutable CPlusPlus::Snapshot m_codeModelSnapshot;
1046
1047
    DebuggerPlugin *m_plugin;

1048
    SnapshotHandler *m_snapshotHandler;
1049
    bool m_shuttingDown;
hjk's avatar
hjk committed
1050
    DebuggerEngine *m_currentEngine;
hjk's avatar
hjk committed
1051
1052
1053
    DebuggerSettings *m_debuggerSettings;
    QSettings *m_coreSettings;
    bool m_gdbBinariesChanged;
1054
    uint m_cmdLineEnabledEngines;
1055
    QStringList m_arguments;
1056
    DebuggerToolTipManager *m_toolTipManager;
1057
    CommonOptionsPage *m_commonOptionsPage;
1058
1059
};

1060
1061
DebuggerPluginPrivate::DebuggerPluginPrivate(DebuggerPlugin *plugin) :
    m_toolTipManager(new DebuggerToolTipManager(this))
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;
hjk's avatar
hjk committed
1093
    m_currentEngine = 0;
hjk's avatar
hjk committed
1094
1095
1096
    m_debuggerSettings = 0;

    m_gdbBinariesChanged = true;
1097
    m_cmdLineEnabledEngines = AllEngineTypes;
hjk's avatar
hjk committed
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108

    m_reverseToolButton = 0;
    m_debugAction = 0;
    m_startExternalAction = 0;
    m_startRemoteAction = 0;
    m_startRemoteCdbAction = 0;
    m_startRemoteLldbAction = 0;
    m_attachExternalAction = 0;
    m_attachCoreAction = 0;
    m_attachTcfAction = 0;
    m_detachAction = 0;
1109
1110

    m_commonOptionsPage = 0;
1111
1112
}

1113
1114
DebuggerPluginPrivate::~DebuggerPluginPrivate()
{