debuggerplugin.cpp 140 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
con's avatar
con committed
2
**
3 4
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://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
12 13 14
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
15
**
16 17 18 19 20 21 22
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
con's avatar
con committed
23
**
hjk's avatar
hjk committed
24
****************************************************************************/
hjk's avatar
hjk committed
25

con's avatar
con committed
26 27
#include "debuggerplugin.h"

28
#include "debuggermainwindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
29
#include "debuggerstartparameters.h"
30
#include "debuggeractions.h"
31
#include "debuggerinternalconstants.h"
32
#include "debuggercore.h"
33
#include "debuggerkitconfigwidget.h"
34 35
#include "debuggerdialogs.h"
#include "debuggerengine.h"
36
#include "debuggericons.h"
37
#include "debuggeritem.h"
38
#include "debuggeritemmanager.h"
39
#include "debuggermainwindow.h"
40
#include "debuggerrunconfigurationaspect.h"
41
#include "debuggerruncontrol.h"
42
#include "debuggerstringutils.h"
43
#include "debuggeroptionspage.h"
Tobias Hunger's avatar
Tobias Hunger committed
44
#include "debuggerkitinformation.h"
45
#include "memoryagent.h"
46
#include "breakhandler.h"
47
#include "breakwindow.h"
48
#include "disassemblerlines.h"
49
#include "logwindow.h"
50
#include "moduleswindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
51
#include "moduleshandler.h"
52 53
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
54
#include "stackhandler.h"
55 56 57
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
58
#include "watchhandler.h"
59
#include "watchwindow.h"
hjk's avatar
hjk committed
60
#include "watchutils.h"
61
#include "unstartedappwatcherdialog.h"
62
#include "debuggertooltipmanager.h"
63
#include "localsandexpressionswindow.h"
64
#include "loadcoredialog.h"
65
#include "sourceutils.h"
hjk's avatar
hjk committed
66 67
#include "shared/hostutils.h"
#include "console/console.h"
68

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

hjk's avatar
hjk committed
74
#include "analyzer/analyzerconstants.h"
75
#include "analyzer/analyzericons.h"
hjk's avatar
hjk committed
76
#include "analyzer/analyzermanager.h"
77 78
#include "analyzer/analyzerruncontrol.h"
#include "analyzer/analyzerstartparameters.h"
hjk's avatar
hjk committed
79

80
#include <coreplugin/actionmanager/actioncontainer.h>
81
#include <coreplugin/actionmanager/actionmanager.h>
82
#include <coreplugin/actionmanager/command.h>
83
#include <coreplugin/coreconstants.h>
84
#include <coreplugin/coreicons.h>
85 86 87
#include <coreplugin/editormanager/documentmodel.h>
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/find/itemviewfind.h>
con's avatar
con committed
88
#include <coreplugin/icore.h>
89
#include <coreplugin/imode.h>
90
#include <coreplugin/messagebox.h>
91
#include <coreplugin/messagemanager.h>
con's avatar
con committed
92
#include <coreplugin/modemanager.h>
93
#include <coreplugin/modemanager.h>
94 95 96
#include <coreplugin/navigationwidget.h>
#include <coreplugin/outputpane.h>
#include <coreplugin/rightpane.h>
hjk's avatar
hjk committed
97

con's avatar
con committed
98
#include <cppeditor/cppeditorconstants.h>
99
#include <cpptools/cppmodelmanager.h>
hjk's avatar
hjk committed
100

101
#include <projectexplorer/buildconfiguration.h>
102
#include <projectexplorer/buildmanager.h>
103
#include <projectexplorer/devicesupport/deviceprocessesdialog.h>
104 105
#include <projectexplorer/devicesupport/deviceprocesslist.h>
#include <projectexplorer/project.h>
106
#include <projectexplorer/projectexplorer.h>
107
#include <projectexplorer/projectexplorericons.h>
108
#include <projectexplorer/projectexplorersettings.h>
109
#include <projectexplorer/projecttree.h>
110
#include <projectexplorer/runconfiguration.h>
111
#include <projectexplorer/runnables.h>
con's avatar
con committed
112
#include <projectexplorer/session.h>
113
#include <projectexplorer/target.h>
114 115
#include <projectexplorer/taskhub.h>
#include <projectexplorer/toolchain.h>
116

117
#include <texteditor/texteditor.h>
118
#include <texteditor/textdocument.h>
119
#include <texteditor/fontsettings.h>
120
#include <texteditor/texteditorsettings.h>
hjk's avatar
hjk committed
121

