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

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

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

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

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

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

89
90
#include <extensionsystem/pluginmanager.h>

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

99
#include <qtsupport/qtsupportconstants.h>
100

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

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

112
113
#include <qml/scriptconsole.h>

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

127
128
#include <climits>

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

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

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

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

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

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


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



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

356
\endcode */
357

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

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

con's avatar
con committed
366
367
368
369

namespace Debugger {
namespace Constants {

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

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

hjk's avatar
hjk committed
380
const char * const RUN_TO_LINE              = "Debugger.RunToLine";
381
const char * const RUN_TO_SELECTED_FUNCTION = "Debugger.RunToSelectedFunction";
hjk's avatar
hjk committed
382
const char * const JUMP_TO_LINE             = "Debugger.JumpToLine";
383
384
385
386
387
const char * const RETURN_FROM_FUNCTION     = "Debugger.ReturnFromFunction";
const char * const SNAPSHOT                 = "Debugger.Snapshot";
const char * const TOGGLE_BREAK             = "Debugger.ToggleBreak";
const char * const BREAK_BY_FUNCTION        = "Debugger.BreakByFunction";
const char * const BREAK_AT_MAIN            = "Debugger.BreakAtMain";
388
389
// Don't add '1' to the string as it shows up in the shortcut dialog.
const char * const ADD_TO_WATCH1            = "Debugger.AddToWatch";
390
391
392
const char * const ADD_TO_WATCH2            = "Debugger.AddToWatch2";
const char * const FRAME_UP                 = "Debugger.FrameUp";
const char * const FRAME_DOWN               = "Debugger.FrameDown";
con's avatar
con committed
393

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
394
#ifdef Q_WS_MAC
395
396
397
398
399
400
401
402
403
404
405
406
407
408
const char * const STOP_KEY                     = "Shift+Ctrl+Y";
const char * const RESET_KEY                    = "Ctrl+Shift+F5";
const char * const STEP_KEY                     = "Ctrl+Shift+I";
const char * const STEPOUT_KEY                  = "Ctrl+Shift+T";
const char * const NEXT_KEY                     = "Ctrl+Shift+O";
const char * const REVERSE_KEY                  = "";
const char * const RUN_TO_LINE_KEY              = "Shift+F8";
const char * const RUN_TO_SELECTED_FUNCTION_KEY = "Ctrl+F6";
const char * const JUMP_TO_LINE_KEY             = "Ctrl+D,Ctrl+L";
const char * const TOGGLE_BREAK_KEY             = "F8";
const char * const BREAK_BY_FUNCTION_KEY        = "Ctrl+D,Ctrl+F";
const char * const BREAK_AT_MAIN_KEY            = "Ctrl+D,Ctrl+M";
const char * const ADD_TO_WATCH_KEY             = "Ctrl+D,Ctrl+W";
const char * const SNAPSHOT_KEY                 = "Ctrl+D,Ctrl+S";
con's avatar
con committed
409
#else
410
411
412
413
414
415
416
417
418
419
420
421
422
423
const char * const STOP_KEY                     = "Shift+F5";
const char * const RESET_KEY                    = "Ctrl+Shift+F5";
const char * const STEP_KEY                     = "F11";
const char * const STEPOUT_KEY                  = "Shift+F11";
const char * const NEXT_KEY                     = "F10";
const char * const REVERSE_KEY                  = "F12";
const char * const RUN_TO_LINE_KEY              = "";
const char * const RUN_TO_SELECTED_FUNCTION_KEY = "Ctrl+F6";
const char * const JUMP_TO_LINE_KEY             = "";
const char * const TOGGLE_BREAK_KEY             = "F9";
const char * const BREAK_BY_FUNCTION_KEY        = "";
const char * const BREAK_AT_MAIN_KEY            = "";
const char * const ADD_TO_WATCH_KEY             = "Ctrl+Alt+Q";
const char * const SNAPSHOT_KEY                 = "Ctrl+D,Ctrl+S";
con's avatar
con committed
424
425
426
427
428
#endif

} // namespace Constants


429
430
431
432
433
434
435
436
namespace Internal {

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

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

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

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

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

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

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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

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

496
class DebugMode : public IMode
hjk's avatar
hjk committed
497
498
{
public:
499
500
501
502
    DebugMode()
    {
        setObjectName(QLatin1String("DebugMode"));
        setContext(Context(CC::C_EDITORMANAGER, C_DEBUGMODE, CC::C_NAVIGATION_PANE));
503
504
505
506
507
        setDisplayName(DebuggerPlugin::tr("Debug"));
        setIcon(QIcon(QLatin1String(":/fancyactionbar/images/mode_Debug.png")));
        setPriority(P_MODE_DEBUG);
        setId(MODE_DEBUG);
        setType(CC::MODE_EDIT_TYPE);
508
    }
hjk's avatar
hjk committed
509

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

518

519
520
521
522
523
524
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

525
static TextEditor::ITextEditor *currentTextEditor()
526
{
527
528
529
530
531
    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
532

533
534
535
536
537
538
539
540
541
542
543
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;
}
544

545
546
///////////////////////////////////////////////////////////////////////
//
547
// DebuggerPluginPrivate
548
549
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
550

551
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
552

553
554
555
556
557
558
559
560
561
562
563
564
565
566
/*!
    \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.
*/

567
class DebuggerPluginPrivate : public DebuggerCore
568
569
{
    Q_OBJECT
570

571
572
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
573
    ~DebuggerPluginPrivate();
574

575
    bool initialize(const QStringList &arguments, QString *errorMessage);
576
577
578
    void extensionsInitialized();
    void aboutToShutdown();

579
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
580
    void disconnectEngine() { connectEngine(0); }
581
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
582
    DebuggerEngine *dummyEngine();
583

584
public slots:
585
586
587
588
589
590
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

591
592
593
594
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
595

hjk's avatar
hjk committed
596
    void breakpointSetMarginActionTriggered()
597
    {
598
599
600
601
602
603
604
        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);
605
    }
606

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

    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);
626
627
    }

628
    void updateWatchersHeader(int section, int, int newSize)
629
630
631
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
    }
