debuggerplugin.cpp 136 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
**
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
29
** Nokia at qt-info@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/id.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/abi.h>
hjk's avatar
hjk committed
92
93
#include <projectexplorer/applicationrunconfiguration.h>
#include <projectexplorer/buildconfiguration.h>
con's avatar
con committed
94
#include <projectexplorer/projectexplorerconstants.h>
95
96
97
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/projectexplorersettings.h>
#include <projectexplorer/project.h>
con's avatar
con committed
98
#include <projectexplorer/session.h>
99
#include <projectexplorer/target.h>
100
101
#include <projectexplorer/toolchain.h>
#include <projectexplorer/toolchainmanager.h>
hjk's avatar
hjk committed
102

103
#include <qtsupport/qtsupportconstants.h>
104

hjk's avatar
hjk committed
105
#include <texteditor/basetexteditor.h>
106
#include <texteditor/fontsettings.h>
107
#include <texteditor/texteditorsettings.h>
hjk's avatar
hjk committed
108
109

#include <utils/qtcassert.h>
110
#include <utils/savedaction.h>
111
#include <utils/styledbar.h>
112
#include <utils/proxyaction.h>
113
#include <utils/statuslabel.h>
114
#include <utils/fileutils.h>
con's avatar
con committed
115

116
#include <qml/qmljsscriptconsole.h>
117

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

hjk's avatar
hjk committed
132
133
134
135
136
137
#ifdef WITH_TESTS
#include <QtTest/QTest>
#include <QtTest/QSignalSpy>
#include <QtTest/QTestEventLoop>
#endif

138
139
#include <climits>

140
141
142
143
144
145
146
147
148
149
#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

150
151
152
153
154
155
156
157
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
158
    \internal
159
160
161
162
163
164
165
166
*/

/*!
    \class Debugger::DebuggerEngine

    \brief Base class of a debugger engine.

    Note: the Debugger process itself and any helper processes like
Pawel Polanski's avatar
Pawel Polanski committed
167
    gdbserver, the CODA client etc are referred to as 'Engine',
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
    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
285

286
287
288
/* 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
289

290
291
292
293
294
295
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" ];
296
sg1:   InferiorSetupRequested -> InferiorSetupOk [ label="notifyInferiorSetupOk", style="dashed" ];
297
sg1:   InferiorSetupRequested -> InferiorSetupFailed [ label="notifyInferiorFailed", style="dashed" ];
298
sg1:   InferiorSetupOk -> EngineRunRequested
299
300
301
302
303
304
305
306
307
308
309
310
311
312
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
313
314
sg1:   InferiorStopOk -> InferiorShutdownRequested [ label="Close event" ];
sg1:   InferiorUnrunnable -> InferiorShutdownRequested [ label="Close event" ];
315
316
sg1:   InferiorShutdownRequested -> InferiorShutdownOk [ label= "Engine::shutdownInferior\nnotifyInferiorShutdownOk", style="dashed" ];
sg1:   InferiorShutdownRequested -> InferiorShutdownFailed [ label="Engine::shutdownInferior\nnotifyInferiorShutdownFailed", style="dashed" ];
317
318
sg1:   InferiorExited -> InferiorExitOk [ label="notifyInferiorExited", style="dashed"];
sg1:   InferiorExitOk -> InferiorShutdownOk
319
320
321
322
323
324
325
326
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
327
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
328
329


330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
/*!
    \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}
352
353
354



355
356
357
358
359
360
361
362
363
364
365
                GdbEngine::setupInferior()
                          +
            (calls *Adapter->prepareInferior())
                          |      |
                          |      `---> handlePrepareInferiorFailed()
                          |                   +
                          |             {notifyInferiorSetupFailed}
                          |
                handleInferiorPrepared()
                          +
                {notifyInferiorSetupOk}
366

367
\endcode */
368

con's avatar
con committed
369
using namespace Core;
hjk's avatar
hjk committed
370
using namespace Debugger::Constants;
con's avatar
con committed
371
using namespace ProjectExplorer;
hjk's avatar
hjk committed
372
using namespace TextEditor;
373
using namespace ExtensionSystem;
con's avatar
con committed
374

