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 "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 75
#include "analyzer/analyzerconstants.h"
#include "analyzer/analyzermanager.h"
76 77
#include "analyzer/analyzerruncontrol.h"
#include "analyzer/analyzerstartparameters.h"
hjk's avatar
hjk committed
78

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

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

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

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

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

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

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

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

165 166
#include <utils/executeondestruction.h>

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

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

176 177
#endif // WITH_TESTS

178 179
#include <climits>

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

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

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

/*!
    \class Debugger::DebuggerEngine

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

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

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

\endcode */
hjk's avatar
hjk committed
325

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

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


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

    GdbEngine specific startup. All happens in EngineSetupRequested state:

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

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

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



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

410
\endcode */
411

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

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

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

427
void addCdbOptionPages(QList<IOptionsPage*> *opts);
428
void addGdbOptionPages(QList<IOptionsPage*> *opts);
429
QObject *createDebuggerRunControlFactory(QObject *parent);
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 457 458 459 460
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();
}

461
static void setProxyAction(ProxyAction *proxy, Id id)
462
{
hjk's avatar
hjk committed
463
    proxy->setAction(ActionManager::command(id)->action());
464
    proxy->setIcon(visibleStartIcon(id, true));
465 466
}

467 468 469 470 471 472 473 474 475
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
public:
476
    DummyEngine() : DebuggerEngine(DebuggerRunParameters()) {}
477 478 479 480 481 482 483 484 485 486 487
    ~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 {}
488 489
};

490
bool DummyEngine::hasCapability(unsigned cap) const
491 492
{
    // This can only be a first approximation of what to expect when running.
493
    Project *project = ProjectTree::currentProject();
494 495 496 497 498 499 500 501
    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:
502
    if (activeRc->extraAspect<Debugger::DebuggerRunConfigurationAspect>()->useCppDebugger())
503
        return cap & (WatchpointByAddressCapability
504 505
               | BreakConditionCapability
               | TracePointCapability
506
               | OperateByInstructionCapability);
507 508

    // This is a Qml or unknown engine.
509
    return cap & AddWatcherCapability;
510 511
}

512 513 514 515 516 517
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

518 519 520
class DebugModeContext : public IContext
{
public:
521
    DebugModeContext(QWidget *modeWindow)
522 523
    {
        setContext(Context(CC::C_EDITORMANAGER));
524
        setWidget(modeWindow);
525 526 527 528
        ICore::addContextObject(this);
    }
};

529
class DebugMode : public IMode
hjk's avatar
hjk committed
530 531
{
public:
532
    DebugMode()
533 534
    {
        setObjectName(QLatin1String("DebugMode"));
535
        setContext(Context(C_DEBUGMODE, CC::C_NAVIGATION_PANE));
536
        setDisplayName(DebuggerPlugin::tr("Debug"));
537 538
        setIcon(Utils::Icon::modeIcon(Icons::MODE_DEBUGGER_CLASSIC,
                                      Icons::MODE_DEBUGGER_FLAT, Icons::MODE_DEBUGGER_FLAT_ACTIVE));
539
        setPriority(85);
540
        setId(MODE_DEBUG);
541
    }
542
};
hjk's avatar
hjk committed
543

544 545 546 547 548 549
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

550
static QWidget *addSearch(BaseTreeView *treeView, const QString &title,
551
    const char *objectName)
552
{
hjk's avatar
hjk committed
553
    QAction *act = action(UseAlternatingRowColors);
554
    treeView->setAlternatingRowColors(act->isChecked());
555 556
    QObject::connect(act, &QAction::toggled,
                     treeView, &BaseTreeView::setAlternatingRowColorsHelper);
557

Daniel Teske's avatar
Daniel Teske committed
558
    QWidget *widget = ItemViewFind::createSearchableWrapper(treeView);
559 560 561 562 563
    widget->setObjectName(QLatin1String(objectName));
    widget->setWindowTitle(title);
    return widget;
}

564
static std::function<bool(const Kit *)> cdbMatcher(char wordWidth = 0)
565
{
566
    return [wordWidth](const Kit *k) -> bool {
567 568
        if (DebuggerKitInformation::engineType(k) != CdbEngineType
            || !DebuggerKitInformation::isValidDebugger(k)) {
569
            return false;
570
        }
571
        if (wordWidth) {
572
            const ToolChain *tc = ToolChainKitInformation::toolChain(k);
573
            return tc && wordWidth == tc->targetAbi().wordWidth();
574
        }
575
        return true;
576 577
    };
}
578

579 580 581 582 583
// 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
584
        if (Kit *cdb64Kit = KitManager::find(KitMatcher(cdbMatcher(64))))
585
            return cdb64Kit;
586
    }
Tobias Hunger's avatar
Tobias Hunger committed
587
    return KitManager::find(KitMatcher(cdbMatcher()));
588
}
589

590 591
///////////////////////////////////////////////////////////////////////
//
592
// DebuggerPluginPrivate
593 594
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
595

596
static DebuggerPluginPrivate *dd = 0;
con's avatar
con committed
597

