debuggerplugin.cpp 122 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
Eike Ziller's avatar
Eike Ziller committed
3 4
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
con's avatar
con committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
con's avatar
con committed
7
**
hjk's avatar
hjk committed
8 9 10 11
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
Eike Ziller's avatar
Eike Ziller committed
12 13
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Eike Ziller's avatar
Eike Ziller committed
14
** use the contact form at http://www.qt.io/contact-us.
15
**
16
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18 19 20 21 22 23
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
hjk's avatar
hjk committed
24
**
Eike Ziller's avatar
Eike Ziller committed
25 26
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
con's avatar
con committed
27 28
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
29
****************************************************************************/
hjk's avatar
hjk committed
30

con's avatar
con committed
31 32
#include "debuggerplugin.h"

Friedemann Kleint's avatar
Friedemann Kleint committed
33
#include "debuggerstartparameters.h"
34
#include "debuggeractions.h"
35
#include "debuggerinternalconstants.h"
36
#include "debuggercore.h"
37
#include "debuggerkitconfigwidget.h"
38 39
#include "debuggerdialogs.h"
#include "debuggerengine.h"
40
#include "debuggericons.h"
41
#include "debuggeritemmanager.h"
42
#include "debuggermainwindow.h"
43
#include "debuggerrunconfigurationaspect.h"
44
#include "debuggerruncontrol.h"
45
#include "debuggerstringutils.h"
46
#include "debuggeroptionspage.h"
Tobias Hunger's avatar
Tobias Hunger committed
47
#include "debuggerkitinformation.h"
48
#include "memoryagent.h"
49
#include "breakhandler.h"
50
#include "breakwindow.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 "unstartedappwatcherdialog.h"
65
#include "debuggertooltipmanager.h"
66
#include "localsandexpressionswindow.h"
67
#include "loadcoredialog.h"
68
#include "sourceutils.h"
69
#include <debugger/shared/hostutils.h>
70

71 72
#include "snapshothandler.h"
#include "threadshandler.h"
73
#include "commonoptionspage.h"
74
#include "gdb/startgdbserverdialog.h"
con's avatar
con committed
75

76
#include <coreplugin/actionmanager/actionmanager.h>
77
#include <coreplugin/actionmanager/actioncontainer.h>
78
#include <coreplugin/actionmanager/command.h>
Daniel Teske's avatar
Daniel Teske committed
79
#include <coreplugin/find/itemviewfind.h>
80
#include <coreplugin/imode.h>
81
#include <coreplugin/coreicons.h>
con's avatar
con committed
82
#include <coreplugin/icore.h>
83
#include <coreplugin/messagebox.h>
84
#include <coreplugin/messagemanager.h>
con's avatar
con committed
85
#include <coreplugin/modemanager.h>
86 87
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/editormanager/documentmodel.h>
hjk's avatar
hjk committed
88

con's avatar
con committed
89
#include <cppeditor/cppeditorconstants.h>
90
#include <cpptools/cppmodelmanager.h>
hjk's avatar
hjk committed
91

92
#include <extensionsystem/invoker.h>
93

94
#include <projectexplorer/localapplicationrunconfiguration.h>
95
#include <projectexplorer/buildmanager.h>
96
#include <projectexplorer/taskhub.h>
97
#include <projectexplorer/toolchain.h>
98
#include <projectexplorer/devicesupport/deviceprocesslist.h>
99
#include <projectexplorer/devicesupport/deviceprocessesdialog.h>
100
#include <projectexplorer/projectexplorer.h>
101
#include <projectexplorer/projectexplorericons.h>
102
#include <projectexplorer/projecttree.h>
103 104
#include <projectexplorer/projectexplorersettings.h>
#include <projectexplorer/project.h>
con's avatar
con committed
105
#include <projectexplorer/session.h>
106
#include <projectexplorer/target.h>
107

108
#include <texteditor/texteditor.h>
109
#include <texteditor/textdocument.h>
110
#include <texteditor/fontsettings.h>
111
#include <texteditor/texteditorsettings.h>
hjk's avatar
hjk committed
112

113
#include <utils/basetreeview.h>
114
#include <utils/hostosinfo.h>
Eike Ziller's avatar
Eike Ziller committed
115
#include <utils/mimetypes/mimedatabase.h>
116
#include <utils/proxyaction.h>
117 118
#include <utils/qtcassert.h>
#include <utils/savedaction.h>
119
#include <utils/statuslabel.h>
120
#include <utils/styledbar.h>
hjk's avatar
hjk committed
121
#include <utils/winutils.h>
con's avatar
con committed
122

