debuggerplugin.cpp 122 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"

Friedemann Kleint's avatar
Friedemann Kleint committed
28
#include "debuggerstartparameters.h"
29
#include "debuggeractions.h"
30
#include "debuggerinternalconstants.h"
31
#include "debuggercore.h"
32
#include "debuggerkitconfigwidget.h"
33 34
#include "debuggerdialogs.h"
#include "debuggerengine.h"
35
#include "debuggericons.h"
36
#include "debuggeritemmanager.h"
37
#include "debuggermainwindow.h"
38
#include "debuggerrunconfigurationaspect.h"
39
#include "debuggerruncontrol.h"
40
#include "debuggerstringutils.h"
41
#include "debuggeroptionspage.h"
Tobias Hunger's avatar
Tobias Hunger committed
42
#include "debuggerkitinformation.h"
43
#include "memoryagent.h"
44
#include "breakhandler.h"
45
#include "breakwindow.h"
46
#include "disassemblerlines.h"
47
#include "logwindow.h"
48
#include "moduleswindow.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
49
#include "moduleshandler.h"
50 51
#include "registerwindow.h"
#include "snapshotwindow.h"
hjk's avatar
hjk committed
52
#include "stackhandler.h"
53 54 55
#include "stackwindow.h"
#include "sourcefileswindow.h"
#include "threadswindow.h"
hjk's avatar
hjk committed
56
#include "watchhandler.h"
57
#include "watchwindow.h"
hjk's avatar
hjk committed
58
#include "watchutils.h"
59
#include "unstartedappwatcherdialog.h"
60
#include "debuggertooltipmanager.h"
61
#include "localsandexpressionswindow.h"
62
#include "loadcoredialog.h"
63
#include "sourceutils.h"
hjk's avatar
hjk committed
64 65
#include "shared/hostutils.h"
#include "console/console.h"
66

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

hjk's avatar
hjk committed
72 73 74
#include "analyzer/analyzerconstants.h"
#include "analyzer/analyzermanager.h"

75
#include <coreplugin/actionmanager/actionmanager.h>
76
#include <coreplugin/actionmanager/actioncontainer.h>
77
#include <coreplugin/actionmanager/command.h>
Daniel Teske's avatar
Daniel Teske committed
78
#include <coreplugin/find/itemviewfind.h>
79
#include <coreplugin/imode.h>
80
#include <coreplugin/coreicons.h>
con's avatar
con committed
81
#include <coreplugin/icore.h>
82
#include <coreplugin/messagebox.h>
83
#include <coreplugin/messagemanager.h>
con's avatar
con committed
84
#include <coreplugin/modemanager.h>
85 86
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/editormanager/documentmodel.h>
hjk's avatar
hjk committed
87

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

91
#include <extensionsystem/invoker.h>
92

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

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

113
#include <utils/basetreeview.h>
114
#include <utils/hostosinfo.h>
Eike Ziller's avatar
Eike Ziller committed
115
#include <utils/mimetypes/mimedatabase.h>
116
#include <utils/proxyaction.h>
117 118
#include <utils/qtcassert.h>
#include <utils/savedaction.h>
119
#include <utils/statuslabel.h>
120
#include <utils/styledbar.h>
hjk's avatar
hjk committed
121
#include <utils/winutils.h>
con's avatar
con committed
122

Campbell Barton's avatar
Campbell Barton committed
123
#include <QApplication>
hjk's avatar
hjk committed
124
#include <QCheckBox>
125
#include <QComboBox>
126 127
#include <QDockWidget>
#include <QFileDialog>
hjk's avatar
hjk committed
128 129
#include <QHBoxLayout>
#include <QHeaderView>
hjk's avatar
hjk committed
130
#include <QInputDialog>
131 132 133
#include <QMessageBox>
#include <QTextBlock>
#include <QToolButton>
hjk's avatar
hjk committed
134
#include <QtPlugin>
135
#include <QTreeWidget>
136
#include <QVBoxLayout>
137
#include <QMenu>
138

hjk's avatar
hjk committed
139
#ifdef WITH_TESTS
140 141 142
#include <QTest>
#include <QSignalSpy>
#include <QTestEventLoop>
143 144 145 146

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

149 150
#endif // WITH_TESTS

151 152
#include <climits>

