debuggerengine.cpp 44.7 KB
Newer Older
1 2 3 4
/**************************************************************************
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
6 7 8
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
con's avatar
con committed
9
** No Commercial Usage
10
**
con's avatar
con committed
11 12 13 14
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
15 16 17 18 19 20 21 22 23 24
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
con's avatar
con committed
25 26 27 28 29 30
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
31 32 33 34 35 36
**
**************************************************************************/

#include "debuggerengine.h"

#include "debuggeractions.h"
37
#include "debuggercore.h"
38
#include "debuggerplugin.h"
39
#include "debuggerrunner.h"
40
#include "debuggerstringutils.h"
41
#include "debuggertooltip.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
42
#include "debuggerstartparameters.h"
43

44 45
#include "memoryagent.h"
#include "disassembleragent.h"
46 47 48 49 50 51 52 53 54
#include "breakhandler.h"
#include "moduleshandler.h"
#include "registerhandler.h"
#include "snapshothandler.h"
#include "sourcefileshandler.h"
#include "stackhandler.h"
#include "threadshandler.h"
#include "watchhandler.h"

hjk's avatar
hjk committed
55
#include <coreplugin/icore.h>
56
#include <coreplugin/ifile.h>
hjk's avatar
hjk committed
57
#include <coreplugin/editormanager/editormanager.h>
58 59
#include <coreplugin/progressmanager/progressmanager.h>
#include <coreplugin/progressmanager/futureprogress.h>
hjk's avatar
hjk committed
60

hjk's avatar
hjk committed
61
#include <projectexplorer/toolchain.h>
62
#include <projectexplorer/toolchaintype.h>
63

hjk's avatar
hjk committed
64
#include <texteditor/itexteditor.h>
65
#include <texteditor/basetextmark.h>
hjk's avatar
hjk committed
66

67 68 69 70 71
#include <utils/savedaction.h>
#include <utils/qtcassert.h>

#include <QtCore/QDebug>
#include <QtCore/QTimer>
72
#include <QtCore/QFutureInterface>
73

74
#include <QtGui/QMessageBox>
75

hjk's avatar
hjk committed
76
using namespace Core;
77
using namespace Debugger::Internal;
hjk's avatar
hjk committed
78 79
using namespace ProjectExplorer;
using namespace TextEditor;
80

hjk's avatar
hjk committed
81 82 83 84 85 86 87
//#define DEBUG_STATE 1
#if DEBUG_STATE
#   define SDEBUG(s) qDebug() << s
#else
#   define SDEBUG(s)
#endif
# define XSDEBUG(s) qDebug() << s
88

89

90 91 92 93 94 95
///////////////////////////////////////////////////////////////////////
//
// DebuggerStartParameters
//
///////////////////////////////////////////////////////////////////////

96 97
namespace Debugger {

Friedemann Kleint's avatar
Friedemann Kleint committed
98 99 100 101 102 103 104 105 106 107 108
Internal::Location::Location(const StackFrame &frame, bool marker)
{
    init();
    m_fileName = frame.file;
    m_lineNumber = frame.line;
    m_needsMarker = marker;
    m_functionName = frame.function;
    m_hasDebugInfo = frame.isUsable();
    m_address = frame.address;
}

109 110
QDebug operator<<(QDebug d, DebuggerState state)
{
hjk's avatar
hjk committed
111 112
    //return d << DebuggerEngine::stateName(state) << '(' << int(state) << ')';
    return d << DebuggerEngine::stateName(state);
113 114 115 116 117 118 119
}

QDebug operator<<(QDebug str, const DebuggerStartParameters &sp)
{
    QDebug nospace = str.nospace();
    nospace << "executable=" << sp.executable
            << " coreFile=" << sp.coreFile
120
            << " processArgs=" << sp.processArgs
121 122 123 124 125 126 127
            << " environment=<" << sp.environment.size() << " variables>"
            << " workingDir=" << sp.workingDirectory
            << " attachPID=" << sp.attachPID
            << " useTerminal=" << sp.useTerminal
            << " remoteChannel=" << sp.remoteChannel
            << " remoteArchitecture=" << sp.remoteArchitecture
            << " symbolFileName=" << sp.symbolFileName
hjk's avatar
hjk committed
128
            << " useServerStartScript=" << sp.useServerStartScript
129 130 131 132 133
            << " serverStartScript=" << sp.serverStartScript
            << " toolchain=" << sp.toolChainType << '\n';
    return str;
}

134

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
///////////////////////////////////////////////////////////////////////
//
// LocationMark
//
///////////////////////////////////////////////////////////////////////

// Used in "real" editors
class LocationMark : public TextEditor::BaseTextMark
{
public:
    LocationMark(const QString &fileName, int linenumber)
        : BaseTextMark(fileName, linenumber)
    {}

