debuggerplugin.cpp 142 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 "debuggeroptionspage.h"
Tobias Hunger's avatar
Tobias Hunger committed
43
#include "debuggerkitinformation.h"
44
#include "memoryagent.h"
45
#include "breakhandler.h"
46
#include "disassemblerlines.h"
47
#include "logwindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
48
#include "moduleshandler.h"
49
#include "snapshotwindow.h"
hjk's avatar
hjk committed
50
#include "stackhandler.h"
51
#include "stackwindow.h"
hjk's avatar
hjk committed
52
#include "watchhandler.h"
53
#include "watchwindow.h"
hjk's avatar
hjk committed
54
#include "watchutils.h"
55
#include "unstartedappwatcherdialog.h"
56
#include "debuggertooltipmanager.h"
57
#include "localsandexpressionswindow.h"
58
#include "loadcoredialog.h"
59
#include "sourceutils.h"
hjk's avatar
hjk committed
60 61
#include "shared/hostutils.h"
#include "console/console.h"
62

63 64
#include "snapshothandler.h"
#include "threadshandler.h"
65
#include "commonoptionspage.h"
66
#include "gdb/startgdbserverdialog.h"
con's avatar
con committed
67

hjk's avatar
hjk committed
68 69
#include "analyzer/analyzerconstants.h"
#include "analyzer/analyzermanager.h"
70 71
#include "analyzer/analyzerruncontrol.h"
#include "analyzer/analyzerstartparameters.h"
hjk's avatar
hjk committed
72

73
#include <coreplugin/actionmanager/actioncontainer.h>
74
#include <coreplugin/actionmanager/actionmanager.h>
75
#include <coreplugin/actionmanager/command.h>
76 77 78 79
#include <coreplugin/coreconstants.h>
#include <coreplugin/editormanager/documentmodel.h>
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/find/itemviewfind.h>
con's avatar
con committed
80
#include <coreplugin/icore.h>
81
#include <coreplugin/imode.h>
82
#include <coreplugin/messagebox.h>
83
#include <coreplugin/messagemanager.h>
con's avatar
con committed
84
#include <coreplugin/modemanager.h>
85
#include <coreplugin/modemanager.h>
86 87 88
#include <coreplugin/navigationwidget.h>
#include <coreplugin/outputpane.h>
#include <coreplugin/rightpane.h>
hjk's avatar
hjk committed
89

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

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

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

114 115
#include <utils/algorithm.h>
#include <utils/appmainwindow.h>
116
#include <utils/basetreeview.h>
117
#include <utils/checkablemessagebox.h>
118
#include <utils/fancymainwindow.h>
119
#include <utils/hostosinfo.h>
Eike Ziller's avatar
Eike Ziller committed
120
#include <utils/mimetypes/mimedatabase.h>
121
#include <utils/proxyaction.h>
122 123
#include <utils/qtcassert.h>
#include <utils/savedaction.h>
124
#include <utils/statuslabel.h>
125
#include <utils/styledbar.h>
Ulf Hermann's avatar
Ulf Hermann committed
126
#include <utils/utilsicons.h>
hjk's avatar
hjk committed
127
#include <utils/winutils.h>
con's avatar
con committed
128

129
#include <QAction>
Campbell Barton's avatar
Campbell Barton committed
130
#include <QApplication>
hjk's avatar
hjk committed
131
#include <QCheckBox>
132
#include <QComboBox>
133
#include <QDebug>
134 135
#include <QDialog>
#include <QDialogButtonBox>
136 137
#include <QDockWidget>
#include <QFileDialog>
hjk's avatar
hjk committed
138 139
#include <QHBoxLayout>
#include <QHeaderView>
hjk's avatar
hjk committed
140
#include <QInputDialog>
141
#include <QMenu>
142
#include <QMessageBox>
143 144 145
#include <QPointer>
#include <QPushButton>
#include <QSettings>
146
#include <QStackedWidget>
147 148 149
#include <QTextBlock>
#include <QToolButton>
#include <QTreeWidget>
150
#include <QVBoxLayout>
151
#include <QVariant>
152 153
#include <QJsonDocument>
#include <QJsonObject>
154
#include <QtPlugin>
155

hjk's avatar
hjk committed
156
#ifdef WITH_TESTS
157 158 159 160

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

161 162
#include <utils/executeondestruction.h>

163 164 165
#include <QTest>
#include <QSignalSpy>
#include <QTestEventLoop>
166 167 168 169

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

172 173
#endif // WITH_TESTS

174 175
#include <climits>

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

186 187 188 189 190 191 192 193
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
194
    \internal
195 196 197 198 199
*/