153 154 155 156 157
#define DEBUG_STATE 1
#ifdef DEBUG_STATE
//#   define STATE_DEBUG(s)
//    do { QString msg; QTextStream ts(&msg); ts << s;
//      showMessage(msg, LogDebug); } while (0)
158
#   define STATE_DEBUG(s) do { qDebug() << s; } while (0)
159 160 161 162
#else
#   define STATE_DEBUG(s)
#endif

163 164 165 166 167 168 169 170
/*!
    \namespace Debugger
    Debugger plugin namespace
*/

/*!
    \namespace Debugger::Internal
    Internal namespace of the Debugger plugin
171
    \internal
172 173 174 175 176
*/

/*!
    \class Debugger::DebuggerEngine

177
    \brief The DebuggerEngine class is the base class of a debugger engine.
178

Leena Miettinen's avatar
Leena Miettinen committed
179
    \note The Debugger process itself and any helper processes like
180 181
    gdbserver are referred to as 'Engine', whereas the debugged process
    is referred to as 'Inferior'.
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279

    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}            +        +                                       +
           +             +        +                                       +
280
            +            +        +                                       +
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
             +           +        +                                       +
            InferiorShutdownOk InferiorShutdownFailed                     +
                      *          *                                        +
                  EngineShutdownRequested                                 +
                            +                                             +
           (calls *Engine->shutdownEngine())  <+-+-+-+-+-+-+-+-+-+-+-+-+-+'
                         |        |
                         |        |
                    {notify-   {notify-
                     Engine-    Engine-
                  ShutdownOk}  ShutdownFailed}
                         +       +
            EngineShutdownOk  EngineShutdownFailed
                         *       *
                     DebuggerFinished

\endcode */
hjk's avatar
hjk committed
298

299 300 301
/* 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
302

303 304 305 306 307 308
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" ];
309
sg1:   InferiorSetupRequested -> InferiorSetupOk [ label="notifyInferiorSetupOk", style="dashed" ];
310
sg1:   InferiorSetupRequested -> InferiorSetupFailed [ label="notifyInferiorFailed", style="dashed" ];
311
sg1:   InferiorSetupOk -> EngineRunRequested
312 313 314 315 316 317 318 319 320 321 322 323 324 325
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
326 327
sg1:   InferiorStopOk -> InferiorShutdownRequested [ label="Close event" ];
sg1:   InferiorUnrunnable -> InferiorShutdownRequested [ label="Close event" ];
328 329
sg1:   InferiorShutdownRequested -> InferiorShutdownOk [ label= "Engine::shutdownInferior\nnotifyInferiorShutdownOk", style="dashed" ];
sg1:   InferiorShutdownRequested -> InferiorShutdownFailed [ label="Engine::shutdownInferior\nnotifyInferiorShutdownFailed", style="dashed" ];
330 331
sg1:   InferiorExited -> InferiorExitOk [ label="notifyInferiorExited", style="dashed"];
sg1:   InferiorExitOk -> InferiorShutdownOk
332 333 334 335 336 337 338 339
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
340
// Additional signalling:    {notifyInferiorIll}   {notifyEngineIll}
hjk's avatar
hjk committed
341 342


343 344
/*!
    \class Debugger::Internal::GdbEngine
345 346
    \brief The GdbEngine class implements Debugger::Engine driving a GDB
    executable.
347 348 349

    GdbEngine specific startup. All happens in EngineSetupRequested state:

Leena Miettinen's avatar
Leena Miettinen committed
350 351
    \list
        \li Transitions marked by '---' are done in the individual adapters.
352

Leena Miettinen's avatar
Leena Miettinen committed
353 354
        \li Transitions marked by '+-+' are done in the GdbEngine.
    \endlist
355 356 357 358 359 360 361 362 363 364 365 366 367

    \code
                  GdbEngine::setupEngine()
                          +
            (calls *Adapter->startAdapter())
                          |      |
                          |      `---> handleAdapterStartFailed()
                          |                   +
                          |             {notifyEngineSetupFailed}
                          |
                 handleAdapterStarted()
                          +
                 {notifyEngineSetupOk}
368 369 370



371 372 373 374 375 376 377 378 379 380 381
                GdbEngine::setupInferior()
                          +
            (calls *Adapter->prepareInferior())
                          |      |
                          |      `---> handlePrepareInferiorFailed()
                          |                   +
                          |             {notifyInferiorSetupFailed}
                          |
                handleInferiorPrepared()
                          +
                {notifyInferiorSetupOk}
382

383
\endcode */
384