Campbell Barton's avatar
Campbell Barton committed
123
#include <QApplication>
hjk's avatar
hjk committed
124
#include <QCheckBox>
125
#include <QComboBox>
126 127
#include <QDockWidget>
#include <QFileDialog>
hjk's avatar
hjk committed
128 129
#include <QHBoxLayout>
#include <QHeaderView>
hjk's avatar
hjk committed
130
#include <QInputDialog>
131 132 133
#include <QMessageBox>
#include <QTextBlock>
#include <QToolButton>
hjk's avatar
hjk committed
134
#include <QtPlugin>
135
#include <QTreeWidget>
136
#include <QVBoxLayout>
137
#include <QMenu>
138

hjk's avatar
hjk committed
139
#ifdef WITH_TESTS
140 141 142
#include <QTest>
#include <QSignalSpy>
#include <QTestEventLoop>
143 144 145 146

//#define WITH_BENCHMARK
#ifdef WITH_BENCHMARK
#include <valgrind/callgrind.h>
hjk's avatar
hjk committed
147 148
#endif

149 150
#endif // WITH_TESTS

151 152
#include <climits>

153 154 155 156 157
#define DEBUG_STATE 1
#ifdef DEBUG_STATE
//#   define STATE_DEBUG(s)
//    do { QString msg; QTextStream ts(&msg); ts << s;
//      showMessage(msg, LogDebug); } while (0)
158
#   define STATE_DEBUG(s) do { qDebug() << s; } while (0)
159 160 161 162
#else
#   define STATE_DEBUG(s)
#endif

163 164 165 166 167 168 169 170
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
171
    \internal
172 173 174 175 176
*/

/*!
    \class Debugger::DebuggerEngine

177
    \brief The DebuggerEngine class is the base class of a debugger engine.
178

Leena Miettinen's avatar
Leena Miettinen committed
179
    \note The Debugger process itself and any helper processes like
180 181
    gdbserver are referred to as 'Engine', whereas the debugged process
    is referred to as 'Inferior'.
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

    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}            +        +                                       +
           +             +        +                                       +
280
            +            +        +                                       +
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
             +           +        +                                       +
            InferiorShutdownOk InferiorShutdownFailed                     +
                      *          *                                        +
                  EngineShutdownRequested                                 +
                            +                                             +
           (calls *Engine->shutdownEngine())  <+-+-+-+-+-+-+-+-+-+-+-+-+-+'
                         |        |
                         |        |
                    {notify-   {notify-
                     Engine-    Engine-
                  ShutdownOk}  ShutdownFailed}
                         +       +
            EngineShutdownOk  EngineShutdownFailed
                         *       *
                     DebuggerFinished

\endcode */
hjk's avatar
hjk committed
298

299 300 301
/* 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
302

303 304 305 306 307 308
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" ];
309
sg1:   InferiorSetupRequested -> InferiorSetupOk [ label="notifyInferiorSetupOk", style="dashed" ];
310
sg1:   InferiorSetupRequested -> InferiorSetupFailed [ label="notifyInferiorFailed", style="dashed" ];
311
sg1:   InferiorSetupOk -> EngineRunRequested
312 313 314 315 316 317 318 319 320 321 322 323 324 325
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
326 327
sg1:   InferiorStopOk -> InferiorShutdownRequested [ label="Close event" ];
sg1:   InferiorUnrunnable -> InferiorShutdownRequested [ label="Close event" ];
328 329
sg1:   InferiorShutdownRequested -> InferiorShutdownOk [ label= "Engine::shutdownInferior\nnotifyInferiorShutdownOk", style="dashed" ];
sg1:   InferiorShutdownRequested -> InferiorShutdownFailed [ label="Engine::shutdownInferior\nnotifyInferiorShutdownFailed", style="dashed" ];
330 331
sg1:   InferiorExited -> InferiorExitOk [ label="notifyInferiorExited", style="dashed"];
sg1:   InferiorExitOk -> InferiorShutdownOk
332 333 334 335 336 337 338 339
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
340
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
341 342


343 344
/*!
    \class Debugger::Internal::GdbEngine
345 346
    \brief The GdbEngine class implements Debugger::Engine driving a GDB
    executable.
347 348 349

    GdbEngine specific startup. All happens in EngineSetupRequested state:

Leena Miettinen's avatar
Leena Miettinen committed
350 351
    \list
        \li Transitions marked by '---' are done in the individual adapters.
352

Leena Miettinen's avatar
Leena Miettinen committed
353 354
        \li Transitions marked by '+-+' are done in the GdbEngine.
    \endlist
355 356 357 358 359 360 361 362 363 364 365 366 367

    \code
                  GdbEngine::setupEngine()
                          +
            (calls *Adapter->startAdapter())
                          |      |
                          |      `---> handleAdapterStartFailed()
                          |                   +
                          |             {notifyEngineSetupFailed}
                          |
                 handleAdapterStarted()
                          +
                 {notifyEngineSetupOk}
368 369 370



371 372 373 374 375 376 377 378 379 380 381
                GdbEngine::setupInferior()
                          +
            (calls *Adapter->prepareInferior())
                          |      |
                          |      `---> handlePrepareInferiorFailed()
                          |                   +
                          |             {notifyInferiorSetupFailed}
                          |
                handleInferiorPrepared()
                          +
                {notifyInferiorSetupOk}
382

383
\endcode */
384

