debuggerplugin.cpp 133 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>
con's avatar
con committed
92
#include <projectexplorer/projectexplorerconstants.h>
93
94
95
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/projectexplorersettings.h>
#include <projectexplorer/project.h>
con's avatar
con committed
96
#include <projectexplorer/session.h>
97
#include <projectexplorer/target.h>
98
99
#include <projectexplorer/toolchain.h>
#include <projectexplorer/toolchainmanager.h>
hjk's avatar
hjk committed
100

101
#include <qtsupport/qtsupportconstants.h>
102

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

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

114
#include <qml/qmljsscriptconsole.h>
115

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

130
131
#include <climits>

132
133
134
135
136
137
138
139
140
141
#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

142
143
144
145
146
147
148
149
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
150
    \internal
151
152
153
154
155
156
157
158
*/

/*!
    \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
159
    gdbserver, the CODA client etc are referred to as 'Engine',
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
274
275
276
    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
277

278
279
280
/* 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
281

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


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



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

359
\endcode */
360

con's avatar
con committed
361
using namespace Core;
hjk's avatar
hjk committed
362
using namespace Debugger::Constants;
con's avatar
con committed
363
using namespace ProjectExplorer;
hjk's avatar
hjk committed
364
using namespace TextEditor;
365
using namespace ExtensionSystem;
con's avatar
con committed
366

hjk's avatar
hjk committed
367
368
369
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
370
371
372
373

namespace Debugger {
namespace Constants {

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
374
#ifdef Q_WS_MAC
hjk's avatar
hjk committed
375
376
377
378
379
380
381
382
383
384
385
386
387
388
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
389
#else
hjk's avatar
hjk committed
390
391
392
393
394
395
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";
396
const char RUN_TO_LINE_KEY[]              = "Ctrl+F10";
hjk's avatar
hjk committed
397
398
399
400
401
402
403
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
404
405
406
407
408
#endif

} // namespace Constants


409
410
namespace Internal {

411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
// 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 {

432
433
434
435
436
437
// 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.

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

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

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

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

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

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

class DummyEngine : public DebuggerEngine
{
    Q_OBJECT

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

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

491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
unsigned DummyEngine::debuggerCapabilities() const
{
    // 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())
        return WatchpointByAddressCapability
               | BreakConditionCapability
               | TracePointCapability
               | OperateByInstructionCapability;

    // This is a Qml or unknown engine.
    return AddWatcherCapability;
}

513
514
515
516
517
518
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

519
class DebugMode : public IMode
hjk's avatar
hjk committed
520
521
{
public:
522
523
524
525
    DebugMode()
    {
        setObjectName(QLatin1String("DebugMode"));
        setContext(Context(CC::C_EDITORMANAGER, C_DEBUGMODE, CC::C_NAVIGATION_PANE));
526
527
        setDisplayName(DebuggerPlugin::tr("Debug"));
        setIcon(QIcon(QLatin1String(":/fancyactionbar/images/mode_Debug.png")));
528
        setPriority(85);
529
530
        setId(QLatin1String(MODE_DEBUG));
        setType(QLatin1String(CC::MODE_EDIT_TYPE));
531
    }
hjk's avatar
hjk committed
532

hjk's avatar
hjk committed
533
534
535
536
537
538
    ~DebugMode()
    {
        // Make sure the editor manager does not get deleted.
        //EditorManager::instance()->setParent(0);
        delete m_widget;
    }
539
};
hjk's avatar
hjk committed
540

541
542
543
544
545
546
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

547
static TextEditor::ITextEditor *currentTextEditor()
548
{
549
550
551
552
553
    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
554

555
556
557
558
559
560
561
562
563
564
565
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;
}
566

567
568
///////////////////////////////////////////////////////////////////////
//
569
// DebuggerPluginPrivate
570
571
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
572

573
static DebuggerPluginPrivate *theDebuggerCore = 0;
con's avatar
con committed
574

575
576
577
578
579
580
581
582
583
584
585
586
587
588
/*!
    \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.
*/

589
class DebuggerPluginPrivate : public DebuggerCore
590
591
{
    Q_OBJECT
592

593
594
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
595
    ~DebuggerPluginPrivate();
596

597
    bool initialize(const QStringList &arguments, QString *errorMessage);
598
599
600
    void extensionsInitialized();
    void aboutToShutdown();

601
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
602
    void disconnectEngine() { connectEngine(0); }
603
    DebuggerEngine *currentEngine() const { return m_currentEngine; }
604
    DebuggerEngine *dummyEngine();
605

606
607
608
609
610
611
612
613
614
615
    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);
    }

616
public slots:
617
618
619
620
621
622
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

623
624
625
626
    void selectThread(int index)
    {
        currentEngine()->selectThread(index);
    }
627

hjk's avatar
hjk committed
628
    void breakpointSetMarginActionTriggered()
629
    {
630
631
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
hjk's avatar
hjk committed
632
633
        const BreakpointMenuContextData data =
            action->data().value<BreakpointMenuContextData>();
634
635
636
637
638
639
640
641
642
643
644
645
646
        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
647
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
648
649
650
651
652
653
654
655
            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();
        }
656
        if (data.address)
657
            toggleBreakpointByAddress(data.address, message);
658
        else
659
            toggleBreakpointByFileAndLine(data.fileName, data.lineNumber, message);
660
    }
661

hjk's avatar
hjk committed
662
    void breakpointRemoveMarginActionTriggered()
663
    {
hjk's avatar
hjk committed
664
665
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
666
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
667
        m_breakHandler->removeBreakpoint(id);
hjk's avatar
hjk committed
668
669
670
671
672
673
     }