    QIcon icon() const { return debuggerCore()->locationMarkIcon(); }
    void updateLineNumber(int /*lineNumber*/) {}
    void updateBlock(const QTextBlock & /*block*/) {}
    void removedFromEditor() {}
};



157 158 159 160 161 162
//////////////////////////////////////////////////////////////////////
//
// DebuggerEnginePrivate
//
//////////////////////////////////////////////////////////////////////

163
class DebuggerEnginePrivate : public QObject
164
{
165 166
    Q_OBJECT

167
public:
168 169 170
    DebuggerEnginePrivate(DebuggerEngine *engine,
            DebuggerEngine *masterEngine,
            const DebuggerStartParameters &sp)
171
      : m_engine(engine),
172
        m_masterEngine(masterEngine),
173 174 175
        m_runControl(0),
        m_startParameters(sp),
        m_state(DebuggerNotReady),
hjk's avatar
hjk committed
176
        m_lastGoodState(DebuggerNotReady),
Friedemann Kleint's avatar
Friedemann Kleint committed
177
        m_targetState(DebuggerNotReady),
178
        m_modulesHandler(),
179
        m_registerHandler(),
180 181
        m_sourceFilesHandler(),
        m_stackHandler(),
hjk's avatar
hjk committed
182
        m_threadsHandler(),
183
        m_watchHandler(engine),
184
        m_disassemblerAgent(engine),
185 186
        m_memoryAgent(engine),
        m_isStateDebugging(false)
187
    {
188
        connect(&m_locationTimer, SIGNAL(timeout()), SLOT(resetLocation()));
189
    }
190 191

    ~DebuggerEnginePrivate() {}
192

193
public slots:
hjk's avatar
hjk committed
194 195
    void doSetupInferior();
    void doRunEngine();
hjk's avatar
hjk committed
196 197
    void doShutdownEngine();
    void doShutdownInferior();
198
    void doInterruptInferior();
hjk's avatar
hjk committed
199
    void doFinishDebugger();
hjk's avatar
hjk committed
200

201 202
    void queueRunEngine()
    {
hjk's avatar
hjk committed
203 204 205 206 207
        m_engine->setState(EngineRunRequested);
        m_engine->showMessage(_("QUEUE: RUN ENGINE"));
        QTimer::singleShot(0, this, SLOT(doRunEngine()));
    }

208 209
    void queueShutdownEngine()
    {
hjk's avatar
hjk committed
210 211 212 213 214
        m_engine->setState(EngineShutdownRequested);
        m_engine->showMessage(_("QUEUE: SHUTDOWN ENGINE"));
        QTimer::singleShot(0, this, SLOT(doShutdownEngine()));
    }

215 216
    void queueShutdownInferior()
    {
hjk's avatar
hjk committed
217 218 219 220 221
        m_engine->setState(InferiorShutdownRequested);
        m_engine->showMessage(_("QUEUE: SHUTDOWN INFERIOR"));
        QTimer::singleShot(0, this, SLOT(doShutdownInferior()));
    }

222 223
    void queueFinishDebugger()
    {
224 225 226 227
        QTC_ASSERT(state() == EngineShutdownOk
            || state() == EngineShutdownFailed, qDebug() << state());
        m_engine->setState(DebuggerFinished);
        m_engine->showMessage(_("QUEUE: FINISH DEBUGGER"));
hjk's avatar
hjk committed
228 229 230
        QTimer::singleShot(0, this, SLOT(doFinishDebugger()));
    }

231 232
    void raiseApplication()
    {
233 234
        QTC_ASSERT(runControl(), return);
        runControl()->bringApplicationToForeground(m_inferiorPid);
235 236
    }

237
    void scheduleResetLocation()
238
    {
239
        m_stackHandler.scheduleResetLocation();
240 241 242 243
        m_locationTimer.setSingleShot(true);
        m_locationTimer.start(80);
    }

244
    void resetLocation()
245 246 247
    {
        m_locationTimer.stop();
        m_locationMark.reset();
248 249
        m_stackHandler.resetLocation();
        m_disassemblerAgent.resetLocation();
250 251
    }

252
public:
hjk's avatar
hjk committed
253
    DebuggerState state() const { return m_state; }
254 255 256
    bool isMasterEngine() const { return m_engine->isMasterEngine(); }
    DebuggerRunControl *runControl() const
        { return m_masterEngine ? m_masterEngine->runControl() : m_runControl; }
hjk's avatar
hjk committed
257

258
    DebuggerEngine *m_engine; // Not owned.
259
    DebuggerEngine *m_masterEngine; // Not owned
260 261 262
    DebuggerRunControl *m_runControl;  // Not owned.

    DebuggerStartParameters m_startParameters;
hjk's avatar
hjk committed
263 264

    // The current state.
265 266
    DebuggerState m_state;

hjk's avatar
hjk committed
267 268 269 270 271 272
    // The state we had before something unexpected happend.
    DebuggerState m_lastGoodState;

    // The state we are aiming for.
    DebuggerState m_targetState;

273 274 275 276 277 278 279 280
    qint64 m_inferiorPid;

    ModulesHandler m_modulesHandler;
    RegisterHandler m_registerHandler;
    SourceFilesHandler m_sourceFilesHandler;
    StackHandler m_stackHandler;
    ThreadsHandler m_threadsHandler;
    WatchHandler m_watchHandler;
281
    QFutureInterface<void> m_progress;
282

283 284
    DisassemblerAgent m_disassemblerAgent;
    MemoryAgent m_memoryAgent;
285 286
    QScopedPointer<TextEditor::BaseTextMark> m_locationMark;
    QTimer m_locationTimer;
287 288

    bool m_isStateDebugging;
289 290 291 292 293 294 295 296 297
};


//////////////////////////////////////////////////////////////////////
//
// DebuggerEngine
//
//////////////////////////////////////////////////////////////////////

298 299 300
DebuggerEngine::DebuggerEngine(const DebuggerStartParameters &startParameters,
        DebuggerEngine *parentEngine)
  : d(new DebuggerEnginePrivate(this, parentEngine, startParameters))
301 302 303 304 305
{
}

DebuggerEngine::~DebuggerEngine()
{
306 307
    disconnect();
    delete d;
308 309
}

310 311 312 313 314 315 316 317 318
const char *DebuggerEngine::stateName(int s)
{
#    define SN(x) case x: return #x;
    switch (s) {
        SN(DebuggerNotReady)
        SN(EngineSetupRequested)
        SN(EngineSetupOk)
        SN(EngineSetupFailed)
        SN(EngineRunFailed)
319
        SN(EngineRunOk)
320 321
        SN(InferiorSetupRequested)
        SN(InferiorSetupFailed)
322
        SN(InferiorSetupOk)
323 324 325 326 327
        SN(EngineRunRequested)
        SN(InferiorRunRequested)
        SN(InferiorRunOk)
        SN(InferiorRunFailed)
        SN(InferiorUnrunnable)
328
        SN(InferiorStopSpontaneous)
329 330 331
        SN(InferiorStopRequested)
        SN(InferiorStopOk)
        SN(InferiorStopFailed)
332
        SN(InferiorExitOk)
333 334 335 336 337 338 339 340 341 342 343 344
        SN(InferiorShutdownRequested)
        SN(InferiorShutdownOk)
        SN(InferiorShutdownFailed)
        SN(EngineShutdownRequested)
        SN(EngineShutdownOk)
        SN(EngineShutdownFailed)
        SN(DebuggerFinished)
    }
    return "<unknown>";
#    undef SN
}

345
void DebuggerEngine::showStatusMessage(const QString &msg, int timeout) const
346
{
347
    showMessage(msg, StatusBar, timeout);
348
}
349

350 351 352 353 354 355
void DebuggerEngine::removeTooltip()
{
    watchHandler()->removeTooltip();
    hideDebuggerToolTip();
}

356 357 358 359 360 361 362 363 364 365 366 367 368 369
void DebuggerEngine::frameUp()
{
    int currentIndex = stackHandler()->currentIndex();
    activateFrame(qMin(currentIndex + 1, stackHandler()->stackSize() - 1));
}

void DebuggerEngine::frameDown()
{
    int currentIndex = stackHandler()->currentIndex();
    activateFrame(qMax(currentIndex - 1, 0));
}

ModulesHandler *DebuggerEngine::modulesHandler() const
{
370 371 372
    return d->m_masterEngine
        ? d->m_masterEngine->modulesHandler()
        : &d->m_modulesHandler;
373 374 375 376
}

RegisterHandler *DebuggerEngine::registerHandler() const
{
377 378 379
    return d->m_masterEngine
        ? d->m_masterEngine->registerHandler()
        : &d->m_registerHandler;
380 381 382 383
}

StackHandler *DebuggerEngine::stackHandler() const
{
384 385 386
    return d->m_masterEngine
        ? d->m_masterEngine->stackHandler()
        : &d->m_stackHandler;
387 388 389 390
}

ThreadsHandler *DebuggerEngine::threadsHandler() const
{
391 392 393
    return d->m_masterEngine
        ? d->m_masterEngine->threadsHandler()
        : &d->m_threadsHandler;
394 395 396 397
}

WatchHandler *DebuggerEngine::watchHandler() const
{
398 399 400
    return d->m_masterEngine
        ? d->m_masterEngine->watchHandler()
        : &d->m_watchHandler;
401 402 403 404
}

SourceFilesHandler *DebuggerEngine::sourceFilesHandler() const
{
405 406 407
    return d->m_masterEngine
        ? d->m_masterEngine->sourceFilesHandler()
        : &d->m_sourceFilesHandler;
408 409 410 411
}

QAbstractItemModel *DebuggerEngine::modulesModel() const
{
412
    QAbstractItemModel *model = modulesHandler()->model();
Friedemann Kleint's avatar
Friedemann Kleint committed
413 414 415
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ModulesModel"));
    return model;
416 417 418 419
}

QAbstractItemModel *DebuggerEngine::registerModel() const
{
420
    QAbstractItemModel *model = registerHandler()->model();
Friedemann Kleint's avatar
Friedemann Kleint committed
421 422 423
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("RegisterModel"));
    return model;
424 425 426 427
}

