debuggerplugin.cpp 115 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 "disassemblerlines.h"
52
#include "logwindow.h"
53
#include "moduleswindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
54
#include "moduleshandler.h"
55
56
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
57
#include "stackhandler.h"
58
59
60
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
61
#include "watchhandler.h"
62
#include "watchwindow.h"
hjk's avatar
hjk committed
63
#include "watchutils.h"
64
#include "debuggertooltipmanager.h"
65

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

70
#include <coreplugin/actionmanager/actionmanager.h>
71
72
#include <coreplugin/actionmanager/actioncontainer.h>
#include <coreplugin/actionmanager/command.h>
73
#include <coreplugin/uniqueidmanager.h>
74
#include <coreplugin/imode.h>
con's avatar
con committed
75
#include <coreplugin/coreconstants.h>
76
#include <coreplugin/dialogs/ioptionspage.h>
con's avatar
con committed
77
#include <coreplugin/editormanager/editormanager.h>
hjk's avatar
hjk committed
78
#include <coreplugin/findplaceholder.h>
79
#include <coreplugin/icontext.h>
con's avatar
con committed
80
#include <coreplugin/icore.h>
81
#include <coreplugin/imode.h>
82
#include <coreplugin/icorelistener.h>
hjk's avatar
hjk committed
83
#include <coreplugin/minisplitter.h>
con's avatar
con committed
84
#include <coreplugin/modemanager.h>
hjk's avatar
hjk committed
85

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

89
90
#include <extensionsystem/pluginmanager.h>

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

99
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
const char * const STARTEXTERNAL            = "Debugger.StartExternal";
const char * const ATTACHEXTERNAL           = "Debugger.AttachExternal";
const char * const ATTACHCORE               = "Debugger.AttachCore";
const char * const ATTACHREMOTE             = "Debugger.AttachRemote";
const char * const ATTACHREMOTECDB          = "Debugger.AttachRemoteCDB";
const char * const STARTREMOTELLDB          = "Debugger.StartRemoteLLDB";
const char * const DETACH                   = "Debugger.Detach";

hjk's avatar
hjk committed
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
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
484
    unsigned debuggerCapabilities() const { return AddWatcherCapability; }
485
    bool acceptsBreakpoint(BreakpointId) const { return false; }
486
    bool acceptsDebuggerCommands() const { return false; }
487
488
};

489
490
491
492
493
494
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

495
class DebugMode : public IMode
hjk's avatar
hjk committed
496
497
{
public:
498
499
500
501
502
    DebugMode()
    {
        setObjectName(QLatin1String("DebugMode"));
        setContext(Context(CC::C_EDITORMANAGER, C_DEBUGMODE, CC::C_NAVIGATION_PANE));
    }
hjk's avatar
hjk committed
503

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

511
512
513
514
515
    void setWidget(QWidget *widget)
    {
        m_widget = widget;
    }

516
    // IMode
hjk's avatar
hjk committed
517
518
519
520
521
522
    QString displayName() const { return DebuggerPlugin::tr("Debug"); }
    QIcon icon() const { return QIcon(__(":/fancyactionbar/images/mode_Debug.png")); }
    int priority() const { return P_MODE_DEBUG; }
    QString id() const { return MODE_DEBUG; }
    QString type() const { return CC::MODE_EDIT_TYPE; }
    QString contextHelpId() const { return QString(); }
523
};
hjk's avatar
hjk committed
524

525

526
527
528
529
530
531
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

532
static TextEditor::ITextEditor *currentTextEditor()
533
{
534
535
536
537
538
    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
539

540
541
542
543
544
545
546
547
548
549
550
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;
}
551

552
553
///////////////////////////////////////////////////////////////////////
//
554
// DebuggerPluginPrivate
555
556
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
557

558
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
559

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

574
class DebuggerPluginPrivate : public DebuggerCore
575
576
{
    Q_OBJECT
577

578
579
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
580
    ~DebuggerPluginPrivate();
581

582
    bool initialize(const QStringList &arguments, QString *errorMessage);
583
584
585
    void extensionsInitialized();
    void aboutToShutdown();

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

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

598
599
600
601
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
602

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

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

    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);
633
634
    }

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

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

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

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

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

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

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

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

691
    void debugProject();
692
    void startExternalApplication();
693
    void startRemoteCdbSession();
694
    void startRemoteApplication();
695
    void startRemoteEngine();
696
    void attachExternalApplication();
697
    void attachExternalApplication(qint64 pid, const QString &binary,
698
699
                                   const ProjectExplorer::Abi &abi = ProjectExplorer::Abi(),
                                   const QString &debuggerCommand = QString());
700
    void runScheduled();
701
    void attachCore();
702
703
704
    void attachCore(const QString &core, const QString &exeFileName,
                    const ProjectExplorer::Abi &abi = ProjectExplorer::Abi(),
                    const QString &debuggerCommand = QString());
705
    void attachRemote(const QString &spec);
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

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
755

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    QString m_previousMode;
983
    QList<DebuggerStartParameters> m_scheduledStarts;
984

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

1013
1014
    QToolButton *m_reverseToolButton;

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

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

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

    bool m_busy;
    QString m_lastPermanentStatusMessage;

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

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

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

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

1071
1072
    m_plugin = plugin;

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

    m_breakWindow = 0;
1079
    m_breakHandler = 0;
1080
1081
1082
1083
1084
1085
1086
1087
1088
    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;
1089
    m_logWindow = 0;
1090
    m_scriptConsoleWindow = 0;
1091