con's avatar
con committed
385
using namespace Core;
hjk's avatar
hjk committed
386
using namespace Debugger::Constants;
387
using namespace Debugger::Internal;
388
using namespace ExtensionSystem;
con's avatar
con committed
389
using namespace ProjectExplorer;
hjk's avatar
hjk committed
390
using namespace TextEditor;
391
using namespace Utils;
con's avatar
con committed
392

hjk's avatar
hjk committed
393 394 395
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
396 397

namespace Debugger {
398 399
namespace Internal {

400 401 402 403 404 405 406 407 408 409 410
struct TestCallBack
{
    TestCallBack() : receiver(0), slot(0) {}
    TestCallBack(QObject *ob, const char *s) : receiver(ob), slot(s) {}

    QObject *receiver;
    const char *slot;
    QVariant cookie;
};


411 412 413
} // namespace Internal
} // namespace Debugger

414 415
Q_DECLARE_METATYPE(Debugger::Internal::TestCallBack)

416 417 418
namespace Debugger {
namespace Internal {

419
void addCdbOptionPages(QList<IOptionsPage*> *opts);
420
void addGdbOptionPages(QList<IOptionsPage*> *opts);
421
QObject *createDebuggerRunControlFactory(QObject *parent);
422

423 424 425 426 427 428 429
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

430
static void setProxyAction(ProxyAction *proxy, Id id)
431
{
hjk's avatar
hjk committed
432
    proxy->setAction(ActionManager::command(id)->action());
433 434
}

435
static QToolButton *toolButton(Id id)
436
{
hjk's avatar
hjk committed
437
    return toolButton(ActionManager::command(id)->action());
438 439
}

440 441 442 443 444 445 446 447 448
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
public:
449
    DummyEngine() : DebuggerEngine(DebuggerRunParameters()) {}
450 451 452 453 454 455 456
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
457
    bool hasCapability(unsigned cap) const;
458
    bool acceptsBreakpoint(Breakpoint) const { return false; }
459
    bool acceptsDebuggerCommands() const { return false; }
hjk's avatar
hjk committed
460
    void selectThread(ThreadId) {}
461 462
};

463
bool DummyEngine::hasCapability(unsigned cap) const
464 465
{
    // This can only be a first approximation of what to expect when running.
466
    Project *project = ProjectTree::currentProject();
467 468 469 470 471 472 473 474
    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:
475
    if (activeRc->extraAspect<Debugger::DebuggerRunConfigurationAspect>()->useCppDebugger())
476
        return cap & (WatchpointByAddressCapability
477 478
               | BreakConditionCapability
               | TracePointCapability
479
               | OperateByInstructionCapability);
480 481

    // This is a Qml or unknown engine.
482
    return cap & AddWatcherCapability;
483 484
}

485 486 487 488 489 490
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

491
class DebugMode : public IMode
hjk's avatar
hjk committed
492 493
{
public:
494 495 496
    DebugMode()
    {
        setObjectName(QLatin1String("DebugMode"));
497
        setContext(Context(C_DEBUGMODE, CC::C_NAVIGATION_PANE));
498
        setDisplayName(DebuggerPlugin::tr("Debug"));
499 500
        setIcon(Utils::Icon::modeIcon(Icons::MODE_DEBUGGER_CLASSIC,
                                      Icons::MODE_DEBUGGER_FLAT, Icons::MODE_DEBUGGER_FLAT_ACTIVE));
501
        setPriority(85);
502
        setId(MODE_DEBUG);
503
    }
hjk's avatar
hjk committed
504

hjk's avatar
hjk committed
505 506 507 508
    ~DebugMode()
    {
        delete m_widget;
    }
509
};
hjk's avatar
hjk committed
510

511 512 513 514 515 516
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

517
static QWidget *addSearch(BaseTreeView *treeView, const QString &title,
518
    const char *objectName)
519
{
hjk's avatar
hjk committed
520
    QAction *act = action(UseAlternatingRowColors);
521
    treeView->setAlternatingRowColors(act->isChecked());
522 523
    QObject::connect(act, &QAction::toggled,
                     treeView, &BaseTreeView::setAlternatingRowColorsHelper);
524

Daniel Teske's avatar
Daniel Teske committed
525
    QWidget *widget = ItemViewFind::createSearchableWrapper(treeView);
526 527 528 529 530
    widget->setObjectName(QLatin1String(objectName));
    widget->setWindowTitle(title);
    return widget;
}

531
static std::function<bool(const Kit *)> cdbMatcher(char wordWidth = 0)
532
{
533
    return [wordWidth](const Kit *k) -> bool {
534 535
        if (DebuggerKitInformation::engineType(k) != CdbEngineType
            || !DebuggerKitInformation::isValidDebugger(k)) {
536
            return false;
537
        }
538
        if (wordWidth) {
539
            const ToolChain *tc = ToolChainKitInformation::toolChain(k);
540
            return tc && wordWidth == tc->targetAbi().wordWidth();
541
        }
542
        return true;
543 544
    };
}
545

546 547 548 549 550 551 552
// Find a CDB kit for debugging unknown processes.
// On a 64bit OS, prefer a 64bit debugger.
static Kit *findUniversalCdbKit()
{
    if (Utils::is64BitWindowsSystem()) {
        if (Kit *cdb64Kit = KitManager::find(cdbMatcher(64)))
            return cdb64Kit;
553
    }
554 555
    return KitManager::find(cdbMatcher());
}
556

557 558
///////////////////////////////////////////////////////////////////////
//
559
// DebuggerPluginPrivate
560 561
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
562

563
static DebuggerPluginPrivate *dd = 0;
con's avatar
con committed
564

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

579
class DebuggerPluginPrivate : public QObject
580 581
{
    Q_OBJECT
582

583 584
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
585
    ~DebuggerPluginPrivate();
586

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

591
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
592
    void disconnectEngine() { connectEngine(0); }
593
    DebuggerEngine *dummyEngine();
594

hjk's avatar
hjk committed
595
    void setThreadBoxContents(const QStringList &list, int index)
596 597 598 599 600 601 602 603
    {
        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);
    }
604 605