122 123
#include <utils/algorithm.h>
#include <utils/appmainwindow.h>
124
#include <utils/basetreeview.h>
125
#include <utils/checkablemessagebox.h>
126
#include <utils/fancymainwindow.h>
127
#include <utils/hostosinfo.h>
Eike Ziller's avatar
Eike Ziller committed
128
#include <utils/mimetypes/mimedatabase.h>
129
#include <utils/proxyaction.h>
130 131
#include <utils/qtcassert.h>
#include <utils/savedaction.h>
132
#include <utils/statuslabel.h>
133
#include <utils/styledbar.h>
hjk's avatar
hjk committed
134
#include <utils/winutils.h>
con's avatar
con committed
135

136
#include <QAction>
Campbell Barton's avatar
Campbell Barton committed
137
#include <QApplication>
hjk's avatar
hjk committed
138
#include <QCheckBox>
139
#include <QComboBox>
140
#include <QDebug>
141 142
#include <QDialog>
#include <QDialogButtonBox>
143 144
#include <QDockWidget>
#include <QFileDialog>
hjk's avatar
hjk committed
145 146
#include <QHBoxLayout>
#include <QHeaderView>
hjk's avatar
hjk committed
147
#include <QInputDialog>
148
#include <QMenu>
149
#include <QMessageBox>
150 151 152
#include <QPointer>
#include <QPushButton>
#include <QSettings>
153
#include <QStackedWidget>
154 155 156
#include <QTextBlock>
#include <QToolButton>
#include <QTreeWidget>
157
#include <QVBoxLayout>
158
#include <QVariant>
159
#include <QtPlugin>
160

hjk's avatar
hjk committed
161
#ifdef WITH_TESTS
162 163 164 165

#include <cpptools/cpptoolstestcase.h>
#include <cpptools/projectinfo.h>

166 167 168
#include <QTest>
#include <QSignalSpy>
#include <QTestEventLoop>
169 170 171 172

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

175 176
#endif // WITH_TESTS

177 178
#include <climits>

179 180 181 182 183
#define DEBUG_STATE 1
#ifdef DEBUG_STATE
//#   define STATE_DEBUG(s)
//    do { QString msg; QTextStream ts(&msg); ts << s;
//      showMessage(msg, LogDebug); } while (0)
184
#   define STATE_DEBUG(s) do { qDebug() << s; } while (0)
185 186 187 188
#else
#   define STATE_DEBUG(s)
#endif

189 190 191 192 193 194 195 196
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
197
    \internal
198 199 200 201 202
*/

/*!
    \class Debugger::DebuggerEngine

203
    \brief The DebuggerEngine class is the base class of a debugger engine.
204

Leena Miettinen's avatar
Leena Miettinen committed
205
    \note The Debugger process itself and any helper processes like
206 207
    gdbserver are referred to as 'Engine', whereas the debugged process
    is referred to as 'Inferior'.
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 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305

    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}            +        +                                       +
           +             +        +                                       +
306
            +            +        +                                       +
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
             +           +        +                                       +
            InferiorShutdownOk InferiorShutdownFailed                     +
                      *          *                                        +
                  EngineShutdownRequested                                 +
                            +                                             +
           (calls *Engine->shutdownEngine())  <+-+-+-+-+-+-+-+-+-+-+-+-+-+'
                         |        |
                         |        |
                    {notify-   {notify-
                     Engine-    Engine-
                  ShutdownOk}  ShutdownFailed}
                         +       +
            EngineShutdownOk  EngineShutdownFailed
                         *       *
                     DebuggerFinished

\endcode */
hjk's avatar
hjk committed
324