QAbstractItemModel *DebuggerEngine::stackModel() const
{
428
    QAbstractItemModel *model = stackHandler()->model();
Friedemann Kleint's avatar
Friedemann Kleint committed
429 430 431
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("StackModel"));
    return model;
432 433 434 435
}

QAbstractItemModel *DebuggerEngine::threadsModel() const
{
436
    QAbstractItemModel *model = threadsHandler()->model();
Friedemann Kleint's avatar
Friedemann Kleint committed
437 438 439
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ThreadsModel"));
    return model;
440 441 442 443
}

QAbstractItemModel *DebuggerEngine::localsModel() const
{
444
    QAbstractItemModel *model = watchHandler()->model(LocalsWatch);
Friedemann Kleint's avatar
Friedemann Kleint committed
445 446 447
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("LocalsModel"));
    return model;
448 449 450 451
}

QAbstractItemModel *DebuggerEngine::watchersModel() const
{
452
    QAbstractItemModel *model = watchHandler()->model(WatchersWatch);
Friedemann Kleint's avatar
Friedemann Kleint committed
453 454 455
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("WatchersModel"));
    return model;
456 457 458 459
}

QAbstractItemModel *DebuggerEngine::returnModel() const
{
460
    QAbstractItemModel *model = watchHandler()->model(ReturnWatch);
Friedemann Kleint's avatar
Friedemann Kleint committed
461 462 463
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("ReturnModel"));
    return model;