hjk's avatar
hjk committed
375
376
377
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
378
379
380
381

namespace Debugger {
namespace Constants {

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
382
#ifdef Q_WS_MAC
hjk's avatar
hjk committed
383
384
385
386
387
388
389
390
391
392
393
394
395
396
const char STOP_KEY[]                     = "Shift+Ctrl+Y";
const char RESET_KEY[]                    = "Ctrl+Shift+F5";
const char STEP_KEY[]                     = "Ctrl+Shift+I";
const char STEPOUT_KEY[]                  = "Ctrl+Shift+T";
const char NEXT_KEY[]                     = "Ctrl+Shift+O";
const char REVERSE_KEY[]                  = "";
const char RUN_TO_LINE_KEY[]              = "Shift+F8";
const char RUN_TO_SELECTED_FUNCTION_KEY[] = "Ctrl+F6";
const char JUMP_TO_LINE_KEY[]             = "Ctrl+D,Ctrl+L";
const char TOGGLE_BREAK_KEY[]             = "F8";
const char BREAK_BY_FUNCTION_KEY[]        = "Ctrl+D,Ctrl+F";
const char BREAK_AT_MAIN_KEY[]            = "Ctrl+D,Ctrl+M";
const char ADD_TO_WATCH_KEY[]             = "Ctrl+D,Ctrl+W";
const char SNAPSHOT_KEY[]                 = "Ctrl+D,Ctrl+S";
con's avatar
con committed
397
#else
hjk's avatar
hjk committed
398
399
400
401
402
403
const char STOP_KEY[]                     = "Shift+F5";
const char RESET_KEY[]                    = "Ctrl+Shift+F5";
const char STEP_KEY[]                     = "F11";
const char STEPOUT_KEY[]                  = "Shift+F11";
const char NEXT_KEY[]                     = "F10";
const char REVERSE_KEY[]                  = "F12";
404
const char RUN_TO_LINE_KEY[]              = "Ctrl+F10";
hjk's avatar
hjk committed
405
406
407
408
409
410
411
const char RUN_TO_SELECTED_FUNCTION_KEY[] = "Ctrl+F6";
const char JUMP_TO_LINE_KEY[]             = "";
const char TOGGLE_BREAK_KEY[]             = "F9";
const char BREAK_BY_FUNCTION_KEY[]        = "";
const char BREAK_AT_MAIN_KEY[]            = "";
const char ADD_TO_WATCH_KEY[]             = "Ctrl+Alt+Q";
const char SNAPSHOT_KEY[]                 = "Ctrl+D,Ctrl+S";
con's avatar
con committed
412
413
414
415
416
#endif

} // namespace Constants


417
418
namespace Internal {

419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
// To be passed through margin menu action's data
struct BreakpointMenuContextData : public ContextData
{
    enum Mode
    {
        Breakpoint,
        MessageTracePoint
    };

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

} // namespace Internal
} // namespace Debugger

Q_DECLARE_METATYPE(Debugger::Internal::BreakpointMenuContextData)

namespace Debugger {
namespace Internal {

440
441
442
443
444
445
// 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.

446
void addCdbOptionPages(QList<IOptionsPage*> *opts);
447
448
449
void addGdbOptionPages(QList<IOptionsPage*> *opts);
void addScriptOptionPages(QList<IOptionsPage*> *opts);
void addTcfOptionPages(QList<IOptionsPage*> *opts);
450

451
452
453
454
#ifdef WITH_LLDB
void addLldbOptionPages(QList<IOptionsPage*> *opts);
#endif

hjk's avatar
hjk committed
455
static SessionManager *sessionManager()
456
{
hjk's avatar
hjk committed
457
    return ProjectExplorerPlugin::instance()->session();
458
459
}

460
461
462
463
464
465
466
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

467
static Abi anyAbiOfBinary(const QString &fileName)
468
{
Tobias Hunger's avatar
Tobias Hunger committed
469
    QList<Abi> abis = Abi::abisOfBinary(Utils::FileName::fromString(fileName));
470
471
472
473
    if (abis.isEmpty())
        return Abi();
    return abis.at(0);
}
474
475
476
477
478
479
480
481
482
483
484
485

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

public:
486
    DummyEngine() : DebuggerEngine(DebuggerStartParameters(), AnyLanguage) {}
487
488
489
490
491
492
493
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
494
    bool hasCapability(unsigned cap) const;
495
    bool acceptsBreakpoint(BreakpointModelId) const { return false; }
496
    bool acceptsDebuggerCommands() const { return false; }
497
498
};

499
bool DummyEngine::hasCapability(unsigned cap) const
500
501
502
503
504
505
506
507
508
509
510
511
{
    // This can only be a first approximation of what to expect when running.
    Project *project = ProjectExplorerPlugin::instance()->currentProject();
    if (!project)
        return 0;
    Target *target = project->activeTarget();
    QTC_ASSERT(target, return 0);
    RunConfiguration *activeRc = target->activeRunConfiguration();
    QTC_ASSERT(activeRc, return 0);

    // This is a non-started Cdb or Gdb engine:
    if (activeRc->useCppDebugger())
512
        return cap & (WatchpointByAddressCapability
513
514
               | BreakConditionCapability
               | TracePointCapability
515
               | OperateByInstructionCapability);
516
517

    // This is a Qml or unknown engine.
518
    return cap & AddWatcherCapability;
519
520
}

521
522
523
524
525
526
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

527
class DebugMode : public IMode
hjk's avatar
hjk committed
528
529
{
public:
530
531
532
533
    DebugMode()
    {
        setObjectName(QLatin1String("DebugMode"));
        setContext(Context(CC::C_EDITORMANAGER, C_DEBUGMODE, CC::C_NAVIGATION_PANE));
534
535
        setDisplayName(DebuggerPlugin::tr("Debug"));
        setIcon(QIcon(QLatin1String(":/fancyactionbar/images/mode_Debug.png")));
536
        setPriority(85);
537
538
        setId(QLatin1String(MODE_DEBUG));
        setType(QLatin1String(CC::MODE_EDIT_TYPE));
539
    }
hjk's avatar
hjk committed
540

hjk's avatar
hjk committed
541
542
543
544
545
546
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        //EditorManager::instance()->setParent(0);
        delete m_widget;
    }
547
};
hjk's avatar
hjk committed
548

549
550
551
552
553
554
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

555
static TextEditor::ITextEditor *currentTextEditor()
556
{
557
558
559
560
561
    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
562

563
564
static bool currentTextEditorPosition(ContextData *data)
{
565
566
567
568
569
570
571
572
573
574
575
576
577
    TextEditor::ITextEditor *textEditor = currentTextEditor();
    if (!textEditor)
        return false;
    const Core::IFile *file = textEditor->file();
    QTC_ASSERT(file, return false);
    data->fileName = file->fileName();
    if (textEditor->property("DisassemblerView").toBool()) {
        int lineNumber = textEditor->currentLine();
        QString line = textEditor->contents()
            .section(QLatin1Char('\n'), lineNumber - 1, lineNumber - 1);
        data->address = DisassemblerLine::addressFromDisassemblyLine(line);
    } else {
        data->lineNumber = textEditor->currentLine();
578
    }
579
    return true;
580
}
581

582
583
///////////////////////////////////////////////////////////////////////
//
584
// DebuggerPluginPrivate
585
586
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
587

588
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
589

590
591
592
593
594
595
596
597
598
599
600
601
602
603
/*!
    \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.
*/

604
class DebuggerPluginPrivate : public DebuggerCore
605
606
{
    Q_OBJECT
607

608
609
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
610
    ~DebuggerPluginPrivate();
611

612
    bool initialize(const QStringList &arguments, QString *errorMessage);
613
614
615
    void extensionsInitialized();
    void aboutToShutdown();

616
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
617
    void disconnectEngine() { connectEngine(0); }
618
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
619
    DebuggerEngine *dummyEngine();
620

621
622
623
624
625
626
627
628
629
630
    void setThreads(const QStringList &list, int index)
    {
        const bool state = m_threadBox->blockSignals(true);
        m_threadBox->clear();
        foreach (const QString &item, list)
            m_threadBox->addItem(item);
        m_threadBox->setCurrentIndex(index);
        m_threadBox->blockSignals(state);
    }

631
public slots:
632
633
634
635
636
637
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

638
639
640
641
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
642

hjk's avatar
hjk committed
643
    void breakpointSetMarginActionTriggered()
644
    {
645
646
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
hjk's avatar
hjk committed
647
648
        const BreakpointMenuContextData data =
            action->data().value<BreakpointMenuContextData>();
649
650
651
652
653
654
655
656
657
658
659
660
661
        QString message;
        if (data.mode == BreakpointMenuContextData::MessageTracePoint) {
            if (data.address) {
                //: Message tracepoint: Address hit.
                message = tr("0x%1 hit").arg(data.address, 0, 16);
            } else {
                //: Message tracepoint: %1 file, %2 line %3 function hit.
                message = tr("%1:%2 %3() hit").arg(QFileInfo(data.fileName).fileName()).
                        arg(data.lineNumber).
                        arg(cppFunctionAt(data.fileName, data.lineNumber));
            }
            QInputDialog dialog; // Create wide input dialog.
            dialog.setWindowFlags(dialog.windowFlags()
hjk's avatar
hjk committed
662
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
663
664
665
666
667
668
669
670
            dialog.resize(600, dialog.height());
            dialog.setWindowTitle(tr("Add Message Tracepoint"));
            dialog.setLabelText (tr("Message:"));
            dialog.setTextValue(message);
            if (dialog.exec() != QDialog::Accepted || dialog.textValue().isEmpty())
                return;
            message = dialog.textValue();
        }
671
        if (data.address)
672
            toggleBreakpointByAddress(data.address, message);
673
        else
674
            toggleBreakpointByFileAndLine(data.fileName, data.lineNumber, message);
675
    }
676

hjk's avatar
hjk committed
677
    void breakpointRemoveMarginActionTriggered()
678
    {
hjk's avatar
hjk committed
679
680
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
681
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
682
        m_breakHandler->removeBreakpoint(id);
hjk's avatar
hjk committed
683
684
685
686
687
688
     }

    void breakpointEnableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
689
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
690
        breakHandler()->setEnabled(id, true);
hjk's avatar
hjk committed
691
692
693
694
695
696
    }

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

701
    void updateWatchersHeader(int section, int, int newSize)
702
703
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
704
        m_returnWindow->header()->resizeSection(section, newSize);
705
    }
706

707

708
    void sourceFilesDockToggled(bool on)
709
    {
710
        if (on && m_currentEngine->state() == InferiorStopOk)
711
712
713
            m_currentEngine->reloadSourceFiles();
    }

714
    void modulesDockToggled(bool on)
715
    {
716
        if (on && m_currentEngine->state() == InferiorStopOk)
717
718
            m_currentEngine->reloadModules();
    }
719

hjk's avatar
hjk committed
720
    void registerDockToggled(bool on)
721
    {
722
        if (on && m_currentEngine->state() == InferiorStopOk)
723
724
            m_currentEngine->reloadRegisters();
    }
725

726
727
    void synchronizeBreakpoints()
    {
728
        showMessage(QLatin1String("ATTEMPT SYNC"), LogDebug);
729
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
730
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
731
732
733
734
                engine->attemptBreakpointSynchronization();
        }
    }

hjk's avatar
hjk committed
735
736
737
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
738
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
739
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
740
741
742
        }
    }

