debuggerplugin.cpp 141 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 "breakwindow.h"
47
#include "disassemblerlines.h"
48
#include "logwindow.h"
49
#include "moduleswindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
50
#include "moduleshandler.h"
51 52
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
53
#include "stackhandler.h"
54 55 56
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
57
#include "watchhandler.h"
58
#include "watchwindow.h"
hjk's avatar
hjk committed
59
#include "watchutils.h"
60
#include "unstartedappwatcherdialog.h"
61
#include "debuggertooltipmanager.h"
62
#include "localsandexpressionswindow.h"
63
#include "loadcoredialog.h"
64
#include "sourceutils.h"
hjk's avatar
hjk committed
65 66
#include "shared/hostutils.h"
#include "console/console.h"
67

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

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

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

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

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

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

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

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

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

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

164 165
#include <utils/executeondestruction.h>

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

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

175 176
#endif // WITH_TESTS

177 178
#include <climits>

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

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

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

/*!
    \class Debugger::DebuggerEngine

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

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

    Transitions marked by '---' are done in the individual engines.
    Transitions marked by '+-+' are done in the base DebuggerEngine.
    Transitions marked by '*' are done asynchronously.

    The GdbEngine->setupEngine() function is described in more detail below.

    The engines are responsible for local roll-back to the last
    acknowledged state before calling notify*Failed. I.e. before calling
    notifyEngineSetupFailed() any process started during setupEngine()
    so far must be terminated.
    \code

                        DebuggerNotReady
                         progressmanager/progressmanager.cpp      +
                      EngineSetupRequested
                               +
                  (calls *Engine->setupEngine())
                            |      |
                            |      |
                       {notify-  {notify-
                        Engine-   Engine-
                        SetupOk}  SetupFailed}
                            +      +
                            +      `+-+-+> EngineSetupFailed
                            +                   +
                            +    [calls RunControl->startFailed]
                            +                   +
                            +             DebuggerFinished
                            v
                      EngineSetupOk
                            +
             [calls RunControl->StartSuccessful]
                            +
                  InferiorSetupRequested
                            +
             (calls *Engine->setupInferior())
                         |       |
                         |       |
                    {notify-   {notify-
                     Inferior- Inferior-
                     SetupOk}  SetupFailed}
                         +       +
                         +       ` +-+-> InferiorSetupFailed +-+-+-+-+-+->.
                         +                                                +
                  InferiorSetupOk                                         +
                         +                                                +
                  EngineRunRequested                                      +
                         +                                                +
                 (calls *Engine->runEngine())                             +
               /       |            |        \                            +
             /         |            |          \                          +
            | (core)   | (attach)   |           |                         +
            |          |            |           |                         +
      {notify-    {notifyER&- {notifyER&-  {notify-                       +
      Inferior-     Inferior-   Inferior-  EngineRun-                     +
     Unrunnable}     StopOk}     RunOk}     Failed}                       +
           +           +            +           +                         +
   InferiorUnrunnable  +     InferiorRunOk      +                         +
                       +                        +                         +
                InferiorStopOk            EngineRunFailed                 +
                                                +                         v
                                                 `-+-+-+-+-+-+-+-+-+-+-+>-+
                                                                          +
                                                                          +
                       #Interrupt@InferiorRunOk#                          +
                                  +                                       +
                          InferiorStopRequested                           +
  #SpontaneousStop                +                                       +
   @InferiorRunOk#         (calls *Engine->                               +
          +               interruptInferior())                            +
      {notify-               |          |                                 +
     Spontaneous-       {notify-    {notify-                              +
      Inferior-          Inferior-   Inferior-                            +
       StopOk}           StopOk}    StopFailed}                           +
           +              +             +                                 +
            +            +              +                                 +
            InferiorStopOk              +                                 +
                  +                     +                                 +
                  +                    +                                  +
                  +                   +                                   +
        #Stop@InferiorUnrunnable#    +                                    +
          #Creator Close Event#     +                                     +
                       +           +                                      +
                InferiorShutdownRequested                                 +
                            +                                             +
           (calls *Engine->shutdownInferior())                            +
                         |        |                                       +
                    {notify-   {notify-                                   +
                     Inferior- Inferior-                                  +
                  ShutdownOk}  ShutdownFailed}                            +
                         +        +                                       +
                         +        +                                       +
  #Inferior exited#      +        +                                       +
         |               +        +                                       +
   {notifyInferior-      +        +                                       +
      Exited}            +        +                                       +
           +             +        +                                       +
306
            +            +        +                                       +
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
             +           +        +                                       +
            InferiorShutdownOk InferiorShutdownFailed                     +
                      *          *                                        +
                  EngineShutdownRequested                                 +
                            +                                             +
           (calls *Engine->shutdownEngine())  <+-+-+-+-+-+-+-+-+-+-+-+-+-+'
                         |        |
                         |        |
                    {notify-   {notify-
                     Engine-    Engine-
                  ShutdownOk}  ShutdownFailed}
                         +       +
            EngineShutdownOk  EngineShutdownFailed
                         *       *
                     DebuggerFinished

\endcode */
hjk's avatar
hjk committed
324