464 465 466 467
}

QAbstractItemModel *DebuggerEngine::sourceFilesModel() const
{
468
    QAbstractItemModel *model = sourceFilesHandler()->model();
Friedemann Kleint's avatar
Friedemann Kleint committed
469 470 471
    if (model->objectName().isEmpty()) // Make debugging easier.
        model->setObjectName(objectName() + QLatin1String("SourceFilesModel"));
    return model;
472 473
}

474
void DebuggerEngine::fetchMemory(MemoryAgent *, QObject *,
475 476 477 478 479 480 481 482 483 484 485 486 487 488
        quint64 addr, quint64 length)
{
    Q_UNUSED(addr);
    Q_UNUSED(length);
}

void DebuggerEngine::setRegisterValue(int regnr, const QString &value)
{
    Q_UNUSED(regnr);
    Q_UNUSED(value);
}

void DebuggerEngine::showMessage(const QString &msg, int channel, int timeout) const
{
489 490 491 492
    if (d->m_masterEngine) {
        d->m_masterEngine->showMessage(msg, channel, timeout);
        return;
    }
493 494
    //if (msg.size() && msg.at(0).isUpper() && msg.at(1).isUpper())
    //    qDebug() << qPrintable(msg) << "IN STATE" << state();
495
    debuggerCore()->showMessage(msg, channel, timeout);
496 497 498 499 500
    if (d->m_runControl) {
        d->m_runControl->showMessage(msg, channel);
    } else {
        qWarning("Warning: %s (no active run control)", qPrintable(msg));
    }
501 502 503 504
}