632

633
    void sourceFilesDockToggled(bool on)
634
    {
635
        if (on && m_currentEngine->state() == InferiorStopOk)
636
637
638
            m_currentEngine->reloadSourceFiles();
    }

639
    void modulesDockToggled(bool on)
640
    {
641
        if (on && m_currentEngine->state() == InferiorStopOk)
642
643
            m_currentEngine->reloadModules();
    }
644

hjk's avatar
hjk committed
645
    void registerDockToggled(bool on)
646
    {
647
        if (on && m_currentEngine->state() == InferiorStopOk)
648
649
            m_currentEngine->reloadRegisters();
    }
650

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

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

668
    void editorOpened(Core::IEditor *editor);
669
    void updateBreakMenuItem(Core::IEditor *editor);
670
671
672
673
    void setBusyCursor(bool busy);
    void requestMark(TextEditor::ITextEditor *editor, int lineNumber);
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
674

675
676
677
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
678
679
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber);
    void toggleBreakpointByAddress(quint64 address);
680
    void onModeChanged(Core::IMode *mode);
681
    void onCoreAboutToOpen();
682
    void showSettingsDialog();
683

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

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

708
709
710
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

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

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

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

    bool isReverseDebugging() const;
726

727
728
729
730
731
    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;
732

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

    void dumpLog();
    void cleanupViews();
740
    void setInitialState();
741
742
743
744

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

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

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
751

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

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

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

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

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

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

    void handleExecStep()
    {
785
786
787
788
789
790
791
792
793
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeStepI();
            else
                currentEngine()->executeStep();
        }
hjk's avatar
hjk committed
794
795
796
797
    }

    void handleExecNext()
    {
798
799
800
801
802
803
804
805
806
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeNextI();
            else
                currentEngine()->executeNext();
        }
hjk's avatar
hjk committed
807
808
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

979
    DebuggerToolTipManager *toolTipManager() const { return m_toolTipManager; }
980
    virtual QSharedPointer<GlobalDebuggerOptions> globalDebuggerOptions() const { return m_globalDebuggerOptions; }
981

982
public:
983
    DebuggerMainWindow *m_mainWindow;
984
985
986
    DebuggerRunControlFactory *m_debuggerRunControlFactory;

    QString m_previousMode;
987
    QList<DebuggerStartParameters> m_scheduledStarts;
988

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

1017
1018
    QToolButton *m_reverseToolButton;

1019
    QIcon m_startIcon;
1020
    QIcon m_exitIcon;
1021
    QIcon m_continueIcon;
1022
1023
1024
    QIcon m_interruptIcon;
    QIcon m_locationMarkIcon;

1025
    Utils::StatusLabel *m_statusLabel;
1026
1027
1028
    QComboBox *m_threadBox;

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

    bool m_busy;
    QString m_lastPermanentStatusMessage;

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

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

1063
DebuggerPluginPrivate::DebuggerPluginPrivate(DebuggerPlugin *plugin) :
1064
    m_toolTipManager(new DebuggerToolTipManager(this)),
1065
1066
    m_dummyEngine(0),
    m_globalDebuggerOptions(new GlobalDebuggerOptions)
1067
{
1068
1069
    qRegisterMetaType<WatchData>("WatchData");
    qRegisterMetaType<ContextData>("ContextData");
1070
    qRegisterMetaType<DebuggerStartParameters>("DebuggerStartParameters");
1071

1072
1073
1074
    QTC_ASSERT(!theDebuggerCore, /**/);
    theDebuggerCore = this;

1075
1076
    m_plugin = plugin;

1077
    m_startRemoteCdbAction = 0;
hjk's avatar
hjk committed
1078
    m_shuttingDown = false;
1079
1080
1081
1082
    m_statusLabel = 0;
    m_threadBox = 0;

    m_breakWindow = 0;
1083
    m_breakHandler = 0;
1084
1085
1086
1087