325 326 327
/* 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
328

329 330 331 332 333 334
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" ];
335
sg1:   InferiorSetupRequested -> InferiorSetupOk [ label="notifyInferiorSetupOk", style="dashed" ];
336
sg1:   InferiorSetupRequested -> InferiorSetupFailed [ label="notifyInferiorFailed", style="dashed" ];
337
sg1:   InferiorSetupOk -> EngineRunRequested
338 339 340 341 342 343 344 345 346 347 348 349 350 351
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
352 353
sg1:   InferiorStopOk -> InferiorShutdownRequested [ label="Close event" ];
sg1:   InferiorUnrunnable -> InferiorShutdownRequested [ label="Close event" ];
354 355
sg1:   InferiorShutdownRequested -> InferiorShutdownOk [ label= "Engine::shutdownInferior\nnotifyInferiorShutdownOk", style="dashed" ];
sg1:   InferiorShutdownRequested -> InferiorShutdownFailed [ label="Engine::shutdownInferior\nnotifyInferiorShutdownFailed", style="dashed" ];
356 357
sg1:   InferiorExited -> InferiorExitOk [ label="notifyInferiorExited", style="dashed"];
sg1:   InferiorExitOk -> InferiorShutdownOk
358 359 360 361 362 363 364 365
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
366
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
367 368


369 370
/*!
    \class Debugger::Internal::GdbEngine
371 372
    \brief The GdbEngine class implements Debugger::Engine driving a GDB
    executable.
373 374 375

    GdbEngine specific startup. All happens in EngineSetupRequested state:

Leena Miettinen's avatar
Leena Miettinen committed
376 377
    \list
        \li Transitions marked by '---' are done in the individual adapters.
378

Leena Miettinen's avatar
Leena Miettinen committed
379 380
        \li Transitions marked by '+-+' are done in the GdbEngine.
    \endlist
381 382 383 384 385 386 387 388 389 390 391 392 393

    \code
                  GdbEngine::setupEngine()
                          +
            (calls *Adapter->startAdapter())
                          |      |
                          |      `---> handleAdapterStartFailed()
                          |                   +
                          |             {notifyEngineSetupFailed}
                          |
                 handleAdapterStarted()
                          +
                 {notifyEngineSetupOk}
394 395 396



397 398 399 400 401 402 403 404 405 406 407
                GdbEngine::setupInferior()
                          +
            (calls *Adapter->prepareInferior())
                          |      |
                          |      `---> handlePrepareInferiorFailed()
                          |                   +
                          |             {notifyInferiorSetupFailed}
                          |
                handleInferiorPrepared()
                          +
                {notifyInferiorSetupOk}
408

409
\endcode */
410

con's avatar
con committed
411
using namespace Core;
412
using namespace Core::Constants;
hjk's avatar
hjk committed
413
using namespace Debugger::Constants;
414
using namespace Debugger::Internal;
415
using namespace ExtensionSystem;
con's avatar
con committed
416
using namespace ProjectExplorer;
hjk's avatar
hjk committed
417
using namespace TextEditor;
418
using namespace Utils;
con's avatar
con committed
419

hjk's avatar
hjk committed
420 421 422
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
423
namespace Debugger {
424 425
namespace Internal {

426
void addCdbOptionPages(QList<IOptionsPage*> *opts);
427
void addGdbOptionPages(QList<IOptionsPage*> *opts);
428
QObject *createDebuggerRunControlFactory(QObject *parent);
429

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

435 436 437 438 439 440 441 442 443
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
public:
444
    DummyEngine() : DebuggerEngine(DebuggerRunParameters()) {}
445 446 447 448 449 450 451 452 453 454 455
    ~DummyEngine() override {}

    void setupEngine() override {}
    void setupInferior() override {}
    void runEngine() override {}
    void shutdownEngine() override {}
    void shutdownInferior() override {}
    bool hasCapability(unsigned cap) const override;
    bool acceptsBreakpoint(Breakpoint) const override { return false; }
    bool acceptsDebuggerCommands() const override { return false; }
    void selectThread(ThreadId) override {}
456 457
};

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

    // This is a Qml or unknown engine.
477
    return cap & AddWatcherCapability;
478 479
}

480 481 482 483 484 485
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

486 487 488 489 490 491 492 493 494 495 496 497 498 499
class DebugModeContext : public IContext
{
public:
    DebugModeContext(DebuggerMainWindow *mainWindow) : m_mainWindow(mainWindow)
    {
        setContext(Context(CC::C_EDITORMANAGER));
        ICore::addContextObject(this);
    }

    QWidget *widget() const override { return m_mainWindow->modeWindow(); }

    DebuggerMainWindow *m_mainWindow;
};