743
    void editorOpened(Core::IEditor *editor);
744
    void updateBreakMenuItem(Core::IEditor *editor);
745
    void setBusyCursor(bool busy);
746
747
748
    void requestMark(TextEditor::ITextEditor *editor,
                     int lineNumber,
                     TextEditor::ITextEditor::MarkRequestKind kind);
749
750
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
751

752
753
754
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
755
756
757
758
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
759
    void onModeChanged(Core::IMode *mode);
760
    void onCoreAboutToOpen();
761
    void showSettingsDialog();
762
    void updateDebugWithoutDeployMenu();
763

764
    void debugProject();
765
    void debugProjectWithoutDeploy();
766
    void debugProjectBreakMain();
767
    void startExternalApplication();
768
    void startRemoteCdbSession();
769
770
    void startRemoteProcess();
    void startRemoteServer();
771
    bool queryRemoteParameters(DebuggerStartParameters &sp, bool useScript);
772
    void attachToRemoteServer();
773
    void attachToRemoteProcess();
774
    void attachToQmlPort();
775
    void startRemoteEngine();
776
    void attachExternalApplication();
777
    Q_SLOT void attachExternalApplication(ProjectExplorer::RunControl *rc);
778
    void runScheduled();
779
    void attachCore();
780
    void attachToRemoteServer(const QString &spec);