325 326 327
/* Here is a matching graph as a GraphViz graph. View it using
 * \code
grep "^sg1:" debuggerplugin.cpp | cut -c5- | dot -osg1.ps -Tps && gv sg1.ps
328

329 330 331 332 333 334
sg1: digraph DebuggerStates {
sg1:   DebuggerNotReady -> EngineSetupRequested
sg1:   EngineSetupRequested -> EngineSetupOk [ label="notifyEngineSetupOk", style="dashed" ];
sg1:   EngineSetupRequested -> EngineSetupFailed [ label= "notifyEngineSetupFailed", style="dashed"];
sg1:   EngineSetupFailed -> DebuggerFinished [ label= "RunControl::StartFailed" ];
sg1:   EngineSetupOk -> InferiorSetupRequested [ label= "RunControl::StartSuccessful" ];
335
sg1:   InferiorSetupRequested -> InferiorSetupOk [ label="notifyInferiorSetupOk", style="dashed" ];
336
sg1:   InferiorSetupRequested -> InferiorSetupFailed [ label="notifyInferiorFailed", style="dashed" ];
337
sg1:   InferiorSetupOk -> EngineRunRequested
338 339 340 341 342 343 344 345 346 347 348 349 350 351
sg1:   InferiorSetupFailed -> EngineShutdownRequested
sg1:   EngineRunRequested -> InferiorUnrunnable [ label="notifyInferiorUnrunnable", style="dashed" ];
sg1:   EngineRunRequested -> InferiorStopOk [ label="notifyEngineRunAndInferiorStopOk", style="dashed" ];
sg1:   EngineRunRequested -> InferiorRunOk [ label="notifyEngineRunAndInferiorRunOk", style="dashed" ];
sg1:   EngineRunRequested -> EngineRunFailed [ label="notifyEngineRunFailed", style="dashed" ];
sg1:   EngineRunFailed -> EngineShutdownRequested
sg1:   InferiorRunOk -> InferiorStopOk [ label="SpontaneousStop\nnotifyInferiorSpontaneousStop", style="dashed" ];
sg1:   InferiorRunOk -> InferiorStopRequested [ label="User stop\nEngine::interruptInferior", style="dashed"];
sg1:   InferiorStopRequested -> InferiorStopOk [ label="notifyInferiorStopOk", style="dashed" ];
sg1:   InferiorStopRequested -> InferiorShutdownRequested  [ label="notifyInferiorStopFailed", style="dashed" ];
sg1:   InferiorStopOk -> InferiorRunRequested [ label="User\nEngine::continueInferior" ];
sg1:   InferiorRunRequested -> InferiorRunOk [ label="notifyInferiorRunOk", style="dashed"];
sg1:   InferiorRunRequested -> InferiorRunFailed [ label="notifyInferiorRunFailed", style="dashed"];
sg1:   InferiorRunFailed -> InferiorStopOk
352 353
sg1:   InferiorStopOk -> InferiorShutdownRequested [ label="Close event" ];
sg1:   InferiorUnrunnable -> InferiorShutdownRequested [ label="Close event" ];
354 355
sg1:   InferiorShutdownRequested -> InferiorShutdownOk [ label= "Engine::shutdownInferior\nnotifyInferiorShutdownOk", style="dashed" ];
sg1:   InferiorShutdownRequested -> InferiorShutdownFailed [ label="Engine::shutdownInferior\nnotifyInferiorShutdownFailed", style="dashed" ];
356 357
sg1:   InferiorExited -> InferiorExitOk [ label="notifyInferiorExited", style="dashed"];
sg1:   InferiorExitOk -> InferiorShutdownOk
358 359 360 361 362 363 364 365
sg1:   InferiorShutdownOk -> EngineShutdownRequested
sg1:   InferiorShutdownFailed -> EngineShutdownRequested
sg1:   EngineShutdownRequested -> EngineShutdownOk [ label="Engine::shutdownEngine\nnotifyEngineShutdownOk", style="dashed" ];
sg1:   EngineShutdownRequested -> EngineShutdownFailed  [ label="Engine::shutdownEngine\nnotifyEngineShutdownFailed", style="dashed" ];
sg1:   EngineShutdownOk -> DebuggerFinished  [ style = "dotted" ];
sg1:   EngineShutdownFailed  -> DebuggerFinished [ style = "dotted" ];
sg1: }
* \endcode */
hjk's avatar
hjk committed
366
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
367 368


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

    GdbEngine specific startup. All happens in EngineSetupRequested state:

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

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

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



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

409
\endcode */
410

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

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

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

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

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

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

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

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

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

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

511 512 513 514 515 516
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

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

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

543 544 545 546 547 548
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

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

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

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

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

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

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

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

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

620
class DebuggerPluginPrivate : public QObject
621 622
{
    Q_OBJECT
623

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
751

752
    void coreShutdown();
753

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

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

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

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

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

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

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

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

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

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

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

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

847
    void handleExecRunToSelectedFunction()
hjk's avatar
hjk committed
848
    {
849
        BaseTextEditor *textEditor = BaseTextEditor::currentTextEditor();
850
        QTC_ASSERT(textEditor, return);
851
        QTextCursor cursor = textEditor->textCursor();
852 853 854 855
        QString functionName = cursor.selectedText();
        if (functionName.isEmpty()) {
            const QTextBlock block = cursor.block();
            const QString line = block.text();
856
            foreach (const QString &str, line.trimmed().split(QLatin1Char('('))) {
857 858 859 860 861 862 863 864 865 866 867 868 869
                QString a;
                for (int i = str.size(); --i >= 0; ) {
                    if (!str.at(i).isLetterOrNumber())
                        break;
                    a = str.at(i) + a;
                }
                if (!a.isEmpty()) {
                    functionName = a;
                    break;
                }
            }
        }

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

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

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

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

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

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

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

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

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