500
class DebugMode : public IMode
hjk's avatar
hjk committed
501 502
{
public:
503
    DebugMode(DebuggerMainWindow *mainWindow) : m_mainWindow(mainWindow)
504 505
    {
        setObjectName(QLatin1String("DebugMode"));
506
        setContext(Context(C_DEBUGMODE, CC::C_NAVIGATION_PANE));
507
        setDisplayName(DebuggerPlugin::tr("Debug"));
508 509
        setIcon(Utils::Icon::modeIcon(Icons::MODE_DEBUGGER_CLASSIC,
                                      Icons::MODE_DEBUGGER_FLAT, Icons::MODE_DEBUGGER_FLAT_ACTIVE));
510 511
//        setIcon(Utils::Icon::modeIcon(Icons::MODE_ANALYZE_CLASSIC,
//                                      Icons::MODE_ANALYZE_FLAT, Icons::MODE_ANALYZE_FLAT_ACTIVE));
512
        setPriority(85);
513
        setId(MODE_DEBUG);
514
    }
hjk's avatar
hjk committed
515

516 517
    QWidget *widget() const override { return m_mainWindow->modeWindow(); }

hjk's avatar
hjk committed
518 519
    ~DebugMode()
    {
520
//        delete m_widget;
hjk's avatar
hjk committed
521
    }
522 523

    DebuggerMainWindow *m_mainWindow;
524
};
hjk's avatar
hjk committed
525

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

532
static QWidget *addSearch(BaseTreeView *treeView, const QString &title,
533
    const char *objectName)
534
{
hjk's avatar
hjk committed
535
    QAction *act = action(UseAlternatingRowColors);
536
    treeView->setAlternatingRowColors(act->isChecked());
537 538
    QObject::connect(act, &QAction::toggled,
                     treeView, &BaseTreeView::setAlternatingRowColorsHelper);
539

Daniel Teske's avatar
Daniel Teske committed
540
    QWidget *widget = ItemViewFind::createSearchableWrapper(treeView);
541 542 543 544 545
    widget->setObjectName(QLatin1String(objectName));
    widget->setWindowTitle(title);
    return widget;
}

546
static std::function<bool(const Kit *)> cdbMatcher(char wordWidth = 0)
547
{
548
    return [wordWidth](const Kit *k) -> bool {
549 550
        if (DebuggerKitInformation::engineType(k) != CdbEngineType
            || !DebuggerKitInformation::isValidDebugger(k)) {
551
            return false;
552
        }
553
        if (wordWidth) {
554
            const ToolChain *tc = ToolChainKitInformation::toolChain(k);
555
            return tc && wordWidth == tc->targetAbi().wordWidth();
556
        }
557
        return true;
558 559
    };
}
560

561 562 563 564 565
// Find a CDB kit for debugging unknown processes.
// On a 64bit OS, prefer a 64bit debugger.
static Kit *findUniversalCdbKit()
{
    if (Utils::is64BitWindowsSystem()) {
Tobias Hunger's avatar
Tobias Hunger committed
566
        if (Kit *cdb64Kit = KitManager::find(KitMatcher(cdbMatcher(64))))
567
            return cdb64Kit;
568
    }
Tobias Hunger's avatar
Tobias Hunger committed
569
    return KitManager::find(KitMatcher(cdbMatcher()));
570
}
571

572 573
///////////////////////////////////////////////////////////////////////
//
574
// DebuggerPluginPrivate
575 576
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
577

578
static DebuggerPluginPrivate *dd = 0;
con's avatar
con committed
579

580 581 582 583
//class DockWidgetEventFilter : public QObject
//{
//public:
//    DockWidgetEventFilter() {}
584

585 586 587
//private:
//    bool eventFilter(QObject *obj, QEvent *event) override;
//};
588

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

603
class DebuggerPluginPrivate : public QObject
604 605
{
    Q_OBJECT
606

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

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

615
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
616
    void disconnectEngine() { connectEngine(0); }
617
    DebuggerEngine *dummyEngine();
618

hjk's avatar
hjk committed
619
    void setThreadBoxContents(const QStringList &list, int index)
620 621 622 623 624 625 626 627
    {
        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);
    }
628 629

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

631 632 633
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
634
//        writeWindowSettings();
635 636
    }

637 638
    void selectThread(int index)
    {
hjk's avatar
hjk committed
639 640
        ThreadId id = m_currentEngine->threadsHandler()->threadAt(index);
        m_currentEngine->selectThread(id);
641
    }
642

643
    void breakpointSetMarginActionTriggered(bool isMessageOnly, const ContextData &data)