void DebuggerEngine::startDebugger(DebuggerRunControl *runControl)
{
505 506
    QTC_ASSERT(runControl, notifyEngineSetupFailed(); return);
    QTC_ASSERT(!d->m_runControl, notifyEngineSetupFailed(); return);
507

508 509 510 511 512 513 514
    d->m_progress.setProgressRange(0, 1000);
    Core::FutureProgress *fp = Core::ICore::instance()->progressManager()
        ->addTask(d->m_progress.future(),
        tr("Launching"), _("Debugger.Launcher"));
    fp->setKeepOnFinish(Core::FutureProgress::DontKeepOnFinish);
    d->m_progress.reportStarted();

515 516 517 518 519
    d->m_runControl = runControl;

    d->m_inferiorPid = d->m_startParameters.attachPID > 0
        ? d->m_startParameters.attachPID : 0;

520 521
    if (!d->m_startParameters.environment.size())
        d->m_startParameters.environment = Utils::Environment();
522 523

    const unsigned engineCapabilities = debuggerCapabilities();
hjk's avatar
hjk committed
524
    debuggerCore()->action(OperateByInstruction)
525 526
        ->setEnabled(engineCapabilities & DisassemblerCapability);

527 528
    QTC_ASSERT(state() == DebuggerNotReady || state() == DebuggerFinished,
         qDebug() << state());
529 530
    d->m_lastGoodState = DebuggerNotReady;
    d->m_targetState = DebuggerNotReady;
hjk's avatar
hjk committed
531
    setState(EngineSetupRequested);
532

533
    d->m_progress.setProgressValue(200);
hjk's avatar
hjk committed
534
    setupEngine();
535 536 537 538
}

void DebuggerEngine::resetLocation()
{
539 540
    // Do it after some delay to avoid flicker.
    d->scheduleResetLocation();
541 542
}

543
void DebuggerEngine::gotoLocation(const Location &loc)
544
{
545 546 547 548 549
    if (debuggerCore()->boolSetting(OperateByInstruction) || !loc.hasDebugInfo()) {
        d->m_disassemblerAgent.setTryMixed(true);
        d->m_disassemblerAgent.setLocation(loc);
        return;
    }
550 551 552 553
    // CDB might hit on breakpoints while shutting down.
    //if (m_shuttingDown)
    //    return;

554
    d->resetLocation();
555

556 557
    const QString file = loc.fileName();
    const int line = loc.lineNumber();
hjk's avatar
hjk committed
558 559
    EditorManager *editorManager = EditorManager::instance();
    QList<IEditor *> editors = editorManager->editorsForFileName(file);
560
    IEditor *editor = 0;
hjk's avatar
hjk committed
561
    if (editors.isEmpty()) {
562 563 564 565 566 567 568 569
        editor = editorManager->openEditor(file, QString(),
            EditorManager::IgnoreNavigationHistory);
        if (editor) {
            editors.append(editor);
            editor->setProperty(Constants::OPENED_BY_DEBUGGER, true);
        }
    } else {
        editor = editors.back();
hjk's avatar
hjk committed
570
    }
571
    ITextEditor *texteditor = qobject_cast<ITextEditor *>(editor);
hjk's avatar
hjk committed
572 573 574
    if (texteditor)
        texteditor->gotoLine(line, 0);

575
    if (loc.needsMarker())
576
        d->m_locationMark.reset(new LocationMark(file, line));
577 578

    // FIXME: Breaks with split views.
579
    if (!d->m_memoryAgent.hasVisibleEditor() || loc.needsRaise())
580
        editorManager->activateEditor(editor);
581
    //qDebug() << "MEMORY: " << d->m_memoryAgent.hasVisibleEditor();
582 583
}

584 585 586
// Called from RunControl.
void DebuggerEngine::handleStartFailed()
{
587
    showMessage("HANDLE RUNCONTROL START FAILED");
588
    d->m_runControl = 0;
589
    d->m_progress.setProgressValue(900);
590 591
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
592 593
}

594 595
// Called from RunControl.
void DebuggerEngine::handleFinished()
596
{
597
    showMessage("HANDLE RUNCONTROL FINISHED");
598
    d->m_runControl = 0;
599 600 601 602
    modulesHandler()->removeAll();
    stackHandler()->removeAll();
    threadsHandler()->removeAll();
    watchHandler()->cleanup();
603
    d->m_progress.setProgressValue(1000);
604
    d->m_progress.reportFinished();
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
}

const DebuggerStartParameters &DebuggerEngine::startParameters() const
{
    return d->m_startParameters;
}