    DebuggerRunControl *attachToRunningProcess(Kit *kit, DeviceProcessItem process, bool contAfterAttach);
606

607 608 609 610 611 612
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

613 614
    void selectThread(int index)
    {
hjk's avatar
hjk committed
615 616
        ThreadId id = m_currentEngine->threadsHandler()->threadAt(index);
        m_currentEngine->selectThread(id);
617
    }
618

619
    void breakpointSetMarginActionTriggered(bool isMessageOnly, const ContextData &data)
620
    {
621
        QString message;
622
        if (isMessageOnly) {
623
            if (data.type == LocationByAddress) {
624 625 626 627
                //: Message tracepoint: Address hit.
                message = tr("0x%1 hit").arg(data.address, 0, 16);
            } else {
                //: Message tracepoint: %1 file, %2 line %3 function hit.
628
                message = tr("%1:%2 %3() hit").arg(FileName::fromString(data.fileName).fileName()).
629 630 631 632 633
                        arg(data.lineNumber).
                        arg(cppFunctionAt(data.fileName, data.lineNumber));
            }
            QInputDialog dialog; // Create wide input dialog.
            dialog.setWindowFlags(dialog.windowFlags()
hjk's avatar
hjk committed
634
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
635 636 637 638 639 640 641 642
            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();
        }
643
        toggleBreakpoint(data, message);
644
    }
645

646
    void updateWatchersHeader(int section, int, int newSize)
647
    {
648 649
        m_watchersView->header()->resizeSection(section, newSize);
        m_returnView->header()->resizeSection(section, newSize);
650
    }
651

652
    void sourceFilesDockToggled(bool on)
653
    {
654
        if (on && m_currentEngine->state() == InferiorStopOk)
655 656 657
            m_currentEngine->reloadSourceFiles();
    }

658
    void modulesDockToggled(bool on)
659
    {
660
        if (on && m_currentEngine->state() == InferiorStopOk)
661 662
            m_currentEngine->reloadModules();
    }
663

hjk's avatar
hjk committed
664
    void registerDockToggled(bool on)
665
    {
666
        if (on && m_currentEngine->state() == InferiorStopOk)
667 668
            m_currentEngine->reloadRegisters();
    }
669

670 671
    void synchronizeBreakpoints()
    {
672
        showMessage(QLatin1String("ATTEMPT SYNC"), LogDebug);
673
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
674
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
675 676 677 678
                engine->attemptBreakpointSynchronization();
        }
    }

679 680
    void editorOpened(IEditor *editor);
    void updateBreakMenuItem(IEditor *editor);
681
    void setBusyCursor(bool busy);
682 683 684
    void requestMark(TextEditorWidget *widget, int lineNumber,
                     TextMarkRequestKind kind);
    void requestContextMenu(TextEditorWidget *widget,
685
                            int lineNumber, QMenu *menu);
686

687 688
    void activatePreviousMode();
    void activateDebugMode();
689 690
    void toggleBreakpointHelper();
    void toggleBreakpoint(const ContextData &location, const QString &tracePointMessage = QString());
691
    void onModeChanged(IMode *mode);
692
    void onCoreAboutToOpen();
693
    void updateDebugWithoutDeployMenu();
694

695
    void startAndDebugApplication();
696
    void startRemoteCdbSession();
697
    void startRemoteServerAndAttachToProcess();
698
    void attachToRemoteServer();
hjk's avatar
hjk committed
699
    void attachToRunningApplication();
700
    void attachToUnstartedApplicationDialog();
701
    void attachToQmlPort();
hjk's avatar
hjk committed
702
    Q_SLOT void runScheduled();
703
    void attachCore();
704

705
    void enableReverseDebuggingTriggered(const QVariant &value);
706
    void showStatusMessage(const QString &msg, int timeout = -1);
707

708 709
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
710
    void remoteCommand(const QStringList &options);
711

712
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
713 714 715