    void breakpointEnableMarginActionTriggered()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
674
        BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
675
        breakHandler()->setEnabled(id, true);
hjk's avatar
hjk committed
676
677
678
679
680
681
    }

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

686
    void updateWatchersHeader(int section, int, int newSize)
687
688
    {
        m_watchersWindow->header()->resizeSection(section, newSize);
689
        m_returnWindow->header()->resizeSection(section, newSize);
690
    }
691

692

693
    void sourceFilesDockToggled(bool on)
694
    {
695
        if (on && m_currentEngine->state() == InferiorStopOk)
696
697
698
            m_currentEngine->reloadSourceFiles();
    }

699
    void modulesDockToggled(bool on)
700
    {
701
        if (on && m_currentEngine->state() == InferiorStopOk)
702
703
            m_currentEngine->reloadModules();
    }
704

hjk's avatar
hjk committed
705
    void registerDockToggled(bool on)
706
    {
707
        if (on && m_currentEngine->state() == InferiorStopOk)
708
709
            m_currentEngine->reloadRegisters();
    }
710

711
712
    void synchronizeBreakpoints()
    {
713
        showMessage(QLatin1String("ATTEMPT SYNC"), LogDebug);
714
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
715
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
716
717
718
719
                engine->attemptBreakpointSynchronization();
        }
    }

hjk's avatar
hjk committed
720
721
722
    void synchronizeWatchers()
    {
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
723
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
724
                engine->watchHandler()->updateWatchers();
hjk's avatar
hjk committed
725
726
727
        }
    }

728
    void editorOpened(Core::IEditor *editor);
729
    void updateBreakMenuItem(Core::IEditor *editor);
730
    void setBusyCursor(bool busy);
731
732
733
    void requestMark(TextEditor::ITextEditor *editor,
                     int lineNumber,
                     TextEditor::ITextEditor::MarkRequestKind kind);
734
735
    void requestContextMenu(TextEditor::ITextEditor *editor,
        int lineNumber, QMenu *menu);
736

737
738
739
    void activatePreviousMode();
    void activateDebugMode();
    void toggleBreakpoint();
740
741
742
743
    void toggleBreakpointByFileAndLine(const QString &fileName, int lineNumber,
                                       const QString &tracePointMessage = QString());
    void toggleBreakpointByAddress(quint64 address,
                                   const QString &tracePointMessage = QString());
744
    void onModeChanged(Core::IMode *mode);
745
    void onCoreAboutToOpen();
746
    void showSettingsDialog();
747
    void updateDebugWithoutDeployMenu();
748

749
    void debugProject();
750
    void debugProjectWithoutDeploy();
751
    void debugProjectBreakMain();
752
    void startExternalApplication();
753
    void startRemoteCdbSession();
754
755
    void startRemoteProcess();
    void startRemoteServer();
756
    bool queryRemoteParameters(DebuggerStartParameters &sp, bool useScript);
757
    void attachToRemoteServer();
758
    void attachToRemoteProcess();
759
    void attachToQmlPort();
760
    void startRemoteEngine();
761
    void attachExternalApplication();
