debuggerplugin.cpp 136 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 "debuggeritemmanager.h"
38
#include "debuggermainwindow.h"
39
#include "debuggerrunconfigurationaspect.h"
40
#include "debuggerruncontrol.h"
41
#include "debuggerstringutils.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
#include "analyzer/analyzerconstants.h"
74
#include "analyzer/analyzericons.h"
hjk's avatar
hjk committed
75
#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 87
#include <coreplugin/editormanager/documentmodel.h>
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/find/itemviewfind.h>
#include <coreplugin/findplaceholder.h>
con's avatar
con committed
88
#include <coreplugin/icore.h>
89
#include <coreplugin/imode.h>
90
#include <coreplugin/messagebox.h>
91
#include <coreplugin/messagemanager.h>
con's avatar
con committed
92
#include <coreplugin/modemanager.h>
93
#include <coreplugin/modemanager.h>
94 95 96
#include <coreplugin/navigationwidget.h>
#include <coreplugin/outputpane.h>
#include <coreplugin/rightpane.h>
hjk's avatar
hjk committed
97

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

101
#include <extensionsystem/invoker.h>
102

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

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

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

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

163 164 165 166 167 168 169
using namespace Core;
using namespace Utils;
using namespace Core::Constants;
using namespace ProjectExplorer;
using namespace Debugger;
using namespace Debugger::Internal;

hjk's avatar
hjk committed
170
#ifdef WITH_TESTS
171 172 173
#include <QTest>
#include <QSignalSpy>
#include <QTestEventLoop>
174 175 176 177

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

180 181
#endif // WITH_TESTS

182 183
#include <climits>

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

194 195 196 197 198 199 200 201
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
202
    \internal
203 204 205 206 207
*/

/*!
    \class Debugger::DebuggerEngine

208
    \brief The DebuggerEngine class is the base class of a debugger engine.
209

Leena Miettinen's avatar
Leena Miettinen committed
210
    \note The Debugger process itself and any helper processes like
211 212
    gdbserver are referred to as 'Engine', whereas the debugged process
    is referred to as 'Inferior'.
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 307 308 309 310

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

\endcode */
hjk's avatar
hjk committed
329

330 331 332
/* 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
333

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


374 375
/*!
    \class Debugger::Internal::GdbEngine
376 377
    \brief The GdbEngine class implements Debugger::Engine driving a GDB
    executable.
378 379 380

    GdbEngine specific startup. All happens in EngineSetupRequested state:

Leena Miettinen's avatar
Leena Miettinen committed
381 382
    \list
        \li Transitions marked by '---' are done in the individual adapters.
383

Leena Miettinen's avatar
Leena Miettinen committed
384 385
        \li Transitions marked by '+-+' are done in the GdbEngine.
    \endlist
386 387 388 389 390 391 392 393 394 395 396 397 398

    \code
                  GdbEngine::setupEngine()
                          +
            (calls *Adapter->startAdapter())
                          |      |
                          |      `---> handleAdapterStartFailed()
                          |                   +
                          |             {notifyEngineSetupFailed}
                          |
                 handleAdapterStarted()
                          +
                 {notifyEngineSetupOk}
399 400 401



402 403 404 405 406 407 408 409 410 411 412
                GdbEngine::setupInferior()
                          +
            (calls *Adapter->prepareInferior())
                          |      |
                          |      `---> handlePrepareInferiorFailed()
                          |                   +
                          |             {notifyInferiorSetupFailed}
                          |
                handleInferiorPrepared()
                          +
                {notifyInferiorSetupOk}
413

414
\endcode */
415

con's avatar
con committed
416
using namespace Core;
hjk's avatar
hjk committed
417
using namespace Debugger::Constants;
418
using namespace Debugger::Internal;
419
using namespace ExtensionSystem;
con's avatar
con committed
420
using namespace ProjectExplorer;
hjk's avatar
hjk committed
421
using namespace TextEditor;
422
using namespace Utils;
con's avatar
con committed
423