781

782
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
783
    void languagesChanged();
784
    void showStatusMessage(const QString &msg, int timeout = -1);
785
    void openMemoryEditor();
786

787
788
789
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

    void showQtDumperLibraryWarning(const QString &details);
hjk's avatar
hjk committed
790
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
791
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
792
        { return mainWindow()->isDockVisible(objectName); }
793
794

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

797
798
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
799
    DebuggerLanguages activeLanguages() const;
800
801
    unsigned enabledEngines() const { return m_cmdLineEnabledEngines; }
    QString debuggerForAbi(const Abi &abi, DebuggerEngineType et = NoEngineType) const;
802
803
804
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
805

806
807
808
809
810
    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;
811

ck's avatar
ck committed
812
    DebuggerRunControl *createDebugger(const DebuggerStartParameters &sp,
hjk's avatar
hjk committed
813
814
        RunConfiguration *rc = 0);
    void startDebugger(RunControl *runControl);
815
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
816
817
818

    void dumpLog();
    void cleanupViews();
819
    void setInitialState();
820
821
822
823

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

    void updateState(DebuggerEngine *engine);
824
    void updateWatchersWindow();
825
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
826
827
828
829

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
830

831
    void executeDebuggerCommand(const QString &command);
832
    void evaluateExpression(const QString &expression);