644
    {
645
        QString message;
646
        if (isMessageOnly) {
647
            if (data.type == LocationByAddress) {
648 649 650 651
                //: Message tracepoint: Address hit.
                message = tr("0x%1 hit").arg(data.address, 0, 16);
            } else {
                //: Message tracepoint: %1 file, %2 line %3 function hit.
652
                message = tr("%1:%2 %3() hit").arg(FileName::fromString(data.fileName).fileName()).
653 654 655 656 657
                        arg(data.lineNumber).
                        arg(cppFunctionAt(data.fileName, data.lineNumber));
            }
            QInputDialog dialog; // Create wide input dialog.
            dialog.setWindowFlags(dialog.windowFlags()
hjk's avatar
hjk committed
658
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
659 660 661 662 663 664 665 666
            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();
        }
667
        toggleBreakpoint(data, message);
668
    }
669

670
    void updateWatchersHeader(int section, int, int newSize)
671
    {
672 673
        m_watchersView->header()->resizeSection(section, newSize);
        m_returnView->header()->resizeSection(section, newSize);
674
    }
675

676 677
    void synchronizeBreakpoints()
    {
678
        showMessage(QLatin1String("ATTEMPT SYNC"), LogDebug);
679
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
680
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
681 682 683 684
                engine->attemptBreakpointSynchronization();
        }
    }

685 686
    void editorOpened(IEditor *editor);
    void updateBreakMenuItem(IEditor *editor);
687
    void setBusyCursor(bool busy);
688 689 690
    void requestMark(TextEditorWidget *widget, int lineNumber,
                     TextMarkRequestKind kind);
    void requestContextMenu(TextEditorWidget *widget,
691
                            int lineNumber, QMenu *menu);
692

693 694
    void activatePreviousMode();
    void activateDebugMode();
695 696
    void toggleBreakpointHelper();
    void toggleBreakpoint(const ContextData &location, const QString &tracePointMessage = QString());
697
    void onModeChanged(IMode *mode);
698
    void updateDebugWithoutDeployMenu();
699

700
    void startAndDebugApplication();
701
    void startRemoteCdbSession();
702
    void startRemoteServerAndAttachToProcess();
703
    void attachToRemoteServer();
hjk's avatar
hjk committed
704
    void attachToRunningApplication();
705
    void attachToUnstartedApplicationDialog();
706
    void attachToQmlPort();
707
    void runScheduled();
708
    void attachCore();
709

710
    void enableReverseDebuggingTriggered(const QVariant &value);
711
    void showStatusMessage(const QString &msg, int timeout = -1);
712

713 714
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
715
    void remoteCommand(const QStringList &options);
716

717
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
718 719 720

    void dumpLog();
    void cleanupViews();
721
    void setInitialState();
722

723
    void fontSettingsChanged(const FontSettings &settings);
724 725

    void updateState(DebuggerEngine *engine);
726
    void onCurrentProjectChanged(Project *project);
727 728 729 730

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
731

732
    void coreShutdown();
733

734
public:
735
    void updateDebugActions();
736 737 738

    void handleExecDetach()
    {
739
        currentEngine()->resetLocation();
740 741 742 743 744
        currentEngine()->detachDebugger();
    }

    void handleExecContinue()
    {
745
        currentEngine()->resetLocation();
746 747 748 749 750
        currentEngine()->continueInferior();
    }

    void handleExecInterrupt()
    {
751
        currentEngine()->resetLocation();
752 753 754
        currentEngine()->requestInterruptInferior();
    }

755
    void handleAbort()
756
    {
757
        currentEngine()->resetLocation();
758
        currentEngine()->abortDebugger();
759
    }
hjk's avatar
hjk committed
760

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

hjk's avatar
hjk committed
767 768
    void handleExecStep()
    {
769
        if (currentEngine()->state() == DebuggerNotReady) {
770
            ProjectExplorerPlugin::runStartupProject(ProjectExplorer::Constants::DEBUG_RUN_MODE_WITH_BREAK_ON_MAIN);
771 772 773 774 775 776 777
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeStepI();
            else
                currentEngine()->executeStep();
        }
hjk's avatar
hjk committed
778 779 780 781
    }

    void handleExecNext()
    {
782
        if (currentEngine()->state() == DebuggerNotReady) {
783
            ProjectExplorerPlugin::runStartupProject(ProjectExplorer::Constants::DEBUG_RUN_MODE_WITH_BREAK_ON_MAIN);
784 785 786 787 788 789 790
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeNextI();
            else
                currentEngine()->executeNext();
        }
hjk's avatar
hjk committed
791 792
    }