DebuggerStartParameters &DebuggerEngine::startParameters()
{
    return d->m_startParameters;
}


//////////////////////////////////////////////////////////////////////
//
// Dumpers. "Custom dumpers" are a library compiled against the current
// Qt containing functions to evaluate values of Qt classes
// (such as QString, taking pointers to their addresses).
// The library must be loaded into the debuggee.
//
//////////////////////////////////////////////////////////////////////

bool DebuggerEngine::qtDumperLibraryEnabled() const
{
hjk's avatar
hjk committed
629
    return debuggerCore()->boolSetting(UseDebuggingHelpers);
630 631 632 633
}

QStringList DebuggerEngine::qtDumperLibraryLocations() const
{
hjk's avatar
hjk committed
634
    if (debuggerCore()->action(UseCustomDebuggingHelperLocation)->value().toBool()) {
635
        const QString customLocation =
hjk's avatar
hjk committed
636
            debuggerCore()->action(CustomDebuggingHelperLocation)->value().toString();
637 638 639 640 641 642 643 644 645
        const QString location =
            tr("%1 (explicitly set in the Debugger Options)").arg(customLocation);
        return QStringList(location);
    }
    return d->m_startParameters.dumperLibraryLocations;
}

void DebuggerEngine::showQtDumperLibraryWarning(const QString &details)
{
646
    debuggerCore()->showQtDumperLibraryWarning(details);
647 648 649 650
}

QString DebuggerEngine::qtDumperLibraryName() const
{
hjk's avatar
hjk committed
651 652
    if (debuggerCore()->action(UseCustomDebuggingHelperLocation)->value().toBool())
        return debuggerCore()->action(CustomDebuggingHelperLocation)->value().toString();
653 654 655 656 657 658 659 660
    return startParameters().dumperLibrary;
}

DebuggerState DebuggerEngine::state() const
{
    return d->m_state;
}

hjk's avatar
hjk committed
661
DebuggerState DebuggerEngine::lastGoodState() const
662
{
hjk's avatar
hjk committed
663 664 665 666 667 668 669
    return d->m_lastGoodState;
}

DebuggerState DebuggerEngine::targetState() const
{
    return d->m_targetState;
}
670

hjk's avatar
hjk committed
671 672 673
static bool isAllowedTransition(DebuggerState from, DebuggerState to)
{
    switch (from) {
674
    case DebuggerNotReady:
675
        return to == EngineSetupRequested;
676

hjk's avatar
hjk committed
677
    case EngineSetupRequested:
678 679
        return to == EngineSetupOk || to == EngineSetupFailed;
    case EngineSetupFailed:
680 681 682
        // In is the engine's task to go into a proper "Shutdown"
        // state before calling notifyEngineSetupFailed
        return to == DebuggerFinished;
683
    case EngineSetupOk:
hjk's avatar
hjk committed
684
        return to == InferiorSetupRequested || to == EngineShutdownRequested;
685

hjk's avatar
hjk committed
686
    case InferiorSetupRequested:
687
        return to == InferiorSetupOk || to == InferiorSetupFailed;
hjk's avatar
hjk committed
688
    case InferiorSetupFailed:
hjk's avatar
hjk committed
689
        return to == EngineShutdownRequested;
690 691
    case InferiorSetupOk:
        return to == EngineRunRequested;
hjk's avatar
hjk committed
692 693

    case EngineRunRequested:
694
        return to == EngineRunOk || EngineRunFailed;
hjk's avatar
hjk committed
695
    case EngineRunFailed:
696
        return to == EngineShutdownRequested;
697 698 699
    case EngineRunOk:
        return InferiorRunOk || to == InferiorStopOk
            || to == InferiorUnrunnable;
hjk's avatar
hjk committed
700 701 702 703 704 705

    case InferiorRunRequested:
        return to == InferiorRunOk || to == InferiorRunFailed;
    case InferiorRunFailed:
        return to == InferiorStopOk;
    case InferiorRunOk:
706 707 708
        return to == InferiorStopRequested || to == InferiorStopSpontaneous
            || InferiorExitOk;
            //|| to == InferiorStopOk;
hjk's avatar
hjk committed
709 710 711

    case InferiorStopRequested:
        return to == InferiorStopOk || to == InferiorStopFailed;
712 713
    case InferiorStopSpontaneous:
        return to == InferiorStopOk;
hjk's avatar
hjk committed
714 715
    case InferiorStopOk:
        return to == InferiorRunRequested || to == InferiorShutdownRequested
716
            || to == InferiorStopOk || InferiorExitOk;
717
    case InferiorStopFailed:
hjk's avatar
hjk committed
718
        return to == EngineShutdownRequested;
719

720 721 722
    case InferiorExitOk:
        return to == InferiorShutdownOk;

723
    case InferiorUnrunnable:
hjk's avatar
hjk committed
724 725 726 727 728
        return to == InferiorShutdownRequested;
    case InferiorShutdownRequested:
        return to == InferiorShutdownOk || to == InferiorShutdownFailed;
    case InferiorShutdownOk:
        return to == EngineShutdownRequested;
729
    case InferiorShutdownFailed:
hjk's avatar
hjk committed
730
        return to == EngineShutdownRequested;
731

hjk's avatar
hjk committed
732
    case EngineShutdownRequested:
733
        return to == EngineShutdownOk || to == EngineShutdownFailed;
hjk's avatar
hjk committed
734 735 736 737 738 739
    case EngineShutdownOk:
        return to == DebuggerFinished;
    case EngineShutdownFailed:
        return to == DebuggerFinished;

    case DebuggerFinished:
740
        return to == EngineSetupRequested; // Happens on restart.
741 742
    }

743
    qDebug() << "UNKNOWN DEBUGGER STATE:" << from;
744 745 746
    return false;
}