/*!
    \class Debugger::DebuggerEngine

200
    \brief The DebuggerEngine class is the base class of a debugger engine.
201

Leena Miettinen's avatar
Leena Miettinen committed
202
    \note The Debugger process itself and any helper processes like
203 204
    gdbserver are referred to as 'Engine', whereas the debugged process
    is referred to as 'Inferior'.
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302

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

\endcode */
hjk's avatar
hjk committed
321

322 323 324
/* 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
325

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


366 367
/*!
    \class Debugger::Internal::GdbEngine
368 369
    \brief The GdbEngine class implements Debugger::Engine driving a GDB
    executable.
370 371 372

    GdbEngine specific startup. All happens in EngineSetupRequested state:

Leena Miettinen's avatar
Leena Miettinen committed
373 374
    \list
        \li Transitions marked by '---' are done in the individual adapters.
375

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

    \code
                  GdbEngine::setupEngine()
                          +
            (calls *Adapter->startAdapter())
                          |      |
                          |      `---> handleAdapterStartFailed()
                          |                   +
                          |             {notifyEngineSetupFailed}
                          |
                 handleAdapterStarted()
                          +
                 {notifyEngineSetupOk}
391 392 393



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

406
\endcode */
407

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

hjk's avatar
hjk committed
417 418 419
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
420
namespace Debugger {
421 422
namespace Internal {

423
void addCdbOptionPages(QList<IOptionsPage*> *opts);
424
void addGdbOptionPages(QList<IOptionsPage*> *opts);
425
QObject *createDebuggerRunControlFactory(QObject *parent);
426

427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
static QIcon visibleStartIcon(Id id, bool toolBarStyle)
{
    if (id == Id(Constants::DEBUG)) {
        const static QIcon sidebarIcon =
                Icon::sideBarIcon(ProjectExplorer::Icons::DEBUG_START, ProjectExplorer::Icons::DEBUG_START_FLAT);
        const static QIcon icon =
                Icon::combinedIcon({ProjectExplorer::Icons::DEBUG_START_SMALL.icon(), sidebarIcon});
        const static QIcon iconToolBar =
                Icon::combinedIcon({ProjectExplorer::Icons::DEBUG_START_SMALL_TOOLBAR.icon(), sidebarIcon});
        return toolBarStyle ? iconToolBar : icon;
    } else if (id == Id(Constants::CONTINUE)) {
        const static QIcon sidebarIcon =
                Icon::sideBarIcon(Icons::CONTINUE, Icons::CONTINUE_FLAT);
        const static QIcon icon =
                Icon::combinedIcon({Icons::DEBUG_CONTINUE_SMALL.icon(), sidebarIcon});
        const static QIcon iconToolBar =
                Icon::combinedIcon({Icons::DEBUG_CONTINUE_SMALL_TOOLBAR.icon(), sidebarIcon});
        return toolBarStyle ? iconToolBar : icon;
    } else if (id == Id(Constants::INTERRUPT)) {
        const static QIcon sidebarIcon =
                Icon::sideBarIcon(Icons::INTERRUPT, Icons::INTERRUPT_FLAT);
        const static QIcon icon =
                Icon::combinedIcon({Icons::DEBUG_INTERRUPT_SMALL.icon(), sidebarIcon});
        const static QIcon iconToolBar =
                Icon::combinedIcon({Icons::DEBUG_INTERRUPT_SMALL_TOOLBAR.icon(), sidebarIcon});
        return toolBarStyle ? iconToolBar : icon;
    }
    return QIcon();
}

457
static void setProxyAction(ProxyAction *proxy, Id id)
458
{
hjk's avatar
hjk committed
459
    proxy->setAction(ActionManager::command(id)->action());
460
    proxy->setIcon(visibleStartIcon(id, true));
461 462
}

463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
QAction *addAction(QMenu *menu, const QString &display, bool on,
                   const std::function<void()> &onTriggered)
{
    QAction *act = menu->addAction(display);
    act->setEnabled(on);
    QObject::connect(act, &QAction::triggered, onTriggered);
    return act;
};

QAction *addAction(QMenu *menu, const QString &d1, const QString &d2, bool on,
                   const std::function<void()> &onTriggered)
{
    return on ? addAction(menu, d1, true, onTriggered) : addAction(menu, d2, false);
};

QAction *addCheckableAction(QMenu *menu, const QString &display, bool on, bool checked,
                            const std::function<void()> &onTriggered)
{
    QAction *act = addAction(menu, display, on, onTriggered);
    act->setCheckable(true);
    act->setChecked(checked);
    return act;
}

487 488 489 490 491 492 493 494 495
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
public:
496
    DummyEngine() : DebuggerEngine(DebuggerRunParameters()) {}
497 498 499 500 501 502 503 504 505 506 507
    ~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 {}
508 509
};

510
bool DummyEngine::hasCapability(unsigned cap) const
511 512
{
    // This can only be a first approximation of what to expect when running.
513
    Project *project = ProjectTree::currentProject();
514 515 516 517 518 519 520 521
    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:
522
    if (activeRc->extraAspect<Debugger::DebuggerRunConfigurationAspect>()->useCppDebugger())
523
        return cap & (WatchpointByAddressCapability
524 525
               | BreakConditionCapability
               | TracePointCapability
526
               | OperateByInstructionCapability);
527 528

    // This is a Qml or unknown engine.
529
    return cap & AddWatcherCapability;
530 531
}

532 533 534 535 536 537
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

538 539 540
class DebugModeContext : public IContext
{
public:
541
    DebugModeContext(QWidget *modeWindow)
542 543
    {
        setContext(Context(CC::C_EDITORMANAGER));
544
        setWidget(modeWindow);
545 546 547 548
        ICore::addContextObject(this);
    }
};

549
class DebugMode : public IMode
hjk's avatar
hjk committed
550 551
{
public:
552
    DebugMode()
553 554
    {
        setObjectName(QLatin1String("DebugMode"));
555
        setContext(Context(C_DEBUGMODE, CC::C_NAVIGATION_PANE));
556
        setDisplayName(DebuggerPlugin::tr("Debug"));
557 558
        setIcon(Utils::Icon::modeIcon(Icons::MODE_DEBUGGER_CLASSIC,
                                      Icons::MODE_DEBUGGER_FLAT, Icons::MODE_DEBUGGER_FLAT_ACTIVE));
559
        setPriority(85);
560
        setId(MODE_DEBUG);
561
    }
562
};
hjk's avatar
hjk committed
563

564 565 566 567 568 569
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

570
static QWidget *addSearch(BaseTreeView *treeView, const QString &title,
571
    const QString &objectName)
572
{
hjk's avatar
hjk committed
573
    QAction *act = action(UseAlternatingRowColors);
574
    treeView->setAlternatingRowColors(act->isChecked());
575
    QObject::connect(act, &QAction::toggled,
576
                     treeView, &BaseTreeView::setAlternatingRowColors);
577

Daniel Teske's avatar
Daniel Teske committed
578
    QWidget *widget = ItemViewFind::createSearchableWrapper(treeView);
579
    widget->setObjectName(objectName);
580 581 582 583
    widget->setWindowTitle(title);
    return widget;
}

584
static std::function<bool(const Kit *)> cdbMatcher(char wordWidth = 0)
585
{
586
    return [wordWidth](const Kit *k) -> bool {
587
        if (DebuggerKitInformation::engineType(k) != CdbEngineType
588
            || DebuggerKitInformation::configurationErrors(k)) {
589
            return false;
590
        }
591 592
        if (wordWidth)
            ToolChainKitInformation::targetAbi(k).wordWidth();
593
        return true;
594 595
    };
}
596

597 598 599 600 601
// 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
602
        if (Kit *cdb64Kit = KitManager::find(KitMatcher(cdbMatcher(64))))
603
            return cdb64Kit;
604
    }