598 599 600 601
//class DockWidgetEventFilter : public QObject
//{
//public:
//    DockWidgetEventFilter() {}
602

603 604 605
//private:
//    bool eventFilter(QObject *obj, QEvent *event) override;
//};
606

607 608 609 610 611 612 613 614 615 616 617 618 619 620
/*!
    \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.
*/

621
class DebuggerPluginPrivate : public QObject
622 623
{
    Q_OBJECT
624

625 626
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
627
    ~DebuggerPluginPrivate();
628

629
    bool initialize(const QStringList &arguments, QString *errorMessage);
630 631 632
    void extensionsInitialized();
    void aboutToShutdown();

633
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
634
    void disconnectEngine() { connectEngine(0); }
635
    DebuggerEngine *dummyEngine();
636

hjk's avatar
hjk committed
637
    void setThreadBoxContents(const QStringList &list, int index)
638 639 640 641 642 643 644 645
    {
        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);
    }
646 647

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

649 650 651
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
652
//        writeWindowSettings();
653 654
    }

655 656
    void selectThread(int index)
    {
hjk's avatar
hjk committed
657 658
        ThreadId id = m_currentEngine->threadsHandler()->threadAt(index);
        m_currentEngine->selectThread(id);
659
    }
660

661
    void breakpointSetMarginActionTriggered(bool isMessageOnly, const ContextData &data)
662
    {
663
        QString message;
664
        if (isMessageOnly) {
665
            if (data.type == LocationByAddress) {
666 667 668 669
                //: Message tracepoint: Address hit.
                message = tr("0x%1 hit").arg(data.address, 0, 16);
            } else {
                //: Message tracepoint: %1 file, %2 line %3 function hit.
670
                message = tr("%1:%2 %3() hit").arg(FileName::fromString(data.fileName).fileName()).
671 672 673 674 675
                        arg(data.lineNumber).
                        arg(cppFunctionAt(data.fileName, data.lineNumber));
            }
            QInputDialog dialog; // Create wide input dialog.
            dialog.setWindowFlags(dialog.windowFlags()
hjk's avatar
hjk committed
676
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
677 678 679 680 681 682 683 684
            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();
        }
685
        toggleBreakpoint(data, message);
686
    }
687

688
    void updateWatchersHeader(int section, int, int newSize)
689
    {
690 691 692
        if (m_shuttingDown)
            return;

693 694
        m_watchersView->header()->resizeSection(section, newSize);
        m_returnView->header()->resizeSection(section, newSize);
695
    }
696

697 698
    void synchronizeBreakpoints()
    {
699
        showMessage(QLatin1String("ATTEMPT SYNC"), LogDebug);
700
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
701
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
702 703 704 705
                engine->attemptBreakpointSynchronization();
        }
    }

706 707
    void editorOpened(IEditor *editor);
    void updateBreakMenuItem(IEditor *editor);
708
    void setBusyCursor(bool busy);
709 710 711
    void requestMark(TextEditorWidget *widget, int lineNumber,
                     TextMarkRequestKind kind);
    void requestContextMenu(TextEditorWidget *widget,
712
                            int lineNumber, QMenu *menu);
713

714 715
    void activatePreviousMode();
    void activateDebugMode();
716 717
    void toggleBreakpointHelper();
    void toggleBreakpoint(const ContextData &location, const QString &tracePointMessage = QString());
hjk's avatar
hjk committed
718
    void onModeChanged(Id mode);
719
    void updateDebugWithoutDeployMenu();
720

721
    void startAndDebugApplication();
722
    void startRemoteCdbSession();
723
    void startRemoteServerAndAttachToProcess();
724
    void attachToRemoteServer();
hjk's avatar
hjk committed
725
    void attachToRunningApplication();
726
    void attachToUnstartedApplicationDialog();
727
    void attachToQmlPort();
728
    void runScheduled();
729
    void attachCore();
730

731
    void enableReverseDebuggingTriggered(const QVariant &value);
732
    void showStatusMessage(const QString &msg, int timeout = -1);
733

734 735
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
736
    void remoteCommand(const QStringList &options);
737

738
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
739 740 741

    void dumpLog();
    void cleanupViews();
742
    void setInitialState();
743

744
    void fontSettingsChanged(const FontSettings &settings);
745 746

    void updateState(DebuggerEngine *engine);
747
    void onCurrentProjectChanged(Project *project);
748 749 750 751

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
752

753
    void coreShutdown();
754

755
public:
756
    void updateDebugActions();
757 758 759

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

920
    void handleOperateByInstructionTriggered(bool operateByInstructionTriggered)
hjk's avatar
hjk committed
921
    {
922
        // Go to source only if we have the file.
923 924 925 926 927 928
        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));
            }
929
        }
hjk's avatar
hjk committed
930 931
    }

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

934
    bool parseArgument(QStringList::const_iterator &it,
935 936
        const QStringList::const_iterator &cend, QString *errorMessage);
    bool parseArguments(const QStringList &args, QString *errorMessage);
937
    void parseCommandLineArguments();
938

939 940 941 942 943 944 945
    // 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();
946

947
public:
948 949 950
    QPointer<DebuggerMainWindow> m_mainWindow;