con's avatar
con committed
385
using namespace Core;
hjk's avatar
hjk committed
386
using namespace Debugger::Constants;
387
using namespace Debugger::Internal;
388
using namespace ExtensionSystem;
con's avatar
con committed
389
using namespace ProjectExplorer;
hjk's avatar
hjk committed
390
using namespace TextEditor;
391
using namespace Utils;
con's avatar
con committed
392

hjk's avatar
hjk committed
393 394 395
using namespace Analyzer;
//using namespace Analyzer::Internal;

hjk's avatar
hjk committed
396 397 398
namespace CC = Core::Constants;
namespace PE = ProjectExplorer::Constants;

con's avatar
con committed
399 400

namespace Debugger {
401 402
namespace Internal {

403 404 405 406 407 408 409 410 411 412 413
struct TestCallBack
{
    TestCallBack() : receiver(0), slot(0) {}
    TestCallBack(QObject *ob, const char *s) : receiver(ob), slot(s) {}

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


414 415 416
} // namespace Internal
} // namespace Debugger

417 418
Q_DECLARE_METATYPE(Debugger::Internal::TestCallBack)

419 420 421
namespace Debugger {
namespace Internal {

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

426 427 428 429 430 431 432
static QToolButton *toolButton(QAction *action)
{
    QToolButton *button = new QToolButton;
    button->setDefaultAction(action);
    return button;
}

433
static void setProxyAction(ProxyAction *proxy, Id id)
434
{
hjk's avatar
hjk committed
435
    proxy->setAction(ActionManager::command(id)->action());
436 437
}

438
static QToolButton *toolButton(Id id)
439
{
hjk's avatar
hjk committed
440
    return toolButton(ActionManager::command(id)->action());
441 442
}

443 444 445 446 447 448 449 450 451
///////////////////////////////////////////////////////////////////////
//
// DummyEngine
//
///////////////////////////////////////////////////////////////////////

class DummyEngine : public DebuggerEngine
{
public:
452
    DummyEngine() : DebuggerEngine(DebuggerRunParameters()) {}
453 454 455 456 457 458 459
    ~DummyEngine() {}

    void setupEngine() {}
    void setupInferior() {}
    void runEngine() {}
    void shutdownEngine() {}
    void shutdownInferior() {}
460
    bool hasCapability(unsigned cap) const;
461
    bool acceptsBreakpoint(Breakpoint) const { return false; }
462
    bool acceptsDebuggerCommands() const { return false; }
hjk's avatar
hjk committed
463
    void selectThread(ThreadId) {}
464 465
};

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

    // This is a Qml or unknown engine.
485
    return cap & AddWatcherCapability;
486 487
}

488 489 490 491 492 493
///////////////////////////////////////////////////////////////////////
//
// DebugMode
//
///////////////////////////////////////////////////////////////////////

494
class DebugMode : public IMode
hjk's avatar
hjk committed
495 496
{
public:
497 498 499
    DebugMode()
    {
        setObjectName(QLatin1String("DebugMode"));
500
        setContext(Context(C_DEBUGMODE, CC::C_NAVIGATION_PANE));
501
        setDisplayName(DebuggerPlugin::tr("Debug"));
502 503
        setIcon(Utils::Icon::modeIcon(Icons::MODE_DEBUGGER_CLASSIC,
                                      Icons::MODE_DEBUGGER_FLAT, Icons::MODE_DEBUGGER_FLAT_ACTIVE));
504
        setPriority(85);
505
        setId(MODE_DEBUG);
506
    }
hjk's avatar
hjk committed
507

hjk's avatar
hjk committed
508 509 510 511
    ~DebugMode()
    {
        delete m_widget;
    }
512
};
hjk's avatar
hjk committed
513

514 515 516 517 518 519
///////////////////////////////////////////////////////////////////////
//
// Misc
//
///////////////////////////////////////////////////////////////////////

520
static QWidget *addSearch(BaseTreeView *treeView, const QString &title,
521
    const char *objectName)
522
{
hjk's avatar
hjk committed
523
    QAction *act = action(UseAlternatingRowColors);
524
    treeView->setAlternatingRowColors(act->isChecked());
525 526
    QObject::connect(act, &QAction::toggled,
                     treeView, &BaseTreeView::setAlternatingRowColorsHelper);
527

Daniel Teske's avatar
Daniel Teske committed
528
    QWidget *widget = ItemViewFind::createSearchableWrapper(treeView);
529 530 531 532 533
    widget->setObjectName(QLatin1String(objectName));
    widget->setWindowTitle(title);
    return widget;
}

534
static std::function<bool(const Kit *)> cdbMatcher(char wordWidth = 0)
535
{
536
    return [wordWidth](const Kit *k) -> bool {
537 538
        if (DebuggerKitInformation::engineType(k) != CdbEngineType
            || !DebuggerKitInformation::isValidDebugger(k)) {
539
            return false;
540
        }
541
        if (wordWidth) {
542
            const ToolChain *tc = ToolChainKitInformation::toolChain(k);
543
            return tc && wordWidth == tc->targetAbi().wordWidth();
544
        }
545
        return true;
546 547
    };
}
548

549 550 551 552 553
// 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
554
        if (Kit *cdb64Kit = KitManager::find(KitMatcher(cdbMatcher(64))))
555
            return cdb64Kit;
556
    }
Tobias Hunger's avatar
Tobias Hunger committed
557
    return KitManager::find(KitMatcher(cdbMatcher()));
558
}
559