    void dumpLog();
    void cleanupViews();
716
    void setInitialState();
717

718
    void fontSettingsChanged(const FontSettings &settings);
719 720

    void updateState(DebuggerEngine *engine);
721
    void onCurrentProjectChanged(Project *project);
722 723 724 725

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
726

727
    void coreShutdown();
728

hjk's avatar
hjk committed
729 730
#ifdef WITH_TESTS
public slots:
731
    void testLoadProject(const QString &proFile, const TestCallBack &cb);
732
    void testProjectLoaded(Project *project);
733 734
    void testProjectEvaluated();
    void testProjectBuilt(bool success);
735 736 737
    void testUnloadProject();
    void testFinished();

738
    void testRunProject(const DebuggerRunParameters &sp, const TestCallBack &cb);
hjk's avatar
hjk committed
739
    void testRunControlFinished();
740

hjk's avatar
hjk committed
741 742 743
//    void testStateMachine1();
//    void testStateMachine2();
//    void testStateMachine3();
744

745 746
    void testBenchmark1();

747
public:
hjk's avatar
hjk committed
748
    Project *m_testProject;
749 750 751
    bool m_testSuccess;
    QList<TestCallBack> m_testCallbacks;

hjk's avatar
hjk committed
752 753
#endif

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

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

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

    void handleExecInterrupt()
    {
771
        currentEngine()->resetLocation();
772 773 774
        currentEngine()->requestInterruptInferior();
    }

775
    void handleAbort()
776
    {
777
        currentEngine()->resetLocation();
778
        currentEngine()->abortDebugger();
779
    }
hjk's avatar
hjk committed
780

781 782 783 784 785 786
    void handleReset()
    {
        currentEngine()->resetLocation();
        currentEngine()->resetInferior();
    }

hjk's avatar
hjk committed
787 788
    void handleExecStep()
    {
789
        if (currentEngine()->state() == DebuggerNotReady) {
790
            ProjectExplorerPlugin::runStartupProject(ProjectExplorer::Constants::DEBUG_RUN_MODE_WITH_BREAK_ON_MAIN);
791 792 793 794 795 796 797
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeStepI();
            else
                currentEngine()->executeStep();
        }
hjk's avatar
hjk committed
798 799 800 801
    }