hjk's avatar
hjk committed
424 425 426
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
427
namespace Debugger {
428 429
namespace Internal {

430 431 432 433 434 435 436 437 438 439
struct TestCallBack
{
    TestCallBack() : receiver(0), slot(0) {}
    TestCallBack(QObject *ob, const char *s) : receiver(ob), slot(s) {}

    QObject *receiver;
    const char *slot;
    QVariant cookie;
};

440
void addCdbOptionPages(QList<IOptionsPage*> *opts);
441
void addGdbOptionPages(QList<IOptionsPage*> *opts);
442
QObject *createDebuggerRunControlFactory(QObject *parent);
443

444
static void setProxyAction(ProxyAction *proxy, Id id)
445
{
hjk's avatar
hjk committed
446
    proxy->setAction(ActionManager::command(id)->action());
447 448
}

449 450 451 452 453 454 455 456 457
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
public:
458
    DummyEngine() : DebuggerEngine(DebuggerRunParameters()) {}
459 460 461 462 463 464 465 466 467 468 469
    ~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 {}
470 471
};

472
bool DummyEngine::hasCapability(unsigned cap) const
473 474
{
    // This can only be a first approximation of what to expect when running.
475
    Project *project = ProjectTree::currentProject();
476 477 478 479 480 481 482 483
    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:
484
    if (activeRc->extraAspect<Debugger::DebuggerRunConfigurationAspect>()->useCppDebugger())
485
        return cap & (WatchpointByAddressCapability
486 487
               | BreakConditionCapability
               | TracePointCapability
488
               | OperateByInstructionCapability);
489 490

    // This is a Qml or unknown engine.
491
    return cap & AddWatcherCapability;
492 493
}

494 495 496 497 498 499
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

500 501 502 503 504 505 506 507 508 509 510 511 512 513
class DebugModeContext : public IContext
{
public:
    DebugModeContext(DebuggerMainWindow *mainWindow) : m_mainWindow(mainWindow)
    {
        setContext(Context(CC::C_EDITORMANAGER));
        ICore::addContextObject(this);
    }

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

    DebuggerMainWindow *m_mainWindow;
};

514
class DebugMode : public IMode
hjk's avatar
hjk committed
515 516
{
public:
517
    DebugMode(DebuggerMainWindow *mainWindow) : m_mainWindow(mainWindow)
518 519
    {
        setObjectName(QLatin1String("DebugMode"));
520
        setContext(Context(C_DEBUGMODE, CC::C_NAVIGATION_PANE));
521
        setDisplayName(DebuggerPlugin::tr("Debug"));
522 523
        setIcon(Utils::Icon::modeIcon(Icons::MODE_DEBUGGER_CLASSIC,
                                      Icons::MODE_DEBUGGER_FLAT, Icons::MODE_DEBUGGER_FLAT_ACTIVE));
524 525
//        setIcon(Utils::Icon::modeIcon(Icons::MODE_ANALYZE_CLASSIC,
//                                      Icons::MODE_ANALYZE_FLAT, Icons::MODE_ANALYZE_FLAT_ACTIVE));
526
        setPriority(85);
527
        setId(MODE_DEBUG);
528
    }
hjk's avatar
hjk committed
529

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

hjk's avatar
hjk committed
532 533
    ~DebugMode()
    {
534
//        delete m_widget;
hjk's avatar
hjk committed
535
    }
536 537

    DebuggerMainWindow *m_mainWindow;
538
};
hjk's avatar
hjk committed
539

540 541 542 543 544 545
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

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

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

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

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

586 587
///////////////////////////////////////////////////////////////////////
//
588
// DebuggerPluginPrivate
589 590
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
591

592
static DebuggerPluginPrivate *dd = 0;
con's avatar
con committed
593

594 595 596 597
//class DockWidgetEventFilter : public QObject
//{
//public:
//    DockWidgetEventFilter() {}
598

599 600 601
//private:
//    bool eventFilter(QObject *obj, QEvent *event) override;
//};
602

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

617
class DebuggerPluginPrivate : public QObject
618 619
{
    Q_OBJECT
620

621 622
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
623
    ~DebuggerPluginPrivate();
624

625
    bool initialize(const QStringList &arguments, QString *errorMessage);
626 627 628
    void extensionsInitialized();
    void aboutToShutdown();

629
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
630
    void disconnectEngine() { connectEngine(0); }
631
    DebuggerEngine *dummyEngine();
632

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

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

645 646 647
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
648
//        writeWindowSettings();
649 650
    }

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

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

684
    void updateWatchersHeader(int section, int, int newSize)
685
    {
686 687
        m_watchersView->header()->resizeSection(section, newSize);
        m_returnView->header()->resizeSection(section, newSize);
688
    }
689

690 691
    void synchronizeBreakpoints()
    {
692
        showMessage(QLatin1String("ATTEMPT SYNC"), LogDebug);
693
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
694
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
695 696 697 698
                engine->attemptBreakpointSynchronization();
        }
    }