793 794
    void handleExecStepOut()
    {
795
        currentEngine()->resetLocation();
796 797 798 799 800
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
801
        currentEngine()->resetLocation();
802 803
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
804 805 806

    void handleExecJumpToLine()
    {
807
        currentEngine()->resetLocation();
808 809 810 811 812 813
        if (BaseTextEditor *textEditor = BaseTextEditor::currentTextEditor()) {
            ContextData location = getLocationContext(textEditor->textDocument(),
                                                      textEditor->currentLine());
            if (location.isValid())
                currentEngine()->executeJumpToLine(location);
        }
hjk's avatar
hjk committed
814 815 816 817
    }

    void handleExecRunToLine()
    {
818
        currentEngine()->resetLocation();
819 820 821 822 823 824
        if (BaseTextEditor *textEditor = BaseTextEditor::currentTextEditor()) {
            ContextData location = getLocationContext(textEditor->textDocument(),
                                                      textEditor->currentLine());
            if (location.isValid())
                currentEngine()->executeRunToLine(location);
        }
hjk's avatar
hjk committed
825 826
    }

827
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
828
    {
829
        BaseTextEditor *textEditor = BaseTextEditor::currentTextEditor();
830
        QTC_ASSERT(textEditor, return);
831
        QTextCursor cursor = textEditor->textCursor();
832 833 834 835
        QString functionName = cursor.selectedText();
        if (functionName.isEmpty()) {
            const QTextBlock block = cursor.block();
            const QString line = block.text();
836
            foreach (const QString &str, line.trimmed().split(QLatin1Char('('))) {
837 838 839 840 841 842 843 844 845 846 847 848 849
                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;
                }
            }
        }

850 851 852 853 854 855
        if (functionName.isEmpty()) {
            showStatusMessage(tr("No function selected."));
        } else {
            showStatusMessage(tr("Running to function \"%1\".")
                .arg(functionName));
            currentEngine()->resetLocation();
856
            currentEngine()->executeRunToFunction(functionName);
857
        }
hjk's avatar
hjk committed
858 859 860 861 862
    }

    void handleAddToWatchWindow()
    {
        // Requires a selection, but that's the only case we want anyway.
863
        BaseTextEditor *textEditor = BaseTextEditor::currentTextEditor();
hjk's avatar
hjk committed
864 865
        if (!textEditor)
            return;
866
        QTextCursor tc = textEditor->textCursor();
hjk's avatar
hjk committed
867 868 869 870 871
        QString exp;
        if (tc.hasSelection()) {
            exp = tc.selectedText();
        } else {
            int line, column;
872
            exp = cppExpressionAt(textEditor->editorWidget(), tc.position(), &line, &column);
hjk's avatar
hjk committed
873
        }
874 875 876 877
        if (currentEngine()->hasCapability(WatchComplexExpressionsCapability))
            exp = removeObviousSideEffects(exp);
        else
            exp = fixCppExpression(exp);
878
        exp = exp.trimmed();
hjk's avatar
hjk committed
879 880
        if (exp.isEmpty())
            return;
881
        currentEngine()->watchHandler()->watchVariable(exp);
hjk's avatar
hjk committed
882 883 884 885
    }

    void handleExecExit()
    {
886
        currentEngine()->exitDebugger();
hjk's avatar
hjk committed
887 888 889 890 891 892 893 894 895 896 897 898
    }

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

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

899
    void handleOperateByInstructionTriggered(bool operateByInstructionTriggered)
hjk's avatar
hjk committed
900
    {
901
        // Go to source only if we have the file.
902 903 904 905 906 907
        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));
            }
908
        }
hjk's avatar
hjk committed
909 910
    }

911 912
    void showMessage(const QString &msg, int channel, int timeout = -1);

913
    bool parseArgument(QStringList::const_iterator &it,
914 915
        const QStringList::const_iterator &cend, QString *errorMessage);
    bool parseArguments(const QStringList &args, QString *errorMessage);
916
    void parseCommandLineArguments();
917

918 919 920 921 922 923 924
    // Called when all dependent plugins have loaded.
    void initialize();

    void updateUiForProject(ProjectExplorer::Project *project);
    void updateUiForTarget(ProjectExplorer::Target *target);
    void updateUiForRunConfiguration(ProjectExplorer::RunConfiguration *rc);
    void updateActiveLanguages();
925

926
public:
927 928 929 930
    DebuggerMainWindow *m_mainWindow = 0;

    QHash<Id, ActionDescription> m_descriptions;
    ActionContainer *m_menu = 0;
931