747
void DebuggerEngine::notifyEngineSetupFailed()
hjk's avatar
hjk committed
748
{
hjk's avatar
hjk committed
749
    showMessage(_("NOTE: ENGINE SETUP FAILED"));
750
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << this << state());
751
    setState(EngineSetupFailed);
752 753
    if (isMasterEngine())
        runControl()->startFailed();
hjk's avatar
hjk committed
754
    setState(DebuggerFinished);
hjk's avatar
hjk committed
755 756
}

757
void DebuggerEngine::notifyEngineSetupOk()
758
{
hjk's avatar
hjk committed
759
    showMessage(_("NOTE: ENGINE SETUP OK"));
760
    QTC_ASSERT(state() == EngineSetupRequested, qDebug() << this << state());
761
    setState(EngineSetupOk);
hjk's avatar
hjk committed
762
    showMessage(_("QUEUE: SETUP INFERIOR"));
763 764
    if (isMasterEngine())
        QTimer::singleShot(0, d, SLOT(doSetupInferior()));
765 766
}

hjk's avatar
hjk committed
767
void DebuggerEnginePrivate::doSetupInferior()
768
{
769
    QTC_ASSERT(isMasterEngine(), return);
770
    m_engine->showMessage(_("CALL: SETUP INFERIOR"));
771
    QTC_ASSERT(state() == EngineSetupOk, qDebug() << m_engine << state());
772
    m_progress.setProgressValue(250);
hjk's avatar
hjk committed
773
    m_engine->setState(InferiorSetupRequested);
hjk's avatar
hjk committed
774 775 776 777 778
    m_engine->setupInferior();
}

void DebuggerEngine::notifyInferiorSetupFailed()
{
hjk's avatar
hjk committed
779
    showMessage(_("NOTE: INFERIOR SETUP FAILED"));
780
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << this << state());
hjk's avatar
hjk committed
781
    setState(InferiorSetupFailed);
782 783
    if (isMasterEngine())
        d->queueShutdownEngine();
hjk's avatar
hjk committed
784 785 786 787
}

void DebuggerEngine::notifyInferiorSetupOk()
{
hjk's avatar
hjk committed
788
    showMessage(_("NOTE: INFERIOR SETUP OK"));
789 790 791 792
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << this << state());
    setState(InferiorSetupOk);
    if (isMasterEngine())
        d->queueRunEngine();
hjk's avatar
hjk committed
793 794 795 796
}

void DebuggerEnginePrivate::doRunEngine()
{
797
    QTC_ASSERT(isMasterEngine(), return);
hjk's avatar
hjk committed
798
    m_engine->showMessage(_("CALL: RUN ENGINE"));
799
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << m_engine << state());
800
    m_progress.setProgressValue(300);
hjk's avatar
hjk committed
801 802 803
    m_engine->runEngine();
}

hjk's avatar
hjk committed
804 805
void DebuggerEngine::notifyInferiorUnrunnable()
{
hjk's avatar
hjk committed
806
    showMessage(_("NOTE: INFERIOR UNRUNNABLE"));
807 808
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
809
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << this << state());
hjk's avatar
hjk committed
810 811 812 813 814
    setState(InferiorUnrunnable);
}