833
    void coreShutdown();
834

hjk's avatar
hjk committed
835
836
837
838
839
840
841
842
#ifdef WITH_TESTS
public slots:
    void testStuff(int testCase);
    void testProjectLoaded(ProjectExplorer::Project *project);
    void testRunControlFinished();
#endif


hjk's avatar
hjk committed
843
public slots:
844
    void updateDebugActions();
845
846
847

    void handleExecDetach()
    {
848
        currentEngine()->resetLocation();
849
850
851
852
853
        currentEngine()->detachDebugger();
    }

    void handleExecContinue()
    {
854
        currentEngine()->resetLocation();
855
856
857
858
859
        currentEngine()->continueInferior();
    }

    void handleExecInterrupt()
    {
860
        currentEngine()->resetLocation();
861
862
863
        currentEngine()->requestInterruptInferior();
    }

864
    void handleAbort()
865
    {
866
        currentEngine()->resetLocation();
867
        currentEngine()->abortDebugger();
868
    }
hjk's avatar
hjk committed
869
870
871

    void handleExecStep()
    {
872
873
874
875
876
877
878
879
880
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeStepI();
            else
                currentEngine()->executeStep();
        }
hjk's avatar
hjk committed
881
882
883
884
    }

    void handleExecNext()
    {
885
886
887
888
889
890
891
892
893
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeNextI();
            else
                currentEngine()->executeNext();
        }
hjk's avatar
hjk committed
894
895
    }

896
897
    void handleExecStepOut()
    {
898
        currentEngine()->resetLocation();
899
900
901
902
903
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
904
        currentEngine()->resetLocation();
905
906
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
907
908
909
910

    void handleExecJumpToLine()
    {
        //removeTooltip();
911
        currentEngine()->resetLocation();
912
913
914
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeJumpToLine(data);
hjk's avatar
hjk committed
915
916
917
918
919
    }

    void handleExecRunToLine()
    {
        //removeTooltip();
920
        currentEngine()->resetLocation();
921
922
923
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeRunToLine(data);
hjk's avatar
hjk committed
924
925
    }

926
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
927
    {
928
929
930
931
932
933
934
935
936
937
        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();
938
            foreach (const QString &str, line.trimmed().split(QLatin1Char('('))) {
939
940
941
942
943
944
945
946
947
948
949
950
951
                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;
                }
            }
        }