699 700
    void editorOpened(IEditor *editor);
    void updateBreakMenuItem(IEditor *editor);
701
    void setBusyCursor(bool busy);
702 703 704
    void requestMark(TextEditorWidget *widget, int lineNumber,
                     TextMarkRequestKind kind);
    void requestContextMenu(TextEditorWidget *widget,
705
                            int lineNumber, QMenu *menu);
706

707 708
    void activatePreviousMode();
    void activateDebugMode();
709 710
    void toggleBreakpointHelper();
    void toggleBreakpoint(const ContextData &location, const QString &tracePointMessage = QString());
711
    void onModeChanged(IMode *mode);
712
    void updateDebugWithoutDeployMenu();
713

714
    void startAndDebugApplication();
715
    void startRemoteCdbSession();
716
    void startRemoteServerAndAttachToProcess();
717
    void attachToRemoteServer();
hjk's avatar
hjk committed
718
    void attachToRunningApplication();
719
    void attachToUnstartedApplicationDialog();
720
    void attachToQmlPort();
hjk's avatar
hjk committed
721
    Q_SLOT void runScheduled();
722
    void attachCore();
723

724
    void enableReverseDebuggingTriggered(const QVariant &value);
725
    void showStatusMessage(const QString &msg, int timeout = -1);
726

727 728
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
729
    void remoteCommand(const QStringList &options);
730

731
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
732 733 734

    void dumpLog();
    void cleanupViews();
735
    void setInitialState();
736

737
    void fontSettingsChanged(const FontSettings &settings);
738 739

    void updateState(DebuggerEngine *engine);
740
    void onCurrentProjectChanged(Project *project);
741 742 743 744

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
745

746
    void coreShutdown();
747

hjk's avatar
hjk committed
748 749
#ifdef WITH_TESTS
public slots:
750
    void testLoadProject(const QString &proFile, const TestCallBack &cb);
751
    void testProjectLoaded(Project *project);
752 753
    void testProjectEvaluated();
    void testProjectBuilt(bool success);
754 755 756
    void testUnloadProject();
    void testFinished();

757
    void testRunProject(const DebuggerRunParameters &sp, const TestCallBack &cb);
hjk's avatar
hjk committed
758
    void testRunControlFinished();
759

hjk's avatar
hjk committed
760 761 762
//    void testStateMachine1();
//    void testStateMachine2();
//    void testStateMachine3();
763

764 765
    void testBenchmark1();

766
public:
hjk's avatar
hjk committed
767
    Project *m_testProject;
768 769 770
    bool m_testSuccess;
    QList<TestCallBack> m_testCallbacks;

hjk's avatar
hjk committed
771 772
#endif

773
public:
774
    void updateDebugActions();
775 776 777

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

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

    void handleExecInterrupt()
    {
790
        currentEngine()->resetLocation();
791 792 793
        currentEngine()->requestInterruptInferior();
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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