560 561
///////////////////////////////////////////////////////////////////////
//
562
// DebuggerPluginPrivate
563 564
//
///////////////////////////////////////////////////////////////////////
con's avatar
con committed
565

566
static DebuggerPluginPrivate *dd = 0;
con's avatar
con committed
567

568 569 570 571 572 573 574 575 576 577 578 579 580 581
/*!
    \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.
*/

582
class DebuggerPluginPrivate : public QObject
583 584
{
    Q_OBJECT
585

586 587
public:
    explicit DebuggerPluginPrivate(DebuggerPlugin *plugin);
588
    ~DebuggerPluginPrivate();
589

590
    bool initialize(const QStringList &arguments, QString *errorMessage);
591 592 593
    void extensionsInitialized();
    void aboutToShutdown();

594
    void connectEngine(DebuggerEngine *engine);
hjk's avatar
hjk committed
595
    void disconnectEngine() { connectEngine(0); }
596
    DebuggerEngine *dummyEngine();
597

hjk's avatar
hjk committed
598
    void setThreadBoxContents(const QStringList &list, int index)
599 600 601 602 603 604 605 606
    {
        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);
    }
607 608

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

610 611 612 613 614 615
    void writeSettings()
    {
        m_debuggerSettings->writeSettings();
        m_mainWindow->writeSettings();
    }

616 617
    void selectThread(int index)
    {
hjk's avatar
hjk committed
618 619
        ThreadId id = m_currentEngine->threadsHandler()->threadAt(index);
        m_currentEngine->selectThread(id);
620
    }
621

622
    void breakpointSetMarginActionTriggered(bool isMessageOnly, const ContextData &data)
623
    {
624
        QString message;
625
        if (isMessageOnly) {
626
            if (data.type == LocationByAddress) {
627 628 629 630
                //: Message tracepoint: Address hit.
                message = tr("0x%1 hit").arg(data.address, 0, 16);
            } else {
                //: Message tracepoint: %1 file, %2 line %3 function hit.
631
                message = tr("%1:%2 %3() hit").arg(FileName::fromString(data.fileName).fileName()).
632 633 634 635 636
                        arg(data.lineNumber).
                        arg(cppFunctionAt(data.fileName, data.lineNumber));
            }
            QInputDialog dialog; // Create wide input dialog.
            dialog.setWindowFlags(dialog.windowFlags()
hjk's avatar
hjk committed
637
              & ~(Qt::WindowContextHelpButtonHint|Qt::MSWindowsFixedSizeDialogHint));
638 639 640 641 642 643 644 645
            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();
        }
646
        toggleBreakpoint(data, message);
647
    }
648

649
    void updateWatchersHeader(int section, int, int newSize)
650
    {
651 652
        m_watchersView->header()->resizeSection(section, newSize);
        m_returnView->header()->resizeSection(section, newSize);
653
    }
654

655
    void sourceFilesDockToggled(bool on)
656
    {
657
        if (on && m_currentEngine->state() == InferiorStopOk)
658 659 660
            m_currentEngine->reloadSourceFiles();
    }