    void handleExecNext()
    {
802
        if (currentEngine()->state() == DebuggerNotReady) {
803
            ProjectExplorerPlugin::runStartupProject(ProjectExplorer::Constants::DEBUG_RUN_MODE_WITH_BREAK_ON_MAIN);
804 805 806 807 808 809 810
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeNextI();
            else
                currentEngine()->executeNext();
        }
hjk's avatar
hjk committed
811 812
    }

813 814
    void handleExecStepOut()
    {
815
        currentEngine()->resetLocation();
816 817 818 819 820
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
821
        currentEngine()->resetLocation();
822 823
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
824 825 826

    void handleExecJumpToLine()
    {
827
        currentEngine()->resetLocation();
828 829 830 831 832 833
        if (BaseTextEditor *textEditor = BaseTextEditor::currentTextEditor()) {
            ContextData location = getLocationContext(textEditor->textDocument(),
                                                      textEditor->currentLine());
            if (location.isValid())
                currentEngine()->executeJumpToLine(location);
        }
hjk's avatar
hjk committed
834 835 836 837
    }

    void handleExecRunToLine()
    {
838
        currentEngine()->resetLocation();
839 840 841 842 843 844
        if (BaseTextEditor *textEditor = BaseTextEditor::currentTextEditor()) {
            ContextData location = getLocationContext(textEditor->textDocument(),
                                                      textEditor->currentLine());
            if (location.isValid())
                currentEngine()->executeRunToLine(location);
        }
hjk's avatar
hjk committed
845 846
    }

847
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
848
    {
849
        BaseTextEditor *textEditor = BaseTextEditor::currentTextEditor();
850
        QTC_ASSERT(textEditor, return);
851
        QTextCursor cursor = textEditor->textCursor();
852 853 854 855
        QString functionName = cursor.selectedText();
        if (functionName.isEmpty()) {
            const QTextBlock block = cursor.block();
            const QString line = block.text();
856
            foreach (const QString &str, line.trimmed().split(QLatin1Char('('))) {
857 858 859 860 861 862 863 864 865 866 867 868 869
                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;
                }
            }
        }

870 871 872 873 874 875
        if (functionName.isEmpty()) {
            showStatusMessage(tr("No function selected."));
        } else {
            showStatusMessage(tr("Running to function \"%1\".")
                .arg(functionName));
            currentEngine()->resetLocation();
876
            currentEngine()->executeRunToFunction(functionName);
877
        }
hjk's avatar
hjk committed
878 879 880 881 882
    }

    void handleAddToWatchWindow()
    {
        // Requires a selection, but that's the only case we want anyway.
883
        BaseTextEditor *textEditor = BaseTextEditor::currentTextEditor();
hjk's avatar
hjk committed
884 885
        if (!textEditor)
            return;
886
        QTextCursor tc = textEditor->textCursor();
hjk's avatar
hjk committed
887 888 889 890 891
        QString exp;
        if (tc.hasSelection()) {
            exp = tc.selectedText();
        } else {
            int line, column;
892
            exp = cppExpressionAt(textEditor->editorWidget(), tc.position(), &line, &column);
hjk's avatar
hjk committed
893
        }
894 895 896 897
        if (currentEngine()->hasCapability(WatchComplexExpressionsCapability))
            exp = removeObviousSideEffects(exp);
        else
            exp = fixCppExpression(exp);
898
        exp = exp.trimmed();
hjk's avatar
hjk committed
899 900
        if (exp.isEmpty())
            return;
901
        currentEngine()->watchHandler()->watchVariable(exp);
hjk's avatar
hjk committed
902 903 904 905
    }

    void handleExecExit()
    {
906
        currentEngine()->exitDebugger();
hjk's avatar
hjk committed
907 908 909 910 911 912 913 914 915 916 917 918
    }

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

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

919
    void handleOperateByInstructionTriggered(bool operateByInstructionTriggered)
hjk's avatar
hjk committed
920
    {
921
        // Go to source only if we have the file.
922 923 924 925 926 927
        if (DebuggerEngine *cppEngine = currentEngine()->cppEngine()) {
            if (cppEngine->stackHandler()->currentIndex() >= 0) {
                const StackFrame frame = cppEngine->stackHandler()->currentFrame();
                if (operateByInstructionTriggered || frame.isUsable())
                    cppEngine->gotoLocation(Location(frame, true));
            }