Tobias Hunger's avatar
Tobias Hunger committed
605
    return KitManager::find(KitMatcher(cdbMatcher()));
606
}
607

608 609
///////////////////////////////////////////////////////////////////////
//
610
// DebuggerPluginPrivate
611 612
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
613

614
static DebuggerPluginPrivate *dd = 0;
con's avatar
con committed
615

616 617 618 619
//class DockWidgetEventFilter : public QObject
//{
//public:
//    DockWidgetEventFilter() {}
620

621 622 623
//private:
//    bool eventFilter(QObject *obj, QEvent *event) override;
//};
624

625 626 627 628 629 630 631 632 633 634 635 636 637 638
/*!
    \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.
*/

639
class DebuggerPluginPrivate : public QObject
640 641
{
    Q_OBJECT
642

643 644
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
645
    ~DebuggerPluginPrivate();
646

647
    bool initialize(const QStringList &arguments, QString *errorMessage);
648 649 650
    void extensionsInitialized();
    void aboutToShutdown();

651
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
652
    void disconnectEngine() { connectEngine(0); }
653
    DebuggerEngine *dummyEngine();
654

hjk's avatar
hjk committed
655
    void setThreadBoxContents(const QStringList &list, int index)
656 657 658 659 660 661 662 663
    {
        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);
    }
664 665

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

667 668 669
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
670
//        writeWindowSettings();
671 672
    }