762
    Q_SLOT void attachExternalApplication(ProjectExplorer::RunControl *rc);
763
    void runScheduled();
764
    void attachCore();
765
    void attachToRemoteServer(const QString &spec);
766

767
    void enableReverseDebuggingTriggered(const QVariant &value);
hjk's avatar
hjk committed
768
    void languagesChanged();
769
    void showStatusMessage(const QString &msg, int timeout = -1);
770
    void openMemoryEditor();
771

772
773
774
    const CPlusPlus::Snapshot &cppCodeModelSnapshot() const;

    void showQtDumperLibraryWarning(const QString &details);
hjk's avatar
hjk committed
775
    DebuggerMainWindow *mainWindow() const { return m_mainWindow; }
776
    bool isDockVisible(const QString &objectName) const
hjk's avatar
hjk committed
777
        { return mainWindow()->isDockVisible(objectName); }
778
779

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

782
783
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
784
    DebuggerLanguages activeLanguages() const;
785
786
    unsigned enabledEngines() const { return m_cmdLineEnabledEngines; }
    QString debuggerForAbi(const Abi &abi, DebuggerEngineType et = NoEngineType) const;
787
788
789
    void remoteCommand(const QStringList &options, const QStringList &);

    bool isReverseDebugging() const;
790

791
792
793
794
795
    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;
796

ck's avatar
ck committed
797
    DebuggerRunControl *createDebugger(const DebuggerStartParameters &sp,
hjk's avatar
hjk committed
798
799
        RunConfiguration *rc = 0);
    void startDebugger(RunControl *runControl);
800
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
801
802
803

    void dumpLog();
    void cleanupViews();
804
    void setInitialState();
805
806
807
808

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

    void updateState(DebuggerEngine *engine);
809
    void updateWatchersWindow();
810
    void onCurrentProjectChanged(ProjectExplorer::Project *project);
811
812
813
814

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
815

816
    void executeDebuggerCommand(const QString &command);
817
    void evaluateExpression(const QString &expression);
818
    void coreShutdown();
819

hjk's avatar
hjk committed
820
public slots:
821
    void updateDebugActions();
822
823
824

    void handleExecDetach()
    {
825
        currentEngine()->resetLocation();
826
827
828
829
830
        currentEngine()->detachDebugger();
    }

    void handleExecContinue()
    {
831
        currentEngine()->resetLocation();
832
833
834
835
836
        currentEngine()->continueInferior();
    }

    void handleExecInterrupt()
    {
837
        currentEngine()->resetLocation();
838
839
840
        currentEngine()->requestInterruptInferior();
    }

841
    void handleAbort()
842
    {
843
        currentEngine()->resetLocation();
844
        currentEngine()->abortDebugger();
845
    }
hjk's avatar
hjk committed
846
847
848

    void handleExecStep()
    {
849
850
851
852
853
854
855
856
857
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeStepI();
            else
                currentEngine()->executeStep();
        }
hjk's avatar
hjk committed
858
859
860
861
    }

    void handleExecNext()
    {
862
863
864
865
866
867
868
869
870
        if (currentEngine()->state() == DebuggerNotReady) {
            debugProjectBreakMain();
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeNextI();
            else
                currentEngine()->executeNext();
        }
hjk's avatar
hjk committed
871
872
    }

873
874
    void handleExecStepOut()
    {
875
        currentEngine()->resetLocation();
876
877
878
879
880
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
881
        currentEngine()->resetLocation();
882
883
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
884
885
886
887

    void handleExecJumpToLine()
    {
        //removeTooltip();
888
        currentEngine()->resetLocation();
889
890
891
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeJumpToLine(data);
hjk's avatar
hjk committed
892
893
894
895
896
    }

    void handleExecRunToLine()
    {
        //removeTooltip();
897
        currentEngine()->resetLocation();
898
899
900
        ContextData data;
        if (currentTextEditorPosition(&data))
            currentEngine()->executeRunToLine(data);
hjk's avatar
hjk committed
901
902
    }

903
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
904
    {
905
906
907
908
909
910
911
912
913
914
        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();
915
            foreach (const QString &str, line.trimmed().split(QLatin1Char('('))) {
916
917
918
919
920
921
922
923
924
925
926
927
928
                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;
                }
            }
        }