952
953
954
955
956
957
        if (functionName.isEmpty()) {
            showStatusMessage(tr("No function selected."));
        } else {
            showStatusMessage(tr("Running to function \"%1\".")
                .arg(functionName));
            currentEngine()->resetLocation();
958
            currentEngine()->executeRunToFunction(functionName);
959
        }
hjk's avatar
hjk committed
960
961
    }

962
963
964
965
    void slotEditBreakpoint()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
966
        const BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
967
968
        QTC_ASSERT(id > 0, return);
        BreakWindow::editBreakpoint(id, mainWindow());
969
970
971
972
    }

    void slotRunToLine()
    {
973
974
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
975
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
976
        currentEngine()->executeRunToLine(data);
977
978
979
980
    }

    void slotJumpToLine()
    {
981
982
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
983
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
984
        currentEngine()->executeJumpToLine(data);
985
986
    }

hjk's avatar
hjk committed
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
    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()
    {
1017
        currentEngine()->exitDebugger();
hjk's avatar
hjk committed
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
    }

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

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

1030
    void handleOperateByInstructionTriggered(bool operateByInstructionTriggered)
hjk's avatar
hjk committed
1031
    {
1032
1033
1034
        // Go to source only if we have the file.
        if (currentEngine()->stackHandler()->currentIndex() >= 0) {
            const StackFrame frame = currentEngine()->stackHandler()->currentFrame();
1035
1036
1037
            if (operateByInstructionTriggered || frame.isUsable()) {
                currentEngine()->gotoLocation(Location(frame, true));
            }
1038
        }
hjk's avatar
hjk committed
1039
1040
    }

1041
    bool isActiveDebugLanguage(int lang) const
hjk's avatar
hjk committed
1042
    {
1043
        return m_mainWindow->activeDebugLanguages() & lang;
hjk's avatar
hjk committed
1044
1045
    }

1046
1047
1048
1049
1050
1051
1052
1053
    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
1054
1055
1056
1057
    Utils::SavedAction *action(int code) const;
    bool boolSetting(int code) const;
    QString stringSetting(int code) const;

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

1060
1061
1062
1063
1064
1065
    bool parseArgument(QStringList::const_iterator &it,
        const QStringList::const_iterator &cend,
        unsigned *enabledEngines, QString *errorMessage);
    bool parseArguments(const QStringList &args,
        unsigned *enabledEngines, QString *errorMessage);

1066
    DebuggerToolTipManager *toolTipManager() const { return m_toolTipManager; }
1067
    virtual QSharedPointer<GlobalDebuggerOptions> globalDebuggerOptions() const { return m_globalDebuggerOptions; }
1068

1069
1070
1071
    // FIXME: Remove.
    void maybeEnrichParameters(DebuggerStartParameters *sp);

1072
1073
    void gdbServerStarted(const QString &channel, const QString &sysroot, const QString &localExecutable);

1074
public:
1075
    DebuggerMainWindow *m_mainWindow;
1076
1077
1078
    DebuggerRunControlFactory *m_debuggerRunControlFactory;

    QString m_previousMode;
1079
    QList<DebuggerStartParameters> m_scheduledStarts;
1080

hjk's avatar
hjk committed
1081
1082
1083
    Utils::ProxyAction *m_visibleStartAction;
    Utils::ProxyAction *m_hiddenStopAction;
    QAction *m_startAction;
1084
    QAction *m_debugWithoutDeployAction;
1085
    QAction *m_startLocalProcessAction;
1086
    QAction *m_startRemoteProcessAction;
1087
1088
    QAction *m_startRemoteServerAction;
    QAction *m_attachToRemoteProcessAction;
1089
    QAction *m_attachToQmlPortAction;
1090
    QAction *m_attachToRemoteServerAction;
1091
    QAction *m_startRemoteCdbAction;
1092
    QAction *m_startRemoteLldbAction;
1093
    QAction *m_attachToLocalProcessAction;
1094
    QAction *m_attachToCoreAction;
1095
    QAction *m_detachAction;
1096
1097
1098
1099
    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
hjk's avatar