debuggerplugin.cpp 143 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
#include <coreplugin/coreconstants.h>
77
#include <coreplugin/coreicons.h>
78 79 80
#include <coreplugin/editormanager/documentmodel.h>
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/find/itemviewfind.h>
con's avatar
con committed
81
#include <coreplugin/icore.h>
82
#include <coreplugin/imode.h>
83
#include <coreplugin/messagebox.h>
84
#include <coreplugin/messagemanager.h>
con's avatar
con committed
85
#include <coreplugin/modemanager.h>
86
#include <coreplugin/modemanager.h>
87 88 89
#include <coreplugin/navigationwidget.h>
#include <coreplugin/outputpane.h>
#include <coreplugin/rightpane.h>
hjk's avatar
hjk committed
90

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

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

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

115 116
#include <utils/algorithm.h>
#include <utils/appmainwindow.h>
117
#include <utils/basetreeview.h>
118
#include <utils/checkablemessagebox.h>
119
#include <utils/fancymainwindow.h>
120
#include <utils/hostosinfo.h>
Eike Ziller's avatar
Eike Ziller committed
121
#include <utils/mimetypes/mimedatabase.h>
122
#include <utils/proxyaction.h>
123 124
#include <utils/qtcassert.h>
#include <utils/savedaction.h>
125
#include <utils/statuslabel.h>
126
#include <utils/styledbar.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
#include <QtPlugin>
153

hjk's avatar
hjk committed
154
#ifdef WITH_TESTS
155 156 157 158

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

159 160
#include <utils/executeondestruction.h>

161 162 163
#include <QTest>
#include <QSignalSpy>
#include <QTestEventLoop>
164 165 166 167

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

170 171
#endif // WITH_TESTS

172 173
#include <climits>

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

184 185 186 187 188 189 190 191
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

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

/*!
    \class Debugger::DebuggerEngine

198
    \brief The DebuggerEngine class is the base class of a debugger engine.
199

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

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

\endcode */
hjk's avatar
hjk committed
319

320 321 322
/* 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
323

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


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

    GdbEngine specific startup. All happens in EngineSetupRequested state:

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

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

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



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

404
\endcode */
405

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

hjk's avatar
hjk committed
415 416 417
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
418
namespace Debugger {
419 420
namespace Internal {

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

425 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
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();
}

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

461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
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;
}

485 486 487 488 489 490 491 492 493
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

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

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

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

530 531 532 533 534 535
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

562 563 564 565 566 567
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

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

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

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

606 607
///////////////////////////////////////////////////////////////////////
//
608
// DebuggerPluginPrivate
609 610
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
611

612
static DebuggerPluginPrivate *dd = 0;
con's avatar
con committed
613

614 615 616 617
//class DockWidgetEventFilter : public QObject
//{
//public:
//    DockWidgetEventFilter() {}
618

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

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

637
class DebuggerPluginPrivate : public QObject
638 639
{
    Q_OBJECT
640

641 642
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
643
    ~DebuggerPluginPrivate();
644

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

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

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

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

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

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

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

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

709 710
        m_watchersView->header()->resizeSection(section, newSize);
        m_returnView->header()->resizeSection(section, newSize);
711
    }
712

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

722 723 724 725
    void reloadSourceFiles() { if (m_currentEngine) m_currentEngine->reloadSourceFiles(); }
    void reloadRegisters() { if (m_currentEngine) m_currentEngine->reloadRegisters(); }
    void reloadModules() { if (m_currentEngine) m_currentEngine->reloadModules(); }

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

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

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

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

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

758
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
759 760 761

    void dumpLog();
    void cleanupViews();
762
    void setInitialState();
763

764
    void fontSettingsChanged(const FontSettings &settings);
765 766

    void updateState(DebuggerEngine *engine);
767
    void onCurrentProjectChanged(Project *project);
768 769 770 771

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
772

773
    void coreShutdown();
774

775
public:
776
    void updateDebugActions();
777 778 779

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

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

    void handleExecInterrupt()
    {
792
        currentEngine()->resetLocation();
793 794 795
        currentEngine()->requestInterruptInferior();
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

954
    bool parseArgument(QStringList::const_iterator &it,
955 956
        const QStringList::const_iterator &cend, QString *errorMessage);
    bool parseArguments(const QStringList &args, QString *errorMessage);