void DebuggerEngine::notifyEngineRunFailed()
{
hjk's avatar
hjk committed
815
    showMessage(_("NOTE: ENGINE RUN FAILED"));
816
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << this << state());
817 818 819
    d->m_progress.setProgressValue(900);
    d->m_progress.reportCanceled();
    d->m_progress.reportFinished();
hjk's avatar
hjk committed
820
    setState(EngineRunFailed);
821 822
    if (isMasterEngine())
        d->queueShutdownEngine();
hjk's avatar
hjk committed
823 824 825 826
}

void DebuggerEngine::notifyEngineRunAndInferiorRunOk()
{
hjk's avatar
hjk committed
827
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR RUN OK"));
828 829
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
830 831 832 833
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << this << state());
    setState(EngineRunOk);
    if (isMasterEngine())
        setState(InferiorRunOk);
hjk's avatar
hjk committed
834 835 836 837
}

void DebuggerEngine::notifyEngineRunAndInferiorStopOk()
{
hjk's avatar
hjk committed
838
    showMessage(_("NOTE: ENGINE RUN AND INFERIOR STOP OK"));
839 840
    d->m_progress.setProgressValue(1000);
    d->m_progress.reportFinished();
841 842 843 844
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << this << state());
    setState(EngineRunOk);
    if (isMasterEngine())
        setState(InferiorStopOk);
hjk's avatar
hjk committed
845 846 847 848
}

void DebuggerEngine::notifyInferiorRunRequested()
{
hjk's avatar
hjk committed
849
    showMessage(_("NOTE: INFERIOR RUN REQUESTED"));
850
    QTC_ASSERT(state() == InferiorStopOk, qDebug() << this << state());
hjk's avatar
hjk committed
851 852 853 854 855
    setState(InferiorRunRequested);
}

void DebuggerEngine::notifyInferiorRunOk()
{
hjk's avatar
hjk committed
856
    showMessage(_("NOTE: INFERIOR RUN OK"));
857
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << this << state());
hjk's avatar
hjk committed
858 859 860 861 862
    setState(InferiorRunOk);
}

void DebuggerEngine::notifyInferiorRunFailed()
{
hjk's avatar
hjk committed
863
    showMessage(_("NOTE: INFERIOR RUN FAILED"));
864
    QTC_ASSERT(state() == InferiorRunRequested, qDebug() << this << state());
hjk's avatar
hjk committed
865 866
    setState(InferiorRunFailed);
    setState(InferiorStopOk);
hjk's avatar
hjk committed
867 868
    if (isDying())
        d->queueShutdownInferior();
hjk's avatar
hjk committed
869 870 871 872
}

void DebuggerEngine::notifyInferiorStopOk()
{
hjk's avatar
hjk committed
873 874
    showMessage(_("NOTE: INFERIOR STOP OK"));
    // Ignore spurious notifications after we are set to die.
hjk's avatar
hjk committed
875
    if (isDying()) {
hjk's avatar
hjk committed
876 877 878 879 880 881 882 883 884 885 886 887 888
        showMessage(_("NOTE: ... WHILE DYING. "));
        // Forward state to "StopOk" if needed.
        if (state() == InferiorStopRequested
                || state() == InferiorRunRequested
                || state() == InferiorRunOk) {
            showMessage(_("NOTE: ... FORWARDING TO 'STOP OK'. "));
            setState(InferiorStopOk);
        }
        if (state() == InferiorStopOk || state() == InferiorStopFailed) {
            d->queueShutdownInferior();
        }
        showMessage(_("NOTE: ... IGNORING STOP MESSAGE"));
        return;
hjk's avatar
hjk committed
889
    }
890
    QTC_ASSERT(state() == InferiorStopRequested, qDebug() << this << state());
hjk's avatar
hjk committed
891
    setState(InferiorStopOk);
hjk's avatar
hjk committed
892 893
}

hjk's avatar
hjk committed
894
void DebuggerEngine::notifyInferiorSpontaneousStop()
895
{
hjk's avatar
hjk committed
896
    showMessage(_("NOTE: INFERIOR SPONTANEOUES STOP"));
897 898 899 900
    QTC_ASSERT(state() == InferiorRunOk, qDebug() << this << state());
    setState(InferiorStopSpontaneous);
    if (isMasterEngine())
        setState(InferiorStopOk);
901 902
}

hjk's avatar
hjk committed
903
void DebuggerEngine::notifyInferiorStopFailed()
904
{
hjk's avatar
hjk committed
905
    showMessage(_("NOTE: INFERIOR STOP FAILED"));
906
    QTC_ASSERT(state() == InferiorStopRequested, qDebug() << this << state());