929
930
931
932
933
934
        if (functionName.isEmpty()) {
            showStatusMessage(tr("No function selected."));
        } else {
            showStatusMessage(tr("Running to function \"%1\".")
                .arg(functionName));
            currentEngine()->resetLocation();
935
            currentEngine()->executeRunToFunction(functionName);
936
        }
hjk's avatar
hjk committed
937
938
    }

939
940
941
942
    void slotEditBreakpoint()
    {
        const QAction *act = qobject_cast<QAction *>(sender());
        QTC_ASSERT(act, return);
943
        const BreakpointModelId id = act->data().value<BreakpointModelId>();
hjk's avatar
hjk committed
944
945
        QTC_ASSERT(id > 0, return);
        BreakWindow::editBreakpoint(id, mainWindow());
946
947
948
949
    }

    void slotRunToLine()
    {
950
951
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
952
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
953
        currentEngine()->executeRunToLine(data);
954
955
956
957
    }

    void slotJumpToLine()
    {
958
959
        const QAction *action = qobject_cast<const QAction *>(sender());
        QTC_ASSERT(action, return);
960
        const BreakpointMenuContextData data = action->data().value<BreakpointMenuContextData>();
961
        currentEngine()->executeJumpToLine(data);
962
963
    }

hjk's avatar
hjk committed
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
    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()
    {
994
        currentEngine()->exitDebugger();
hjk's avatar
hjk committed
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
    }

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

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

1007
    void handleOperateByInstructionTriggered(bool operateByInstructionTriggered)
hjk's avatar
hjk committed
1008
    {
1009
1010
1011
        // Go to source only if we have the file.
        if (currentEngine()->stackHandler()->currentIndex() >= 0) {
            const StackFrame frame = currentEngine()->stackHandler()->currentFrame();
1012
1013
1014
            if (operateByInstructionTriggered || frame.isUsable()) {
                currentEngine()->gotoLocation(Location(frame, true));
            }
1015
        }
hjk's avatar
hjk committed
1016
1017
    }

1018
    bool isActiveDebugLanguage(int lang) const
hjk's avatar
hjk committed
1019
    {
1020
        return m_mainWindow->activeDebugLanguages() & lang;
hjk's avatar
hjk committed
1021
1022
    }

1023
1024
1025
1026
1027
1028
1029
1030
    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
1031
1032
1033
1034
    Utils::SavedAction *action(int code) const;
    bool boolSetting(int code) const;
    QString stringSetting(int code) const;

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

1037
1038
1039
1040
1041
1042
    bool parseArgument(QStringList::const_iterator &it,
        const QStringList::const_iterator &cend,
        unsigned *enabledEngines, QString *errorMessage);
    bool parseArguments(const QStringList &args,
        unsigned *enabledEngines, QString *errorMessage);

1043
    DebuggerToolTipManager *toolTipManager() const { return m_toolTipManager; }
1044
    virtual QSharedPointer<GlobalDebuggerOptions> globalDebuggerOptions() const { return m_globalDebuggerOptions; }
1045

1046
1047
1048
    // FIXME: Remove.
    void maybeEnrichParameters(DebuggerStartParameters *sp);

1049
1050
    void gdbServerStarted(const QString &channel, const QString &sysroot, const QString &localExecutable);

1051
public:
1052
    DebuggerMainWindow *m_mainWindow;
1053
1054
1055
    DebuggerRunControlFactory *m_debuggerRunControlFactory;

    QString m_previousMode;
1056
    QList<DebuggerStartParameters> m_scheduledStarts;
1057

hjk's avatar
hjk committed
1058
1059
1060
    Utils::ProxyAction *m_visibleStartAction;
    Utils::ProxyAction *m_hiddenStopAction;
    QAction *m_startAction;
1061
    QAction *m_debugWithoutDeployAction;
1062
    QAction *m_startLocalProcessAction;
1063
    QAction *m_startRemoteProcessAction;
1064
1065
    QAction *m_startRemoteServerAction;
    QAction *m_attachToRemoteProcessAction;
1066
    QAction *m_attachToQmlPortAction;
1067
    QAction *m_attachToRemoteServerAction;
1068
    QAction *m_startRemoteCdbAction;
1069
    QAction *m_startRemoteLldbAction;
1070
    QAction *m_attachToLocalProcessAction;
1071
    QAction *m_attachToCoreAction;
1072
    QAction *m_detachAction;
1073
1074
1075
1076
    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
1077
    QAction *m_abortAction;