661
    void modulesDockToggled(bool on)
662
    {
663
        if (on && m_currentEngine->state() == InferiorStopOk)
664 665
            m_currentEngine->reloadModules();
    }
666

hjk's avatar
hjk committed
667
    void registerDockToggled(bool on)
668
    {
669
        if (on && m_currentEngine->state() == InferiorStopOk)
670 671
            m_currentEngine->reloadRegisters();
    }
672

673 674
    void synchronizeBreakpoints()
    {
675
        showMessage(QLatin1String("ATTEMPT SYNC"), LogDebug);
676
        for (int i = 0, n = m_snapshotHandler->size(); i != n; ++i) {
677
            if (DebuggerEngine *engine = m_snapshotHandler->at(i))
678 679 680 681
                engine->attemptBreakpointSynchronization();
        }
    }

682 683
    void editorOpened(IEditor *editor);
    void updateBreakMenuItem(IEditor *editor);
684
    void setBusyCursor(bool busy);
685 686 687
    void requestMark(TextEditorWidget *widget, int lineNumber,
                     TextMarkRequestKind kind);
    void requestContextMenu(TextEditorWidget *widget,
688
                            int lineNumber, QMenu *menu);
689

690 691
    void activatePreviousMode();
    void activateDebugMode();
692 693
    void toggleBreakpointHelper();
    void toggleBreakpoint(const ContextData &location, const QString &tracePointMessage = QString());
694
    void onModeChanged(IMode *mode);
695
    void onCoreAboutToOpen();
696
    void updateDebugWithoutDeployMenu();
697

698
    void startAndDebugApplication();
699
    void startRemoteCdbSession();
700
    void startRemoteServerAndAttachToProcess();
701
    void attachToRemoteServer();
hjk's avatar
hjk committed
702
    void attachToRunningApplication();
703
    void attachToUnstartedApplicationDialog();
704
    void attachToQmlPort();
hjk's avatar
hjk committed
705
    Q_SLOT void runScheduled();
706
    void attachCore();
707

708
    void enableReverseDebuggingTriggered(const QVariant &value);
709
    void showStatusMessage(const QString &msg, int timeout = -1);
710

711 712
    void runControlStarted(DebuggerEngine *engine);
    void runControlFinished(DebuggerEngine *engine);
713
    void remoteCommand(const QStringList &options);
714

715
    void displayDebugger(DebuggerEngine *engine, bool updateEngine = true);
716 717 718

    void dumpLog();
    void cleanupViews();
719
    void setInitialState();
720

721
    void fontSettingsChanged(const FontSettings &settings);
722 723

    void updateState(DebuggerEngine *engine);
724
    void onCurrentProjectChanged(Project *project);
725 726 727 728

    void sessionLoaded();
    void aboutToUnloadSession();
    void aboutToSaveSession();
729

730
    void coreShutdown();
731

hjk's avatar
hjk committed
732 733
#ifdef WITH_TESTS
public slots:
734
    void testLoadProject(const QString &proFile, const TestCallBack &cb);
735
    void testProjectLoaded(Project *project);
736 737
    void testProjectEvaluated();
    void testProjectBuilt(bool success);
738 739 740
    void testUnloadProject();
    void testFinished();

741
    void testRunProject(const DebuggerRunParameters &sp, const TestCallBack &cb);
hjk's avatar
hjk committed
742
    void testRunControlFinished();
743

hjk's avatar
hjk committed
744 745 746
//    void testStateMachine1();
//    void testStateMachine2();
//    void testStateMachine3();
747

748 749
    void testBenchmark1();

750
public:
hjk's avatar
hjk committed
751
    Project *m_testProject;
752 753 754
    bool m_testSuccess;
    QList<TestCallBack> m_testCallbacks;

hjk's avatar
hjk committed
755 756
#endif

hjk's avatar
hjk committed
757
public slots:
758
    void updateDebugActions();
759 760 761

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

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

    void handleExecInterrupt()
    {
774
        currentEngine()->resetLocation();
775 776 777
        currentEngine()->requestInterruptInferior();
    }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

922
    void handleOperateByInstructionTriggered(bool operateByInstructionTriggered)
hjk's avatar
hjk committed
923
    {
924
        // Go to source only if we have the file.
925 926 927 928 929 930