673 674
    void selectThread(int index)
    {
hjk's avatar
hjk committed
675 676
        ThreadId id = m_currentEngine->threadsHandler()->threadAt(index);
        m_currentEngine->selectThread(id);
677
    }
678

679
    void breakpointSetMarginActionTriggered(bool isMessageOnly, const ContextData &data)
680
    {
681
        QString message;
682
        if (isMessageOnly) {
683
            if (data.type == LocationByAddress) {
684 685 686 687
                //: Message tracepoint: Address hit.
                message = tr("0x%1 hit").arg(data.address, 0, 16);
            } else {
                //: Message tracepoint: %1 file, %2 line %3 function hit.
688
                message = tr("%1:%2 %3() hit").arg(FileName::fromString(data.fileName).fileName()).
689 690 691 692 693
                        arg(data.lineNumber).
                        arg(cppFunctionAt(data.fileName, data.lineNumber));
            }
            QInputDialog dialog; // Create wide input dialog.
            dialog.setWindowFlags(dialog.windowFlags()
hjk's avatar
hjk committed
694
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
695 696 697 698 699 700 701 702
            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();
        }
703
        toggleBreakpoint(data, message);
704
    }
705

706
    void updateWatchersHeader(int section, int, int newSize)
707
    {
708 709 710
        if (m_shuttingDown)
            return;

711 712
        m_watchersView->header()->resizeSection(section, newSize);
        m_returnView->header()->resizeSection(section, newSize);
713
    }
714

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

724 725 726 727
    void reloadSourceFiles() { if (m_currentEngine) m_currentEngine->reloadSourceFiles(); }
    void reloadRegisters() { if (m_currentEngine) m_currentEngine->reloadRegisters(); }
    void reloadModules() { if (m_currentEngine) m_currentEngine->reloadModules(); }

728 729
    void editorOpened(IEditor *editor);
    void updateBreakMenuItem(IEditor *editor);
730
    void setBusyCursor(bool busy);
731 732 733
    void requestMark(TextEditorWidget *widget, int lineNumber,
                     TextMarkRequestKind kind);
    void requestContextMenu(TextEditorWidget *widget,
734
                            int lineNumber, QMenu *menu);
735

736 737
    void activatePreviousMode();
    void activateDebugMode();
738 739
    void toggleBreakpointHelper();
    void toggleBreakpoint(const ContextData &location, const QString &tracePointMessage = QString());
hjk's avatar
hjk committed
740
    void onModeChanged(Id mode);
741
    void updateDebugWithoutDeployMenu();
742

743
    void startAndDebugApplication();
744
    void startRemoteCdbSession();
745
    void startRemoteServerAndAttachToProcess();
746
    void attachToRemoteServer();
hjk's avatar
hjk committed
747
    void attachToRunningApplication();
748
    void attachToUnstartedApplicationDialog();
749
    void attachToQmlPort();
750
    void runScheduled();
751
    void attachCore();
752

753
    void enableReverseDebuggingTriggered(const QVariant &value);
754
    void showStatusMessage(const QString &msg, int timeout = -1);
755

756 757
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
758
    void remoteCommand(const QStringList &options);
759

760
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
761 762 763

    void dumpLog();
    void cleanupViews();
764
    void setInitialState();
765

766
    void fontSettingsChanged(const FontSettings &settings);
767 768

    void updateState(DebuggerEngine *engine);
769
    void onCurrentProjectChanged(Project *project);
770 771 772 773

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
774

775
    void coreShutdown();
776

777
public:
778
    void updateDebugActions();
779 780 781

    void handleExecDetach()
    {
782
        currentEngine()->resetLocation();
783 784 785 786 787
        currentEngine()->detachDebugger();
    }

    void handleExecContinue()
    {
788
        currentEngine()->resetLocation();
789 790 791 792 793
        currentEngine()->continueInferior();
    }

    void handleExecInterrupt()
    {
794
        currentEngine()->resetLocation();
795 796 797
        currentEngine()->requestInterruptInferior();
    }

798
    void handleAbort()
799
    {
800
        currentEngine()->resetLocation();
801
        currentEngine()->abortDebugger();
802
    }
hjk's avatar
hjk committed
803

804 805 806 807 808 809
    void handleReset()
    {
        currentEngine()->resetLocation();
        currentEngine()->resetInferior();
    }

hjk's avatar
hjk committed
810 811
    void handleExecStep()
    {
812
        if (currentEngine()->state() == DebuggerNotReady) {
813
            ProjectExplorerPlugin::runStartupProject(ProjectExplorer::Constants::DEBUG_RUN_MODE_WITH_BREAK_ON_MAIN);
814 815 816 817 818 819 820
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeStepI();
            else
                currentEngine()->executeStep();
        }
hjk's avatar
hjk committed
821 822 823 824
    }

    void handleExecNext()
    {
825
        if (currentEngine()->state() == DebuggerNotReady) {
826
            ProjectExplorerPlugin::runStartupProject(ProjectExplorer::Constants::DEBUG_RUN_MODE_WITH_BREAK_ON_MAIN);
827 828 829 830 831 832 833
        } else {
            currentEngine()->resetLocation();
            if (boolSetting(OperateByInstruction))
                currentEngine()->executeNextI();
            else
                currentEngine()->executeNext();
        }
hjk's avatar
hjk committed
834 835
    }

836 837
    void handleExecStepOut()
    {
838
        currentEngine()->resetLocation();
839 840 841 842 843
        currentEngine()->executeStepOut();
    }

    void handleExecReturn()
    {
844
        currentEngine()->resetLocation();
845 846
        currentEngine()->executeReturn();
    }
hjk's avatar
hjk committed
847 848 849

    void handleExecJumpToLine()
    {
850
        currentEngine()->resetLocation();
851 852 853 854 855 856
        if (BaseTextEditor *textEditor = BaseTextEditor::currentTextEditor()) {
            ContextData location = getLocationContext(textEditor->textDocument(),
                                                      textEditor->currentLine());
            if (location.isValid())
                currentEngine()->executeJumpToLine(location);
        }
hjk's avatar
hjk committed
857 858 859 860
    }

    void handleExecRunToLine()
    {
861
        currentEngine()->resetLocation();
862 863 864 865 866 867
        if (BaseTextEditor *textEditor = BaseTextEditor::currentTextEditor()) {
            ContextData location = getLocationContext(textEditor->textDocument(),
                                                      textEditor->currentLine());
            if (location.isValid())
                currentEngine()->executeRunToLine(location);
        }
hjk's avatar
hjk committed
868 869
    }

870
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
871
    {
872
        BaseTextEditor *textEditor = BaseTextEditor::currentTextEditor();
873
        QTC_ASSERT(textEditor, return);
874
        QTextCursor cursor = textEditor->textCursor();
875 876 877 878
        QString functionName = cursor.selectedText();
        if (functionName.isEmpty()) {
            const QTextBlock block = cursor.block();
            const QString line = block.text();
879
            foreach (const QString &str, line.trimmed().split(QLatin1Char('('))) {
880 881 882 883 884 885 886 887 888 889 890 891 892
                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;
                }
            }
        }

893 894 895 896 897 898
        if (functionName.isEmpty()) {
            showStatusMessage(tr("No function selected."));
        } else {
            showStatusMessage(tr("Running to function \"%1\".")
                .arg(functionName));
            currentEngine()->resetLocation();
899
            currentEngine()->executeRunToFunction(functionName);
900
        }
hjk's avatar
hjk committed
901 902 903 904 905
    }

    void handleAddToWatchWindow()
    {
        // Requires a selection, but that's the only case we want anyway.
906
        BaseTextEditor *textEditor = BaseTextEditor::currentTextEditor();
hjk's avatar
hjk committed
907 908
        if (!textEditor)
            return;
909
        QTextCursor tc = textEditor->textCursor();
hjk's avatar
hjk committed
910 911 912 913 914
        QString exp;
        if (tc.hasSelection()) {
            exp = tc.selectedText();
        } else {
            int line, column;
915
            exp = cppExpressionAt(textEditor->editorWidget(), tc.position(), &line, &column);
hjk's avatar
hjk committed
916
        }
917 918 919 920
        if (currentEngine()->hasCapability(WatchComplexExpressionsCapability))
            exp = removeObviousSideEffects(exp);
        else
            exp = fixCppExpression(exp);
921
        exp = exp.trimmed();
hjk's avatar
hjk committed
922 923
        if (exp.isEmpty())
            return;
924
        currentEngine()->watchHandler()->watchVariable(exp);
hjk's avatar
hjk committed
925 926 927 928
    }

    void handleExecExit()
    {
929
        currentEngine()->exitDebugger();
hjk's avatar
hjk committed
930 931 932 933 934 935 936 937 938 939 940 941
    }

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

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

942
    void handleOperateByInstructionTriggered(bool operateByInstructionTriggered)
hjk's avatar
hjk committed
943
    {
944
        // Go to source only if we have the file.
945 946 947 948 949 950
        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));
            }
951
        }
hjk's avatar
hjk committed
952 953
    }

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

956
    bool parseArgument(QStringList::const_iterator &it,